Vuo  2.3.2
Classes | Typedefs | Functions
VuoList_VuoUrl

Description

A list of VuoUrl elements.

Classes

struct  VuoList_VuoUrl_struct
 A list of VuoUrl elements. More...
 

Typedefs

typedef const struct VuoList_VuoUrl_structVuoList_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...
 
VuoUrlVuoListGetData_VuoUrl (const VuoList_VuoUrl list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoUrl (const VuoList_VuoUrl list, bool(^function)(const VuoUrl value))
 Applies function to each of list's items, serially in order of index. 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_objectVuoList_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...
 

Class Documentation

◆ VuoList_VuoUrl_struct

struct VuoList_VuoUrl_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoUrl

typedef const struct VuoList_VuoUrl_struct * VuoList_VuoUrl

A list of VuoUrl elements.

Function Documentation

◆ VuoList_VuoUrl_getJson()

struct json_object* VuoList_VuoUrl_getJson ( const VuoList_VuoUrl  value)

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoUrl.cc.

◆ VuoList_VuoUrl_getString()

char* VuoList_VuoUrl_getString ( const VuoList_VuoUrl  value)

Automatically generated function.

◆ VuoList_VuoUrl_getSummary()

char* VuoList_VuoUrl_getSummary ( const VuoList_VuoUrl  value)

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoUrl.cc.

◆ VuoList_VuoUrl_makeFromJson()

VuoList_VuoUrl VuoList_VuoUrl_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

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

Definition at line 63 of file VuoList_VuoUrl.cc.

◆ VuoList_VuoUrl_makeFromString()

VuoList_VuoUrl VuoList_VuoUrl_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoUrl()

void VuoListAppendValue_VuoUrl ( VuoList_VuoUrl  list,
const VuoUrl  value 
)

Appends value to list.

Definition at line 308 of file VuoList_VuoUrl.cc.

◆ VuoListCopy_VuoUrl()

VuoList_VuoUrl VuoListCopy_VuoUrl ( const VuoList_VuoUrl  list)

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

Definition at line 174 of file VuoList_VuoUrl.cc.

◆ VuoListCreate_VuoUrl()

VuoList_VuoUrl VuoListCreate_VuoUrl ( void  )

Creates a new list of VuoUrl elements.

Definition at line 154 of file VuoList_VuoUrl.cc.

◆ VuoListCreateWithCount_VuoUrl()

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.

Definition at line 161 of file VuoList_VuoUrl.cc.

◆ VuoListExchangeValues_VuoUrl()

void VuoListExchangeValues_VuoUrl ( VuoList_VuoUrl  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

Definition at line 318 of file VuoList_VuoUrl.cc.

◆ VuoListForeach_VuoUrl()

void VuoListForeach_VuoUrl ( const VuoList_VuoUrl  list,
bool(^)(const VuoUrl value)  function 
)

Applies function to each of list's items, 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.

Definition at line 229 of file VuoList_VuoUrl.cc.

◆ VuoListGetCount_VuoUrl()

unsigned long VuoListGetCount_VuoUrl ( const VuoList_VuoUrl  list)

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoUrl.cc.

◆ VuoListGetData_VuoUrl()

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.

Definition at line 219 of file VuoList_VuoUrl.cc.

◆ VuoListGetValue_VuoUrl()

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

If iterating over an entire list, consider using VuoListGetData_VuoUrl or VuoListForeach_VuoUrl.

Definition at line 203 of file VuoList_VuoUrl.cc.

◆ VuoListInsertValue_VuoUrl()

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.

Definition at line 276 of file VuoList_VuoUrl.cc.

◆ VuoListPrependValue_VuoUrl()

void VuoListPrependValue_VuoUrl ( VuoList_VuoUrl  list,
const VuoUrl  value 
)

Prepends value to list.

Definition at line 298 of file VuoList_VuoUrl.cc.

◆ VuoListRemoveAll_VuoUrl()

void VuoListRemoveAll_VuoUrl ( VuoList_VuoUrl  list)

Removes all values from list.

Definition at line 527 of file VuoList_VuoUrl.cc.

◆ VuoListRemoveFirstValue_VuoUrl()

void VuoListRemoveFirstValue_VuoUrl ( VuoList_VuoUrl  list)

Removes the first value from list.

Definition at line 499 of file VuoList_VuoUrl.cc.

◆ VuoListRemoveLastValue_VuoUrl()

void VuoListRemoveLastValue_VuoUrl ( VuoList_VuoUrl  list)

Removes the last value from list.

Definition at line 513 of file VuoList_VuoUrl.cc.

◆ VuoListRemoveValue_VuoUrl()

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.

Definition at line 536 of file VuoList_VuoUrl.cc.

◆ VuoListReverse_VuoUrl()

void VuoListReverse_VuoUrl ( VuoList_VuoUrl  list)

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoUrl.cc.

◆ VuoListSetValue_VuoUrl()

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.

Definition at line 241 of file VuoList_VuoUrl.cc.

◆ VuoListShuffle_VuoUrl()

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.

Definition at line 401 of file VuoList_VuoUrl.cc.

◆ VuoListSubset_VuoUrl()

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.

Definition at line 431 of file VuoList_VuoUrl.cc.