Prism Ruby parser
Loading...
Searching...
No Matches
constant_pool.h File Reference

A data structure that stores a set of strings. More...

#include "prism/compiler/exported.h"
#include "prism/compiler/inline.h"
#include "prism/compiler/nodiscard.h"
#include "prism/compiler/nonnull.h"
#include "prism/arena.h"
#include <stddef.h>
#include <stdint.h>
Include dependency graph for constant_pool.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  pm_constant_id_list_t
 A list of constant IDs. More...

Typedefs

typedef uint32_t pm_constant_id_t
 A constant id is a unique identifier for a constant in the constant pool.
typedef struct pm_constant_t pm_constant_t
 A constant in the pool which effectively stores a string.
typedef struct pm_constant_pool_t pm_constant_pool_t
 The overall constant pool, which stores constants found while parsing.

Functions

PRISM_EXPORTED_FUNCTION const uint8_t * pm_constant_start (const pm_constant_t *constant) PRISM_NONNULL(1)
 Return a raw pointer to the start of a constant.
PRISM_EXPORTED_FUNCTION size_t pm_constant_length (const pm_constant_t *constant) PRISM_NONNULL(1)
 Return the length of a constant.
PRISM_EXPORTED_FUNCTION void pm_constant_id_list_init (pm_arena_t *arena, pm_constant_id_list_t *list, uint32_t size) PRISM_NONNULL(1
 Initialize a list of constant ids.
PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void pm_constant_id_list_append (pm_arena_t *arena, pm_constant_id_list_t *list, pm_constant_id_t id) PRISM_NONNULL(1
 Append a constant id to a list of constant ids.

Detailed Description

A data structure that stores a set of strings.

Each string is assigned a unique id, which can be used to compare strings for equality. This comparison ends up being much faster than strcmp, since it only requires a single integer comparison.

Function Documentation

◆ pm_constant_start()

PRISM_EXPORTED_FUNCTION const uint8_t * pm_constant_start ( const pm_constant_t * constant)

Return a raw pointer to the start of a constant.

Parameters
constantThe constant to get the start of.
Returns
A raw pointer to the start of the constant.

◆ pm_constant_length()

PRISM_EXPORTED_FUNCTION size_t pm_constant_length ( const pm_constant_t * constant)

Return the length of a constant.

Parameters
constantThe constant to get the length of.
Returns
The length of the constant.

◆ pm_constant_id_list_init()

PRISM_EXPORTED_FUNCTION void pm_constant_id_list_init ( pm_arena_t * arena,
pm_constant_id_list_t * list,
uint32_t size )

Initialize a list of constant ids.

Parameters
arenaThe arena to use for allocations.
listThe list to initialize.
sizeThe size of the list.

◆ pm_constant_id_list_append()

PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void pm_constant_id_list_append ( pm_arena_t * arena,
pm_constant_id_list_t * list,
pm_constant_id_t id )

Append a constant id to a list of constant ids.

A list's storage is always exactly its size, so it is regrown to exactly one more id by allocating from the given arena, which must live as long as the list does. For a list in a parsed tree, that is the arena that was passed to pm_parser_new.

Parameters
arenaThe arena to use for allocations.
listThe list to append to.
idThe constant id to append.