2 PowerDNS Versatile Database Driven Nameserver
3 Copyright (C) 2002 PowerDNS.COM BV
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License version 2
7 as published by the Free Software Foundation
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
28 #include "ahuexception.hh"
30 # include <sys/types.h>
37 typedef AhuException ArgException;
39 /** This class helps parsing argc and argv into a map of parameters. We have 3 kinds of formats:
42 -w this leads to a key/value pair of "w"/void
46 --daemon "daemon"/void
48 We do not support "--port 25" syntax.
50 It can also read from a file. This file can contain '#' to delimit comments.
58 R.set("port")="25"; // use this to specify default parameters
59 R.file("./default.conf"); // parse configuration file
61 R.parse(argc, argv); // read the arguments from main()
63 cout<<"Will we be a deamon?: "<<R.isset("daemon")<<endl;
64 cout<<"Our port will be "<<R["port"]<<endl;
66 map<string,string>::const_iterator i;
67 cout<<"via iterator"<<endl;
68 for(i=R.begin();i!=R.end();i++)
69 cout<<i->first<<"="<<i->second<<endl;
79 void parse(int &argc, char **argv, bool lax=false); //!< use this to parse from argc and argv
80 void laxParse(int &argc, char **argv) //!< use this to parse from argc and argv
82 parse(argc,argv,true);
84 void preParse(int &argc, char **argv, const string &arg); //!< use this to preparse a single var
85 bool preParseFile(const char *fname, const string &arg, const string& theDefault=""); //!< use this to preparse a single var in configuration
87 bool file(const char *fname, bool lax=false); //!< Parses a file with parameters
88 bool laxFile(const char *fname)
90 return file(fname,true);
92 typedef map<string,string> param_t; //!< use this if you need to know the content of the map
93 bool parmIsset(const string &var); //!< Checks if a parameter is set to *a* value
94 bool mustDo(const string &var); //!< if a switch is given, if we must do something (--help)
95 int asNum(const string &var); //!< return a variable value as a number
97 mode_t asMode(const string &var); //<!< return value interprepted as octal number
98 uid_t asUid(const string &var); //!< return user id, resolves if necessary
99 gid_t asGid(const string &var); //!< return group id, resolves if necessary
101 double asDouble(const string &var); //!< return a variable value as a number
102 string &set(const string &); //!< Gives a writable reference and allocates space for it
103 string &set(const string &, const string &); //!< Does the same but also allows to specify a help message
104 void setCmd(const string &, const string &); //!< Add a command flag
105 string &setSwitch(const string &, const string &); //!< Add a command flag
106 string helpstring(string prefix=""); //!< generates the --help
107 string configstring(); //!< generates the --mkconfig
108 bool contains(const string &var, const string &val);
109 bool isEmpty(const string &var); //<! checks if variable has value
111 vector<string>list();
112 string getHelp(const string &item);
114 const param_t::const_iterator begin(); //!< iterator semantics
115 const param_t::const_iterator end(); //!< iterator semantics
116 const string &operator[](const string &); //!< iterator semantics
117 const vector<string>&getCommands();
119 void parseOne(const string &unparsed, const string &parseOnly="", bool lax=false);
120 typedef map<string,string> params_t;
122 map<string,string> helpmap;
123 map<string,string> d_typeMap;
124 vector<string> d_cmds;
127 extern ArgvMap &arg();
129 #endif /* ARGUMENTS_HH */