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