source/classes/inc/mh5tokenmanager.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 _MH5TOKENMANAGER_H
#define _MH5TOKENMANAGER_H

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

#include "mh5base.h"
#include "mh5root.h"

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

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

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

typedef struct sMHEG5IntList
{
   MHEG5Int number;
   struct sMHEG5IntList *next;
} MHEG5IntList;

typedef struct sMHEG5MovementTable
{
   MHEG5IntList *row;
   struct sMHEG5MovementTable *next;
} MHEG5MovementTable;

typedef struct
{
   /* No base class for this class (mix-in) */

   /* Exchanged attributes */
   MHEG5MovementTable *movementTable;

   /* Internal attributes */
   MHEG5Int tokenPosition;
} MHEG5TokenManager;

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

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

/*
   Debug
 */
#ifdef MH5PRINTOUT

void MHEG5tokenManagerPrint(MHEG5TokenManager *tokenManager, char *out);

void MHEG5intListPrint(MHEG5IntList *intList, char *out);

void MHEG5movementTablePrint(MHEG5MovementTable *movementTable, char *out);


#endif /* MH5PRINTOUT */


/*
   Constructor
 */
void MHEG5tokenManagerInit(MHEG5TokenManager *tokenManager);


void MHEG5tokenManagerPrepare(MHEG5TokenManager *tokenManager);


void MHEG5tokenManagerFree(MHEG5TokenManager *tokenManager);


void MHEG5tokenManagerAddRow(MHEG5TokenManager *tokenManager);
void MHEG5tokenManagerAddNumber(MHEG5TokenManager *tokenManager, MHEG5Int number);

/*
   Copy Constructor
 */
void MHEG5tokenManagerCopy(MHEG5TokenManager *destination, MHEG5TokenManager *source);

/*
   Internal behaviours
 */
void MHEG5tokenManagerPrepare(MHEG5TokenManager *tokenManager);
void MHEG5tokenManagerDestruct(MHEG5TokenManager *tokenManager);

/*
   Actions
 */
MHEG5ErrorCode MHEG5move(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5moveTo(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5getTokenPosition(MHEG5Root *target, MHEG5GList *params);

#endif /*_MH5TOKENMANAGER_H*/