source/classes/inc/mh5variable.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 _MH5VARIABLE_H
#define _MH5VARIABLE_H

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

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

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

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

   /* Exchanged attributes (from Variable class) */
   MHEG5Bool originalValue;

   /* Internal attributes (from Variable class) */
   MHEG5Bool value;
} MHEG5BooleanVariable;


typedef struct
{
   /* Base class */
   MHEG5Ingredient ingredient;

   /* Exchanged attributes (from Variable class) */
   MHEG5Int originalValue;

   /* Internal attributes (from Variable class) */
   MHEG5Int value;
} MHEG5IntegerVariable;


typedef struct
{
   /* Base class */
   MHEG5Ingredient ingredient;

   /* Exchanged attributes (from Variable class) */
   MHEG5String originalValue;

   /* Internal attributes (from Variable class) */
   MHEG5String value;
} MHEG5OctetStringVariable;


typedef struct
{
   /* Base class */
   MHEG5Ingredient ingredient;

   /* Exchanged attributes (from Variable class) */
   MH5GroupRef originalValueGid;
   MHEG5Int originalValueId;

   /* Internal attributes (from Variable class) */
   MHEG5Int valueId;
   MHEG5String valueGrp;
} MHEG5ObjectRefVariable;


typedef struct
{
   /* Base class */
   MHEG5Ingredient ingredient;

   /* Exchanged attributes (from Variable class) */
   MHEG5String originalContentData;

   /* Internal attributes (from Variable class) */
   MHEG5String contentData;
} MHEG5ContentVariable;

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

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

void MHEG5booleanVariableInit(MHEG5BooleanVariable *variable);


void MHEG5booleanVariablePrepare(MHEG5BooleanVariable *variable);


void MHEG5booleanVariableFree(MHEG5BooleanVariable *variable);


void MHEG5integerVariableInit(MHEG5IntegerVariable *variable);


void MHEG5integerVariablePrepare(MHEG5IntegerVariable *variable);


void MHEG5integerVariableFree(MHEG5IntegerVariable *variable);


void MHEG5octetStringVariableInit(MHEG5OctetStringVariable *variable);


void MHEG5octetStringVariablePrepare(
   MHEG5OctetStringVariable *variable);


void MHEG5octetStringVariableFree(MHEG5OctetStringVariable *variable);

void MHEG5octetStringVariableDestruct(MHEG5OctetStringVariable *variable);

void MHEG5objectRefVariableInit(MHEG5ObjectRefVariable *variable);

void MHEG5objectRefVariablePrepare(
   MHEG5ObjectRefVariable *variable);


void MHEG5objectRefVariableFree(MHEG5ObjectRefVariable *variable);


void MHEG5contentVariableInit(MHEG5ContentVariable *variable);


void MHEG5contentVariablePrepare(MHEG5ContentVariable *variable);


void MHEG5contentVariableFree(MHEG5ContentVariable *variable);

void MHEG5contentVariableDestruct(MHEG5ContentVariable *variable);

void MHEG5objRefStoreValue( MHEG5ObjectRefVariable *objRef, MH5GroupRef ref, MHEG5Int id );
void MHEG5objRefStoreString( MHEG5ObjectRefVariable *objRef, MHEG5String ref, MHEG5Int id );

/*
    Internal behaviours
 */
void MHEG5variablePrepare(MHEG5Ingredient *variable);
void MHEG5variableActivate(MHEG5Ingredient *variable);
void MHEG5variableDeactivate(MHEG5Ingredient *variable);
void MHEG5variableDestruct(MHEG5Ingredient *variable);

/*
    Actions
 */
MHEG5ErrorCode MHEG5setVariable(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5testVariable(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5add(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5subtract(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5multiply(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5divide(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5modulo(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5append(MHEG5Root *target, MHEG5GList *params);

/*
    Store/Read Persistant helper functions
 */
/*
   Store the value of the Variable in the Buffer and Return number of Bytes used.
   Return -1 for failure
 */
MHEG5Int MHEG5variableStore(MHEG5Ingredient *v, void *buf, MHEG5Int bufLen);

/*
   Set the Variable to the Buffer values and Return the Number of Bytes read.
   Return -1 for failure
 */
MHEG5Int MHEG5variableRead(MHEG5Ingredient *v, char *buf, MHEG5Int max_size);

/*
   Debug
 */
#ifdef MH5PRINTOUT

void MHEG5variablePrint(MHEG5Ingredient *variable, char *out);

void MHEG5booleanVariablePrint(MHEG5BooleanVariable *v, char *out);

void MHEG5integerVariablePrint(MHEG5IntegerVariable *v, char *out);

void MHEG5stringVariablePrint(MHEG5OctetStringVariable *v, char *out);

void MHEG5oRefVariablePrint(MHEG5ObjectRefVariable *v, char *out);

void MHEG5cRefVariablePrint(MHEG5ContentVariable *v, char *out);

#endif /* MH5PRINTOUT */


#endif /*_MH5VARIABLE_H*/