Description

A list of VuoFileType elements.

Classes
struct	VuoList_VuoFileType_struct
	List type. More...

Typedefs
typedef const struct VuoList_VuoFileType_struct *	VuoList_VuoFileType
	A list of VuoFileType elements. More...

Functions
VuoList_VuoFileType	VuoListCreate_VuoFileType (void)
	Creates a new list of VuoFileType elements. More...

VuoList_VuoFileType	VuoListCreateWithCount_VuoFileType (const unsigned long count, const VuoFileType value)
	Creates a new list of `count` instances of `value`. More...

VuoList_VuoFileType	VuoListCreateWithValueArray_VuoFileType (const VuoFileType *values, const unsigned long valueCount)
	Creates a new list containing the items in the C array `values`. More...

VuoList_VuoFileType	VuoListCopy_VuoFileType (const VuoList_VuoFileType 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...

VuoFileType	VuoListGetValue_VuoFileType (const VuoList_VuoFileType list, const unsigned long index)
	Returns the VuoFileType at `index`. More...

VuoFileType *	VuoListGetData_VuoFileType (const VuoList_VuoFileType list)
	Returns a pointer to a C array containing the list items. More...

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

void	VuoListSetValue_VuoFileType (const VuoList_VuoFileType list, const VuoFileType value, const unsigned long index, bool expandListIfNeeded)
	Changes the VuoFileType at `index`. More...

void	VuoListInsertValue_VuoFileType (const VuoList_VuoFileType list, const VuoFileType value, const unsigned long index)
	Inserts the `VuoFileType` immediately before `index`. More...

void	VuoListPrependValue_VuoFileType (VuoList_VuoFileType list, const VuoFileType value)
	Prepends `value` to `list`. More...

void	VuoListAppendValue_VuoFileType (VuoList_VuoFileType list, const VuoFileType value)
	Appends `value` to `list`. More...

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

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

void	VuoListReverse_VuoFileType (VuoList_VuoFileType list)
	Reverses the order of the items in `list`. More...

VuoList_VuoFileType	VuoListSubset_VuoFileType (VuoList_VuoFileType 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_VuoFileType (VuoList_VuoFileType list)
	Removes the first value from `list`. More...

void	VuoListRemoveLastValue_VuoFileType (VuoList_VuoFileType list)
	Removes the last value from `list`. More...

void	VuoListRemoveAll_VuoFileType (VuoList_VuoFileType list)
	Removes all values from `list`. More...

void	VuoListRemoveValue_VuoFileType (VuoList_VuoFileType list, const unsigned long index)
	Removes the `VuoFileType` at `index`. More...

unsigned long	VuoListGetCount_VuoFileType (const VuoList_VuoFileType list)
	Returns the number of elements in `list`. More...

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

struct json_object *	VuoList_VuoFileType_getJson (const VuoList_VuoFileType value)
	Encodes `value` as a JSON object. More...

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

void	VuoList_VuoFileType_retain (VuoList_VuoFileType value)
	Retains the list. More...

void	VuoList_VuoFileType_release (VuoList_VuoFileType value)
	Releases the list. More...

char *	VuoList_VuoFileType_getString (const VuoList_VuoFileType value)
	Automatically generated function. More...

Class Documentation

◆ VuoList_VuoFileType_struct

struct VuoList_VuoFileType_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 63 of file VuoList_VuoFileType.h.

Typedef Documentation

◆ VuoList_VuoFileType

typedef const struct VuoList_VuoFileType_struct * VuoList_VuoFileType

A list of VuoFileType elements.

Function Documentation

◆ VuoList_VuoFileType_getJson()

struct json_object * VuoList_VuoFileType_getJson ( const VuoList_VuoFileType value )

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoFileType.cc.

◆ VuoList_VuoFileType_getString()

char * VuoList_VuoFileType_getString ( const VuoList_VuoFileType value )

Automatically generated function.

◆ VuoList_VuoFileType_getSummary()

char * VuoList_VuoFileType_getSummary ( const VuoList_VuoFileType value )

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoFileType.cc.

◆ VuoList_VuoFileType_makeFromJson()

VuoList_VuoFileType VuoList_VuoFileType_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_VuoFileType.cc.

◆ VuoList_VuoFileType_release()

void VuoList_VuoFileType_release ( VuoList_VuoFileType value )

Releases the list.

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

Definition at line 580 of file VuoList_VuoFileType.cc.

◆ VuoList_VuoFileType_retain()

void VuoList_VuoFileType_retain ( VuoList_VuoFileType value )

Retains the list.

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

Definition at line 575 of file VuoList_VuoFileType.cc.

◆ VuoListAppendValue_VuoFileType()

void VuoListAppendValue_VuoFileType	(	VuoList_VuoFileType	list,
		const VuoFileType	value
	)

Appends value to list.

Definition at line 321 of file VuoList_VuoFileType.cc.

◆ VuoListCopy_VuoFileType()

VuoList_VuoFileType VuoListCopy_VuoFileType ( const VuoList_VuoFileType list )

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

Definition at line 187 of file VuoList_VuoFileType.cc.

◆ VuoListCreate_VuoFileType()

VuoList_VuoFileType VuoListCreate_VuoFileType ( void )

Creates a new list of VuoFileType elements.

Definition at line 154 of file VuoList_VuoFileType.cc.

◆ VuoListCreateWithCount_VuoFileType()

VuoList_VuoFileType VuoListCreateWithCount_VuoFileType	(	const unsigned long	count,
		const VuoFileType	value
	)

Creates a new list of count instances of value.

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

Definition at line 161 of file VuoList_VuoFileType.cc.

◆ VuoListCreateWithValueArray_VuoFileType()

VuoList_VuoFileType VuoListCreateWithValueArray_VuoFileType	(	const VuoFileType *	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.

Definition at line 174 of file VuoList_VuoFileType.cc.

◆ VuoListExchangeValues_VuoFileType()

void VuoListExchangeValues_VuoFileType	(	VuoList_VuoFileType	list,
		const unsigned long	indexA,
		const unsigned long	indexB
	)

Swaps the value at indexA with the value at indexB.

Definition at line 331 of file VuoList_VuoFileType.cc.

◆ VuoListForeach_VuoFileType()

void VuoListForeach_VuoFileType	(	const VuoList_VuoFileType	list,
		bool(^)(const VuoFileType 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 242 of file VuoList_VuoFileType.cc.

◆ VuoListGetCount_VuoFileType()

unsigned long VuoListGetCount_VuoFileType ( const VuoList_VuoFileType list )

Returns the number of elements in list.

Definition at line 566 of file VuoList_VuoFileType.cc.

◆ VuoListGetData_VuoFileType()

VuoFileType * VuoListGetData_VuoFileType ( const VuoList_VuoFileType 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 232 of file VuoList_VuoFileType.cc.

◆ VuoListGetValue_VuoFileType()

VuoFileType VuoListGetValue_VuoFileType	(	const VuoList_VuoFileType	list,
		const unsigned long	index
	)

Returns the VuoFileType 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_VuoFileType or VuoListForeach_VuoFileType.

Definition at line 216 of file VuoList_VuoFileType.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 70 of file VuoList_VuoFileType.h.

◆ VuoListInsertValue_VuoFileType()

void VuoListInsertValue_VuoFileType	(	const VuoList_VuoFileType	list,
		const VuoFileType	value,
		const unsigned long	index
	)

Inserts the VuoFileType 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 289 of file VuoList_VuoFileType.cc.

◆ VuoListPrependValue_VuoFileType()

void VuoListPrependValue_VuoFileType	(	VuoList_VuoFileType	list,
		const VuoFileType	value
	)

Prepends value to list.

Definition at line 311 of file VuoList_VuoFileType.cc.

◆ VuoListRemoveAll_VuoFileType()

void VuoListRemoveAll_VuoFileType ( VuoList_VuoFileType list )

Removes all values from list.

Definition at line 540 of file VuoList_VuoFileType.cc.

◆ VuoListRemoveFirstValue_VuoFileType()

void VuoListRemoveFirstValue_VuoFileType ( VuoList_VuoFileType list )

Removes the first value from list.

Definition at line 512 of file VuoList_VuoFileType.cc.

◆ VuoListRemoveLastValue_VuoFileType()

void VuoListRemoveLastValue_VuoFileType ( VuoList_VuoFileType list )

Removes the last value from list.

Definition at line 526 of file VuoList_VuoFileType.cc.

◆ VuoListRemoveValue_VuoFileType()

void VuoListRemoveValue_VuoFileType	(	VuoList_VuoFileType	list,
		const unsigned long	index
	)

Removes the VuoFileType 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 549 of file VuoList_VuoFileType.cc.

◆ VuoListReverse_VuoFileType()

void VuoListReverse_VuoFileType ( VuoList_VuoFileType list )

Reverses the order of the items in list.

Definition at line 435 of file VuoList_VuoFileType.cc.

◆ VuoListSetValue_VuoFileType()

void VuoListSetValue_VuoFileType	(	const VuoList_VuoFileType	list,
		const VuoFileType	value,
		const unsigned long	index,
		bool	expandListIfNeeded
	)

Changes the VuoFileType 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 254 of file VuoList_VuoFileType.cc.

◆ VuoListShuffle_VuoFileType()

void VuoListShuffle_VuoFileType	(	VuoList_VuoFileType	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 414 of file VuoList_VuoFileType.cc.

◆ VuoListSubset_VuoFileType()

VuoList_VuoFileType VuoListSubset_VuoFileType	(	VuoList_VuoFileType	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 444 of file VuoList_VuoFileType.cc.