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
33 //#include "Utility.mpp"
34 ///////////////////////////////hh.p////////////////////////////////////////
39 /** \brief Value range
41 A value range may be represented in the console either by a single value (setting both \a
42 low and \a high to the same value) or as a lower and upper bound seperated by a colon
54 struct ArgumentTraits< ValueRange<T> >
56 typedef ValueRange<T> type;
57 static bool const singleToken = true;
59 static void parse(ParseCommandInfo::TokensRange const & tokens, type & out);
60 static std::string description();
61 static std::string str(type const & value);
65 struct ReturnValueTraits< ValueRange<T> >
67 typedef ValueRange<T> type;
69 static void format(type const & value, std::ostream & os);
74 /** \brief Bit-mask flag argument type
76 senf::console::FlagCollection supplies a special argument type for use in registering
77 console commands. This argument type is used to represent a bit-mask of single flags.
80 // Function taking a flags argument
81 void func(unsigned flags);
83 // Enum containing all the possible flag values
84 enum MyFlags { Foo = 1,
88 SENF_CONSOLE_REGISTER_ENUM(MyFlags, (Foo)(Bar)(Baz)(Boo));
90 // Register the function with a FlagCollection argument type
91 consoleDir.add("func", boost::function<void (FlagCollection<MyFlags>)>(&func));
94 To use the FlagCollection class
95 \li you need a function which takes a bit-mask of flags as argument
96 \li you define and register an enum with all possible flag values
97 \li you register the function with a FlagCollection argument type using \c boost::function
98 for the conversion. This is also possible for return values.
100 The nice thing is, that \c boot::function supports compatible argument types and does
101 automatic type conversion. Since a FlagCollection is convertible to and from unsigned long,
102 this conversion will work.
104 After registering this function, you can call it with a collection of flags as argument
111 console:/$ func (Foo Boo)
114 template <class Enum>
115 struct FlagCollection
117 operator unsigned long() const { return value; }
118 FlagCollection() : value (0) {}
119 FlagCollection(unsigned long value_) : value (value_) {}
120 FlagCollection(Enum value_) : value (value_) {}
126 template <class Enum>
127 struct ArgumentTraits< FlagCollection<Enum> >
129 typedef FlagCollection<Enum> type;
130 static bool const singleToken = false;
131 static void parse(ParseCommandInfo::TokensRange const & tokens, type & out);
132 static std::string description();
133 static std::string str(type const & value);
136 template <class Enum>
137 struct ReturnValueTraits< FlagCollection<Enum> >
139 typedef FlagCollection<Enum> type;
140 static void format(type const & value, std::ostream & os);
147 ///////////////////////////////hh.e////////////////////////////////////////
148 //#include "Utility.cci"
149 #include "Utility.ct"
150 //#include "Utility.cti"
157 // comment-column: 40
158 // c-file-style: "senf"
159 // indent-tabs-mode: nil
160 // ispell-local-dictionary: "american"
161 // compile-command: "scons -u test"