XMMS2
xmmsv_coll.h File Reference
#include <xmmsc/xmmsc_compiler.h>
#include <xmmsc/xmmsc_stdint.h>
#include <xmmsc/xmmsc_idnumbers.h>
#include <xmmsc/xmmsv_general.h>

Macros

#define xmmsc_coll_new   xmmsv_coll_new
#define xmmsc_coll_ref   xmmsv_coll_ref
#define xmmsc_coll_unref   xmmsv_coll_unref
#define xmmsc_coll_set_idlist   xmmsv_coll_set_idlist
#define xmmsc_coll_add_operand   xmmsv_coll_add_operand
#define xmmsc_coll_remove_operand   xmmsv_coll_remove_operand
#define xmmsc_coll_idlist_append   xmmsv_coll_idlist_append
#define xmmsc_coll_idlist_insert   xmmsv_coll_idlist_insert
#define xmmsc_coll_idlist_move   xmmsv_coll_idlist_move
#define xmmsc_coll_idlist_remove   xmmsv_coll_idlist_remove
#define xmmsc_coll_idlist_clear   xmmsv_coll_idlist_clear
#define xmmsc_coll_idlist_get_index   xmmsv_coll_idlist_get_index
#define xmmsc_coll_idlist_set_index   xmmsv_coll_idlist_set_index
#define xmmsc_coll_idlist_get_size   xmmsv_coll_idlist_get_size
#define xmmsc_coll_get_type   xmmsv_coll_get_type
#define xmmsc_coll_attribute_set   xmmsv_coll_attribute_set
#define xmmsc_coll_attribute_remove   xmmsv_coll_attribute_remove
#define xmmsc_coll_attribute_get   xmmsv_coll_attribute_get
#define xmmsc_coll_universe   xmmsv_coll_universe
#define xmmsv_coll_idlist_get_index   xmmsv_coll_idlist_get_index_int32
#define xmmsv_coll_attribute_get_int   xmmsv_coll_attribute_get_int32

Typedefs

typedef xmmsv_t xmmsv_coll_t
typedef xmmsv_t xmmsc_coll_t

Functions

xmmsv_txmmsv_coll_new (xmmsv_coll_type_t type)
xmmsv_txmmsv_coll_ref (xmmsv_t *coll)
 Increases the references for the xmmsv_t.
void xmmsv_coll_unref (xmmsv_t *coll)
 Decreases the references for the xmmsv_t When the number of references reaches 0 it will be freed and all its operands unreferenced as well.
xmmsv_txmmsv_new_coll (xmmsv_coll_type_t type)
 Allocates a new collection xmmsv_t of the given type.
void xmmsv_coll_set_idlist (xmmsv_t *coll, int ids[])
 Set the list of ids in the given collection.
void xmmsv_coll_add_operand (xmmsv_t *coll, xmmsv_t *op)
 Add the operand to the given collection.
void xmmsv_coll_remove_operand (xmmsv_t *coll, xmmsv_t *op)
 Remove all the occurences of the operand in the given collection.
xmmsv_txmmsv_coll_operands_get (xmmsv_t *coll)
void xmmsv_coll_operands_set (xmmsv_t *coll, xmmsv_t *operands)
 Replace all operands in the given collection.
int xmmsv_coll_idlist_append (xmmsv_t *coll, int64_t id)
 Append a value to the idlist.
int xmmsv_coll_idlist_insert (xmmsv_t *coll, int index, int64_t id)
 Insert a value at a given position in the idlist.
int xmmsv_coll_idlist_move (xmmsv_t *coll, int index, int newindex)
 Move a value of the idlist to a new position.
int xmmsv_coll_idlist_remove (xmmsv_t *coll, int index)
 Remove the value at a given index from the idlist.
int xmmsv_coll_idlist_clear (xmmsv_t *coll)
 Empties the idlist.
int xmmsv_coll_idlist_get_index_int32 (xmmsv_t *coll, int index, int32_t *val)
 Retrieves the value at the given position in the idlist.
int xmmsv_coll_idlist_get_index_int64 (xmmsv_t *coll, int index, int64_t *val)
 Retrieves the value at the given position in the idlist.
int xmmsv_coll_idlist_set_index (xmmsv_t *coll, int index, int64_t val)
 Sets the value at the given position in the idlist.
int xmmsv_coll_idlist_get_size (xmmsv_t *coll)
 Get the size of the idlist.
int xmmsv_coll_is_type (xmmsv_t *val, xmmsv_coll_type_t t)
 Check if collection is of specified type.
xmmsv_coll_type_t xmmsv_coll_get_type (xmmsv_t *coll)
 Return the type of the collection.
xmmsv_txmmsv_coll_idlist_get (xmmsv_t *coll)
 Return the list of ids stored in the collection.
void xmmsv_coll_idlist_set (xmmsv_t *coll, xmmsv_t *idlist)
 Replace the idlist in the given collection.
void xmmsv_coll_attribute_set (xmmsv_t *coll, const char *key, const char *value)
 Set a string attribute in the given collection.
void xmmsv_coll_attribute_set_string (xmmsv_t *coll, const char *key, const char *value)
 Set a string attribute in the given collection.
void xmmsv_coll_attribute_set_int (xmmsv_t *coll, const char *key, int64_t value)
 Set an integer attribute in the given collection.
void xmmsv_coll_attribute_set_value (xmmsv_t *coll, const char *key, xmmsv_t *value)
 Set an attribute in the given collection.
int xmmsv_coll_attribute_remove (xmmsv_t *coll, const char *key)
 Remove an attribute from the given collection.
int xmmsv_coll_attribute_get (xmmsv_t *coll, const char *key, const char **value)
 Retrieve a string attribute from the given collection.
int xmmsv_coll_attribute_get_string (xmmsv_t *coll, const char *key, const char **value)
 Retrieve a string attribute from the given collection.
int xmmsv_coll_attribute_get_int32 (xmmsv_t *coll, const char *key, int32_t *value)
 Retrieve an integer attribute from the given collection.
int xmmsv_coll_attribute_get_int64 (xmmsv_t *coll, const char *key, int64_t *value)
 Retrieve an integer attribute from the given collection.
int xmmsv_coll_attribute_get_value (xmmsv_t *coll, const char *key, xmmsv_t **value)
 Retrieve an attribute from the given collection.
xmmsv_txmmsv_coll_attributes_get (xmmsv_t *coll)
void xmmsv_coll_attributes_set (xmmsv_t *coll, xmmsv_t *attributes)
 Replace all attributes in the given collection.
xmmsv_txmmsv_coll_universe (void)
 Return a collection referencing the whole media library.
xmmsv_txmmsv_coll_add_order_operator (xmmsv_t *coll, xmmsv_t *order)
 Return a collection with an order-operator added.
xmmsv_txmmsv_coll_add_order_operators (xmmsv_t *coll, xmmsv_t *order)
 Return a collection with several order-operators added.
xmmsv_txmmsv_coll_add_limit_operator (xmmsv_t *coll, int lim_start, int lim_len)
 Returns a collection with a LIMIT operator added.

Macro Definition Documentation

◆ xmmsc_coll_add_operand

#define xmmsc_coll_add_operand   xmmsv_coll_add_operand

◆ xmmsc_coll_attribute_get

#define xmmsc_coll_attribute_get   xmmsv_coll_attribute_get

◆ xmmsc_coll_attribute_remove

#define xmmsc_coll_attribute_remove   xmmsv_coll_attribute_remove

◆ xmmsc_coll_attribute_set

#define xmmsc_coll_attribute_set   xmmsv_coll_attribute_set

◆ xmmsc_coll_get_type

#define xmmsc_coll_get_type   xmmsv_coll_get_type

◆ xmmsc_coll_idlist_append

#define xmmsc_coll_idlist_append   xmmsv_coll_idlist_append

◆ xmmsc_coll_idlist_clear

#define xmmsc_coll_idlist_clear   xmmsv_coll_idlist_clear

◆ xmmsc_coll_idlist_get_index

#define xmmsc_coll_idlist_get_index   xmmsv_coll_idlist_get_index

◆ xmmsc_coll_idlist_get_size

#define xmmsc_coll_idlist_get_size   xmmsv_coll_idlist_get_size

◆ xmmsc_coll_idlist_insert

#define xmmsc_coll_idlist_insert   xmmsv_coll_idlist_insert

◆ xmmsc_coll_idlist_move

#define xmmsc_coll_idlist_move   xmmsv_coll_idlist_move

◆ xmmsc_coll_idlist_remove

#define xmmsc_coll_idlist_remove   xmmsv_coll_idlist_remove

◆ xmmsc_coll_idlist_set_index

#define xmmsc_coll_idlist_set_index   xmmsv_coll_idlist_set_index

◆ xmmsc_coll_new

#define xmmsc_coll_new   xmmsv_coll_new

◆ xmmsc_coll_ref

#define xmmsc_coll_ref   xmmsv_coll_ref

◆ xmmsc_coll_remove_operand

#define xmmsc_coll_remove_operand   xmmsv_coll_remove_operand

◆ xmmsc_coll_set_idlist

#define xmmsc_coll_set_idlist   xmmsv_coll_set_idlist

◆ xmmsc_coll_universe

#define xmmsc_coll_universe   xmmsv_coll_universe

◆ xmmsc_coll_unref

#define xmmsc_coll_unref   xmmsv_coll_unref

◆ xmmsv_coll_attribute_get_int

#define xmmsv_coll_attribute_get_int   xmmsv_coll_attribute_get_int32

◆ xmmsv_coll_idlist_get_index

#define xmmsv_coll_idlist_get_index   xmmsv_coll_idlist_get_index_int32

Typedef Documentation

◆ xmmsc_coll_t

◆ xmmsv_coll_t