CicmWrapper  Beta 0.4
A wrapper for Pure Data
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Modules Pages
Typedefs | Functions | Variables
The Common Part

The general part. More...

Typedefs

typedef long t_pd_err
 The error type.
 
typedef void(* t_typ_method )(void *x,...)
 The standart method.
 
typedef void *(* t_ret_method )(void *x,...)
 The return method.
 
typedef t_pd_err(* t_err_method )(void *x,...)
 The error method.
 

Functions

int atoms_get_attributes_offset (int argc, t_atom *argv)
 Retrieves the position of the first attribute in an array of t_atom. More...
 
int binbuf_get_attributes_offset (t_binbuf *d)
 Retrieves the position of the first attribute in a t_binbuf. More...
 
int atoms_get_nattributes (int argc, t_atom *argv)
 Retrieves the number of attributes in an array of t_atom. More...
 
int binbuf_get_nattributes (t_binbuf *d)
 Retrieves the number of attributes in a t_binbuf. More...
 
t_pd_err atoms_has_attribute (int argc, t_atom *argv, t_symbol *key)
 Retrieves if an attributes is in an array of t_atom. More...
 
t_pd_err binbuf_has_attribute (t_binbuf *d, t_symbol *key)
 Retrieves if an attributes is in a t_binbuf. More...
 
int atoms_get_attribute_index (int argc, t_atom *argv, t_symbol *key)
 Retrieves the position of an attribute in an array of t_atom. More...
 
int binbuf_get_attribute_index (t_binbuf *d, t_symbol *key)
 Retrieves the position of an attribute in a t_binbuf. More...
 
t_pd_err atoms_get_attribute (int ac, t_atom *av, t_symbol *key, int *argc, t_atom **argv)
 Retrieves the values of an attribute from an array of t_atom. More...
 
t_pd_err binbuf_get_attribute (t_binbuf *d, t_symbol *key, int *argc, t_atom **argv)
 Retrieves the values of an attribute from a t_binbuf. More...
 
t_pd_err atoms_get_attribute_long (int ac, t_atom *av, t_symbol *key, long *value)
 Retrieves the long value of an attribute from an array of t_atom. More...
 
t_pd_err binbuf_get_attribute_long (t_binbuf *d, t_symbol *key, long *value)
 Retrieves the long value of an attribute from a t_binbuf. More...
 
t_pd_err atoms_get_attribute_float (int ac, t_atom *av, t_symbol *key, float *value)
 Retrieves the float value of an attribute from an array of t_atom. More...
 
t_pd_err binbuf_get_attribute_float (t_binbuf *d, t_symbol *key, float *value)
 Retrieves the float value of an attribute from a t_binbuf. More...
 
int atoms_get_keys (int ac, t_atom *av, t_symbol ***keys)
 Retrieves the keys of attributes presents in an array of t_atom. More...
 
int binbuf_get_keys (t_binbuf *d, t_symbol ***keys)
 Retrieves the keys of attributes presents in a t_binbuf. More...
 
t_binbufbinbuf_via_atoms (int ac, t_atom *av)
 Retrieves a t_binbuf from an array of t_atom. More...
 
t_pd_err binbuf_append_attribute (t_binbuf *d, t_symbol *key, int argc, t_atom *argv)
 Adds the key and the values of an attribute to a t_binbuf. More...
 
void epd_add_folder (const char *name, const char *folder)
 Adds a subfolder to library folder. More...
 

Variables

t_symbols_null
 The pre-defined ("null") t_symbol*.
 
t_symbols_obj
 The pre-defined obj t_symbol*.
 
t_symbols_atom
 The pre-defined atom t_symbol*.
 
t_symbols_attr_modified
 The pre-defined attr_modified t_symbol*.
 
t_symbols_eboxbd
 The pre-defined eboxbd t_symbol*.
 
t_symbols_eboxio
 The pre-defined eboxio t_symbol*.
 
t_symbols_size
 The pre-defined size t_symbol*.
 
t_symbols_int
 The pre-defined int t_symbol*.
 
t_symbols_long
 The pre-defined long t_symbol*.
 
t_symbols_double
 The pre-defined double t_symbol*.
 

Detailed Description

The general part.

This part refers to the general methods and definitions.

Function Documentation

int atoms_get_attributes_offset ( int  argc,
t_atom argv 
)

Retrieves the position of the first attribute in an array of t_atom.

The function looks for the first t_symbol* that starts with the character @.

Parameters
argcThe size of the array of t_atom.
argvThe array of t_atom.
Returns
The index of the first attribute or the maximum if there's no attribute.
int binbuf_get_attributes_offset ( t_binbuf d)

Retrieves the position of the first attribute in a t_binbuf.

The function looks for the first t_symbol* that starts with the character @.

Parameters
dThe t_binbuf.
Returns
The index of the first attribute or the maximum if there's no attribute.
int atoms_get_nattributes ( int  argc,
t_atom argv 
)

Retrieves the number of attributes in an array of t_atom.

The function looks for the symbols that start with the character @.

Parameters
argcThe size of the array of t_atom.
argvThe array of t_atom.
Returns
The number of attributes.
int binbuf_get_nattributes ( t_binbuf d)

Retrieves the number of attributes in a t_binbuf.

The function looks for the symbols that start with the character @.

Parameters
dThe t_binbuf.
Returns
The number of attributes.
t_pd_err atoms_has_attribute ( int  argc,
t_atom argv,
t_symbol key 
)

Retrieves if an attributes is in an array of t_atom.

The function looks for the key t_symbol* of the attribute.

Parameters
argcThe size of the array of t_atom.
argvThe array of t_atom.
keyThe key of the attribute.
Returns
1 if the attribute is in the array of t_atom, otherwise 0.
t_pd_err binbuf_has_attribute ( t_binbuf d,
t_symbol key 
)

Retrieves if an attributes is in a t_binbuf.

The function looks for the key t_symbol* of the attribute.

Parameters
dThe t_binbuf.
keyThe key of the attribute.
Returns
1 if the attribute is in the array of t_atom, otherwise 0.
int atoms_get_attribute_index ( int  argc,
t_atom argv,
t_symbol key 
)

Retrieves the position of an attribute in an array of t_atom.

The function looks for position of the key t_symbol* of the attribute.

Parameters
argcThe size of the array of t_atom.
argvThe array of t_atom.
keyThe key of the attribute.
Returns
The position of the attribute or the maximum if the attribute isn't in the array.
int binbuf_get_attribute_index ( t_binbuf d,
t_symbol key 
)

Retrieves the position of an attribute in a t_binbuf.

The function looks for position of the key t_symbol* of the attribute.

Parameters
dThe t_binbuf.
keyThe key of the attribute.
Returns
The position of the attribute or the maximum if the attribute isn't in the array.
t_pd_err atoms_get_attribute ( int  ac,
t_atom av,
t_symbol key,
int *  argc,
t_atom **  argv 
)

Retrieves the values of an attribute from an array of t_atom.

The function looks for an attribute and retrieves its values. You should free the result memory if it has been allocated.

Parameters
acThe size of the array of t_atom.
avThe array of t_atom.
keyThe key of the attribute.
argcThe pointer to the int that will be initialized with number of values of the attributes.
argvThe pointer to the array of t_atom that will be initalized with the values of the attributes.
Returns
0 if the attribute values has been returned.
t_pd_err binbuf_get_attribute ( t_binbuf d,
t_symbol key,
int *  argc,
t_atom **  argv 
)

Retrieves the values of an attribute from a t_binbuf.

The function looks for an attribute and retrieves its values. You should free the result memory if it has been allocated.

Parameters
dThe t_binbuf.
keyThe key of the attribute.
argcThe pointer to the int that will be initialized with number of values of the attributes.
argvThe pointer to the array of t_atom that will be initalized with the values of the attributes.
Returns
0 if the attribute values has been returned.
t_pd_err atoms_get_attribute_long ( int  ac,
t_atom av,
t_symbol key,
long *  value 
)

Retrieves the long value of an attribute from an array of t_atom.

The function looks for an attribute and retrieves its long value.

Parameters
acThe size of the array of t_atom.
avThe array of t_atom.
keyThe key of the attribute.
valueThe pointer to the long value that will be initialized with number of values of the attributes.
Returns
0 if the attribute value has been returned.
t_pd_err binbuf_get_attribute_long ( t_binbuf d,
t_symbol key,
long *  value 
)

Retrieves the long value of an attribute from a t_binbuf.

The function looks for an attribute and retrieves its long value.

Parameters
dThe t_binbuf.
keyThe key of the attribute.
valueThe pointer to the long value that will be initialized with number of values of the attributes.
Returns
0 if the attribute value has been returned.
t_pd_err atoms_get_attribute_float ( int  ac,
t_atom av,
t_symbol key,
float *  value 
)

Retrieves the float value of an attribute from an array of t_atom.

The function looks for an attribute and retrieves its float value.

Parameters
acThe size of the array of t_atom.
avThe array of t_atom.
keyThe key of the attribute.
valueThe pointer to the float value that will be initialized with number of values of the attributes.
Returns
0 if the attribute value has been returned.
t_pd_err binbuf_get_attribute_float ( t_binbuf d,
t_symbol key,
float *  value 
)

Retrieves the float value of an attribute from a t_binbuf.

The function looks for an attribute and retrieves its float value.

Parameters
dThe t_binbuf.
keyThe key of the attribute.
valueThe pointer to the float value that will be initialized with number of values of the attributes.
Returns
0 if the attribute value has been returned.
int atoms_get_keys ( int  ac,
t_atom av,
t_symbol ***  keys 
)

Retrieves the keys of attributes presents in an array of t_atom.

The function retrieves all the t_symbol* that start with the character @. You should free the result memory if it has been allocated.

Parameters
acThe size of the array of t_atom.
avThe array of t_atom.
keysThe pointer to an array of t_symbol* that will be allocated if keys has been found.
Returns
The number of keys.
int binbuf_get_keys ( t_binbuf d,
t_symbol ***  keys 
)

Retrieves the keys of attributes presents in a t_binbuf.

The function retrieves all the t_symbol* that start with the character @. You should free the result memory if it has been allocated.

Parameters
dThe t_binbuf.
keysThe pointer to an array of t_symbol* that will be allocated if keys has been found.
Returns
The number of keys.
t_binbuf* binbuf_via_atoms ( int  ac,
t_atom av 
)

Retrieves a t_binbuf from an array of t_atom.

The function allocates a t_binbuf and intialized it with the array of t_atom.

Parameters
acThe size of the array of t_atom.
avThe array of t_atom.
Returns
The t_binbuf or NULL if the allocation goes wrong.
t_pd_err binbuf_append_attribute ( t_binbuf d,
t_symbol key,
int  argc,
t_atom argv 
)

Adds the key and the values of an attribute to a t_binbuf.

The function format and append the key and the values of an attribute.

Parameters
dThe t_binbuf.
keyThe key of the attribute.
argcThe size of the array of t_atom.
argvThe array of t_atom that owns the values.
Returns
0 if the attribute has been added.
void epd_add_folder ( const char *  name,
const char *  folder 
)

Adds a subfolder to library folder.

The function looks for the folder of a library and adds the subfolder in the search path.

Parameters
nameThe name of the library.
folderThe name of the subfolder.