cups/ppd-private.h

   1 /*
   2  * "$Id$"
   3  *
   4  * Private PPD definitions for CUPS.
   5  *
   6  * Copyright 2007-2015 by Apple Inc.
   7  * Copyright 1997-2007 by Easy Software Products, all rights reserved.
   8  *
   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/".
  14  *
  15  * PostScript is a trademark of Adobe Systems, Inc.
  16  *
  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
  22  * agreement.
  23  *
  24  * This file is subject to the Apple OS-Developed Software exception.
  25  */
  26
  27 #ifndef _CUPS_PPD_PRIVATE_H_
  28 #  define _CUPS_PPD_PRIVATE_H_
  29
  30 /*
  31  * Include necessary headers...
  32  */
  33
  34 #  include <cups/cups.h>
  35 #  include <cups/ppd.h>
  36 #  include "pwg-private.h"
  37
  38
  39 /*
  40  * C++ magic...
  41  */
  42
  43 #  ifdef __cplusplus
  44 extern "C" {
  45 #  endif /* __cplusplus */
  46
  47
  48 /*
  49  * Constants...
  50  */
  51
  52 #  define _PPD_CACHE_VERSION    7       /* Version number in cache file */
  53
  54
  55 /*
  56  * Types and structures...
  57  */
  58
  59 typedef enum _ppd_localization_e        /**** Selector for _ppdOpen ****/
  60 {
  61   _PPD_LOCALIZATION_DEFAULT,            /* Load only the default localization */
  62   _PPD_LOCALIZATION_ICC_PROFILES,       /* Load only the color profile localization */
  63   _PPD_LOCALIZATION_NONE,               /* Load no localizations */
  64   _PPD_LOCALIZATION_ALL                 /* Load all localizations */
  65 } _ppd_localization_t;
  66
  67 typedef enum _ppd_parse_e               /**** Selector for _ppdParseOptions ****/
  68 {
  69   _PPD_PARSE_OPTIONS,                   /* Parse only the options */
  70   _PPD_PARSE_PROPERTIES,                /* Parse only the properties */
  71   _PPD_PARSE_ALL                        /* Parse everything */
  72 } _ppd_parse_t;
  73
  74 typedef struct _ppd_cups_uiconst_s      /**** Constraint from cupsUIConstraints ****/
  75 {
  76   ppd_option_t  *option;                /* Constrained option */
  77   ppd_choice_t  *choice;                /* Constrained choice or @code NULL@ */
  78   int           installable;            /* Installable option? */
  79 } _ppd_cups_uiconst_t;
  80
  81 typedef struct _ppd_cups_uiconsts_s     /**** cupsUIConstraints ****/
  82 {
  83   char          resolver[PPD_MAX_NAME]; /* Resolver name */
  84   int           installable,            /* Constrained against any installable options? */
  85                 num_constraints;        /* Number of constraints */
  86   _ppd_cups_uiconst_t *constraints;     /* Constraints */
  87 } _ppd_cups_uiconsts_t;
  88
  89 typedef enum _pwg_print_color_mode_e    /**** PWG print-color-mode indices ****/
  90 {
  91   _PWG_PRINT_COLOR_MODE_MONOCHROME = 0, /* print-color-mode=monochrome */
  92   _PWG_PRINT_COLOR_MODE_COLOR,          /* print-color-mode=color */
  93   /* Other proposed values are not supported by CUPS yet. */
  94   _PWG_PRINT_COLOR_MODE_MAX
  95 } _pwg_print_color_mode_t;
  96
  97 typedef enum _pwg_print_quality_e       /**** PWG print-quality values ****/
  98 {
  99   _PWG_PRINT_QUALITY_DRAFT = 0,         /* print-quality=3 */
 100   _PWG_PRINT_QUALITY_NORMAL,            /* print-quality=4 */
 101   _PWG_PRINT_QUALITY_HIGH,              /* print-quality=5 */
 102   _PWG_PRINT_QUALITY_MAX
 103 } _pwg_print_quality_t;
 104
 105 typedef struct _pwg_finishings_s        /**** PWG finishings mapping data ****/
 106 {
 107   ipp_finishings_t      value;          /* finishings value */
 108   int                   num_options;    /* Number of options to apply */
 109   cups_option_t         *options;       /* Options to apply */
 110 } _pwg_finishings_t;
 111
 112 typedef struct _pwg_material_s          /**** PWG material mapping data ****/
 113 {
 114   char          *key,                   /* material-key value */
 115                 *name;                  /* material-name value */
 116   int           num_props;              /* Number of properties */
 117   cups_option_t *props;                 /* Material properties */
 118 } _pwg_material_t;
 119
 120 struct _ppd_cache_s                     /**** PPD cache and PWG conversion data ****/
 121 {
 122   int           num_bins;               /* Number of output bins */
 123   pwg_map_t     *bins;                  /* Output bins */
 124   int           num_sizes;              /* Number of media sizes */
 125   pwg_size_t    *sizes;                 /* Media sizes */
 126   int           custom_max_width,       /* Maximum custom width in 2540ths */
 127                 custom_max_length,      /* Maximum custom length in 2540ths */
 128                 custom_min_width,       /* Minimum custom width in 2540ths */
 129                 custom_min_length;      /* Minimum custom length in 2540ths */
 130   char          *custom_max_keyword,    /* Maximum custom size PWG keyword */
 131                 *custom_min_keyword,    /* Minimum custom size PWG keyword */
 132                 custom_ppd_size[41];    /* Custom PPD size name */
 133   pwg_size_t    custom_size;            /* Custom size record */
 134   char          *source_option;         /* PPD option for media source */
 135   int           num_sources;            /* Number of media sources */
 136   pwg_map_t     *sources;               /* Media sources */
 137   int           num_types;              /* Number of media types */
 138   pwg_map_t     *types;                 /* Media types */
 139   int           num_presets[_PWG_PRINT_COLOR_MODE_MAX][_PWG_PRINT_QUALITY_MAX];
 140                                         /* Number of print-color-mode/print-quality options */
 141   cups_option_t *presets[_PWG_PRINT_COLOR_MODE_MAX][_PWG_PRINT_QUALITY_MAX];
 142                                         /* print-color-mode/print-quality options */
 143   char          *sides_option,          /* PPD option for sides */
 144                 *sides_1sided,          /* Choice for one-sided */
 145                 *sides_2sided_long,     /* Choice for two-sided-long-edge */
 146                 *sides_2sided_short;    /* Choice for two-sided-short-edge */
 147   char          *product;               /* Product value */
 148   cups_array_t  *filters,               /* cupsFilter/cupsFilter2 values */
 149                 *prefilters;            /* cupsPreFilter values */
 150   int           single_file;            /* cupsSingleFile value */
 151   cups_array_t  *finishings;            /* cupsIPPFinishings values */
 152   int           max_copies,             /* cupsMaxCopies value */
 153                 account_id,             /* cupsJobAccountId value */
 154                 accounting_user_id;     /* cupsJobAccountingUserId value */
 155   char          *password;              /* cupsJobPassword value */
 156   cups_array_t  *mandatory;             /* cupsMandatory value */
 157   char          *charge_info_uri;       /* cupsChargeInfoURI value */
 158   cups_array_t  *support_files;         /* Support files - ICC profiles, etc. */
 159   char          *cups_3d,               /* cups3D value */
 160                 *cups_layer_order;      /* cupsLayerOrder value */
 161   int           cups_accuracy[3];       /* cupsAccuracy value - x, y, and z in nanometers */
 162   int           cups_volume[3];         /* cupsVolume value - x, y, and z in millimeters */
 163   cups_array_t  *materials;             /* cupsMaterial values */
 164 };
 165
 166
 167 /*
 168  * Prototypes...
 169  */
 170
 171 extern int              _cupsConvertOptions(ipp_t *request, ppd_file_t *ppd, _ppd_cache_t *pc, ipp_attribute_t *media_col_sup, ipp_attribute_t *doc_handling_sup, ipp_attribute_t *print_color_mode_sup, const char *user, const char *format, int copies, int num_options, cups_option_t *options);
 172 extern _ppd_cache_t     *_ppdCacheCreateWithFile(const char *filename,
 173                                                  ipp_t **attrs);
 174 extern _ppd_cache_t     *_ppdCacheCreateWithPPD(ppd_file_t *ppd);
 175 extern void             _ppdCacheDestroy(_ppd_cache_t *pc);
 176 extern const char       *_ppdCacheGetBin(_ppd_cache_t *pc,
 177                                          const char *output_bin);
 178 extern int              _ppdCacheGetFinishingOptions(_ppd_cache_t *pc,
 179                                                      ipp_t *job,
 180                                                      ipp_finishings_t value,
 181                                                      int num_options,
 182                                                      cups_option_t **options);
 183 extern int              _ppdCacheGetFinishingValues(_ppd_cache_t *pc,
 184                                                     int num_options,
 185                                                     cups_option_t *options,
 186                                                     int max_values,
 187                                                     int *values);
 188 extern const char       *_ppdCacheGetInputSlot(_ppd_cache_t *pc, ipp_t *job,
 189                                                const char *keyword);
 190 extern const char       *_ppdCacheGetMediaType(_ppd_cache_t *pc, ipp_t *job,
 191                                                const char *keyword);
 192 extern const char       *_ppdCacheGetOutputBin(_ppd_cache_t *pc,
 193                                                const char *keyword);
 194 extern const char       *_ppdCacheGetPageSize(_ppd_cache_t *pc, ipp_t *job,
 195                                               const char *keyword, int *exact);
 196 extern pwg_size_t       *_ppdCacheGetSize(_ppd_cache_t *pc,
 197                                           const char *page_size);
 198 extern const char       *_ppdCacheGetSource(_ppd_cache_t *pc,
 199                                             const char *input_slot);
 200 extern const char       *_ppdCacheGetType(_ppd_cache_t *pc,
 201                                           const char *media_type);
 202 extern int              _ppdCacheWriteFile(_ppd_cache_t *pc,
 203                                            const char *filename, ipp_t *attrs);
 204 extern char             *_ppdCreateFromIPP(char *buffer, size_t bufsize, ipp_t *response);
 205 extern void             _ppdFreeLanguages(cups_array_t *languages);
 206 extern cups_encoding_t  _ppdGetEncoding(const char *name);
 207 extern cups_array_t     *_ppdGetLanguages(ppd_file_t *ppd);
 208 extern unsigned         _ppdHashName(const char *name);
 209 extern ppd_attr_t       *_ppdLocalizedAttr(ppd_file_t *ppd, const char *keyword,
 210                                            const char *spec, const char *ll_CC);
 211 extern char             *_ppdNormalizeMakeAndModel(const char *make_and_model,
 212                                                    char *buffer,
 213                                                    size_t bufsize);
 214 extern ppd_file_t       *_ppdOpen(cups_file_t *fp,
 215                                   _ppd_localization_t localization);
 216 extern ppd_file_t       *_ppdOpenFile(const char *filename,
 217                                       _ppd_localization_t localization);
 218 extern int              _ppdParseOptions(const char *s, int num_options,
 219                                          cups_option_t **options,
 220                                          _ppd_parse_t which);
 221 extern const char       *_pwgInputSlotForSource(const char *media_source,
 222                                                 char *name, size_t namesize);
 223 extern const char       *_pwgMediaTypeForType(const char *media_type,
 224                                               char *name, size_t namesize);
 225 extern const char       *_pwgPageSizeForMedia(pwg_media_t *media,
 226                                               char *name, size_t namesize);
 227
 228
 229 /*
 230  * C++ magic...
 231  */
 232
 233 #  ifdef __cplusplus
 234 }
 235 #  endif /* __cplusplus */
 236 #endif /* !_CUPS_PPD_PRIVATE_H_ */
 237
 238 /*
 239  * End of "$Id$".
 240  */