kirke-docs/group__io.html at master · this-kirke/kirke-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libkirke: IO</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom_dark_theme.css" rel="stylesheet" type="text/css"/>
<link href="custom.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">libkirke
   </div>
   <div id="projectbrief">Generic functionality for building C applications.</div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.svg"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)"
               onblur="searchBox.OnSearchFieldFocus(false)"
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__io.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">IO</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gaaf6053bd62e90ef9bce3563121345c4d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io.html#gaaf6053bd62e90ef9bce3563121345c4d">IO__Error</a> { <a class="el" href="group__io.html#ggaaf6053bd62e90ef9bce3563121345c4dabe168a907fad535d639ef615c44d044d">IO__Error__UnableToOpenFile</a> = 1
 }</td></tr>
<tr class="memdesc:gaaf6053bd62e90ef9bce3563121345c4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This enumerator defines possible <a class="el" href="structError.html" title="A structure which represents a recoverable runtime error which was encountered.">Error</a> types for IO functions.  <a href="group__io.html#gaaf6053bd62e90ef9bce3563121345c4d">More...</a><br /></td></tr>
<tr class="separator:gaaf6053bd62e90ef9bce3563121345c4d"><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:gaa0943605ba2cfeacd414c065394ff6ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="io_8h.html#a54ad19f2d17915dbf4eb4c2fa2fa8680">String</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io.html#gaa0943605ba2cfeacd414c065394ff6ac">io__read_text_file</a> (<a class="el" href="structAllocator.html">Allocator</a> *allocator, <a class="el" href="io_8h.html#a54ad19f2d17915dbf4eb4c2fa2fa8680">String</a> *file_path, <a class="el" href="structError.html">Error</a> *error)</td></tr>
<tr class="memdesc:gaa0943605ba2cfeacd414c065394ff6ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method reads the contents of the file located at <code>file_path</code> into a newly-allocated Slice.  <a href="group__io.html#gaa0943605ba2cfeacd414c065394ff6ac">More...</a><br /></td></tr>
<tr class="separator:gaa0943605ba2cfeacd414c065394ff6ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga04c52d339b81cb0f5fbcfe5404103433"><td class="memItemLeft" align="right" valign="top"><a class="el" href="io_8h.html#a54ad19f2d17915dbf4eb4c2fa2fa8680">String</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io.html#ga04c52d339b81cb0f5fbcfe5404103433">io__read_stdin</a> (<a class="el" href="structAllocator.html">Allocator</a> *allocator)</td></tr>
<tr class="memdesc:ga04c52d339b81cb0f5fbcfe5404103433"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method reads the contents of stdin into a newly-allocated String.  <a href="group__io.html#ga04c52d339b81cb0f5fbcfe5404103433">More...</a><br /></td></tr>
<tr class="separator:ga04c52d339b81cb0f5fbcfe5404103433"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gaaf6053bd62e90ef9bce3563121345c4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaf6053bd62e90ef9bce3563121345c4d">&#9670;&nbsp;</a></span>IO__Error</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__io.html#gaaf6053bd62e90ef9bce3563121345c4d">IO__Error</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This enumerator defines possible <a class="el" href="structError.html" title="A structure which represents a recoverable runtime error which was encountered.">Error</a> types for IO functions. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaaf6053bd62e90ef9bce3563121345c4dabe168a907fad535d639ef615c44d044d"></a>IO__Error__UnableToOpenFile&#160;</td><td class="fielddoc"><p>Denotes that an error occurred because the specified file could not be found. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga04c52d339b81cb0f5fbcfe5404103433"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga04c52d339b81cb0f5fbcfe5404103433">&#9670;&nbsp;</a></span>io__read_stdin()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="io_8h.html#a54ad19f2d17915dbf4eb4c2fa2fa8680">String</a>* io__read_stdin </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structAllocator.html">Allocator</a> *&#160;</td>
          <td class="paramname"><em>allocator</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This method reads the contents of stdin into a newly-allocated String. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">allocator</td><td>A pointer to the <a class="el" href="structAllocator.html" title="Allocator is a simple vtable for functions which manage memory.">Allocator</a> which will be used to allocate memory for the returned String. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to a newly-allocated String containing the contents of stdin. </dd></dl>

</div>
</div>
<a id="gaa0943605ba2cfeacd414c065394ff6ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa0943605ba2cfeacd414c065394ff6ac">&#9670;&nbsp;</a></span>io__read_text_file()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="io_8h.html#a54ad19f2d17915dbf4eb4c2fa2fa8680">String</a>* io__read_text_file </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structAllocator.html">Allocator</a> *&#160;</td>
          <td class="paramname"><em>allocator</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="io_8h.html#a54ad19f2d17915dbf4eb4c2fa2fa8680">String</a> *&#160;</td>
          <td class="paramname"><em>file_path</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structError.html">Error</a> *&#160;</td>
          <td class="paramname"><em>error</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This method reads the contents of the file located at <code>file_path</code> into a newly-allocated Slice. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">allocator</td><td>A pointer to the <a class="el" href="structAllocator.html" title="Allocator is a simple vtable for functions which manage memory.">Allocator</a> which will be used to allocate memory controlled by the returned Slice. </td></tr>
    <tr><td class="paramname">file_path</td><td>A pointer to a String containing the path of the file to be read. </td></tr>
    <tr><td class="paramname">error</td><td>Optional. The address of a pointer to an <a class="el" href="structError.html" title="A structure which represents a recoverable runtime error which was encountered.">Error</a> structure, which will be non-NULL upon return if an error is encountered while attempting to read the specified file. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to a newly-allocated String containing the contents of the file. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
  </ul>
</div>
</body>
</html>