]> git.ipfire.org Git - thirdparty/cups.git/blob - cups/ipp.h
projects / thirdparty / cups.git / blob
? search:


dd2d9bf0b69ba2bcb6d849c9b4150adb36508f1c
[thirdparty/cups.git] / cups / ipp.h
1 /*
2 * Internet Printing Protocol definitions for CUPS.
3 *
4 * Copyright 2007-2017 by Apple Inc.
5 * Copyright 1997-2006 by Easy Software Products.
6 *
7 * These coded instructions, statements, and computer programs are the
8 * property of Apple Inc. and are protected by Federal copyright
9 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
10 * which should have been included with this file. If this file is
11 * missing or damaged, see the license at "http://www.cups.org/".
12 *
13 * This file is subject to the Apple OS-Developed Software exception.
14 */
15
16 #ifndef _CUPS_IPP_H_
17 # define _CUPS_IPP_H_
18
19 /*
20 * Include necessary headers...
21 */
22
23 # include "http.h"
24 # include <stdarg.h>
25
26
27 /*
28 * C++ magic...
29 */
30
31 # ifdef __cplusplus
32 extern "C" {
33 # endif /* __cplusplus */
34
35
36 /*
37 * IPP version string...
38 */
39
40 # define IPP_VERSION "\002\001"
41
42 /*
43 * IPP registered port number...
44 *
45 * Note: Applications should never use IPP_PORT, but instead use the
46 * ippPort() function to allow overrides via the IPP_PORT environment
47 * variable and services file if needed!
48 */
49
50 # define IPP_PORT 631
51
52 /*
53 * Common limits...
54 */
55
56 # define IPP_MAX_CHARSET 64 /* Maximum length of charset values w/nul */
57 # define IPP_MAX_KEYWORD 256 /* Maximum length of keyword values w/nul */
58 # define IPP_MAX_LANGUAGE 64 /* Maximum length of naturalLanguage values w/nul */
59 # define IPP_MAX_LENGTH 32767 /* Maximum size of any single value */
60 # define IPP_MAX_MIMETYPE 256 /* Maximum length of mimeMediaType values w/nul */
61 # define IPP_MAX_NAME 256 /* Maximum length of common name values w/nul */
62 # define IPP_MAX_OCTETSTRING 1023 /* Maximum length of octetString values w/o nul */
63 # define IPP_MAX_TEXT 1024 /* Maximum length of text values w/nul */
64 # define IPP_MAX_URI 1024 /* Maximum length of uri values w/nul */
65 # define IPP_MAX_URISCHEME 64 /* Maximum length of uriScheme values w/nul */
66 # define IPP_MAX_VALUES 8 /* Power-of-2 allocation increment */
67
68 /*
69 * Macro to flag a text string attribute as "const" (static storage) vs.
70 * allocated.
71 */
72
73 # define IPP_CONST_TAG(x) (ipp_tag_t)(IPP_TAG_CUPS_CONST | (x))
74
75
76 /*
77 * Types and structures...
78 */
79
80 typedef enum ipp_dstate_e /**** Document states @exclude all@ ****/
81 {
82 IPP_DOCUMENT_PENDING = 3, /* Document is pending */
83 IPP_DOCUMENT_PROCESSING = 5, /* Document is processing */
84 IPP_DOCUMENT_CANCELED = 7, /* Document is canceled */
85 IPP_DOCUMENT_ABORTED, /* Document is aborted */
86 IPP_DOCUMENT_COMPLETED /* Document is completed */
87
88 # ifndef _CUPS_NO_DEPRECATED
89 # define IPP_DOCUMENT_PENDING IPP_DSTATE_PENDING
90 # define IPP_DOCUMENT_PROCESSING IPP_DSTATE_PROCESSING
91 # define IPP_DOCUMENT_CANCELED IPP_DSTATE_CANCELED
92 # define IPP_DOCUMENT_ABORTED IPP_DSTATE_ABORTED
93 # define IPP_DOCUMENT_COMPLETED IPP_DSTATE_COMPLETED
94 # endif /* !_CUPS_NO_DEPRECATED */
95 } ipp_dstate_t;
96
97 typedef enum ipp_finishings_e /**** Finishings values ****/
98 {
99 IPP_FINISHINGS_NONE = 3, /* No finishing */
100 IPP_FINISHINGS_STAPLE, /* Staple (any location/method) */
101 IPP_FINISHINGS_PUNCH, /* Punch (any location/count) */
102 IPP_FINISHINGS_COVER, /* Add cover */
103 IPP_FINISHINGS_BIND, /* Bind */
104 IPP_FINISHINGS_SADDLE_STITCH, /* Staple interior */
105 IPP_FINISHINGS_EDGE_STITCH, /* Stitch along any side */
106 IPP_FINISHINGS_FOLD, /* Fold (any type) */
107 IPP_FINISHINGS_TRIM, /* Trim (any type) */
108 IPP_FINISHINGS_BALE, /* Bale (any type) */
109 IPP_FINISHINGS_BOOKLET_MAKER, /* Fold to make booklet */
110 IPP_FINISHINGS_JOG_OFFSET, /* Offset for binding (any type) */
111 IPP_FINISHINGS_COAT, /* Apply protective liquid or powder coating */
112 IPP_FINISHINGS_LAMINATE, /* Apply protective (solid) material */
113 IPP_FINISHINGS_STAPLE_TOP_LEFT = 20, /* Staple top left corner */
114 IPP_FINISHINGS_STAPLE_BOTTOM_LEFT, /* Staple bottom left corner */
115 IPP_FINISHINGS_STAPLE_TOP_RIGHT, /* Staple top right corner */
116 IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT, /* Staple bottom right corner */
117 IPP_FINISHINGS_EDGE_STITCH_LEFT, /* Stitch along left side */
118 IPP_FINISHINGS_EDGE_STITCH_TOP, /* Stitch along top edge */
119 IPP_FINISHINGS_EDGE_STITCH_RIGHT, /* Stitch along right side */
120 IPP_FINISHINGS_EDGE_STITCH_BOTTOM, /* Stitch along bottom edge */
121 IPP_FINISHINGS_STAPLE_DUAL_LEFT, /* Two staples on left */
122 IPP_FINISHINGS_STAPLE_DUAL_TOP, /* Two staples on top */
123 IPP_FINISHINGS_STAPLE_DUAL_RIGHT, /* Two staples on right */
124 IPP_FINISHINGS_STAPLE_DUAL_BOTTOM, /* Two staples on bottom */
125 IPP_FINISHINGS_STAPLE_TRIPLE_LEFT, /* Three staples on left */
126 IPP_FINISHINGS_STAPLE_TRIPLE_TOP, /* Three staples on top */
127 IPP_FINISHINGS_STAPLE_TRIPLE_RIGHT, /* Three staples on right */
128 IPP_FINISHINGS_STAPLE_TRIPLE_BOTTOM, /* Three staples on bottom */
129 IPP_FINISHINGS_BIND_LEFT = 50, /* Bind on left */
130 IPP_FINISHINGS_BIND_TOP, /* Bind on top */
131 IPP_FINISHINGS_BIND_RIGHT, /* Bind on right */
132 IPP_FINISHINGS_BIND_BOTTOM, /* Bind on bottom */
133 IPP_FINISHINGS_TRIM_AFTER_PAGES = 60, /* Trim output after each page */
134 IPP_FINISHINGS_TRIM_AFTER_DOCUMENTS, /* Trim output after each document */
135 IPP_FINISHINGS_TRIM_AFTER_COPIES, /* Trim output after each copy */
136 IPP_FINISHINGS_TRIM_AFTER_JOB, /* Trim output after job */
137 IPP_FINISHINGS_PUNCH_TOP_LEFT = 70, /* Punch 1 hole top left */
138 IPP_FINISHINGS_PUNCH_BOTTOM_LEFT, /* Punch 1 hole bottom left */
139 IPP_FINISHINGS_PUNCH_TOP_RIGHT, /* Punch 1 hole top right */
140 IPP_FINISHINGS_PUNCH_BOTTOM_RIGHT, /* Punch 1 hole bottom right */
141 IPP_FINISHINGS_PUNCH_DUAL_LEFT, /* Punch 2 holes left side */
142 IPP_FINISHINGS_PUNCH_DUAL_TOP, /* Punch 2 holes top edge */
143 IPP_FINISHINGS_PUNCH_DUAL_RIGHT, /* Punch 2 holes right side */
144 IPP_FINISHINGS_PUNCH_DUAL_BOTTOM, /* Punch 2 holes bottom edge */
145 IPP_FINISHINGS_PUNCH_TRIPLE_LEFT, /* Punch 3 holes left side */
146 IPP_FINISHINGS_PUNCH_TRIPLE_TOP, /* Punch 3 holes top edge */
147 IPP_FINISHINGS_PUNCH_TRIPLE_RIGHT, /* Punch 3 holes right side */
148 IPP_FINISHINGS_PUNCH_TRIPLE_BOTTOM, /* Punch 3 holes bottom edge */
149 IPP_FINISHINGS_PUNCH_QUAD_LEFT, /* Punch 4 holes left side */
150 IPP_FINISHINGS_PUNCH_QUAD_TOP, /* Punch 4 holes top edge */
151 IPP_FINISHINGS_PUNCH_QUAD_RIGHT, /* Punch 4 holes right side */
152 IPP_FINISHINGS_PUNCH_QUAD_BOTTOM, /* Punch 4 holes bottom edge */
153 IPP_FINISHINGS_PUNCH_MULTIPLE_LEFT, /* Pucnh multiple holes left side */
154 IPP_FINISHINGS_PUNCH_MULTIPLE_TOP, /* Pucnh multiple holes top edge */
155 IPP_FINISHINGS_PUNCH_MULTIPLE_RIGHT, /* Pucnh multiple holes right side */
156 IPP_FINISHINGS_PUNCH_MULTIPLE_BOTTOM, /* Pucnh multiple holes bottom edge */
157 IPP_FINISHINGS_FOLD_ACCORDIAN = 90, /* Accordian-fold the paper vertically into four sections */
158 IPP_FINISHINGS_FOLD_DOUBLE_GATE, /* Fold the top and bottom quarters of the paper towards the midline, then fold in half vertically */
159 IPP_FINISHINGS_FOLD_GATE, /* Fold the top and bottom quarters of the paper towards the midline */
160 IPP_FINISHINGS_FOLD_HALF, /* Fold the paper in half vertically */
161 IPP_FINISHINGS_FOLD_HALF_Z, /* Fold the paper in half horizontally, then Z-fold the paper vertically */
162 IPP_FINISHINGS_FOLD_LEFT_GATE, /* Fold the top quarter of the paper towards the midline */
163 IPP_FINISHINGS_FOLD_LETTER, /* Fold the paper into three sections vertically; sometimes also known as a C fold*/
164 IPP_FINISHINGS_FOLD_PARALLEL, /* Fold the paper in half vertically two times, yielding four sections */
165 IPP_FINISHINGS_FOLD_POSTER, /* Fold the paper in half horizontally and vertically; sometimes also called a cross fold */
166 IPP_FINISHINGS_FOLD_RIGHT_GATE, /* Fold the bottom quarter of the paper towards the midline */
167 IPP_FINISHINGS_FOLD_Z, /* Fold the paper vertically into three sections, forming a Z */
168 IPP_FINISHINGS_FOLD_ENGINEERING_Z, /* Fold the paper vertically into two small sections and one larger, forming an elongated Z */
169
170 /* CUPS extensions for finishings (pre-standard versions of values above) */
171 IPP_FINISHINGS_CUPS_PUNCH_TOP_LEFT = 0x40000046,
172 /* Punch 1 hole top left @exclude all@ */
173 IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_LEFT,/* Punch 1 hole bottom left @exclude all@ */
174 IPP_FINISHINGS_CUPS_PUNCH_TOP_RIGHT, /* Punch 1 hole top right @exclude all@ */
175 IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_RIGHT,
176 /* Punch 1 hole bottom right @exclude all@ */
177 IPP_FINISHINGS_CUPS_PUNCH_DUAL_LEFT, /* Punch 2 holes left side @exclude all@ */
178 IPP_FINISHINGS_CUPS_PUNCH_DUAL_TOP, /* Punch 2 holes top edge @exclude all@ */
179 IPP_FINISHINGS_CUPS_PUNCH_DUAL_RIGHT, /* Punch 2 holes right side @exclude all@ */
180 IPP_FINISHINGS_CUPS_PUNCH_DUAL_BOTTOM,/* Punch 2 holes bottom edge @exclude all@ */
181 IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_LEFT,/* Punch 3 holes left side @exclude all@ */
182 IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_TOP, /* Punch 3 holes top edge @exclude all@ */
183 IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_RIGHT,
184 /* Punch 3 holes right side @exclude all@ */
185 IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_BOTTOM,
186 /* Punch 3 holes bottom edge @exclude all@ */
187 IPP_FINISHINGS_CUPS_PUNCH_QUAD_LEFT, /* Punch 4 holes left side @exclude all@ */
188 IPP_FINISHINGS_CUPS_PUNCH_QUAD_TOP, /* Punch 4 holes top edge @exclude all@ */
189 IPP_FINISHINGS_CUPS_PUNCH_QUAD_RIGHT, /* Punch 4 holes right side @exclude all@ */
190 IPP_FINISHINGS_CUPS_PUNCH_QUAD_BOTTOM,/* Punch 4 holes bottom edge @exclude all@ */
191
192 IPP_FINISHINGS_CUPS_FOLD_ACCORDIAN = 0x4000005A,
193 /* Accordian-fold the paper vertically into four sections @exclude all@ */
194 IPP_FINISHINGS_CUPS_FOLD_DOUBLE_GATE, /* Fold the top and bottom quarters of the paper towards the midline, then fold in half vertically @exclude all@ */
195 IPP_FINISHINGS_CUPS_FOLD_GATE, /* Fold the top and bottom quarters of the paper towards the midline @exclude all@ */
196 IPP_FINISHINGS_CUPS_FOLD_HALF, /* Fold the paper in half vertically @exclude all@ */
197 IPP_FINISHINGS_CUPS_FOLD_HALF_Z, /* Fold the paper in half horizontally, then Z-fold the paper vertically @exclude all@ */
198 IPP_FINISHINGS_CUPS_FOLD_LEFT_GATE, /* Fold the top quarter of the paper towards the midline @exclude all@ */
199 IPP_FINISHINGS_CUPS_FOLD_LETTER, /* Fold the paper into three sections vertically; sometimes also known as a C fold @exclude all@ */
200 IPP_FINISHINGS_CUPS_FOLD_PARALLEL, /* Fold the paper in half vertically two times, yielding four sections @exclude all@ */
201 IPP_FINISHINGS_CUPS_FOLD_POSTER, /* Fold the paper in half horizontally and vertically; sometimes also called a cross fold @exclude all@ */
202 IPP_FINISHINGS_CUPS_FOLD_RIGHT_GATE, /* Fold the bottom quarter of the paper towards the midline @exclude all@ */
203 IPP_FINISHINGS_CUPS_FOLD_Z /* Fold the paper vertically into three sections, forming a Z @exclude all@ */
204 } ipp_finishings_t;
205 # ifndef _CUPS_NO_DEPRECATED
206 # define IPP_FINISHINGS_JOB_OFFSET IPP_FINISHINGS_JOG_OFFSET
207 /* Long-time misspelling... */
208 typedef enum ipp_finishings_e ipp_finish_t;
209 # endif /* !_CUPS_NO_DEPRECATED */
210
211 typedef enum ipp_jcollate_e /**** Job collation types @deprecated@ @exclude all@ ****/
212 {
213 IPP_JCOLLATE_UNCOLLATED_SHEETS = 3,
214 IPP_JCOLLATE_COLLATED_DOCUMENTS,
215 IPP_JCOLLATE_UNCOLLATED_DOCUMENTS
216
217 # ifndef _CUPS_NO_DEPRECATED
218 # define IPP_JOB_UNCOLLATED_SHEETS IPP_JCOLLATE_UNCOLLATED_SHEETS
219 # define IPP_JOB_COLLATED_DOCUMENTS IPP_JCOLLATE_COLLATED_DOCUMENTS
220 # define IPP_JOB_UNCOLLATED_DOCUMENTS IPP_JCOLLATE_UNCOLLATED_DOCUMENTS
221 # endif /* !_CUPS_NO_DEPRECATED */
222 } ipp_jcollate_t;
223
224 typedef enum ipp_jstate_e /**** Job states ****/
225 {
226 IPP_JSTATE_PENDING = 3, /* Job is waiting to be printed */
227 IPP_JSTATE_HELD, /* Job is held for printing */
228 IPP_JSTATE_PROCESSING, /* Job is currently printing */
229 IPP_JSTATE_STOPPED, /* Job has been stopped */
230 IPP_JSTATE_CANCELED, /* Job has been canceled */
231 IPP_JSTATE_ABORTED, /* Job has aborted due to error */
232 IPP_JSTATE_COMPLETED /* Job has completed successfully */
233
234 # ifndef _CUPS_NO_DEPRECATED
235 # define IPP_JOB_PENDING IPP_JSTATE_PENDING
236 # define IPP_JOB_HELD IPP_JSTATE_HELD
237 # define IPP_JOB_PROCESSING IPP_JSTATE_PROCESSING
238 # define IPP_JOB_STOPPED IPP_JSTATE_STOPPED
239 # define IPP_JOB_CANCELED IPP_JSTATE_CANCELED
240 # define IPP_JOB_ABORTED IPP_JSTATE_ABORTED
241 # define IPP_JOB_COMPLETED IPP_JSTATE_COMPLETED
242 /* Legacy name for canceled state */
243 # define IPP_JOB_CANCELLED IPP_JSTATE_CANCELED
244 # endif /* !_CUPS_NO_DEPRECATED */
245 } ipp_jstate_t;
246
247 typedef enum ipp_op_e /**** IPP operations ****/
248 {
249 IPP_OP_CUPS_INVALID = -1, /* Invalid operation name for @link ippOpValue@ */
250 IPP_OP_CUPS_NONE = 0, /* No operation @private@ */
251 IPP_OP_PRINT_JOB = 0x0002, /* Print-Job: Print a single file */
252 IPP_OP_PRINT_URI, /* Print-URI: Print a single URL @exclude all@ */
253 IPP_OP_VALIDATE_JOB, /* Validate-Job: Validate job values prior to submission */
254 IPP_OP_CREATE_JOB, /* Create-Job: Create an empty print job */
255 IPP_OP_SEND_DOCUMENT, /* Send-Document: Add a file to a job */
256 IPP_OP_SEND_URI, /* Send-URI: Add a URL to a job @exclude all@ */
257 IPP_OP_CANCEL_JOB, /* Cancel-Job: Cancel a job */
258 IPP_OP_GET_JOB_ATTRIBUTES, /* Get-Job-Attribute: Get information about a job */
259 IPP_OP_GET_JOBS, /* Get-Jobs: Get a list of jobs */
260 IPP_OP_GET_PRINTER_ATTRIBUTES, /* Get-Printer-Attributes: Get information about a printer */
261 IPP_OP_HOLD_JOB, /* Hold-Job: Hold a job for printing */
262 IPP_OP_RELEASE_JOB, /* Release-Job: Release a job for printing */
263 IPP_OP_RESTART_JOB, /* Restart-Job: Reprint a job @deprecated@ */
264 IPP_OP_PAUSE_PRINTER = 0x0010, /* Pause-Printer: Stop a printer */
265 IPP_OP_RESUME_PRINTER, /* Resume-Printer: Start a printer */
266 IPP_OP_PURGE_JOBS, /* Purge-Jobs: Delete all jobs @deprecated@ @exclude all@ */
267 IPP_OP_SET_PRINTER_ATTRIBUTES, /* Set-Printer-Attributes: Set printer values */
268 IPP_OP_SET_JOB_ATTRIBUTES, /* Set-Job-Attributes: Set job values */
269 IPP_OP_GET_PRINTER_SUPPORTED_VALUES, /* Get-Printer-Supported-Values: Get supported values */
270 IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS, /* Create-Printer-Subscriptions: Create one or more printer subscriptions @since CUPS 1.2/macOS 10.5@ */
271 IPP_OP_CREATE_JOB_SUBSCRIPTIONS, /* Create-Job-Subscriptions: Create one of more job subscriptions @since CUPS 1.2/macOS 10.5@ */
272 IPP_OP_GET_SUBSCRIPTION_ATTRIBUTES, /* Get-Subscription-Attributes: Get subscription information @since CUPS 1.2/macOS 10.5@ */
273 IPP_OP_GET_SUBSCRIPTIONS, /* Get-Subscriptions: Get list of subscriptions @since CUPS 1.2/macOS 10.5@ */
274 IPP_OP_RENEW_SUBSCRIPTION, /* Renew-Subscription: Renew a printer subscription @since CUPS 1.2/macOS 10.5@ */
275 IPP_OP_CANCEL_SUBSCRIPTION, /* Cancel-Subscription: Cancel a subscription @since CUPS 1.2/macOS 10.5@ */
276 IPP_OP_GET_NOTIFICATIONS, /* Get-Notifications: Get notification events @since CUPS 1.2/macOS 10.5@ */
277 IPP_OP_SEND_NOTIFICATIONS, /* Send-Notifications: Send notification events @private@ */
278 IPP_OP_GET_RESOURCE_ATTRIBUTES, /* Get-Resource-Attributes: Get resource information @private@ */
279 IPP_OP_GET_RESOURCE_DATA, /* Get-Resource-Data: Get resource data @private@ @deprecated@ */
280 IPP_OP_GET_RESOURCES, /* Get-Resources: Get list of resources @private@ */
281 IPP_OP_GET_PRINT_SUPPORT_FILES, /* Get-Printer-Support-Files: Get printer support files @private@ */
282 IPP_OP_ENABLE_PRINTER, /* Enable-Printer: Accept new jobs for a printer */
283 IPP_OP_DISABLE_PRINTER, /* Disable-Printer: Reject new jobs for a printer */
284 IPP_OP_PAUSE_PRINTER_AFTER_CURRENT_JOB,
285 /* Pause-Printer-After-Current-Job: Stop printer after the current job */
286 IPP_OP_HOLD_NEW_JOBS, /* Hold-New-Jobs: Hold new jobs */
287 IPP_OP_RELEASE_HELD_NEW_JOBS, /* Release-Held-New-Jobs: Release new jobs that were previously held */
288 IPP_OP_DEACTIVATE_PRINTER, /* Deactivate-Printer: Stop a printer and do not accept jobs @deprecated@ @exclude all@ */
289 IPP_OP_ACTIVATE_PRINTER, /* Activate-Printer: Start a printer and accept jobs @deprecated@ @exclude all@ */
290 IPP_OP_RESTART_PRINTER, /* Restart-Printer: Restart a printer @exclude all@ */
291 IPP_OP_SHUTDOWN_PRINTER, /* Shutdown-Printer: Turn a printer off @exclude all@ */
292 IPP_OP_STARTUP_PRINTER, /* Startup-Printer: Turn a printer on @exclude all@ */
293 IPP_OP_REPROCESS_JOB, /* Reprocess-Job: Reprint a job @deprecated@ @exclude all@*/
294 IPP_OP_CANCEL_CURRENT_JOB, /* Cancel-Current-Job: Cancel the current job */
295 IPP_OP_SUSPEND_CURRENT_JOB, /* Suspend-Current-Job: Suspend the current job */
296 IPP_OP_RESUME_JOB, /* Resume-Job: Resume the current job */
297 IPP_OP_PROMOTE_JOB, /* Promote-Job: Promote a job to print sooner */
298 IPP_OP_SCHEDULE_JOB_AFTER, /* Schedule-Job-After: Schedule a job to print after another */
299 IPP_OP_CANCEL_DOCUMENT = 0x0033, /* Cancel-Document: Cancel a document @exclude all@ */
300 IPP_OP_GET_DOCUMENT_ATTRIBUTES, /* Get-Document-Attributes: Get document information @exclude all@ */
301 IPP_OP_GET_DOCUMENTS, /* Get-Documents: Get a list of documents in a job @exclude all@ */
302 IPP_OP_DELETE_DOCUMENT, /* Delete-Document: Delete a document @deprecated@ @exclude all@ */
303 IPP_OP_SET_DOCUMENT_ATTRIBUTES, /* Set-Document-Attributes: Set document values @exclude all@ */
304 IPP_OP_CANCEL_JOBS, /* Cancel-Jobs: Cancel all jobs (administrative) */
305 IPP_OP_CANCEL_MY_JOBS, /* Cancel-My-Jobs: Cancel a user's jobs */
306 IPP_OP_RESUBMIT_JOB, /* Resubmit-Job: Copy and reprint a job @exclude all@ */
307 IPP_OP_CLOSE_JOB, /* Close-Job: Close a job and start printing */
308 IPP_OP_IDENTIFY_PRINTER, /* Identify-Printer: Make the printer beep, flash, or display a message for identification */
309 IPP_OP_VALIDATE_DOCUMENT, /* Validate-Document: Validate document values prior to submission @exclude all@ */
310 IPP_OP_ADD_DOCUMENT_IMAGES, /* Add-Document-Images: Add image(s) from the specified scanner source @exclude all@ */
311 IPP_OP_ACKNOWLEDGE_DOCUMENT, /* Acknowledge-Document: Acknowledge processing of a document @exclude all@ */
312 IPP_OP_ACKNOWLEDGE_IDENTIFY_PRINTER, /* Acknowledge-Identify-Printer: Acknowledge action on an Identify-Printer request @exclude all@ */
313 IPP_OP_ACKNOWLEDGE_JOB, /* Acknowledge-Job: Acknowledge processing of a job @exclude all@ */
314 IPP_OP_FETCH_DOCUMENT, /* Fetch-Document: Fetch a document for processing @exclude all@ */
315 IPP_OP_FETCH_JOB, /* Fetch-Job: Fetch a job for processing @exclude all@ */
316 IPP_OP_GET_OUTPUT_DEVICE_ATTRIBUTES, /* Get-Output-Device-Attributes: Get printer information for a specific output device @exclude all@ */
317 IPP_OP_UPDATE_ACTIVE_JOBS, /* Update-Active-Jobs: Update the list of active jobs that a proxy has processed @exclude all@ */
318 IPP_OP_DEREGISTER_OUTPUT_DEVICE, /* Deregister-Output-Device: Remove an output device @exclude all@ */
319 IPP_OP_UPDATE_DOCUMENT_STATUS, /* Update-Document-Status: Update document values @exclude all@ */
320 IPP_OP_UPDATE_JOB_STATUS, /* Update-Job-Status: Update job values @exclude all@ */
321 IPP_OP_UPDATE_OUTPUT_DEVICE_ATTRIBUTES,
322 /* Update-Output-Device-Attributes: Update output device values @exclude all@ */
323 IPP_OP_GET_NEXT_DOCUMENT_DATA, /* Get-Next-Document-Data: Scan more document data @exclude all@ */
324 IPP_OP_ALLOCATE_PRINTER_RESOURCES, /* Allocate-Printer-Resources: Use resources for a printer. */
325 IPP_OP_CREATE_PRINTER, /* Create-Printer: Create a new service. */
326 IPP_OP_DEALLOCATE_PRINTER_RESOURCES, /* Deallocate-Printer-Resources: Stop using resources for a printer. */
327 IPP_OP_DELETE_PRINTER, /* Delete-Printer: Delete an existing service. */
328 IPP_OP_GET_PRINTERS, /* Get-Printers: Get a list of services. */
329 IPP_OP_SHUTDOWN_ONE_PRINTER, /* Shutdown-One-Printer: Shutdown a service. */
330 IPP_OP_STARTUP_ONE_PRINTER, /* Startup-One-Printer: Start a service. */
331 IPP_OP_CANCEL_RESOURCE, /* Cancel-Resource: Uninstall a resource. */
332 IPP_OP_CREATE_RESOURCE, /* Create-Resource: Create a new (empty) resource. */
333 IPP_OP_INSTALL_RESOURCE, /* Install-Resource: Install a resource. */
334 IPP_OP_SEND_RESOURCE_DATA, /* Send-Resource-Data: Upload the data for a resource. */
335 IPP_OP_SET_RESOURCE_ATTRIBUTES, /* Set-Resource-Attributes: Set resource object attributes. */
336 IPP_OP_CREATE_RESOURCE_SUBSCRIPTIONS, /* Create-Resource-Subscriptions: Create event subscriptions for a resource. */
337 IPP_OP_CREATE_SYSTEM_SUBSCRIPTIONS, /* Create-System-Subscriptions: Create event subscriptions for a system. */
338 IPP_OP_DISABLE_ALL_PRINTERS, /* Disable-All-Printers: Stop accepting new jobs on all services. */
339 IPP_OP_ENABLE_ALL_PRINTERS, /* Enable-All-Printers: Start accepting new jobs on all services. */
340 IPP_OP_GET_SYSTEM_ATTRIBUTES, /* Get-System-Attributes: Get system object attributes. */
341 IPP_OP_GET_SYSTEM_SUPPORTED_VALUES, /* Get-System-Supported-Values: Get supported values for system object attributes. */
342 IPP_OP_PAUSE_ALL_PRINTERS, /* Pause-All-Printers: Stop all services immediately. */
343 IPP_OP_PAUSE_ALL_PRINTERS_AFTER_CURRENT_JOB,
344 /* Pause-All-Printers-After-Current-Job: Stop all services after processing the current jobs. */
345 IPP_OP_REGISTER_OUTPUT_DEVICE, /* Register-Output-Device: Register a remote service. */
346 IPP_OP_RESTART_SYSTEM, /* Restart-System: Restart all services. */
347 IPP_OP_RESUME_ALL_PRINTERS, /* Resume-All-Printers: Start job processing on all services. */
348 IPP_OP_SET_SYSTEM_ATTRIBUTES, /* Set-System-Attributes: Set system object attributes. */
349 IPP_OP_SHUTDOWN_ALL_PRINTERS, /* Shutdown-All-Printers: Shutdown all services. */
350 IPP_OP_STARTUP_ALL_PRINTERS, /* Startup-All-Printers: Startup all services. */
351
352 IPP_OP_PRIVATE = 0x4000, /* Reserved @private@ */
353 IPP_OP_CUPS_GET_DEFAULT, /* CUPS-Get-Default: Get the default printer */
354 IPP_OP_CUPS_GET_PRINTERS, /* CUPS-Get-Printers: Get a list of printers and/or classes */
355 IPP_OP_CUPS_ADD_MODIFY_PRINTER, /* CUPS-Add-Modify-Printer: Add or modify a printer */
356 IPP_OP_CUPS_DELETE_PRINTER, /* CUPS-Delete-Printer: Delete a printer */
357 IPP_OP_CUPS_GET_CLASSES, /* CUPS-Get-Classes: Get a list of classes @deprecated@ @exclude all@ */
358 IPP_OP_CUPS_ADD_MODIFY_CLASS, /* CUPS-Add-Modify-Class: Add or modify a class */
359 IPP_OP_CUPS_DELETE_CLASS, /* CUPS-Delete-Class: Delete a class */
360 IPP_OP_CUPS_ACCEPT_JOBS, /* CUPS-Accept-Jobs: Accept new jobs on a printer @exclude all@ */
361 IPP_OP_CUPS_REJECT_JOBS, /* CUPS-Reject-Jobs: Reject new jobs on a printer @exclude all@ */
362 IPP_OP_CUPS_SET_DEFAULT, /* CUPS-Set-Default: Set the default printer */
363 IPP_OP_CUPS_GET_DEVICES, /* CUPS-Get-Devices: Get a list of supported devices @deprecated@ */
364 IPP_OP_CUPS_GET_PPDS, /* CUPS-Get-PPDs: Get a list of supported drivers @deprecated@ */
365 IPP_OP_CUPS_MOVE_JOB, /* CUPS-Move-Job: Move a job to a different printer */
366 IPP_OP_CUPS_AUTHENTICATE_JOB, /* CUPS-Authenticate-Job: Authenticate a job @since CUPS 1.2/macOS 10.5@ */
367 IPP_OP_CUPS_GET_PPD, /* CUPS-Get-PPD: Get a PPD file @deprecated@ */
368 IPP_OP_CUPS_GET_DOCUMENT = 0x4027, /* CUPS-Get-Document: Get a document file @since CUPS 1.4/macOS 10.6@ */
369 IPP_OP_CUPS_CREATE_LOCAL_PRINTER /* CUPS-Create-Local-Printer: Create a local (temporary) printer @since CUPS 2.2@ */
370
371 # ifndef _CUPS_NO_DEPRECATED
372 # define IPP_PRINT_JOB IPP_OP_PRINT_JOB
373 # define IPP_PRINT_URI IPP_OP_PRINT_URI
374 # define IPP_VALIDATE_JOB IPP_OP_VALIDATE_JOB
375 # define IPP_CREATE_JOB IPP_OP_CREATE_JOB
376 # define IPP_SEND_DOCUMENT IPP_OP_SEND_DOCUMENT
377 # define IPP_SEND_URI IPP_OP_SEND_URI
378 # define IPP_CANCEL_JOB IPP_OP_CANCEL_JOB
379 # define IPP_GET_JOB_ATTRIBUTES IPP_OP_GET_JOB_ATTRIBUTES
380 # define IPP_GET_JOBS IPP_OP_GET_JOBS
381 # define IPP_GET_PRINTER_ATTRIBUTES IPP_OP_GET_PRINTER_ATTRIBUTES
382 # define IPP_HOLD_JOB IPP_OP_HOLD_JOB
383 # define IPP_RELEASE_JOB IPP_OP_RELEASE_JOB
384 # define IPP_RESTART_JOB IPP_OP_RESTART_JOB
385 # define IPP_PAUSE_PRINTER IPP_OP_PAUSE_PRINTER
386 # define IPP_RESUME_PRINTER IPP_OP_RESUME_PRINTER
387 # define IPP_PURGE_JOBS IPP_OP_PURGE_JOBS
388 # define IPP_SET_PRINTER_ATTRIBUTES IPP_OP_SET_PRINTER_ATTRIBUTES
389 # define IPP_SET_JOB_ATTRIBUTES IPP_OP_SET_JOB_ATTRIBUTES
390 # define IPP_GET_PRINTER_SUPPORTED_VALUES IPP_OP_GET_PRINTER_SUPPORTED_VALUES
391 # define IPP_CREATE_PRINTER_SUBSCRIPTION IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS
392 # define IPP_CREATE_JOB_SUBSCRIPTION IPP_OP_CREATE_JOB_SUBSCRIPTIONS
393 # define IPP_OP_CREATE_PRINTER_SUBSCRIPTION IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS
394 # define IPP_OP_CREATE_JOB_SUBSCRIPTION IPP_OP_CREATE_JOB_SUBSCRIPTIONS
395 # define IPP_GET_SUBSCRIPTION_ATTRIBUTES IPP_OP_GET_SUBSCRIPTION_ATTRIBUTES
396 # define IPP_GET_SUBSCRIPTIONS IPP_OP_GET_SUBSCRIPTIONS
397 # define IPP_RENEW_SUBSCRIPTION IPP_OP_RENEW_SUBSCRIPTION
398 # define IPP_CANCEL_SUBSCRIPTION IPP_OP_CANCEL_SUBSCRIPTION
399 # define IPP_GET_NOTIFICATIONS IPP_OP_GET_NOTIFICATIONS
400 # define IPP_SEND_NOTIFICATIONS IPP_OP_SEND_NOTIFICATIONS
401 # define IPP_GET_RESOURCE_ATTRIBUTES IPP_OP_GET_RESOURCE_ATTRIBUTES
402 # define IPP_GET_RESOURCE_DATA IPP_OP_GET_RESOURCE_DATA
403 # define IPP_GET_RESOURCES IPP_OP_GET_RESOURCES
404 # define IPP_GET_PRINT_SUPPORT_FILES IPP_OP_GET_PRINT_SUPPORT_FILES
405 # define IPP_ENABLE_PRINTER IPP_OP_ENABLE_PRINTER
406 # define IPP_DISABLE_PRINTER IPP_OP_DISABLE_PRINTER
407 # define IPP_PAUSE_PRINTER_AFTER_CURRENT_JOB IPP_OP_PAUSE_PRINTER_AFTER_CURRENT_JOB
408 # define IPP_HOLD_NEW_JOBS IPP_OP_HOLD_NEW_JOBS
409 # define IPP_RELEASE_HELD_NEW_JOBS IPP_OP_RELEASE_HELD_NEW_JOBS
410 # define IPP_DEACTIVATE_PRINTER IPP_OP_DEACTIVATE_PRINTER
411 # define IPP_ACTIVATE_PRINTER IPP_OP_ACTIVATE_PRINTER
412 # define IPP_RESTART_PRINTER IPP_OP_RESTART_PRINTER
413 # define IPP_SHUTDOWN_PRINTER IPP_OP_SHUTDOWN_PRINTER
414 # define IPP_STARTUP_PRINTER IPP_OP_STARTUP_PRINTER
415 # define IPP_REPROCESS_JOB IPP_OP_REPROCESS_JOB
416 # define IPP_CANCEL_CURRENT_JOB IPP_OP_CANCEL_CURRENT_JOB
417 # define IPP_SUSPEND_CURRENT_JOB IPP_OP_SUSPEND_CURRENT_JOB
418 # define IPP_RESUME_JOB IPP_OP_RESUME_JOB
419 # define IPP_PROMOTE_JOB IPP_OP_PROMOTE_JOB
420 # define IPP_SCHEDULE_JOB_AFTER IPP_OP_SCHEDULE_JOB_AFTER
421 # define IPP_CANCEL_DOCUMENT IPP_OP_CANCEL_DOCUMENT
422 # define IPP_GET_DOCUMENT_ATTRIBUTES IPP_OP_GET_DOCUMENT_ATTRIBUTES
423 # define IPP_GET_DOCUMENTS IPP_OP_GET_DOCUMENTS
424 # define IPP_DELETE_DOCUMENT IPP_OP_DELETE_DOCUMENT
425 # define IPP_SET_DOCUMENT_ATTRIBUTES IPP_OP_SET_DOCUMENT_ATTRIBUTES
426 # define IPP_CANCEL_JOBS IPP_OP_CANCEL_JOBS
427 # define IPP_CANCEL_MY_JOBS IPP_OP_CANCEL_MY_JOBS
428 # define IPP_RESUBMIT_JOB IPP_OP_RESUBMIT_JOB
429 # define IPP_CLOSE_JOB IPP_OP_CLOSE_JOB
430 # define IPP_IDENTIFY_PRINTER IPP_OP_IDENTIFY_PRINTER
431 # define IPP_VALIDATE_DOCUMENT IPP_OP_VALIDATE_DOCUMENT
432 # define IPP_OP_SEND_HARDCOPY_DOCUMENT IPP_OP_ADD_DOCUMENT_IMAGES
433 # define IPP_PRIVATE IPP_OP_PRIVATE
434 # define CUPS_GET_DEFAULT IPP_OP_CUPS_GET_DEFAULT
435 # define CUPS_GET_PRINTERS IPP_OP_CUPS_GET_PRINTERS
436 # define CUPS_ADD_MODIFY_PRINTER IPP_OP_CUPS_ADD_MODIFY_PRINTER
437 # define CUPS_DELETE_PRINTER IPP_OP_CUPS_DELETE_PRINTER
438 # define CUPS_GET_CLASSES IPP_OP_CUPS_GET_CLASSES
439 # define CUPS_ADD_MODIFY_CLASS IPP_OP_CUPS_ADD_MODIFY_CLASS
440 # define CUPS_DELETE_CLASS IPP_OP_CUPS_DELETE_CLASS
441 # define CUPS_ACCEPT_JOBS IPP_OP_CUPS_ACCEPT_JOBS
442 # define CUPS_REJECT_JOBS IPP_OP_CUPS_REJECT_JOBS
443 # define CUPS_SET_DEFAULT IPP_OP_CUPS_SET_DEFAULT
444 # define CUPS_GET_DEVICES IPP_OP_CUPS_GET_DEVICES
445 # define CUPS_GET_PPDS IPP_OP_CUPS_GET_PPDS
446 # define CUPS_MOVE_JOB IPP_OP_CUPS_MOVE_JOB
447 # define CUPS_AUTHENTICATE_JOB IPP_OP_CUPS_AUTHENTICATE_JOB
448 # define CUPS_GET_PPD IPP_OP_CUPS_GET_PPD
449 # define CUPS_GET_DOCUMENT IPP_OP_CUPS_GET_DOCUMENT
450 /* Legacy names */
451 # define CUPS_ADD_PRINTER IPP_OP_CUPS_ADD_MODIFY_PRINTER
452 # define CUPS_ADD_CLASS IPP_OP_CUPS_ADD_MODIFY_CLASS
453 # endif /* !_CUPS_NO_DEPRECATED */
454 } ipp_op_t;
455
456 typedef enum ipp_orient_e /**** Orientation values ****/
457 {
458 IPP_ORIENT_PORTRAIT = 3, /* No rotation */
459 IPP_ORIENT_LANDSCAPE, /* 90 degrees counter-clockwise */
460 IPP_ORIENT_REVERSE_LANDSCAPE, /* 90 degrees clockwise */
461 IPP_ORIENT_REVERSE_PORTRAIT, /* 180 degrees */
462 IPP_ORIENT_NONE /* No rotation */
463
464 # ifndef _CUPS_NO_DEPRECATED
465 # define IPP_PORTRAIT IPP_ORIENT_PORTRAIT
466 # define IPP_LANDSCAPE IPP_ORIENT_LANDSCAPE
467 # define IPP_REVERSE_LANDSCAPE IPP_ORIENT_REVERSE_LANDSCAPE
468 # define IPP_REVERSE_PORTRAIT IPP_ORIENT_REVERSE_PORTRAIT
469 # endif /* !_CUPS_NO_DEPRECATED */
470 } ipp_orient_t;
471
472 typedef enum ipp_pstate_e /**** Printer state values ****/
473 {
474 IPP_PSTATE_IDLE = 3, /* Printer is idle */
475 IPP_PSTATE_PROCESSING, /* Printer is working */
476 IPP_PSTATE_STOPPED /* Printer is stopped */
477
478 # ifndef _CUPS_NO_DEPRECATED
479 # define IPP_PRINTER_IDLE IPP_PSTATE_IDLE
480 # define IPP_PRINTER_PROCESSING IPP_PSTATE_PROCESSING
481 # define IPP_PRINTER_STOPPED IPP_PSTATE_STOPPED
482 # endif /* _CUPS_NO_DEPRECATED */
483 } ipp_pstate_t;
484
485 typedef enum ipp_quality_e /**** Print quality values ****/
486 {
487 IPP_QUALITY_DRAFT = 3, /* Draft quality */
488 IPP_QUALITY_NORMAL, /* Normal quality */
489 IPP_QUALITY_HIGH /* High quality */
490 } ipp_quality_t;
491
492 typedef enum ipp_res_e /**** Resolution units ****/
493 {
494 IPP_RES_PER_INCH = 3, /* Pixels per inch */
495 IPP_RES_PER_CM /* Pixels per centimeter */
496 } ipp_res_t;
497
498 typedef enum ipp_state_e /**** ipp_t state values ****/
499 {
500 IPP_STATE_ERROR = -1, /* An error occurred */
501 IPP_STATE_IDLE, /* Nothing is happening/request completed */
502 IPP_STATE_HEADER, /* The request header needs to be sent/received */
503 IPP_STATE_ATTRIBUTE, /* One or more attributes need to be sent/received */
504 IPP_STATE_DATA /* IPP request data needs to be sent/received */
505
506 # ifndef _CUPS_NO_DEPRECATED
507 # define IPP_ERROR IPP_STATE_ERROR
508 # define IPP_IDLE IPP_STATE_IDLE
509 # define IPP_HEADER IPP_STATE_HEADER
510 # define IPP_ATTRIBUTE IPP_STATE_ATTRIBUTE
511 # define IPP_DATA IPP_STATE_DATA
512 # endif /* !_CUPS_NO_DEPRECATED */
513 } ipp_state_t;
514
515 typedef enum ipp_status_e /**** IPP status code values ****/
516 {
517 IPP_STATUS_CUPS_INVALID = -1, /* Invalid status name for @link ippErrorValue@ */
518 IPP_STATUS_OK = 0x0000, /* successful-ok */
519 IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED, /* successful-ok-ignored-or-substituted-attributes */
520 IPP_STATUS_OK_CONFLICTING, /* successful-ok-conflicting-attributes */
521 IPP_STATUS_OK_IGNORED_SUBSCRIPTIONS, /* successful-ok-ignored-subscriptions */
522 IPP_STATUS_OK_IGNORED_NOTIFICATIONS, /* successful-ok-ignored-notifications @private@ */
523 IPP_STATUS_OK_TOO_MANY_EVENTS, /* successful-ok-too-many-events */
524 IPP_STATUS_OK_BUT_CANCEL_SUBSCRIPTION,/* successful-ok-but-cancel-subscription @private@ */
525 IPP_STATUS_OK_EVENTS_COMPLETE, /* successful-ok-events-complete */
526 IPP_STATUS_REDIRECTION_OTHER_SITE = 0x0200,
527 /* redirection-other-site @private@ */
528 IPP_STATUS_CUPS_SEE_OTHER = 0x0280, /* cups-see-other @private@ */
529 IPP_STATUS_ERROR_BAD_REQUEST = 0x0400,/* client-error-bad-request */
530 IPP_STATUS_ERROR_FORBIDDEN, /* client-error-forbidden */
531 IPP_STATUS_ERROR_NOT_AUTHENTICATED, /* client-error-not-authenticated */
532 IPP_STATUS_ERROR_NOT_AUTHORIZED, /* client-error-not-authorized */
533 IPP_STATUS_ERROR_NOT_POSSIBLE, /* client-error-not-possible */
534 IPP_STATUS_ERROR_TIMEOUT, /* client-error-timeout */
535 IPP_STATUS_ERROR_NOT_FOUND, /* client-error-not-found */
536 IPP_STATUS_ERROR_GONE, /* client-error-gone */
537 IPP_STATUS_ERROR_REQUEST_ENTITY, /* client-error-request-entity-too-large */
538 IPP_STATUS_ERROR_REQUEST_VALUE, /* client-error-request-value-too-long */
539 IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED,
540 /* client-error-document-format-not-supported */
541 IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES,/* client-error-attributes-or-values-not-supported */
542 IPP_STATUS_ERROR_URI_SCHEME, /* client-error-uri-scheme-not-supported */
543 IPP_STATUS_ERROR_CHARSET, /* client-error-charset-not-supported */
544 IPP_STATUS_ERROR_CONFLICTING, /* client-error-conflicting-attributes */
545 IPP_STATUS_ERROR_COMPRESSION_NOT_SUPPORTED,
546 /* client-error-compression-not-supported */
547 IPP_STATUS_ERROR_COMPRESSION_ERROR, /* client-error-compression-error */
548 IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR,
549 /* client-error-document-format-error */
550 IPP_STATUS_ERROR_DOCUMENT_ACCESS, /* client-error-document-access-error */
551 IPP_STATUS_ERROR_ATTRIBUTES_NOT_SETTABLE,
552 /* client-error-attributes-not-settable */
553 IPP_STATUS_ERROR_IGNORED_ALL_SUBSCRIPTIONS,
554 /* client-error-ignored-all-subscriptions */
555 IPP_STATUS_ERROR_TOO_MANY_SUBSCRIPTIONS,
556 /* client-error-too-many-subscriptions */
557 IPP_STATUS_ERROR_IGNORED_ALL_NOTIFICATIONS,
558 /* client-error-ignored-all-notifications @private@ */
559 IPP_STATUS_ERROR_PRINT_SUPPORT_FILE_NOT_FOUND,
560 /* client-error-print-support-file-not-found @private@ */
561 IPP_STATUS_ERROR_DOCUMENT_PASSWORD, /* client-error-document-password-error */
562 IPP_STATUS_ERROR_DOCUMENT_PERMISSION, /* client-error-document-permission-error */
563 IPP_STATUS_ERROR_DOCUMENT_SECURITY, /* client-error-document-security-error */
564 IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE,/* client-error-document-unprintable-error */
565 IPP_STATUS_ERROR_ACCOUNT_INFO_NEEDED, /* client-error-account-info-needed */
566 IPP_STATUS_ERROR_ACCOUNT_CLOSED, /* client-error-account-closed */
567 IPP_STATUS_ERROR_ACCOUNT_LIMIT_REACHED,
568 /* client-error-account-limit-reached */
569 IPP_STATUS_ERROR_ACCOUNT_AUTHORIZATION_FAILED,
570 /* client-error-account-authorization-failed */
571 IPP_STATUS_ERROR_NOT_FETCHABLE, /* client-error-not-fetchable */
572
573 /* Legacy status codes for paid printing */
574 IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED = 0x049C,
575 /* cups-error-account-info-needed @deprecated@ */
576 IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED, /* cups-error-account-closed @deprecate@ */
577 IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED,
578 /* cups-error-account-limit-reached @deprecated@ */
579 IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED,
580 /* cups-error-account-authorization-failed @deprecated@ */
581
582 IPP_STATUS_ERROR_INTERNAL = 0x0500, /* server-error-internal-error */
583 IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED,
584 /* server-error-operation-not-supported */
585 IPP_STATUS_ERROR_SERVICE_UNAVAILABLE, /* server-error-service-unavailable */
586 IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED,
587 /* server-error-version-not-supported */
588 IPP_STATUS_ERROR_DEVICE, /* server-error-device-error */
589 IPP_STATUS_ERROR_TEMPORARY, /* server-error-temporary-error */
590 IPP_STATUS_ERROR_NOT_ACCEPTING_JOBS, /* server-error-not-accepting-jobs */
591 IPP_STATUS_ERROR_BUSY, /* server-error-busy */
592 IPP_STATUS_ERROR_JOB_CANCELED, /* server-error-job-canceled */
593 IPP_STATUS_ERROR_MULTIPLE_JOBS_NOT_SUPPORTED,
594 /* server-error-multiple-document-jobs-not-supported */
595 IPP_STATUS_ERROR_PRINTER_IS_DEACTIVATED,
596 /* server-error-printer-is-deactivated */
597 IPP_STATUS_ERROR_TOO_MANY_JOBS, /* server-error-too-many-jobs */
598 IPP_STATUS_ERROR_TOO_MANY_DOCUMENTS, /* server-error-too-many-documents */
599
600 /* These are internal and never sent over the wire... */
601 IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED = 0x1000,
602 /* cups-authentication-canceled - Authentication canceled by user @since CUPS 1.5/macOS 10.7@ */
603 IPP_STATUS_ERROR_CUPS_PKI, /* cups-pki-error - Error negotiating a secure connection @since CUPS 1.5/macOS 10.7@ */
604 IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED/* cups-upgrade-required - TLS upgrade required @since CUPS 1.5/macOS 10.7@ */
605
606 # ifndef _CUPS_NO_DEPRECATED
607 # define IPP_OK IPP_STATUS_OK
608 # define IPP_OK_SUBST IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED
609 # define IPP_OK_CONFLICT IPP_STATUS_OK_CONFLICTING
610 # define IPP_OK_IGNORED_SUBSCRIPTIONS IPP_STATUS_OK_IGNORED_SUBSCRIPTIONS
611 # define IPP_OK_IGNORED_NOTIFICATIONS IPP_STATUS_OK_IGNORED_NOTIFICATIONS
612 # define IPP_OK_TOO_MANY_EVENTS IPP_STATUS_OK_TOO_MANY_EVENTS
613 # define IPP_OK_BUT_CANCEL_SUBSCRIPTION IPP_STATUS_OK_BUT_CANCEL_SUBSCRIPTION
614 # define IPP_OK_EVENTS_COMPLETE IPP_STATUS_OK_EVENTS_COMPLETE
615 # define IPP_REDIRECTION_OTHER_SITE IPP_STATUS_REDIRECTION_OTHER_SITE
616 # define CUPS_SEE_OTHER IPP_STATUS_CUPS_SEE_OTHER
617 # define IPP_BAD_REQUEST IPP_STATUS_ERROR_BAD_REQUEST
618 # define IPP_FORBIDDEN IPP_STATUS_ERROR_FORBIDDEN
619 # define IPP_NOT_AUTHENTICATED IPP_STATUS_ERROR_NOT_AUTHENTICATED
620 # define IPP_NOT_AUTHORIZED IPP_STATUS_ERROR_NOT_AUTHORIZED
621 # define IPP_NOT_POSSIBLE IPP_STATUS_ERROR_NOT_POSSIBLE
622 # define IPP_TIMEOUT IPP_STATUS_ERROR_TIMEOUT
623 # define IPP_NOT_FOUND IPP_STATUS_ERROR_NOT_FOUND
624 # define IPP_GONE IPP_STATUS_ERROR_GONE
625 # define IPP_REQUEST_ENTITY IPP_STATUS_ERROR_REQUEST_ENTITY
626 # define IPP_REQUEST_VALUE IPP_STATUS_ERROR_REQUEST_VALUE
627 # define IPP_DOCUMENT_FORMAT IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
628 # define IPP_ATTRIBUTES IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
629 # define IPP_URI_SCHEME IPP_STATUS_ERROR_URI_SCHEME
630 # define IPP_CHARSET IPP_STATUS_ERROR_CHARSET
631 # define IPP_CONFLICT IPP_STATUS_ERROR_CONFLICTING
632 # define IPP_COMPRESSION_NOT_SUPPORTED IPP_STATUS_ERROR_COMPRESSION_NOT_SUPPORTED
633 # define IPP_COMPRESSION_ERROR IPP_STATUS_ERROR_COMPRESSION_ERROR
634 # define IPP_DOCUMENT_FORMAT_ERROR IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR
635 # define IPP_DOCUMENT_ACCESS_ERROR IPP_STATUS_ERROR_DOCUMENT_ACCESS
636 # define IPP_ATTRIBUTES_NOT_SETTABLE IPP_STATUS_ERROR_ATTRIBUTES_NOT_SETTABLE
637 # define IPP_IGNORED_ALL_SUBSCRIPTIONS IPP_STATUS_ERROR_IGNORED_ALL_SUBSCRIPTIONS
638 # define IPP_TOO_MANY_SUBSCRIPTIONS IPP_STATUS_ERROR_TOO_MANY_SUBSCRIPTIONS
639 # define IPP_IGNORED_ALL_NOTIFICATIONS IPP_STATUS_ERROR_IGNORED_ALL_NOTIFICATIONS
640 # define IPP_PRINT_SUPPORT_FILE_NOT_FOUND IPP_STATUS_ERROR_PRINT_SUPPORT_FILE_NOT_FOUND
641 # define IPP_DOCUMENT_PASSWORD_ERROR IPP_STATUS_ERROR_DOCUMENT_PASSWORD
642 # define IPP_DOCUMENT_PERMISSION_ERROR IPP_STATUS_ERROR_DOCUMENT_PERMISSION
643 # define IPP_DOCUMENT_SECURITY_ERROR IPP_STATUS_ERROR_DOCUMENT_SECURITY
644 # define IPP_DOCUMENT_UNPRINTABLE_ERROR IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE
645 # define IPP_INTERNAL_ERROR IPP_STATUS_ERROR_INTERNAL
646 # define IPP_OPERATION_NOT_SUPPORTED IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED
647 # define IPP_SERVICE_UNAVAILABLE IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
648 # define IPP_VERSION_NOT_SUPPORTED IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED
649 # define IPP_DEVICE_ERROR IPP_STATUS_ERROR_DEVICE
650 # define IPP_TEMPORARY_ERROR IPP_STATUS_ERROR_TEMPORARY
651 # define IPP_NOT_ACCEPTING IPP_STATUS_ERROR_NOT_ACCEPTING_JOBS
652 # define IPP_PRINTER_BUSY IPP_STATUS_ERROR_BUSY
653 # define IPP_ERROR_JOB_CANCELED IPP_STATUS_ERROR_JOB_CANCELED
654 # define IPP_MULTIPLE_JOBS_NOT_SUPPORTED IPP_STATUS_ERROR_MULTIPLE_JOBS_NOT_SUPPORTED
655 # define IPP_PRINTER_IS_DEACTIVATED IPP_STATUS_ERROR_PRINTER_IS_DEACTIVATED
656 # define IPP_TOO_MANY_JOBS IPP_STATUS_ERROR_TOO_MANY_JOBS
657 # define IPP_TOO_MANY_DOCUMENTS IPP_STATUS_ERROR_TOO_MANY_DOCUMENTS
658 # define IPP_AUTHENTICATION_CANCELED IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
659 # define IPP_PKI_ERROR IPP_STATUS_ERROR_CUPS_PKI
660 # define IPP_UPGRADE_REQUIRED IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED
661 /* Legacy name for canceled status */
662 # define IPP_ERROR_JOB_CANCELLED IPP_STATUS_ERROR_JOB_CANCELED
663 # endif /* _CUPS_NO_DEPRECATED */
664 } ipp_status_t;
665
666 typedef enum ipp_tag_e /**** Value and group tag values for attributes ****/
667 {
668 IPP_TAG_CUPS_INVALID = -1, /* Invalid tag name for @link ippTagValue@ */
669 IPP_TAG_ZERO = 0x00, /* Zero tag - used for separators */
670 IPP_TAG_OPERATION, /* Operation group */
671 IPP_TAG_JOB, /* Job group */
672 IPP_TAG_END, /* End-of-attributes */
673 IPP_TAG_PRINTER, /* Printer group */
674 IPP_TAG_UNSUPPORTED_GROUP, /* Unsupported attributes group */
675 IPP_TAG_SUBSCRIPTION, /* Subscription group */
676 IPP_TAG_EVENT_NOTIFICATION, /* Event group */
677 IPP_TAG_RESOURCE, /* Resource group */
678 IPP_TAG_DOCUMENT, /* Document group */
679 IPP_TAG_SYSTEM, /* System group */
680 IPP_TAG_UNSUPPORTED_VALUE = 0x10, /* Unsupported value */
681 IPP_TAG_DEFAULT, /* Default value */
682 IPP_TAG_UNKNOWN, /* Unknown value */
683 IPP_TAG_NOVALUE, /* No-value value */
684 IPP_TAG_NOTSETTABLE = 0x15, /* Not-settable value */
685 IPP_TAG_DELETEATTR, /* Delete-attribute value */
686 IPP_TAG_ADMINDEFINE, /* Admin-defined value */
687 IPP_TAG_INTEGER = 0x21, /* Integer value */
688 IPP_TAG_BOOLEAN, /* Boolean value */
689 IPP_TAG_ENUM, /* Enumeration value */
690 IPP_TAG_STRING = 0x30, /* Octet string value */
691 IPP_TAG_DATE, /* Date/time value */
692 IPP_TAG_RESOLUTION, /* Resolution value */
693 IPP_TAG_RANGE, /* Range value */
694 IPP_TAG_BEGIN_COLLECTION, /* Beginning of collection value @exclude all@ */
695 IPP_TAG_TEXTLANG, /* Text-with-language value */
696 IPP_TAG_NAMELANG, /* Name-with-language value */
697 IPP_TAG_END_COLLECTION, /* End of collection value @exclude all@ */
698 IPP_TAG_TEXT = 0x41, /* Text value */
699 IPP_TAG_NAME, /* Name value */
700 IPP_TAG_RESERVED_STRING, /* Reserved for future string value @private@ */
701 IPP_TAG_KEYWORD, /* Keyword value */
702 IPP_TAG_URI, /* URI value */
703 IPP_TAG_URISCHEME, /* URI scheme value */
704 IPP_TAG_CHARSET, /* Character set value */
705 IPP_TAG_LANGUAGE, /* Language value */
706 IPP_TAG_MIMETYPE, /* MIME media type value */
707 IPP_TAG_MEMBERNAME, /* Collection member name value @exclude all@ */
708 IPP_TAG_EXTENSION = 0x7f, /* Extension point for 32-bit tags @exclude all@ */
709 IPP_TAG_CUPS_MASK = 0x7fffffff, /* Mask for copied attribute values @private@ */
710 /* The following expression is used to avoid compiler warnings with +/-0x80000000 */
711 IPP_TAG_CUPS_CONST = -0x7fffffff-1 /* Bitflag for copied/const attribute values @private@ */
712
713 # ifndef _CUPS_NO_DEPRECATED
714 # define IPP_TAG_MASK IPP_TAG_CUPS_MASK
715 # define IPP_TAG_COPY IPP_TAG_CUPS_CONST
716 # endif /* !_CUPS_NO_DEPRECATED */
717 } ipp_tag_t;
718
719 typedef unsigned char ipp_uchar_t; /**** Unsigned 8-bit integer/character @exclude all@ ****/
720 typedef struct _ipp_s ipp_t; /**** IPP request/response data ****/
721 typedef struct _ipp_attribute_s ipp_attribute_t;
722 /**** IPP attribute ****/
723
724 /**** New in CUPS 1.2/macOS 10.5 ****/
725 typedef ssize_t (*ipp_iocb_t)(void *context, ipp_uchar_t *buffer, size_t bytes);
726 /**** ippReadIO/ippWriteIO callback function @since CUPS 1.2/macOS 10.5@ ****/
727
728 /**** New in CUPS 1.6/macOS 10.8 ****/
729 typedef int (*ipp_copycb_t)(void *context, ipp_t *dst, ipp_attribute_t *attr);
730 /**** ippCopyAttributes callback function @since CUPS 1.6/macOS 10.8 ****/
731
732
733 /*
734 * The following structures are PRIVATE starting with CUPS 1.6/macOS 10.8.
735 * Please use the new accessor functions available in CUPS 1.6 and later, as
736 * these definitions will be moved to a private header file in a future release.
737 *
738 * Define _IPP_PRIVATE_STRUCTURES to 1 to cause the private IPP structures to be
739 * exposed in CUPS 1.6. This happens automatically on macOS when compiling for
740 * a deployment target of 10.7 or earlier.
741 *
742 * Define _IPP_PRIVATE_STRUCTURES to 0 to prevent the private IPP structures
743 * from being exposed. This is useful when migrating existing code to the new
744 * accessors.
745 */
746
747 # ifdef _IPP_PRIVATE_STRUCTURES
748 /* Somebody has overridden the value */
749 # elif defined(_CUPS_SOURCE) || defined(_CUPS_IPP_PRIVATE_H_)
750 /* Building CUPS */
751 # define _IPP_PRIVATE_STRUCTURES 1
752 # elif defined(__APPLE__)
753 # if defined(MAC_OS_X_VERSION_10_8) && MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_8
754 /* Building for 10.7 and earlier */
755 # define _IPP_PRIVATE_STRUCTURES 1
756 # elif !defined(MAC_OS_X_VERSION_10_8)
757 /* Building for 10.7 and earlier */
758 # define _IPP_PRIVATE_STRUCTURES 1
759 # endif /* MAC_OS_X_VERSION_10_8 && MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_8 */
760 # else
761 # define _IPP_PRIVATE_STRUCTURES 0
762 # endif /* _CUPS_SOURCE || _CUPS_IPP_PRIVATE_H_ */
763
764 # if _IPP_PRIVATE_STRUCTURES
765 typedef union _ipp_request_u /**** Request Header ****/
766 {
767 struct /* Any Header */
768 {
769 ipp_uchar_t version[2]; /* Protocol version number */
770 int op_status; /* Operation ID or status code*/
771 int request_id; /* Request ID */
772 } any;
773
774 struct /* Operation Header */
775 {
776 ipp_uchar_t version[2]; /* Protocol version number */
777 ipp_op_t operation_id; /* Operation ID */
778 int request_id; /* Request ID */
779 } op;
780
781 struct /* Status Header */
782 {
783 ipp_uchar_t version[2]; /* Protocol version number */
784 ipp_status_t status_code; /* Status code */
785 int request_id; /* Request ID */
786 } status;
787
788 /**** New in CUPS 1.1.19 ****/
789 struct /* Event Header @since CUPS 1.1.19/macOS 10.3@ */
790 {
791 ipp_uchar_t version[2]; /* Protocol version number */
792 ipp_status_t status_code; /* Status code */
793 int request_id; /* Request ID */
794 } event;
795 } _ipp_request_t;
796
797 /**** New in CUPS 1.1.19 ****/
798
799 typedef union _ipp_value_u /**** Attribute Value ****/
800 {
801 int integer; /* Integer/enumerated value */
802
803 char boolean; /* Boolean value */
804
805 ipp_uchar_t date[11]; /* Date/time value */
806
807 struct
808 {
809 int xres, /* Horizontal resolution */
810 yres; /* Vertical resolution */
811 ipp_res_t units; /* Resolution units */
812 } resolution; /* Resolution value */
813
814 struct
815 {
816 int lower, /* Lower value */
817 upper; /* Upper value */
818 } range; /* Range of integers value */
819
820 struct
821 {
822 char *language; /* Language code */
823 char *text; /* String */
824 } string; /* String with language value */
825
826 struct
827 {
828 int length; /* Length of attribute */
829 void *data; /* Data in attribute */
830 } unknown; /* Unknown attribute type */
831
832 /**** New in CUPS 1.1.19 ****/
833 ipp_t *collection; /* Collection value @since CUPS 1.1.19/macOS 10.3@ */
834 } _ipp_value_t;
835 typedef _ipp_value_t ipp_value_t; /**** Convenience typedef that will be removed @private@ ****/
836
837 struct _ipp_attribute_s /**** IPP attribute ****/
838 {
839 ipp_attribute_t *next; /* Next attribute in list */
840 ipp_tag_t group_tag, /* Job/Printer/Operation group tag */
841 value_tag; /* What type of value is it? */
842 char *name; /* Name of attribute */
843 int num_values; /* Number of values */
844 _ipp_value_t values[1]; /* Values */
845 };
846
847 struct _ipp_s /**** IPP Request/Response/Notification ****/
848 {
849 ipp_state_t state; /* State of request */
850 _ipp_request_t request; /* Request header */
851 ipp_attribute_t *attrs; /* Attributes */
852 ipp_attribute_t *last; /* Last attribute in list */
853 ipp_attribute_t *current; /* Current attribute (for read/write) */
854 ipp_tag_t curtag; /* Current attribute group tag */
855
856 /**** New in CUPS 1.2 ****/
857 ipp_attribute_t *prev; /* Previous attribute (for read) @since CUPS 1.2/macOS 10.5@ */
858
859 /**** New in CUPS 1.4.4 ****/
860 int use; /* Use count @since CUPS 1.4.4/macOS 10.6.?@ */
861 /**** New in CUPS 2.0 ****/
862 int atend, /* At end of list? */
863 curindex; /* Current attribute index for hierarchical search */
864 };
865 # endif /* _IPP_PRIVATE_STRUCTURES */
866
867
868 /*
869 * Prototypes...
870 */
871
872 extern ipp_attribute_t *ippAddBoolean(ipp_t *ipp, ipp_tag_t group,
873 const char *name, char value);
874 extern ipp_attribute_t *ippAddBooleans(ipp_t *ipp, ipp_tag_t group,
875 const char *name, int num_values,
876 const char *values);
877 extern ipp_attribute_t *ippAddDate(ipp_t *ipp, ipp_tag_t group,
878 const char *name, const ipp_uchar_t *value);
879 extern ipp_attribute_t *ippAddInteger(ipp_t *ipp, ipp_tag_t group,
880 ipp_tag_t value_tag, const char *name,
881 int value);
882 extern ipp_attribute_t *ippAddIntegers(ipp_t *ipp, ipp_tag_t group,
883 ipp_tag_t value_tag, const char *name,
884 int num_values, const int *values);
885 extern ipp_attribute_t *ippAddRange(ipp_t *ipp, ipp_tag_t group,
886 const char *name, int lower, int upper);
887 extern ipp_attribute_t *ippAddRanges(ipp_t *ipp, ipp_tag_t group,
888 const char *name, int num_values,
889 const int *lower, const int *upper);
890 extern ipp_attribute_t *ippAddResolution(ipp_t *ipp, ipp_tag_t group,
891 const char *name, ipp_res_t units,
892 int xres, int yres);
893 extern ipp_attribute_t *ippAddResolutions(ipp_t *ipp, ipp_tag_t group,
894 const char *name, int num_values,
895 ipp_res_t units, const int *xres,
896 const int *yres);
897 extern ipp_attribute_t *ippAddSeparator(ipp_t *ipp);
898 extern ipp_attribute_t *ippAddString(ipp_t *ipp, ipp_tag_t group,
899 ipp_tag_t value_tag, const char *name,
900 const char *language, const char *value);
901 extern ipp_attribute_t *ippAddStrings(ipp_t *ipp, ipp_tag_t group,
902 ipp_tag_t value_tag, const char *name,
903 int num_values, const char *language,
904 const char * const *values);
905 extern time_t ippDateToTime(const ipp_uchar_t *date);
906 extern void ippDelete(ipp_t *ipp);
907 extern const char *ippErrorString(ipp_status_t error);
908 extern ipp_attribute_t *ippFindAttribute(ipp_t *ipp, const char *name,
909 ipp_tag_t value_tag);
910 extern ipp_attribute_t *ippFindNextAttribute(ipp_t *ipp, const char *name,
911 ipp_tag_t value_tag);
912 extern size_t ippLength(ipp_t *ipp);
913 extern ipp_t *ippNew(void);
914 extern ipp_state_t ippRead(http_t *http, ipp_t *ipp);
915 extern const ipp_uchar_t *ippTimeToDate(time_t t);
916 extern ipp_state_t ippWrite(http_t *http, ipp_t *ipp);
917 extern int ippPort(void);
918 extern void ippSetPort(int p);
919
920 /**** New in CUPS 1.1.19 ****/
921 extern ipp_attribute_t *ippAddCollection(ipp_t *ipp, ipp_tag_t group,
922 const char *name, ipp_t *value) _CUPS_API_1_1_19;
923 extern ipp_attribute_t *ippAddCollections(ipp_t *ipp, ipp_tag_t group,
924 const char *name, int num_values,
925 const ipp_t **values) _CUPS_API_1_1_19;
926 extern void ippDeleteAttribute(ipp_t *ipp, ipp_attribute_t *attr) _CUPS_API_1_1_19;
927 extern ipp_state_t ippReadFile(int fd, ipp_t *ipp) _CUPS_API_1_1_19;
928 extern ipp_state_t ippWriteFile(int fd, ipp_t *ipp) _CUPS_API_1_1_19;
929
930 /**** New in CUPS 1.2/macOS 10.5 ****/
931 extern ipp_attribute_t *ippAddOctetString(ipp_t *ipp, ipp_tag_t group,
932 const char *name,
933 const void *data, int datalen) _CUPS_API_1_2;
934 extern ipp_status_t ippErrorValue(const char *name) _CUPS_API_1_2;
935 extern ipp_t *ippNewRequest(ipp_op_t op) _CUPS_API_1_2;
936 extern const char *ippOpString(ipp_op_t op) _CUPS_API_1_2;
937 extern ipp_op_t ippOpValue(const char *name) _CUPS_API_1_2;
938 extern ipp_state_t ippReadIO(void *src, ipp_iocb_t cb, int blocking,
939 ipp_t *parent, ipp_t *ipp) _CUPS_API_1_2;
940 extern ipp_state_t ippWriteIO(void *dst, ipp_iocb_t cb, int blocking,
941 ipp_t *parent, ipp_t *ipp) _CUPS_API_1_2;
942
943 /**** New in CUPS 1.4/macOS 10.6 ****/
944 extern const char *ippTagString(ipp_tag_t tag) _CUPS_API_1_4;
945 extern ipp_tag_t ippTagValue(const char *name) _CUPS_API_1_4;
946
947 /**** New in CUPS 1.6/macOS 10.8 ****/
948 extern ipp_attribute_t *ippAddOutOfBand(ipp_t *ipp, ipp_tag_t group,
949 ipp_tag_t value_tag, const char *name)
950 _CUPS_API_1_6;
951 extern size_t ippAttributeString(ipp_attribute_t *attr, char *buffer,
952 size_t bufsize) _CUPS_API_1_6;
953 extern ipp_attribute_t *ippCopyAttribute(ipp_t *dst, ipp_attribute_t *attr,
954 int quickcopy) _CUPS_API_1_6;
955 extern int ippCopyAttributes(ipp_t *dst, ipp_t *src,
956 int quickcopy, ipp_copycb_t cb,
957 void *context) _CUPS_API_1_6;
958 extern int ippDeleteValues(ipp_t *ipp, ipp_attribute_t **attr,
959 int element, int count) _CUPS_API_1_6;
960 extern const char *ippEnumString(const char *attrname, int enumvalue)
961 _CUPS_API_1_6;
962 extern int ippEnumValue(const char *attrname,
963 const char *enumstring) _CUPS_API_1_6;
964 extern ipp_attribute_t *ippFirstAttribute(ipp_t *ipp) _CUPS_API_1_6;
965 extern int ippGetBoolean(ipp_attribute_t *attr, int element)
966 _CUPS_API_1_6;
967 extern ipp_t *ippGetCollection(ipp_attribute_t *attr,
968 int element) _CUPS_API_1_6;
969 extern int ippGetCount(ipp_attribute_t *attr) _CUPS_API_1_6;
970 extern const ipp_uchar_t *ippGetDate(ipp_attribute_t *attr, int element)
971 _CUPS_API_1_6;
972 extern ipp_tag_t ippGetGroupTag(ipp_attribute_t *attr) _CUPS_API_1_6;
973 extern int ippGetInteger(ipp_attribute_t *attr, int element)
974 _CUPS_API_1_6;
975 extern const char *ippGetName(ipp_attribute_t *attr) _CUPS_API_1_6;
976 extern ipp_op_t ippGetOperation(ipp_t *ipp) _CUPS_API_1_6;
977 extern int ippGetRange(ipp_attribute_t *attr, int element,
978 int *upper) _CUPS_API_1_6;
979 extern int ippGetRequestId(ipp_t *ipp) _CUPS_API_1_6;
980 extern int ippGetResolution(ipp_attribute_t *attr, int element,
981 int *yres, ipp_res_t *units)
982 _CUPS_API_1_6;
983 extern ipp_state_t ippGetState(ipp_t *ipp) _CUPS_API_1_6;
984 extern ipp_status_t ippGetStatusCode(ipp_t *ipp) _CUPS_API_1_6;
985 extern const char *ippGetString(ipp_attribute_t *attr, int element,
986 const char **language) _CUPS_API_1_6;
987 extern ipp_tag_t ippGetValueTag(ipp_attribute_t *attr) _CUPS_API_1_6;
988 extern int ippGetVersion(ipp_t *ipp, int *minor) _CUPS_API_1_6;
989 extern ipp_attribute_t *ippNextAttribute(ipp_t *ipp) _CUPS_API_1_6;
990 extern int ippSetBoolean(ipp_t *ipp, ipp_attribute_t **attr,
991 int element, int boolvalue) _CUPS_API_1_6;
992 extern int ippSetCollection(ipp_t *ipp, ipp_attribute_t **attr,
993 int element, ipp_t *colvalue)
994 _CUPS_API_1_6;
995 extern int ippSetDate(ipp_t *ipp, ipp_attribute_t **attr,
996 int element, const ipp_uchar_t *datevalue)
997 _CUPS_API_1_6;
998 extern int ippSetGroupTag(ipp_t *ipp, ipp_attribute_t **attr,
999 ipp_tag_t group_tag) _CUPS_API_1_6;
1000 extern int ippSetInteger(ipp_t *ipp, ipp_attribute_t **attr,
1001 int element, int intvalue) _CUPS_API_1_6;
1002 extern int ippSetName(ipp_t *ipp, ipp_attribute_t **attr,
1003 const char *name) _CUPS_API_1_6;
1004 extern int ippSetOperation(ipp_t *ipp, ipp_op_t op) _CUPS_API_1_6;
1005 extern int ippSetRange(ipp_t *ipp, ipp_attribute_t **attr,
1006 int element, int lowervalue, int uppervalue)
1007 _CUPS_API_1_6;
1008 extern int ippSetRequestId(ipp_t *ipp, int request_id)
1009 _CUPS_API_1_6;
1010 extern int ippSetResolution(ipp_t *ipp, ipp_attribute_t **attr,
1011 int element, ipp_res_t unitsvalue,
1012 int xresvalue, int yresvalue)
1013 _CUPS_API_1_6;
1014 extern int ippSetState(ipp_t *ipp, ipp_state_t state)
1015 _CUPS_API_1_6;
1016 extern int ippSetStatusCode(ipp_t *ipp, ipp_status_t status)
1017 _CUPS_API_1_6;
1018 extern int ippSetString(ipp_t *ipp, ipp_attribute_t **attr,
1019 int element, const char *strvalue)
1020 _CUPS_API_1_6;
1021 extern int ippSetValueTag(ipp_t *ipp, ipp_attribute_t **attr,
1022 ipp_tag_t value_tag) _CUPS_API_1_6;
1023 extern int ippSetVersion(ipp_t *ipp, int major, int minor)
1024 _CUPS_API_1_6;
1025
1026 /**** New in CUPS 1.7 ****/
1027 extern ipp_attribute_t *ippAddStringf(ipp_t *ipp, ipp_tag_t group,
1028 ipp_tag_t value_tag, const char *name,
1029 const char *language, const char *format,
1030 ...) _CUPS_API_1_7;
1031 extern ipp_attribute_t *ippAddStringfv(ipp_t *ipp, ipp_tag_t group,
1032 ipp_tag_t value_tag, const char *name,
1033 const char *language,
1034 const char *format, va_list ap)
1035 _CUPS_API_1_7;
1036 extern int ippContainsInteger(ipp_attribute_t *attr, int value)
1037 _CUPS_API_1_7;
1038 extern int ippContainsString(ipp_attribute_t *attr,
1039 const char *value) _CUPS_API_1_7;
1040 extern cups_array_t *ippCreateRequestedArray(ipp_t *request) _CUPS_API_1_7;
1041 extern void *ippGetOctetString(ipp_attribute_t *attr, int element,
1042 int *datalen) _CUPS_API_1_7;
1043 extern ipp_t *ippNewResponse(ipp_t *request) _CUPS_API_1_7;
1044 extern int ippSetOctetString(ipp_t *ipp, ipp_attribute_t **attr,
1045 int element, const void *data,
1046 int datalen) _CUPS_API_1_7;
1047 extern int ippSetStringf(ipp_t *ipp, ipp_attribute_t **attr,
1048 int element, const char *format,
1049 ...) _CUPS_API_1_7;
1050 extern int ippSetStringfv(ipp_t *ipp, ipp_attribute_t **attr,
1051 int element, const char *format,
1052 va_list ap) _CUPS_API_1_7;
1053 extern int ippValidateAttribute(ipp_attribute_t *attr)
1054 _CUPS_API_1_7;
1055 extern int ippValidateAttributes(ipp_t *ipp) _CUPS_API_1_7;
1056
1057
1058 /**** New in CUPS 2.0 ****/
1059 extern const char *ippStateString(ipp_state_t state) _CUPS_API_2_0;
1060
1061
1062 /*
1063 * C++ magic...
1064 */
1065
1066 # ifdef __cplusplus
1067 }
1068 # endif /* __cplusplus */
1069 #endif /* !_CUPS_IPP_H_ */
Unnamed repository; edit this file 'description' to name the repository.