]>
Commit | Line | Data |
---|---|---|
6c139d6e AL |
1 | // -*- mode: cpp; mode: fold -*- |
2 | // Description /*{{{*/ | |
584e4558 | 3 | // $Id: configuration.h,v 1.16 2002/11/11 06:55:50 doogie Exp $ |
6c139d6e AL |
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). | |
7f25bdff | 17 | |
6c139d6e AL |
18 | Most things can get by quite happily with, |
19 | cout << _config->Find("Foo::Bar") << endl; | |
7f25bdff AL |
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". | |
6c139d6e AL |
25 | |
26 | ##################################################################### */ | |
27 | /*}}}*/ | |
9c14e3d6 AL |
28 | #ifndef PKGLIB_CONFIGURATION_H |
29 | #define PKGLIB_CONFIGURATION_H | |
6c139d6e | 30 | |
13500573 | 31 | |
6c139d6e AL |
32 | |
33 | #include <string> | |
ff2a211a | 34 | #include <iostream> |
6c139d6e | 35 | |
233b185f AL |
36 | using std::string; |
37 | ||
6c139d6e AL |
38 | class Configuration |
39 | { | |
b2e465d6 AL |
40 | public: |
41 | ||
6c139d6e AL |
42 | struct Item |
43 | { | |
44 | string Value; | |
45 | string Tag; | |
9c14e3d6 | 46 | Item *Parent; |
6c139d6e AL |
47 | Item *Child; |
48 | Item *Next; | |
0a8a80e5 | 49 | |
b2e465d6 | 50 | string FullTag(const Item *Stop = 0) const; |
0a8a80e5 | 51 | |
e72403e1 | 52 | Item() : Parent(0), Child(0), Next(0) {}; |
6c139d6e | 53 | }; |
b2e465d6 AL |
54 | |
55 | private: | |
56 | ||
6c139d6e | 57 | Item *Root; |
b2e465d6 | 58 | bool ToFree; |
6c139d6e AL |
59 | |
60 | Item *Lookup(Item *Head,const char *S,unsigned long Len,bool Create); | |
b2e465d6 AL |
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 | ||
6c139d6e AL |
67 | public: |
68 | ||
b2e465d6 | 69 | string Find(const char *Name,const char *Default = 0) const; |
171c75f1 | 70 | string Find(const string Name,const char *Default = 0) const {return Find(Name.c_str(),Default);}; |
b2e465d6 AL |
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; | |
171c75f1 | 74 | int FindI(const string Name,int Default = 0) const {return FindI(Name.c_str(),Default);}; |
b2e465d6 | 75 | bool FindB(const char *Name,bool Default = false) const; |
171c75f1 | 76 | bool FindB(const string Name,bool Default = false) const {return FindB(Name.c_str(),Default);}; |
b2e465d6 | 77 | string FindAny(const char *Name,const char *Default = 0) const; |
08e8f724 | 78 | |
171c75f1 MV |
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); | |
08e8f724 | 82 | void Set(const char *Name,int Value); |
9c14e3d6 | 83 | |
171c75f1 | 84 | inline bool Exists(const string Name) const {return Exists(Name.c_str());}; |
b2e465d6 AL |
85 | bool Exists(const char *Name) const; |
86 | bool ExistsAny(const char *Name) const; | |
93bf083d | 87 | |
75ef8f14 | 88 | // clear a whole tree |
171c75f1 | 89 | void Clear(const string Name); |
75ef8f14 MV |
90 | |
91 | // remove a certain value from a list (e.g. the list of "APT::Keep-Fds") | |
171c75f1 MV |
92 | void Clear(const string List, string Value); |
93 | void Clear(const string List, int Value); | |
75ef8f14 | 94 | |
b2e465d6 AL |
95 | inline const Item *Tree(const char *Name) const {return Lookup(Name);}; |
96 | ||
584e4558 AL |
97 | inline void Dump() { Dump(std::clog); }; |
98 | void Dump(std::ostream& str); | |
b2e465d6 AL |
99 | |
100 | Configuration(const Item *Root); | |
6c139d6e | 101 | Configuration(); |
b2e465d6 | 102 | ~Configuration(); |
6c139d6e AL |
103 | }; |
104 | ||
105 | extern Configuration *_config; | |
106 | ||
171c75f1 MV |
107 | bool ReadConfigFile(Configuration &Conf,const string &FName, |
108 | bool AsSectional = false, | |
b2e465d6 AL |
109 | unsigned Depth = 0); |
110 | ||
171c75f1 MV |
111 | bool ReadConfigDir(Configuration &Conf,const string &Dir, |
112 | bool AsSectional = false, | |
113 | unsigned Depth = 0); | |
08e8f724 | 114 | |
6c139d6e | 115 | #endif |