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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<!-- SECTION: Programming -->
<head>
<title>Array API</title>
<meta name='keywords' content='Programming'>
<meta name='creator' content='Mini-XML v2.3'>
<style type='text/css'><!--
h1, h2, h3, p { font-family: sans-serif; text-align: justify; }
tt, pre a:link, pre a:visited, tt a:link, tt a:visited { font-weight: bold; color: #7f0000; }
pre { font-weight: bold; color: #7f0000; margin-left: 2em; }
span.info { background: #000000; border: solid thin #000000; color: #ffffff; font-size: 80%; font-style: italic; font-weight: bold; white-space: nowrap; }
h3 span.info { float: right; font-size: 100%; }
h1.title, h2.title, h3.title { border-bottom: solid 2px #000000; }
--></style>
</head>
<body>
<!--
"$Id: api-array.shtml 5138 2006-02-21 10:49:06Z mike $"
Array API introduction for the Common UNIX Printing System (CUPS).
Copyright 1997-2006 by Easy Software Products.
These coded instructions, statements, and computer programs are the
property of Easy Software Products and are protected by Federal
copyright law. Distribution and use rights are outlined in the file
"LICENSE.txt" which should have been included with this file. If this
file is missing or damaged please contact Easy Software Products
at:
Attn: CUPS Licensing Information
Easy Software Products
44141 Airport View Drive, Suite 204
Hollywood, Maryland 20636 USA
Voice: (301) 373-9600
EMail: cups-info@cups.org
WWW: http://www.cups.org
-->
<h2 class='title'>Introduction</h2>
<p>The CUPS array API provides a high-performance generic array
container. The contents of the array container can be sorted and
the container itself is designed for optimal speed and memory
usage under a wide variety of conditions.</p>
<p>The CUPS scheduler (<tt>cupsd</tt>) and many of the CUPS API
functions use the array API to efficiently manage large lists of
data.</p>
<h2 class='title'>General Usage</h2>
<p>The <var><cups/array.h></var> header file must be
included to use the <tt>cupsArray</tt> functions.</p>
<p>Programs using these functions must be linked to the CUPS
library: <var>libcups.a</var>, <var>libcups.so.2</var>,
<var>libcups.2.dylib</var>, <var>libcups_s.a</var>, or
<var>libcups2.lib</var> depending on the platform. The following
command compiles <var>myprogram.c</var> using GCC and the CUPS
library:</p>
<pre class='command'>
<kbd>gcc -o myprogram myprogram.c -lcups</kbd>
</pre>
<h2 class='title'>Compatibility</h2>
<p>All of these functions require CUPS 1.2 or higher.</p>
<h2 class='title'>Contents</h2>
<ul>
<li><a href='#FUNCTIONS'>Functions</a></li>
<li><a href='#TYPES'>Types</a></li>
</ul>
<!-- NEW PAGE -->
<h2 class='title'><a name='FUNCTIONS'>Functions</a></h2>
<ul>
<li><a href='#cupsArrayAdd'><tt>cupsArrayAdd()</tt></a> </li>
<li><a href='#cupsArrayClear'><tt>cupsArrayClear()</tt></a> </li>
<li><a href='#cupsArrayCount'><tt>cupsArrayCount()</tt></a> </li>
<li><a href='#cupsArrayCurrent'><tt>cupsArrayCurrent()</tt></a> </li>
<li><a href='#cupsArrayDelete'><tt>cupsArrayDelete()</tt></a> </li>
<li><a href='#cupsArrayDup'><tt>cupsArrayDup()</tt></a> </li>
<li><a href='#cupsArrayFind'><tt>cupsArrayFind()</tt></a> </li>
<li><a href='#cupsArrayFirst'><tt>cupsArrayFirst()</tt></a> </li>
<li><a href='#cupsArrayIndex'><tt>cupsArrayIndex()</tt></a> </li>
<li><a href='#cupsArrayInsert'><tt>cupsArrayInsert()</tt></a> </li>
<li><a href='#cupsArrayLast'><tt>cupsArrayLast()</tt></a> </li>
<li><a href='#cupsArrayNew'><tt>cupsArrayNew()</tt></a> </li>
<li><a href='#cupsArrayNext'><tt>cupsArrayNext()</tt></a> </li>
<li><a href='#cupsArrayPrev'><tt>cupsArrayPrev()</tt></a> </li>
<li><a href='#cupsArrayRemove'><tt>cupsArrayRemove()</tt></a> </li>
<li><a href='#cupsArrayRestore'><tt>cupsArrayRestore()</tt></a> </li>
<li><a href='#cupsArraySave'><tt>cupsArraySave()</tt></a> </li>
<li><a href='#cupsArrayUserData'><tt>cupsArrayUserData()</tt></a> </li>
</ul>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayAdd'>cupsArrayAdd()</a></h3>
<h4>Description</h4>
<p>Add an element to the array.
When adding an element to a sorted array, non-unique elements are
appended at the end of the run. For unsorted arrays, the element
is inserted at the end of the array.</p>
<h4>Syntax</h4>
<pre>
int
cupsArrayAdd(
<a href='#cups_array_t'>cups_array_t</a> * a,
void * e);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
<tr><td><tt>e</tt></td><td>Element</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>1 on success, 0 on failure</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayClear'>cupsArrayClear()</a></h3>
<h4>Description</h4>
<p>Clear the array.</p>
<h4>Syntax</h4>
<pre>
void
cupsArrayClear(
<a href='#cups_array_t'>cups_array_t</a> * a);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Nothing.</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayCount'>cupsArrayCount()</a></h3>
<h4>Description</h4>
<p>Get the number of elements in the array.</p>
<h4>Syntax</h4>
<pre>
int
cupsArrayCount(
<a href='#cups_array_t'>cups_array_t</a> * a);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Number of elements</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayCurrent'>cupsArrayCurrent()</a></h3>
<h4>Description</h4>
<p>Return the current element in the array.</p>
<h4>Syntax</h4>
<pre>
void *
cupsArrayCurrent(
<a href='#cups_array_t'>cups_array_t</a> * a);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Element</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayDelete'>cupsArrayDelete()</a></h3>
<h4>Description</h4>
<p>Free all memory used by the array.</p>
<h4>Syntax</h4>
<pre>
void
cupsArrayDelete(
<a href='#cups_array_t'>cups_array_t</a> * a);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Nothing.</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayDup'>cupsArrayDup()</a></h3>
<h4>Description</h4>
<p>Duplicate the array.</p>
<h4>Syntax</h4>
<pre>
<a href='#cups_array_t'>cups_array_t</a> *
cupsArrayDup(
<a href='#cups_array_t'>cups_array_t</a> * a);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Duplicate array</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayFind'>cupsArrayFind()</a></h3>
<h4>Description</h4>
<p>Find an element in the array.</p>
<h4>Syntax</h4>
<pre>
void *
cupsArrayFind(
<a href='#cups_array_t'>cups_array_t</a> * a,
void * e);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
<tr><td><tt>e</tt></td><td>Element</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Element found or NULL</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayFirst'>cupsArrayFirst()</a></h3>
<h4>Description</h4>
<p>Get the first element in the array.</p>
<h4>Syntax</h4>
<pre>
void *
cupsArrayFirst(
<a href='#cups_array_t'>cups_array_t</a> * a);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>First element or NULL</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayIndex'>cupsArrayIndex()</a></h3>
<h4>Description</h4>
<p>Get the N-th element in the array.</p>
<h4>Syntax</h4>
<pre>
void *
cupsArrayIndex(
<a href='#cups_array_t'>cups_array_t</a> * a,
int n);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
<tr><td><tt>n</tt></td><td>Index into array, starting at 0</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>N-th element or NULL</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayInsert'>cupsArrayInsert()</a></h3>
<h4>Description</h4>
<p>Insert an element in the array.
When inserting an element in a sorted array, non-unique elements are
inserted at the beginning of the run. For unsorted arrays, the element
is inserted at the beginning of the array.</p>
<h4>Syntax</h4>
<pre>
int
cupsArrayInsert(
<a href='#cups_array_t'>cups_array_t</a> * a,
void * e);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
<tr><td><tt>e</tt></td><td>Element</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>0 on failure, 1 on success</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayLast'>cupsArrayLast()</a></h3>
<h4>Description</h4>
<p>Get the last element in the array.</p>
<h4>Syntax</h4>
<pre>
void *
cupsArrayLast(
<a href='#cups_array_t'>cups_array_t</a> * a);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Last element or NULL</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayNew'>cupsArrayNew()</a></h3>
<h4>Description</h4>
<p>Create a new array.</p>
<h4>Syntax</h4>
<pre>
<a href='#cups_array_t'>cups_array_t</a> *
cupsArrayNew(
<a href='#cups_array_func_t'>cups_array_func_t</a> f,
void * d);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>f</tt></td><td>Comparison function</td></tr>
<tr><td><tt>d</tt></td><td>User data</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Array</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayNext'>cupsArrayNext()</a></h3>
<h4>Description</h4>
<p>Get the next element in the array.</p>
<h4>Syntax</h4>
<pre>
void *
cupsArrayNext(
<a href='#cups_array_t'>cups_array_t</a> * a);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Next element or NULL</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayPrev'>cupsArrayPrev()</a></h3>
<h4>Description</h4>
<p>Get the previous element in the array.</p>
<h4>Syntax</h4>
<pre>
void *
cupsArrayPrev(
<a href='#cups_array_t'>cups_array_t</a> * a);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Previous element or NULL</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayRemove'>cupsArrayRemove()</a></h3>
<h4>Description</h4>
<p>Remove an element from the array.</p>
<h4>Syntax</h4>
<pre>
int
cupsArrayRemove(
<a href='#cups_array_t'>cups_array_t</a> * a,
void * e);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
<tr><td><tt>e</tt></td><td>Element</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>1 on success, 0 on failure</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayRestore'>cupsArrayRestore()</a></h3>
<h4>Description</h4>
<p>Reset the current element to the last cupsArraySave.</p>
<h4>Syntax</h4>
<pre>
void *
cupsArrayRestore(
<a href='#cups_array_t'>cups_array_t</a> * a);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>New current element</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArraySave'>cupsArraySave()</a></h3>
<h4>Description</h4>
<p>Mark the current element for a later cupsArrayRestore.
The save/restore stack is guaranteed to be at least 32 elements deep.</p>
<h4>Syntax</h4>
<pre>
int
cupsArraySave(
<a href='#cups_array_t'>cups_array_t</a> * a);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>1 on success, 0 on failure</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsArrayUserData'>cupsArrayUserData()</a></h3>
<h4>Description</h4>
<p>Return the user data for an array.</p>
<h4>Syntax</h4>
<pre>
void *
cupsArrayUserData(
<a href='#cups_array_t'>cups_array_t</a> * a);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>a</tt></td><td>Array</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>User data</p>
<!-- NEW PAGE -->
<h2 class='title'><a name='TYPES'>Types</a></h2>
<ul>
<li><a href='#cups_array_func_t'><tt>cups_array_func_t</tt></a> </li>
<li><a href='#cups_array_t'><tt>cups_array_t</tt></a> </li>
</ul>
<!-- NEW PAGE -->
<h3 class='title'><a name='cups_array_func_t'>cups_array_func_t</a></h3>
<h4>Description</h4>
<p>Array comparison function</p>
<h4>Definition</h4>
<pre>
typedef int (*cups_array_func_t)(void *first, void *second, void *data);
</pre>
<!-- NEW PAGE -->
<h3 class='title'><a name='cups_array_t'>cups_array_t</a></h3>
<h4>Description</h4>
<p>CUPS array type</p>
<h4>Definition</h4>
<pre>
typedef struct _cups_array_s cups_array_t;
</pre>
</body>
</html>
|
