Vuo
1.2.7
|
A list of VuoUrl elements.
Classes | |
struct | VuoList_VuoUrl_struct |
A list of VuoUrl elements. More... | |
Typedefs | |
typedef const struct VuoList_VuoUrl_struct * | VuoList_VuoUrl |
A list of VuoUrl elements. More... | |
Functions | |
VuoList_VuoUrl | VuoListCreate_VuoUrl (void) |
Creates a new list of VuoUrl elements. More... | |
VuoList_VuoUrl | VuoListCreateWithCount_VuoUrl (const unsigned long count, const VuoUrl value) |
Creates a new list of count instances of value . More... | |
VuoList_VuoUrl | VuoListCopy_VuoUrl (const VuoList_VuoUrl list) |
Makes a shallow copy of list — its items are retained (not copied) by the new list. More... | |
VuoUrl | VuoListGetValue_VuoUrl (const VuoList_VuoUrl list, const unsigned long index) |
Returns the VuoUrl at index . More... | |
VuoUrl * | VuoListGetData_VuoUrl (const VuoList_VuoUrl list) |
Returns a pointer to a C array containing the list items. More... | |
void | VuoListSetValue_VuoUrl (const VuoList_VuoUrl list, const VuoUrl value, const unsigned long index, bool expandListIfNeeded) |
Changes the VuoUrl at index . More... | |
void | VuoListInsertValue_VuoUrl (const VuoList_VuoUrl list, const VuoUrl value, const unsigned long index) |
Inserts the VuoUrl immediately before index . More... | |
void | VuoListPrependValue_VuoUrl (VuoList_VuoUrl list, const VuoUrl value) |
Prepends value to list . More... | |
void | VuoListAppendValue_VuoUrl (VuoList_VuoUrl list, const VuoUrl value) |
Appends value to list . More... | |
void | VuoListExchangeValues_VuoUrl (VuoList_VuoUrl list, const unsigned long indexA, const unsigned long indexB) |
Swaps the value at indexA with the value at indexB . More... | |
void | VuoListShuffle_VuoUrl (VuoList_VuoUrl list, const double chaos) |
Generates a random permutation of list . More... | |
void | VuoListReverse_VuoUrl (VuoList_VuoUrl list) |
Reverses the order of the items in list . More... | |
VuoList_VuoUrl | VuoListSubset_VuoUrl (VuoList_VuoUrl list, const signed long startIndex, const unsigned long itemCount) |
Returns a new list containing items from the original list in the range specified by startIndex and itemCount . More... | |
void | VuoListRemoveFirstValue_VuoUrl (VuoList_VuoUrl list) |
Removes the first value from list . More... | |
void | VuoListRemoveLastValue_VuoUrl (VuoList_VuoUrl list) |
Removes the last value from list . More... | |
void | VuoListRemoveAll_VuoUrl (VuoList_VuoUrl list) |
Removes all values from list . More... | |
void | VuoListRemoveValue_VuoUrl (VuoList_VuoUrl list, const unsigned long index) |
Removes the VuoUrl at index . More... | |
unsigned long | VuoListGetCount_VuoUrl (const VuoList_VuoUrl list) |
Returns the number of elements in list . More... | |
VuoList_VuoUrl | VuoList_VuoUrl_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. More... | |
struct json_object * | VuoList_VuoUrl_getJson (const VuoList_VuoUrl value) |
Encodes value as a JSON object. More... | |
char * | VuoList_VuoUrl_getSummary (const VuoList_VuoUrl value) |
Produces a brief human-readable summary of value . More... | |
VuoList_VuoUrl | VuoList_VuoUrl_makeFromString (const char *str) |
Automatically generated function. More... | |
char * | VuoList_VuoUrl_getString (const VuoList_VuoUrl value) |
Automatically generated function. More... | |
typedef const struct VuoList_VuoUrl_struct * VuoList_VuoUrl |
A list of VuoUrl elements.
struct json_object* VuoList_VuoUrl_getJson | ( | const VuoList_VuoUrl | value | ) |
Encodes value
as a JSON object.
char* VuoList_VuoUrl_getString | ( | const VuoList_VuoUrl | value | ) |
Automatically generated function.
char* VuoList_VuoUrl_getSummary | ( | const VuoList_VuoUrl | value | ) |
Produces a brief human-readable summary of value
.
VuoList_VuoUrl VuoList_VuoUrl_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
VuoList_VuoUrl VuoList_VuoUrl_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoUrl | ( | VuoList_VuoUrl | list, |
const VuoUrl | value | ||
) |
Appends value
to list
.
VuoList_VuoUrl VuoListCopy_VuoUrl | ( | const VuoList_VuoUrl | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
VuoList_VuoUrl VuoListCreate_VuoUrl | ( | void | ) |
Creates a new list of VuoUrl elements.
VuoList_VuoUrl VuoListCreateWithCount_VuoUrl | ( | const unsigned long | count, |
const VuoUrl | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoUrl to quickly initialize a large list.
void VuoListExchangeValues_VuoUrl | ( | VuoList_VuoUrl | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
unsigned long VuoListGetCount_VuoUrl | ( | const VuoList_VuoUrl | list | ) |
Returns the number of elements in list
.
VuoUrl* VuoListGetData_VuoUrl | ( | const VuoList_VuoUrl | list | ) |
Returns a pointer to a C array containing the list items.
Use this if you need a fast way to get or change multiple list items.
You can modify values in the list by changing them in this array. Just don't attempt to access beyond the list size.
The pointer becomes invalid if you modify the list size using other functions (e.g., Insert, Prepend, Append, Cut, Remove); if you use those functions, just get a new pointer by calling this function again.
If the list has no items, returns NULL.
The pointer remains owned by the list; don't free it.
VuoUrl VuoListGetValue_VuoUrl | ( | const VuoList_VuoUrl | list, |
const unsigned long | index | ||
) |
Returns the VuoUrl at index
.
Index values start at 1. If the list has no items, returns a default value. Attempting to access an out-of-bounds index returns the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).
void VuoListInsertValue_VuoUrl | ( | const VuoList_VuoUrl | list, |
const VuoUrl | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoUrl
immediately before index
.
Index values start at 1. Inserting at index 0 prepends the value to the list. Inserting at an index beyond the last value in the list appends the value to the list.
void VuoListPrependValue_VuoUrl | ( | VuoList_VuoUrl | list, |
const VuoUrl | value | ||
) |
Prepends value
to list
.
void VuoListRemoveAll_VuoUrl | ( | VuoList_VuoUrl | list | ) |
Removes all values from list
.
void VuoListRemoveFirstValue_VuoUrl | ( | VuoList_VuoUrl | list | ) |
Removes the first value from list
.
void VuoListRemoveLastValue_VuoUrl | ( | VuoList_VuoUrl | list | ) |
Removes the last value from list
.
void VuoListRemoveValue_VuoUrl | ( | VuoList_VuoUrl | list, |
const unsigned long | index | ||
) |
Removes the VuoUrl
at index
.
Index values start at 1. Attempting to remove index 0 or an index beyond the last value in the list has no effect.
void VuoListReverse_VuoUrl | ( | VuoList_VuoUrl | list | ) |
Reverses the order of the items in list
.
void VuoListSetValue_VuoUrl | ( | const VuoList_VuoUrl | list, |
const VuoUrl | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the VuoUrl at index
.
Index values start at 1.
If expandListIfNeeded
is false: If the list has no items, nothing is changed. Attempting to change an out-of-bounds index changes the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).
If expandListIfNeeded
is true: If the list has less than index
elements, it is expanded to accommodate the specified index
. If index
is 0, the list is resized to contain 1 item set to value
.
void VuoListShuffle_VuoUrl | ( | VuoList_VuoUrl | list, |
const double | chaos | ||
) |
Generates a random permutation of list
.
chaos
ranges from 0 to 1. When chaos
is 1, a full Fisher–Yates shuffle is performed. When less than 1, fewer iterations are performed.
VuoList_VuoUrl VuoListSubset_VuoUrl | ( | VuoList_VuoUrl | list, |
const signed long | startIndex, | ||
const unsigned long | itemCount | ||
) |
Returns a new list containing items from the original list in the range specified by startIndex
and itemCount
.
Items in the new list are retained (not copied) from the original list.