d4d_string.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_STRING_H
#define __D4D_STRING_H

/******************************************************************************
* Includes
******************************************************************************/
#include "common_files/d4d_font.h"
/******************************************************************************
* D4D STRING setting  constants
*
*/
#ifndef D4D_STR_TABLE_MAX_CNT
  #define D4D_STR_TABLE_MAX_CNT 4
#endif

/******************************************************************************
* Private constants - obsolete
******************************************************************************/
// just for backward compatibility
#define D4D_TXT_PRTY_ALIGN_H_MASK                D4D_ALIGN_H_MASK
#define D4D_TXT_PRTY_ALIGN_H_LEFT_MASK           D4D_ALIGN_H_LEFT_MASK
#define D4D_TXT_PRTY_ALIGN_H_RIGHT_MASK          D4D_ALIGN_H_RIGHT_MASK
#define D4D_TXT_PRTY_ALIGN_H_CENTER_MASK         D4D_ALIGN_H_CENTER_MASK

#define D4D_TXT_PRTY_ALIGN_V_MASK                D4D_ALIGN_V_MASK
#define D4D_TXT_PRTY_ALIGN_V_TOP_MASK            D4D_ALIGN_V_TOP_MASK
#define D4D_TXT_PRTY_ALIGN_V_BOTTOM_MASK         D4D_ALIGN_V_BOTTOM_MASK
#define D4D_TXT_PRTY_ALIGN_V_CENTER_MASK         D4D_ALIGN_V_CENTER_MASK

/******************************************************************************
* D4D STRING setting  types
*
*/
typedef Byte D4D_TEXT_PROPERTIES;

typedef struct D4D_STR_PROPERTIES_S
{
  D4D_FONT_PROPERTIES font_properties;  
  D4D_TEXT_PROPERTIES text_properties;  
}D4D_STR_PROPERTIES;

typedef struct D4D_STRING_S
{
  D4D_TCHAR *pText;                     
  D4D_INDEX buffSize;                   
  D4D_FONT fontId;                      
  D4D_STR_PROPERTIES *str_properties;   
  D4D_INDEX printLen;                   
  D4D_INDEX printOff;                   
}D4D_STRING;

/******************************************************************************
* Private types
******************************************************************************/

typedef struct
{
  D4D_INDEX     stringId;
  D4D_TCHAR**   stringTable;
  D4D_INDEX     stringCount;
}D4D_STRING_TABLE;

/******************************************************************************
* D4D Object macros
*
*/
/**************************************************************************/ 
#define D4D_DECLARE_STRING_TABLE_BEGIN  D4D_DECLARE_USR_STRING_TABLE_BEGIN(d4d_StringTable)

/**************************************************************************/ 
#define D4D_DECLARE_USR_STRING_TABLE_BEGIN(name)  const D4D_STRING_TABLE name[] = {

/**************************************************************************/ 
#define D4D_DECLARE_STRING(stringId, string_table) \
  {stringId, (D4D_TCHAR**)string_table, (sizeof(string_table) / sizeof(D4D_TCHAR*))}, // string info will be replaced by string descriptor

/**************************************************************************/ 
#define D4D_DECLARE_STRING_TABLE_END {0, NULL, 0} };

/**************************************************************************/ 
#define D4D_DECLARE_TAB_TABLE_BEGIN(name)  const D4D_COOR name[] = {

/**************************************************************************/ 
#define D4D_DECLARE_TAB(tab) tab, // tab space in pixels

/**************************************************************************/ 
#define D4D_DECLARE_TAB_TABLE_END 0 };

#ifdef D4D_UNICODE
  /**************************************************************************/ 
  #define D4D_DEFSTR(str) L##str
#else
  /**************************************************************************/ 
  #define D4D_DEFSTR(str) str
#endif


/**************************************************************************/ 
#define D4D_IsDigit(x) (((x)>= '0') && ((x)<= '9'))

/******************************************************************************
* Private macros
******************************************************************************/
#define D4D_StringTable_GetCount(x) (sizeof(x) / sizeof(D4D_TCHAR*))

/******************************************************************************
* Global variables
******************************************************************************/
extern const D4D_STRING_TABLE d4d_StringTable[];
/******************************************************************************
* Global functions
******************************************************************************/
D4D_TCHAR* D4D_GetInternalStringPointer(const D4D_TCHAR* originTxt);
void D4D_ChangeStringTable(LWord stringId);
LWord D4D_GetCurrentStringId(void);
void D4D_LCD_PrintStr(D4D_PRINT_DESC* p_StrDes);
#if D4D_EXTSRC_FILE_ENABLE != D4D_FALSE

#endif

#endif  /* __D4D_STRING_H */