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);
305usage(
const char *name,
int help,
int highlight,
int columns)
307#define M(shortopt, longopt, desc) RUBY_OPT_MESSAGE(shortopt, longopt, desc)
310# define DEFAULT_JIT_OPTION "--yjit"
312# define DEFAULT_JIT_OPTION "--zjit"
318 M(
"-0[octal]",
"",
"Set input record separator ($/):\n"
319 "-0 for \\0; -00 for paragraph mode; -0777 for slurp mode."),
320 M(
"-a",
"",
"Split each input line ($_) into fields ($F)."),
321 M(
"-c",
"",
"Check syntax (no execution)."),
322 M(
"-Cdirpath",
"",
"Execute program in specified directory."),
323 M(
"-d",
", --debug",
"Set debugging flag ($DEBUG) to true."),
324 M(
"-e 'code'",
"",
"Execute given Ruby code; multiple -e allowed."),
325 M(
"-Eex[:in]",
", --encoding=ex[:in]",
"Set default external and internal encodings."),
326 M(
"-Fpattern",
"",
"Set input field separator ($;); used with -a."),
327 M(
"-i[extension]",
"",
"Set ARGF in-place mode;\n"
328 "create backup files with given extension."),
329 M(
"-Idirpath",
"",
"Prepend specified directory to load paths ($LOAD_PATH);\n"
330 "relative paths are expanded; multiple -I are allowed."),
331 M(
"-l",
"",
"Set output record separator ($\\) to $/;\n"
332 "used for line-oriented output."),
333 M(
"-n",
"",
"Run program in gets loop."),
334 M(
"-p",
"",
"Like -n, with printing added."),
335 M(
"-rlibrary",
"",
"Require the given library."),
336 M(
"-s",
"",
"Define global variables using switches following program path."),
337 M(
"-S",
"",
"Search directories found in the PATH environment variable."),
338 M(
"-v",
"",
"Print version; set $VERBOSE to true."),
339 M(
"-w",
"",
"Synonym for -W1."),
340 M(
"-W[level=2|:category]",
"",
"Set warning flag ($-W):\n"
341 "0 for silent; 1 for moderate; 2 for verbose."),
342 M(
"-x[dirpath]",
"",
"Execute Ruby code starting from a #!ruby line."),
343#if USE_YJIT || USE_ZJIT
344 M(
"--jit",
"",
"Enable the default JIT for the build; same as " DEFAULT_JIT_OPTION
"."),
347 M(
"--yjit",
"",
"Enable in-process JIT compiler."),
350 M(
"--zjit",
"",
"Enable method-based JIT compiler."),
352 M(
"-h",
"",
"Print this help message; use --help for longer message."),
354 STATIC_ASSERT(usage_msg_size, numberof(usage_msg) < 26);
357 M(
"--backtrace-limit=num",
"",
"Set backtrace limit."),
358 M(
"--copyright",
"",
"Print Ruby copyright."),
359 M(
"--crash-report=template",
"",
"Set template for crash report file."),
360 M(
"--disable=features",
"",
"Disable features; see list below."),
361 M(
"--dump=items",
"",
"Dump items; see list below."),
362 M(
"--enable=features",
"",
"Enable features; see list below."),
363 M(
"--external-encoding=encoding",
"",
"Set default external encoding."),
364 M(
"--help",
"",
"Print long help message; use -h for short message."),
365 M(
"--internal-encoding=encoding",
"",
"Set default internal encoding."),
366 M(
"--parser=parser",
"",
"Set Ruby parser: parse.y or prism."),
367 M(
"--verbose",
"",
"Set $VERBOSE to true; ignore input from $stdin."),
368 M(
"--version",
"",
"Print Ruby version."),
369 M(
"-y",
", --yydebug",
"Print parser log; backward compatibility not guaranteed."),
372 M(
"insns",
"",
"Instruction sequences."),
373 M(
"yydebug",
"",
"yydebug of yacc parser generator."),
374 M(
"parsetree",
"",
"Abstract syntax tree (AST)."),
375 M(
"-optimize",
"",
"Disable optimization (affects insns)."),
376 M(
"+error-tolerant",
"",
"Error-tolerant parsing (affects yydebug, parsetree)."),
377 M(
"+comment",
"",
"Add comments to AST (affects parsetree with --parser=parse.y)."),
380 M(
"gems",
"",
"Rubygems (only for debugging, default: "DEFAULT_RUBYGEMS_ENABLED
")."),
381 M(
"error_highlight",
"",
"error_highlight (default: "DEFAULT_RUBYGEMS_ENABLED
")."),
382 M(
"did_you_mean",
"",
"did_you_mean (default: "DEFAULT_RUBYGEMS_ENABLED
")."),
383 M(
"syntax_suggest",
"",
"syntax_suggest (default: "DEFAULT_RUBYGEMS_ENABLED
")."),
384 M(
"rubyopt",
"",
"RUBYOPT environment variable (default: enabled)."),
385 M(
"frozen-string-literal",
"",
"Freeze all string literals (default: disabled)."),
387 M(
"yjit",
"",
"In-process JIT compiler (default: disabled)."),
390 M(
"zjit",
"",
"Method-based JIT compiler (default: disabled)."),
394 M(
"deprecated",
"",
"Deprecated features."),
395 M(
"experimental",
"",
"Experimental features."),
396 M(
"performance",
"",
"Performance issues."),
397 M(
"strict_unused_block",
"",
"Warning unused block strictly"),
400 const char *sb = highlight ? esc_standout+1 : esc_none;
401 const char *se = highlight ? esc_reset : esc_none;
402 const int num = numberof(usage_msg) - (help ? 1 : 0);
403 unsigned int w = (columns > 80 ? (columns - 79) / 2 : 0) + 16;
404#define SHOW(m) show_usage_line(&(m), help, highlight, w, columns)
406 printf(
"%sUsage:%s %s [options] [--] [filepath] [arguments]\n", sb, se, name);
407 for (i = 0; i < num; ++i)
412 if (highlight) sb = esc_standout;
414 for (i = 0; i < numberof(help_msg); ++i)
416 printf(
"%s""Dump List:%s\n", sb, se);
417 for (i = 0; i < numberof(dumps); ++i)
419 printf(
"%s""Features:%s\n", sb, se);
420 for (i = 0; i < numberof(features); ++i)
422 printf(
"%s""Warning categories:%s\n", sb, se);
423 for (i = 0; i < numberof(warn_categories); ++i)
424 SHOW(warn_categories[i]);
426 printf(
"%s""YJIT options:%s\n", sb, se);
427 rb_yjit_show_usage(help, highlight, w, columns);
430 printf(
"%s""ZJIT options:%s\n", sb, se);
431 extern void rb_zjit_show_usage(
int help,
int highlight,
unsigned int width,
int columns);
432 rb_zjit_show_usage(help, highlight, w, columns);
436#define rubylib_path_new rb_str_new
439ruby_push_include(
const char *path,
VALUE (*filter)(
VALUE))
443 VALUE load_path = GET_VM()->load_path;
445 char rubylib[FILENAME_MAX];
447# define is_path_sep(c) ((c) == sep || (c) == ';')
449# define is_path_sep(c) ((c) == sep)
452 if (path == 0)
return;
456 while (is_path_sep(*p))
459 for (s = p; *s && !is_path_sep(*s); s = CharNext(s));
467 p = RSTRING_PTR(buf);
470 rb_str_resize(buf,
len);
471 p = strncpy(RSTRING_PTR(buf), p,
len);
474#ifdef HAVE_CYGWIN_CONV_PATH
475#define CONV_TO_POSIX_PATH(p, lib) \
476 cygwin_conv_path(CCP_WIN_A_TO_POSIX|CCP_RELATIVE, (p), (lib), sizeof(lib))
478# error no cygwin_conv_path
480 if (CONV_TO_POSIX_PATH(p, rubylib) == 0) {
491identical_path(
VALUE path)
497locale_path(
VALUE path)
499 rb_enc_associate(path, rb_locale_encoding());
506 ruby_push_include(path, locale_path);
510expand_include_path(
VALUE path)
512 char *p = RSTRING_PTR(path);
515 if (*p ==
'.' && p[1] ==
'/')
517 return rb_file_expand_path(path,
Qnil);
521ruby_incpush_expand(
const char *path)
523 ruby_push_include(path, expand_include_path);
527#if defined _WIN32 || defined __CYGWIN__
528static HMODULE libruby;
531DllMain(HINSTANCE dll, DWORD reason, LPVOID reserved)
533 if (reason == DLL_PROCESS_ATTACH)
539rb_libruby_handle(
void)
545translit_char_bin(
char *p,
int from,
int to)
548 if ((
unsigned char)*p == from)
557# define chdir rb_w32_uchdir
565# define IF_UTF8_PATH(t, f) t
567# define IF_UTF8_PATH(t, f) f
579# define str_conv_enc(str, from, to) (str)
584#if defined(LOAD_RELATIVE)
586runtime_libruby_path(
void)
588#if defined _WIN32 || defined __CYGWIN__
596 while (wlibpath = (WCHAR *)RSTRING_PTR(wsopath),
597 ret = GetModuleFileNameW(libruby, wlibpath,
len),
603 if (!ret || ret >
len) rb_fatal(
"failed to get module file name");
604#if defined __CYGWIN__
606 const int win_to_posix = CCP_WIN_W_TO_POSIX | CCP_RELATIVE;
607 size_t newsize = cygwin_conv_path(win_to_posix, wlibpath, 0, 0);
608 if (!newsize) rb_fatal(
"failed to convert module path to cygwin");
610 libpath = RSTRING_PTR(path);
611 if (cygwin_conv_path(win_to_posix, wlibpath, libpath, newsize)) {
612 rb_str_resize(path, 0);
618 for (
len = ret, i = 0; i <
len; ++i) {
619 if (wlibpath[i] == L
'\\') {
625 len = WideCharToMultiByte(CP_UTF8, 0, wlibpath, ret, NULL, 0, NULL, NULL);
627 libpath = RSTRING_PTR(path);
628 WideCharToMultiByte(CP_UTF8, 0, wlibpath, ret, libpath,
len, NULL, NULL);
630 rb_str_resize(wsopath, 0);
632#elif defined(HAVE_DLADDR)
635 const void* addr = (
void *)(
VALUE)expand_include_path;
637 if (!dladdr((
void *)addr, &dli)) {
641 else if (origarg.argc > 0 && origarg.argv && dli.dli_fname == origarg.argv[0]) {
643 path = rb_readlink(fname, NULL);
648 path = rb_realpath_internal(
Qnil, fname, 1);
650 rb_str_resize(fname, 0);
653# error relative load path is not supported on this platform.
658#define INITIAL_LOAD_PATH_MARK rb_intern_const("@gem_prelude_index")
660VALUE ruby_archlibdir_path, ruby_prefix_path;
665 VALUE load_path, archlibdir = 0;
666 ID id_initial_load_path_mark;
667 const char *paths = ruby_initial_load_paths;
669#if defined LOAD_RELATIVE
670#if !defined ENABLE_MULTIARCH
671# define RUBY_ARCH_PATH ""
672#elif defined RUBY_ARCH
673# define RUBY_ARCH_PATH "/"RUBY_ARCH
675# define RUBY_ARCH_PATH "/"RUBY_PLATFORM
682 sopath = runtime_libruby_path();
683 libpath = RSTRING_PTR(sopath);
685 p = strrchr(libpath,
'/');
687 static const char libdir[] =
"/"
688#ifdef LIBDIR_BASENAME
694 const ptrdiff_t libdir_len = (ptrdiff_t)
sizeof(libdir)
696 static const char bindir[] =
"/bin";
697 const ptrdiff_t bindir_len = (ptrdiff_t)
sizeof(bindir) - 1;
699 const char *p2 = NULL;
701#ifdef ENABLE_MULTIARCH
704 if (p - libpath >= bindir_len && !
STRNCASECMP(p - bindir_len, bindir, bindir_len)) {
710 else if (p - libpath >= libdir_len && !strncmp(p - libdir_len, libdir, libdir_len)) {
711 archlibdir =
rb_str_subseq(sopath, 0, (p2 ? p2 : p) - libpath);
715#ifdef ENABLE_MULTIARCH
721 p = rb_enc_path_last_separator(libpath, p, rb_ascii8bit_encoding());
722 if (p)
goto multiarch;
726 baselen = p - libpath;
731 rb_str_resize(sopath, baselen);
732 libpath = RSTRING_PTR(sopath);
733#define PREFIX_PATH() sopath
734#define BASEPATH() rb_str_buf_cat(rb_str_buf_new(baselen+len), libpath, baselen)
735#define RUBY_RELATIVE(path, len) rb_str_buf_cat(BASEPATH(), (path), (len))
737 const size_t exec_prefix_len = strlen(ruby_exec_prefix);
738#define RUBY_RELATIVE(path, len) rubylib_path_new((path), (len))
739#define PREFIX_PATH() RUBY_RELATIVE(ruby_exec_prefix, exec_prefix_len)
741 rb_gc_register_address(&ruby_prefix_path);
742 ruby_prefix_path = PREFIX_PATH();
744 if (!archlibdir) archlibdir = ruby_prefix_path;
745 rb_gc_register_address(&ruby_archlibdir_path);
746 ruby_archlibdir_path = archlibdir;
748 load_path = GET_VM()->load_path;
750 ruby_push_include(getenv(
"RUBYLIB"), identical_path);
752 id_initial_load_path_mark = INITIAL_LOAD_PATH_MARK;
754 size_t len = strlen(paths);
755 VALUE path = RUBY_RELATIVE(paths,
len);
756 rb_ivar_set(path, id_initial_load_path_mark, path);
764add_modules(
VALUE *req_list,
const char *mod)
766 VALUE list = *req_list;
777require_libraries(
VALUE *req_list)
779 VALUE list = *req_list;
780 VALUE self = rb_vm_top_self();
782 rb_encoding *extenc = rb_default_external_encoding();
787 rb_enc_associate(feature, extenc);
790 rb_funcallv(self, require, 1, &feature);
802process_sflag(
int sflag)
820 if (s[1] ==
'-' && s[2] ==
'\0')
825 for (p = s + 1; *p; p++) {
834 else if (*p !=
'_' && !
ISALNUM(*p)) {
837 rb_str_new2(
"invalid name for global variable - ");
838 if (!(p = strchr(p,
'='))) {
844 name_error[1] = args[-1];
850 for (p = s + 1; *p; ++p) {
874 VALUE argstr, argary;
877 VALUE src_enc_name = opt->src.enc.name;
878 VALUE ext_enc_name = opt->ext.enc.name;
879 VALUE int_enc_name = opt->intern.enc.name;
882 long backtrace_length_limit = opt->backtrace_length_limit;
883 const char *crash_report = opt->crash_report;
888 opt->src.enc.name = opt->ext.enc.name = opt->intern.enc.name = 0;
890 const int hyphen = *s !=
'-';
894 p = RSTRING_PTR(argstr);
895 if (hyphen) *p =
'-';
896 memcpy(p + hyphen, s,
len + 1);
902 while (*p && !
ISSPACE(*p)) ++p;
907 argc = RSTRING_LEN(argary) /
sizeof(ap);
910 argv = ptr =
ALLOC_N(
char *, argc);
911 MEMMOVE(argv, RSTRING_PTR(argary),
char *, argc);
913 while ((i = proc_options(argc, argv, opt, envopt)) > 1 && envopt && (argc -= i) > 0) {
925 opt->src.enc.name = src_enc_name;
928 opt->ext.enc.name = ext_enc_name;
931 opt->intern.enc.name = int_enc_name;
933 FEATURE_SET_RESTORE(opt->features, feat);
934 FEATURE_SET_RESTORE(opt->warn, warn);
935 if (BACKTRACE_LENGTH_LIMIT_VALID_P(backtrace_length_limit)) {
936 opt->backtrace_length_limit = backtrace_length_limit;
939 opt->crash_report = crash_report;
944 rb_str_resize(argary, 0);
945 rb_str_resize(argstr, 0);
949name_match_p(
const char *name,
const char *str,
size_t len)
951 if (
len == 0)
return 0;
953 while (
TOLOWER(*str) == *name) {
954 if (!--
len)
return 1;
958 if (*str !=
'-' && *str !=
'_')
return 0;
960 if (*name !=
'-' && *name !=
'_')
return 0;
961 if (!*++name)
return 1;
963 if (--
len == 0)
return 1;
967#define NAME_MATCH_P(name, str, len) \
968 ((len) < (int)sizeof(name) && name_match_p((name), (str), (len)))
970#define UNSET_WHEN(name, bit, str, len) \
971 if (NAME_MATCH_P((name), (str), (len))) { \
972 *(unsigned int *)arg &= ~(bit); \
976#define SET_WHEN(name, bit, str, len) \
977 if (NAME_MATCH_P((name), (str), (len))) { \
978 *(unsigned int *)arg |= (bit); \
982#define LITERAL_NAME_ELEMENT(name) #name
985feature_option(
const char *str,
int len,
void *arg,
const unsigned int enable)
987 static const char list[] = EACH_FEATURES(LITERAL_NAME_ELEMENT,
", ");
989 unsigned int mask = ~0
U;
990 unsigned int set = 0
U;
991#if AMBIGUOUS_FEATURE_NAMES
993# define FEATURE_FOUND ++matched
995# define FEATURE_FOUND goto found
997#define SET_FEATURE(bit) \
998 if (NAME_MATCH_P(#bit, str, len)) {set |= mask = FEATURE_BIT(bit); FEATURE_FOUND;}
999 EACH_FEATURES(SET_FEATURE, ;);
1000 if (NAME_MATCH_P(
"jit", str,
len)) {
1001 set |= mask = FEATURE_BIT(jit);
1004 if (NAME_MATCH_P(
"all", str,
len)) {
1006 mask &= ~feature_jit_mask | FEATURE_BIT(jit);
1009#if AMBIGUOUS_FEATURE_NAMES
1010 if (matched == 1)
goto found;
1012 VALUE mesg = rb_sprintf(
"ambiguous feature: '%.*s' (",
len, str);
1013#define ADD_FEATURE_NAME(bit) \
1014 if (FEATURE_BIT(bit) & set) { \
1015 rb_str_cat_cstr(mesg, #bit); \
1016 if (--matched) rb_str_cat_cstr(mesg, ", "); \
1018 EACH_FEATURES(ADD_FEATURE_NAME, ;);
1021#undef ADD_FEATURE_NAME
1026 rb_warn(
"unknown argument for --%s: '%.*s'",
1027 enable ?
"enable" :
"disable",
len, str);
1028 rb_warn(
"features are [%.*s].", (
int)strlen(list), list);
1032 FEATURE_SET_TO(*argp, mask, (mask & enable));
1033 if (NAME_MATCH_P(
"frozen_string_literal", str,
len)) {
1034 FEATURE_SET_TO(*argp, FEATURE_BIT(frozen_string_literal_set), FEATURE_BIT(frozen_string_literal_set));
1040enable_option(
const char *str,
int len,
void *arg)
1042 feature_option(str,
len, arg, ~0
U);
1046disable_option(
const char *str,
int len,
void *arg)
1048 feature_option(str,
len, arg, 0
U);
1052int ruby_env_debug_option(
const char *str,
int len,
void *arg);
1055debug_option(
const char *str,
int len,
void *arg)
1057 static const char list[] = EACH_DEBUG_FEATURES(LITERAL_NAME_ELEMENT,
", ");
1059#define SET_WHEN_DEBUG(bit) \
1060 if (NAME_MATCH_P(#bit, str, len)) { \
1061 FEATURE_SET(*argp, DEBUG_BIT(bit)); \
1064 EACH_DEBUG_FEATURES(SET_WHEN_DEBUG, ;);
1068 rb_warn(
"unknown argument for --debug: '%.*s'",
len, str);
1069 rb_warn(
"debug features are [%.*s].", (
int)strlen(list), list);
1073memtermspn(
const char *str,
char term,
int len)
1076 if (
len <= 0)
return 0;
1077 const char *next = memchr(str, term,
len);
1078 return next ? (int)(next - str) :
len;
1081static const char additional_opt_sep =
'+';
1084dump_additional_option_flag(
const char *str,
int len,
unsigned int bits,
bool set)
1086#define SET_DUMP_OPT(bit) if (NAME_MATCH_P(#bit, str, len)) { \
1087 return set ? (bits | DUMP_BIT(opt_ ## bit)) : (bits & ~DUMP_BIT(opt_ ## bit)); \
1089 SET_DUMP_OPT(error_tolerant);
1090 SET_DUMP_OPT(comment);
1091 SET_DUMP_OPT(optimize);
1093 rb_warn(
"don't know how to dump with%s '%.*s'", set ?
"" :
"out",
len, str);
1098dump_additional_option(
const char *str,
int len,
unsigned int bits)
1101 for (;
len-- > 0 && *str++ == additional_opt_sep;
len -= w, str += w) {
1102 w = memtermspn(str, additional_opt_sep,
len);
1104 if (*str ==
'-' || *str ==
'+') {
1105 set = *str++ ==
'+';
1109 int n = memtermspn(str,
'-', w);
1110 if (str[n] ==
'-') {
1111 if (NAME_MATCH_P(
"with", str, n)) {
1115 else if (NAME_MATCH_P(
"without", str, n)) {
1122 bits = dump_additional_option_flag(str, w, bits, set);
1128dump_option(
const char *str,
int len,
void *arg)
1130 static const char list[] = EACH_DUMPS(LITERAL_NAME_ELEMENT,
", ");
1131 unsigned int *bits_ptr = (
unsigned int *)arg;
1132 if (*str ==
'+' || *str ==
'-') {
1133 bool set = *str++ ==
'+';
1134 *bits_ptr = dump_additional_option_flag(str, --
len, *bits_ptr, set);
1137 int w = memtermspn(str, additional_opt_sep,
len);
1139#define SET_WHEN_DUMP(bit) \
1140 if (NAME_MATCH_P(#bit "-", (str), (w))) { \
1141 *bits_ptr = dump_additional_option(str + w, len - w, *bits_ptr | DUMP_BIT(bit)); \
1144 EACH_DUMPS(SET_WHEN_DUMP, ;);
1145 rb_warn(
"don't know how to dump '%.*s',",
len, str);
1146 rb_warn(
"but only [%.*s].", (
int)strlen(list), list);
1150set_option_encoding_once(
const char *
type,
VALUE *name,
const char *e,
long elen)
1154 if (!elen) elen = strlen(e);
1160 "%s already set to %"PRIsVALUE,
type, *name);
1165#define set_internal_encoding_once(opt, e, elen) \
1166 set_option_encoding_once("default_internal", &(opt)->intern.enc.name, (e), (elen))
1167#define set_external_encoding_once(opt, e, elen) \
1168 set_option_encoding_once("default_external", &(opt)->ext.enc.name, (e), (elen))
1169#define set_source_encoding_once(opt, e, elen) \
1170 set_option_encoding_once("source", &(opt)->src.enc.name, (e), (elen))
1172#define yjit_opt_match_noarg(s, l, name) \
1173 opt_match(s, l, name) && (*(s) ? (rb_warn("argument to --yjit-" name " is ignored"), 1) : 1)
1174#define yjit_opt_match_arg(s, l, name) \
1175 opt_match(s, l, name) && (*(s) && *(s+1) ? 1 : (rb_raise(rb_eRuntimeError, "--yjit-" name " needs an argument"), 0))
1179setup_yjit_options(
const char *s)
1182 bool rb_yjit_parse_option(
const char* s);
1183 bool success = rb_yjit_parse_option(s);
1191 "invalid YJIT option '%s' (--help will show valid yjit options)",
1202 extern void *rb_zjit_init_options(
void);
1203 extern bool rb_zjit_parse_option(
void *options,
const char *s);
1205 if (!opt->zjit) opt->zjit = rb_zjit_init_options();
1206 if (!rb_zjit_parse_option(opt->zjit, s)) {
1207 rb_raise(
rb_eRuntimeError,
"invalid ZJIT option '%s' (--help will show valid zjit options)", s);
1229 unsigned int bits = 0;
1230 static const char no_prefix[] =
"no-";
1231 int enable = strncmp(s += 2, no_prefix,
sizeof(no_prefix)-1) != 0;
1232 if (!enable) s +=
sizeof(no_prefix)-1;
1233 size_t len = strlen(s);
1234 if (NAME_MATCH_P(
"deprecated", s,
len)) {
1237 else if (NAME_MATCH_P(
"experimental", s,
len)) {
1240 else if (NAME_MATCH_P(
"performance", s,
len)) {
1243 else if (NAME_MATCH_P(
"strict_unused_block", s,
len)) {
1247 rb_warn(
"unknown warning category: '%s'", s);
1249 if (bits) FEATURE_SET_TO(opt->warn, bits, enable ? bits : 0);
1262 if (!opt->warning) {
1278 FEATURE_SET_TO(opt->warn, RB_WARN_CATEGORY_DEFAULT_BITS, 0);
1284 FEATURE_SET(opt->warn, RB_WARN_CATEGORY_DEFAULT_BITS);
1303 if (!opt->e_script) {
1305 if (opt->script == 0)
1318 const char *enc_name = 0;
1321 enc_name =
"EUC-JP";
1324 enc_name =
"Windows-31J";
1329 case 'N':
case 'n':
case 'A':
case 'a':
1330 enc_name =
"ASCII-8BIT";
1335 if (!opt->ext.enc.name)
1336 opt->ext.enc.name = opt->src.enc.name;
1355 else if (v == 0 && numlen >= 2) {
1356 rb_rs = rb_fstring_lit(
"");
1370# define set_encoding_part(type) \
1371 if (!(p = strchr(s, ':'))) { \
1372 set_##type##_encoding_once(opt, s, 0); \
1376 set_##type##_encoding_once(opt, s, p-s); \
1378 set_encoding_part(external);
1379 if (!*(s = ++p))
return;
1380 set_encoding_part(internal);
1381 if (!*(s = ++p))
return;
1382#if defined ALLOW_DEFAULT_SOURCE_ENCODING && ALLOW_DEFAULT_SOURCE_ENCODING
1383 set_encoding_part(source);
1384 if (!*(s = ++p))
return;
1387# undef set_encoding_part
1396# define is_option_end(c, allow_hyphen) \
1397 (!(c) || ((allow_hyphen) && (c) == '-') || (c) == '=')
1398# define check_envopt(name, allow_envopt) \
1399 (((allow_envopt) || !envopt) ? (void)0 : \
1400 rb_raise(rb_eRuntimeError, "invalid switch in RUBYOPT: --" name))
1401# define need_argument(name, s, needs_arg, next_arg) \
1402 ((*(s) ? !*++(s) : (next_arg) && (argc <= 1 || !((s) = argv[1]) || (--argc, ++argv, 0))) && (needs_arg) ? \
1403 rb_raise(rb_eRuntimeError, "missing argument for --" name) \
1405# define is_option_with_arg(name, allow_hyphen, allow_envopt) \
1406 is_option_with_optarg(name, allow_hyphen, allow_envopt, Qtrue, Qtrue)
1407# define is_option_with_optarg(name, allow_hyphen, allow_envopt, needs_arg, next_arg) \
1408 (strncmp((name), s, n = sizeof(name) - 1) == 0 && is_option_end(s[n], (allow_hyphen)) && \
1409 (s[n] != '-' || (s[n] && s[n+1])) ? \
1410 (check_envopt(name, (allow_envopt)), s += n, \
1411 need_argument(name, s, needs_arg, next_arg), 1) : 0)
1413 if (strcmp(
"copyright", s) == 0) {
1414 if (envopt)
goto noenvopt_long;
1415 opt->dump |= DUMP_BIT(copyright);
1426 else if (is_option_with_arg(
"enable",
Qtrue,
Qtrue)) {
1429 else if (is_option_with_arg(
"disable",
Qtrue,
Qtrue)) {
1432 else if (is_option_with_arg(
"encoding",
Qfalse,
Qtrue)) {
1433 proc_encoding_option(opt, s,
"--encoding");
1435 else if (is_option_with_arg(
"internal-encoding",
Qfalse,
Qtrue)) {
1436 set_internal_encoding_once(opt, s, 0);
1438 else if (is_option_with_arg(
"external-encoding",
Qfalse,
Qtrue)) {
1439 set_external_encoding_once(opt, s, 0);
1441 else if (is_option_with_arg(
"parser",
Qfalse,
Qtrue)) {
1442 if (strcmp(
"prism", s) == 0) {
1443 rb_ruby_default_parser_set(RB_DEFAULT_PARSER_PRISM);
1445 else if (strcmp(
"parse.y", s) == 0) {
1446 rb_ruby_default_parser_set(RB_DEFAULT_PARSER_PARSE_Y);
1452#if defined ALLOW_DEFAULT_SOURCE_ENCODING && ALLOW_DEFAULT_SOURCE_ENCODING
1453 else if (is_option_with_arg(
"source-encoding",
Qfalse,
Qtrue)) {
1454 set_source_encoding_once(opt, s, 0);
1457 else if (strcmp(
"version", s) == 0) {
1458 if (envopt)
goto noenvopt_long;
1459 opt->dump |= DUMP_BIT(version);
1461 else if (strcmp(
"verbose", s) == 0) {
1465 else if (strcmp(
"jit", s) == 0) {
1467 FEATURE_SET(opt->features, FEATURE_BIT(jit));
1469 rb_warn(
"Ruby was built without JIT support");
1472 else if (is_option_with_optarg(
"yjit",
'-',
true,
false,
false)) {
1474 FEATURE_SET(opt->features, FEATURE_BIT(yjit));
1475 setup_yjit_options(s);
1477 rb_warn(
"Ruby was built without YJIT support."
1478 " You may need to install rustc to build Ruby with YJIT.");
1481 else if (is_option_with_optarg(
"zjit",
'-',
true,
false,
false)) {
1483 FEATURE_SET(opt->features, FEATURE_BIT(zjit));
1484 setup_zjit_options(opt, s);
1486 rb_warn(
"Ruby was built without ZJIT support."
1487 " You may need to install rustc to build Ruby with ZJIT.");
1490 else if (strcmp(
"yydebug", s) == 0) {
1491 if (envopt)
goto noenvopt_long;
1492 opt->dump |= DUMP_BIT(yydebug);
1497 else if (strcmp(
"help", s) == 0) {
1498 if (envopt)
goto noenvopt_long;
1499 opt->dump |= DUMP_BIT(help);
1502 else if (is_option_with_arg(
"backtrace-limit",
Qfalse,
Qtrue)) {
1504 long n = strtol(s, &e, 10);
1505 if (
errno == ERANGE || !BACKTRACE_LENGTH_LIMIT_VALID_P(n) || *e) {
1509 opt->backtrace_length_limit = n;
1512 else if (is_option_with_arg(
"crash-report",
true,
true)) {
1513 opt->crash_report = s;
1517 "invalid option --%s (-h will show valid options)", s);
1519 return argc0 - argc + 1;
1523# undef is_option_end
1525# undef need_argument
1526# undef is_option_with_arg
1527# undef is_option_with_optarg
1534 long n, argc0 = argc;
1536 int warning = opt->warning;
1538 if (argc <= 0 || !argv)
1541 for (argc--, argv++; argc > 0; argc--, argv++) {
1542 const char *
const arg = argv[0];
1543 if (!arg || arg[0] !=
'-' || !arg[1])
1550 if (envopt)
goto noenvopt;
1551 opt->do_split = TRUE;
1556 if (envopt)
goto noenvopt;
1557 opt->do_print = TRUE;
1560 if (envopt)
goto noenvopt;
1561 opt->do_loop = TRUE;
1572 if (envopt)
goto noenvopt;
1573 opt->dump |= DUMP_BIT(yydebug);
1582 opt->dump |= DUMP_BIT(version_v);
1585 if (!opt->warning) {
1589 FEATURE_SET(opt->warn, RB_WARN_CATEGORY_DEFAULT_BITS);
1594 if (!(s = proc_W_option(opt, s, &warning)))
break;
1598 if (envopt)
goto noenvopt;
1599 opt->dump |= DUMP_BIT(syntax);
1604 if (envopt)
goto noenvopt;
1606 if (!opt->sflag) opt->sflag = 1;
1611 if (envopt)
goto noenvopt;
1612 opt->dump |= DUMP_BIT(usage);
1616 if (envopt)
goto noenvopt;
1617 opt->do_line = TRUE;
1623 if (envopt)
goto noenvopt;
1625 opt->do_search = TRUE;
1630 if (envopt)
goto noenvopt;
1631 if (!(n = proc_e_option(opt, s, argc, argv)))
break;
1640 add_modules(&opt->req_list, s);
1642 else if (argc > 1) {
1643 add_modules(&opt->req_list, argv[1]);
1649 if (envopt)
goto noenvopt;
1651 ruby_set_inplace_mode(s + 1);
1655 if (envopt)
goto noenvopt;
1659 if (*s && chdir(s) < 0) {
1660 rb_fatal(
"Can't chdir to %s", s);
1666 if (envopt)
goto noenvopt;
1667 if (!*++s && (!--argc || !(s = *++argv) || !*s)) {
1668 rb_fatal(
"Can't chdir");
1671 rb_fatal(
"Can't chdir to %s", s);
1676 if (envopt)
goto noenvopt;
1683 if (!*++s && (!--argc || !(s = *++argv))) {
1686 proc_encoding_option(opt, s,
"-E");
1690 set_internal_encoding_once(opt,
"UTF-8", 0);
1695 if (!(s = proc_K_option(opt, s)))
break;
1701 ruby_incpush_expand(s);
1702 else if (argc > 1) {
1703 ruby_incpush_expand(argv[1]);
1709 if (envopt)
goto noenvopt;
1710 if (!(s = proc_0_option(opt, s)))
break;
1714 if (!s[1] || (s[1] ==
'\r' && !s[2])) {
1720 if (!(n = proc_long_options(opt, s, argc, argv, envopt)))
goto switch_end;
1731 rb_encoding *enc = IF_UTF8_PATH(rb_utf8_encoding(), rb_locale_encoding());
1732 const char *e = s + strlen(s);
1733 int r = rb_enc_precise_mbclen(s, e, enc);
1734 unsigned int c = (
unsigned char)*s;
1736 c = rb_enc_mbc_to_codepoint(s, e, enc);
1737 if (ONIGENC_IS_CODE_GRAPH(enc, c) ||
1738 ((s = ruby_escaped_char(c)) != 0 &&
1739 (r = (
int)strlen(s), 1))) {
1741 "invalid option -%.*s (-h will show valid options)",
1746 "invalid option -\\x%.2x (-h will show valid options)",
1763 if (warning) opt->warning = warning;
1764 return argc0 - argc;
1767void Init_builtin_features(
void);
1770ruby_init_prelude(
void)
1772 Init_builtin_features();
1775void rb_call_builtin_inits(
void);
1779#if RBIMPL_HAS_ATTRIBUTE(weak)
1783Init_extra_exts(
void)
1790 rb_warning_category_update(opt->warn.mask, opt->warn.set);
1792 if (opt->dump & dump_exit_bits)
return;
1794 if (FEATURE_SET_P(opt->features, gems)) {
1796 if (opt->features.set & FEATURE_BIT(error_highlight)) {
1799 if (opt->features.set & FEATURE_BIT(did_you_mean)) {
1802 if (opt->features.set & FEATURE_BIT(syntax_suggest)) {
1809 if (getenv(
"RUBY_GC_HEAP_INIT_SLOTS")) {
1810 rb_warn_deprecated(
"The environment variable RUBY_GC_HEAP_INIT_SLOTS",
1811 "environment variables RUBY_GC_HEAP_%d_INIT_SLOTS");
1817 GET_VM()->running = 0;
1818 rb_call_builtin_inits();
1819 GET_VM()->running = 1;
1820 memset(ruby_vm_redefined_flag, 0,
sizeof(ruby_vm_redefined_flag));
1822 if (rb_namespace_available())
1823 rb_initialize_main_namespace();
1827 rb_yjit_init(opt->yjit);
1831 extern void rb_zjit_init(
void *options);
1832 rb_zjit_init(opt->zjit);
1838 void Init_builtin_yjit_hook();
1839 Init_builtin_yjit_hook();
1842 rb_namespace_init_done();
1843 ruby_init_prelude();
1845 require_libraries(&opt->req_list);
1849opt_enc_index(
VALUE enc_name)
1851 const char *s = RSTRING_PTR(enc_name);
1852 int i = rb_enc_find_index(s);
1857 else if (rb_enc_dummy_p(rb_enc_from_index(i))) {
1863#define rb_progname (GET_VM()->progname)
1864#define rb_orig_progname (GET_VM()->orig_progname)
1880#define rb_define_readonly_boolean(name, val) \
1881 rb_define_virtual_variable((name), (val) ? true_value : false_value, 0)
1890 rb_raise(
rb_eTypeError,
"$_ value need to be String (%s given)",
1972setup_pager_env(
void)
1974 if (!getenv(
"LESS")) {
1976 ruby_setenv(
"LESS",
"-R +/^[A-Z].*");
1984 HANDLE h = GetStdHandle(STD_OUTPUT_HANDLE);
1986 if (!GetConsoleMode(h, &m))
return 0;
1987# ifndef ENABLE_VIRTUAL_TERMINAL_PROCESSING
1988# define ENABLE_VIRTUAL_TERMINAL_PROCESSING 0x4
1990 if (!(m & ENABLE_VIRTUAL_TERMINAL_PROCESSING))
return 0;
1993#elif !defined(HAVE_WORKING_FORK)
1994# define tty_enabled() 0
2003 return rb_enc_associate(
rb_str_dup(str), enc);
2008#if USE_YJIT || USE_ZJIT
2011env_var_truthy(
const char *name)
2013 const char *value = getenv(name);
2017 if (strcmp(value,
"1") == 0)
2019 if (strcmp(value,
"true") == 0)
2021 if (strcmp(value,
"yes") == 0)
2028rb_pid_t rb_fork_ruby(
int *status);
2031show_help(
const char *progname,
int help)
2033 int tty = isatty(1);
2036 const char *pager_env = getenv(
"RUBY_PAGER");
2037 if (!pager_env) pager_env = getenv(
"PAGER");
2038 if (pager_env && *pager_env && isatty(0)) {
2039 const char *columns_env = getenv(
"COLUMNS");
2040 if (columns_env) columns = atoi(columns_env);
2042#ifdef HAVE_WORKING_FORK
2045 rb_pid_t pid = rb_fork_ruby(NULL);
2050 else if (pid == 0) {
2068 int oldout = dup(1);
2069 int olderr = dup(2);
2070 int fd =
RFILE(port)->fptr->fd;
2071 tty = tty_enabled();
2074 usage(progname, 1, tty, columns);
2084 usage(progname, help, tty, columns);
2092 VALUE parser = rb_parser_new();
2093 const unsigned int dump = opt->dump;
2095 if (dump & DUMP_BIT(yydebug)) {
2096 rb_parser_set_yydebug(parser,
Qtrue);
2099 if ((dump & dump_exit_bits) && (dump & DUMP_BIT(opt_error_tolerant))) {
2100 rb_parser_error_tolerant(parser);
2103 if (opt->e_script) {
2104 VALUE progname = rb_progname;
2105 rb_parser_set_context(parser, 0, TRUE);
2109 rb_parser_set_options(parser, opt->do_print, opt->do_loop,
2110 opt->do_line, opt->do_split);
2111 ast_value = rb_parser_compile_string(parser, opt->script, opt->e_script, 1);
2115 int xflag = opt->xflag;
2116 f = open_load_file(opt->script_name, &xflag);
2117 opt->xflag = xflag != 0;
2118 rb_parser_set_context(parser, 0, f ==
rb_stdin);
2119 ast_value = load_file(parser, opt->script_name, f, 1, opt);
2121 ast = rb_ruby_ast_data_get(ast_value);
2122 if (!ast->body.root) {
2123 rb_ast_dispose(ast);
2132 uint8_t command_line = 0;
2138 return command_line;
2142prism_script_shebang_callback(
pm_options_t *options,
const uint8_t *source,
size_t length,
void *data)
2147 char *switches = malloc(length + 1);
2148 memcpy(switches, source, length);
2149 switches[length] =
'\0';
2151 int no_src_enc = !opt->src.enc.name;
2152 int no_ext_enc = !opt->ext.enc.name;
2153 int no_int_enc = !opt->intern.enc.name;
2155 moreswitches(switches, opt, 0);
2158 pm_options_command_line_set(options, prism_script_command_line(opt));
2160 if (no_src_enc && opt->src.enc.name) {
2161 opt->src.enc.index = opt_enc_index(opt->src.enc.name);
2164 if (no_ext_enc && opt->ext.enc.name) {
2165 opt->ext.enc.index = opt_enc_index(opt->ext.enc.name);
2167 if (no_int_enc && opt->intern.enc.name) {
2168 opt->intern.enc.index = opt_enc_index(opt->intern.enc.name);
2182 pm_options_line_set(options, 1);
2183 pm_options_main_script_set(options,
true);
2185 const bool read_stdin = (strcmp(opt->script,
"-") == 0);
2188 pm_options_encoding_set(options, rb_enc_name(rb_locale_encoding()));
2190 if (opt->src.enc.name != 0) {
2194 uint8_t command_line = prism_script_command_line(opt);
2198 pm_options_command_line_set(options, command_line);
2199 pm_options_filepath_set(options,
"-");
2200 pm_options_shebang_callback_set(options, prism_script_shebang_callback, (
void *) opt);
2203 error = pm_parse_stdin(result);
2212 else if (opt->e_script) {
2214 pm_options_command_line_set(options, command_line);
2217 result->
node.coverage_enabled = 0;
2218 error = pm_parse_string(result, opt->e_script,
rb_str_new2(
"-e"), NULL);
2221 VALUE script_name = rb_str_encode_ospath(opt->script_name);
2223 pm_options_command_line_set(options, command_line);
2224 pm_options_shebang_callback_set(options, prism_script_shebang_callback, (
void *) opt);
2226 error = pm_load_file(result, script_name,
true);
2233 error = pm_parse_file(result, opt->script_name, NULL);
2238 if (
RTEST(rb_get_coverages())) {
2239 result->
node.coverage_enabled = 1;
2246 int xflag = opt->xflag;
2247 VALUE file = open_load_file(script_name, &xflag);
2252 if ((parser->
start + offset < parser->end) && parser->
start[offset] ==
'\r') offset++;
2253 if ((parser->
start + offset < parser->end) && parser->
start[offset] ==
'\n') offset++;
2260 if (!
NIL_P(error)) {
2261 pm_parse_result_free(result);
2271 pm_prettyprint(&output_buffer, &result->
parser, result->
node.ast_node);
2273 pm_buffer_free(&output_buffer);
2280 if (OPT_BACKTRACE_LENGTH_LIMIT_VALID_P(opt)) {
2281 rb_backtrace_length_limit = opt->backtrace_length_limit;
2291 rb_define_readonly_boolean(
"$-p", opt->do_print);
2292 rb_define_readonly_boolean(
"$-l", opt->do_line);
2293 rb_define_readonly_boolean(
"$-a", opt->do_split);
2295 rb_gvar_ractor_local(
"$-p");
2296 rb_gvar_ractor_local(
"$-l");
2297 rb_gvar_ractor_local(
"$-a");
2299 if ((rb_e_script = opt->e_script) != 0) {
2301 rb_vm_register_global_object(opt->e_script);
2305 VALUE script = (opt->e_script ? opt->e_script :
Qnil);
2306 rb_exec_event_hook_script_compiled(ec, iseq, script);
2317#define dispose_result() \
2318 (result.ast ? rb_ast_dispose(result.ast) : pm_parse_result_free(&result.prism))
2327 char fbuf[MAXPATHLEN];
2328 int i = (int)proc_options(argc, argv, opt, 0);
2329 unsigned int dump = opt->dump & dump_exit_bits;
2331 const long loaded_before_enc =
RARRAY_LEN(vm->loaded_features);
2333 if (opt->dump & (DUMP_BIT(usage)|DUMP_BIT(help))) {
2334 const char *
const progname =
2335 (argc > 0 && argv && argv[0] ? argv[0] :
2336 origarg.argc > 0 && origarg.argv && origarg.argv[0] ? origarg.argv[0] :
2338 show_help(progname, (opt->dump & DUMP_BIT(help)));
2345 if (FEATURE_SET_P(opt->features, rubyopt) && (s = getenv(
"RUBYOPT"))) {
2346 moreswitches(s, opt, 1);
2349 if (opt->src.enc.name)
2353 rb_warning(
"-K is specified; it is for 1.8 compatibility and may cause odd behavior");
2355 if (!(FEATURE_SET_BITS(opt->features) & feature_jit_mask)) {
2357 if (!FEATURE_USED_P(opt->features, yjit) && env_var_truthy(
"RUBY_YJIT_ENABLE")) {
2358 FEATURE_SET(opt->features, FEATURE_BIT(yjit));
2361 if (!FEATURE_USED_P(opt->features, zjit) && env_var_truthy(
"RUBY_ZJIT_ENABLE")) {
2362 FEATURE_SET(opt->features, FEATURE_BIT(zjit));
2366 if (MULTI_BITS_P(FEATURE_SET_BITS(opt->features) & feature_jit_mask)) {
2367 rb_warn(
"Only one JIT can be enabled at the same time. Exiting");
2372 if (FEATURE_SET_P(opt->features, yjit)) {
2373 bool rb_yjit_option_disable(
void);
2374 opt->yjit = !rb_yjit_option_disable();
2378 if (FEATURE_SET_P(opt->features, zjit) && !opt->zjit) {
2379 extern void *rb_zjit_init_options(
void);
2380 opt->zjit = rb_zjit_init_options();
2384 ruby_mn_threads_params();
2385 Init_ruby_description(opt);
2387 if (opt->dump & (DUMP_BIT(version) | DUMP_BIT(version_v))) {
2389 if (opt->dump & DUMP_BIT(version))
return Qtrue;
2391 if (opt->dump & DUMP_BIT(copyright)) {
2396 if (!opt->e_script) {
2403 opt->script = argv[0];
2404 if (!opt->script || opt->script[0] ==
'\0') {
2407 else if (opt->do_search) {
2408 const char *path = getenv(
"RUBYPATH");
2412 opt->script = dln_find_file_r(argv[0], path, fbuf,
sizeof(fbuf));
2415 opt->script = dln_find_file_r(argv[0], getenv(
PATH_ENV), fbuf,
sizeof(fbuf));
2418 opt->script = argv[0];
2423 if (opt->script[0] ==
'-' && !opt->script[1]) {
2424 forbid_setid(
"program input from stdin");
2429 opt->script = RSTRING_PTR(opt->script_name);
2432 translit_char_bin(RSTRING_PTR(opt->script_name),
'\\',
'/');
2435 ruby_gc_set_params();
2439 lenc = rb_locale_encoding();
2440 rb_enc_associate(rb_progname, lenc);
2442 if (opt->ext.enc.name != 0) {
2443 opt->ext.enc.index = opt_enc_index(opt->ext.enc.name);
2445 if (opt->intern.enc.name != 0) {
2446 opt->intern.enc.index = opt_enc_index(opt->intern.enc.name);
2448 if (opt->src.enc.name != 0) {
2449 opt->src.enc.index = opt_enc_index(opt->src.enc.name);
2450 src_encoding_index = opt->src.enc.index;
2452 if (opt->ext.enc.index >= 0) {
2453 enc = rb_enc_from_index(opt->ext.enc.index);
2456 enc = IF_UTF8_PATH(uenc, lenc);
2458 rb_enc_set_default_external(rb_enc_from_encoding(enc));
2459 if (opt->intern.enc.index >= 0) {
2460 enc = rb_enc_from_index(opt->intern.enc.index);
2461 rb_enc_set_default_internal(rb_enc_from_encoding(enc));
2462 opt->intern.enc.index = -1;
2467 rb_enc_associate(opt->script_name, IF_UTF8_PATH(uenc, lenc));
2470 opt->script_name = str_conv_enc(opt->script_name, uenc, lenc);
2471 opt->script = RSTRING_PTR(opt->script_name);
2475 if (IF_UTF8_PATH(uenc != lenc, 1)) {
2477 VALUE load_path = vm->load_path;
2478 const ID id_initial_load_path_mark = INITIAL_LOAD_PATH_MARK;
2479 int modifiable = FALSE;
2481 rb_get_expanded_load_path();
2482 for (i = 0; i <
RARRAY_LEN(load_path); ++i) {
2484 int mark = rb_attr_get(path, id_initial_load_path_mark) == path;
2487 if (newpath == path)
continue;
2490 if (!(path = copy_str(path, lenc, !mark)))
continue;
2492 if (mark)
rb_ivar_set(path, id_initial_load_path_mark, path);
2504 VALUE loaded_features = vm->loaded_features;
2505 bool modified =
false;
2506 for (
long i = loaded_before_enc; i <
RARRAY_LEN(loaded_features); ++i) {
2508 if (!(path = copy_str(path, IF_UTF8_PATH(uenc, lenc),
true)))
continue;
2520 if (opt->features.mask & COMPILATION_FEATURES) {
2521 VALUE option = rb_hash_new();
2522#define SET_COMPILE_OPTION(h, o, name) \
2523 rb_hash_aset((h), ID2SYM(rb_intern_const(#name)), \
2524 RBOOL(FEATURE_SET_P(o->features, name)))
2526 if (FEATURE_SET_P(opt->features, frozen_string_literal_set)) {
2527 SET_COMPILE_OPTION(option, opt, frozen_string_literal);
2529 SET_COMPILE_OPTION(option, opt, debug_frozen_string_literal);
2530 rb_funcallv(rb_cISeq,
rb_intern_const(
"compile_option="), 1, &option);
2531#undef SET_COMPILE_OPTION
2534 opt->sflag = process_sflag(opt->sflag);
2536 if (opt->e_script) {
2538 if (opt->src.enc.index >= 0) {
2539 eenc = rb_enc_from_index(opt->src.enc.index);
2544 if (ienc) eenc = ienc;
2549 opt->e_script = str_conv_enc(opt->e_script, uenc, eenc);
2552 rb_enc_associate(opt->e_script, eenc);
2555 if (!rb_ruby_prism_p()) {
2556 ast_value = process_script(opt);
2557 if (!(result.ast = rb_ruby_ast_data_get(ast_value)))
return Qfalse;
2560 prism_script(opt, &result.prism);
2563 if ((dump & DUMP_BIT(yydebug)) && !(dump &= ~DUMP_BIT(yydebug))) {
2568 if (opt->ext.enc.index >= 0) {
2569 enc = rb_enc_from_index(opt->ext.enc.index);
2572 enc = IF_UTF8_PATH(uenc, lenc);
2574 rb_enc_set_default_external(rb_enc_from_encoding(enc));
2575 if (opt->intern.enc.index >= 0) {
2577 enc = rb_enc_from_index(opt->intern.enc.index);
2578 rb_enc_set_default_internal(rb_enc_from_encoding(enc));
2580 else if (!rb_default_internal_encoding())
2582 rb_enc_set_default_internal(
Qnil);
2583 rb_stdio_set_default_encoding();
2585 opt->sflag = process_sflag(opt->sflag);
2588 if (dump & DUMP_BIT(syntax)) {
2589 printf(
"Syntax OK\n");
2590 dump &= ~DUMP_BIT(syntax);
2597 if (dump & DUMP_BIT(parsetree)) {
2600 int comment = opt->dump & DUMP_BIT(opt_comment);
2601 tree = rb_parser_dump_tree(result.ast->body.root, comment);
2604 tree = prism_dump_tree(&result.prism);
2608 dump &= ~DUMP_BIT(parsetree);
2617 if (!opt->e_script && strcmp(opt->script,
"-")) {
2618 path = rb_realpath_internal(
Qnil, opt->script_name, 1);
2621 path = str_conv_enc(path, uenc, lenc);
2625 rb_enc_copy(path, opt->script_name);
2630 GetBindingPtr(
rb_const_get(rb_cObject, rb_intern(
"TOPLEVEL_BINDING")), toplevel_binding);
2631 const struct rb_block *base_block = toplevel_context(toplevel_binding);
2632 const rb_iseq_t *parent = vm_block_iseq(base_block);
2633 bool optimize = (opt->dump & DUMP_BIT(opt_optimize)) != 0;
2638 iseq = pm_iseq_new_main(&pm->
node, opt->script_name, path, parent, optimize, &error_state);
2640 pm_parse_result_free(pm);
2644 rb_jump_tag(error_state);
2649 iseq = rb_iseq_new_main(ast_value, opt->script_name, path, parent, optimize);
2650 rb_ast_dispose(ast);
2654 if (dump & DUMP_BIT(insns)) {
2657 dump &= ~DUMP_BIT(insns);
2658 if (!dump)
return Qtrue;
2660 if (opt->dump & dump_exit_bits)
return Qtrue;
2662 process_options_global_setup(opt, iseq);
2668warn_cr_in_shebang(
const char *str,
long len)
2670 if (
len > 1 && str[
len-1] ==
'\n' && str[
len-2] ==
'\r') {
2671 rb_warn(
"shebang line ending with \\r may cause problems");
2675#define warn_cr_in_shebang(str, len) (void)0
2678void rb_reset_argf_lineno(
long n);
2688void rb_set_script_lines_for(
VALUE vparser,
VALUE path);
2691load_file_internal(
VALUE argp_v)
2694 VALUE parser = argp->parser;
2695 VALUE orig_fname = argp->fname;
2696 int script = argp->script;
2704 CONST_ID(set_encoding,
"set_encoding");
2710 int no_src_enc = !opt->src.enc.name;
2711 int no_ext_enc = !opt->ext.enc.name;
2712 int no_int_enc = !opt->intern.enc.name;
2714 enc = rb_ascii8bit_encoding();
2715 rb_funcall(f, set_encoding, 1, rb_enc_from_encoding(enc));
2723 if (
len > 2 && str[0] ==
'#' && str[1] ==
'!') {
2724 if (line_start == 1) warn_cr_in_shebang(str,
len);
2738 warn_cr_in_shebang(str,
len);
2741 goto search_shebang;
2746 if (*str ==
'\n') *str-- =
'\0';
2747 if (*str ==
'\r') *str-- =
'\0';
2749 if ((p = strstr(p,
" -")) != 0) {
2751 moreswitches(p + 1, opt, 0);
2757 else if (!
NIL_P(c)) {
2761 if (no_src_enc && opt->src.enc.name) {
2762 opt->src.enc.index = opt_enc_index(opt->src.enc.name);
2763 src_encoding_index = opt->src.enc.index;
2765 if (no_ext_enc && opt->ext.enc.name) {
2766 opt->ext.enc.index = opt_enc_index(opt->ext.enc.name);
2768 if (no_int_enc && opt->intern.enc.name) {
2769 opt->intern.enc.index = opt_enc_index(opt->intern.enc.name);
2772 else if (!
NIL_P(c)) {
2778 rb_reset_argf_lineno(0);
2781 if (opt->src.enc.index >= 0) {
2782 enc = rb_enc_from_index(opt->src.enc.index);
2785 enc = rb_locale_encoding();
2788 enc = rb_utf8_encoding();
2790 rb_parser_set_options(parser, opt->do_print, opt->do_loop,
2791 opt->do_line, opt->do_split);
2793 rb_set_script_lines_for(parser, orig_fname);
2797 rb_enc_associate(f, enc);
2798 return rb_parser_compile_string_path(parser, orig_fname, f, line_start);
2801 ast_value = rb_parser_compile_file_path(parser, orig_fname, f, line_start);
2802 rb_funcall(f, set_encoding, 1, rb_parser_encoding(parser));
2803 if (script && rb_parser_end_seen_p(parser)) {
2824disable_nonblock(
int fd)
2826#if defined(HAVE_FCNTL) && defined(F_SETFL)
2827 if (fcntl(fd, F_SETFL, 0) < 0) {
2828 const int e =
errno;
2831 if (e == ENOTSUP)
return 0;
2833# if defined B_UNSUPPORTED
2834 if (e == B_UNSUPPORTED)
return 0;
2843open_load_file(
VALUE fname_v,
int *xflag)
2845 const char *fname = (fname_v = rb_str_encode_ospath(fname_v),
2847 long flen = RSTRING_LEN(fname_v);
2851 if (flen == 1 && fname[0] ==
'-') {
2858 const int MODE_TO_LOAD = O_RDONLY | (
2859#if defined O_NONBLOCK && HAVE_FCNTL
2861 !(O_NONBLOCK & O_ACCMODE) ? O_NONBLOCK :
2863#if defined O_NDELAY && HAVE_FCNTL
2864 !(O_NDELAY & O_ACCMODE) ? O_NDELAY :
2867 int mode = MODE_TO_LOAD;
2868#if defined DOSISH || defined __CYGWIN__
2869# define isdirsep(x) ((x) == '/' || (x) == '\\')
2871 static const char exeext[] =
".exe";
2872 enum {extlen =
sizeof(exeext)-1};
2873 if (flen > extlen && !isdirsep(fname[flen-extlen-1]) &&
2874 STRNCASECMP(fname+flen-extlen, exeext, extlen) == 0) {
2883 if (!rb_gc_for_fd(e)) {
2884 rb_load_fail(fname_v, strerror(e));
2887 rb_load_fail(fname_v, strerror(
errno));
2892 if (MODE_TO_LOAD != O_RDONLY && (e = disable_nonblock(fd)) != 0) {
2894 rb_load_fail(fname_v, strerror(e));
2897 e = ruby_is_fd_loadable(fd);
2901 rb_load_fail(fname_v, strerror(e));
2917restore_load_file(
VALUE arg)
2932 arg.parser = parser;
2934 arg.script = script;
2938 restore_load_file, (
VALUE)&arg);
2952 ast_value = rb_parser_load_file(rb_parser_new(), fname_v);
2953 return (
void *)rb_ruby_ast_data_get(ast_value);
2957rb_parser_load_file(
VALUE parser,
VALUE fname_v)
2961 VALUE f = open_load_file(fname_v, &xflag);
2962 cmdline_options_init(&opt)->xflag = xflag != 0;
2963 return load_file(parser, fname_v, f, 0, &opt);
2978proc_argv0(
VALUE process)
2980 return rb_orig_progname;
3005 return ruby_setproctitle(title);
3009ruby_setproctitle(
VALUE title)
3019 if (origarg.argv == 0)
3026external_str_new_cstr(
const char *p)
3030 str = str_conv_enc(str, NULL, rb_default_external_encoding());
3038set_progname(
VALUE name)
3040 rb_orig_progname = rb_progname = name;
3041 rb_vm_set_progname(rb_progname);
3065 rb_uid_t uid = getuid();
3066 rb_uid_t euid = geteuid();
3067 rb_gid_t gid = getgid();
3068 rb_gid_t egid = getegid();
3070 if (uid != euid) opt->setids |= 1;
3071 if (egid != gid) opt->setids |= 2;
3078 if (opt->setids & 1)
3080 if (opt->setids & 2)
3085verbose_getter(
ID id,
VALUE *ptr)
3087 return *rb_ruby_verbose_ptr();
3093 *rb_ruby_verbose_ptr() =
RTEST(val) ?
Qtrue : val;
3097opt_W_getter(
ID id,
VALUE *dmy)
3099 VALUE v = *rb_ruby_verbose_ptr();
3114debug_getter(
ID id,
VALUE *dmy)
3116 return *rb_ruby_debug_ptr();
3122 *rb_ruby_debug_ptr() = val;
3135 rb_gvar_ractor_local(
"$VERBOSE");
3136 rb_gvar_ractor_local(
"$-v");
3137 rb_gvar_ractor_local(
"$-w");
3138 rb_gvar_ractor_local(
"$-W");
3139 rb_gvar_ractor_local(
"$DEBUG");
3140 rb_gvar_ractor_local(
"$-d");
3164 for (i = 0; i < argc; i++) {
3165 VALUE arg = external_str_new_cstr(argv[i]);
3177 const char *script_name = (argc > 0 && argv[0]) ? argv[0] :
ruby_engine;
3179 if (!origarg.argv || origarg.argc <= 0) {
3180 origarg.argc = argc;
3181 origarg.argv = argv;
3183 set_progname(external_str_new_cstr(script_name));
3185 rb_vm_register_global_object(
rb_argv0);
3187#ifndef HAVE_SETPROCTITLE
3188 ruby_init_setproctitle(argc, argv);
3191 if (getenv(
"RUBY_FREE_AT_EXIT")) {
3192 rb_free_at_exit =
true;
3196 iseq = process_options(argc, argv, cmdline_options_init(&opt));
3198 if (opt.crash_report && *opt.crash_report) {
3199 void ruby_set_crash_report(
const char *
template);
3200 ruby_set_crash_report(opt.crash_report);
3203 return (
void*)(
struct RData*)iseq;
3207fill_standard_fds(
void)
3209 int f0, f1, f2, fds[2];
3211 f0 = fstat(0, &buf) == -1 &&
errno == EBADF;
3212 f1 = fstat(1, &buf) == -1 &&
errno == EBADF;
3213 f2 = fstat(2, &buf) == -1 &&
errno == EBADF;
3215 if (pipe(fds) == 0) {
3224 if (pipe(fds) == 0) {
3226 if (f1 && fds[1] != 1)
3228 if (f2 && fds[1] != 2)
3230 if (fds[1] != 1 && fds[1] != 2)
3240 rb_w32_sysinit(argc, argv);
3242 if (*argc >= 0 && *argv) {
3243 origarg.argc = *argc;
3244 origarg.argv = *argv;
3246 fill_standard_fds();
3249#ifdef RUBY_ASAN_ENABLED
3250RUBY_SYMBOL_EXPORT_BEGIN
3251const char ruby_asan_default_options[] =
"use_sigaltstack=0:detect_leaks=0";
3252RUBY_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.