switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Utils / Console / Variables.cti
index 1d19fbd..872d742 100644 (file)
@@ -1,24 +1,29 @@
 // $Id$
 //
-// Copyright (C) 2008 
+// Copyright (C) 2008
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
-// Competence Center NETwork research (NET), St. Augustin, GERMANY
-//     Stefan Bund <g0dil@berlios.de>
 //
-// This program is free software; you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation; either version 2 of the License, or
-// (at your option) any later version.
+// The contents of this file are subject to the Fraunhofer FOKUS Public License
+// Version 1.0 (the "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at 
+// http://senf.berlios.de/license.html
 //
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
+// The Fraunhofer FOKUS Public License Version 1.0 is based on, 
+// but modifies the Mozilla Public License Version 1.1.
+// See the full license text for the amendments.
 //
-// You should have received a copy of the GNU General Public License
-// along with this program; if not, write to the
-// Free Software Foundation, Inc.,
-// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+// Software distributed under the License is distributed on an "AS IS" basis, 
+// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
+// for the specific language governing rights and limitations under the License.
+//
+// The Original Code is Fraunhofer FOKUS code.
+//
+// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
+// (registered association), Hansastraße 27 c, 80686 Munich, Germany.
+// All Rights Reserved.
+//
+// Contributor(s):
+//   Stefan Bund <g0dil@berlios.de>
 
 /** \file
     \brief Variables inline template implementation */
@@ -28,9 +33,9 @@
 // Custom includes
 
 #define prefix_ inline
-///////////////////////////////cti.p///////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::console::detail::QueryVariable<Variable>
 
 template <class Variable>
@@ -39,13 +44,20 @@ prefix_ senf::console::detail::QueryVariable<Variable>::QueryVariable(Variable c
 {}
 
 template <class Variable>
+prefix_ typename senf::console::detail::QueryVariable<Variable>::Traits::Overload::ptr
+senf::console::detail::QueryVariable<Variable>::create(Variable const & var)
+{
+    return CreateOverload::create(Function(QueryVariable(var)));
+}
+
+template <class Variable>
 prefix_ Variable const & senf::console::detail::QueryVariable<Variable>::operator()()
     const
 {
     return var_;
 }
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::console::detail::SetVariable<Variable>
 
 template <class Variable>
@@ -55,6 +67,15 @@ prefix_ senf::console::detail::SetVariable<Variable>::SetVariable(Variable & var
 {}
 
 template <class Variable>
+prefix_ typename senf::console::detail::SetVariable<Variable>::Traits::Overload::ptr
+senf::console::detail::SetVariable<Variable>::create(Variable & var)
+{
+    typename Traits::Overload::ptr overload (CreateOverload::create(Function(SetVariable(var))));
+    overload->arg(0).name = "new_value";
+    return overload;
+}
+
+template <class Variable>
 prefix_ void senf::console::detail::SetVariable<Variable>::operator()(Variable const & value)
     const
 {
@@ -67,217 +88,152 @@ prefix_ void senf::console::detail::SetVariable<Variable>::operator()(Variable c
         var_ = value;
 }
 
-///////////////////////////////////////////////////////////////////////////
-// senf::console::ConstVariableAttributor<Variable>
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+// senf::console::ConstVariableFactory<Variable>
 
 template <class Variable>
-prefix_ senf::console::ConstVariableAttributor<Variable>
-senf::console::ConstVariableAttributor<Variable>::doc(std::string const & doc)
+prefix_ senf::console::factory::ConstVariableFactory<Variable>
+senf::console::factory::ConstVariableFactory<Variable>::doc(std::string const & doc)
 {
-    queryOverload_.node().doc(doc);
+    doc_ = doc;
     return *this;
 }
 
 template <class Variable>
-prefix_ senf::console::ConstVariableAttributor<Variable>
-senf::console::ConstVariableAttributor<Variable>::shortdoc(std::string const & doc)
+prefix_ senf::console::factory::ConstVariableFactory<Variable>
+senf::console::factory::ConstVariableFactory<Variable>::shortdoc(std::string const & doc)
 {
-    queryOverload_.node().shortdoc(doc);
+    shortdoc_ = doc;
     return *this;
 }
 
 template <class Variable>
-prefix_ senf::console::ConstVariableAttributor<Variable>
-senf::console::ConstVariableAttributor<Variable>::formatter(Formatter formatter)
+prefix_ senf::console::factory::ConstVariableFactory<Variable>
+senf::console::factory::ConstVariableFactory<Variable>::formatter(Formatter formatter)
 {
-    queryOverload_.formatter(formatter);
+    queryOverload_->formatter(formatter);
     return *this;
 }
 
 template <class Variable>
-prefix_ senf::console::ConstVariableAttributor<Variable>::
-ConstVariableAttributor(QueryOverload & queryOverload)
-    : queryOverload_ (queryOverload)
-{}
-
-template <class Variable>
 prefix_ senf::console::OverloadedCommandNode &
-senf::console::ConstVariableAttributor<Variable>::node()
+senf::console::factory::ConstVariableFactory<Variable>::create(DirectoryNode & dir,
+                                                               std::string const & name)
     const
 {
-    return queryOverload_.node();
+    OverloadedCommandNode & node (OverloadedCommandNode::insertOverload(dir, name, queryOverload_));
+    if (doc_) node.doc(*doc_);
+    if (shortdoc_) node.shortdoc(*shortdoc_);
+    return node;
 }
 
 template <class Variable>
-prefix_ senf::console::ConstVariableAttributor<Variable>::
-operator senf::console::OverloadedCommandNode &()
-    const
-{
-    return node();
-}
+prefix_ senf::console::factory::ConstVariableFactory<Variable>::
+ConstVariableFactory(Variable const & var)
+    : queryOverload_ (detail::QueryVariable<Variable>::create(var))
+{}
 
-///////////////////////////////////////////////////////////////////////////
-// senf::console::VariableAttributor<Variable>
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+// senf::console::VariableFactory<Variable>
 
 template <class Variable>
-prefix_ senf::console::VariableAttributor<Variable>
-senf::console::VariableAttributor<Variable>::parser(Parser parser)
+prefix_ typename senf::console::factory::VariableFactory<Variable>
+senf::console::factory::VariableFactory<Variable>::parser(Parser parser)
 {
-    setOverload_.template arg<0>().parser = parser;
+    setOverload_->template arg<0>().parser = parser;
     return *this;
 }
 
 template <class Variable>
-prefix_ senf::console::VariableAttributor<Variable>
-senf::console::VariableAttributor<Variable>::typeName(std::string const & name)
+prefix_ typename senf::console::factory::VariableFactory<Variable>
+senf::console::factory::VariableFactory<Variable>::typeName(std::string const & name)
 {
-    setOverload_.arg(0).type = name;
+    setOverload_->arg(0).type = name;
     return *this;
 }
 
 template <class Variable>
-prefix_ typename senf::console::VariableAttributor<Variable>
-senf::console::VariableAttributor<Variable>::onChange(OnChangeHandler handler)
+prefix_ typename senf::console::factory::VariableFactory<Variable>
+senf::console::factory::VariableFactory<Variable>::onChange(OnChangeHandler handler)
 {
-    setOverload_.function( 
+    setOverload_->function(
         boost::bind(detail::SetVariable<Variable>(var_, handler),_2));
     return *this;
 }
 
 template <class Variable>
-prefix_ typename senf::console::VariableAttributor<Variable>
-senf::console::VariableAttributor<Variable>::doc(std::string const & doc)
+prefix_ typename senf::console::factory::VariableFactory<Variable>
+senf::console::factory::VariableFactory<Variable>::doc(std::string const & doc)
 {
-    ConstVariableAttributor<Variable>::doc(doc);
+    ConstVariableFactory<Variable>::doc(doc);
     return *this;
 }
 
 template <class Variable>
-prefix_ typename senf::console::VariableAttributor<Variable>
-senf::console::VariableAttributor<Variable>::shortdoc(std::string const & doc)
+prefix_ typename senf::console::factory::VariableFactory<Variable>
+senf::console::factory::VariableFactory<Variable>::shortdoc(std::string const & doc)
 {
-    ConstVariableAttributor<Variable>::shortdoc(doc);
+    ConstVariableFactory<Variable>::shortdoc(doc);
     return *this;
 }
 
 template <class Variable>
-prefix_ typename senf::console::VariableAttributor<Variable>
-senf::console::VariableAttributor<Variable>::formatter(Formatter formatter)
+prefix_ typename senf::console::factory::VariableFactory<Variable>
+senf::console::factory::VariableFactory<Variable>::formatter(Formatter formatter)
 {
-    ConstVariableAttributor<Variable>::formatter(formatter);
+    ConstVariableFactory<Variable>::formatter(formatter);
     return *this;
 }
 
 template <class Variable>
-prefix_
-senf::console::VariableAttributor<Variable>::VariableAttributor(QueryOverload & queryOverload,
-                                                                SetOverload & setOverload,
-                                                                Variable & var)
-    : ConstVariableAttributor<Variable> (queryOverload), setOverload_ (setOverload), var_ (var)
-{}
-
-///////////////////////////////////////////////////////////////////////////
-
-template <class Variable, bool isConst>
-prefix_ senf::console::VariableAttributor<Variable>
-senf::console::detail::VariableNodeCreator<Variable,isConst>::add(DirectoryNode & node,
-                                                                  std::string const & name,
-                                                                  Variable & var)
-{
-    typename VariableAttributor<Variable>::SetOverload & setOverload ( 
-        node.add(name, typename detail::SetVariable<Variable>::Function(
-                     detail::SetVariable<Variable>(var)))
-            .arg("new_value")
-            .overload() );
-    typename VariableAttributor<Variable>::QueryOverload & queryOverload ( 
-        node.add(name, typename detail::QueryVariable<Variable>::Function(
-                     detail::QueryVariable<Variable>(var))).overload() );
-
-    return VariableAttributor<Variable>(queryOverload, setOverload, var);
-}
-
-template <class Variable>
-prefix_ senf::console::ConstVariableAttributor<Variable>
-senf::console::detail::VariableNodeCreator<Variable, true>::add(DirectoryNode & node,
-                                                                std::string const & name,
-                                                                Variable const & var)
+prefix_ senf::console::OverloadedCommandNode &
+senf::console::factory::VariableFactory<Variable>::create(DirectoryNode & dir,
+                                                          std::string const & name)
+    const
 {
-    typename VariableAttributor<Variable>::QueryOverload & queryOverload ( 
-        node.add(name, typename detail::QueryVariable<Variable>::Function(
-                     detail::QueryVariable<Variable>(var))).overload() );
-
-    return ConstVariableAttributor<Variable>(queryOverload);
+    OverloadedCommandNode & node (ConstVariableFactory<Variable>::create(dir,name));
+    node.add(setOverload_);
+    return node;
 }
 
-#ifndef DOXYGEN
-
 template <class Variable>
-prefix_ typename senf::console::detail::VariableNodeCreator<Variable>::result_type
-senf::console::
-senf_console_add_node(DirectoryNode & node, std::string const & name, Variable & var, int,
-                      typename boost::disable_if< boost::is_convertible<Variable*, ScopedDirectoryBase*> >::type *,
-                      typename boost::disable_if< boost::is_convertible<Variable*, GenericNode*> >::type *, 
-                      typename boost::disable_if_c<detail::ParsedCommandTraits<Variable>::is_callable>::type *)
-{
-    return detail::VariableNodeCreator<Variable>::add(node, name, var);
-}
+prefix_ senf::console::factory::VariableFactory<Variable>::VariableFactory(Variable & var)
+    : ConstVariableFactory<Variable> (var),
+      setOverload_ (detail::SetVariable<Variable>::create(var)),
+      var_ (var)
+{}
 
-template <class Variable>
-prefix_ typename senf::console::detail::VariableNodeCreator<Variable const>::result_type 
-senf::console::
-senf_console_add_node(DirectoryNode & node, std::string const & name, Variable const & var, int,
-                      typename boost::disable_if< boost::is_convertible<Variable*, ScopedDirectoryBase*> >::type *,
-                      typename boost::disable_if< boost::is_convertible<Variable*, GenericNode*> >::type *, 
-                      typename boost::disable_if_c<detail::ParsedCommandTraits<Variable>::is_callable>::type *)
-{
-    return detail::VariableNodeCreator<Variable const>::add(node, name, var);
-}
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
-template <class Variable>
-prefix_ typename senf::console::detail::VariableNodeCreator<Variable>::result_type
-senf::console::
-senf_console_add_node(DirectoryNode & node, std::string const & name,
-                      boost::reference_wrapper<Variable> var, int)
+template <class Var>
+prefix_ senf::console::factory::VariableFactory<Var>
+senf::console::factory::Variable(Var & var)
 {
-    return detail::VariableNodeCreator<Variable>::add(node, name, var.get());
+    return VariableFactory<Var>(var);
 }
 
-template <class Variable, class Owner>
-prefix_ typename senf::console::detail::VariableNodeCreator<Variable>::result_type
-senf::console::
-senf_console_add_node(DirectoryNode & node, Owner & owner, std::string const & name,
-                      Variable & var, int,
-                      typename boost::disable_if< boost::is_convertible<Variable*, ScopedDirectoryBase*> >::type *, 
-                      typename boost::disable_if< boost::is_convertible<Variable*, GenericNode*> >::type *, 
-                      typename boost::disable_if_c<detail::ParsedCommandTraits<Variable>::is_callable>::type *)
+template <class Var>
+prefix_ senf::console::factory::VariableFactory<Var>
+senf::console::factory::Variable(boost::reference_wrapper<Var> var)
 {
-    return detail::VariableNodeCreator<Variable>::add(node, name, var);
+    return VariableFactory<Var>(var);
 }
 
-template <class Variable, class Owner>
-prefix_ typename senf::console::detail::VariableNodeCreator<Variable const>::result_type
-senf::console::
-senf_console_add_node(DirectoryNode & node, Owner & owner, std::string const & name,
-                      Variable const & var, int,
-                      typename boost::disable_if< boost::is_convertible<Variable*, ScopedDirectoryBase*> >::type *, 
-                      typename boost::disable_if< boost::is_convertible<Variable*, GenericNode*> >::type *, 
-                      typename boost::disable_if_c<detail::ParsedCommandTraits<Variable>::is_callable>::type *)
+template <class Var>
+prefix_ senf::console::factory::ConstVariableFactory<Var>
+senf::console::factory::Variable(Var const & var)
 {
-    return detail::VariableNodeCreator<Variable const>::add(node, name, var);
+    return ConstVariableFactory<Var>(var);
 }
 
-template <class Variable, class Owner>
-prefix_ typename senf::console::detail::VariableNodeCreator<Variable>::result_type
-senf::console::senf_console_add_node(DirectoryNode & node, Owner &,
-                                     std::string const & name,
-                                     boost::reference_wrapper<Variable> var, int)
+template <class Var>
+prefix_ senf::console::factory::ConstVariableFactory<Var>
+senf::console::factory::Variable(boost::reference_wrapper<Var const> var)
 {
-    return detail::VariableNodeCreator<Variable>::add(node, name, var.get());
+    return ConstVariableFactory<Var>(var);
 }
 
-#endif
-
-///////////////////////////////cti.e///////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #undef prefix_
 
 \f