param.h

Go to the documentation of this file.

/*
    Copyright (c) 2006-2018, Alexis Royer, http://alexis.royer.free.fr/CLI

    All rights reserved.

    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

        * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
        * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        * Neither the name of the CLI library project nor the names of its contributors may be used to endorse or promote products derived from this software
          without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/



#ifndef _CLI_PARAM_H_
#define _CLI_PARAM_H_

#include "cli/namespace.h"
#include "cli/syntax_node.h"
#include "cli/tk.h"


CLI_NS_BEGIN(cli)

    // Forward declarations.
    class Help;


    class Param : public SyntaxNode
    {
    protected:
        explicit Param(
            const char* const STR_Keyword,  
            const Help& CLI_Help            
            );

    public:
        virtual ~Param(void);

    private:
        explicit Param(void);
        Param(const Param&);
        Param& operator=(const Param&);

    public:
        // Inherit doxygen comments from cli::Element documentation.
        virtual const tk::String GetKeyword(void) const;

        // Inherit doxygen comments from cli::Element documentation.
        virtual const bool FindElements(Element::List& CLI_ExactList, Element::List& CLI_NearList, const char* const STR_Keyword) const;

        // Note: use of @param doxygen tag in order to avoid doxygen warnings for reimplementations in sub-classes.
        virtual const bool SetstrValue(const char* const STR_Value) const = 0;

        const tk::String GetstrValue(void) const;

        virtual const Param* const Clone(void) const = 0;

        const Param* const GetCloned(void) const;

        // Note: use of @param doxygen tag in order to avoid doxygen warnings for reimplementations in sub-classes.
        virtual const Param& CopyValue(const Param& CLI_Param) const = 0;

    protected:
        const bool SetValue(
            const char* const STR_Value     
            ) const;

        const Param* const InitClone(
            Param& CLI_CloneParam           
            ) const;

        const bool SetCloned(
            const Param& CLI_Cloned         
            );

    private:
        mutable tk::String m_strValue;

        const Param* m_pcliCloned;
    };


    template <class T> class ParamT : public Param
    {
    public:
        explicit ParamT<T>(
                const char* const STR_Keyword,  
                const T& T_Default,             
                const Help& CLI_Help            
                )
          : Param(STR_Keyword, CLI_Help),
            m_tValue(T_Default)
        {
        }

        virtual ~ParamT<T>(void)
        {
        }

    private:
        explicit ParamT<T>(void);
        ParamT<T>(const ParamT<T>&);
        ParamT<T>& operator=(const ParamT<T>&);

    public:
        operator const T(void) const
        {
            return m_tValue;
        }

        // Inherit doxygen comments from cli::Param documentation.
        virtual const Param& CopyValue(const Param& CLI_Param) const
        {
            if (const ParamT<T>* const pcli_Param = dynamic_cast<const ParamT<T>*>(& CLI_Param))
            {
                SetValue(CLI_Param.GetKeyword(), *pcli_Param);
            }
            return *this;
        }

    protected:
        void SetValue(
            const char* const STR_Value,    
            const T& T_Value                
            ) const
        {
            Param::SetValue(STR_Value);
            m_tValue = T_Value;
        }

    private:
        mutable T m_tValue;
    };

CLI_NS_END(cli)

#endif // _CLI_PARAM_H_