src/external/3rd/library/perforce/include/strdict.h

   1 /*
   2  * Copyright 1995, 1996 Perforce Software.  All rights reserved.
   3  *
   4  * This file is part of Perforce - the FAST SCM System.
   5  */
   6
   7 /*
   8  * StrDict.h - a set/get dictionary interface
   9  *
  10  * Classes:
  11  *
  12  *      StrDict - a GetVar/PutVar dictionary interface
  13  *
  14  * Methods:
  15  *
  16  */
  17
  18 class Error;
  19
  20 class StrVarName : public StrRef {
  21
  22     public:
  23                 StrVarName( const char *buf, int length )
  24                 {
  25                     memcpy( varName, buf, length );
  26                     varName[ length ] = 0;
  27                     Set( varName, length );
  28                 }
  29
  30                 StrVarName( const StrPtr &name, int x );
  31                 StrVarName( const StrPtr &name, int x, int y );
  32
  33     private:
  34                 char varName[64];
  35 } ;
  36
  37 class StrDict {
  38
  39     public:
  40
  41         virtual ~StrDict();
  42
  43         // Handy wrappers
  44
  45         void    SetVar( const char *var );
  46         void    SetVar( const char *var, int value );
  47         void    SetVar( const char *var, const char *value );
  48         void    SetVar( const char *var, const StrPtr *value );
  49         void    SetVar( const char *var, const StrPtr &value );
  50         void    SetVar( const StrPtr &var, const StrPtr &value )
  51                 { VSetVar( var, value ); }
  52
  53         void    SetVarV( const char *arg );
  54         void    SetArgv( int argc, char *const *argv );
  55         void    SetVar( const StrPtr &var, int x, const StrPtr &val );
  56         void    SetVar( const char *var, int x, const StrPtr &val );
  57         void    SetVar( const char *var, int x, int y, const StrPtr &val );
  58
  59         StrPtr *GetVar( const char *var );
  60         StrPtr *GetVar( const char *var, Error *e );
  61         StrPtr *GetVar( const StrPtr &var, int x );
  62         StrPtr *GetVar( const StrPtr &var, int x, int y );
  63         StrPtr *GetVar( const StrPtr &var )
  64                 { return VGetVar( var ); }
  65
  66         int     GetVar( int x, StrRef &var, StrRef &val )
  67                 { return VGetVarX( x, var, val ); }
  68
  69         void    ReplaceVar( const char *var, const char *value );
  70         void    RemoveVar( const char *var );
  71
  72         int     Save( FILE * out );
  73         int     Load( FILE * out );
  74
  75     protected:
  76
  77         // Get/Set vars, provided by subclass
  78
  79         virtual StrPtr *VGetVar( const StrPtr &var ) = 0;
  80         virtual void    VSetVar( const StrPtr &var, const StrPtr &val );
  81         virtual void    VRemoveVar( const StrPtr &var );
  82         virtual int     VGetVarX( int x, StrRef &var, StrRef &val );
  83         virtual void    VSetError( const StrPtr &var, Error *e );
  84
  85 } ;