Ruby
2.4.2p198(2017-09-14revision59899)
|
CRuby interpreter APIs. More...
![]() |
Modules | |
ruby(1) implementation | |
A part of the implementation of ruby(1) command. | |
Macros | |
#define | Init_stack(addr) ruby_init_stack(addr) |
Functions | |
void | ruby_init_stack (volatile VALUE *) |
int | ruby_setup (void) |
int | ruby_cleanup (volatile int) |
Destructs the VM. More... | |
void | ruby_finalize (void) |
Runs the VM finalization processes. More... | |
NORETURN (void rb_exit(int)) | |
void | ruby_set_stack_size (size_t) |
int | ruby_stack_check (void) |
size_t | ruby_stack_length (VALUE **) |
int | ruby_exec_node (void *n) |
Runs the given compiled source. More... | |
void | ruby_script (const char *name) |
Sets the current script name to this value. More... | |
void | ruby_set_script_name (VALUE name) |
Sets the current script name to this value. More... | |
void | ruby_prog_init (void) |
Defines built-in variables. More... | |
void | ruby_set_argv (int, char **) |
void * | ruby_process_options (int, char **) |
void | ruby_init_loadpath (void) |
void | ruby_incpush (const char *) |
void | ruby_sig_finalize (void) |
CRuby interpreter APIs.
These are APIs to embed MRI interpreter into your program. These functions are not a part of Ruby extension library API. Extension libraries of Ruby should not depend on these functions.
#define Init_stack | ( | addr | ) | ruby_init_stack(addr) |
NORETURN | ( | void | rb_exitint | ) |
int ruby_cleanup | ( | volatile int | ex | ) |
Destructs the VM.
Runs the VM finalization processes as well as ruby_finalize(), and frees resources used by the VM.
ex | Default value to the return value. |
Definition at line 159 of file eval.c.
References ATOMIC_VALUE_EXCHANGE, err, rb_thread_struct::errinfo, error_handle(), EXEC_TAG, EXIT_FAILURE, EXIT_SUCCESS, GET_THREAD, GET_VM, id_signo, NUM2INT, numberof, Qnil, rb_eSignal, rb_eSystemExit, rb_ivar_get(), rb_obj_is_kind_of(), rb_thread_stop_timer_thread(), rb_thread_terminate_all(), rb_threadptr_check_signal(), rb_threadptr_interrupt(), rb_threadptr_unlock_all_locking_mutexes(), RTEST, ruby_default_signal(), ruby_finalize_0(), ruby_finalize_1(), ruby_init_stack(), RUBY_VM_CHECK_INTS, ruby_vm_destruct(), rb_thread_struct::safe_level, SAVE_ROOT_JMPBUF, STACK_UPPER, rb_thread_struct::status, sysexit_status(), TH_POP_TAG, TH_PUSH_TAG, THREAD_KILLED, and THROW_DATA_P.
Referenced by PPP_ShutdownModule(), ruby_run_node(), and ruby_stop().
int ruby_exec_node | ( | void * | n | ) |
Runs the given compiled source.
Definition at line 305 of file eval.c.
References ruby_exec_internal(), and ruby_init_stack().
Referenced by ruby_run_node().
void ruby_finalize | ( | void | ) |
Runs the VM finalization processes.
END{}
and procs registered by Kernel.#at_exit
are executed here. See the Ruby language spec for more details.
Definition at line 142 of file eval.c.
References ruby_finalize_0(), and ruby_finalize_1().
Referenced by rescue_callback().
void ruby_incpush | ( | const char * | ) |
Definition at line 354 of file ruby.c.
References locale_path(), and ruby_push_include().
Referenced by init_loadpath().
void ruby_init_loadpath | ( | void | ) |
Definition at line 431 of file ruby.c.
References NULL, origarg, Qnil, rb_readlink(), rb_realpath_internal(), rb_str_new(), rb_str_new_cstr(), rb_str_resize(), and ruby_init_loadpath_safe().
void ruby_init_stack | ( | volatile VALUE * | ) |
Referenced by Init_stack(), ruby_cleanup(), ruby_exec_node(), ruby_options(), and ruby_setup().
void* ruby_process_options | ( | int | , |
char ** | |||
) |
Definition at line 2201 of file ruby.c.
References cmdline_options_init(), load_file_arg::opt, process_options(), rb_gc_register_mark_object(), rb_progname, rb_str_new4, ruby_engine, ruby_init_setproctitle(), ruby_script(), and ruby_cmdline_options::script_name.
Referenced by ruby_options().
void ruby_prog_init | ( | void | ) |
Defines built-in variables.
Definition at line 2155 of file ruby.c.
References opt_W_getter(), proc_argv0(), proc_setproctitle(), rb_argv, rb_define_global_const(), rb_define_hooked_variable(), rb_define_module_function(), rb_define_variable(), rb_gvar_readonly_setter(), rb_mProcess, rb_progname, ruby_debug, ruby_verbose, set_arg0(), and verbose_setter().
Referenced by ruby_setup().
void ruby_script | ( | const char * | name | ) |
Sets the current script name to this value.
This is similar to $0 = name
in Ruby level but also affects Method::location
and others.
Definition at line 2084 of file ruby.c.
References external_str_new_cstr(), rb_orig_progname, rb_progname, and rb_vm_set_progname().
Referenced by ruby_process_options().
void ruby_set_argv | ( | int | , |
char ** | |||
) |
Definition at line 2180 of file ruby.c.
References argc, external_str_new_cstr(), OBJ_FREEZE, origarg, rb_argv, rb_ary_clear(), and rb_ary_push().
Referenced by process_options(), and stub_options().
void ruby_set_script_name | ( | VALUE | name | ) |
Sets the current script name to this value.
Same as ruby_script() but accepts a VALUE.
Definition at line 2097 of file ruby.c.
References rb_orig_progname, rb_progname, rb_str_dup(), and rb_vm_set_progname().
Referenced by Init_version(), load_file_internal(), and process_options().
void ruby_set_stack_size | ( | size_t | ) |
int ruby_setup | ( | void | ) |
Definition at line 46 of file eval.c.
References EXEC_TAG, GET_VM, Init_BareVM(), Init_heap(), Init_vm_objects(), POP_TAG, PUSH_TAG, rb_call_inits(), ruby_init_stack(), and ruby_prog_init().
Referenced by ruby_init().
void ruby_sig_finalize | ( | void | ) |
Definition at line 1405 of file signal.c.
References ruby_signal, sighandler(), sighandler_t, and SIGINT.
Referenced by ruby_finalize_1().
int ruby_stack_check | ( | void | ) |
Definition at line 3976 of file gc.c.
References ATTRIBUTE_NO_ADDRESS_SAFETY_ANALYSIS, stack_check(), and STACKFRAME_FOR_CALL_CFUNC.
Referenced by stack_check().
size_t ruby_stack_length | ( | VALUE ** | ) |
Definition at line 3947 of file gc.c.
References GET_THREAD, SET_STACK_END, STACK_END, STACK_LENGTH, STACK_START, and STACK_UPPER.