4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 /** \mainpage The Configuration and Runtime Control Library
25 The Console library implements a runtime interactive (network) console which allows to
26 configure, control and manipulate a running application in any way. Additionally this library
27 provides support for configuration files and command line parsing which can be used with or
28 without the network console.
33 \section console_intro Introduction
35 There are three parts to the Config/console library:
37 The Config/Console library is built around several components
39 \li The \link node_tree Node tree\endlink represents all configuration options and commands
40 organized in a filesystem like structure.
41 \li \link console_commands Actions\endlink are added to the node tree in the form of command
43 \li There exist several interfaces to \link console_access access\endlink entries in the node
44 tree: interactive console, reading configuration files etc.
46 The node tree works like a directory structure. Commands are entered into this directory
47 structure and can be called passing arbitrary arguments. Configuration parameters are just
48 commands which set their respective parameter, however the library allows commands to do much
52 \section console_example Example
54 The following example shows a \e very short summary on how to integrate the config/console
55 library. See above links for more:
58 #include <senf/Console.hh>
60 // Define callback function.
61 void mycommand(std::ostream & os, int foo, int bar)
64 os << "!! Important message ...\n";
67 namespace kw = senf::console::kw;
69 int main(int argc, char** argv)
71 // Provide global documentation
73 .doc("This is someServer server");
77 .add("mycommand", &mycommand)
78 .doc("If <bar> is given, flurgle the <foo>, otherwise burgle it")
80 .arg(kw::name = "bar", kw::default_value = 0);
82 // Parse command line parameters
83 senf::console::parseOptions(argc,argv);
85 // Start the interactive console server
86 senf::console::Server::start(senf::INet4SocketAddress(senf::INet4Address::None, 23232u))
90 senf::scheduler::process();
94 after this registration, we can call the command from the command-line using
97 $ someServer --mycommand="1 2"
100 the console can be accessed easily via telnet:
103 $ telnet localhost 23232
105 Connected to localhost.
106 Escape character is '^]'
107 xxxx-xx-xx xx:xx:xx.xxxxxx-0000 [NOTICE][senf::console::Server] Registered new client 0xxxxxxx
110 someServer:/# mycommand
111 !! Important message ...
113 xxxx-xx-xx xx:xx:xx.xxxxxx-0000 [NOTICE][senf::console::Server] Disposing client 0xxxxxxx
114 Connection closed by foreign host.
118 \see \ref console_testserver for a complete example application
121 \section intro_usage Using the Console: Configuration files, Network console
122 \seechapter \ref console_access
124 There are several ways to access the node tree:
125 \li By parsing configuration files
126 \li By parsing command line parameters
127 \li By providing interactive or non-interactive network console access
130 \section intro_nodes The node tree
131 \seechapter \ref node_tree
133 The basic idea is, that the console/config library manages a directory structure of parameters
134 and auxiliary commands. Parameters are just commands which set a parameter value so everything
135 is either a directory entry (senf::console::DirectoryNode) or a command
136 (senf::console::CommandNode).
139 \section intro_commands Implementing console/config commands
140 \seechapter \ref console_commands
142 The console/config language does not define, how arguments are passed to the commands, it just
143 tokenizes the input and passes the tokens to the commands which then handle the
146 Since parsing the tokens into something usable is quite tedious and error prone, the library
147 implements automatic argument parsing where the argument tokens are automatically parsed
148 depending on argument types. This enables you to register a command taking an integer argument
149 which will be called with an already parsed integer value (or throw a
150 senf::console::SyntaxErrorException if the conversion fails). This will be the most often used
154 /** \defgroup console_access Accessing the Console/Config tree
156 The Console/Config library provides several ways to use the node tree to configure and control
162 \section console_access_config Configuration support
164 The configuration support of the Console/Config library revolves around the ConfigSource
165 concept. Each ConfigSource will somehow provide commands which will then be executed against the
168 To simplify the usage, there will always be three interfaces to a specific config source:
169 \li A constructor to build a bare config source which is then added to a
170 senf::console::ConfigBundle (see \ref console_access_multiple)
171 \li A class parsing and executing a single config source. The visible interface of this class is
172 a combination of the constructor and the senf::console::ConfigBundle interfaces.
173 \li A helper function which will do the complete parsing of a single source with default
176 When parsing these configuration sources, it is always possible to optionally change the root
177 node used during parsing and it is also possible to restrict parsing to a command subset. See
178 \ref console_access_partial.
181 \subsection console_access_file Configuration files
183 <table class="senf fixedwidth">
184 <tr><td><b>Constructor</b></td> <td>senf::console::FileConfig()</td></tr>
185 <tr><td><b>Class</b></td> <td>senf::console::ConfigFile</td></tr>
186 <tr><td><b>Helper</b></td> <td>senf::console::parseFile()</td></tr>
189 In it's simplest form, parsing a configuration file consists of calling
190 senf::console::parseFile() with the name of the respective config file as argument.
193 senf::console::parseFile("some.conf");
196 To get more flexible, instantiate a senf::console::ConfigFile instance at use that to parse the
200 senf::console::ConfigFile cf ("some.conf");
201 // The following line is optional: Call to ignore mussing files
206 If the application supports other configuration sources besides a single configuration file
207 (like command line options) or if it supports multiple configuration files (e.g. a system-wide
208 and a user specific configuration file) see \ref console_access_multiple and add one (or more)
209 senf::console::FileConfig() source to a senf::console::ConfigBundle.
212 \subsubsection console_access_file_syntax Configuration file syntax
214 Configuration files are written in a simple configuration language. This language is almost
215 declarative (e.g. it does not have any control-flow statements) but is processed imperatively
216 from top to bottom. This is very simple and flexible.
218 Commands are referenced by their path in the node tree. To simplify working with deeply nested
219 directory structures, the current directory may be changed persistently or temporarily for some
224 /logger/targets/console {
225 accept senf::log::Debug IMPORTANT;
226 accept server::ServerLog CRITICAL;
230 \see \ref console_parser
233 \subsection console_access_options Command line options
235 <table class="senf fixedwidth">
236 <tr><td><b>Constructor</b></td> <td>senf::console::OptionsConfig()</td></tr>
237 <tr><td><b>Class</b></td> <td>senf::console::ProgramOptions</td></tr>
238 <tr><td><b>Helper</b></td> <td>senf::console::parseOptions()</td></tr>
241 Command line options can either be parsed by calling the senf::console::parseOptions() helper
244 senf::console::parseOptions(argc, argv)
247 or more flexibly by instantiating a senf::console::ProgramOptions class
250 std::vector<std::string> args;
251 senf::console::ProgramOptions opts (argc, argv);
254 .alias('c', "--mycommand",true)
255 .alias('C', "--mycommand=2 3");
259 This registeres two short options and accumulates all non-option arguments in \c args.
261 If the application supports other configuration sources besides the command line options (like
262 configuration files) see \ref console_access_multiple and add a senf::console::OptionsConfig()
263 source to a senf::console::ConfigBundle.
265 See \ref senf::console::ProgramOptions for the source specific additional parameters. These
266 apply to senf::console::ProgramOptions and to the senf::console::OptionsConfig() source.
269 \subsubsection console_access_options_syntax Options syntax
271 Command line options are primarily parsed as long-options. Long options start with '--'. Further
272 '-' characters serve as directory separators if required (that is, they are \e only interpreted
273 as directory separator is there is no entry in the current (sub-) directory matching more than a
274 single name component). This still allows using hyphens in node names.
276 Options can be abbreviated at each directory boundary: A command <tt>/foo/bar/do</tt> can be
277 called as <tt>--f-b-d</tt> as long as this name is unique.
279 Everything after the first '=' character is parsed into argument tokens using the normal
280 config/console parser. If the option has no '=' character, the list of argument tokens will be
283 <table style="font-size:80%" class="senf">
284 <tr><th>Command</th><th>File syntax</th><th>Option syntax</th></tr>
287 <td><tt>void doo()</tt></td>
288 <td><tt>/path/to/doo;</tt></td>
289 <td><tt>--path-to-doo</tt></td>
293 <td><tt>void doo(std::string const &)</tt></td>
294 <td><tt>/path/to/doo john.doe@everywhere.org;</tt></td>
295 <td><tt>--path-to-doo="john.doe@everywhere.org"</tt></td>
299 <td><tt>void doo(std::string const &)</tt></td>
300 <td><tt>/path/to/doo "some test";</tt></td>
301 <td><tt>--path-to-doo='"some text"'</tt></td>
305 <td><tt>void doo(std::string const &, int)</tt></td>
306 <td><tt>/path/to/doo take 1;</tt></td>
307 <td><tt>--path-to-doo="take 1"</tt></td>
311 The last column is additionally quoted using standard \c sh quoting: quotes in arguments need to
312 be additionally quoted for the shell.
314 Short options are registered as aliases for long options. They can be registered with or without
315 an implied parameter and can optionally take a parameter. so after
319 .alias('c', "--mycommand",true)
320 .alias('C', "--mycommand=2 3");
326 $ program -C -c "4 5"
333 $ program --mycommand="2 3" --mycommand="4 5"
336 (Beware, that the second argument to \c alias() is \e not shell quoted).
339 \subsection console_access_root Changing the root node
341 When used in it's default state, parsing will always interpret all commands relative to the
342 senf::console::root() node and will parse a file completely.
344 The first possibility to control this is to change the root node. This is done by
345 \li passing that root node to the helper class or to the parse helper as an additional argument
346 (see the respective documentation).
347 \li passing it to the senf:;console::ConfigBundle constructor when parsing multiple sources.
352 senf::console::parseFile("/etc/myserver.conf", senf::console::root()['config']);
355 This functionality is even more powerful by combining it with \c link nodes: This allows to
356 selectively choose commands from the node tree which are to be made accessible for
357 configuration. See \ref node_tree.
360 \subsection console_access_partial Partial / incremental configuration
362 Another feature provided by senf::console::ConfigBundle and all helper classes is partial
366 // Create a console/config aware object and place it into the node tree
368 senf::console::root().add("foo", foo.dir);
370 // Open configuration file
371 senf::console::ConfigFile cf ("/etc/myserver.conf");
373 // Parse only commands in the configuration file which are in the foo.dir directory
378 // Anywhere later, parse the rest of the configuration file
382 This feature allows to parse parts of one or more configuration sources before the
383 console/config tree has been fully established. Partial parsing can be applied any number of
384 times to arbitrary nodes. Any command already parsed will be skipped automatically.
386 When combining partial parsing with \c chroot() and \c link's, it is important to realize, that
387 <em>partial parsing always applies to the \e real target and ignores links</em>. This is very
388 important: It allows a subsystem to parse it's configuration parameters irrespective of any
389 links pointing to nodes of that subsystem.
392 \subsection console_access_multiple Multiple sources
394 Most of the time, an application will utilize multiple configuration sources: A global
395 configuration file, maybe a user specific local configuration file, command line options ...
397 When parsing configuration commands, especially using partial / incremental parsing, all parse
398 commands should be applied to each configuration source in turn. This is the responsibility of
399 senf::console::ConfigBundle.
402 senf::console::ScopedDirectory<> config;
403 senf::console::root().add("config", config);
405 // Let's enable all logger commands for configuration
406 config.link("logger", senf::console::root()["logger"]);
408 // Create bundle and add sources
409 std::vector<std::string> args;
410 senf::console::ConfigBundle conf (senf::console::root()["config"]);
411 conf.add( senf::console::FileConfig("/etc/myserver.conf") );
412 conf.add( senf::console::FileConfig(".myserver.conf")->ignoreMissing() );
413 conf.add( senf::console::OptionsConfig(senf::Daemon::instance().argc(),
414 senf::Daemon::instance().argv()) )
416 .alias('c', "--mycommand",true)
417 .alias('C', "--mycommand=2 3");
419 // Parse the logger subsystem commands in '/logger'
420 conf.parse(senf::console::root()['logger']);
424 // Parse all other configuration commands. All necessary commands and links in '/config' must by
425 // now have been created.
429 This example parses three configuration sources: Two configuration files and additional
430 parameters specified on the command line. All the configuration commands are placed into the
431 <tt>/config</tt> directory (directly or via links). The configuration sources are parsed in the
432 order they are specified, so in this case, the command line options will override any options
433 specified in one of the configuration files.
436 \section console_access_console The network console
438 To make the network console accessible, it must be initialized when the program is started:
440 #include <senf/Console.hh>
442 int main(int argc, char * argv [])
444 // Configure console nodes, add commands ...
446 // Start console server
447 senf::console::start(senf::INet4SocketAddress(12345u))
450 // You need to enter the scheduler main-loop for the server to work
451 senf::scheduler::process();
453 // Alternatively enter the main-loop via the PPI
458 This will start the server on IPv4 port 12345. The servers name (as displayed in the interactive
459 console prompt) is set to 'myserver'.
461 After launching the application, the server can be accessed at the given port:
464 bash$ telnet localhost 12345
466 Connected to localhost.
467 Escape character is '^]'.
470 Connection closed by foreign host.
475 It is possible to start multiple server consoles by calling \c start() multiple times with
476 different ports/addresses. Each server can be configured separately (e.g. root node, mode ...).q
479 \subsection console_serverclient Server and Client objects
481 The senf::console::Server and senf::console::Client objects offer further API calls. To access
482 the server instance you need to store away the senf::console::Server reference returned when
483 starting the server so you can later refer to it:
485 int main(int, char**)
487 senf::console::Server & server ( senf::console::start( ... ) );
495 The client instance can be accessed via the \c std::ostream arg of any command callback
497 void someCallback(std::ostream & os, ... )
499 senf::console::Client & client (senf::console::Client::get(os));
501 // Use the client's log target
502 client.route<senf::log::Debug, senf::Log::IMPORTANT>();
507 senf::console::Server for the Server API \n
508 <a href="classsenf_1_1console_1_1Client-members.html">senf::console::Client / List of all
509 members</a> for the Client API
512 \subsection console_shell The interactive console shell
514 The interactive shell will use the GNU readline library for the first connected
515 instance. Further users will not have access to this functionality since GNU readline is
516 completely non-reentrant. GNU readline supports history and some command keys (like C-d for \c
517 exit or C-c to clear and restart the input).
519 The shell supports auto-cd and auto-completion: If you enter the name of a directory at the
520 prompt, the console will change to that directory. With auto-completion, any unique beginning of
521 a path component will be completed automatically and transparently to the corresponding full
525 \subsection console_noninteractive Non-interactive network console
527 After a new connection is established, the console server waits a short time for data to arrive.
528 arrive. Only if nothing happens in the first 500ms, readline is initialized (if available) and
529 the interactive prompt is displayed.
531 By sending data immediately after opening the connection, the console is switched into
532 non-interactive mode. In this mode, no prompt is displayed. In this mode, commands are \e not
533 terminated automatically by end-of-line (CR). This allows, to easily cat an arbitrary
534 configuration file into the network console using netcat:
537 $ nc -q1 localhost 23232 < some.conf
540 The argument <tt>-q1</tt> makes netcat close the sending end of the connection on EOF and wait
541 up to 1 second for the console to terminate. Even better, use \c netcat6, which has full TCP
545 $ echo "ls" | nc6 --half-close localhost 23232 2>/dev/null
552 Commands are executed as soon as the terminating character (';', '{' or '}') is received or when
553 the sending end of the connection is closed.
556 /** \defgroup console_commands Supported command types
558 The Console/config library supports quite a number of different command types. All these types
559 of command are registered, by passing them to DirectoryNode::add()
564 \section console_cmdadd Adding commands and setting attributes
566 Basically, all commands are added using senf::console::DirectoryNode::add(). What exactly
567 happens depends on the type of object added.
569 dir.add("name", callback)
571 will add a command 'name' which will execute 'callback' when called, where 'callback' can be a
572 lot of things as documented in the following chapters.
574 The add call always returns (something which can be used as) a reference to the command node
577 senf::console::CommandNode & node ( dir.add( ... ) );
580 Depending on the object added, you can also bind to a more specific node type
581 (e.g. senf::console::SimpleCommand) if you know the type of node returned.
583 Depending on the type of object added, there are additional attributes which can be set. These
584 attributes are always set by calling them on the return value <b>before saving that value as a
585 node reference</b>. It is \e not guaranteed, you can call these members on the node
588 dir.add("name", callback)
589 .doc("The documentation");
591 sets the \e doc attribute (if that is available, otherwise this will fail to compile). The
592 attribute members return value is again (something which can be used as) a reference to the
595 senf::console::CommandNode & node (
596 dir.add("name", callback)
597 .doc("The documentation") );
601 \section console_manualparse Manually parsing command arguments
603 This is the most primitive type of command. It will be called with an output stream and with a
604 senf::console::ParseCommandInfo reference which holds information about the command parsed.
606 From this information the command callback gets a list of arguments or tokens which then can be
607 interpreted in an arbitrary way.
609 void fun1(std::ostream & os, senf::console::ParseCommandInfo const & command)
611 // Here we declare variables for the arguments
615 // We parse the arguments using the CheckedArgumentIteratorWrapper. This wrapper
616 // will throw a SyntaxErrorException if we access a nonexistent argument or if we
617 // do not parse all arguments.
618 senf::console::CheckedArgumentIteratorWrapper args (command.arguments());
620 senf::console::ParseCommandInfo::TokensRange argTokens ( *(args++) );
621 if (arg1Tokens.size() != 1)
622 raise senf::console::SyntaxErrorException("argument syntax error");
623 value = arg1Tokens[0];
626 os << value << std::endl;
630 Registering this callback is done by simply adding it. To provide online help, pass it to
633 senf::console::root()
638 "Echo 'arg' to the console");
641 The callback may now be called interactively on the console by it's registered name:
645 invalid number of arguments
646 server:/$ test1 stefan@j32.de
648 server:/$ test1 (echo me)
649 argument syntax error
654 Echo 'arg' to the console
659 As you can see above, the arguments and tokens are returned as <a
660 href="http://www.boost.org/doc/libs/1_33_1/libs/range/doc/utility_class.html#iter_range">
661 boost::iterator_range</a> instances. These behave much like containers: They have \c begin() and
662 \c end() and some other useful members.
664 The parser will have divided the argument tokens into arguments already. This simplifies further
665 parsing. If however you want to access the list of argument tokens as a single list, you can do
666 so using senf::console::ParseCommandInfo::tokens().
668 Parsing arguments is quite simple but can get very tedious. To simplify this task, the parsing
669 can be delegated to the Console/config library. See the next section.
671 This type of command has only a single attribute, \e doc to set the commands documentation.
674 \section console_autoparse Automatic argument parsing
676 To greatly simplify parsing complex commands, we turn to automatic argument parsing.
679 \subsection console_autoadd Adding
681 Automatically parsed commands are registered by just adding a callback which has the correct
682 arguments and return-value defined:
684 std::string fun2(std::string const & arg)
690 This extremely simple callback may be registered by adding it to a senf::console::DirectoryNode.
692 senf::console::root()
693 .add("test2", &fun2);
695 The functionality is now identical to \c test1:
699 invalid number of arguments
700 server:/$ test2 stefan@j32.de
702 server:/$ test2 (echo me)
703 argument syntax error
712 \subsection command_ostream Accessing the console stream
714 Commands may have an optional first argument of type <tt>std::ostream &</tt>. This argument is
715 not considered part of the real interface. When the command is executed, the callback will be
716 passed the current consoles output stream object in this argument. With this, the callback can
717 output arbitrary messages to the network console.
719 void fun3(std::ostream & os, unsigned n, std::string text)
721 while (n-- > 0) os << text << std::endl;
724 senf::console::root()
725 .add("test3", &fun3);
728 This simple command can now be used thus:
732 invalid number of arguments
733 server:/$ test3 stefan@j32.de
734 invalid number of arguments
740 test3 arg11:int arg12:string
746 \subsection command_overload Overloading
748 Automatically parsed commands can be overloaded: You can register multiple commands under the
749 same name. Each overload is tried in turn until no SyntaxErrorException is raised.
751 senf::console::root()
752 .add("test4", &fun3);
753 senf::console::root()
754 .add("test4", &fun2);
756 And now, we can call \c test4 with one or two args:
759 invalid number of arguments
760 server:/$ test4 stefan@j32.de
767 1- test4 arg11:int arg12:string
768 2- test4 arg21:string
772 One note: When taking the address of an overloaded function (member or non-member), the C++
773 language forces you to cast that address to one of the possible types so the compiler knows,
774 which overload is requested. So to add a function which is overloaded in C++, each overload
775 needs to be added explicitly, casting to the correct type:
780 senf::console::root()
781 .add("over", static_cast<void (*)(int)>(&over));
782 senf::console::root()
783 .add("over", static_cast<void (*)(int,int)>(&over));
787 \subsection console_attributes Attributes
789 As have seen so far, some documentation is automatically provided. We can add more info, by
790 setting additional attributes.
792 senf::console::root()
794 .doc("Echo text to the console")
795 .overloadDoc("Repeat {arg12} for {arg11} lines");
796 senf::console::root()
798 .overloadDoc("Echo the {arg21} argument")
801 This additional info is used to provide more documentation:
806 1- test5 arg11:int arg12:string
807 2- test5 arg21:string
809 Echo text to the console
812 Repeat {arg12} for {arg11} lines
815 Echo the {arg21} argument
821 \subsection console_argattributes Argument attributes
823 Additional attributes can be set for each parameter. They are all passed to the
824 senf::console::ParsedArgumentAttributor::arg() attribute.
827 namespace kw = senf::console::kw;
829 senf::console::root()
831 .doc("Echo text to the console")
832 .overloadDoc("Repeat {text} for {n} lines");
833 .arg( kw::name = "n", kw::description="Number of repetitions" )
834 .arg( kw::name = "text", kw::description="Text to output" );
835 senf::console::root()
837 .overloadDoc("Echo the {text} argument")
838 .arg( kw::name = "text" );
841 (Sadly, there is no way to automatically find out the \e name of an argument, just it's type.)
842 Every callback argument corresponds with a call of the \c arg() attribute. Argument attributes
843 are set using keywords from the \ref senf::console::kw namespace. You will probably either use
844 this namespace via a namespace alias (as above) or via a <tt>using namespace
845 senf::console::kw</tt> declaration (but beware of name collisions).
847 You don't need to specify any information for an argument: To skip an argument, just call \c
848 arg() without attributes for this argument.
850 After adding this information, the online help is much more readable
855 1- test6 n:int text:string
859 n Number of repetitions
862 Echo text to the console
865 Repeat {text} for {n} lines
868 Echo the {text} argument
873 Since most of the time, we only need to set the name and possibly a description for arguments,
874 there is a shortcut: name and description can be specified as positional arguments in this
875 order. So the following will give the exactly same result as above:
877 namespace kw = senf::console::kw;
879 senf::console::root()
881 .doc("Echo text to the console")
882 .overloadDoc("Repeat <text> for <n> lines");
883 .arg("n", "Number of repetitions")
884 .arg("text", "Text to output");
885 senf::console::root()
887 .overloadDoc("Echo the <text> argument")
891 Keyword arguments should always be used if additional attributes are set. You can however mix
892 positional and keyword arguments.
895 \subsection console_defaults Default values
897 Another information which can not be automatically gathered from the type system is default
898 values. These have to be declared explicitly:
900 namespace kw = senf::console::kw;
902 senf::console::root()
904 .doc("Echo {text} to the console, repeating {text} for {n} lines")
905 .arg("n", "Number of repetitions", kw::default_value=1)
906 .arg("text", "Text to output");
909 Default values can be used together with overloading. Default (optional) value support is quite
910 flexible, it is not mandatory, for default values to be specified only for the trailing
911 arguments. For the exact definition, how parsed argument values are assigned to overload
912 arguments in the presence of default values, see \ref senf::console::kw::default_value.
925 test4 [n:unsigned] text:string
928 n Number of repetitions
932 Echo {text} to the console, repeating {text} for {n} lines
938 \subsection console_boostfn Non-function-pointer commands
940 It is possible to add other callable objects besides function (and member-function)
941 pointers. However, since it is not possible to automatically deduce the argument and return
942 types in this case, the callables have to be wrapped in a \c boost::function object:
945 senf::console::root()
947 boost::function<void (std::ostream &, std::string const &)>(
948 boost::bind(&fun3, _1, 4u, _2)));
951 This works with any callable object where argument types cannot be deduced automatically:
952 Boost.Bind expressions, Boost.Lambda expressions, functors and so on.
969 \subsection console_attr_summary Attribute summary
971 Here a summary of the most common attributes
973 <table class="senf fixedwidth">
975 <tr><td style="width:14em">\link senf::console::ParsedArgumentAttributorBase::doc() .doc\endlink
976 ( \e doc )</td><td>Set documentation for all overloads</td></tr>
978 <tr><td>\link senf::console::ParsedArgumentAttributorBase::overloadDoc()
979 .overloadDoc\endlink ( \e doc )</td><td>Set documentation for a specific overload</td></tr>
981 <tr><td>\link senf::console::ParsedArgumentAttributor::arg() .arg\endlink ( \e argument \e
982 attributes )</td><td>Set argument attributes (see below)</td></tr>
986 The most important argument attributes (all defined in the senf::console::kw namespace) are:
988 <table class="senf fixed width">
990 <tr><td style="width:14em">\link senf::console::kw::name kw::name\endlink</td><td>Parameter
993 <tr><td>\link senf::console::kw::description kw::description\endlink</td><td>One-line
994 description of the argument</td></tr>
996 <tr><td>\link senf::console::kw::default_value kw::default_value\endlink</td><td>Arguments
997 default value</td></tr>
1002 href="classsenf_1_1console_1_1ParsedArgumentAttributor-members.html">senf::console::ParsedArgumentAttributor
1003 / List of all members</a> for the complete attribute interface \n
1004 \ref senf::console::kw for a list of all argument attribute keywords
1007 \section console_memberfn Member functions
1009 Non-static member functions are supported like non-member functions (static member functions are
1010 identical to non-members). They must however be added through a senf::console::ScopedDirectory
1011 instance to bind them to their instance.
1016 senf::console::ScopedDirectory<Test1> dir;
1018 Test1(std::string label) : dir(this), label_ (label)
1019 { dir.add("test", &Test::test1);
1020 dir.add("test", &Test::test2); }
1022 std::string test1(std::string const & text)
1023 { return label_ + ": " + text; }
1025 void test2(std::ostream & os, unsigned n, std::string const & text)
1026 { while (n-- > 0) os << label << ": " << text << std::endl; }
1034 Test1 test1ob ("test");
1035 senf::console::root().add("test1ob", test1ob.dir);
1038 Binding via senf::console::ScopedDirectory ensures, that the commands are automatically removed
1039 from the tree when the object is destroyed.
1042 \section console_variables Variables
1044 \subsection console_varadd Adding
1046 The console/config library supports the direct registration of variables as commands. A
1047 variable command consists of two overloads, one to query the current value and one to change the
1053 senf::console::ScopedDirectory<Test2> dir;
1055 Test2() : dir(this), var_(0)
1056 { dir.add("var", var_); }
1063 senf::console::root().add("test2ob", test2ob.dir);
1065 This shows the most common scenario: A member variable is added to a ScopedDirectory of the same
1066 class. This ensures, that the variable command node is removed from the tree when the instance
1067 (and thereby the variable) are destroyed. The variable can now be used like any other command:
1070 server:/$ test2ob/var
1072 server:/$ test2ob/var 10
1073 server:/$ test2ob/var
1075 server:/$ help test2ob
1077 1- var new_value:int
1084 \subsection console_varro Read-only variables
1086 The library also supports read-only variables. To make a variable read-only, just wrap it in \c
1087 boost::cref() (where \c cref stands for \c const reference)
1091 senf::console::root().add("var1", boost::cref(var));
1093 A read-only variable only has a single overload:
1106 \subsection console_varattr Attributes
1108 The most important Variable command attributes are
1110 <table class="senf fixedwidth">
1112 <tr><td style="width:14em">\link senf::console::VariableAttributor::doc() .doc\endlink
1113 ( \e doc )</td><td>Set variable documentation</td></tr>
1115 <tr><td>\link senf::console::VariableAttributor::onChange() .onChange\endlink
1116 ( \e handler )</td><td>Set change handler</td></tr>
1120 \see senf::console::VariableAttributor for the complete attribute interface
1123 \subsection console_varchange Change notification
1125 A \e handler can be set to be called, whenever the variable is changed. It will be called with a
1126 reference to the old value. The handler is called, after the value has been changed
1131 // Since this is int, it would make sense to declare the argument pass-by-value (int old)
1132 // but for more complex args, use a const & here
1133 void varChanged(int const & old)
1138 senf::console::root().add("var2",var)
1139 .onChange(&varChanged);
1142 After this setup, \c varChanged will be called, whenever the value has changed.
1145 \section console_args Special argument types
1147 By default, argument types which can be read and written using \c iostreams are automatically
1148 supported. Other types need to be registered explicitly
1151 \subsection console_args_bool Boolean arguments and return values
1153 The console library by default formats boolean values using the strings \c true and \c false for
1154 their representation. When parsing a boolean value, most sensible representations will be
1157 <table class="senf">
1158 <tr><td>\c true</td> <td>\c false</td> <td>\ref senf::console::formatTrueFalse</td></tr>
1159 <tr><td>\c on</td> <td>\c off</td> <td>\ref senf::console::formatOnOff</td></tr>
1160 <tr><td>\c enabled</td> <td>\c disabled</td> <td>\ref senf::console::formatEnabledDisabled</td></tr>
1161 <tr><td>\c yes</td> <td>\c no</td> <td>\ref senf::console::formatYesNo</td></tr>
1162 <tr><td><em>non-zero integer</em></td><td>\c 0</td><td>\ref senf::console::formatOneZero</td></tr>
1165 The boolean parser will accept these values in any (mixed) case and accepts any unique initial
1166 substring (e.g. \c Y / \c N).
1168 The last column lists explicit formatters which can be set to customize the return value
1169 formatting of a registered overload accordingly.
1172 \subsection console_args_enum Registering enum types
1174 Enum types are a special case, since it is not possible, to find a string representation for the
1175 enumerator values automatically. Therefore, enum types need to be registered manually.
1177 enum MyEnum { Sit, Run, Jump };
1178 SENF_CONSOLE_REGISTER_ENUM( MyEnum, (Sit)(Run)(Jump) );
1180 MyEnum fun4(MyEnum v) { return v }
1182 senf::console::root()
1183 .add("test9", &fun4);
1186 After an enum type is registered, it can be used like any other type for arguments or
1193 server:/$ test9 Crawl
1194 argument syntax error: invalid enum value
1195 server:/$ help test9
1202 \ref SENF_CONSOLE_REGISTER_ENUM() can only be used, to register enums at namespace scope. To
1203 register enums defined within some class, use \ref SENF_CONSOLE_REGISTER_ENUM_MEMBER()
1209 enum Color { Red, Green, Blue };
1211 senf::console::ScopedDirectory<MyClass> dir;
1215 Color mem3(Color c) { return c }
1217 SENF_CONSOLE_REGISTER_ENUM_MEMBER( Test3, Color, (Red)(Green)(Blue) );
1219 Test3::Test3() : dir(this)
1220 { dir.add("test", &MyClass::mem3); }
1223 senf::console::root().add("test3ob", test3ob.dir);
1226 Using this command/type is identical
1229 server:/$ test3ob/test Red
1231 server:/$ test3ob/test White
1232 argument syntax error: invalid enum value
1233 server:/$ help test3ob/test
1240 \subsection console_args_custom Extending the library to support additional types
1242 To support or customize parsing/formatting of other types, they need to be registered. In it's
1243 simplest case, this works, by just providing an appropriate overload for
1244 senf_console_parse_argument() and senf_console_format_value():
1248 Coordinate() : x(0), y(0) {}
1249 Coordinate(int x_, int y_) : x(x_), y(y_) {}
1254 void senf_console_parse_argument(senf::console::ParseCommandInfo::TokensRange const & tokens,
1257 senf::console::CheckedArgumentIteratorWrapper arg (tokens);
1258 senf::console::parse( *(arg++), out.x );
1259 senf::console::parse( *(arg++), out.y );
1262 void senf_console_format_value(Coordinate const & value, std::ostream & os)
1264 os << '(' << value.x << ' ' << value.y << ')';
1268 The parser will accept an argument with two tokens which are each forwarded to the integer
1269 parser. The senf::console::CheckedArgumentIteratorWrapper ensures two things: That all input
1270 tokens are parsed and no extra trailing tokens are left unparsed and it checks, that all
1271 referenced tokens really exist.
1273 The formatter writes out the value as a parenthesized pair.
1276 Coordinate fun5(Coordinate const & p) { return Coordinate(2*p.x, 2*p.y) }
1278 namespace kw = senf::console::kw;
1280 senf::console::root()
1281 .add("test10", &fun5)
1282 .arg("x","coordinate to double",
1283 kw::default_value = Coordinate())
1285 We can now call \c test10 with a coordinate argument:
1288 server:/$ test10 (2 7)
1290 server:/$ help test10
1292 test10 [x:Coordinate]
1295 x Coordinate to double
1301 If you want to customize the formatting of default values differently from the formating of
1302 return-values or if you want to change the displayed name of a type, you will need to specialize
1303 the senf::console::ArgumentTraits class instead of implementing
1304 senf_console_parse_argument(). See senf::console::ArgumentTraits and
1305 senf::console::ReturnValueTraits for more.
1312 // comment-column: 40
1313 // c-file-style: "senf"
1314 // indent-tabs-mode: nil
1315 // ispell-local-dictionary: "american"
1316 // compile-command: "scons -u test"