oc_terminal.h

Go to the documentation of this file.

#ifndef INC_KERNEL_OC_TERMINAL_H_
#define INC_KERNEL_OC_TERMINAL_H_

#include <stdbool.h>
#include <stdint.h>

#define _________________________________________TYPES_SECTION______________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
    oC_Terminal_Color_Black   ,               
    oC_Terminal_Color_Red     ,               
    oC_Terminal_Color_Green   ,               
    oC_Terminal_Color_Yellow  ,               
    oC_Terminal_Color_Blue    ,               
    oC_Terminal_Color_Magenta ,               
    oC_Terminal_Color_Cyan    ,               
    oC_Terminal_Color_White                   
} oC_Terminal_Color_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct
{
    int16_t         Column;     
    int16_t         Row;        
} oC_Terminal_CursorPos_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct
{
    //======================================================================================================================================
    //======================================================================================================================================
    bool (*ResetDevice)(void * Context);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*ClearScreen)(void * Context);

    //======================================================================================================================================
    //======================================================================================================================================
    oC_Terminal_CursorPos_t (*GetCursorPosition)(void * Context);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*EnableLineWrap)(void * Context);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*DisableLineWrap)(void * Context);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*SetCursorHome)(void * Context , oC_Terminal_CursorPos_t CursorPos);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*CursorHome)(void * Context);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*CursorUp)(void * Context,int Count);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*CursorDown)(void * Context,int Count);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*CursorForward)(void * Context,int Count);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*CursorBackward)(void * Context,int Count);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*SaveCursorPosition)(void * Context);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*RestoreCursorPosition)(void * Context);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*SaveCursorPositionAndAttrs)(void * Context);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*RestoreCursorPositionAndAttrs)(void * Context);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*EnableScrollScreen)(void * Context);

    //==========================================================================================================================================
    //==========================================================================================================================================
    bool (*EnableScrollScreenTo)(void * Context, int startRow , int endRow );

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*ScrollUp)(void * Context);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*ScrollDown)(void * Context);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*SetTab)(void * Context);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*ClearTab)(void * Context);

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*ClearAllTabs)( void * Context );

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*EraseToEndOfLine)( void * Context );

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*EraseToStartOfLine)( void * Context );

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*EraseCurrentLine)( void * Context );

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*SetKeyDefinition)(void * Context, char Key , char * String );

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*ResetAllAttributes)( void * Context );

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*SetBright)( void * Context );

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*SetDim)( void * Context );

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*SetUnderscore)( void * Context );

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*SetBlink)( void * Context );

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*SetReverese)( void * Context );

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*SetHidden)( void * Context );

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*SetForegroundColor)( void * Context,oC_Terminal_Color_t Color );

    //======================================================================================================================================
    //======================================================================================================================================
    bool (*SetBackgroundColor)( void * Context, oC_Terminal_Color_t Color );
} oC_Terminal_IfCfg_t;

#undef  _________________________________________TYPES_SECTION______________________________________________________________________________

#endif /* INC_KERNEL_OC_TERMINAL_H_ */