Param.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2018.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Marc Sturm, Clemens Groepl $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/DATASTRUCTURES/DataValue.h>
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/DATASTRUCTURES/ListUtils.h>
#include <OpenMS/OpenMSConfig.h>

#include <iosfwd>
#include <set>

namespace OpenMS
{

  template <class Key, class T>
  class Map;

  namespace Logger
  {
    class LogStream;
  }

  class OPENMS_DLLAPI Param
  {
public:

    struct OPENMS_DLLAPI ParamEntry
    {
      ParamEntry();
      ParamEntry(const String& n, const DataValue& v, const String& d, const StringList& t = StringList());
      ParamEntry(const ParamEntry&) = default;
      ParamEntry(ParamEntry&&) = default;
      ~ParamEntry();

      ParamEntry& operator=(const ParamEntry&) = default;
      ParamEntry& operator=(ParamEntry&&) & = default;

      bool isValid(String& message) const;
      bool operator==(const ParamEntry& rhs) const;

      String name;
      String description;
      DataValue value;
      std::set<String> tags;

      double min_float; 
      double max_float; 
      Int min_int; 
      Int max_int; 
      std::vector<String> valid_strings; 

    };

    struct OPENMS_DLLAPI ParamNode
    {
      typedef std::vector<ParamNode>::iterator NodeIterator;
      typedef std::vector<ParamEntry>::iterator EntryIterator;
      typedef std::vector<ParamNode>::const_iterator ConstNodeIterator;
      typedef std::vector<ParamEntry>::const_iterator ConstEntryIterator;

      ParamNode();
      ParamNode(const String& n, const String& d);
      ParamNode(const ParamNode&) = default;
      ParamNode(ParamNode&&) = default;
      ~ParamNode();

      ParamNode& operator=(const ParamNode&) = default;
      ParamNode& operator=(ParamNode&&) & = default;

      bool operator==(const ParamNode& rhs) const;

      EntryIterator findEntry(const String& name);
      NodeIterator findNode(const String& name);
      ParamNode* findParentOf(const String& name);
      ParamEntry* findEntryRecursive(const String& name);

      void insert(const ParamNode& node, const String& prefix = "");
      void insert(const ParamEntry& entry, const String& prefix = "");
      Size size() const;
      String suffix(const String& key) const;

      String name;
      String description;
      std::vector<ParamEntry> entries;
      std::vector<ParamNode> nodes;
    };

public:

    class OPENMS_DLLAPI ParamIterator
    {
public:
      struct OPENMS_DLLAPI TraceInfo
      {
        inline TraceInfo(const String& n, const String& d, bool o) :
          name(n),
          description(d),
          opened(o)
        {
        }

        String name;
        String description;
        bool opened;
      };

      ParamIterator();
      ParamIterator(const Param::ParamNode& root);
      ~ParamIterator();
      const Param::ParamEntry& operator*();
      const Param::ParamEntry* operator->();
      ParamIterator& operator++();
      ParamIterator operator++(int);
      bool operator==(const ParamIterator& rhs) const;
      bool operator!=(const ParamIterator& rhs) const;
      String getName() const;
      const std::vector<TraceInfo>& getTrace() const;

protected:
      const Param::ParamNode* root_;
      Int current_;
      std::vector<const Param::ParamNode*> stack_;
      std::vector<TraceInfo> trace_;

    };

    Param();

    Param(const Param&) = default;

    Param(Param&&) = default;

    ~Param();

    Param& operator=(const Param&) = default;

    Param& operator=(Param&&) & = default;

    bool operator==(const Param& rhs) const;

    ParamIterator begin() const;

    ParamIterator end() const;



    void setValue(const String& key, const DataValue& value, const String& description = "", const StringList& tags = StringList());

    const DataValue& getValue(const String& key) const;

    const ParamEntry& getEntry(const String& key) const;

    bool exists(const String& key) const;

    ParamIterator findFirst(const String& leaf) const;

    ParamIterator findNext(const String& leaf, const ParamIterator& start_leaf) const;



    void addTag(const String& key, const String& tag);

    void addTags(const String& key, const StringList& tags);

    bool hasTag(const String& key, const String& tag) const;

    StringList getTags(const String& key) const;

    void clearTags(const String& key);




    const String& getDescription(const String& key) const;

    void setSectionDescription(const String& key, const String& description);

    const String& getSectionDescription(const String& key) const;

    void addSection(const String& key, const String& description);



    Size size() const;

    bool empty() const;

    void clear();

    void insert(const String& prefix, const Param& param);

    void remove(const String& key);

    void removeAll(const String& prefix);

    Param copy(const String& prefix, bool remove_prefix = false) const;

    bool update(const Param& p_outdated, const bool add_unknown = false);

    bool update(const Param& p_outdated, const bool add_unknown, Logger::LogStream& stream);
   
   
    bool update(const Param& p_outdated, bool verbose, bool add_unknown, bool fail_on_invalid_values, bool fail_on_unknown_parameters, Logger::LogStream& stream);

    void merge(const Param& toMerge);





    void setDefaults(const Param& defaults, const String& prefix = "", bool showMessage = false);

    void checkDefaults(const String& name, const Param& defaults, const String& prefix = "") const;



    void setValidStrings(const String& key, const std::vector<String>& strings);

    void setMinInt(const String& key, Int min);

    void setMaxInt(const String& key, Int max);

    void setMinFloat(const String& key, double min);

    void setMaxFloat(const String& key, double max);



    void parseCommandLine(const int argc, const char** argv, const String& prefix = "");

    void parseCommandLine(const int argc, const char** argv, const Map<String, String>& options_with_one_argument, const Map<String, String>& options_without_argument, const Map<String, String>& options_with_multiple_argument, const String& misc = "misc", const String& unknown = "unknown");


protected:

    ParamEntry& getEntry_(const String& key) const;

    Param(const Param::ParamNode& node);

    mutable Param::ParamNode root_;
  };

  OPENMS_DLLAPI std::ostream& operator<<(std::ostream& os, const Param& param);

} // namespace OpenMS