[thirdparty/cups.git] / cups / ppd.h

/*
 * "$Id: ppd.h 7791 2008-07-24 00:55:30Z mike $"
 *
 *   PostScript Printer Description definitions for CUPS.
 *
 *   Copyright 2007-2011 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 "cups.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/Mac OS X 10.3@ ****/
{
  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_MISSING_OPTION_KEYWORD,		/* Missing option keyword */
  PPD_BAD_VALUE,			/* Bad value string */
  PPD_MISSING_CLOSE_GROUP,		/* Missing CloseGroup */
  PPD_MAX_STATUS			/* @private@ */
} ppd_status_t;

enum ppd_conform_e			/**** Conformance Levels @since CUPS 1.1.19/Mac OS X 10.3@ ****/
{
  PPD_CONFORM_RELAXED,			/* Relax whitespace and control char */
  PPD_CONFORM_STRICT			/* Require strict conformance */
};

typedef enum ppd_conform_e ppd_conform_t;
					/**** Conformance Levels @since CUPS 1.1.19/Mac OS X 10.3@ ****/

typedef struct ppd_attr_s		/**** PPD Attribute Structure @since CUPS 1.1.19/Mac OS X 10.3@ ****/
{
  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/Mac OS X 10.3@ */
  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 ppd_const_s		/**** 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/Mac OS X 10.5 ****/
typedef enum ppd_cptype_e		/**** Custom Parameter Type @since CUPS 1.2/Mac OS X 10.5@ ****/
{
  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/Mac OS X 10.5@ ****/
{
  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/Mac OS X 10.5@ ****/
{
  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/Mac OS X 10.5@ ****/
{
  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/Mac OS X 10.5@ ****/
{
  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_cache_s _ppd_cache_t;
					/**** PPD cache and mapping data @since CUPS 1.5/Mac OS X 10.7@ @private@ ****/

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 @deprecated@ */
  ppd_profile_t	*profiles;		/* sRGB color profiles @deprecated@ */
  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/Mac OS X 10.3@ */
  char		*pcfilename;		/* PCFileName string @since CUPS 1.1.19/Mac OS X 10.3@ */
  int		num_attrs;		/* Number of attributes @since CUPS 1.1.19/Mac OS X 10.3@ @private@ */
  int		cur_attr;		/* Current attribute @since CUPS 1.1.19/Mac OS X 10.3@ @private@ */
  ppd_attr_t	**attrs;		/* Attributes @since CUPS 1.1.19/Mac OS X 10.3@ @private@ */

  /**** New in CUPS 1.2/Mac OS X 10.5 ****/
  cups_array_t	*sorted_attrs;		/* Attribute lookup array @since CUPS 1.2/Mac OS X 10.5@ @private@ */
  cups_array_t	*options;		/* Option lookup array @since CUPS 1.2/Mac OS X 10.5@ @private@ */
  cups_array_t	*coptions;		/* Custom options array @since CUPS 1.2/Mac OS X 10.5@ @private@ */

  /**** New in CUPS 1.3/Mac OS X 10.5 ****/
  cups_array_t	*marked;		/* Marked choices @since CUPS 1.3/Mac OS X 10.5@ @private@ */

  /**** New in CUPS 1.4/Mac OS X 10.6 ****/
  cups_array_t	*cups_uiconstraints;	/* cupsUIConstraints @since CUPS 1.4/Mac OS X 10.6@ @private@ */

  /**** New in CUPS 1.5 ****/
  _ppd_cache_t	*cache;			/* PPD cache and mapping data @since CUPS 1.5/Mac OS X 10.7@ @private@ */
} ppd_file_t;


/*
 * Prototypes...
 */

extern int		cupsMarkOptions(ppd_file_t *ppd, int num_options,
			                cups_option_t *options);
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) _CUPS_API_1_1_19;
extern ppd_attr_t	*ppdFindAttr(ppd_file_t *ppd, const char *name,
			             const char *spec) _CUPS_API_1_1_19;
extern ppd_attr_t	*ppdFindNextAttr(ppd_file_t *ppd, const char *name,
			                 const char *spec) _CUPS_API_1_1_19;
extern ppd_status_t	ppdLastError(int *line) _CUPS_API_1_1_19;

/**** New in CUPS 1.1.20 ****/
extern void		ppdSetConformance(ppd_conform_t c) _CUPS_API_1_1_20;

/**** New in CUPS 1.2 ****/
extern int		ppdCollect2(ppd_file_t *ppd, ppd_section_t section,
			            float min_order, ppd_choice_t  ***choices) _CUPS_API_1_2;
extern int		ppdEmitAfterOrder(ppd_file_t *ppd, FILE *fp,
			                  ppd_section_t section, int limit,
					  float min_order) _CUPS_API_1_2;
extern int		ppdEmitJCLEnd(ppd_file_t *ppd, FILE *fp) _CUPS_API_1_2;
extern char		*ppdEmitString(ppd_file_t *ppd, ppd_section_t section,
			               float min_order) _CUPS_API_1_2;
extern ppd_coption_t	*ppdFindCustomOption(ppd_file_t *ppd,
			                     const char *keyword) _CUPS_API_1_2;
extern ppd_cparam_t	*ppdFindCustomParam(ppd_coption_t *opt,
			                    const char *name) _CUPS_API_1_2;
extern ppd_cparam_t	*ppdFirstCustomParam(ppd_coption_t *opt) _CUPS_API_1_2;
extern ppd_option_t	*ppdFirstOption(ppd_file_t *ppd) _CUPS_API_1_2;
extern ppd_cparam_t	*ppdNextCustomParam(ppd_coption_t *opt) _CUPS_API_1_2;
extern ppd_option_t	*ppdNextOption(ppd_file_t *ppd) _CUPS_API_1_2;
extern int		ppdLocalize(ppd_file_t *ppd) _CUPS_API_1_2;
extern ppd_file_t	*ppdOpen2(cups_file_t *fp) _CUPS_API_1_2;

/**** New in CUPS 1.3/Mac OS X 10.5 ****/
extern const char	*ppdLocalizeIPPReason(ppd_file_t *ppd,
			                      const char *reason,
					      const char *scheme,
					      char *buffer,
					      size_t bufsize) _CUPS_API_1_3;

/**** New in CUPS 1.4/Mac OS X 10.6 ****/
extern int		cupsGetConflicts(ppd_file_t *ppd, const char *option,
					 const char *choice,
					 cups_option_t **options)
					     _CUPS_API_1_4;
extern int		cupsResolveConflicts(ppd_file_t *ppd, const char *option,
			                     const char *choice,
					     int *num_options,
					     cups_option_t **options)
					     _CUPS_API_1_4;
extern int		ppdInstallableConflict(ppd_file_t *ppd,
			                       const char *option,
					       const char *choice)
					           _CUPS_API_1_4;
extern ppd_attr_t	*ppdLocalizeAttr(ppd_file_t *ppd, const char *keyword,
			                 const char *spec) _CUPS_API_1_4;
extern const char	*ppdLocalizeMarkerName(ppd_file_t *ppd,
			                       const char *name) _CUPS_API_1_4;
extern int		ppdPageSizeLimits(ppd_file_t *ppd,
			                  ppd_size_t *minimum,
					  ppd_size_t *maximum) _CUPS_API_1_4;


/*
 * C++ magic...
 */

#  ifdef __cplusplus
}
#  endif /* __cplusplus */
#endif /* !_CUPS_PPD_H_ */

/*
 * End of "$Id: ppd.h 7791 2008-07-24 00:55:30Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
b19ccc9e	2	* "$Id: ppd.h 7791 2008-07-24 00:55:30Z mike $"
ef416fc2	3	*
54afec33	4	* PostScript Printer Description definitions for CUPS.
ef416fc2	5	*
0268488e	6	* Copyright 2007-2011 by Apple Inc.
b94498cf	7	* Copyright 1997-2007 by Easy Software Products, all rights reserved.
ef416fc2	8	*
ef416fc2	9	* These coded instructions, statements, and computer programs are the
bc44d920	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/".
ef416fc2	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_H_
	28	# define _CUPS_PPD_H_
	29
	30	/*
	31	* Include necessary headers...
	32	*/
	33
	34	# include <stdio.h>
aaf19ab0	35	# include "cups.h"
fa73b229	36	# include "array.h"
ef416fc2	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
fa73b229	53	# define PPD_VERSION 4.3 /* Kept in sync with Adobe version number */
ef416fc2	54
	55
	56	/*
	57	* PPD size limits (defined in Adobe spec)
	58	*/
	59
fa73b229	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 */
ef416fc2	63
	64
	65	/*
	66	* Types and structures...
	67	*/
	68
fa73b229	69	typedef enum ppd_ui_e /** UI Types **/
ef416fc2	70	{
fa73b229	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 */
ef416fc2	74	} ppd_ui_t;
ef416fc2	75
fa73b229	76	typedef enum ppd_section_e /** Order dependency sections **/
ef416fc2	77	{
fa73b229	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 */
ef416fc2	84	} ppd_section_t;
ef416fc2	85
fa73b229	86	typedef enum ppd_cs_e /** Colorspaces **/
ef416fc2	87	{
fa73b229	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 */
ef416fc2	94	} ppd_cs_t;
ef416fc2	95
426c6a59	96	typedef enum ppd_status_e /** Status Codes @since CUPS 1.1.19/Mac OS X 10.3@ **/
ef416fc2	97	{
fa73b229	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 */
ef55b745 MS	118	PPD_BAD_CUSTOM_PARAM, /* Bad custom parameter */
	119	PPD_MISSING_OPTION_KEYWORD, /* Missing option keyword */
	120	PPD_BAD_VALUE, /* Bad value string */
0268488e	121	PPD_MISSING_CLOSE_GROUP, /* Missing CloseGroup */
ef55b745	122	PPD_MAX_STATUS /* @private@ */
ef416fc2	123	} ppd_status_t;
ef416fc2	124
426c6a59	125	enum ppd_conform_e /** Conformance Levels @since CUPS 1.1.19/Mac OS X 10.3@ **/
ef416fc2	126	{
fa73b229	127	PPD_CONFORM_RELAXED, /* Relax whitespace and control char */
fa73b229	128	PPD_CONFORM_STRICT /* Require strict conformance */
5a738aea MS	129	};
	130
	131	typedef enum ppd_conform_e ppd_conform_t;
426c6a59	132	/** Conformance Levels @since CUPS 1.1.19/Mac OS X 10.3@ **/
ef416fc2	133
426c6a59	134	typedef struct ppd_attr_s /** PPD Attribute Structure @since CUPS 1.1.19/Mac OS X 10.3@ **/
ef416fc2	135	{
fa73b229	136	char name[PPD_MAX_NAME]; /* Name of attribute (cupsXYZ) */
	137	char spec[PPD_MAX_NAME]; /* Specifier string, if any */
	138	char text[PPD_MAX_TEXT]; /* Human-readable text, if any */
	139	char value; / Value string */
ef416fc2	140	} ppd_attr_t;
ef416fc2	141
fa73b229	142	typedef struct ppd_option_s ppd_option_t;
fa73b229	143	/** Options **/
ef416fc2	144
fa73b229	145	typedef struct ppd_choice_s /** Option choices **/
ef416fc2	146	{
fa73b229	147	char marked; /* 0 if not selected, 1 otherwise */
	148	char choice[PPD_MAX_NAME]; /* Computer-readable option name */
	149	char text[PPD_MAX_TEXT]; /* Human-readable option name */
	150	char code; / Code to send for this option */
	151	ppd_option_t option; / Pointer to parent option structure */
ef416fc2	152	} ppd_choice_t;
ef416fc2	153
fa73b229	154	struct ppd_option_s /** Options **/
ef416fc2	155	{
fa73b229	156	char conflicted; /* 0 if no conflicts exist, 1 otherwise */
	157	char keyword[PPD_MAX_NAME]; /* Option keyword name ("PageSize", etc.) */
	158	char defchoice[PPD_MAX_NAME];/* Default option choice */
	159	char text[PPD_MAX_TEXT]; /* Human-readable text */
	160	ppd_ui_t ui; /* Type of UI option */
	161	ppd_section_t section; /* Section for command */
	162	float order; /* Order number */
	163	int num_choices; /* Number of option choices */
	164	ppd_choice_t choices; / Option choices */
ef416fc2	165	};
ef416fc2	166
fa73b229	167	typedef struct ppd_group_s /** Groups **/
ef416fc2	168	{
	169	/**** Group text strings are limited to 39 chars + nul in order to
	170	**** preserve binary compatibility and allow applications to get
	171	**** the group's keyword name.
	172	****/
	173	char text[PPD_MAX_TEXT - PPD_MAX_NAME];
fa73b229	174	/* Human-readable group name */
426c6a59	175	char name[PPD_MAX_NAME]; /* Group name @since CUPS 1.1.18/Mac OS X 10.3@ */
fa73b229	176	int num_options; /* Number of options */
	177	ppd_option_t options; / Options */
	178	int num_subgroups; /* Number of sub-groups */
	179	struct ppd_group_s subgroups; / Sub-groups (max depth = 1) */
ef416fc2	180	} ppd_group_t;
ef416fc2	181
5a738aea	182	typedef struct ppd_const_s /** Constraints **/
ef416fc2	183	{
fa73b229	184	char option1[PPD_MAX_NAME]; /* First keyword */
	185	char choice1[PPD_MAX_NAME]; /* First option/choice (blank for all) */
	186	char option2[PPD_MAX_NAME]; /* Second keyword */
	187	char choice2[PPD_MAX_NAME]; /* Second option/choice (blank for all) */
ef416fc2	188	} ppd_const_t;
ef416fc2	189
fa73b229	190	typedef struct ppd_size_s /** Page Sizes **/
ef416fc2	191	{
fa73b229	192	int marked; /* Page size selected? */
	193	char name[PPD_MAX_NAME]; /* Media size option */
	194	float width; /* Width of media in points */
	195	float length; /* Length of media in points */
	196	float left; /* Left printable margin in points */
	197	float bottom; /* Bottom printable margin in points */
	198	float right; /* Right printable margin in points */
	199	float top; /* Top printable margin in points */
ef416fc2	200	} ppd_size_t;
ef416fc2	201
fa73b229	202	typedef struct ppd_emul_s /** Emulators **/
ef416fc2	203	{
fa73b229	204	char name[PPD_MAX_NAME]; /* Emulator name */
	205	char start; / Code to switch to this emulation */
	206	char stop; / Code to stop this emulation */
ef416fc2	207	} ppd_emul_t;
ef416fc2	208
fa73b229	209	typedef struct ppd_profile_s /** sRGB Color Profiles **/
ef416fc2	210	{
ef416fc2	211	char resolution[PPD_MAX_NAME];
fa73b229	212	/* Resolution or "-" */
ef416fc2	213	char media_type[PPD_MAX_NAME];
fa73b229	214	/* Media type or "-" */
	215	float density; /* Ink density to use */
	216	float gamma; /* Gamma correction to use */
	217	float matrix[3][3]; /* Transform matrix */
ef416fc2	218	} ppd_profile_t;
ef416fc2	219
b0f6947b	220	/** New in CUPS 1.2/Mac OS X 10.5 **/
426c6a59	221	typedef enum ppd_cptype_e /** Custom Parameter Type @since CUPS 1.2/Mac OS X 10.5@ **/
ef416fc2	222	{
fa73b229	223	PPD_CUSTOM_CURVE, /* Curve value for f(x) = x^value */
	224	PPD_CUSTOM_INT, /* Integer number value */
	225	PPD_CUSTOM_INVCURVE, /* Curve value for f(x) = x^(1/value) */
	226	PPD_CUSTOM_PASSCODE, /* String of (hidden) numbers */
	227	PPD_CUSTOM_PASSWORD, /* String of (hidden) characters */
	228	PPD_CUSTOM_POINTS, /* Measurement value in points */
	229	PPD_CUSTOM_REAL, /* Real number value */
	230	PPD_CUSTOM_STRING /* String of characters */
	231	} ppd_cptype_t;
	232
426c6a59	233	typedef union ppd_cplimit_u /** Custom Parameter Limit @since CUPS 1.2/Mac OS X 10.5@ **/
b423cd4c	234	{
	235	float custom_curve; /* Gamma value */
	236	int custom_int; /* Integer value */
	237	float custom_invcurve; /* Gamma value */
	238	int custom_passcode; /* Passcode length */
	239	int custom_password; /* Password length */
	240	float custom_points; /* Measurement value */
	241	float custom_real; /* Real value */
	242	int custom_string; /* String length */
	243	} ppd_cplimit_t;
	244
426c6a59	245	typedef union ppd_cpvalue_u /** Custom Parameter Value @since CUPS 1.2/Mac OS X 10.5@ **/
ef416fc2	246	{
fa73b229	247	float custom_curve; /* Gamma value */
	248	int custom_int; /* Integer value */
	249	float custom_invcurve; /* Gamma value */
	250	char custom_passcode; / Passcode value */
	251	char custom_password; / Password value */
	252	float custom_points; /* Measurement value */
	253	float custom_real; /* Real value */
	254	char custom_string; / String value */
	255	} ppd_cpvalue_t;
	256
426c6a59	257	typedef struct ppd_cparam_s /** Custom Parameter @since CUPS 1.2/Mac OS X 10.5@ **/
ef416fc2	258	{
fa73b229	259	char name[PPD_MAX_NAME]; /* Parameter name */
	260	char text[PPD_MAX_TEXT]; /* Human-readable text */
	261	int order; /* Order (0 to N) */
	262	ppd_cptype_t type; /* Parameter type */
b423cd4c	263	ppd_cplimit_t minimum, /* Minimum value */
	264	maximum; /* Maximum value */
	265	ppd_cpvalue_t current; /* Current value */
fa73b229	266	} ppd_cparam_t;
fa73b229	267
426c6a59	268	typedef struct ppd_coption_s /** Custom Option @since CUPS 1.2/Mac OS X 10.5@ **/
ef416fc2	269	{
fa73b229	270	char keyword[PPD_MAX_NAME]; /* Name of option that is being extended... */
	271	ppd_option_t option; / Option that is being extended... */
	272	int marked; /* Extended option is marked */
	273	cups_array_t params; / Parameters */
	274	} ppd_coption_t;
	275
f14324a7	276	typedef struct _ppd_cache_s _ppd_cache_t;
321d8d57	277	/** PPD cache and mapping data @since CUPS 1.5/Mac OS X 10.7@ @private@ **/
f14324a7	278
fa73b229	279	typedef struct ppd_file_s /** PPD File **/
ef416fc2	280	{
fa73b229	281	int language_level; /* Language level of device */
	282	int color_device; /* 1 = color device, 0 = grayscale */
	283	int variable_sizes; /* 1 = supports variable sizes, 0 = doesn't */
	284	int accurate_screens; /* 1 = supports accurate screens, 0 = not */
	285	int contone_only; /* 1 = continuous tone only, 0 = not */
	286	int landscape; /* -90 or 90 */
	287	int model_number; /* Device-specific model number */
	288	int manual_copies; /* 1 = Copies done manually, 0 = hardware */
	289	int throughput; /* Pages per minute */
	290	ppd_cs_t colorspace; /* Default colorspace */
	291	char patches; / Patch commands to be sent to printer */
	292	int num_emulations; /* Number of emulations supported */
	293	ppd_emul_t emulations; / Emulations and the code to invoke them */
	294	char jcl_begin; / Start JCL commands */
	295	char jcl_ps; / Enter PostScript interpreter */
	296	char jcl_end; / End JCL commands */
	297	char lang_encoding; / Language encoding */
	298	char lang_version; / Language version (English, Spanish, etc.) */
	299	char modelname; / Model name (general) */
	300	char ttrasterizer; / Truetype rasterizer */
	301	char manufacturer; / Manufacturer name */
	302	char product; / Product name (from PS RIP/interpreter) */
	303	char nickname; / Nickname (specific) */
	304	char shortnickname; / Short version of nickname */
	305	int num_groups; /* Number of UI groups */
	306	ppd_group_t groups; / UI groups */
	307	int num_sizes; /* Number of page sizes */
	308	ppd_size_t sizes; / Page sizes */
	309	float custom_min[2]; /* Minimum variable page size */
	310	float custom_max[2]; /* Maximum variable page size */
	311	float custom_margins[4]; /* Margins around page */
	312	int num_consts; /* Number of UI/Non-UI constraints */
	313	ppd_const_t consts; / UI/Non-UI constraints */
	314	int num_fonts; /* Number of pre-loaded fonts */
	315	char *fonts; / Pre-loaded fonts */
66ab9486 MS	316	int num_profiles; /* Number of sRGB color profiles @deprecated@ */
66ab9486 MS	317	ppd_profile_t profiles; / sRGB color profiles @deprecated@ */
fa73b229	318	int num_filters; /* Number of filters */
fa73b229	319	char *filters; / Filter strings... */
ef416fc2	320
ef416fc2	321	/** New in CUPS 1.1 **/
bc44d920	322	int flip_duplex; /* 1 = Flip page for back sides @deprecated@ */
ef416fc2	323
ef416fc2	324	/** New in CUPS 1.1.19 **/
426c6a59 MS	325	char protocols; / Protocols (BCP, TBCP) string @since CUPS 1.1.19/Mac OS X 10.3@ */
	326	char pcfilename; / PCFileName string @since CUPS 1.1.19/Mac OS X 10.3@ */
	327	int num_attrs; /* Number of attributes @since CUPS 1.1.19/Mac OS X 10.3@ @private@ */
	328	int cur_attr; /* Current attribute @since CUPS 1.1.19/Mac OS X 10.3@ @private@ */
	329	ppd_attr_t *attrs; / Attributes @since CUPS 1.1.19/Mac OS X 10.3@ @private@ */
ef416fc2	330
b0f6947b	331	/** New in CUPS 1.2/Mac OS X 10.5 **/
426c6a59 MS	332	cups_array_t sorted_attrs; / Attribute lookup array @since CUPS 1.2/Mac OS X 10.5@ @private@ */
	333	cups_array_t options; / Option lookup array @since CUPS 1.2/Mac OS X 10.5@ @private@ */
	334	cups_array_t coptions; / Custom options array @since CUPS 1.2/Mac OS X 10.5@ @private@ */
b94498cf	335
b0f6947b	336	/** New in CUPS 1.3/Mac OS X 10.5 **/
426c6a59	337	cups_array_t marked; / Marked choices @since CUPS 1.3/Mac OS X 10.5@ @private@ */
66ab9486	338
b0f6947b	339	/** New in CUPS 1.4/Mac OS X 10.6 **/
178cb736	340	cups_array_t cups_uiconstraints; / cupsUIConstraints @since CUPS 1.4/Mac OS X 10.6@ @private@ */
54afec33 MS	341
54afec33 MS	342	/** New in CUPS 1.5 **/
321d8d57	343	_ppd_cache_t cache; / PPD cache and mapping data @since CUPS 1.5/Mac OS X 10.7@ @private@ */
ef416fc2	344	} ppd_file_t;
	345
	346
	347	/*
	348	* Prototypes...
	349	*/
	350
aaf19ab0 MS	351	extern int cupsMarkOptions(ppd_file_t *ppd, int num_options,
aaf19ab0 MS	352	cups_option_t *options);
ef416fc2	353	extern void ppdClose(ppd_file_t *ppd);
	354	extern int ppdCollect(ppd_file_t *ppd, ppd_section_t section,
	355	ppd_choice_t ***choices);
	356	extern int ppdConflicts(ppd_file_t *ppd);
	357	extern int ppdEmit(ppd_file_t ppd, FILE fp,
	358	ppd_section_t section);
	359	extern int ppdEmitFd(ppd_file_t *ppd, int fd,
	360	ppd_section_t section);
	361	extern int ppdEmitJCL(ppd_file_t ppd, FILE fp, int job_id,
	362	const char user, const char title);
	363	extern ppd_choice_t ppdFindChoice(ppd_option_t o, const char *option);
	364	extern ppd_choice_t ppdFindMarkedChoice(ppd_file_t ppd, const char *keyword);
	365	extern ppd_option_t ppdFindOption(ppd_file_t ppd, const char *keyword);
	366	extern int ppdIsMarked(ppd_file_t ppd, const char keyword,
	367	const char *option);
	368	extern void ppdMarkDefaults(ppd_file_t *ppd);
	369	extern int ppdMarkOption(ppd_file_t ppd, const char keyword,
	370	const char *option);
	371	extern ppd_file_t ppdOpen(FILE fp);
	372	extern ppd_file_t *ppdOpenFd(int fd);
	373	extern ppd_file_t ppdOpenFile(const char filename);
	374	extern float ppdPageLength(ppd_file_t ppd, const char name);
	375	extern ppd_size_t ppdPageSize(ppd_file_t ppd, const char *name);
	376	extern float ppdPageWidth(ppd_file_t ppd, const char name);
	377
	378	/** New in CUPS 1.1.19 **/
2fb76298	379	extern const char *ppdErrorString(ppd_status_t status) _CUPS_API_1_1_19;
ef416fc2	380	extern ppd_attr_t ppdFindAttr(ppd_file_t ppd, const char *name,
2fb76298	381	const char *spec) _CUPS_API_1_1_19;
ef416fc2	382	extern ppd_attr_t ppdFindNextAttr(ppd_file_t ppd, const char *name,
2fb76298 MS	383	const char *spec) _CUPS_API_1_1_19;
2fb76298 MS	384	extern ppd_status_t ppdLastError(int *line) _CUPS_API_1_1_19;
ef416fc2	385
ef416fc2	386	/** New in CUPS 1.1.20 **/
2fb76298	387	extern void ppdSetConformance(ppd_conform_t c) _CUPS_API_1_1_20;
ef416fc2	388
ef416fc2	389	/** New in CUPS 1.2 **/
fa73b229	390	extern int ppdCollect2(ppd_file_t *ppd, ppd_section_t section,
2fb76298	391	float min_order, ppd_choice_t ***choices) _CUPS_API_1_2;
fa73b229	392	extern int ppdEmitAfterOrder(ppd_file_t ppd, FILE fp,
fa73b229	393	ppd_section_t section, int limit,
2fb76298 MS	394	float min_order) _CUPS_API_1_2;
2fb76298 MS	395	extern int ppdEmitJCLEnd(ppd_file_t ppd, FILE fp) _CUPS_API_1_2;
757d2cad	396	extern char ppdEmitString(ppd_file_t ppd, ppd_section_t section,
2fb76298	397	float min_order) _CUPS_API_1_2;
fa73b229	398	extern ppd_coption_t ppdFindCustomOption(ppd_file_t ppd,
2fb76298	399	const char *keyword) _CUPS_API_1_2;
fa73b229	400	extern ppd_cparam_t ppdFindCustomParam(ppd_coption_t opt,
2fb76298 MS	401	const char *name) _CUPS_API_1_2;
	402	extern ppd_cparam_t ppdFirstCustomParam(ppd_coption_t opt) _CUPS_API_1_2;
	403	extern ppd_option_t ppdFirstOption(ppd_file_t ppd) _CUPS_API_1_2;
	404	extern ppd_cparam_t ppdNextCustomParam(ppd_coption_t opt) _CUPS_API_1_2;
	405	extern ppd_option_t ppdNextOption(ppd_file_t ppd) _CUPS_API_1_2;
	406	extern int ppdLocalize(ppd_file_t *ppd) _CUPS_API_1_2;
	407	extern ppd_file_t ppdOpen2(cups_file_t fp) _CUPS_API_1_2;
ef416fc2	408
aaf19ab0	409	/** New in CUPS 1.3/Mac OS X 10.5 **/
bc44d920	410	extern const char ppdLocalizeIPPReason(ppd_file_t ppd,
	411	const char *reason,
	412	const char *scheme,
5a738aea MS	413	char *buffer,
	414	size_t bufsize) _CUPS_API_1_3;
	415
aaf19ab0 MS	416	/** New in CUPS 1.4/Mac OS X 10.6 **/
	417	extern int cupsGetConflicts(ppd_file_t ppd, const char option,
	418	const char *choice,
	419	cups_option_t **options)
	420	_CUPS_API_1_4;
	421	extern int cupsResolveConflicts(ppd_file_t ppd, const char option,
	422	const char *choice,
	423	int *num_options,
	424	cups_option_t **options)
	425	_CUPS_API_1_4;
66ab9486 MS	426	extern int ppdInstallableConflict(ppd_file_t *ppd,
66ab9486 MS	427	const char *option,
aaf19ab0 MS	428	const char *choice)
aaf19ab0 MS	429	_CUPS_API_1_4;
75bd9771	430	extern ppd_attr_t ppdLocalizeAttr(ppd_file_t ppd, const char *keyword,
aaf19ab0	431	const char *spec) _CUPS_API_1_4;
5a738aea MS	432	extern const char ppdLocalizeMarkerName(ppd_file_t ppd,
5a738aea MS	433	const char *name) _CUPS_API_1_4;
005dd1eb MS	434	extern int ppdPageSizeLimits(ppd_file_t *ppd,
	435	ppd_size_t *minimum,
	436	ppd_size_t *maximum) _CUPS_API_1_4;
bc44d920	437
ef416fc2	438
	439	/*
	440	* C++ magic...
	441	*/
	442
	443	# ifdef __cplusplus
	444	}
	445	# endif /* __cplusplus */
	446	#endif /* !_CUPS_PPD_H_ */
	447
	448	/*
b19ccc9e	449	* End of "$Id: ppd.h 7791 2008-07-24 00:55:30Z mike $".
ef416fc2	450	*/