Implement basic functions for the MHEG5 defined basic data types. More...

#include "mh5memory.h"
#include "mh5base.h"
#include "mh5debug.h"
#include "stb_os.h"
#include <string.h>
#include <stdlib.h>

Functions
MHEG5String	MHEG5stringCopy (MHEG5String source)
	<Function description>=""> More...

MHEG5String	MHEG5stringCopyChr (const char *source)
	Copy the C-String source to a MHEG5String. More...

MHEG5String	MHEG5stringCat (MHEG5String source1, MHEG5String source2)
	Concatenate two MHEG5Strings. More...

void	MHEG5stringDestruct (MHEG5String *item)
	Destruct a MHEG5String. More...

MHEG5Bool	MHEG5stringEqual (MHEG5String s1, MHEG5String s2)
	Compare two Strings (case sensitive!) More...

MHEG5Int	MHEG5strToInt (MHEG5String string)
	Convert a MHEG5String to a MHEG5Integer. More...

MHEG5String	MHEG5intToStr (MHEG5Int i)
	Convert MHEG5Int to MHEG5String. More...

void	MHEG5genericInit (MHEG5Generic *item)
	Initialize an empty MHEG5Generic. More...

void	MHEG5genericDestruct (MHEG5Generic *item)
	Destruct a MHEG5Generic. More...

void	MHEG5genericCopy (MHEG5Generic dest, MHEG5Generic src)
	Copy a MHEG5Generic. More...

MHEG5Bool	MHEG5genericEqual (MHEG5Generic g1, MHEG5Generic g2)
	Compare two generic Variables. More...

void	MHEG5gListDestruct (MHEG5GList *item)
	Destruct a list of MHEG5Generic objects. More...

MHEG5GList *	MHEG5gListCopy (MHEG5GList *list)
	Copy a list of MHEG5Generic objects. More...

void	MHEG5genericSet (MHEG5Generic *item, MHEG5Int initialValue)
	Set a MHEG5Generic to the MHEG5Int value. More...

void	MHEG5genericBSet (MHEG5Generic *item, MHEG5Bool initialValue)
	Set a MHEG5Generic to the MHEG5Bool value. More...

void	MHEG5genericSSet (MHEG5Generic item, char initialValue)

void	MHEG5colourInit (MHEG5Colour *item, MHEG5Int initialValue)
	Initialize a MHEG5Colour with the initial value MHEG5Int. More...

void	MHEG5colourDestruct (MHEG5Colour *item)
	Destruct a MHEG5Colour object. More...

unsigned long	MHEG5random (void)
	Calculate and return a psuedo random number. More...

char *	MHEG5safeStrcat (char dest, size_t destLength, const char source)
	Perform a standard strcat restricted to the length of the destination. The dest string will always be null terminated. More...

Detailed Description

Implement basic functions for the MHEG5 defined basic data types.

Date: 29/01/2002

Author: iwillis

Function Documentation

void MHEG5colourDestruct ( MHEG5Colour * item )

Destruct a MHEG5Colour object.

Parameters

MHEG5Colour * item

Returns: void

void MHEG5colourInit	(	MHEG5Colour *	item,
		MHEG5Int	initialValue
	)

Initialize a MHEG5Colour with the initial value MHEG5Int.

Parameters

MHEG5Colour	* item
MHEG5Int	initialValue

Returns: void

void MHEG5genericBSet	(	MHEG5Generic *	item,
		MHEG5Bool	initialValue
	)

Set a MHEG5Generic to the MHEG5Bool value.

Parameters

MHEG5Generic	* item
MHEG5Bool	initialValue

Returns: void

void MHEG5genericCopy	(	MHEG5Generic *	dest,
		MHEG5Generic *	src
	)

Copy a MHEG5Generic.

Parameters

MHEG5Generic	* dest
MHEG5Generic	* src

Returns: void

void MHEG5genericDestruct ( MHEG5Generic * item )

Destruct a MHEG5Generic.

Parameters

MHEG5Generic * item

Returns: void

MHEG5Bool MHEG5genericEqual	(	MHEG5Generic *	g1,
		MHEG5Generic *	g2
	)

Compare two generic Variables.

Parameters

MHEG5Generic	* g1
MHEG5Generic	* g2

Returns: MHEG5Bool MHEG5Bool

void MHEG5genericInit ( MHEG5Generic * item )

Initialize an empty MHEG5Generic.

Parameters

MHEG5Generic * item

Returns: void

void MHEG5genericSet	(	MHEG5Generic *	item,
		MHEG5Int	initialValue
	)

Set a MHEG5Generic to the MHEG5Int value.

Parameters

MHEG5Generic	* item
MHEG5Int	initialValue

Returns: void

void MHEG5genericSSet	(	MHEG5Generic *	item,
		char *	initialValue
	)

MHEG5GList* MHEG5gListCopy ( MHEG5GList * list )

Copy a list of MHEG5Generic objects.

Parameters

MHEG5GList *list

Returns: MHEG5GList * Pointer to the first element of the new MHEG5GList

void MHEG5gListDestruct ( MHEG5GList * item )

Destruct a list of MHEG5Generic objects.

Parameters

MHEG5GList *item

Returns: void

MHEG5String MHEG5intToStr ( MHEG5Int i )

Convert MHEG5Int to MHEG5String.

Parameters

MHEG5Int i

Returns: MHEG5String MHEG5String

unsigned long MHEG5random ( void )

Calculate and return a psuedo random number.

Returns: Next random number in the sequence

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

Perform a standard strcat restricted to the length of the destination. The dest string will always be null terminated.

Parameters

dest	Destination to concatenate string to.
destLength	Maximum length of the destination string, including null termination.
source	Null terminated string to concatenate with the destination.

Returns: Pointer to dest

MHEG5String MHEG5stringCat	(	MHEG5String	source1,
		MHEG5String	source2
	)

Concatenate two MHEG5Strings.

Parameters

MHEG5String	source1
MHEG5String	source2

Returns: MHEG5String MHEG5String

MHEG5String MHEG5stringCopy ( MHEG5String source )

Returns: <Return value>=""> Copy a MHEG5String and return the new MHEG5String

Parameters

MHEG5String source

Returns: MHEG5String MHEG5String

MHEG5String MHEG5stringCopyChr ( const char * source )

Copy the C-String source to a MHEG5String.

Parameters

char *source

Returns: MHEG5String MHEG5String

void MHEG5stringDestruct ( MHEG5String * item )

Destruct a MHEG5String.

Parameters

MHEG5String item

Returns: void

MHEG5Bool MHEG5stringEqual	(	MHEG5String *	s1,
		MHEG5String *	s2
	)

Compare two Strings (case sensitive!)

Parameters

MHEG5String	s1
MHEG5String	s2

Returns: MHEG5Bool MHEG5Bool

MHEG5Int MHEG5strToInt ( MHEG5String string )

Convert a MHEG5String to a MHEG5Integer.

Parameters

MHEG5String string

Returns: MHEG5Int MHEG5Int

Functions

Detailed Description

Function Documentation