annotate lib/getnline.h @ 4554:5a1e7c84e9cd

Use three spaces, rather than tab, after '#' in shell-script copyright notices. Suggested by Bruno Haible.
author Paul Eggert <eggert@cs.ucla.edu>
date Fri, 15 Aug 2003 18:04:34 +0000
parents 1892b6732a40
children aa119e787246
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4460
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
1 /* getnline - Read a line from a stream, with bounded memory allocation.
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
2
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
3 Copyright (C) 2003 Free Software Foundation, Inc.
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
4
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
5 This program is free software; you can redistribute it and/or modify
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
7 the Free Software Foundation; either version 2, or (at your option)
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
8 any later version.
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
9
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
13 GNU General Public License for more details.
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
14
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
16 along with this program; if not, write to the Free Software Foundation,
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
17 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
18
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
19 #ifndef GETNLINE_H
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
20 #define GETNLINE_H 1
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
21
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
22 #include <stddef.h>
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
23 #include <stdio.h>
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
24
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
25 /* Get ssize_t. */
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
26 #include <sys/types.h>
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
27
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
28 /* Read a line, up to the next newline, from STREAM, and store it in *LINEPTR.
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
29 *LINEPTR is a pointer returned from malloc (or NULL), pointing to *LINESIZE
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
30 bytes of space. It is realloc'd as necessary. Reallocation is limited to
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
31 NMAX bytes; if the line is longer than that, the extra bytes are read but
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
32 thrown away.
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33 Return the number of bytes read and stored at *LINEPTR (not including the
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34 NUL terminator), or -1 on error or EOF. */
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
35 extern ssize_t getnline (char **lineptr, size_t *linesize, size_t nmax,
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
36 FILE *stream);
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
37
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
38 /* Read a line, up to the next occurrence of DELIMITER, from STREAM, and store
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
39 it in *LINEPTR.
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
40 *LINEPTR is a pointer returned from malloc (or NULL), pointing to *LINESIZE
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
41 bytes of space. It is realloc'd as necessary. Reallocation is limited to
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
42 NMAX bytes; if the line is longer than that, the extra bytes are read but
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
43 thrown away.
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
44 Return the number of bytes read and stored at *LINEPTR (not including the
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
45 NUL terminator), or -1 on error or EOF. */
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
46 extern ssize_t getndelim (char **lineptr, size_t *linesize, size_t nmax,
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
47 int delimiter, FILE *stream);
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
48
1892b6732a40 New module 'getnline'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
49 #endif /* GETNLINE_H */