command_line_edition.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_EDITION_H_
#define _CLI_CMD_LINE_EDITION_H_

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


CLI_NS_BEGIN(cli)

    // Forward declarations.
    class OutputDevice;


    class CmdLineEdition : public Object
    {
    public:
        CmdLineEdition(const CmdLineEdition&);

        explicit CmdLineEdition(void);

        virtual ~CmdLineEdition(void);

    public:
        CmdLineEdition& operator=(const CmdLineEdition&);

        void Set(
            const tk::String& TK_Left,  
            const tk::String& TK_Right  
            );

        void Reset(void);

    public:
        void SetInsertMode(
            const bool B_InsertMode 
            );

        const bool GetInsertMode(void) const;

    public:
        void Put(
            const OutputDevice& CLI_OutputDevice,   
            const KEY E_Char                        
            );

        void Put(
            const OutputDevice& CLI_OutputDevice,   
            const tk::String& TK_String             
            );

    private:
        void Put(
            const OutputDevice& CLI_OutputDevice,   
            const tk::Queue<KEY>& TK_Keys           
            );

    public:
        void CleanAll(
            const OutputDevice& CLI_OutputDevice    
            );

        void Delete(
            const OutputDevice& CLI_OutputDevice,   
            const int I_Count                       
            );

    public:
        void PrintCmdLine(
            const OutputDevice& CLI_OutputDevice    
            ) const;

        void MoveCursor(
            const OutputDevice& CLI_OutputDevice,   
            const int I_Count                       
            );

        void NextLine(
            const OutputDevice& CLI_OutputDevice    
            );

        void Home(
            const OutputDevice& CLI_OutputDevice    
            );

        void End(
            const OutputDevice& CLI_OutputDevice    
            );

    public:
        const tk::String GetLine(void) const;

        const tk::String GetRight(void) const;

        const tk::String GetLeft(void) const;

        const tk::String GetNextWord(void) const;

        const tk::String GetPrevWord(void) const;

    private:
        tk::Queue<KEY> m_tkLeft;

        tk::Queue<KEY> m_tkRight;

        bool m_bInsertMode;
    };

CLI_NS_END(cli)

#endif // _CLI_CMD_LINE_EDITION_H_