Ruby
3.4.0dev (2024-11-05 revision e440268d51fe02b303e3817a7a733a0dac1c5091)
|
An abstract linked list. More...
#include "prism/defines.h"
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdlib.h>
Go to the source code of this file.
Data Structures | |
struct | pm_list_node |
This struct represents an abstract linked list that provides common functionality. More... | |
struct | pm_list_t |
This represents the overall linked list. More... | |
Typedefs | |
typedef struct pm_list_node | pm_list_node_t |
This struct represents an abstract linked list that provides common functionality. More... | |
Functions | |
PRISM_EXPORTED_FUNCTION bool | pm_list_empty_p (pm_list_t *list) |
Returns true if the given list is empty. More... | |
PRISM_EXPORTED_FUNCTION size_t | pm_list_size (pm_list_t *list) |
Returns the size of the list. More... | |
void | pm_list_append (pm_list_t *list, pm_list_node_t *node) |
Append a node to the given list. More... | |
PRISM_EXPORTED_FUNCTION void | pm_list_free (pm_list_t *list) |
Deallocate the internal state of the given list. More... | |
An abstract linked list.
Definition in file pm_list.h.
typedef struct pm_list_node pm_list_node_t |
This struct represents an abstract linked list that provides common functionality.
It is meant to be used any time a linked list is necessary to store data.
The linked list itself operates off a set of pointers. Because the pointers are not necessarily sequential, they can be of any size. We use this fact to allow the consumer of this linked list to extend the node struct to include any data they want. This is done by using the pm_list_node_t as the first member of the struct.
For example, if we want to store a list of integers, we can do the following:
The pm_list_t struct is used to represent the overall linked list. It contains a pointer to the head and tail of the list. This allows for easy iteration and appending of new nodes.
void pm_list_append | ( | pm_list_t * | list, |
pm_list_node_t * | node | ||
) |
Append a node to the given list.
list | The list to append to. |
node | The node to append. |
Definition at line 23 of file pm_list.c.
Referenced by pm_diagnostic_list_append(), and pm_diagnostic_list_append_format().
PRISM_EXPORTED_FUNCTION bool pm_list_empty_p | ( | pm_list_t * | list | ) |
PRISM_EXPORTED_FUNCTION void pm_list_free | ( | pm_list_t * | list | ) |
PRISM_EXPORTED_FUNCTION size_t pm_list_size | ( | pm_list_t * | list | ) |
Returns the size of the list.
list | The list to check. |
Definition at line 15 of file pm_list.c.
Referenced by pm_serialize_comment_list().