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