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
  32
  33 #include <string>
  34 #include <iostream>
  35
  36 using std::string;
  37
  38 class Configuration
  39 {
  40    public:
  41
  42    struct Item
  43    {
  44       string Value;
  45       string Tag;
  46       Item *Parent;
  47       Item *Child;
  48       Item *Next;
  49
  50       string FullTag(const Item *Stop = 0) const;
  51
  52       Item() : Parent(0), Child(0), Next(0) {};
  53    };
  54
  55    private:
  56
  57    Item *Root;
  58    bool ToFree;
  59
  60    Item *Lookup(Item *Head,const char *S,unsigned long Len,bool Create);
  61    Item *Lookup(const char *Name,bool Create);
  62    inline const Item *Lookup(const char *Name) const
  63    {
  64       return ((Configuration *)this)->Lookup(Name,false);
  65    }
  66
  67    public:
  68
  69    string Find(const char *Name,const char *Default = 0) const;
  70    string Find(const string Name,const char *Default = 0) const {return Find(Name.c_str(),Default);};
  71    string FindFile(const char *Name,const char *Default = 0) const;
  72    string FindDir(const char *Name,const char *Default = 0) const;
  73    int FindI(const char *Name,int Default = 0) const;
  74    int FindI(const string Name,int Default = 0) const {return FindI(Name.c_str(),Default);};
  75    bool FindB(const char *Name,bool Default = false) const;
  76    bool FindB(const string Name,bool Default = false) const {return FindB(Name.c_str(),Default);};
  77    string FindAny(const char *Name,const char *Default = 0) const;
  78
  79    inline void Set(const string Name,string Value) {Set(Name.c_str(),Value);};
  80    void CndSet(const char *Name,const string &Value);
  81    void Set(const char *Name,const string &Value);
  82    void Set(const char *Name,int Value);
  83
  84    inline bool Exists(const string Name) const {return Exists(Name.c_str());};
  85    bool Exists(const char *Name) const;
  86    bool ExistsAny(const char *Name) const;
  87
  88    // clear a whole tree
  89    void Clear(const string Name);
  90
  91    // remove a certain value from a list (e.g. the list of "APT::Keep-Fds")
  92    void Clear(const string List, string Value);
  93    void Clear(const string List, int Value);
  94
  95    inline const Item *Tree(const char *Name) const {return Lookup(Name);};
  96
  97    inline void Dump() { Dump(std::clog); };
  98    void Dump(std::ostream& str);
  99
 100    Configuration(const Item *Root);
 101    Configuration();
 102    ~Configuration();
 103 };
 104
 105 extern Configuration *_config;
 106
 107 bool ReadConfigFile(Configuration &Conf,const string &FName,
 108                     bool AsSectional = false,
 109                     unsigned Depth = 0);
 110
 111 bool ReadConfigDir(Configuration &Conf,const string &Dir,
 112                    bool AsSectional = false,
 113                    unsigned Depth = 0);
 114
 115 #endif