/usr/share/gtk-doc/html/libkmod-3/libkmod-libkmod-list.html is in libkmod-dev 24-1ubuntu3.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libkmod-list: libkmod Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libkmod Reference Manual">
<link rel="up" href="ch01.html" title="libkmod">
<link rel="prev" href="libkmod-libkmod.html" title="libkmod">
<link rel="next" href="libkmod-libkmod-config.html" title="libkmod-config">
<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="#libkmod-libkmod-list.description" class="shortcut">Description</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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libkmod-libkmod.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libkmod-libkmod-config.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libkmod-libkmod-list"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libkmod-libkmod-list.top_of_page"></a>libkmod-list</span></h2>
<p>libkmod-list — general purpose list</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libkmod-libkmod-list.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="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libkmod-libkmod-list.html#kmod-list-foreach" title="kmod_list_foreach()">kmod_list_foreach</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libkmod-libkmod-list.html#kmod-list-foreach-reverse" title="kmod_list_foreach_reverse()">kmod_list_foreach_reverse</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">struct <a class="link" href="libkmod-libkmod-list.html#kmod-list" title="struct kmod_list"><span class="returnvalue">kmod_list</span></a> *
</td>
<td class="function_name">
<a class="link" href="libkmod-libkmod-list.html#kmod-list-last" title="kmod_list_last ()">kmod_list_last</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">struct <a class="link" href="libkmod-libkmod-list.html#kmod-list" title="struct kmod_list"><span class="returnvalue">kmod_list</span></a> *
</td>
<td class="function_name">
<a class="link" href="libkmod-libkmod-list.html#kmod-list-next" title="kmod_list_next ()">kmod_list_next</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">struct <a class="link" href="libkmod-libkmod-list.html#kmod-list" title="struct kmod_list"><span class="returnvalue">kmod_list</span></a> *
</td>
<td class="function_name">
<a class="link" href="libkmod-libkmod-list.html#kmod-list-prev" title="kmod_list_prev ()">kmod_list_prev</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libkmod-libkmod-list.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="libkmod-libkmod-list.html#kmod-list" title="struct kmod_list">kmod_list</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libkmod-libkmod-list.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libkmod-libkmod-list.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="kmod-list-foreach"></a><h3>kmod_list_foreach()</h3>
<pre class="programlisting">#define kmod_list_foreach(list_entry, first_entry)</pre>
</div>
<hr>
<div class="refsect2">
<a name="kmod-list-foreach-reverse"></a><h3>kmod_list_foreach_reverse()</h3>
<pre class="programlisting">#define kmod_list_foreach_reverse(list_entry, first_entry)</pre>
</div>
<hr>
<div class="refsect2">
<a name="kmod-list-last"></a><h3>kmod_list_last ()</h3>
<pre class="programlisting">struct <a class="link" href="libkmod-libkmod-list.html#kmod-list" title="struct kmod_list"><span class="returnvalue">kmod_list</span></a> *
kmod_list_last (<em class="parameter"><code>const <span class="type">struct kmod_list</span> *list</code></em>);</pre>
<p>Get the last element of the <em class="parameter"><code>list</code></em>
. As <em class="parameter"><code>list</code></em>
is a circular list,
this is a cheap operation O(1) with the last element being the
previous element.</p>
<p>If the list has a single element it will return the list itself (as
expected, and this is what differentiates from <a class="link" href="libkmod-libkmod-list.html#kmod-list-prev" title="kmod_list_prev ()"><code class="function">kmod_list_prev()</code></a>).</p>
<div class="refsect3">
<a name="kmod-list-last.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>list</p></td>
<td class="parameter_description"><p>the head of the list</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="kmod-list-last.returns"></a><h4>Returns</h4>
<p> last node at <em class="parameter"><code>list</code></em>
or NULL if the list is empty.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="kmod-list-next"></a><h3>kmod_list_next ()</h3>
<pre class="programlisting">struct <a class="link" href="libkmod-libkmod-list.html#kmod-list" title="struct kmod_list"><span class="returnvalue">kmod_list</span></a> *
kmod_list_next (<em class="parameter"><code>const <span class="type">struct kmod_list</span> *list</code></em>,
<em class="parameter"><code>const <span class="type">struct kmod_list</span> *curr</code></em>);</pre>
<p>Get the next node in <em class="parameter"><code>list</code></em>
relative to <em class="parameter"><code>curr</code></em>
as if <em class="parameter"><code>list</code></em>
was not a circular
list. I.e. calling this function in the last node of the list returns
NULL.. It can be used to iterate a list by checking for NULL return to know
when all elements were iterated.</p>
<div class="refsect3">
<a name="kmod-list-next.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>list</p></td>
<td class="parameter_description"><p>the head of the list</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>curr</p></td>
<td class="parameter_description"><p>the current node in the list</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="kmod-list-next.returns"></a><h4>Returns</h4>
<p> node next to <em class="parameter"><code>curr</code></em>
or NULL if either this node is the last of or
list is empty.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="kmod-list-prev"></a><h3>kmod_list_prev ()</h3>
<pre class="programlisting">struct <a class="link" href="libkmod-libkmod-list.html#kmod-list" title="struct kmod_list"><span class="returnvalue">kmod_list</span></a> *
kmod_list_prev (<em class="parameter"><code>const <span class="type">struct kmod_list</span> *list</code></em>,
<em class="parameter"><code>const <span class="type">struct kmod_list</span> *curr</code></em>);</pre>
<p>Get the previous node in <em class="parameter"><code>list</code></em>
relative to <em class="parameter"><code>curr</code></em>
as if <em class="parameter"><code>list</code></em>
was not a
circular list. I.e.: the previous of the head is NULL. It can be used to
iterate a list by checking for NULL return to know when all elements were
iterated.</p>
<div class="refsect3">
<a name="kmod-list-prev.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>list</p></td>
<td class="parameter_description"><p>the head of the list</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>curr</p></td>
<td class="parameter_description"><p>the current node in the list</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="kmod-list-prev.returns"></a><h4>Returns</h4>
<p> node previous to <em class="parameter"><code>curr</code></em>
or NULL if either this node is the head of
the list or the list is empty.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libkmod-libkmod-list.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="kmod-list"></a><h3>struct kmod_list</h3>
<pre class="programlisting">struct kmod_list;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|