xref: /aosp_15_r20/external/libcups/cups/file.h (revision 5e7646d21f1134fb0638875d812ef646c12ab91e)
1*5e7646d2SAndroid Build Coastguard Worker /*
2*5e7646d2SAndroid Build Coastguard Worker  * Public file definitions for CUPS.
3*5e7646d2SAndroid Build Coastguard Worker  *
4*5e7646d2SAndroid Build Coastguard Worker  * Since stdio files max out at 256 files on many systems, we have to
5*5e7646d2SAndroid Build Coastguard Worker  * write similar functions without this limit.  At the same time, using
6*5e7646d2SAndroid Build Coastguard Worker  * our own file functions allows us to provide transparent support of
7*5e7646d2SAndroid Build Coastguard Worker  * different line endings, gzip'd print files, PPD files, etc.
8*5e7646d2SAndroid Build Coastguard Worker  *
9*5e7646d2SAndroid Build Coastguard Worker  * Copyright © 2007-2018 by Apple Inc.
10*5e7646d2SAndroid Build Coastguard Worker  * Copyright © 1997-2007 by Easy Software Products, all rights reserved.
11*5e7646d2SAndroid Build Coastguard Worker  *
12*5e7646d2SAndroid Build Coastguard Worker  * Licensed under Apache License v2.0.  See the file "LICENSE" for more
13*5e7646d2SAndroid Build Coastguard Worker  * information.
14*5e7646d2SAndroid Build Coastguard Worker  */
15*5e7646d2SAndroid Build Coastguard Worker 
16*5e7646d2SAndroid Build Coastguard Worker #ifndef _CUPS_FILE_H_
17*5e7646d2SAndroid Build Coastguard Worker #  define _CUPS_FILE_H_
18*5e7646d2SAndroid Build Coastguard Worker 
19*5e7646d2SAndroid Build Coastguard Worker 
20*5e7646d2SAndroid Build Coastguard Worker /*
21*5e7646d2SAndroid Build Coastguard Worker  * Include necessary headers...
22*5e7646d2SAndroid Build Coastguard Worker  */
23*5e7646d2SAndroid Build Coastguard Worker 
24*5e7646d2SAndroid Build Coastguard Worker #  include "versioning.h"
25*5e7646d2SAndroid Build Coastguard Worker #  include <stddef.h>
26*5e7646d2SAndroid Build Coastguard Worker #  include <sys/types.h>
27*5e7646d2SAndroid Build Coastguard Worker #  if defined(_WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
28*5e7646d2SAndroid Build Coastguard Worker #    define __CUPS_SSIZE_T_DEFINED
29*5e7646d2SAndroid Build Coastguard Worker /* Windows does not support the ssize_t type, so map it to off_t... */
30*5e7646d2SAndroid Build Coastguard Worker typedef off_t ssize_t;			/* @private@ */
31*5e7646d2SAndroid Build Coastguard Worker #  endif /* _WIN32 && !__CUPS_SSIZE_T_DEFINED */
32*5e7646d2SAndroid Build Coastguard Worker 
33*5e7646d2SAndroid Build Coastguard Worker 
34*5e7646d2SAndroid Build Coastguard Worker /*
35*5e7646d2SAndroid Build Coastguard Worker  * C++ magic...
36*5e7646d2SAndroid Build Coastguard Worker  */
37*5e7646d2SAndroid Build Coastguard Worker 
38*5e7646d2SAndroid Build Coastguard Worker #  ifdef __cplusplus
39*5e7646d2SAndroid Build Coastguard Worker extern "C" {
40*5e7646d2SAndroid Build Coastguard Worker #  endif /* __cplusplus */
41*5e7646d2SAndroid Build Coastguard Worker 
42*5e7646d2SAndroid Build Coastguard Worker 
43*5e7646d2SAndroid Build Coastguard Worker /*
44*5e7646d2SAndroid Build Coastguard Worker  * CUPS file definitions...
45*5e7646d2SAndroid Build Coastguard Worker  */
46*5e7646d2SAndroid Build Coastguard Worker 
47*5e7646d2SAndroid Build Coastguard Worker #  define CUPS_FILE_NONE	0	/* No compression */
48*5e7646d2SAndroid Build Coastguard Worker #  define CUPS_FILE_GZIP	1	/* GZIP compression */
49*5e7646d2SAndroid Build Coastguard Worker 
50*5e7646d2SAndroid Build Coastguard Worker 
51*5e7646d2SAndroid Build Coastguard Worker /*
52*5e7646d2SAndroid Build Coastguard Worker  * Types and structures...
53*5e7646d2SAndroid Build Coastguard Worker  */
54*5e7646d2SAndroid Build Coastguard Worker 
55*5e7646d2SAndroid Build Coastguard Worker typedef struct _cups_file_s cups_file_t;/**** CUPS file type ****/
56*5e7646d2SAndroid Build Coastguard Worker 
57*5e7646d2SAndroid Build Coastguard Worker 
58*5e7646d2SAndroid Build Coastguard Worker /*
59*5e7646d2SAndroid Build Coastguard Worker  * Prototypes...
60*5e7646d2SAndroid Build Coastguard Worker  */
61*5e7646d2SAndroid Build Coastguard Worker 
62*5e7646d2SAndroid Build Coastguard Worker extern int		cupsFileClose(cups_file_t *fp) _CUPS_API_1_2;
63*5e7646d2SAndroid Build Coastguard Worker extern int		cupsFileCompression(cups_file_t *fp) _CUPS_API_1_2;
64*5e7646d2SAndroid Build Coastguard Worker extern int		cupsFileEOF(cups_file_t *fp) _CUPS_API_1_2;
65*5e7646d2SAndroid Build Coastguard Worker extern const char	*cupsFileFind(const char *filename, const char *path, int executable, char *buffer, int bufsize) _CUPS_API_1_2;
66*5e7646d2SAndroid Build Coastguard Worker extern int		cupsFileFlush(cups_file_t *fp) _CUPS_API_1_2;
67*5e7646d2SAndroid Build Coastguard Worker extern int		cupsFileGetChar(cups_file_t *fp) _CUPS_API_1_2;
68*5e7646d2SAndroid Build Coastguard Worker extern char		*cupsFileGetConf(cups_file_t *fp, char *buf, size_t buflen, char **value, int *linenum) _CUPS_API_1_2;
69*5e7646d2SAndroid Build Coastguard Worker extern size_t		cupsFileGetLine(cups_file_t *fp, char *buf, size_t buflen) _CUPS_API_1_2;
70*5e7646d2SAndroid Build Coastguard Worker extern char		*cupsFileGets(cups_file_t *fp, char *buf, size_t buflen) _CUPS_API_1_2;
71*5e7646d2SAndroid Build Coastguard Worker extern int		cupsFileLock(cups_file_t *fp, int block) _CUPS_API_1_2;
72*5e7646d2SAndroid Build Coastguard Worker extern int		cupsFileNumber(cups_file_t *fp) _CUPS_API_1_2;
73*5e7646d2SAndroid Build Coastguard Worker extern cups_file_t	*cupsFileOpen(const char *filename, const char *mode) _CUPS_API_1_2;
74*5e7646d2SAndroid Build Coastguard Worker extern cups_file_t	*cupsFileOpenFd(int fd, const char *mode) _CUPS_API_1_2;
75*5e7646d2SAndroid Build Coastguard Worker extern int		cupsFilePeekChar(cups_file_t *fp) _CUPS_API_1_2;
76*5e7646d2SAndroid Build Coastguard Worker extern int		cupsFilePrintf(cups_file_t *fp, const char *format, ...) _CUPS_FORMAT(2, 3) _CUPS_API_1_2;
77*5e7646d2SAndroid Build Coastguard Worker extern int		cupsFilePutChar(cups_file_t *fp, int c) _CUPS_API_1_2;
78*5e7646d2SAndroid Build Coastguard Worker extern ssize_t		cupsFilePutConf(cups_file_t *fp, const char *directive, const char *value) _CUPS_API_1_4;
79*5e7646d2SAndroid Build Coastguard Worker extern int		cupsFilePuts(cups_file_t *fp, const char *s) _CUPS_API_1_2;
80*5e7646d2SAndroid Build Coastguard Worker extern ssize_t		cupsFileRead(cups_file_t *fp, char *buf, size_t bytes) _CUPS_API_1_2;
81*5e7646d2SAndroid Build Coastguard Worker extern off_t		cupsFileRewind(cups_file_t *fp) _CUPS_API_1_2;
82*5e7646d2SAndroid Build Coastguard Worker extern off_t		cupsFileSeek(cups_file_t *fp, off_t pos) _CUPS_API_1_2;
83*5e7646d2SAndroid Build Coastguard Worker extern cups_file_t	*cupsFileStderr(void) _CUPS_API_1_2;
84*5e7646d2SAndroid Build Coastguard Worker extern cups_file_t	*cupsFileStdin(void) _CUPS_API_1_2;
85*5e7646d2SAndroid Build Coastguard Worker extern cups_file_t	*cupsFileStdout(void) _CUPS_API_1_2;
86*5e7646d2SAndroid Build Coastguard Worker extern off_t		cupsFileTell(cups_file_t *fp) _CUPS_API_1_2;
87*5e7646d2SAndroid Build Coastguard Worker extern int		cupsFileUnlock(cups_file_t *fp) _CUPS_API_1_2;
88*5e7646d2SAndroid Build Coastguard Worker extern ssize_t		cupsFileWrite(cups_file_t *fp, const char *buf, size_t bytes) _CUPS_API_1_2;
89*5e7646d2SAndroid Build Coastguard Worker 
90*5e7646d2SAndroid Build Coastguard Worker 
91*5e7646d2SAndroid Build Coastguard Worker #  ifdef __cplusplus
92*5e7646d2SAndroid Build Coastguard Worker }
93*5e7646d2SAndroid Build Coastguard Worker #  endif /* __cplusplus */
94*5e7646d2SAndroid Build Coastguard Worker #endif /* !_CUPS_FILE_H_ */
95