Vuo 2.4.4
Loading...
Searching...
No Matches
Classes
VuoList_VuoKey.h File Reference

Description

VuoList interface.

Definition in file VuoList_VuoKey.h.

Go to the source code of this file.

Classes

struct  VuoList_VuoKey
 An ordered list of items, all of the same type. More...
 

Functions

VuoList_VuoKey VuoListCreate_VuoKey (void)
 Creates a new list of VuoKey items.
 
VuoList_VuoKey VuoListCreateWithCount_VuoKey (const unsigned long count, const VuoKey value)
 Creates a new list of count instances of value.
 
VuoList_VuoKey VuoListCreateWithValueArray_VuoKey (const VuoKey *values, const unsigned long valueCount)
 Creates a new list containing the items in the C array values.
 
VuoList_VuoKey VuoListCopy_VuoKey (const VuoList_VuoKey list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoKey VuoListGetValue_VuoKey (const VuoList_VuoKey list, const unsigned long index)
 Returns the item at index.
 
VuoKeyVuoListGetData_VuoKey (const VuoList_VuoKey list)
 Returns a pointer to a C array containing the list items.
 
void VuoListForeach_VuoKey (const VuoList_VuoKey list, bool(^function)(const VuoKey value))
 Applies function to each item in list, serially in order of index.
 
void VuoListSetValue_VuoKey (const VuoList_VuoKey list, const VuoKey value, const unsigned long index, bool expandListIfNeeded)
 Changes the item at index.
 
void VuoListInsertValue_VuoKey (const VuoList_VuoKey list, const VuoKey value, const unsigned long index)
 Inserts value immediately before index.
 
void VuoListPrependValue_VuoKey (VuoList_VuoKey list, const VuoKey value)
 Prepends value to list.
 
void VuoListAppendValue_VuoKey (VuoList_VuoKey list, const VuoKey value)
 Appends value to list.
 
void VuoListExchangeValues_VuoKey (VuoList_VuoKey list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoKey (VuoList_VuoKey list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoKey (VuoList_VuoKey list)
 Reverses the order of the items in list.
 
VuoList_VuoKey VuoListSubset_VuoKey (VuoList_VuoKey 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.
 
void VuoListRemoveFirstValue_VuoKey (VuoList_VuoKey list)
 Removes the first item from list.
 
void VuoListRemoveLastValue_VuoKey (VuoList_VuoKey list)
 Removes the last item from list.
 
void VuoListRemoveAll_VuoKey (VuoList_VuoKey list)
 Removes all items from list.
 
void VuoListRemoveValue_VuoKey (VuoList_VuoKey list, const unsigned long index)
 Removes the item at index.
 
unsigned long VuoListGetCount_VuoKey (const VuoList_VuoKey list)
 Returns the number of items in list.
 
VuoList_VuoKey VuoList_VuoKey_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new list.
 
struct json_object * VuoList_VuoKey_getJson (const VuoList_VuoKey list)
 Encodes list as a JSON object.
 
char * VuoList_VuoKey_getSummary (const VuoList_VuoKey list)
 Produces a brief human-readable summary of list.
 
void VuoList_VuoKey_retain (VuoList_VuoKey list)
 Retains the list.
 
void VuoList_VuoKey_release (VuoList_VuoKey list)
 Releases the list.
 
char * VuoList_VuoKey_getString (const VuoList_VuoKey list)
 Automatically generated function.
 

Function Documentation

◆ VuoList_VuoKey_getJson()

struct json_object * VuoList_VuoKey_getJson ( const VuoList_VuoKey  list)

Encodes list as a JSON object.

◆ VuoList_VuoKey_getString()

char * VuoList_VuoKey_getString ( const VuoList_VuoKey  list)

Automatically generated function.

◆ VuoList_VuoKey_getSummary()

char * VuoList_VuoKey_getSummary ( const VuoList_VuoKey  list)

Produces a brief human-readable summary of list.

◆ VuoList_VuoKey_makeFromJson()

VuoList_VuoKey VuoList_VuoKey_makeFromJson ( struct json_object *  js)

Decodes the JSON object js to create a new list.

Example:
["uno", "dos", "tres", "catorce"]

◆ VuoList_VuoKey_release()

void VuoList_VuoKey_release ( VuoList_VuoKey  list)

Releases the list.

This function is provided for use in polymorphism; it just calls VuoRelease().

◆ VuoList_VuoKey_retain()

void VuoList_VuoKey_retain ( VuoList_VuoKey  list)

Retains the list.

This function is provided for use in polymorphism; it just calls VuoRetain().

◆ VuoListAppendValue_VuoKey()

void VuoListAppendValue_VuoKey ( VuoList_VuoKey  list,
const VuoKey  value 
)

Appends value to list.

◆ VuoListCopy_VuoKey()

VuoList_VuoKey VuoListCopy_VuoKey ( const VuoList_VuoKey  list)

Makes a shallow copy of list — its items are retained (not copied) by the new list.

◆ VuoListCreate_VuoKey()

VuoList_VuoKey VuoListCreate_VuoKey ( void  )

Creates a new list of VuoKey items.

◆ VuoListCreateWithCount_VuoKey()

VuoList_VuoKey VuoListCreateWithCount_VuoKey ( const unsigned long  count,
const VuoKey  value 
)

Creates a new list of count instances of value.

Use this in conjunction with VuoListGetData_VuoKey to quickly initialize a large list.

◆ VuoListCreateWithValueArray_VuoKey()

VuoList_VuoKey VuoListCreateWithValueArray_VuoKey ( const VuoKey values,
const unsigned long  valueCount 
)

Creates a new list containing the items in the C array values.

The list retains each item in values. The caller may discard values after this function returns.

◆ VuoListExchangeValues_VuoKey()

void VuoListExchangeValues_VuoKey ( VuoList_VuoKey  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

◆ VuoListForeach_VuoKey()

void VuoListForeach_VuoKey ( const VuoList_VuoKey  list,
bool(^)(const VuoKey value)  function 
)

Applies function to each item in list, serially in order of index.

If function returns false, visiting will stop immediately (possibly before all items have been visited).

Changed in Vuo 2.0.0:
New.

◆ VuoListGetCount_VuoKey()

unsigned long VuoListGetCount_VuoKey ( const VuoList_VuoKey  list)

Returns the number of items in list.

◆ VuoListGetData_VuoKey()

VuoKey * VuoListGetData_VuoKey ( const VuoList_VuoKey  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.

◆ VuoListGetValue_VuoKey()

VuoKey VuoListGetValue_VuoKey ( const VuoList_VuoKey  list,
const unsigned long  index 
)

Returns the item at index.

Index values start at 1.

If the list has no items, returns a default value (an empty/zero value of VuoKey).

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).

If iterating over an entire list, consider using VuoListGetData_VuoKey or VuoListForeach_VuoKey.

◆ VuoListInsertValue_VuoKey()

void VuoListInsertValue_VuoKey ( const VuoList_VuoKey  list,
const VuoKey  value,
const unsigned long  index 
)

Inserts value 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.

◆ VuoListPrependValue_VuoKey()

void VuoListPrependValue_VuoKey ( VuoList_VuoKey  list,
const VuoKey  value 
)

Prepends value to list.

◆ VuoListRemoveAll_VuoKey()

void VuoListRemoveAll_VuoKey ( VuoList_VuoKey  list)

Removes all items from list.

◆ VuoListRemoveFirstValue_VuoKey()

void VuoListRemoveFirstValue_VuoKey ( VuoList_VuoKey  list)

Removes the first item from list.

◆ VuoListRemoveLastValue_VuoKey()

void VuoListRemoveLastValue_VuoKey ( VuoList_VuoKey  list)

Removes the last item from list.

◆ VuoListRemoveValue_VuoKey()

void VuoListRemoveValue_VuoKey ( VuoList_VuoKey  list,
const unsigned long  index 
)

Removes the item 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.

◆ VuoListReverse_VuoKey()

void VuoListReverse_VuoKey ( VuoList_VuoKey  list)

Reverses the order of the items in list.

◆ VuoListSetValue_VuoKey()

void VuoListSetValue_VuoKey ( const VuoList_VuoKey  list,
const VuoKey  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the item 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 items, it is expanded to accommodate the specified index. If index is 0, the list is resized to contain 1 item set to value.

◆ VuoListShuffle_VuoKey()

void VuoListShuffle_VuoKey ( VuoList_VuoKey  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.

◆ VuoListSubset_VuoKey()

VuoList_VuoKey VuoListSubset_VuoKey ( VuoList_VuoKey  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.