annotate lib/freadptr.h @ 10780:5c7a68d31801

Add support for Haiku.
author Bruno Haible <bruno@clisp.org>
date Mon, 10 Nov 2008 12:37:32 +0100
parents 569a44f4dd4d
children b5e42ef33b49
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:
9779
569a44f4dd4d Extend freadptr to return also the buffer size.
Bruno Haible <bruno@clisp.org>
parents: 9733
diff changeset
25 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
26 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
27 of the input buffer.
569a44f4dd4d Extend freadptr to return also the buffer size.
Bruno Haible <bruno@clisp.org>
parents: 9733
diff changeset
28 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
29 fgetc (STREAM), or fread (..., STREAM) to access the input from STREAM.
9727
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
30
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
31 The resulting pointer becomes invalid upon any operation on STREAM.
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
32
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33 STREAM must not be wide-character oriented. */
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34
9779
569a44f4dd4d Extend freadptr to return also the buffer size.
Bruno Haible <bruno@clisp.org>
parents: 9733
diff changeset
35 extern const char * freadptr (FILE *stream, size_t *sizep);
9727
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
36
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
37 #ifdef __cplusplus
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
38 }
7c1260f0aac3 New module 'freadptr'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
39 #endif