liboil0.3-doc 0.3.17-2 / usr / share / gtk-doc / html / liboil / liboil-liboiltest.html

This file is indexed.

/usr/share/gtk-doc/html/liboil/liboil-liboiltest.html is in liboil0.3-doc 0.3.17-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
396
397
398
399
400
401
402
403
404
405
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OilTest</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="Liboil Reference Manual">
<link rel="up" href="ch02.html" title="Liboil Unstable API">
<link rel="prev" href="liboil-liboilrandom.html" title="Random Number Generation">
<link rel="next" href="liboil-liboiltypes.html" title="liboiltypes">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Liboil Stable API">
<link rel="chapter" href="ch02.html" title="Liboil Unstable API">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="liboil-liboilrandom.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Liboil Reference Manual</th>
<td><a accesskey="n" href="liboil-liboiltypes.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#liboil-liboiltest.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#liboil-liboiltest.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="OilTest">
<a name="liboil-liboiltest"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="liboil-liboiltest.top_of_page"></a>OilTest</span></h2>
<p>OilTest — Test and profile function implementations.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="liboil-liboiltest.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a>;
void                (<a class="link" href="liboil-liboiltest.html#OilTestFunction" title="OilTestFunction ()">*OilTestFunction</a>)                  (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);
#define             <a class="link" href="liboil-liboiltest.html#OIL-TEST-HEADER--CAPS" title="OIL_TEST_HEADER">OIL_TEST_HEADER</a>
#define             <a class="link" href="liboil-liboiltest.html#OIL-TEST-FOOTER--CAPS" title="OIL_TEST_FOOTER">OIL_TEST_FOOTER</a>
<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *           <a class="link" href="liboil-liboiltest.html#oil-test-new" title="oil_test_new ()">oil_test_new</a>                        (<a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> *klass);
void                <a class="link" href="liboil-liboiltest.html#oil-test-init" title="oil_test_init ()">oil_test_init</a>                       (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);
void                <a class="link" href="liboil-liboiltest.html#oil-test-free" title="oil_test_free ()">oil_test_free</a>                       (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);
void                <a class="link" href="liboil-liboiltest.html#oil-test-set-iterations" title="oil_test_set_iterations ()">oil_test_set_iterations</a>             (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
                                                         int iterations);
void                <a class="link" href="liboil-liboiltest.html#oil-test-check-ref" title="oil_test_check_ref ()">oil_test_check_ref</a>                  (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);
int                 <a class="link" href="liboil-liboiltest.html#oil-test-check-impl" title="oil_test_check_impl ()">oil_test_check_impl</a>                 (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
                                                         <a class="link" href="liboil-liboilimpl-unstable.html#OilFunctionImpl" title="OilFunctionImpl">OilFunctionImpl</a> *impl);
void                <a class="link" href="liboil-liboiltest.html#oil-test-cleanup" title="oil_test_cleanup ()">oil_test_cleanup</a>                    (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);
void *              <a class="link" href="liboil-liboiltest.html#oil-test-get-source-data" title="oil_test_get_source_data ()">oil_test_get_source_data</a>            (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
                                                         <a class="link" href="liboil-liboiltypes.html#OilArgType" title="enum OilArgType">OilArgType</a> arg_type);
int                 <a class="link" href="liboil-liboiltest.html#oil-test-get-value" title="oil_test_get_value ()">oil_test_get_value</a>                  (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
                                                         <a class="link" href="liboil-liboiltypes.html#OilArgType" title="enum OilArgType">OilArgType</a> arg_type);
void                <a class="link" href="liboil-liboiltest.html#oil-test-set-test-footer" title="oil_test_set_test_footer ()">oil_test_set_test_footer</a>            (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
                                                         <a class="link" href="liboil-liboilparameter.html#OilParameter" title="OilParameter">OilParameter</a> *p,
                                                         int test_footer);
void                <a class="link" href="liboil-liboiltest.html#oil-test-set-test-header" title="oil_test_set_test_header ()">oil_test_set_test_header</a>            (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
                                                         <a class="link" href="liboil-liboilparameter.html#OilParameter" title="OilParameter">OilParameter</a> *p,
                                                         int test_header);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="liboil-liboiltest.description"></a><h2>Description</h2>
<p>
</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="liboil-liboiltest.details"></a><h2>Details</h2>
<div class="refsect2" title="OilTest">
<a name="OilTest"></a><h3>OilTest</h3>
<pre class="programlisting">typedef struct {
} OilTest;
</pre>
<p>
An opaque structure describing how to test an OilFunctionImpl
for an OilFunctionClass.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="OilTestFunction ()">
<a name="OilTestFunction"></a><h3>OilTestFunction ()</h3>
<pre class="programlisting">void                (*OilTestFunction)                  (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);</pre>
<p>
Typedef for functions that initialize special values
in source arrays for a particular function class.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
<td> the <em class="parameter"><code>OilTest</code></em> structure
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="OIL_TEST_HEADER">
<a name="OIL-TEST-HEADER--CAPS"></a><h3>OIL_TEST_HEADER</h3>
<pre class="programlisting">#define OIL_TEST_HEADER 256
</pre>
<p>
Default number of bytes that are prepended to the array test area.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="OIL_TEST_FOOTER">
<a name="OIL-TEST-FOOTER--CAPS"></a><h3>OIL_TEST_FOOTER</h3>
<pre class="programlisting">#define OIL_TEST_FOOTER 256
</pre>
<p>
Default number of bytes that are appended to the array test area.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="oil_test_new ()">
<a name="oil-test-new"></a><h3>oil_test_new ()</h3>
<pre class="programlisting"><a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *           oil_test_new                        (<a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> *klass);</pre>
<p>
Creates a new OilTest for the OilFunctionClass represented by <em class="parameter"><code>klass</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> an OilFunctionClass
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the new OilTest
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_test_init ()">
<a name="oil-test-init"></a><h3>oil_test_init ()</h3>
<pre class="programlisting">void                oil_test_init                       (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);</pre>
<p>
Intializes <em class="parameter"><code>test</code></em>.
</p>
<p>
FIXME: needs work</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
<td> the OilTest
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_test_free ()">
<a name="oil-test-free"></a><h3>oil_test_free ()</h3>
<pre class="programlisting">void                oil_test_free                       (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);</pre>
<p>
Frees memory associated with <em class="parameter"><code>test</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
<td> the OilTest
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_test_set_iterations ()">
<a name="oil-test-set-iterations"></a><h3>oil_test_set_iterations ()</h3>
<pre class="programlisting">void                oil_test_set_iterations             (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
                                                         int iterations);</pre>
<p>
Sets the number of iterations of <em class="parameter"><code>test</code></em> to <em class="parameter"><code>iterations</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
<td> the OilTest
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iterations</code></em> :</span></p></td>
<td> the number of iterations
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_test_check_ref ()">
<a name="oil-test-check-ref"></a><h3>oil_test_check_ref ()</h3>
<pre class="programlisting">void                oil_test_check_ref                  (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);</pre>
<p>
Runs the test specified by <em class="parameter"><code>test</code></em> on the reference function of the
class being tested.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
<td> the OilTest
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_test_check_impl ()">
<a name="oil-test-check-impl"></a><h3>oil_test_check_impl ()</h3>
<pre class="programlisting">int                 oil_test_check_impl                 (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
                                                         <a class="link" href="liboil-liboilimpl-unstable.html#OilFunctionImpl" title="OilFunctionImpl">OilFunctionImpl</a> *impl);</pre>
<p>
Runs the testing procedure described by <em class="parameter"><code>test</code></em> on the implementation
<em class="parameter"><code>impl</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
<td> the OilTest
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>impl</code></em> :</span></p></td>
<td> an OilFunctionImpl
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 1 if <em class="parameter"><code>impl</code></em> passes the test, 0 if it fails
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_test_cleanup ()">
<a name="oil-test-cleanup"></a><h3>oil_test_cleanup ()</h3>
<pre class="programlisting">void                oil_test_cleanup                    (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);</pre>
<p>
Cleans up <em class="parameter"><code>test</code></em>.
</p>
<p>
FIXME: needs work</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
<td> the OilTest
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_test_get_source_data ()">
<a name="oil-test-get-source-data"></a><h3>oil_test_get_source_data ()</h3>
<pre class="programlisting">void *              oil_test_get_source_data            (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
                                                         <a class="link" href="liboil-liboiltypes.html#OilArgType" title="enum OilArgType">OilArgType</a> arg_type);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg_type</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_test_get_value ()">
<a name="oil-test-get-value"></a><h3>oil_test_get_value ()</h3>
<pre class="programlisting">int                 oil_test_get_value                  (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
                                                         <a class="link" href="liboil-liboiltypes.html#OilArgType" title="enum OilArgType">OilArgType</a> arg_type);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg_type</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_test_set_test_footer ()">
<a name="oil-test-set-test-footer"></a><h3>oil_test_set_test_footer ()</h3>
<pre class="programlisting">void                oil_test_set_test_footer            (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
                                                         <a class="link" href="liboil-liboilparameter.html#OilParameter" title="OilParameter">OilParameter</a> *p,
                                                         int test_footer);</pre>
<p>
Sets the number of bytes of guard footer for <em class="parameter"><code>p</code></em> to <em class="parameter"><code>test_footer</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
<td> the OilTest
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
<td> the OilParameter to change the footer for
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>test_footer</code></em> :</span></p></td>
<td> the number of bytes of guard footer
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_test_set_test_header ()">
<a name="oil-test-set-test-header"></a><h3>oil_test_set_test_header ()</h3>
<pre class="programlisting">void                oil_test_set_test_header            (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
                                                         <a class="link" href="liboil-liboilparameter.html#OilParameter" title="OilParameter">OilParameter</a> *p,
                                                         int test_header);</pre>
<p>
Sets the number of bytes of guard header for <em class="parameter"><code>p</code></em> to <em class="parameter"><code>test_header</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
<td> the OilTest
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
<td> the OilParameter to change the header for
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>test_header</code></em> :</span></p></td>
<td> the number of bytes of guard header
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.