ae72796c7a49dbcb359fb1a1845a8be9c0039a5a
[people/sha0/gpxe.git] / src / core / linebuf.c
1 /*
2  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * 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  */
18
19 /**
20  * @file
21  *
22  * Line buffering
23  *
24  */
25
26 #include <stdint.h>
27 #include <string.h>
28 #include <stdlib.h>
29 #include <errno.h>
30 #include <gpxe/linebuf.h>
31
32 /**
33  * Retrieve buffered-up line
34  *
35  * @v linebuf           Line buffer
36  * @ret line            Buffered line, or NULL if no line ready to read
37  */
38 char * buffered_line ( struct line_buffer *linebuf ) {
39         return ( linebuf->ready ? linebuf->data : NULL );
40 }
41
42 /**
43  * Discard line buffer contents
44  *
45  * @v linebuf           Line buffer
46  */
47 void empty_line_buffer ( struct line_buffer *linebuf ) {
48         free ( linebuf->data );
49         linebuf->data = NULL;
50         linebuf->len = 0;
51         linebuf->ready = 0;
52 }
53
54 /**
55  * Buffer up received data by lines
56  *
57  * @v linebuf                   Line buffer
58  * @v data                      New data to add
59  * @v len                       Length of new data to add
60  * @ret rc                      Return status code
61  * 
62  * If line_buffer() returns >0, then an end of line has been reached
63  * and the buffered-up line can be obtained from buffered_line().
64  * Carriage returns and newlines will have been stripped, and the line
65  * will be NUL-terminated.  This buffered line is valid only until the
66  * next call to line_buffer() (or to empty_line_buffer()).
67  *
68  * @c data and @c len will be updated to reflect the data consumed by
69  * line_buffer().
70  *
71  * Note that line buffers use dynamically allocated storage; you
72  * should call empty_line_buffer() before freeing a @c struct @c
73  * line_buffer.
74  */
75 int line_buffer ( struct line_buffer *linebuf,
76                   const char **data, size_t *len ) {
77         const char *eol;
78         size_t consume;
79         size_t new_len;
80         char *new_data;
81
82         /* Free any completed line from previous iteration */
83         if ( linebuf->ready )
84                 empty_line_buffer ( linebuf );
85
86         /* Search for line terminator */
87         if ( ( eol = memchr ( *data, '\n', *len ) ) ) {
88                 consume = ( eol - *data + 1 );
89         } else {
90                 consume = *len;
91         }
92
93         /* Reallocate data buffer and copy in new data */
94         new_len = ( linebuf->len + consume );
95         new_data = realloc ( linebuf->data, ( new_len + 1 ) );
96         if ( ! new_data )
97                 return -ENOMEM;
98         memcpy ( ( new_data + linebuf->len ), *data, consume );
99         new_data[new_len] = '\0';
100         linebuf->data = new_data;
101         linebuf->len = new_len;
102
103         /* Update data and len */
104         *data += consume;
105         *len -= consume;
106
107         /* If we have reached end of line, trim the line and mark as ready */
108         if ( eol ) {
109                 linebuf->data[--linebuf->len] = '\0'; /* trim NL */
110                 if ( linebuf->data[linebuf->len - 1] == '\r' )
111                         linebuf->data[--linebuf->len] = '\0'; /* trim CR */
112                 linebuf->ready = 1;
113         }
114
115         return 0;
116 }