d4d_base.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_BASE_H
#define __D4D_BASE_H

/******************************************************************************
* Includes
******************************************************************************/

/******************************************************************************
* D4D BASE setting  constants
*
*/
#define D4D_VERSION "v3.01"

#ifndef D4D_MCU_TYPE
  #define D4D_MCU_TYPE D4D_MK
  #warning "There is no definition for D4D_MCU_TYPE in configuration file. The driver is using as default D4D_MK."
#endif

#ifndef D4D_SCREEN_HISTORY
  #define D4D_SCREEN_HISTORY 5
#endif


#ifdef D4D_ENABLE_AUTOSIZE

  #if D4D_ENABLE_AUTOSIZE != D4D_FALSE
    #error The D4D_ENABLE_AUTOSIZE capability had removed from eGUI since version 3.00. For update your eGUI project just define size for all objects.
  #endif
#endif

#ifndef D4D_ROUND_CORNER_ENABLE
  #define D4D_ROUND_CORNER_ENABLE D4D_FALSE
#endif

#ifndef D4D_FONT_TABLE_DISABLED
  #define D4D_FONT_TABLE_DISABLED D4D_FALSE
  #warning "Font table is disabled by default, set the D4D_FONT_TABLE_DISABLED to D4D_TRUE in config file."
#endif

#ifndef D4D_SCREEN_SIZE_LONGER_SIDE
          #define D4D_SCREEN_SIZE_LONGER_SIDE 320
          #warning "The D4D configuration file doesn't contains the resolution information for longer axis. The D4D sets this value to default: 320 pixels."
#endif

#ifndef D4D_SCREEN_SIZE_SHORTER_SIDE
          #define D4D_SCREEN_SIZE_SHORTER_SIDE 240
          #warning "The D4D configuration file doesn't contains the resolution information for shorter axis. The D4D sets this value to default: 240 pixels."
#endif

#ifndef D4D_MCU_BUS_CLOCK
  #define D4D_MCU_BUS_CLOCK 24000000L
#endif

#ifndef D4D_COLOR_SYSTEM_FORE
  #define D4D_COLOR_SYSTEM_FORE D4D_COLOR_YELLOW
#endif

#ifndef D4D_COLOR_SYSTEM_BCKG
  #define D4D_COLOR_SYSTEM_BCKG D4D_COLOR_BLACK
#endif

#ifndef D4D_FONT_SYSTEM_DEFAULT
  #define D4D_FONT_SYSTEM_DEFAULT 0
#endif

#ifndef D4D_BMP_EXTSRC_SUPPORT_D4D
  #define D4D_BMP_EXTSRC_SUPPORT_D4D D4D_FALSE
#endif

#ifndef D4D_BMP_EXTSRC_SUPPORT_BMP
  #define D4D_BMP_EXTSRC_SUPPORT_BMP D4D_FALSE
#endif

#ifndef D4D_EXTSRC_TEXT_ENABLE
          #define D4D_EXTSRC_TEXT_ENABLE D4D_FALSE
#endif

#ifndef D4D_EXTSRC_FILE_ENABLE
          #if (D4D_BMP_EXTSRC_SUPPORT_BMP != D4D_FALSE) || (D4D_BMP_EXTSRC_SUPPORT_D4D != D4D_FALSE) || (D4D_FNT_EXTSRC_SUPPORT != D4D_FALSE)
                    #define D4D_EXTSRC_FILE_ENABLE D4D_TRUE
          #else
                    #define D4D_EXTSRC_FILE_ENABLE D4D_FALSE
          #endif
#endif

#ifndef D4D_EXTSRC_BUFF_SIZE
  #define D4D_EXTSRC_BUFF_SIZE 64
#endif

#ifndef D4D_LLD_FLUSH_ELEMENT
  #define D4D_LLD_FLUSH_ELEMENT D4D_FALSE
#endif

#ifndef D4D_DEBUG
  #define D4D_DEBUG D4D_FALSE
#endif

#define D4D_ENDIAN_BIG 0

#define D4D_ENDIAN_LITTLE 1

#ifndef D4D_ENDIAN
  #if (D4D_MCU_TYPE == D4D_MK)
    #define D4D_ENDIAN D4D_ENDIAN_LITTLE
  #else  // for other cases (this should not work for every cases)
    #define D4D_ENDIAN D4D_ENDIAN_BIG
  #endif
#endif

/*********************************************************
*
* D4D align constants
*
*********************************************************/


  #define D4D_ALIGN_MASK                  (0x0F)

  #define D4D_ALIGN_H_MASK                (0x03)

  #define D4D_ALIGN_H_LEFT_MASK           (0x00)

  #define D4D_ALIGN_H_RIGHT_MASK          (0x01)

  #define D4D_ALIGN_H_CENTER_MASK         (0x02)

  #define D4D_ALIGN_V_MASK                (0x0C)

  #define D4D_ALIGN_V_TOP_MASK            (0x00)

  #define D4D_ALIGN_V_BOTTOM_MASK         (0x04)

  #define D4D_ALIGN_V_CENTER_MASK         (0x08)

/*********************************************************
*
* keys setting  constants
*
*********************************************************/



#ifndef D4D_KEY_UP
  #define D4D_KEY_UP     0x01
#endif

#ifndef D4D_KEY_DOWN
  #define D4D_KEY_DOWN   0x02
#endif

#ifndef D4D_KEY_LEFT
  #define D4D_KEY_LEFT   0x04
#endif

#ifndef D4D_KEY_RIGHT
  #define D4D_KEY_RIGHT  0x08
#endif

#ifndef D4D_KEY_ENTER
  #define D4D_KEY_ENTER  0x10
#endif

#ifndef D4D_KEY_ESC
  #define D4D_KEY_ESC    0x20
#endif

#ifndef D4D_KEY_SCANCODE_UP
  #define D4D_KEY_SCANCODE_UP     0x51
#endif

#ifndef D4D_KEY_SCANCODE_DOWN
  #define D4D_KEY_SCANCODE_DOWN   0x50
#endif

#ifndef D4D_KEY_SCANCODE_LEFT
  #define D4D_KEY_SCANCODE_LEFT   0x4B
#endif

#ifndef D4D_KEY_SCANCODE_RIGHT
  #define D4D_KEY_SCANCODE_RIGHT  0x4D
#endif

#ifndef D4D_KEY_SCANCODE_ENTER
  #define D4D_KEY_SCANCODE_ENTER  0x1C
#endif

#ifndef D4D_KEY_SCANCODE_ESC
  #define D4D_KEY_SCANCODE_ESC    0x01
#endif

#define D4D_KEY_SCANCODE_KEYMASK  0x7F

#define D4D_KEY_SCANCODE_RELEASEMASK  0x80

#ifndef D4D_KEY_FUNC_FOCUS_NEXT
  #define D4D_KEY_FUNC_FOCUS_NEXT    D4D_KEY_SCANCODE_DOWN
#endif

#ifndef D4D_KEY_FUNC_FOCUS_PREV
  #define D4D_KEY_FUNC_FOCUS_PREV    D4D_KEY_SCANCODE_UP
#endif

#ifndef D4D_KEYS_BUFF_LENGTH
  #define D4D_KEYS_BUFF_LENGTH 4
#endif

/*********************************************************
*
* touch screen constants
*
*********************************************************/

#ifndef D4DTCH_CALIB_CROSS_OFFSET
  #define D4DTCH_CALIB_CROSS_OFFSET 30
#endif

/******************************************************************************
* Internal constants
******************************************************************************/
#if D4D_SCREEN_SIZE_SHORTER_SIDE > D4D_SCREEN_SIZE_LONGER_SIDE
  #warning "The D4D_SCREEN_SIZE_SHORTER_SIDE macro has greater value then D4D_SCREEN_SIZE_LONGER_SIDE in d4d_cfg.h file. Please check!"
#endif

/******************************************************************************
* D4D Base types
*
*/
typedef Byte D4D_OBJECT_DRAWFLAGS;

#define D4D_OBJECT_DRAWFLAGS_COMPLETE   (0x01)  
#define D4D_OBJECT_DRAWFLAGS_FOCUSED    (0x02)  
#define D4D_OBJECT_DRAWFLAGS_CAPTURING  (0x04)  
#define D4D_OBJECT_DRAWFLAGS_STATE      (0x08)  


typedef enum
{
    D4D_MSG_NONE,               
    D4D_MSG_ONINIT,             
    D4D_MSG_DRAW,               
    D4D_MSG_DRAWDONE,           
    D4D_MSG_SETFOCUS,           
    D4D_MSG_KILLFOCUS,          
    D4D_MSG_SETCAPTURE,         
    D4D_MSG_KILLCAPTURE,        
    D4D_MSG_KEYUP,              
    D4D_MSG_KEYDOWN,            
    D4D_MSG_TOUCHED,            
    D4D_MSG_TOUCH_AUTO,         
    D4D_MSG_TOUCH_LOST,         
    D4D_MSG_UNTOUCHED,          
    D4D_MSG_MOUSE_BTN_LEFT_DOWN,        
    D4D_MSG_MOUSE_BTN_LEFT_UP,          
    D4D_MSG_MOUSE_BTN_RIGHT_DOWN,       
    D4D_MSG_MOUSE_BTN_RIGHT_UP,         
    D4D_MSG_MOUSE_BTN_MIDDLE_DOWN,      
    D4D_MSG_MOUSE_BTN_MIDDLE_UP,        
    D4D_MSG_MOUSE_BTN_WHEEL_UP,         
    D4D_MSG_MOUSE_BTN_WHEEL_DOWN,       
    D4D_MSG_MOUSE_ENTER,        
    D4D_MSG_MOUSE_LEAVE,        
    D4D_MSG_TIMETICK            
} D4D_MSGID;

/* the message object */
struct D4D_OBJECT_S;

typedef struct D4D_MESSAGE_S
{
    struct D4D_OBJECT_S* pObject;       
    struct D4D_SCREEN_S* pScreen;       
    D4D_MSGID   nMsgId;                 

    union
    {
        D4D_OBJECT_DRAWFLAGS draw;      
        D4D_KEY_SCANCODE key;           

    } prm;                              

} D4D_MESSAGE;


typedef enum
{
  D4D_MSG_NOSKIP = 0,                
  D4D_MSG_SKIP = 1                  
}D4D_MSG_HANDLER_ACTION;

/*********************************************************
*
* global events
*
*********************************************************/

typedef enum
{
    D4D_EVENT_ONCLICK,          
    D4D_EVENT_ONDOUBLECLICK,    
    D4D_EVENT_ONCHANGE,         
    D4D_EVENT_ONCHANGEDONE,     
    D4D_EVENT_ONRELOAD,         
    D4D_EVENT_ONCLEAR,          

    D4D_EVENT_CNT               
} D4D_EVENTID;

/******************************************************************************
* Internal types
******************************************************************************/

// Internal keys buffer structure
typedef struct
{
  D4D_KEY_SCANCODE buff[D4D_KEYS_BUFF_LENGTH];
  Byte readPos;
  Byte writePos;
} D4D_KEYS_BUFFER;

// Internal touch screen status
typedef Byte D4D_TOUCHSCREEN_STATUS;

#define D4D_TCHSCR_STATUS_TOUCHED       (0x01) // The new touch has to be 0x01
#define D4D_TCHSCR_STATUS_RESERVED      (0x02)
#define D4D_TCHSCR_STATUS_NEWTOUCH      (0x04)
#define D4D_TCHSCR_STATUS_RESERVED1     (0x08)
#define D4D_TCHSCR_STATUS_LOSTTOUCH     (0x10)
#define D4D_TCHSCR_STATUS_NEWRAWEVENT   (0x20)
#define D4D_TCHSCR_STATUS_NEWEVENT      (0x40)
#define D4D_TCHSCR_STATUS_CHECKTOUCH    (0x80)

#define D4D_TCHSCR_STATUS_EVENTS        (0xE0)

// System flags type
typedef Byte D4D_SYSTEM_FLAGS;

// System flag - TimeTick
#define D4D_SYSTEM_F_TIMETICK           (0x01)
#define D4D_SYSTEM_F_SYSTEM_KEYS_DISABLE (0x02)

/******************************************************************************
* D4D Base macros
*
*/
/**************************************************************************/ 
#define D4D_SWAP_WORD(x) D4D_SwapWord(x)

/**************************************************************************/ 
#define D4D_LOG_EXOR(a,b) (!!(a) ^ !!(b))

/**************************************************************************/ 
#define D4D_UNUSED(x) (void)(x);

/**************************************************************************/ 
#define D4D_TEXT_LEN(txt) (sizeof((txt)) / sizeof(D4D_TCHAR))

/*********************************************************
*
* internal macros
*
*********************************************************/
#define D4D_CONST const
#define D4D_NO_CONST

#define D4D_GetKeys() 0 // Just for backward compatibility
/*********************************************************
*
* external macros
*
*********************************************************/

/******************************************************************************
* Begin of D4D_BASE public functions
*/
/**************************************************************************/ 
#define D4D_GetTextBuffWidthTabAdj(text_buffer, pTab) D4D_GetTextBuffWidthTab(text_buffer, pTab)

/**************************************************************************/ 
#define D4D_GetTextBuffWidth(text_buffer) D4D_GetTextBuffWidthTab(text_buffer, NULL)

/******************************************************************************
* Global call back functions
******************************************************************************/

/**************************************************************************/ 
#ifdef D4D_INPUT_EVENT_CALLBACK
   extern void D4D_INPUT_EVENT_CALLBACK(void);
#endif


/******************************************************************************
*       End of public functions                                               */
/******************************************************************************/

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

// global shared memory used by multiple modules as temporary storage
#define D4D_SCRATCHPAD_SIZE 48
extern Byte d4d_scratchPad[D4D_SCRATCHPAD_SIZE];

// assert macro
#define D4D_ASSERT(cond) if(!(cond)) for(;;)

extern const D4D_MARGIN d4d_marginDefault;

#endif /* __D4D_BASE_H */