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