source/classes/inc/mh5link.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 _MH5LINK_H
#define _MH5LINK_H

/*---includes for this file--------------------------------------------------*/
#include "mh5ingredient.h"
#include "mh5action.h"

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

#define HTEXT_TOP_STR   1
#define HTEXT_BOT_STR   2

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

/*---Global type defs for public use-----------------------------------------*/
typedef struct sMHEG5Link
{
   /* Base class */
   MHEG5Ingredient ingredient;

   /* Exchanged attributes */
   MH5GroupRef sourcegid;           /* \                    */
   MHEG5Int source;                 /*  | LinkCondition     */
   MHEG5EventType eventType;        /*  |                   */
   MHEG5Generic eventData;          /* /                    */
   MHEG5ActionList linkEffect;

   /* No internal attributes for this class */

   /* Engine data */
   struct sMHEG5Link *nextActiveLink;       /* Pointer to the next currently */
                                            /* active link */
} MHEG5Link;

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

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

void MHEG5linkInit(MHEG5Link *link);


void MHEG5linkFree(MHEG5Link *link);


/*
     Internal behaviours
 */
void MHEG5linkPrepare(MHEG5Link *link);
void MHEG5linkDestruct(MHEG5Link *link);
void MHEG5linkActivate(MHEG5Link *link);
void MHEG5linkDeactivate(MHEG5Link *link);
U8BIT* MHEG5linkEventName( MHEG5Link *link );

/*
    Actions
 */
MHEG5ErrorCode MHEG5activate(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5deactivate(MHEG5Root *target, MHEG5GList *params);

/*
    Internal Engine Functions
 */

int LNK_RegisterString( MHEG5String s );
int LNK_GetStringIndex( MHEG5String s );
MHEG5String LNK_GetString( int i );


void initialiseActiveLinkQs(void);

#ifdef MH5PRINTOUT
void MHEG5linkPrint(MHEG5Link *link, char *out);
#endif

extern MHEG5Link *activeLinksHead[MHEG5LASTEVENT + 1];
extern unsigned int existsLinkCount[MHEG5LASTEVENT + 1];

#endif /*_MH5LINK_H*/