cups/ppd.h

   1 /*
   2  * "$Id: ppd.h 7791 2008-07-24 00:55:30Z mike $"
   3  *
   4  *   PostScript Printer Description definitions for the Common UNIX Printing
   5  *   System (CUPS).
   6  *
   7  *   Copyright 2007-2008 by Apple Inc.
   8  *   Copyright 1997-2007 by Easy Software Products, all rights reserved.
   9  *
  10  *   These coded instructions, statements, and computer programs are the
  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/".
  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>
  36 #  include "array.h"
  37 #  include "file.h"
  38
  39
  40 /*
  41  * C++ magic...
  42  */
  43
  44 #  ifdef __cplusplus
  45 extern "C" {
  46 #  endif /* __cplusplus */
  47
  48
  49 /*
  50  * PPD version...
  51  */
  52
  53 #  define PPD_VERSION   4.3             /* Kept in sync with Adobe version number */
  54
  55
  56 /*
  57  * PPD size limits (defined in Adobe spec)
  58  */
  59
  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 */
  63
  64
  65 /*
  66  * Types and structures...
  67  */
  68
  69 typedef enum ppd_ui_e                   /**** UI Types ****/
  70 {
  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 */
  74 } ppd_ui_t;
  75
  76 typedef enum ppd_section_e              /**** Order dependency sections ****/
  77 {
  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 */
  84 } ppd_section_t;
  85
  86 typedef enum ppd_cs_e                   /**** Colorspaces ****/
  87 {
  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 */
  94 } ppd_cs_t;
  95
  96 typedef enum ppd_status_e               /**** Status Codes @since CUPS 1.1.19/Mac OS X 10.3@ ****/
  97 {
  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 */
 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@ */
 122 } ppd_status_t;
 123
 124 enum ppd_conform_e                      /**** Conformance Levels @since CUPS 1.1.19/Mac OS X 10.3@ ****/
 125 {
 126   PPD_CONFORM_RELAXED,                  /* Relax whitespace and control char */
 127   PPD_CONFORM_STRICT                    /* Require strict conformance */
 128 };
 129
 130 typedef enum ppd_conform_e ppd_conform_t;
 131                                         /**** Conformance Levels @since CUPS 1.1.19/Mac OS X 10.3@ ****/
 132
 133 typedef struct ppd_attr_s               /**** PPD Attribute Structure @since CUPS 1.1.19/Mac OS X 10.3@ ****/
 134 {
 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 */
 139 } ppd_attr_t;
 140
 141 typedef struct ppd_option_s ppd_option_t;
 142                                         /**** Options ****/
 143
 144 typedef struct ppd_choice_s             /**** Option choices ****/
 145 {
 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 */
 151 } ppd_choice_t;
 152
 153 struct ppd_option_s                     /**** Options ****/
 154 {
 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 */
 164 };
 165
 166 typedef struct ppd_group_s              /**** Groups ****/
 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];
 173                                         /* Human-readable group name */
 174   char          name[PPD_MAX_NAME];     /* Group name @since CUPS 1.1.18/Mac OS X 10.3@ */
 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) */
 179 } ppd_group_t;
 180
 181 typedef struct ppd_const_s              /**** Constraints ****/
 182 {
 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) */
 187 } ppd_const_t;
 188
 189 typedef struct ppd_size_s               /**** Page Sizes ****/
 190 {
 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 */
 199 } ppd_size_t;
 200
 201 typedef struct ppd_emul_s               /**** Emulators ****/
 202 {
 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 */
 206 } ppd_emul_t;
 207
 208 typedef struct ppd_profile_s            /**** sRGB Color Profiles ****/
 209 {
 210   char          resolution[PPD_MAX_NAME];
 211                                         /* Resolution or "-" */
 212   char          media_type[PPD_MAX_NAME];
 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 */
 217 } ppd_profile_t;
 218
 219 /**** New in CUPS 1.2/Mac OS X 10.5 ****/
 220 typedef enum ppd_cptype_e               /**** Custom Parameter Type @since CUPS 1.2/Mac OS X 10.5@ ****/
 221 {
 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
 232 typedef union ppd_cplimit_u             /**** Custom Parameter Limit @since CUPS 1.2/Mac OS X 10.5@ ****/
 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
 244 typedef union ppd_cpvalue_u             /**** Custom Parameter Value @since CUPS 1.2/Mac OS X 10.5@ ****/
 245 {
 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
 256 typedef struct ppd_cparam_s             /**** Custom Parameter @since CUPS 1.2/Mac OS X 10.5@ ****/
 257 {
 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 */
 262   ppd_cplimit_t minimum,                /* Minimum value */
 263                 maximum;                /* Maximum value */
 264   ppd_cpvalue_t current;                /* Current value */
 265 } ppd_cparam_t;
 266
 267 typedef struct ppd_coption_s            /**** Custom Option @since CUPS 1.2/Mac OS X 10.5@ ****/
 268 {
 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
 275 typedef struct ppd_file_s               /**** PPD File ****/
 276 {
 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 */
 312   int           num_profiles;           /* Number of sRGB color profiles @deprecated@ */
 313   ppd_profile_t *profiles;              /* sRGB color profiles @deprecated@ */
 314   int           num_filters;            /* Number of filters */
 315   char          **filters;              /* Filter strings... */
 316
 317   /**** New in CUPS 1.1 ****/
 318   int           flip_duplex;            /* 1 = Flip page for back sides @deprecated@ */
 319
 320   /**** New in CUPS 1.1.19 ****/
 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@ */
 326
 327   /**** New in CUPS 1.2/Mac OS X 10.5 ****/
 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@ */
 331
 332   /**** New in CUPS 1.3/Mac OS X 10.5 ****/
 333   cups_array_t  *marked;                /* Marked choices @since CUPS 1.3/Mac OS X 10.5@ @private@ */
 334
 335   /**** New in CUPS 1.4/Mac OS X 10.6 ****/
 336   cups_array_t  *cups_uiconstraints;    /* cupsUIConstraints @since CUPS 1.4/Mac OS X 10.6@ @private@ */
 337 } ppd_file_t;
 338
 339
 340 /*
 341  * Prototypes...
 342  */
 343
 344 extern void             ppdClose(ppd_file_t *ppd);
 345 extern int              ppdCollect(ppd_file_t *ppd, ppd_section_t section,
 346                                    ppd_choice_t  ***choices);
 347 extern int              ppdConflicts(ppd_file_t *ppd);
 348 extern int              ppdEmit(ppd_file_t *ppd, FILE *fp,
 349                                 ppd_section_t section);
 350 extern int              ppdEmitFd(ppd_file_t *ppd, int fd,
 351                                   ppd_section_t section);
 352 extern int              ppdEmitJCL(ppd_file_t *ppd, FILE *fp, int job_id,
 353                                    const char *user, const char *title);
 354 extern ppd_choice_t     *ppdFindChoice(ppd_option_t *o, const char *option);
 355 extern ppd_choice_t     *ppdFindMarkedChoice(ppd_file_t *ppd, const char *keyword);
 356 extern ppd_option_t     *ppdFindOption(ppd_file_t *ppd, const char *keyword);
 357 extern int              ppdIsMarked(ppd_file_t *ppd, const char *keyword,
 358                                     const char *option);
 359 extern void             ppdMarkDefaults(ppd_file_t *ppd);
 360 extern int              ppdMarkOption(ppd_file_t *ppd, const char *keyword,
 361                                       const char *option);
 362 extern ppd_file_t       *ppdOpen(FILE *fp);
 363 extern ppd_file_t       *ppdOpenFd(int fd);
 364 extern ppd_file_t       *ppdOpenFile(const char *filename);
 365 extern float            ppdPageLength(ppd_file_t *ppd, const char *name);
 366 extern ppd_size_t       *ppdPageSize(ppd_file_t *ppd, const char *name);
 367 extern float            ppdPageWidth(ppd_file_t *ppd, const char *name);
 368
 369 /**** New in CUPS 1.1.19 ****/
 370 extern const char       *ppdErrorString(ppd_status_t status) _CUPS_API_1_1_19;
 371 extern ppd_attr_t       *ppdFindAttr(ppd_file_t *ppd, const char *name,
 372                                      const char *spec) _CUPS_API_1_1_19;
 373 extern ppd_attr_t       *ppdFindNextAttr(ppd_file_t *ppd, const char *name,
 374                                          const char *spec) _CUPS_API_1_1_19;
 375 extern ppd_status_t     ppdLastError(int *line) _CUPS_API_1_1_19;
 376
 377 /**** New in CUPS 1.1.20 ****/
 378 extern void             ppdSetConformance(ppd_conform_t c) _CUPS_API_1_1_20;
 379
 380 /**** New in CUPS 1.2 ****/
 381 extern int              ppdCollect2(ppd_file_t *ppd, ppd_section_t section,
 382                                     float min_order, ppd_choice_t  ***choices) _CUPS_API_1_2;
 383 extern int              ppdEmitAfterOrder(ppd_file_t *ppd, FILE *fp,
 384                                           ppd_section_t section, int limit,
 385                                           float min_order) _CUPS_API_1_2;
 386 extern int              ppdEmitJCLEnd(ppd_file_t *ppd, FILE *fp) _CUPS_API_1_2;
 387 extern char             *ppdEmitString(ppd_file_t *ppd, ppd_section_t section,
 388                                        float min_order) _CUPS_API_1_2;
 389 extern ppd_coption_t    *ppdFindCustomOption(ppd_file_t *ppd,
 390                                              const char *keyword) _CUPS_API_1_2;
 391 extern ppd_cparam_t     *ppdFindCustomParam(ppd_coption_t *opt,
 392                                             const char *name) _CUPS_API_1_2;
 393 extern ppd_cparam_t     *ppdFirstCustomParam(ppd_coption_t *opt) _CUPS_API_1_2;
 394 extern ppd_option_t     *ppdFirstOption(ppd_file_t *ppd) _CUPS_API_1_2;
 395 extern ppd_cparam_t     *ppdNextCustomParam(ppd_coption_t *opt) _CUPS_API_1_2;
 396 extern ppd_option_t     *ppdNextOption(ppd_file_t *ppd) _CUPS_API_1_2;
 397 extern int              ppdLocalize(ppd_file_t *ppd) _CUPS_API_1_2;
 398 extern ppd_file_t       *ppdOpen2(cups_file_t *fp) _CUPS_API_1_2;
 399
 400 /**** New in CUPS 1.3 ****/
 401 extern const char       *ppdLocalizeIPPReason(ppd_file_t *ppd,
 402                                               const char *reason,
 403                                               const char *scheme,
 404                                               char *buffer,
 405                                               size_t bufsize) _CUPS_API_1_3;
 406
 407 /**** New in CUPS 1.4 ****/
 408 extern int              ppdInstallableConflict(ppd_file_t *ppd,
 409                                                const char *option,
 410                                                const char *choice);
 411 extern ppd_attr_t       *ppdLocalizeAttr(ppd_file_t *ppd, const char *keyword,
 412                                          const char *spec);
 413 extern const char       *ppdLocalizeMarkerName(ppd_file_t *ppd,
 414                                                const char *name) _CUPS_API_1_4;
 415 extern int              ppdPageSizeLimits(ppd_file_t *ppd,
 416                                           ppd_size_t *minimum,
 417                                           ppd_size_t *maximum) _CUPS_API_1_4;
 418
 419
 420 /*
 421  * C++ magic...
 422  */
 423
 424 #  ifdef __cplusplus
 425 }
 426 #  endif /* __cplusplus */
 427 #endif /* !_CUPS_PPD_H_ */
 428
 429 /*
 430  * End of "$Id: ppd.h 7791 2008-07-24 00:55:30Z mike $".
 431  */