add usefun info on SIGINT handling peculiarities
[oweals/busybox.git] / libbb / get_line_from_file.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Utility routines.
4  *
5  * Copyright (C) 2005, 2006 Rob Landley <rob@landley.net>
6  * Copyright (C) 2004 Erik Andersen <andersen@codepoet.org>
7  * Copyright (C) 2001 Matt Krai
8  *
9  * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
10  */
11
12 #include <stdio.h>
13 #include <stdlib.h>
14 #include "libbb.h"
15
16 /* get_line_from_file() - This function reads an entire line from a text file,
17  * up to a newline or NUL byte.  It returns a malloc'ed char * which must be
18  * stored and free'ed  by the caller.  If end is null '\n' isn't considered
19  * end of line.  If end isn't null, length of the chunk read is stored in it. */
20
21 char *bb_get_chunk_from_file(FILE * file, int *end)
22 {
23         int ch;
24         int idx = 0;
25         char *linebuf = NULL;
26         int linebufsz = 0;
27
28         while ((ch = getc(file)) != EOF) {
29                 /* grow the line buffer as necessary */
30                 if (idx > linebufsz - 2) {
31                         linebuf = xrealloc(linebuf, linebufsz += 80);
32                 }
33                 linebuf[idx++] = (char) ch;
34                 if (!ch || (end && ch == '\n'))
35                         break;
36         }
37         if (end)
38                 *end = idx;
39         if (linebuf) {
40                 if (ferror(file)) {
41                         free(linebuf);
42                         return NULL;
43                 }
44                 linebuf = xrealloc(linebuf, idx+1);
45                 linebuf[idx] = 0;
46         }
47         return linebuf;
48 }
49
50 /* Get line, including trailing \n if any */
51 char *xmalloc_fgets(FILE * file)
52 {
53         int i;
54
55         return bb_get_chunk_from_file(file, &i);
56 }
57
58 /* Get line.  Remove trailing \n */
59 char *xmalloc_getline(FILE * file)
60 {
61         int i;
62         char *c = bb_get_chunk_from_file(file, &i);
63
64         if (i && c[--i] == '\n')
65                 c[i] = 0;
66
67         return c;
68 }