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