GNU text utilities
[gnulib.git] / lib / linebuffer.h
1 /* linebuffer.h -- declarations for reading arbitrarily long lines
2    Copyright (C) 1986, 1991 Free Software Foundation, Inc.
3
4    This program is free software; you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation; either version 2, or (at your option)
7    any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program; if not, write to the Free Software
16    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
17 \f
18 /* A `struct linebuffer' holds a line of text. */
19
20 struct linebuffer
21 {
22   long size;                    /* Allocated. */
23   long length;                  /* Used. */
24   char *buffer;
25 };
26
27 #undef __P
28 #if defined (__STDC__) && __STDC__
29 #define __P(x) x
30 #else
31 #define __P(x) ()
32 #endif
33
34 /* Initialize linebuffer LINEBUFFER for use. */
35 void initbuffer __P ((struct linebuffer *linebuffer));
36
37 /* Read an arbitrarily long line of text from STREAM into LINEBUFFER.
38    Remove any newline.  Does not null terminate.
39    Return LINEBUFFER, except at end of file return 0.  */
40 struct linebuffer *readline __P ((struct linebuffer *linebuffer, FILE *stream));
41
42 /* Free linebuffer LINEBUFFER and its data, all allocated with malloc. */
43 void freebuffer __P ((struct linebuffer *));