command_line_history.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_CMD_LINE_HISTORY_H_
#define _CLI_CMD_LINE_HISTORY_H_

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

#include "command_line_edition.h"


CLI_NS_BEGIN(cli)

    // Forward declarations.
    class CmdLineEdition;


    class CmdLineHistory : public Object
    {
    public:
        explicit CmdLineHistory(
            const unsigned int UI_StackSize 
            );

        virtual ~CmdLineHistory(void);

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

    public:
        const bool Push(
            const CmdLineEdition& CLI_Line  
            );

        const bool Clear(void);

    public:
        const CmdLineEdition& GetLine(
            const unsigned int UI_BackwardIndex 
            ) const;

        const unsigned int GetCount(void) const;

    public:
        const bool SaveCurrentLine(
            const CmdLineEdition& CLI_CurrentLine   
            );

        const bool Navigate(
            CmdLineEdition& CLI_CmdLine,    
            const OutputDevice& CLI_Stream, 
            const int I_Navigation          
            );

        const unsigned int GetNavigationIndex(void) const;

        void EnableNavigationMemory(
            const bool B_NavigationMemory   
            );

    private:
        const unsigned int m_uiStackSize;
        tk::Queue<CmdLineEdition> m_qHistory;
        unsigned int m_uiNavigationIndex;
        bool m_bNavigation;
    };

CLI_NS_END(cli)

#endif // _CLI_CMD_LINE_HISTORY_H_