_ModuleDescriptorList

Module: AudioWeaver Core / Module Descriptor List

Linked list containing module descriptor entries. More...

#include <Include/ModuleDescriptorList.h>

Public Functions

	Name
bool	awe_moduleDescriptorList_prepend(ModuleDescriptorList * list, ModuleDescriptorListEntry * entry) Insert an entry at the beginning of the list.
bool	awe_moduleDescriptorList_append(ModuleDescriptorList * list, ModuleDescriptorListEntry * entry) Insert an entry at the end of the list.
ModuleDescriptorListEntry *	awe_moduleDescriptorList_removeHead(ModuleDescriptorList * list) Remove the first entry of the module descriptor list.

Public Attributes

	Name
size_t	length Number of entries in the list.
ModuleDescriptorListEntry *	head Pointer to the first entry in the list.
ModuleDescriptorListEntry *	last Pointer to the last entry in the list.

Detailed Description

struct _ModuleDescriptorList;

Linked list containing module descriptor entries.

Should be initialized to zeros and manipulated with mutator functions.

Public Functions Documentation

function awe_moduleDescriptorList_prepend

bool awe_moduleDescriptorList_prepend(
    ModuleDescriptorList * list,
    ModuleDescriptorListEntry * entry
)

Insert an entry at the beginning of the list.

Parameters:

• list ModuleDescriptorList to mutate.
• entry Entry to prepend. Note that the list does not take ownership of the entry. If it was dynamically allocated, the caller is responsible for freeing it.

Return: True if the operation was successful, false otherwise.

function awe_moduleDescriptorList_append

bool awe_moduleDescriptorList_append(
    ModuleDescriptorList * list,
    ModuleDescriptorListEntry * entry
)

Insert an entry at the end of the list.

Parameters:

• list ModuleDescriptorList to mutate.
• entry Entry to append. Note that the list does not take ownership of the entry. If it was dynamically allocated, the caller is responsible for freeing it.

Return: True if the operation was successful, false otherwise.

function awe_moduleDescriptorList_removeHead

ModuleDescriptorListEntry * awe_moduleDescriptorList_removeHead(
    ModuleDescriptorList * list
)

Remove the first entry of the module descriptor list.

Parameters:

• list ModuleDescriptorList to mutate.

Return: The entry which was removed, or NULL if the list is empty/invalid. If the entry was dynamically allocated, then it is now safe to free it.

Public Attributes Documentation

variable length

size_t length;

Number of entries in the list.

variable head

ModuleDescriptorListEntry * head;

Pointer to the first entry in the list.

variable last

ModuleDescriptorListEntry * last;

Pointer to the last entry in the list.

---

Updated on 2026-02-10 at 15:44:29 -0500