14#include "ruby/internal/config.h"
22# include <sys/cygwin.h>
25#if defined(LOAD_RELATIVE) && defined(HAVE_DLADDR)
33#if defined(HAVE_FCNTL_H)
35#elif defined(HAVE_SYS_FCNTL_H)
36# include <sys/fcntl.h>
39#ifdef HAVE_SYS_PARAM_H
40# include <sys/param.h>
44#include "eval_intern.h"
46#include "internal/cmdlineopt.h"
47#include "internal/cont.h"
48#include "internal/error.h"
49#include "internal/file.h"
50#include "internal/inits.h"
51#include "internal/io.h"
52#include "internal/load.h"
53#include "internal/loadpath.h"
54#include "internal/missing.h"
55#include "internal/object.h"
56#include "internal/thread.h"
57#include "internal/ruby_parser.h"
58#include "internal/variable.h"
65#define singlebit_only_p(x) !((x) & ((x)-1))
66STATIC_ASSERT(Qnil_1bit_from_Qfalse, singlebit_only_p(
Qnil^
Qfalse));
67STATIC_ASSERT(Qundef_1bit_from_Qnil, singlebit_only_p(
Qundef^
Qnil));
70# define MAXPATHLEN 1024
73# define O_ACCMODE (O_RDONLY | O_WRONLY | O_RDWR)
82#ifndef DISABLE_RUBYGEMS
83# define DISABLE_RUBYGEMS 0
86#define DEFAULT_RUBYGEMS_ENABLED "disabled"
88#define DEFAULT_RUBYGEMS_ENABLED "enabled"
91void rb_warning_category_update(
unsigned int mask,
unsigned int bits);
94#define FEATURE_BIT(bit) (1U << feature_##bit)
95#define EACH_FEATURES(X, SEP) \
106 X(frozen_string_literal) \
112#define EACH_DEBUG_FEATURES(X, SEP) \
113 X(frozen_string_literal) \
115#define AMBIGUOUS_FEATURE_NAMES 0
116#define DEFINE_FEATURE(bit) feature_##bit
117#define DEFINE_DEBUG_FEATURE(bit) feature_debug_##bit
118enum feature_flag_bits {
119 EACH_FEATURES(DEFINE_FEATURE, COMMA),
120 DEFINE_FEATURE(frozen_string_literal_set),
121 feature_debug_flag_first,
122 DEFINE_FEATURE(jit) = feature_yjit,
123 feature_jit_mask = FEATURE_BIT(yjit) | FEATURE_BIT(zjit),
125 feature_debug_flag_begin = feature_debug_flag_first - 1,
126 EACH_DEBUG_FEATURES(DEFINE_DEBUG_FEATURE, COMMA),
130#define MULTI_BITS_P(bits) ((bits) & ((bits) - 1))
132#define DEBUG_BIT(bit) (1U << feature_debug_##bit)
134#define DUMP_BIT(bit) (1U << dump_##bit)
135#define DEFINE_DUMP(bit) dump_##bit
136#define EACH_DUMPS(X, SEP) \
155 dump_opt_error_tolerant,
158 EACH_DUMPS(DEFINE_DUMP, COMMA),
159 dump_exit_bits = (DUMP_BIT(yydebug) | DUMP_BIT(syntax) |
160 DUMP_BIT(parsetree) | DUMP_BIT(insns)),
161 dump_optional_bits = (DUMP_BIT(opt_error_tolerant) |
162 DUMP_BIT(opt_comment) |
163 DUMP_BIT(opt_optimize))
167rb_feature_set_to(
ruby_features_t *feat,
unsigned int bit_mask,
unsigned int bit_set)
169 feat->mask |= bit_mask;
170 feat->set = (feat->set & ~bit_mask) | bit_set;
173#define FEATURE_SET_TO(feat, bit_mask, bit_set) \
174 rb_feature_set_to(&(feat), bit_mask, bit_set)
175#define FEATURE_SET(feat, bits) FEATURE_SET_TO(feat, bits, bits)
176#define FEATURE_SET_RESTORE(feat, save) FEATURE_SET_TO(feat, (save).mask, (save).set & (save).mask)
177#define FEATURE_SET_P(feat, bits) ((feat).set & FEATURE_BIT(bits))
178#define FEATURE_USED_P(feat, bits) ((feat).mask & FEATURE_BIT(bits))
179#define FEATURE_SET_BITS(feat) ((feat).set & (feat).mask)
183#define src_encoding_index GET_VM()->src_encoding_index
186 COMPILATION_FEATURES = (
188 | FEATURE_BIT(frozen_string_literal)
189 | FEATURE_BIT(frozen_string_literal_set)
190 | FEATURE_BIT(debug_frozen_string_literal)
193 (FEATURE_BIT(debug_flag_first)-1)
197 & ~FEATURE_BIT(frozen_string_literal)
198 & ~FEATURE_BIT(frozen_string_literal_set)
203#define BACKTRACE_LENGTH_LIMIT_VALID_P(n) ((n) >= -1)
204#define OPT_BACKTRACE_LENGTH_LIMIT_VALID_P(opt) \
205 BACKTRACE_LENGTH_LIMIT_VALID_P((opt)->backtrace_length_limit)
212 opt->src.enc.index = src_encoding_index;
213 opt->ext.enc.index = -1;
214 opt->intern.enc.index = -1;
215 opt->features.set = DEFAULT_FEATURES;
216#if defined(YJIT_FORCE_ENABLE)
217 opt->features.set |= FEATURE_BIT(yjit);
219 opt->dump |= DUMP_BIT(opt_optimize);
220 opt->backtrace_length_limit = LONG_MIN;
227static VALUE open_load_file(
VALUE fname_v,
int *xflag);
229#define forbid_setid(s) forbid_setid((s), opt)
236static const char esc_standout[] =
"\n\033[1;7m";
237static const char esc_bold[] =
"\033[1m";
238static const char esc_reset[] =
"\033[0m";
239static const char esc_none[] =
"";
240#define USAGE_INDENT " "
243show_usage_part(
const char *str,
const unsigned int namelen,
244 const char *str2,
const unsigned int secondlen,
246 int help,
int highlight,
unsigned int w,
int columns)
248 static const int indent_width = (int)
rb_strlen_lit(USAGE_INDENT);
249 const char *sb = highlight ? esc_bold : esc_none;
250 const char *se = highlight ? esc_reset : esc_none;
251 unsigned int desclen = (
unsigned int)strcspn(desc,
"\n");
252 if (!help && desclen > 0 && strchr(
".;:", desc[desclen-1])) --desclen;
253 if (help && (namelen + 1 > w) &&
254 (int)(namelen + secondlen + indent_width) >= columns) {
255 printf(USAGE_INDENT
"%s" "%.*s" "%s\n", sb, namelen, str, se);
257 const int second_end = secondlen;
259 if (str2[n] ==
',') n++;
260 if (str2[n] ==
' ') n++;
261 printf(USAGE_INDENT
"%s" "%.*s" "%s\n", sb, second_end-n, str2+n, se);
263 printf(
"%-*s%.*s\n", w + indent_width, USAGE_INDENT, desclen, desc);
266 const int wrap = help && namelen + secondlen >= w;
267 printf(USAGE_INDENT
"%s%.*s%-*.*s%s%-*s%.*s\n", sb, namelen, str,
268 (wrap ? 0 : w - namelen),
269 (help ? secondlen : 0), str2, se,
271 (wrap ?
"\n" USAGE_INDENT :
""),
275 while (desc[desclen]) {
277 desclen = (
unsigned int)strcspn(desc,
"\n");
278 printf(
"%-*s%.*s\n", w + indent_width, USAGE_INDENT, desclen, desc);
285 int help,
int highlight,
unsigned int w,
int columns)
287 const char *str = m->str;
288 const unsigned int namelen = m->namelen, secondlen = m->secondlen;
289 const char *desc = str + namelen + secondlen;
290 show_usage_part(str, namelen - 1, str + namelen, secondlen - 1, desc,
291 help, highlight, w, columns);
295ruby_show_usage_line(
const char *name,
const char *secondary,
const char *description,
296 int help,
int highlight,
unsigned int width,
int columns)
298 unsigned int namelen = (
unsigned int)strlen(name);
299 unsigned int secondlen = (secondary ? (
unsigned int)strlen(secondary) : 0);
300 show_usage_part(name, namelen, secondary, secondlen,
301 description, help, highlight, width, columns);
307usage(
const char *name,
int help,
int highlight,
int columns)
309#define M(shortopt, longopt, desc) RUBY_OPT_MESSAGE(shortopt, longopt, desc)
312# define DEFAULT_JIT_OPTION "--yjit"
314# define DEFAULT_JIT_OPTION "--zjit"
320 M(
"-0[octal]",
"",
"Set input record separator ($/):\n"
321 "-0 for \\0; -00 for paragraph mode; -0777 for slurp mode."),
322 M(
"-a",
"",
"Split each input line ($_) into fields ($F)."),
323 M(
"-c",
"",
"Check syntax (no execution)."),
324 M(
"-Cdirpath",
"",
"Execute program in specified directory."),
325 M(
"-d",
", --debug",
"Set debugging flag ($DEBUG) to true."),
326 M(
"-e 'code'",
"",
"Execute given Ruby code; multiple -e allowed."),
327 M(
"-Eex[:in]",
", --encoding=ex[:in]",
"Set default external and internal encodings."),
328 M(
"-Fpattern",
"",
"Set input field separator ($;); used with -a."),
329 M(
"-i[extension]",
"",
"Set ARGF in-place mode;\n"
330 "create backup files with given extension."),
331 M(
"-Idirpath",
"",
"Prepend specified directory to load paths ($LOAD_PATH);\n"
332 "relative paths are expanded; multiple -I are allowed."),
333 M(
"-l",
"",
"Set output record separator ($\\) to $/;\n"
334 "used for line-oriented output."),
335 M(
"-n",
"",
"Run program in gets loop."),
336 M(
"-p",
"",
"Like -n, with printing added."),
337 M(
"-rlibrary",
"",
"Require the given library."),
338 M(
"-s",
"",
"Define global variables using switches following program path."),
339 M(
"-S",
"",
"Search directories found in the PATH environment variable."),
340 M(
"-v",
"",
"Print version; set $VERBOSE to true."),
341 M(
"-w",
"",
"Synonym for -W1."),
342 M(
"-W[level=2|:category]",
"",
"Set warning flag ($-W):\n"
343 "0 for silent; 1 for moderate; 2 for verbose."),
344 M(
"-x[dirpath]",
"",
"Execute Ruby code starting from a #!ruby line."),
345#if USE_YJIT || USE_ZJIT
346 M(
"--jit",
"",
"Enable the default JIT for the build; same as " DEFAULT_JIT_OPTION
"."),
349 M(
"--yjit",
"",
"Enable in-process JIT compiler."),
352 M(
"--zjit",
"",
"Enable method-based JIT compiler."),
354 M(
"-h",
"",
"Print this help message; use --help for longer message."),
356 STATIC_ASSERT(usage_msg_size, numberof(usage_msg) < 26);
359 M(
"--backtrace-limit=num",
"",
"Set backtrace limit."),
360 M(
"--copyright",
"",
"Print Ruby copyright."),
361 M(
"--crash-report=template",
"",
"Set template for crash report file."),
362 M(
"--disable=features",
"",
"Disable features; see list below."),
363 M(
"--dump=items",
"",
"Dump items; see list below."),
364 M(
"--enable=features",
"",
"Enable features; see list below."),
365 M(
"--external-encoding=encoding",
"",
"Set default external encoding."),
366 M(
"--help",
"",
"Print long help message; use -h for short message."),
367 M(
"--internal-encoding=encoding",
"",
"Set default internal encoding."),
368 M(
"--parser=parser",
"",
"Set Ruby parser: parse.y or prism."),
369 M(
"--verbose",
"",
"Set $VERBOSE to true; ignore input from $stdin."),
370 M(
"--version",
"",
"Print Ruby version."),
371 M(
"-y",
", --yydebug",
"Print parser log; backward compatibility not guaranteed."),
374 M(
"insns",
"",
"Instruction sequences."),
375 M(
"yydebug",
"",
"yydebug of yacc parser generator."),
376 M(
"parsetree",
"",
"Abstract syntax tree (AST)."),
377 M(
"-optimize",
"",
"Disable optimization (affects insns)."),
378 M(
"+error-tolerant",
"",
"Error-tolerant parsing (affects yydebug, parsetree)."),
379 M(
"+comment",
"",
"Add comments to AST (affects parsetree with --parser=parse.y)."),
382 M(
"gems",
"",
"Rubygems (only for debugging, default: "DEFAULT_RUBYGEMS_ENABLED
")."),
383 M(
"error_highlight",
"",
"error_highlight (default: "DEFAULT_RUBYGEMS_ENABLED
")."),
384 M(
"did_you_mean",
"",
"did_you_mean (default: "DEFAULT_RUBYGEMS_ENABLED
")."),
385 M(
"syntax_suggest",
"",
"syntax_suggest (default: "DEFAULT_RUBYGEMS_ENABLED
")."),
386 M(
"rubyopt",
"",
"RUBYOPT environment variable (default: enabled)."),
387 M(
"frozen-string-literal",
"",
"Freeze all string literals (default: disabled)."),
389 M(
"yjit",
"",
"In-process JIT compiler (default: disabled)."),
392 M(
"zjit",
"",
"Method-based JIT compiler (default: disabled)."),
396 M(
"deprecated",
"",
"Deprecated features."),
397 M(
"experimental",
"",
"Experimental features."),
398 M(
"performance",
"",
"Performance issues."),
399 M(
"strict_unused_block",
"",
"Warning unused block strictly"),
402 const char *sb = highlight ? esc_standout+1 : esc_none;
403 const char *se = highlight ? esc_reset : esc_none;
404 const int num = numberof(usage_msg) - (help ? 1 : 0);
405 unsigned int w = (columns > 80 ? (columns - 79) / 2 : 0) + 16;
406#define SHOW(m) show_usage_line(&(m), help, highlight, w, columns)
408 printf(
"%sUsage:%s %s [options] [--] [filepath] [arguments]\n", sb, se, name);
409 printf(
"\n""Details and examples at https://docs.ruby-lang.org/en/%s/ruby/options_md.html\n",
410 ruby_api_version_name);
412 for (i = 0; i < num; ++i)
417 if (highlight) sb = esc_standout;
419 for (i = 0; i < numberof(help_msg); ++i)
421 printf(
"%s""Dump List:%s\n", sb, se);
422 for (i = 0; i < numberof(dumps); ++i)
424 printf(
"%s""Features:%s\n", sb, se);
425 for (i = 0; i < numberof(features); ++i)
427 printf(
"%s""Warning categories:%s\n", sb, se);
428 for (i = 0; i < numberof(warn_categories); ++i)
429 SHOW(warn_categories[i]);
431 printf(
"%s""YJIT options:%s\n", sb, se);
432 rb_yjit_show_usage(help, highlight, w, columns);
435 printf(
"%s""ZJIT options:%s\n", sb, se);
436 extern void rb_zjit_show_usage(
int help,
int highlight,
unsigned int width,
int columns);
437 rb_zjit_show_usage(help, highlight, w, columns);
441#define rubylib_path_new rb_str_new
444ruby_push_include(
const char *path,
VALUE (*filter)(
VALUE))
448 VALUE load_path = GET_VM()->load_path;
450 char rubylib[FILENAME_MAX];
452# define is_path_sep(c) ((c) == sep || (c) == ';')
454# define is_path_sep(c) ((c) == sep)
457 if (path == 0)
return;
461 while (is_path_sep(*p))
464 for (s = p; *s && !is_path_sep(*s); s = CharNext(s));
472 p = RSTRING_PTR(buf);
475 rb_str_resize(buf,
len);
476 p = strncpy(RSTRING_PTR(buf), p,
len);
479#ifdef HAVE_CYGWIN_CONV_PATH
480#define CONV_TO_POSIX_PATH(p, lib) \
481 cygwin_conv_path(CCP_WIN_A_TO_POSIX|CCP_RELATIVE, (p), (lib), sizeof(lib))
483# error no cygwin_conv_path
485 if (CONV_TO_POSIX_PATH(p, rubylib) == 0) {
496identical_path(
VALUE path)
502locale_path(
VALUE path)
504 rb_enc_associate(path, rb_locale_encoding());
511 ruby_push_include(path, locale_path);
515expand_include_path(
VALUE path)
517 char *p = RSTRING_PTR(path);
520 if (*p ==
'.' && p[1] ==
'/')
522 return rb_file_expand_path(path,
Qnil);
526ruby_incpush_expand(
const char *path)
528 ruby_push_include(path, expand_include_path);
532#if defined _WIN32 || defined __CYGWIN__
533static HMODULE libruby;
536DllMain(HINSTANCE dll, DWORD reason, LPVOID reserved)
538 if (reason == DLL_PROCESS_ATTACH)
544rb_libruby_handle(
void)
550translit_char_bin(
char *p,
int from,
int to)
553 if ((
unsigned char)*p == from)
562# define chdir rb_w32_uchdir
570# define IF_UTF8_PATH(t, f) t
572# define IF_UTF8_PATH(t, f) f
584# define str_conv_enc(str, from, to) (str)
589#if defined(LOAD_RELATIVE)
591runtime_libruby_path(
void)
593#if defined _WIN32 || defined __CYGWIN__
601 while (wlibpath = (WCHAR *)RSTRING_PTR(wsopath),
602 ret = GetModuleFileNameW(libruby, wlibpath,
len),
608 if (!ret || ret >
len) rb_fatal(
"failed to get module file name");
609#if defined __CYGWIN__
611 const int win_to_posix = CCP_WIN_W_TO_POSIX | CCP_RELATIVE;
612 size_t newsize = cygwin_conv_path(win_to_posix, wlibpath, 0, 0);
613 if (!newsize) rb_fatal(
"failed to convert module path to cygwin");
615 libpath = RSTRING_PTR(path);
616 if (cygwin_conv_path(win_to_posix, wlibpath, libpath, newsize)) {
617 rb_str_resize(path, 0);
623 for (
len = ret, i = 0; i <
len; ++i) {
624 if (wlibpath[i] == L
'\\') {
630 len = WideCharToMultiByte(CP_UTF8, 0, wlibpath, ret, NULL, 0, NULL, NULL);
632 libpath = RSTRING_PTR(path);
633 WideCharToMultiByte(CP_UTF8, 0, wlibpath, ret, libpath,
len, NULL, NULL);
635 rb_str_resize(wsopath, 0);
637#elif defined(HAVE_DLADDR)
640 const void* addr = (
void *)(
VALUE)expand_include_path;
642 if (!dladdr((
void *)addr, &dli)) {
646 else if (origarg.argc > 0 && origarg.argv && dli.dli_fname == origarg.argv[0]) {
648 path = rb_readlink(fname, NULL);
653 path = rb_realpath_internal(
Qnil, fname, 1);
655 rb_str_resize(fname, 0);
658# error relative load path is not supported on this platform.
663#define INITIAL_LOAD_PATH_MARK rb_intern_const("@gem_prelude_index")
665VALUE ruby_archlibdir_path, ruby_prefix_path;
670 VALUE load_path, archlibdir = 0;
671 ID id_initial_load_path_mark;
672 const char *paths = ruby_initial_load_paths;
674#if defined LOAD_RELATIVE
675#if !defined ENABLE_MULTIARCH
676# define RUBY_ARCH_PATH ""
677#elif defined RUBY_ARCH
678# define RUBY_ARCH_PATH "/"RUBY_ARCH
680# define RUBY_ARCH_PATH "/"RUBY_PLATFORM
687 sopath = runtime_libruby_path();
688 libpath = RSTRING_PTR(sopath);
690 p = strrchr(libpath,
'/');
692 static const char libdir[] =
"/"
693#ifdef LIBDIR_BASENAME
699 const ptrdiff_t libdir_len = (ptrdiff_t)
sizeof(libdir)
701 static const char bindir[] =
"/bin";
702 const ptrdiff_t bindir_len = (ptrdiff_t)
sizeof(bindir) - 1;
704 const char *p2 = NULL;
706#ifdef ENABLE_MULTIARCH
709 if (p - libpath >= bindir_len && !
STRNCASECMP(p - bindir_len, bindir, bindir_len)) {
715 else if (p - libpath >= libdir_len && !strncmp(p - libdir_len, libdir, libdir_len)) {
716 archlibdir =
rb_str_subseq(sopath, 0, (p2 ? p2 : p) - libpath);
720#ifdef ENABLE_MULTIARCH
726 p = rb_enc_path_last_separator(libpath, p, rb_ascii8bit_encoding());
727 if (p)
goto multiarch;
731 baselen = p - libpath;
736 rb_str_resize(sopath, baselen);
737 libpath = RSTRING_PTR(sopath);
738#define PREFIX_PATH() sopath
739#define BASEPATH() rb_str_buf_cat(rb_str_buf_new(baselen+len), libpath, baselen)
740#define RUBY_RELATIVE(path, len) rb_str_buf_cat(BASEPATH(), (path), (len))
742 const size_t exec_prefix_len = strlen(ruby_exec_prefix);
743#define RUBY_RELATIVE(path, len) rubylib_path_new((path), (len))
744#define PREFIX_PATH() RUBY_RELATIVE(ruby_exec_prefix, exec_prefix_len)
746 rb_gc_register_address(&ruby_prefix_path);
747 ruby_prefix_path = PREFIX_PATH();
749 if (!archlibdir) archlibdir = ruby_prefix_path;
750 rb_gc_register_address(&ruby_archlibdir_path);
751 ruby_archlibdir_path = archlibdir;
753 load_path = GET_VM()->load_path;
755 ruby_push_include(getenv(
"RUBYLIB"), identical_path);
757 id_initial_load_path_mark = INITIAL_LOAD_PATH_MARK;
759 size_t len = strlen(paths);
760 VALUE path = RUBY_RELATIVE(paths,
len);
761 rb_ivar_set(path, id_initial_load_path_mark, path);
769add_modules(
VALUE *req_list,
const char *mod)
771 VALUE list = *req_list;
782require_libraries(
VALUE *req_list)
784 VALUE list = *req_list;
785 VALUE self = rb_vm_top_self();
787 rb_encoding *extenc = rb_default_external_encoding();
792 rb_enc_associate(feature, extenc);
795 rb_funcallv(self, require, 1, &feature);
807process_sflag(
int sflag)
825 if (s[1] ==
'-' && s[2] ==
'\0')
830 for (p = s + 1; *p; p++) {
839 else if (*p !=
'_' && !
ISALNUM(*p)) {
842 rb_str_new2(
"invalid name for global variable - ");
843 if (!(p = strchr(p,
'='))) {
849 name_error[1] = args[-1];
855 for (p = s + 1; *p; ++p) {
879 VALUE argstr, argary;
882 VALUE src_enc_name = opt->src.enc.name;
883 VALUE ext_enc_name = opt->ext.enc.name;
884 VALUE int_enc_name = opt->intern.enc.name;
887 long backtrace_length_limit = opt->backtrace_length_limit;
888 const char *crash_report = opt->crash_report;
893 opt->src.enc.name = opt->ext.enc.name = opt->intern.enc.name = 0;
895 const int hyphen = *s !=
'-';
899 p = RSTRING_PTR(argstr);
900 if (hyphen) *p =
'-';
901 memcpy(p + hyphen, s,
len + 1);
907 while (*p && !
ISSPACE(*p)) ++p;
912 argc = RSTRING_LEN(argary) /
sizeof(ap);
915 argv = ptr =
ALLOC_N(
char *, argc);
916 MEMMOVE(argv, RSTRING_PTR(argary),
char *, argc);
918 while ((i = proc_options(argc, argv, opt, envopt)) > 1 && envopt && (argc -= i) > 0) {
930 opt->src.enc.name = src_enc_name;
933 opt->ext.enc.name = ext_enc_name;
936 opt->intern.enc.name = int_enc_name;
938 FEATURE_SET_RESTORE(opt->features, feat);
939 FEATURE_SET_RESTORE(opt->warn, warn);
940 if (BACKTRACE_LENGTH_LIMIT_VALID_P(backtrace_length_limit)) {
941 opt->backtrace_length_limit = backtrace_length_limit;
944 opt->crash_report = crash_report;
949 rb_str_resize(argary, 0);
950 rb_str_resize(argstr, 0);
954name_match_p(
const char *name,
const char *str,
size_t len)
956 if (
len == 0)
return 0;
958 while (
TOLOWER(*str) == *name) {
959 if (!--
len)
return 1;
963 if (*str !=
'-' && *str !=
'_')
return 0;
965 if (*name !=
'-' && *name !=
'_')
return 0;
966 if (!*++name)
return 1;
968 if (--
len == 0)
return 1;
972#define NAME_MATCH_P(name, str, len) \
973 ((len) < (int)sizeof(name) && name_match_p((name), (str), (len)))
975#define UNSET_WHEN(name, bit, str, len) \
976 if (NAME_MATCH_P((name), (str), (len))) { \
977 *(unsigned int *)arg &= ~(bit); \
981#define SET_WHEN(name, bit, str, len) \
982 if (NAME_MATCH_P((name), (str), (len))) { \
983 *(unsigned int *)arg |= (bit); \
987#define LITERAL_NAME_ELEMENT(name) #name
990feature_option(
const char *str,
int len,
void *arg,
const unsigned int enable)
992 static const char list[] = EACH_FEATURES(LITERAL_NAME_ELEMENT,
", ");
994 unsigned int mask = ~0
U;
995 unsigned int set = 0
U;
996#if AMBIGUOUS_FEATURE_NAMES
998# define FEATURE_FOUND ++matched
1000# define FEATURE_FOUND goto found
1002#define SET_FEATURE(bit) \
1003 if (NAME_MATCH_P(#bit, str, len)) {set |= mask = FEATURE_BIT(bit); FEATURE_FOUND;}
1004 EACH_FEATURES(SET_FEATURE, ;);
1005 if (NAME_MATCH_P(
"jit", str,
len)) {
1006 set |= mask = FEATURE_BIT(jit);
1009 if (NAME_MATCH_P(
"all", str,
len)) {
1011 mask &= ~feature_jit_mask | FEATURE_BIT(jit);
1014#if AMBIGUOUS_FEATURE_NAMES
1015 if (matched == 1)
goto found;
1017 VALUE mesg = rb_sprintf(
"ambiguous feature: '%.*s' (",
len, str);
1018#define ADD_FEATURE_NAME(bit) \
1019 if (FEATURE_BIT(bit) & set) { \
1020 rb_str_cat_cstr(mesg, #bit); \
1021 if (--matched) rb_str_cat_cstr(mesg, ", "); \
1023 EACH_FEATURES(ADD_FEATURE_NAME, ;);
1026#undef ADD_FEATURE_NAME
1031 rb_warn(
"unknown argument for --%s: '%.*s'",
1032 enable ?
"enable" :
"disable",
len, str);
1033 rb_warn(
"features are [%.*s].", (
int)strlen(list), list);
1037 FEATURE_SET_TO(*argp, mask, (mask & enable));
1038 if (NAME_MATCH_P(
"frozen_string_literal", str,
len)) {
1039 FEATURE_SET_TO(*argp, FEATURE_BIT(frozen_string_literal_set), FEATURE_BIT(frozen_string_literal_set));
1045enable_option(
const char *str,
int len,
void *arg)
1047 feature_option(str,
len, arg, ~0
U);
1051disable_option(
const char *str,
int len,
void *arg)
1053 feature_option(str,
len, arg, 0
U);
1057int ruby_env_debug_option(
const char *str,
int len,
void *arg);
1060debug_option(
const char *str,
int len,
void *arg)
1062 static const char list[] = EACH_DEBUG_FEATURES(LITERAL_NAME_ELEMENT,
", ");
1064#define SET_WHEN_DEBUG(bit) \
1065 if (NAME_MATCH_P(#bit, str, len)) { \
1066 FEATURE_SET(*argp, DEBUG_BIT(bit)); \
1069 EACH_DEBUG_FEATURES(SET_WHEN_DEBUG, ;);
1073 rb_warn(
"unknown argument for --debug: '%.*s'",
len, str);
1074 rb_warn(
"debug features are [%.*s].", (
int)strlen(list), list);
1078memtermspn(
const char *str,
char term,
int len)
1081 if (
len <= 0)
return 0;
1082 const char *next = memchr(str, term,
len);
1083 return next ? (int)(next - str) :
len;
1086static const char additional_opt_sep =
'+';
1089dump_additional_option_flag(
const char *str,
int len,
unsigned int bits,
bool set)
1091#define SET_DUMP_OPT(bit) if (NAME_MATCH_P(#bit, str, len)) { \
1092 return set ? (bits | DUMP_BIT(opt_ ## bit)) : (bits & ~DUMP_BIT(opt_ ## bit)); \
1094 SET_DUMP_OPT(error_tolerant);
1095 SET_DUMP_OPT(comment);
1096 SET_DUMP_OPT(optimize);
1098 rb_warn(
"don't know how to dump with%s '%.*s'", set ?
"" :
"out",
len, str);
1103dump_additional_option(
const char *str,
int len,
unsigned int bits)
1106 for (;
len-- > 0 && *str++ == additional_opt_sep;
len -= w, str += w) {
1107 w = memtermspn(str, additional_opt_sep,
len);
1109 if (*str ==
'-' || *str ==
'+') {
1110 set = *str++ ==
'+';
1114 int n = memtermspn(str,
'-', w);
1115 if (str[n] ==
'-') {
1116 if (NAME_MATCH_P(
"with", str, n)) {
1120 else if (NAME_MATCH_P(
"without", str, n)) {
1127 bits = dump_additional_option_flag(str, w, bits, set);
1133dump_option(
const char *str,
int len,
void *arg)
1135 static const char list[] = EACH_DUMPS(LITERAL_NAME_ELEMENT,
", ");
1136 unsigned int *bits_ptr = (
unsigned int *)arg;
1137 if (*str ==
'+' || *str ==
'-') {
1138 bool set = *str++ ==
'+';
1139 *bits_ptr = dump_additional_option_flag(str, --
len, *bits_ptr, set);
1142 int w = memtermspn(str, additional_opt_sep,
len);
1144#define SET_WHEN_DUMP(bit) \
1145 if (NAME_MATCH_P(#bit "-", (str), (w))) { \
1146 *bits_ptr = dump_additional_option(str + w, len - w, *bits_ptr | DUMP_BIT(bit)); \
1149 EACH_DUMPS(SET_WHEN_DUMP, ;);
1150 rb_warn(
"don't know how to dump '%.*s',",
len, str);
1151 rb_warn(
"but only [%.*s].", (
int)strlen(list), list);
1155set_option_encoding_once(
const char *
type,
VALUE *name,
const char *e,
long elen)
1159 if (!elen) elen = strlen(e);
1165 "%s already set to %"PRIsVALUE,
type, *name);
1170#define set_internal_encoding_once(opt, e, elen) \
1171 set_option_encoding_once("default_internal", &(opt)->intern.enc.name, (e), (elen))
1172#define set_external_encoding_once(opt, e, elen) \
1173 set_option_encoding_once("default_external", &(opt)->ext.enc.name, (e), (elen))
1174#define set_source_encoding_once(opt, e, elen) \
1175 set_option_encoding_once("source", &(opt)->src.enc.name, (e), (elen))
1177#define yjit_opt_match_noarg(s, l, name) \
1178 opt_match(s, l, name) && (*(s) ? (rb_warn("argument to --yjit-" name " is ignored"), 1) : 1)
1179#define yjit_opt_match_arg(s, l, name) \
1180 opt_match(s, l, name) && (*(s) && *(s+1) ? 1 : (rb_raise(rb_eRuntimeError, "--yjit-" name " needs an argument"), 0))
1184setup_yjit_options(
const char *s)
1187 bool rb_yjit_parse_option(
const char* s);
1188 bool success = rb_yjit_parse_option(s);
1196 "invalid YJIT option '%s' (--help will show valid yjit options)",
1204setup_zjit_options(
const char *s)
1207 extern bool rb_zjit_parse_option(
const char *s);
1209 if (!rb_zjit_parse_option(s)) {
1210 rb_raise(
rb_eRuntimeError,
"invalid ZJIT option '%s' (--help will show valid zjit options)", s);
1232 unsigned int bits = 0;
1233 static const char no_prefix[] =
"no-";
1234 int enable = strncmp(s += 2, no_prefix,
sizeof(no_prefix)-1) != 0;
1235 if (!enable) s +=
sizeof(no_prefix)-1;
1236 size_t len = strlen(s);
1237 if (NAME_MATCH_P(
"deprecated", s,
len)) {
1240 else if (NAME_MATCH_P(
"experimental", s,
len)) {
1243 else if (NAME_MATCH_P(
"performance", s,
len)) {
1246 else if (NAME_MATCH_P(
"strict_unused_block", s,
len)) {
1250 rb_warn(
"unknown warning category: '%s'", s);
1252 if (bits) FEATURE_SET_TO(opt->warn, bits, enable ? bits : 0);
1265 if (!opt->warning) {
1281 FEATURE_SET_TO(opt->warn, RB_WARN_CATEGORY_DEFAULT_BITS, 0);
1287 FEATURE_SET(opt->warn, RB_WARN_CATEGORY_DEFAULT_BITS);
1306 if (!opt->e_script) {
1308 if (opt->script == 0)
1321 const char *enc_name = 0;
1324 enc_name =
"EUC-JP";
1327 enc_name =
"Windows-31J";
1332 case 'N':
case 'n':
case 'A':
case 'a':
1333 enc_name =
"ASCII-8BIT";
1338 if (!opt->ext.enc.name)
1339 opt->ext.enc.name = opt->src.enc.name;
1358 else if (v == 0 && numlen >= 2) {
1359 rb_rs = rb_fstring_lit(
"");
1373# define set_encoding_part(type) \
1374 if (!(p = strchr(s, ':'))) { \
1375 set_##type##_encoding_once(opt, s, 0); \
1379 set_##type##_encoding_once(opt, s, p-s); \
1381 set_encoding_part(external);
1382 if (!*(s = ++p))
return;
1383 set_encoding_part(internal);
1384 if (!*(s = ++p))
return;
1385#if defined ALLOW_DEFAULT_SOURCE_ENCODING && ALLOW_DEFAULT_SOURCE_ENCODING
1386 set_encoding_part(source);
1387 if (!*(s = ++p))
return;
1390# undef set_encoding_part
1399# define is_option_end(c, allow_hyphen) \
1400 (!(c) || ((allow_hyphen) && (c) == '-') || (c) == '=')
1401# define check_envopt(name, allow_envopt) \
1402 (((allow_envopt) || !envopt) ? (void)0 : \
1403 rb_raise(rb_eRuntimeError, "invalid switch in RUBYOPT: --" name))
1404# define need_argument(name, s, needs_arg, next_arg) \
1405 ((*(s) ? !*++(s) : (next_arg) && (argc <= 1 || !((s) = argv[1]) || (--argc, ++argv, 0))) && (needs_arg) ? \
1406 rb_raise(rb_eRuntimeError, "missing argument for --" name) \
1408# define is_option_with_arg(name, allow_hyphen, allow_envopt) \
1409 is_option_with_optarg(name, allow_hyphen, allow_envopt, Qtrue, Qtrue)
1410# define is_option_with_optarg(name, allow_hyphen, allow_envopt, needs_arg, next_arg) \
1411 (strncmp((name), s, n = sizeof(name) - 1) == 0 && is_option_end(s[n], (allow_hyphen)) && \
1412 (s[n] != '-' || (s[n] && s[n+1])) ? \
1413 (check_envopt(name, (allow_envopt)), s += n, \
1414 need_argument(name, s, needs_arg, next_arg), 1) : 0)
1416 if (strcmp(
"copyright", s) == 0) {
1417 if (envopt)
goto noenvopt_long;
1418 opt->dump |= DUMP_BIT(copyright);
1429 else if (is_option_with_arg(
"enable",
Qtrue,
Qtrue)) {
1432 else if (is_option_with_arg(
"disable",
Qtrue,
Qtrue)) {
1435 else if (is_option_with_arg(
"encoding",
Qfalse,
Qtrue)) {
1436 proc_encoding_option(opt, s,
"--encoding");
1438 else if (is_option_with_arg(
"internal-encoding",
Qfalse,
Qtrue)) {
1439 set_internal_encoding_once(opt, s, 0);
1441 else if (is_option_with_arg(
"external-encoding",
Qfalse,
Qtrue)) {
1442 set_external_encoding_once(opt, s, 0);
1444 else if (is_option_with_arg(
"parser",
Qfalse,
Qtrue)) {
1445 if (strcmp(
"prism", s) == 0) {
1446 rb_ruby_default_parser_set(RB_DEFAULT_PARSER_PRISM);
1448 else if (strcmp(
"parse.y", s) == 0) {
1449 rb_ruby_default_parser_set(RB_DEFAULT_PARSER_PARSE_Y);
1455#if defined ALLOW_DEFAULT_SOURCE_ENCODING && ALLOW_DEFAULT_SOURCE_ENCODING
1456 else if (is_option_with_arg(
"source-encoding",
Qfalse,
Qtrue)) {
1457 set_source_encoding_once(opt, s, 0);
1460 else if (strcmp(
"version", s) == 0) {
1461 if (envopt)
goto noenvopt_long;
1462 opt->dump |= DUMP_BIT(version);
1464 else if (strcmp(
"verbose", s) == 0) {
1468 else if (strcmp(
"jit", s) == 0) {
1470 FEATURE_SET(opt->features, FEATURE_BIT(jit));
1472 rb_warn(
"Ruby was built without JIT support");
1475 else if (is_option_with_optarg(
"yjit",
'-',
true,
false,
false)) {
1477 FEATURE_SET(opt->features, FEATURE_BIT(yjit));
1478 setup_yjit_options(s);
1480 rb_warn(
"Ruby was built without YJIT support."
1481 " You may need to install rustc to build Ruby with YJIT.");
1484 else if (is_option_with_optarg(
"zjit",
'-',
true,
false,
false)) {
1486 FEATURE_SET(opt->features, FEATURE_BIT(zjit));
1487 setup_zjit_options(s);
1489 rb_warn(
"Ruby was built without ZJIT support."
1490 " You may need to install rustc to build Ruby with ZJIT.");
1493 else if (strcmp(
"yydebug", s) == 0) {
1494 if (envopt)
goto noenvopt_long;
1495 opt->dump |= DUMP_BIT(yydebug);
1500 else if (strcmp(
"help", s) == 0) {
1501 if (envopt)
goto noenvopt_long;
1502 opt->dump |= DUMP_BIT(help);
1505 else if (is_option_with_arg(
"backtrace-limit",
Qfalse,
Qtrue)) {
1507 long n = strtol(s, &e, 10);
1508 if (
errno == ERANGE || !BACKTRACE_LENGTH_LIMIT_VALID_P(n) || *e) {
1512 opt->backtrace_length_limit = n;
1515 else if (is_option_with_arg(
"crash-report",
true,
true)) {
1516 opt->crash_report = s;
1520 "invalid option --%s (-h will show valid options)", s);
1522 return argc0 - argc + 1;
1526# undef is_option_end
1528# undef need_argument
1529# undef is_option_with_arg
1530# undef is_option_with_optarg
1537 long n, argc0 = argc;
1539 int warning = opt->warning;
1541 if (argc <= 0 || !argv)
1544 for (argc--, argv++; argc > 0; argc--, argv++) {
1545 const char *
const arg = argv[0];
1546 if (!arg || arg[0] !=
'-' || !arg[1])
1553 if (envopt)
goto noenvopt;
1554 opt->do_split = TRUE;
1559 if (envopt)
goto noenvopt;
1560 opt->do_print = TRUE;
1563 if (envopt)
goto noenvopt;
1564 opt->do_loop = TRUE;
1575 if (envopt)
goto noenvopt;
1576 opt->dump |= DUMP_BIT(yydebug);
1585 opt->dump |= DUMP_BIT(version_v);
1588 if (!opt->warning) {
1592 FEATURE_SET(opt->warn, RB_WARN_CATEGORY_DEFAULT_BITS);
1597 if (!(s = proc_W_option(opt, s, &warning)))
break;
1601 if (envopt)
goto noenvopt;
1602 opt->dump |= DUMP_BIT(syntax);
1607 if (envopt)
goto noenvopt;
1609 if (!opt->sflag) opt->sflag = 1;
1614 if (envopt)
goto noenvopt;
1615 opt->dump |= DUMP_BIT(usage);
1619 if (envopt)
goto noenvopt;
1620 opt->do_line = TRUE;
1626 if (envopt)
goto noenvopt;
1628 opt->do_search = TRUE;
1633 if (envopt)
goto noenvopt;
1634 if (!(n = proc_e_option(opt, s, argc, argv)))
break;
1643 add_modules(&opt->req_list, s);
1645 else if (argc > 1) {
1646 add_modules(&opt->req_list, argv[1]);
1652 if (envopt)
goto noenvopt;
1654 ruby_set_inplace_mode(s + 1);
1658 if (envopt)
goto noenvopt;
1662 if (*s && chdir(s) < 0) {
1663 rb_fatal(
"Can't chdir to %s", s);
1669 if (envopt)
goto noenvopt;
1670 if (!*++s && (!--argc || !(s = *++argv) || !*s)) {
1671 rb_fatal(
"Can't chdir");
1674 rb_fatal(
"Can't chdir to %s", s);
1679 if (envopt)
goto noenvopt;
1686 if (!*++s && (!--argc || !(s = *++argv))) {
1689 proc_encoding_option(opt, s,
"-E");
1693 set_internal_encoding_once(opt,
"UTF-8", 0);
1698 if (!(s = proc_K_option(opt, s)))
break;
1704 ruby_incpush_expand(s);
1705 else if (argc > 1) {
1706 ruby_incpush_expand(argv[1]);
1712 if (envopt)
goto noenvopt;
1713 if (!(s = proc_0_option(opt, s)))
break;
1717 if (!s[1] || (s[1] ==
'\r' && !s[2])) {
1723 if (!(n = proc_long_options(opt, s, argc, argv, envopt)))
goto switch_end;
1734 rb_encoding *enc = IF_UTF8_PATH(rb_utf8_encoding(), rb_locale_encoding());
1735 const char *e = s + strlen(s);
1736 int r = rb_enc_precise_mbclen(s, e, enc);
1737 unsigned int c = (
unsigned char)*s;
1739 c = rb_enc_mbc_to_codepoint(s, e, enc);
1740 if (ONIGENC_IS_CODE_GRAPH(enc, c) ||
1741 ((s = ruby_escaped_char(c)) != 0 &&
1742 (r = (
int)strlen(s), 1))) {
1744 "invalid option -%.*s (-h will show valid options)",
1749 "invalid option -\\x%.2x (-h will show valid options)",
1766 if (warning) opt->warning = warning;
1767 return argc0 - argc;
1770void Init_builtin_features(
void);
1773ruby_init_prelude(
void)
1775 Init_builtin_features();
1778void rb_call_builtin_inits(
void);
1782#if RBIMPL_HAS_ATTRIBUTE(weak)
1786Init_extra_exts(
void)
1793 rb_warning_category_update(opt->warn.mask, opt->warn.set);
1795 if (opt->dump & dump_exit_bits)
return;
1797 if (FEATURE_SET_P(opt->features, gems)) {
1799 if (opt->features.set & FEATURE_BIT(error_highlight)) {
1802 if (opt->features.set & FEATURE_BIT(did_you_mean)) {
1805 if (opt->features.set & FEATURE_BIT(syntax_suggest)) {
1812 if (getenv(
"RUBY_GC_HEAP_INIT_SLOTS")) {
1813 rb_warn_deprecated(
"The environment variable RUBY_GC_HEAP_INIT_SLOTS",
1814 "environment variables RUBY_GC_HEAP_%d_INIT_SLOTS");
1820 GET_VM()->running = 0;
1821 rb_call_builtin_inits();
1822 GET_VM()->running = 1;
1823 memset(ruby_vm_redefined_flag, 0,
sizeof(ruby_vm_redefined_flag));
1825 if (rb_namespace_available())
1826 rb_initialize_main_namespace();
1827 rb_namespace_init_done();
1828 ruby_init_prelude();
1832 rb_yjit_init(opt->yjit);
1836 extern void rb_zjit_init(
void);
1842 require_libraries(&opt->req_list);
1846opt_enc_index(
VALUE enc_name)
1848 const char *s = RSTRING_PTR(enc_name);
1849 int i = rb_enc_find_index(s);
1854 else if (rb_enc_dummy_p(rb_enc_from_index(i))) {
1860#define rb_progname (GET_VM()->progname)
1861#define rb_orig_progname (GET_VM()->orig_progname)
1877#define rb_define_readonly_boolean(name, val) \
1878 rb_define_virtual_variable((name), (val) ? true_value : false_value, 0)
1887 rb_raise(
rb_eTypeError,
"$_ value need to be String (%s given)",
1969setup_pager_env(
void)
1971 if (!getenv(
"LESS")) {
1973 ruby_setenv(
"LESS",
"-R +/^[A-Z].*");
1981 HANDLE h = GetStdHandle(STD_OUTPUT_HANDLE);
1983 if (!GetConsoleMode(h, &m))
return 0;
1984# ifndef ENABLE_VIRTUAL_TERMINAL_PROCESSING
1985# define ENABLE_VIRTUAL_TERMINAL_PROCESSING 0x4
1987 if (!(m & ENABLE_VIRTUAL_TERMINAL_PROCESSING))
return 0;
1990#elif !defined(HAVE_WORKING_FORK)
1991# define tty_enabled() 0
2000 return rb_enc_associate(
rb_str_dup(str), enc);
2005#if USE_YJIT || USE_ZJIT
2008env_var_truthy(
const char *name)
2010 const char *value = getenv(name);
2014 if (strcmp(value,
"1") == 0)
2016 if (strcmp(value,
"true") == 0)
2018 if (strcmp(value,
"yes") == 0)
2025rb_pid_t rb_fork_ruby(
int *status);
2028show_help(
const char *progname,
int help)
2030 int tty = isatty(1);
2033 const char *pager_env = getenv(
"RUBY_PAGER");
2034 if (!pager_env) pager_env = getenv(
"PAGER");
2035 if (pager_env && *pager_env && isatty(0)) {
2036 const char *columns_env = getenv(
"COLUMNS");
2037 if (columns_env) columns = atoi(columns_env);
2039#ifdef HAVE_WORKING_FORK
2042 rb_pid_t pid = rb_fork_ruby(NULL);
2047 else if (pid == 0) {
2065 int oldout = dup(1);
2066 int olderr = dup(2);
2067 int fd =
RFILE(port)->fptr->fd;
2068 tty = tty_enabled();
2071 usage(progname, 1, tty, columns);
2081 usage(progname, help, tty, columns);
2089 VALUE parser = rb_parser_new();
2090 const unsigned int dump = opt->dump;
2092 if (dump & DUMP_BIT(yydebug)) {
2093 rb_parser_set_yydebug(parser,
Qtrue);
2096 if ((dump & dump_exit_bits) && (dump & DUMP_BIT(opt_error_tolerant))) {
2097 rb_parser_error_tolerant(parser);
2100 if (opt->e_script) {
2101 VALUE progname = rb_progname;
2102 rb_parser_set_context(parser, 0, TRUE);
2106 rb_parser_set_options(parser, opt->do_print, opt->do_loop,
2107 opt->do_line, opt->do_split);
2108 ast_value = rb_parser_compile_string(parser, opt->script, opt->e_script, 1);
2112 int xflag = opt->xflag;
2113 f = open_load_file(opt->script_name, &xflag);
2114 opt->xflag = xflag != 0;
2115 rb_parser_set_context(parser, 0, f ==
rb_stdin);
2116 ast_value = load_file(parser, opt->script_name, f, 1, opt);
2118 ast = rb_ruby_ast_data_get(ast_value);
2119 if (!ast->body.root) {
2120 rb_ast_dispose(ast);
2129 uint8_t command_line = 0;
2135 return command_line;
2139prism_script_shebang_callback(
pm_options_t *options,
const uint8_t *source,
size_t length,
void *data)
2144 char *switches = malloc(length + 1);
2145 memcpy(switches, source, length);
2146 switches[length] =
'\0';
2148 int no_src_enc = !opt->src.enc.name;
2149 int no_ext_enc = !opt->ext.enc.name;
2150 int no_int_enc = !opt->intern.enc.name;
2152 moreswitches(switches, opt, 0);
2155 pm_options_command_line_set(options, prism_script_command_line(opt));
2157 if (no_src_enc && opt->src.enc.name) {
2158 opt->src.enc.index = opt_enc_index(opt->src.enc.name);
2161 if (no_ext_enc && opt->ext.enc.name) {
2162 opt->ext.enc.index = opt_enc_index(opt->ext.enc.name);
2164 if (no_int_enc && opt->intern.enc.name) {
2165 opt->intern.enc.index = opt_enc_index(opt->intern.enc.name);
2179 pm_options_line_set(options, 1);
2180 pm_options_main_script_set(options,
true);
2182 const bool read_stdin = (strcmp(opt->script,
"-") == 0);
2185 pm_options_encoding_set(options, rb_enc_name(rb_locale_encoding()));
2187 if (opt->src.enc.name != 0) {
2191 uint8_t command_line = prism_script_command_line(opt);
2195 pm_options_command_line_set(options, command_line);
2196 pm_options_filepath_set(options,
"-");
2197 pm_options_shebang_callback_set(options, prism_script_shebang_callback, (
void *) opt);
2200 error = pm_parse_stdin(result);
2209 else if (opt->e_script) {
2211 pm_options_command_line_set(options, command_line);
2214 result->
node.coverage_enabled = 0;
2215 error = pm_parse_string(result, opt->e_script,
rb_str_new2(
"-e"), NULL);
2218 VALUE script_name = rb_str_encode_ospath(opt->script_name);
2220 pm_options_command_line_set(options, command_line);
2221 pm_options_shebang_callback_set(options, prism_script_shebang_callback, (
void *) opt);
2223 error = pm_load_file(result, script_name,
true);
2230 error = pm_parse_file(result, opt->script_name, NULL);
2235 if (
RTEST(rb_get_coverages())) {
2236 result->
node.coverage_enabled = 1;
2243 int xflag = opt->xflag;
2244 VALUE file = open_load_file(script_name, &xflag);
2249 if ((parser->
start + offset < parser->end) && parser->
start[offset] ==
'\r') offset++;
2250 if ((parser->
start + offset < parser->end) && parser->
start[offset] ==
'\n') offset++;
2257 if (!
NIL_P(error)) {
2258 pm_parse_result_free(result);
2268 pm_prettyprint(&output_buffer, &result->
parser, result->
node.ast_node);
2270 pm_buffer_free(&output_buffer);
2277 if (OPT_BACKTRACE_LENGTH_LIMIT_VALID_P(opt)) {
2278 rb_backtrace_length_limit = opt->backtrace_length_limit;
2288 rb_define_readonly_boolean(
"$-p", opt->do_print);
2289 rb_define_readonly_boolean(
"$-l", opt->do_line);
2290 rb_define_readonly_boolean(
"$-a", opt->do_split);
2292 rb_gvar_ractor_local(
"$-p");
2293 rb_gvar_ractor_local(
"$-l");
2294 rb_gvar_ractor_local(
"$-a");
2296 if ((rb_e_script = opt->e_script) != 0) {
2298 rb_vm_register_global_object(opt->e_script);
2302 VALUE script = (opt->e_script ? opt->e_script :
Qnil);
2303 rb_exec_event_hook_script_compiled(ec, iseq, script);
2314#define dispose_result() \
2315 (result.ast ? rb_ast_dispose(result.ast) : pm_parse_result_free(&result.prism))
2324 char fbuf[MAXPATHLEN];
2325 int i = (int)proc_options(argc, argv, opt, 0);
2326 unsigned int dump = opt->dump & dump_exit_bits;
2328 const long loaded_before_enc =
RARRAY_LEN(vm->loaded_features);
2330 if (opt->dump & (DUMP_BIT(usage)|DUMP_BIT(help))) {
2331 const char *
const progname =
2332 (argc > 0 && argv && argv[0] ? argv[0] :
2333 origarg.argc > 0 && origarg.argv && origarg.argv[0] ? origarg.argv[0] :
2335 show_help(progname, (opt->dump & DUMP_BIT(help)));
2342 if (FEATURE_SET_P(opt->features, rubyopt) && (s = getenv(
"RUBYOPT"))) {
2343 moreswitches(s, opt, 1);
2346 if (opt->src.enc.name)
2350 rb_warning(
"-K is specified; it is for 1.8 compatibility and may cause odd behavior");
2352 if (!(FEATURE_SET_BITS(opt->features) & feature_jit_mask)) {
2354 if (!FEATURE_USED_P(opt->features, yjit) && env_var_truthy(
"RUBY_YJIT_ENABLE")) {
2355 FEATURE_SET(opt->features, FEATURE_BIT(yjit));
2359 if (!FEATURE_USED_P(opt->features, zjit) && env_var_truthy(
"RUBY_ZJIT_ENABLE")) {
2360 FEATURE_SET(opt->features, FEATURE_BIT(zjit));
2364 if (MULTI_BITS_P(FEATURE_SET_BITS(opt->features) & feature_jit_mask)) {
2365 rb_warn(
"Only one JIT can be enabled at the same time. Exiting");
2370 if (FEATURE_SET_P(opt->features, yjit)) {
2371 bool rb_yjit_option_disable(
void);
2372 opt->yjit = !rb_yjit_option_disable();
2376 if (FEATURE_SET_P(opt->features, zjit) && !opt->zjit) {
2377 extern void rb_zjit_prepare_options(
void);
2378 rb_zjit_prepare_options();
2383 ruby_mn_threads_params();
2384 Init_ruby_description(opt);
2386 if (opt->dump & (DUMP_BIT(version) | DUMP_BIT(version_v))) {
2388 if (opt->dump & DUMP_BIT(version))
return Qtrue;
2390 if (opt->dump & DUMP_BIT(copyright)) {
2395 if (!opt->e_script) {
2402 opt->script = argv[0];
2403 if (!opt->script || opt->script[0] ==
'\0') {
2406 else if (opt->do_search) {
2407 const char *path = getenv(
"RUBYPATH");
2411 opt->script = dln_find_file_r(argv[0], path, fbuf,
sizeof(fbuf));
2414 opt->script = dln_find_file_r(argv[0], getenv(
PATH_ENV), fbuf,
sizeof(fbuf));
2417 opt->script = argv[0];
2422 if (opt->script[0] ==
'-' && !opt->script[1]) {
2423 forbid_setid(
"program input from stdin");
2428 opt->script = RSTRING_PTR(opt->script_name);
2431 translit_char_bin(RSTRING_PTR(opt->script_name),
'\\',
'/');
2434 ruby_gc_set_params();
2438 lenc = rb_locale_encoding();
2439 rb_enc_associate(rb_progname, lenc);
2441 if (opt->ext.enc.name != 0) {
2442 opt->ext.enc.index = opt_enc_index(opt->ext.enc.name);
2444 if (opt->intern.enc.name != 0) {
2445 opt->intern.enc.index = opt_enc_index(opt->intern.enc.name);
2447 if (opt->src.enc.name != 0) {
2448 opt->src.enc.index = opt_enc_index(opt->src.enc.name);
2449 src_encoding_index = opt->src.enc.index;
2451 if (opt->ext.enc.index >= 0) {
2452 enc = rb_enc_from_index(opt->ext.enc.index);
2455 enc = IF_UTF8_PATH(uenc, lenc);
2457 rb_enc_set_default_external(rb_enc_from_encoding(enc));
2458 if (opt->intern.enc.index >= 0) {
2459 enc = rb_enc_from_index(opt->intern.enc.index);
2460 rb_enc_set_default_internal(rb_enc_from_encoding(enc));
2461 opt->intern.enc.index = -1;
2466 rb_enc_associate(opt->script_name, IF_UTF8_PATH(uenc, lenc));
2469 opt->script_name = str_conv_enc(opt->script_name, uenc, lenc);
2470 opt->script = RSTRING_PTR(opt->script_name);
2474 if (IF_UTF8_PATH(uenc != lenc, 1)) {
2476 VALUE load_path = vm->load_path;
2477 const ID id_initial_load_path_mark = INITIAL_LOAD_PATH_MARK;
2478 int modifiable = FALSE;
2480 rb_get_expanded_load_path();
2481 for (i = 0; i <
RARRAY_LEN(load_path); ++i) {
2483 int mark = rb_attr_get(path, id_initial_load_path_mark) == path;
2486 if (newpath == path)
continue;
2489 if (!(path = copy_str(path, lenc, !mark)))
continue;
2491 if (mark)
rb_ivar_set(path, id_initial_load_path_mark, path);
2503 VALUE loaded_features = vm->loaded_features;
2504 bool modified =
false;
2505 for (
long i = loaded_before_enc; i <
RARRAY_LEN(loaded_features); ++i) {
2507 if (!(path = copy_str(path, IF_UTF8_PATH(uenc, lenc),
true)))
continue;
2519 if (opt->features.mask & COMPILATION_FEATURES) {
2520 VALUE option = rb_hash_new();
2521#define SET_COMPILE_OPTION(h, o, name) \
2522 rb_hash_aset((h), ID2SYM(rb_intern_const(#name)), \
2523 RBOOL(FEATURE_SET_P(o->features, name)))
2525 if (FEATURE_SET_P(opt->features, frozen_string_literal_set)) {
2526 SET_COMPILE_OPTION(option, opt, frozen_string_literal);
2528 SET_COMPILE_OPTION(option, opt, debug_frozen_string_literal);
2529 rb_funcallv(rb_cISeq,
rb_intern_const(
"compile_option="), 1, &option);
2530#undef SET_COMPILE_OPTION
2533 opt->sflag = process_sflag(opt->sflag);
2535 if (opt->e_script) {
2537 if (opt->src.enc.index >= 0) {
2538 eenc = rb_enc_from_index(opt->src.enc.index);
2543 if (ienc) eenc = ienc;
2548 opt->e_script = str_conv_enc(opt->e_script, uenc, eenc);
2551 rb_enc_associate(opt->e_script, eenc);
2554 if (!rb_ruby_prism_p()) {
2555 ast_value = process_script(opt);
2556 if (!(result.ast = rb_ruby_ast_data_get(ast_value)))
return Qfalse;
2559 prism_script(opt, &result.prism);
2562 if ((dump & DUMP_BIT(yydebug)) && !(dump &= ~DUMP_BIT(yydebug))) {
2567 if (opt->ext.enc.index >= 0) {
2568 enc = rb_enc_from_index(opt->ext.enc.index);
2571 enc = IF_UTF8_PATH(uenc, lenc);
2573 rb_enc_set_default_external(rb_enc_from_encoding(enc));
2574 if (opt->intern.enc.index >= 0) {
2576 enc = rb_enc_from_index(opt->intern.enc.index);
2577 rb_enc_set_default_internal(rb_enc_from_encoding(enc));
2579 else if (!rb_default_internal_encoding())
2581 rb_enc_set_default_internal(
Qnil);
2582 rb_stdio_set_default_encoding();
2584 opt->sflag = process_sflag(opt->sflag);
2587 if (dump & DUMP_BIT(syntax)) {
2588 printf(
"Syntax OK\n");
2589 dump &= ~DUMP_BIT(syntax);
2596 if (dump & DUMP_BIT(parsetree)) {
2599 int comment = opt->dump & DUMP_BIT(opt_comment);
2600 tree = rb_parser_dump_tree(result.ast->body.root, comment);
2603 tree = prism_dump_tree(&result.prism);
2607 dump &= ~DUMP_BIT(parsetree);
2616 if (!opt->e_script && strcmp(opt->script,
"-")) {
2617 path = rb_realpath_internal(
Qnil, opt->script_name, 1);
2620 path = str_conv_enc(path, uenc, lenc);
2624 rb_enc_copy(path, opt->script_name);
2629 GetBindingPtr(
rb_const_get(rb_cObject, rb_intern(
"TOPLEVEL_BINDING")), toplevel_binding);
2630 const struct rb_block *base_block = toplevel_context(toplevel_binding);
2631 const rb_iseq_t *parent = vm_block_iseq(base_block);
2632 bool optimize = (opt->dump & DUMP_BIT(opt_optimize)) != 0;
2637 iseq = pm_iseq_new_main(&pm->
node, opt->script_name, path, parent, optimize, &error_state);
2639 pm_parse_result_free(pm);
2643 rb_jump_tag(error_state);
2648 iseq = rb_iseq_new_main(ast_value, opt->script_name, path, parent, optimize);
2649 rb_ast_dispose(ast);
2653 if (dump & DUMP_BIT(insns)) {
2656 dump &= ~DUMP_BIT(insns);
2657 if (!dump)
return Qtrue;
2659 if (opt->dump & dump_exit_bits)
return Qtrue;
2661 process_options_global_setup(opt, iseq);
2667warn_cr_in_shebang(
const char *str,
long len)
2669 if (
len > 1 && str[
len-1] ==
'\n' && str[
len-2] ==
'\r') {
2670 rb_warn(
"shebang line ending with \\r may cause problems");
2674#define warn_cr_in_shebang(str, len) (void)0
2677void rb_reset_argf_lineno(
long n);
2687void rb_set_script_lines_for(
VALUE vparser,
VALUE path);
2690load_file_internal(
VALUE argp_v)
2693 VALUE parser = argp->parser;
2694 VALUE orig_fname = argp->fname;
2695 int script = argp->script;
2703 CONST_ID(set_encoding,
"set_encoding");
2709 int no_src_enc = !opt->src.enc.name;
2710 int no_ext_enc = !opt->ext.enc.name;
2711 int no_int_enc = !opt->intern.enc.name;
2713 enc = rb_ascii8bit_encoding();
2714 rb_funcall(f, set_encoding, 1, rb_enc_from_encoding(enc));
2722 if (
len > 2 && str[0] ==
'#' && str[1] ==
'!') {
2723 if (line_start == 1) warn_cr_in_shebang(str,
len);
2737 warn_cr_in_shebang(str,
len);
2740 goto search_shebang;
2745 if (*str ==
'\n') *str-- =
'\0';
2746 if (*str ==
'\r') *str-- =
'\0';
2748 if ((p = strstr(p,
" -")) != 0) {
2750 moreswitches(p + 1, opt, 0);
2756 else if (!
NIL_P(c)) {
2760 if (no_src_enc && opt->src.enc.name) {
2761 opt->src.enc.index = opt_enc_index(opt->src.enc.name);
2762 src_encoding_index = opt->src.enc.index;
2764 if (no_ext_enc && opt->ext.enc.name) {
2765 opt->ext.enc.index = opt_enc_index(opt->ext.enc.name);
2767 if (no_int_enc && opt->intern.enc.name) {
2768 opt->intern.enc.index = opt_enc_index(opt->intern.enc.name);
2771 else if (!
NIL_P(c)) {
2777 rb_reset_argf_lineno(0);
2780 if (opt->src.enc.index >= 0) {
2781 enc = rb_enc_from_index(opt->src.enc.index);
2784 enc = rb_locale_encoding();
2787 enc = rb_utf8_encoding();
2789 rb_parser_set_options(parser, opt->do_print, opt->do_loop,
2790 opt->do_line, opt->do_split);
2792 rb_set_script_lines_for(parser, orig_fname);
2796 rb_enc_associate(f, enc);
2797 return rb_parser_compile_string_path(parser, orig_fname, f, line_start);
2800 ast_value = rb_parser_compile_file_path(parser, orig_fname, f, line_start);
2801 rb_funcall(f, set_encoding, 1, rb_parser_encoding(parser));
2802 if (script && rb_parser_end_seen_p(parser)) {
2823disable_nonblock(
int fd)
2825#if defined(HAVE_FCNTL) && defined(F_SETFL)
2826 if (fcntl(fd, F_SETFL, 0) < 0) {
2827 const int e =
errno;
2830 if (e == ENOTSUP)
return 0;
2832# if defined B_UNSUPPORTED
2833 if (e == B_UNSUPPORTED)
return 0;
2842open_load_file(
VALUE fname_v,
int *xflag)
2844 const char *fname = (fname_v = rb_str_encode_ospath(fname_v),
2846 long flen = RSTRING_LEN(fname_v);
2850 if (flen == 1 && fname[0] ==
'-') {
2857 const int MODE_TO_LOAD = O_RDONLY | (
2858#if defined O_NONBLOCK && HAVE_FCNTL
2860 !(O_NONBLOCK & O_ACCMODE) ? O_NONBLOCK :
2862#if defined O_NDELAY && HAVE_FCNTL
2863 !(O_NDELAY & O_ACCMODE) ? O_NDELAY :
2866 int mode = MODE_TO_LOAD;
2867#if defined DOSISH || defined __CYGWIN__
2868# define isdirsep(x) ((x) == '/' || (x) == '\\')
2870 static const char exeext[] =
".exe";
2871 enum {extlen =
sizeof(exeext)-1};
2872 if (flen > extlen && !isdirsep(fname[flen-extlen-1]) &&
2873 STRNCASECMP(fname+flen-extlen, exeext, extlen) == 0) {
2882 if (!rb_gc_for_fd(e)) {
2883 rb_load_fail(fname_v, strerror(e));
2886 rb_load_fail(fname_v, strerror(
errno));
2891 if (MODE_TO_LOAD != O_RDONLY && (e = disable_nonblock(fd)) != 0) {
2893 rb_load_fail(fname_v, strerror(e));
2896 e = ruby_is_fd_loadable(fd);
2900 rb_load_fail(fname_v, strerror(e));
2916restore_load_file(
VALUE arg)
2931 arg.parser = parser;
2933 arg.script = script;
2937 restore_load_file, (
VALUE)&arg);
2951 ast_value = rb_parser_load_file(rb_parser_new(), fname_v);
2952 return (
void *)rb_ruby_ast_data_get(ast_value);
2956rb_parser_load_file(
VALUE parser,
VALUE fname_v)
2960 VALUE f = open_load_file(fname_v, &xflag);
2961 cmdline_options_init(&opt)->xflag = xflag != 0;
2962 return load_file(parser, fname_v, f, 0, &opt);
2977proc_argv0(
VALUE process)
2979 return rb_orig_progname;
3004 return ruby_setproctitle(title);
3008ruby_setproctitle(
VALUE title)
3018 if (origarg.argv == 0)
3025external_str_new_cstr(
const char *p)
3029 str = str_conv_enc(str, NULL, rb_default_external_encoding());
3037set_progname(
VALUE name)
3039 rb_orig_progname = rb_progname = name;
3040 rb_vm_set_progname(rb_progname);
3064 rb_uid_t uid = getuid();
3065 rb_uid_t euid = geteuid();
3066 rb_gid_t gid = getgid();
3067 rb_gid_t egid = getegid();
3069 if (uid != euid) opt->setids |= 1;
3070 if (egid != gid) opt->setids |= 2;
3077 if (opt->setids & 1)
3079 if (opt->setids & 2)
3084verbose_getter(
ID id,
VALUE *ptr)
3086 return *rb_ruby_verbose_ptr();
3092 *rb_ruby_verbose_ptr() =
RTEST(val) ?
Qtrue : val;
3096opt_W_getter(
ID id,
VALUE *dmy)
3098 VALUE v = *rb_ruby_verbose_ptr();
3113debug_getter(
ID id,
VALUE *dmy)
3115 return *rb_ruby_debug_ptr();
3121 *rb_ruby_debug_ptr() = val;
3134 rb_gvar_ractor_local(
"$VERBOSE");
3135 rb_gvar_ractor_local(
"$-v");
3136 rb_gvar_ractor_local(
"$-w");
3137 rb_gvar_ractor_local(
"$-W");
3138 rb_gvar_ractor_local(
"$DEBUG");
3139 rb_gvar_ractor_local(
"$-d");
3163 for (i = 0; i < argc; i++) {
3164 VALUE arg = external_str_new_cstr(argv[i]);
3176 const char *script_name = (argc > 0 && argv[0]) ? argv[0] :
ruby_engine;
3178 if (!origarg.argv || origarg.argc <= 0) {
3179 origarg.argc = argc;
3180 origarg.argv = argv;
3182 set_progname(external_str_new_cstr(script_name));
3184 rb_vm_register_global_object(
rb_argv0);
3186#ifndef HAVE_SETPROCTITLE
3187 ruby_init_setproctitle(argc, argv);
3190 if (getenv(
"RUBY_FREE_AT_EXIT")) {
3191 rb_free_at_exit =
true;
3195 iseq = process_options(argc, argv, cmdline_options_init(&opt));
3197 if (opt.crash_report && *opt.crash_report) {
3198 void ruby_set_crash_report(
const char *
template);
3199 ruby_set_crash_report(opt.crash_report);
3202 return (
void*)(
struct RData*)iseq;
3206fill_standard_fds(
void)
3208 int f0, f1, f2, fds[2];
3210 f0 = fstat(0, &buf) == -1 &&
errno == EBADF;
3211 f1 = fstat(1, &buf) == -1 &&
errno == EBADF;
3212 f2 = fstat(2, &buf) == -1 &&
errno == EBADF;
3214 if (pipe(fds) == 0) {
3223 if (pipe(fds) == 0) {
3225 if (f1 && fds[1] != 1)
3227 if (f2 && fds[1] != 2)
3229 if (fds[1] != 1 && fds[1] != 2)
3239 rb_w32_sysinit(argc, argv);
3241 if (*argc >= 0 && *argv) {
3242 origarg.argc = *argc;
3243 origarg.argv = *argv;
3245 fill_standard_fds();
3248#ifdef RUBY_ASAN_ENABLED
3249RUBY_SYMBOL_EXPORT_BEGIN
3250const char ruby_asan_default_options[] =
"use_sigaltstack=0:detect_leaks=0";
3251RUBY_SYMBOL_EXPORT_END
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
#define rb_define_module_function(klass, mid, func, arity)
Defines klass#mid and makes it a module function.
#define rb_define_global_function(mid, func, arity)
Defines rb_mKernel #mid.
#define RUBY_EXTERN
Declaration of externally visible global variables.
#define PATH_SEP_CHAR
Identical to PATH_SEP, except it is of type char.
VALUE rb_define_module(const char *name)
Defines a top-level module.
#define rb_str_new2
Old name of rb_str_new_cstr.
#define ISSPACE
Old name of rb_isspace.
#define T_STRING
Old name of RUBY_T_STRING.
#define Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
#define rb_str_cat2
Old name of rb_str_cat_cstr.
#define UNREACHABLE
Old name of RBIMPL_UNREACHABLE.
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
#define ECONV_UNDEF_REPLACE
Old name of RUBY_ECONV_UNDEF_REPLACE.
#define UNREACHABLE_RETURN
Old name of RBIMPL_UNREACHABLE_RETURN.
#define SIZET2NUM
Old name of RB_SIZE2NUM.
#define ENCODING_GET(obj)
Old name of RB_ENCODING_GET.
#define ECONV_INVALID_REPLACE
Old name of RUBY_ECONV_INVALID_REPLACE.
#define ASSUME
Old name of RBIMPL_ASSUME.
#define ALLOC_N
Old name of RB_ALLOC_N.
#define STRNCASECMP
Old name of st_locale_insensitive_strncasecmp.
#define TOLOWER
Old name of rb_tolower.
#define Qtrue
Old name of RUBY_Qtrue.
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define ENC_CODERANGE_BROKEN
Old name of RUBY_ENC_CODERANGE_BROKEN.
#define NIL_P
Old name of RB_NIL_P.
#define scan_oct(s, l, e)
Old name of ruby_scan_oct.
#define CONST_ID
Old name of RUBY_CONST_ID.
#define ISALNUM
Old name of rb_isalnum.
#define rb_str_new4
Old name of rb_str_new_frozen.
void ruby_script(const char *name)
Sets the current script name to this value.
void ruby_set_argv(int argc, char **argv)
Sets argv that ruby understands.
void ruby_set_script_name(VALUE name)
Sets the current script name to this value.
void ruby_init_loadpath(void)
Sets up $LOAD_PATH.
void * ruby_process_options(int argc, char **argv)
Identical to ruby_options(), except it raises ruby-level exceptions on failure.
void ruby_prog_init(void)
Defines built-in variables.
void ruby_incpush(const char *path)
Appends the given path to the end of the load path.
#define ruby_debug
This variable controls whether the interpreter is in debug mode.
void rb_category_warn(rb_warning_category_t category, const char *fmt,...)
Identical to rb_category_warning(), except it reports unless $VERBOSE is nil.
void rb_exc_raise(VALUE mesg)
Raises an exception in the current thread.
#define ruby_verbose
This variable controls whether the interpreter is in debug mode.
VALUE rb_eTypeError
TypeError exception.
VALUE rb_eNameError
NameError exception.
VALUE rb_eRuntimeError
RuntimeError exception.
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
VALUE rb_exc_new_str(VALUE etype, VALUE str)
Identical to rb_exc_new_cstr(), except it takes a Ruby's string instead of C's.
void rb_enc_raise(rb_encoding *enc, VALUE exc, const char *fmt,...)
Identical to rb_raise(), except it additionally takes an encoding.
void rb_loaderror(const char *fmt,...)
Raises an instance of rb_eLoadError.
VALUE rb_eSecurityError
SecurityError exception.
void rb_warning(const char *fmt,...)
Issues a warning.
@ RB_WARN_CATEGORY_STRICT_UNUSED_BLOCK
Warning is for checking unused block strictly.
@ RB_WARN_CATEGORY_DEPRECATED
Warning is for deprecated features.
@ RB_WARN_CATEGORY_EXPERIMENTAL
Warning is for experimental features.
@ RB_WARN_CATEGORY_PERFORMANCE
Warning is for performance issues (not enabled by -w).
VALUE rb_mProcess
Process module.
VALUE rb_class_new_instance(int argc, const VALUE *argv, VALUE klass)
Allocates, then initialises an instance of the given class.
VALUE rb_stdin
STDIN constant.
VALUE rb_obj_freeze(VALUE obj)
Just calls rb_obj_freeze_inline() inside.
VALUE rb_stdout
STDOUT constant.
VALUE rb_cString
String class.
void ruby_show_copyright(void)
Prints the copyright notice of the CRuby interpreter to stdout.
void ruby_sysinit(int *argc, char ***argv)
Initializes the process for libruby.
void ruby_show_version(void)
Prints the version information of the CRuby interpreter to stdout.
VALUE rb_str_conv_enc(VALUE str, rb_encoding *from, rb_encoding *to)
Encoding conversion main routine.
VALUE rb_str_conv_enc_opts(VALUE str, rb_encoding *from, rb_encoding *to, int ecflags, VALUE ecopts)
Identical to rb_str_conv_enc(), except it additionally takes IO encoder options.
VALUE rb_enc_interned_str(const char *ptr, long len, rb_encoding *enc)
Identical to rb_enc_str_new(), except it returns a "f"string.
VALUE rb_funcall_passing_block(VALUE recv, ID mid, int argc, const VALUE *argv)
Identical to rb_funcallv_public(), except you can pass the passed block.
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
VALUE rb_ary_shift(VALUE ary)
Destructively deletes an element from the beginning of the passed array and returns what was deleted.
void rb_ary_modify(VALUE ary)
Declares that the array is about to be modified.
VALUE rb_ary_replace(VALUE copy, VALUE orig)
Replaces the contents of the former object with the contents of the latter.
VALUE rb_ary_hidden_new(long capa)
Allocates a hidden (no class) empty array.
VALUE rb_ary_clear(VALUE ary)
Destructively removes everything form an array.
VALUE rb_ary_push(VALUE ary, VALUE elem)
Special case of rb_ary_cat() that it adds only one element.
VALUE rb_io_gets(VALUE io)
Reads a "line" from the given IO.
VALUE rb_io_ungetbyte(VALUE io, VALUE b)
Identical to rb_io_ungetc(), except it doesn't take the encoding of the passed IO into account.
VALUE rb_io_getbyte(VALUE io)
Reads a byte from the given IO.
VALUE rb_io_fdopen(int fd, int flags, const char *path)
Creates an IO instance whose backend is the given file descriptor.
void rb_update_max_fd(int fd)
Informs the interpreter that the passed fd can be the max.
int rb_cloexec_open(const char *pathname, int flags, mode_t mode)
Opens a file that closes on exec.
VALUE rb_fs
The field separator character for inputs, or the $;.
VALUE rb_output_rs
The record separator character for outputs, or the $\.
int rb_pipe(int *pipes)
This is an rb_cloexec_pipe() + rb_update_max_fd() combo.
VALUE rb_io_close(VALUE io)
Closes the IO.
void rb_lastline_set(VALUE str)
Updates $_.
VALUE rb_lastline_get(void)
Queries the last line, or the $_.
rb_pid_t rb_waitpid(rb_pid_t pid, int *status, int flags)
Waits for a process, with releasing GVL.
VALUE rb_f_exec(int argc, const VALUE *argv)
Replaces the current process by running the given external command.
VALUE rb_reg_new(const char *src, long len, int opts)
Creates a new Regular expression.
#define rb_utf8_str_new_cstr(str)
Identical to rb_str_new_cstr, except it generates a string of "UTF-8" encoding.
#define rb_str_new_lit(str)
Identical to rb_str_new_static(), except it cannot take string variables.
VALUE rb_str_tmp_new(long len)
Allocates a "temporary" string.
VALUE rb_str_subseq(VALUE str, long beg, long len)
Identical to rb_str_substr(), except the numbers are interpreted as byte offsets instead of character...
#define rb_str_new(str, len)
Allocates an instance of rb_cString.
VALUE rb_str_new_frozen(VALUE str)
Creates a frozen copy of the string, if necessary.
VALUE rb_str_dup(VALUE str)
Duplicates a string.
VALUE rb_str_cat(VALUE dst, const char *src, long srclen)
Destructively appends the passed contents to the string.
#define rb_external_str_new_cstr(str)
Identical to rb_str_new_cstr, except it generates a string of "default external" encoding.
void rb_str_set_len(VALUE str, long len)
Overwrites the length of the string.
#define rb_strlen_lit(str)
Length of a string literal.
VALUE rb_str_freeze(VALUE str)
This is the implementation of String#freeze.
#define rb_str_cat_cstr(buf, str)
Identical to rb_str_cat(), except it assumes the passed pointer is a pointer to a C string.
#define rb_utf8_str_new(str, len)
Identical to rb_str_new, except it generates a string of "UTF-8" encoding.
void rb_str_modify_expand(VALUE str, long capa)
Identical to rb_str_modify(), except it additionally expands the capacity of the receiver.
#define rb_str_new_cstr(str)
Identical to rb_str_new, except it assumes the passed pointer is a pointer to a C string.
VALUE rb_const_get(VALUE space, ID name)
Identical to rb_const_defined(), except it returns the actual defined value.
VALUE rb_ivar_set(VALUE obj, ID name, VALUE val)
Identical to rb_iv_set(), except it accepts the name as an ID instead of a C string.
static ID rb_intern_const(const char *str)
This is a "tiny optimisation" over rb_intern().
void rb_define_global_const(const char *name, VALUE val)
Identical to rb_define_const(), except it defines that of "global", i.e.
rb_gvar_setter_t rb_gvar_readonly_setter
This function just raises rb_eNameError.
VALUE rb_gv_set(const char *name, VALUE val)
Assigns to a global variable.
@ RUBY_IO_READABLE
IO::READABLE
VALUE rb_io_wait(VALUE io, VALUE events, VALUE timeout)
Blocks until the passed IO is ready for the passed events.
int len
Length of the buffer.
void ruby_each_words(const char *str, void(*func)(const char *word, int len, void *argv), void *argv)
Scans the passed string, with calling the callback function every time it encounters a "word".
const char ruby_engine[]
This is just "ruby" for us.
const int ruby_patchlevel
This is a monotonic increasing integer that describes specific "patch" level.
#define RB_INT2NUM
Just another name of rb_int2num_inline.
#define MEMZERO(p, type, n)
Handy macro to erase a region of memory.
#define MEMMOVE(p1, p2, type, n)
Handy macro to call memmove.
void rb_define_hooked_variable(const char *q, VALUE *w, type *e, void_type *r)
Define a function-backended global variable.
VALUE type(ANYARGS)
ANYARGS-ed function type.
void rb_define_virtual_variable(const char *q, type *w, void_type *e)
Define a function-backended global variable.
VALUE rb_ensure(type *q, VALUE w, type *e, VALUE r)
An equivalent of ensure clause.
static const uint8_t PM_OPTIONS_COMMAND_LINE_E
A bit representing whether or not the command line -e option was set.
static const uint8_t PM_OPTIONS_COMMAND_LINE_L
A bit representing whether or not the command line -l option was set.
static const uint8_t PM_OPTIONS_COMMAND_LINE_A
A bit representing whether or not the command line -a option was set.
static const uint8_t PM_OPTIONS_COMMAND_LINE_N
A bit representing whether or not the command line -n option was set.
static const uint8_t PM_OPTIONS_COMMAND_LINE_X
A bit representing whether or not the command line -x option was set.
static const uint8_t PM_OPTIONS_COMMAND_LINE_P
A bit representing whether or not the command line -p option was set.
#define RARRAY_LEN
Just another name of rb_array_len.
static void RARRAY_ASET(VALUE ary, long i, VALUE v)
Assigns an object in an array.
#define RARRAY_AREF(a, i)
#define RARRAY_CONST_PTR
Just another name of rb_array_const_ptr.
#define RFILE(obj)
Convenient casting macro.
#define StringValuePtr(v)
Identical to StringValue, except it returns a char*.
static int RSTRING_LENINT(VALUE str)
Identical to RSTRING_LEN(), except it differs for the return type.
#define RSTRING_GETMEM(str, ptrvar, lenvar)
Convenient macro to obtain the contents and length at once.
#define StringValueCStr(v)
Identical to StringValuePtr, except it additionally checks for the contents for viability as a C stri...
VALUE rb_argv0
The value of $0 at process bootup.
void * rb_load_file_str(VALUE file)
Identical to rb_load_file(), except it takes the argument as a Ruby's string instead of C's.
void * rb_load_file(const char *file)
Loads the given file.
#define rb_argv
Just another name of rb_get_argv.
const char * rb_obj_classname(VALUE obj)
Queries the name of the class of the passed object.
#define errno
Ractor-aware version of errno.
#define RTEST
This is an old name of RB_TEST.
#define _(args)
This was a transition path from K&R to ANSI.
A pm_buffer_t is a simple memory buffer that stores data in a contiguous block of memory.
size_t length
The length of the buffer in bytes.
char * value
A pointer to the start of the buffer.
const uint8_t * start
A pointer to the start location of the range in the source.
The options that can be passed to the parser.
pm_scope_node_t node
The resulting scope node that will hold the generated AST.
pm_parser_t parser
The parser that will do the actual parsing.
pm_options_t options
The options that will be passed to the parser.
This struct represents the overall parser.
pm_location_t data_loc
An optional location that represents the location of the END marker and the rest of the content of th...
const uint8_t * start
The pointer to the start of the source.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.