Utility.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_Utility_
#define HH_SENF_Utils_Console_Utility_ 1

// Custom includes
#include "Parse.hh"

//#include "Utility.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {
namespace console {

    template <class CharT>
    struct CharAsString
    {
        CharAsString();
        CharAsString(CharT value_);
        operator CharT () const;
        CharT value;
    };

#ifndef DOXYGEN

    template <class CharT>
    struct ArgumentTraits< CharAsString<CharT> >
    {
        typedef CharAsString<CharT> type;
        static bool const singleToken = true;

        static void parse(ParseCommandInfo::TokensRange const & tokens, CharAsString<CharT> & out);
        static std::string description();
        static std::string str(CharAsString<CharT> value);
    };

    template <class CharT>
    struct ReturnValueTraits< CharAsString<CharT> >
    {
        typedef CharAsString<CharT> type;

        static void format(CharAsString<CharT> value, std::ostream & os);
    };

#endif

    template <class T>
    struct ValueRange
    {
        T lower;
        T upper;
    };

#ifndef DOXYGEN

    template <class T>
    struct ArgumentTraits< ValueRange<T> >
    {
        typedef ValueRange<T> type;
        static bool const singleToken = true;

        static void parse(ParseCommandInfo::TokensRange const & tokens, type & out);
        static std::string description();
        static std::string str(type const & value);
    };

    template <class T>
    struct ReturnValueTraits< ValueRange<T> >
    {
        typedef ValueRange<T> type;

        static void format(type const & value, std::ostream & os);
    };

    namespace detail {
        template <typename FlagType>
        struct UnderlyingFlagType
        {
#           ifdef SENF_CXX11_ENABLED
                typedef typename std::underlying_type<FlagType>::type type;
#           else
                typedef unsigned long type;
#           endif
        };
    }

#endif

    template <typename Enum>
    struct FlagCollection
    {
        typedef typename detail::UnderlyingFlagType<Enum>::type underlying_type;

        operator underlying_type() const { return value; }

        FlagCollection() : value (0) {}
        FlagCollection(underlying_type v) : value (v) {}
        FlagCollection(Enum v) : value (static_cast<underlying_type>(v)) {}

        underlying_type value;
    };

#ifndef DOXYGEN

    template <class Enum>
    struct ArgumentTraits< FlagCollection<Enum> >
    {
        typedef FlagCollection<Enum> type;
        static bool const singleToken = false;
        static void parse(ParseCommandInfo::TokensRange const & tokens, type & out);
        static std::string description();
        static std::string str(type const & value);
    };

    template <class Enum>
    struct ReturnValueTraits< FlagCollection<Enum> >
    {
        typedef FlagCollection<Enum> type;
        static void format(type const & value, std::ostream & os);
    };

#endif

}}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
//#include "Utility.cci"
#include "Utility.ct"
#include "Utility.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: