Skip to content

Commit 1bfec47

Browse files
committed
Merge pull request #24 from sagmor/master
C API documentation website
2 parents 36a8a4b + c517a9c commit 1bfec47

File tree

267 files changed

+29450
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

267 files changed

+29450
-1
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
_site
1+
_site
2+
mruby

docs/c-api/annotated.html

Lines changed: 152 additions & 0 deletions
Large diffs are not rendered by default.

docs/c-api/array_8h.html

Lines changed: 225 additions & 0 deletions
Large diffs are not rendered by default.

docs/c-api/array_8h_source.html

Lines changed: 202 additions & 0 deletions
Large diffs are not rendered by default.

docs/c-api/arrowdown.png

246 Bytes
Loading

docs/c-api/arrowright.png

229 Bytes
Loading

docs/c-api/bc_s.png

676 Bytes
Loading

docs/c-api/bdwn.png

147 Bytes
Loading

docs/c-api/boxing__nan_8h_source.html

Lines changed: 204 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
<!-- HTML header for doxygen 1.8.8-->
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
<html xmlns="http://www.w3.org/1999/xhtml">
4+
<head>
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<!-- For Mobile Devices -->
7+
<meta name="viewport" content="width=device-width, initial-scale=1">
8+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
9+
<meta name="generator" content="Doxygen 1.8.9.1"/>
10+
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
11+
<title>MRuby C API: mruby/boxing_no.h Source File</title>
12+
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
13+
<script type="text/javascript" src="dynsections.js"></script>
14+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
15+
<script type="text/javascript" src="search/searchdata.js"></script>
16+
<script type="text/javascript" src="search/search.js"></script>
17+
<script type="text/javascript">
18+
$(document).ready(function() { init_search(); });
19+
</script>
20+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
21+
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
22+
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
23+
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
24+
<script type="text/javascript" src="doxy-boot.js"></script>
25+
</head>
26+
<body>
27+
<nav class="navbar navbar-default" role="navigation">
28+
<div class="container">
29+
<div class="navbar-header">
30+
<a class="navbar-brand">MRuby C API </a>
31+
</div>
32+
</div>
33+
</nav>
34+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
35+
<div class="content" id="content">
36+
<div class="container">
37+
<div class="row">
38+
<div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
39+
<div style="margin-bottom: 15px;">
40+
<!-- end header part -->
41+
<!-- Generated by Doxygen 1.8.9.1 -->
42+
<script type="text/javascript">
43+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
44+
</script>
45+
<div id="navrow1" class="tabs">
46+
<ul class="tablist">
47+
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
48+
<li><a href="modules.html"><span>Modules</span></a></li>
49+
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
50+
<li class="current"><a href="files.html"><span>Files</span></a></li>
51+
<li>
52+
<div id="MSearchBox" class="MSearchBoxInactive">
53+
<span class="left">
54+
<img id="MSearchSelect" src="search/mag_sel.png"
55+
onmouseover="return searchBox.OnSearchSelectShow()"
56+
onmouseout="return searchBox.OnSearchSelectHide()"
57+
alt=""/>
58+
<input type="text" id="MSearchField" value="Search" accesskey="S"
59+
onfocus="searchBox.OnSearchFieldFocus(true)"
60+
onblur="searchBox.OnSearchFieldFocus(false)"
61+
onkeyup="searchBox.OnSearchFieldChange(event)"/>
62+
</span><span class="right">
63+
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
64+
</span>
65+
</div>
66+
</li>
67+
</ul>
68+
</div>
69+
<div id="navrow2" class="tabs2">
70+
<ul class="tablist">
71+
<li><a href="files.html"><span>File&#160;List</span></a></li>
72+
<li><a href="globals.html"><span>Globals</span></a></li>
73+
</ul>
74+
</div>
75+
<!-- window showing the filter options -->
76+
<div id="MSearchSelectWindow"
77+
onmouseover="return searchBox.OnSearchSelectShow()"
78+
onmouseout="return searchBox.OnSearchSelectHide()"
79+
onkeydown="return searchBox.OnSearchSelectKey(event)">
80+
</div>
81+
82+
<!-- iframe showing the search results (closed by default) -->
83+
<div id="MSearchResultsWindow">
84+
<iframe src="javascript:void(0)" frameborder="0"
85+
name="MSearchResults" id="MSearchResults">
86+
</iframe>
87+
</div>
88+
89+
<div id="nav-path" class="navpath">
90+
<ul>
91+
<li class="navelem"><a class="el" href="dir_c322d02e4f23ec37ca1bc15eaa8ecbb9.html">mruby</a></li> </ul>
92+
</div>
93+
</div><!-- top -->
94+
<div class="header">
95+
<div class="headertitle">
96+
<div class="title">boxing_no.h</div> </div>
97+
</div><!--header-->
98+
<div class="contents">
99+
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
100+
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">** mruby/boxing_no.h - unboxed mrb_value definition</span></div>
101+
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">**</span></div>
102+
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">** See Copyright Notice in mruby.h</span></div>
103+
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">*/</span></div>
104+
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;</div>
105+
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#ifndef MRUBY_BOXING_NO_H</span></div>
106+
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define MRUBY_BOXING_NO_H</span></div>
107+
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div>
108+
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#define MRB_FIXNUM_SHIFT 0</span></div>
109+
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#define MRB_TT_HAS_BASIC MRB_TT_OBJECT</span></div>
110+
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
111+
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structmrb__value.html">mrb_value</a> {</div>
112+
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; <span class="keyword">union </span>{</div>
113+
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; mrb_float f;</div>
114+
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keywordtype">void</span> *p;</div>
115+
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; mrb_int i;</div>
116+
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; mrb_sym sym;</div>
117+
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; } value;</div>
118+
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">enum</span> mrb_vtype tt;</div>
119+
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;} <a class="code" href="structmrb__value.html">mrb_value</a>;</div>
120+
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
121+
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#define mrb_float_pool(mrb,f) mrb_float_value(mrb,f)</span></div>
122+
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div>
123+
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#define mrb_ptr(o) (o).value.p</span></div>
124+
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#define mrb_cptr(o) mrb_ptr(o)</span></div>
125+
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#define mrb_float(o) (o).value.f</span></div>
126+
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#define mrb_fixnum(o) (o).value.i</span></div>
127+
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#define mrb_symbol(o) (o).value.sym</span></div>
128+
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#define mrb_type(o) (o).tt</span></div>
129+
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
130+
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#define BOXNIX_SET_VALUE(o, ttt, attr, v) do {\</span></div>
131+
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor"> (o).tt = ttt;\</span></div>
132+
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor"> (o).attr = v;\</span></div>
133+
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">} while (0)</span></div>
134+
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
135+
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#define SET_NIL_VALUE(r) BOXNIX_SET_VALUE(r, MRB_TT_FALSE, value.i, 0)</span></div>
136+
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#define SET_FALSE_VALUE(r) BOXNIX_SET_VALUE(r, MRB_TT_FALSE, value.i, 1)</span></div>
137+
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#define SET_TRUE_VALUE(r) BOXNIX_SET_VALUE(r, MRB_TT_TRUE, value.i, 1)</span></div>
138+
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#define SET_BOOL_VALUE(r,b) BOXNIX_SET_VALUE(r, b ? MRB_TT_TRUE : MRB_TT_FALSE, value.i, 1)</span></div>
139+
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#define SET_INT_VALUE(r,n) BOXNIX_SET_VALUE(r, MRB_TT_FIXNUM, value.i, (n))</span></div>
140+
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#define SET_FLOAT_VALUE(mrb,r,v) BOXNIX_SET_VALUE(r, MRB_TT_FLOAT, value.f, (v))</span></div>
141+
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#define SET_SYM_VALUE(r,v) BOXNIX_SET_VALUE(r, MRB_TT_SYMBOL, value.sym, (v))</span></div>
142+
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#define SET_OBJ_VALUE(r,v) BOXNIX_SET_VALUE(r, (((struct RObject*)(v))-&gt;tt), value.p, (v))</span></div>
143+
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#define SET_CPTR_VALUE(mrb,r,v) BOXNIX_SET_VALUE(r, MRB_TT_CPTR, value.p, v)</span></div>
144+
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#define SET_UNDEF_VALUE(r) BOXNIX_SET_VALUE(r, MRB_TT_UNDEF, value.i, 0)</span></div>
145+
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
146+
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* MRUBY_BOXING_NO_H */</span><span class="preprocessor"></span></div>
147+
<div class="ttc" id="structmrb__value_html"><div class="ttname"><a href="structmrb__value.html">mrb_value</a></div><div class="ttdef"><b>Definition:</b> boxing_nan.h:35</div></div>
148+
</div><!-- fragment --></div><!-- contents -->
149+
<!-- HTML footer for doxygen 1.8.8-->
150+
<!-- start footer part -->
151+
</div>
152+
</div>
153+
</div>
154+
</div>
155+
</div>
156+
<hr class="footer"/><address class="footer"><small>
157+
</small></address>
158+
</body>
159+
</html>

0 commit comments

Comments
 (0)