Mercurial > code

annotate C++/modules/Parser/Parser.h @ 334:0b576ee64d45

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Create brand new hierarchy * Rename DynLib to Dynlib * Remove some warnings
author David Demelier <markand@malikania.fr>
date Sun, 08 Mar 2015 14:26:33 +0100
parents C++/Parser.h@3b0e276f0866
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * Parser.h -- config file parser
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
205
9f22ce5f1b39 Parser: rename getValue, add operator==
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
4 * Copyright (c) 2013, 2014 David Demelier <markand@malikania.fr>
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef _PARSER_H_
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define _PARSER_H_
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include <cstdlib>
180
2bcdee0fe8d4 Update parser
David Demelier <markand@malikania.fr>
parents: 179
diff changeset
23 #include <functional>
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
24 #include <stdexcept>
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 #include <string>
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
26 #include <unordered_map>
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
27 #include <utility>
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 #include <vector>
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
29
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 /**
187
600754c27c88 Update parser to style and remove useless stuff
David Demelier <markand@malikania.fr>
parents: 180
diff changeset
31 * @class Section
600754c27c88 Update parser to style and remove useless stuff
David Demelier <markand@malikania.fr>
parents: 180
diff changeset
32 * @brief The option container
600754c27c88 Update parser to style and remove useless stuff
David Demelier <markand@malikania.fr>
parents: 180
diff changeset
33 *
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 * A list of section found in the file. If root
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 * options are allowed (default behavior), the root
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 * section is "".
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 */
187
600754c27c88 Update parser to style and remove useless stuff
David Demelier <markand@malikania.fr>
parents: 180
diff changeset
38 class Section {
180
2bcdee0fe8d4 Update parser
David Demelier <markand@malikania.fr>
parents: 179
diff changeset
39 public:
209
706f861c4c6d Little cleanup and rename getValue -> getOption
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
40 friend class Parser;
706f861c4c6d Little cleanup and rename getValue -> getOption
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
41
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
42 using Map = std::unordered_map<std::string, std::string>;
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
43
209
706f861c4c6d Little cleanup and rename getValue -> getOption
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
44 template <typename T>
706f861c4c6d Little cleanup and rename getValue -> getOption
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
45 struct Converter {
706f861c4c6d Little cleanup and rename getValue -> getOption
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
46 static const bool supported = false;
706f861c4c6d Little cleanup and rename getValue -> getOption
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
47 };
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
48
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
49 private:
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
50 std::string m_name; /*! name of section */
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
51 Map m_options; /*! list of options inside */
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
52 bool m_allowed; /*! is authorized to push */
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
53
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
54 public:
180
2bcdee0fe8d4 Update parser
David Demelier <markand@malikania.fr>
parents: 179
diff changeset
55 /**
2bcdee0fe8d4 Update parser
David Demelier <markand@malikania.fr>
parents: 179
diff changeset
56 * Default constructor.
2bcdee0fe8d4 Update parser
David Demelier <markand@malikania.fr>
parents: 179
diff changeset
57 */
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 Section();
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
59
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 /**
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
61 * Named constructor.
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 *
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
63 * @param name the section name
209
706f861c4c6d Little cleanup and rename getValue -> getOption
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
64 * @param allowed is allowed to push
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 */
209
706f861c4c6d Little cleanup and rename getValue -> getOption
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
66 Section(const std::string &name, bool allowed = true);
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
67
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 /**
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 * Tells if that section has the specified option name.
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 *
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 * @param name the option name
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 * @return true if has
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 */
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 bool hasOption(const std::string &name) const;
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
75
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 /**
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
77 * Get the section name
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
78 *
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
79 * @return the section name
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
80 */
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
81 const std::string &getName() const;
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
82
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
83 /**
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
84 * Return an iterator to the beginning.
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
85 *
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
86 * @return the iterator.
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
87 */
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
88 Map::iterator begin();
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
89
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
90 /**
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
91 * Return a const iterator to the beginning.
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
92 *
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
93 * @return the iterator.
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
94 */
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
95 Map::const_iterator cbegin() const;
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
96
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
97 /**
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
98 * Return an iterator to the end.
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
99 *
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
100 * @return the iterator.
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
101 */
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
102 Map::iterator end();
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
103
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
104 /**
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
105 * Return a const iterator to the end.
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
106 *
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
107 * @return the iterator.
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
108 */
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
109 Map::const_iterator cend() const;
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
110
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
111 /**
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
112 * Template all functions for retrieving options value.
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
113 *
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
114 * @param name the option name
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
115 * @return the value if found
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
116 */
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 template <typename T>
209
706f861c4c6d Little cleanup and rename getValue -> getOption
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
118 T getOption(const std::string &name) const
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
119 {
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
120 try {
209
706f861c4c6d Little cleanup and rename getValue -> getOption
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
121 return requireOption<T>(name);
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
122 } catch (...) {
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
123 // Catch any conversion error.
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
124 }
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
125
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
126 return T();
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
127 }
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
128
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
129 /**
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
130 * Requires an option, this works like getOption except
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
131 * that if an option is not found, an exception is
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
132 * thrown.
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
133 *
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
134 * @param name the name
180
2bcdee0fe8d4 Update parser
David Demelier <markand@malikania.fr>
parents: 179
diff changeset
135 * @return the value
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
136 * @throw std::out_of_range if not found
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
137 * @throw std::invalid_argument on conversion failures
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
138 */
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
139 template <typename T>
209
706f861c4c6d Little cleanup and rename getValue -> getOption
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
140 T requireOption(const std::string &name) const
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
141 {
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
142 static_assert(Converter<T>::supported, "invalid type requested");
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
143
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
144 return Converter<T>::convert(m_options.at(name));
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
145 }
205
9f22ce5f1b39 Parser: rename getValue, add operator==
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
146
9f22ce5f1b39 Parser: rename getValue, add operator==
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
147 friend bool operator==(const Section &s1, const Section &s2);
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
148 };
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
149
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
150 template <>
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
151 struct Section::Converter<bool> {
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
152 static const bool supported = true;
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
153
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
154 static bool convert(const std::string &value)
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
155 {
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
156 bool result(false);
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
157
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
158 if (value == "yes" || value == "true"|| value == "1")
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
159 result = true;
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
160 else if (value == "no" || value == "false" || value == "0")
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
161 result = false;
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
162
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
163 return result;
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
164 }
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
165 };
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
166
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
167 template <>
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
168 struct Section::Converter<int> {
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
169 static const bool supported = true;
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
170
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
171 static int convert(const std::string &value)
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
172 {
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
173 return std::stoi(value);
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
174 }
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
175 };
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
176
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
177 template <>
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
178 struct Section::Converter<float> {
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
179 static const bool supported = true;
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
180
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
181 static float convert(const std::string &value)
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
182 {
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
183 return std::stof(value);
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
184 }
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
185 };
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
186
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
187 template <>
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
188 struct Section::Converter<double> {
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
189 static const bool supported = true;
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
190
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
191 static double convert(const std::string &value)
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
192 {
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
193 return std::stod(value);
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
194 }
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
195 };
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
196
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
197 template <>
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
198 struct Section::Converter<std::string> {
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
199 static const bool supported = true;
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
200
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
201 static std::string convert(const std::string &value)
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
202 {
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
203 return value;
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
204 }
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
205 };
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
206
187
600754c27c88 Update parser to style and remove useless stuff
David Demelier <markand@malikania.fr>
parents: 180
diff changeset
207 /**
600754c27c88 Update parser to style and remove useless stuff
David Demelier <markand@malikania.fr>
parents: 180
diff changeset
208 * @class Parser
600754c27c88 Update parser to style and remove useless stuff
David Demelier <markand@malikania.fr>
parents: 180
diff changeset
209 * @brief Config file parser
600754c27c88 Update parser to style and remove useless stuff
David Demelier <markand@malikania.fr>
parents: 180
diff changeset
210 *
600754c27c88 Update parser to style and remove useless stuff
David Demelier <markand@malikania.fr>
parents: 180
diff changeset
211 * Open and read .ini files.
600754c27c88 Update parser to style and remove useless stuff
David Demelier <markand@malikania.fr>
parents: 180
diff changeset
212 */
600754c27c88 Update parser to style and remove useless stuff
David Demelier <markand@malikania.fr>
parents: 180
diff changeset
213 class Parser {
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
214 public:
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
215 /**
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
216 * Options available for the parser.
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
217 */
187
600754c27c88 Update parser to style and remove useless stuff
David Demelier <markand@malikania.fr>
parents: 180
diff changeset
218 enum Tuning {
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
219 DisableRootSection = 1, /*! disable options on root */
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
220 DisableRedefinition = 2, /*! disable multiple redefinition */
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
221 DisableVerbosity = 4 /*! be verbose by method */
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
222 };
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
223
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
224 using FindFunc = std::function<void (const Section &)>;
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
225 using List = std::vector<Section>;
180
2bcdee0fe8d4 Update parser
David Demelier <markand@malikania.fr>
parents: 179
diff changeset
226
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
227 private:
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
228 List m_sections; /*! list of sections found */
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
229 std::string m_path; /*! path file */
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
230 int m_tuning; /*! options for parsing */
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
231 char m_commentChar; /*! the comment token default (#) */
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
232
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
233 void addSection(const std::string &name);
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
234 void addOption(const std::string &key, const std::string &value);
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
235
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
236 void readSection(int lineno, const std::string &line);
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
237 void readOption(int lineno, const std::string &line);
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
238
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
239 void readLine(int lineno, const std::string &line);
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
240
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
241 void open();
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
242
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
243 public:
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
244 static const char DEFAULT_COMMENT_CHAR;
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
245
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
246 /**
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
247 * Create a parser at the specified file path. Optional
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
248 * options may be added.
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
249 *
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
250 * @param path the file path
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
251 * @param tuning optional tuning flags
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
252 * @param commentToken an optional comment delimiter
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
253 * @throw std::runtime_error on errors
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
254 * @see Tuning
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
255 */
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
256 Parser(const std::string &path, int tuning = 0, char commentToken = Parser::DEFAULT_COMMENT_CHAR);
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
257
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
258 /**
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
259 * Default constructor.
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
260 */
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
261 Parser();
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
262
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
263 /**
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
264 * Default destructor.
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
265 */
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
266 virtual ~Parser();
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
267
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
268 /**
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
269 * Return an iterator to the beginning.
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
270 *
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
271 * @return the iterator.
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
272 */
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
273 List::iterator begin();
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
274
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
275 /**
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
276 * Return a const iterator to the beginning.
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
277 *
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
278 * @return the iterator.
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
279 */
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
280 List::const_iterator cbegin() const;
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
281
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
282 /**
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
283 * Return an iterator to the end.
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
284 *
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
285 * @return the iterator.
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
286 */
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
287 List::iterator end();
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
288
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
289 /**
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
290 * Return a const iterator to the end.
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
291 *
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
292 * @return the iterator.
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
293 */
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
294 List::const_iterator cend() const;
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
295
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
296 /**
180
2bcdee0fe8d4 Update parser
David Demelier <markand@malikania.fr>
parents: 179
diff changeset
297 * Find all sections matching the name.
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
298 *
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
299 * @param name the sections name
180
2bcdee0fe8d4 Update parser
David Demelier <markand@malikania.fr>
parents: 179
diff changeset
300 * @param func the function
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
301 * @return a list of section with the options
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
302 */
180
2bcdee0fe8d4 Update parser
David Demelier <markand@malikania.fr>
parents: 179
diff changeset
303 void findSections(const std::string &name, FindFunc func) const;
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
304
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
305 /**
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
306 * Tell if a section is existing.
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
307 *
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
308 * @return true if exists
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
309 */
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
310 bool hasSection(const std::string &name) const;
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
311
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
312 /**
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
313 * Get a specified section.
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
314 *
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
315 * @param name the section name
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
316 * @return a section
203
1ffe6d4937b7 Update parser for more convenience and types security #224
David Demelier <markand@malikania.fr>
parents: 187
diff changeset
317 * @throw std::out_of_range if not found
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
318 */
180
2bcdee0fe8d4 Update parser
David Demelier <markand@malikania.fr>
parents: 179
diff changeset
319 const Section &getSection(const std::string &name) const;
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
320
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
321 /**
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
322 * Logging function, used only if DisableVerbosity is not set. The
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
323 * default behavior is to print to stdout something like:
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
324 * line 10: syntax error
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
325 * line 8: missing =
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
326 *
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
327 * @param number the line number
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
328 * @param section the current section worked on
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
329 * @param message the message
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
330 */
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
331 virtual void log(int number, const std::string &section, const std::string &message);
205
9f22ce5f1b39 Parser: rename getValue, add operator==
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
332
9f22ce5f1b39 Parser: rename getValue, add operator==
David Demelier <markand@malikania.fr>
parents: 203
diff changeset
333 friend bool operator==(const Parser &p1, const Parser &p2);
179
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
334 };
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
335
3648e9e6935b Add parser
David Demelier <markand@malikania.fr>
parents:
diff changeset
336 #endif // !_PARSER_H_