apt-pkg/contrib/configuration.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: configuration.h,v 1.11 1999/04/03 00:34:33 jgg 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
  37 class Configuration
  38 {
  39    struct Item
  40    {
  41       string Value;
  42       string Tag;
  43       Item *Parent;
  44       Item *Child;
  45       Item *Next;
  46
  47       string FullTag() const;
  48
  49       Item() : Parent(0), Child(0), Next(0) {};
  50    };
  51    Item *Root;
  52
  53    Item *Lookup(Item *Head,const char *S,unsigned long Len,bool Create);
  54    Item *Lookup(const char *Name,bool Create);
  55
  56    public:
  57
  58    string Find(const char *Name,const char *Default = 0);
  59    string Find(string Name,const char *Default = 0) {return Find(Name.c_str(),Default);};
  60    string FindFile(const char *Name,const char *Default = 0);
  61    string FindDir(const char *Name,const char *Default = 0);
  62    int FindI(const char *Name,int Default = 0);
  63    int FindI(string Name,bool Default = 0) {return FindI(Name.c_str(),Default);};
  64    bool FindB(const char *Name,bool Default = false);
  65    bool FindB(string Name,bool Default = false) {return FindB(Name.c_str(),Default);};
  66
  67    inline void Set(string Name,string Value) {Set(Name.c_str(),Value);};
  68    void Set(const char *Name,string Value);
  69    void Set(const char *Name,int Value);
  70
  71    inline bool Exists(string Name) {return Exists(Name.c_str());};
  72    bool Exists(const char *Name);
  73
  74    inline const Item *Tree(const char *Name) {return Lookup(Name,false);};
  75
  76    void Dump();
  77
  78    Configuration();
  79 };
  80
  81 extern Configuration *_config;
  82
  83 bool ReadConfigFile(Configuration &Conf,string File);
  84
  85 #endif