source/core/inc/mh5base.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _MH5BASE_H
#define _MH5BASE_H

/*---includes for this file--------------------------------------------------*/

#include <stdio.h>

#include "techtype.h"
#include "glue_debug.h"

/*---Constant and macro definitions for public use---------------------------*/

/* Rules for version number:
   Realeases to customers             : n.n
   Minor releases to testers/internal : n.nbn
   Modified minor releases            : n.nbn+

   Example version sequence: 1.2, 1.3b0+, 1.3b1, 1.3b1+, 1.3b2, 1.3b2+, 1.3, ...
 */

/* Boolean values */
#define MHEG5FALSE          (0)
#define MHEG5TRUE           (-1)

#ifndef MHG_STRNCMP
#define MHEG5strncmp(a, b, n)    strncmp((char *)a, (char *)b, n)
#endif  /* #ifdef MHG_STRNCMP */

#ifndef MHG_STRCMP
#define MHEG5strcmp(a, b)    strcmp((char *)a, (char *)b)
#endif  /* #ifdef MHG_STRCMP */

#define INVALID_GRP_REF    0

/*---Enumerations for public use---------------------------------------------*/

/*---Global type defs for public use-----------------------------------------*/

/*
     Simple Types
 */
typedef short MHEG5Bool;
typedef short MHEG5Short;
typedef long MHEG5Int;
typedef unsigned char MHEG5Byte;

typedef struct SMHEG5IntPair
{
   MHEG5Int x;
   MHEG5Int y;
} MHEG5IntPair;

typedef struct sMHEG5String
{
   MHEG5Int len;
   MHEG5Byte *data;
} MHEG5String;

/* forward declaration of group structure */
typedef struct sMHEG5Group sMHEG5Group;

/* unique id for each new group created */
typedef MHEG5Int MH5GroupId;

/* forward declaration of pointer to group structure */
typedef struct sMHEG5Group *MH5GroupPtr;

typedef struct  sMH5GroupRef
{
   MHEG5Int len;  /* if (len == 0) 'pgrp' points to group, else len is string length of 'name' */
   union
   {
      MHEG5Byte *name;
      MH5GroupPtr group;
   } ptr;
} MH5GroupRef;

typedef struct sMHEG5ObjectReference
{
   MHEG5Int id;
   MH5GroupRef gref;
} MHEG5ObjectReference;


typedef enum
{
   MHEG5NONEEVENT,
   /* Synchronous events */
   MHEG5ISAVAILABLE, MHEG5ISDELETED, MHEG5ISRUNNING, MHEG5ISSTOPPED,
   MHEG5TOKENMOVEDFROM, MHEG5TOKENMOVEDTO, MHEG5HIGHLIGHTON, MHEG5HIGHLIGHTOFF,
   MHEG5ISSELECTED, MHEG5ISDESELECTED, MHEG5TESTEVENT,
   MHEG5HEADITEMS, MHEG5TAILITEMS, MHEG5FIRSTITEMPRESENTED,
   MHEG5ITEMSELECTED, MHEG5ITEMDESELECTED, MHEG5LASTITEMPRESENTED,
   /* Asynchronous events */
   MHEG5ANCHORFIRED, MHEG5ASYNCHSTOPPED, MHEG5CONTENTAVAILABLE,
   MHEG5COUNTERTRIGGER, MHEG5CURSORENTER, MHEG5CURSORLEAVE,
   MHEG5ENGINEEVENT, MHEG5ENTRYFIELDFULL, MHEG5FOCUSMOVED,
   MHEG5INTERACTIONCOMPLETED, MHEG5SLIDERVALUECHANGED,
   MHEG5STREAMEVENT, MHEG5STREAMPLAYING, MHEG5STREAMSTOPPED,
   MHEG5TIMERFIRED, MHEG5USERINPUT,
   /* dummy last event */
   MHEG5LASTEVENT
} MHEG5EventType;


/*
     special MEGA-Type for holding a lot of MHEG5 types
 */
typedef enum
{
   MHEG5NONE, MHEG5INT, MHEG5BOOL, MHEG5NULL, MHEG5OCTETSTRING,
   MHEG5BRACKETOPEN, MHEG5BRACKETCLOSE, MHEG5EVENT, MHEG5CONTENTREF,
   MHEG5INTPAIR, MHEG5OBJECTREF, MHEG5OBJREFEXT, MHEG5CONTENTSIZE, MHEG5CONTENTCCP
} E_ParamTypes;

typedef MHEG5Bool MHEG5Boolean;

typedef struct
{
   U8BIT indirect;
   U8BIT isfirst;
   U16BIT type;
   union
   {
      MHEG5Int i;
      MHEG5Bool b;
      MHEG5String s;
      MHEG5EventType e;
      MHEG5IntPair p;
      MHEG5ObjectReference o;
   } value;
} MHEG5Generic;




/*
     List of Generic Items
 */
struct sMHEG5GList
{
   MHEG5Generic generic;
   struct sMHEG5GList *next;
};

typedef struct sMHEG5GList MHEG5GList;

typedef MHEG5Generic MHEG5Colour;

typedef struct sParamList
{
   MHEG5Int total;
   MHEG5GList *params;
} ParamList;



/*
     MHEG5 Finals
 */
typedef enum
{
   MHEG5SCENE, MHEG5APPLICATION, MHEG5LINK, MHEG5PALETTE, MHEG5CURSORSHAPE,
   MHEG5FONT, MHEG5RESIDENTPROGRAM, MHEG5REMOTEPROGRAM, MHEG5INTERCHANGEDPROGRAM,
   MHEG5BOOLEANVARIABLE, MHEG5INTEGERVARIABLE,
   MHEG5OCTETSTRINGVARIABLE, MHEG5OBJECTREFVARIABLE, MHEG5CONTENTREFVARIABLE,
   MHEG5STREAM, MHEG5AUDIO, MHEG5TOKENGROUP, MHEG5LISTGROUP, MHEG5RTGRAPHICS,
   MHEG5LINEART, MHEG5BITMAP, MHEG5TEXT, MHEG5VIDEO, MHEG5SLIDER, MHEG5DYNAMICLINEART,
   MHEG5RECTANGLE, MHEG5ENTRYFIELD, MHEG5HYPERTEXT, MHEG5HOTSPOT, MHEG5PUSHBUTTON,
   MHEG5SWITCHBUTTON
} MHEG5Final;


typedef enum
{
   MHEG5LEFT, MHEG5RIGHT, MHEG5UP, MHEG5DOWN
} MHEG5Orientation;

typedef enum
{
   MHEG5NORMAL, MHEG5THERMOMETER, MHEG5PROPORTIONAL
} MHEG5SliderStyle;

typedef enum
{
   MHEG5PUSHBUTTONS, MHEG5RADIOBUTTON, MHEG5CHECKBOX
} MHEG5PushbuttonStyle;


/*
     Error Codes
 */
typedef enum
{
   MHEG5ERR_NOERROR,
   MHEG5ERR_NOTYETSUPPORTED,
   MHEG5ERR_NOTSUPPORTEDBYPROFILE,
   MHEG5ERR_WRONGNUMBEROFPARAMS,
   MHEG5ERR_TARGETNOTAVAILABLE,
   MHEG5ERR_WRONGTARGET,
   MHEG5ERR_REFERENCEDPARAMNOTAVAILABLE,
   MHEG5ERR_WRONGPARAM,
   MHEG5ERR_PARAMNOTACTIVE,
   MHEG5ERR_NOSCENE,
   MHEG5ERR_TARGETNOTACTIVE,
   MHEG5ERR_NOSUCHITEM,
   MHEG5ERR_NOSUCHSLOT,
   MHEG5ERR_IGNORE_ACTION          /* Used by Launch, Spawn and TransitionTo */
} MHEG5ErrorCode;

typedef struct sMHEG5FontBody
{
   MHEG5Bool referenced;
   union
   {
      MHEG5String included;
      struct
      {
         MHEG5Int id;
         MH5GroupRef grp;
      } referenced;
   } ref;
} MHEG5FontBody;


typedef enum
{
   SCENE_RATIO_16x9,
   SCENE_RATIO_4x3,
   SCENE_RATIO_UNSPECIFIED
} MHEG5SceneRatio_t;

/*---Global variable declarations for public use-----------------------------*/

/*---Global Function prototypes for public use-------------------------------*/

#ifdef MHG_TRACK_MEM
MHEG5String MHEG5stringCopyFunc(MHEG5String source, int line );
#define MHEG5stringCopy(s)   MHEG5stringCopyFunc(s, __LINE__)
#else
MHEG5String MHEG5stringCopy(MHEG5String source);
#endif
MHEG5String MHEG5stringCopyChr(const char *source);
MHEG5String MHEG5stringCat(MHEG5String string1, MHEG5String string2);
void MHEG5stringDestruct(MHEG5String *item);
MHEG5Int MHEG5strToInt(MHEG5String string);
MHEG5Bool MHEG5stringEqual(MHEG5String *s1, MHEG5String *s2);
MHEG5String MHEG5intToStr(MHEG5Int i);

#ifdef MHEG5LOG

char* MHEG5stringGet(MHEG5String source);

#endif

void MHEG5genericInit(MHEG5Generic *item);
void MHEG5genericSet(MHEG5Generic *item, MHEG5Int initialValue);
void MHEG5genericBSet(MHEG5Generic *item, MHEG5Bool initialValue);
void MHEG5genericSSet(MHEG5Generic *item, char *initialValue);
void MHEG5genericDestruct(MHEG5Generic *item);
MHEG5Bool MHEG5genericEqual(MHEG5Generic *g1, MHEG5Generic *g2);
void MHEG5genericCopy(MHEG5Generic *dest, MHEG5Generic *src);

void MHEG5gListDestruct(MHEG5GList *item);
MHEG5GList* MHEG5gListCopy(MHEG5GList *list);
void MHEG5colourInit(MHEG5Colour *item, MHEG5Int initialValue);
void MHEG5colourDestruct(MHEG5Colour *item);

#ifdef MHG_STRNCMP

int MHEG5strncmp(char *a, char *b, int n);

#endif  /* #ifdef MHG_STRNCMP */

#ifdef MHG_STRCMP

int MHEG5strcmp(char *a, char *b);

#endif  /* #ifdef MHG_STRCMP */

unsigned long MHEG5random(void);


char* MHEG5safeStrcat(char *dest, size_t destLength,
   const char *source);


#ifdef _WIN32_WCE
TCHAR* StrToUnicode(char *string);
char* StrFromUnicode(TCHAR *string);
#endif

/*
   Debug
 */
#ifdef MH5PRINTOUT
void MHEG5classPrint(MHEG5Final class, char *out);
void MHEG5indent(char *out);
int  MHEG5setIndent(int i);
void MHEG5incIndent(void);
void MHEG5decIndent(void);
void MHEG5newLine(char *out);

#define MHEG_PRINT(out, str)  STB_DebugLogPrintf(str)
#define MHEG5intPrint(i, out) STB_DebugLogPrintf("%ld", i)
#define MHEG5hexPrint(i, out) STB_DebugLogPrintf("%#x", i)
#endif  /* #ifdef MH5PRINTOUT */

#if defined(MHEG5LOG) || defined(MH5PRINTOUT)
void MHEG5eventPrint(MHEG5EventType e, char *out);
void MHEG5stringPrint(MHEG5String s, char *out);
void MHEG5objectrefPrint(MHEG5ObjectReference o, char *out);
void MHEG5boolPrint(MHEG5Bool b, char *out);
void MHEG5genericPrint(MHEG5Generic g, char *out, U8BIT dotype);
void MHEG5colourPrint(MHEG5Colour c, char *out);
void MHEG5gListPrint(MHEG5GList *l, char *out, U8BIT noTypeCnt);
void MHEG5cListPrint(MHEG5GList *l, char *out);
void MHEG5sdListPrint(MHEG5GList *l, char *out);
void MHEG5clrListPrint(MHEG5GList *l, char *out);
#endif  /* #ifdef MHEG5LOG */

#ifdef TRACING
extern int extra_trace_param;
#endif

#endif /*_MH5BASE_H*/