gsCmdLine.h

Go to the documentation of this file.

#pragma once

#include <gsCore/gsForwardDeclarations.h>
#include <gsIO/gsOptionList.h>

namespace gismo
{

// Forward declaration
class gsCmdLinePrivate;

class GISMO_EXPORT gsCmdLine : public gsOptionList //TODO: better name: gsCmdOptionList
{
    typedef index_t intVal_t;

public:
    gsCmdLine(const std::string& message,
              const char delimiter = ' ',
              bool helpAndVersion = true);

    void addInt(const std::string& flag,
                const std::string& name,
                const std::string& desc,
                intVal_t         & value); //TODO: rename as argInt

    void addNewInt(const std::string& flag,
                   const std::string& name,
                   const std::string& desc,
                   intVal_t          value) //TODO: rename as addInt
    {
        gsOptionList::addInt(name, desc, value); //add new option
        addInt(flag, name, desc, getIntRef(name) );    //bind cmd arg
    }

    // Third (inherited) version: add int option which is NOT a
    // command-line argument
    using gsOptionList::addInt;

    void addMultiInt(const std::string    & flag,
                     const std::string    & name,
                     const std::string    & desc,
                     std::vector<intVal_t>& value);

    //using gsOptionList::addMultiInt;
        
    void addReal(const std::string& flag,
                 const std::string& name,
                 const std::string& desc,
                 real_t           & value);
    
    //using gsOptionList::addReal;

    void addMultiReal(const std::string  & flag,
                      const std::string  & name,
                      const std::string  & desc,
                      std::vector<real_t>& value);

    //using gsOptionList::addMultiReal;

    void addString(const std::string& flag,
                   const std::string& name,
                   const std::string& desc,
                   std::string      & value);

    //using gsOptionList::addString;

    void addMultiString(const std::string      & flag,
                       const std::string       & name,
                       const std::string       & desc,
                       std::vector<std::string>& value);

    //using gsOptionList::addMultiString;

    void addSwitch(const std::string& flag,
                   const std::string& name,
                   const std::string& desc,
                   bool             & value);

    void addSwitch(const std::string& name,
                   const std::string& desc,
                   bool             & value)
    {
        gsOptionList::addSwitch(name, desc, value); //add new option
        addSwitch("",name,desc,value);
    }

    void addPlainString(const std::string& name,
                        const std::string& desc,
                        std::string      & value);

    void getValues(int argc, char *argv[]);

    static void printVersion();

    std::string& getMessage();

    bool valid(int argc, char *argv[]) const;

    void setExceptionHandling(const bool state);

    bool getExceptionHandling() const;

    // Destructor
    ~gsCmdLine();

private:
    void updateOptionList();

private:

    gsCmdLinePrivate * my;

}; // class gsCmdLine

#ifdef GISMO_WITH_PYBIND11

  void pybind11_init_gsCmdLine(pybind11::module &m);

#endif // GISMO_WITH_PYBIND11

namespace internal
{

template<>
class GISMO_EXPORT gsXml<gsCmdLine> : public gsXml<gsOptionList> { };

}

} // namespace gismo