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