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 source tree.
  10  */
  11
  12 #include "libbb.h"
  13
  14 /* This function reads an entire line from a text file, up to a newline
  15  * or NUL byte, inclusive.  It returns a malloc'ed char * which
  16  * must be free'ed by the caller.  If end is NULL '\n' isn't considered
  17  * end of line.  If end isn't NULL, length of the chunk is stored in it.
  18  * If lineno is not NULL, *lineno is incremented for each line,
  19  * and also trailing '\' is recognized as line continuation.
  20  *
  21  * Returns NULL if EOF/error. */
  22 char* FAST_FUNC bb_get_chunk_with_continuation(FILE *file, int *end, int *lineno)
  23 {
  24         int ch;
  25         int idx = 0;
  26         char *linebuf = NULL;
  27         int linebufsz = 0;
  28
  29         while ((ch = getc(file)) != EOF) {
  30                 /* grow the line buffer as necessary */
  31                 if (idx >= linebufsz) {
  32                         linebufsz += 256;
  33                         linebuf = xrealloc(linebuf, linebufsz);
  34                 }
  35                 linebuf[idx++] = (char) ch;
  36                 if (!ch)
  37                         break;
  38                 if (end && ch == '\n') {
  39                         if (lineno == NULL)
  40                                 break;
  41                         (*lineno)++;
  42                         if (idx < 2 || linebuf[idx-2] != '\\')
  43                                 break;
  44                         idx -= 2;
  45                 }
  46         }
  47         if (end) {
  48                 *end = idx;
  49                 /* handle corner case when the file is not ended with '\n' */
  50                 if (ch == EOF && lineno != NULL)
  51                         (*lineno)++;
  52         }
  53         if (linebuf) {
  54                 // huh, does fgets discard prior data on error like this?
  55                 // I don't think so....
  56                 //if (ferror(file)) {
  57                 //      free(linebuf);
  58                 //      return NULL;
  59                 //}
  60                 linebuf = xrealloc(linebuf, idx + 1);
  61                 linebuf[idx] = '\0';
  62         }
  63         return linebuf;
  64 }
  65
  66 char* FAST_FUNC bb_get_chunk_from_file(FILE *file, int *end)
  67 {
  68         return bb_get_chunk_with_continuation(file, end, NULL);
  69 }
  70
  71 /* Get line, including trailing \n if any */
  72 char* FAST_FUNC xmalloc_fgets(FILE *file)
  73 {
  74         int i;
  75
  76         return bb_get_chunk_from_file(file, &i);
  77 }
  78 /* Get line.  Remove trailing \n */
  79 char* FAST_FUNC xmalloc_fgetline(FILE *file)
  80 {
  81         int i;
  82         char *c = bb_get_chunk_from_file(file, &i);
  83
  84         if (i && c[--i] == '\n')
  85                 c[i] = '\0';
  86
  87         return c;
  88 }
  89
  90 #if 0
  91 /* GNUism getline() should be faster (not tested) than a loop with fgetc */
  92
  93 /* Get line, including trailing \n if any */
  94 char* FAST_FUNC xmalloc_fgets(FILE *file)
  95 {
  96         char *res_buf = NULL;
  97         size_t res_sz;
  98
  99         if (getline(&res_buf, &res_sz, file) == -1) {
 100                 free(res_buf); /* uclibc allocates a buffer even on EOF. WTF? */
 101                 res_buf = NULL;
 102         }
 103 //TODO: trimming to res_sz?
 104         return res_buf;
 105 }
 106 /* Get line.  Remove trailing \n */
 107 char* FAST_FUNC xmalloc_fgetline(FILE *file)
 108 {
 109         char *res_buf = NULL;
 110         size_t res_sz;
 111
 112         res_sz = getline(&res_buf, &res_sz, file);
 113
 114         if ((ssize_t)res_sz != -1) {
 115                 if (res_buf[res_sz - 1] == '\n')
 116                         res_buf[--res_sz] = '\0';
 117 //TODO: trimming to res_sz?
 118         } else {
 119                 free(res_buf); /* uclibc allocates a buffer even on EOF. WTF? */
 120                 res_buf = NULL;
 121         }
 122         return res_buf;
 123 }
 124
 125 #endif
 126
 127 #if 0
 128 /* Faster routines (~twice as fast). +170 bytes. Unused as of 2008-07.
 129  *
 130  * NB: they stop at NUL byte too.
 131  * Performance is important here. Think "grep 50gigabyte_file"...
 132  * Ironically, grep can't use it because of NUL issue.
 133  * We sorely need C lib to provide fgets which reports size!
 134  *
 135  * Update:
 136  * Actually, uclibc and glibc have it. man getline. It's GNUism,
 137  *   but very useful one (if it's as fast as this code).
 138  * TODO:
 139  * - currently, sed and sort use bb_get_chunk_from_file and heavily
 140  *   depend on its "stop on \n or \0" behavior, and STILL they fail
 141  *   to handle all cases with embedded NULs correctly. So:
 142  * - audit sed and sort; convert them to getline FIRST.
 143  * - THEN ditch bb_get_chunk_from_file, replace it with getline.
 144  * - provide getline implementation for non-GNU systems.
 145  */
 146
 147 static char* xmalloc_fgets_internal(FILE *file, int *sizep)
 148 {
 149         int len;
 150         int idx = 0;
 151         char *linebuf = NULL;
 152
 153         while (1) {
 154                 char *r;
 155
 156                 linebuf = xrealloc(linebuf, idx + 0x100);
 157                 r = fgets(&linebuf[idx], 0x100, file);
 158                 if (!r) {
 159                         /* need to terminate in case this is error
 160                          * (EOF puts NUL itself) */
 161                         linebuf[idx] = '\0';
 162                         break;
 163                 }
 164                 /* stupid. fgets knows the len, it should report it somehow */
 165                 len = strlen(&linebuf[idx]);
 166                 idx += len;
 167                 if (len != 0xff || linebuf[idx - 1] == '\n')
 168                         break;
 169         }
 170         *sizep = idx;
 171         if (idx) {
 172                 /* xrealloc(linebuf, idx + 1) is up to caller */
 173                 return linebuf;
 174         }
 175         free(linebuf);
 176         return NULL;
 177 }
 178
 179 /* Get line, remove trailing \n */
 180 char* FAST_FUNC xmalloc_fgetline_fast(FILE *file)
 181 {
 182         int sz;
 183         char *r = xmalloc_fgets_internal(file, &sz);
 184         if (r && r[sz - 1] == '\n')
 185                 r[--sz] = '\0';
 186         return r; /* not xrealloc(r, sz + 1)! */
 187 }
 188
 189 char* FAST_FUNC xmalloc_fgets(FILE *file)
 190 {
 191         int sz;
 192         return xmalloc_fgets_internal(file, &sz);
 193 }
 194
 195 /* Get line, remove trailing \n */
 196 char* FAST_FUNC xmalloc_fgetline(FILE *file)
 197 {
 198         int sz;
 199         char *r = xmalloc_fgets_internal(file, &sz);
 200         if (!r)
 201                 return r;
 202         if (r[sz - 1] == '\n')
 203                 r[--sz] = '\0';
 204         return xrealloc(r, sz + 1);
 205 }
 206 #endif