]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - cups/cups-private.h
Allow ippSetXxx from no-value or unknown to the corresponding type.
[thirdparty/cups.git] / cups / cups-private.h
index 6e1677f8867a2bd7525784062aa5142e5940e5c0..2b363e6d63427db4d1dde0ef539ce5e4c5bacf40 100644 (file)
@@ -1,18 +1,11 @@
 /*
- * "$Id: cups-private.h 9596 2011-03-11 18:26:36Z mike $"
+ * Private definitions for CUPS.
  *
- *   Private definitions for CUPS.
+ * Copyright © 2007-2018 by Apple Inc.
+ * Copyright © 1997-2007 by Easy Software Products, all rights reserved.
  *
- *   Copyright 2007-2011 by Apple Inc.
- *   Copyright 1997-2007 by Easy Software Products, all rights reserved.
- *
- *   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
- *   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_PRIVATE_H_
  * Include necessary headers...
  */
 
-#  include <cups/cups.h>
 #  include "string-private.h"
-#  include "debug-private.h"
-#  include "ppd-private.h"
-#  include "http-private.h"
+#  include "array-private.h"
 #  include "ipp-private.h"
+#  include "http-private.h"
 #  include "language-private.h"
 #  include "pwg-private.h"
 #  include "thread-private.h"
+#  include <cups/cups.h>
 #  ifdef __APPLE__
 #    include <sys/cdefs.h>
 #    include <CoreFoundation/CoreFoundation.h>
@@ -50,6 +42,21 @@ extern "C" {
  * Types...
  */
 
+typedef struct _cups_buffer_s          /**** Read/write buffer ****/
+{
+  struct _cups_buffer_s        *next;          /* Next buffer in list */
+  size_t               size;           /* Size of buffer */
+  char                 used,           /* Is this buffer used? */
+                       d[1];           /* Data buffer */
+} _cups_buffer_t;
+
+typedef struct _cups_raster_error_s    /**** Error buffer structure ****/
+{
+  char *start,                         /* Start of buffer */
+       *current,                       /* Current position in buffer */
+       *end;                           /* End of buffer */
+} _cups_raster_error_t;
+
 typedef struct _cups_globals_s         /**** CUPS global state data ****/
 {
   /* Multiple places... */
@@ -68,10 +75,21 @@ typedef struct _cups_globals_s              /**** CUPS global state data ****/
                                        /* Number of server settings */
   cups_option_t                *cupsd_settings;/* Server settings */
 
+  /* auth.c */
+#  ifdef HAVE_GSSAPI
+  char                 gss_service_name[32];
+                                       /* Kerberos service name */
+#  endif /* HAVE_GSSAPI */
+
   /* backend.c */
   char                 resolved_uri[1024];
                                        /* Buffer for cupsBackendDeviceURI */
 
+  /* debug.c */
+#  ifdef DEBUG
+  int                  thread_id;      /* Friendly thread ID */
+#  endif /* DEBUG */
+
   /* file.c */
   cups_file_t          *stdio_files[3];/* stdin, stdout, stderr */
 
@@ -88,8 +106,8 @@ typedef struct _cups_globals_s               /**** CUPS global state data ****/
   int                  need_res_init;  /* Need to reinitialize resolver? */
 
   /* ipp.c */
-  ipp_uchar_t          ipp_date[11];   /* RFC-1903 date/time data */
-  _ipp_buffer_t                *ipp_buffers;   /* Buffer list */
+  ipp_uchar_t          ipp_date[11];   /* RFC-2579 date/time data */
+  _cups_buffer_t       *cups_buffers;  /* Buffer list */
 
   /* ipp-support.c */
   int                  ipp_port;       /* IPP port number */
@@ -102,17 +120,16 @@ typedef struct _cups_globals_s            /**** CUPS global state data ****/
   char                 language[32];   /* Cached language */
 #  endif /* __APPLE__ */
 
-  /* ppd.c */
-  ppd_status_t         ppd_status;     /* Status of last ppdOpen*() */
-  int                  ppd_line;       /* Current line number */
-  ppd_conform_t                ppd_conform;    /* Level of conformance required */
-
   /* pwg-media.c */
   cups_array_t         *leg_size_lut,  /* Lookup table for legacy names */
                        *ppd_size_lut,  /* Lookup table for PPD names */
                        *pwg_size_lut;  /* Lookup table for PWG names */
-  _pwg_media_t         pwg_media;      /* PWG media data for custom size */
-  char                 pwg_name[65];   /* PWG media name for custom size */
+  pwg_media_t          pwg_media;      /* PWG media data for custom size */
+  char                 pwg_name[65],   /* PWG media name for custom size */
+                       ppd_name[41];   /* PPD media name for custom size */
+
+  /* raster-error.c */
+  _cups_raster_error_t raster_error;   /* Raster error information */
 
   /* request.c */
   http_t               *http;          /* Current server connection */
@@ -131,8 +148,10 @@ typedef struct _cups_globals_s             /**** CUPS global state data ****/
   /* usersys.c */
   http_encryption_t    encryption;     /* Encryption setting */
   char                 user[65],       /* User name */
+                       user_agent[256],/* User-Agent string */
                        server[256],    /* Server address */
-                       servername[256];/* Server hostname */
+                       servername[256],/* Server hostname */
+                       password[128];  /* Password for default callback */
   cups_password_cb2_t  password_cb;    /* Password callback */
   void                 *password_data; /* Password user data */
   http_tls_credentials_t tls_credentials;
@@ -143,49 +162,104 @@ typedef struct _cups_globals_s           /**** CUPS global state data ****/
   cups_server_cert_cb_t        server_cert_cb; /* Server certificate callback */
   void                 *server_cert_data;
                                        /* Server certificate user data */
-  int                  any_root,       /* Allow any root */
+  int                  server_version, /* Server IPP version */
+                       trust_first,    /* Trust on first use? */
+                       any_root,       /* Allow any (e.g., self-signed) root */
                        expired_certs,  /* Allow expired certs */
-                       expired_root;   /* Allow expired root */
+                       validate_certs; /* Validate certificates */
 
   /* util.c */
   char                 def_printer[256];
                                        /* Default printer */
-  char                 ppd_filename[HTTP_MAX_URI];
-                                       /* PPD filename */
 } _cups_globals_t;
 
+typedef struct _cups_media_db_s                /* Media database */
+{
+  char         *color,                 /* Media color, if any */
+               *key,                   /* Media key, if any */
+               *info,                  /* Media human-readable name, if any */
+               *size_name,             /* Media PWG size name, if provided */
+               *source,                /* Media source, if any */
+               *type;                  /* Media type, if any */
+  int          width,                  /* Width in hundredths of millimeters */
+               length,                 /* Length in hundredths of
+                                        * millimeters */
+               bottom,                 /* Bottom margin in hundredths of
+                                        * millimeters */
+               left,                   /* Left margin in hundredths of
+                                        * millimeters */
+               right,                  /* Right margin in hundredths of
+                                        * millimeters */
+               top;                    /* Top margin in hundredths of
+                                        * millimeters */
+} _cups_media_db_t;
+
+typedef struct _cups_dconstres_s       /* Constraint/resolver */
+{
+  char *name;                          /* Name of resolver */
+  ipp_t        *collection;                    /* Collection containing attrs */
+} _cups_dconstres_t;
+
+struct _cups_dinfo_s                   /* Destination capability and status
+                                        * information */
+{
+  int                  version;        /* IPP version */
+  const char           *uri;           /* Printer URI */
+  char                 *resource;      /* Resource path */
+  ipp_t                        *attrs;         /* Printer attributes */
+  int                  num_defaults;   /* Number of default options */
+  cups_option_t                *defaults;      /* Default options */
+  cups_array_t         *constraints;   /* Job constraints */
+  cups_array_t         *resolvers;     /* Job resolvers */
+  cups_array_t         *localizations; /* Localization information */
+  cups_array_t         *media_db;      /* Media database */
+  _cups_media_db_t     min_size,       /* Minimum size */
+                       max_size;       /* Maximum size */
+  unsigned             cached_flags;   /* Flags used for cached media */
+  cups_array_t         *cached_db;     /* Cache of media from last index/default */
+  time_t               ready_time;     /* When xxx-ready attributes were last queried */
+  ipp_t                        *ready_attrs;   /* xxx-ready attributes */
+  cups_array_t         *ready_db;      /* media[-col]-ready media database */
+};
+
 
 /*
  * Prototypes...
  */
 
 #  ifdef __APPLE__
-extern CFStringRef     _cupsAppleCopyDefaultPaperID(void);
-extern CFStringRef     _cupsAppleCopyDefaultPrinter(void);
-extern int             _cupsAppleGetUseLastPrinter(void);
-extern void            _cupsAppleSetDefaultPaperID(CFStringRef name);
-extern void            _cupsAppleSetDefaultPrinter(CFStringRef name);
-extern void            _cupsAppleSetUseLastPrinter(int uselast);
+extern CFStringRef     _cupsAppleCopyDefaultPaperID(void) _CUPS_PRIVATE;
+extern CFStringRef     _cupsAppleCopyDefaultPrinter(void) _CUPS_PRIVATE;
+extern int             _cupsAppleGetUseLastPrinter(void) _CUPS_PRIVATE;
+extern void            _cupsAppleSetDefaultPaperID(CFStringRef name) _CUPS_PRIVATE;
+extern void            _cupsAppleSetDefaultPrinter(CFStringRef name) _CUPS_PRIVATE;
+extern void            _cupsAppleSetUseLastPrinter(int uselast) _CUPS_PRIVATE;
 #  endif /* __APPLE__ */
 
-extern http_t          *_cupsConnect(void);
-extern int             _cupsGet1284Values(const char *device_id,
-                                          cups_option_t **values);
-extern int             _cupsGetDests(http_t *http, ipp_op_t op,
-                                     const char *name, cups_dest_t **dests);
-extern const char      *_cupsGetPassword(const char *prompt);
-extern void            _cupsGlobalLock(void);
-extern _cups_globals_t *_cupsGlobals(void);
-extern void            _cupsGlobalUnlock(void);
-extern int             _cupsNextDelay(int current, int *previous);
-extern void            _cupsSetDefaults(void);
-extern void            _cupsSetError(ipp_status_t status, const char *message,
-                                     int localize);
-extern void            _cupsSetHTTPError(http_status_t status);
+extern char            *_cupsBufferGet(size_t size) _CUPS_PRIVATE;
+extern void            _cupsBufferRelease(char *b) _CUPS_PRIVATE;
+
+extern http_t          *_cupsConnect(void) _CUPS_PRIVATE;
+extern char            *_cupsCreateDest(const char *name, const char *info, const char *device_id, const char *device_uri, char *uri, size_t urisize) _CUPS_PRIVATE;
+extern ipp_attribute_t *_cupsEncodeOption(ipp_t *ipp, ipp_tag_t group_tag, _ipp_option_t *map, const char *name, const char *value) _CUPS_PRIVATE;
+extern int             _cupsGet1284Values(const char *device_id, cups_option_t **values) _CUPS_PRIVATE;
+extern const char      *_cupsGetDestResource(cups_dest_t *dest, unsigned flags, char *resource, size_t resourcesize) _CUPS_PRIVATE;
+extern int             _cupsGetDests(http_t *http, ipp_op_t op, const char *name, cups_dest_t **dests, cups_ptype_t type, cups_ptype_t mask) _CUPS_PRIVATE;
+extern const char      *_cupsGetPassword(const char *prompt) _CUPS_PRIVATE;
+extern void            _cupsGlobalLock(void) _CUPS_PRIVATE;
+extern _cups_globals_t *_cupsGlobals(void) _CUPS_PRIVATE;
+extern void            _cupsGlobalUnlock(void) _CUPS_PRIVATE;
+#  ifdef HAVE_GSSAPI
+extern const char      *_cupsGSSServiceName(void) _CUPS_PRIVATE;
+#  endif /* HAVE_GSSAPI */
+extern int             _cupsNextDelay(int current, int *previous) _CUPS_PRIVATE;
+extern void            _cupsSetDefaults(void) _CUPS_INTERNAL;
+extern void            _cupsSetError(ipp_status_t status, const char *message, int localize) _CUPS_PRIVATE;
+extern void            _cupsSetHTTPError(http_status_t status) _CUPS_INTERNAL;
 #  ifdef HAVE_GSSAPI
-extern int             _cupsSetNegotiateAuthString(http_t *http);
+extern int             _cupsSetNegotiateAuthString(http_t *http, const char *method, const char *resource) _CUPS_PRIVATE;
 #  endif /* HAVE_GSSAPI */
-extern char            *_cupsUserDefault(char *name, size_t namesize);
+extern char            *_cupsUserDefault(char *name, size_t namesize) _CUPS_INTERNAL;
 
 
 /*
@@ -196,7 +270,3 @@ extern char         *_cupsUserDefault(char *name, size_t namesize);
 }
 #  endif /* __cplusplus */
 #endif /* !_CUPS_CUPS_PRIVATE_H_ */
-
-/*
- * End of "$Id: cups-private.h 9596 2011-03-11 18:26:36Z mike $".
- */