cruft/doc/tmpl/tbx_dynar.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Dynamic array
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Use arrays, forget about malloc
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 This module provide the quite usual dynamic array facility.
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### FUNCTION gras_dynar_new ##### -->
  18 <para>
  19
  20 </para>
  21
  22 @whereto:
  23 @elm_size:
  24 @free_func:
  25 @Returns:
  26
  27
  28 <!-- ##### FUNCTION gras_dynar_free ##### -->
  29 <para>
  30
  31 </para>
  32
  33 @dynar:
  34 <!-- # Unused Parameters # -->
  35 @Returns:
  36
  37
  38 <!-- ##### FUNCTION gras_dynar_free_container ##### -->
  39 <para>
  40
  41 </para>
  42
  43 @dynar:
  44 <!-- # Unused Parameters # -->
  45 @Returns:
  46
  47
  48 <!-- ##### FUNCTION gras_dynar_length ##### -->
  49 <para>
  50
  51 </para>
  52
  53 @dynar:
  54 @Returns:
  55
  56
  57 <!-- ##### FUNCTION gras_dynar_reset ##### -->
  58 <para>
  59
  60 </para>
  61
  62 @dynar:
  63 <!-- # Unused Parameters # -->
  64 @Returns:
  65
  66
  67 <!-- ##### FUNCTION gras_dynar_get ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @dynar:
  73 @idx:
  74 @dst:
  75 <!-- # Unused Parameters # -->
  76 @whereto:
  77 @Returns:
  78
  79
  80 <!-- ##### FUNCTION gras_dynar_set ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @dynar:
  86 @idx:
  87 @src:
  88 @Returns:
  89 <!-- # Unused Parameters # -->
  90 @object:
  91
  92
  93 <!-- ##### FUNCTION gras_dynar_remplace ##### -->
  94 <para>
  95
  96 </para>
  97
  98 @dynar:
  99 @idx:
 100 @object:
 101 @Returns:
 102
 103
 104 <!-- ##### FUNCTION gras_dynar_insert_at ##### -->
 105 <para>
 106
 107 </para>
 108
 109 @dynar:
 110 @idx:
 111 @src:
 112 @Returns:
 113 <!-- # Unused Parameters # -->
 114 @object:
 115
 116
 117 <!-- ##### FUNCTION gras_dynar_remove_at ##### -->
 118 <para>
 119
 120 </para>
 121
 122 @dynar:
 123 @idx:
 124 @object:
 125 <!-- # Unused Parameters # -->
 126 @Returns:
 127
 128
 129 <!-- ##### FUNCTION gras_dynar_map ##### -->
 130 <para>
 131
 132 </para>
 133
 134 @dynar:
 135 @operator:
 136 <!-- # Unused Parameters # -->
 137 @Returns:
 138
 139
 140 <!-- ##### FUNCTION gras_dynar_push ##### -->
 141 <para>
 142
 143 </para>
 144
 145 @dynar:
 146 @src:
 147 @Returns:
 148 <!-- # Unused Parameters # -->
 149 @object:
 150
 151
 152 <!-- ##### FUNCTION gras_dynar_pop ##### -->
 153 <para>
 154
 155 </para>
 156
 157 @dynar:
 158 @dst:
 159 <!-- # Unused Parameters # -->
 160 @whereto:
 161
 162
 163 <!-- ##### FUNCTION gras_dynar_shift ##### -->
 164 <para>
 165
 166 </para>
 167
 168 @dynar:
 169 @dst:
 170 <!-- # Unused Parameters # -->
 171 @whereto:
 172 @Returns:
 173
 174
 175 <!-- ##### FUNCTION gras_dynar_unshift ##### -->
 176 <para>
 177
 178 </para>
 179
 180 @dynar:
 181 @src:
 182 @Returns:
 183 <!-- # Unused Parameters # -->
 184 @object:
 185
 186
 187 <!-- ##### MACRO gras_dynar_foreach ##### -->
 188 <para>
 189
 190 </para>
 191
 192 @_dynar:
 193 @_cursor:
 194 @_data:
 195 <!-- # Unused Parameters # -->
 196 @_whereto:
 197
 198
 199 <!-- ##### FUNCTION gras_dynar_cursor_rm ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @dynar:
 205 @cursor:
 206
 207
 208 <!-- ##### FUNCTION gras_dynar_cursor_first ##### -->
 209 <para>
 210
 211 </para>
 212
 213 @dynar:
 214 @cursor:
 215
 216
 217 <!-- ##### FUNCTION gras_dynar_cursor_get ##### -->
 218 <para>
 219
 220 </para>
 221
 222 @dynar:
 223 @cursor:
 224 @whereto:
 225 @Returns:
 226
 227
 228 <!-- ##### FUNCTION gras_dynar_cursor_step ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @dynar:
 234 @cursor:
 235
 236