apt-pkg/contrib/configuration.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: configuration.h,v 1.16 2002/11/11 06:55:50 doogie Exp $
   4 /* ######################################################################
   5
   6    Configuration Class
   7
   8    This class provides a configuration file and command line parser
   9    for a tree-oriented configuration environment. All runtime configuration
  10    is stored in here.
  11
  12    Each configuration name is given as a fully scoped string such as
  13      Foo::Bar
  14    And has associated with it a text string. The Configuration class only
  15    provides storage and lookup for this tree, other classes provide
  16    configuration file formats (and parsers/emitters if needed).
  17
  18    Most things can get by quite happily with,
  19      cout << _config->Find("Foo::Bar") << endl;
  20
  21    A special extension, support for ordered lists is provided by using the
  22    special syntax, "block::list::" the trailing :: designates the
  23    item as a list. To access the list you must use the tree function on
  24    "block::list".
  25
  26    ##################################################################### */
  27                                                                         /*}}}*/
  28 #ifndef PKGLIB_CONFIGURATION_H
  29 #define PKGLIB_CONFIGURATION_H
  30
  31 #ifdef __GNUG__
  32 #pragma interface "apt-pkg/configuration.h"
  33 #endif
  34
  35 #include <string>
  36 #include <iostream>
  37
  38 using std::string;
  39
  40 class Configuration
  41 {
  42    public:
  43
  44    struct Item
  45    {
  46       string Value;
  47       string Tag;
  48       Item *Parent;
  49       Item *Child;
  50       Item *Next;
  51
  52       string FullTag(const Item *Stop = 0) const;
  53
  54       Item() : Parent(0), Child(0), Next(0) {};
  55    };
  56
  57    private:
  58
  59    Item *Root;
  60    bool ToFree;
  61
  62    Item *Lookup(Item *Head,const char *S,unsigned long Len,bool Create);
  63    Item *Lookup(const char *Name,bool Create);
  64    inline const Item *Lookup(const char *Name) const
  65    {
  66       return ((Configuration *)this)->Lookup(Name,false);
  67    }
  68
  69    public:
  70
  71    string Find(const char *Name,const char *Default = 0) const;
  72    string Find(const string Name,const char *Default = 0) const {return Find(Name.c_str(),Default);};
  73    string FindFile(const char *Name,const char *Default = 0) const;
  74    string FindDir(const char *Name,const char *Default = 0) const;
  75    int FindI(const char *Name,int Default = 0) const;
  76    int FindI(const string Name,int Default = 0) const {return FindI(Name.c_str(),Default);};
  77    bool FindB(const char *Name,bool Default = false) const;
  78    bool FindB(const string Name,bool Default = false) const {return FindB(Name.c_str(),Default);};
  79    string FindAny(const char *Name,const char *Default = 0) const;
  80
  81    inline void Set(const string Name,string Value) {Set(Name.c_str(),Value);};
  82    void CndSet(const char *Name,const string &Value);
  83    void Set(const char *Name,const string &Value);
  84    void Set(const char *Name,int Value);
  85
  86    inline bool Exists(const string Name) const {return Exists(Name.c_str());};
  87    bool Exists(const char *Name) const;
  88    bool ExistsAny(const char *Name) const;
  89
  90    // clear a whole tree
  91    void Clear(const string Name);
  92
  93    // remove a certain value from a list (e.g. the list of "APT::Keep-Fds")
  94    void Clear(const string List, string Value);
  95    void Clear(const string List, int Value);
  96
  97    inline const Item *Tree(const char *Name) const {return Lookup(Name);};
  98
  99    inline void Dump() { Dump(std::clog); };
 100    void Dump(std::ostream& str);
 101
 102    Configuration(const Item *Root);
 103    Configuration();
 104    ~Configuration();
 105 };
 106
 107 extern Configuration *_config;
 108
 109 bool ReadConfigFile(Configuration &Conf,const string &FName,
 110                     bool AsSectional = false,
 111                     unsigned Depth = 0);
 112
 113 bool ReadConfigDir(Configuration &Conf,const string &Dir,
 114                    bool AsSectional = false,
 115                    unsigned Depth = 0);
 116
 117 #endif