shell.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_SHELL_H_
#define _CLI_SHELL_H_

#include "cli/namespace.h"
#include "cli/exec_context.h"


CLI_NS_BEGIN(cli)

    // Forward declarations.
    class Cli;
    class Menu;
    class Element;
    class CmdLineEdition;
    class CmdLineHistory;


    class Shell : public ExecutionContext
    {
    private:
        void InitObject(
            const Cli& CLI_Cli                      
            );

    public:
        explicit Shell(
            const Cli& CLI_Cli                      
            );

        explicit Shell(
            ExecutionContext& CLI_ParentContext,    
            const Cli& CLI_Cli                      
            );

        virtual ~Shell(void);

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

    public:
        const Cli& GetCli(void) const;

        void SetWelcomeMessage(
            const ResourceString& CLI_WelcomeMessage    
            );
        void SetByeMessage(
            const ResourceString& CLI_ByeMessage        
            );
        void SetPrompt(
            const ResourceString& CLI_Prompt            
            );

    public:
        const unsigned int GetHelpMargin(void) const;

        const unsigned int GetHelpOffset(void) const;

    private:
        void PromptWelcomeMessage(void) const;
        void PromptByeMessage(void) const;
        void PromptMenu(void) const;
        void PrintError(
            const ResourceString& CLI_Location,     
            const ResourceString& CLI_ErrorMessage  
            ) const;

    public:
        const Menu* const GetCurrentMenu(
            const int I_MenuIndex       
            ) const;

        void EnterMenu(
            const Menu& CLI_Menu,       
            const bool B_PromptMenu     
            );

        void ExitMenu(
            const bool B_PromptMenu     
            );

        void Quit(void);

        void DisplayHelp(void);

        void PrintWorkingMenu(void);

        void CleanScreen(
            const bool B_PromptMenu     
            );

    protected:
        // Inherit doxygen comments from cli::ExecutionContext interface documentation.
        virtual const bool OnStartExecution(void);
        // Inherit doxygen comments from cli::ExecutionContext interface documentation.
        virtual void OnKey(const KEY E_KeyCode);
        // Inherit doxygen comments from cli::ExecutionContext interface documentation.
        virtual const bool OnStopExecution(void);

    private:
        void OnPrintableChar(const KEY E_KeyCode);
        void OnKeyBegin(void);
        void OnKeyEnd(void);
        void OnKeyLeft(void);
        void OnKeyRight(void);
        void OnBackspace(void);
        void OnSuppr(void);
        void OnEscape(void);
        void OnExit(
            const bool B_PromptMenu     
            );
        void OnHelp(
            const bool B_PromptMenu,    
            const bool B_Completion     
            );
        void OnExecute(void);
        void OnHistory(
            const int I_Navigation      
            );

    private:
        void PrintHelp(
            const Element& CLI_Element  
            );

    private:
        const Cli& m_cliCli;
        ResourceString m_cliWelcomeMessage;
        ResourceString m_cliByeMessage;
        ResourceString m_cliNoDefaultPrompt;
        tk::Queue<const Menu*> m_qMenus;
        CmdLineEdition& m_cliCmdLine;
        CmdLineHistory& m_cliHistory;
    };

CLI_NS_END(cli)

#endif // _CLI_SHELL_H_