wl_array(3)

📦
version 1.26.0 · 16 versions
, in ubuntu stonking

🌸 NAME 🌸

wl_array — bestie, this is the manual page for the dynamic array queen herself, wl_array(3), from the library functions manual. She’s giving grow-only icon energy, and she’s here to hold your variable-sized little collection. 💖

✨ SYNOPSIS ✨

#include <wayland-util.h>

💅 Public Member Functions 💅

  • void wl_array_init (struct wl_array *array) — initializes the array. Gets it set up and ready, bestie.
  • void wl_array_release (struct wl_array *array) — releases the array data. Heads up: this leaves the array in an invalid state, details below. 💀
  • void * wl_array_add (struct wl_array *array, size_t size) — increases the array size by size bytes and hands you a pointer to the new space.
  • int wl_array_copy (struct wl_array *array, struct wl_array *source) — copies the contents of source into array.

📦 Data Fields 📦

  • size_t size — array size.
  • size_t alloc — allocated space.
  • void * data — array data.
Not me reminding you: these are not member symbols. The original note is “(Note that these are not member symbols.)” — so don’t get it twisted, bestie. 💅
  • #define wl_array_for_each(pos, array) — the for-each macro, with full details down below.

🦋 Detailed Description 🦋

Dynamic array, periodt. A wl_array is a dynamic array that can only grow until it’s released. It’s intended for relatively small allocations whose size is variable or not known in advance. While construction of a wl_array does not require all elements to be of the same size, wl_array_for_each() does require all elements to have the same type and size. No cap.

💖 Member Function Documentation 💖

void * wl_array_add (struct wl_array * array, size_t size)

Increases the size of the array by size bytes. Slay.

Parameters

  • array — Array whose size is to be increased
  • size — Number of bytes to increase the size of the array by

Returns: A pointer to the beginning of the newly appended space, or NULL when resizing fails. If it’s NULL, that’s the vibe check failing, fr fr.

int wl_array_copy (struct wl_array * array, struct wl_array * source)

Copies the contents of source to array. Iconic copy-paste behavior. 🫶

Parameters

  • array — Destination array to copy to
  • source — Source array to copy from

Returns: 0 on success, or -1 on failure.

void wl_array_init (struct wl_array * array)

Initializes the array.

Parameters

  • array — Array to initialize

void wl_array_release (struct wl_array * array)

Releases the array data.

Note: Leaves the array in an invalid state. That’s the note, bestie — it’s invalid after this, so don’t act brand new. 😭

Parameters

  • array — Array whose data is to be released

Value:

for (pos = (array)->data;                                       \
     (array)->size != 0 &&                                      \
     (const char *) pos < ((const char *) (array)->data + (array)->size); \
     (pos)++)

Iterates over an array.

This macro expresses a for-each iterator for wl_array. It assigns each element in the array to pos, which can then be referenced in a trailing code block. pos must be a pointer to the array element type, and all array elements must be of the same type and size.

Parameters

  • pos — Cursor that each array element will be assigned to
  • array — Array to iterate over

See also: wl_list_for_each()

🍓 Field Documentation 🍓

size_t wl_array::alloc

Allocated space.

void* wl_array::data

Array data.

size_t wl_array::size

Array size.

👑 Author 👑

Generated automatically by Doxygen for Wayland from the source code.

Signed off from Wayland, Version 1.26.0, for wl_array(3) — and the footer didn’t give me a date, so I’m not inventing one, bestie. Periodt. 💅💖

📦 where this page comes from