xref: /openbsd-src/lib/libc/stdio/fgetln.c (revision db3296cf5c1dd9058ceecc3a29fe4aaa0bd26000)
1 /*-
2  * Copyright (c) 1990, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Chris Torek.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 #if defined(LIBC_SCCS) && !defined(lint)
34 static char *rcsid = "$OpenBSD: fgetln.c,v 1.4 2003/06/02 20:18:37 millert Exp $";
35 #endif /* LIBC_SCCS and not lint */
36 
37 #include <stdio.h>
38 #include <stdlib.h>
39 #include <string.h>
40 #include "local.h"
41 
42 /*
43  * Expand the line buffer.  Return -1 on error.
44 #ifdef notdef
45  * The `new size' does not account for a terminating '\0',
46  * so we add 1 here.
47 #endif
48  */
49 int
50 __slbexpand(fp, newsize)
51 	FILE *fp;
52 	size_t newsize;
53 {
54 	void *p;
55 
56 #ifdef notdef
57 	++newsize;
58 #endif
59 	if (fp->_lb._size >= newsize)
60 		return (0);
61 	if ((p = realloc(fp->_lb._base, newsize)) == NULL)
62 		return (-1);
63 	fp->_lb._base = p;
64 	fp->_lb._size = newsize;
65 	return (0);
66 }
67 
68 /*
69  * Get an input line.  The returned pointer often (but not always)
70  * points into a stdio buffer.  Fgetline does not alter the text of
71  * the returned line (which is thus not a C string because it will
72  * not necessarily end with '\0'), but does allow callers to modify
73  * it if they wish.  Thus, we set __SMOD in case the caller does.
74  */
75 char *
76 fgetln(fp, lenp)
77 	register FILE *fp;
78 	size_t *lenp;
79 {
80 	register unsigned char *p;
81 	register size_t len;
82 	size_t off;
83 
84 	/* make sure there is input */
85 	if (fp->_r <= 0 && __srefill(fp)) {
86 		*lenp = 0;
87 		return (NULL);
88 	}
89 
90 	/* look for a newline in the input */
91 	if ((p = memchr((void *)fp->_p, '\n', fp->_r)) != NULL) {
92 		register char *ret;
93 
94 		/*
95 		 * Found one.  Flag buffer as modified to keep fseek from
96 		 * `optimising' a backward seek, in case the user stomps on
97 		 * the text.
98 		 */
99 		p++;		/* advance over it */
100 		ret = (char *)fp->_p;
101 		*lenp = len = p - fp->_p;
102 		fp->_flags |= __SMOD;
103 		fp->_r -= len;
104 		fp->_p = p;
105 		return (ret);
106 	}
107 
108 	/*
109 	 * We have to copy the current buffered data to the line buffer.
110 	 * As a bonus, though, we can leave off the __SMOD.
111 	 *
112 	 * OPTIMISTIC is length that we (optimistically) expect will
113 	 * accommodate the `rest' of the string, on each trip through the
114 	 * loop below.
115 	 */
116 #define OPTIMISTIC 80
117 
118 	for (len = fp->_r, off = 0;; len += fp->_r) {
119 		register size_t diff;
120 
121 		/*
122 		 * Make sure there is room for more bytes.  Copy data from
123 		 * file buffer to line buffer, refill file and look for
124 		 * newline.  The loop stops only when we find a newline.
125 		 */
126 		if (__slbexpand(fp, len + OPTIMISTIC))
127 			goto error;
128 		(void)memcpy((void *)(fp->_lb._base + off), (void *)fp->_p,
129 		    len - off);
130 		off = len;
131 		if (__srefill(fp))
132 			break;	/* EOF or error: return partial line */
133 		if ((p = memchr((void *)fp->_p, '\n', fp->_r)) == NULL)
134 			continue;
135 
136 		/* got it: finish up the line (like code above) */
137 		p++;
138 		diff = p - fp->_p;
139 		len += diff;
140 		if (__slbexpand(fp, len))
141 			goto error;
142 		(void)memcpy((void *)(fp->_lb._base + off), (void *)fp->_p,
143 		    diff);
144 		fp->_r -= diff;
145 		fp->_p = p;
146 		break;
147 	}
148 	*lenp = len;
149 #ifdef notdef
150 	fp->_lb._base[len] = 0;
151 #endif
152 	return ((char *)fp->_lb._base);
153 
154 error:
155 	*lenp = 0;		/* ??? */
156 	return (NULL);		/* ??? */
157 }
158