doc/help/api-array.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
   2 <html>
   3 <!-- SECTION: Programming -->
   4 <head>
   5         <title>Array API</title>
   6         <meta name='keywords' content='Programming'>
   7         <meta name='creator' content='Mini-XML v2.3'>
   8         <style type='text/css'><!--
   9         h1, h2, h3, p { font-family: sans-serif; text-align: justify; }
  10         tt, pre a:link, pre a:visited, tt a:link, tt a:visited { font-weight: bold; color: #7f0000; }
  11         pre { font-weight: bold; color: #7f0000; margin-left: 2em; }
  12         span.info { background: #000000; border: solid thin #000000; color: #ffffff; font-size: 80%; font-style: italic; font-weight: bold; white-space: nowrap; }
  13         h3 span.info { float: right; font-size: 100%; }
  14         h1.title, h2.title, h3.title { border-bottom: solid 2px #000000; }
  15         --></style>
  16 </head>
  17 <body>
  18 <!--
  19   "$Id$"
  20
  21   Array API introduction for the Common UNIX Printing System (CUPS).
  22
  23   Copyright 1997-2006 by Easy Software Products.
  24
  25   These coded instructions, statements, and computer programs are the
  26   property of Easy Software Products and are protected by Federal
  27   copyright law.  Distribution and use rights are outlined in the file
  28   "LICENSE.txt" which should have been included with this file.  If this
  29   file is missing or damaged please contact Easy Software Products
  30   at:
  31
  32       Attn: CUPS Licensing Information
  33       Easy Software Products
  34       44141 Airport View Drive, Suite 204
  35       Hollywood, Maryland 20636 USA
  36
  37       Voice: (301) 373-9600
  38       EMail: cups-info@cups.org
  39         WWW: http://www.cups.org
  40 -->
  41
  42 <h2 class='title'>Introduction</h2>
  43
  44 <p>The CUPS array API provides a high-performance generic array
  45 container. The contents of the array container can be sorted and
  46 the container itself is designed for optimal speed and memory
  47 usage under a wide variety of conditions.</p>
  48
  49 <p>The CUPS scheduler (<tt>cupsd</tt>) and many of the CUPS API
  50 functions use the array API to efficiently manage large lists of
  51 data.</p>
  52
  53 <h2 class='title'>General Usage</h2>
  54
  55 <p>The <var>&lt;cups/array.h&gt;</var> header file must be
  56 included to use the <tt>cupsArray</tt> functions.</p>
  57
  58 <p>Programs using these functions must be linked to the CUPS
  59 library: <var>libcups.a</var>, <var>libcups.so.2</var>,
  60 <var>libcups.2.dylib</var>, <var>libcups_s.a</var>, or
  61 <var>libcups2.lib</var> depending on the platform. The following
  62 command compiles <var>myprogram.c</var> using GCC and the CUPS
  63 library:</p>
  64
  65 <pre class='command'>
  66 <kbd>gcc -o myprogram myprogram.c -lcups</kbd>
  67 </pre>
  68
  69 <h2 class='title'>Compatibility</h2>
  70
  71 <p>All of these functions require CUPS 1.2 or higher.</p>
  72 <h2 class='title'>Contents</h2>
  73 <ul>
  74         <li><a href='#FUNCTIONS'>Functions</a></li>
  75         <li><a href='#TYPES'>Types</a></li>
  76 </ul>
  77 <!-- NEW PAGE -->
  78 <h2 class='title'><a name='FUNCTIONS'>Functions</a></h2>
  79 <ul>
  80         <li><a href='#cupsArrayAdd'><tt>cupsArrayAdd()</tt></a> </li>
  81         <li><a href='#cupsArrayClear'><tt>cupsArrayClear()</tt></a> </li>
  82         <li><a href='#cupsArrayCount'><tt>cupsArrayCount()</tt></a> </li>
  83         <li><a href='#cupsArrayCurrent'><tt>cupsArrayCurrent()</tt></a> </li>
  84         <li><a href='#cupsArrayDelete'><tt>cupsArrayDelete()</tt></a> </li>
  85         <li><a href='#cupsArrayDup'><tt>cupsArrayDup()</tt></a> </li>
  86         <li><a href='#cupsArrayFind'><tt>cupsArrayFind()</tt></a> </li>
  87         <li><a href='#cupsArrayFirst'><tt>cupsArrayFirst()</tt></a> </li>
  88         <li><a href='#cupsArrayIndex'><tt>cupsArrayIndex()</tt></a> </li>
  89         <li><a href='#cupsArrayInsert'><tt>cupsArrayInsert()</tt></a> </li>
  90         <li><a href='#cupsArrayLast'><tt>cupsArrayLast()</tt></a> </li>
  91         <li><a href='#cupsArrayNew'><tt>cupsArrayNew()</tt></a> </li>
  92         <li><a href='#cupsArrayNext'><tt>cupsArrayNext()</tt></a> </li>
  93         <li><a href='#cupsArrayPrev'><tt>cupsArrayPrev()</tt></a> </li>
  94         <li><a href='#cupsArrayRemove'><tt>cupsArrayRemove()</tt></a> </li>
  95         <li><a href='#cupsArrayRestore'><tt>cupsArrayRestore()</tt></a> </li>
  96         <li><a href='#cupsArraySave'><tt>cupsArraySave()</tt></a> </li>
  97 </ul>
  98 <!-- NEW PAGE -->
  99 <h3 class='title'><a name='cupsArrayAdd'>cupsArrayAdd()</a></h3>
 100 <h4>Description</h4>
 101 <p>Add an element to the array.
 102
 103 When adding an element to a sorted array, non-unique elements are
 104 appended at the end of the run.  For unsorted arrays, the element
 105 is inserted at the end of the array.</p>
 106 <h4>Syntax</h4>
 107 <pre>
 108 int
 109 cupsArrayAdd(
 110     <a href='#cups_array_t'>cups_array_t</a> * a,
 111     void * e);
 112 </pre>
 113 <h4>Arguments</h4>
 114 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 115 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 116 <tbody>
 117 <tr><td><tt>a</tt></td><td>Array</td></tr>
 118 <tr><td><tt>e</tt></td><td>Element</td></tr>
 119 </tbody></table></div>
 120 <h4>Returns</h4>
 121 <p>1 on success, 0 on failure</p>
 122 <!-- NEW PAGE -->
 123 <h3 class='title'><a name='cupsArrayClear'>cupsArrayClear()</a></h3>
 124 <h4>Description</h4>
 125 <p>Clear the array.</p>
 126 <h4>Syntax</h4>
 127 <pre>
 128 void
 129 cupsArrayClear(
 130     <a href='#cups_array_t'>cups_array_t</a> * a);
 131 </pre>
 132 <h4>Arguments</h4>
 133 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 134 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 135 <tbody>
 136 <tr><td><tt>a</tt></td><td>Array</td></tr>
 137 </tbody></table></div>
 138 <h4>Returns</h4>
 139 <p>Nothing.</p>
 140 <!-- NEW PAGE -->
 141 <h3 class='title'><a name='cupsArrayCount'>cupsArrayCount()</a></h3>
 142 <h4>Description</h4>
 143 <p>Get the number of elements in the array.</p>
 144 <h4>Syntax</h4>
 145 <pre>
 146 int
 147 cupsArrayCount(
 148     <a href='#cups_array_t'>cups_array_t</a> * a);
 149 </pre>
 150 <h4>Arguments</h4>
 151 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 152 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 153 <tbody>
 154 <tr><td><tt>a</tt></td><td>Array</td></tr>
 155 </tbody></table></div>
 156 <h4>Returns</h4>
 157 <p>Number of elements</p>
 158 <!-- NEW PAGE -->
 159 <h3 class='title'><a name='cupsArrayCurrent'>cupsArrayCurrent()</a></h3>
 160 <h4>Description</h4>
 161 <p>Return the current element in the array.</p>
 162 <h4>Syntax</h4>
 163 <pre>
 164 void *
 165 cupsArrayCurrent(
 166     <a href='#cups_array_t'>cups_array_t</a> * a);
 167 </pre>
 168 <h4>Arguments</h4>
 169 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 170 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 171 <tbody>
 172 <tr><td><tt>a</tt></td><td>Array</td></tr>
 173 </tbody></table></div>
 174 <h4>Returns</h4>
 175 <p>Element</p>
 176 <!-- NEW PAGE -->
 177 <h3 class='title'><a name='cupsArrayDelete'>cupsArrayDelete()</a></h3>
 178 <h4>Description</h4>
 179 <p>Free all memory used by the array.</p>
 180 <h4>Syntax</h4>
 181 <pre>
 182 void
 183 cupsArrayDelete(
 184     <a href='#cups_array_t'>cups_array_t</a> * a);
 185 </pre>
 186 <h4>Arguments</h4>
 187 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 188 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 189 <tbody>
 190 <tr><td><tt>a</tt></td><td>Array</td></tr>
 191 </tbody></table></div>
 192 <h4>Returns</h4>
 193 <p>Nothing.</p>
 194 <!-- NEW PAGE -->
 195 <h3 class='title'><a name='cupsArrayDup'>cupsArrayDup()</a></h3>
 196 <h4>Description</h4>
 197 <p>Duplicate the array.</p>
 198 <h4>Syntax</h4>
 199 <pre>
 200 <a href='#cups_array_t'>cups_array_t</a> *
 201 cupsArrayDup(
 202     <a href='#cups_array_t'>cups_array_t</a> * a);
 203 </pre>
 204 <h4>Arguments</h4>
 205 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 206 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 207 <tbody>
 208 <tr><td><tt>a</tt></td><td>Array</td></tr>
 209 </tbody></table></div>
 210 <h4>Returns</h4>
 211 <p>Duplicate array</p>
 212 <!-- NEW PAGE -->
 213 <h3 class='title'><a name='cupsArrayFind'>cupsArrayFind()</a></h3>
 214 <h4>Description</h4>
 215 <p>Find an element in the array.</p>
 216 <h4>Syntax</h4>
 217 <pre>
 218 void *
 219 cupsArrayFind(
 220     <a href='#cups_array_t'>cups_array_t</a> * a,
 221     void * e);
 222 </pre>
 223 <h4>Arguments</h4>
 224 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 225 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 226 <tbody>
 227 <tr><td><tt>a</tt></td><td>Array</td></tr>
 228 <tr><td><tt>e</tt></td><td>Element</td></tr>
 229 </tbody></table></div>
 230 <h4>Returns</h4>
 231 <p>Element found or NULL</p>
 232 <!-- NEW PAGE -->
 233 <h3 class='title'><a name='cupsArrayFirst'>cupsArrayFirst()</a></h3>
 234 <h4>Description</h4>
 235 <p>Get the first element in the array.</p>
 236 <h4>Syntax</h4>
 237 <pre>
 238 void *
 239 cupsArrayFirst(
 240     <a href='#cups_array_t'>cups_array_t</a> * a);
 241 </pre>
 242 <h4>Arguments</h4>
 243 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 244 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 245 <tbody>
 246 <tr><td><tt>a</tt></td><td>Array</td></tr>
 247 </tbody></table></div>
 248 <h4>Returns</h4>
 249 <p>First element or NULL</p>
 250 <!-- NEW PAGE -->
 251 <h3 class='title'><a name='cupsArrayIndex'>cupsArrayIndex()</a></h3>
 252 <h4>Description</h4>
 253 <p>Get the N-th element in the array.</p>
 254 <h4>Syntax</h4>
 255 <pre>
 256 void *
 257 cupsArrayIndex(
 258     <a href='#cups_array_t'>cups_array_t</a> * a,
 259     int n);
 260 </pre>
 261 <h4>Arguments</h4>
 262 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 263 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 264 <tbody>
 265 <tr><td><tt>a</tt></td><td>Array</td></tr>
 266 <tr><td><tt>n</tt></td><td>Index into array, starting at 0</td></tr>
 267 </tbody></table></div>
 268 <h4>Returns</h4>
 269 <p>N-th element or NULL</p>
 270 <!-- NEW PAGE -->
 271 <h3 class='title'><a name='cupsArrayInsert'>cupsArrayInsert()</a></h3>
 272 <h4>Description</h4>
 273 <p>Insert an element in the array.
 274
 275 When inserting an element in a sorted array, non-unique elements are
 276 inserted at the beginning of the run.  For unsorted arrays, the element
 277 is inserted at the beginning of the array.</p>
 278 <h4>Syntax</h4>
 279 <pre>
 280 int
 281 cupsArrayInsert(
 282     <a href='#cups_array_t'>cups_array_t</a> * a,
 283     void * e);
 284 </pre>
 285 <h4>Arguments</h4>
 286 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 287 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 288 <tbody>
 289 <tr><td><tt>a</tt></td><td>Array</td></tr>
 290 <tr><td><tt>e</tt></td><td>Element</td></tr>
 291 </tbody></table></div>
 292 <h4>Returns</h4>
 293 <p>0 on failure, 1 on success</p>
 294 <!-- NEW PAGE -->
 295 <h3 class='title'><a name='cupsArrayLast'>cupsArrayLast()</a></h3>
 296 <h4>Description</h4>
 297 <p>Get the last element in the array.</p>
 298 <h4>Syntax</h4>
 299 <pre>
 300 void *
 301 cupsArrayLast(
 302     <a href='#cups_array_t'>cups_array_t</a> * a);
 303 </pre>
 304 <h4>Arguments</h4>
 305 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 306 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 307 <tbody>
 308 <tr><td><tt>a</tt></td><td>Array</td></tr>
 309 </tbody></table></div>
 310 <h4>Returns</h4>
 311 <p>Last element or NULL</p>
 312 <!-- NEW PAGE -->
 313 <h3 class='title'><a name='cupsArrayNew'>cupsArrayNew()</a></h3>
 314 <h4>Description</h4>
 315 <p>Create a new array.</p>
 316 <h4>Syntax</h4>
 317 <pre>
 318 <a href='#cups_array_t'>cups_array_t</a> *
 319 cupsArrayNew(
 320     <a href='#cups_array_func_t'>cups_array_func_t</a> f,
 321     void * d);
 322 </pre>
 323 <h4>Arguments</h4>
 324 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 325 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 326 <tbody>
 327 <tr><td><tt>f</tt></td><td>Comparison function</td></tr>
 328 <tr><td><tt>d</tt></td><td>User data</td></tr>
 329 </tbody></table></div>
 330 <h4>Returns</h4>
 331 <p>Array</p>
 332 <!-- NEW PAGE -->
 333 <h3 class='title'><a name='cupsArrayNext'>cupsArrayNext()</a></h3>
 334 <h4>Description</h4>
 335 <p>Get the next element in the array.</p>
 336 <h4>Syntax</h4>
 337 <pre>
 338 void *
 339 cupsArrayNext(
 340     <a href='#cups_array_t'>cups_array_t</a> * a);
 341 </pre>
 342 <h4>Arguments</h4>
 343 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 344 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 345 <tbody>
 346 <tr><td><tt>a</tt></td><td>Array</td></tr>
 347 </tbody></table></div>
 348 <h4>Returns</h4>
 349 <p>Next element or NULL</p>
 350 <!-- NEW PAGE -->
 351 <h3 class='title'><a name='cupsArrayPrev'>cupsArrayPrev()</a></h3>
 352 <h4>Description</h4>
 353 <p>Get the previous element in the array.</p>
 354 <h4>Syntax</h4>
 355 <pre>
 356 void *
 357 cupsArrayPrev(
 358     <a href='#cups_array_t'>cups_array_t</a> * a);
 359 </pre>
 360 <h4>Arguments</h4>
 361 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 362 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 363 <tbody>
 364 <tr><td><tt>a</tt></td><td>Array</td></tr>
 365 </tbody></table></div>
 366 <h4>Returns</h4>
 367 <p>Previous element or NULL</p>
 368 <!-- NEW PAGE -->
 369 <h3 class='title'><a name='cupsArrayRemove'>cupsArrayRemove()</a></h3>
 370 <h4>Description</h4>
 371 <p>Remove an element from the array.</p>
 372 <h4>Syntax</h4>
 373 <pre>
 374 int
 375 cupsArrayRemove(
 376     <a href='#cups_array_t'>cups_array_t</a> * a,
 377     void * e);
 378 </pre>
 379 <h4>Arguments</h4>
 380 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 381 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 382 <tbody>
 383 <tr><td><tt>a</tt></td><td>Array</td></tr>
 384 <tr><td><tt>e</tt></td><td>Element</td></tr>
 385 </tbody></table></div>
 386 <h4>Returns</h4>
 387 <p>1 on success, 0 on failure</p>
 388 <!-- NEW PAGE -->
 389 <h3 class='title'><a name='cupsArrayRestore'>cupsArrayRestore()</a></h3>
 390 <h4>Description</h4>
 391 <p>Reset the current element to the last cupsArraySave.</p>
 392 <h4>Syntax</h4>
 393 <pre>
 394 void *
 395 cupsArrayRestore(
 396     <a href='#cups_array_t'>cups_array_t</a> * a);
 397 </pre>
 398 <h4>Arguments</h4>
 399 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 400 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 401 <tbody>
 402 <tr><td><tt>a</tt></td><td>Array</td></tr>
 403 </tbody></table></div>
 404 <h4>Returns</h4>
 405 <p>New current element</p>
 406 <!-- NEW PAGE -->
 407 <h3 class='title'><a name='cupsArraySave'>cupsArraySave()</a></h3>
 408 <h4>Description</h4>
 409 <p>Mark the current element for a later cupsArrayRestore.
 410
 411 The save/restore stack is guaranteed to be at least 32 elements deep.</p>
 412 <h4>Syntax</h4>
 413 <pre>
 414 int
 415 cupsArraySave(
 416     <a href='#cups_array_t'>cups_array_t</a> * a);
 417 </pre>
 418 <h4>Arguments</h4>
 419 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 420 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 421 <tbody>
 422 <tr><td><tt>a</tt></td><td>Array</td></tr>
 423 </tbody></table></div>
 424 <h4>Returns</h4>
 425 <p>1 on success, 0 on failure</p>
 426 <!-- NEW PAGE -->
 427 <h2 class='title'><a name='TYPES'>Types</a></h2>
 428 <ul>
 429         <li><a href='#cups_array_func_t'><tt>cups_array_func_t</tt></a> </li>
 430         <li><a href='#cups_array_t'><tt>cups_array_t</tt></a> </li>
 431 </ul>
 432 <!-- NEW PAGE -->
 433 <h3 class='title'><a name='cups_array_func_t'>cups_array_func_t</a></h3>
 434 <h4>Description</h4>
 435 <p>Array comparison function</p>
 436 <h4>Definition</h4>
 437 <pre>
 438 typedef int (*cups_array_func_t)(void *first, void *second, void *data);
 439 </pre>
 440 <!-- NEW PAGE -->
 441 <h3 class='title'><a name='cups_array_t'>cups_array_t</a></h3>
 442 <h4>Description</h4>
 443 <p>CUPS array type</p>
 444 <h4>Definition</h4>
 445 <pre>
 446 typedef struct _cups_array_s cups_array_t;
 447 </pre>
 448 </body>
 449 </html>