cli.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_CLI_H_
#define _CLI_CLI_H_

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


CLI_NS_BEGIN(cli)

    // Forward declarations
    class Cli;
    class Console;
    class Help;
    class ConfigMenu;
    #ifdef _DEBUG
    class TracesMenu;
    #endif


    class Cli : public Menu
    {
    private:
        explicit Cli(void);
        Cli(const Cli&);

    public:
        explicit Cli(
            const char* const STR_Name,     
            const Help& CLI_Help            
            );

        virtual ~Cli(void) = 0;

    private:
        Cli& operator=(const Cli&);

    public:
        typedef tk::Queue<const Cli*> List;

        static const int FindFromName(
            Cli::List& CLI_CliList,         
            const char* const STR_RegExp    
            );

    public:
        Menu& AddMenu(
            Menu* const PCLI_Menu       
            );

        const Menu* const GetMenu(
            const char* const STR_MenuName  
            ) const;

    public:
        const bool AddCommentLinePattern(
            const char* const STR_Start             
            );
        const bool RemoveCommentLinePattern(
            const char* const STR_Start             
            );
        const tk::Queue<tk::String>& GetCommentLinePatterns(void) const;

    public:
        void SetShell(
            Shell& CLI_Shell    
            ) const;
        Shell& GetShell(void) const;

        // Inherit doxygen comments from cli::Element documentation.
        virtual void SetCli(Cli& CLI_Cli);
        // Inherit doxygen comments from cli::Menu documentation.
        virtual const bool ExecuteReserved(const CommandLine& CLI_CommandLine) const;
        virtual const bool OnError(
            const ResourceString& CLI_Location,     
            const ResourceString& CLI_ErrorMessage  
            ) const;
        virtual void OnExit(void) const;

    private:
        ConfigMenu& GetConfigMenu(void);
        const ConfigMenu& GetConfigMenu(void) const;
        const Keyword& GetConfigMenuNode(void) const;
    public:
        const bool IsConfigMenuEnabled(void) const;

        const bool EnableConfigMenu(
            const bool B_Enable     
            );

    private:
        #ifdef _DEBUG
        TracesMenu& GetTracesMenu(void);
        const TracesMenu& GetTracesMenu(void) const;
        const Keyword& GetTracesMenuNode(void) const;
        #endif

    private:
        mutable Shell* m_pcliShell;
        tk::Queue<const Menu*> m_qMenus;
        tk::Queue<tk::String> m_qCommentLinePatterns;
        ConfigMenu* m_pcliConfigMenu;
        Keyword* m_pcliConfigMenuNode;
        #ifdef _DEBUG
        TracesMenu* m_pcliTracesMenu;
        Keyword* m_pcliTracesMenuNode;
        #endif
    };

CLI_NS_END(cli)

#endif // _CLI_CLI_H_