1 /* 2 * API definitions for CUPS. 3 * 4 * Copyright © 2007-2019 by Apple Inc. 5 * Copyright © 1997-2007 by Easy Software Products. 6 * 7 * Licensed under Apache License v2.0. See the file "LICENSE" for more 8 * information. 9 */ 10 11 #ifndef _CUPS_CUPS_H_ 12 # define _CUPS_CUPS_H_ 13 14 /* 15 * Include necessary headers... 16 */ 17 18 # include <sys/types.h> 19 # if defined(_WIN32) && !defined(__CUPS_SSIZE_T_DEFINED) 20 # define __CUPS_SSIZE_T_DEFINED 21 # include <stddef.h> 22 /* Windows does not support the ssize_t type, so map it to long... */ 23 typedef long ssize_t; /* @private@ */ 24 # endif /* _WIN32 && !__CUPS_SSIZE_T_DEFINED */ 25 26 # include "file.h" 27 # include "ipp.h" 28 # include "language.h" 29 # include "pwg.h" 30 31 32 /* 33 * C++ magic... 34 */ 35 36 # ifdef __cplusplus 37 extern "C" { 38 # endif /* __cplusplus */ 39 40 41 /* 42 * Constants... 43 */ 44 45 # define CUPS_VERSION 2.0303 46 # define CUPS_VERSION_MAJOR 2 47 # define CUPS_VERSION_MINOR 3 48 # define CUPS_VERSION_PATCH 3 49 50 # define CUPS_BC_FD 3 51 /* Back-channel file descriptor for 52 * select/poll */ 53 # define CUPS_DATE_ANY (time_t)-1 54 # define CUPS_EXCLUDE_NONE (const char *)0 55 # define CUPS_FORMAT_AUTO "application/octet-stream" 56 # define CUPS_FORMAT_COMMAND "application/vnd.cups-command" 57 # define CUPS_FORMAT_JPEG "image/jpeg" 58 # define CUPS_FORMAT_PDF "application/pdf" 59 # define CUPS_FORMAT_POSTSCRIPT "application/postscript" 60 # define CUPS_FORMAT_RAW "application/vnd.cups-raw" 61 # define CUPS_FORMAT_TEXT "text/plain" 62 # define CUPS_HTTP_DEFAULT (http_t *)0 63 # define CUPS_INCLUDE_ALL (const char *)0 64 # define CUPS_JOBID_ALL -1 65 # define CUPS_JOBID_CURRENT 0 66 # define CUPS_LENGTH_VARIABLE (ssize_t)0 67 # define CUPS_TIMEOUT_DEFAULT 0 68 # define CUPS_WHICHJOBS_ALL -1 69 # define CUPS_WHICHJOBS_ACTIVE 0 70 # define CUPS_WHICHJOBS_COMPLETED 1 71 72 /* Flags for cupsConnectDest and cupsEnumDests */ 73 # define CUPS_DEST_FLAGS_NONE 0x00 74 /* No flags are set */ 75 # define CUPS_DEST_FLAGS_UNCONNECTED 0x01 76 /* There is no connection */ 77 # define CUPS_DEST_FLAGS_MORE 0x02 78 /* There are more destinations */ 79 # define CUPS_DEST_FLAGS_REMOVED 0x04 80 /* The destination has gone away */ 81 # define CUPS_DEST_FLAGS_ERROR 0x08 82 /* An error occurred */ 83 # define CUPS_DEST_FLAGS_RESOLVING 0x10 84 /* The destination address is being 85 * resolved */ 86 # define CUPS_DEST_FLAGS_CONNECTING 0x20 87 /* A connection is being established */ 88 # define CUPS_DEST_FLAGS_CANCELED 0x40 89 /* Operation was canceled */ 90 # define CUPS_DEST_FLAGS_DEVICE 0x80 91 /* For @link cupsConnectDest@: Connect to device */ 92 93 /* Flags for cupsGetDestMediaByName/Size */ 94 # define CUPS_MEDIA_FLAGS_DEFAULT 0x00 95 /* Find the closest size supported by 96 * the printer */ 97 # define CUPS_MEDIA_FLAGS_BORDERLESS 0x01 98 /* Find a borderless size */ 99 # define CUPS_MEDIA_FLAGS_DUPLEX 0x02 100 /* Find a size compatible with 2-sided 101 * printing */ 102 # define CUPS_MEDIA_FLAGS_EXACT 0x04 103 /* Find an exact match for the size */ 104 # define CUPS_MEDIA_FLAGS_READY 0x08 105 /* If the printer supports media 106 * sensing, find the size amongst the 107 * "ready" media. */ 108 109 /* Options and values */ 110 # define CUPS_COPIES "copies" 111 # define CUPS_COPIES_SUPPORTED "copies-supported" 112 113 # define CUPS_FINISHINGS "finishings" 114 # define CUPS_FINISHINGS_SUPPORTED "finishings-supported" 115 116 # define CUPS_FINISHINGS_BIND "7" 117 # define CUPS_FINISHINGS_COVER "6" 118 # define CUPS_FINISHINGS_FOLD "10" 119 # define CUPS_FINISHINGS_NONE "3" 120 # define CUPS_FINISHINGS_PUNCH "5" 121 # define CUPS_FINISHINGS_STAPLE "4" 122 # define CUPS_FINISHINGS_TRIM "11" 123 124 # define CUPS_MEDIA "media" 125 # define CUPS_MEDIA_READY "media-ready" 126 # define CUPS_MEDIA_SUPPORTED "media-supported" 127 128 # define CUPS_MEDIA_3X5 "na_index-3x5_3x5in" 129 # define CUPS_MEDIA_4X6 "na_index-4x6_4x6in" 130 # define CUPS_MEDIA_5X7 "na_5x7_5x7in" 131 # define CUPS_MEDIA_8X10 "na_govt-letter_8x10in" 132 # define CUPS_MEDIA_A3 "iso_a3_297x420mm" 133 # define CUPS_MEDIA_A4 "iso_a4_210x297mm" 134 # define CUPS_MEDIA_A5 "iso_a5_148x210mm" 135 # define CUPS_MEDIA_A6 "iso_a6_105x148mm" 136 # define CUPS_MEDIA_ENV10 "na_number-10_4.125x9.5in" 137 # define CUPS_MEDIA_ENVDL "iso_dl_110x220mm" 138 # define CUPS_MEDIA_LEGAL "na_legal_8.5x14in" 139 # define CUPS_MEDIA_LETTER "na_letter_8.5x11in" 140 # define CUPS_MEDIA_PHOTO_L "oe_photo-l_3.5x5in" 141 # define CUPS_MEDIA_SUPERBA3 "na_super-b_13x19in" 142 # define CUPS_MEDIA_TABLOID "na_ledger_11x17in" 143 144 # define CUPS_MEDIA_SOURCE "media-source" 145 # define CUPS_MEDIA_SOURCE_SUPPORTED "media-source-supported" 146 147 # define CUPS_MEDIA_SOURCE_AUTO "auto" 148 # define CUPS_MEDIA_SOURCE_MANUAL "manual" 149 150 # define CUPS_MEDIA_TYPE "media-type" 151 # define CUPS_MEDIA_TYPE_SUPPORTED "media-type-supported" 152 153 # define CUPS_MEDIA_TYPE_AUTO "auto" 154 # define CUPS_MEDIA_TYPE_ENVELOPE "envelope" 155 # define CUPS_MEDIA_TYPE_LABELS "labels" 156 # define CUPS_MEDIA_TYPE_LETTERHEAD "stationery-letterhead" 157 # define CUPS_MEDIA_TYPE_PHOTO "photographic" 158 # define CUPS_MEDIA_TYPE_PHOTO_GLOSSY "photographic-glossy" 159 # define CUPS_MEDIA_TYPE_PHOTO_MATTE "photographic-matte" 160 # define CUPS_MEDIA_TYPE_PLAIN "stationery" 161 # define CUPS_MEDIA_TYPE_TRANSPARENCY "transparency" 162 163 # define CUPS_NUMBER_UP "number-up" 164 # define CUPS_NUMBER_UP_SUPPORTED "number-up-supported" 165 166 # define CUPS_ORIENTATION "orientation-requested" 167 # define CUPS_ORIENTATION_SUPPORTED "orientation-requested-supported" 168 169 # define CUPS_ORIENTATION_PORTRAIT "3" 170 # define CUPS_ORIENTATION_LANDSCAPE "4" 171 172 # define CUPS_PRINT_COLOR_MODE "print-color-mode" 173 # define CUPS_PRINT_COLOR_MODE_SUPPORTED "print-color-mode-supported" 174 175 # define CUPS_PRINT_COLOR_MODE_AUTO "auto" 176 # define CUPS_PRINT_COLOR_MODE_MONOCHROME "monochrome" 177 # define CUPS_PRINT_COLOR_MODE_COLOR "color" 178 179 # define CUPS_PRINT_QUALITY "print-quality" 180 # define CUPS_PRINT_QUALITY_SUPPORTED "print-quality-supported" 181 182 # define CUPS_PRINT_QUALITY_DRAFT "3" 183 # define CUPS_PRINT_QUALITY_NORMAL "4" 184 # define CUPS_PRINT_QUALITY_HIGH "5" 185 186 # define CUPS_SIDES "sides" 187 # define CUPS_SIDES_SUPPORTED "sides-supported" 188 189 # define CUPS_SIDES_ONE_SIDED "one-sided" 190 # define CUPS_SIDES_TWO_SIDED_PORTRAIT "two-sided-long-edge" 191 # define CUPS_SIDES_TWO_SIDED_LANDSCAPE "two-sided-short-edge" 192 193 194 /* 195 * Types and structures... 196 */ 197 198 typedef unsigned cups_ptype_t; /* Printer type/capability bits */ 199 enum cups_ptype_e /* Printer type/capability bit 200 * constants */ 201 { /* Not a typedef'd enum so we can OR */ 202 CUPS_PRINTER_LOCAL = 0x0000, /* Local printer or class */ 203 CUPS_PRINTER_CLASS = 0x0001, /* Printer class */ 204 CUPS_PRINTER_REMOTE = 0x0002, /* Remote printer or class */ 205 CUPS_PRINTER_BW = 0x0004, /* Can do B&W printing */ 206 CUPS_PRINTER_COLOR = 0x0008, /* Can do color printing */ 207 CUPS_PRINTER_DUPLEX = 0x0010, /* Can do two-sided printing */ 208 CUPS_PRINTER_STAPLE = 0x0020, /* Can staple output */ 209 CUPS_PRINTER_COPIES = 0x0040, /* Can do copies in hardware */ 210 CUPS_PRINTER_COLLATE = 0x0080, /* Can quickly collate copies */ 211 CUPS_PRINTER_PUNCH = 0x0100, /* Can punch output */ 212 CUPS_PRINTER_COVER = 0x0200, /* Can cover output */ 213 CUPS_PRINTER_BIND = 0x0400, /* Can bind output */ 214 CUPS_PRINTER_SORT = 0x0800, /* Can sort output */ 215 CUPS_PRINTER_SMALL = 0x1000, /* Can print on Letter/Legal/A4-size media */ 216 CUPS_PRINTER_MEDIUM = 0x2000, /* Can print on Tabloid/B/C/A3/A2-size media */ 217 CUPS_PRINTER_LARGE = 0x4000, /* Can print on D/E/A1/A0-size media */ 218 CUPS_PRINTER_VARIABLE = 0x8000, /* Can print on rolls and custom-size media */ 219 CUPS_PRINTER_IMPLICIT = 0x10000, /* Implicit class @private@ 220 * @since Deprecated@ */ 221 CUPS_PRINTER_DEFAULT = 0x20000, /* Default printer on network */ 222 CUPS_PRINTER_FAX = 0x40000, /* Fax queue */ 223 CUPS_PRINTER_REJECTING = 0x80000, /* Printer is rejecting jobs */ 224 CUPS_PRINTER_DELETE = 0x100000, /* Delete printer 225 * @deprecated@ @exclude all@ */ 226 CUPS_PRINTER_NOT_SHARED = 0x200000, /* Printer is not shared 227 * @since CUPS 1.2/macOS 10.5@ */ 228 CUPS_PRINTER_AUTHENTICATED = 0x400000,/* Printer requires authentication 229 * @since CUPS 1.2/macOS 10.5@ */ 230 CUPS_PRINTER_COMMANDS = 0x800000, /* Printer supports maintenance commands 231 * @since CUPS 1.2/macOS 10.5@ */ 232 CUPS_PRINTER_DISCOVERED = 0x1000000, /* Printer was discovered @since CUPS 1.2/macOS 10.5@ */ 233 CUPS_PRINTER_SCANNER = 0x2000000, /* Scanner-only device 234 * @since CUPS 1.4/macOS 10.6@ @private@ */ 235 CUPS_PRINTER_MFP = 0x4000000, /* Printer with scanning capabilities 236 * @since CUPS 1.4/macOS 10.6@ @private@ */ 237 CUPS_PRINTER_3D = 0x8000000, /* Printer with 3D capabilities @exclude all@ @private@ */ 238 CUPS_PRINTER_OPTIONS = 0x6fffc /* ~(CLASS | REMOTE | IMPLICIT | 239 * DEFAULT | FAX | REJECTING | DELETE | 240 * NOT_SHARED | AUTHENTICATED | 241 * COMMANDS | DISCOVERED) @private@ */ 242 }; 243 244 typedef struct cups_option_s /**** Printer Options ****/ 245 { 246 char *name; /* Name of option */ 247 char *value; /* Value of option */ 248 } cups_option_t; 249 250 typedef struct cups_dest_s /**** Destination ****/ 251 { 252 char *name, /* Printer or class name */ 253 *instance; /* Local instance name or NULL */ 254 int is_default; /* Is this printer the default? */ 255 int num_options; /* Number of options */ 256 cups_option_t *options; /* Options */ 257 } cups_dest_t; 258 259 typedef struct _cups_dinfo_s cups_dinfo_t; 260 /* Destination capability and status 261 * information @since CUPS 1.6/macOS 10.8@ */ 262 263 typedef struct cups_job_s /**** Job ****/ 264 { 265 int id; /* The job ID */ 266 char *dest; /* Printer or class name */ 267 char *title; /* Title/job name */ 268 char *user; /* User that submitted the job */ 269 char *format; /* Document format */ 270 ipp_jstate_t state; /* Job state */ 271 int size; /* Size in kilobytes */ 272 int priority; /* Priority (1-100) */ 273 time_t completed_time; /* Time the job was completed */ 274 time_t creation_time; /* Time the job was created */ 275 time_t processing_time; /* Time the job was processed */ 276 } cups_job_t; 277 278 typedef struct cups_size_s /**** Media Size @since CUPS 1.6/macOS 10.8@ ****/ 279 { 280 char media[128]; /* Media name to use */ 281 int width, /* Width in hundredths of millimeters */ 282 length, /* Length in hundredths of 283 * millimeters */ 284 bottom, /* Bottom margin in hundredths of 285 * millimeters */ 286 left, /* Left margin in hundredths of 287 * millimeters */ 288 right, /* Right margin in hundredths of 289 * millimeters */ 290 top; /* Top margin in hundredths of 291 * millimeters */ 292 } cups_size_t; 293 294 typedef int (*cups_client_cert_cb_t)(http_t *http, void *tls, 295 cups_array_t *distinguished_names, 296 void *user_data); 297 /* Client credentials callback 298 * @since CUPS 1.5/macOS 10.7@ */ 299 300 typedef int (*cups_dest_cb_t)(void *user_data, unsigned flags, 301 cups_dest_t *dest); 302 /* Destination enumeration callback 303 * @since CUPS 1.6/macOS 10.8@ */ 304 305 # ifdef __BLOCKS__ 306 typedef int (^cups_dest_block_t)(unsigned flags, cups_dest_t *dest); 307 /* Destination enumeration block 308 * @since CUPS 1.6/macOS 10.8@ 309 * @exclude all@ */ 310 # endif /* __BLOCKS__ */ 311 312 typedef const char *(*cups_password_cb_t)(const char *prompt); 313 /* Password callback @exclude all@ */ 314 315 typedef const char *(*cups_password_cb2_t)(const char *prompt, http_t *http, 316 const char *method, 317 const char *resource, 318 void *user_data); 319 /* New password callback 320 * @since CUPS 1.4/macOS 10.6@ */ 321 322 typedef int (*cups_server_cert_cb_t)(http_t *http, void *tls, 323 cups_array_t *certs, void *user_data); 324 /* Server credentials callback 325 * @since CUPS 1.5/macOS 10.7@ */ 326 327 328 /* 329 * Functions... 330 */ 331 332 extern int cupsCancelJob(const char *name, int job_id) _CUPS_PUBLIC; 333 extern ipp_t *cupsDoFileRequest(http_t *http, ipp_t *request, 334 const char *resource, 335 const char *filename) _CUPS_PUBLIC; 336 extern ipp_t *cupsDoRequest(http_t *http, ipp_t *request, 337 const char *resource) _CUPS_PUBLIC; 338 extern http_encryption_t cupsEncryption(void); 339 extern void cupsFreeJobs(int num_jobs, cups_job_t *jobs) _CUPS_PUBLIC; 340 extern int cupsGetClasses(char ***classes) _CUPS_DEPRECATED_MSG("Use cupsEnumDests instead."); 341 extern const char *cupsGetDefault(void) _CUPS_PUBLIC; 342 extern int cupsGetJobs(cups_job_t **jobs, const char *name, 343 int myjobs, int whichjobs) _CUPS_PUBLIC; 344 extern int cupsGetPrinters(char ***printers) _CUPS_DEPRECATED_MSG("Use cupsEnumDests instead."); 345 extern ipp_status_t cupsLastError(void) _CUPS_PUBLIC; 346 extern int cupsPrintFile(const char *name, const char *filename, 347 const char *title, int num_options, 348 cups_option_t *options) _CUPS_PUBLIC; 349 extern int cupsPrintFiles(const char *name, int num_files, 350 const char **files, const char *title, 351 int num_options, cups_option_t *options) _CUPS_PUBLIC; 352 extern char *cupsTempFile(char *filename, int len) _CUPS_DEPRECATED_MSG("Use cupsTempFd or cupsTempFile2 instead."); 353 extern int cupsTempFd(char *filename, int len) _CUPS_PUBLIC; 354 355 extern int cupsAddDest(const char *name, const char *instance, 356 int num_dests, cups_dest_t **dests) _CUPS_PUBLIC; 357 extern void cupsFreeDests(int num_dests, cups_dest_t *dests) _CUPS_PUBLIC; 358 extern cups_dest_t *cupsGetDest(const char *name, const char *instance, 359 int num_dests, cups_dest_t *dests) _CUPS_PUBLIC; 360 extern int cupsGetDests(cups_dest_t **dests) _CUPS_PUBLIC; 361 extern void cupsSetDests(int num_dests, cups_dest_t *dests) _CUPS_PUBLIC; 362 363 extern int cupsAddOption(const char *name, const char *value, 364 int num_options, cups_option_t **options) _CUPS_PUBLIC; 365 extern void cupsEncodeOptions(ipp_t *ipp, int num_options, 366 cups_option_t *options) _CUPS_PUBLIC; 367 extern void cupsFreeOptions(int num_options, 368 cups_option_t *options) _CUPS_PUBLIC; 369 extern const char *cupsGetOption(const char *name, int num_options, 370 cups_option_t *options) _CUPS_PUBLIC; 371 extern int cupsParseOptions(const char *arg, int num_options, 372 cups_option_t **options) _CUPS_PUBLIC; 373 374 extern const char *cupsGetPassword(const char *prompt) _CUPS_PUBLIC; 375 extern const char *cupsServer(void) _CUPS_PUBLIC; 376 extern void cupsSetEncryption(http_encryption_t e) _CUPS_PUBLIC; 377 extern void cupsSetPasswordCB(cups_password_cb_t cb) _CUPS_PUBLIC; 378 extern void cupsSetServer(const char *server) _CUPS_PUBLIC; 379 extern void cupsSetUser(const char *user) _CUPS_PUBLIC; 380 extern const char *cupsUser(void) _CUPS_PUBLIC; 381 382 /**** New in CUPS 1.1.20 ****/ 383 extern int cupsDoAuthentication(http_t *http, const char *method, 384 const char *resource) 385 _CUPS_API_1_1_20; 386 extern http_status_t cupsGetFile(http_t *http, const char *resource, 387 const char *filename) _CUPS_API_1_1_20; 388 extern http_status_t cupsGetFd(http_t *http, const char *resource, int fd) _CUPS_API_1_1_20; 389 extern http_status_t cupsPutFile(http_t *http, const char *resource, 390 const char *filename) _CUPS_API_1_1_20; 391 extern http_status_t cupsPutFd(http_t *http, const char *resource, int fd) 392 _CUPS_API_1_1_20; 393 394 /**** New in CUPS 1.1.21 ****/ 395 extern const char *cupsGetDefault2(http_t *http) _CUPS_API_1_1_21; 396 extern int cupsGetDests2(http_t *http, cups_dest_t **dests) 397 _CUPS_API_1_1_21; 398 extern int cupsGetJobs2(http_t *http, cups_job_t **jobs, 399 const char *name, int myjobs, 400 int whichjobs) _CUPS_API_1_1_21; 401 extern int cupsPrintFile2(http_t *http, const char *name, 402 const char *filename, 403 const char *title, int num_options, 404 cups_option_t *options) _CUPS_API_1_1_21; 405 extern int cupsPrintFiles2(http_t *http, const char *name, 406 int num_files, const char **files, 407 const char *title, int num_options, 408 cups_option_t *options) 409 _CUPS_API_1_1_21; 410 extern int cupsSetDests2(http_t *http, int num_dests, 411 cups_dest_t *dests) _CUPS_API_1_1_21; 412 413 /**** New in CUPS 1.2/macOS 10.5 ****/ 414 extern void cupsEncodeOptions2(ipp_t *ipp, int num_options, 415 cups_option_t *options, 416 ipp_tag_t group_tag) _CUPS_API_1_2; 417 extern const char *cupsLastErrorString(void) _CUPS_API_1_2; 418 extern char *cupsNotifySubject(cups_lang_t *lang, ipp_t *event) 419 _CUPS_API_1_2; 420 extern char *cupsNotifyText(cups_lang_t *lang, ipp_t *event) 421 _CUPS_API_1_2; 422 extern int cupsRemoveOption(const char *name, int num_options, 423 cups_option_t **options) _CUPS_API_1_2; 424 extern cups_file_t *cupsTempFile2(char *filename, int len) _CUPS_API_1_2; 425 426 /**** New in CUPS 1.3/macOS 10.5 ****/ 427 extern ipp_t *cupsDoIORequest(http_t *http, ipp_t *request, 428 const char *resource, int infile, 429 int outfile) _CUPS_API_1_3; 430 extern int cupsRemoveDest(const char *name, 431 const char *instance, 432 int num_dests, cups_dest_t **dests) 433 _CUPS_API_1_3; 434 extern void cupsSetDefaultDest(const char *name, 435 const char *instance, 436 int num_dests, 437 cups_dest_t *dests) _CUPS_API_1_3; 438 439 /**** New in CUPS 1.4/macOS 10.6 ****/ 440 extern ipp_status_t cupsCancelJob2(http_t *http, const char *name, 441 int job_id, int purge) _CUPS_API_1_4; 442 extern int cupsCreateJob(http_t *http, const char *name, 443 const char *title, int num_options, 444 cups_option_t *options) _CUPS_API_1_4; 445 extern ipp_status_t cupsFinishDocument(http_t *http, 446 const char *name) _CUPS_API_1_4; 447 extern cups_dest_t *cupsGetNamedDest(http_t *http, const char *name, 448 const char *instance) _CUPS_API_1_4; 449 extern const char *cupsGetPassword2(const char *prompt, http_t *http, 450 const char *method, 451 const char *resource) _CUPS_API_1_4; 452 extern ipp_t *cupsGetResponse(http_t *http, 453 const char *resource) _CUPS_API_1_4; 454 extern ssize_t cupsReadResponseData(http_t *http, char *buffer, 455 size_t length) _CUPS_API_1_4; 456 extern http_status_t cupsSendRequest(http_t *http, ipp_t *request, 457 const char *resource, 458 size_t length) _CUPS_API_1_4; 459 extern void cupsSetPasswordCB2(cups_password_cb2_t cb, 460 void *user_data) _CUPS_API_1_4; 461 extern http_status_t cupsStartDocument(http_t *http, const char *name, 462 int job_id, const char *docname, 463 const char *format, 464 int last_document) _CUPS_API_1_4; 465 extern http_status_t cupsWriteRequestData(http_t *http, const char *buffer, 466 size_t length) _CUPS_API_1_4; 467 468 /**** New in CUPS 1.5/macOS 10.7 ****/ 469 extern void cupsSetClientCertCB(cups_client_cert_cb_t cb, 470 void *user_data) _CUPS_API_1_5; 471 extern int cupsSetCredentials(cups_array_t *certs) _CUPS_API_1_5; 472 extern void cupsSetServerCertCB(cups_server_cert_cb_t cb, 473 void *user_data) _CUPS_API_1_5; 474 475 /**** New in CUPS 1.6/macOS 10.8 ****/ 476 extern ipp_status_t cupsCancelDestJob(http_t *http, cups_dest_t *dest, 477 int job_id) _CUPS_API_1_6; 478 extern int cupsCheckDestSupported(http_t *http, cups_dest_t *dest, 479 cups_dinfo_t *info, 480 const char *option, 481 const char *value) _CUPS_API_1_6; 482 extern ipp_status_t cupsCloseDestJob(http_t *http, cups_dest_t *dest, 483 cups_dinfo_t *info, int job_id) 484 _CUPS_API_1_6; 485 extern http_t *cupsConnectDest(cups_dest_t *dest, unsigned flags, 486 int msec, int *cancel, 487 char *resource, size_t resourcesize, 488 cups_dest_cb_t cb, void *user_data) 489 _CUPS_API_1_6; 490 # ifdef __BLOCKS__ 491 extern http_t *cupsConnectDestBlock(cups_dest_t *dest, 492 unsigned flags, int msec, 493 int *cancel, char *resource, 494 size_t resourcesize, 495 cups_dest_block_t block) 496 _CUPS_API_1_6; 497 # endif /* __BLOCKS__ */ 498 extern int cupsCopyDest(cups_dest_t *dest, int num_dests, 499 cups_dest_t **dests) _CUPS_API_1_6; 500 extern cups_dinfo_t *cupsCopyDestInfo(http_t *http, cups_dest_t *dest) 501 _CUPS_API_1_6; 502 extern int cupsCopyDestConflicts(http_t *http, cups_dest_t *dest, 503 cups_dinfo_t *info, 504 int num_options, 505 cups_option_t *options, 506 const char *new_option, 507 const char *new_value, 508 int *num_conflicts, 509 cups_option_t **conflicts, 510 int *num_resolved, 511 cups_option_t **resolved) 512 _CUPS_API_1_6; 513 extern ipp_status_t cupsCreateDestJob(http_t *http, cups_dest_t *dest, 514 cups_dinfo_t *info, int *job_id, 515 const char *title, int num_options, 516 cups_option_t *options) _CUPS_API_1_6; 517 extern int cupsEnumDests(unsigned flags, int msec, int *cancel, 518 cups_ptype_t type, cups_ptype_t mask, 519 cups_dest_cb_t cb, void *user_data) 520 _CUPS_API_1_6; 521 # ifdef __BLOCKS__ 522 extern int cupsEnumDestsBlock(unsigned flags, int msec, 523 int *cancel, cups_ptype_t type, 524 cups_ptype_t mask, 525 cups_dest_block_t block) 526 _CUPS_API_1_6; 527 # endif /* __BLOCKS__ */ 528 extern ipp_status_t cupsFinishDestDocument(http_t *http, 529 cups_dest_t *dest, 530 cups_dinfo_t *info) 531 _CUPS_API_1_6; 532 extern void cupsFreeDestInfo(cups_dinfo_t *dinfo) _CUPS_API_1_6; 533 extern int cupsGetDestMediaByName(http_t *http, cups_dest_t *dest, 534 cups_dinfo_t *dinfo, 535 const char *media, 536 unsigned flags, 537 cups_size_t *size) _CUPS_API_1_6; 538 extern int cupsGetDestMediaBySize(http_t *http, cups_dest_t *dest, 539 cups_dinfo_t *dinfo, 540 int width, int length, 541 unsigned flags, 542 cups_size_t *size) _CUPS_API_1_6; 543 extern const char *cupsLocalizeDestOption(http_t *http, cups_dest_t *dest, 544 cups_dinfo_t *info, 545 const char *option) 546 _CUPS_API_1_6; 547 extern const char *cupsLocalizeDestValue(http_t *http, cups_dest_t *dest, 548 cups_dinfo_t *info, 549 const char *option, 550 const char *value) 551 _CUPS_API_1_6; 552 extern http_status_t cupsStartDestDocument(http_t *http, cups_dest_t *dest, 553 cups_dinfo_t *info, int job_id, 554 const char *docname, 555 const char *format, 556 int num_options, 557 cups_option_t *options, 558 int last_document) _CUPS_API_1_6; 559 560 /* New in CUPS 1.7 */ 561 extern ipp_attribute_t *cupsFindDestDefault(http_t *http, cups_dest_t *dest, 562 cups_dinfo_t *dinfo, 563 const char *option) _CUPS_API_1_7; 564 extern ipp_attribute_t *cupsFindDestReady(http_t *http, cups_dest_t *dest, 565 cups_dinfo_t *dinfo, 566 const char *option) _CUPS_API_1_7; 567 extern ipp_attribute_t *cupsFindDestSupported(http_t *http, cups_dest_t *dest, 568 cups_dinfo_t *dinfo, 569 const char *option) 570 _CUPS_API_1_7; 571 extern int cupsGetDestMediaByIndex(http_t *http, cups_dest_t *dest, 572 cups_dinfo_t *dinfo, int n, 573 unsigned flags, 574 cups_size_t *size) 575 _CUPS_API_1_7; 576 extern int cupsGetDestMediaCount(http_t *http, cups_dest_t *dest, 577 cups_dinfo_t *dinfo, 578 unsigned flags) _CUPS_API_1_7; 579 extern int cupsGetDestMediaDefault(http_t *http, cups_dest_t *dest, 580 cups_dinfo_t *dinfo, 581 unsigned flags, 582 cups_size_t *size) 583 _CUPS_API_1_7; 584 extern void cupsSetUserAgent(const char *user_agent) _CUPS_API_1_7; 585 extern const char *cupsUserAgent(void) _CUPS_API_1_7; 586 587 /* New in CUPS 2.0/macOS 10.10 */ 588 extern cups_dest_t *cupsGetDestWithURI(const char *name, const char *uri) _CUPS_API_2_0; 589 extern const char *cupsLocalizeDestMedia(http_t *http, cups_dest_t *dest, cups_dinfo_t *info, unsigned flags, cups_size_t *size) _CUPS_API_2_0; 590 extern int cupsMakeServerCredentials(const char *path, const char *common_name, int num_alt_names, const char **alt_names, time_t expiration_date) _CUPS_API_2_0; 591 extern int cupsSetServerCredentials(const char *path, const char *common_name, int auto_create) _CUPS_API_2_0; 592 593 /* New in CUPS 2.2/macOS 10.12 */ 594 extern ssize_t cupsHashData(const char *algorithm, const void *data, size_t datalen, unsigned char *hash, size_t hashsize) _CUPS_API_2_2; 595 596 /* New in CUPS 2.2.4 */ 597 extern int cupsAddIntegerOption(const char *name, int value, int num_options, cups_option_t **options) _CUPS_API_2_2_4; 598 extern int cupsGetIntegerOption(const char *name, int num_options, cups_option_t *options) _CUPS_API_2_2_4; 599 600 /* New in CUPS 2.2.7 */ 601 extern const char *cupsHashString(const unsigned char *hash, size_t hashsize, char *buffer, size_t bufsize) _CUPS_API_2_2_7; 602 603 /* New in CUPS 2.3 */ 604 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; 605 extern ipp_attribute_t *cupsEncodeOption(ipp_t *ipp, ipp_tag_t group_tag, const char *name, const char *value) _CUPS_API_2_3; 606 607 # ifdef __cplusplus 608 } 609 # endif /* __cplusplus */ 610 611 #endif /* !_CUPS_CUPS_H_ */ 612