cups/cups.h

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