Ruby 3.0.5p211 (2022-11-24 revision ba5cf0f7c52d4d35cc6a173c89eda98ceffa2dcf)
Modules | Functions
CRuby Embedding APIs

CRuby interpreter APIs. More...

Modules

 ruby(1) implementation
 A part of the implementation of ruby(1) command.
 

Functions

void ruby_init_stack (volatile VALUE *)
 
int ruby_setup (void)
 Initializes the VM and builtin libraries. More...
 
int ruby_cleanup (volatile int)
 Destructs the VM. More...
 
void ruby_finalize (void)
 Runs the VM finalization processes. More...
 
void ruby_stop (int)
 Calls ruby_cleanup() and exits the process. More...
 
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)
 

Detailed Description

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.

Function Documentation

◆ ruby_cleanup()

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.

Parameters
exDefault value to the return value.
Returns
If an error occurred returns a non-zero. If otherwise, returns the given ex.
Note
This function does not raise any exception.

Definition at line 213 of file eval.c.

Referenced by ruby_stop().

◆ ruby_exec_node()

int ruby_exec_node ( void *  n)

Runs the given compiled source.

Definition at line 380 of file eval.c.

References ruby_init_stack().

◆ ruby_finalize()

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.

Note
This function is allowed to raise an exception if an error occurred.

Definition at line 195 of file eval.c.

◆ ruby_incpush()

void ruby_incpush ( const char *  path)

Definition at line 456 of file ruby.c.

References ruby_push_include().

◆ ruby_init_loadpath()

void ruby_init_loadpath ( void  )

◆ ruby_init_stack()

void ruby_init_stack ( volatile VALUE )

◆ ruby_process_options()

void * ruby_process_options ( int  argc,
char **  argv 
)

◆ ruby_prog_init()

void ruby_prog_init ( void  )

◆ ruby_script()

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 2458 of file ruby.c.

References name, rb_orig_progname, rb_progname, and rb_vm_set_progname().

Referenced by ruby_process_options().

◆ ruby_set_argv()

void ruby_set_argv ( int  argc,
char **  argv 
)

Definition at line 2574 of file ruby.c.

References argc, argv, OBJ_FREEZE, rb_argv, rb_ary_clear(), and rb_ary_push().

◆ ruby_set_script_name()

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 2471 of file ruby.c.

References name, rb_orig_progname, rb_progname, rb_str_dup(), and rb_vm_set_progname().

Referenced by Init_version().

◆ ruby_setup()

int ruby_setup ( void  )

Initializes the VM and builtin libraries.

Return values
0if succeeded.
non-zeroan error occurred.

Definition at line 70 of file eval.c.

References EC_EXEC_TAG, EC_POP_TAG, EC_PUSH_TAG, Init_BareVM(), Init_heap(), Init_vm_objects(), rb_call_inits(), rb_vm_encoded_insn_data_table_init(), ruby_init_stack(), ruby_prog_init(), and TAG_NONE.

Referenced by ruby_init().

◆ ruby_sig_finalize()

void ruby_sig_finalize ( void  )

Definition at line 1496 of file signal.c.

References ruby_signal, sighandler_t, and SIGINT.

◆ ruby_stack_check()

int ruby_stack_check ( void  )

Definition at line 5552 of file gc.c.

References stack_check, and STACKFRAME_FOR_CALL_CFUNC.

◆ ruby_stack_length()

size_t ruby_stack_length ( VALUE **  p)

Definition at line 5512 of file gc.c.

References SET_STACK_END, STACK_END, STACK_LENGTH, STACK_START, and STACK_UPPER.

◆ ruby_stop()

void ruby_stop ( int  ex)

Calls ruby_cleanup() and exits the process.

Definition at line 327 of file eval.c.

References ruby_cleanup().

Referenced by rb_exit().