source: mainline/uspace/lib/posix/stdio.h@ 82cb6768

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 82cb6768 was 55b1efd, checked in by Petr Koupy <petr.koupy@…>, 14 years ago

Minor corrections and unifications of the recently added documentation.

  • Property mode set to 100644
File size: 6.0 KB
Line 
1/*
2 * Copyright (c) 2011 Jiri Zarevucky
3 * Copyright (c) 2011 Petr Koupy
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * - Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * - The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/** @addtogroup libposix
31 * @{
32 */
33/** @file Standard buffered input/output.
34 */
35
36#ifndef POSIX_STDIO_H_
37#define POSIX_STDIO_H_
38
39#include "libc/stdio.h"
40#include "sys/types.h"
41#include "libc/stdarg.h"
42#include "limits.h"
43
44/* Identifying the Terminal */
45#undef L_ctermid
46#define L_ctermid PATH_MAX
47extern char *posix_ctermid(char *s);
48
49/* Error Recovery */
50extern void posix_clearerr(FILE *stream);
51
52/* Input/Output */
53#undef putc
54#define putc fputc
55extern int posix_fputs(const char *restrict s, FILE *restrict stream);
56#undef getc
57#define getc fgetc
58extern int posix_ungetc(int c, FILE *stream);
59extern ssize_t posix_getdelim(char **restrict lineptr, size_t *restrict n,
60 int delimiter, FILE *restrict stream);
61extern ssize_t posix_getline(char **restrict lineptr, size_t *restrict n,
62 FILE *restrict stream);
63
64/* Opening Streams */
65extern FILE *posix_freopen(const char *restrict filename,
66 const char *restrict mode, FILE *restrict stream);
67
68/* Error Messages */
69extern void posix_perror(const char *s);
70
71/* File Positioning */
72typedef struct _posix_fpos posix_fpos_t;
73extern int posix_fsetpos(FILE *stream, const posix_fpos_t *pos);
74extern int posix_fgetpos(FILE *restrict stream, posix_fpos_t *restrict pos);
75extern int posix_fseek(FILE *stream, long offset, int whence);
76extern int posix_fseeko(FILE *stream, posix_off_t offset, int whence);
77extern long posix_ftell(FILE *stream);
78extern posix_off_t posix_ftello(FILE *stream);
79
80/* Flushing Buffers */
81extern int posix_fflush(FILE *stream);
82
83/* Formatted Output */
84extern int posix_dprintf(int fildes, const char *restrict format, ...)
85 PRINTF_ATTRIBUTE(2, 3);
86extern int posix_vdprintf(int fildes, const char *restrict format, va_list ap);
87extern int posix_sprintf(char *restrict s, const char *restrict format, ...)
88 PRINTF_ATTRIBUTE(2, 3);
89extern int posix_vsprintf(char *restrict s, const char *restrict format, va_list ap);
90
91/* Formatted Input */
92extern int posix_fscanf(
93 FILE *restrict stream, const char *restrict format, ...);
94extern int posix_vfscanf(
95 FILE *restrict stream, const char *restrict format, va_list arg);
96extern int posix_scanf(const char *restrict format, ...);
97extern int posix_vscanf(const char *restrict format, va_list arg);
98extern int posix_sscanf(
99 const char *restrict s, const char *restrict format, ...);
100extern int posix_vsscanf(
101 const char *restrict s, const char *restrict format, va_list arg);
102
103/* File Locking */
104extern void posix_flockfile(FILE *file);
105extern int posix_ftrylockfile(FILE *file);
106extern void posix_funlockfile(FILE *file);
107extern int posix_getc_unlocked(FILE *stream);
108extern int posix_getchar_unlocked(void);
109extern int posix_putc_unlocked(int c, FILE *stream);
110extern int posix_putchar_unlocked(int c);
111
112/* Deleting Files */
113extern int posix_remove(const char *path);
114
115/* Renaming Files */
116extern int posix_rename(const char *old, const char *new);
117
118/* Temporary Files */
119#undef L_tmpnam
120#define L_tmpnam PATH_MAX
121extern char *posix_tmpnam(char *s);
122extern char *posix_tempnam(const char *dir, const char *pfx);
123extern FILE *posix_tmpfile(void);
124
125#ifndef LIBPOSIX_INTERNAL
126 /* DEBUG macro does not belong to POSIX stdio.h. Its unconditional
127 * definition in the native stdio.h causes unexpected behaviour of
128 * applications which uses their own DEBUG macro (e.g. debugging
129 * output is printed even if not desirable). */
130 #undef DEBUG
131
132 #define ctermid posix_ctermid
133
134 #define clearerr posix_clearerr
135
136 #define fputs posix_fputs
137 #define ungetc posix_ungetc
138 #define getdelim posix_getdelim
139 #define getline posix_getline
140
141 #define freopen posix_freopen
142
143 #define perror posix_perror
144
145 #define fpos_t posix_fpos_t
146 #define fsetpos posix_fsetpos
147 #define fgetpos posix_fgetpos
148 #define fseek posix_fseek
149 #define fseeko posix_fseeko
150 #define ftell posix_ftell
151 #define ftello posix_ftello
152
153 #define fflush posix_fflush
154
155 #define dprintf posix_dprintf
156 #define vdprintf posix_vdprintf
157 #define sprintf posix_sprintf
158 #define vsprintf posix_vsprintf
159
160 #define fscanf posix_fscanf
161 #define vfscanf posix_vfscanf
162 #define vscanf posix_vscanf
163 #define scanf posix_scanf
164 #define sscanf posix_sscanf
165 #define vsscanf posix_vsscanf
166
167 #define flockfile posix_flockfile
168 #define ftrylockfile posix_ftrylockfile
169 #define funlockfile posix_funlockfile
170
171 #define getc_unlocked posix_getc_unlocked
172 #define getchar_unlocked posix_getchar_unlocked
173 #define putc_unlocked posix_putc_unlocked
174 #define putchar_unlocked posix_putchar_unlocked
175
176 #define remove posix_remove
177
178 #define rename posix_rename
179
180 #define tmpnam posix_tmpnam
181 #define tempnam posix_tempnam
182 #define tmpfile posix_tmpfile
183#endif
184
185#endif /* POSIX_STDIO_H_ */
186
187/** @}
188 */
Note: See TracBrowser for help on using the repository browser.