element.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_ELEMENT_H_
#define _CLI_ELEMENT_H_

#include "cli/namespace.h"
#include "cli/object.h"
#include "cli/help.h"
#include "cli/tk.h"


CLI_NS_BEGIN(cli)

    // Forward declarations.
    class Cli;
    class Shell;
    class OutputDevice;
    class Element;
    class Help;


    class Element : public Object
    {
    public:
        // Typedefs.
        typedef tk::Queue<const Element*> List;
        typedef tk::Map<const tk::String, const Element*> Map;

    public:
        explicit Element(
            const char* const STR_Keyword,  
            const Help& STR_Help            
            );

        virtual ~Element(void) = 0;

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

    public:
        virtual const tk::String GetKeyword(void) const;

        virtual const Help& GetHelp(void) const;

        // Note: use of @param doxygen tag in order to avoid doxygen warnings for reimplementations in sub-classes.
        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 void SetCli(Cli& CLI_Cli);

        Cli& GetCli(void);
        const Cli& GetCli(void) const;

        Shell& GetShell(void) const;

        const OutputDevice& GetOutputStream(void) const;

        const OutputDevice& GetErrorStream(void) const;

    private:
        const tk::String m_strKeyword;
        const Help m_cliHelp;
        Cli* m_pcliCli;
    };

CLI_NS_END(cli)

#endif // _CLI_ELEMENT_H_