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 Traits public header */
26 #ifndef HH_SENF_Scheduler_Console_Traits_
27 #define HH_SENF_Scheduler_Console_Traits_ 1
31 #include <boost/intrusive_ptr.hpp>
32 #include <boost/type_traits/is_same.hpp>
33 #include <senf/Utils/intrusive_refcount.hh>
37 //#include "Traits.mpp"
38 ///////////////////////////////hh.p////////////////////////////////////////
43 /** \brief Customize argument parsing
45 ArgumentTraits provides argument parsing, Additionally, this class provides a way to get a
46 string-description of a type and to convert a value back into it's string representation
47 used to display default values.
49 The default implementation provided here
50 \li will use senf_console_parse_argument() to parse a value. This functions default
51 implementation uses \c boost::lexical_cast and thereby \c iostreams to convert an
52 argument consisting of a single input token into the required type.
53 \li will name types by returning the last component of the fully scoped name (e.g. \c
54 "string" for \c std::string).
55 \li Will format values (for default value display) by forwarding the value to the
56 ReturnValueTraits of that type.
58 To customize just the argument parsing, just provide an implementation of
59 senf_console_parse_argument(). Alternatively or to customize type naming or default value
60 formatting, specialize ArgumentTraits for the type.
67 static bool const singleToken =
68 boost::is_same< typeof(senf_console_parse_argument(
69 *static_cast<ParseCommandInfo::TokensRange const *>(0),
70 *static_cast<Type*>(0))),
73 static void parse(ParseCommandInfo::TokensRange const & tokens, Type & out);
74 ///< Parse token range into value
75 /**< This function needs to parse \a tokens and write the
76 parsed value into \a out. This function needs to parse
77 the \e complete list of tokens, additional tokens must
78 be considered as syntax error.
79 \throws SyntaxErrorException
80 \param[in] tokens tokens to parse
81 \param[out] out parsed value */
83 static std::string description(); ///< String description of type
84 /**< Returns the string description of \a Type. Used to
85 generate online help. */
86 static std::string str(Type const & value); ///< Stringify value
87 /**< To show default values in the online help, this
88 function converts a value back into a one-line string
89 representation. The default implementation uses the
90 ReturnValueTraits for this conversion. */
93 /** \brief Argument parser
97 \related ArgumentTraits
100 bool senf_console_parse_argument(ParseCommandInfo::TokensRange const & tokens, Type & out);
103 /** \brief Customize return value formating
105 ReturnValueTraits provides return value formatting. The default implementation provided here
106 will forward the call directly to senf_console_format_value(). The default implementation of
107 that function will write the \a value to \a os using standard iostream formatting.
109 To customize this behavior for some type, either provide an implementation of
110 senf_console_format_value() in the types namespace or provide a specialization of
113 The output should \e not end in a newline since one is added automatically.
115 template <class Type>
116 struct ReturnValueTraits
120 static void format(Type const & value, std::ostream & os);
121 ///< Write \a value to \a os
124 /** \brief Return value formatter
126 \see ReturnValuetraits
128 \related ReturnValueTraits
130 template <class Type>
131 void senf_console_format_value(Type const & value, std::ostream & os);
134 /** \brief Parse token range
136 This helper will invoke the correct ArgumentTraits::parse function to parse the input tokens
137 into the passed in variable.
141 template <class Type>
142 void parse(ParseCommandInfo::TokensRange const & tokens, Type & out);
144 /** \brief Format value
146 This helper will call the correct ArgumentTraits::str function to format \a value
150 template <class Type>
151 std::string str(Type const & value);
153 /** \brief Format return value
155 This helper will invoke the correct ReturnValueTraits::format function to write \a value
156 into the \a out stream.
158 \see ReturnValueTraits
160 template <class Type>
161 void format(Type const & value, std::ostream & os);
164 /** \brief Register enum type for argument parsing
166 Enum types need to be registered explicitly to support parsing.
168 enum Foo { Foo1, Foo2 };
169 SENF_CONSOLE_REGISTER_ENUM( Foo, (Foo1)(Foo2) );
171 This macro will register an enum type and it's enumerators defined at namespace scope. See
172 \ref SENF_CONSOLE_REGISTER_ENUM_MEMBER to register a member enum type.
174 \note All enumerator values must be unique ignoring case.
176 The enum parser will accept any unique initial substring ignoring case as valid enum value.
178 \ingroup console_commands
180 # define SENF_CONSOLE_REGISTER_ENUM(Type, Values) \
181 SENF_CONSOLE_REGISTER_ENUM_(BOOST_PP_EMPTY(), Type, Values)
183 /** \brief Register enum type for argument parsing
185 Enum types need to be registered explicitly to support parsing.
189 enum Foo { Foo1, Foo2 };
192 SENF_CONSOLE_REGISTER_ENUM_MEMBER( SomeClass, Foo, (Foo1)(Foo2) );
193 \endcode This macro will register an enum type and it's enumerators defined in a class. See
194 \ref SENF_CONSOLE_REGISTER_ENUM to register an enum type declared at namespace scope.
196 \ingroup console_commands
198 # define SENF_CONSOLE_REGISTER_ENUM_MEMBER(Class, Type, Values) \
199 SENF_CONSOLE_REGISTER_ENUM_(Class::, Type, Values)
202 /** \brief Format boolean value as \c true / \c false */
203 void formatTrueFalse(bool value, std::ostream & os);
205 /** \brief Format boolean value as \c yes / \c no */
206 void formatYesNo(bool value, std::ostream & os);
208 /** \brief Format boolean value as \c enabled / \c disabled */
209 void formatEnabledDisabled(bool value, std::ostream & os);
211 /** \brief Format boolean value as \c on / \c off */
212 void formatOnOff(bool value, std::ostream & os);
214 /** \brief Format boolean value as \c 1 / \c 0 */
215 void formatOneZero(bool value, std::ostream & os);
220 // Parse bool: true/false, yes/no, enabled/disabled, 0/1
222 struct ArgumentTraits<bool>
225 static bool const singleToken = true;
227 static void parse(ParseCommandInfo::TokensRange const & tokens, bool & out);
228 static std::string description();
229 static std::string str(bool value);
233 struct ReturnValueTraits<bool>
237 static void format(bool value, std::ostream & os);
240 template <> struct ArgumentTraits<char> : public detail::CharArgumentTraits<char> {};
241 template <> struct ReturnValueTraits<char> : public detail::CharReturnValueTraits<char> {};
242 template <> struct ArgumentTraits<signed char> : public detail::CharArgumentTraits<signed char> {};
243 template <> struct ReturnValueTraits<signed char> : public detail::CharReturnValueTraits<signed char> {};
244 template <> struct ArgumentTraits<unsigned char> : public detail::CharArgumentTraits<unsigned char> {};
245 template <> struct ReturnValueTraits<unsigned char> : public detail::CharReturnValueTraits<unsigned char> {};
251 ///////////////////////////////hh.e////////////////////////////////////////
252 #include "Traits.cci"
254 #include "Traits.cti"
261 // comment-column: 40
262 // c-file-style: "senf"
263 // indent-tabs-mode: nil
264 // ispell-local-dictionary: "american"
265 // compile-command: "scons -u test"