io_device.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_IO_DEVICE_H_
#define _CLI_IO_DEVICE_H_

#include <stdint.h> // int8_t, int16_t, int32_t, int64_t...

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


CLI_NS_BEGIN(cli)


    
    typedef enum _KEY
    {
        NULL_KEY = '\0',    

        BREAK = 3,          
        LOGOUT = 4,         
        ENTER = 10,         
        ESCAPE = 27,        
        SPACE = 32,         
        BACKSPACE = 8,      
        DELETE = 127,       
        CLS = 501,          
        INSERT = 502,       
        TAB = '\t',         

        KEY_0 = '0',
        KEY_1 = '1',
        KEY_2 = '2',
        KEY_3 = '3',
        KEY_4 = '4',
        KEY_5 = '5',
        KEY_6 = '6',
        KEY_7 = '7',
        KEY_8 = '8',
        KEY_9 = '9',
        KEY_a = 'a',
            KEY_aacute = 0xc3a1,    
            KEY_agrave = 0xc3a0,    
            KEY_auml = 0xc3a4,      
            KEY_acirc = 0xc3a2,     
        KEY_b = 'b',
        KEY_c = 'c',
            KEY_ccedil = 0xc3a7,    
        KEY_d = 'd',
        KEY_e = 'e',
            KEY_eacute = 0xc3a9,    
            KEY_egrave = 0xc3a8,    
            KEY_euml = 0xc3ab,      
            KEY_ecirc = 0xc3aa,     
        KEY_f = 'f',
        KEY_g = 'g',
        KEY_h = 'h',
        KEY_i = 'i',
            KEY_iacute = 0xc3ad,    
            KEY_igrave = 0xc3ac,    
            KEY_iuml = 0xc3af,      
            KEY_icirc = 0xc3ae,     
        KEY_j = 'j',
        KEY_k = 'k',
        KEY_l = 'l',
        KEY_m = 'm',
        KEY_n = 'n',
        KEY_o = 'o',
            KEY_oacute = 0xc3b3,    
            KEY_ograve = 0xc3b2,    
            KEY_ouml = 0xc3b6,      
            KEY_ocirc = 0xc3b4,     
        KEY_p = 'p',
        KEY_q = 'q',
        KEY_r = 'r',
        KEY_s = 's',
        KEY_t = 't',
        KEY_u = 'u',
            KEY_uacute = 0xc3ba,    
            KEY_ugrave = 0xc3b9,    
            KEY_uuml = 0xc3bc,      
            KEY_ucirc = 0xc3bb,     
        KEY_v = 'v',
        KEY_w = 'w',
        KEY_x = 'x',
        KEY_y = 'y',
        KEY_z = 'z',

        KEY_A = 'A',
        KEY_B = 'B',
        KEY_C = 'C',
        KEY_D = 'D',
        KEY_E = 'E',
        KEY_F = 'F',
        KEY_G = 'G',
        KEY_H = 'H',
        KEY_I = 'I',
        KEY_J = 'J',
        KEY_K = 'K',
        KEY_L = 'L',
        KEY_M = 'M',
        KEY_N = 'N',
        KEY_O = 'O',
        KEY_P = 'P',
        KEY_Q = 'Q',
        KEY_R = 'R',
        KEY_S = 'S',
        KEY_T = 'T',
        KEY_U = 'U',
        KEY_V = 'V',
        KEY_W = 'W',
        KEY_X = 'X',
        KEY_Y = 'Y',
        KEY_Z = 'Z',

        PLUS = '+',
        MINUS = '-',
        STAR = '*',
        SLASH = '/',
        LOWER_THAN = '<',
        GREATER_THAN = '>',
        EQUAL = '=',
        PERCENT = '%',

        UNDERSCORE = '_',
        AROBASE = '@',
        SHARP = '#',
        AMPERCENT = '&',
        DOLLAR = '$',
        BACKSLASH = '\\',
        PIPE = '|',
        TILDE = '~',
        SQUARE = 0xc2b2,    
        EURO = 0xe282ac,    
        POUND = 0xc2a3,     
        MICRO = 0xc2b5,     
        PARAGRAPH = 0xc2a7, 
        DEGREE = 0xc2b0,    
        COPYRIGHT = 0xc2a9, 

        QUESTION = '?',
        EXCLAMATION = '!',
        COLUMN = ':',
        DOT = '.',
        COMA = ',',
        SEMI_COLUMN = ';',
        QUOTE = '\'',
        DOUBLE_QUOTE = '"',
        BACK_QUOTE = '`',

        OPENING_BRACE = '(',
        CLOSING_BRACE = ')',
        OPENING_CURLY_BRACE = '{',
        CLOSING_CURLY_BRACE = '}',
        OPENING_BRACKET = '[',
        CLOSING_BRACKET = ']',

        KEY_UP = 1001,              
        KEY_DOWN = 1002,            
        KEY_LEFT = 1003,            
        KEY_RIGHT = 1004,           
        PAGE_UP = 1005,             
        PAGE_DOWN = 1006,           
        PAGE_LEFT = 1007,           
        PAGE_RIGHT = 1008,          

        KEY_BEGIN = 1020,           
        KEY_END = 1021,             

        COPY = 2001,                
        CUT = 2002,                 
        PASTE = 2003,               

        UNDO = 2004,                
        REDO = 2005,                
        PREVIOUS = 2006,            
        NEXT = 2007,                

        F1 = 0x0f000001,
        F2 = 0x0f000002,
        F3 = 0x0f000003,
        F4 = 0x0f000004,
        F5 = 0x0f000005,
        F6 = 0x0f000006,
        F7 = 0x0f000007,
        F8 = 0x0f000008,
        F9 = 0x0f000009,
        F10 = 0x0f00000a,
        F11 = 0x0f00000b,
        F12 = 0x0f00000c,

        FEED_MORE = 0xffffffff,     
    } KEY;

    class IOEndl : public Object
    {
    public:
        explicit IOEndl(void) : Object() {}

    private:
        IOEndl(const IOEndl&);
        IOEndl& operator=(const IOEndl&);
    };

    extern const IOEndl endl;


    // Forward declarations.
    class StringEncoder;
    class StringDecoder;

    class OutputDevice : public Object
    {
    protected:
        explicit OutputDevice(
            const char* const STR_DbgName,  
            const bool B_AutoDelete         
            );

        virtual ~OutputDevice(void);

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

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

    public:
        const int UseInstance(
            const CallInfo& CLI_CallInfo    
            );

        const int FreeInstance(
            const CallInfo& CLI_CallInfo    
            );

        const int GetInstanceUsers(void) const;

    public:
        const bool OpenUp(
            const CallInfo& CLI_CallInfo    
            );

        const bool CloseDown(
            const CallInfo& CLI_CallInfo    
            );

        const int GetOpenUsers(void) const;

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

        virtual const bool CloseDevice(void) = 0;

    public:
        #ifndef CLI_NO_STL
        const OutputDevice& operator<<(
            const std::string& STR_Out  
            ) const;
        #endif

        const OutputDevice& operator<<(
            const tk::String& STR_Out  
            ) const;

        const OutputDevice& operator<<(
            const char* const STR_Out   
            ) const;

        const OutputDevice& operator<<(
            const char C_Out            
            ) const;

        const OutputDevice& operator<<(
            const KEY E_Key             
            ) const;

        const OutputDevice& operator<<(
            const uint8_t UI8_Out       
            ) const;

        const OutputDevice& operator<<(
            const int16_t I16_Out       
            ) const;

        const OutputDevice& operator<<(
            const uint16_t UI16_Out     
            ) const;

        const OutputDevice& operator<<(
            const int32_t I32_Out       
            ) const;

        const OutputDevice& operator<<(
            const uint32_t UI32_Out     
            ) const;

        const OutputDevice& operator<<(
            const int64_t I64_Out       
            ) const;

        const OutputDevice& operator<<(
            const uint64_t UI64_Out     
            ) const;

        const OutputDevice& operator<<(
            const float F_Out           
            ) const;

        const OutputDevice& operator<<(
            const double D_Out          
            ) const;

        const OutputDevice& operator<<(
            const void* const PV_Out    
            ) const;

        const OutputDevice& operator<<(
            const IOEndl& CLI_IOEndl    
            ) const;

    public:
        const ResourceString GetLastError(void) const;

    public:
        static OutputDevice& GetNullDevice(void);

        static OutputDevice& GetStdOut(void);

        static OutputDevice& GetStdErr(void);

    public:
        class ScreenInfo : public Object
        {
        public:
            enum _RegularValues {
                UNKNOWN = -1,           
                DEFAULT_WIDTH = 80,     
                DEFAULT_HEIGHT = 20     
            };

        private:
            explicit ScreenInfo(void);

        public:
            explicit ScreenInfo(
                const int I_Width,      
                const int I_Height,     
                const bool B_TrueCls,   
                const bool B_WrapLines  
                ) : Object(),
                    m_iWidth(I_Width), m_iHeight(I_Height),
                    m_bTrueCls(B_TrueCls), m_bWrapLines(B_WrapLines)
            {}
            ScreenInfo(
                const ScreenInfo& CLI_Info      
                ) : Object(),
                    m_iWidth(CLI_Info.GetWidth()), m_iHeight(CLI_Info.GetHeight()),
                    m_bTrueCls(CLI_Info.GetbTrueCls()), m_bWrapLines(CLI_Info.GetbWrapLines())
            {}
            virtual ~ScreenInfo(void) {}
        public:
            ScreenInfo& operator=(
                const ScreenInfo& CLI_ScreenInfo    
                )
            {
                m_iWidth = CLI_ScreenInfo.m_iWidth;
                m_iHeight = CLI_ScreenInfo.m_iHeight;
                m_bTrueCls = CLI_ScreenInfo.m_bTrueCls;
                m_bWrapLines = CLI_ScreenInfo.m_bWrapLines;
                return *this;
            }
        public:
            const int GetWidth(void) const { return ((m_iWidth > 0) ? m_iWidth : UNKNOWN); }
            const unsigned int GetSafeWidth(void) const { return ((m_iWidth > 0) ? m_iWidth : DEFAULT_WIDTH); }
            const int GetHeight(void) const { return ((m_iHeight > 0) ? m_iHeight : UNKNOWN); }
            const unsigned int GetSafeHeight(void) const { return ((m_iHeight > 0) ? m_iHeight : DEFAULT_HEIGHT); }
            const bool GetbTrueCls(void) const { return m_bTrueCls; }
            const bool GetbWrapLines(void) const { return m_bWrapLines; }
        private:
            int m_iWidth;       
            int m_iHeight;      
            bool m_bTrueCls;    
            bool m_bWrapLines;  
        };

    public:
        // Note: use of @param doxygen tag in order to avoid doxygen warnings for reimplementations in sub-classes.
        virtual void PutString(const char* const STR_Out) const = 0;

        virtual void Beep(void) const;

        virtual void CleanScreen(void) const;

        virtual const ScreenInfo GetScreenInfo(void) const;

        // Note: use of @param doxygen tag in order to avoid doxygen warnings for reimplementations in sub-classes.
        virtual const bool WouldOutput(const OutputDevice& CLI_Device) const;

    private:
        const tk::String m_strDebugName;

        int m_iInstanceLock;

        int m_iOpenLock;

        StringEncoder& m_cliStringEncoder;

    protected:
        mutable ResourceString m_cliLastError;
    };


    class IODevice : public OutputDevice
    {
    public:
        explicit IODevice(
            const char* const STR_DbgName,  
            const bool B_AutoDelete         
            );

        virtual ~IODevice(void);

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

    public:
        virtual const KEY GetKey(void) const = 0;

        virtual const ResourceString GetLocation(void) const;

        // Note: use of @param doxygen tag in order to avoid doxygen warnings for reimplementations in sub-classes.
        virtual const bool WouldInput(const IODevice& CLI_Device) const;

    public:
        static IODevice& GetNullDevice(void);

        static IODevice& GetStdIn(void);

    protected:
        const KEY Char2Key(
            const int I_Char    
            ) const;
    private:
        StringDecoder& m_cliStringDecoder;
    };

CLI_NS_END(cli)

#endif // _CLI_IO_DEVICE_H_