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 detail::CreateParsedCommandOverload<Traits> CreateOverload;
  52         typedef Variable const & result_type;
  53
  54         QueryVariable(Variable const & var);
  55
  56         static typename Traits::Overload::ptr create(Variable const & var);
  57
  58         Variable const & operator()()  const;
  59
  60         Variable const & var_;
  61     };
  62
  63     template <class Variable>
  64     struct SetVariable
  65     {
  66         typedef void Signature (Variable &);
  67         typedef boost::function<Signature> Function;
  68         typedef detail::ParsedCommandTraits<Signature> Traits;
  69         typedef detail::CreateParsedCommandOverload<Traits> CreateOverload;
  70         typedef boost::function<void (Variable const &)> OnChangeHandler;
  71         typedef void result_type;
  72
  73         SetVariable(Variable & var, OnChangeHandler handler = OnChangeHandler());
  74
  75         static typename Traits::Overload::ptr create(Variable & var);
  76
  77         void operator()(Variable const & value) const;
  78
  79         Variable & var_;
  80         OnChangeHandler handler_;
  81     };
  82
  83 #endif
  84
  85 }}}
  86
  87 ///////////////////////////////ih.e////////////////////////////////////////
  88 #endif
  89
  90 \f
  91 // Local Variables:
  92 // mode: c++
  93 // fill-column: 100
  94 // comment-column: 40
  95 // c-file-style: "senf"
  96 // indent-tabs-mode: nil
  97 // ispell-local-dictionary: "american"
  98 // compile-command: "scons -u test"
  99 // End: