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 }}
  75
  76 ///////////////////////////////hh.e////////////////////////////////////////
  77 //#include "Utility.cci"
  78 #include "Utility.ct"
  79 //#include "Utility.cti"
  80 #endif
  81
  82 \f
  83 // Local Variables:
  84 // mode: c++
  85 // fill-column: 100
  86 // comment-column: 40
  87 // c-file-style: "senf"
  88 // indent-tabs-mode: nil
  89 // ispell-local-dictionary: "american"
  90 // compile-command: "scons -u test"
  91 // End: