[thirdparty/cups.git] / cups / globals.h

/*
 * "$Id: globals.h 5294 2006-03-15 21:09:32Z mike $"
 *
 *   Global variable definitions for the Common UNIX Printing System (CUPS).
 *
 *   Copyright 1997-2006 by Easy Software Products, all rights reserved.
 *
 *   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
 *
 *   This file is subject to the Apple OS-Developed Software exception.
 */

#ifndef _CUPS_GLOBALS_H_
#  define _CUPS_GLOBALS_H_

/*
 * Include necessary headers...
 */

#  include "string.h"
#  include "cups.h"
#  include "i18n.h"

#  ifdef HAVE_PTHREAD_H
#    include <pthread.h>
#  endif /* HAVE_PTHREAD_H */


/*
 * C++ magic...
 */

#  ifdef __cplusplus
extern "C" {
#  endif /* __cplusplus */


/*
 * To make libcups thread safe, define thread safe globals (aka thread-
 * specific data) for the static variables used in the library.
 */

typedef struct _cups_globals_s		/**** CUPS global state data ****/
{
  /* Multiple places... */
  const char		*cups_datadir,	/* CUPS_DATADIR environment var */
			*cups_serverbin,/* CUPS_SERVERBIN environment var */
			*cups_serverroot,
					/* CUPS_SERVERROOT environment var */
			*cups_statedir,	/* CUPS_STATEDIR environment var */
			*localedir;	/* LOCALDIR environment var */

  /* adminutil.c */
  time_t		cupsd_update;	/* Last time we got or set cupsd.conf */
  char			cupsd_hostname[HTTP_MAX_HOST];
					/* Hostname for connection */
  int			cupsd_num_settings;
					/* Number of server settings */
  cups_option_t		*cupsd_settings;/* Server settings */

  /* http.c */
  char			http_date[256];	/* Date+time buffer */

  /* http-addr.c */
  unsigned		ip_addr;	/* Packed IPv4 address */
  char			*ip_ptrs[2];	/* Pointer to packed address */
  struct hostent	hostent;	/* Host entry for IP address */
#  ifdef HAVE_GETADDRINFO
  char			hostname[1024];	/* Hostname */
#  endif /* HAVE_GETADDRINFO */

  /* ipp.c */
  ipp_uchar_t		ipp_date[11];	/* RFC-1903 date/time data */

  /* ipp-support.c */
  int			ipp_port;	/* IPP port number */
  char			ipp_unknown[255];
					/* Unknown error statuses */

  /* language.c */
  cups_lang_t		*lang_cache;	/* Language string cache */
  cups_lang_t		*lang_default;	/* Default language */
#  ifdef __APPLE__
#    ifdef HAVE_CF_LOCALE_ID
  char			language[32];	/* Cached language */
#    else
  const char		*language;	/* Cached language */
#    endif /* HAVE_CF_LOCALE_ID */
#  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 */

  /* tempfile.c */
  char			tempfile[1024];	/* cupsTempFd/File buffer */

  /* transcode.c */
  _cups_cmap_t		*cmap_cache;	/* SBCS Charmap Cache */
  _cups_vmap_t		*vmap_cache;	/* VBCS Charmap Cache */

  /* usersys.c */
  http_encryption_t	encryption;	/* Encryption setting */
  char			user[65],	/* User name */
			server[256],	/* Server address */
			servername[256];/* Server hostname */
  cups_password_cb_t	password_cb;	/* Password callback */

  /* util.c */
  http_t		*http;		/* Current server connection */
  ipp_status_t		last_error;	/* Last IPP error */
  char			*last_status_message;
					/* Last IPP status-message */

  char			def_printer[256];
					/* Default printer */
  char			ppd_filename[HTTP_MAX_URI];
					/* PPD filename */

  /* string.c */
  cups_array_t		*stringpool;	/* String pool */
} _cups_globals_t;


/*
 * Prototypes...
 */

extern void		_cupsCharmapFlush(_cups_globals_t *cg);
extern const char	*_cupsGetPassword(const char *prompt);
extern _cups_globals_t	*_cupsGlobals(void);
extern void		_cupsLangFlush(_cups_globals_t *cg);
extern void		_cupsSetError(ipp_status_t status, const char *message);
extern void		_cupsStrFlush(_cups_globals_t *cg);


/*
 * C++ magic...
 */

#  ifdef __cplusplus
}
#  endif /* __cplusplus */
#endif /* !_CUPS_GLOBALS_H_ */

/*
 * End of "$Id: globals.h 5294 2006-03-15 21:09:32Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
e1d6a774	2	* "$Id: globals.h 5294 2006-03-15 21:09:32Z mike $"
ef416fc2	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"
ef416fc2	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
757d2cad	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
ef416fc2	75	/* http.c */
	76	char http_date[256]; /* Date+time buffer */
	77
	78	/* http-addr.c */
	79	unsigned ip_addr; /* Packed IPv4 address */
	80	char ip_ptrs[2]; / Pointer to packed address */
	81	struct hostent hostent; /* Host entry for IP address */
	82	# ifdef HAVE_GETADDRINFO
	83	char hostname[1024]; /* Hostname */
	84	# endif /* HAVE_GETADDRINFO */
	85
	86	/* ipp.c */
	87	ipp_uchar_t ipp_date[11]; /* RFC-1903 date/time data */
	88
	89	/* ipp-support.c */
	90	int ipp_port; /* IPP port number */
	91	char ipp_unknown[255];
	92	/* Unknown error statuses */
	93
ef416fc2	94	/* language.c */
ef416fc2	95	cups_lang_t lang_cache; / Language string cache */
fa73b229	96	cups_lang_t lang_default; / Default language */
ef416fc2	97	# ifdef __APPLE__
	98	# ifdef HAVE_CF_LOCALE_ID
	99	char language[32]; /* Cached language */
	100	# else
	101	const char language; / Cached language */
	102	# endif /* HAVE_CF_LOCALE_ID */
	103	# endif /* __APPLE__ */
	104
	105	/* ppd.c */
	106	ppd_status_t ppd_status; /* Status of last ppdOpen() /
	107	int ppd_line; /* Current line number */
	108	ppd_conform_t ppd_conform; /* Level of conformance required */
	109
	110	/* tempfile.c */
	111	char tempfile[1024]; /* cupsTempFd/File buffer */
	112
	113	/* transcode.c */
	114	_cups_cmap_t cmap_cache; / SBCS Charmap Cache */
	115	_cups_vmap_t vmap_cache; / VBCS Charmap Cache */
	116
	117	/* usersys.c */
	118	http_encryption_t encryption; /* Encryption setting */
	119	char user[65], /* User name */
	120	server[256], /* Server address */
	121	servername[256];/* Server hostname */
	122	cups_password_cb_t password_cb; /* Password callback */
	123
	124	/* util.c */
	125	http_t http; / Current server connection */
	126	ipp_status_t last_error; /* Last IPP error */
	127	char *last_status_message;
	128	/* Last IPP status-message */
	129
	130	char def_printer[256];
	131	/* Default printer */
	132	char ppd_filename[HTTP_MAX_URI];
	133	/* PPD filename */
4400e98d	134
	135	/* string.c */
	136	cups_array_t stringpool; / String pool */
ef416fc2	137	} _cups_globals_t;
	138
	139
	140	/*
	141	* Prototypes...
	142	*/
	143
e1d6a774	144	extern void _cupsCharmapFlush(_cups_globals_t *cg);
ef416fc2	145	extern const char _cupsGetPassword(const char prompt);
ef416fc2	146	extern _cups_globals_t *_cupsGlobals(void);
fa73b229	147	extern void _cupsLangFlush(_cups_globals_t *cg);
ecdc0628	148	extern void _cupsSetError(ipp_status_t status, const char *message);
757d2cad	149	extern void _cupsStrFlush(_cups_globals_t *cg);
ef416fc2	150
	151
	152	/*
	153	* C++ magic...
	154	*/
	155
	156	# ifdef __cplusplus
	157	}
	158	# endif /* __cplusplus */
	159	#endif /* !_CUPS_GLOBALS_H_ */
	160
	161	/*
e1d6a774	162	* End of "$Id: globals.h 5294 2006-03-15 21:09:32Z mike $".
ef416fc2	163	*/