command_line.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_COMMAND_LINE_H_
#define _CLI_COMMAND_LINE_H_

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


CLI_NS_BEGIN(cli)

    // Forward declarations.
    class Menu;


    class CommandLine : public Object
    {
    public:
        explicit CommandLine(void);

        virtual ~CommandLine(void);

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

    public:
        const bool Parse(
            const Menu& CLI_Menu,           
            const tk::String& STR_Line,    
            const bool B_Execution          
            );

        const Element& GetLastElement(void) const;

        const char* const GetLastWord(void) const;

        const int GetNumBackspacesForCompletion(void) const;

        const ResourceString& GetLastError(void) const;

    private:
        const bool Split(
            const tk::String& STR_Line,            
            tk::Queue<tk::String>& Q_Words,         
            int& I_LastWordPosition                 
            );

        CommandLine& AddElement(
            const Element* const PCLI_Element       
            );

    private:
        Element::List m_cliElements;
        Element::List m_cliAutoDelete;
        const Element* m_pcliMenu;
        tk::String m_strLastWord;
        bool m_bLastWordValid;
        int m_iNumBackspacesForCompletion;
        ResourceString m_cliError;

    private:
        // In order to allow access to private members for iteration.
        friend class CommandLineIterator;
    };

    class CommandLineIterator : public Object
    {
    public:
        explicit CommandLineIterator(
            const CommandLine& CLI_CmdLine  
            );

        virtual ~CommandLineIterator(void);

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

    public:
        const bool StepIt(void);

        const bool operator==(
            const Element& CLI_Element      
            ) const;

        const Element* const operator*(void) const;

    private:
        const CommandLine& m_cliCmdLine;

        Element::List::Iterator m_cliIterator;

        const Element* m_pcliCurrentElement;
    };

CLI_NS_END(cli)

#endif // _CLI_COMMAND_LINE_H_