docs/reference/glib/html/glib-Trash-Stacks.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>Trash Stacks</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GLib Reference Manual">
   8 <link rel="up" href="glib-data-types.html" title="GLib Data Types">
   9 <link rel="prev" href="glib-Sequences.html" title="Sequences">
  10 <link rel="next" href="glib-Hash-Tables.html" title="Hash Tables">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="glib-Sequences.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="glib-data-types.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GLib Reference Manual</th>
  21 <td><a accesskey="n" href="glib-Hash-Tables.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#glib-Trash-Stacks.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#glib-Trash-Stacks.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="glib-Trash-Stacks"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="glib-Trash-Stacks.top_of_page"></a>Trash Stacks</span></h2>
  34 <p>Trash Stacks — maintain a stack of unused allocated memory chunks</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="glib-Trash-Stacks.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;glib.h&gt;
  42
  43 struct              <a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack">GTrashStack</a>;
  44 <span class="returnvalue">void</span>                <a class="link" href="glib-Trash-Stacks.html#g-trash-stack-push" title="g_trash_stack_push ()">g_trash_stack_push</a>                  (<em class="parameter"><code><a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a> **stack_p</code></em>,
  45                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data_p</code></em>);
  46 <a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a>            <a class="link" href="glib-Trash-Stacks.html#g-trash-stack-pop" title="g_trash_stack_pop ()">g_trash_stack_pop</a>                   (<em class="parameter"><code><a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a> **stack_p</code></em>);
  47 <a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a>            <a class="link" href="glib-Trash-Stacks.html#g-trash-stack-peek" title="g_trash_stack_peek ()">g_trash_stack_peek</a>                  (<em class="parameter"><code><a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a> **stack_p</code></em>);
  48 <a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="returnvalue">guint</span></a>               <a class="link" href="glib-Trash-Stacks.html#g-trash-stack-height" title="g_trash_stack_height ()">g_trash_stack_height</a>                (<em class="parameter"><code><a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a> **stack_p</code></em>);
  49 </pre>
  50 </div>
  51 <div class="refsect1">
  52 <a name="glib-Trash-Stacks.description"></a><h2>Description</h2>
  53 <p>
  54 A <a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a> is an efficient way to keep a stack of unused allocated
  55 memory chunks. Each memory chunk is required to be large enough to hold
  56 a <a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a>. This allows the stack to be maintained without any space
  57 overhead, since the stack pointers can be stored inside the memory chunks.
  58 </p>
  59 <p>
  60 There is no function to create a <a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a>. A <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> <a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a>*
  61 is a perfectly valid empty stack.
  62 </p>
  63 </div>
  64 <div class="refsect1">
  65 <a name="glib-Trash-Stacks.details"></a><h2>Details</h2>
  66 <div class="refsect2">
  67 <a name="GTrashStack"></a><h3>struct GTrashStack</h3>
  68 <pre class="programlisting">struct GTrashStack {
  69   GTrashStack *next;
  70 };
  71 </pre>
  72 <p>
  73 Each piece of memory that is pushed onto the stack
  74 is cast to a <span class="structname">GTrashStack*</span>.
  75 </p>
  76 <div class="variablelist"><table border="0">
  77 <col align="left" valign="top">
  78 <tbody><tr>
  79 <td><p><span class="term"><a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a> *<em class="structfield"><code><a name="GTrashStack.next"></a>next</code></em>;</span></p></td>
  80 <td>pointer to the previous element of the stack,
  81 gets stored in the first <code class="literal">sizeof (gpointer)</code>
  82 bytes of the element</td>
  83 </tr></tbody>
  84 </table></div>
  85 </div>
  86 <hr>
  87 <div class="refsect2">
  88 <a name="g-trash-stack-push"></a><h3>g_trash_stack_push ()</h3>
  89 <pre class="programlisting"><span class="returnvalue">void</span>                g_trash_stack_push                  (<em class="parameter"><code><a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a> **stack_p</code></em>,
  90                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data_p</code></em>);</pre>
  91 <p>
  92 Pushes a piece of memory onto a <a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a>.
  93 </p>
  94 <div class="variablelist"><table border="0">
  95 <col align="left" valign="top">
  96 <tbody>
  97 <tr>
  98 <td><p><span class="term"><em class="parameter"><code>stack_p</code></em> :</span></p></td>
  99 <td>a <a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a>
 100 </td>
 101 </tr>
 102 <tr>
 103 <td><p><span class="term"><em class="parameter"><code>data_p</code></em> :</span></p></td>
 104 <td>the piece of memory to push on the stack</td>
 105 </tr>
 106 </tbody>
 107 </table></div>
 108 </div>
 109 <hr>
 110 <div class="refsect2">
 111 <a name="g-trash-stack-pop"></a><h3>g_trash_stack_pop ()</h3>
 112 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a>            g_trash_stack_pop                   (<em class="parameter"><code><a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a> **stack_p</code></em>);</pre>
 113 <p>
 114 Pops a piece of memory off a <a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a>.
 115 </p>
 116 <div class="variablelist"><table border="0">
 117 <col align="left" valign="top">
 118 <tbody>
 119 <tr>
 120 <td><p><span class="term"><em class="parameter"><code>stack_p</code></em> :</span></p></td>
 121 <td>a <a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a>
 122 </td>
 123 </tr>
 124 <tr>
 125 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 126 <td>the element at the top of the stack</td>
 127 </tr>
 128 </tbody>
 129 </table></div>
 130 </div>
 131 <hr>
 132 <div class="refsect2">
 133 <a name="g-trash-stack-peek"></a><h3>g_trash_stack_peek ()</h3>
 134 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a>            g_trash_stack_peek                  (<em class="parameter"><code><a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a> **stack_p</code></em>);</pre>
 135 <p>
 136 Returns the element at the top of a <a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a>
 137 which may be <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>.
 138 </p>
 139 <div class="variablelist"><table border="0">
 140 <col align="left" valign="top">
 141 <tbody>
 142 <tr>
 143 <td><p><span class="term"><em class="parameter"><code>stack_p</code></em> :</span></p></td>
 144 <td>a <a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a>
 145 </td>
 146 </tr>
 147 <tr>
 148 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 149 <td>the element at the top of the stack</td>
 150 </tr>
 151 </tbody>
 152 </table></div>
 153 </div>
 154 <hr>
 155 <div class="refsect2">
 156 <a name="g-trash-stack-height"></a><h3>g_trash_stack_height ()</h3>
 157 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="returnvalue">guint</span></a>               g_trash_stack_height                (<em class="parameter"><code><a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a> **stack_p</code></em>);</pre>
 158 <p>
 159 Returns the height of a <a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a>.
 160 </p>
 161 <p>
 162 Note that execution of this function is of O(N) complexity
 163 where N denotes the number of items on the stack.
 164 </p>
 165 <div class="variablelist"><table border="0">
 166 <col align="left" valign="top">
 167 <tbody>
 168 <tr>
 169 <td><p><span class="term"><em class="parameter"><code>stack_p</code></em> :</span></p></td>
 170 <td>a <a class="link" href="glib-Trash-Stacks.html#GTrashStack" title="struct GTrashStack"><span class="type">GTrashStack</span></a>
 171 </td>
 172 </tr>
 173 <tr>
 174 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 175 <td>the height of the stack</td>
 176 </tr>
 177 </tbody>
 178 </table></div>
 179 </div>
 180 </div>
 181 </div>
 182 <div class="footer">
 183 <hr>
 184           Generated by GTK-Doc V1.18</div>
 185 </body>
 186 </html>