]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - cups/ppd-private.h
Full sweep of all Clang warnings, plus some bug fixes for incorrect memcpy usage.
[thirdparty/cups.git] / cups / ppd-private.h
index ffbebfc59631fb4e88b46317ac175fe47d80828a..9e890e9edec86873e98316973f3c4d5df86a86f2 100644 (file)
@@ -1,27 +1,27 @@
 /*
  * "$Id$"
  *
- *   Private PPD definitions for the Common UNIX Printing System (CUPS).
+ * Private PPD definitions for CUPS.
  *
- *   Copyright 2007-2008 by Apple Inc.
- *   Copyright 1997-2007 by Easy Software Products, all rights reserved.
+ * Copyright 2007-2014 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/".
+ * 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.
+ * 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 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.
+ * This file is subject to the Apple OS-Developed Software exception.
  */
 
 #ifndef _CUPS_PPD_PRIVATE_H_
@@ -31,7 +31,9 @@
  * Include necessary headers...
  */
 
-#  include "ppd.h"
+#  include <cups/cups.h>
+#  include <cups/ppd.h>
+#  include "pwg-private.h"
 
 
 /*
@@ -43,11 +45,170 @@ extern "C" {
 #  endif /* __cplusplus */
 
 
+/*
+ * Constants...
+ */
+
+#  define _PPD_CACHE_VERSION   6       /* Version number in cache file */
+
+
+/*
+ * Types and structures...
+ */
+
+typedef enum _ppd_localization_e       /**** Selector for _ppdOpen ****/
+{
+  _PPD_LOCALIZATION_DEFAULT,           /* Load only the default localization */
+  _PPD_LOCALIZATION_ICC_PROFILES,      /* Load only the color profile localization */
+  _PPD_LOCALIZATION_NONE,              /* Load no localizations */
+  _PPD_LOCALIZATION_ALL                        /* Load all localizations */
+} _ppd_localization_t;
+
+typedef enum _ppd_parse_e              /**** Selector for _ppdParseOptions ****/
+{
+  _PPD_PARSE_OPTIONS,                  /* Parse only the options */
+  _PPD_PARSE_PROPERTIES,               /* Parse only the properties */
+  _PPD_PARSE_ALL                       /* Parse everything */
+} _ppd_parse_t;
+
+typedef struct _ppd_cups_uiconst_s     /**** Constraint from cupsUIConstraints ****/
+{
+  ppd_option_t *option;                /* Constrained option */
+  ppd_choice_t *choice;                /* Constrained choice or @code NULL@ */
+  int          installable;            /* Installable option? */
+} _ppd_cups_uiconst_t;
+
+typedef struct _ppd_cups_uiconsts_s    /**** cupsUIConstraints ****/
+{
+  char         resolver[PPD_MAX_NAME]; /* Resolver name */
+  int          installable,            /* Constrained against any installable options? */
+               num_constraints;        /* Number of constraints */
+  _ppd_cups_uiconst_t *constraints;    /* Constraints */
+} _ppd_cups_uiconsts_t;
+
+typedef enum _pwg_print_color_mode_e   /**** PWG print-color-mode indices ****/
+{
+  _PWG_PRINT_COLOR_MODE_MONOCHROME = 0,        /* print-color-mode=monochrome */
+  _PWG_PRINT_COLOR_MODE_COLOR,         /* print-color-mode=color */
+  /* Other proposed values are not supported by CUPS yet. */
+  _PWG_PRINT_COLOR_MODE_MAX
+} _pwg_print_color_mode_t;
+
+typedef enum _pwg_print_quality_e      /**** PWG print-quality values ****/
+{
+  _PWG_PRINT_QUALITY_DRAFT = 0,                /* print-quality=3 */
+  _PWG_PRINT_QUALITY_NORMAL,           /* print-quality=4 */
+  _PWG_PRINT_QUALITY_HIGH,             /* print-quality=5 */
+  _PWG_PRINT_QUALITY_MAX
+} _pwg_print_quality_t;
+
+typedef struct _pwg_finishings_s       /**** PWG finishings mapping data ****/
+{
+  ipp_finishings_t     value;          /* finishings value */
+  int                  num_options;    /* Number of options to apply */
+  cups_option_t                *options;       /* Options to apply */
+} _pwg_finishings_t;
+
+struct _ppd_cache_s                    /**** PPD cache and PWG conversion data ****/
+{
+  int          num_bins;               /* Number of output bins */
+  pwg_map_t    *bins;                  /* Output bins */
+  int          num_sizes;              /* Number of media sizes */
+  pwg_size_t   *sizes;                 /* Media sizes */
+  int          custom_max_width,       /* Maximum custom width in 2540ths */
+               custom_max_length,      /* Maximum custom length in 2540ths */
+               custom_min_width,       /* Minimum custom width in 2540ths */
+               custom_min_length;      /* Minimum custom length in 2540ths */
+  char         *custom_max_keyword,    /* Maximum custom size PWG keyword */
+               *custom_min_keyword,    /* Minimum custom size PWG keyword */
+               custom_ppd_size[41];    /* Custom PPD size name */
+  pwg_size_t   custom_size;            /* Custom size record */
+  char         *source_option;         /* PPD option for media source */
+  int          num_sources;            /* Number of media sources */
+  pwg_map_t    *sources;               /* Media sources */
+  int          num_types;              /* Number of media types */
+  pwg_map_t    *types;                 /* Media types */
+  int          num_presets[_PWG_PRINT_COLOR_MODE_MAX][_PWG_PRINT_QUALITY_MAX];
+                                       /* Number of print-color-mode/print-quality options */
+  cups_option_t        *presets[_PWG_PRINT_COLOR_MODE_MAX][_PWG_PRINT_QUALITY_MAX];
+                                       /* print-color-mode/print-quality options */
+  char         *sides_option,          /* PPD option for sides */
+               *sides_1sided,          /* Choice for one-sided */
+               *sides_2sided_long,     /* Choice for two-sided-long-edge */
+               *sides_2sided_short;    /* Choice for two-sided-short-edge */
+  char         *product;               /* Product value */
+  cups_array_t *filters,               /* cupsFilter/cupsFilter2 values */
+               *prefilters;            /* cupsPreFilter values */
+  int          single_file;            /* cupsSingleFile value */
+  cups_array_t *finishings;            /* cupsIPPFinishings values */
+  int          max_copies,             /* cupsMaxCopies value */
+               account_id,             /* cupsJobAccountId value */
+               accounting_user_id;     /* cupsJobAccountingUserId value */
+  char         *password;              /* cupsJobPassword value */
+  cups_array_t *mandatory;             /* cupsMandatory value */
+  char         *charge_info_uri;       /* cupsChargeInfoURI value */
+  cups_array_t *support_files;         /* Support files - ICC profiles, etc. */
+};
+
+
+/*
+ * Prototypes...
+ */
+
+extern _ppd_cache_t    *_ppdCacheCreateWithFile(const char *filename,
+                                                ipp_t **attrs);
+extern _ppd_cache_t    *_ppdCacheCreateWithPPD(ppd_file_t *ppd);
+extern void            _ppdCacheDestroy(_ppd_cache_t *pc);
+extern const char      *_ppdCacheGetBin(_ppd_cache_t *pc,
+                                        const char *output_bin);
+extern int             _ppdCacheGetFinishingOptions(_ppd_cache_t *pc,
+                                                    ipp_t *job,
+                                                    ipp_finishings_t value,
+                                                    int num_options,
+                                                    cups_option_t **options);
+extern int             _ppdCacheGetFinishingValues(_ppd_cache_t *pc,
+                                                   int num_options,
+                                                   cups_option_t *options,
+                                                   int max_values,
+                                                   int *values);
+extern const char      *_ppdCacheGetInputSlot(_ppd_cache_t *pc, ipp_t *job,
+                                              const char *keyword);
+extern const char      *_ppdCacheGetMediaType(_ppd_cache_t *pc, ipp_t *job,
+                                              const char *keyword);
+extern const char      *_ppdCacheGetOutputBin(_ppd_cache_t *pc,
+                                              const char *keyword);
+extern const char      *_ppdCacheGetPageSize(_ppd_cache_t *pc, ipp_t *job,
+                                             const char *keyword, int *exact);
+extern pwg_size_t      *_ppdCacheGetSize(_ppd_cache_t *pc,
+                                         const char *page_size);
+extern const char      *_ppdCacheGetSource(_ppd_cache_t *pc,
+                                           const char *input_slot);
+extern const char      *_ppdCacheGetType(_ppd_cache_t *pc,
+                                         const char *media_type);
+extern int             _ppdCacheWriteFile(_ppd_cache_t *pc,
+                                          const char *filename, ipp_t *attrs);
 extern void            _ppdFreeLanguages(cups_array_t *languages);
+extern cups_encoding_t _ppdGetEncoding(const char *name);
 extern cups_array_t    *_ppdGetLanguages(ppd_file_t *ppd);
 extern unsigned                _ppdHashName(const char *name);
 extern ppd_attr_t      *_ppdLocalizedAttr(ppd_file_t *ppd, const char *keyword,
                                           const char *spec, const char *ll_CC);
+extern char            *_ppdNormalizeMakeAndModel(const char *make_and_model,
+                                                  char *buffer,
+                                                  size_t bufsize);
+extern ppd_file_t      *_ppdOpen(cups_file_t *fp,
+                                 _ppd_localization_t localization);
+extern ppd_file_t      *_ppdOpenFile(const char *filename,
+                                     _ppd_localization_t localization);
+extern int             _ppdParseOptions(const char *s, int num_options,
+                                        cups_option_t **options,
+                                        _ppd_parse_t which);
+extern const char      *_pwgInputSlotForSource(const char *media_source,
+                                               char *name, size_t namesize);
+extern const char      *_pwgMediaTypeForType(const char *media_type,
+                                             char *name, size_t namesize);
+extern const char      *_pwgPageSizeForMedia(pwg_media_t *media,
+                                             char *name, size_t namesize);
 
 
 /*