2 * "$Id: cups.h 8781 2009-08-28 17:34:54Z mike $"
4 * API definitions for CUPS.
6 * Copyright 2007-2011 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products.
9 * These coded instructions, statements, and computer programs are the
10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * which should have been included with this file. If this file is
13 * file is missing or damaged, see the license at "http://www.cups.org/".
15 * This file is subject to the Apple OS-Developed Software exception.
19 # define _CUPS_CUPS_H_
22 * Include necessary headers...
25 # include <sys/types.h>
26 # if defined(WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
27 # define __CUPS_SSIZE_T_DEFINED
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 */
35 # include "language.h"
39 * With GCC 3.0 and higher, we can mark old APIs "deprecated" so you get
40 * a warning at compile-time.
43 # if defined(__GNUC__) && __GNUC__ > 2
44 # define _CUPS_DEPRECATED __attribute__ ((__deprecated__))
46 # define _CUPS_DEPRECATED
47 # endif /* __GNUC__ && __GNUC__ > 2 */
56 # endif /* __cplusplus */
63 # define CUPS_VERSION 1.0499
64 # define CUPS_VERSION_MAJOR 1
65 # define CUPS_VERSION_MINOR 5
66 # define CUPS_VERSION_PATCH -1
68 # define CUPS_BC_FD 3 /* Back-channel file descriptor for select/poll */
69 # define CUPS_DATE_ANY (time_t)-1
70 # define CUPS_EXCLUDE_NONE (const char *)0
71 # define CUPS_FORMAT_AUTO "application/octet-stream"
72 # define CUPS_FORMAT_COMMAND "application/vnd.cups-command"
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
78 # define CUPS_INCLUDE_ALL (const char *)0
79 # define CUPS_JOBID_ALL -1
80 # define CUPS_JOBID_CURRENT 0
81 # define CUPS_LENGTH_VARIABLE (ssize_t)0
82 # define CUPS_TIMEOUT_DEFAULT 0
83 # define CUPS_WHICHJOBS_ALL -1
84 # define CUPS_WHICHJOBS_ACTIVE 0
85 # define CUPS_WHICHJOBS_COMPLETED 1
89 * Types and structures...
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 */
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 */
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@ */
121 CUPS_PRINTER_SCANNER
= 0x2000000, /* Scanner-only device @since CUPS 1.4/Mac OS X 10.6@ */
122 CUPS_PRINTER_MFP
= 0x4000000, /* Printer with scanning capabilities @since CUPS 1.4/Mac OS X 10.6@ */
123 CUPS_PRINTER_OPTIONS
= 0x6fffc /* ~(CLASS | REMOTE | IMPLICIT | DEFAULT | FAX | REJECTING | DELETE | NOT_SHARED | AUTHENTICATED | COMMANDS | DISCOVERED) @private@ */
126 typedef const char *(*cups_password_cb_t
)(const char *prompt
);
127 /**** Password callback ****/
129 typedef const char *(*cups_password_cb2_t
)(const char *prompt
, http_t
*http
,
131 const char *resource
,
133 /**** New password callback @since CUPS 1.4/Mac OS X 10.6@ ****/
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
,
138 const char *device_uri
,
139 const char *device_location
, void *user_data
);
140 /**** Device callback @since CUPS 1.4/Mac OS X 10.6@ ****/
142 typedef struct cups_option_s
/**** Printer Options ****/
144 char *name
; /* Name of option */
145 char *value
; /* Value of option */
148 typedef struct cups_dest_s
/**** Destination ****/
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 */
157 typedef struct cups_job_s
/**** Job ****/
159 int id
; /* The job ID */
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 */
164 ipp_jstate_t state
; /* Job state */
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 */
172 typedef int (*cups_client_cert_cb_t
)(http_t
*http
, void *tls
,
173 cups_array_t
*distinguished_names
,
175 /**** Client credentials callback @since CUPS 1.5/Mac OS X 10.7@ ****/
177 typedef int (*cups_server_cert_cb_t
)(http_t
*http
, void *tls
,
178 cups_array_t
*certs
, void *user_data
);
179 /**** Server credentials callback @since CUPS 1.5/Mac OS X 10.7@ ****/
186 extern int cupsCancelJob(const char *name
, int job_id
);
187 extern ipp_t
*cupsDoFileRequest(http_t
*http
, ipp_t
*request
,
188 const char *resource
,
189 const char *filename
);
190 extern ipp_t
*cupsDoRequest(http_t
*http
, ipp_t
*request
,
191 const char *resource
);
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);
196 extern int cupsGetJobs(cups_job_t
**jobs
, const char *name
,
197 int myjobs
, int whichjobs
);
198 extern const char *cupsGetPPD(const char *name
);
199 extern int cupsGetPrinters(char ***printers
) _CUPS_DEPRECATED
;
200 extern ipp_status_t
cupsLastError(void);
201 extern int cupsPrintFile(const char *name
, const char *filename
,
202 const char *title
, int num_options
,
203 cups_option_t
*options
);
204 extern int cupsPrintFiles(const char *name
, int num_files
,
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
);
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
);
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
);
225 extern int cupsParseOptions(const char *arg
, int num_options
,
226 cups_option_t
**options
);
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);
236 /**** New in CUPS 1.1.20 ****/
237 extern int cupsDoAuthentication(http_t
*http
, const char *method
,
238 const char *resource
) _CUPS_API_1_1_20
;
239 extern http_status_t
cupsGetFile(http_t
*http
, const char *resource
,
240 const char *filename
) _CUPS_API_1_1_20
;
241 extern http_status_t
cupsGetFd(http_t
*http
, const char *resource
, int fd
);
242 extern http_status_t
cupsPutFile(http_t
*http
, const char *resource
,
243 const char *filename
) _CUPS_API_1_1_20
;
244 extern http_status_t
cupsPutFd(http_t
*http
, const char *resource
, int fd
) _CUPS_API_1_1_20
;
246 /**** New in CUPS 1.1.21 ****/
247 extern const char *cupsGetDefault2(http_t
*http
) _CUPS_API_1_1_21
;
248 extern int cupsGetDests2(http_t
*http
, cups_dest_t
**dests
) _CUPS_API_1_1_21
;
249 extern int cupsGetJobs2(http_t
*http
, cups_job_t
**jobs
,
250 const char *name
, int myjobs
,
251 int whichjobs
) _CUPS_API_1_1_21
;
252 extern const char *cupsGetPPD2(http_t
*http
, const char *name
) _CUPS_API_1_1_21
;
253 extern int cupsPrintFile2(http_t
*http
, const char *name
,
254 const char *filename
,
255 const char *title
, int num_options
,
256 cups_option_t
*options
) _CUPS_API_1_1_21
;
257 extern int cupsPrintFiles2(http_t
*http
, const char *name
,
258 int num_files
, const char **files
,
259 const char *title
, int num_options
,
260 cups_option_t
*options
) _CUPS_API_1_1_21
;
261 extern int cupsSetDests2(http_t
*http
, int num_dests
,
262 cups_dest_t
*dests
) _CUPS_API_1_1_21
;
264 /**** New in CUPS 1.2/Mac OS X 10.5 ****/
265 extern ssize_t
cupsBackChannelRead(char *buffer
, size_t bytes
,
266 double timeout
) _CUPS_API_1_2
;
267 extern ssize_t
cupsBackChannelWrite(const char *buffer
, size_t bytes
,
268 double timeout
) _CUPS_API_1_2
;
269 extern void cupsEncodeOptions2(ipp_t
*ipp
, int num_options
,
270 cups_option_t
*options
,
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
;
275 extern int cupsRemoveOption(const char *name
, int num_options
,
276 cups_option_t
**options
) _CUPS_API_1_2
;
277 extern cups_file_t
*cupsTempFile2(char *filename
, int len
) _CUPS_API_1_2
;
279 /**** New in CUPS 1.3/Mac OS X 10.5 ****/
280 extern ipp_t
*cupsDoIORequest(http_t
*http
, ipp_t
*request
,
281 const char *resource
, int infile
,
282 int outfile
) _CUPS_API_1_3
;
283 extern char *cupsGetServerPPD(http_t
*http
, const char *name
) _CUPS_API_1_3
;
284 extern int cupsRemoveDest(const char *name
,
285 const char *instance
,
286 int num_dests
, cups_dest_t
**dests
) _CUPS_API_1_3
;
287 extern void cupsSetDefaultDest(const char *name
,
288 const char *instance
,
290 cups_dest_t
*dests
) _CUPS_API_1_3
;
292 /**** New in CUPS 1.4/Mac OS X 10.6 ****/
293 extern ipp_status_t
cupsCancelJob2(http_t
*http
, const char *name
,
294 int job_id
, int purge
) _CUPS_API_1_4
;
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
;
300 extern ipp_status_t
cupsGetDevices(http_t
*http
, int timeout
,
301 const char *include_schemes
,
302 const char *exclude_schemes
,
303 cups_device_cb_t callback
,
304 void *user_data
) _CUPS_API_1_4
;
305 extern cups_dest_t
*cupsGetNamedDest(http_t
*http
, const char *name
,
306 const char *instance
) _CUPS_API_1_4
;
307 extern const char *cupsGetPassword2(const char *prompt
, http_t
*http
,
309 const char *resource
) _CUPS_API_1_4
;
310 extern http_status_t
cupsGetPPD3(http_t
*http
, const char *name
,
311 time_t *modtime
, char *buffer
,
312 size_t bufsize
) _CUPS_API_1_4
;
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
;
320 extern void cupsSetPasswordCB2(cups_password_cb2_t cb
,
321 void *user_data
) _CUPS_API_1_4
;
322 extern http_status_t
cupsStartDocument(http_t
*http
, const char *name
,
323 int job_id
, const char *docname
,
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
;
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
;
339 # endif /* __cplusplus */
341 #endif /* !_CUPS_CUPS_H_ */
344 * End of "$Id: cups.h 8781 2009-08-28 17:34:54Z mike $".