Ruby 4.1.0dev (2026-04-04 revision 6ab9b22553ac802819aa1643a9ac9575e75d1286)
options.c
1#include "prism/internal/options.h"
2
4
5#include "prism/internal/allocator.h"
6#include "prism/internal/char.h"
7#include "prism/internal/stringy.h"
8
9#include <stdlib.h>
10#include <string.h>
11
17pm_options_new(void) {
18 pm_options_t *options = xcalloc(1, sizeof(pm_options_t));
19 if (options == NULL) abort();
20 return options;
21}
22
26void
27pm_options_cleanup(pm_options_t *options) {
28 pm_string_cleanup(&options->filepath);
29 pm_string_cleanup(&options->encoding);
30
31 for (size_t scope_index = 0; scope_index < options->scopes_count; scope_index++) {
32 pm_options_scope_t *scope = &options->scopes[scope_index];
33
34 for (size_t local_index = 0; local_index < scope->locals_count; local_index++) {
35 pm_string_cleanup(&scope->locals[local_index]);
36 }
37
38 xfree_sized(scope->locals, scope->locals_count * sizeof(pm_string_t));
39 }
40
41 xfree_sized(options->scopes, options->scopes_count * sizeof(pm_options_scope_t));
42}
43
49void
50pm_options_free(pm_options_t *options) {
51 pm_options_cleanup(options);
52 xfree_sized(options, sizeof(pm_options_t));
53}
54
58void
59pm_options_shebang_callback_set(pm_options_t *options, pm_options_shebang_callback_t shebang_callback, void *shebang_callback_data) {
60 options->shebang_callback = shebang_callback;
61 options->shebang_callback_data = shebang_callback_data;
62}
63
67const pm_string_t *
68pm_options_filepath(const pm_options_t *options) {
69 return &options->filepath;
70}
71
75void
76pm_options_filepath_set(pm_options_t *options, const char *filepath) {
77 pm_string_constant_init(&options->filepath, filepath, strlen(filepath));
78}
79
83void
84pm_options_encoding_set(pm_options_t *options, const char *encoding) {
85 pm_string_constant_init(&options->encoding, encoding, strlen(encoding));
86}
87
91void
92pm_options_encoding_locked_set(pm_options_t *options, bool encoding_locked) {
93 options->encoding_locked = encoding_locked;
94}
95
99void
100pm_options_line_set(pm_options_t *options, int32_t line) {
101 options->line = line;
102}
103
107void
108pm_options_frozen_string_literal_set(pm_options_t *options, bool frozen_string_literal) {
109 options->frozen_string_literal = frozen_string_literal ? PM_OPTIONS_FROZEN_STRING_LITERAL_ENABLED : PM_OPTIONS_FROZEN_STRING_LITERAL_DISABLED;
110}
111
115void
116pm_options_command_line_set(pm_options_t *options, uint8_t command_line) {
117 options->command_line = command_line;
118}
119
123static PRISM_INLINE bool
124is_number(const char *string, size_t length) {
125 return pm_strspn_decimal_digit((const uint8_t *) string, (ptrdiff_t) length) == length;
126}
127
133bool
134pm_options_version_set(pm_options_t *options, const char *version, size_t length) {
135 if (version == NULL) {
136 options->version = PM_OPTIONS_VERSION_LATEST;
137 return true;
138 }
139
140 if (length == 3) {
141 if (strncmp(version, "3.3", 3) == 0) {
142 options->version = PM_OPTIONS_VERSION_CRUBY_3_3;
143 return true;
144 }
145
146 if (strncmp(version, "3.4", 3) == 0) {
147 options->version = PM_OPTIONS_VERSION_CRUBY_3_4;
148 return true;
149 }
150
151 if (strncmp(version, "3.5", 3) == 0 || strncmp(version, "4.0", 3) == 0) {
152 options->version = PM_OPTIONS_VERSION_CRUBY_4_0;
153 return true;
154 }
155
156 if (strncmp(version, "4.1", 3) == 0) {
157 options->version = PM_OPTIONS_VERSION_CRUBY_4_1;
158 return true;
159 }
160
161 return false;
162 }
163
164 if (length >= 4 && is_number(version + 4, length - 4)) {
165 if (strncmp(version, "3.3.", 4) == 0) {
166 options->version = PM_OPTIONS_VERSION_CRUBY_3_3;
167 return true;
168 }
169
170 if (strncmp(version, "3.4.", 4) == 0) {
171 options->version = PM_OPTIONS_VERSION_CRUBY_3_4;
172 return true;
173 }
174
175 if (strncmp(version, "3.5.", 4) == 0 || strncmp(version, "4.0.", 4) == 0) {
176 options->version = PM_OPTIONS_VERSION_CRUBY_4_0;
177 return true;
178 }
179
180 if (strncmp(version, "4.1.", 4) == 0) {
181 options->version = PM_OPTIONS_VERSION_CRUBY_4_1;
182 return true;
183 }
184 }
185
186 if (length == 6) {
187 if (strncmp(version, "latest", 6) == 0) {
188 options->version = PM_OPTIONS_VERSION_LATEST;
189 return true;
190 }
191 }
192
193 return false;
194}
195
200void
201pm_options_version_set_lowest(pm_options_t *options) {
202 options->version = PM_OPTIONS_VERSION_CRUBY_3_3;
203}
204
209void
210pm_options_version_set_highest(pm_options_t *options) {
211 options->version = PM_OPTIONS_VERSION_LATEST;
212}
213
217void
218pm_options_main_script_set(pm_options_t *options, bool main_script) {
219 options->main_script = main_script;
220}
221
225void
226pm_options_partial_script_set(pm_options_t *options, bool partial_script) {
227 options->partial_script = partial_script;
228}
229
233bool
234pm_options_freeze(const pm_options_t *options) {
235 return options->freeze;
236}
237
241void
242pm_options_freeze_set(pm_options_t *options, bool freeze) {
243 options->freeze = freeze;
244}
245
246// For some reason, GCC analyzer thinks we're leaking allocated scopes and
247// locals here, even though we definitely aren't. This is a false positive.
248// Ideally we wouldn't need to suppress this.
249#if defined(__GNUC__) && (__GNUC__ >= 10)
250#pragma GCC diagnostic push
251#pragma GCC diagnostic ignored "-Wanalyzer-malloc-leak"
252#endif
253
257bool
258pm_options_scopes_init(pm_options_t *options, size_t scopes_count) {
259 options->scopes_count = scopes_count;
260 options->scopes = xcalloc(scopes_count, sizeof(pm_options_scope_t));
261 return options->scopes != NULL;
262}
263
268const pm_options_scope_t *
269pm_options_scope(const pm_options_t *options, size_t index) {
270 return &options->scopes[index];
271}
272
278pm_options_scope_mut(pm_options_t *options, size_t index) {
279 return &options->scopes[index];
280}
281
286void
287pm_options_scope_init(pm_options_scope_t *scope, size_t locals_count) {
288 scope->locals_count = locals_count;
289 scope->locals = xcalloc(locals_count, sizeof(pm_string_t));
290 scope->forwarding = PM_OPTIONS_SCOPE_FORWARDING_NONE;
291 if (scope->locals == NULL) abort();
292}
293
298const pm_string_t *
299pm_options_scope_local(const pm_options_scope_t *scope, size_t index) {
300 return &scope->locals[index];
301}
302
308pm_options_scope_local_mut(pm_options_scope_t *scope, size_t index) {
309 return &scope->locals[index];
310}
311
315void
316pm_options_scope_forwarding_set(pm_options_scope_t *scope, uint8_t forwarding) {
317 scope->forwarding = forwarding;
318}
319
325static uint32_t
326pm_options_read_u32(const char *data) {
327 if (((uintptr_t) data) % sizeof(uint32_t) == 0) {
328 return *((uint32_t *) data);
329 } else {
330 uint32_t value;
331 memcpy(&value, data, sizeof(uint32_t));
332 return value;
333 }
334}
335
341static int32_t
342pm_options_read_s32(const char *data) {
343 if (((uintptr_t) data) % sizeof(int32_t) == 0) {
344 return *((int32_t *) data);
345 } else {
346 int32_t value;
347 memcpy(&value, data, sizeof(int32_t));
348 return value;
349 }
350}
351
359void
360pm_options_read(pm_options_t *options, const char *data) {
361 options->line = 1; // default
362 if (data == NULL) return;
363
364 uint32_t filepath_length = pm_options_read_u32(data);
365 data += 4;
366
367 if (filepath_length > 0) {
368 pm_string_constant_init(&options->filepath, data, filepath_length);
369 data += filepath_length;
370 }
371
372 options->line = pm_options_read_s32(data);
373 data += 4;
374
375 uint32_t encoding_length = pm_options_read_u32(data);
376 data += 4;
377
378 if (encoding_length > 0) {
379 pm_string_constant_init(&options->encoding, data, encoding_length);
380 data += encoding_length;
381 }
382
383 options->frozen_string_literal = (int8_t) *data++;
384 options->command_line = (uint8_t) *data++;
385 options->version = (pm_options_version_t) *data++;
386 options->encoding_locked = ((uint8_t) *data++) > 0;
387 options->main_script = ((uint8_t) *data++) > 0;
388 options->partial_script = ((uint8_t) *data++) > 0;
389 options->freeze = ((uint8_t) *data++) > 0;
390
391 uint32_t scopes_count = pm_options_read_u32(data);
392 data += 4;
393
394 if (scopes_count > 0) {
395 if (!pm_options_scopes_init(options, scopes_count)) return;
396
397 for (size_t scope_index = 0; scope_index < scopes_count; scope_index++) {
398 uint32_t locals_count = pm_options_read_u32(data);
399 data += 4;
400
401 pm_options_scope_t *scope = &options->scopes[scope_index];
402 pm_options_scope_init(scope, locals_count);
403
404 uint8_t forwarding = (uint8_t) *data++;
405 pm_options_scope_forwarding_set(&options->scopes[scope_index], forwarding);
406
407 for (size_t local_index = 0; local_index < locals_count; local_index++) {
408 uint32_t local_length = pm_options_read_u32(data);
409 data += 4;
410
411 pm_string_constant_init(&scope->locals[local_index], data, local_length);
412 data += local_length;
413 }
414 }
415 }
416}
417
418#if defined(__GNUC__) && (__GNUC__ >= 10)
419#pragma GCC diagnostic pop
420#endif
#define xcalloc
Old name of ruby_xcalloc.
Definition xmalloc.h:55
#define PRISM_INLINE
Old Visual Studio versions do not support the inline keyword, so we need to define it to be __inline.
Definition inline.h:12
static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_NONE
The default value for parameters.
Definition options.h:45
#define PM_OPTIONS_FROZEN_STRING_LITERAL_DISABLED
String literals should not be frozen.
Definition options.h:31
#define PM_OPTIONS_FROZEN_STRING_LITERAL_ENABLED
String literals should be made frozen.
Definition options.h:42
void(* pm_options_shebang_callback_t)(pm_options_t *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:71
A generic string type that can have various ownership semantics.
Definition stringy.h:18