annotate lib/freadptr.h @ 9727:7c1260f0aac3

New module 'freadptr'.
author Bruno Haible <bruno@clisp.org>
date Thu, 28 Feb 2008 13:19:17 +0100
parents
children 969f2ce575c5
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.
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
2 Copyright (C) 2007-2008 Free Software Foundation, Inc.
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 #ifdef __cplusplus
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
21 extern "C" {
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
22 #endif
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
23
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
24 /* Assuming the stream STREAM is open for reading:
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
25 Return a pointer to the input buffer of STREAM.
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
26 If freadahead (STREAM) > 0, the result is a pointer to freadahead (STREAM)
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
27 bytes.
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
28 If freadahead (STREAM) == 0, the result is not usable; it may be NULL.
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
29 In this case, you should use getc (STREAM), fgetc (STREAM), or
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
30 fread (..., STREAM) to access the input from STREAM.
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
31
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
32 The resulting pointer becomes invalid upon any operation on STREAM.
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34 STREAM must not be wide-character oriented. */
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
35
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
36 extern const char * freadptr (FILE *stream);
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
37
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
38 #ifdef __cplusplus
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
39 }
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
40 #endif