The type xmmsv_t

Modules
	Bitbuffer
	Easier building of lists and dictionaries
	Deprecated
	Dictionaries
	Lists
	Utilities
	Collections
	The API to be used to work with collection structures.

Macros
#define	XMMSV_TYPE_INT32   XMMSV_TYPE_INT64
#define	xmmsv_get_int   xmmsv_get_int32

Typedefs
typedef struct xmmsv_St	xmmsv_t

Enumerations
enum	xmmsv_type_t {   XMMSV_TYPE_NONE, XMMSV_TYPE_ERROR, XMMSV_TYPE_INT64, XMMSV_TYPE_STRING,   XMMSV_TYPE_COLL, XMMSV_TYPE_BIN, XMMSV_TYPE_LIST, XMMSV_TYPE_DICT,   XMMSV_TYPE_BITBUFFER, XMMSV_TYPE_FLOAT, XMMSV_TYPE_END }

Functions
xmmsv_t *	xmmsv_new_none (void)
	Allocates a new empty xmmsv_t. More...
xmmsv_t *	xmmsv_new_error (const char *errstr)
	Allocates a new error xmmsv_t. More...
xmmsv_t *	xmmsv_new_int (int64_t i)
	Allocates a new integer xmmsv_t. More...
xmmsv_t *	xmmsv_new_float (float i)
	Allocates a new float xmmsv_t. More...
xmmsv_t *	xmmsv_new_string (const char *s)
	Allocates a new string xmmsv_t. More...
xmmsv_t *	xmmsv_new_bin (const unsigned char *data, unsigned int len)
	Allocates a new binary data xmmsv_t. More...
xmmsv_t *	xmmsv_copy (xmmsv_t *val)
	Return a new value object which is a deep copy of the input value. More...
xmmsv_t *	xmmsv_coll_copy (xmmsv_t *orig_coll)
xmmsv_t *	xmmsv_ref (xmmsv_t *val)
	References the xmmsv_t. More...
void	xmmsv_unref (xmmsv_t *val)
	Decreases the references for the xmmsv_t When the number of references reaches 0 it will be freed. More...
xmmsv_type_t	xmmsv_get_type (const xmmsv_t *val)
	Get the type of the value. More...
int	xmmsv_is_type (const xmmsv_t *val, xmmsv_type_t t)
	Check if value is of specified type. More...
int	xmmsv_get_error (const xmmsv_t *val, const char **r)
	Retrieves an error string describing the server error from the value. More...
int	xmmsv_get_int32 (const xmmsv_t *val, int32_t *r)
	Retrieves a signed integer from the value. More...
int	xmmsv_get_int64 (const xmmsv_t *val, int64_t *r)
	Retrieves a signed integer from the value. More...
int	xmmsv_get_float (const xmmsv_t *val, float *r)
	Retrieves a float from the value. More...
int	xmmsv_get_string (const xmmsv_t *val, const char **r)
	Retrieves a string from the value. More...
int	xmmsv_get_coll (const xmmsv_t *val, xmmsv_t **coll)
	Retrieves a collection from the value. More...
int	xmmsv_get_bin (const xmmsv_t *val, const unsigned char **r, unsigned int *rlen)
	Retrieves binary data from the value. More...
int	xmmsv_is_error (const xmmsv_t *val)
	Check if the value stores an error. More...

Detailed Description

Macro Definition Documentation

#define xmmsv_get_int   xmmsv_get_int32

Referenced by xmms_medialib_query_random_id(), xmms_xform_metadata_get_int(), xmmsv_copy(), and xmmsv_dict_format().

#define XMMSV_TYPE_INT32   XMMSV_TYPE_INT64

Referenced by xmms_xform_metadata_get_int().

Typedef Documentation

typedef struct xmmsv_St xmmsv_t

Enumeration Type Documentation

enum xmmsv_type_t

Enumerator
XMMSV_TYPE_NONE
XMMSV_TYPE_ERROR
XMMSV_TYPE_INT64
XMMSV_TYPE_STRING
XMMSV_TYPE_COLL
XMMSV_TYPE_BIN
XMMSV_TYPE_LIST
XMMSV_TYPE_DICT
XMMSV_TYPE_BITBUFFER
XMMSV_TYPE_FLOAT
XMMSV_TYPE_END

Function Documentation

xmmsv_t* xmmsv_coll_copy

(

xmmsv_t *

orig_coll

)

xmmsv_t* xmmsv_copy

(

xmmsv_t *

val

)

Return a new value object which is a deep copy of the input value.

Parameters

val	xmmsv_t to copy.

Returns

1 the address to the new copy of the value.

Referenced by xmms_collection_snapshot().

int xmmsv_get_bin	(	const xmmsv_t *	val,
		const unsigned char **	r,
		unsigned int *	rlen
	)

Retrieves binary data from the value.

Parameters

val	a xmmsv_t containing a string.
r	the return data. This data is owned by the value and will be freed when the value is freed.
rlen	the return length of data.

Returns

1 upon success otherwise 0

Referenced by xmms_bin_to_gstring(), xmms_xform_auxdata_get_bin(), and xmmsv_deserialize().

int xmmsv_get_coll	(	const xmmsv_t *	val,
		xmmsv_t **	c
	)

Retrieves a collection from the value.

Parameters

val	a xmmsv_t containing a collection.
c	the return collection. This collection is owned by the value and will be unref'd when the value is freed.

Returns

1 upon success otherwise 0

int xmmsv_get_error	(	const xmmsv_t *	val,
		const char **	r
	)

Retrieves an error string describing the server error from the value.

Parameters

val	a xmmsv_t containing a integer.
r	the return error.

Returns

1 upon success otherwise 0

Referenced by xmmsv_copy().

int xmmsv_get_float	(	const xmmsv_t *	val,
		float *	r
	)

Retrieves a float from the value.

Parameters

val	a xmmsv_t containing a float value.
r	the return float.

Returns

1 upon success otherwise 0

Referenced by xmmsv_copy(), and xmmsv_dict_format().

int xmmsv_get_int32	(	const xmmsv_t *	val,
		int32_t *	r
	)

Retrieves a signed integer from the value.

Parameters

val	a xmmsv_t containing an integer.
r	the return integer.

Returns

1 upon success otherwise 0

int xmmsv_get_int64	(	const xmmsv_t *	val,
		int64_t *	r
	)

Retrieves a signed integer from the value.

Parameters

val	a xmmsv_t containing an integer.
r	the return integer.

Returns

1 upon success otherwise 0

int xmmsv_get_string	(	const xmmsv_t *	val,
		const char **	r
	)

Retrieves a string from the value.

Parameters

val	a xmmsv_t containing a string.
r	the return string. This string is owned by the value and will be freed when the value is freed.

Returns

1 upon success otherwise 0

Referenced by xmms_collection_restore(), xmms_xform_metadata_get_str(), xmmsv_copy(), xmmsv_decode_url(), xmmsv_dict_format(), and xmmsv_encode_url_full().

xmmsv_type_t xmmsv_get_type

(

const xmmsv_t *

val

)

Get the type of the value.

Parameters

val	a xmmsv_t to get the type from.

Returns

The data type in the value.

Referenced by xmms_fetch_spec_new(), xmms_xform_auxdata_get_bin(), xmms_xform_metadata_get_int(), xmms_xform_metadata_get_str(), xmmsv_bitbuffer_serialize_value(), xmmsv_build_metadata(), xmmsv_copy(), xmmsv_dict_entry_get_type(), xmmsv_dict_format(), xmmsv_is_type(), and xmmsv_sc_argument_new().

int xmmsv_is_error

(

const xmmsv_t *

val

)

Check if the value stores an error.

Parameters

val

a xmmsv_t

Returns

1 if error was encountered, 0 otherwise.

int xmmsv_is_type	(	const xmmsv_t *	val,
		xmmsv_type_t	t
	)

Check if value is of specified type.

Parameters

val	xmmsv_t to check.
t	xmmsv_type_t to check for.

Returns

1 if value is of specified type, 0 otherwise.

Referenced by xmms_collection_restore(), xmmsv_coll_add_order_operators(), xmmsv_coll_attribute_get_int32(), xmmsv_coll_attribute_get_int64(), xmmsv_coll_attribute_get_string(), xmmsv_coll_attribute_get_value(), xmmsv_coll_attribute_set_int(), xmmsv_coll_attribute_set_string(), xmmsv_coll_attribute_set_value(), xmmsv_coll_attributes_set(), xmmsv_dict_clear(), xmmsv_dict_foreach(), xmmsv_dict_get(), xmmsv_dict_get_size(), xmmsv_dict_remove(), xmmsv_dict_set(), xmmsv_is_error(), xmmsv_list_append(), xmmsv_list_clear(), xmmsv_list_foreach(), xmmsv_list_get(), xmmsv_list_get_size(), xmmsv_list_get_type(), xmmsv_list_has_type(), xmmsv_list_index_of(), xmmsv_list_insert(), xmmsv_list_move(), xmmsv_list_remove(), xmmsv_list_set(), and xmmsv_list_sort().

xmmsv_t* xmmsv_new_bin	(	const unsigned char *	data,
		unsigned int	len
	)

Allocates a new binary data xmmsv_t.

Parameters

data	The data to store in the xmmsv_t.
len	The size of the data.

Returns

The new xmmsv_t. Must be unreferenced with xmmsv_unref.

Referenced by xmms_xform_auxdata_set_bin(), xmmsv_copy(), xmmsv_decode_url(), and xmmsv_serialize().

xmmsv_t* xmmsv_new_error

(

const char *

errstr

)

Allocates a new error xmmsv_t.

Parameters

s	The error message to store in the xmmsv_t. The string is copied in the value.

Returns

The new xmmsv_t. Must be unreferenced with xmmsv_unref.

Referenced by xmmsv_copy().

xmmsv_t* xmmsv_new_float

(

float

i

)

Allocates a new float xmmsv_t.

Parameters

i	The value to store in the xmmsv_t.

Returns

The new xmmsv_t. Must be unreferenced with xmmsv_unref.

Referenced by xmmsv_copy().

xmmsv_t* xmmsv_new_int

(

int64_t

i

)

Allocates a new integer xmmsv_t.

Parameters

i	The value to store in the xmmsv_t.

Returns

The new xmmsv_t. Must be unreferenced with xmmsv_unref.

Referenced by xmms_medialib_entry_property_get_value(), xmms_medialib_query_to_xmmsv(), xmms_xform_auxdata_set_int(), xmms_xform_browse_add_entry_property_int(), xmms_xform_metadata_set_int(), and xmmsv_copy().

xmmsv_t* xmmsv_new_none

(

void

)

Allocates a new empty xmmsv_t.

Returns

The new xmmsv_t. Must be unreferenced with xmmsv_unref.

Referenced by xmms_xform_auxdata_barrier(), and xmmsv_copy().

xmmsv_t* xmmsv_new_string

(

const char *

s

)

Allocates a new string xmmsv_t.

Parameters

s	The value to store in the xmmsv_t. The string is copied in the value.

Returns

The new xmmsv_t. Must be unreferenced with xmmsv_unref.

Referenced by xmms_config_property_set_data(), xmms_convert_and_kill_string(), xmms_medialib_entry_property_get_value(), xmms_xform_auxdata_set_str(), xmms_xform_browse_add_entry_property_str(), xmms_xform_metadata_set_str(), xmmsv_copy(), and xmmsv_make_stringlist().

xmmsv_t* xmmsv_ref

(

xmmsv_t *

val

)

References the xmmsv_t.

Parameters

val	the value to reference.

Returns

val

Referenced by _xmmsv_new(), xmms_collection_update_pointer(), xmmsv_c2c_message_format(), xmmsv_coll_add_limit_operator(), xmmsv_coll_add_order_operator(), xmmsv_coll_add_order_operators(), xmmsv_coll_attributes_set(), xmmsv_coll_idlist_set(), xmmsv_coll_operands_set(), xmmsv_coll_ref(), xmmsv_dict_iter_set(), xmmsv_dict_set(), and xmmsv_list_set().

void xmmsv_unref

(

xmmsv_t *

val

)

Decreases the references for the xmmsv_t When the number of references reaches 0 it will be freed.

And thus all data you extracted from it will be deallocated.

Referenced by _xmmsv_coll_free(), _xmmsv_dict_free(), _xmmsv_list_free(), xmms_collection_query_ids(), xmms_collection_restore(), xmms_collection_snapshot(), xmms_ipc_msg_destroy(), xmms_medialib_check_id(), xmms_medialib_query_random_id(), xmms_medialib_query_recurs(), xmms_medialib_query_to_xmmsv(), xmms_object_emit(), xmms_xform_browse_add_entry(), xmms_xform_browse_add_entry_property_int(), xmms_xform_browse_add_entry_property_str(), xmms_xform_new(), xmms_xform_this_seek(), xmmsv_build_cluster_dict(), xmmsv_build_cluster_list(), xmmsv_build_dict_va(), xmmsv_build_list_va(), xmmsv_build_metadata(), xmmsv_build_organize(), xmmsv_coll_add_order_operator(), xmmsv_coll_add_order_operators(), xmmsv_coll_attributes_set(), xmmsv_coll_idlist_set(), xmmsv_coll_operands_set(), xmmsv_coll_unref(), xmmsv_deserialize(), xmmsv_dict_clear(), xmmsv_dict_iter_set(), xmmsv_list_flatten(), xmmsv_list_set(), xmmsv_make_stringlist(), and xmmsv_serialize().