cargument.h File Reference

#include <cybergarage/typedef.h>
#include <cybergarage/xml/cxml.h>
#include <cybergarage/util/clist.h>

Data Structures
struct	_CgUpnpArgument
Defines
#define	CG_UPNP_ARGUMENT_ELEM_NAME   "argument"
#define	CG_UPNP_ARGUMENTLIST_ELEM_NAME   "argumentList"
#define	CG_UPNP_ARGUMENT_IN_DIR   "in"
#define	CG_UPNP_ARGUMENT_OUT_DIR   "out"
#define	CG_UPNP_ARGUMENT_NAME   "name"
#define	CG_UPNP_ARGUMENT_DIRECTION   "direction"
#define	CG_UPNP_ARGUMENT_RELATED_STATE_VARIABLE   "relatedStateVariable"
#define	cg_upnp_argument_next(arg)   (CgUpnpArgument *)cg_list_next((CgList *)arg)
#define	cg_upnp_argument_isargumentnode(node)   cg_xml_node_isname(node, CG_UPNP_ARGUMENT_ELEM_NAME)
#define	cg_upnp_argument_setservicenode(arg, node)   (arg->serviceNode = node)
#define	cg_upnp_argument_getservicenode(arg)   (arg->serviceNode)
#define	cg_upnp_argument_setargumentnode(arg, node)   (arg->argumentNode = node)
#define	cg_upnp_argument_getargumentnode(arg)   (arg->argumentNode)
#define	cg_upnp_argument_setname(arg, value)   cg_xml_node_setchildnode(cg_upnp_argument_getargumentnode(arg), CG_UPNP_ARGUMENT_NAME, value)
#define	cg_upnp_argument_getname(arg)   cg_xml_node_getchildnodevalue(cg_upnp_argument_getargumentnode(arg), CG_UPNP_ARGUMENT_NAME)
#define	cg_upnp_argument_isname(arg, name)   cg_streq(cg_upnp_argument_getname(arg), name)
#define	cg_upnp_argument_setdirection(arg, value)   cg_xml_node_setchildnode(cg_upnp_argument_getargumentnode(arg), CG_UPNP_ARGUMENT_DIRECTION, value)
#define	cg_upnp_argument_getdirection(arg)   cg_xml_node_getchildnodevalue(cg_upnp_argument_getargumentnode(arg), CG_UPNP_ARGUMENT_DIRECTION)
#define	cg_upnp_argument_isindirection(arg)   cg_streq(cg_upnp_argument_getdirection(arg), CG_UPNP_ARGUMENT_IN_DIR)
#define	cg_upnp_argument_isoutdirection(arg)   cg_streq(cg_upnp_argument_getdirection(arg), CG_UPNP_ARGUMENT_OUT_DIR)
#define	cg_upnp_argument_setrelatedstatevariable(arg, value)   cg_xml_node_setchildnode(cg_upnp_argument_getargumentnode(arg), CG_UPNP_ARGUMENT_RELATED_STATE_VARIABLE, value)
#define	cg_upnp_argument_getrelatedstatevariable(arg)   cg_xml_node_getchildnodevalue(cg_upnp_argument_getargumentnode(arg), CG_UPNP_ARGUMENT_RELATED_STATE_VARIABLE)
#define	cg_upnp_argument_setvalue(arg, data)   cg_string_setvalue(arg->value, data)
#define	cg_upnp_argument_getvalue(arg)   cg_string_getvalue(arg->value)
#define	cg_upnp_argumentlist_clear(argList)   cg_list_clear((CgList *)argList, (CG_LIST_DESTRUCTORFUNC)cg_upnp_argument_delete)
#define	cg_upnp_argumentlist_size(argList)   cg_list_size((CgList *)argList)
#define	cg_upnp_argumentlist_gets(argList)   (CgUpnpArgument *)cg_list_next((CgList *)argList)
#define	cg_upnp_argumentlist_add(argList, arg)   cg_list_add((CgList *)argList, (CgList *)arg)
Typedefs
typedef _CgUpnpArgument	CgUpnpArgument
typedef _CgUpnpArgument	CgUpnpArgumentList
Functions
CgUpnpArgument *	cg_upnp_argument_new ()
void	cg_upnp_argument_delete (CgUpnpArgument *dev)
CgUpnpArgumentList *	cg_upnp_argumentlist_new ()
void	cg_upnp_argumentlist_delete (CgUpnpArgumentList *argumentList)
CgUpnpArgument *	cg_upnp_argumentlist_get (CgUpnpArgumentList *argumentList, char *name)
void	cg_upnp_argumentlist_set (CgUpnpArgumentList *argumentList, CgUpnpArgumentList *srcArgumentList)

---

Define Documentation

#define CG_UPNP_ARGUMENT_DIRECTION   "direction"

Definition for argument element "direction"

#define CG_UPNP_ARGUMENT_ELEM_NAME   "argument"

Definition for argument element name

#define cg_upnp_argument_getargumentnode

(

arg

)

(arg->argumentNode)

Get XML argument node from argument

Parameters:

arg

Argument

#define cg_upnp_argument_getdirection

(

arg

)

cg_xml_node_getchildnodevalue(cg_upnp_argument_getargumentnode(arg), CG_UPNP_ARGUMENT_DIRECTION)

Get argument direction

Parameters:

arg

Argument

Returns:

Argument direction

#define cg_upnp_argument_getname

(

arg

)

cg_xml_node_getchildnodevalue(cg_upnp_argument_getargumentnode(arg), CG_UPNP_ARGUMENT_NAME)

Get argument name

Parameters:

arg

Argument

#define cg_upnp_argument_getrelatedstatevariable

(

arg

)

cg_xml_node_getchildnodevalue(cg_upnp_argument_getargumentnode(arg), CG_UPNP_ARGUMENT_RELATED_STATE_VARIABLE)

Get related state variable

Parameters:

arg

Argument

Returns:

String representing the related state variable

#define cg_upnp_argument_getservicenode

(

arg

)

(arg->serviceNode)

Get service node from argument

Parameters:

arg

Argument

#define cg_upnp_argument_getvalue

(

arg

)

cg_string_getvalue(arg->value)

Get argument value

Parameters:

arg

Argument

Returns:

Argument value

#define CG_UPNP_ARGUMENT_IN_DIR   "in"

Definition for argument passing direction (in)

#define cg_upnp_argument_isargumentnode

(

node

)

cg_xml_node_isname(node, CG_UPNP_ARGUMENT_ELEM_NAME)

Check if XML node is argument node

Parameters:

node

XML node

Returns:

True if node is argument node, false otherwise

#define cg_upnp_argument_isindirection

(

arg

)

cg_streq(cg_upnp_argument_getdirection(arg), CG_UPNP_ARGUMENT_IN_DIR)

Check if argument direction is "in"

Parameters:

arg

Argument

Returns:

True if argument directon is "in"

#define cg_upnp_argument_isname	(	arg,
		name		)	cg_streq(cg_upnp_argument_getname(arg), name)

Check if current argument name matches with the provided name

Parameters:

	arg	Argument
	name	Name matched with argument name

Returns:

True if argument name equals with the provided name, false otherwise

#define cg_upnp_argument_isoutdirection

(

arg

)

cg_streq(cg_upnp_argument_getdirection(arg), CG_UPNP_ARGUMENT_OUT_DIR)

Check if argument direction is "out"

Parameters:

arg

Argument

Returns:

True if argument direction is "out"

#define CG_UPNP_ARGUMENT_NAME   "name"

Definition for argument element name

#define cg_upnp_argument_next

(

arg

)

(CgUpnpArgument *)cg_list_next((CgList *)arg)

Get next argument using argument as iterator

Parameters:

arg

Argument node

#define CG_UPNP_ARGUMENT_OUT_DIR   "out"

Definition for argument passing direction (out)

#define CG_UPNP_ARGUMENT_RELATED_STATE_VARIABLE   "relatedStateVariable"

Definition for argument related state variable

#define cg_upnp_argument_setargumentnode	(	arg,
		node		)	(arg->argumentNode = node)

Set XML argument node for argument

Parameters:

	arg	Argument
	node	XML argument node

#define cg_upnp_argument_setdirection	(	arg,
		value		)	cg_xml_node_setchildnode(cg_upnp_argument_getargumentnode(arg), CG_UPNP_ARGUMENT_DIRECTION, value)

Set direction for argument

Parameters:

	arg	Argument
	value	New direction value

#define cg_upnp_argument_setname	(	arg,
		value		)	cg_xml_node_setchildnode(cg_upnp_argument_getargumentnode(arg), CG_UPNP_ARGUMENT_NAME, value)

Set name for argument

Parameters:

	arg	Argument
	value	Argument name

#define cg_upnp_argument_setrelatedstatevariable	(	arg,
		value		)	cg_xml_node_setchildnode(cg_upnp_argument_getargumentnode(arg), CG_UPNP_ARGUMENT_RELATED_STATE_VARIABLE, value)

Set related state variable

Parameters:

	arg	Argument
	value	Related state variable name

#define cg_upnp_argument_setservicenode	(	arg,
		node		)	(arg->serviceNode = node)

Set XML service node for argument

Parameters:

	arg	Argument
	node	XML service node

#define cg_upnp_argument_setvalue	(	arg,
		data		)	cg_string_setvalue(arg->value, data)

Set argument value

Parameters:

	arg	Argument
	data	Argument value

#define cg_upnp_argumentlist_add	(	argList,
		arg		)	cg_list_add((CgList *)argList, (CgList *)arg)

Add argument into argument list

Parameters:

	argList	Argument list
	arg	Argument

#define cg_upnp_argumentlist_clear

(

argList

)

cg_list_clear((CgList *)argList, (CG_LIST_DESTRUCTORFUNC)cg_upnp_argument_delete)

Clear argument list

Parameters:

argList

Argument list

#define CG_UPNP_ARGUMENTLIST_ELEM_NAME   "argumentList"

Definition for argument list element name

#define cg_upnp_argumentlist_gets

(

argList

)

(CgUpnpArgument *)cg_list_next((CgList *)argList)

Get next argument from argument list

Parameters:

argList

Argument list

#define cg_upnp_argumentlist_size

(

argList

)

cg_list_size((CgList *)argList)

Get argument list size

Parameters:

argList

Argument list

---

Typedef Documentation

typedef struct _CgUpnpArgument CgUpnpArgument

Data type definition for UPnP argument and UPnP argument list

typedef struct _CgUpnpArgument CgUpnpArgumentList

Data type definition for UPnP argument and UPnP argument list

---

Function Documentation

void cg_upnp_argument_delete

(

CgUpnpArgument *

dev

)

Delete argument

Parameters:

dev

Argument

CgUpnpArgument* cg_upnp_argument_new

(

)

Create new argument

void cg_upnp_argumentlist_delete

(

CgUpnpArgumentList *

argumentList

)

Delete argument list

Parameters:

argumentList

Argument list

CgUpnpArgument* cg_upnp_argumentlist_get	(	CgUpnpArgumentList *	argumentList,
		char *	name
	)

Get argument from argument list based on argument name

Parameters:

	argumentList	argumentList
	name	Argument name

Returns:

Argument

CgUpnpArgumentList* cg_upnp_argumentlist_new

(

)

Create new argument list

void cg_upnp_argumentlist_set	(	CgUpnpArgumentList *	argumentList,
		CgUpnpArgumentList *	srcArgumentList
	)

Set argument values by using source argument list. If there is an argument with the name in argument list and source argument list argument data is set from source argument list to the matching argument list.

Parameters:

	argumentList	Argument list
	srcArgumentList	Source argument list

---