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_Variables_
  27 #define IH_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     template <class Variable>
  44     struct QueryVariable
  45     {
  46         typedef Variable const & Signature ();
  47         typedef boost::function<Signature> Function;
  48         typedef detail::ParsedCommandTraits<Signature> Traits;
  49
  50         QueryVariable(Variable const & var);
  51
  52         Variable const & operator()()  const;
  53
  54         Variable const & var_;
  55     };
  56
  57     template <class Variable>
  58     struct SetVariable
  59     {
  60         typedef void Signature (Variable &);
  61         typedef boost::function<Signature> Function;
  62         typedef detail::ParsedCommandTraits<Signature> Traits;
  63         typedef boost::function<void (Variable const &)> OnChangeHandler;
  64
  65         SetVariable(Variable & var);
  66
  67         void operator()(Variable const & value) const;
  68         void onChange(OnChangeHandler handler);
  69
  70         Variable & var_;
  71         OnChangeHandler handler_;
  72     };
  73
  74     template <class Variable, bool isConst=boost::is_const<Variable>::value>
  75     struct VariableNodeCreator
  76     {
  77         typedef VariableAttributor<Variable> result_type;
  78         static VariableAttributor<Variable> add(DirectoryNode & node, std::string const & name,
  79                                                 Variable & var);
  80     };
  81
  82     template <class Variable>
  83     struct VariableNodeCreator<Variable, true>
  84     {
  85         typedef ConstVariableAttributor<Variable> result_type;
  86         static ConstVariableAttributor<Variable> add(DirectoryNode & node, std::string const & name,
  87                                                      Variable & var);
  88     };
  89
  90 }}}
  91
  92 ///////////////////////////////ih.e////////////////////////////////////////
  93 #endif
  94
  95 \f
  96 // Local Variables:
  97 // mode: c++
  98 // fill-column: 100
  99 // comment-column: 40
 100 // c-file-style: "senf"
 101 // indent-tabs-mode: nil
 102 // ispell-local-dictionary: "american"
 103 // compile-command: "scons -u test"
 104 // End: