senf/Utils/Console/Variables.ih

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   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 Variables internal header */
  25
  26 #ifndef IH_SENF_Scheduler_Console_Variables_
  27 #define IH_SENF_Scheduler_Console_Variables_ 1
  28
  29 // Custom includes
  30 #include <boost/function.hpp>
  31 #include <boost/type_traits/is_const.hpp>
  32
  33 ///////////////////////////////ih.p////////////////////////////////////////
  34
  35 namespace senf {
  36 namespace console {
  37
  38     template <class Variable> class ConstVariableAttributor;
  39     template <class Variable> class VariableAttributor;
  40
  41 namespace detail {
  42
  43 #ifndef DOXYGEN
  44
  45     template <class Variable>
  46     struct QueryVariable
  47     {
  48         typedef Variable const & Signature ();
  49         typedef boost::function<Signature> Function;
  50         typedef detail::ParsedCommandTraits<Signature> Traits;
  51         typedef Variable const & result_type;
  52
  53         QueryVariable(Variable const & var);
  54
  55         Variable const & operator()()  const;
  56
  57         Variable const & var_;
  58     };
  59
  60     template <class Variable>
  61     struct SetVariable
  62     {
  63         typedef void Signature (Variable &);
  64         typedef boost::function<Signature> Function;
  65         typedef detail::ParsedCommandTraits<Signature> Traits;
  66         typedef boost::function<void (Variable const &)> OnChangeHandler;
  67         typedef void result_type;
  68
  69         SetVariable(Variable & var, OnChangeHandler handler = OnChangeHandler());
  70
  71         void operator()(Variable const & value) const;
  72
  73         Variable & var_;
  74         OnChangeHandler handler_;
  75     };
  76
  77     template <class Variable, bool isConst=boost::is_const<Variable>::value>
  78     struct VariableNodeCreator
  79     {
  80         typedef VariableAttributor<Variable> result_type;
  81         static VariableAttributor<Variable> add(DirectoryNode & node, std::string const & name,
  82                                                 Variable & var);
  83     };
  84
  85     template <class Variable>
  86     struct VariableNodeCreator<Variable, true>
  87     {
  88         typedef ConstVariableAttributor<Variable> result_type;
  89         static ConstVariableAttributor<Variable> add(DirectoryNode & node, std::string const & name,
  90                                                      Variable & var);
  91     };
  92
  93 #endif
  94
  95 }}}
  96
  97 ///////////////////////////////ih.e////////////////////////////////////////
  98 #endif
  99
 100 \f
 101 // Local Variables:
 102 // mode: c++
 103 // fill-column: 100
 104 // comment-column: 40
 105 // c-file-style: "senf"
 106 // indent-tabs-mode: nil
 107 // ispell-local-dictionary: "american"
 108 // compile-command: "scons -u test"
 109 // End: