XMMS2
|
The API to be used to work with collection structures. More...
Functions | |
xmmsv_coll_t * | xmmsv_coll_ref (xmmsv_coll_t *coll) |
Increases the references for the xmmsv_coll_t. More... | |
xmmsv_coll_t * | xmmsv_coll_new (xmmsv_coll_type_t type) |
Allocate a new collection of the given type. More... | |
void | xmmsv_coll_unref (xmmsv_coll_t *coll) |
Decreases the references for the xmmsv_coll_t When the number of references reaches 0 it will be freed and all its operands unreferenced as well. More... | |
void | xmmsv_coll_set_idlist (xmmsv_coll_t *coll, int ids[]) |
Set the list of ids in the given collection. More... | |
void | xmmsv_coll_add_operand (xmmsv_coll_t *coll, xmmsv_coll_t *op) |
Add the operand to the given collection. More... | |
void | xmmsv_coll_remove_operand (xmmsv_coll_t *coll, xmmsv_coll_t *op) |
Remove all the occurences of the operand in the given collection. More... | |
int | xmmsv_coll_idlist_append (xmmsv_coll_t *coll, int id) |
Append a value to the idlist. More... | |
int | xmmsv_coll_idlist_insert (xmmsv_coll_t *coll, int index, int id) |
Insert a value at a given position in the idlist. More... | |
int | xmmsv_coll_idlist_move (xmmsv_coll_t *coll, int index, int newindex) |
Move a value of the idlist to a new position. More... | |
int | xmmsv_coll_idlist_remove (xmmsv_coll_t *coll, int index) |
Remove the value at a given index from the idlist. More... | |
int | xmmsv_coll_idlist_clear (xmmsv_coll_t *coll) |
Empties the idlist. More... | |
int | xmmsv_coll_idlist_get_index (xmmsv_coll_t *coll, int index, int32_t *val) |
Retrieves the value at the given position in the idlist. More... | |
int | xmmsv_coll_idlist_set_index (xmmsv_coll_t *coll, int index, int32_t val) |
Sets the value at the given position in the idlist. More... | |
size_t | xmmsv_coll_idlist_get_size (xmmsv_coll_t *coll) |
Get the size of the idlist. More... | |
xmmsv_coll_type_t | xmmsv_coll_get_type (xmmsv_coll_t *coll) |
Return the type of the collection. More... | |
const int32_t * | xmmsv_coll_get_idlist (xmmsv_coll_t *coll) |
Return the list of ids stored in the collection. More... | |
xmmsv_t * | xmmsv_coll_idlist_get (xmmsv_coll_t *coll) |
Return the list of ids stored in the collection. More... | |
xmmsv_t * | xmmsv_coll_operands_get (xmmsv_coll_t *coll) |
xmmsv_t * | xmmsv_coll_attributes_get (xmmsv_coll_t *coll) |
void | xmmsv_coll_attribute_set (xmmsv_coll_t *coll, const char *key, const char *value) |
Set an attribute in the given collection. More... | |
int | xmmsv_coll_attribute_remove (xmmsv_coll_t *coll, const char *key) |
Remove an attribute from the given collection. More... | |
int | xmmsv_coll_attribute_get (xmmsv_coll_t *coll, const char *key, char **value) |
Retrieve the value of the attribute of the given collection. More... | |
void | xmmsv_coll_attribute_foreach (xmmsv_coll_t *coll, xmmsv_coll_attribute_foreach_func func, void *user_data) |
Iterate over all key/value-pair of the collection attributes. More... | |
xmmsv_coll_t * | xmmsv_coll_universe () |
Return a collection referencing the whole media library, that is a reference to the "All Media" collection. More... | |
The API to be used to work with collection structures.
void xmmsv_coll_add_operand | ( | xmmsv_coll_t * | coll, |
xmmsv_coll_t * | op | ||
) |
Add the operand to the given collection.
coll | The collection to add the operand to. |
op | The operand to add. |
Definition at line 195 of file coll.c.
Referenced by bind_all_references().
void xmmsv_coll_attribute_foreach | ( | xmmsv_coll_t * | coll, |
xmmsv_coll_attribute_foreach_func | func, | ||
void * | user_data | ||
) |
Iterate over all key/value-pair of the collection attributes.
Calls specified function for each key/value-pair of the attribute list.
void function (const char *key, const char *value, void *user_data);
coll | the xmmsv_coll_t. |
func | function that is called for each key/value-pair |
user_data | extra data passed to func |
int xmmsv_coll_attribute_get | ( | xmmsv_coll_t * | coll, |
const char * | key, | ||
char ** | value | ||
) |
Retrieve the value of the attribute of the given collection.
The return value is 1 if the attribute was found and 0 otherwise. The value of the attribute is owned by the collection and must not be freed by the caller.
coll | The collection to retrieve the attribute from. |
key | The name of the attribute. |
value | The value of the attribute if found (owned by the collection). |
Definition at line 498 of file coll.c.
Referenced by bind_all_references(), and xmms_collection_get_int_attr().
int xmmsv_coll_attribute_remove | ( | xmmsv_coll_t * | coll, |
const char * | key | ||
) |
void xmmsv_coll_attribute_set | ( | xmmsv_coll_t * | coll, |
const char * | key, | ||
const char * | value | ||
) |
Set an attribute in the given collection.
coll | The collection in which to set the attribute. |
key | The name of the attribute to set. |
value | The value of the attribute. |
Definition at line 460 of file coll.c.
Referenced by xmms_collection_set_int_attr(), and xmmsv_coll_universe().
xmmsv_t* xmmsv_coll_attributes_get | ( | xmmsv_coll_t * | coll | ) |
const int32_t* xmmsv_coll_get_idlist | ( | xmmsv_coll_t * | coll | ) |
Return the list of ids stored in the collection.
The list is owned by the collection. Note that this must not be confused with the content of the collection, which must be queried using xmmsc_coll_query_ids!
Also note that this function is deprecated (use xmmsv_coll_idlist_get instead) and that changes to the returned array will be ignored. The array is also not updated when the idlist is changed using the supplied functions. Additionally every call to this function allocates a new array, so calling it repetitively will be a performance penalty.
coll | The collection to consider. |
xmmsv_coll_type_t xmmsv_coll_get_type | ( | xmmsv_coll_t * | coll | ) |
Return the type of the collection.
coll | The collection to consider. |
Definition at line 367 of file coll.c.
Referenced by bind_all_references().
int xmmsv_coll_idlist_append | ( | xmmsv_coll_t * | coll, |
int | id | ||
) |
int xmmsv_coll_idlist_clear | ( | xmmsv_coll_t * | coll | ) |
xmmsv_t* xmmsv_coll_idlist_get | ( | xmmsv_coll_t * | coll | ) |
Return the list of ids stored in the collection.
This function does not increase the refcount of the list, the reference is still owned by the collection.
Note that this must not be confused with the content of the collection, which must be queried using xmmsc_coll_query_ids!
coll | The collection to consider. |
int xmmsv_coll_idlist_get_index | ( | xmmsv_coll_t * | coll, |
int | index, | ||
int32_t * | val | ||
) |
size_t xmmsv_coll_idlist_get_size | ( | xmmsv_coll_t * | coll | ) |
Get the size of the idlist.
coll | The collection to update. |
Definition at line 352 of file coll.c.
Referenced by xmmsv_coll_get_idlist().
int xmmsv_coll_idlist_insert | ( | xmmsv_coll_t * | coll, |
int | index, | ||
int | id | ||
) |
int xmmsv_coll_idlist_move | ( | xmmsv_coll_t * | coll, |
int | index, | ||
int | newindex | ||
) |
int xmmsv_coll_idlist_remove | ( | xmmsv_coll_t * | coll, |
int | index | ||
) |
int xmmsv_coll_idlist_set_index | ( | xmmsv_coll_t * | coll, |
int | index, | ||
int32_t | val | ||
) |
xmmsv_coll_t* xmmsv_coll_new | ( | xmmsv_coll_type_t | type | ) |
Allocate a new collection of the given type.
The pointer will have to be deallocated using xmmsv_coll_unref.
type | the xmmsv_coll_type_t specifying the type of collection to create. |
Definition at line 78 of file coll.c.
Referenced by xmmsv_coll_universe().
xmmsv_t* xmmsv_coll_operands_get | ( | xmmsv_coll_t * | coll | ) |
xmmsv_coll_t* xmmsv_coll_ref | ( | xmmsv_coll_t * | coll | ) |
Increases the references for the xmmsv_coll_t.
coll | the collection to reference. |
Definition at line 61 of file coll.c.
Referenced by xmms_collection_update_pointer(), and xmmsv_coll_new().
void xmmsv_coll_remove_operand | ( | xmmsv_coll_t * | coll, |
xmmsv_coll_t * | op | ||
) |
void xmmsv_coll_set_idlist | ( | xmmsv_coll_t * | coll, |
int | ids[] | ||
) |
xmmsv_coll_t* xmmsv_coll_universe | ( | void | ) |
Return a collection referencing the whole media library, that is a reference to the "All Media" collection.
The returned structure must be unref'd using xmmsv_coll_unref after usage.
void xmmsv_coll_unref | ( | xmmsv_coll_t * | coll | ) |
Decreases the references for the xmmsv_coll_t When the number of references reaches 0 it will be freed and all its operands unreferenced as well.
coll | the collection to unref. |