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

/*
 * "$Id: ipp.h 5090 2006-02-08 17:08:01Z mike $"
 *
 *   Internet Printing Protocol definitions for the Common UNIX Printing
 *   System (CUPS).
 *
 *   Copyright 1997-2006 by Easy Software Products.
 *
 *   These coded instructions, statements, and computer programs are the
 *   property of Easy Software Products 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 missing or damaged please contact Easy Software Products
 *   at:
 *
 *       Attn: CUPS Licensing Information
 *       Easy Software Products
 *       44141 Airport View Drive, Suite 204
 *       Hollywood, Maryland 20636 USA
 *
 *       Voice: (301) 373-9600
 *       EMail: cups-info@cups.org
 *         WWW: http://www.cups.org
 *
 *   This file is subject to the Apple OS-Developed Software exception.
 */

#ifndef _CUPS_IPP_H_
#  define _CUPS_IPP_H_

/*
 * Include necessary headers...
 */

#  include "http.h"


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

#  ifdef __cplusplus
extern "C" {
#  endif /* __cplusplus */


/*
 * IPP version string...
 */

#  define IPP_VERSION		"\001\001"

/*
 * IPP registered port number...
 *
 * Note: Applications should never use IPP_PORT, but instead use the
 * ippPort() function to allow overrides via the IPP_PORT environment
 * variable and services file if needed!
 */

#  define IPP_PORT		631

/*
 * Common limits...
 */

#  define IPP_MAX_NAME		256
#  define IPP_MAX_VALUES	8	/* Power-of-2 allocation increment */


/*
 * Types and structures...
 */

typedef enum				/**** Format tags for attribute formats... ****/
{
  IPP_TAG_ZERO = 0x00,
  IPP_TAG_OPERATION,
  IPP_TAG_JOB,
  IPP_TAG_END,
  IPP_TAG_PRINTER,
  IPP_TAG_UNSUPPORTED_GROUP,
  IPP_TAG_SUBSCRIPTION,
  IPP_TAG_EVENT_NOTIFICATION,
  IPP_TAG_UNSUPPORTED_VALUE = 0x10,
  IPP_TAG_DEFAULT,
  IPP_TAG_UNKNOWN,
  IPP_TAG_NOVALUE,
  IPP_TAG_NOTSETTABLE = 0x15,
  IPP_TAG_DELETEATTR,
  IPP_TAG_ADMINDEFINE,
  IPP_TAG_INTEGER = 0x21,
  IPP_TAG_BOOLEAN,
  IPP_TAG_ENUM,
  IPP_TAG_STRING = 0x30,
  IPP_TAG_DATE,
  IPP_TAG_RESOLUTION,
  IPP_TAG_RANGE,
  IPP_TAG_BEGIN_COLLECTION,
  IPP_TAG_TEXTLANG,
  IPP_TAG_NAMELANG,
  IPP_TAG_END_COLLECTION,
  IPP_TAG_TEXT = 0x41,
  IPP_TAG_NAME,
  IPP_TAG_KEYWORD = 0x44,
  IPP_TAG_URI,
  IPP_TAG_URISCHEME,
  IPP_TAG_CHARSET,
  IPP_TAG_LANGUAGE,
  IPP_TAG_MIMETYPE,
  IPP_TAG_MEMBERNAME,
  IPP_TAG_MASK = 0x7fffffff,		/* Mask for copied attribute values */
  IPP_TAG_COPY = -0x7fffffff-1		/* Bitflag for copied attribute values */
} ipp_tag_t;

typedef enum				/**** Resolution units... ****/
{
  IPP_RES_PER_INCH = 3,
  IPP_RES_PER_CM
} ipp_res_t;

typedef enum				/**** Finishings... ****/
{
  IPP_FINISHINGS_NONE = 3,
  IPP_FINISHINGS_STAPLE,
  IPP_FINISHINGS_PUNCH,
  IPP_FINISHINGS_COVER,
  IPP_FINISHINGS_BIND,
  IPP_FINISHINGS_SADDLE_STITCH,
  IPP_FINISHINGS_EDGE_STITCH,
  IPP_FINISHINGS_FOLD,
  IPP_FINISHINGS_TRIM,
  IPP_FINISHINGS_BALE,
  IPP_FINISHINGS_BOOKLET_MAKER,
  IPP_FINISHINGS_JOB_OFFSET,
  IPP_FINISHINGS_STAPLE_TOP_LEFT = 20,
  IPP_FINISHINGS_STAPLE_BOTTOM_LEFT,
  IPP_FINISHINGS_STAPLE_TOP_RIGHT,
  IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT,
  IPP_FINISHINGS_EDGE_STITCH_LEFT,
  IPP_FINISHINGS_EDGE_STITCH_TOP,
  IPP_FINISHINGS_EDGE_STITCH_RIGHT,
  IPP_FINISHINGS_EDGE_STITCH_BOTTOM,
  IPP_FINISHINGS_STAPLE_DUAL_LEFT,
  IPP_FINISHINGS_STAPLE_DUAL_TOP,
  IPP_FINISHINGS_STAPLE_DUAL_RIGHT,
  IPP_FINISHINGS_STAPLE_DUAL_BOTTOM,
  IPP_FINISHINGS_BIND_LEFT = 50,
  IPP_FINISHINGS_BIND_TOP,
  IPP_FINISHINGS_BIND_RIGHT,
  IPP_FINISHINGS_BIND_BOTTOM
} ipp_finish_t;

typedef enum				/**** Orientation... ****/
{
  IPP_PORTRAIT = 3,			/* No rotation */
  IPP_LANDSCAPE,			/* 90 degrees counter-clockwise */
  IPP_REVERSE_LANDSCAPE,		/* 90 degrees clockwise */
  IPP_REVERSE_PORTRAIT			/* 180 degrees */
} ipp_orient_t;

typedef enum				/**** Qualities... ****/
{
  IPP_QUALITY_DRAFT = 3,
  IPP_QUALITY_NORMAL,
  IPP_QUALITY_HIGH
} ipp_quality_t;

typedef enum				/**** Job States.... */
{
  IPP_JOB_PENDING = 3,
  IPP_JOB_HELD,
  IPP_JOB_PROCESSING,
  IPP_JOB_STOPPED,
  IPP_JOB_CANCELLED,
  IPP_JOB_ABORTED,
  IPP_JOB_COMPLETED
} ipp_jstate_t;

typedef enum				/**** Printer States.... */
{
  IPP_PRINTER_IDLE = 3,
  IPP_PRINTER_PROCESSING,
  IPP_PRINTER_STOPPED
} ipp_pstate_t;

typedef enum				/**** IPP states... ****/
{
  IPP_ERROR = -1,			/* An error occurred */
  IPP_IDLE,				/* Nothing is happening/request completed */
  IPP_HEADER,				/* The request header needs to be sent/received */
  IPP_ATTRIBUTE,			/* One or more attributes need to be sent/received */
  IPP_DATA				/* IPP request data needs to be sent/received */
} ipp_state_t;

typedef enum				/**** IPP operations... ****/
{
  IPP_PRINT_JOB = 0x0002,
  IPP_PRINT_URI,
  IPP_VALIDATE_JOB,
  IPP_CREATE_JOB,
  IPP_SEND_DOCUMENT,
  IPP_SEND_URI,
  IPP_CANCEL_JOB,
  IPP_GET_JOB_ATTRIBUTES,
  IPP_GET_JOBS,
  IPP_GET_PRINTER_ATTRIBUTES,
  IPP_HOLD_JOB,
  IPP_RELEASE_JOB,
  IPP_RESTART_JOB,
  IPP_PAUSE_PRINTER = 0x0010,
  IPP_RESUME_PRINTER,
  IPP_PURGE_JOBS,
  IPP_SET_PRINTER_ATTRIBUTES,
  IPP_SET_JOB_ATTRIBUTES,
  IPP_GET_PRINTER_SUPPORTED_VALUES,
  IPP_CREATE_PRINTER_SUBSCRIPTION,
  IPP_CREATE_JOB_SUBSCRIPTION,
  IPP_GET_SUBSCRIPTION_ATTRIBUTES,
  IPP_GET_SUBSCRIPTIONS,
  IPP_RENEW_SUBSCRIPTION,
  IPP_CANCEL_SUBSCRIPTION,
  IPP_GET_NOTIFICATIONS,
  IPP_SEND_NOTIFICATIONS,
  IPP_GET_PRINT_SUPPORT_FILES = 0x0021,
  IPP_ENABLE_PRINTER,
  IPP_DISABLE_PRINTER,
  IPP_PAUSE_PRINTER_AFTER_CURRENT_JOB,
  IPP_HOLD_NEW_JOBS,
  IPP_RELEASE_HELD_NEW_JOBS,
  IPP_DEACTIVATE_PRINTER,
  IPP_ACTIVATE_PRINTER,
  IPP_RESTART_PRINTER,
  IPP_SHUTDOWN_PRINTER,
  IPP_STARTUP_PRINTER,
  IPP_REPROCESS_JOB,
  IPP_CANCEL_CURRENT_JOB,
  IPP_SUSPEND_CURRENT_JOB,
  IPP_RESUME_JOB,
  IPP_PROMOTE_JOB,
  IPP_SCHEDULE_JOB_AFTER,
  IPP_PRIVATE = 0x4000,
  CUPS_GET_DEFAULT,
  CUPS_GET_PRINTERS,
  CUPS_ADD_MODIFY_PRINTER,
  CUPS_DELETE_PRINTER,
  CUPS_GET_CLASSES,
  CUPS_ADD_MODIFY_CLASS,
  CUPS_DELETE_CLASS,
  CUPS_ACCEPT_JOBS,
  CUPS_REJECT_JOBS,
  CUPS_SET_DEFAULT,
  CUPS_GET_DEVICES,
  CUPS_GET_PPDS,
  CUPS_MOVE_JOB,
  CUPS_AUTHENTICATE_JOB
} ipp_op_t;

/* Old names for the operations */
#define CUPS_ADD_PRINTER	CUPS_ADD_MODIFY_PRINTER
#define CUPS_ADD_CLASS		CUPS_ADD_MODIFY_CLASS

typedef enum				/**** IPP status codes... ****/
{
  IPP_OK = 0x0000,
  IPP_OK_SUBST,
  IPP_OK_CONFLICT,
  IPP_OK_IGNORED_SUBSCRIPTIONS,
  IPP_OK_IGNORED_NOTIFICATIONS,
  IPP_OK_TOO_MANY_EVENTS,
  IPP_OK_BUT_CANCEL_SUBSCRIPTION,
  IPP_OK_EVENTS_COMPLETE,
  IPP_REDIRECTION_OTHER_SITE = 0x300,
  IPP_BAD_REQUEST = 0x0400,
  IPP_FORBIDDEN,
  IPP_NOT_AUTHENTICATED,
  IPP_NOT_AUTHORIZED,
  IPP_NOT_POSSIBLE,
  IPP_TIMEOUT,
  IPP_NOT_FOUND,
  IPP_GONE,
  IPP_REQUEST_ENTITY,
  IPP_REQUEST_VALUE,
  IPP_DOCUMENT_FORMAT,
  IPP_ATTRIBUTES,
  IPP_URI_SCHEME,
  IPP_CHARSET,
  IPP_CONFLICT,
  IPP_COMPRESSION_NOT_SUPPORTED,
  IPP_COMPRESSION_ERROR,
  IPP_DOCUMENT_FORMAT_ERROR,
  IPP_DOCUMENT_ACCESS_ERROR,
  IPP_ATTRIBUTES_NOT_SETTABLE,
  IPP_IGNORED_ALL_SUBSCRIPTIONS,
  IPP_TOO_MANY_SUBSCRIPTIONS,
  IPP_IGNORED_ALL_NOTIFICATIONS,
  IPP_PRINT_SUPPORT_FILE_NOT_FOUND,

  IPP_INTERNAL_ERROR = 0x0500,
  IPP_OPERATION_NOT_SUPPORTED,
  IPP_SERVICE_UNAVAILABLE,
  IPP_VERSION_NOT_SUPPORTED,
  IPP_DEVICE_ERROR,
  IPP_TEMPORARY_ERROR,
  IPP_NOT_ACCEPTING,
  IPP_PRINTER_BUSY,
  IPP_ERROR_JOB_CANCELLED,
  IPP_MULTIPLE_JOBS_NOT_SUPPORTED,
  IPP_PRINTER_IS_DEACTIVATED
} ipp_status_t;

typedef unsigned char ipp_uchar_t;	/**** Unsigned 8-bit integer/character ****/

/**** New in CUPS 1.2 ****/
typedef ssize_t	(*ipp_iocb_t)(void *, ipp_uchar_t *, size_t);
					/**** IPP IO Callback Function @since CUPS 1.2@ ****/

typedef union				/**** Request Header ****/
{
  struct				/* Any Header */
  {
    ipp_uchar_t	version[2];		/* Protocol version number */
    int		op_status;		/* Operation ID or status code*/
    int		request_id;		/* Request ID */
  }		any;

  struct				/* Operation Header */
  {
    ipp_uchar_t	version[2];		/* Protocol version number */
    ipp_op_t	operation_id;		/* Operation ID */
    int		request_id;		/* Request ID */
  }		op;

  struct				/* Status Header */
  {
    ipp_uchar_t	version[2];		/* Protocol version number */
    ipp_status_t status_code;		/* Status code */
    int		request_id;		/* Request ID */
  }		status;

  /**** New in CUPS 1.1.19 ****/
  struct				/* Event Header */
  {
    ipp_uchar_t	version[2];		/* Protocol version number */
    ipp_status_t status_code;		/* Status code */
    int		request_id;		/* Request ID */
  }		event;
} ipp_request_t;

/**** New in CUPS 1.1.19 ****/
typedef struct ipp_str ipp_t;

typedef union				/**** Attribute Value ****/
{
  int		integer;		/* Integer/enumerated value */

  char		boolean;		/* Boolean value */

  ipp_uchar_t	date[11];		/* Date/time value */

  struct
  {
    int		xres,			/* Horizontal resolution */
		yres;			/* Vertical resolution */
    ipp_res_t	units;			/* Resolution units */
  }		resolution;		/* Resolution value */

  struct
  {
    int		lower,			/* Lower value */
		upper;			/* Upper value */
  }		range;			/* Range of integers value */

  struct
  {
    char	*charset;		/* Character set */
    char	*text;			/* String */
  }		string;			/* String with language value */

  struct
  {
    int		length;			/* Length of attribute */
    void	*data;			/* Data in attribute */
  }		unknown;		/* Unknown attribute type */

/**** New in CUPS 1.1.19 ****/
  ipp_t		*collection;		/* Collection value */
} ipp_value_t;

typedef struct ipp_attribute_s		/**** Attribute ****/
{
  struct ipp_attribute_s *next;		/* Next attribute in list */
  ipp_tag_t	group_tag,		/* Job/Printer/Operation group tag */
		value_tag;		/* What type of value is it? */
  char		*name;			/* Name of attribute */
  int		num_values;		/* Number of values */
  ipp_value_t	values[1];		/* Values */
} ipp_attribute_t;

struct ipp_str				/**** IPP Request/Response/Notification ****/
{
  ipp_state_t	state;			/* State of request */
  ipp_request_t	request;		/* Request header */
  ipp_attribute_t *attrs,		/* Attributes */
		*last,			/* Last attribute in list */
		*current;		/* Current attribute (for read/write) */
  ipp_tag_t	curtag;			/* Current attribute group tag */

/**** New in CUPS 1.2 ****/
  ipp_attribute_t *prev;		/* Previous attribute (for read) */
};


/*
 * Prototypes...
 */

extern ipp_attribute_t	*ippAddBoolean(ipp_t *ipp, ipp_tag_t group,
			               const char *name, char value);
extern ipp_attribute_t	*ippAddBooleans(ipp_t *ipp, ipp_tag_t group,
			                const char *name, int num_values,
					const char *values);
extern ipp_attribute_t	*ippAddDate(ipp_t *ipp, ipp_tag_t group,
			            const char *name, const ipp_uchar_t *value);
extern ipp_attribute_t	*ippAddInteger(ipp_t *ipp, ipp_tag_t group,
			               ipp_tag_t type, const char *name,
				       int value);
extern ipp_attribute_t	*ippAddIntegers(ipp_t *ipp, ipp_tag_t group,
			                ipp_tag_t type, const char *name,
					int num_values, const int *values);
extern ipp_attribute_t	*ippAddRange(ipp_t *ipp, ipp_tag_t group,
			             const char *name, int lower, int upper);
extern ipp_attribute_t	*ippAddRanges(ipp_t *ipp, ipp_tag_t group,
			              const char *name, int num_values,
				      const int *lower, const int *upper);
extern ipp_attribute_t	*ippAddResolution(ipp_t *ipp, ipp_tag_t group,
			                  const char *name, ipp_res_t units,
					  int xres, int yres);
extern ipp_attribute_t	*ippAddResolutions(ipp_t *ipp, ipp_tag_t group,
			                   const char *name, int num_values,
					   ipp_res_t units, const int *xres,
					   const int *yres);
extern ipp_attribute_t	*ippAddSeparator(ipp_t *ipp);
extern ipp_attribute_t	*ippAddString(ipp_t *ipp, ipp_tag_t group,
			              ipp_tag_t type, const char *name,
				      const char *charset, const char *value);
extern ipp_attribute_t	*ippAddStrings(ipp_t *ipp, ipp_tag_t group,
			               ipp_tag_t type, const char *name,
				       int num_values, const char *charset,
				       const char * const *values);
extern time_t		ippDateToTime(const ipp_uchar_t *date);
extern void		ippDelete(ipp_t *ipp);
extern const char	*ippErrorString(ipp_status_t error);
extern ipp_attribute_t	*ippFindAttribute(ipp_t *ipp, const char *name,
			                  ipp_tag_t type);
extern ipp_attribute_t	*ippFindNextAttribute(ipp_t *ipp, const char *name,
			                      ipp_tag_t type);
extern size_t		ippLength(ipp_t *ipp);
extern ipp_t		*ippNew(void);
extern ipp_state_t	ippRead(http_t *http, ipp_t *ipp);
extern const ipp_uchar_t *ippTimeToDate(time_t t);
extern ipp_state_t	ippWrite(http_t *http, ipp_t *ipp);
extern int		ippPort(void);
extern void		ippSetPort(int p);

/**** New in CUPS 1.1.19 ****/
extern ipp_attribute_t	*ippAddCollection(ipp_t *ipp, ipp_tag_t group,
			                  const char *name, ipp_t *value);
extern ipp_attribute_t	*ippAddCollections(ipp_t *ipp, ipp_tag_t group,
			                   const char *name, int num_values,
					   const ipp_t **values);
extern void		ippDeleteAttribute(ipp_t *ipp, ipp_attribute_t *attr);
extern ipp_state_t	ippReadFile(int fd, ipp_t *ipp);
extern ipp_state_t	ippWriteFile(int fd, ipp_t *ipp);

/**** New in CUPS 1.2 ****/
extern ipp_attribute_t	*ippAddOctetString(ipp_t *ipp, ipp_tag_t group,
			                   const char *name,
					   const void *data, int datalen);
extern ipp_status_t	ippErrorValue(const char *name);
extern ipp_t		*ippNewRequest(ipp_op_t op);
extern const char	*ippOpString(ipp_op_t op);
extern ipp_op_t		ippOpValue(const char *name);
extern ipp_state_t	ippReadIO(void *src, ipp_iocb_t cb, int blocking,
			          ipp_t *parent, ipp_t *ipp);
extern ipp_state_t	ippWriteIO(void *dst, ipp_iocb_t cb, int blocking,
			           ipp_t *parent, ipp_t *ipp);


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

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

/*
 * End of "$Id: ipp.h 5090 2006-02-08 17:08:01Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
bd7854cb	2	* "$Id: ipp.h 5090 2006-02-08 17:08:01Z mike $"
ef416fc2	3	*
	4	* Internet Printing Protocol definitions for the Common UNIX Printing
	5	* System (CUPS).
	6	*
	7	* Copyright 1997-2006 by Easy Software Products.
	8	*
	9	* These coded instructions, statements, and computer programs are the
	10	* property of Easy Software Products and are protected by Federal
	11	* copyright law. Distribution and use rights are outlined in the file
	12	* "LICENSE.txt" which should have been included with this file. If this
	13	* file is missing or damaged please contact Easy Software Products
	14	* at:
	15	*
	16	* Attn: CUPS Licensing Information
	17	* Easy Software Products
	18	* 44141 Airport View Drive, Suite 204
	19	* Hollywood, Maryland 20636 USA
	20	*
	21	* Voice: (301) 373-9600
	22	* EMail: cups-info@cups.org
	23	* WWW: http://www.cups.org
	24	*
	25	* This file is subject to the Apple OS-Developed Software exception.
	26	*/
	27
	28	#ifndef _CUPS_IPP_H_
	29	# define _CUPS_IPP_H_
	30
	31	/*
	32	* Include necessary headers...
	33	*/
	34
	35	# include "http.h"
	36
	37
	38	/*
	39	* C++ magic...
	40	*/
	41
	42	# ifdef __cplusplus
	43	extern "C" {
	44	# endif /* __cplusplus */
	45
	46
	47	/*
	48	* IPP version string...
	49	*/
	50
	51	# define IPP_VERSION "\001\001"
	52
	53	/*
	54	* IPP registered port number...
	55	*
	56	* Note: Applications should never use IPP_PORT, but instead use the
	57	* ippPort() function to allow overrides via the IPP_PORT environment
	58	* variable and services file if needed!
	59	*/
	60
	61	# define IPP_PORT 631
	62
	63	/*
	64	* Common limits...
	65	*/
	66
67	# define IPP_MAX_NAME 256
68	# define IPP_MAX_VALUES 8 /* Power-of-2 allocation increment */
69
70
71	/*
72	* Types and structures...
73	*/
74
fa73b229	75	typedef enum /** Format tags for attribute formats... **/
ef416fc2	76	{
	77	IPP_TAG_ZERO = 0x00,
	78	IPP_TAG_OPERATION,
	79	IPP_TAG_JOB,
	80	IPP_TAG_END,
	81	IPP_TAG_PRINTER,
	82	IPP_TAG_UNSUPPORTED_GROUP,
	83	IPP_TAG_SUBSCRIPTION,
	84	IPP_TAG_EVENT_NOTIFICATION,
	85	IPP_TAG_UNSUPPORTED_VALUE = 0x10,
	86	IPP_TAG_DEFAULT,
	87	IPP_TAG_UNKNOWN,
	88	IPP_TAG_NOVALUE,
	89	IPP_TAG_NOTSETTABLE = 0x15,
	90	IPP_TAG_DELETEATTR,
	91	IPP_TAG_ADMINDEFINE,
	92	IPP_TAG_INTEGER = 0x21,
	93	IPP_TAG_BOOLEAN,
	94	IPP_TAG_ENUM,
	95	IPP_TAG_STRING = 0x30,
	96	IPP_TAG_DATE,
	97	IPP_TAG_RESOLUTION,
	98	IPP_TAG_RANGE,
	99	IPP_TAG_BEGIN_COLLECTION,
	100	IPP_TAG_TEXTLANG,
	101	IPP_TAG_NAMELANG,
	102	IPP_TAG_END_COLLECTION,
	103	IPP_TAG_TEXT = 0x41,
	104	IPP_TAG_NAME,
	105	IPP_TAG_KEYWORD = 0x44,
	106	IPP_TAG_URI,
	107	IPP_TAG_URISCHEME,
	108	IPP_TAG_CHARSET,
	109	IPP_TAG_LANGUAGE,
	110	IPP_TAG_MIMETYPE,
	111	IPP_TAG_MEMBERNAME,
fa73b229	112	IPP_TAG_MASK = 0x7fffffff, /* Mask for copied attribute values */
fa73b229	113	IPP_TAG_COPY = -0x7fffffff-1 /* Bitflag for copied attribute values */
ef416fc2	114	} ipp_tag_t;
ef416fc2	115
fa73b229	116	typedef enum /** Resolution units... **/
ef416fc2	117	{
	118	IPP_RES_PER_INCH = 3,
	119	IPP_RES_PER_CM
	120	} ipp_res_t;
	121
fa73b229	122	typedef enum /** Finishings... **/
ef416fc2	123	{
	124	IPP_FINISHINGS_NONE = 3,
	125	IPP_FINISHINGS_STAPLE,
	126	IPP_FINISHINGS_PUNCH,
	127	IPP_FINISHINGS_COVER,
	128	IPP_FINISHINGS_BIND,
	129	IPP_FINISHINGS_SADDLE_STITCH,
	130	IPP_FINISHINGS_EDGE_STITCH,
	131	IPP_FINISHINGS_FOLD,
	132	IPP_FINISHINGS_TRIM,
	133	IPP_FINISHINGS_BALE,
	134	IPP_FINISHINGS_BOOKLET_MAKER,
	135	IPP_FINISHINGS_JOB_OFFSET,
	136	IPP_FINISHINGS_STAPLE_TOP_LEFT = 20,
	137	IPP_FINISHINGS_STAPLE_BOTTOM_LEFT,
	138	IPP_FINISHINGS_STAPLE_TOP_RIGHT,
	139	IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT,
	140	IPP_FINISHINGS_EDGE_STITCH_LEFT,
	141	IPP_FINISHINGS_EDGE_STITCH_TOP,
	142	IPP_FINISHINGS_EDGE_STITCH_RIGHT,
	143	IPP_FINISHINGS_EDGE_STITCH_BOTTOM,
	144	IPP_FINISHINGS_STAPLE_DUAL_LEFT,
	145	IPP_FINISHINGS_STAPLE_DUAL_TOP,
	146	IPP_FINISHINGS_STAPLE_DUAL_RIGHT,
	147	IPP_FINISHINGS_STAPLE_DUAL_BOTTOM,
	148	IPP_FINISHINGS_BIND_LEFT = 50,
	149	IPP_FINISHINGS_BIND_TOP,
	150	IPP_FINISHINGS_BIND_RIGHT,
	151	IPP_FINISHINGS_BIND_BOTTOM
	152	} ipp_finish_t;
	153
fa73b229	154	typedef enum /** Orientation... **/
ef416fc2	155	{
fa73b229	156	IPP_PORTRAIT = 3, /* No rotation */
	157	IPP_LANDSCAPE, /* 90 degrees counter-clockwise */
	158	IPP_REVERSE_LANDSCAPE, /* 90 degrees clockwise */
	159	IPP_REVERSE_PORTRAIT /* 180 degrees */
ef416fc2	160	} ipp_orient_t;
ef416fc2	161
fa73b229	162	typedef enum /** Qualities... **/
ef416fc2	163	{
	164	IPP_QUALITY_DRAFT = 3,
	165	IPP_QUALITY_NORMAL,
	166	IPP_QUALITY_HIGH
	167	} ipp_quality_t;
	168
fa73b229	169	typedef enum /**** Job States.... */
ef416fc2	170	{
	171	IPP_JOB_PENDING = 3,
	172	IPP_JOB_HELD,
	173	IPP_JOB_PROCESSING,
	174	IPP_JOB_STOPPED,
	175	IPP_JOB_CANCELLED,
	176	IPP_JOB_ABORTED,
	177	IPP_JOB_COMPLETED
	178	} ipp_jstate_t;
	179
fa73b229	180	typedef enum /**** Printer States.... */
ef416fc2	181	{
	182	IPP_PRINTER_IDLE = 3,
	183	IPP_PRINTER_PROCESSING,
	184	IPP_PRINTER_STOPPED
	185	} ipp_pstate_t;
	186
fa73b229	187	typedef enum /** IPP states... **/
ef416fc2	188	{
fa73b229	189	IPP_ERROR = -1, /* An error occurred */
	190	IPP_IDLE, /* Nothing is happening/request completed */
	191	IPP_HEADER, /* The request header needs to be sent/received */
	192	IPP_ATTRIBUTE, /* One or more attributes need to be sent/received */
	193	IPP_DATA /* IPP request data needs to be sent/received */
ef416fc2	194	} ipp_state_t;
ef416fc2	195
fa73b229	196	typedef enum /** IPP operations... **/
ef416fc2	197	{
	198	IPP_PRINT_JOB = 0x0002,
	199	IPP_PRINT_URI,
	200	IPP_VALIDATE_JOB,
	201	IPP_CREATE_JOB,
	202	IPP_SEND_DOCUMENT,
	203	IPP_SEND_URI,
	204	IPP_CANCEL_JOB,
	205	IPP_GET_JOB_ATTRIBUTES,
	206	IPP_GET_JOBS,
	207	IPP_GET_PRINTER_ATTRIBUTES,
	208	IPP_HOLD_JOB,
	209	IPP_RELEASE_JOB,
	210	IPP_RESTART_JOB,
	211	IPP_PAUSE_PRINTER = 0x0010,
	212	IPP_RESUME_PRINTER,
	213	IPP_PURGE_JOBS,
	214	IPP_SET_PRINTER_ATTRIBUTES,
	215	IPP_SET_JOB_ATTRIBUTES,
	216	IPP_GET_PRINTER_SUPPORTED_VALUES,
	217	IPP_CREATE_PRINTER_SUBSCRIPTION,
	218	IPP_CREATE_JOB_SUBSCRIPTION,
	219	IPP_GET_SUBSCRIPTION_ATTRIBUTES,
	220	IPP_GET_SUBSCRIPTIONS,
	221	IPP_RENEW_SUBSCRIPTION,
	222	IPP_CANCEL_SUBSCRIPTION,
	223	IPP_GET_NOTIFICATIONS,
	224	IPP_SEND_NOTIFICATIONS,
	225	IPP_GET_PRINT_SUPPORT_FILES = 0x0021,
	226	IPP_ENABLE_PRINTER,
	227	IPP_DISABLE_PRINTER,
	228	IPP_PAUSE_PRINTER_AFTER_CURRENT_JOB,
	229	IPP_HOLD_NEW_JOBS,
	230	IPP_RELEASE_HELD_NEW_JOBS,
	231	IPP_DEACTIVATE_PRINTER,
	232	IPP_ACTIVATE_PRINTER,
	233	IPP_RESTART_PRINTER,
	234	IPP_SHUTDOWN_PRINTER,
	235	IPP_STARTUP_PRINTER,
	236	IPP_REPROCESS_JOB,
	237	IPP_CANCEL_CURRENT_JOB,
	238	IPP_SUSPEND_CURRENT_JOB,
	239	IPP_RESUME_JOB,
	240	IPP_PROMOTE_JOB,
	241	IPP_SCHEDULE_JOB_AFTER,
	242	IPP_PRIVATE = 0x4000,
	243	CUPS_GET_DEFAULT,
	244	CUPS_GET_PRINTERS,
fa73b229	245	CUPS_ADD_MODIFY_PRINTER,
ef416fc2	246	CUPS_DELETE_PRINTER,
ef416fc2	247	CUPS_GET_CLASSES,
fa73b229	248	CUPS_ADD_MODIFY_CLASS,
ef416fc2	249	CUPS_DELETE_CLASS,
	250	CUPS_ACCEPT_JOBS,
	251	CUPS_REJECT_JOBS,
	252	CUPS_SET_DEFAULT,
	253	CUPS_GET_DEVICES,
	254	CUPS_GET_PPDS,
	255	CUPS_MOVE_JOB,
	256	CUPS_AUTHENTICATE_JOB
	257	} ipp_op_t;
	258
fa73b229	259	/* Old names for the operations */
	260	#define CUPS_ADD_PRINTER CUPS_ADD_MODIFY_PRINTER
	261	#define CUPS_ADD_CLASS CUPS_ADD_MODIFY_CLASS
	262
	263	typedef enum /** IPP status codes... **/
ef416fc2	264	{
	265	IPP_OK = 0x0000,
	266	IPP_OK_SUBST,
	267	IPP_OK_CONFLICT,
	268	IPP_OK_IGNORED_SUBSCRIPTIONS,
	269	IPP_OK_IGNORED_NOTIFICATIONS,
	270	IPP_OK_TOO_MANY_EVENTS,
	271	IPP_OK_BUT_CANCEL_SUBSCRIPTION,
bd7854cb	272	IPP_OK_EVENTS_COMPLETE,
ef416fc2	273	IPP_REDIRECTION_OTHER_SITE = 0x300,
	274	IPP_BAD_REQUEST = 0x0400,
	275	IPP_FORBIDDEN,
	276	IPP_NOT_AUTHENTICATED,
	277	IPP_NOT_AUTHORIZED,
	278	IPP_NOT_POSSIBLE,
	279	IPP_TIMEOUT,
	280	IPP_NOT_FOUND,
	281	IPP_GONE,
	282	IPP_REQUEST_ENTITY,
	283	IPP_REQUEST_VALUE,
	284	IPP_DOCUMENT_FORMAT,
	285	IPP_ATTRIBUTES,
	286	IPP_URI_SCHEME,
	287	IPP_CHARSET,
	288	IPP_CONFLICT,
	289	IPP_COMPRESSION_NOT_SUPPORTED,
	290	IPP_COMPRESSION_ERROR,
	291	IPP_DOCUMENT_FORMAT_ERROR,
	292	IPP_DOCUMENT_ACCESS_ERROR,
	293	IPP_ATTRIBUTES_NOT_SETTABLE,
	294	IPP_IGNORED_ALL_SUBSCRIPTIONS,
	295	IPP_TOO_MANY_SUBSCRIPTIONS,
	296	IPP_IGNORED_ALL_NOTIFICATIONS,
	297	IPP_PRINT_SUPPORT_FILE_NOT_FOUND,
	298
	299	IPP_INTERNAL_ERROR = 0x0500,
	300	IPP_OPERATION_NOT_SUPPORTED,
	301	IPP_SERVICE_UNAVAILABLE,
	302	IPP_VERSION_NOT_SUPPORTED,
	303	IPP_DEVICE_ERROR,
	304	IPP_TEMPORARY_ERROR,
	305	IPP_NOT_ACCEPTING,
	306	IPP_PRINTER_BUSY,
	307	IPP_ERROR_JOB_CANCELLED,
	308	IPP_MULTIPLE_JOBS_NOT_SUPPORTED,
	309	IPP_PRINTER_IS_DEACTIVATED
	310	} ipp_status_t;
	311
fa73b229	312	typedef unsigned char ipp_uchar_t; /** Unsigned 8-bit integer/character **/
ef416fc2	313
a4d04587	314	/** New in CUPS 1.2 **/
	315	typedef ssize_t (ipp_iocb_t)(void , ipp_uchar_t *, size_t);
	316	/** IPP IO Callback Function @since CUPS 1.2@ **/
ef416fc2	317
fa73b229	318	typedef union /** Request Header **/
ef416fc2	319	{
fa73b229	320	struct /* Any Header */
ef416fc2	321	{
fa73b229	322	ipp_uchar_t version[2]; /* Protocol version number */
	323	int op_status; /* Operation ID or status code*/
	324	int request_id; /* Request ID */
ef416fc2	325	} any;
ef416fc2	326
fa73b229	327	struct /* Operation Header */
ef416fc2	328	{
fa73b229	329	ipp_uchar_t version[2]; /* Protocol version number */
	330	ipp_op_t operation_id; /* Operation ID */
	331	int request_id; /* Request ID */
ef416fc2	332	} op;
ef416fc2	333
fa73b229	334	struct /* Status Header */
ef416fc2	335	{
fa73b229	336	ipp_uchar_t version[2]; /* Protocol version number */
	337	ipp_status_t status_code; /* Status code */
	338	int request_id; /* Request ID */
ef416fc2	339	} status;
	340
	341	/** New in CUPS 1.1.19 **/
fa73b229	342	struct /* Event Header */
ef416fc2	343	{
fa73b229	344	ipp_uchar_t version[2]; /* Protocol version number */
	345	ipp_status_t status_code; /* Status code */
	346	int request_id; /* Request ID */
ef416fc2	347	} event;
	348	} ipp_request_t;
	349
	350	/** New in CUPS 1.1.19 **/
	351	typedef struct ipp_str ipp_t;
	352
fa73b229	353	typedef union /** Attribute Value **/
ef416fc2	354	{
fa73b229	355	int integer; /* Integer/enumerated value */
ef416fc2	356
fa73b229	357	char boolean; /* Boolean value */
ef416fc2	358
fa73b229	359	ipp_uchar_t date[11]; /* Date/time value */
ef416fc2	360
	361	struct
	362	{
fa73b229	363	int xres, /* Horizontal resolution */
	364	yres; /* Vertical resolution */
	365	ipp_res_t units; /* Resolution units */
	366	} resolution; /* Resolution value */
ef416fc2	367
	368	struct
	369	{
fa73b229	370	int lower, /* Lower value */
	371	upper; /* Upper value */
	372	} range; /* Range of integers value */
ef416fc2	373
	374	struct
	375	{
fa73b229	376	char charset; / Character set */
	377	char text; / String */
	378	} string; /* String with language value */
ef416fc2	379
	380	struct
	381	{
fa73b229	382	int length; /* Length of attribute */
	383	void data; / Data in attribute */
	384	} unknown; /* Unknown attribute type */
ef416fc2	385
ef416fc2	386	/** New in CUPS 1.1.19 **/
fa73b229	387	ipp_t collection; / Collection value */
ef416fc2	388	} ipp_value_t;
ef416fc2	389
fa73b229	390	typedef struct ipp_attribute_s /** Attribute **/
ef416fc2	391	{
fa73b229	392	struct ipp_attribute_s next; / Next attribute in list */
	393	ipp_tag_t group_tag, /* Job/Printer/Operation group tag */
	394	value_tag; /* What type of value is it? */
	395	char name; / Name of attribute */
	396	int num_values; /* Number of values */
	397	ipp_value_t values[1]; /* Values */
ef416fc2	398	} ipp_attribute_t;
ef416fc2	399
fa73b229	400	struct ipp_str /** IPP Request/Response/Notification **/
ef416fc2	401	{
fa73b229	402	ipp_state_t state; /* State of request */
	403	ipp_request_t request; /* Request header */
	404	ipp_attribute_t attrs, / Attributes */
	405	last, / Last attribute in list */
	406	current; / Current attribute (for read/write) */
	407	ipp_tag_t curtag; /* Current attribute group tag */
ef416fc2	408
ef416fc2	409	/** New in CUPS 1.2 **/
fa73b229	410	ipp_attribute_t prev; / Previous attribute (for read) */
ef416fc2	411	};
	412
	413
	414	/*
	415	* Prototypes...
	416	*/
	417
fa73b229	418	extern ipp_attribute_t ippAddBoolean(ipp_t ipp, ipp_tag_t group,
	419	const char *name, char value);
	420	extern ipp_attribute_t ippAddBooleans(ipp_t ipp, ipp_tag_t group,
	421	const char *name, int num_values,
	422	const char *values);
	423	extern ipp_attribute_t ippAddDate(ipp_t ipp, ipp_tag_t group,
	424	const char name, const ipp_uchar_t value);
	425	extern ipp_attribute_t ippAddInteger(ipp_t ipp, ipp_tag_t group,
	426	ipp_tag_t type, const char *name,
	427	int value);
	428	extern ipp_attribute_t ippAddIntegers(ipp_t ipp, ipp_tag_t group,
	429	ipp_tag_t type, const char *name,
	430	int num_values, const int *values);
	431	extern ipp_attribute_t ippAddRange(ipp_t ipp, ipp_tag_t group,
	432	const char *name, int lower, int upper);
	433	extern ipp_attribute_t ippAddRanges(ipp_t ipp, ipp_tag_t group,
	434	const char *name, int num_values,
	435	const int lower, const int upper);
	436	extern ipp_attribute_t ippAddResolution(ipp_t ipp, ipp_tag_t group,
	437	const char *name, ipp_res_t units,
	438	int xres, int yres);
	439	extern ipp_attribute_t ippAddResolutions(ipp_t ipp, ipp_tag_t group,
	440	const char *name, int num_values,
	441	ipp_res_t units, const int *xres,
	442	const int *yres);
ef416fc2	443	extern ipp_attribute_t ippAddSeparator(ipp_t ipp);
fa73b229	444	extern ipp_attribute_t ippAddString(ipp_t ipp, ipp_tag_t group,
	445	ipp_tag_t type, const char *name,
	446	const char charset, const char value);
	447	extern ipp_attribute_t ippAddStrings(ipp_t ipp, ipp_tag_t group,
	448	ipp_tag_t type, const char *name,
	449	int num_values, const char *charset,
	450	const char * const *values);
ef416fc2	451	extern time_t ippDateToTime(const ipp_uchar_t *date);
	452	extern void ippDelete(ipp_t *ipp);
	453	extern const char *ippErrorString(ipp_status_t error);
	454	extern ipp_attribute_t ippFindAttribute(ipp_t ipp, const char *name,
	455	ipp_tag_t type);
	456	extern ipp_attribute_t ippFindNextAttribute(ipp_t ipp, const char *name,
	457	ipp_tag_t type);
	458	extern size_t ippLength(ipp_t *ipp);
	459	extern ipp_t *ippNew(void);
	460	extern ipp_state_t ippRead(http_t http, ipp_t ipp);
	461	extern const ipp_uchar_t *ippTimeToDate(time_t t);
	462	extern ipp_state_t ippWrite(http_t http, ipp_t ipp);
	463	extern int ippPort(void);
	464	extern void ippSetPort(int p);
	465
	466	/** New in CUPS 1.1.19 **/
fa73b229	467	extern ipp_attribute_t ippAddCollection(ipp_t ipp, ipp_tag_t group,
	468	const char name, ipp_t value);
	469	extern ipp_attribute_t ippAddCollections(ipp_t ipp, ipp_tag_t group,
	470	const char *name, int num_values,
	471	const ipp_t **values);
ef416fc2	472	extern void ippDeleteAttribute(ipp_t ipp, ipp_attribute_t attr);
ef416fc2	473	extern ipp_state_t ippReadFile(int fd, ipp_t *ipp);
ef416fc2	474	extern ipp_state_t ippWriteFile(int fd, ipp_t *ipp);
ef416fc2	475
	476	/** New in CUPS 1.2 **/
	477	extern ipp_attribute_t ippAddOctetString(ipp_t ipp, ipp_tag_t group,
	478	const char *name,
	479	const void *data, int datalen);
	480	extern ipp_status_t ippErrorValue(const char *name);
	481	extern ipp_t *ippNewRequest(ipp_op_t op);
	482	extern const char *ippOpString(ipp_op_t op);
	483	extern ipp_op_t ippOpValue(const char *name);
a4d04587	484	extern ipp_state_t ippReadIO(void *src, ipp_iocb_t cb, int blocking,
	485	ipp_t parent, ipp_t ipp);
	486	extern ipp_state_t ippWriteIO(void *dst, ipp_iocb_t cb, int blocking,
	487	ipp_t parent, ipp_t ipp);
ef416fc2	488
ef416fc2	489
	490	/*
	491	* C++ magic...
	492	*/
	493
	494	# ifdef __cplusplus
	495	}
	496	# endif /* __cplusplus */
	497	#endif /* !_CUPS_IPP_H_ */
	498
	499	/*
bd7854cb	500	* End of "$Id: ipp.h 5090 2006-02-08 17:08:01Z mike $".
ef416fc2	501	*/