/usr/share/doc/libbg1-doc/html/group__adt__gstack.html is in libbg1-doc 1.106-1.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>bglibs: adt gstack: Generic simple stack.</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.4 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="classes.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<h1>adt gstack: Generic simple stack.</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structgstack__node.html">gstack_node</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structgstack.html">gstack</a></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__adt__gstack.html#g4f8f96eebb71e97682246e416882860a">GSTACK_DECL</a>(PREFIX, TYPE)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__adt__gstack.html#g1a6b766c1e85ad942288d34b3b452a51">GSTACK_PUSH_DEFN</a>(PREFIX, TYPE, COPY)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__adt__gstack.html#g9fa46018a9c712216d216afe6cc43fea">GSTACK_TOP_DEFN</a>(PREFIX, TYPE)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__adt__gstack.html#gb5b75f18ad1625de1b08b456290554a3">GSTACK_POP_DEFN</a>(PREFIX, FREE)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__adt__gstack.html#g6db6fa756dd91724aab0a0d9513389cb">GSTACK_DEFN</a>(PREFIX, TYPE, COPY, FREE)</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__adt__gstack.html#gf83a5565c8a02ed6a2a95aacebfdd448">gstack_push</a> (struct <a class="el" href="structgstack.html">gstack</a> *d, unsigned datasize, const void *data, <a class="el" href="group__adt.html#ga98f7f3499407a5dc1afdcbb20df2e15">adt_copy_fn</a> *fn)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__adt__gstack.html#g89d5e3c467a1d97c60cb817ed5f4f3f6">gstack_top</a> (const struct <a class="el" href="structgstack.html">gstack</a> *s)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__adt__gstack.html#g1e4ffbe6a4c391351d7543ae47f9c2bf">gstack_pop</a> (struct <a class="el" href="structgstack.html">gstack</a> *s, <a class="el" href="group__adt.html#g87ba7ca9dce36c22fe75a730a1d768a9">adt_free_fn</a> *fn)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A generic stack is a first-in-last-out structure defined here based on three primary operations: push, top, and pop. Pushing an element onto a stack adds it to the head of the list. The top operation fetches the most recently pushed element still on the stack, and popping removes it. <hr><h2>Define Documentation</h2>
<a class="anchor" name="g4f8f96eebb71e97682246e416882860a"></a><!-- doxytag: member="gstack.h::GSTACK_DECL" ref="g4f8f96eebb71e97682246e416882860a" args="(PREFIX, TYPE)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GSTACK_DECL </td>
<td>(</td>
<td class="paramtype">PREFIX, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TYPE </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keyword">extern</span> <span class="keywordtype">int</span> PREFIX##_push(<span class="keyword">struct</span> <a class="code" href="structgstack.html">gstack</a>* <a class="code" href="group__instlib.html#g346f8f89a44bdef281c2bf180d9fee4f">s</a>, TYPE <span class="keyword">const</span>* data); \
<span class="keyword">extern</span> TYPE* PREFIX##_top(<span class="keyword">struct</span> <a class="code" href="structgstack.html">gstack</a>* <a class="code" href="group__instlib.html#g346f8f89a44bdef281c2bf180d9fee4f">s</a>); \
<span class="keyword">extern</span> <span class="keywordtype">void</span> PREFIX##_pop(<span class="keyword">struct</span> <a class="code" href="structgstack.html">gstack</a>* <a class="code" href="group__instlib.html#g346f8f89a44bdef281c2bf180d9fee4f">s</a>);
</pre></div>Declare specialized <code><a class="el" href="structgstack.html">gstack</a></code> functions. <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="adt_2gstack__test_8c-example.html#a0">adt/gstack_test.c</a>.</dl>
</div>
</div><p>
<a class="anchor" name="g6db6fa756dd91724aab0a0d9513389cb"></a><!-- doxytag: member="gstack.h::GSTACK_DEFN" ref="g6db6fa756dd91724aab0a0d9513389cb" args="(PREFIX, TYPE, COPY, FREE)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GSTACK_DEFN </td>
<td>(</td>
<td class="paramtype">PREFIX, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TYPE, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">COPY, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FREE </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="group__adt__gstack.html#g1a6b766c1e85ad942288d34b3b452a51">GSTACK_PUSH_DEFN</a>(PREFIX,TYPE,COPY) \
<a class="code" href="group__adt__gstack.html#g9fa46018a9c712216d216afe6cc43fea">GSTACK_TOP_DEFN</a>(PREFIX,TYPE) \
<a class="code" href="group__adt__gstack.html#gb5b75f18ad1625de1b08b456290554a3">GSTACK_POP_DEFN</a>(PREFIX,FREE)
</pre></div>Define all the specialized <code><a class="el" href="structgstack.html">gstack</a></code> functions. If <code>COPY</code> is <code>NULL</code>, a simple memcpy is used instead. If <code>FREE</code> is <code>NULL</code>, no attempt is made to free the data. <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="adt_2gstack__test_8c-example.html#a1">adt/gstack_test.c</a>.</dl>
</div>
</div><p>
<a class="anchor" name="gb5b75f18ad1625de1b08b456290554a3"></a><!-- doxytag: member="gstack.h::GSTACK_POP_DEFN" ref="gb5b75f18ad1625de1b08b456290554a3" args="(PREFIX, FREE)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GSTACK_POP_DEFN </td>
<td>(</td>
<td class="paramtype">PREFIX, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FREE </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keywordtype">void</span> PREFIX##_pop(<span class="keyword">struct</span> <a class="code" href="structgstack.html">gstack</a>* <a class="code" href="group__instlib.html#g346f8f89a44bdef281c2bf180d9fee4f">s</a>) { \
<a class="code" href="group__adt__gstack.html#g1e4ffbe6a4c391351d7543ae47f9c2bf">gstack_pop</a>(s, (<a class="code" href="group__adt.html#g87ba7ca9dce36c22fe75a730a1d768a9">adt_free_fn</a>*)(FREE)); \
}
</pre></div>Define a specialized <code><a class="el" href="structgstack.html">gstack</a></code> pop function.
</div>
</div><p>
<a class="anchor" name="g1a6b766c1e85ad942288d34b3b452a51"></a><!-- doxytag: member="gstack.h::GSTACK_PUSH_DEFN" ref="g1a6b766c1e85ad942288d34b3b452a51" args="(PREFIX, TYPE, COPY)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GSTACK_PUSH_DEFN </td>
<td>(</td>
<td class="paramtype">PREFIX, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TYPE, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">COPY </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keywordtype">int</span> PREFIX##_push(<span class="keyword">struct</span> <a class="code" href="structgstack.html">gstack</a>* <a class="code" href="group__instlib.html#g346f8f89a44bdef281c2bf180d9fee4f">s</a>, TYPE <span class="keyword">const</span>* data) { \
<span class="keywordflow">return</span> <a class="code" href="group__adt__gstack.html#gf83a5565c8a02ed6a2a95aacebfdd448">gstack_push</a>(s, <span class="keyword">sizeof</span> *data, data, (<a class="code" href="group__adt.html#ga98f7f3499407a5dc1afdcbb20df2e15">adt_copy_fn</a>*)COPY); \
}
</pre></div>Define a specialized <code><a class="el" href="structgstack.html">gstack</a></code> push function.
</div>
</div><p>
<a class="anchor" name="g9fa46018a9c712216d216afe6cc43fea"></a><!-- doxytag: member="gstack.h::GSTACK_TOP_DEFN" ref="g9fa46018a9c712216d216afe6cc43fea" args="(PREFIX, TYPE)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GSTACK_TOP_DEFN </td>
<td>(</td>
<td class="paramtype">PREFIX, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TYPE </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment">TYPE* PREFIX##_top(<span class="keyword">struct</span> <a class="code" href="structgstack.html">gstack</a>* <a class="code" href="group__instlib.html#g346f8f89a44bdef281c2bf180d9fee4f">s</a>) { \
<span class="keywordflow">return</span> (s-><a class="code" href="structgstack.html#d339b0b08c44d8c4b9ec6cd5ecf0ec7c">head</a> == 0) ? 0 : (TYPE*)s-><a class="code" href="structgstack.html#d339b0b08c44d8c4b9ec6cd5ecf0ec7c">head</a>-><a class="code" href="structgstack__node.html#4769bda6786e113cc265ef516e16f6b4">data</a>; \
}
</pre></div>Define a specialized <code><a class="el" href="structgstack.html">gstack</a></code> top function.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g1e4ffbe6a4c391351d7543ae47f9c2bf"></a><!-- doxytag: member="gstack.h::gstack_pop" ref="g1e4ffbe6a4c391351d7543ae47f9c2bf" args="(struct gstack *s, adt_free_fn *fn)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gstack_pop </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structgstack.html">gstack</a> * </td>
<td class="paramname"> <em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__adt.html#g87ba7ca9dce36c22fe75a730a1d768a9">adt_free_fn</a> * </td>
<td class="paramname"> <em>fn</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove the first (most recently pushed) element from the queue. If the free function <code>fn</code> is <code>NULL</code> no data freeing is done. Note that this does not return a pointer to the popped item, as once the item has been popped it is also freed.
</div>
</div><p>
<a class="anchor" name="gf83a5565c8a02ed6a2a95aacebfdd448"></a><!-- doxytag: member="gstack.h::gstack_push" ref="gf83a5565c8a02ed6a2a95aacebfdd448" args="(struct gstack *d, unsigned datasize, const void *data, adt_copy_fn *fn)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gstack_push </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structgstack.html">gstack</a> * </td>
<td class="paramname"> <em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>datasize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__adt.html#ga98f7f3499407a5dc1afdcbb20df2e15">adt_copy_fn</a> * </td>
<td class="paramname"> <em>fn</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a new element onto the stack. If the copy function <code>fn</code> is <code>NULL</code> memcpy is used in its place.
</div>
</div><p>
<a class="anchor" name="g89d5e3c467a1d97c60cb817ed5f4f3f6"></a><!-- doxytag: member="gstack.h::gstack_top" ref="g89d5e3c467a1d97c60cb817ed5f4f3f6" args="(const struct gstack *s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* gstack_top </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structgstack.html">gstack</a> * </td>
<td class="paramname"> <em>s</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the address of first (most recently pushed) element in the queue.
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 19 11:11:50 2009 for bglibs by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
</body>
</html>
|