Personal Computer World 2009 February

home *** CD-ROM | disk | FTP | other *** search

/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / SLAX 6.0.8 / slax-6.0.8.iso / slax / base / 006-devel.lzm / usr / include / cups / ppd.h < prev next >

Wrap

C/C++ Source or Header | 2008-10-21 | 15.4 KB | 410 lines

/* * "$Id: ppd.h 7721 2008-07-11 22:48:49Z mike $" * * PostScript Printer Description definitions for the Common UNIX Printing * System (CUPS). * * Copyright 2007 by Apple Inc. * Copyright 1997-2007 by Easy Software Products, all rights reserved. * * These coded instructions, statements, and computer programs are the * property of Apple Inc. and are protected by Federal copyright * law. Distribution and use rights are outlined in the file "LICENSE.txt" * which should have been included with this file. If this file is * file is missing or damaged, see the license at "http://www.cups.org/". * * PostScript is a trademark of Adobe Systems, Inc. * * This code and any derivative of it may be used and distributed * freely under the terms of the GNU General Public License when * used with GNU Ghostscript or its derivatives. Use of the code * (or any derivative of it) with software other than GNU * GhostScript (or its derivatives) is governed by the CUPS license * agreement. * * This file is subject to the Apple OS-Developed Software exception. */ #ifndef _CUPS_PPD_H_ # define _CUPS_PPD_H_ /* * Include necessary headers... */ # include <stdio.h> # include "array.h" # include "file.h" /* * C++ magic... */ # ifdef __cplusplus extern "C" { # endif /* __cplusplus */ /* * PPD version... */ # define PPD_VERSION 4.3 /* Kept in sync with Adobe version number */ /* * PPD size limits (defined in Adobe spec) */ # define PPD_MAX_NAME 41 /* Maximum size of name + 1 for nul */ # define PPD_MAX_TEXT 81 /* Maximum size of text + 1 for nul */ # define PPD_MAX_LINE 256 /* Maximum size of line + 1 for nul */ /* * Types and structures... */ typedef enum ppd_ui_e /**** UI Types ****/ { PPD_UI_BOOLEAN, /* True or False option */ PPD_UI_PICKONE, /* Pick one from a list */ PPD_UI_PICKMANY /* Pick zero or more from a list */ } ppd_ui_t; typedef enum ppd_section_e /**** Order dependency sections ****/ { PPD_ORDER_ANY, /* Option code can be anywhere in the file */ PPD_ORDER_DOCUMENT, /* ... must be in the DocumentSetup section */ PPD_ORDER_EXIT, /* ... must be sent prior to the document */ PPD_ORDER_JCL, /* ... must be sent as a JCL command */ PPD_ORDER_PAGE, /* ... must be in the PageSetup section */ PPD_ORDER_PROLOG /* ... must be in the Prolog section */ } ppd_section_t; typedef enum ppd_cs_e /**** Colorspaces ****/ { PPD_CS_CMYK = -4, /* CMYK colorspace */ PPD_CS_CMY, /* CMY colorspace */ PPD_CS_GRAY = 1, /* Grayscale colorspace */ PPD_CS_RGB = 3, /* RGB colorspace */ PPD_CS_RGBK, /* RGBK (K = gray) colorspace */ PPD_CS_N /* DeviceN colorspace */ } ppd_cs_t; typedef enum ppd_status_e /**** Status Codes @since CUPS 1.1.19@ ****/ { PPD_OK = 0, /* OK */ PPD_FILE_OPEN_ERROR, /* Unable to open PPD file */ PPD_NULL_FILE, /* NULL PPD file pointer */ PPD_ALLOC_ERROR, /* Memory allocation error */ PPD_MISSING_PPDADOBE4, /* Missing PPD-Adobe-4.x header */ PPD_MISSING_VALUE, /* Missing value string */ PPD_INTERNAL_ERROR, /* Internal error */ PPD_BAD_OPEN_GROUP, /* Bad OpenGroup */ PPD_NESTED_OPEN_GROUP, /* OpenGroup without a CloseGroup first */ PPD_BAD_OPEN_UI, /* Bad OpenUI/JCLOpenUI */ PPD_NESTED_OPEN_UI, /* OpenUI/JCLOpenUI without a CloseUI/JCLCloseUI first */ PPD_BAD_ORDER_DEPENDENCY, /* Bad OrderDependency */ PPD_BAD_UI_CONSTRAINTS, /* Bad UIConstraints */ PPD_MISSING_ASTERISK, /* Missing asterisk in column 0 */ PPD_LINE_TOO_LONG, /* Line longer than 255 chars */ PPD_ILLEGAL_CHARACTER, /* Illegal control character */ PPD_ILLEGAL_MAIN_KEYWORD, /* Illegal main keyword string */ PPD_ILLEGAL_OPTION_KEYWORD, /* Illegal option keyword string */ PPD_ILLEGAL_TRANSLATION, /* Illegal translation string */ PPD_ILLEGAL_WHITESPACE, /* Illegal whitespace character */ PPD_BAD_CUSTOM_PARAM /* Bad custom parameter */ } ppd_status_t; typedef enum ppd_conform_e /**** Conformance Levels @since CUPS 1.1.19@ ****/ { PPD_CONFORM_RELAXED, /* Relax whitespace and control char */ PPD_CONFORM_STRICT /* Require strict conformance */ } ppd_conform_t; typedef struct ppd_attr_s /**** PPD Attribute Structure @since CUPS 1.1.19@ ****/ { char name[PPD_MAX_NAME]; /* Name of attribute (cupsXYZ) */ char spec[PPD_MAX_NAME]; /* Specifier string, if any */ char text[PPD_MAX_TEXT]; /* Human-readable text, if any */ char *value; /* Value string */ } ppd_attr_t; typedef struct ppd_option_s ppd_option_t; /**** Options ****/ typedef struct ppd_choice_s /**** Option choices ****/ { char marked; /* 0 if not selected, 1 otherwise */ char choice[PPD_MAX_NAME]; /* Computer-readable option name */ char text[PPD_MAX_TEXT]; /* Human-readable option name */ char *code; /* Code to send for this option */ ppd_option_t *option; /* Pointer to parent option structure */ } ppd_choice_t; struct ppd_option_s /**** Options ****/ { char conflicted; /* 0 if no conflicts exist, 1 otherwise */ char keyword[PPD_MAX_NAME]; /* Option keyword name ("PageSize", etc.) */ char defchoice[PPD_MAX_NAME];/* Default option choice */ char text[PPD_MAX_TEXT]; /* Human-readable text */ ppd_ui_t ui; /* Type of UI option */ ppd_section_t section; /* Section for command */ float order; /* Order number */ int num_choices; /* Number of option choices */ ppd_choice_t *choices; /* Option choices */ }; typedef struct ppd_group_s /**** Groups ****/ { /**** Group text strings are limited to 39 chars + nul in order to **** preserve binary compatibility and allow applications to get **** the group's keyword name. ****/ char text[PPD_MAX_TEXT - PPD_MAX_NAME]; /* Human-readable group name */ char name[PPD_MAX_NAME]; /* Group name @since CUPS 1.1.18@ */ int num_options; /* Number of options */ ppd_option_t *options; /* Options */ int num_subgroups; /* Number of sub-groups */ struct ppd_group_s *subgroups; /* Sub-groups (max depth = 1) */ } ppd_group_t; typedef struct /**** Constraints ****/ { char option1[PPD_MAX_NAME]; /* First keyword */ char choice1[PPD_MAX_NAME]; /* First option/choice (blank for all) */ char option2[PPD_MAX_NAME]; /* Second keyword */ char choice2[PPD_MAX_NAME]; /* Second option/choice (blank for all) */ } ppd_const_t; typedef struct ppd_size_s /**** Page Sizes ****/ { int marked; /* Page size selected? */ char name[PPD_MAX_NAME]; /* Media size option */ float width; /* Width of media in points */ float length; /* Length of media in points */ float left; /* Left printable margin in points */ float bottom; /* Bottom printable margin in points */ float right; /* Right printable margin in points */ float top; /* Top printable margin in points */ } ppd_size_t; typedef struct ppd_emul_s /**** Emulators ****/ { char name[PPD_MAX_NAME]; /* Emulator name */ char *start; /* Code to switch to this emulation */ char *stop; /* Code to stop this emulation */ } ppd_emul_t; typedef struct ppd_profile_s /**** sRGB Color Profiles ****/ { char resolution[PPD_MAX_NAME]; /* Resolution or "-" */ char media_type[PPD_MAX_NAME]; /* Media type or "-" */ float density; /* Ink density to use */ float gamma; /* Gamma correction to use */ float matrix[3][3]; /* Transform matrix */ } ppd_profile_t; /**** New in CUPS 1.2 ****/ typedef enum ppd_cptype_e /**** Custom Parameter Type @since CUPS 1.2@ ****/ { PPD_CUSTOM_CURVE, /* Curve value for f(x) = x^value */ PPD_CUSTOM_INT, /* Integer number value */ PPD_CUSTOM_INVCURVE, /* Curve value for f(x) = x^(1/value) */ PPD_CUSTOM_PASSCODE, /* String of (hidden) numbers */ PPD_CUSTOM_PASSWORD, /* String of (hidden) characters */ PPD_CUSTOM_POINTS, /* Measurement value in points */ PPD_CUSTOM_REAL, /* Real number value */ PPD_CUSTOM_STRING /* String of characters */ } ppd_cptype_t; typedef union ppd_cplimit_u /**** Custom Parameter Limit @since CUPS 1.2@ ****/ { float custom_curve; /* Gamma value */ int custom_int; /* Integer value */ float custom_invcurve; /* Gamma value */ int custom_passcode; /* Passcode length */ int custom_password; /* Password length */ float custom_points; /* Measurement value */ float custom_real; /* Real value */ int custom_string; /* String length */ } ppd_cplimit_t; typedef union ppd_cpvalue_u /**** Custom Parameter Value @since CUPS 1.2@ ****/ { float custom_curve; /* Gamma value */ int custom_int; /* Integer value */ float custom_invcurve; /* Gamma value */ char *custom_passcode; /* Passcode value */ char *custom_password; /* Password value */ float custom_points; /* Measurement value */ float custom_real; /* Real value */ char *custom_string; /* String value */ } ppd_cpvalue_t; typedef struct ppd_cparam_s /**** Custom Parameter @since CUPS 1.2@ ****/ { char name[PPD_MAX_NAME]; /* Parameter name */ char text[PPD_MAX_TEXT]; /* Human-readable text */ int order; /* Order (0 to N) */ ppd_cptype_t type; /* Parameter type */ ppd_cplimit_t minimum, /* Minimum value */ maximum; /* Maximum value */ ppd_cpvalue_t current; /* Current value */ } ppd_cparam_t; typedef struct ppd_coption_s /**** Custom Option @since CUPS 1.2@ ****/ { char keyword[PPD_MAX_NAME]; /* Name of option that is being extended... */ ppd_option_t *option; /* Option that is being extended... */ int marked; /* Extended option is marked */ cups_array_t *params; /* Parameters */ } ppd_coption_t; typedef struct ppd_file_s /**** PPD File ****/ { int language_level; /* Language level of device */ int color_device; /* 1 = color device, 0 = grayscale */ int variable_sizes; /* 1 = supports variable sizes, 0 = doesn't */ int accurate_screens; /* 1 = supports accurate screens, 0 = not */ int contone_only; /* 1 = continuous tone only, 0 = not */ int landscape; /* -90 or 90 */ int model_number; /* Device-specific model number */ int manual_copies; /* 1 = Copies done manually, 0 = hardware */ int throughput; /* Pages per minute */ ppd_cs_t colorspace; /* Default colorspace */ char *patches; /* Patch commands to be sent to printer */ int num_emulations; /* Number of emulations supported */ ppd_emul_t *emulations; /* Emulations and the code to invoke them */ char *jcl_begin; /* Start JCL commands */ char *jcl_ps; /* Enter PostScript interpreter */ char *jcl_end; /* End JCL commands */ char *lang_encoding; /* Language encoding */ char *lang_version; /* Language version (English, Spanish, etc.) */ char *modelname; /* Model name (general) */ char *ttrasterizer; /* Truetype rasterizer */ char *manufacturer; /* Manufacturer name */ char *product; /* Product name (from PS RIP/interpreter) */ char *nickname; /* Nickname (specific) */ char *shortnickname; /* Short version of nickname */ int num_groups; /* Number of UI groups */ ppd_group_t *groups; /* UI groups */ int num_sizes; /* Number of page sizes */ ppd_size_t *sizes; /* Page sizes */ float custom_min[2]; /* Minimum variable page size */ float custom_max[2]; /* Maximum variable page size */ float custom_margins[4]; /* Margins around page */ int num_consts; /* Number of UI/Non-UI constraints */ ppd_const_t *consts; /* UI/Non-UI constraints */ int num_fonts; /* Number of pre-loaded fonts */ char **fonts; /* Pre-loaded fonts */ int num_profiles; /* Number of sRGB color profiles */ ppd_profile_t *profiles; /* sRGB color profiles */ int num_filters; /* Number of filters */ char **filters; /* Filter strings... */ /**** New in CUPS 1.1 ****/ int flip_duplex; /* 1 = Flip page for back sides @deprecated@ */ /**** New in CUPS 1.1.19 ****/ char *protocols; /* Protocols (BCP, TBCP) string @since CUPS 1.1.19@ */ char *pcfilename; /* PCFileName string @since CUPS 1.1.19@ */ int num_attrs; /* Number of attributes @since CUPS 1.1.19@ @private@ */ int cur_attr; /* Current attribute @since CUPS 1.1.19@ @private@ */ ppd_attr_t **attrs; /* Attributes @since CUPS 1.1.19@ @private@ */ /**** New in CUPS 1.2 ****/ cups_array_t *sorted_attrs; /* Attribute lookup array @since CUPS 1.2@ @private@ */ cups_array_t *options; /* Option lookup array @since CUPS 1.2@ @private@ */ cups_array_t *coptions; /* Custom options array @since CUPS 1.2@ @private@ */ /**** New in CUPS 1.3 ****/ cups_array_t *marked; /* Marked choices @since CUPS 1.3@ @private@ */ } ppd_file_t; /* * Prototypes... */ extern void ppdClose(ppd_file_t *ppd); extern int ppdCollect(ppd_file_t *ppd, ppd_section_t section, ppd_choice_t ***choices); extern int ppdConflicts(ppd_file_t *ppd); extern int ppdEmit(ppd_file_t *ppd, FILE *fp, ppd_section_t section); extern int ppdEmitFd(ppd_file_t *ppd, int fd, ppd_section_t section); extern int ppdEmitJCL(ppd_file_t *ppd, FILE *fp, int job_id, const char *user, const char *title); extern ppd_choice_t *ppdFindChoice(ppd_option_t *o, const char *option); extern ppd_choice_t *ppdFindMarkedChoice(ppd_file_t *ppd, const char *keyword); extern ppd_option_t *ppdFindOption(ppd_file_t *ppd, const char *keyword); extern int ppdIsMarked(ppd_file_t *ppd, const char *keyword, const char *option); extern void ppdMarkDefaults(ppd_file_t *ppd); extern int ppdMarkOption(ppd_file_t *ppd, const char *keyword, const char *option); extern ppd_file_t *ppdOpen(FILE *fp); extern ppd_file_t *ppdOpenFd(int fd); extern ppd_file_t *ppdOpenFile(const char *filename); extern float ppdPageLength(ppd_file_t *ppd, const char *name); extern ppd_size_t *ppdPageSize(ppd_file_t *ppd, const char *name); extern float ppdPageWidth(ppd_file_t *ppd, const char *name); /**** New in CUPS 1.1.19 ****/ extern const char *ppdErrorString(ppd_status_t status); extern ppd_attr_t *ppdFindAttr(ppd_file_t *ppd, const char *name, const char *spec); extern ppd_attr_t *ppdFindNextAttr(ppd_file_t *ppd, const char *name, const char *spec); extern ppd_status_t ppdLastError(int *line); /**** New in CUPS 1.1.20 ****/ extern void ppdSetConformance(ppd_conform_t c); /**** New in CUPS 1.2 ****/ extern int ppdCollect2(ppd_file_t *ppd, ppd_section_t section, float min_order, ppd_choice_t ***choices); extern int ppdEmitAfterOrder(ppd_file_t *ppd, FILE *fp, ppd_section_t section, int limit, float min_order); extern int ppdEmitJCLEnd(ppd_file_t *ppd, FILE *fp); extern char *ppdEmitString(ppd_file_t *ppd, ppd_section_t section, float min_order); extern ppd_coption_t *ppdFindCustomOption(ppd_file_t *ppd, const char *keyword); extern ppd_cparam_t *ppdFindCustomParam(ppd_coption_t *opt, const char *name); extern ppd_cparam_t *ppdFirstCustomParam(ppd_coption_t *opt); extern ppd_option_t *ppdFirstOption(ppd_file_t *ppd); extern ppd_cparam_t *ppdNextCustomParam(ppd_coption_t *opt); extern ppd_option_t *ppdNextOption(ppd_file_t *ppd); extern int ppdLocalize(ppd_file_t *ppd); extern ppd_file_t *ppdOpen2(cups_file_t *fp); /**** New in CUPS 1.3 ****/ extern const char *ppdLocalizeIPPReason(ppd_file_t *ppd, const char *reason, const char *scheme, char *buffer, size_t bufsize); /* * C++ magic... */ # ifdef __cplusplus } # endif /* __cplusplus */ #endif /* !_CUPS_PPD_H_ */ /* * End of "$Id: ppd.h 7721 2008-07-11 22:48:49Z mike $". */