d4d_console.h

Go to the documentation of this file.

/**************************************************************************
*
* Copyright 2014 by Petr Gargulak. eGUI Community.
* Copyright 2009-2013 by Petr Gargulak. Freescale Semiconductor, Inc.
*
***************************************************************************
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License Version 3
* or later (the "LGPL").
*
* As a special exception, the copyright holders of the eGUI project give you
* permission to link the eGUI sources with independent modules to produce an
* executable, regardless of the license terms of these independent modules,
* and to copy and distribute the resulting executable under terms of your
* choice, provided that you also meet, for each linked independent module,
* the terms and conditions of the license of that module.
* An independent module is a module which is not derived from or based
* on this library.
* If you modify the eGUI sources, you may extend this exception
* to your version of the eGUI sources, but you are not obligated
* to do so. If you do not wish to do so, delete this
* exception statement from your version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* You should have received a copy of the GNU General Public License
* and the GNU Lesser General Public License along with this program.
* If not, see <http://www.gnu.org/licenses/>.
*
***************************************************************************/
#ifndef __D4D_CONSOLE_H
#define __D4D_CONSOLE_H

extern const D4D_OBJECT_SYS_FUNCTION d4d_consoleSysFunc;
void D4D_CnslScrollBarsFeedBack(D4D_OBJECT* pThis, D4D_INDEX old_position, D4D_INDEX new_position);


/******************************************************************************
* D4D CONSOLE setting  constants
*
*/
#ifndef D4D_CNSL_F_DEFAULT
  #define D4D_CNSL_F_DEFAULT  (D4D_OBJECT_F_VISIBLE | D4D_OBJECT_F_ENABLED | D4D_OBJECT_F_FOCUSRECT | D4D_OBJECT_F_TOUCHENABLE | D4D_OBJECT_F_TABSTOP | D4D_OBJECT_F_MOUSE_NORMAL | D4D_OBJECT_F_BEVEL_DENTED)
#endif

#ifndef D4D_CNSL_F_SCRLBRS_DEFAULT
  #define D4D_CNSL_F_SCRLBRS_DEFAULT  (D4D_OBJECT_F_ENABLED | D4D_OBJECT_F_TOUCHENABLE | D4D_OBJECT_F_FASTTOUCH | D4D_OBJECT_F_FOCUSRECT | D4D_OBJECT_F_MOUSE_NORMAL | D4D_OBJECT_F_BEVEL_RAISED)
#endif

#ifndef D4D_CNSL_TXT_PRTY_DEFAULT
  #define D4D_CNSL_TXT_PRTY_DEFAULT  (D4D_ALIGN_H_LEFT_MASK | D4D_ALIGN_V_CENTER_MASK)
#endif

#ifndef D4D_CNSL_FNT_PRTY_DEFAULT
  #define D4D_CNSL_FNT_PRTY_DEFAULT  ( 0 )
#endif

#ifndef D4D_CNSL_CURSOR_HEIGHT
  #define D4D_CNSL_CURSOR_HEIGHT  ( 1 )
#endif

#ifndef D4D_CNSL_STD_TAB_SIZE
  #define D4D_CNSL_STD_TAB_SIZE  ( 8 )
#endif

#ifndef D4D_CNSL_SCRLBR_WIDTH
  #define D4D_CNSL_SCRLBR_WIDTH  ( 20 )
#endif

#ifndef D4D_CNSL_SCRLBR_STEP_V
  #define D4D_CNSL_SCRLBR_STEP_V  ( 2 )
#endif

#ifndef D4D_CNSL_SCRLBR_STEP_H
  #define D4D_CNSL_SCRLBR_STEP_H  ( 8 )
#endif

#ifndef D4D_CNSL_CURSOR_BLINK_TICK_COUNTER
  #define D4D_CNSL_CURSOR_BLINK_TICK_COUNTER  ( 10 )
#endif

typedef Byte D4D_CNSL_FLAGS;

#define D4D_CNSL_FLAGS_CHECKLINE      (0x01)
#define D4D_CNSL_FLAGS_REDRAWALL      (0x02)
#define D4D_CNSL_FLAGS_REDRAWLINE     (0x04)
#define D4D_CNSL_FLAGS_REDRAWCURSOR   (0x10)
#define D4D_CNSL_FLAGS_CURSORSTATE    (0x20)

typedef struct D4D_CNSL_DATA_S
{
          D4D_COOR lastLineIx;                                                                                // index of last line
          D4D_POINT cursorPos;
          D4D_CNSL_FLAGS flags;
          D4D_INDEX tickCounter;
          D4D_FONT_PROPERTIES fnt_properties;     // propertis of used font for object strings
}D4D_CNSL_DATA;

// label configuration (goes to ROM by default)

typedef struct
{
    D4D_TCHAR* pTxtArr;                            // Pointer on text array that will use Console to store all lines
    D4D_SIZE txtArrSize;     // Size of two dimensional array for text
    D4D_FONT textFontId;                 // Used font for whole text
    D4D_INDEX tabSize;       // TAb Size of console object
    D4D_CNSL_DATA* pData;                // Run time data needed for Console
} D4D_CONSOLE;


#define D4D_LIST_BOX_CHILD_SCROLL_BAR_HOR_IX 1
#define D4D_LIST_BOX_CHILD_SCROLL_BAR_VER_IX 2

/******************************************************************************
* Macros
******************************************************************************/

// getting the CONSOLE structure from general OBJECT
#define D4D_GET_CONSOLE(pObj) ((D4D_CONSOLE*)((pObj)->pParam))
#define D4D_GET_CONSOLE_DATA(pObj) (D4D_GET_CONSOLE(pObj)->pData)
#define D4D_GET_LIST_BOX_SCROLL_BAR_HOR(pObj) ((D4D_OBJECT*)((pObj)->pRelations[D4D_LIST_BOX_CHILD_SCROLL_BAR_HOR_IX]))
#define D4D_GET_LIST_BOX_SCROLL_BAR_VER(pObj) ((D4D_OBJECT*)((pObj)->pRelations[D4D_LIST_BOX_CHILD_SCROLL_BAR_VER_IX]))

/******************************************************************************
* D4D CONSOLE setting  public macros
*
*/
/**************************************************************************/ 
#define _D4D_DECLARE_CONSOLE(type, name, x, y, cx, cy, radius, pMargin, pParent, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg) \
    static D4D_CNSL_DATA name##_data = { 0, {0, 0}, 0, 0, 0};\
    static D4D_TCHAR name##_txtArray[line_cnt][char_cnt + 1];\
    extern type D4D_OBJECT name##_scrollBarHor;\
    extern type D4D_OBJECT name##_scrollBarVer;\
    static const D4D_OBJECT * const name##_relations[] = {pParent, &name##_scrollBarHor, &name##_scrollBarVer, NULL};\
    static type D4D_CONSOLE name##_params = \
    { \
        (D4D_TCHAR*)&name##_txtArray[0][0],       /* pTextArr */ \
        { char_cnt, line_cnt }, /* txtArrSize */ \
        fontId,                         /* textFontId */ \
        tabSize,    /* tabSize */ \
        &name##_data, /* pData */ \
    }; \
    \
    D4D_DECLARE_OBJECT(type, name, x, y, cx, cy, radius, pMargin, name##_relations, pOnUsrMsg, &d4d_consoleSysFunc, &(name##_params), ((flags) | D4D_OBJECT_F_TIMETICK), pUser, pScheme)\
    \
    static const D4D_OBJECT* const name##_scrollBarsRelations[] = {&name, NULL};\
    \
    _D4D_DECLARE_SCROLL_BAR(type, name##_scrollBarHor,  D4D_BORDER_WIDTH(flags), (D4D_COOR)(cy - 2*D4D_BORDER_WIDTH(flags) - D4D_CNSL_SCRLBR_WIDTH + 1), (D4D_COOR)(cx - D4D_CNSL_SCRLBR_WIDTH - 2 * D4D_BORDER_WIDTH(flags)), D4D_CNSL_SCRLBR_WIDTH, \
     radius, NULL, name##_scrollBarsRelations, D4D_CNSL_F_SCRLBRS_DEFAULT, pScheme, (void*)&name, D4D_CnslScrollBarsFeedBack, NULL) \
    \
    _D4D_DECLARE_SCROLL_BAR(type, name##_scrollBarVer,  (D4D_COOR)(cx - D4D_CNSL_SCRLBR_WIDTH - 2 * D4D_BORDER_WIDTH(flags) + 1), D4D_BORDER_WIDTH(flags), D4D_LIST_BOX_SCRLBR_WIDTH, (D4D_COOR)(cy - D4D_LIST_BOX_SCRLBR_WIDTH - 2*D4D_BEVEL_WIDTH),\
     radius, NULL, name##_scrollBarsRelations, D4D_CNSL_F_SCRLBRS_DEFAULT, pScheme, (void*)&name, D4D_CnslScrollBarsFeedBack, NULL)

/**************************************************************************/ 
#define D4D_DECLARE_CONSOLE(name, x, y, cx, cy, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg) \
  _D4D_DECLARE_CONSOLE(D4D_CONST, name, x, y, cx, cy, 0, (D4D_MARGIN*)&d4d_marginDefault, NULL, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_CONSOLE(name, x, y, cx, cy, line_cnt, char_cnt, fontId) \
  D4D_DECLARE_CONSOLE(name, x, y, cx, cy, line_cnt, char_cnt, D4D_CNSL_STD_TAB_SIZE, D4D_CNSL_F_DEFAULT, NULL, fontId, NULL, NULL)

/**************************************************************************/ 
#define D4D_DECLARE_RCONSOLE(name, x, y, cx, cy, radius, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg) \
  _D4D_DECLARE_CONSOLE(D4D_CONST, name, x, y, cx, cy, radius, (D4D_MARGIN*)&d4d_marginDefault, NULL, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RCONSOLE(name, x, y, cx, cy, radius, line_cnt, char_cnt, fontId) \
  D4D_DECLARE_RCONSOLE(name, x, y, cx, cy, radius, line_cnt, char_cnt, D4D_CNSL_STD_TAB_SIZE, D4D_CNSL_F_DEFAULT, NULL, fontId, NULL, NULL)


// IN RAM instantions macro
/**************************************************************************/ 
#define D4D_DECLARE_CONSOLE_INRAM(name, x, y, cx, cy, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg) \
  _D4D_DECLARE_CONSOLE(D4D_NO_CONST, name, x, y, cx, cy, 0, (D4D_MARGIN*)&d4d_marginDefault, NULL, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_CONSOLE_INRAM(name, x, y, cx, cy, line_cnt, char_cnt, fontId) \
  D4D_DECLARE_CONSOLE_INRAM(name, x, y, cx, cy, line_cnt, char_cnt, D4D_CNSL_STD_TAB_SIZE, D4D_CNSL_F_DEFAULT, NULL, fontId, NULL, NULL)

// Rounded console definition
/**************************************************************************/ 
#define D4D_DECLARE_RCONSOLE_INRAM(name, x, y, cx, cy, radius, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg) \
  _D4D_DECLARE_CONSOLE(D4D_NO_CONST, name, x, y, cx, cy, radius, (D4D_MARGIN*)&d4d_marginDefault, NULL, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RCONSOLE_INRAM(name, x, y, cx, cy, radius, line_cnt, char_cnt, fontId) \
  D4D_DECLARE_RCONSOLE_INRAM(name, x, y, cx, cy, radius, line_cnt, char_cnt, D4D_CNSL_STD_TAB_SIZE, D4D_CNSL_F_DEFAULT, NULL, fontId, NULL, NULL)

/******************************************************************************
* Global variables
******************************************************************************/


/******************************************************************************
* Global functions
******************************************************************************/

D4D_BOOL D4D_CnslPutChar(D4D_OBJECT_PTR pObj, D4D_TCHAR ch);
D4D_BOOL D4D_CnslPutString(D4D_OBJECT_PTR pObj, D4D_TCHAR* pText);
void D4D_CnslClearLine(D4D_OBJECT_PTR pObj, D4D_INDEX line);
void D4D_CnslGoToXY(D4D_OBJECT_PTR pObj, D4D_POINT newPosition);
void D4D_CnslEnsureVisible(D4D_OBJECT_PTR pObj);
void D4D_CnslClearAll(D4D_OBJECT_PTR pObj);
D4D_POINT D4D_CnslGetCursor(D4D_OBJECT_PTR pObj);
void D4D_CnslSetScrollBarPosition(D4D_OBJECT_PTR pObj, D4D_INDEX hor, D4D_INDEX ver);
D4D_POINT D4D_CnslGetScrollBarPosition(D4D_OBJECT_PTR pObj);
/*********************************************************
*
* Object API
*
*********************************************************/


#endif /* __D4D_CONSOLE_H */