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

/*
 * "$Id: cups.h 8781 2009-08-28 17:34:54Z mike $"
 *
 *   API definitions for CUPS.
 *
 *   Copyright 2007-2011 by Apple Inc.
 *   Copyright 1997-2007 by Easy Software Products.
 *
 *   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/".
 *
 *   This file is subject to the Apple OS-Developed Software exception.
 */

#ifndef _CUPS_CUPS_H_
#  define _CUPS_CUPS_H_

/*
 * Include necessary headers...
 */

#  include <sys/types.h>
#  if defined(WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
#    define __CUPS_SSIZE_T_DEFINED
#    include <stddef.h>
/* Windows does not support the ssize_t type, so map it to off_t... */
typedef off_t ssize_t;			/* @private@ */
#  endif /* WIN32 && !__CUPS_SSIZE_T_DEFINED */

#  include "file.h"
#  include "ipp.h"
#  include "language.h"


/*
 * With GCC 3.0 and higher, we can mark old APIs "deprecated" so you get
 * a warning at compile-time.
 */

#  if defined(__GNUC__) && __GNUC__ > 2
#    define _CUPS_DEPRECATED __attribute__ ((__deprecated__))
#  else
#    define _CUPS_DEPRECATED
#  endif /* __GNUC__ && __GNUC__ > 2 */


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

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


/*
 * Constants...
 */

#  define CUPS_VERSION		1.0599
#  define CUPS_VERSION_MAJOR	1
#  define CUPS_VERSION_MINOR	6
#  define CUPS_VERSION_PATCH	-1

#  define CUPS_BC_FD		3	/* Back-channel file descriptor for select/poll */
#  define CUPS_DATE_ANY		(time_t)-1
#  define CUPS_EXCLUDE_NONE	(const char *)0
#  define CUPS_FORMAT_AUTO	"application/octet-stream"
#  define CUPS_FORMAT_COMMAND	"application/vnd.cups-command"
#  define CUPS_FORMAT_PDF	"application/pdf"
#  define CUPS_FORMAT_POSTSCRIPT "application/postscript"
#  define CUPS_FORMAT_RAW	"application/vnd.cups-raw"
#  define CUPS_FORMAT_TEXT	"text/plain"
#  define CUPS_HTTP_DEFAULT	(http_t *)0
#  define CUPS_INCLUDE_ALL	(const char *)0
#  define CUPS_JOBID_ALL	-1
#  define CUPS_JOBID_CURRENT	0
#  define CUPS_LENGTH_VARIABLE	(ssize_t)0
#  define CUPS_TIMEOUT_DEFAULT	0
#  define CUPS_WHICHJOBS_ALL	-1
#  define CUPS_WHICHJOBS_ACTIVE	0
#  define CUPS_WHICHJOBS_COMPLETED 1


/*
 * Types and structures...
 */

typedef unsigned cups_ptype_t;		/**** Printer type/capability bits ****/
enum cups_ptype_e			/**** Printer type/capability bit constants ****/
{					/* Not a typedef'd enum so we can OR */
  CUPS_PRINTER_LOCAL = 0x0000,		/* Local printer or class */
  CUPS_PRINTER_CLASS = 0x0001,		/* Printer class */
  CUPS_PRINTER_REMOTE = 0x0002,		/* Remote printer or class */
  CUPS_PRINTER_BW = 0x0004,		/* Can do B&W printing */
  CUPS_PRINTER_COLOR = 0x0008,		/* Can do color printing */
  CUPS_PRINTER_DUPLEX = 0x0010,		/* Can do duplexing */
  CUPS_PRINTER_STAPLE = 0x0020,		/* Can staple output */
  CUPS_PRINTER_COPIES = 0x0040,		/* Can do copies */
  CUPS_PRINTER_COLLATE = 0x0080,	/* Can collage copies */
  CUPS_PRINTER_PUNCH = 0x0100,		/* Can punch output */
  CUPS_PRINTER_COVER = 0x0200,		/* Can cover output */
  CUPS_PRINTER_BIND = 0x0400,		/* Can bind output */
  CUPS_PRINTER_SORT = 0x0800,		/* Can sort output */
  CUPS_PRINTER_SMALL = 0x1000,		/* Can do Letter/Legal/A4 */
  CUPS_PRINTER_MEDIUM = 0x2000,		/* Can do Tabloid/B/C/A3/A2 */
  CUPS_PRINTER_LARGE = 0x4000,		/* Can do D/E/A1/A0 */
  CUPS_PRINTER_VARIABLE = 0x8000,	/* Can do variable sizes */
  CUPS_PRINTER_IMPLICIT = 0x10000,	/* Implicit class */
  CUPS_PRINTER_DEFAULT = 0x20000,	/* Default printer on network */
  CUPS_PRINTER_FAX = 0x40000,		/* Fax queue */
  CUPS_PRINTER_REJECTING = 0x80000,	/* Printer is rejecting jobs */
  CUPS_PRINTER_DELETE = 0x100000,	/* Delete printer @since CUPS 1.2/Mac OS X 10.5@ */
  CUPS_PRINTER_NOT_SHARED = 0x200000,	/* Printer is not shared @since CUPS 1.2/Mac OS X 10.5@ */
  CUPS_PRINTER_AUTHENTICATED = 0x400000,/* Printer requires authentication @since CUPS 1.2/Mac OS X 10.5@ */
  CUPS_PRINTER_COMMANDS = 0x800000,	/* Printer supports maintenance commands @since CUPS 1.2/Mac OS X 10.5@ */
  CUPS_PRINTER_DISCOVERED = 0x1000000,	/* Printer was automatically discovered and added @since CUPS 1.3/Mac OS X 10.5@ */
  CUPS_PRINTER_SCANNER = 0x2000000,	/* Scanner-only device @since CUPS 1.4/Mac OS X 10.6@ */
  CUPS_PRINTER_MFP = 0x4000000,		/* Printer with scanning capabilities @since CUPS 1.4/Mac OS X 10.6@ */
  CUPS_PRINTER_OPTIONS = 0x6fffc	/* ~(CLASS | REMOTE | IMPLICIT | DEFAULT | FAX | REJECTING | DELETE | NOT_SHARED | AUTHENTICATED | COMMANDS | DISCOVERED) @private@ */
};

typedef const char *(*cups_password_cb_t)(const char *prompt);
					/**** Password callback ****/

typedef const char *(*cups_password_cb2_t)(const char *prompt, http_t *http,
					   const char *method,
					   const char *resource,
					   void *user_data);
					/**** New password callback @since CUPS 1.4/Mac OS X 10.6@ ****/

typedef void (*cups_device_cb_t)(const char *device_class,
                                 const char *device_id, const char *device_info,
                                 const char *device_make_and_model,
                                 const char *device_uri,
				 const char *device_location, void *user_data);
					/**** Device callback @since CUPS 1.4/Mac OS X 10.6@ ****/

typedef struct cups_option_s		/**** Printer Options ****/
{
  char		*name;			/* Name of option */
  char		*value;			/* Value of option */
} cups_option_t;

typedef struct cups_dest_s		/**** Destination ****/
{
  char		*name,			/* Printer or class name */
		*instance;		/* Local instance name or NULL */
  int		is_default;		/* Is this printer the default? */
  int		num_options;		/* Number of options */
  cups_option_t	*options;		/* Options */
} cups_dest_t;

typedef struct cups_job_s		/**** Job ****/
{
  int		id;			/* The job ID */
  char		*dest;			/* Printer or class name */
  char		*title;			/* Title/job name */
  char		*user;			/* User the submitted the job */
  char		*format;		/* Document format */
  ipp_jstate_t	state;			/* Job state */
  int		size;			/* Size in kilobytes */
  int		priority;		/* Priority (1-100) */
  time_t	completed_time;		/* Time the job was completed */
  time_t	creation_time;		/* Time the job was created */
  time_t	processing_time;	/* Time the job was processed */
} cups_job_t;

typedef int (*cups_client_cert_cb_t)(http_t *http, void *tls,
				     cups_array_t *distinguished_names,
				     void *user_data);
					/**** Client credentials callback @since CUPS 1.5/Mac OS X 10.7@ ****/

typedef int (*cups_server_cert_cb_t)(http_t *http, void *tls,
				     cups_array_t *certs, void *user_data);
					/**** Server credentials callback @since CUPS 1.5/Mac OS X 10.7@ ****/


/*
 * Functions...
 */

extern int		cupsCancelJob(const char *name, int job_id);
extern ipp_t		*cupsDoFileRequest(http_t *http, ipp_t *request,
			                   const char *resource,
					   const char *filename);
extern ipp_t		*cupsDoRequest(http_t *http, ipp_t *request,
			               const char *resource);
extern http_encryption_t cupsEncryption(void);
extern void		cupsFreeJobs(int num_jobs, cups_job_t *jobs);
extern int		cupsGetClasses(char ***classes) _CUPS_DEPRECATED;
extern const char	*cupsGetDefault(void);
extern int		cupsGetJobs(cups_job_t **jobs, const char *name,
			            int myjobs, int whichjobs);
extern const char	*cupsGetPPD(const char *name);
extern int		cupsGetPrinters(char ***printers) _CUPS_DEPRECATED;
extern ipp_status_t	cupsLastError(void);
extern int		cupsPrintFile(const char *name, const char *filename,
			              const char *title, int num_options,
				      cups_option_t *options);
extern int		cupsPrintFiles(const char *name, int num_files,
			               const char **files, const char *title,
				       int num_options, cups_option_t *options);
extern char		*cupsTempFile(char *filename, int len) _CUPS_DEPRECATED;
extern int		cupsTempFd(char *filename, int len);

extern int		cupsAddDest(const char *name, const char *instance,
			            int num_dests, cups_dest_t **dests);
extern void		cupsFreeDests(int num_dests, cups_dest_t *dests);
extern cups_dest_t	*cupsGetDest(const char *name, const char *instance,
			             int num_dests, cups_dest_t *dests);
extern int		cupsGetDests(cups_dest_t **dests);
extern void		cupsSetDests(int num_dests, cups_dest_t *dests);

extern int		cupsAddOption(const char *name, const char *value,
			              int num_options, cups_option_t **options);
extern void		cupsEncodeOptions(ipp_t *ipp, int num_options,
					  cups_option_t *options);
extern void		cupsFreeOptions(int num_options, cups_option_t *options);
extern const char	*cupsGetOption(const char *name, int num_options,
			               cups_option_t *options);
extern int		cupsParseOptions(const char *arg, int num_options,
			                 cups_option_t **options);

extern const char	*cupsGetPassword(const char *prompt);
extern const char	*cupsServer(void);
extern void		cupsSetEncryption(http_encryption_t e);
extern void		cupsSetPasswordCB(cups_password_cb_t cb);
extern void		cupsSetServer(const char *server);
extern void		cupsSetUser(const char *user);
extern const char	*cupsUser(void);

/**** New in CUPS 1.1.20 ****/
extern int		cupsDoAuthentication(http_t *http, const char *method,
			                     const char *resource) _CUPS_API_1_1_20;
extern http_status_t	cupsGetFile(http_t *http, const char *resource,
			            const char *filename) _CUPS_API_1_1_20;
extern http_status_t	cupsGetFd(http_t *http, const char *resource, int fd);
extern http_status_t	cupsPutFile(http_t *http, const char *resource,
			            const char *filename) _CUPS_API_1_1_20;
extern http_status_t	cupsPutFd(http_t *http, const char *resource, int fd) _CUPS_API_1_1_20;

/**** New in CUPS 1.1.21 ****/
extern const char	*cupsGetDefault2(http_t *http) _CUPS_API_1_1_21;
extern int		cupsGetDests2(http_t *http, cups_dest_t **dests) _CUPS_API_1_1_21;
extern int		cupsGetJobs2(http_t *http, cups_job_t **jobs,
			             const char *name, int myjobs,
				     int whichjobs) _CUPS_API_1_1_21;
extern const char	*cupsGetPPD2(http_t *http, const char *name) _CUPS_API_1_1_21;
extern int		cupsPrintFile2(http_t *http, const char *name,
			               const char *filename,
				       const char *title, int num_options,
				       cups_option_t *options) _CUPS_API_1_1_21;
extern int		cupsPrintFiles2(http_t *http, const char *name,
			                int num_files, const char **files,
					const char *title, int num_options,
					cups_option_t *options) _CUPS_API_1_1_21;
extern int		cupsSetDests2(http_t *http, int num_dests,
			              cups_dest_t *dests) _CUPS_API_1_1_21;

/**** New in CUPS 1.2/Mac OS X 10.5 ****/
extern ssize_t		cupsBackChannelRead(char *buffer, size_t bytes,
			                    double timeout) _CUPS_API_1_2;
extern ssize_t		cupsBackChannelWrite(const char *buffer, size_t bytes,
			                     double timeout) _CUPS_API_1_2;
extern void		cupsEncodeOptions2(ipp_t *ipp, int num_options,
					   cups_option_t *options,
					   ipp_tag_t group_tag) _CUPS_API_1_2;
extern const char	*cupsLastErrorString(void) _CUPS_API_1_2;
extern char		*cupsNotifySubject(cups_lang_t *lang, ipp_t *event) _CUPS_API_1_2;
extern char		*cupsNotifyText(cups_lang_t *lang, ipp_t *event) _CUPS_API_1_2;
extern int		cupsRemoveOption(const char *name, int num_options,
			                 cups_option_t **options) _CUPS_API_1_2;
extern cups_file_t	*cupsTempFile2(char *filename, int len) _CUPS_API_1_2;

/**** New in CUPS 1.3/Mac OS X 10.5 ****/
extern ipp_t		*cupsDoIORequest(http_t *http, ipp_t *request,
			                 const char *resource, int infile,
					 int outfile) _CUPS_API_1_3;
extern char		*cupsGetServerPPD(http_t *http, const char *name) _CUPS_API_1_3;
extern int		cupsRemoveDest(const char *name,
			               const char *instance,
				       int num_dests, cups_dest_t **dests) _CUPS_API_1_3;
extern void		cupsSetDefaultDest(const char *name,
			                   const char *instance,
					   int num_dests,
					   cups_dest_t *dests) _CUPS_API_1_3;

/**** New in CUPS 1.4/Mac OS X 10.6 ****/
extern ipp_status_t	cupsCancelJob2(http_t *http, const char *name,
			               int job_id, int purge) _CUPS_API_1_4;
extern int		cupsCreateJob(http_t *http, const char *name,
				      const char *title, int num_options,
				      cups_option_t *options) _CUPS_API_1_4;
extern ipp_status_t	cupsFinishDocument(http_t *http,
			                   const char *name) _CUPS_API_1_4;
extern ipp_status_t	cupsGetDevices(http_t *http, int timeout,
			               const char *include_schemes,
			               const char *exclude_schemes,
				       cups_device_cb_t callback,
				       void *user_data) _CUPS_API_1_4;
extern cups_dest_t	*cupsGetNamedDest(http_t *http, const char *name,
			                  const char *instance) _CUPS_API_1_4;
extern const char	*cupsGetPassword2(const char *prompt, http_t *http,
					  const char *method,
					  const char *resource) _CUPS_API_1_4;
extern http_status_t	cupsGetPPD3(http_t *http, const char *name,
			            time_t *modtime, char *buffer,
				    size_t bufsize) _CUPS_API_1_4;
extern ipp_t		*cupsGetResponse(http_t *http,
			                 const char *resource) _CUPS_API_1_4;
extern ssize_t		cupsReadResponseData(http_t *http, char *buffer,
			                     size_t length) _CUPS_API_1_4;
extern http_status_t	cupsSendRequest(http_t *http, ipp_t *request,
			                const char *resource,
					size_t length) _CUPS_API_1_4;
extern void		cupsSetPasswordCB2(cups_password_cb2_t cb,
			                   void *user_data) _CUPS_API_1_4;
extern http_status_t	cupsStartDocument(http_t *http, const char *name,
			                  int job_id, const char *docname,
					  const char *format,
					  int last_document) _CUPS_API_1_4;
extern http_status_t	cupsWriteRequestData(http_t *http, const char *buffer,
			                     size_t length) _CUPS_API_1_4;

/**** New in CUPS 1.5 ****/
extern void		cupsSetClientCertCB(cups_client_cert_cb_t cb,
					    void *user_data) _CUPS_API_1_5;
extern int		cupsSetCredentials(cups_array_t *certs) _CUPS_API_1_5;
extern void		cupsSetServerCertCB(cups_server_cert_cb_t cb,
					    void *user_data) _CUPS_API_1_5;


#  ifdef __cplusplus
}
#  endif /* __cplusplus */

#endif /* !_CUPS_CUPS_H_ */

/*
 * End of "$Id: cups.h 8781 2009-08-28 17:34:54Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
18ecb428	2	* "$Id: cups.h 8781 2009-08-28 17:34:54Z mike $"
ef416fc2	3	*
aaf19ab0	4	* API definitions for CUPS.
ef416fc2	5	*
321d8d57	6	* Copyright 2007-2011 by Apple Inc.
b86bc4cf	7	* Copyright 1997-2007 by Easy Software Products.
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	* This file is subject to the Apple OS-Developed Software exception.
	16	*/
	17
	18	#ifndef _CUPS_CUPS_H_
	19	# define _CUPS_CUPS_H_
	20
	21	/*
	22	* Include necessary headers...
	23	*/
	24
b86bc4cf	25	# include <sys/types.h>
	26	# if defined(WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
	27	# define __CUPS_SSIZE_T_DEFINED
6d2f911b	28	# include <stddef.h>
b86bc4cf	29	/* Windows does not support the ssize_t type, so map it to off_t... */
	30	typedef off_t ssize_t; /* @private@ */
	31	# endif /* WIN32 && !__CUPS_SSIZE_T_DEFINED */
	32
aaf19ab0	33	# include "file.h"
ef416fc2	34	# include "ipp.h"
fa73b229	35	# include "language.h"
fa73b229	36
ef416fc2	37
	38	/*
	39	* With GCC 3.0 and higher, we can mark old APIs "deprecated" so you get
fa73b229	40	* a warning at compile-time.
ef416fc2	41	*/
	42
	43	# if defined(__GNUC__) && __GNUC__ > 2
	44	# define _CUPS_DEPRECATED __attribute__ ((__deprecated__))
	45	# else
	46	# define _CUPS_DEPRECATED
	47	# endif /* __GNUC__ && __GNUC__ > 2 */
	48
	49
	50	/*
	51	* C++ magic...
	52	*/
	53
	54	# ifdef __cplusplus
	55	extern "C" {
	56	# endif /* __cplusplus */
	57
	58
	59	/*
	60	* Constants...
	61	*/
	62
a4845881	63	# define CUPS_VERSION 1.0599
ef416fc2	64	# define CUPS_VERSION_MAJOR 1
a4845881 MS	65	# define CUPS_VERSION_MINOR 6
a4845881 MS	66	# define CUPS_VERSION_PATCH -1
3d052e43	67
79e1d494	68	# define CUPS_BC_FD 3 /* Back-channel file descriptor for select/poll */
3d052e43	69	# define CUPS_DATE_ANY (time_t)-1
ae71f5de	70	# define CUPS_EXCLUDE_NONE (const char *)0
3d052e43	71	# define CUPS_FORMAT_AUTO "application/octet-stream"
1f6f3dbc	72	# define CUPS_FORMAT_COMMAND "application/vnd.cups-command"
3d052e43 MS	73	# define CUPS_FORMAT_PDF "application/pdf"
	74	# define CUPS_FORMAT_POSTSCRIPT "application/postscript"
	75	# define CUPS_FORMAT_RAW "application/vnd.cups-raw"
	76	# define CUPS_FORMAT_TEXT "text/plain"
	77	# define CUPS_HTTP_DEFAULT (http_t *)0
ed6e7faf	78	# define CUPS_INCLUDE_ALL (const char *)0
5a738aea MS	79	# define CUPS_JOBID_ALL -1
5a738aea MS	80	# define CUPS_JOBID_CURRENT 0
3d052e43	81	# define CUPS_LENGTH_VARIABLE (ssize_t)0
ae71f5de	82	# define CUPS_TIMEOUT_DEFAULT 0
5a738aea MS	83	# define CUPS_WHICHJOBS_ALL -1
	84	# define CUPS_WHICHJOBS_ACTIVE 0
	85	# define CUPS_WHICHJOBS_COMPLETED 1
ef416fc2	86
	87
	88	/*
	89	* Types and structures...
	90	*/
	91
5a738aea MS	92	typedef unsigned cups_ptype_t; /** Printer type/capability bits **/
	93	enum cups_ptype_e /** Printer type/capability bit constants **/
	94	{ /* Not a typedef'd enum so we can OR */
ef416fc2	95	CUPS_PRINTER_LOCAL = 0x0000, /* Local printer or class */
	96	CUPS_PRINTER_CLASS = 0x0001, /* Printer class */
	97	CUPS_PRINTER_REMOTE = 0x0002, /* Remote printer or class */
	98	CUPS_PRINTER_BW = 0x0004, /* Can do B&W printing */
	99	CUPS_PRINTER_COLOR = 0x0008, /* Can do color printing */
	100	CUPS_PRINTER_DUPLEX = 0x0010, /* Can do duplexing */
	101	CUPS_PRINTER_STAPLE = 0x0020, /* Can staple output */
	102	CUPS_PRINTER_COPIES = 0x0040, /* Can do copies */
	103	CUPS_PRINTER_COLLATE = 0x0080, /* Can collage copies */
	104	CUPS_PRINTER_PUNCH = 0x0100, /* Can punch output */
	105	CUPS_PRINTER_COVER = 0x0200, /* Can cover output */
	106	CUPS_PRINTER_BIND = 0x0400, /* Can bind output */
	107	CUPS_PRINTER_SORT = 0x0800, /* Can sort output */
	108	CUPS_PRINTER_SMALL = 0x1000, /* Can do Letter/Legal/A4 */
	109	CUPS_PRINTER_MEDIUM = 0x2000, /* Can do Tabloid/B/C/A3/A2 */
	110	CUPS_PRINTER_LARGE = 0x4000, /* Can do D/E/A1/A0 */
	111	CUPS_PRINTER_VARIABLE = 0x8000, /* Can do variable sizes */
	112	CUPS_PRINTER_IMPLICIT = 0x10000, /* Implicit class */
	113	CUPS_PRINTER_DEFAULT = 0x20000, /* Default printer on network */
	114	CUPS_PRINTER_FAX = 0x40000, /* Fax queue */
	115	CUPS_PRINTER_REJECTING = 0x80000, /* Printer is rejecting jobs */
426c6a59 MS	116	CUPS_PRINTER_DELETE = 0x100000, /* Delete printer @since CUPS 1.2/Mac OS X 10.5@ */
	117	CUPS_PRINTER_NOT_SHARED = 0x200000, /* Printer is not shared @since CUPS 1.2/Mac OS X 10.5@ */
	118	CUPS_PRINTER_AUTHENTICATED = 0x400000,/* Printer requires authentication @since CUPS 1.2/Mac OS X 10.5@ */
	119	CUPS_PRINTER_COMMANDS = 0x800000, /* Printer supports maintenance commands @since CUPS 1.2/Mac OS X 10.5@ */
	120	CUPS_PRINTER_DISCOVERED = 0x1000000, /* Printer was automatically discovered and added @since CUPS 1.3/Mac OS X 10.5@ */
178cb736 MS	121	CUPS_PRINTER_SCANNER = 0x2000000, /* Scanner-only device @since CUPS 1.4/Mac OS X 10.6@ */
178cb736 MS	122	CUPS_PRINTER_MFP = 0x4000000, /* Printer with scanning capabilities @since CUPS 1.4/Mac OS X 10.6@ */
5a738aea	123	CUPS_PRINTER_OPTIONS = 0x6fffc /* ~(CLASS \| REMOTE \| IMPLICIT \| DEFAULT \| FAX \| REJECTING \| DELETE \| NOT_SHARED \| AUTHENTICATED \| COMMANDS \| DISCOVERED) @private@ */
ef416fc2	124	};
ef416fc2	125
ae71f5de	126	typedef const char (cups_password_cb_t)(const char *prompt);
ecdc0628	127	/** Password callback **/
ef416fc2	128
f11a948a MS	129	typedef const char (cups_password_cb2_t)(const char prompt, http_t http,
	130	const char *method,
	131	const char *resource,
	132	void *user_data);
178cb736	133	/** New password callback @since CUPS 1.4/Mac OS X 10.6@ **/
f11a948a	134
ae71f5de MS	135	typedef void (cups_device_cb_t)(const char device_class,
	136	const char device_id, const char device_info,
	137	const char *device_make_and_model,
749b1e90 MS	138	const char *device_uri,
749b1e90 MS	139	const char device_location, void user_data);
178cb736	140	/** Device callback @since CUPS 1.4/Mac OS X 10.6@ **/
ae71f5de	141
ef416fc2	142	typedef struct cups_option_s /** Printer Options **/
	143	{
	144	char name; / Name of option */
	145	char value; / Value of option */
	146	} cups_option_t;
	147
	148	typedef struct cups_dest_s /** Destination **/
	149	{
	150	char name, / Printer or class name */
	151	instance; / Local instance name or NULL */
	152	int is_default; /* Is this printer the default? */
	153	int num_options; /* Number of options */
	154	cups_option_t options; / Options */
	155	} cups_dest_t;
	156
	157	typedef struct cups_job_s /** Job **/
	158	{
	159	int id; /* The job ID */
ecdc0628	160	char dest; / Printer or class name */
	161	char title; / Title/job name */
	162	char user; / User the submitted the job */
	163	char format; / Document format */
ef416fc2	164	ipp_jstate_t state; /* Job state */
ecdc0628	165	int size; /* Size in kilobytes */
	166	int priority; /* Priority (1-100) */
	167	time_t completed_time; /* Time the job was completed */
	168	time_t creation_time; /* Time the job was created */
	169	time_t processing_time; /* Time the job was processed */
ef416fc2	170	} cups_job_t;
ef416fc2	171
7cf5915e	172	typedef int (cups_client_cert_cb_t)(http_t http, void *tls,
321d8d57	173	cups_array_t *distinguished_names,
7cf5915e	174	void *user_data);
321d8d57	175	/** Client credentials callback @since CUPS 1.5/Mac OS X 10.7@ **/
7cf5915e MS	176
	177	typedef int (cups_server_cert_cb_t)(http_t http, void *tls,
	178	cups_array_t certs, void user_data);
321d8d57	179	/** Server credentials callback @since CUPS 1.5/Mac OS X 10.7@ **/
7cf5915e	180
ef416fc2	181
	182	/*
	183	* Functions...
	184	*/
	185
3d052e43	186	extern int cupsCancelJob(const char *name, int job_id);
ef416fc2	187	extern ipp_t cupsDoFileRequest(http_t http, ipp_t *request,
ecdc0628	188	const char *resource,
	189	const char *filename);
	190	extern ipp_t cupsDoRequest(http_t http, ipp_t *request,
	191	const char *resource);
ef416fc2	192	extern http_encryption_t cupsEncryption(void);
	193	extern void cupsFreeJobs(int num_jobs, cups_job_t *jobs);
	194	extern int cupsGetClasses(char ***classes) _CUPS_DEPRECATED;
	195	extern const char *cupsGetDefault(void);
5a738aea MS	196	extern int cupsGetJobs(cups_job_t *jobs, const char name,
5a738aea MS	197	int myjobs, int whichjobs);
3d052e43	198	extern const char cupsGetPPD(const char name);
ef416fc2	199	extern int cupsGetPrinters(char ***printers) _CUPS_DEPRECATED;
ef416fc2	200	extern ipp_status_t cupsLastError(void);
3d052e43	201	extern int cupsPrintFile(const char name, const char filename,
ef416fc2	202	const char *title, int num_options,
ef416fc2	203	cups_option_t *options);
3d052e43	204	extern int cupsPrintFiles(const char *name, int num_files,
ef416fc2	205	const char *files, const char title,
	206	int num_options, cups_option_t *options);
	207	extern char cupsTempFile(char filename, int len) _CUPS_DEPRECATED;
	208	extern int cupsTempFd(char *filename, int len);
	209
	210	extern int cupsAddDest(const char name, const char instance,
	211	int num_dests, cups_dest_t **dests);
	212	extern void cupsFreeDests(int num_dests, cups_dest_t *dests);
	213	extern cups_dest_t cupsGetDest(const char name, const char *instance,
	214	int num_dests, cups_dest_t *dests);
	215	extern int cupsGetDests(cups_dest_t **dests);
	216	extern void cupsSetDests(int num_dests, cups_dest_t *dests);
	217
	218	extern int cupsAddOption(const char name, const char value,
	219	int num_options, cups_option_t **options);
	220	extern void cupsEncodeOptions(ipp_t *ipp, int num_options,
	221	cups_option_t *options);
	222	extern void cupsFreeOptions(int num_options, cups_option_t *options);
	223	extern const char cupsGetOption(const char name, int num_options,
	224	cups_option_t *options);
b423cd4c	225	extern int cupsParseOptions(const char *arg, int num_options,
b423cd4c	226	cups_option_t **options);
ef416fc2	227
	228	extern const char cupsGetPassword(const char prompt);
	229	extern const char *cupsServer(void);
	230	extern void cupsSetEncryption(http_encryption_t e);
	231	extern void cupsSetPasswordCB(cups_password_cb_t cb);
	232	extern void cupsSetServer(const char *server);
	233	extern void cupsSetUser(const char *user);
	234	extern const char *cupsUser(void);
	235
	236	/** New in CUPS 1.1.20 **/
	237	extern int cupsDoAuthentication(http_t http, const char method,
2fb76298	238	const char *resource) _CUPS_API_1_1_20;
ef416fc2	239	extern http_status_t cupsGetFile(http_t http, const char resource,
2fb76298	240	const char *filename) _CUPS_API_1_1_20;
ef416fc2	241	extern http_status_t cupsGetFd(http_t http, const char resource, int fd);
ef416fc2	242	extern http_status_t cupsPutFile(http_t http, const char resource,
2fb76298 MS	243	const char *filename) _CUPS_API_1_1_20;
2fb76298 MS	244	extern http_status_t cupsPutFd(http_t http, const char resource, int fd) _CUPS_API_1_1_20;
ef416fc2	245
ef416fc2	246	/** New in CUPS 1.1.21 **/
2fb76298 MS	247	extern const char cupsGetDefault2(http_t http) _CUPS_API_1_1_21;
2fb76298 MS	248	extern int cupsGetDests2(http_t http, cups_dest_t *dests) _CUPS_API_1_1_21;
ef416fc2	249	extern int cupsGetJobs2(http_t http, cups_job_t *jobs,
3d052e43	250	const char *name, int myjobs,
5a738aea	251	int whichjobs) _CUPS_API_1_1_21;
3d052e43 MS	252	extern const char cupsGetPPD2(http_t http, const char *name) _CUPS_API_1_1_21;
3d052e43 MS	253	extern int cupsPrintFile2(http_t http, const char name,
ef416fc2	254	const char *filename,
ef416fc2	255	const char *title, int num_options,
2fb76298	256	cups_option_t *options) _CUPS_API_1_1_21;
3d052e43	257	extern int cupsPrintFiles2(http_t http, const char name,
ef416fc2	258	int num_files, const char **files,
ef416fc2	259	const char *title, int num_options,
2fb76298	260	cups_option_t *options) _CUPS_API_1_1_21;
ef416fc2	261	extern int cupsSetDests2(http_t *http, int num_dests,
2fb76298	262	cups_dest_t *dests) _CUPS_API_1_1_21;
ef416fc2	263
b0f6947b	264	/** New in CUPS 1.2/Mac OS X 10.5 **/
ecdc0628	265	extern ssize_t cupsBackChannelRead(char *buffer, size_t bytes,
2fb76298	266	double timeout) _CUPS_API_1_2;
ecdc0628	267	extern ssize_t cupsBackChannelWrite(const char *buffer, size_t bytes,
2fb76298	268	double timeout) _CUPS_API_1_2;
ef416fc2	269	extern void cupsEncodeOptions2(ipp_t *ipp, int num_options,
ef416fc2	270	cups_option_t *options,
2fb76298 MS	271	ipp_tag_t group_tag) _CUPS_API_1_2;
	272	extern const char *cupsLastErrorString(void) _CUPS_API_1_2;
	273	extern char cupsNotifySubject(cups_lang_t lang, ipp_t *event) _CUPS_API_1_2;
	274	extern char cupsNotifyText(cups_lang_t lang, ipp_t *event) _CUPS_API_1_2;
b423cd4c	275	extern int cupsRemoveOption(const char *name, int num_options,
2fb76298 MS	276	cups_option_t **options) _CUPS_API_1_2;
2fb76298 MS	277	extern cups_file_t cupsTempFile2(char filename, int len) _CUPS_API_1_2;
ef416fc2	278
b0f6947b	279	/** New in CUPS 1.3/Mac OS X 10.5 **/
b94498cf	280	extern ipp_t cupsDoIORequest(http_t http, ipp_t *request,
b94498cf	281	const char *resource, int infile,
2fb76298 MS	282	int outfile) _CUPS_API_1_3;
2fb76298 MS	283	extern char cupsGetServerPPD(http_t http, const char *name) _CUPS_API_1_3;
f7deaa1a	284	extern int cupsRemoveDest(const char *name,
f7deaa1a	285	const char *instance,
2fb76298	286	int num_dests, cups_dest_t **dests) _CUPS_API_1_3;
f7deaa1a	287	extern void cupsSetDefaultDest(const char *name,
	288	const char *instance,
	289	int num_dests,
2fb76298	290	cups_dest_t *dests) _CUPS_API_1_3;
f7deaa1a	291
b0f6947b	292	/** New in CUPS 1.4/Mac OS X 10.6 **/
5a738aea MS	293	extern ipp_status_t cupsCancelJob2(http_t http, const char name,
5a738aea MS	294	int job_id, int purge) _CUPS_API_1_4;
3d052e43 MS	295	extern int cupsCreateJob(http_t http, const char name,
	296	const char *title, int num_options,
	297	cups_option_t *options) _CUPS_API_1_4;
	298	extern ipp_status_t cupsFinishDocument(http_t *http,
	299	const char *name) _CUPS_API_1_4;
ae71f5de	300	extern ipp_status_t cupsGetDevices(http_t *http, int timeout,
ed6e7faf	301	const char *include_schemes,
38e73f87	302	const char *exclude_schemes,
ae71f5de MS	303	cups_device_cb_t callback,
ae71f5de MS	304	void *user_data) _CUPS_API_1_4;
a4924f6c MS	305	extern cups_dest_t cupsGetNamedDest(http_t http, const char *name,
a4924f6c MS	306	const char *instance) _CUPS_API_1_4;
f11a948a MS	307	extern const char cupsGetPassword2(const char prompt, http_t *http,
	308	const char *method,
	309	const char *resource) _CUPS_API_1_4;
2e4ff8af MS	310	extern http_status_t cupsGetPPD3(http_t http, const char name,
2e4ff8af MS	311	time_t modtime, char buffer,
2fb76298	312	size_t bufsize) _CUPS_API_1_4;
3d052e43 MS	313	extern ipp_t cupsGetResponse(http_t http,
	314	const char *resource) _CUPS_API_1_4;
	315	extern ssize_t cupsReadResponseData(http_t http, char buffer,
	316	size_t length) _CUPS_API_1_4;
	317	extern http_status_t cupsSendRequest(http_t http, ipp_t request,
	318	const char *resource,
	319	size_t length) _CUPS_API_1_4;
f11a948a MS	320	extern void cupsSetPasswordCB2(cups_password_cb2_t cb,
f11a948a MS	321	void *user_data) _CUPS_API_1_4;
3d052e43 MS	322	extern http_status_t cupsStartDocument(http_t http, const char name,
	323	int job_id, const char *docname,
	324	const char *format,
	325	int last_document) _CUPS_API_1_4;
	326	extern http_status_t cupsWriteRequestData(http_t http, const char buffer,
	327	size_t length) _CUPS_API_1_4;
ef416fc2	328
7cf5915e MS	329	/** New in CUPS 1.5 **/
	330	extern void cupsSetClientCertCB(cups_client_cert_cb_t cb,
	331	void *user_data) _CUPS_API_1_5;
	332	extern int cupsSetCredentials(cups_array_t *certs) _CUPS_API_1_5;
	333	extern void cupsSetServerCertCB(cups_server_cert_cb_t cb,
	334	void *user_data) _CUPS_API_1_5;
	335
	336
ef416fc2	337	# ifdef __cplusplus
	338	}
	339	# endif /* __cplusplus */
	340
	341	#endif /* !_CUPS_CUPS_H_ */
	342
	343	/*
18ecb428	344	* End of "$Id: cups.h 8781 2009-08-28 17:34:54Z mike $".
ef416fc2	345	*/