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