📁 File Manager Pro
v10.0.3 | PHP: 8.1.34
Server: Apache
2026-06-22 18:25:27
📂
/ (Root)
/
opt
/
alt
/
ruby21
/
share
/
doc
/
ruby
/
capi
/
html
/
de
/
d43
📍 /opt/alt/ruby21/share/doc/ruby/capi/html/de/d43
🔄 Refresh
✏️
Editing: group__embed.html
Read Only
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Ruby: CRuby Embedding APIs</title> <link href="../../tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="../../jquery.js"></script> <script type="text/javascript" src="../../dynsections.js"></script> <link href="../../doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Ruby  <span id="projectnumber">2.1.10p492(2016-04-01revision54464)</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript" src="../../menudata.js"></script> <script type="text/javascript" src="../../menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('../../',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#groups">Modules</a> | <a href="#define-members">Macros</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">CRuby Embedding APIs</div> </div> </div><!--header--> <div class="contents"> <p>CRuby interpreter APIs. <a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a> Modules</h2></td></tr> <tr class="memitem:d7/dce/group__ruby1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/dce/group__ruby1.html">ruby(1) implementation</a></td></tr> <tr class="memdesc:d7/dce/group__ruby1"><td class="mdescLeft"> </td><td class="mdescRight">A part of the implementation of ruby(1) command. <br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:ga1b620d9508844b84f2facc6b77bae0c2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#ga1b620d9508844b84f2facc6b77bae0c2">Init_stack</a>(addr)   <a class="el" href="../../de/d43/group__embed.html#gab7d9aa9836c379212b86b985909f7303">ruby_init_stack</a>(addr)</td></tr> <tr class="separator:ga1b620d9508844b84f2facc6b77bae0c2"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:gab7d9aa9836c379212b86b985909f7303"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#gab7d9aa9836c379212b86b985909f7303">ruby_init_stack</a> (volatile <a class="el" href="../../de/de6/ruby_2ruby_8h.html#a3c1d4bfc6a81af60bdcb48744c35f760">VALUE</a> *)</td></tr> <tr class="separator:gab7d9aa9836c379212b86b985909f7303"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga3cdb762fb84f21bf6fed553b81888423"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#ga3cdb762fb84f21bf6fed553b81888423">ruby_setup</a> (void)</td></tr> <tr class="separator:ga3cdb762fb84f21bf6fed553b81888423"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad9a4bb7e06e2ea58231480dc5b3abcdc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#gad9a4bb7e06e2ea58231480dc5b3abcdc">ruby_cleanup</a> (volatile int)</td></tr> <tr class="memdesc:gad9a4bb7e06e2ea58231480dc5b3abcdc"><td class="mdescLeft"> </td><td class="mdescRight">Destructs the VM. <a href="#gad9a4bb7e06e2ea58231480dc5b3abcdc">More...</a><br /></td></tr> <tr class="separator:gad9a4bb7e06e2ea58231480dc5b3abcdc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga5efbdb123063db473a9b82d8250c0b96"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#ga5efbdb123063db473a9b82d8250c0b96">ruby_finalize</a> (void)</td></tr> <tr class="memdesc:ga5efbdb123063db473a9b82d8250c0b96"><td class="mdescLeft"> </td><td class="mdescRight">Runs the VM finalization processes. <a href="#ga5efbdb123063db473a9b82d8250c0b96">More...</a><br /></td></tr> <tr class="separator:ga5efbdb123063db473a9b82d8250c0b96"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gafbcec98f9a6334634c42b236a684baf6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#gafbcec98f9a6334634c42b236a684baf6">NORETURN</a> (void <a class="el" href="../../d0/d85/process_8c.html#af2c2f0407075dba1e3067907fb91ddda">rb_exit</a>(int))</td></tr> <tr class="separator:gafbcec98f9a6334634c42b236a684baf6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaf9718c7d285ce2091e7a1f8724dff839"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#gaf9718c7d285ce2091e7a1f8724dff839">ruby_set_stack_size</a> (size_t)</td></tr> <tr class="separator:gaf9718c7d285ce2091e7a1f8724dff839"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9be1c274a7c6746223f95464b3fe7c45"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#ga9be1c274a7c6746223f95464b3fe7c45">ruby_stack_check</a> (void)</td></tr> <tr class="separator:ga9be1c274a7c6746223f95464b3fe7c45"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaf73c2b3991b1f89c5b3241e2b7e4ed48"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#gaf73c2b3991b1f89c5b3241e2b7e4ed48">ruby_stack_length</a> (<a class="el" href="../../de/de6/ruby_2ruby_8h.html#a3c1d4bfc6a81af60bdcb48744c35f760">VALUE</a> **)</td></tr> <tr class="separator:gaf73c2b3991b1f89c5b3241e2b7e4ed48"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga37e32e7c9181dda6e68eb8e9627baf0c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#ga37e32e7c9181dda6e68eb8e9627baf0c">ruby_exec_node</a> (void *n)</td></tr> <tr class="memdesc:ga37e32e7c9181dda6e68eb8e9627baf0c"><td class="mdescLeft"> </td><td class="mdescRight">Runs the given compiled source. <a href="#ga37e32e7c9181dda6e68eb8e9627baf0c">More...</a><br /></td></tr> <tr class="separator:ga37e32e7c9181dda6e68eb8e9627baf0c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga79f43a6183d996338565fb22430d60c5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#ga79f43a6183d996338565fb22430d60c5">ruby_script</a> (<a class="el" href="../../da/d50/vsnprintf_8c.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char *<a class="el" href="../../db/d97/parse_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>)</td></tr> <tr class="memdesc:ga79f43a6183d996338565fb22430d60c5"><td class="mdescLeft"> </td><td class="mdescRight">Sets the current script name to this value. <a href="#ga79f43a6183d996338565fb22430d60c5">More...</a><br /></td></tr> <tr class="separator:ga79f43a6183d996338565fb22430d60c5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga91ccb58731af718175751a4cd7b6293b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#ga91ccb58731af718175751a4cd7b6293b">ruby_set_script_name</a> (<a class="el" href="../../de/de6/ruby_2ruby_8h.html#a3c1d4bfc6a81af60bdcb48744c35f760">VALUE</a> <a class="el" href="../../db/d97/parse_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>)</td></tr> <tr class="memdesc:ga91ccb58731af718175751a4cd7b6293b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the current script name to this value. <a href="#ga91ccb58731af718175751a4cd7b6293b">More...</a><br /></td></tr> <tr class="separator:ga91ccb58731af718175751a4cd7b6293b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad6a1cc74c8bfe75b72688ca185c14db8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#gad6a1cc74c8bfe75b72688ca185c14db8">ruby_prog_init</a> (void)</td></tr> <tr class="memdesc:gad6a1cc74c8bfe75b72688ca185c14db8"><td class="mdescLeft"> </td><td class="mdescRight">Defines built-in variables. <a href="#gad6a1cc74c8bfe75b72688ca185c14db8">More...</a><br /></td></tr> <tr class="separator:gad6a1cc74c8bfe75b72688ca185c14db8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga2b37b368f133db1234220d20c0c07689"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#ga2b37b368f133db1234220d20c0c07689">ruby_set_argv</a> (int, char **)</td></tr> <tr class="separator:ga2b37b368f133db1234220d20c0c07689"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga77b3346dd4a545359a66113f1e888556"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#ga77b3346dd4a545359a66113f1e888556">ruby_process_options</a> (int, char **)</td></tr> <tr class="separator:ga77b3346dd4a545359a66113f1e888556"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab6a5ac6ba25ac697f5aef14f07f0f5d9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#gab6a5ac6ba25ac697f5aef14f07f0f5d9">ruby_init_loadpath</a> (void)</td></tr> <tr class="separator:gab6a5ac6ba25ac697f5aef14f07f0f5d9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga396d18f1de73ca9b8f6a3896adb3067a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#ga396d18f1de73ca9b8f6a3896adb3067a">ruby_incpush</a> (<a class="el" href="../../da/d50/vsnprintf_8c.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char *)</td></tr> <tr class="separator:ga396d18f1de73ca9b8f6a3896adb3067a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae0fc89013d9cf6ab2afea16f82750789"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d43/group__embed.html#gae0fc89013d9cf6ab2afea16f82750789">ruby_sig_finalize</a> (void)</td></tr> <tr class="separator:gae0fc89013d9cf6ab2afea16f82750789"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>CRuby interpreter APIs. </p> <p>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. </p> <h2 class="groupheader">Macro Definition Documentation</h2> <a id="ga1b620d9508844b84f2facc6b77bae0c2"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga1b620d9508844b84f2facc6b77bae0c2">◆ </a></span>Init_stack</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define Init_stack</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">addr</td><td>)</td> <td>   <a class="el" href="../../de/d43/group__embed.html#gab7d9aa9836c379212b86b985909f7303">ruby_init_stack</a>(addr)</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="../../de/de6/ruby_2ruby_8h_source.html#l01846">1846</a> of file <a class="el" href="../../de/de6/ruby_2ruby_8h_source.html">ruby.h</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a id="gafbcec98f9a6334634c42b236a684baf6"></a> <h2 class="memtitle"><span class="permalink"><a href="#gafbcec98f9a6334634c42b236a684baf6">◆ </a></span>NORETURN()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">NORETURN </td> <td>(</td> <td class="paramtype">void  </td> <td class="paramname"><em>rb_exit</em>int</td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a id="gad9a4bb7e06e2ea58231480dc5b3abcdc"></a> <h2 class="memtitle"><span class="permalink"><a href="#gad9a4bb7e06e2ea58231480dc5b3abcdc">◆ </a></span>ruby_cleanup()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int ruby_cleanup </td> <td>(</td> <td class="paramtype">volatile int </td> <td class="paramname"><em>ex</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Destructs the VM. </p> <p>Runs the VM finalization processes as well as <a class="el" href="../../de/d43/group__embed.html#ga5efbdb123063db473a9b82d8250c0b96" title="Runs the VM finalization processes. ">ruby_finalize()</a>, and frees resources used by the VM.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ex</td><td>Default value to the return value. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>If an error occurred returns a non-zero. If otherwise, returns the given ex. </dd></dl> <dl class="section note"><dt>Note</dt><dd>This function does not raise any exception. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d3/d57/eval_8c_source.html#l00157">157</a> of file <a class="el" href="../../d3/d57/eval_8c_source.html">eval.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/df2/win32_8c_source.html#l00114">err</a>, <a class="el" href="../../d8/d32/vm__core_8h_source.html#l00573">rb_thread_struct::errinfo</a>, <a class="el" href="../../d5/d1d/eval__error_8c_source.html#l00245">error_handle()</a>, <a class="el" href="../../dd/dd0/eval__intern_8h_source.html#l00168">EXEC_TAG</a>, <a class="el" href="../../dd/dd0/eval__intern_8h_source.html#l00024">EXIT_FAILURE</a>, <a class="el" href="../../db/dcc/error_8c_source.html#l00029">EXIT_SUCCESS</a>, <a class="el" href="../../d8/d32/vm__core_8h_source.html#l00929">GET_THREAD()</a>, <a class="el" href="../../d8/d32/vm__core_8h_source.html#l00922">GET_VM</a>, <a class="el" href="../../de/de6/ruby_2ruby_8h_source.html#l00630">NUM2INT</a>, <a class="el" href="../../d5/d97/etc_8c_source.html#l00602">numberof</a>, <a class="el" href="../../dd/dd0/eval__intern_8h_source.html#l00142">POP_TAG</a>, <a class="el" href="../../dd/dd0/eval__intern_8h_source.html#l00141">PUSH_TAG</a>, <a class="el" href="../../db/dcc/error_8c_source.html#l00544">rb_eSignal</a>, <a class="el" href="../../db/dcc/error_8c_source.html#l00542">rb_eSystemExit</a>, <a class="el" href="../../d0/d2a/variable_8c_source.html#l02604">rb_iv_get()</a>, <a class="el" href="../../d0/de1/object_8c_source.html#l00646">rb_obj_is_kind_of()</a>, <a class="el" href="../../d3/de7/thread_8c_source.html#l03860">rb_thread_stop_timer_thread()</a>, <a class="el" href="../../d3/de7/thread_8c_source.html#l00421">rb_thread_terminate_all()</a>, <a class="el" href="../../d3/de7/thread_8c_source.html#l03819">rb_threadptr_check_signal()</a>, <a class="el" href="../../d3/de7/thread_8c_source.html#l00359">rb_threadptr_interrupt()</a>, <a class="el" href="../../d3/de7/thread_8c_source.html#l00404">rb_threadptr_unlock_all_locking_mutexes()</a>, <a class="el" href="../../de/de6/ruby_2ruby_8h_source.html#l01672">RB_TYPE_P</a>, <a class="el" href="../../de/de6/ruby_2ruby_8h_source.html#l00437">RTEST</a>, <a class="el" href="../../d8/d36/signal_8c_source.html#l00340">ruby_default_signal()</a>, <a class="el" href="../../d3/d57/eval_8c_source.html#l00113">ruby_finalize_0()</a>, <a class="el" href="../../d3/d57/eval_8c_source.html#l00125">ruby_finalize_1()</a>, <a class="el" href="../../de/d43/group__embed.html#gab7d9aa9836c379212b86b985909f7303">ruby_init_stack()</a>, <a class="el" href="../../d8/d32/vm__core_8h_source.html#l00991">RUBY_VM_CHECK_INTS</a>, <a class="el" href="../../da/d0a/vm_8h.html#a64b7830f0ac2f5c4e03c3659051b3e4b">ruby_vm_destruct()</a>, <a class="el" href="../../d8/d32/vm__core_8h_source.html#l00532">rb_thread_struct::safe_level</a>, <a class="el" href="../../dd/dd0/eval__intern_8h_source.html#l00112">SAVE_ROOT_JMPBUF</a>, <a class="el" href="../../d0/daa/gc_8h_source.html#l00074">STACK_UPPER</a>, <a class="el" href="../../d8/d32/vm__core_8h_source.html#l00562">rb_thread_struct::status</a>, <a class="el" href="../../d5/d1d/eval__error_8c_source.html#l00238">sysexit_status()</a>, <a class="el" href="../../de/de6/ruby_2ruby_8h_source.html#l00498">T_NODE</a>, and <a class="el" href="../../d8/d32/vm__core_8h_source.html#l00479">THREAD_KILLED</a>.</p> <p class="reference">Referenced by <a class="el" href="../../dd/daa/pepper__main_8c_source.html#l00679">PPP_ShutdownModule()</a>, <a class="el" href="../../d3/d57/eval_8c_source.html#l00303">ruby_run_node()</a>, and <a class="el" href="../../d3/d57/eval_8c_source.html#l00264">ruby_stop()</a>.</p> </div> </div> <a id="ga37e32e7c9181dda6e68eb8e9627baf0c"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga37e32e7c9181dda6e68eb8e9627baf0c">◆ </a></span>ruby_exec_node()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int ruby_exec_node </td> <td>(</td> <td class="paramtype">void * </td> <td class="paramname"><em>n</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Runs the given compiled source. </p> <p class="definition">Definition at line <a class="el" href="../../d3/d57/eval_8c_source.html#l00315">315</a> of file <a class="el" href="../../d3/d57/eval_8c_source.html">eval.c</a>.</p> <p class="reference">References <a class="el" href="../../d3/d57/eval_8c_source.html#l00243">ruby_exec_internal()</a>, and <a class="el" href="../../de/d43/group__embed.html#gab7d9aa9836c379212b86b985909f7303">ruby_init_stack()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d57/eval_8c_source.html#l00303">ruby_run_node()</a>.</p> </div> </div> <a id="ga5efbdb123063db473a9b82d8250c0b96"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga5efbdb123063db473a9b82d8250c0b96">◆ </a></span>ruby_finalize()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ruby_finalize </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Runs the VM finalization processes. </p> <p><code>END{}</code> and procs registered by <code>Kernel.<a class="el" href="../../d5/d9d/tcltklib_8c.html#a0964f0f2c4ef2a9554392a5aaf13b032">at_exit</a></code> are executed here. See the Ruby language spec for more details.</p> <dl class="section note"><dt>Note</dt><dd>This function is allowed to raise an exception if an error occurred. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d3/d57/eval_8c_source.html#l00140">140</a> of file <a class="el" href="../../d3/d57/eval_8c_source.html">eval.c</a>.</p> <p class="reference">References <a class="el" href="../../d3/d57/eval_8c_source.html#l00113">ruby_finalize_0()</a>, and <a class="el" href="../../d3/d57/eval_8c_source.html#l00125">ruby_finalize_1()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d0/d85/process_8c_source.html#l03656">rb_exit()</a>, and <a class="el" href="../../d2/d99/win32ole_8c_source.html#l07820">rescue_callback()</a>.</p> </div> </div> <a id="ga396d18f1de73ca9b8f6a3896adb3067a"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga396d18f1de73ca9b8f6a3896adb3067a">◆ </a></span>ruby_incpush()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ruby_incpush </td> <td>(</td> <td class="paramtype"><a class="el" href="../../da/d50/vsnprintf_8c.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char * </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="../../df/d77/ruby_8c_source.html#l00337">337</a> of file <a class="el" href="../../df/d77/ruby_8c_source.html">ruby.c</a>.</p> <p class="reference">References <a class="el" href="../../df/d77/ruby_8c_source.html#l00330">locale_path()</a>, and <a class="el" href="../../df/d77/ruby_8c_source.html#l00317">ruby_push_include()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../dd/daa/pepper__main_8c_source.html#l00342">init_loadpath()</a>.</p> </div> </div> <a id="gab6a5ac6ba25ac697f5aef14f07f0f5d9"></a> <h2 class="memtitle"><span class="permalink"><a href="#gab6a5ac6ba25ac697f5aef14f07f0f5d9">◆ </a></span>ruby_init_loadpath()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ruby_init_loadpath </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="../../df/d77/ruby_8c_source.html#l00380">380</a> of file <a class="el" href="../../df/d77/ruby_8c_source.html">ruby.c</a>.</p> <p class="reference">References <a class="el" href="../../df/d77/ruby_8c_source.html#l00386">ruby_init_loadpath_safe()</a>.</p> </div> </div> <a id="gab7d9aa9836c379212b86b985909f7303"></a> <h2 class="memtitle"><span class="permalink"><a href="#gab7d9aa9836c379212b86b985909f7303">◆ </a></span>ruby_init_stack()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ruby_init_stack </td> <td>(</td> <td class="paramtype">volatile <a class="el" href="../../de/de6/ruby_2ruby_8h.html#a3c1d4bfc6a81af60bdcb48744c35f760">VALUE</a> * </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p class="reference">Referenced by <a class="el" href="../../d8/d16/gc_8c_source.html#l05127">Init_stack()</a>, <a class="el" href="../../d3/d57/eval_8c_source.html#l00157">ruby_cleanup()</a>, <a class="el" href="../../d3/d57/eval_8c_source.html#l00315">ruby_exec_node()</a>, <a class="el" href="../../d3/d57/eval_8c_source.html#l00093">ruby_options()</a>, and <a class="el" href="../../d3/d57/eval_8c_source.html#l00044">ruby_setup()</a>.</p> </div> </div> <a id="ga77b3346dd4a545359a66113f1e888556"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga77b3346dd4a545359a66113f1e888556">◆ </a></span>ruby_process_options()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void* ruby_process_options </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char ** </td> <td class="paramname"> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="../../df/d77/ruby_8c_source.html#l01960">1960</a> of file <a class="el" href="../../df/d77/ruby_8c_source.html">ruby.c</a>.</p> <p class="reference">References <a class="el" href="../../df/d77/ruby_8c_source.html#l00131">argc</a>, <a class="el" href="../../df/d77/ruby_8c_source.html#l00132">argv</a>, <a class="el" href="../../df/d77/ruby_8c_source.html#l00113">cmdline_options_init()</a>, <a class="el" href="../../df/d77/ruby_8c_source.html#l01321">process_options()</a>, <a class="el" href="../../df/d77/ruby_8c_source.html#l01212">rb_argv0</a>, <a class="el" href="../../d8/d16/gc_8c_source.html#l04923">rb_gc_register_mark_object()</a>, <a class="el" href="../../df/d77/ruby_8c_source.html#l01210">rb_progname</a>, <a class="el" href="../../db/d2e/intern_8h_source.html#l00842">rb_str_new4</a>, <a class="el" href="../../df/d77/ruby_8c_source.html#l01842">ruby_script()</a>, and <a class="el" href="../../df/d77/ruby_8c_source.html#l00097">cmdline_options::script_name</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d57/eval_8c_source.html#l00093">ruby_options()</a>.</p> </div> </div> <a id="gad6a1cc74c8bfe75b72688ca185c14db8"></a> <h2 class="memtitle"><span class="permalink"><a href="#gad6a1cc74c8bfe75b72688ca185c14db8">◆ </a></span>ruby_prog_init()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ruby_prog_init </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Defines built-in variables. </p> <p class="definition">Definition at line <a class="el" href="../../df/d77/ruby_8c_source.html#l01913">1913</a> of file <a class="el" href="../../df/d77/ruby_8c_source.html">ruby.c</a>.</p> <p class="reference">References <a class="el" href="../../df/d77/ruby_8c_source.html#l01896">opt_W_getter()</a>, <a class="el" href="../../df/d77/ruby_8c_source.html#l01795">proc_argv0()</a>, <a class="el" href="../../df/d77/ruby_8c_source.html#l01818">proc_setproctitle()</a>, <a class="el" href="../../db/d2e/intern_8h_source.html#l00681">rb_argv</a>, <a class="el" href="../../d0/d2a/variable_8c_source.html#l02239">rb_define_global_const()</a>, <a class="el" href="../../d0/d2a/variable_8c_source.html#l00585">rb_define_hooked_variable()</a>, <a class="el" href="../../d9/d0c/class_8c_source.html#l01661">rb_define_module_function()</a>, <a class="el" href="../../d0/d2a/variable_8c_source.html#l00604">rb_define_variable()</a>, <a class="el" href="../../de/de6/ruby_2ruby_8h.html#a2e765570aa5fb68b36e0ee87ed60de5f">rb_gvar_readonly_setter()</a>, <a class="el" href="../../de/de6/ruby_2ruby_8h_source.html#l01556">rb_mProcess</a>, <a class="el" href="../../df/d77/ruby_8c_source.html#l01210">rb_progname</a>, <a class="el" href="../../de/de6/ruby_2ruby_8h_source.html#l01484">ruby_debug</a>, <a class="el" href="../../de/de6/ruby_2ruby_8h_source.html#l01483">ruby_verbose</a>, <a class="el" href="../../df/d77/ruby_8c_source.html#l01828">set_arg0()</a>, and <a class="el" href="../../df/d77/ruby_8c_source.html#l01889">verbose_setter()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d57/eval_8c_source.html#l00044">ruby_setup()</a>.</p> </div> </div> <a id="ga79f43a6183d996338565fb22430d60c5"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga79f43a6183d996338565fb22430d60c5">◆ </a></span>ruby_script()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ruby_script </td> <td>(</td> <td class="paramtype"><a class="el" href="../../da/d50/vsnprintf_8c.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char * </td> <td class="paramname"><em>name</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Sets the current script name to this value. </p> <p>This is similar to <code>$0 = name</code> in Ruby level but also affects <code>Method::location</code> and others. </p> <p class="definition">Definition at line <a class="el" href="../../df/d77/ruby_8c_source.html#l01842">1842</a> of file <a class="el" href="../../df/d77/ruby_8c_source.html">ruby.c</a>.</p> <p class="reference">References <a class="el" href="../../d6/da0/nkf-utf8_2nkf_8c_source.html#l00208">name</a>, <a class="el" href="../../d1/db0/string_8c_source.html#l00707">rb_external_str_new()</a>, <a class="el" href="../../df/d77/ruby_8c_source.html#l01211">rb_orig_progname</a>, <a class="el" href="../../df/d77/ruby_8c_source.html#l01210">rb_progname</a>, <a class="el" href="../../de/de9/vm_8c_source.html#l02787">rb_vm_set_progname()</a>, and <a class="el" href="../../d6/d7b/strchr_8c.html#a219836f542ce53545052bed5353820ca">strlen()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../df/d77/ruby_8c_source.html#l01960">ruby_process_options()</a>.</p> </div> </div> <a id="ga2b37b368f133db1234220d20c0c07689"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga2b37b368f133db1234220d20c0c07689">◆ </a></span>ruby_set_argv()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ruby_set_argv </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char ** </td> <td class="paramname"> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="../../df/d77/ruby_8c_source.html#l01939">1939</a> of file <a class="el" href="../../df/d77/ruby_8c_source.html">ruby.c</a>.</p> <p class="reference">References <a class="el" href="../../df/d77/ruby_8c_source.html#l00131">argc</a>, <a class="el" href="../../df/d77/ruby_8c_source.html#l00132">argv</a>, <a class="el" href="../../de/de6/ruby_2ruby_8h_source.html#l01194">OBJ_FREEZE</a>, <a class="el" href="../../df/d77/ruby_8c.html#a258b28246f1ea3e6e9b380f0e04e1bae">origarg</a>, <a class="el" href="../../db/d2e/intern_8h_source.html#l00681">rb_argv</a>, <a class="el" href="../../dc/dcc/array_8c_source.html#l03392">rb_ary_clear()</a>, <a class="el" href="../../dc/dcc/array_8c_source.html#l00900">rb_ary_push()</a>, and <a class="el" href="../../d1/db0/string_8c_source.html#l00713">rb_external_str_new_cstr()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../df/d77/ruby_8c_source.html#l01321">process_options()</a>.</p> </div> </div> <a id="ga91ccb58731af718175751a4cd7b6293b"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga91ccb58731af718175751a4cd7b6293b">◆ </a></span>ruby_set_script_name()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ruby_set_script_name </td> <td>(</td> <td class="paramtype"><a class="el" href="../../de/de6/ruby_2ruby_8h.html#a3c1d4bfc6a81af60bdcb48744c35f760">VALUE</a> </td> <td class="paramname"><em>name</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Sets the current script name to this value. </p> <p>Same as <a class="el" href="../../de/d43/group__embed.html#ga79f43a6183d996338565fb22430d60c5" title="Sets the current script name to this value. ">ruby_script()</a> but accepts a VALUE. </p> <p class="definition">Definition at line <a class="el" href="../../df/d77/ruby_8c_source.html#l01855">1855</a> of file <a class="el" href="../../df/d77/ruby_8c_source.html">ruby.c</a>.</p> <p class="reference">References <a class="el" href="../../d6/da0/nkf-utf8_2nkf_8c_source.html#l00208">name</a>, <a class="el" href="../../df/d77/ruby_8c_source.html#l01211">rb_orig_progname</a>, <a class="el" href="../../df/d77/ruby_8c_source.html#l01210">rb_progname</a>, <a class="el" href="../../d1/db0/string_8c_source.html#l01062">rb_str_dup()</a>, and <a class="el" href="../../de/de9/vm_8c_source.html#l02787">rb_vm_set_progname()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../df/d77/ruby_8c_source.html#l01584">load_file_internal()</a>, and <a class="el" href="../../df/d77/ruby_8c_source.html#l01321">process_options()</a>.</p> </div> </div> <a id="gaf9718c7d285ce2091e7a1f8724dff839"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaf9718c7d285ce2091e7a1f8724dff839">◆ </a></span>ruby_set_stack_size()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ruby_set_stack_size </td> <td>(</td> <td class="paramtype">size_t </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a id="ga3cdb762fb84f21bf6fed553b81888423"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga3cdb762fb84f21bf6fed553b81888423">◆ </a></span>ruby_setup()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int ruby_setup </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="../../d3/d57/eval_8c_source.html#l00044">44</a> of file <a class="el" href="../../d3/d57/eval_8c_source.html">eval.c</a>.</p> <p class="reference">References <a class="el" href="../../dd/dd0/eval__intern_8h_source.html#l00168">EXEC_TAG</a>, <a class="el" href="../../d8/d32/vm__core_8h_source.html#l00922">GET_VM</a>, <a class="el" href="../../de/de9/vm_8c_source.html#l02800">Init_BareVM()</a>, <a class="el" href="../../d8/d16/gc_8c_source.html#l01661">Init_heap()</a>, <a class="el" href="../../dd/dd0/eval__intern_8h_source.html#l00142">POP_TAG</a>, <a class="el" href="../../dd/dd0/eval__intern_8h_source.html#l00141">PUSH_TAG</a>, <a class="el" href="../../d9/dfe/inits_8c_source.html#l00018">rb_call_inits()</a>, <a class="el" href="../../de/d43/group__embed.html#gab7d9aa9836c379212b86b985909f7303">ruby_init_stack()</a>, and <a class="el" href="../../df/d77/ruby_8c_source.html#l01913">ruby_prog_init()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d57/eval_8c_source.html#l00073">ruby_init()</a>.</p> </div> </div> <a id="gae0fc89013d9cf6ab2afea16f82750789"></a> <h2 class="memtitle"><span class="permalink"><a href="#gae0fc89013d9cf6ab2afea16f82750789">◆ </a></span>ruby_sig_finalize()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ruby_sig_finalize </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="../../d8/d36/signal_8c_source.html#l01244">1244</a> of file <a class="el" href="../../d8/d36/signal_8c_source.html">signal.c</a>.</p> <p class="reference">References <a class="el" href="../../d8/d36/signal_8c_source.html#l00616">ruby_signal</a>, <a class="el" href="../../d8/d36/signal_8c_source.html#l00656">sighandler()</a>, <a class="el" href="../../d8/d36/signal_8c_source.html#l00503">sighandler_t</a>, and <a class="el" href="../../dc/db1/win32_8h_source.html#l00495">SIGINT</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d57/eval_8c_source.html#l00125">ruby_finalize_1()</a>.</p> </div> </div> <a id="ga9be1c274a7c6746223f95464b3fe7c45"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga9be1c274a7c6746223f95464b3fe7c45">◆ </a></span>ruby_stack_check()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int ruby_stack_check </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="../../d8/d16/gc_8c_source.html#l03282">3282</a> of file <a class="el" href="../../d8/d16/gc_8c_source.html">gc.c</a>.</p> <p class="reference">References <a class="el" href="../../d8/d16/gc_8c_source.html#l03263">stack_check()</a>, and <a class="el" href="../../d8/d16/gc_8c_source.html#l03279">STACKFRAME_FOR_CALL_CFUNC</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d80/vm__eval_8c_source.html#l00282">stack_check()</a>.</p> </div> </div> <a id="gaf73c2b3991b1f89c5b3241e2b7e4ed48"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaf73c2b3991b1f89c5b3241e2b7e4ed48">◆ </a></span>ruby_stack_length()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t ruby_stack_length </td> <td>(</td> <td class="paramtype"><a class="el" href="../../de/de6/ruby_2ruby_8h.html#a3c1d4bfc6a81af60bdcb48744c35f760">VALUE</a> ** </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="../../d8/d16/gc_8c_source.html#l03253">3253</a> of file <a class="el" href="../../d8/d16/gc_8c_source.html">gc.c</a>.</p> <p class="reference">References <a class="el" href="../../d8/d32/vm__core_8h_source.html#l00929">GET_THREAD()</a>, <a class="el" href="../../d8/d16/gc_8c_source.html#l03224">SET_STACK_END</a>, <a class="el" href="../../d8/d16/gc_8c_source.html#l03228">STACK_END</a>, <a class="el" href="../../d8/d16/gc_8c_source.html#l03236">STACK_LENGTH</a>, <a class="el" href="../../d8/d16/gc_8c_source.html#l03227">STACK_START</a>, and <a class="el" href="../../d0/daa/gc_8h_source.html#l00074">STACK_UPPER</a>.</p> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="../../doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> </body> </html>
💾 Save Changes
❌ Cancel