annotate lib/freadptr.h @ 17282:a4996fb12971

locale: port to Solaris 2.6 and 7 + GNU gettext * lib/locale.in.h: Just include_next <locale.h> when being invoked recursively. This prevents problems on Solaris 2.6 and 7 when combining the localename module with GNU gettext 0.18.2. Problem reported by Tom G. Christensen in <http://lists.gnu.org/archive/html/bug-gnulib/2013-01/msg00084.html>.
author Paul Eggert <eggert@cs.ucla.edu>
date Thu, 10 Jan 2013 13:24:13 -0800
parents e542fd46ad6f
children 344018b6e5d7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9727
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
1 /* Retrieve information about a FILE stream.
17249
e542fd46ad6f maint: update all copyright year number ranges
Eric Blake <eblake@redhat.com>
parents: 16916
diff changeset
2 Copyright (C) 2007-2013 Free Software Foundation, Inc.
9727
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
3
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
4 This program is free software: you can redistribute it and/or modify
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
5 it under the terms of the GNU General Public License as published by
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
6 the Free Software Foundation; either version 3 of the License, or
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
7 (at your option) any later version.
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
8
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
9 This program is distributed in the hope that it will be useful,
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
12 GNU General Public License for more details.
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
13
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
14 You should have received a copy of the GNU General Public License
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
16
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
17 #include <stddef.h>
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
18 #include <stdio.h>
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
19
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
20 /* Assuming the stream STREAM is open for reading:
9779
569a44f4dd4d Extend freadptr to return also the buffer size.
Bruno Haible <bruno@clisp.org>
parents: 9733
diff changeset
21 Return a pointer to the input buffer of STREAM, or NULL.
569a44f4dd4d Extend freadptr to return also the buffer size.
Bruno Haible <bruno@clisp.org>
parents: 9733
diff changeset
22 If the returned pointer is non-NULL, *SIZEP is set to the (positive) size
569a44f4dd4d Extend freadptr to return also the buffer size.
Bruno Haible <bruno@clisp.org>
parents: 9733
diff changeset
23 of the input buffer.
569a44f4dd4d Extend freadptr to return also the buffer size.
Bruno Haible <bruno@clisp.org>
parents: 9733
diff changeset
24 If the returned pointer is NULL, you should use getc (STREAM),
569a44f4dd4d Extend freadptr to return also the buffer size.
Bruno Haible <bruno@clisp.org>
parents: 9733
diff changeset
25 fgetc (STREAM), or fread (..., STREAM) to access the input from STREAM.
9727
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
26
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
27 The resulting pointer becomes invalid upon any operation on STREAM.
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
28
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
29 STREAM must not be wide-character oriented. */
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
30
16916
3d02d25fa13d stdioext: Add support for musl libc.
Bruno Haible <bruno@clisp.org>
parents: 16201
diff changeset
31 #if HAVE___FREADPTR /* musl libc */
3d02d25fa13d stdioext: Add support for musl libc.
Bruno Haible <bruno@clisp.org>
parents: 16201
diff changeset
32
3d02d25fa13d stdioext: Add support for musl libc.
Bruno Haible <bruno@clisp.org>
parents: 16201
diff changeset
33 # include <stdio_ext.h>
3d02d25fa13d stdioext: Add support for musl libc.
Bruno Haible <bruno@clisp.org>
parents: 16201
diff changeset
34 # define freadptr(stream,sizep) __freadptr (stream, sizep)
3d02d25fa13d stdioext: Add support for musl libc.
Bruno Haible <bruno@clisp.org>
parents: 16201
diff changeset
35
3d02d25fa13d stdioext: Add support for musl libc.
Bruno Haible <bruno@clisp.org>
parents: 16201
diff changeset
36 #else
3d02d25fa13d stdioext: Add support for musl libc.
Bruno Haible <bruno@clisp.org>
parents: 16201
diff changeset
37
3d02d25fa13d stdioext: Add support for musl libc.
Bruno Haible <bruno@clisp.org>
parents: 16201
diff changeset
38 # ifdef __cplusplus
3d02d25fa13d stdioext: Add support for musl libc.
Bruno Haible <bruno@clisp.org>
parents: 16201
diff changeset
39 extern "C" {
3d02d25fa13d stdioext: Add support for musl libc.
Bruno Haible <bruno@clisp.org>
parents: 16201
diff changeset
40 # endif
3d02d25fa13d stdioext: Add support for musl libc.
Bruno Haible <bruno@clisp.org>
parents: 16201
diff changeset
41
9779
569a44f4dd4d Extend freadptr to return also the buffer size.
Bruno Haible <bruno@clisp.org>
parents: 9733
diff changeset
42 extern const char * freadptr (FILE *stream, size_t *sizep);
9727
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
43
16916
3d02d25fa13d stdioext: Add support for musl libc.
Bruno Haible <bruno@clisp.org>
parents: 16201
diff changeset
44 # ifdef __cplusplus
9727
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
45 }
16916
3d02d25fa13d stdioext: Add support for musl libc.
Bruno Haible <bruno@clisp.org>
parents: 16201
diff changeset
46 # endif
3d02d25fa13d stdioext: Add support for musl libc.
Bruno Haible <bruno@clisp.org>
parents: 16201
diff changeset
47
9727
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
48 #endif