lv_array.h

API reference for lv_array.h

Report on GitHub

Array. The elements are dynamically allocated by the 'lv_mem' module.

Summary

20Functions

1Structs

2Macros

Functions

misc/lv_array.h:54function

lv_array_init_from_buf

Init an array from a buffer.

void lv_array_init_from_buf(lv_array_t *array, void *buf, uint32_t capacity, uint32_t element_size)

Name	Type	Description
`array`	`lv_array_t *`	pointer to an `lv_array_t` variable to initialize
`buf`	`void *`	pointer to a buffer to use as the array's data
`capacity`	`uint32_t`	the initial capacity of the array
`element_size`	`uint32_t`	the size of an element in bytes

The buffer must be large enough to store capacity elements. The array will not release the buffer and reallocate it. The user must ensure that the buffer is valid during the lifetime of the array. And release the buffer when the array is no longer needed.

misc/lv_array.h:73function

lv_array_resize

Resize the array to the given capacity.

bool lv_array_resize(lv_array_t *array, uint32_t new_capacity)

Name	Type	Description
`array`	`lv_array_t *`	pointer to an `lv_array_t` variable
`new_capacity`	`uint32_t`	the new capacity of the array

if the new capacity is smaller than the current size, the array will be truncated.

misc/lv_array.h:79function

lv_array_deinit

Deinit the array, and free the allocated memory

void lv_array_deinit(lv_array_t *array)

Name	Type	Description
`array`	`lv_array_t *`	pointer to an `lv_array_t` variable to deinitialize

misc/lv_array.h:86function

lv_array_size

Return how many elements are stored in the array.

static uint32_t lv_array_size(const lv_array_t *array)

Name	Type	Description
`array`	`const lv_array_t *`	pointer to an `lv_array_t` variable

Returns: uint32_t — the number of elements stored in the array

misc/lv_array.h:96function

lv_array_capacity

Return the capacity of the array, i.e. how many elements can be stored.

static uint32_t lv_array_capacity(const lv_array_t *array)

Name	Type	Description
`array`	`const lv_array_t *`	pointer to an `lv_array_t` variable

Returns: uint32_t — the capacity of the array

misc/lv_array.h:106function

lv_array_is_empty

Return if the array is empty

static bool lv_array_is_empty(const lv_array_t *array)

Name	Type	Description
`array`	`const lv_array_t *`	pointer to an `lv_array_t` variable

Returns: bool — true: array is empty; false: array is not empty

misc/lv_array.h:116function

lv_array_is_full

Return if the array is full

static bool lv_array_is_full(const lv_array_t *array)

Name	Type	Description
`array`	`const lv_array_t *`	pointer to an `lv_array_t` variable

Returns: bool — true: array is full; false: array is not full

misc/lv_array.h:127function

lv_array_copy

Copy an array to another.

void lv_array_copy(lv_array_t *target, const lv_array_t *source)

Name	Type	Description
`target`	`lv_array_t *`	pointer to an `lv_array_t` variable to copy to
`source`	`const lv_array_t *`	pointer to an `lv_array_t` variable to copy from

this will create a new array with the same capacity and size as the source array.

misc/lv_array.h:133function

lv_array_clear

Remove all elements in array.

static void lv_array_clear(lv_array_t *array)

Name	Type	Description
`array`	`lv_array_t *`	pointer to an `lv_array_t` variable

misc/lv_array.h:142function

lv_array_shrink

Shrink the memory capacity of array if necessary.

void lv_array_shrink(lv_array_t *array)

Name	Type	Description
`array`	`lv_array_t *`	pointer to an `lv_array_t` variable

misc/lv_array.h:153function

lv_array_remove

Remove the element at the specified position in the array.

This function keeps the array order. Complexity is O(n)

lv_result_t lv_array_remove(lv_array_t *array, uint32_t index)

Name	Type	Description
`array`	`lv_array_t *`	pointer to an `lv_array_t` variable
`index`	`uint32_t`	the index of the element to remove

Returns: lv_result_t — LV_RESULT_OK: success, otherwise: error

misc/lv_array.h:164function

lv_array_remove_unordered

Remove the element at the specified position in the array.

This function does not guarantee the array order. Complexity is O(1)

lv_result_t lv_array_remove_unordered(lv_array_t *array, uint32_t index)

Name	Type	Description
`array`	`lv_array_t *`	pointer to an `lv_array_t` variable
`index`	`uint32_t`	the index of the element to remove

Returns: lv_result_t — LV_RESULT_OK: success, otherwise: error

misc/lv_array.h:175function

lv_array_erase

Remove from the array either a single element or a range of elements ([start, end)).

lv_result_t lv_array_erase(lv_array_t *array, uint32_t start, uint32_t end)

Name	Type	Description
`array`	`lv_array_t *`	pointer to an `lv_array_t` variable
`start`	`uint32_t`	the index of the first element to be removed
`end`	`uint32_t`	the index of the first element that is not to be removed

Returns: lv_result_t — LV_RESULT_OK: success, otherwise: error

This effectively reduces the container size by the number of elements removed.

When start equals to end, the function has no effect.

misc/lv_array.h:184function

lv_array_concat

Concatenate two arrays. Adds new elements to the end of the array.

lv_result_t lv_array_concat(lv_array_t *array, const lv_array_t *other)

Name	Type	Description
`array`	`lv_array_t *`	pointer to an `lv_array_t` variable
`other`	`const lv_array_t *`	pointer to the array to concatenate

Returns: lv_result_t — LV_RESULT_OK: success, otherwise: error

The destination array is automatically expanded as necessary.

misc/lv_array.h:194function

lv_array_push_back

Push back element. Adds a new element to the end of the array. If the array capacity is not enough for the new element, the array will be resized automatically.

lv_result_t lv_array_push_back(lv_array_t *array, const void *element)

Name	Type	Description
`array`	`lv_array_t *`	pointer to an `lv_array_t` variable
`element`	`const void *`	pointer to the element to add. NULL to push an empty element.

Returns: lv_result_t — LV_RESULT_OK: success, otherwise: error

If the element is NULL, it will be added as an empty element.

misc/lv_array.h:203function

lv_array_assign

Assigns one content to the array, replacing its current content.

lv_result_t lv_array_assign(lv_array_t *array, uint32_t index, const void *value)

Name	Type	Description
`array`	`lv_array_t *`	pointer to an `lv_array_t` variable
`index`	`uint32_t`	the index of the element to replace
`value`	`const void *`	pointer to the elements to add

Returns: lv_result_t — true: success; false: error

misc/lv_array.h:211function

lv_array_at

Returns a pointer to the element at position n in the array.

void * lv_array_at(const lv_array_t *array, uint32_t index)

Name	Type	Description
`array`	`const lv_array_t *`	pointer to an `lv_array_t` variable
`index`	`uint32_t`	the index of the element to return

Returns: void * — a pointer to the requested element, NULL if index is out of range

misc/lv_array.h:218function

lv_array_front

Returns a pointer to the first element in the array.

static void * lv_array_front(const lv_array_t *array)

Name	Type	Description
`array`	`const lv_array_t *`	pointer to an `lv_array_t` variable

Returns: void * — a pointer to the first element in the array

misc/lv_array.h:227function

lv_array_back

Returns a pointer to the last element in the array.

static void * lv_array_back(const lv_array_t *array)

Name	Type	Description
`array`	`const lv_array_t *`	pointer to an `lv_array_t` variable

Structs

struct

_lv_array_t

Description of a array

Member	Type	Description
`data`	`uint8_t *`
`size`	`uint32_t`
`capacity`	`uint32_t`
`element_size`	`uint32_t`
`inner_alloc`	`bool`

Macros

misc/lv_array.h:23macro

LV_ARRAY_DEFAULT_CAPACITY

#define LV_ARRAY_DEFAULT_CAPACITY 4

misc/lv_array.h:27macro

LV_ARRAY_DEFAULT_SHRINK_RATIO

#define LV_ARRAY_DEFAULT_SHRINK_RATIO 2

Dependencies

lv_types.h

Indirect dependencies

lv_array.h

On this page