]> git.ipfire.org Git - thirdparty/cups.git/blob - cups/ppd.h
Use IPP printer-state-reasons localizations instead of the old English strings.
[thirdparty/cups.git] / cups / ppd.h
1 /*
2 * PostScript Printer Description definitions for CUPS.
3 *
4 * THESE APIS ARE DEPRECATED. TO COMPILE WITHOUT WARNINGS ADD
5 * -D_PPD_DEPRECATED="" TO YOUR COMPILE OPTIONS. THIS HEADER AND THESE
6 * FUNCTIONS WILL BE REMOVED IN A FUTURE RELEASE OF CUPS.
7 *
8 * Copyright 2007-2015 by Apple Inc.
9 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
10 *
11 * Licensed under Apache License v2.0. See the file "LICENSE" for more
12 * information.
13 *
14 * PostScript is a trademark of Adobe Systems, Inc.
15 */
16
17 #ifndef _CUPS_PPD_H_
18 # define _CUPS_PPD_H_
19
20 /*
21 * Include necessary headers...
22 */
23
24 # include <stdio.h>
25 # include "cups.h"
26 # include "array.h"
27 # include "file.h"
28 # include "raster.h"
29
30
31 /*
32 * C++ magic...
33 */
34
35 # ifdef __cplusplus
36 extern "C" {
37 # endif /* __cplusplus */
38
39
40 /*
41 * Define _PPD_DEPRECATED to silence the warnings about PPD functions being
42 * deprecated...
43 */
44
45 # ifndef _PPD_DEPRECATED
46 # define _PPD_DEPRECATED _CUPS_DEPRECATED_1_6_MSG("Use cupsCopyDestInfo and friends instead.")
47 # endif /* !_PPD_DEPRECATED */
48
49
50 /*
51 * PPD version...
52 */
53
54 # define PPD_VERSION 4.3 /* Kept in sync with Adobe version number */
55
56
57 /*
58 * PPD size limits (defined in Adobe spec)
59 */
60
61 # define PPD_MAX_NAME 41 /* Maximum size of name + 1 for nul */
62 # define PPD_MAX_TEXT 81 /* Maximum size of text + 1 for nul */
63 # define PPD_MAX_LINE 256 /* Maximum size of line + 1 for nul */
64
65
66 /*
67 * Types and structures...
68 */
69
70 typedef enum ppd_ui_e /**** UI Types ****/
71 {
72 PPD_UI_BOOLEAN, /* True or False option */
73 PPD_UI_PICKONE, /* Pick one from a list */
74 PPD_UI_PICKMANY /* Pick zero or more from a list */
75 } ppd_ui_t;
76
77 typedef enum ppd_section_e /**** Order dependency sections ****/
78 {
79 PPD_ORDER_ANY, /* Option code can be anywhere in the file */
80 PPD_ORDER_DOCUMENT, /* ... must be in the DocumentSetup section */
81 PPD_ORDER_EXIT, /* ... must be sent prior to the document */
82 PPD_ORDER_JCL, /* ... must be sent as a JCL command */
83 PPD_ORDER_PAGE, /* ... must be in the PageSetup section */
84 PPD_ORDER_PROLOG /* ... must be in the Prolog section */
85 } ppd_section_t;
86
87 typedef enum ppd_cs_e /**** Colorspaces ****/
88 {
89 PPD_CS_CMYK = -4, /* CMYK colorspace */
90 PPD_CS_CMY, /* CMY colorspace */
91 PPD_CS_GRAY = 1, /* Grayscale colorspace */
92 PPD_CS_RGB = 3, /* RGB colorspace */
93 PPD_CS_RGBK, /* RGBK (K = gray) colorspace */
94 PPD_CS_N /* DeviceN colorspace */
95 } ppd_cs_t;
96
97 typedef enum ppd_status_e /**** Status Codes @since CUPS 1.1.19/macOS 10.3@ ****/
98 {
99 PPD_OK = 0, /* OK */
100 PPD_FILE_OPEN_ERROR, /* Unable to open PPD file */
101 PPD_NULL_FILE, /* NULL PPD file pointer */
102 PPD_ALLOC_ERROR, /* Memory allocation error */
103 PPD_MISSING_PPDADOBE4, /* Missing PPD-Adobe-4.x header */
104 PPD_MISSING_VALUE, /* Missing value string */
105 PPD_INTERNAL_ERROR, /* Internal error */
106 PPD_BAD_OPEN_GROUP, /* Bad OpenGroup */
107 PPD_NESTED_OPEN_GROUP, /* OpenGroup without a CloseGroup first */
108 PPD_BAD_OPEN_UI, /* Bad OpenUI/JCLOpenUI */
109 PPD_NESTED_OPEN_UI, /* OpenUI/JCLOpenUI without a CloseUI/JCLCloseUI first */
110 PPD_BAD_ORDER_DEPENDENCY, /* Bad OrderDependency */
111 PPD_BAD_UI_CONSTRAINTS, /* Bad UIConstraints */
112 PPD_MISSING_ASTERISK, /* Missing asterisk in column 0 */
113 PPD_LINE_TOO_LONG, /* Line longer than 255 chars */
114 PPD_ILLEGAL_CHARACTER, /* Illegal control character */
115 PPD_ILLEGAL_MAIN_KEYWORD, /* Illegal main keyword string */
116 PPD_ILLEGAL_OPTION_KEYWORD, /* Illegal option keyword string */
117 PPD_ILLEGAL_TRANSLATION, /* Illegal translation string */
118 PPD_ILLEGAL_WHITESPACE, /* Illegal whitespace character */
119 PPD_BAD_CUSTOM_PARAM, /* Bad custom parameter */
120 PPD_MISSING_OPTION_KEYWORD, /* Missing option keyword */
121 PPD_BAD_VALUE, /* Bad value string */
122 PPD_MISSING_CLOSE_GROUP, /* Missing CloseGroup */
123 PPD_MAX_STATUS /* @private@ */
124 } ppd_status_t;
125
126 enum ppd_conform_e /**** Conformance Levels @since CUPS 1.1.19/macOS 10.3@ ****/
127 {
128 PPD_CONFORM_RELAXED, /* Relax whitespace and control char */
129 PPD_CONFORM_STRICT /* Require strict conformance */
130 };
131
132 typedef enum ppd_conform_e ppd_conform_t;
133 /**** Conformance Levels @since CUPS 1.1.19/macOS 10.3@ ****/
134
135 typedef struct ppd_attr_s /**** PPD Attribute Structure @since CUPS 1.1.19/macOS 10.3@ ****/
136 {
137 char name[PPD_MAX_NAME]; /* Name of attribute (cupsXYZ) */
138 char spec[PPD_MAX_NAME]; /* Specifier string, if any */
139 char text[PPD_MAX_TEXT]; /* Human-readable text, if any */
140 char *value; /* Value string */
141 } ppd_attr_t;
142
143 typedef struct ppd_option_s ppd_option_t;
144 /**** Options ****/
145
146 typedef struct ppd_choice_s /**** Option choices ****/
147 {
148 char marked; /* 0 if not selected, 1 otherwise */
149 char choice[PPD_MAX_NAME]; /* Computer-readable option name */
150 char text[PPD_MAX_TEXT]; /* Human-readable option name */
151 char *code; /* Code to send for this option */
152 ppd_option_t *option; /* Pointer to parent option structure */
153 } ppd_choice_t;
154
155 struct ppd_option_s /**** Options ****/
156 {
157 char conflicted; /* 0 if no conflicts exist, 1 otherwise */
158 char keyword[PPD_MAX_NAME]; /* Option keyword name ("PageSize", etc.) */
159 char defchoice[PPD_MAX_NAME];/* Default option choice */
160 char text[PPD_MAX_TEXT]; /* Human-readable text */
161 ppd_ui_t ui; /* Type of UI option */
162 ppd_section_t section; /* Section for command */
163 float order; /* Order number */
164 int num_choices; /* Number of option choices */
165 ppd_choice_t *choices; /* Option choices */
166 };
167
168 typedef struct ppd_group_s /**** Groups ****/
169 {
170 /**** Group text strings are limited to 39 chars + nul in order to
171 **** preserve binary compatibility and allow applications to get
172 **** the group's keyword name.
173 ****/
174 char text[PPD_MAX_TEXT - PPD_MAX_NAME];
175 /* Human-readable group name */
176 char name[PPD_MAX_NAME]; /* Group name @since CUPS 1.1.18/macOS 10.3@ */
177 int num_options; /* Number of options */
178 ppd_option_t *options; /* Options */
179 int num_subgroups; /* Number of sub-groups */
180 struct ppd_group_s *subgroups; /* Sub-groups (max depth = 1) */
181 } ppd_group_t;
182
183 typedef struct ppd_const_s /**** Constraints ****/
184 {
185 char option1[PPD_MAX_NAME]; /* First keyword */
186 char choice1[PPD_MAX_NAME]; /* First option/choice (blank for all) */
187 char option2[PPD_MAX_NAME]; /* Second keyword */
188 char choice2[PPD_MAX_NAME]; /* Second option/choice (blank for all) */
189 } ppd_const_t;
190
191 typedef struct ppd_size_s /**** Page Sizes ****/
192 {
193 int marked; /* Page size selected? */
194 char name[PPD_MAX_NAME]; /* Media size option */
195 float width; /* Width of media in points */
196 float length; /* Length of media in points */
197 float left; /* Left printable margin in points */
198 float bottom; /* Bottom printable margin in points */
199 float right; /* Right printable margin in points */
200 float top; /* Top printable margin in points */
201 } ppd_size_t;
202
203 typedef struct ppd_emul_s /**** Emulators ****/
204 {
205 char name[PPD_MAX_NAME]; /* Emulator name */
206 char *start; /* Code to switch to this emulation */
207 char *stop; /* Code to stop this emulation */
208 } ppd_emul_t;
209
210 typedef struct ppd_profile_s /**** sRGB Color Profiles ****/
211 {
212 char resolution[PPD_MAX_NAME];
213 /* Resolution or "-" */
214 char media_type[PPD_MAX_NAME];
215 /* Media type or "-" */
216 float density; /* Ink density to use */
217 float gamma; /* Gamma correction to use */
218 float matrix[3][3]; /* Transform matrix */
219 } ppd_profile_t;
220
221 /**** New in CUPS 1.2/macOS 10.5 ****/
222 typedef enum ppd_cptype_e /**** Custom Parameter Type @since CUPS 1.2/macOS 10.5@ ****/
223 {
224 PPD_CUSTOM_CURVE, /* Curve value for f(x) = x^value */
225 PPD_CUSTOM_INT, /* Integer number value */
226 PPD_CUSTOM_INVCURVE, /* Curve value for f(x) = x^(1/value) */
227 PPD_CUSTOM_PASSCODE, /* String of (hidden) numbers */
228 PPD_CUSTOM_PASSWORD, /* String of (hidden) characters */
229 PPD_CUSTOM_POINTS, /* Measurement value in points */
230 PPD_CUSTOM_REAL, /* Real number value */
231 PPD_CUSTOM_STRING /* String of characters */
232 } ppd_cptype_t;
233
234 typedef union ppd_cplimit_u /**** Custom Parameter Limit @since CUPS 1.2/macOS 10.5@ ****/
235 {
236 float custom_curve; /* Gamma value */
237 int custom_int; /* Integer value */
238 float custom_invcurve; /* Gamma value */
239 int custom_passcode; /* Passcode length */
240 int custom_password; /* Password length */
241 float custom_points; /* Measurement value */
242 float custom_real; /* Real value */
243 int custom_string; /* String length */
244 } ppd_cplimit_t;
245
246 typedef union ppd_cpvalue_u /**** Custom Parameter Value @since CUPS 1.2/macOS 10.5@ ****/
247 {
248 float custom_curve; /* Gamma value */
249 int custom_int; /* Integer value */
250 float custom_invcurve; /* Gamma value */
251 char *custom_passcode; /* Passcode value */
252 char *custom_password; /* Password value */
253 float custom_points; /* Measurement value */
254 float custom_real; /* Real value */
255 char *custom_string; /* String value */
256 } ppd_cpvalue_t;
257
258 typedef struct ppd_cparam_s /**** Custom Parameter @since CUPS 1.2/macOS 10.5@ ****/
259 {
260 char name[PPD_MAX_NAME]; /* Parameter name */
261 char text[PPD_MAX_TEXT]; /* Human-readable text */
262 int order; /* Order (0 to N) */
263 ppd_cptype_t type; /* Parameter type */
264 ppd_cplimit_t minimum, /* Minimum value */
265 maximum; /* Maximum value */
266 ppd_cpvalue_t current; /* Current value */
267 } ppd_cparam_t;
268
269 typedef struct ppd_coption_s /**** Custom Option @since CUPS 1.2/macOS 10.5@ ****/
270 {
271 char keyword[PPD_MAX_NAME]; /* Name of option that is being extended... */
272 ppd_option_t *option; /* Option that is being extended... */
273 int marked; /* Extended option is marked */
274 cups_array_t *params; /* Parameters */
275 } ppd_coption_t;
276
277 typedef struct _ppd_cache_s _ppd_cache_t;
278 /**** PPD cache and mapping data @since CUPS 1.5/macOS 10.7@ @private@ ****/
279
280 typedef struct ppd_file_s /**** PPD File ****/
281 {
282 int language_level; /* Language level of device */
283 int color_device; /* 1 = color device, 0 = grayscale */
284 int variable_sizes; /* 1 = supports variable sizes, 0 = doesn't */
285 int accurate_screens; /* 1 = supports accurate screens, 0 = not */
286 int contone_only; /* 1 = continuous tone only, 0 = not */
287 int landscape; /* -90 or 90 */
288 int model_number; /* Device-specific model number */
289 int manual_copies; /* 1 = Copies done manually, 0 = hardware */
290 int throughput; /* Pages per minute */
291 ppd_cs_t colorspace; /* Default colorspace */
292 char *patches; /* Patch commands to be sent to printer */
293 int num_emulations; /* Number of emulations supported */
294 ppd_emul_t *emulations; /* Emulations and the code to invoke them */
295 char *jcl_begin; /* Start JCL commands */
296 char *jcl_ps; /* Enter PostScript interpreter */
297 char *jcl_end; /* End JCL commands */
298 char *lang_encoding; /* Language encoding */
299 char *lang_version; /* Language version (English, Spanish, etc.) */
300 char *modelname; /* Model name (general) */
301 char *ttrasterizer; /* Truetype rasterizer */
302 char *manufacturer; /* Manufacturer name */
303 char *product; /* Product name (from PS RIP/interpreter) */
304 char *nickname; /* Nickname (specific) */
305 char *shortnickname; /* Short version of nickname */
306 int num_groups; /* Number of UI groups */
307 ppd_group_t *groups; /* UI groups */
308 int num_sizes; /* Number of page sizes */
309 ppd_size_t *sizes; /* Page sizes */
310 float custom_min[2]; /* Minimum variable page size */
311 float custom_max[2]; /* Maximum variable page size */
312 float custom_margins[4]; /* Margins around page */
313 int num_consts; /* Number of UI/Non-UI constraints */
314 ppd_const_t *consts; /* UI/Non-UI constraints */
315 int num_fonts; /* Number of pre-loaded fonts */
316 char **fonts; /* Pre-loaded fonts */
317 int num_profiles; /* Number of sRGB color profiles @deprecated@ */
318 ppd_profile_t *profiles; /* sRGB color profiles @deprecated@ */
319 int num_filters; /* Number of filters */
320 char **filters; /* Filter strings... */
321
322 /**** New in CUPS 1.1 ****/
323 int flip_duplex; /* 1 = Flip page for back sides @deprecated@ */
324
325 /**** New in CUPS 1.1.19 ****/
326 char *protocols; /* Protocols (BCP, TBCP) string @since CUPS 1.1.19/macOS 10.3@ */
327 char *pcfilename; /* PCFileName string @since CUPS 1.1.19/macOS 10.3@ */
328 int num_attrs; /* Number of attributes @since CUPS 1.1.19/macOS 10.3@ @private@ */
329 int cur_attr; /* Current attribute @since CUPS 1.1.19/macOS 10.3@ @private@ */
330 ppd_attr_t **attrs; /* Attributes @since CUPS 1.1.19/macOS 10.3@ @private@ */
331
332 /**** New in CUPS 1.2/macOS 10.5 ****/
333 cups_array_t *sorted_attrs; /* Attribute lookup array @since CUPS 1.2/macOS 10.5@ @private@ */
334 cups_array_t *options; /* Option lookup array @since CUPS 1.2/macOS 10.5@ @private@ */
335 cups_array_t *coptions; /* Custom options array @since CUPS 1.2/macOS 10.5@ @private@ */
336
337 /**** New in CUPS 1.3/macOS 10.5 ****/
338 cups_array_t *marked; /* Marked choices @since CUPS 1.3/macOS 10.5@ @private@ */
339
340 /**** New in CUPS 1.4/macOS 10.6 ****/
341 cups_array_t *cups_uiconstraints; /* cupsUIConstraints @since CUPS 1.4/macOS 10.6@ @private@ */
342
343 /**** New in CUPS 1.5 ****/
344 _ppd_cache_t *cache; /* PPD cache and mapping data @since CUPS 1.5/macOS 10.7@ @private@ */
345 } ppd_file_t;
346
347
348 /*
349 * Prototypes...
350 */
351
352 extern const char *cupsGetPPD(const char *name) _PPD_DEPRECATED;
353 extern const char *cupsGetPPD2(http_t *http, const char *name) _PPD_DEPRECATED;
354 extern http_status_t cupsGetPPD3(http_t *http, const char *name, time_t *modtime, char *buffer, size_t bufsize) _PPD_DEPRECATED;
355 extern char *cupsGetServerPPD(http_t *http, const char *name) _PPD_DEPRECATED;
356 extern int cupsMarkOptions(ppd_file_t *ppd, int num_options, cups_option_t *options) _PPD_DEPRECATED;
357
358 extern void ppdClose(ppd_file_t *ppd) _PPD_DEPRECATED;
359 extern int ppdCollect(ppd_file_t *ppd, ppd_section_t section,
360 ppd_choice_t ***choices) _PPD_DEPRECATED;
361 extern int ppdConflicts(ppd_file_t *ppd) _PPD_DEPRECATED;
362 extern int ppdEmit(ppd_file_t *ppd, FILE *fp,
363 ppd_section_t section) _PPD_DEPRECATED;
364 extern int ppdEmitFd(ppd_file_t *ppd, int fd,
365 ppd_section_t section) _PPD_DEPRECATED;
366 extern int ppdEmitJCL(ppd_file_t *ppd, FILE *fp, int job_id,
367 const char *user, const char *title)
368 _PPD_DEPRECATED;
369 extern ppd_choice_t *ppdFindChoice(ppd_option_t *o, const char *option)
370 _PPD_DEPRECATED;
371 extern ppd_choice_t *ppdFindMarkedChoice(ppd_file_t *ppd,
372 const char *keyword)
373 _PPD_DEPRECATED;
374 extern ppd_option_t *ppdFindOption(ppd_file_t *ppd, const char *keyword)
375 _PPD_DEPRECATED;
376 extern int ppdIsMarked(ppd_file_t *ppd, const char *keyword,
377 const char *option) _PPD_DEPRECATED;
378 extern void ppdMarkDefaults(ppd_file_t *ppd) _PPD_DEPRECATED;
379 extern int ppdMarkOption(ppd_file_t *ppd, const char *keyword,
380 const char *option) _PPD_DEPRECATED;
381 extern ppd_file_t *ppdOpen(FILE *fp) _PPD_DEPRECATED;
382 extern ppd_file_t *ppdOpenFd(int fd) _PPD_DEPRECATED;
383 extern ppd_file_t *ppdOpenFile(const char *filename) _PPD_DEPRECATED;
384 extern float ppdPageLength(ppd_file_t *ppd, const char *name)
385 _PPD_DEPRECATED;
386 extern ppd_size_t *ppdPageSize(ppd_file_t *ppd, const char *name)
387 _PPD_DEPRECATED;
388 extern float ppdPageWidth(ppd_file_t *ppd, const char *name)
389 _PPD_DEPRECATED;
390
391 /**** New in CUPS 1.1.19 ****/
392 extern const char *ppdErrorString(ppd_status_t status) _PPD_DEPRECATED;
393 extern ppd_attr_t *ppdFindAttr(ppd_file_t *ppd, const char *name,
394 const char *spec) _PPD_DEPRECATED;
395 extern ppd_attr_t *ppdFindNextAttr(ppd_file_t *ppd, const char *name,
396 const char *spec) _PPD_DEPRECATED;
397 extern ppd_status_t ppdLastError(int *line) _PPD_DEPRECATED;
398
399 /**** New in CUPS 1.1.20 ****/
400 extern void ppdSetConformance(ppd_conform_t c) _PPD_DEPRECATED;
401
402 /**** New in CUPS 1.2 ****/
403 extern int cupsRasterInterpretPPD(cups_page_header2_t *h,
404 ppd_file_t *ppd,
405 int num_options,
406 cups_option_t *options,
407 cups_interpret_cb_t func) _PPD_DEPRECATED;
408 extern int ppdCollect2(ppd_file_t *ppd, ppd_section_t section,
409 float min_order, ppd_choice_t ***choices)
410 _PPD_DEPRECATED;
411 extern int ppdEmitAfterOrder(ppd_file_t *ppd, FILE *fp,
412 ppd_section_t section, int limit,
413 float min_order) _PPD_DEPRECATED;
414 extern int ppdEmitJCLEnd(ppd_file_t *ppd, FILE *fp)
415 _PPD_DEPRECATED;
416 extern char *ppdEmitString(ppd_file_t *ppd, ppd_section_t section,
417 float min_order) _PPD_DEPRECATED;
418 extern ppd_coption_t *ppdFindCustomOption(ppd_file_t *ppd,
419 const char *keyword)
420 _PPD_DEPRECATED;
421 extern ppd_cparam_t *ppdFindCustomParam(ppd_coption_t *opt,
422 const char *name) _PPD_DEPRECATED;
423 extern ppd_cparam_t *ppdFirstCustomParam(ppd_coption_t *opt)
424 _PPD_DEPRECATED;
425 extern ppd_option_t *ppdFirstOption(ppd_file_t *ppd) _PPD_DEPRECATED;
426 extern ppd_cparam_t *ppdNextCustomParam(ppd_coption_t *opt) _PPD_DEPRECATED;
427 extern ppd_option_t *ppdNextOption(ppd_file_t *ppd) _PPD_DEPRECATED;
428 extern int ppdLocalize(ppd_file_t *ppd) _PPD_DEPRECATED;
429 extern ppd_file_t *ppdOpen2(cups_file_t *fp) _PPD_DEPRECATED;
430
431 /**** New in CUPS 1.3/macOS 10.5 ****/
432 extern const char *ppdLocalizeIPPReason(ppd_file_t *ppd,
433 const char *reason,
434 const char *scheme,
435 char *buffer,
436 size_t bufsize) _PPD_DEPRECATED;
437
438 /**** New in CUPS 1.4/macOS 10.6 ****/
439 extern int cupsGetConflicts(ppd_file_t *ppd, const char *option,
440 const char *choice,
441 cups_option_t **options)
442 _PPD_DEPRECATED;
443 extern int cupsResolveConflicts(ppd_file_t *ppd,
444 const char *option,
445 const char *choice,
446 int *num_options,
447 cups_option_t **options)
448 _PPD_DEPRECATED;
449 extern int ppdInstallableConflict(ppd_file_t *ppd,
450 const char *option,
451 const char *choice)
452 _PPD_DEPRECATED;
453 extern ppd_attr_t *ppdLocalizeAttr(ppd_file_t *ppd, const char *keyword,
454 const char *spec) _PPD_DEPRECATED;
455 extern const char *ppdLocalizeMarkerName(ppd_file_t *ppd,
456 const char *name)
457 _PPD_DEPRECATED;
458 extern int ppdPageSizeLimits(ppd_file_t *ppd,
459 ppd_size_t *minimum,
460 ppd_size_t *maximum) _PPD_DEPRECATED;
461
462
463 /*
464 * C++ magic...
465 */
466
467 # ifdef __cplusplus
468 }
469 # endif /* __cplusplus */
470 #endif /* !_CUPS_PPD_H_ */