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