GOptionString.hh

Go to the documentation of this file.

//======================================================================
/*! \file GOptionString.hh
 *
 *  Include file for class GOptionString.
 */
//======================================================================

#ifndef G_OPTION_STRING_HH
#define G_OPTION_STRING_HH

#include "GString.hh"

//======================================================================
/*! \class GOptionString
 *
 *  Class for options defined by text strings.
 *  Options may be searched for with or without additional numerical
 *  or text parameters.
 *
 *  The CheckOption() functions search for an option and return true
 *  if it is found in the string, that is let unchanged.
 *  The ExtractOption() functions do the same, but the corresponding
 *  text is removed from the string.
 *
 *  The search for options ignores spaces between options.
 *
 *  La recherche d'option ignore les espaces entre les options.
 *
 *  The option arguments can be defined with 2 froms:
 *  - "... opt = valeur; ..."
 *  - "... opt = (valeur) ..."
 */

class GOptionString : public GString
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GOptionString)
  //------------------------------------------------------------

  protected:

    static  char    arg_begin;     ///< Character for beginning of argument
    static  char    arg_end;       ///< Character for end of argument
    static  string  arg_separ;     ///< Characters to separate options
    bool            case_flag;     ///< Indicates if options are case sensitive

  //------------------------------------------------------------
  //  Constructor / Destructor / Affectation
  public:
    GOptionString ( bool case_sens = false );
          GOptionString ( const string & s, bool case_sens = false );
          GOptionString ( const char   * s, bool case_sens = false );
    GOptionString ( const GOptionString & s );

    GOptionString & operator = ( const GOptionString & s );
    GOptionString & operator = ( const string & s );
    GOptionString & operator = ( const char * s );

    virtual ~GOptionString ();  // inline

  //------------------------------------------------------------
  protected:
    virtual size_t  OptPosition ( const GString &opt ) const;
    virtual size_t  OptPosition ( const GString &opt, size_t &end_pos ) const;

    virtual string  OptArgument ( const size_t pos, size_t &end ) const;

  //------------------------------------------------------------
  public:

    virtual void  SetArgumentDelimiter ( char c );
    virtual void  SetArgumentSeparator ( char c );
    virtual void  SetArgumentSeparator ( const string &str );
    virtual void  SetCaseSensitive     ( bool case_sens = true );

    // options check without change of the original option string
    virtual bool  CheckOption ( const char    opt ) const;
    virtual bool  CheckOption ( const string &opt ) const;

    virtual bool  CheckOption ( const char    opt, string &arg ) const;
    virtual bool  CheckOption ( const string &opt, string &arg ) const;

    virtual bool  CheckOption ( const char    opt, int &arg, const int default_val = 0 ) const;
    virtual bool  CheckOption ( const string &opt, int &arg, const int default_val = 0 ) const;

    virtual bool  CheckOption ( const char    opt, double &arg, const double default_val = 0. ) const;
    virtual bool  CheckOption ( const string &opt, double &arg, const double default_val = 0. ) const;

    // options check, removed from original option string
    virtual bool  ExtractOption ( const char    opt );
    virtual bool  ExtractOption ( const string &opt );

    virtual bool  ExtractOption ( const char    opt, string &arg );
    virtual bool  ExtractOption ( const string &opt, string &arg );

    virtual bool  ExtractOption ( const char    opt, int &arg, const int default_val = 0 );
    virtual bool  ExtractOption ( const string &opt, int &arg, const int default_val = 0 );

    virtual bool  ExtractOption ( const char    opt, double &arg, const double default_val = 0. );
    virtual bool  ExtractOption ( const string &opt, double &arg, const double default_val = 0. );

};

//----------------------------------------------------------------------
// Inline functions
#include "icc/GOptionString.icc"

//======================================================================
#endif