Macro variables
[HTTP Interface]

Collaboration diagram for Macro variables:

These variables can be used in the <vlc> macros and in the RPN evaluator. More...

Data Structures
struct	mvar_s
struct	mvar_t
	This structure defines a macro variable. More...
Typedefs
typedef struct mvar_s	mvar_t
Functions
mvar_t *	mvar_New (const char *name, const char *value)
	This function creates a new variable.
void	mvar_Delete (mvar_t *v)
	This function deletes a variable.
void	mvar_AppendVar (mvar_t *v, mvar_t *f)
	This function adds f to the children variables of v, at last position.
mvar_t *	mvar_Duplicate (const mvar_t *v)
	This function duplicates a variable.
void	mvar_PushVar (mvar_t *v, mvar_t *f)
	This function adds f to the children variables of v, at fist position.
void	mvar_RemoveVar (mvar_t *v, mvar_t *f)
	This function removes f from the children variables of v.
mvar_t *	mvar_GetVar (mvar_t *s, const char *name)
	This function retrieves the child variable named "name".
const char *	mvar_GetValue (mvar_t *v, const char *field)
	This function retrieves the value of the child variable named "field".
void	mvar_PushNewVar (mvar_t *vars, const char *name, const char *value)
	This function creates a variable with the given name and value and adds it as first child of vars.
void	mvar_AppendNewVar (mvar_t *vars, const char *name, const char *value)
	This function creates a variable with the given name and value and adds it as last child of vars.

---

Detailed Description

These variables can be used in the <vlc> macros and in the RPN evaluator.

The variables make a tree: each variable can have an arbitrary number of "children" variables. A number of helper functions are provided to manipulate the main variable structure

---

Typedef Documentation

typedef struct mvar_s mvar_t

---

Function Documentation

void mvar_AppendNewVar	(	mvar_t *	vars,
		const char *	name,
		const char *	value
	)

This function creates a variable with the given name and value and adds it as last child of vars.

References mvar_AppendVar(), and mvar_New().

Referenced by EvaluateRPN(), MacroDo(), mvar_FileSetNew(), mvar_InfoSetNew(), mvar_InputVarSetNew(), mvar_ObjectSetNew(), mvar_VlmSetNewLoop(), ParseExecute(), and PlaylistListNode().

void mvar_AppendVar	(	mvar_t *	v,
		mvar_t *	f
	)

This function adds f to the children variables of v, at last position.

Referenced by mvar_AppendNewVar(), mvar_Duplicate(), mvar_FileSetNew(), mvar_InfoSetNew(), mvar_InputVarSetNew(), mvar_ObjectSetNew(), mvar_VlmSetNewLoop(), and PlaylistListNode().

void mvar_Delete

(

mvar_t *

v

)

This function deletes a variable.

References i, and mvar_Delete().

Referenced by Execute(), mvar_Delete(), and ParseExecute().

mvar_t* mvar_Duplicate

(

const mvar_t *

v

)

This function duplicates a variable.

References i, mvar_AppendVar(), mvar_Duplicate(), and mvar_New().

Referenced by Execute(), and mvar_Duplicate().

const char* mvar_GetValue	(	mvar_t *	v,
		const char *	field
	)

This function retrieves the value of the child variable named "field".

References mvar_GetVar().

Referenced by EvaluateRPN(), MacroDo(), and SSPopN().

mvar_t* mvar_GetVar	(	mvar_t *	s,
		const char *	name
	)

This function retrieves the child variable named "name".

References i, mvar_GetVar(), and strlcpy().

Referenced by Execute(), mvar_GetValue(), and mvar_GetVar().

mvar_t* mvar_New	(	const char *	name,
		const char *	value
	)

This function creates a new variable.

References strdup().

Referenced by mvar_AppendNewVar(), mvar_Duplicate(), mvar_FileSetNew(), mvar_InfoSetNew(), mvar_InputVarSetNew(), mvar_IntegerSetNew(), mvar_ObjectSetNew(), mvar_PlaylistSetNew(), mvar_PushNewVar(), mvar_VlmSetNew(), mvar_VlmSetNewLoop(), ParseExecute(), and PlaylistListNode().

void mvar_PushNewVar	(	mvar_t *	vars,
		const char *	name,
		const char *	value
	)

This function creates a variable with the given name and value and adds it as first child of vars.

References mvar_New(), and mvar_PushVar().

Referenced by EvaluateRPN(), and mvar_IntegerSetNew().

void mvar_PushVar	(	mvar_t *	v,
		mvar_t *	f
	)

This function adds f to the children variables of v, at fist position.

Referenced by Execute(), and mvar_PushNewVar().

void mvar_RemoveVar	(	mvar_t *	v,
		mvar_t *	f
	)

This function removes f from the children variables of v.

References i.

Referenced by Execute().