This file is indexed.

/usr/share/gtk-doc/html/liboil/liboil-liboilimpl-unstable.html is in liboil0.3-doc 0.3.17-2ubuntu3.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OilFunctionImpl</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-liboilclass-unstable.html" title="OilFunctionClass">
<link rel="next" href="liboil-liboilparameter.html" title="OilParameter">
<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-liboilclass-unstable.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-liboilparameter.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-liboilimpl-unstable.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#liboil-liboilimpl-unstable.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="OilFunctionImpl">
<a name="liboil-liboilimpl-unstable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="liboil-liboilimpl-unstable.top_of_page"></a>OilFunctionImpl</span></h2>
<p>OilFunctionImpl — Functions for manipulating function implementations.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="liboil-liboilimpl-unstable.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a class="link" href="liboil-liboilimpl-unstable.html#OilFunctionImpl" title="OilFunctionImpl">OilFunctionImpl</a>;
<a class="link" href="liboil-liboilimpl-unstable.html#OilFunctionImpl" title="OilFunctionImpl">OilFunctionImpl</a> *   <a class="link" href="liboil-liboilimpl-unstable.html#oil-impl-get-by-index" title="oil_impl_get_by_index ()">oil_impl_get_by_index</a>               (int i);
int                 <a class="link" href="liboil-liboilimpl-unstable.html#oil-impl-is-runnable" title="oil_impl_is_runnable ()">oil_impl_is_runnable</a>                (<a class="link" href="liboil-liboilimpl-unstable.html#OilFunctionImpl" title="OilFunctionImpl">OilFunctionImpl</a> *impl);
enum                <a class="link" href="liboil-liboilimpl-unstable.html#OilImplFlag" title="enum OilImplFlag">OilImplFlag</a>;
#define             <a class="link" href="liboil-liboilimpl-unstable.html#OIL-CPU-FLAG-MASK--CAPS" title="OIL_CPU_FLAG_MASK">OIL_CPU_FLAG_MASK</a>
#define             <a class="link" href="liboil-liboilimpl-unstable.html#OIL-DEFINE-IMPL-FULL--CAPS" title="OIL_DEFINE_IMPL_FULL()">OIL_DEFINE_IMPL_FULL</a>                (function,klass,flags)
#define             <a class="link" href="liboil-liboilimpl-unstable.html#OIL-DEFINE-IMPL--CAPS" title="OIL_DEFINE_IMPL()">OIL_DEFINE_IMPL</a>                     (function,klass)
#define             <a class="link" href="liboil-liboilimpl-unstable.html#OIL-DEFINE-IMPL-REF--CAPS" title="OIL_DEFINE_IMPL_REF()">OIL_DEFINE_IMPL_REF</a>                 (function,klass)
#define             <a class="link" href="liboil-liboilimpl-unstable.html#OIL-DEFINE-IMPL-ASM--CAPS" title="OIL_DEFINE_IMPL_ASM()">OIL_DEFINE_IMPL_ASM</a>                 (function,klass)
#define             <a class="link" href="liboil-liboilimpl-unstable.html#OIL-DEFINE-IMPL-DEPENDS--CAPS" title="OIL_DEFINE_IMPL_DEPENDS()">OIL_DEFINE_IMPL_DEPENDS</a>             (function,klass,...)
</pre>
</div>
<div class="refsect1" title="Description">
<a name="liboil-liboilimpl-unstable.description"></a><h2>Description</h2>
<p>
</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="liboil-liboilimpl-unstable.details"></a><h2>Details</h2>
<div class="refsect2" title="OilFunctionImpl">
<a name="OilFunctionImpl"></a><h3>OilFunctionImpl</h3>
<pre class="programlisting">typedef struct {
} OilFunctionImpl;
</pre>
<p>
An opaque structure representing a function implementation.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="oil_impl_get_by_index ()">
<a name="oil-impl-get-by-index"></a><h3>oil_impl_get_by_index ()</h3>
<pre class="programlisting"><a class="link" href="liboil-liboilimpl-unstable.html#OilFunctionImpl" title="OilFunctionImpl">OilFunctionImpl</a> *   oil_impl_get_by_index               (int i);</pre>
<p>
Returns a pointer to the function implementation with index <em class="parameter"><code>i</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>i</code></em> :</span></p></td>
<td> index
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a pointer to a function implementation structure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_impl_is_runnable ()">
<a name="oil-impl-is-runnable"></a><h3>oil_impl_is_runnable ()</h3>
<pre class="programlisting">int                 oil_impl_is_runnable                (<a class="link" href="liboil-liboilimpl-unstable.html#OilFunctionImpl" title="OilFunctionImpl">OilFunctionImpl</a> *impl);</pre>
<p>
Determines whether the function implementation given by <em class="parameter"><code>impl</code></em>
can be executed by the current CPU.</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>impl</code></em> :</span></p></td>
<td> an <em class="parameter"><code>OilFunctionImpl</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 1 if the implementation can be executed, otherwise 0
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum OilImplFlag">
<a name="OilImplFlag"></a><h3>enum OilImplFlag</h3>
<pre class="programlisting">typedef enum {
  OIL_IMPL_FLAG_REF = (1&lt;&lt;0),
  OIL_IMPL_FLAG_OPT = (1&lt;&lt;1),
  OIL_IMPL_FLAG_ASM = (1&lt;&lt;2),
  OIL_IMPL_FLAG_DISABLED = (1&lt;&lt;3),
  OIL_IMPL_FLAG_CMOV = (1&lt;&lt;16),
  OIL_IMPL_FLAG_MMX = (1&lt;&lt;17),
  OIL_IMPL_FLAG_SSE = (1&lt;&lt;18),
  OIL_IMPL_FLAG_MMXEXT = (1&lt;&lt;19),
  OIL_IMPL_FLAG_SSE2 = (1&lt;&lt;20),
  OIL_IMPL_FLAG_3DNOW = (1&lt;&lt;21),
  OIL_IMPL_FLAG_3DNOWEXT = (1&lt;&lt;22),
  OIL_IMPL_FLAG_SSE3 = (1&lt;&lt;23),
  OIL_IMPL_FLAG_ALTIVEC = (1&lt;&lt;24),
  OIL_IMPL_FLAG_EDSP = (1&lt;&lt;25),
  OIL_IMPL_FLAG_ARM6 = (1&lt;&lt;26),
  OIL_IMPL_FLAG_VFP = (1&lt;&lt;27),
  OIL_IMPL_FLAG_SSSE3 = (1&lt;&lt;28)
} OilImplFlag;
</pre>
<p>
Implementation flags.
</p>
<p>
<em class="parameter"><code>OIL_IMPL_FLAG_REF</code></em>: is the reference implementation for the class.
</p>
<p>
<em class="parameter"><code>OIL_IMPL_FLAG_OPT</code></em>: was compiled with alternate CFLAGS as specified
by --enable-alternate-optimization.
</p>
<p>
<em class="parameter"><code>OIL_IMPL_FLAG_ASM</code></em>: is written in assembly code.
</p>
<p>
<em class="parameter"><code>OIL_IMPL_FLAG_DISABLED</code></em>: is disabled.  This can be set either in the
source code or during library initialization.
</p>
<p>
<em class="parameter"><code>OIL_IMPL_FLAG_CMOV</code></em>: uses the i386 instruction cmov or its variants.
</p>
<p>
<em class="parameter"><code>OIL_IMPL_FLAG_MMX</code></em>: uses MMX instructions.
</p>
<p>
<em class="parameter"><code>OIL_IMPL_FLAG_SSE</code></em>: uses SSE instructions.
</p>
<p>
<em class="parameter"><code>OIL_IMPL_FLAG_MMXEXT</code></em>: uses AMD's extended MMX instructions.  These
are a subset of what Intel calls SSE2.  If an implementation uses
only AMD's extended MMX instructions, it should set this flag, and
not <em class="parameter"><code>OIL_IMPL_FLAG_SSE2</code></em>.
</p>
<p>
<em class="parameter"><code>OIL_IMPL_FLAG_SSE2</code></em>: uses SSE2 instructions.  This flag implies
<em class="parameter"><code>OIL_IMPL_FLAG_SSE</code></em> and <em class="parameter"><code>OIL_IMPL_FLAG_MMXEXT</code></em>.
</p>
<p>
<em class="parameter"><code>OIL_IMPL_FLAG_3DNOW</code></em>: uses 3DNow! instructions.
</p>
<p>
<em class="parameter"><code>OIL_IMPL_FLAG_3DNOWEXT</code></em>: uses extended 3DNow! instructions.
</p>
<p>
<em class="parameter"><code>OIL_IMPL_FLAG_SSE3</code></em>: uses SSE3 instructions.  This flag implies
<em class="parameter"><code>OIL_IMPL_FLAG_SSE2</code></em>.
</p>
<p>
<em class="parameter"><code>OIL_IMPL_FLAG_SSSE3</code></em>: uses SSSE3 instructions.  This flag implies
<em class="parameter"><code>OIL_IMPL_FLAG_SSE3</code></em>.
</p>
<p>
<em class="parameter"><code>OIL_IMPL_FLAG_ALTIVEC</code></em>: uses Altivec instructions.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="OIL_CPU_FLAG_MASK">
<a name="OIL-CPU-FLAG-MASK--CAPS"></a><h3>OIL_CPU_FLAG_MASK</h3>
<pre class="programlisting">#define OIL_CPU_FLAG_MASK 0xffff0000
</pre>
<p>
Mask describing which bits in <a class="link" href="liboil-liboilimpl-unstable.html#OilImplFlag" title="enum OilImplFlag"><span class="type">OilImplFlag</span></a> depend on the current
CPU.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="OIL_DEFINE_IMPL_FULL()">
<a name="OIL-DEFINE-IMPL-FULL--CAPS"></a><h3>OIL_DEFINE_IMPL_FULL()</h3>
<pre class="programlisting">#define             OIL_DEFINE_IMPL_FULL(function,klass,flags)</pre>
<p>
Defines a <a class="link" href="liboil-liboilimpl-unstable.html#OilFunctionImpl" title="OilFunctionImpl"><span class="type">OilFunctionImpl</span></a> structure for the function <em class="parameter"><code>function</code></em>
and class <em class="parameter"><code>klass</code></em>.  CPU-dependent flags in <em class="parameter"><code>flags</code></em> will indicate
that this implementation requires the given CPU flags.</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>function</code></em> :</span></p></td>
<td> name of function
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> name of class to declare (without oil_ prefix)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td> implementation flags and CPU requirements
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="OIL_DEFINE_IMPL()">
<a name="OIL-DEFINE-IMPL--CAPS"></a><h3>OIL_DEFINE_IMPL()</h3>
<pre class="programlisting">#define             OIL_DEFINE_IMPL(function,klass)</pre>
<p>
Shorthand for defining a C implementation.  See <a class="link" href="liboil-liboilimpl-unstable.html#OIL-DEFINE-IMPL-FULL--CAPS" title="OIL_DEFINE_IMPL_FULL()"><code class="function">OIL_DEFINE_IMPL_FULL()</code></a>.</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>function</code></em> :</span></p></td>
<td> name of function
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> name of class to declare (without oil_ prefix)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="OIL_DEFINE_IMPL_REF()">
<a name="OIL-DEFINE-IMPL-REF--CAPS"></a><h3>OIL_DEFINE_IMPL_REF()</h3>
<pre class="programlisting">#define             OIL_DEFINE_IMPL_REF(function,klass)</pre>
<p>
Shorthand for defining a reference implementation.  See <a class="link" href="liboil-liboilimpl-unstable.html#OIL-DEFINE-IMPL-FULL--CAPS" title="OIL_DEFINE_IMPL_FULL()"><code class="function">OIL_DEFINE_IMPL_FULL()</code></a>.</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>function</code></em> :</span></p></td>
<td> name of function
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> name of class to declare (without oil_ prefix)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="OIL_DEFINE_IMPL_ASM()">
<a name="OIL-DEFINE-IMPL-ASM--CAPS"></a><h3>OIL_DEFINE_IMPL_ASM()</h3>
<pre class="programlisting">#define             OIL_DEFINE_IMPL_ASM(function,klass)</pre>
<p>
Shorthand for defining an implementation written in inline
assembly code.  See <a class="link" href="liboil-liboilimpl-unstable.html#OIL-DEFINE-IMPL-FULL--CAPS" title="OIL_DEFINE_IMPL_FULL()"><code class="function">OIL_DEFINE_IMPL_FULL()</code></a>.</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>function</code></em> :</span></p></td>
<td> name of function
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> name of class to declare (without oil_ prefix)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="OIL_DEFINE_IMPL_DEPENDS()">
<a name="OIL-DEFINE-IMPL-DEPENDS--CAPS"></a><h3>OIL_DEFINE_IMPL_DEPENDS()</h3>
<pre class="programlisting">#define             OIL_DEFINE_IMPL_DEPENDS(function,klass,...)</pre>
<p>
Shorthand for defining an implementation that uses another Liboil
function class.  This is not currently used.  See
<a class="link" href="liboil-liboilimpl-unstable.html#OIL-DEFINE-IMPL-FULL--CAPS" title="OIL_DEFINE_IMPL_FULL()"><code class="function">OIL_DEFINE_IMPL_FULL()</code></a>.</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>function</code></em> :</span></p></td>
<td> name of function
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> name of class to declare (without oil_ prefix)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td> other classes this implementation uses
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>