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

/*
 * "$Id: globals.h 7910 2008-09-06 00:25:17Z mike $"
 *
 *   Global variable definitions for the Common UNIX Printing System (CUPS).
 *
 *   Copyright 2007-2009 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.
 */

#ifndef _CUPS_GLOBALS_H_
#  define _CUPS_GLOBALS_H_

/*
 * Include necessary headers...
 */

#  include "string.h"
#  include "http-private.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 */

  /* backend.c */
  char			resolved_uri[1024];
					/* Buffer for cupsBackendDeviceURI */

  /* file.c */
  cups_file_t		*stdio_files[3];/* stdin, stdout, stderr */

  /* 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 */
  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-support.c */
  int			ipp_port;	/* IPP port number */
  char			ipp_unknown[255];
					/* Unknown error statuses */

  /* language.c */
  cups_lang_t		*lang_default;	/* Default language */
#  ifdef __APPLE__
  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 */

  /* pwgmedia.c */
  cups_array_t		*pwg_size_lut,	/* Lookup table for PWG names */
			*leg_size_lut;	/* Lookup table for legacy names */

  /* snmp.c */
  char			snmp_community[255];
					/* Default SNMP community name */
  int			snmp_debug;	/* Log SNMP IO to stderr? */

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

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

  /* 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 */
} _cups_globals_t;


/*
 * Prototypes...
 */

extern http_t		*_cupsConnect(void);
extern const char	*_cupsGetPassword(const char *prompt);
extern _cups_globals_t	*_cupsGlobals(void);
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		*_cupsUserDefault(char *name, size_t namesize);


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

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

/*
 * End of "$Id: globals.h 7910 2008-09-06 00:25:17Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
b19ccc9e	2	* "$Id: globals.h 7910 2008-09-06 00:25:17Z mike $"
ef416fc2	3	*
	4	* Global variable definitions for the Common UNIX Printing System (CUPS).
	5	*
c168a833	6	* Copyright 2007-2009 by Apple Inc.
f7deaa1a	7	* Copyright 1997-2007 by Easy Software Products, all rights reserved.
ef416fc2	8	*
ef416fc2	9	* These coded instructions, statements, and computer programs are the
bc44d920	10	* property of Apple Inc. and are protected by Federal copyright
	11	* law. Distribution and use rights are outlined in the file "LICENSE.txt"
	12	* which should have been included with this file. If this file is
	13	* file is missing or damaged, see the license at "http://www.cups.org/".
ef416fc2	14	*
	15	* This file is subject to the Apple OS-Developed Software exception.
	16	*/
	17
	18	#ifndef _CUPS_GLOBALS_H_
	19	# define _CUPS_GLOBALS_H_
	20
	21	/*
	22	* Include necessary headers...
	23	*/
	24
	25	# include "string.h"
8ca02f3c	26	# include "http-private.h"
ef416fc2	27	# include "cups.h"
ef416fc2	28	# include "i18n.h"
ef416fc2	29
	30	# ifdef HAVE_PTHREAD_H
	31	# include <pthread.h>
	32	# endif /* HAVE_PTHREAD_H */
	33
	34
	35	/*
	36	* C++ magic...
	37	*/
	38
	39	# ifdef __cplusplus
	40	extern "C" {
	41	# endif /* __cplusplus */
	42
	43
	44	/*
	45	* To make libcups thread safe, define thread safe globals (aka thread-
	46	* specific data) for the static variables used in the library.
	47	*/
	48
	49	typedef struct _cups_globals_s /** CUPS global state data **/
	50	{
	51	/* Multiple places... */
	52	const char cups_datadir, / CUPS_DATADIR environment var */
	53	cups_serverbin,/ CUPS_SERVERBIN environment var */
	54	*cups_serverroot,
	55	/* CUPS_SERVERROOT environment var */
	56	cups_statedir, / CUPS_STATEDIR environment var */
	57	localedir; / LOCALDIR environment var */
	58
757d2cad	59	/* adminutil.c */
	60	time_t cupsd_update; /* Last time we got or set cupsd.conf */
	61	char cupsd_hostname[HTTP_MAX_HOST];
	62	/* Hostname for connection */
	63	int cupsd_num_settings;
	64	/* Number of server settings */
	65	cups_option_t cupsd_settings;/ Server settings */
	66
5eb9da71 MS	67	/* backend.c */
	68	char resolved_uri[1024];
	69	/* Buffer for cupsBackendDeviceURI */
	70
80ca4592	71	/* file.c */
	72	cups_file_t stdio_files[3];/ stdin, stdout, stderr */
	73
ef416fc2	74	/* http.c */
	75	char http_date[256]; /* Date+time buffer */
	76
	77	/* http-addr.c */
	78	unsigned ip_addr; /* Packed IPv4 address */
	79	char ip_ptrs[2]; / Pointer to packed address */
	80	struct hostent hostent; /* Host entry for IP address */
	81	# ifdef HAVE_GETADDRINFO
	82	char hostname[1024]; /* Hostname */
	83	# endif /* HAVE_GETADDRINFO */
49d87452	84	int need_res_init; /* Need to reinitialize resolver? */
ef416fc2	85
	86	/* ipp.c */
	87	ipp_uchar_t ipp_date[11]; /* RFC-1903 date/time data */
1f6f3dbc	88	_ipp_buffer_t ipp_buffers; / Buffer list */
ef416fc2	89
	90	/* ipp-support.c */
	91	int ipp_port; /* IPP port number */
	92	char ipp_unknown[255];
	93	/* Unknown error statuses */
	94
ef416fc2	95	/* language.c */
fa73b229	96	cups_lang_t lang_default; / Default language */
ef416fc2	97	# ifdef __APPLE__
ef416fc2	98	char language[32]; /* Cached language */
ef416fc2	99	# endif /* __APPLE__ */
	100
	101	/* ppd.c */
	102	ppd_status_t ppd_status; /* Status of last ppdOpen() /
	103	int ppd_line; /* Current line number */
	104	ppd_conform_t ppd_conform; /* Level of conformance required */
	105
c168a833 MS	106	/* pwgmedia.c */
	107	cups_array_t pwg_size_lut, / Lookup table for PWG names */
	108	leg_size_lut; / Lookup table for legacy names */
	109
91c84a35	110	/* snmp.c */
ac884b6a MS	111	char snmp_community[255];
ac884b6a MS	112	/* Default SNMP community name */
91c84a35 MS	113	int snmp_debug; /* Log SNMP IO to stderr? */
91c84a35 MS	114
ef416fc2	115	/* tempfile.c */
	116	char tempfile[1024]; /* cupsTempFd/File buffer */
	117
ef416fc2	118	/* usersys.c */
	119	http_encryption_t encryption; /* Encryption setting */
	120	char user[65], /* User name */
	121	server[256], /* Server address */
	122	servername[256];/* Server hostname */
f11a948a MS	123	cups_password_cb2_t password_cb; /* Password callback */
f11a948a MS	124	void password_data; / Password user data */
ef416fc2	125
	126	/* util.c */
	127	http_t http; / Current server connection */
	128	ipp_status_t last_error; /* Last IPP error */
	129	char *last_status_message;
	130	/* Last IPP status-message */
	131
	132	char def_printer[256];
	133	/* Default printer */
	134	char ppd_filename[HTTP_MAX_URI];
	135	/* PPD filename */
	136	} _cups_globals_t;
	137
	138
	139	/*
	140	* Prototypes...
	141	*/
	142
3d052e43	143	extern http_t *_cupsConnect(void);
ef416fc2	144	extern const char _cupsGetPassword(const char prompt);
ef416fc2	145	extern _cups_globals_t *_cupsGlobals(void);
e07d4801	146	extern void _cupsSetDefaults(void);
749b1e90 MS	147	extern void _cupsSetError(ipp_status_t status, const char *message,
749b1e90 MS	148	int localize);
355e94dc	149	extern void _cupsSetHTTPError(http_status_t status);
38e73f87	150	extern char _cupsUserDefault(char name, size_t namesize);
ef416fc2	151
	152
	153	/*
	154	* C++ magic...
	155	*/
	156
	157	# ifdef __cplusplus
	158	}
	159	# endif /* __cplusplus */
	160	#endif /* !_CUPS_GLOBALS_H_ */
	161
	162	/*
b19ccc9e	163	* End of "$Id: globals.h 7910 2008-09-06 00:25:17Z mike $".
ef416fc2	164	*/