Ruby  3.4.0dev (2024-11-05 revision e440268d51fe02b303e3817a7a733a0dac1c5091)
Data Structures | Typedefs | Functions
pm_list.h File Reference

(e440268d51fe02b303e3817a7a733a0dac1c5091)

An abstract linked list. More...

#include "prism/defines.h"
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdlib.h>
Include dependency graph for pm_list.h:
This graph shows which files directly or indirectly include this file:

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...
 

Detailed Description

An abstract linked list.

Definition in file pm_list.h.

Typedef Documentation

◆ pm_list_node_t

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:

typedef struct {
int value;
} pm_int_node_t;
pm_list_t list = { 0 };
pm_int_node_t *node = xmalloc(sizeof(pm_int_node_t));
node->value = 5;
pm_list_append(&list, &node->node);
#define xmalloc
Old name of ruby_xmalloc.
Definition: xmalloc.h:53
void pm_list_append(pm_list_t *list, pm_list_node_t *node)
Append a node to the given list.
Definition: pm_list.c:23
This struct represents an abstract linked list that provides common functionality.
Definition: pm_list.h:46
This represents the overall linked list.
Definition: pm_list.h:55

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.

Function Documentation

◆ pm_list_append()

void pm_list_append ( pm_list_t list,
pm_list_node_t node 
)

Append a node to the given list.

Parameters
listThe list to append to.
nodeThe node to append.

Definition at line 23 of file pm_list.c.

Referenced by pm_diagnostic_list_append(), and pm_diagnostic_list_append_format().

◆ pm_list_empty_p()

PRISM_EXPORTED_FUNCTION bool pm_list_empty_p ( pm_list_t list)

Returns true if the given list is empty.

Parameters
listThe list to check.
Returns
True if the given list is empty, otherwise false.

Definition at line 7 of file pm_list.c.

◆ pm_list_free()

PRISM_EXPORTED_FUNCTION void pm_list_free ( pm_list_t list)

Deallocate the internal state of the given list.

Parameters
listThe list to free.

Definition at line 38 of file pm_list.c.

◆ pm_list_size()

PRISM_EXPORTED_FUNCTION size_t pm_list_size ( pm_list_t list)

Returns the size of the list.

Parameters
listThe list to check.
Returns
The size of the list.

Definition at line 15 of file pm_list.c.

Referenced by pm_serialize_comment_list().