Prism Ruby parser
Loading...
Searching...
No Matches
options.h
Go to the documentation of this file.
1
6#ifndef PRISM_OPTIONS_H
7#define PRISM_OPTIONS_H
8
9#include "prism/defines.h"
10#include "prism/util/pm_char.h"
12
13#include <stdbool.h>
14#include <stddef.h>
15#include <stdint.h>
16
20#define PM_OPTIONS_FROZEN_STRING_LITERAL_DISABLED ((int8_t) -1)
21
26#define PM_OPTIONS_FROZEN_STRING_LITERAL_UNSET ((int8_t) 0)
27
31#define PM_OPTIONS_FROZEN_STRING_LITERAL_ENABLED ((int8_t) 1)
32
43
44// Forward declaration needed by the callback typedef.
45struct pm_options;
46
59typedef void (*pm_options_shebang_callback_t)(struct pm_options *options, const uint8_t *source, size_t length, void *shebang_callback_data);
60
76
164
169static const uint8_t PM_OPTIONS_COMMAND_LINE_A = 0x1;
170
176static const uint8_t PM_OPTIONS_COMMAND_LINE_E = 0x2;
177
182static const uint8_t PM_OPTIONS_COMMAND_LINE_L = 0x4;
183
188static const uint8_t PM_OPTIONS_COMMAND_LINE_N = 0x8;
189
194static const uint8_t PM_OPTIONS_COMMAND_LINE_P = 0x10;
195
200static const uint8_t PM_OPTIONS_COMMAND_LINE_X = 0x20;
201
210PRISM_EXPORTED_FUNCTION void pm_options_shebang_callback_set(pm_options_t *options, pm_options_shebang_callback_t shebang_callback, void *shebang_callback_data);
211
218PRISM_EXPORTED_FUNCTION void pm_options_filepath_set(pm_options_t *options, const char *filepath);
219
226PRISM_EXPORTED_FUNCTION void pm_options_line_set(pm_options_t *options, int32_t line);
227
234PRISM_EXPORTED_FUNCTION void pm_options_encoding_set(pm_options_t *options, const char *encoding);
235
242PRISM_EXPORTED_FUNCTION void pm_options_encoding_locked_set(pm_options_t *options, bool encoding_locked);
243
250PRISM_EXPORTED_FUNCTION void pm_options_frozen_string_literal_set(pm_options_t *options, bool frozen_string_literal);
251
258PRISM_EXPORTED_FUNCTION void pm_options_command_line_set(pm_options_t *options, uint8_t command_line);
259
270PRISM_EXPORTED_FUNCTION bool pm_options_version_set(pm_options_t *options, const char *version, size_t length);
271
279
286PRISM_EXPORTED_FUNCTION void pm_options_partial_script_set(pm_options_t *options, bool partial_script);
287
295PRISM_EXPORTED_FUNCTION bool pm_options_scopes_init(pm_options_t *options, size_t scopes_count);
296
305
315
324
331
397void pm_options_read(pm_options_t *options, const char *data);
398
399#endif
Macro definitions used throughout the prism library.
#define PRISM_EXPORTED_FUNCTION
By default, we compile with -fvisibility=hidden.
Definition defines.h:50
PRISM_EXPORTED_FUNCTION void pm_options_shebang_callback_set(pm_options_t *options, pm_options_shebang_callback_t shebang_callback, void *shebang_callback_data)
Set the shebang callback option on the given options struct.
Definition options.c:7
PRISM_EXPORTED_FUNCTION void pm_options_encoding_set(pm_options_t *options, const char *encoding)
Set the encoding option on the given options struct.
Definition options.c:24
PRISM_EXPORTED_FUNCTION void pm_options_free(pm_options_t *options)
Free the internal memory associated with the options.
Definition options.c:191
struct pm_options_scope pm_options_scope_t
A scope of locals surrounding the code that is being parsed.
PRISM_EXPORTED_FUNCTION void pm_options_partial_script_set(pm_options_t *options, bool partial_script)
Set the partial script option on the given options struct.
Definition options.c:138
struct pm_options pm_options_t
The options that can be passed to the parser.
PRISM_EXPORTED_FUNCTION void pm_options_main_script_set(pm_options_t *options, bool main_script)
Set the main script option on the given options struct.
Definition options.c:130
PRISM_EXPORTED_FUNCTION const pm_string_t * pm_options_scope_local_get(const pm_options_scope_t *scope, size_t index)
Return a pointer to the local at the given index within the given scope.
Definition options.c:183
void(* pm_options_shebang_callback_t)(struct pm_options *options, const uint8_t *source, size_t length, void *shebang_callback_data)
The callback called when additional switches are found in a shebang comment that need to be processed...
Definition options.h:59
void pm_options_read(pm_options_t *options, const char *data)
Deserialize an options struct from the given binary string.
Definition options.c:248
PRISM_EXPORTED_FUNCTION bool pm_options_version_set(pm_options_t *options, const char *version, size_t length)
Set the version option on the given options struct by parsing the given string.
Definition options.c:74
PRISM_EXPORTED_FUNCTION bool pm_options_scope_init(pm_options_scope_t *scope, size_t locals_count)
Create a new options scope struct.
Definition options.c:173
PRISM_EXPORTED_FUNCTION void pm_options_line_set(pm_options_t *options, int32_t line)
Set the line option on the given options struct.
Definition options.c:40
PRISM_EXPORTED_FUNCTION const pm_options_scope_t * pm_options_scope_get(const pm_options_t *options, size_t index)
Return a pointer to the scope at the given index within the given options.
Definition options.c:164
PRISM_EXPORTED_FUNCTION void pm_options_encoding_locked_set(pm_options_t *options, bool encoding_locked)
Set the encoding_locked option on the given options struct.
Definition options.c:32
PRISM_EXPORTED_FUNCTION void pm_options_frozen_string_literal_set(pm_options_t *options, bool frozen_string_literal)
Set the frozen string literal option on the given options struct.
Definition options.c:48
PRISM_EXPORTED_FUNCTION void pm_options_command_line_set(pm_options_t *options, uint8_t command_line)
Sets the command line option on the given options struct.
Definition options.c:56
PRISM_EXPORTED_FUNCTION void pm_options_filepath_set(pm_options_t *options, const char *filepath)
Set the filepath option on the given options struct.
Definition options.c:16
PRISM_EXPORTED_FUNCTION bool pm_options_scopes_init(pm_options_t *options, size_t scopes_count)
Allocate and zero out the scopes array on the given options struct.
Definition options.c:154
pm_options_version_t
The version of Ruby syntax that we should be parsing with.
Definition options.h:66
@ PM_OPTIONS_VERSION_CRUBY_3_3
The vendored version of prism in CRuby 3.3.x.
Definition options.h:71
@ PM_OPTIONS_VERSION_LATEST
The current version of prism.
Definition options.h:68
@ PM_OPTIONS_VERSION_CRUBY_3_4
The vendored version of prism in CRuby 3.4.x.
Definition options.h:74
Functions for working with characters and strings.
A generic string type that can have various ownership semantics.
A scope of locals surrounding the code that is being parsed.
Definition options.h:36
size_t locals_count
The number of locals in the scope.
Definition options.h:38
pm_string_t * locals
The names of the locals in the scope.
Definition options.h:41
The options that can be passed to the parser.
Definition options.h:80
uint8_t command_line
A bitset of the various options that were set on the command line.
Definition options.h:129
void * shebang_callback_data
Any additional data that should be passed along to the shebang callback if one was set.
Definition options.h:91
bool encoding_locked
Whether or not the encoding magic comments should be respected.
Definition options.h:145
pm_options_scope_t * scopes
The scopes surrounding the code that is being parsed.
Definition options.h:119
bool main_script
When the file being parsed is the main script, the shebang will be considered for command-line flags ...
Definition options.h:152
pm_string_t encoding
The name of the encoding that the source file is in.
Definition options.h:106
int32_t line
The line within the file that the parse starts on.
Definition options.h:100
pm_options_shebang_callback_t shebang_callback
The callback to call when additional switches are found in a shebang comment.
Definition options.h:85
int8_t frozen_string_literal
Whether or not the frozen string literal option has been set.
Definition options.h:138
bool partial_script
When the file being parsed is considered a "partial" script, jumps will not be marked as errors if th...
Definition options.h:162
size_t scopes_count
The number of scopes surrounding the code that is being parsed.
Definition options.h:111
pm_string_t filepath
The name of the file that is currently being parsed.
Definition options.h:94
pm_options_version_t version
The version of prism that we should be parsing with.
Definition options.h:126
A generic string type that can have various ownership semantics.
Definition pm_string.h:33