GString.hh

Go to the documentation of this file.

//======================================================================
/*! \file GString.hh
 *
 *  Include file for the GString class
 */
//======================================================================


#ifndef G_STRING_HH
#define G_STRING_HH

#include "GGlobal.hh"

//----------------------------------------------------------------------

///! Default separator characters
#define GSTRING_DEFAULT_SEPARATOR " ,;:.!?'[]{}()=+-*&%$#\n\t\r"

///! Default space separator characters
#define GSTRING_DEFAULT_SPACE " \n\t\r"

///! Default punctuation characters
#define GSTRING_DEFAULT_PUNCT ",;:.!?"

///! Lowercase letters with accent
#define GSTRING_ACCENT_LOWER      "àâäéèêëîïôöùü"

///! Uppercase letters with accent
#define GSTRING_ACCENT_UPPER      "ÀÂÄÉÈÊËÎÏÔÖÙÜ"

///! All letters with accent
#define GSTRING_ACCENT_LIST       "àâäéèêëîïôöùüÀÂÄÉÈÊËÎÏÔÖÙÜ"

///! Letters without accent corresponding to letters with accent
#define GSTRING_NO_ACCENT_LIST    "aaaeeeeiioouuAAAEEEEIIOOUU"

//======================================================================
/*! \class GString
 *
 *  Class deriving from the standard C++ \b string class, defining
 *  new functions.
 */

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

  public:
  //------------------------------------------------------------
  //  Constructor / Destructor / Affectation
    GString ( );
    GString ( const string  & s );
    GString ( const char    * s );
    GString ( const GString & s );

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

    virtual ~GString ();

  //------------------------------------------------------------
  // General functions

    virtual GString ToLower ( ) const;
    virtual GString ToUpper ( ) const;

    virtual GString NoAccent ( ) const;
    virtual GString NoPunct  ( const string &punct = GSTRING_DEFAULT_PUNCT, const char rep = ' ' ) const;

    virtual GString NoSpace    ( const string &spc = GSTRING_DEFAULT_SPACE ) const;
    virtual GString NoEndSpace ( const string &spc = GSTRING_DEFAULT_SPACE ) const;

    virtual GString Fill ( size_t len, const char c = ' ', bool trunc = false ) const;

    size_t  FindFirstOf ( const string &s, size_t index = 0 );

    GString & ReplaceChar ( char c, char r, u_int n = 0 );
    GString & ReplaceAll ( const GString & s, const GString & r );


  // Comparison functions
    virtual int Compare     ( const GString & str ) const;
    virtual int CompareDict ( const GString & str ) const;

  // Reading values
    virtual int     ReadInt    ( int    default_val = 0  ) const;
    virtual float   ReadFloat  ( float  default_val = 0. ) const;
    virtual double  ReadDouble ( double default_val = 0. ) const;

    virtual int     ReadSubInt    ( size_t        & ifirst,
                                    size_t        & ilast,
                                    size_t          index = 0,
                                    int             default_val = 0,
                                    const string  & separ = GSTRING_DEFAULT_SPACE  ) const;
    virtual float   ReadSubFloat  ( size_t        & ifirst,
                                    size_t        & ilast,
                                    const size_t    index = 0,
                                    const float     default_val = 0.,
                                    const string  & separ = GSTRING_DEFAULT_SPACE ) const;
    virtual double  ReadSubDouble ( size_t        & ifirst,
                                    size_t        & ilast,
                                    const size_t    index = 0,
                                    const double    default_val = 0.,
                                    const string  & separ = GSTRING_DEFAULT_SPACE ) const;

  // extracting sub strings
    virtual GString GetSubstring ( char      first,
                                   char      last,
                                   size_t  & ifirst,
                                   size_t  & ilast,
                                   size_t    index = 0,
                                   bool      keep  = true ) const;

    virtual GString GetSubstring ( char   first,
                                   char   last,
                                   size_t index = 0,
                                   bool   keep  = true ) const;

  // extracting words
    virtual GString GetWord ( size_t &ifirst, size_t &ilast, size_t index = 0,
                              const string &separ = GSTRING_DEFAULT_SEPARATOR ) const;

    virtual GString GetWord ( size_t  index = 0,
                              const string &separ = GSTRING_DEFAULT_SEPARATOR ) const;

    virtual u_int     CountWords        ( const string &separ = GSTRING_DEFAULT_SEPARATOR ) const;
    virtual u_int     GetWords          ( string * table, const string &separ = GSTRING_DEFAULT_SEPARATOR ) const;
    virtual string *  CreateWordsTable  ( u_int &nw, const string &separ = GSTRING_DEFAULT_SEPARATOR ) const;

  // replacing formats %...X
    virtual size_t  FindFormat    ( const char fmtc, size_t &fmtlen, size_t &len );
    virtual size_t  FindFormat    ( const char fmtc, size_t &fmtlen );
    virtual GString ReplaceFormat ( const char fmtc, const int val, const char spc = '0' );

};

//======================================================================
//  INLINE FUNCTIONS

/*! The function searches in the string for a format identifier.
 *  It should look like "%X" or "%nX", where \b n is an integer indicating
 *  the format size, and \b X is the identification character.
 *  The function returns the position where the format indication is found,
 *  or string::npos if the format is not present.
 *  \param  fmtc    letter (character) for the format
 *  \param  fmtlen  length of the format (as function output)
 */
inline size_t GString::FindFormat ( const char fmtc, size_t &fmtlen )
  { size_t len; return ( FindFormat (fmtc, fmtlen, len) ); }


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


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