exec_context.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_EXEC_CONTEXT_H_
#define _CLI_EXEC_CONTEXT_H_

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


CLI_NS_BEGIN(cli)

    // Forward declarations.
    class ExecutionContextManager;
    class ExecutionResult;


    typedef enum _STREAM_TYPE
    {
        ALL_STREAMS = -1,   

        WELCOME_STREAM = 0, 
        PROMPT_STREAM,      
        ECHO_STREAM,        
        OUTPUT_STREAM,      
        ERROR_STREAM,       
        STREAM_TYPES_COUNT  
    } STREAM_TYPE;


    class ExecutionContext : public Object
    {
    protected:
        explicit ExecutionContext(void);

        explicit ExecutionContext(
            ExecutionContext& CLI_ParentContext 
            );

    public:
        virtual ~ExecutionContext(void);

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

    public:
        ExecutionContextManager& GetContextManager(void);

    public:
        const IODevice& GetInput(void) const;

        const OutputDevice& GetStream(
            const STREAM_TYPE E_StreamType          
            ) const;

        const bool SetStream(
            const STREAM_TYPE E_StreamType,         
            OutputDevice& CLI_Stream                
            );

        const bool StreamEnabled(
            const STREAM_TYPE E_StreamType          
            ) const;

        const bool EnableStream(
            const STREAM_TYPE E_StreamType,         
            const bool B_Enable                     
            );

    public:
        void SetLang(
            const ResourceString::LANG E_Lang   
            );

        const ResourceString::LANG GetLang(void) const;

    public:
        void SetBeep(
            const bool B_Enable         
            );

        const bool GetBeep(void) const;

        void Beep(void);

    public:
        void Run(
            IODevice& CLI_IODevice                             
            );

        void Run(void);

        const bool IsRunning(void) const;

    public:
        void StopExecution(void);

        void StopAllExecutions(void);

    protected:
        virtual const bool OnStartExecution(void) = 0;

        // Note: use of @param doxygen tag in order to avoid doxygen warnings for reimplementations in sub-classes.
        virtual void OnKey(const KEY E_KeyCode) = 0;

        virtual const bool OnStopExecution(void) = 0;

    private:
        const bool BeginExecution(
            IODevice& CLI_IODevice              
            );

        void MainBlockingLoop(void);

        void ProcessKey(
            const KEY E_KeyCode                 
            );

        const bool FinishExecution(void);

    private:
        ExecutionContextManager& m_cliManager;

        tk::Queue<ExecutionResult*> m_tkResults;

    private:
        // ExecutionContext and NonBlockingIODevice are friends so that they can interact with non-public entry points.
        friend class NonBlockingIODevice;

        // ExecutionContext and ExecutionResult as well.
        friend class ExecutionResult;
    };


    class ExecutionResult : public Object
    {
    protected:
        explicit ExecutionResult(void);

    public:
        virtual ~ExecutionResult(void) = 0;

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

    public:
        void WatchResult(
            ExecutionContext& CLI_Context   
            );

    protected:
        virtual void OnResult(
            const ExecutionContext& CLI_Context     
            ) = 0;

    private:
        friend class ExecutionContext;
    };

CLI_NS_END(cli)

#endif // _CLI_EXEC_CONTEXT_H_