cups/globals.h

   1 /*
   2  * "$Id: globals.h 5319 2006-03-21 15:28:29Z mike $"
   3  *
   4  *   Global variable definitions for the Common UNIX Printing System (CUPS).
   5  *
   6  *   Copyright 1997-2006 by Easy Software Products, all rights reserved.
   7  *
   8  *   These coded instructions, statements, and computer programs are the
   9  *   property of Easy Software Products and are protected by Federal
  10  *   copyright law.  Distribution and use rights are outlined in the file
  11  *   "LICENSE.txt" which should have been included with this file.  If this
  12  *   file is missing or damaged please contact Easy Software Products
  13  *   at:
  14  *
  15  *       Attn: CUPS Licensing Information
  16  *       Easy Software Products
  17  *       44141 Airport View Drive, Suite 204
  18  *       Hollywood, Maryland 20636 USA
  19  *
  20  *       Voice: (301) 373-9600
  21  *       EMail: cups-info@cups.org
  22  *         WWW: http://www.cups.org
  23  *
  24  *   This file is subject to the Apple OS-Developed Software exception.
  25  */
  26
  27 #ifndef _CUPS_GLOBALS_H_
  28 #  define _CUPS_GLOBALS_H_
  29
  30 /*
  31  * Include necessary headers...
  32  */
  33
  34 #  include "string.h"
  35 #  include "cups.h"
  36 #  include "i18n.h"
  37
  38 #  ifdef HAVE_PTHREAD_H
  39 #    include <pthread.h>
  40 #  endif /* HAVE_PTHREAD_H */
  41
  42
  43 /*
  44  * C++ magic...
  45  */
  46
  47 #  ifdef __cplusplus
  48 extern "C" {
  49 #  endif /* __cplusplus */
  50
  51
  52 /*
  53  * To make libcups thread safe, define thread safe globals (aka thread-
  54  * specific data) for the static variables used in the library.
  55  */
  56
  57 typedef struct _cups_globals_s          /**** CUPS global state data ****/
  58 {
  59   /* Multiple places... */
  60   const char            *cups_datadir,  /* CUPS_DATADIR environment var */
  61                         *cups_serverbin,/* CUPS_SERVERBIN environment var */
  62                         *cups_serverroot,
  63                                         /* CUPS_SERVERROOT environment var */
  64                         *cups_statedir, /* CUPS_STATEDIR environment var */
  65                         *localedir;     /* LOCALDIR environment var */
  66
  67   /* adminutil.c */
  68   time_t                cupsd_update;   /* Last time we got or set cupsd.conf */
  69   char                  cupsd_hostname[HTTP_MAX_HOST];
  70                                         /* Hostname for connection */
  71   int                   cupsd_num_settings;
  72                                         /* Number of server settings */
  73   cups_option_t         *cupsd_settings;/* Server settings */
  74
  75   /* file.c */
  76   cups_file_t           *stdio_files[3];/* stdin, stdout, stderr */
  77
  78   /* http.c */
  79   char                  http_date[256]; /* Date+time buffer */
  80
  81   /* http-addr.c */
  82   unsigned              ip_addr;        /* Packed IPv4 address */
  83   char                  *ip_ptrs[2];    /* Pointer to packed address */
  84   struct hostent        hostent;        /* Host entry for IP address */
  85 #  ifdef HAVE_GETADDRINFO
  86   char                  hostname[1024]; /* Hostname */
  87 #  endif /* HAVE_GETADDRINFO */
  88
  89   /* ipp.c */
  90   ipp_uchar_t           ipp_date[11];   /* RFC-1903 date/time data */
  91
  92   /* ipp-support.c */
  93   int                   ipp_port;       /* IPP port number */
  94   char                  ipp_unknown[255];
  95                                         /* Unknown error statuses */
  96
  97   /* language.c */
  98   cups_lang_t           *lang_cache;    /* Language string cache */
  99   cups_lang_t           *lang_default;  /* Default language */
 100 #  ifdef __APPLE__
 101 #    ifdef HAVE_CF_LOCALE_ID
 102   char                  language[32];   /* Cached language */
 103 #    else
 104   const char            *language;      /* Cached language */
 105 #    endif /* HAVE_CF_LOCALE_ID */
 106 #  endif /* __APPLE__ */
 107
 108   /* ppd.c */
 109   ppd_status_t          ppd_status;     /* Status of last ppdOpen*() */
 110   int                   ppd_line;       /* Current line number */
 111   ppd_conform_t         ppd_conform;    /* Level of conformance required */
 112
 113   /* tempfile.c */
 114   char                  tempfile[1024]; /* cupsTempFd/File buffer */
 115
 116   /* transcode.c */
 117   _cups_cmap_t          *cmap_cache;    /* SBCS Charmap Cache */
 118   _cups_vmap_t          *vmap_cache;    /* VBCS Charmap Cache */
 119
 120   /* usersys.c */
 121   http_encryption_t     encryption;     /* Encryption setting */
 122   char                  user[65],       /* User name */
 123                         server[256],    /* Server address */
 124                         servername[256];/* Server hostname */
 125   cups_password_cb_t    password_cb;    /* Password callback */
 126
 127   /* util.c */
 128   http_t                *http;          /* Current server connection */
 129   ipp_status_t          last_error;     /* Last IPP error */
 130   char                  *last_status_message;
 131                                         /* Last IPP status-message */
 132
 133   char                  def_printer[256];
 134                                         /* Default printer */
 135   char                  ppd_filename[HTTP_MAX_URI];
 136                                         /* PPD filename */
 137
 138   /* string.c */
 139   cups_array_t          *stringpool;    /* String pool */
 140 } _cups_globals_t;
 141
 142
 143 /*
 144  * Prototypes...
 145  */
 146
 147 extern void             _cupsCharmapFlush(_cups_globals_t *cg);
 148 extern const char       *_cupsGetPassword(const char *prompt);
 149 extern _cups_globals_t  *_cupsGlobals(void);
 150 extern void             _cupsLangFlush(_cups_globals_t *cg);
 151 extern void             _cupsSetError(ipp_status_t status, const char *message);
 152 extern void             _cupsStrFlush(_cups_globals_t *cg);
 153
 154
 155 /*
 156  * C++ magic...
 157  */
 158
 159 #  ifdef __cplusplus
 160 }
 161 #  endif /* __cplusplus */
 162 #endif /* !_CUPS_GLOBALS_H_ */
 163
 164 /*
 165  * End of "$Id: globals.h 5319 2006-03-21 15:28:29Z mike $".
 166  */