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 inline template implementation */
26 #include "ParsedCommand.ih"
29 #include "../Utils/membind.hh"
31 #define prefix_ inline
32 ///////////////////////////////cti.p///////////////////////////////////////
34 ///////////////////////////////////////////////////////////////////////////
35 // senf::console::ParsedCommandOverloadBase
38 prefix_ senf::console::detail::ParameterInfo<Type> &
39 senf::console::ParsedCommandOverloadBase::arg(unsigned n)
42 return static_cast<detail::ParameterInfo<Type> &>(arg(n));
46 prefix_ void senf::console::ParsedCommandOverloadBase::addParameter()
48 parameters_.push_back(detail::ParameterInfo<Type>::create());
51 ///////////////////////////////////////////////////////////////////////////
52 // senf::console::ParsedCommandOverload<FunctionTraits,n>
54 #define BOOST_PP_ITERATION_PARAMS_1 (4, (0, SENF_CONSOLE_MAX_COMMAND_ARITY, \
55 SENF_ABSOLUTE_INCLUDE_PATH(Console/ParsedCommand.mpp), \
57 #include BOOST_PP_ITERATE()
59 ///////////////////////////////////////////////////////////////////////////
64 // What is THIS about ??
66 // Ok, here's the dope: parsed commands may optionally have an std::ostream & first argument. If
67 // this argument is given, then the function will be called with the console output stream as
68 // it's first argument.
70 // This is implemented in the following way: ParsedCommandOverload (the class responsible for
71 // calling the callback) will ALWAYS pass the stream as first argument. If the user callback
72 // expects os as it's first argument, 'ignoreOneArg' will be false and the user supplied
73 // function will be directly passed to ParsedCommandOverload.
75 // If however, it does NOT take an std::ostream first argument, 'ignoreOneArg' will be true and
76 // the create member will use boost::bind to DROP the first argument.
78 template <class Traits, bool ignoreOneArg, unsigned arity=Traits::arity>
79 struct CreateParsedCommandOverload
82 template <class Traits, unsigned arity>
83 struct CreateParsedCommandOverload<Traits, false, arity>
85 typedef Traits traits;
87 template <class Function>
88 static typename senf::console::ParsedCommandOverload<traits>::ptr create(Function fn)
89 { return senf::console::ParsedCommandOverload<traits>::create(fn); };
92 # define BOOST_PP_ITERATION_PARAMS_1 (4, (0, SENF_CONSOLE_MAX_COMMAND_ARITY, \
93 SENF_ABSOLUTE_INCLUDE_PATH(Console/ParsedCommand.mpp), \
95 # include BOOST_PP_ITERATE()
99 template <class Function>
100 prefix_ senf::console::ParsedCommandOverload<
101 typename senf::console::detail::ParsedCommandTraits<Function>::traits> &
102 senf::console::senf_console_add_node(DirectoryNode & node, std::string const & name,
105 OverloadedCommandNode & cmdNode (
107 ? dynamic_cast<OverloadedCommandNode &>(node(name))
108 : node.add(name, OverloadedCommandNode::create()) );
110 typedef senf::console::detail::ParsedCommandTraits<Function> CmdTraits;
112 return cmdNode.add( CreateParsedCommandOverload<
113 typename CmdTraits::traits, ! CmdTraits::has_ostream_arg>::create(fn) );
116 template <class Owner, class Function>
117 prefix_ senf::console::ParsedCommandOverload<
118 typename senf::console::detail::ParsedCommandTraits<Function>::traits> &
120 senf_console_add_node(DirectoryNode & node, Owner & owner, std::string const & name,
122 typename boost::enable_if_c<detail::ParsedCommandTraits<Function>::is_member>::type *)
124 OverloadedCommandNode & cmdNode (
126 ? dynamic_cast<OverloadedCommandNode &>(node(name))
127 : node.add(name, OverloadedCommandNode::create()) );
129 typedef senf::console::detail::ParsedCommandTraits<Function> CmdTraits;
131 return cmdNode.add( CreateParsedCommandOverload<
132 typename CmdTraits::traits, ! CmdTraits::has_ostream_arg>::create(
133 senf::membind(fn,&owner)) );
136 ///////////////////////////////cti.e///////////////////////////////////////
143 // comment-column: 40
144 // c-file-style: "senf"
145 // indent-tabs-mode: nil
146 // ispell-local-dictionary: "american"
147 // compile-command: "scons -u test"