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 namespace senf {
  37 namespace console {
  38
  39     /** \brief Value range
  40
  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
  43      */
  44     template <class T>
  45     struct ValueRange
  46     {
  47         T low;
  48         T high;
  49     };
  50
  51 #ifndef DOXYGEN
  52
  53     template <class T>
  54     struct ArgumentTraits< ValueRange<T> >
  55     {
  56         typedef ValueRange<T> type;
  57         static bool const singleToken = true;
  58
  59         static void parse(ParseCommandInfo::TokensRange const & tokens, type & out);
  60         static std::string description();
  61         static std::string str(type const & value);
  62     };
  63
  64     template <class T>
  65     struct ReturnValueTraits< ValueRange<T> >
  66     {
  67         typedef ValueRange<T> type;
  68
  69         static void format(type const & value, std::ostream & os);
  70     };
  71
  72 #endif
  73
  74     /** \brief Bit-mask flag argument type
  75
  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.
  78
  79         \code
  80         // Function taking a flags argument
  81         void func(unsigned flags);
  82
  83         // Enum containing all the possible flag values
  84         enum MyFlags { Foo = 1,
  85                      Bar = 2,
  86                      Baz = 4,
  87                      Doo = 8 };
  88         SENF_CONSOLE_REGISTER_ENUM(MyFlags, (Foo)(Bar)(Baz)(Boo));
  89
  90         // Register the function with a FlagCollection argument type
  91         consoleDir.add("func", boost::function<void (FlagCollection<MyFlags>)>(&func));
  92         \endcode
  93
  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.
  99
 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.
 103
 104         After registering this function, you can call it with a collection of flags as argument
 105
 106         <pre>
 107         console:/$ help func
 108         Usage:
 109             func arg11:MyFlags
 110         console:/$ func Foo
 111         console:/$ func (Foo Boo)
 112         </pre>
 113      */
 114     template <class Enum>
 115     struct FlagCollection
 116     {
 117         operator unsigned long() const { return value; }
 118         FlagCollection() : value (0) {}
 119         FlagCollection(unsigned long value_) : value (value_) {}
 120         FlagCollection(Enum value_) : value (value_) {}
 121         unsigned long value;
 122     };
 123
 124 #ifndef DOXYGEN
 125
 126     template <class Enum>
 127     struct ArgumentTraits< FlagCollection<Enum> >
 128     {
 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);
 134     };
 135
 136     template <class Enum>
 137     struct ReturnValueTraits< FlagCollection<Enum> >
 138     {
 139         typedef FlagCollection<Enum> type;
 140         static void format(type const & value, std::ostream & os);
 141     };
 142
 143 #endif
 144
 145 }}
 146
 147 ///////////////////////////////hh.e////////////////////////////////////////
 148 //#include "Utility.cci"
 149 #include "Utility.ct"
 150 //#include "Utility.cti"
 151 #endif
 152
 153 \f
 154 // Local Variables:
 155 // mode: c++
 156 // fill-column: 100
 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"
 162 // End: