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