/*
- * "$Id: cups.h 4918 2006-01-12 05:14:40Z mike $"
+ * "$Id: cups.h 6946 2007-09-12 18:28:16Z mike $"
*
* API definitions for the Common UNIX Printing System (CUPS).
*
- * Copyright 1997-2006 by Easy Software Products.
+ * Copyright 2007 by Apple Inc.
+ * Copyright 1997-2007 by Easy Software Products.
*
* These coded instructions, statements, and computer programs are the
- * property of Easy Software Products and are protected by Federal
- * copyright law. Distribution and use rights are outlined in the file
- * "LICENSE.txt" which should have been included with this file. If this
- * file is missing or damaged please contact Easy Software Products
- * at:
- *
- * Attn: CUPS Licensing Information
- * Easy Software Products
- * 44141 Airport View Drive, Suite 204
- * Hollywood, Maryland 20636 USA
- *
- * Voice: (301) 373-9600
- * EMail: cups-info@cups.org
- * WWW: http://www.cups.org
+ * property of Apple Inc. and are protected by Federal copyright
+ * law. Distribution and use rights are outlined in the file "LICENSE.txt"
+ * which should have been included with this file. If this file is
+ * file is missing or damaged, see the license at "http://www.cups.org/".
*
* This file is subject to the Apple OS-Developed Software exception.
*/
* Include necessary headers...
*/
+# include <sys/types.h>
+# if defined(WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
+# define __CUPS_SSIZE_T_DEFINED
+/* Windows does not support the ssize_t type, so map it to off_t... */
+typedef off_t ssize_t; /* @private@ */
+# endif /* WIN32 && !__CUPS_SSIZE_T_DEFINED */
+
# include "ipp.h"
# include "ppd.h"
+# include "language.h"
+
/*
* With GCC 3.0 and higher, we can mark old APIs "deprecated" so you get
- * an error at compile-time.
+ * a warning at compile-time.
*/
# if defined(__GNUC__) && __GNUC__ > 2
* Constants...
*/
-# define CUPS_VERSION 1.0190
+# define CUPS_VERSION 1.0301
# define CUPS_VERSION_MAJOR 1
-# define CUPS_VERSION_MINOR 2
-# define CUPS_VERSION_PATCH -10
+# define CUPS_VERSION_MINOR 3
+# define CUPS_VERSION_PATCH 1
# define CUPS_DATE_ANY -1
CUPS_PRINTER_DELETE = 0x100000, /* Delete printer @since CUPS 1.2@ */
CUPS_PRINTER_NOT_SHARED = 0x200000, /* Printer is not shared @since CUPS 1.2@ */
CUPS_PRINTER_AUTHENTICATED = 0x400000,/* Printer requires authentication @since CUPS 1.2@ */
- CUPS_PRINTER_OPTIONS = 0x66fffc /* ~(CLASS | REMOTE | IMPLICIT) */
+ CUPS_PRINTER_COMMANDS = 0x800000, /* Printer supports maintenance commands @since CUPS 1.2@ */
+ CUPS_PRINTER_DISCOVERED = 0x1000000, /* Printer was automatically discovered and added @since CUPS 1.3@ */
+ CUPS_PRINTER_OPTIONS = 0x6fffc /* ~(CLASS | REMOTE | IMPLICIT | DEFAULT | FAX | REJECTING | DELETE | NOT_SHARED | AUTHENTICATED | COMMANDS | DISCOVERED) */
};
typedef const char *(*cups_password_cb_t)(const char *);
+ /**** Password callback ****/
typedef struct cups_option_s /**** Printer Options ****/
{
typedef struct cups_job_s /**** Job ****/
{
int id; /* The job ID */
- char *dest, /* Printer or class name */
- *title, /* Title/job name */
- *user, /* User the submitted the job */
- *format; /* Document format */
+ char *dest; /* Printer or class name */
+ char *title; /* Title/job name */
+ char *user; /* User the submitted the job */
+ char *format; /* Document format */
ipp_jstate_t state; /* Job state */
- int size, /* Size in kilobytes */
- priority; /* Priority (1-100) */
- time_t completed_time, /* Time the job was completed */
- creation_time, /* Time the job was created */
- processing_time; /* Time the job was processed */
+ int size; /* Size in kilobytes */
+ int priority; /* Priority (1-100) */
+ time_t completed_time; /* Time the job was completed */
+ time_t creation_time; /* Time the job was created */
+ time_t processing_time; /* Time the job was processed */
} cups_job_t;
*/
extern int cupsCancelJob(const char *printer, int job);
-#define cupsDoRequest(http,request,resource) cupsDoFileRequest((http),(request),(resource),NULL)
extern ipp_t *cupsDoFileRequest(http_t *http, ipp_t *request,
- const char *resource, const char *filename);
+ const char *resource,
+ const char *filename);
+extern ipp_t *cupsDoRequest(http_t *http, ipp_t *request,
+ const char *resource);
extern http_encryption_t cupsEncryption(void);
extern void cupsFreeJobs(int num_jobs, cups_job_t *jobs);
extern int cupsGetClasses(char ***classes) _CUPS_DEPRECATED;
extern void cupsFreeOptions(int num_options, cups_option_t *options);
extern const char *cupsGetOption(const char *name, int num_options,
cups_option_t *options);
-extern int cupsParseOptions(const char *arg, int num_options,
- cups_option_t **options);
extern int cupsMarkOptions(ppd_file_t *ppd, int num_options,
cups_option_t *options);
+extern int cupsParseOptions(const char *arg, int num_options,
+ cups_option_t **options);
extern const char *cupsGetPassword(const char *prompt);
extern const char *cupsServer(void);
cups_dest_t *dests);
/**** New in CUPS 1.2 ****/
-extern int cupsBackchannelRead(char *buffer, int bytes, double timeout);
-extern int cupsBackchannelWrite(const char *buffer, int bytes,
+extern ssize_t cupsBackChannelRead(char *buffer, size_t bytes,
+ double timeout);
+extern ssize_t cupsBackChannelWrite(const char *buffer, size_t bytes,
double timeout);
extern void cupsEncodeOptions2(ipp_t *ipp, int num_options,
cups_option_t *options,
ipp_tag_t group_tag);
extern const char *cupsLastErrorString(void);
+extern char *cupsNotifySubject(cups_lang_t *lang, ipp_t *event);
+extern char *cupsNotifyText(cups_lang_t *lang, ipp_t *event);
+extern int cupsRemoveOption(const char *name, int num_options,
+ cups_option_t **options);
extern cups_file_t *cupsTempFile2(char *filename, int len);
+/**** New in CUPS 1.3 ****/
+extern ipp_t *cupsDoIORequest(http_t *http, ipp_t *request,
+ const char *resource, int infile,
+ int outfile);
+extern char *cupsGetServerPPD(http_t *http, const char *name);
+extern int cupsRemoveDest(const char *name,
+ const char *instance,
+ int num_dests, cups_dest_t **dests);
+extern void cupsSetDefaultDest(const char *name,
+ const char *instance,
+ int num_dests,
+ cups_dest_t *dests);
+
# ifdef __cplusplus
}
#endif /* !_CUPS_CUPS_H_ */
/*
- * End of "$Id: cups.h 4918 2006-01-12 05:14:40Z mike $".
+ * End of "$Id: cups.h 6946 2007-09-12 18:28:16Z mike $".
*/