senf/Utils/Console/Variables.ih

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Stefan Bund <g0dil@berlios.de>
  27
  28 /** \file
  29     \brief Variables internal header */
  30
  31 #ifndef IH_SENF_Scheduler_Console_Variables_
  32 #define IH_SENF_Scheduler_Console_Variables_ 1
  33
  34 // Custom includes
  35 #include <boost/function.hpp>
  36 #include <boost/type_traits/is_const.hpp>
  37
  38 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  39
  40 namespace senf {
  41 namespace console {
  42
  43     template <class Variable> class ConstVariableAttributor;
  44     template <class Variable> class VariableAttributor;
  45
  46 namespace detail {
  47
  48 #ifndef DOXYGEN
  49
  50     template <class Variable>
  51     struct QueryVariable
  52     {
  53         typedef Variable const & Signature ();
  54         typedef boost::function<Signature> Function;
  55         typedef detail::ParsedCommandTraits<Signature> Traits;
  56         typedef detail::CreateParsedCommandOverload<Traits> CreateOverload;
  57         typedef Variable const & result_type;
  58
  59         QueryVariable(Variable const & var);
  60
  61         static typename Traits::Overload::ptr create(Variable const & var);
  62
  63         Variable const & operator()()  const;
  64
  65         Variable const & var_;
  66     };
  67
  68     template <class Variable>
  69     struct SetVariable
  70     {
  71         typedef void Signature (Variable &);
  72         typedef boost::function<Signature> Function;
  73         typedef detail::ParsedCommandTraits<Signature> Traits;
  74         typedef detail::CreateParsedCommandOverload<Traits> CreateOverload;
  75         typedef boost::function<void (Variable const &)> OnChangeHandler;
  76         typedef void result_type;
  77
  78         SetVariable(Variable & var, OnChangeHandler handler = OnChangeHandler());
  79
  80         static typename Traits::Overload::ptr create(Variable & var);
  81
  82         void operator()(Variable const & value) const;
  83
  84         Variable & var_;
  85         OnChangeHandler handler_;
  86     };
  87
  88 #endif
  89
  90 }}}
  91
  92 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  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: