2 * "$Id: cups.h 6187 2007-01-10 16:20:42Z mike $"
4 * API definitions for the Common UNIX Printing System (CUPS).
6 * Copyright 1997-2007 by Easy Software Products.
8 * These coded instructions, statements, and computer programs are the
9 * property of Easy Software Products and are protected by Federal
10 * copyright law. Distribution and use rights are outlined in the file
11 * "LICENSE.txt" which should have been included with this file. If this
12 * file is missing or damaged please contact Easy Software Products
15 * Attn: CUPS Licensing Information
16 * Easy Software Products
17 * 44141 Airport View Drive, Suite 204
18 * Hollywood, Maryland 20636 USA
20 * Voice: (301) 373-9600
21 * EMail: cups-info@cups.org
22 * WWW: http://www.cups.org
24 * This file is subject to the Apple OS-Developed Software exception.
28 # define _CUPS_CUPS_H_
31 * Include necessary headers...
34 # include <sys/types.h>
35 # if defined(WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
36 # define __CUPS_SSIZE_T_DEFINED
37 /* Windows does not support the ssize_t type, so map it to off_t... */
38 typedef off_t ssize_t
; /* @private@ */
39 # endif /* WIN32 && !__CUPS_SSIZE_T_DEFINED */
43 # include "language.h"
47 * With GCC 3.0 and higher, we can mark old APIs "deprecated" so you get
48 * a warning at compile-time.
51 # if defined(__GNUC__) && __GNUC__ > 2
52 # define _CUPS_DEPRECATED __attribute__ ((__deprecated__))
54 # define _CUPS_DEPRECATED
55 # endif /* __GNUC__ && __GNUC__ > 2 */
64 # endif /* __cplusplus */
71 # define CUPS_VERSION 1.0300
72 # define CUPS_VERSION_MAJOR 1
73 # define CUPS_VERSION_MINOR 3
74 # define CUPS_VERSION_PATCH 0
75 # define CUPS_DATE_ANY -1
79 * Types and structures...
82 typedef unsigned cups_ptype_t
; /**** Printer Type/Capability Bits ****/
83 enum cups_ptype_e
/* Not a typedef'd enum so we can OR */
85 CUPS_PRINTER_LOCAL
= 0x0000, /* Local printer or class */
86 CUPS_PRINTER_CLASS
= 0x0001, /* Printer class */
87 CUPS_PRINTER_REMOTE
= 0x0002, /* Remote printer or class */
88 CUPS_PRINTER_BW
= 0x0004, /* Can do B&W printing */
89 CUPS_PRINTER_COLOR
= 0x0008, /* Can do color printing */
90 CUPS_PRINTER_DUPLEX
= 0x0010, /* Can do duplexing */
91 CUPS_PRINTER_STAPLE
= 0x0020, /* Can staple output */
92 CUPS_PRINTER_COPIES
= 0x0040, /* Can do copies */
93 CUPS_PRINTER_COLLATE
= 0x0080, /* Can collage copies */
94 CUPS_PRINTER_PUNCH
= 0x0100, /* Can punch output */
95 CUPS_PRINTER_COVER
= 0x0200, /* Can cover output */
96 CUPS_PRINTER_BIND
= 0x0400, /* Can bind output */
97 CUPS_PRINTER_SORT
= 0x0800, /* Can sort output */
98 CUPS_PRINTER_SMALL
= 0x1000, /* Can do Letter/Legal/A4 */
99 CUPS_PRINTER_MEDIUM
= 0x2000, /* Can do Tabloid/B/C/A3/A2 */
100 CUPS_PRINTER_LARGE
= 0x4000, /* Can do D/E/A1/A0 */
101 CUPS_PRINTER_VARIABLE
= 0x8000, /* Can do variable sizes */
102 CUPS_PRINTER_IMPLICIT
= 0x10000, /* Implicit class */
103 CUPS_PRINTER_DEFAULT
= 0x20000, /* Default printer on network */
104 CUPS_PRINTER_FAX
= 0x40000, /* Fax queue */
105 CUPS_PRINTER_REJECTING
= 0x80000, /* Printer is rejecting jobs */
106 CUPS_PRINTER_DELETE
= 0x100000, /* Delete printer @since CUPS 1.2@ */
107 CUPS_PRINTER_NOT_SHARED
= 0x200000, /* Printer is not shared @since CUPS 1.2@ */
108 CUPS_PRINTER_AUTHENTICATED
= 0x400000,/* Printer requires authentication @since CUPS 1.2@ */
109 CUPS_PRINTER_COMMANDS
= 0x800000, /* Printer supports maintenance commands @since CUPS 1.2@ */
110 CUPS_PRINTER_OPTIONS
= 0xe6fffc /* ~(CLASS | REMOTE | IMPLICIT) */
113 typedef const char *(*cups_password_cb_t
)(const char *);
114 /**** Password callback ****/
116 typedef struct cups_option_s
/**** Printer Options ****/
118 char *name
; /* Name of option */
119 char *value
; /* Value of option */
122 typedef struct cups_dest_s
/**** Destination ****/
124 char *name
, /* Printer or class name */
125 *instance
; /* Local instance name or NULL */
126 int is_default
; /* Is this printer the default? */
127 int num_options
; /* Number of options */
128 cups_option_t
*options
; /* Options */
131 typedef struct cups_job_s
/**** Job ****/
133 int id
; /* The job ID */
134 char *dest
; /* Printer or class name */
135 char *title
; /* Title/job name */
136 char *user
; /* User the submitted the job */
137 char *format
; /* Document format */
138 ipp_jstate_t state
; /* Job state */
139 int size
; /* Size in kilobytes */
140 int priority
; /* Priority (1-100) */
141 time_t completed_time
; /* Time the job was completed */
142 time_t creation_time
; /* Time the job was created */
143 time_t processing_time
; /* Time the job was processed */
151 extern int cupsCancelJob(const char *printer
, int job
);
152 extern ipp_t
*cupsDoFileRequest(http_t
*http
, ipp_t
*request
,
153 const char *resource
,
154 const char *filename
);
155 extern ipp_t
*cupsDoRequest(http_t
*http
, ipp_t
*request
,
156 const char *resource
);
157 extern http_encryption_t
cupsEncryption(void);
158 extern void cupsFreeJobs(int num_jobs
, cups_job_t
*jobs
);
159 extern int cupsGetClasses(char ***classes
) _CUPS_DEPRECATED
;
160 extern const char *cupsGetDefault(void);
161 extern int cupsGetJobs(cups_job_t
**jobs
, const char *dest
,
162 int myjobs
, int completed
);
163 extern const char *cupsGetPPD(const char *printer
);
164 extern int cupsGetPrinters(char ***printers
) _CUPS_DEPRECATED
;
165 extern ipp_status_t
cupsLastError(void);
166 extern int cupsPrintFile(const char *printer
, const char *filename
,
167 const char *title
, int num_options
,
168 cups_option_t
*options
);
169 extern int cupsPrintFiles(const char *printer
, int num_files
,
170 const char **files
, const char *title
,
171 int num_options
, cups_option_t
*options
);
172 extern char *cupsTempFile(char *filename
, int len
) _CUPS_DEPRECATED
;
173 extern int cupsTempFd(char *filename
, int len
);
175 extern int cupsAddDest(const char *name
, const char *instance
,
176 int num_dests
, cups_dest_t
**dests
);
177 extern void cupsFreeDests(int num_dests
, cups_dest_t
*dests
);
178 extern cups_dest_t
*cupsGetDest(const char *name
, const char *instance
,
179 int num_dests
, cups_dest_t
*dests
);
180 extern int cupsGetDests(cups_dest_t
**dests
);
181 extern void cupsSetDests(int num_dests
, cups_dest_t
*dests
);
183 extern int cupsAddOption(const char *name
, const char *value
,
184 int num_options
, cups_option_t
**options
);
185 extern void cupsEncodeOptions(ipp_t
*ipp
, int num_options
,
186 cups_option_t
*options
);
187 extern void cupsFreeOptions(int num_options
, cups_option_t
*options
);
188 extern const char *cupsGetOption(const char *name
, int num_options
,
189 cups_option_t
*options
);
190 extern int cupsMarkOptions(ppd_file_t
*ppd
, int num_options
,
191 cups_option_t
*options
);
192 extern int cupsParseOptions(const char *arg
, int num_options
,
193 cups_option_t
**options
);
195 extern const char *cupsGetPassword(const char *prompt
);
196 extern const char *cupsServer(void);
197 extern void cupsSetEncryption(http_encryption_t e
);
198 extern void cupsSetPasswordCB(cups_password_cb_t cb
);
199 extern void cupsSetServer(const char *server
);
200 extern void cupsSetUser(const char *user
);
201 extern const char *cupsUser(void);
203 /**** New in CUPS 1.1.20 ****/
204 extern int cupsDoAuthentication(http_t
*http
, const char *method
,
205 const char *resource
);
206 extern http_status_t
cupsGetFile(http_t
*http
, const char *resource
,
207 const char *filename
);
208 extern http_status_t
cupsGetFd(http_t
*http
, const char *resource
, int fd
);
209 extern http_status_t
cupsPutFile(http_t
*http
, const char *resource
,
210 const char *filename
);
211 extern http_status_t
cupsPutFd(http_t
*http
, const char *resource
, int fd
);
213 /**** New in CUPS 1.1.21 ****/
214 extern const char *cupsGetDefault2(http_t
*http
);
215 extern int cupsGetDests2(http_t
*http
, cups_dest_t
**dests
);
216 extern int cupsGetJobs2(http_t
*http
, cups_job_t
**jobs
,
217 const char *dest
, int myjobs
,
219 extern const char *cupsGetPPD2(http_t
*http
, const char *printer
);
220 extern int cupsPrintFile2(http_t
*http
, const char *printer
,
221 const char *filename
,
222 const char *title
, int num_options
,
223 cups_option_t
*options
);
224 extern int cupsPrintFiles2(http_t
*http
, const char *printer
,
225 int num_files
, const char **files
,
226 const char *title
, int num_options
,
227 cups_option_t
*options
);
228 extern int cupsSetDests2(http_t
*http
, int num_dests
,
231 /**** New in CUPS 1.2 ****/
232 extern ssize_t
cupsBackChannelRead(char *buffer
, size_t bytes
,
234 extern ssize_t
cupsBackChannelWrite(const char *buffer
, size_t bytes
,
236 extern void cupsEncodeOptions2(ipp_t
*ipp
, int num_options
,
237 cups_option_t
*options
,
238 ipp_tag_t group_tag
);
239 extern const char *cupsLastErrorString(void);
240 extern char *cupsNotifySubject(cups_lang_t
*lang
, ipp_t
*event
);
241 extern char *cupsNotifyText(cups_lang_t
*lang
, ipp_t
*event
);
242 extern int cupsRemoveOption(const char *name
, int num_options
,
243 cups_option_t
**options
);
244 extern cups_file_t
*cupsTempFile2(char *filename
, int len
);
246 /**** New in CUPS 1.3 ****/
247 extern int cupsRemoveDest(const char *name
,
248 const char *instance
,
249 int num_dests
, cups_dest_t
**dests
);
250 extern void cupsSetDefaultDest(const char *name
,
251 const char *instance
,
258 # endif /* __cplusplus */
260 #endif /* !_CUPS_CUPS_H_ */
263 * End of "$Id: cups.h 6187 2007-01-10 16:20:42Z mike $".