[thirdparty/cups.git] / scheduler / file.h

/*
 * "$Id: file.h,v 1.5 2004/08/23 18:00:59 mike Exp $"
 *
 *   File definitions for the Common UNIX Printing System (CUPS).
 *
 *   Since stdio files max out at 256 files on many systems, we have to
 *   write similar functions without this limit.  At the same time, using
 *   our own file functions allows us to provide transparent support of
 *   gzip'd print files, PPD files, etc.
 *
 *   Copyright 1997-2004 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
 */

#ifndef _CUPS_FILE_H
#  define _CUPS_FILE_H_

/*
 * Include necessary headers...
 */

#  ifdef HAVE_LIBZ
#    include <zlib.h>
#  endif /* HAVE_LIBZ */


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

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


/*
 * CUPS file definitions...
 */

#  define CUPS_FILE_NONE	0	/* No compression */
#  define CUPS_FILE_GZIP	1	/* GZIP compression */


/*
 * CUPS file structure...
 */

typedef struct
{
  int		fd;			/* File descriptor */
  char		mode,			/* Mode ('r' or 'w') */
		compressed,		/* Compression used? */
		buf[2048],		/* Buffer */
		*ptr,			/* Pointer into buffer */
		*end;			/* End of buffer data */
  int		pos;			/* File position for start of buffer */

#  ifdef HAVE_LIBZ
  z_stream	stream;			/* Decompression stream */
  int		eof;			/* End of file? */
  unsigned char	cbuf[1024];		/* Decompression buffer */
#  endif /* HAVE_LIBZ */
} cups_file_t;


/*
 * Prototypes...
 */

extern int		cupsFileClose(cups_file_t *fp);
#define			cupsFileCompression(fp) (fp)->compressed
extern int		cupsFileFlush(cups_file_t *fp);
extern int		cupsFileGetChar(cups_file_t *fp);
extern char		*cupsFileGets(cups_file_t *fp, char *buf, int buflen);
#define			cupsFileNumber(fp) (fp)->fd
extern cups_file_t	*cupsFileOpen(const char *filename, const char *mode);
extern int		cupsFilePrintf(cups_file_t *fp, const char *format, ...);
extern int		cupsFilePutChar(cups_file_t *fp, int c);
extern int		cupsFilePuts(cups_file_t *fp, const char *s);
extern int		cupsFileRead(cups_file_t *fp, char *buf, int bytes);
extern int		cupsFileSeek(cups_file_t *fp, int pos);
#define			cupsFileTell(fp) (fp)->pos
extern int		cupsFileWrite(cups_file_t *fp, const char *buf, int bytes);


#  ifdef _cplusplus
}
#  endif /* _cplusplus */
#endif /* !_CUPS_FILE_H_ */

/*
 * End of "$Id: file.h,v 1.5 2004/08/23 18:00:59 mike Exp $".
 */
Commit	Line	Data
6afde7ae	1	/*
214cfbc0	2	* "$Id: file.h,v 1.5 2004/08/23 18:00:59 mike Exp $"
6afde7ae	3	*
	4	* File definitions for the Common UNIX Printing System (CUPS).
	5	*
	6	* Since stdio files max out at 256 files on many systems, we have to
	7	* write similar functions without this limit. At the same time, using
	8	* our own file functions allows us to provide transparent support of
	9	* gzip'd print files, PPD files, etc.
	10	*
71649dc9	11	* Copyright 1997-2004 by Easy Software Products, all rights reserved.
6afde7ae	12	*
	13	* These coded instructions, statements, and computer programs are the
	14	* property of Easy Software Products and are protected by Federal
	15	* copyright law. Distribution and use rights are outlined in the file
	16	* "LICENSE.txt" which should have been included with this file. If this
	17	* file is missing or damaged please contact Easy Software Products
	18	* at:
	19	*
	20	* Attn: CUPS Licensing Information
	21	* Easy Software Products
	22	* 44141 Airport View Drive, Suite 204
214cfbc0	23	* Hollywood, Maryland 20636 USA
6afde7ae	24	*
214cfbc0	25	* Voice: (301) 373-9600
6afde7ae	26	* EMail: cups-info@cups.org
	27	* WWW: http://www.cups.org
	28	*/
	29
	30	#ifndef _CUPS_FILE_H
	31	# define _CUPS_FILE_H_
	32
	33	/*
	34	* Include necessary headers...
	35	*/
	36
	37	# ifdef HAVE_LIBZ
	38	# include <zlib.h>
	39	# endif /* HAVE_LIBZ */
	40
	41
	42	/*
	43	* C++ magic...
	44	*/
	45
	46	# ifdef _cplusplus
	47	extern "C" {
	48	# endif /* _cplusplus */
	49
	50
81e0e1f0	51	/*
	52	* CUPS file definitions...
	53	*/
	54
	55	# define CUPS_FILE_NONE 0 /* No compression */
	56	# define CUPS_FILE_GZIP 1 /* GZIP compression */
	57
	58
6afde7ae	59	/*
	60	* CUPS file structure...
	61	*/
	62
	63	typedef struct
	64	{
	65	int fd; /* File descriptor */
	66	char mode, /* Mode ('r' or 'w') */
	67	compressed, /* Compression used? */
	68	buf[2048], /* Buffer */
	69	ptr, / Pointer into buffer */
	70	end; / End of buffer data */
	71	int pos; /* File position for start of buffer */
	72
	73	# ifdef HAVE_LIBZ
	74	z_stream stream; /* Decompression stream */
	75	int eof; /* End of file? */
	76	unsigned char cbuf[1024]; /* Decompression buffer */
	77	# endif /* HAVE_LIBZ */
	78	} cups_file_t;
	79
	80
	81	/*
	82	* Prototypes...
	83	*/
	84
	85	extern int cupsFileClose(cups_file_t *fp);
81e0e1f0	86	#define cupsFileCompression(fp) (fp)->compressed
75e7fa9c	87	extern int cupsFileFlush(cups_file_t *fp);
6afde7ae	88	extern int cupsFileGetChar(cups_file_t *fp);
6afde7ae	89	extern char cupsFileGets(cups_file_t fp, char *buf, int buflen);
75e7fa9c	90	#define cupsFileNumber(fp) (fp)->fd
6afde7ae	91	extern cups_file_t cupsFileOpen(const char filename, const char *mode);
6afde7ae	92	extern int cupsFilePrintf(cups_file_t fp, const char format, ...);
75e7fa9c	93	extern int cupsFilePutChar(cups_file_t *fp, int c);
6afde7ae	94	extern int cupsFilePuts(cups_file_t fp, const char s);
	95	extern int cupsFileRead(cups_file_t fp, char buf, int bytes);
	96	extern int cupsFileSeek(cups_file_t *fp, int pos);
75e7fa9c	97	#define cupsFileTell(fp) (fp)->pos
75e7fa9c	98	extern int cupsFileWrite(cups_file_t fp, const char buf, int bytes);
6afde7ae	99
	100
	101	# ifdef _cplusplus
	102	}
	103	# endif /* _cplusplus */
	104	#endif /* !_CUPS_FILE_H_ */
	105
	106	/*
214cfbc0	107	* End of "$Id: file.h,v 1.5 2004/08/23 18:00:59 mike Exp $".
6afde7ae	108	*/