libcattle-1.0-doc 1.2.2-2 / usr / share / gtk-doc / html / cattle-1.0 / CattleProgram.html

This file is indexed.

/usr/share/gtk-doc/html/cattle-1.0/CattleProgram.html is in libcattle-1.0-doc 1.2.2-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CattleProgram: Cattle Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Cattle Reference Manual">
<link rel="up" href="ch03.html" title="Objects">
<link rel="prev" href="CattleInstruction.html" title="CattleInstruction">
<link rel="next" href="CattleConfiguration.html" title="CattleConfiguration">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#CattleProgram.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#CattleProgram.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#CattleProgram.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="CattleInstruction.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="CattleConfiguration.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="CattleProgram"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CattleProgram.top_of_page"></a>CattleProgram</span></h2>
<p>CattleProgram — Brainfuck program (and possibly its input)</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="CattleProgram.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="CattleProgram.html" title="CattleProgram"><span class="returnvalue">CattleProgram</span></a> *
</td>
<td class="function_name">
<a class="link" href="CattleProgram.html#cattle-program-new" title="cattle_program_new ()">cattle_program_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="CattleProgram.html#cattle-program-load" title="cattle_program_load ()">cattle_program_load</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="CattleProgram.html#cattle-program-set-instructions" title="cattle_program_set_instructions ()">cattle_program_set_instructions</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="CattleInstruction.html" title="CattleInstruction"><span class="returnvalue">CattleInstruction</span></a> *
</td>
<td class="function_name">
<a class="link" href="CattleProgram.html#cattle-program-get-instructions" title="cattle_program_get_instructions ()">cattle_program_get_instructions</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="CattleProgram.html#cattle-program-set-input" title="cattle_program_set_input ()">cattle_program_set_input</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="CattleBuffer.html" title="CattleBuffer"><span class="returnvalue">CattleBuffer</span></a> *
</td>
<td class="function_name">
<a class="link" href="CattleProgram.html#cattle-program-get-input" title="cattle_program_get_input ()">cattle_program_get_input</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CattleProgram.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="CattleBuffer.html" title="CattleBuffer"><span class="type">CattleBuffer</span></a> *</td>
<td class="property_name"><a class="link" href="CattleProgram.html#CattleProgram--input" title="The “input” property">input</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="CattleInstruction.html" title="CattleInstruction"><span class="type">CattleInstruction</span></a> *</td>
<td class="property_name"><a class="link" href="CattleProgram.html#CattleProgram--instructions" title="The “instructions” property">instructions</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CattleProgram.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="CattleProgram.html#CattleProgram-struct" title="struct CattleProgram">CattleProgram</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CattleProgram.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> CattleProgram
</pre>
</div>
<div class="refsect1">
<a name="CattleProgram.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;cattle/cattle.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="CattleProgram.description"></a><h2>Description</h2>
<p>A <a class="link" href="CattleProgram.html" title="CattleProgram"><span class="type">CattleProgram</span></a> represents a complete Brainfuck program, that is,
the instructions to be executed and possibly its input.</p>
<p>The input for a program can optionally be specified in the source
file, and it's separated from the program code by a bang (!)
symbol. For example, given the following input:</p>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="gtkdoc opt">,+.!</span>sometext</pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
<p>the program's code is ",+." while the program's input is
"sometext".</p>
<p>Any Brainfuck instruction after the bang symbol is considered part
of the input, and as such is not executed. Subsequent bang symbols
are also considered part of the input.</p>
</div>
<div class="refsect1">
<a name="CattleProgram.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="cattle-program-new"></a><h3>cattle_program_new ()</h3>
<pre class="programlisting"><a class="link" href="CattleProgram.html" title="CattleProgram"><span class="returnvalue">CattleProgram</span></a> *
cattle_program_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Create a new <a class="link" href="CattleProgram.html" title="CattleProgram"><span class="type">CattleProgram</span></a>.</p>
<p>A single instance of a program can be shared between multiple
interpreters, as long as the object is not modified after it
has been initialized.</p>
<div class="refsect3">
<a name="cattle-program-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="CattleProgram.html" title="CattleProgram"><span class="type">CattleProgram</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cattle-program-load"></a><h3>cattle_program_load ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
cattle_program_load (<em class="parameter"><code><a class="link" href="CattleProgram.html" title="CattleProgram"><span class="type">CattleProgram</span></a> *program</code></em>,
                     <em class="parameter"><code><a class="link" href="CattleBuffer.html" title="CattleBuffer"><span class="type">CattleBuffer</span></a> *buffer</code></em>,
                     <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Load <em class="parameter"><code>program</code></em>
 from <em class="parameter"><code>buffer</code></em>
.</p>
<p>The buffer can optionally contain also the input for the program:
in that case, the input must be separated from the code by a bang
(!) character.</p>
<p>In case of failure, <em class="parameter"><code>error</code></em>
 is filled with detailed information.
The error domain is <a class="link" href="cattle-1.0-Error-Types.html#CATTLE-ERROR:CAPS" title="CATTLE_ERROR"><code class="literal">CATTLE_ERROR</code></a>, and the error code is from the
<a class="link" href="cattle-1.0-Error-Types.html#CattleError" title="enum CattleError"><span class="type">CattleError</span></a> enumeration.</p>
<div class="refsect3">
<a name="cattle-program-load.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>program</p></td>
<td class="parameter_description"><p>a <a class="link" href="CattleProgram.html" title="CattleProgram"><span class="type">CattleProgram</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p> a <a class="link" href="CattleBuffer.html" title="CattleBuffer"><span class="type">CattleBuffer</span></a> containing the code. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cattle-program-load.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cattle-program-set-instructions"></a><h3>cattle_program_set_instructions ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cattle_program_set_instructions (<em class="parameter"><code><a class="link" href="CattleProgram.html" title="CattleProgram"><span class="type">CattleProgram</span></a> *program</code></em>,
                                 <em class="parameter"><code><a class="link" href="CattleInstruction.html" title="CattleInstruction"><span class="type">CattleInstruction</span></a> *instructions</code></em>);</pre>
<p>Set the instructions for <em class="parameter"><code>program</code></em>
.</p>
<p>You shouldn't usually need to use this: see <a class="link" href="CattleProgram.html#cattle-program-load" title="cattle_program_load ()"><code class="function">cattle_program_load()</code></a>
for the standard way to load a program.</p>
<div class="refsect3">
<a name="cattle-program-set-instructions.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>program</p></td>
<td class="parameter_description"><p>a <a class="link" href="CattleProgram.html" title="CattleProgram"><span class="type">CattleProgram</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>instructions</p></td>
<td class="parameter_description"><p> instructions for <em class="parameter"><code>program</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cattle-program-get-instructions"></a><h3>cattle_program_get_instructions ()</h3>
<pre class="programlisting"><a class="link" href="CattleInstruction.html" title="CattleInstruction"><span class="returnvalue">CattleInstruction</span></a> *
cattle_program_get_instructions (<em class="parameter"><code><a class="link" href="CattleProgram.html" title="CattleProgram"><span class="type">CattleProgram</span></a> *program</code></em>);</pre>
<p>Get the instructions for <em class="parameter"><code>program</code></em>
.
See <a class="link" href="CattleProgram.html#cattle-program-load" title="cattle_program_load ()"><code class="function">cattle_program_load()</code></a> and <a class="link" href="CattleProgram.html#cattle-program-set-instructions" title="cattle_program_set_instructions ()"><code class="function">cattle_program_set_instructions()</code></a>.</p>
<div class="refsect3">
<a name="cattle-program-get-instructions.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>program</p></td>
<td class="parameter_description"><p>a <a class="link" href="CattleProgram.html" title="CattleProgram"><span class="type">CattleProgram</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cattle-program-get-instructions.returns"></a><h4>Returns</h4>
<p> the first instruction in <em class="parameter"><code>program</code></em>
. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cattle-program-set-input"></a><h3>cattle_program_set_input ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cattle_program_set_input (<em class="parameter"><code><a class="link" href="CattleProgram.html" title="CattleProgram"><span class="type">CattleProgram</span></a> *program</code></em>,
                          <em class="parameter"><code><a class="link" href="CattleBuffer.html" title="CattleBuffer"><span class="type">CattleBuffer</span></a> *input</code></em>);</pre>
<p>Set the input for <em class="parameter"><code>program</code></em>
.</p>
<p>If the size of <em class="parameter"><code>input</code></em>
 is zero, the program's input will be retrieved
at runtime.</p>
<div class="refsect3">
<a name="cattle-program-set-input.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>program</p></td>
<td class="parameter_description"><p>a <a class="link" href="CattleProgram.html" title="CattleProgram"><span class="type">CattleProgram</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>input</p></td>
<td class="parameter_description"><p> input for <em class="parameter"><code>program</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cattle-program-get-input"></a><h3>cattle_program_get_input ()</h3>
<pre class="programlisting"><a class="link" href="CattleBuffer.html" title="CattleBuffer"><span class="returnvalue">CattleBuffer</span></a> *
cattle_program_get_input (<em class="parameter"><code><a class="link" href="CattleProgram.html" title="CattleProgram"><span class="type">CattleProgram</span></a> *program</code></em>);</pre>
<p>Get the input for <em class="parameter"><code>program</code></em>
.
See <a class="link" href="CattleProgram.html#cattle-program-set-input" title="cattle_program_set_input ()"><code class="function">cattle_program_set_input()</code></a>.</p>
<div class="refsect3">
<a name="cattle-program-get-input.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>program</p></td>
<td class="parameter_description"><p>a <a class="link" href="CattleProgram.html" title="CattleProgram"><span class="type">CattleProgram</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cattle-program-get-input.returns"></a><h4>Returns</h4>
<p> input for <em class="parameter"><code>program</code></em>
. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="CattleProgram.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CattleProgram-struct"></a><h3>struct CattleProgram</h3>
<pre class="programlisting">struct CattleProgram;</pre>
<p>Opaque data structure representing a program. It should never be
accessed directly; use the methods below instead.</p>
</div>
</div>
<div class="refsect1">
<a name="CattleProgram.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="CattleProgram--input"></a><h3>The <code class="literal">“input”</code> property</h3>
<pre class="programlisting">  “input”                    <a class="link" href="CattleBuffer.html" title="CattleBuffer"><span class="type">CattleBuffer</span></a> *</pre>
<p>Input for the program, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no input was available
at the time of loading.</p>
<p>Changes to this property are not notified.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="CattleProgram--instructions"></a><h3>The <code class="literal">“instructions”</code> property</h3>
<pre class="programlisting">  “instructions”             <a class="link" href="CattleInstruction.html" title="CattleInstruction"><span class="type">CattleInstruction</span></a> *</pre>
<p>Instructions for the program.</p>
<p>Changes to this property are not notified.</p>
<p>Flags: Read / Write</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.