annotate lib/linebuffer.h @ 8812:28d0ef9a0a36

* lib/linebuffer.c (readlinebuffer_delim): New function, like readlinebuffer, but use a caller-specified delimiter. (readlinebuffer): Just call readlinebuffer_delim with '\n' as the delimiter. * lib/linebuffer.h (readlinebuffer_delim): Declare it.
author Jim Meyering <jim@meyering.net>
date Sat, 12 May 2007 15:59:59 +0000
parents a48fb0e98c8c
children b8edbad1b48a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
1 /* linebuffer.h -- declarations for reading arbitrarily long lines
4169
f3219f604940 (readlinebuffer): Renamed from readline.
Paul Eggert <eggert@cs.ucla.edu>
parents: 4103
diff changeset
2
8812
28d0ef9a0a36 * lib/linebuffer.c (readlinebuffer_delim): New function,
Jim Meyering <jim@meyering.net>
parents: 5848
diff changeset
3 Copyright (C) 1986, 1991, 1998, 1999, 2002, 2003, 2007 Free Software
4169
f3219f604940 (readlinebuffer): Renamed from readline.
Paul Eggert <eggert@cs.ucla.edu>
parents: 4103
diff changeset
4 Foundation, Inc.
14
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
5
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
6 This program is free software; you can redistribute it and/or modify
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
8 the Free Software Foundation; either version 2, or (at your option)
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
9 any later version.
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
10
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
11 This program is distributed in the hope that it will be useful,
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
14 GNU General Public License for more details.
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
15
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
756
Jim Meyering <jim@meyering.net>
parents: 742
diff changeset
17 along with this program; if not, write to the Free Software Foundation,
5848
a48fb0e98c8c *** empty log message ***
Paul Eggert <eggert@cs.ucla.edu>
parents: 4397
diff changeset
18 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
1216
cf3c93b52b9b Make PARAMS-defining conditionals consistent.
Jim Meyering <jim@meyering.net>
parents: 756
diff changeset
19
cf3c93b52b9b Make PARAMS-defining conditionals consistent.
Jim Meyering <jim@meyering.net>
parents: 756
diff changeset
20 #if !defined LINEBUFFER_H
cf3c93b52b9b Make PARAMS-defining conditionals consistent.
Jim Meyering <jim@meyering.net>
parents: 756
diff changeset
21 # define LINEBUFFER_H
cf3c93b52b9b Make PARAMS-defining conditionals consistent.
Jim Meyering <jim@meyering.net>
parents: 756
diff changeset
22
4347
df44e79ce676 .h files should stand alone, but we shouldn't include <sys/types.h>
Paul Eggert <eggert@cs.ucla.edu>
parents: 4169
diff changeset
23 # include <stdio.h>
df44e79ce676 .h files should stand alone, but we shouldn't include <sys/types.h>
Paul Eggert <eggert@cs.ucla.edu>
parents: 4169
diff changeset
24
14
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
25 /* A `struct linebuffer' holds a line of text. */
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
26
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
27 struct linebuffer
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
28 {
1867
8cac4427bbda [struct linebuffer] (size): Declare to be of type size_t, not long.
Jim Meyering <jim@meyering.net>
parents: 1216
diff changeset
29 size_t size; /* Allocated. */
8cac4427bbda [struct linebuffer] (size): Declare to be of type size_t, not long.
Jim Meyering <jim@meyering.net>
parents: 1216
diff changeset
30 size_t length; /* Used. */
14
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
31 char *buffer;
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
32 };
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
33
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
34 /* Initialize linebuffer LINEBUFFER for use. */
4397
c6450308f123 Assume C89, so PARAMS isn't needed.
Paul Eggert <eggert@cs.ucla.edu>
parents: 4347
diff changeset
35 void initbuffer (struct linebuffer *linebuffer);
14
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
36
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
37 /* Read an arbitrarily long line of text from STREAM into LINEBUFFER.
8812
28d0ef9a0a36 * lib/linebuffer.c (readlinebuffer_delim): New function,
Jim Meyering <jim@meyering.net>
parents: 5848
diff changeset
38 Consider lines to be terminated by DELIMITER.
28d0ef9a0a36 * lib/linebuffer.c (readlinebuffer_delim): New function,
Jim Meyering <jim@meyering.net>
parents: 5848
diff changeset
39 Keep the delimiter; append DELIMITER if we reach EOF and it wasn't
28d0ef9a0a36 * lib/linebuffer.c (readlinebuffer_delim): New function,
Jim Meyering <jim@meyering.net>
parents: 5848
diff changeset
40 the last character in the file. Do not null terminate.
28d0ef9a0a36 * lib/linebuffer.c (readlinebuffer_delim): New function,
Jim Meyering <jim@meyering.net>
parents: 5848
diff changeset
41 Return LINEBUFFER, except at end of file return 0. */
28d0ef9a0a36 * lib/linebuffer.c (readlinebuffer_delim): New function,
Jim Meyering <jim@meyering.net>
parents: 5848
diff changeset
42 struct linebuffer *readlinebuffer_delim (struct linebuffer *linebuffer,
28d0ef9a0a36 * lib/linebuffer.c (readlinebuffer_delim): New function,
Jim Meyering <jim@meyering.net>
parents: 5848
diff changeset
43 FILE *stream, char delimiter);
28d0ef9a0a36 * lib/linebuffer.c (readlinebuffer_delim): New function,
Jim Meyering <jim@meyering.net>
parents: 5848
diff changeset
44
28d0ef9a0a36 * lib/linebuffer.c (readlinebuffer_delim): New function,
Jim Meyering <jim@meyering.net>
parents: 5848
diff changeset
45 /* Read an arbitrarily long line of text from STREAM into LINEBUFFER.
1867
8cac4427bbda [struct linebuffer] (size): Declare to be of type size_t, not long.
Jim Meyering <jim@meyering.net>
parents: 1216
diff changeset
46 Keep the newline; append a newline if it's the last line of a file
8cac4427bbda [struct linebuffer] (size): Declare to be of type size_t, not long.
Jim Meyering <jim@meyering.net>
parents: 1216
diff changeset
47 that ends in a non-newline character. Do not null terminate.
14
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
48 Return LINEBUFFER, except at end of file return 0. */
4397
c6450308f123 Assume C89, so PARAMS isn't needed.
Paul Eggert <eggert@cs.ucla.edu>
parents: 4347
diff changeset
49 struct linebuffer *readlinebuffer (struct linebuffer *linebuffer, FILE *stream);
14
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
50
3eda3e12f7ba Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
51 /* Free linebuffer LINEBUFFER and its data, all allocated with malloc. */
4397
c6450308f123 Assume C89, so PARAMS isn't needed.
Paul Eggert <eggert@cs.ucla.edu>
parents: 4347
diff changeset
52 void freebuffer (struct linebuffer *);
1216
cf3c93b52b9b Make PARAMS-defining conditionals consistent.
Jim Meyering <jim@meyering.net>
parents: 756
diff changeset
53
cf3c93b52b9b Make PARAMS-defining conditionals consistent.
Jim Meyering <jim@meyering.net>
parents: 756
diff changeset
54 #endif /* LINEBUFFER_H */