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.
24 \brief ParsedCommand public header */
26 #ifndef HH_ParsedCommand_
27 #define HH_ParsedCommand_ 1
31 #define BOOST_PARAMETER_MAX_ARITY 6
34 #include <boost/type_traits/function_traits.hpp>
35 #include <boost/type_traits/is_member_pointer.hpp>
36 #include <boost/mpl/if.hpp>
37 #include <boost/utility.hpp>
38 #include <boost/parameter/keyword.hpp>
39 #include <boost/parameter/parameters.hpp>
40 #include "../config.hh"
41 #include "OverloadedCommand.hh"
43 #include "../Utils/type_traits.hh"
45 #include "ParsedCommand.ih"
46 #include "ParsedCommand.mpp"
47 ///////////////////////////////hh.p////////////////////////////////////////
52 namespace detail { class ArgumentInfoBase; }
54 /** \brief CommandOverload implementation with automatic argument parsing
56 ParsedCommandOverloadBase implements a CommandOverload implementation supporting automatic
57 parsing of arguments. This is \e not a node, it's a CommandOverload which is then added to
58 an OverloadedCommandNode instance.
60 Automatic argument parsing and return value processing consists of several components:
61 \li \ref overload_add Adding overload instances to the tree
62 \li (Advanced) \ref overload_parse
63 \li (Advanced) \ref overload_format
65 \section overload_add Adding argument parsing callbacks to the tree
67 Adding appropriate callbacks to the tree is very simple: just path a function pointer to
68 DirectoryNode::add() or a member function pointer to ScopedDirectory::add().
70 std::string taskStatus(int id);
72 senf::console::root().add("taskStatus", &taskStatus);
75 There are quite a number of additional parameters available to be set. These parameters are
76 documented in ParsedArgumentAttributor. Parameters are set by adding them as additional
77 calls after adding the node:
80 senf::console::root().add("taskStatus", &taskStatus)
81 .doc("Query the current task status")
83 description = "numeric id of task to check, -1 for the current task."
87 You may also add an additional \c std::ostream & Argument as first argument to the
88 callback. If this argument is present, the stream connected to the console which issued the
89 command will be passed there. This allows writing arbitrary messages to the console.
91 Additionally, overloading is supported by registering multiple commands under the same
92 name. So, elaborating on above example:
94 std::string taskStatus(int id);
95 std::string taskStatus(std::string const & name);
98 .add("taskStatus", static_cast<std::string (*)(int)>(&taskStatus))
99 .doc("Query the current task status")
100 .overloadDoc("Query status by id")
102 description = "numeric id of task to check, -1 for the current task."
103 default_value = -1 );
104 senf::console::root()
105 .add("taskStatus", static_cast<std::string (*)(std::string const &)>(&taskStatus))
106 .overloadDoc("Query status by name")
108 description = "name of task to check" );
111 We can see here, that taking the address of an overloaded function requires a cast. If you
112 can give unique names to each of the C++ overloads (not the overloads in the console), you
113 should do so to make the unwieldy casts unnecessary.
115 \section overload_parse Custom parameter parsers
117 By default, parameters are parsed using \c boost::lexical_cast and therefore using \c
118 iostreams. This means, that any type which can be read from a stream can automatically be
119 used as argument type.
121 However, argument parsing can be configured by specializing
122 senf::console::ArgumentTraits. See that class for more information.
124 \section overload_format Custom return-value formatters
126 By default, return values are streamed to an ostream. This automatically allows any
127 streamable type to be used as return value. To add new types or customize the formating, the
128 senf::console::ReturnValueTraits template needs to be specialized for that type. See
129 that class for more information.
131 \ingroup console_commands
133 class ParsedCommandOverloadBase
134 : public CommandOverload
137 typedef boost::intrusive_ptr<ParsedCommandOverloadBase> ptr;
139 detail::ArgumentInfoBase & arg(unsigned n) const;
140 template <class Type> detail::ArgumentInfo<Type> & arg(unsigned n) const;
142 void doc(std::string const & d);
145 ParsedCommandOverloadBase();
147 template <class Type>
151 virtual unsigned v_numArguments() const;
152 virtual void v_argumentDoc(unsigned index, ArgumentDoc & doc) const;
153 virtual std::string v_doc() const;
155 typedef std::vector<detail::ArgumentInfoBase::ptr> Parameters;
156 Parameters parameters_;
160 /** \brief Parsed command overload
162 ParsedCommandOverload provides the command overload added to an OverloadedCommandNode for an
163 automatically parsed command.
165 This class is normally instantiated automatically when adding a function or member-function
166 pointer as callback to the tree. Manually instantiation this type of overload is \e not
167 simple, since the function signature has to be manipulated correctly to support the optional
168 \c std::ostream first argument.
170 \implementation This class is specialized for each supported number of command arguments.
172 template <class FunctionTraits, unsigned arity=FunctionTraits::arity>
173 class ParsedCommandOverload : public ParsedCommandOverloadBase
176 typedef boost::intrusive_ptr<ParsedCommandOverload> ptr;
179 static ptr create(Function fn);
185 # define BOOST_PP_ITERATION_PARAMS_1 (4, (0, SENF_CONSOLE_MAX_COMMAND_ARITY, \
186 SENF_ABSOLUTE_INCLUDE_PATH(Console/ParsedCommand.mpp), \
188 # include BOOST_PP_ITERATE()
192 /** \brief Generic ParsedCommandOverladBase attributes
194 Attributes for parsed commands are not set directly on the node. They are set via a special
195 attributor temporary returned when adding a parsed command to the tree.
197 This class is the base class for those attributors. It provides members which do not depend
198 in any way on the exact type of command added.
200 \see \ref console_autoparse
202 class ParsedCommandAttributorBase
205 OverloadedCommandNode & node() const; ///< Return the node object
206 operator OverloadedCommandNode & () const; ///< Automatically convert to node object
209 ParsedCommandAttributorBase(ParsedCommandOverloadBase & overload, unsigned index);
211 void argName(std::string const & name) const;
212 void argDoc(std::string const & doc) const;
213 template <class Type> void defaultValue(Type const & value) const;
214 void typeName(std::string const & doc) const;
215 void defaultDoc(std::string const & doc) const;
216 template <class Type, class Fn> void parser(Fn fn) const;
218 ParsedCommandOverloadBase & overload() const;
219 void overloadDoc(std::string const & doc) const;
221 void nodeDoc(std::string const & doc) const;
224 ParsedCommandOverloadBase & overload_;
228 /** \brief Non argument dependent ParsedCommandBase attributes
230 Attributes for parsed commands are not set directly on the node. They are set via a special
231 attributor temporary returned when adding a parsed command to the tree.
233 This class adds all those members, which do depend on the type of command added (and thereby
234 on that commands signature) but do not depend on the type of any single argument.
236 \see \ref console_autoparse
238 template <class Overload>
239 class ParsedCommandAttributor
240 : public ParsedCommandAttributorBase
243 Overload & overload() const; ///< Get the command overload
246 ParsedCommandAttributor(Overload & overload, unsigned index);
251 /** \brief Keyword argument tags
253 The tags defined in this namespace are used as keyword arguments via the <a
254 href="http://www.boost.org/doc/libs/1_33_1/libs/parameter/doc/html/index.html">Boost.Parameter</a>
257 For the keyword tags, the standard C++ scoping rules apply
259 // Either qualify them with their complete namespace
261 .arg( senf::console::kw::name = "name" );
263 // Or use a namespace alias
264 namespace kw = senf::console::kw;
266 .arg( kw::name = "name" );
268 // Or import the keywords into the current namespace (beware of name collisions)
269 using namespace senf::console::kw;
271 .arg( name = "name" );
274 The second alternative is preferred, the <tt>using namespace</tt> directive may be used as
275 long as the keyword names do not clash with another visible symbol.
277 \section kw_attributes Argument attribute values
279 The keywords are used to set argument attributes. The keywords \ref default_value and \ref
280 parser influence, how an argument is parsed/interpreted whereas \ref name, \ref description,
281 \ref type_name and \ref default_doc are used to change the arguments documentation:
285 dir.add("command", &command)
286 .arg( kw::name = "name",
287 kw::description = "description",
288 kw::default_value = 1,
289 kw::type_name = "type_name",
290 kw::default_doc = "default_doc" );
292 Will create the following documentation:
296 command [name:type_name]
304 \see \ref senf::console::ParsedArgumentAttributor::arg()
307 BOOST_PARAMETER_KEYWORD(type, name) ///< Argument name
308 /**< Sets the displayed name of the argument. */
309 BOOST_PARAMETER_KEYWORD(type, description) ///< One-line argument description
310 /**< This description is shown in the argument
311 reference. If several overloads have same-named
312 arguments, only one of them should be documented. This
313 documentation then applies to all arguments of that
315 BOOST_PARAMETER_KEYWORD(type, default_value) ///< Argument default value
316 /**< If a default value is specified for an argument, that
317 argument is optional. If an overload is called with
318 fewer arguments than defined, optional values will be
319 used beginning at the last optional argument and going
320 forward until all arguments have values assigned. E.g.,
321 an overload with 5 parameters \a a - \a e with two
324 command a:int [b:int] c:int [d:int] e:int
326 When calling the overload, the arguments will be
327 assigned in the following way:
328 <table class="senf fixedwidth">
330 <td><tt>command 1 2</tt></td>
331 <td>SyntaxErrorException: invalid number of
335 <td><tt>command 1 2 3</tt></td>
337 \a b = \e default, \n
339 \a d = \e default, \n
343 <td><tt>command 1 2 3 4</tt></td>
347 \a d = \e default, \n
351 <td><tt>command 1 2 3 4 5</tt></td>
359 <td><tt>command 1 2 3 4 5 6</tt></td>
360 <td>SyntaxErrorException: invalid number of
364 So, if you assign default values as you are used to
365 they will work like in C++ and most other languages */
366 BOOST_PARAMETER_KEYWORD(type, type_name) ///< Type name of this arguments type
367 /**< By default, the type of an argument is extracted from
368 the C++ type name by taking the last component of the
369 fully scoped name. This value can be changed by setting
371 BOOST_PARAMETER_KEYWORD(type, default_doc) ///< String rep of default value
372 /**< By default, the default value is documented by
373 converting the value to it's string representation
374 using \c boost::lexical_cast / \c iostreams. The
375 displayed value can be changed by setting this
377 BOOST_PARAMETER_KEYWORD(type, parser) ///< Argument parser
378 /**< The argument parser is used to convert the argument
379 token list returned by the console/config parser into
380 the appropriate value. If not set explicitly, this
381 conversion is supplied by the ArgumentTraits
384 Setting the \a parser attribute allows to use a custom
385 parser. The parser is an arbitrary callable object with
388 void parser(senf::console::ParseCommandInfo::TokensRange const & tokens, value_type & out);
390 where \c value_type is the type of the overload
391 parameter. The parser must read and parse the complete
392 \a tokens range and return the parsed value in \a
393 out. If the parser fails, it must raise a
394 senf::console::SyntaxErrorException. */
397 /** \brief Derived class dependent ParsedCommandBase attributes
399 Attributes for parsed commands are not set directly on the node. They are set via a special
400 attributor temporary returned when adding a parsed command to the tree.
402 This class adds all those members, which do not depend on any specific argument but which
403 need to return the correct attributor type.
405 \see \ref console_autoparse
407 template <class Overload, class Self>
408 class ParsedArgumentAttributorBase
409 : public ParsedCommandAttributor<Overload>
412 Self doc(std::string const & doc) const; ///< Set documentation for all overloads
413 Self overloadDoc(std::string const & doc) const; ///< Set overload specific documentation
416 ParsedArgumentAttributorBase(Overload & overload, unsigned index);
422 /** \brief Argument dependent ParsedCommandBase attributes
424 Attributes for parsed commands are not set directly on the node. They are set via a special
425 attributor temporary returned when adding a parsed command to the tree.
427 This class adds all those members, which depend on a specific argument. Each call to \c arg
428 will advance to the next argument.
430 \see \ref console_autoparse
432 template < class Overload,
434 bool flag=(index < unsigned(Overload::traits::arity)) >
435 class ParsedArgumentAttributor
436 : public ParsedArgumentAttributorBase< Overload,
437 ParsedArgumentAttributor<Overload, index, flag> >
439 typedef boost::parameter::parameters<
441 kw::type::description,
442 kw::type::default_value,
444 kw::type::default_doc,
445 kw::type::parser> arg_params;
448 typedef OverloadedCommandNode node_type;
449 typedef ParsedArgumentAttributor return_type;
451 typedef typename senf::function_traits_arg_type<
452 typename Overload::traits, int(index) >::type arg_type;
453 typedef typename senf::remove_cvref< arg_type >::type value_type;
454 typedef ParsedArgumentAttributor<Overload, index+1> next_type;
456 next_type arg() const; ///< Set argument attributes
457 /**< This member changes the attributes for the current
458 argument. The attributes are passed to arg() as keyword
459 arguments using the <a
460 href="http://www.boost.org/doc/libs/1_33_1/libs/parameter/doc/html/index.html">Boost.Parameter</a>
464 .arg( kw::name = "name",
465 kw::default_value = 1 )
468 The valid keywords are defined in the senf::console::kw
471 Each call to arg() will increment the argument index
472 and advance to the next argument. This member is only
473 present, if there is an argument at the current. */
477 # define BOOST_PP_ITERATION_PARAMS_1 \
478 (4, (1, BOOST_PARAMETER_MAX_ARITY, \
479 SENF_ABSOLUTE_INCLUDE_PATH(Console/ParsedCommand.mpp), \
481 # include BOOST_PP_ITERATE()
486 explicit ParsedArgumentAttributor(Overload & overload);
488 template <class ArgumentPack>
489 next_type argInfo(ArgumentPack const & args) const;
490 template <class Kw, class ArgumentPack>
491 void argInfo(Kw const &, ArgumentPack const &, boost::mpl::false_)
494 template <class ArgumentPack>
495 void argInfo(boost::parameter::keyword<kw::type::name> const &,
496 ArgumentPack const & args, boost::mpl::true_)
498 template <class ArgumentPack>
499 void argInfo(boost::parameter::keyword<kw::type::description> const &,
500 ArgumentPack const & args, boost::mpl::true_)
502 template <class ArgumentPack>
503 void argInfo(boost::parameter::keyword<kw::type::default_value> const &,
504 ArgumentPack const & args, boost::mpl::true_)
506 template <class ArgumentPack>
507 void argInfo(boost::parameter::keyword<kw::type::type_name> const &,
508 ArgumentPack const & args, boost::mpl::true_)
510 template <class ArgumentPack>
511 void argInfo(boost::parameter::keyword<kw::type::default_doc> const &,
512 ArgumentPack const & args, boost::mpl::true_)
514 template <class ArgumentPack>
515 void argInfo(boost::parameter::keyword<kw::type::parser> const &,
516 ArgumentPack const & args, boost::mpl::true_)
519 next_type next() const;
521 void defaultValue(value_type const & value) const;
522 template <class Fn> void parser(Fn fn) const;
524 template <class O, unsigned i, bool f>
525 friend class ParsedArgumentAttributor;
529 template <class Function>
530 friend ParsedArgumentAttributor<
531 ParsedCommandOverload<typename detail::ParsedCommandTraits<Function>::traits> >
532 senf_console_add_node(DirectoryNode & node, std::string const & name, Function fn, int);
534 template <class Owner, class Function>
535 friend ParsedArgumentAttributor<
536 ParsedCommandOverload<typename detail::ParsedCommandTraits<Function>::traits> >
537 senf_console_add_node(DirectoryNode & node, Owner & owner, std::string const & name,
539 typename boost::enable_if_c<
540 detail::ParsedCommandTraits<Function>::is_member>::type * = 0);
547 template <class Overload, unsigned index>
548 class ParsedArgumentAttributor<Overload, index, false>
549 : public ParsedArgumentAttributorBase< Overload,
550 ParsedArgumentAttributor<Overload, index, false> >
553 typedef OverloadedCommandNode node_type;
554 typedef ParsedArgumentAttributor return_type;
557 explicit ParsedArgumentAttributor(Overload & overload);
559 template <class O, unsigned i, bool f>
560 friend class ParsedArgumentAttributor;
562 template <class Function>
563 friend ParsedArgumentAttributor<
564 ParsedCommandOverload<typename detail::ParsedCommandTraits<Function>::traits> >
565 senf_console_add_node(DirectoryNode & node, std::string const & name, Function fn, int);
567 template <class Owner, class Function>
568 friend ParsedArgumentAttributor<
569 ParsedCommandOverload<typename detail::ParsedCommandTraits<Function>::traits> >
570 senf_console_add_node(DirectoryNode & node, Owner & owner, std::string const & name,
572 typename boost::enable_if_c<
573 detail::ParsedCommandTraits<Function>::is_member>::type * = 0);
576 template <class Function>
577 ParsedArgumentAttributor<
578 ParsedCommandOverload<typename detail::ParsedCommandTraits<Function>::traits> >
579 senf_console_add_node(DirectoryNode & node, std::string const & name, Function fn, int);
581 template <class Owner, class Function>
582 ParsedArgumentAttributor<
583 ParsedCommandOverload<typename detail::ParsedCommandTraits<Function>::traits> >
584 senf_console_add_node(DirectoryNode & node, Owner & owner, std::string const & name,
586 typename boost::enable_if_c<
587 detail::ParsedCommandTraits<Function>::is_member>::type * = 0);
593 #include BOOST_TYPEOF_INCREMENT_REGISTRATION_GROUP()
595 BOOST_TYPEOF_REGISTER_TEMPLATE(senf::console::ParsedCommandOverload, (class,unsigned))
596 BOOST_TYPEOF_REGISTER_TEMPLATE(senf::console::ParsedArgumentAttributor, (class, unsigned, bool))
597 BOOST_TYPEOF_REGISTER_TEMPLATE(boost::function_traits, 1)
599 ///////////////////////////////hh.e////////////////////////////////////////
600 #include "ParsedCommand.cci"
601 #include "ParsedCommand.ct"
602 #include "ParsedCommand.cti"
609 // comment-column: 40
610 // c-file-style: "senf"
611 // indent-tabs-mode: nil
612 // ispell-local-dictionary: "american"
613 // compile-command: "scons -u test"