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 #include <regex.h>
  32
  33 #include <string>
  34 #include <vector>
  35 #include <iostream>
  36
  37 #ifndef APT_8_CLEANER_HEADERS
  38 using std::string;
  39 #endif
  40
  41 class Configuration
  42 {
  43    public:
  44
  45    struct Item
  46    {
  47       std::string Value;
  48       std::string Tag;
  49       Item *Parent;
  50       Item *Child;
  51       Item *Next;
  52
  53       std::string FullTag(const Item *Stop = 0) const;
  54
  55       Item() : Parent(0), Child(0), Next(0) {};
  56    };
  57
  58    private:
  59
  60    Item *Root;
  61    bool ToFree;
  62
  63    Item *Lookup(Item *Head,const char *S,unsigned long const &Len,bool const &Create);
  64    Item *Lookup(const char *Name,const bool &Create);
  65    inline const Item *Lookup(const char *Name) const
  66    {
  67       return ((Configuration *)this)->Lookup(Name,false);
  68    }
  69
  70    public:
  71
  72    std::string Find(const char *Name,const char *Default = 0) const;
  73    std::string Find(std::string const &Name,const char *Default = 0) const {return Find(Name.c_str(),Default);};
  74    std::string Find(std::string const &Name, std::string const &Default) const {return Find(Name.c_str(),Default.c_str());};
  75    std::string FindFile(const char *Name,const char *Default = 0) const;
  76    std::string FindDir(const char *Name,const char *Default = 0) const;
  77    /** return a list of child options
  78     *
  79     * Options like Acquire::Languages are handled as lists which
  80     * can be overridden and have a default. For the later two a comma
  81     * separated list of values is supported.
  82     *
  83     * \param Name of the parent node
  84     * \param Default list of values separated by commas */
  85    std::vector<std::string> FindVector(const char *Name, std::string const &Default) const;
  86    std::vector<std::string> FindVector(std::string const &Name, std::string const &Default) const { return FindVector(Name.c_str(), Default); };
  87 #if (APT_PKG_MAJOR >= 4 && APT_PKG_MINOR < 13)
  88    std::vector<std::string> FindVector(const char *Name) const;
  89 #endif
  90    std::vector<std::string> FindVector(std::string const &Name="") const { return FindVector(Name.c_str(), ""); };
  91    int FindI(const char *Name,int const &Default = 0) const;
  92    int FindI(std::string const &Name,int const &Default = 0) const {return FindI(Name.c_str(),Default);};
  93    bool FindB(const char *Name,bool const &Default = false) const;
  94    bool FindB(std::string const &Name,bool const &Default = false) const {return FindB(Name.c_str(),Default);};
  95    std::string FindAny(const char *Name,const char *Default = 0) const;
  96
  97    inline void Set(const std::string &Name,const std::string &Value) {Set(Name.c_str(),Value);};
  98    void CndSet(const char *Name,const std::string &Value);
  99    void CndSet(const char *Name,const int Value);
 100    void Set(const char *Name,const std::string &Value);
 101    void Set(const char *Name,const int &Value);
 102
 103    inline bool Exists(const std::string &Name) const {return Exists(Name.c_str());};
 104    bool Exists(const char *Name) const;
 105    bool ExistsAny(const char *Name) const;
 106
 107    // clear a whole tree
 108    void Clear(const std::string &Name);
 109    void Clear();
 110
 111    // remove a certain value from a list (e.g. the list of "APT::Keep-Fds")
 112    void Clear(std::string const &List, std::string const &Value);
 113    void Clear(std::string const &List, int const &Value);
 114
 115    inline const Item *Tree(const char *Name) const {return Lookup(Name);};
 116
 117    inline void Dump() { Dump(std::clog); };
 118    void Dump(std::ostream& str);
 119    void Dump(std::ostream& str, char const * const root,
 120              char const * const format, bool const emptyValue);
 121
 122    Configuration(const Item *Root);
 123    Configuration();
 124    ~Configuration();
 125
 126    /** \brief match a string against a configurable list of patterns */
 127    class MatchAgainstConfig
 128    {
 129      std::vector<regex_t *> patterns;
 130      void clearPatterns();
 131
 132    public:
 133      MatchAgainstConfig(char const * Config);
 134      virtual ~MatchAgainstConfig();
 135
 136      /** \brief Returns \b true for a string matching one of the patterns */
 137      bool Match(char const * str) const;
 138      bool Match(std::string const &str) const { return Match(str.c_str()); };
 139
 140      /** \brief returns if the matcher setup was successful */
 141      bool wasConstructedSuccessfully() const { return patterns.empty() == false; }
 142    };
 143 };
 144
 145 extern Configuration *_config;
 146
 147 bool ReadConfigFile(Configuration &Conf,const std::string &FName,
 148                     bool const &AsSectional = false,
 149                     unsigned const &Depth = 0);
 150
 151 bool ReadConfigDir(Configuration &Conf,const std::string &Dir,
 152                    bool const &AsSectional = false,
 153                    unsigned const &Depth = 0);
 154
 155 #endif