]>
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 * different line endings, gzip'd print files, PPD files, etc.
9 * Copyright 2007-2017 by Apple Inc.
10 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
12 * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
16 # define _CUPS_FILE_H_
20 * Include necessary headers...
23 # include "versioning.h"
25 # include <sys/types.h>
26 # if defined(WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
27 # define __CUPS_SSIZE_T_DEFINED
28 /* Windows does not support the ssize_t type, so map it to off_t... */
29 typedef off_t ssize_t
; /* @private@ */
30 # endif /* WIN32 && !__CUPS_SSIZE_T_DEFINED */
39 # endif /* __cplusplus */
43 * CUPS file definitions...
46 # define CUPS_FILE_NONE 0 /* No compression */
47 # define CUPS_FILE_GZIP 1 /* GZIP compression */
51 * Types and structures...
54 typedef struct _cups_file_s cups_file_t
;/**** CUPS file type ****/
61 extern int cupsFileClose(cups_file_t
*fp
) _CUPS_API_1_2
;
62 extern int cupsFileCompression(cups_file_t
*fp
) _CUPS_API_1_2
;
63 extern int cupsFileEOF(cups_file_t
*fp
) _CUPS_API_1_2
;
64 extern const char *cupsFileFind(const char *filename
, const char *path
,
65 int executable
, char *buffer
,
66 int bufsize
) _CUPS_API_1_2
;
67 extern int cupsFileFlush(cups_file_t
*fp
) _CUPS_API_1_2
;
68 extern int cupsFileGetChar(cups_file_t
*fp
) _CUPS_API_1_2
;
69 extern char *cupsFileGetConf(cups_file_t
*fp
, char *buf
,
70 size_t buflen
, char **value
,
71 int *linenum
) _CUPS_API_1_2
;
72 extern size_t cupsFileGetLine(cups_file_t
*fp
, char *buf
,
73 size_t buflen
) _CUPS_API_1_2
;
74 extern char *cupsFileGets(cups_file_t
*fp
, char *buf
, size_t buflen
)
76 extern int cupsFileLock(cups_file_t
*fp
, int block
) _CUPS_API_1_2
;
77 extern int cupsFileNumber(cups_file_t
*fp
) _CUPS_API_1_2
;
78 extern cups_file_t
*cupsFileOpen(const char *filename
, const char *mode
)
80 extern cups_file_t
*cupsFileOpenFd(int fd
, const char *mode
) _CUPS_API_1_2
;
81 extern int cupsFilePeekChar(cups_file_t
*fp
) _CUPS_API_1_2
;
82 extern int cupsFilePrintf(cups_file_t
*fp
, const char *format
, ...)
83 __attribute__((__format__ (__printf__
, 2, 3)))
85 extern int cupsFilePutChar(cups_file_t
*fp
, int c
) _CUPS_API_1_2
;
86 extern ssize_t
cupsFilePutConf(cups_file_t
*fp
, const char *directive
,
87 const char *value
) _CUPS_API_1_4
;
88 extern int cupsFilePuts(cups_file_t
*fp
, const char *s
)
90 extern ssize_t
cupsFileRead(cups_file_t
*fp
, char *buf
, size_t bytes
)
92 extern off_t
cupsFileRewind(cups_file_t
*fp
) _CUPS_API_1_2
;
93 extern off_t
cupsFileSeek(cups_file_t
*fp
, off_t pos
) _CUPS_API_1_2
;
94 extern cups_file_t
*cupsFileStderr(void) _CUPS_API_1_2
;
95 extern cups_file_t
*cupsFileStdin(void) _CUPS_API_1_2
;
96 extern cups_file_t
*cupsFileStdout(void) _CUPS_API_1_2
;
97 extern off_t
cupsFileTell(cups_file_t
*fp
) _CUPS_API_1_2
;
98 extern int cupsFileUnlock(cups_file_t
*fp
) _CUPS_API_1_2
;
99 extern ssize_t
cupsFileWrite(cups_file_t
*fp
, const char *buf
,
100 size_t bytes
) _CUPS_API_1_2
;
105 # endif /* __cplusplus */
106 #endif /* !_CUPS_FILE_H_ */