]>
git.ipfire.org Git - thirdparty/cups.git/blob - cups/file.h
2 * Public file definitions for CUPS.
4 * Since stdio files max out at 256 files on many systems, we have to
5 * write similar functions without this limit. At the same time, using
6 * our own file functions allows us to provide transparent support of
7 * gzip'd print files, PPD files, etc.
9 * Copyright 2007-2014 by Apple Inc.
10 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
12 * These coded instructions, statements, and computer programs are the
13 * property of Apple Inc. and are protected by Federal copyright
14 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
15 * which should have been included with this file. If this file is
16 * file is missing or damaged, see the license at "http://www.cups.org/".
18 * This file is subject to the Apple OS-Developed Software exception.
22 # define _CUPS_FILE_H_
26 * Include necessary headers...
29 # include "versioning.h"
31 # include <sys/types.h>
32 # if defined(WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
33 # define __CUPS_SSIZE_T_DEFINED
34 /* Windows does not support the ssize_t type, so map it to off_t... */
35 typedef off_t ssize_t
; /* @private@ */
36 # endif /* WIN32 && !__CUPS_SSIZE_T_DEFINED */
45 # endif /* __cplusplus */
49 * CUPS file definitions...
52 # define CUPS_FILE_NONE 0 /* No compression */
53 # define CUPS_FILE_GZIP 1 /* GZIP compression */
57 * Types and structures...
60 typedef struct _cups_file_s cups_file_t
;/**** CUPS file type ****/
67 extern int cupsFileClose(cups_file_t
*fp
) _CUPS_API_1_2
;
68 extern int cupsFileCompression(cups_file_t
*fp
) _CUPS_API_1_2
;
69 extern int cupsFileEOF(cups_file_t
*fp
) _CUPS_API_1_2
;
70 extern const char *cupsFileFind(const char *filename
, const char *path
,
71 int executable
, char *buffer
,
72 int bufsize
) _CUPS_API_1_2
;
73 extern int cupsFileFlush(cups_file_t
*fp
) _CUPS_API_1_2
;
74 extern int cupsFileGetChar(cups_file_t
*fp
) _CUPS_API_1_2
;
75 extern char *cupsFileGetConf(cups_file_t
*fp
, char *buf
,
76 size_t buflen
, char **value
,
77 int *linenum
) _CUPS_API_1_2
;
78 extern size_t cupsFileGetLine(cups_file_t
*fp
, char *buf
,
79 size_t buflen
) _CUPS_API_1_2
;
80 extern char *cupsFileGets(cups_file_t
*fp
, char *buf
, size_t buflen
)
82 extern int cupsFileLock(cups_file_t
*fp
, int block
) _CUPS_API_1_2
;
83 extern int cupsFileNumber(cups_file_t
*fp
) _CUPS_API_1_2
;
84 extern cups_file_t
*cupsFileOpen(const char *filename
, const char *mode
)
86 extern cups_file_t
*cupsFileOpenFd(int fd
, const char *mode
) _CUPS_API_1_2
;
87 extern int cupsFilePeekChar(cups_file_t
*fp
) _CUPS_API_1_2
;
88 extern int cupsFilePrintf(cups_file_t
*fp
, const char *format
, ...)
89 __attribute__((__format__ (__printf__
, 2, 3)))
91 extern int cupsFilePutChar(cups_file_t
*fp
, int c
) _CUPS_API_1_2
;
92 extern ssize_t
cupsFilePutConf(cups_file_t
*fp
, const char *directive
,
93 const char *value
) _CUPS_API_1_4
;
94 extern int cupsFilePuts(cups_file_t
*fp
, const char *s
)
96 extern ssize_t
cupsFileRead(cups_file_t
*fp
, char *buf
, size_t bytes
)
98 extern off_t
cupsFileRewind(cups_file_t
*fp
) _CUPS_API_1_2
;
99 extern off_t
cupsFileSeek(cups_file_t
*fp
, off_t pos
) _CUPS_API_1_2
;
100 extern cups_file_t
*cupsFileStderr(void) _CUPS_API_1_2
;
101 extern cups_file_t
*cupsFileStdin(void) _CUPS_API_1_2
;
102 extern cups_file_t
*cupsFileStdout(void) _CUPS_API_1_2
;
103 extern off_t
cupsFileTell(cups_file_t
*fp
) _CUPS_API_1_2
;
104 extern int cupsFileUnlock(cups_file_t
*fp
) _CUPS_API_1_2
;
105 extern ssize_t
cupsFileWrite(cups_file_t
*fp
, const char *buf
,
106 size_t bytes
) _CUPS_API_1_2
;
111 # endif /* __cplusplus */
112 #endif /* !_CUPS_FILE_H_ */