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 Utility public header */
26 #ifndef HH_SENF_Utils_Console_Utility_
27 #define HH_SENF_Utils_Console_Utility_ 1
32 //#include "Utility.mpp"
33 ///////////////////////////////hh.p////////////////////////////////////////
35 /** \defgroup senf_console_utilities Special console utility types
37 These types are provided by the %console library to support special argument or return value
44 /** \brief Parse character value as single-char string
46 This helper types is a wrapper around \a CharT which must be a character type. A value of
47 this type will be represented as a single character string, not as numeric value (the
48 default interpretation of char arguments in the console library).
50 This wrapper is used via type conversion using \c boost::function to convert the
51 argument/return type \a CharT to CharAsString<CharT>:
53 char foo(char v) { return v; }
55 senf::console::root().add(
56 "foo", boost::function< CharAsString<char> (CharAsString<char>) >(&foo));
59 \tparam CharT character type, one of \c char, \c signed \c char or \c unsigned \c char
61 \ingroup senf_console_utilities
63 template <class CharT>
67 CharAsString(CharT value_);
68 operator CharT () const;
74 template <class CharT>
75 struct ArgumentTraits< CharAsString<CharT> >
77 typedef CharAsString<CharT> type;
78 static bool const singleToken = true;
80 static void parse(ParseCommandInfo::TokensRange const & tokens, CharAsString<CharT> & out);
81 static std::string description();
82 static std::string str(CharAsString<CharT> value);
85 template <class CharT>
86 struct ReturnValueTraits< CharAsString<CharT> >
88 typedef CharAsString<CharT> type;
90 static void format(CharAsString<CharT> value, std::ostream & os);
95 /** \brief Value range
97 A value range may be represented in the console either by a single value (setting both \a
98 low and \a high to the same value) or as a lower and upper bound seperated by a colon.
100 \ingroup senf_console_utilities
112 struct ArgumentTraits< ValueRange<T> >
114 typedef ValueRange<T> type;
115 static bool const singleToken = true;
117 static void parse(ParseCommandInfo::TokensRange const & tokens, type & out);
118 static std::string description();
119 static std::string str(type const & value);
123 struct ReturnValueTraits< ValueRange<T> >
125 typedef ValueRange<T> type;
127 static void format(type const & value, std::ostream & os);
132 /** \brief Bit-mask flag argument type
134 senf::console::FlagCollection supplies a special argument type for use in registering
135 console commands. This argument type is used to represent a bit-mask of single flags.
138 // Function taking a flags argument
139 void func(unsigned flags);
141 // Enum containing all the possible flag values
142 enum MyFlags { Foo = 1,
146 SENF_CONSOLE_REGISTER_ENUM(MyFlags, (Foo)(Bar)(Baz)(Boo));
148 // Register the function with a FlagCollection argument type
149 consoleDir.add("func", boost::function<void (FlagCollection<MyFlags>)>(&func));
152 To use the FlagCollection class
153 \li you need a function which takes a bit-mask of flags as argument
154 \li you define and register an enum with all possible flag values
155 \li you register the function with a FlagCollection argument type using \c boost::function
156 for the conversion. This is also possible for return values.
158 The nice thing is, that \c boot::function supports compatible argument types and does
159 automatic type conversion. Since a FlagCollection is convertible to and from unsigned long,
160 this conversion will work.
162 After registering this function, you can call it with a collection of flags as argument
169 console:/$ func (Foo Boo)
172 \ingroup senf_console_utilities
174 template <class Enum>
175 struct FlagCollection
177 operator unsigned long() const { return value; }
178 FlagCollection() : value (0) {}
179 FlagCollection(unsigned long value_) : value (value_) {}
180 FlagCollection(Enum value_) : value (value_) {}
186 template <class Enum>
187 struct ArgumentTraits< FlagCollection<Enum> >
189 typedef FlagCollection<Enum> type;
190 static bool const singleToken = false;
191 static void parse(ParseCommandInfo::TokensRange const & tokens, type & out);
192 static std::string description();
193 static std::string str(type const & value);
196 template <class Enum>
197 struct ReturnValueTraits< FlagCollection<Enum> >
199 typedef FlagCollection<Enum> type;
200 static void format(type const & value, std::ostream & os);
207 ///////////////////////////////hh.e////////////////////////////////////////
208 //#include "Utility.cci"
209 #include "Utility.ct"
210 #include "Utility.cti"
217 // comment-column: 40
218 // c-file-style: "senf"
219 // indent-tabs-mode: nil
220 // ispell-local-dictionary: "american"
221 // compile-command: "scons -u test"