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