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;
141 void doc(std::string const & d);
144 ParsedCommandOverloadBase();
146 template <class Type> void addParameter();
149 virtual unsigned v_numArguments() const;
150 virtual void v_argumentDoc(unsigned index, ArgumentDoc & doc) const;
151 virtual std::string v_doc() const;
153 typedef std::vector<detail::ArgumentInfoBase::ptr> Parameters;
154 Parameters parameters_;
158 /** \brief Parsed command overload
160 ParsedCommandOverload provides the command overload added to an OverloadedCommandNode for an
161 automatically parsed command.
163 This class is normally instantiated automatically when adding a function or member-function
164 pointer as callback to the tree. Manually instantiation this type of overload is \e not
165 simple, since the function signature has to be manipulated correctly to support the optional
166 \c std::ostream first argument.
168 \implementation This class is specialized for each supported number of command arguments.
170 \todo Implement automatic binding of member functions for parser and formatter
172 template <class FunctionTraits, class ReturnType, unsigned 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 void typeName(std::string const & doc) const;
214 void defaultDoc(std::string const & doc) const;
216 ParsedCommandOverloadBase & overload() const;
217 void overloadDoc(std::string const & doc) const;
218 void nodeDoc(std::string const & doc) const;
221 ParsedCommandOverloadBase & overload_;
225 /** \brief Non argument dependent ParsedCommandBase attributes
227 Attributes for parsed commands are not set directly on the node. They are set via a special
228 attributor temporary returned when adding a parsed command to the tree.
230 This class adds all those members, which do depend on the type of command added (and thereby
231 on that commands signature) but do not depend on the type of any single argument.
233 \see \ref console_autoparse
235 template <class Overload>
236 class ParsedCommandAttributor
237 : public ParsedCommandAttributorBase
240 Overload & overload() const; ///< Get the command overload
243 ParsedCommandAttributor(Overload & overload, unsigned index);
248 /** \brief Keyword argument tags
250 The tags defined in this namespace are used as keyword arguments via the <a
251 href="http://www.boost.org/doc/libs/1_33_1/libs/parameter/doc/html/index.html">Boost.Parameter</a>
254 For the keyword tags, the standard C++ scoping rules apply
256 // Either qualify them with their complete namespace
258 .arg( senf::console::kw::name = "name" );
260 // Or use a namespace alias
261 namespace kw = senf::console::kw;
263 .arg( kw::name = "name" );
265 // Or import the keywords into the current namespace (beware of name collisions)
266 using namespace senf::console::kw;
268 .arg( name = "name" );
271 The second alternative is preferred, the <tt>using namespace</tt> directive may be used as
272 long as the keyword names do not clash with another visible symbol.
274 \section kw_attributes Argument attribute values
276 The keywords are used to set argument attributes. The keywords \ref default_value and \ref
277 parser influence, how an argument is parsed/interpreted whereas \ref name, \ref description,
278 \ref type_name and \ref default_doc are used to change the arguments documentation:
282 dir.add("command", &command)
283 .arg( kw::name = "name",
284 kw::description = "description",
285 kw::default_value = 1,
286 kw::type_name = "type_name",
287 kw::default_doc = "default_doc" );
289 Will create the following documentation:
293 command [name:type_name]
301 \see \ref senf::console::ParsedArgumentAttributor::arg()
304 BOOST_PARAMETER_KEYWORD(type, name) ///< Argument name
305 /**< Sets the displayed name of the argument. */
306 BOOST_PARAMETER_KEYWORD(type, description) ///< One-line argument description
307 /**< This description is shown in the argument
308 reference. If several overloads have same-named
309 arguments, only one of them should be documented. This
310 documentation then applies to all arguments of that
312 BOOST_PARAMETER_KEYWORD(type, default_value) ///< Argument default value
313 /**< If a default value is specified for an argument, that
314 argument is optional. If an overload is called with
315 fewer arguments than defined, optional values will be
316 used beginning at the last optional argument and going
317 forward until all arguments have values assigned. E.g.,
318 an overload with 5 parameters \a a - \a e with two
321 command a:int [b:int] c:int [d:int] e:int
323 When calling the overload, the arguments will be
324 assigned in the following way:
325 <table class="senf fixedwidth">
327 <td style="whitespace:no-wrap"><tt>command 1 2</tt></td>
328 <td colspan="5">SyntaxErrorException: invalid number of
332 <td style="white-space:nowrap"><tt>command 1 2 3</tt></td>
333 <td style="width:6em">\a a = 1</td><td style="width:6em">\a b = \e default</td><td style="width:6em">\a c = 2</td><td style="width:6em">\a d = \e default</td><td style="width:6em">\a e = 3</td>
336 <td style="white-space:nowrap"><tt>command 1 2 3 4</tt></td>
337 <td>\a a = 1</td><td>\a b = 2</td><td>\a c = 3</td><td>\a d = \e default</td><td>\a e = 4</td>
340 <td style="white-space:nowrap"><tt>command 1 2 3 4 5</tt></td>
341 <td>\a a = 1</td><td>\a b = 2</td><td>\a c = 3</td><td>\a d = 4</td><td>\a e = 5</td>
344 <td style="white-space:nowrap"><tt>command 1 2 3 4 5 6</tt></td>
345 <td colspan="5">SyntaxErrorException: invalid number of
349 So, if you use default values as you are used to,
350 assigning default values to consecutive trailing
351 arguments, they work like they do in C++ and most other
353 BOOST_PARAMETER_KEYWORD(type, type_name) ///< Type name of this arguments type
354 /**< By default, the type of an argument is extracted from
355 the C++ type name by taking the last component of the
356 fully scoped name. This value can be changed by setting
358 BOOST_PARAMETER_KEYWORD(type, default_doc) ///< String rep of default value
359 /**< By default, the default value is documented by
360 converting the value to it's string representation
361 using \c boost::lexical_cast / \c iostreams. The
362 displayed value can be changed by setting this
364 BOOST_PARAMETER_KEYWORD(type, parser) ///< Argument parser
365 /**< The argument parser is used to convert the argument
366 token list returned by the console/config parser into
367 the appropriate value. If not set explicitly, this
368 conversion is supplied by the ArgumentTraits
371 Setting the \a parser attribute allows to use a custom
372 parser. The parser is an arbitrary callable object with
375 void parser(senf::console::ParseCommandInfo::TokensRange const & tokens, value_type & out);
377 where \c value_type is the type of the overload
378 parameter. The parser must read and parse the complete
379 \a tokens range and return the parsed value in \a
380 out. If the parser fails, it must raise a
381 senf::console::SyntaxErrorException. */
384 /** \brief Derived class dependent ParsedCommandBase attributes
386 Attributes for parsed commands are not set directly on the node. They are set via a special
387 attributor temporary returned when adding a parsed command to the tree.
389 This class adds all those members, which do not depend on any specific argument but which
390 need to return the correct attributor type.
392 \see \ref console_autoparse
394 template <class Overload, class Self, class ReturnType=typename Overload::traits::result_type>
395 class ParsedArgumentAttributorBase
396 : public ParsedCommandAttributor<Overload>
399 Self doc(std::string const & doc) const; ///< Set documentation for all overloads
400 Self overloadDoc(std::string const & doc) const; ///< Set overload specific documentation
401 Self formatter(typename Overload::Formatter formatter) const;
402 ///< Set return value formatter
403 /**< This member is only available, if the \a ReturnType of
404 the installed callback is not \c void.
406 If \a ReturnType is not \c void, the \a formatter must
407 be a callable with a signature compatible with
409 void formatter(ReturnType const & value, std::ostream & os);
411 The \a formatter takes the return value of the call \a
412 value and writes it properly formated to \a os. */
415 ParsedArgumentAttributorBase(Overload & overload, unsigned index);
422 template <class Overload, class Self>
423 class ParsedArgumentAttributorBase<Overload, Self, void>
424 : public ParsedCommandAttributor<Overload>
427 Self doc(std::string const & doc) const; ///< Set documentation for all overloads
428 Self overloadDoc(std::string const & doc) const; ///< Set overload specific documentation
431 ParsedArgumentAttributorBase(Overload & overload, unsigned index);
438 /** \brief Argument dependent ParsedCommandBase attributes
440 Attributes for parsed commands are not set directly on the node. They are set via a special
441 attributor temporary returned when adding a parsed command to the tree.
443 This class adds all those members, which depend on a specific argument. Each call to \c arg
444 will advance to the next argument.
446 \see \ref console_autoparse
448 template < class Overload, unsigned index, bool flag>
449 class ParsedArgumentAttributor
450 : public ParsedArgumentAttributorBase< Overload,
451 ParsedArgumentAttributor<Overload, index, flag> >
453 typedef boost::parameter::parameters<
455 kw::type::description,
456 kw::type::default_value,
458 kw::type::default_doc,
459 kw::type::parser> arg_params;
462 typedef OverloadedCommandNode node_type;
463 typedef ParsedArgumentAttributor return_type;
465 typedef typename senf::function_traits_arg_type<
466 typename Overload::traits, int(index) >::type arg_type;
467 typedef typename senf::remove_cvref< arg_type >::type value_type;
468 typedef ParsedArgumentAttributor<Overload, index+1> next_type;
470 next_type arg() const; ///< Set argument attributes
471 /**< This member changes the attributes for the current
472 argument. The attributes are passed to arg() as keyword
473 arguments using the <a
474 href="http://www.boost.org/doc/libs/1_33_1/libs/parameter/doc/html/index.html">Boost.Parameter</a>
478 .arg( kw::name = "name",
479 kw::default_value = 1 )
482 The valid keywords are defined in the senf::console::kw
485 Each call to arg() will increment the argument index
486 and advance to the next argument. This member is only
487 present, if there is an argument at the current
492 # define BOOST_PP_ITERATION_PARAMS_1 \
493 (4, (1, BOOST_PARAMETER_MAX_ARITY, \
494 SENF_ABSOLUTE_INCLUDE_PATH(Console/ParsedCommand.mpp), \
496 # include BOOST_PP_ITERATE()
501 explicit ParsedArgumentAttributor(Overload & overload);
503 template <class ArgumentPack>
504 next_type argInfo(ArgumentPack const & args) const;
505 template <class Kw, class ArgumentPack>
506 void argInfo(Kw const &, ArgumentPack const &, boost::mpl::false_)
509 template <class ArgumentPack>
510 void argInfo(boost::parameter::keyword<kw::type::name> const &,
511 ArgumentPack const & args, boost::mpl::true_)
513 template <class ArgumentPack>
514 void argInfo(boost::parameter::keyword<kw::type::description> const &,
515 ArgumentPack const & args, boost::mpl::true_)
517 template <class ArgumentPack>
518 void argInfo(boost::parameter::keyword<kw::type::default_value> const &,
519 ArgumentPack const & args, boost::mpl::true_)
521 template <class ArgumentPack>
522 void argInfo(boost::parameter::keyword<kw::type::type_name> const &,
523 ArgumentPack const & args, boost::mpl::true_)
525 template <class ArgumentPack>
526 void argInfo(boost::parameter::keyword<kw::type::default_doc> const &,
527 ArgumentPack const & args, boost::mpl::true_)
529 template <class ArgumentPack>
530 void argInfo(boost::parameter::keyword<kw::type::parser> const &,
531 ArgumentPack const & args, boost::mpl::true_)
534 next_type next() const;
536 void defaultValue(value_type const & value) const;
537 template <class Fn> void parser(Fn fn) const;
539 template <class O, unsigned i, bool f>
540 friend class ParsedArgumentAttributor;
542 friend class detail::ParsedCommandAddNodeAccess;
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 friend class detail::ParsedCommandAddNodeAccess;
565 template <class Function>
566 typename detail::ParsedCommandTraits<Function>::Attributor
567 senf_console_add_node(DirectoryNode & node, std::string const & name, Function fn, int);
569 template <class Signature>
570 typename detail::ParsedCommandTraits<Signature>::Attributor
571 senf_console_add_node(DirectoryNode & node, std::string const & name, boost::function<Signature> fn, int);
573 template <class Owner, class Function>
574 typename detail::ParsedCommandTraits<Function>::Attributor
575 senf_console_add_node(DirectoryNode & node, Owner & owner, std::string const & name,
577 typename boost::enable_if_c<
578 detail::ParsedCommandTraits<Function>::is_member>::type * = 0);
584 #include BOOST_TYPEOF_INCREMENT_REGISTRATION_GROUP()
586 BOOST_TYPEOF_REGISTER_TEMPLATE(senf::console::ParsedCommandOverload, (class,unsigned))
587 BOOST_TYPEOF_REGISTER_TEMPLATE(senf::console::ParsedArgumentAttributor, (class, unsigned, bool))
588 BOOST_TYPEOF_REGISTER_TEMPLATE(boost::function_traits, 1)
590 ///////////////////////////////hh.e////////////////////////////////////////
591 #include "ParsedCommand.cci"
592 #include "ParsedCommand.ct"
593 #include "ParsedCommand.cti"
600 // comment-column: 40
601 // c-file-style: "senf"
602 // indent-tabs-mode: nil
603 // ispell-local-dictionary: "american"
604 // compile-command: "scons -u test"