senf/Utils/Console/Utility.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2009
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   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.
  12 //
  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.
  17 //
  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.
  22
  23 /** \file
  24     \brief Utility public header */
  25
  26 #ifndef HH_SENF_Utils_Console_Utility_
  27 #define HH_SENF_Utils_Console_Utility_ 1
  28
  29 // Custom includes
  30 #include "Parse.hh"
  31 #include "Traits.hh"
  32
  33 //#include "Utility.mpp"
  34 ///////////////////////////////hh.p////////////////////////////////////////
  35
  36 /** \defgroup senf_console_utilities Special console utility types
  37
  38     These types are provided by the %console library to support special argument or return value
  39     formatting rules.
  40  */
  41
  42 namespace senf {
  43 namespace console {
  44
  45     /** \brief Parse character value as single-char string
  46
  47         This helper types is a wrapper around \a CharT which must be a character type. A value of
  48         this type will be represented as a single character string, not as numeric value (the
  49         default interpretation of char arguments in the console library).
  50
  51         This wrapper is used via type conversion using \c boost::function to convert the
  52         argument/return type \a CharT  to CharAsString<CharT>:
  53         \code
  54         char foo(char v) { return v; }
  55
  56         senf::console::root().add(
  57             "foo", boost::function< CharAsString<char> (CharAsString<char>) >(&foo));
  58         \endcode
  59
  60         \tparam CharT character type, one of \c char, \c signed \c char or \c unsigned \c char
  61
  62         \ingroup senf_console_utilities
  63      */
  64     template <class CharT>
  65     struct CharAsString
  66     {
  67         CharAsString();
  68         CharAsString(CharT value_);
  69         operator CharT () const;
  70         CharT value;
  71     };
  72
  73 #ifndef DOXYGEN
  74
  75     template <class CharT>
  76     struct ArgumentTraits< CharAsString<CharT> >
  77     {
  78         typedef CharAsString<CharT> type;
  79         static bool const singleToken = true;
  80
  81         static void parse(ParseCommandInfo::TokensRange const & tokens, CharAsString<CharT> & out);
  82         static std::string description();
  83         static std::string str(CharAsString<CharT> value);
  84     };
  85
  86     template <class CharT>
  87     struct ReturnValueTraits< CharAsString<CharT> >
  88     {
  89         typedef CharAsString<CharT> type;
  90
  91         static void format(CharAsString<CharT> value, std::ostream & os);
  92     };
  93
  94 #endif
  95
  96     /** \brief Value range
  97
  98         A value range may be represented in the console either by a single value (setting both \a
  99         low and \a high to the same value) or as a lower and upper bound seperated by a colon.
 100
 101         \ingroup senf_console_utilities
 102      */
 103     template <class T>
 104     struct ValueRange
 105     {
 106         T low;
 107         T high;
 108     };
 109
 110 #ifndef DOXYGEN
 111
 112     template <class T>
 113     struct ArgumentTraits< ValueRange<T> >
 114     {
 115         typedef ValueRange<T> type;
 116         static bool const singleToken = true;
 117
 118         static void parse(ParseCommandInfo::TokensRange const & tokens, type & out);
 119         static std::string description();
 120         static std::string str(type const & value);
 121     };
 122
 123     template <class T>
 124     struct ReturnValueTraits< ValueRange<T> >
 125     {
 126         typedef ValueRange<T> type;
 127
 128         static void format(type const & value, std::ostream & os);
 129     };
 130
 131 #endif
 132
 133     /** \brief Bit-mask flag argument type
 134
 135         senf::console::FlagCollection supplies a special argument type for use in registering
 136         console commands. This argument type is used to represent a bit-mask of single flags.
 137
 138         \code
 139         // Function taking a flags argument
 140         void func(unsigned flags);
 141
 142         // Enum containing all the possible flag values
 143         enum MyFlags { Foo = 1,
 144                      Bar = 2,
 145                      Baz = 4,
 146                      Doo = 8 };
 147         SENF_CONSOLE_REGISTER_ENUM(MyFlags, (Foo)(Bar)(Baz)(Boo));
 148
 149         // Register the function with a FlagCollection argument type
 150         consoleDir.add("func", boost::function<void (FlagCollection<MyFlags>)>(&func));
 151         \endcode
 152
 153         To use the FlagCollection class
 154         \li you need a function which takes a bit-mask of flags as argument
 155         \li you define and register an enum with all possible flag values
 156         \li you register the function with a FlagCollection argument type using \c boost::function
 157             for the conversion. This is also possible for return values.
 158
 159         The nice thing is, that \c boot::function supports compatible argument types and does
 160         automatic type conversion. Since a FlagCollection is convertible to and from unsigned long,
 161         this conversion will work.
 162
 163         After registering this function, you can call it with a collection of flags as argument
 164
 165         <pre>
 166         console:/$ help func
 167         Usage:
 168             func arg11:MyFlags
 169         console:/$ func Foo
 170         console:/$ func (Foo Boo)
 171         </pre>
 172
 173         \ingroup senf_console_utilities
 174      */
 175     template <class Enum>
 176     struct FlagCollection
 177     {
 178         operator unsigned long() const { return value; }
 179         FlagCollection() : value (0) {}
 180         FlagCollection(unsigned long value_) : value (value_) {}
 181         FlagCollection(Enum value_) : value (value_) {}
 182         unsigned long value;
 183     };
 184
 185 #ifndef DOXYGEN
 186
 187     template <class Enum>
 188     struct ArgumentTraits< FlagCollection<Enum> >
 189     {
 190         typedef FlagCollection<Enum> type;
 191         static bool const singleToken = false;
 192         static void parse(ParseCommandInfo::TokensRange const & tokens, type & out);
 193         static std::string description();
 194         static std::string str(type const & value);
 195     };
 196
 197     template <class Enum>
 198     struct ReturnValueTraits< FlagCollection<Enum> >
 199     {
 200         typedef FlagCollection<Enum> type;
 201         static void format(type const & value, std::ostream & os);
 202     };
 203
 204 #endif
 205
 206 }}
 207
 208 ///////////////////////////////hh.e////////////////////////////////////////
 209 //#include "Utility.cci"
 210 #include "Utility.ct"
 211 #include "Utility.cti"
 212 #endif
 213
 214 \f
 215 // Local Variables:
 216 // mode: c++
 217 // fill-column: 100
 218 // comment-column: 40
 219 // c-file-style: "senf"
 220 // indent-tabs-mode: nil
 221 // ispell-local-dictionary: "american"
 222 // compile-command: "scons -u test"
 223 // End: