projects / thirdparty / cups.git / blame
| Commit | Line | Data |
|---|---|---|
| ef416fc2 | 1 | /* |
| 6539a0af | 2 | * Public file definitions for CUPS. |
| ef416fc2 | 3 | * |
| 6539a0af MS |
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 | |
| 2a75f21b | 7 | * different line endings, gzip'd print files, PPD files, etc. |
| ef416fc2 | 8 | * |
| be3b49a3 MS |
9 | * Copyright © 2007-2018 by Apple Inc. |
| 10 | * Copyright © 1997-2007 by Easy Software Products, all rights reserved. | |
| ef416fc2 | 11 | * |
| be3b49a3 MS |
12 | * Licensed under Apache License v2.0. See the file "LICENSE" for more |
| 13 | * information. | |
| ef416fc2 | 14 | */ |
| 15 | ||
| 16 | #ifndef _CUPS_FILE_H_ | |
| 17 | # define _CUPS_FILE_H_ | |
| 18 | ||
| 19 | ||
| 20 | /* | |
| 21 | * Include necessary headers... | |
| 22 | */ | |
| 23 | ||
| 2fb76298 | 24 | # include "versioning.h" |
| 39ff2fe7 | 25 | # include <stddef.h> |
| ef416fc2 | 26 | # include <sys/types.h> |
| 19dc16f7 | 27 | # if defined(_WIN32) && !defined(__CUPS_SSIZE_T_DEFINED) |
| b86bc4cf | 28 | # define __CUPS_SSIZE_T_DEFINED |
| ef416fc2 | 29 | /* Windows does not support the ssize_t type, so map it to off_t... */ |
| 30 | typedef off_t ssize_t; /* @private@ */ | |
| 19dc16f7 | 31 | # endif /* _WIN32 && !__CUPS_SSIZE_T_DEFINED */ |
| ef416fc2 | 32 | |
| 33 | ||
| 34 | /* | |
| 35 | * C++ magic... | |
| 36 | */ | |
| 37 | ||
| d09495fa | 38 | # ifdef __cplusplus |
| ef416fc2 | 39 | extern "C" { |
| d09495fa | 40 | # endif /* __cplusplus */ |
| ef416fc2 | 41 | |
| 42 | ||
| 43 | /* | |
| 44 | * CUPS file definitions... | |
| 45 | */ | |
| 46 | ||
| 47 | # define CUPS_FILE_NONE 0 /* No compression */ | |
| 48 | # define CUPS_FILE_GZIP 1 /* GZIP compression */ | |
| 49 | ||
| 50 | ||
| 51 | /* | |
| 52 | * Types and structures... | |
| 53 | */ | |
| 54 | ||
| 55 | typedef struct _cups_file_s cups_file_t;/**** CUPS file type ****/ | |
| 56 | ||
| 57 | ||
| 58 | /* | |
| 59 | * Prototypes... | |
| 60 | */ | |
| 61 | ||
| 2fb76298 MS |
62 | extern int cupsFileClose(cups_file_t *fp) _CUPS_API_1_2; |
| 63 | extern int cupsFileCompression(cups_file_t *fp) _CUPS_API_1_2; | |
| 64 | extern int cupsFileEOF(cups_file_t *fp) _CUPS_API_1_2; | |
| be3b49a3 | 65 | extern const char *cupsFileFind(const char *filename, const char *path, int executable, char *buffer, int bufsize) _CUPS_API_1_2; |
| 2fb76298 MS |
66 | extern int cupsFileFlush(cups_file_t *fp) _CUPS_API_1_2; |
| 67 | extern int cupsFileGetChar(cups_file_t *fp) _CUPS_API_1_2; | |
| be3b49a3 MS |
68 | extern char *cupsFileGetConf(cups_file_t *fp, char *buf, size_t buflen, char **value, int *linenum) _CUPS_API_1_2; |
| 69 | extern size_t cupsFileGetLine(cups_file_t *fp, char *buf, size_t buflen) _CUPS_API_1_2; | |
| 70 | extern char *cupsFileGets(cups_file_t *fp, char *buf, size_t buflen) _CUPS_API_1_2; | |
| 2fb76298 MS |
71 | extern int cupsFileLock(cups_file_t *fp, int block) _CUPS_API_1_2; |
| 72 | extern int cupsFileNumber(cups_file_t *fp) _CUPS_API_1_2; | |
| be3b49a3 | 73 | extern cups_file_t *cupsFileOpen(const char *filename, const char *mode) _CUPS_API_1_2; |
| 2fb76298 MS |
74 | extern cups_file_t *cupsFileOpenFd(int fd, const char *mode) _CUPS_API_1_2; |
| 75 | extern int cupsFilePeekChar(cups_file_t *fp) _CUPS_API_1_2; | |
| be3b49a3 | 76 | extern int cupsFilePrintf(cups_file_t *fp, const char *format, ...) _CUPS_FORMAT(2, 3) _CUPS_API_1_2; |
| 2fb76298 | 77 | extern int cupsFilePutChar(cups_file_t *fp, int c) _CUPS_API_1_2; |
| be3b49a3 MS |
78 | extern ssize_t cupsFilePutConf(cups_file_t *fp, const char *directive, const char *value) _CUPS_API_1_4; |
| 79 | extern int cupsFilePuts(cups_file_t *fp, const char *s) _CUPS_API_1_2; | |
| 80 | extern ssize_t cupsFileRead(cups_file_t *fp, char *buf, size_t bytes) _CUPS_API_1_2; | |
| 2fb76298 MS |
81 | extern off_t cupsFileRewind(cups_file_t *fp) _CUPS_API_1_2; |
| 82 | extern off_t cupsFileSeek(cups_file_t *fp, off_t pos) _CUPS_API_1_2; | |
| 83 | extern cups_file_t *cupsFileStderr(void) _CUPS_API_1_2; | |
| 84 | extern cups_file_t *cupsFileStdin(void) _CUPS_API_1_2; | |
| 85 | extern cups_file_t *cupsFileStdout(void) _CUPS_API_1_2; | |
| 86 | extern off_t cupsFileTell(cups_file_t *fp) _CUPS_API_1_2; | |
| 87 | extern int cupsFileUnlock(cups_file_t *fp) _CUPS_API_1_2; | |
| be3b49a3 | 88 | extern ssize_t cupsFileWrite(cups_file_t *fp, const char *buf, size_t bytes) _CUPS_API_1_2; |
| ef416fc2 | 89 | |
| 90 | ||
| d09495fa | 91 | # ifdef __cplusplus |
| ef416fc2 | 92 | } |
| d09495fa | 93 | # endif /* __cplusplus */ |
| ef416fc2 | 94 | #endif /* !_CUPS_FILE_H_ */ |