1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
/*
* This file is part of PowerDNS or dnsdist.
* Copyright -- PowerDNS.COM B.V. and its contributors
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of version 2 of the GNU General Public License as
* published by the Free Software Foundation.
*
* In addition, for the avoidance of any doubt, permission is granted to
* link this program with OpenSSL and to (re)distribute the binaries
* produced as the result of such linking.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#pragma once
#include <map>
#include <set>
#include <string>
#include <vector>
#include <fstream>
#include <iostream>
#include "misc.hh"
#include "pdnsexception.hh"
#include <sys/types.h>
#include <pwd.h>
#include <grp.h>
#include "namespaces.hh"
#include "logging.hh"
using ArgException = PDNSException;
/** This class helps parsing argc and argv into a map of parameters. We have 3 kinds of formats:
-w this leads to a key/value pair of "w"/void
--port=25 "port"/"25"
--daemon "daemon"/void
We do not support "--port 25" syntax.
It can also read from a file. This file can contain '#' to delimit comments.
Some sample code:
\code
ArgvMap R;
R.set("port")="25"; // use this to specify default parameters
R.file("./default.conf"); // parse configuration file
R.parse(argc, argv); // read the arguments from main()
cout<<"Will we be a daemon?: "<<R.isset("daemon")<<endl;
cout<<"Our port will be "<<R["port"]<<endl;
map<string,string>::const_iterator i;
cout<<"via iterator"<<endl;
for(i=R.begin();i!=R.end();i++)
cout<<i->first<<"="<<i->second<<endl;
\endcode
*/
class ArgvMap
{
public:
ArgvMap();
void parse(int& argc, char** argv, bool lax = false); //!< use this to parse from argc and argv
void laxParse(int& argc, char** argv) //!< use this to parse from argc and argv
{
parse(argc, argv, true);
}
void preParse(int& argc, char** argv, const string& arg); //!< use this to preparse a single var
bool preParseFile(const string& fname, const string& arg, const string& theDefault = ""); //!< use this to preparse a single var in configuration
bool file(const string& fname, bool lax = false); //!< Parses a file with parameters
bool file(const string& fname, bool lax, bool included);
bool laxFile(const string& fname)
{
return file(fname, true);
}
bool parseFile(const string& fname, const string& arg, bool lax); //<! parse one line
bool parmIsset(const string& var); //!< Checks if a parameter is set to *a* value
bool mustDo(const string& var); //!< if a switch is given, if we must do something (--help)
int asNum(const string& arg, int def = 0); //!< return a variable value as a number or the default if the variable is empty
mode_t asMode(const string& arg); //!< return value interpreted as octal number
uid_t asUid(const string& arg); //!< return user id, resolves if necessary
gid_t asGid(const string& arg); //!< return group id, resolves if necessary
double asDouble(const string& arg); //!< return a variable value as a number
string& set(const string&); //!< Gives a writable reference and allocates space for it
string& set(const string&, const string&); //!< Does the same but also allows one to specify a help message
void setCmd(const string&, const string&); //!< Add a command flag
string& setSwitch(const string&, const string&); //!< Add a switch flag
string helpstring(string prefix = ""); //!< generates the --help
string configstring(bool running, bool full); //!< generates the --config
bool contains(const string& var, const string& val);
bool isEmpty(const string& arg); //!< checks if variable has value
void setDefault(const string& var, const string& value);
void setDefaults();
vector<string> list();
[[nodiscard]] string getHelp(const string& item) const
{
auto iter = helpmap.find(item);
return iter == helpmap.end() ? "" : iter->second;
}
[[nodiscard]] string getDefault(const string& item) const
{
auto iter = defaultmap.find(item);
return iter == defaultmap.end() ? "" : iter->second;
}
using param_t = map<string, string>; //!< use this if you need to know the content of the map
param_t::const_iterator begin(); //!< iterator semantics
param_t::const_iterator end(); //!< iterator semantics
const string& operator[](const string&); //!< iterator semantics
const vector<string>& getCommands();
void gatherIncludes(const std::string& dir, const std::string& suffix, std::vector<std::string>& extraConfigs);
void warnIfDeprecated(const string& var) const;
[[nodiscard]] static string isDeprecated(const string& var);
#ifdef RECURSOR
void setSLog(Logr::log_t log)
{
d_log = log;
}
#endif
private:
void parseOne(const string& arg, const string& parseOnly = "", bool lax = false);
static string formatOne(bool running, bool full, const string& var, const string& help, const string& theDefault, const string& current);
map<string, string> d_params;
map<string, string> d_unknownParams;
map<string, string> helpmap;
map<string, string> defaultmap;
map<string, string> d_typeMap;
vector<string> d_cmds;
std::set<string> d_cleared;
#ifdef RECURSOR
std::shared_ptr<Logr::Logger> d_log;
#endif
};
extern ArgvMap& arg();
|
