lib/getndelim2.c

   1 /* getndelim2 - Read a line from a stream, stopping at one of 2 delimiters,
   2    with bounded memory allocation.
   3
   4    Copyright (C) 1993, 1996, 1997, 1998, 2000, 2003, 2004, 2006 Free
   5    Software Foundation, Inc.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2, or (at your option)
  10    any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software Foundation,
  19    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  20
  21 /* Originally written by Jan Brittenson, bson@gnu.ai.mit.edu.  */
  22
  23 #include <config.h>
  24
  25 #include "getndelim2.h"
  26
  27 #include <stdlib.h>
  28 #include <stddef.h>
  29
  30 #if USE_UNLOCKED_IO
  31 # include "unlocked-io.h"
  32 #endif
  33
  34 #include <limits.h>
  35 #include <stdint.h>
  36
  37 /* The maximum value that getndelim2 can return without suffering from
  38    overflow problems, either internally (because of pointer
  39    subtraction overflow) or due to the API (because of ssize_t).  */
  40 #define GETNDELIM2_MAXIMUM (PTRDIFF_MAX < SSIZE_MAX ? PTRDIFF_MAX : SSIZE_MAX)
  41
  42 /* Try to add at least this many bytes when extending the buffer.
  43    MIN_CHUNK must be no greater than GETNDELIM2_MAXIMUM.  */
  44 #define MIN_CHUNK 64
  45
  46 ssize_t
  47 getndelim2 (char **lineptr, size_t *linesize, size_t offset, size_t nmax,
  48             int delim1, int delim2, FILE *stream)
  49 {
  50   size_t nbytes_avail;          /* Allocated but unused bytes in *LINEPTR.  */
  51   char *read_pos;               /* Where we're reading into *LINEPTR. */
  52   ssize_t bytes_stored = -1;
  53   char *ptr = *lineptr;
  54   size_t size = *linesize;
  55
  56   if (!ptr)
  57     {
  58       size = nmax < MIN_CHUNK ? nmax : MIN_CHUNK;
  59       ptr = malloc (size);
  60       if (!ptr)
  61         return -1;
  62     }
  63
  64   if (size < offset)
  65     goto done;
  66
  67   nbytes_avail = size - offset;
  68   read_pos = ptr + offset;
  69
  70   if (nbytes_avail == 0 && nmax <= size)
  71     goto done;
  72
  73   for (;;)
  74     {
  75       /* Here always ptr + size == read_pos + nbytes_avail.  */
  76
  77       int c;
  78
  79       /* We always want at least one byte left in the buffer, since we
  80          always (unless we get an error while reading the first byte)
  81          NUL-terminate the line buffer.  */
  82
  83       if (nbytes_avail < 2 && size < nmax)
  84         {
  85           size_t newsize = size < MIN_CHUNK ? size + MIN_CHUNK : 2 * size;
  86           char *newptr;
  87
  88           if (! (size < newsize && newsize <= nmax))
  89             newsize = nmax;
  90
  91           if (GETNDELIM2_MAXIMUM < newsize - offset)
  92             {
  93               size_t newsizemax = offset + GETNDELIM2_MAXIMUM + 1;
  94               if (size == newsizemax)
  95                 goto done;
  96               newsize = newsizemax;
  97             }
  98
  99           nbytes_avail = newsize - (read_pos - ptr);
 100           newptr = realloc (ptr, newsize);
 101           if (!newptr)
 102             goto done;
 103           ptr = newptr;
 104           size = newsize;
 105           read_pos = size - nbytes_avail + ptr;
 106         }
 107
 108       c = getc (stream);
 109       if (c == EOF)
 110         {
 111           /* Return partial line, if any.  */
 112           if (read_pos == ptr)
 113             goto done;
 114           else
 115             break;
 116         }
 117
 118       if (nbytes_avail >= 2)
 119         {
 120           *read_pos++ = c;
 121           nbytes_avail--;
 122         }
 123
 124       if (c == delim1 || c == delim2)
 125         /* Return the line.  */
 126         break;
 127     }
 128
 129   /* Done - NUL terminate and return the number of bytes read.
 130      At this point we know that nbytes_avail >= 1.  */
 131   *read_pos = '\0';
 132
 133   bytes_stored = read_pos - (ptr + offset);
 134
 135  done:
 136   *lineptr = ptr;
 137   *linesize = size;
 138   return bytes_stored;
 139 }