]> git.ipfire.org Git - thirdparty/cups.git/blame_incremental - cups/cups.h
projects / thirdparty / cups.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Merge changes from CUPS 1.5svn-r9763.
[thirdparty/cups.git] / cups / cups.h
... / ...
CommitLineData
1/*
2 * "$Id: cups.h 8781 2009-08-28 17:34:54Z mike $"
3 *
4 * API definitions for CUPS.
5 *
6 * Copyright 2007-2010 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products.
8 *
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/".
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
25# include <sys/types.h>
26# if defined(WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
27# define __CUPS_SSIZE_T_DEFINED
28# include <stddef.h>
29/* Windows does not support the ssize_t type, so map it to off_t... */
30typedef off_t ssize_t; /* @private@ */
31# endif /* WIN32 && !__CUPS_SSIZE_T_DEFINED */
32
33# include "file.h"
34# include "ipp.h"
35# include "language.h"
36
37
38/*
39 * With GCC 3.0 and higher, we can mark old APIs "deprecated" so you get
40 * a warning at compile-time.
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
55extern "C" {
56# endif /* __cplusplus */
57
58
59/*
60 * Constants...
61 */
62
63# define CUPS_VERSION 1.0499
64# define CUPS_VERSION_MAJOR 1
65# define CUPS_VERSION_MINOR 5
66# define CUPS_VERSION_PATCH -1
67
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
86
87
88/*
89 * Types and structures...
90 */
91
92typedef unsigned cups_ptype_t; /**** Printer type/capability bits ****/
93enum 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@ */
124};
125
126typedef const char *(*cups_password_cb_t)(const char *prompt);
127 /**** Password callback ****/
128
129typedef const char *(*cups_password_cb2_t)(const char *prompt, http_t *http,
130 const char *method,
131 const char *resource,
132 void *user_data);
133 /**** New password callback @since CUPS 1.4/Mac OS X 10.6@ ****/
134
135typedef 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@ ****/
141
142typedef struct cups_option_s /**** Printer Options ****/
143{
144 char *name; /* Name of option */
145 char *value; /* Value of option */
146} cups_option_t;
147
148typedef 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
157typedef struct cups_job_s /**** Job ****/
158{
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 */
170} cups_job_t;
171
172typedef int (*cups_client_cert_cb_t)(http_t *http, void *tls,
173 cups_array_t *distinguished_names,
174 void *user_data);
175 /**** Client credentials callback @since CUPS 1.5@ ****/
176
177typedef 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@ ****/
180
181
182/*
183 * Functions...
184 */
185
186extern int cupsCancelJob(const char *name, int job_id);
187extern ipp_t *cupsDoFileRequest(http_t *http, ipp_t *request,
188 const char *resource,
189 const char *filename);
190extern ipp_t *cupsDoRequest(http_t *http, ipp_t *request,
191 const char *resource);
192extern http_encryption_t cupsEncryption(void);
193extern void cupsFreeJobs(int num_jobs, cups_job_t *jobs);
194extern int cupsGetClasses(char ***classes) _CUPS_DEPRECATED;
195extern const char *cupsGetDefault(void);
196extern int cupsGetJobs(cups_job_t **jobs, const char *name,
197 int myjobs, int whichjobs);
198extern const char *cupsGetPPD(const char *name);
199extern int cupsGetPrinters(char ***printers) _CUPS_DEPRECATED;
200extern ipp_status_t cupsLastError(void);
201extern int cupsPrintFile(const char *name, const char *filename,
202 const char *title, int num_options,
203 cups_option_t *options);
204extern int cupsPrintFiles(const char *name, int num_files,
205 const char **files, const char *title,
206 int num_options, cups_option_t *options);
207extern char *cupsTempFile(char *filename, int len) _CUPS_DEPRECATED;
208extern int cupsTempFd(char *filename, int len);
209
210extern int cupsAddDest(const char *name, const char *instance,
211 int num_dests, cups_dest_t **dests);
212extern void cupsFreeDests(int num_dests, cups_dest_t *dests);
213extern cups_dest_t *cupsGetDest(const char *name, const char *instance,
214 int num_dests, cups_dest_t *dests);
215extern int cupsGetDests(cups_dest_t **dests);
216extern void cupsSetDests(int num_dests, cups_dest_t *dests);
217
218extern int cupsAddOption(const char *name, const char *value,
219 int num_options, cups_option_t **options);
220extern void cupsEncodeOptions(ipp_t *ipp, int num_options,
221 cups_option_t *options);
222extern void cupsFreeOptions(int num_options, cups_option_t *options);
223extern const char *cupsGetOption(const char *name, int num_options,
224 cups_option_t *options);
225extern int cupsParseOptions(const char *arg, int num_options,
226 cups_option_t **options);
227
228extern const char *cupsGetPassword(const char *prompt);
229extern const char *cupsServer(void);
230extern void cupsSetEncryption(http_encryption_t e);
231extern void cupsSetPasswordCB(cups_password_cb_t cb);
232extern void cupsSetServer(const char *server);
233extern void cupsSetUser(const char *user);
234extern const char *cupsUser(void);
235
236/**** New in CUPS 1.1.20 ****/
237extern int cupsDoAuthentication(http_t *http, const char *method,
238 const char *resource) _CUPS_API_1_1_20;
239extern http_status_t cupsGetFile(http_t *http, const char *resource,
240 const char *filename) _CUPS_API_1_1_20;
241extern http_status_t cupsGetFd(http_t *http, const char *resource, int fd);
242extern http_status_t cupsPutFile(http_t *http, const char *resource,
243 const char *filename) _CUPS_API_1_1_20;
244extern http_status_t cupsPutFd(http_t *http, const char *resource, int fd) _CUPS_API_1_1_20;
245
246/**** New in CUPS 1.1.21 ****/
247extern const char *cupsGetDefault2(http_t *http) _CUPS_API_1_1_21;
248extern int cupsGetDests2(http_t *http, cups_dest_t **dests) _CUPS_API_1_1_21;
249extern int cupsGetJobs2(http_t *http, cups_job_t **jobs,
250 const char *name, int myjobs,
251 int whichjobs) _CUPS_API_1_1_21;
252extern const char *cupsGetPPD2(http_t *http, const char *name) _CUPS_API_1_1_21;
253extern 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;
257extern 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;
261extern int cupsSetDests2(http_t *http, int num_dests,
262 cups_dest_t *dests) _CUPS_API_1_1_21;
263
264/**** New in CUPS 1.2/Mac OS X 10.5 ****/
265extern ssize_t cupsBackChannelRead(char *buffer, size_t bytes,
266 double timeout) _CUPS_API_1_2;
267extern ssize_t cupsBackChannelWrite(const char *buffer, size_t bytes,
268 double timeout) _CUPS_API_1_2;
269extern void cupsEncodeOptions2(ipp_t *ipp, int num_options,
270 cups_option_t *options,
271 ipp_tag_t group_tag) _CUPS_API_1_2;
272extern const char *cupsLastErrorString(void) _CUPS_API_1_2;
273extern char *cupsNotifySubject(cups_lang_t *lang, ipp_t *event) _CUPS_API_1_2;
274extern char *cupsNotifyText(cups_lang_t *lang, ipp_t *event) _CUPS_API_1_2;
275extern int cupsRemoveOption(const char *name, int num_options,
276 cups_option_t **options) _CUPS_API_1_2;
277extern cups_file_t *cupsTempFile2(char *filename, int len) _CUPS_API_1_2;
278
279/**** New in CUPS 1.3/Mac OS X 10.5 ****/
280extern ipp_t *cupsDoIORequest(http_t *http, ipp_t *request,
281 const char *resource, int infile,
282 int outfile) _CUPS_API_1_3;
283extern char *cupsGetServerPPD(http_t *http, const char *name) _CUPS_API_1_3;
284extern int cupsRemoveDest(const char *name,
285 const char *instance,
286 int num_dests, cups_dest_t **dests) _CUPS_API_1_3;
287extern void cupsSetDefaultDest(const char *name,
288 const char *instance,
289 int num_dests,
290 cups_dest_t *dests) _CUPS_API_1_3;
291
292/**** New in CUPS 1.4/Mac OS X 10.6 ****/
293extern ipp_status_t cupsCancelJob2(http_t *http, const char *name,
294 int job_id, int purge) _CUPS_API_1_4;
295extern int cupsCreateJob(http_t *http, const char *name,
296 const char *title, int num_options,
297 cups_option_t *options) _CUPS_API_1_4;
298extern ipp_status_t cupsFinishDocument(http_t *http,
299 const char *name) _CUPS_API_1_4;
300extern 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;
305extern cups_dest_t *cupsGetNamedDest(http_t *http, const char *name,
306 const char *instance) _CUPS_API_1_4;
307extern const char *cupsGetPassword2(const char *prompt, http_t *http,
308 const char *method,
309 const char *resource) _CUPS_API_1_4;
310extern http_status_t cupsGetPPD3(http_t *http, const char *name,
311 time_t *modtime, char *buffer,
312 size_t bufsize) _CUPS_API_1_4;
313extern ipp_t *cupsGetResponse(http_t *http,
314 const char *resource) _CUPS_API_1_4;
315extern ssize_t cupsReadResponseData(http_t *http, char *buffer,
316 size_t length) _CUPS_API_1_4;
317extern http_status_t cupsSendRequest(http_t *http, ipp_t *request,
318 const char *resource,
319 size_t length) _CUPS_API_1_4;
320extern void cupsSetPasswordCB2(cups_password_cb2_t cb,
321 void *user_data) _CUPS_API_1_4;
322extern 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;
326extern http_status_t cupsWriteRequestData(http_t *http, const char *buffer,
327 size_t length) _CUPS_API_1_4;
328
329/**** New in CUPS 1.5 ****/
330extern void cupsSetClientCertCB(cups_client_cert_cb_t cb,
331 void *user_data) _CUPS_API_1_5;
332extern int cupsSetCredentials(cups_array_t *certs) _CUPS_API_1_5;
333extern void cupsSetServerCertCB(cups_server_cert_cb_t cb,
334 void *user_data) _CUPS_API_1_5;
335
336
337# ifdef __cplusplus
338}
339# endif /* __cplusplus */
340
341#endif /* !_CUPS_CUPS_H_ */
342
343/*
344 * End of "$Id: cups.h 8781 2009-08-28 17:34:54Z mike $".
345 */
Unnamed repository; edit this file 'description' to name the repository.