Ruby  3.4.0dev (2024-11-05 revision 348a53415339076afc4a02fcd09f3ae36e9c4c61)
pm_buffer.h
Go to the documentation of this file.
1 
6 #ifndef PRISM_BUFFER_H
7 #define PRISM_BUFFER_H
8 
9 #include "prism/defines.h"
10 #include "prism/util/pm_char.h"
11 
12 #include <assert.h>
13 #include <stdbool.h>
14 #include <stdint.h>
15 #include <stdlib.h>
16 #include <string.h>
17 
22 typedef struct {
24  size_t length;
25 
27  size_t capacity;
28 
30  char *value;
31 } pm_buffer_t;
32 
39 
47 bool pm_buffer_init_capacity(pm_buffer_t *buffer, size_t capacity);
48 
56 
64 
72 
79 void pm_buffer_append_zeroes(pm_buffer_t *buffer, size_t length);
80 
88 void pm_buffer_append_format(pm_buffer_t *buffer, const char *format, ...) PRISM_ATTRIBUTE_FORMAT(2, 3);
89 
97 void pm_buffer_append_string(pm_buffer_t *buffer, const char *value, size_t length);
98 
106 void pm_buffer_append_bytes(pm_buffer_t *buffer, const uint8_t *value, size_t length);
107 
114 void pm_buffer_append_byte(pm_buffer_t *buffer, uint8_t value);
115 
122 void pm_buffer_append_varuint(pm_buffer_t *buffer, uint32_t value);
123 
130 void pm_buffer_append_varsint(pm_buffer_t *buffer, int32_t value);
131 
138 void pm_buffer_append_double(pm_buffer_t *buffer, double value);
139 
144 typedef enum {
145  PM_BUFFER_ESCAPING_RUBY,
146  PM_BUFFER_ESCAPING_JSON
148 
157 void pm_buffer_append_source(pm_buffer_t *buffer, const uint8_t *source, size_t length, pm_buffer_escaping_t escaping);
158 
166 void pm_buffer_prepend_string(pm_buffer_t *buffer, const char *value, size_t length);
167 
174 void pm_buffer_concat(pm_buffer_t *destination, const pm_buffer_t *source);
175 
182 void pm_buffer_clear(pm_buffer_t *buffer);
183 
189 void pm_buffer_rstrip(pm_buffer_t *buffer);
190 
199 size_t pm_buffer_index(const pm_buffer_t *buffer, char value);
200 
209 void pm_buffer_insert(pm_buffer_t *buffer, size_t index, const char *value, size_t length);
210 
217 
218 #endif
bool pm_buffer_init_capacity(pm_buffer_t *buffer, size_t capacity)
Initialize a pm_buffer_t with the given capacity.
Definition: pm_buffer.c:15
PRISM_EXPORTED_FUNCTION size_t pm_buffer_sizeof(void)
Return the size of the pm_buffer_t struct.
Definition: pm_buffer.c:7
size_t pm_buffer_index(const pm_buffer_t *buffer, char value)
Checks if the buffer includes the given value.
Definition: pm_buffer.c:290
void pm_buffer_append_format(pm_buffer_t *buffer, const char *format,...) PRISM_ATTRIBUTE_FORMAT(2
Append a formatted string to the buffer.
void void pm_buffer_append_string(pm_buffer_t *buffer, const char *value, size_t length)
Append a string to the buffer.
Definition: pm_buffer.c:119
PRISM_EXPORTED_FUNCTION size_t pm_buffer_length(const pm_buffer_t *buffer)
Return the length of the buffer.
Definition: pm_buffer.c:43
pm_buffer_escaping_t
The different types of escaping that can be performed by the buffer when appending a slice of Ruby so...
Definition: pm_buffer.h:144
void pm_buffer_append_zeroes(pm_buffer_t *buffer, size_t length)
Append the given amount of space as zeroes to the buffer.
Definition: pm_buffer.c:86
void pm_buffer_append_source(pm_buffer_t *buffer, const uint8_t *source, size_t length, pm_buffer_escaping_t escaping)
Append a slice of source code to the buffer.
Definition: pm_buffer.c:179
void pm_buffer_append_varuint(pm_buffer_t *buffer, uint32_t value)
Append a 32-bit unsigned integer to the buffer as a variable-length integer.
Definition: pm_buffer.c:144
void pm_buffer_append_byte(pm_buffer_t *buffer, uint8_t value)
Append a single byte to the buffer.
Definition: pm_buffer.c:135
PRISM_EXPORTED_FUNCTION bool pm_buffer_init(pm_buffer_t *buffer)
Initialize a pm_buffer_t with its default values.
Definition: pm_buffer.c:27
void pm_buffer_append_varsint(pm_buffer_t *buffer, int32_t value)
Append a 32-bit signed integer to the buffer as a variable-length integer.
Definition: pm_buffer.c:161
void pm_buffer_prepend_string(pm_buffer_t *buffer, const char *value, size_t length)
Prepend the given string to the buffer.
Definition: pm_buffer.c:249
void pm_buffer_rstrip(pm_buffer_t *buffer)
Strip the whitespace from the end of the buffer.
Definition: pm_buffer.c:280
void pm_buffer_insert(pm_buffer_t *buffer, size_t index, const char *value, size_t length)
Insert the given string into the buffer at the given index.
Definition: pm_buffer.c:299
PRISM_EXPORTED_FUNCTION char * pm_buffer_value(const pm_buffer_t *buffer)
Return the value of the buffer.
Definition: pm_buffer.c:35
PRISM_EXPORTED_FUNCTION void pm_buffer_free(pm_buffer_t *buffer)
Free the memory associated with the buffer.
Definition: pm_buffer.c:315
void pm_buffer_append_bytes(pm_buffer_t *buffer, const uint8_t *value, size_t length)
Append a list of bytes to the buffer.
Definition: pm_buffer.c:127
void pm_buffer_append_double(pm_buffer_t *buffer, double value)
Append a double to the buffer.
Definition: pm_buffer.c:170
void pm_buffer_concat(pm_buffer_t *destination, const pm_buffer_t *source)
Concatenate one buffer onto another.
Definition: pm_buffer.c:261
void pm_buffer_clear(pm_buffer_t *buffer)
Clear the buffer by reducing its size to 0.
Definition: pm_buffer.c:272
Functions for working with characters and strings.
Macro definitions used throughout the prism library.
#define PRISM_ATTRIBUTE_FORMAT(string_index, argument_index)
Certain compilers support specifying that a function accepts variadic parameters that look like print...
Definition: defines.h:64
#define PRISM_EXPORTED_FUNCTION
By default, we compile with -fvisibility=hidden.
Definition: defines.h:50
C99 shim for <stdbool.h>
A pm_buffer_t is a simple memory buffer that stores data in a contiguous block of memory.
Definition: pm_buffer.h:22
size_t capacity
The capacity of the buffer in bytes that has been allocated.
Definition: pm_buffer.h:27
size_t length
The length of the buffer in bytes.
Definition: pm_buffer.h:24
char * value
A pointer to the start of the buffer.
Definition: pm_buffer.h:30