Variables.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


#ifndef HH_SENF_Utils_Console_Variables_
#define HH_SENF_Utils_Console_Variables_ 1

// Custom includes
#include <boost/type_traits/is_convertible.hpp>
#include <boost/ref.hpp>
#include "Node.hh"

#include "Variables.ih"
//#include "Variables.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {
namespace console {

    class ScopedDirectoryBase;
    template <class Variable> class VariableAttributor;

namespace factory {

#ifndef DOXYGEN

    template <class Variable>
    class ConstVariableFactory
        : public detail::NodeFactory
    {
    public:
        typedef typename detail::QueryVariable<Variable>::Traits::Overload QueryOverload;
        typedef typename QueryOverload::Formatter Formatter;
        typedef OverloadedCommandNode node_type;
        typedef OverloadedCommandNode & result_type;

        ConstVariableFactory doc(std::string const & doc);
        ConstVariableFactory shortdoc(std::string const & doc);
        ConstVariableFactory formatter(Formatter formatter);

        OverloadedCommandNode & create(DirectoryNode & dir, std::string const & name) const;

        explicit ConstVariableFactory(Variable const & var);

    private:
        typename QueryOverload::ptr queryOverload_;
        boost::optional<std::string> doc_;
        boost::optional<std::string> shortdoc_;
    };

#endif

#ifdef DOXYGEN
    class Variable
#else
    template <class Variable>
    class VariableFactory
        : public ConstVariableFactory<Variable>
#endif
    {
    public:
        typedef typename detail::SetVariable<Variable>::Traits::Overload SetOverload;
        typedef typename detail::ArgumentInfo<typename SetOverload::arg1_type>::Parser Parser;
        typedef typename detail::SetVariable<Variable>::OnChangeHandler OnChangeHandler;

        typedef typename ConstVariableFactory<Variable>::Formatter Formatter;
        typedef typename ConstVariableFactory<Variable>::QueryOverload QueryOverload;

        VariableFactory doc(std::string const & doc); 
        VariableFactory shortdoc(std::string const & doc); 
        VariableFactory formatter(Formatter formatter); 

        VariableFactory parser(Parser parser); 

        VariableFactory typeName(std::string const & name); 
        VariableFactory onChange(OnChangeHandler handler); 

        explicit VariableFactory(Variable & var); 

    protected:

    private:
        OverloadedCommandNode & create(DirectoryNode & dir, std::string const & name) const;

        typename SetOverload::ptr setOverload_;
        Variable & var_;

        friend class senf::console::DirectoryNode;
    };

#ifndef DOXYGEN

    template <class Var>
    VariableFactory<Var> Variable(Var & var);

    template <class Var>
    VariableFactory<Var> Variable(boost::reference_wrapper<Var> var);

    template <class Var>
    ConstVariableFactory<Var> Variable(Var const & var);

    template <class Var>
    ConstVariableFactory<Var> Variable(boost::reference_wrapper<Var const> var);

#endif

}}}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
//#include "Variables.cci"
//#include "Variables.ct"
#include "Variables.cti"
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// comment-column: 40
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// End: