Description

A list of VuoWindowReference elements.

Classes
struct	VuoList_VuoWindowReference_struct
	A list of VuoWindowReference elements. More...

Typedefs
typedef const struct VuoList_VuoWindowReference_struct *	VuoList_VuoWindowReference
	A list of VuoWindowReference elements. More...

Functions
VuoList_VuoWindowReference	VuoListCreate_VuoWindowReference (void)
	Creates a new list of VuoWindowReference elements. More...

VuoList_VuoWindowReference	VuoListCreateWithCount_VuoWindowReference (const unsigned long count, const VuoWindowReference value)
	Creates a new list of `count` instances of `value`. More...

VuoList_VuoWindowReference	VuoListCopy_VuoWindowReference (const VuoList_VuoWindowReference list)
	Makes a shallow copy of `list` — its items are retained (not copied) by the new list. More...

static unsigned long	VuoListIndexToCArrayIndex (long index, unsigned long listCount) __attribute__((const))
	Converts a Vuo-style `[1..n]` list index into a C-style `[0..n-1]` list index. More...

VuoWindowReference	VuoListGetValue_VuoWindowReference (const VuoList_VuoWindowReference list, const unsigned long index)
	Returns the VuoWindowReference at `index`. More...

VuoWindowReference *	VuoListGetData_VuoWindowReference (const VuoList_VuoWindowReference list)
	Returns a pointer to a C array containing the list items. More...

void	VuoListForeach_VuoWindowReference (const VuoList_VuoWindowReference list, bool(^function)(const VuoWindowReference value))
	Applies `function` to each of `list`'s items, serially in order of index. More...

void	VuoListSetValue_VuoWindowReference (const VuoList_VuoWindowReference list, const VuoWindowReference value, const unsigned long index, bool expandListIfNeeded)
	Changes the VuoWindowReference at `index`. More...

void	VuoListInsertValue_VuoWindowReference (const VuoList_VuoWindowReference list, const VuoWindowReference value, const unsigned long index)
	Inserts the `VuoWindowReference` immediately before `index`. More...

void	VuoListPrependValue_VuoWindowReference (VuoList_VuoWindowReference list, const VuoWindowReference value)
	Prepends `value` to `list`. More...

void	VuoListAppendValue_VuoWindowReference (VuoList_VuoWindowReference list, const VuoWindowReference value)
	Appends `value` to `list`. More...

void	VuoListExchangeValues_VuoWindowReference (VuoList_VuoWindowReference list, const unsigned long indexA, const unsigned long indexB)
	Swaps the value at `indexA` with the value at `indexB`. More...

void	VuoListShuffle_VuoWindowReference (VuoList_VuoWindowReference list, const double chaos)
	Generates a random permutation of `list`. More...

void	VuoListReverse_VuoWindowReference (VuoList_VuoWindowReference list)
	Reverses the order of the items in `list`. More...

VuoList_VuoWindowReference	VuoListSubset_VuoWindowReference (VuoList_VuoWindowReference 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_VuoWindowReference (VuoList_VuoWindowReference list)
	Removes the first value from `list`. More...

void	VuoListRemoveLastValue_VuoWindowReference (VuoList_VuoWindowReference list)
	Removes the last value from `list`. More...

void	VuoListRemoveAll_VuoWindowReference (VuoList_VuoWindowReference list)
	Removes all values from `list`. More...

void	VuoListRemoveValue_VuoWindowReference (VuoList_VuoWindowReference list, const unsigned long index)
	Removes the `VuoWindowReference` at `index`. More...

unsigned long	VuoListGetCount_VuoWindowReference (const VuoList_VuoWindowReference list)
	Returns the number of elements in `list`. More...

VuoList_VuoWindowReference	VuoList_VuoWindowReference_makeFromJson (struct json_object *js)
	Decodes the JSON object `js` to create a new value. More...

struct json_object *	VuoList_VuoWindowReference_getJson (const VuoList_VuoWindowReference value)
	Encodes `value` as a JSON object. More...

char *	VuoList_VuoWindowReference_getSummary (const VuoList_VuoWindowReference value)
	Produces a brief human-readable summary of `value`. More...

VuoList_VuoWindowReference	VuoList_VuoWindowReference_makeFromString (const char *str)
	Automatically generated function. More...

char *	VuoList_VuoWindowReference_getString (const VuoList_VuoWindowReference value)
	Automatically generated function. More...

Class Documentation

◆ VuoList_VuoWindowReference_struct

struct VuoList_VuoWindowReference_struct

Class Members
void *	l

Macro Definition Documentation

◆ VUO_LIST_INDEX_TO_C_ARRAY_INDEX

#define VUO_LIST_INDEX_TO_C_ARRAY_INDEX

Definition at line 54 of file VuoList_VuoWindowReference.h.

Typedef Documentation

◆ VuoList_VuoWindowReference

typedef const struct VuoList_VuoWindowReference_struct * VuoList_VuoWindowReference

A list of VuoWindowReference elements.

Function Documentation

◆ VuoList_VuoWindowReference_getJson()

struct json_object * VuoList_VuoWindowReference_getJson ( const VuoList_VuoWindowReference value )

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoWindowReference.cc.

◆ VuoList_VuoWindowReference_getString()

char * VuoList_VuoWindowReference_getString ( const VuoList_VuoWindowReference value )

Automatically generated function.

◆ VuoList_VuoWindowReference_getSummary()

char * VuoList_VuoWindowReference_getSummary ( const VuoList_VuoWindowReference value )

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoWindowReference.cc.

◆ VuoList_VuoWindowReference_makeFromJson()

VuoList_VuoWindowReference VuoList_VuoWindowReference_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_VuoWindowReference.cc.

◆ VuoList_VuoWindowReference_makeFromString()

VuoList_VuoWindowReference VuoList_VuoWindowReference_makeFromString ( const char * str )

Automatically generated function.

◆ VuoListAppendValue_VuoWindowReference()

void VuoListAppendValue_VuoWindowReference	(	VuoList_VuoWindowReference	list,
		const VuoWindowReference	value
	)

Appends value to list.

Definition at line 308 of file VuoList_VuoWindowReference.cc.

◆ VuoListCopy_VuoWindowReference()

VuoList_VuoWindowReference VuoListCopy_VuoWindowReference ( const VuoList_VuoWindowReference list )

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

Definition at line 174 of file VuoList_VuoWindowReference.cc.

◆ VuoListCreate_VuoWindowReference()

VuoList_VuoWindowReference VuoListCreate_VuoWindowReference ( void )

Creates a new list of VuoWindowReference elements.

Definition at line 154 of file VuoList_VuoWindowReference.cc.

◆ VuoListCreateWithCount_VuoWindowReference()

VuoList_VuoWindowReference VuoListCreateWithCount_VuoWindowReference	(	const unsigned long	count,
		const VuoWindowReference	value
	)

Creates a new list of count instances of value.

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

Definition at line 161 of file VuoList_VuoWindowReference.cc.

◆ VuoListExchangeValues_VuoWindowReference()

void VuoListExchangeValues_VuoWindowReference	(	VuoList_VuoWindowReference	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_VuoWindowReference.cc.

◆ VuoListForeach_VuoWindowReference()

void VuoListForeach_VuoWindowReference	(	const VuoList_VuoWindowReference	list,
		bool(^)(const VuoWindowReference 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_VuoWindowReference.cc.

◆ VuoListGetCount_VuoWindowReference()

unsigned long VuoListGetCount_VuoWindowReference ( const VuoList_VuoWindowReference list )

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoWindowReference.cc.

◆ VuoListGetData_VuoWindowReference()

VuoWindowReference * VuoListGetData_VuoWindowReference ( const VuoList_VuoWindowReference 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_VuoWindowReference.cc.

◆ VuoListGetValue_VuoWindowReference()

VuoWindowReference VuoListGetValue_VuoWindowReference	(	const VuoList_VuoWindowReference	list,
		const unsigned long	index
	)

Returns the VuoWindowReference 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_VuoWindowReference or VuoListForeach_VuoWindowReference.

Definition at line 203 of file VuoList_VuoWindowReference.cc.

◆ VuoListIndexToCArrayIndex()

static unsigned long VuoListIndexToCArrayIndex	(	long	index,
		unsigned long	listCount
	)		const

inlinestatic

Converts a Vuo-style [1..n] list index into a C-style [0..n-1] list index.

If the index is less than 1, or larger than the size of the list, the returned index is clamped.

Definition at line 61 of file VuoList_VuoWindowReference.h.

◆ VuoListInsertValue_VuoWindowReference()

void VuoListInsertValue_VuoWindowReference	(	const VuoList_VuoWindowReference	list,
		const VuoWindowReference	value,
		const unsigned long	index
	)

Inserts the VuoWindowReference 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_VuoWindowReference.cc.

◆ VuoListPrependValue_VuoWindowReference()

void VuoListPrependValue_VuoWindowReference	(	VuoList_VuoWindowReference	list,
		const VuoWindowReference	value
	)

Prepends value to list.

Definition at line 298 of file VuoList_VuoWindowReference.cc.

◆ VuoListRemoveAll_VuoWindowReference()

void VuoListRemoveAll_VuoWindowReference ( VuoList_VuoWindowReference list )

Removes all values from list.

Definition at line 527 of file VuoList_VuoWindowReference.cc.

◆ VuoListRemoveFirstValue_VuoWindowReference()

void VuoListRemoveFirstValue_VuoWindowReference ( VuoList_VuoWindowReference list )

Removes the first value from list.

Definition at line 499 of file VuoList_VuoWindowReference.cc.

◆ VuoListRemoveLastValue_VuoWindowReference()

void VuoListRemoveLastValue_VuoWindowReference ( VuoList_VuoWindowReference list )

Removes the last value from list.

Definition at line 513 of file VuoList_VuoWindowReference.cc.

◆ VuoListRemoveValue_VuoWindowReference()

void VuoListRemoveValue_VuoWindowReference	(	VuoList_VuoWindowReference	list,
		const unsigned long	index
	)

Removes the VuoWindowReference 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_VuoWindowReference.cc.

◆ VuoListReverse_VuoWindowReference()

void VuoListReverse_VuoWindowReference ( VuoList_VuoWindowReference list )

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoWindowReference.cc.

◆ VuoListSetValue_VuoWindowReference()

void VuoListSetValue_VuoWindowReference	(	const VuoList_VuoWindowReference	list,
		const VuoWindowReference	value,
		const unsigned long	index,
		bool	expandListIfNeeded
	)

Changes the VuoWindowReference 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_VuoWindowReference.cc.

◆ VuoListShuffle_VuoWindowReference()

void VuoListShuffle_VuoWindowReference	(	VuoList_VuoWindowReference	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_VuoWindowReference.cc.

◆ VuoListSubset_VuoWindowReference()

VuoList_VuoWindowReference VuoListSubset_VuoWindowReference	(	VuoList_VuoWindowReference	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_VuoWindowReference.cc.