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

114 lines
8.6 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: Immediate objects</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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Immediate objects<div class="ingroups"><a class="el" href="group__datatypes.html">Data types</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Objects that do not require memory allocation.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga91fe9537fe0d1c32e03cb1b8ebf5ed88"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__immediates_ga91fe9537fe0d1c32e03cb1b8ebf5ed88.html#ga91fe9537fe0d1c32e03cb1b8ebf5ed88">CYC_FIXNUM_MAX</a>&#160;&#160;&#160;1073741823</td></tr>
<tr class="separator:ga91fe9537fe0d1c32e03cb1b8ebf5ed88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga52e61d0dd752e0899cbec91cfc925f8f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__immediates_ga52e61d0dd752e0899cbec91cfc925f8f.html#ga52e61d0dd752e0899cbec91cfc925f8f">CYC_FIXNUM_MIN</a>&#160;&#160;&#160;-1073741824</td></tr>
<tr class="separator:ga52e61d0dd752e0899cbec91cfc925f8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga57936aa324ea2422e81e7f3315caf8cc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__immediates_ga57936aa324ea2422e81e7f3315caf8cc.html#ga57936aa324ea2422e81e7f3315caf8cc">is_object_type</a>(x)&#160;&#160;&#160;(x &amp;&amp; !<a class="el" href="group__immediates_gafc6af90619bb95334e37d574a14e4cd5.html#gafc6af90619bb95334e37d574a14e4cd5">is_value_type</a>(x))</td></tr>
<tr class="separator:ga57936aa324ea2422e81e7f3315caf8cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafc6af90619bb95334e37d574a14e4cd5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__immediates_gafc6af90619bb95334e37d574a14e4cd5.html#gafc6af90619bb95334e37d574a14e4cd5">is_value_type</a>(x)&#160;&#160;&#160;((unsigned long)(x) &amp; (unsigned long)3)</td></tr>
<tr class="separator:gafc6af90619bb95334e37d574a14e4cd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaef8292a2af87ee008b7f938203b8c0b4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__immediates_gaef8292a2af87ee008b7f938203b8c0b4.html#gaef8292a2af87ee008b7f938203b8c0b4">obj_char2obj</a>(c)&#160;&#160;&#160;((void *)((((unsigned long)c)&lt;&lt;2) | 2))</td></tr>
<tr class="separator:gaef8292a2af87ee008b7f938203b8c0b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga22f35d58167c6490d581528a564de8fe"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__immediates_ga22f35d58167c6490d581528a564de8fe.html#ga22f35d58167c6490d581528a564de8fe">obj_int2obj</a>(c)&#160;&#160;&#160;((void *)((((long)c)&lt;&lt;1) | 1))</td></tr>
<tr class="separator:ga22f35d58167c6490d581528a564de8fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2ccdc7b4c0eea0bab0fd75ca52ab08a5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__immediates_ga2ccdc7b4c0eea0bab0fd75ca52ab08a5.html#ga2ccdc7b4c0eea0bab0fd75ca52ab08a5">obj_is_char</a>(x)&#160;&#160;&#160;(((unsigned long)(x) &amp; (unsigned long)3) == 2)</td></tr>
<tr class="separator:ga2ccdc7b4c0eea0bab0fd75ca52ab08a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga12581fdcaf8eca4346df3d519046e253"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__immediates_ga12581fdcaf8eca4346df3d519046e253.html#ga12581fdcaf8eca4346df3d519046e253">obj_is_int</a>(x)&#160;&#160;&#160;((unsigned long)(x) &amp; (unsigned long)1)</td></tr>
<tr class="separator:ga12581fdcaf8eca4346df3d519046e253"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6476992ed7a19d5ea31e0dbded085a66"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__immediates_ga6476992ed7a19d5ea31e0dbded085a66.html#ga6476992ed7a19d5ea31e0dbded085a66">obj_obj2char</a>(x)&#160;&#160;&#160;(char)((long)(x)&gt;&gt;2)</td></tr>
<tr class="separator:ga6476992ed7a19d5ea31e0dbded085a66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9e32dd92edfac772bf586c77be4334fc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__immediates_ga9e32dd92edfac772bf586c77be4334fc.html#ga9e32dd92edfac772bf586c77be4334fc">obj_obj2int</a>(x)&#160;&#160;&#160;((long)(x)&gt;&gt;1)</td></tr>
<tr class="separator:ga9e32dd92edfac772bf586c77be4334fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Objects that do not require memory allocation. </p>
<p>Immediate objects (also known as value types) are stored directly within the bits that would otherwise be a pointer to an object type. Since all of the data is contained in those bits, a value type is never allocated on the heap and never needs to be garbage collected, making them very efficient.</p>
<p>Depending on the underlying architecture, compiler, etc these types have extra least significant bits that can be used to mark them as values instead of objects (IE, pointer to a tagged object). On many machines, addresses are multiples of four, leaving the two least significant bits free - from lisp in small pieces.</p>
<p>The possible types are:</p>
<ul>
<li>0x00 - pointer (an object type)</li>
<li>0x01 - integer (also known as fixnum)</li>
<li>0x10 - char </li>
</ul>
</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>