cyclone/c-api/group__prim.html
2017-02-25 22:15:49 -05:00

177 lines
18 KiB
HTML

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Cyclone Scheme: Primitives</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Cyclone Scheme
&#160;<span id="projectnumber">0.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">Primitives</div> </div>
</div><!--header-->
<div class="contents">
<p>Built-in Scheme functions provided by the runtime library.
<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:group__prim__bv"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__bv.html">Bytevectors</a></td></tr>
<tr class="memdesc:group__prim__bv"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bytevector functions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__cvar"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__cvar.html">C vars</a></td></tr>
<tr class="memdesc:group__prim__cvar"><td class="mdescLeft">&#160;</td><td class="mdescRight">Primitives for the C-variable integration type. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__ch"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__ch.html">Call history</a></td></tr>
<tr class="memdesc:group__prim__ch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functions for maintaining call history. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__char"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__char.html">Characters</a></td></tr>
<tr class="memdesc:group__prim__char"><td class="mdescLeft">&#160;</td><td class="mdescRight">Character functions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__ctrl"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__ctrl.html">Control flow</a></td></tr>
<tr class="memdesc:group__prim__ctrl"><td class="mdescLeft">&#160;</td><td class="mdescRight">Primitives that control the flow of program execution. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__eq"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__eq.html">Equality and type predicates</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__err"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__err.html">Error checking</a></td></tr>
<tr class="memdesc:group__prim__err"><td class="mdescLeft">&#160;</td><td class="mdescRight">Runtime error checks including object type validation, bounds, and number of function arguments. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__ex"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__ex.html">Exception handling</a></td></tr>
<tr class="memdesc:group__prim__ex"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raise and handle Scheme exceptions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__gc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__gc.html">Garbage collection</a></td></tr>
<tr class="memdesc:group__prim__gc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functions to manually trigger a GC. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__io"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__io.html">I/O</a></td></tr>
<tr class="memdesc:group__prim__io"><td class="mdescLeft">&#160;</td><td class="mdescRight">Input/Output functions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__num"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__num.html">Numbers</a></td></tr>
<tr class="memdesc:group__prim__num"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number functions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__pairs"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__pairs.html">Pairs and lists</a></td></tr>
<tr class="memdesc:group__prim__pairs"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functions for working with pairs and lists. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__obj"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__obj.html">Primitive objects</a></td></tr>
<tr class="memdesc:group__prim__obj"><td class="mdescLeft">&#160;</td><td class="mdescRight">Objects added to the global environment at runtime as references to the corresponding primitives. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__str"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__str.html">Strings</a></td></tr>
<tr class="memdesc:group__prim__str"><td class="mdescLeft">&#160;</td><td class="mdescRight">String functions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__sym"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__sym.html">Symbols</a></td></tr>
<tr class="memdesc:group__prim__sym"><td class="mdescLeft">&#160;</td><td class="mdescRight">Symbol functions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__sys"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__sys.html">System interface</a></td></tr>
<tr class="memdesc:group__prim__sys"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functions for interacting with the system. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__thd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__thd.html">Threads</a></td></tr>
<tr class="memdesc:group__prim__thd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Thread-oriented functions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__prim__vec"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__vec.html">Vectors</a></td></tr>
<tr class="memdesc:group__prim__vec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector functions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:gab154b8cf89ddd05acae1578d05597ec3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim_gab154b8cf89ddd05acae1578d05597ec3.html#gab154b8cf89ddd05acae1578d05597ec3">__glo_call_95cc_scheme_base</a>&#160;&#160;&#160;<a class="el" href="group__prim_gadb1be8a5abdf0fe836e84266417d1400.html#gadb1be8a5abdf0fe836e84266417d1400">Cyc_glo_call_cc</a></td></tr>
<tr class="separator:gab154b8cf89ddd05acae1578d05597ec3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga96fe9b0b1e64dad3a56dca83bee3813c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim_ga96fe9b0b1e64dad3a56dca83bee3813c.html#ga96fe9b0b1e64dad3a56dca83bee3813c">__glo_eval_91from_91c_scheme_eval</a>&#160;&#160;&#160;<a class="el" href="group__prim_gae07885205bf58cbc3795cababd5ae547.html#gae07885205bf58cbc3795cababd5ae547">Cyc_glo_eval_from_c</a></td></tr>
<tr class="separator:ga96fe9b0b1e64dad3a56dca83bee3813c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga63b79aa081f1235bc39c394805f8bcb9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim_ga63b79aa081f1235bc39c394805f8bcb9.html#ga63b79aa081f1235bc39c394805f8bcb9">global_set</a>(glo, value)&#160;&#160;&#160;<a class="el" href="group__prim_gae7c758ebd7dc1d85c1bf68dbfc460515.html#gae7c758ebd7dc1d85c1bf68dbfc460515">Cyc_global_set</a>(data, (<a class="el" href="group__objects_ga71301352e6ef9a0fcf7b0a8bae72c535.html#ga71301352e6ef9a0fcf7b0a8bae72c535">object</a> *)&amp;glo, value)</td></tr>
<tr class="separator:ga63b79aa081f1235bc39c394805f8bcb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf57520cddd4b66aed818e6ab9ee788e7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim_gaf57520cddd4b66aed818e6ab9ee788e7.html#gaf57520cddd4b66aed818e6ab9ee788e7">load_varargs</a>(var, arg_var, count)</td></tr>
<tr class="separator:gaf57520cddd4b66aed818e6ab9ee788e7"><td class="memSeparator" colspan="2">&#160;</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:ga2fdfd72d226550857adca7795b464c8b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__objects_ga71301352e6ef9a0fcf7b0a8bae72c535.html#ga71301352e6ef9a0fcf7b0a8bae72c535">object</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim_ga2fdfd72d226550857adca7795b464c8b.html#ga2fdfd72d226550857adca7795b464c8b">cell_get</a> (<a class="el" href="group__objects_ga71301352e6ef9a0fcf7b0a8bae72c535.html#ga71301352e6ef9a0fcf7b0a8bae72c535">object</a> cell)</td></tr>
<tr class="separator:ga2fdfd72d226550857adca7795b464c8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae7c758ebd7dc1d85c1bf68dbfc460515"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__objects_ga71301352e6ef9a0fcf7b0a8bae72c535.html#ga71301352e6ef9a0fcf7b0a8bae72c535">object</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim_gae7c758ebd7dc1d85c1bf68dbfc460515.html#gae7c758ebd7dc1d85c1bf68dbfc460515">Cyc_global_set</a> (void *thd, <a class="el" href="group__objects_ga71301352e6ef9a0fcf7b0a8bae72c535.html#ga71301352e6ef9a0fcf7b0a8bae72c535">object</a> *glo, <a class="el" href="group__objects_ga71301352e6ef9a0fcf7b0a8bae72c535.html#ga71301352e6ef9a0fcf7b0a8bae72c535">object</a> value)</td></tr>
<tr class="separator:gae7c758ebd7dc1d85c1bf68dbfc460515"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9a240612595f5c22331d6f14f2251168"><td class="memItemLeft" align="right" valign="top">char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim_ga9a240612595f5c22331d6f14f2251168.html#ga9a240612595f5c22331d6f14f2251168">get_env_variables</a> ()</td></tr>
<tr class="separator:ga9a240612595f5c22331d6f14f2251168"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabd10ce68a5e67c762c8711cbf2bd57bb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim_gabd10ce68a5e67c762c8711cbf2bd57bb.html#gabd10ce68a5e67c762c8711cbf2bd57bb">pack_env_variables</a> (void *data, <a class="el" href="group__objects_ga71301352e6ef9a0fcf7b0a8bae72c535.html#ga71301352e6ef9a0fcf7b0a8bae72c535">object</a> k)</td></tr>
<tr class="separator:gabd10ce68a5e67c762c8711cbf2bd57bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad4a90351f4237dd82fdda26dcb8066bd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim_gad4a90351f4237dd82fdda26dcb8066bd.html#gad4a90351f4237dd82fdda26dcb8066bd">set_env_variables</a> (char **vars)</td></tr>
<tr class="separator:gad4a90351f4237dd82fdda26dcb8066bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:gadb1be8a5abdf0fe836e84266417d1400"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__objects_ga71301352e6ef9a0fcf7b0a8bae72c535.html#ga71301352e6ef9a0fcf7b0a8bae72c535">object</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim_gadb1be8a5abdf0fe836e84266417d1400.html#gadb1be8a5abdf0fe836e84266417d1400">Cyc_glo_call_cc</a></td></tr>
<tr class="separator:gadb1be8a5abdf0fe836e84266417d1400"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae07885205bf58cbc3795cababd5ae547"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__objects_ga71301352e6ef9a0fcf7b0a8bae72c535.html#ga71301352e6ef9a0fcf7b0a8bae72c535">object</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim_gae07885205bf58cbc3795cababd5ae547.html#gae07885205bf58cbc3795cababd5ae547">Cyc_glo_eval_from_c</a></td></tr>
<tr class="separator:gae07885205bf58cbc3795cababd5ae547"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga26075e97c30bab241fad5cd7bbab5879"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim_ga26075e97c30bab241fad5cd7bbab5879.html#ga26075e97c30bab241fad5cd7bbab5879">global_heap_size</a></td></tr>
<tr class="separator:ga26075e97c30bab241fad5cd7bbab5879"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga40967337a1c3f523ee9623aec0f69388"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim_ga40967337a1c3f523ee9623aec0f69388.html#ga40967337a1c3f523ee9623aec0f69388">global_stack_size</a></td></tr>
<tr class="separator:ga40967337a1c3f523ee9623aec0f69388"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Built-in Scheme functions provided by the runtime library. </p>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>