/*
* API definitions for CUPS.
*
- * Copyright 2007-2017 by Apple Inc.
- * Copyright 1997-2007 by Easy Software Products.
+ * Copyright © 2007-2019 by Apple Inc.
+ * Copyright © 1997-2007 by Easy Software Products.
*
- * These coded instructions, statements, and computer programs are the
- * 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
- * missing or damaged, see the license at "http://www.cups.org/".
- *
- * This file is subject to the Apple OS-Developed Software exception.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
#ifndef _CUPS_CUPS_H_
*/
# include <sys/types.h>
-# if defined(WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
+# if defined(_WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
# define __CUPS_SSIZE_T_DEFINED
# include <stddef.h>
/* Windows does not support the ssize_t type, so map it to long... */
typedef long ssize_t; /* @private@ */
-# endif /* WIN32 && !__CUPS_SSIZE_T_DEFINED */
+# endif /* _WIN32 && !__CUPS_SSIZE_T_DEFINED */
# include "file.h"
# include "ipp.h"
* Functions...
*/
-extern int cupsCancelJob(const char *name, int job_id);
+extern int cupsCancelJob(const char *name, int job_id) _CUPS_PUBLIC;
extern ipp_t *cupsDoFileRequest(http_t *http, ipp_t *request,
const char *resource,
- const char *filename);
+ const char *filename) _CUPS_PUBLIC;
extern ipp_t *cupsDoRequest(http_t *http, ipp_t *request,
- const char *resource);
+ const char *resource) _CUPS_PUBLIC;
extern http_encryption_t cupsEncryption(void);
-extern void cupsFreeJobs(int num_jobs, cups_job_t *jobs);
+extern void cupsFreeJobs(int num_jobs, cups_job_t *jobs) _CUPS_PUBLIC;
extern int cupsGetClasses(char ***classes) _CUPS_DEPRECATED_MSG("Use cupsEnumDests instead.");
-extern const char *cupsGetDefault(void);
+extern const char *cupsGetDefault(void) _CUPS_PUBLIC;
extern int cupsGetJobs(cups_job_t **jobs, const char *name,
- int myjobs, int whichjobs);
+ int myjobs, int whichjobs) _CUPS_PUBLIC;
extern int cupsGetPrinters(char ***printers) _CUPS_DEPRECATED_MSG("Use cupsEnumDests instead.");
-extern ipp_status_t cupsLastError(void);
+extern ipp_status_t cupsLastError(void) _CUPS_PUBLIC;
extern int cupsPrintFile(const char *name, const char *filename,
const char *title, int num_options,
- cups_option_t *options);
+ cups_option_t *options) _CUPS_PUBLIC;
extern int cupsPrintFiles(const char *name, int num_files,
const char **files, const char *title,
- int num_options, cups_option_t *options);
+ int num_options, cups_option_t *options) _CUPS_PUBLIC;
extern char *cupsTempFile(char *filename, int len) _CUPS_DEPRECATED_MSG("Use cupsTempFd or cupsTempFile2 instead.");
-extern int cupsTempFd(char *filename, int len);
+extern int cupsTempFd(char *filename, int len) _CUPS_PUBLIC;
extern int cupsAddDest(const char *name, const char *instance,
- int num_dests, cups_dest_t **dests);
-extern void cupsFreeDests(int num_dests, cups_dest_t *dests);
+ int num_dests, cups_dest_t **dests) _CUPS_PUBLIC;
+extern void cupsFreeDests(int num_dests, cups_dest_t *dests) _CUPS_PUBLIC;
extern cups_dest_t *cupsGetDest(const char *name, const char *instance,
- int num_dests, cups_dest_t *dests);
-extern int cupsGetDests(cups_dest_t **dests);
-extern void cupsSetDests(int num_dests, cups_dest_t *dests);
+ int num_dests, cups_dest_t *dests) _CUPS_PUBLIC;
+extern int cupsGetDests(cups_dest_t **dests) _CUPS_PUBLIC;
+extern void cupsSetDests(int num_dests, cups_dest_t *dests) _CUPS_PUBLIC;
extern int cupsAddOption(const char *name, const char *value,
- int num_options, cups_option_t **options);
+ int num_options, cups_option_t **options) _CUPS_PUBLIC;
extern void cupsEncodeOptions(ipp_t *ipp, int num_options,
- cups_option_t *options);
+ cups_option_t *options) _CUPS_PUBLIC;
extern void cupsFreeOptions(int num_options,
- cups_option_t *options);
+ cups_option_t *options) _CUPS_PUBLIC;
extern const char *cupsGetOption(const char *name, int num_options,
- cups_option_t *options);
+ cups_option_t *options) _CUPS_PUBLIC;
extern int cupsParseOptions(const char *arg, int num_options,
- cups_option_t **options);
+ cups_option_t **options) _CUPS_PUBLIC;
-extern const char *cupsGetPassword(const char *prompt);
-extern const char *cupsServer(void);
-extern void cupsSetEncryption(http_encryption_t e);
-extern void cupsSetPasswordCB(cups_password_cb_t cb);
-extern void cupsSetServer(const char *server);
-extern void cupsSetUser(const char *user);
-extern const char *cupsUser(void);
+extern const char *cupsGetPassword(const char *prompt) _CUPS_PUBLIC;
+extern const char *cupsServer(void) _CUPS_PUBLIC;
+extern void cupsSetEncryption(http_encryption_t e) _CUPS_PUBLIC;
+extern void cupsSetPasswordCB(cups_password_cb_t cb) _CUPS_PUBLIC;
+extern void cupsSetServer(const char *server) _CUPS_PUBLIC;
+extern void cupsSetUser(const char *user) _CUPS_PUBLIC;
+extern const char *cupsUser(void) _CUPS_PUBLIC;
/**** New in CUPS 1.1.20 ****/
extern int cupsDoAuthentication(http_t *http, const char *method,
_CUPS_API_1_1_20;
extern http_status_t cupsGetFile(http_t *http, const char *resource,
const char *filename) _CUPS_API_1_1_20;
-extern http_status_t cupsGetFd(http_t *http, const char *resource, int fd);
+extern http_status_t cupsGetFd(http_t *http, const char *resource, int fd) _CUPS_API_1_1_20;
extern http_status_t cupsPutFile(http_t *http, const char *resource,
const char *filename) _CUPS_API_1_1_20;
extern http_status_t cupsPutFd(http_t *http, const char *resource, int fd)
cups_dest_t *dests) _CUPS_API_1_1_21;
/**** New in CUPS 1.2/macOS 10.5 ****/
-extern ssize_t cupsBackChannelRead(char *buffer, size_t bytes,
- double timeout) _CUPS_API_1_2;
-extern ssize_t cupsBackChannelWrite(const char *buffer, size_t bytes,
- double timeout) _CUPS_API_1_2;
extern void cupsEncodeOptions2(ipp_t *ipp, int num_options,
cups_option_t *options,
ipp_tag_t group_tag) _CUPS_API_1_2;
extern int cupsAddIntegerOption(const char *name, int value, int num_options, cups_option_t **options) _CUPS_API_2_2_4;
extern int cupsGetIntegerOption(const char *name, int num_options, cups_option_t *options) _CUPS_API_2_2_4;
+/* New in CUPS 2.2.7 */
+extern const char *cupsHashString(const unsigned char *hash, size_t hashsize, char *buffer, size_t bufsize) _CUPS_API_2_2_7;
+
/* New in CUPS 2.3 */
-extern const char *cupsHashString(const unsigned char *hash, size_t hashsize, char *buffer, size_t bufsize) _CUPS_API_2_3;
+extern int cupsAddDestMediaOptions(http_t *http, cups_dest_t *dest, cups_dinfo_t *dinfo, unsigned flags, cups_size_t *size, int num_options, cups_option_t **options) _CUPS_API_2_3;
+extern ipp_attribute_t *cupsEncodeOption(ipp_t *ipp, ipp_tag_t group_tag, const char *name, const char *value) _CUPS_API_2_3;
# ifdef __cplusplus
}