1.\" $NetBSD: fparseln.3,v 1.7 1999/07/02 15:49:12 simonb Exp $ 2.\" $FreeBSD$ 3.\" 4.\" Copyright (c) 1997 Christos Zoulas. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by Christos Zoulas. 17.\" 4. The name of the author may not be used to endorse or promote products 18.\" derived from this software without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 21.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 22.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 23.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 24.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 25.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 29.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30.\" 31.Dd December 1, 1997 32.Dt FPARSELN 3 33.Os 34.Sh NAME 35.Nm fparseln 36.Nd return the next logical line from a stream 37.Sh LIBRARY 38.Lb libutil 39.Sh SYNOPSIS 40.Fd #include <stdio.h> 41.Fd #include <libutil.h> 42.Ft "char *" 43.Fo fparseln 44.Fa "FILE *stream" "size_t *len" "size_t *lineno" 45.Fa "const char delim[3]" "int flags" 46.Fc 47.Pp 48Link with 49.Va -lutil 50on the 51.Xr cc 1 52command line. 53.Sh DESCRIPTION 54The 55.Fn fparseln 56function 57returns a pointer to the next logical line from the stream referenced by 58.Fa stream . 59This string is 60.Dv NUL 61terminated and it is dynamicaly allocated on each invocation. It is the 62responsibility of the caller to free the pointer. 63.Pp 64By default, if a character is escaped, both it and the preceeding escape 65character will be present in the returned string. 66Various 67.Fa flags 68alter this behaviour. 69.Pp 70The meaning of the arguments is as follows: 71.Bl -tag -width "lineno" 72.It Fa stream 73The stream to read from. 74.It Fa len 75If not 76.Dv NULL , 77the length of the string is stored in the memory location to which it 78points. 79.It Fa lineno 80If not 81.Dv NULL , 82the value of the memory location to which is pointed to, is incremented 83by the number of lines actually read from the file. 84.It Fa delim 85Contains the escape, continuation, and comment characters. 86If a character is 87.Dv NUL 88then processing for that character is disabled. 89If 90.Dv NULL , 91all characters default to values specified below. 92The contents of 93.Fa delim 94is as follows: 95.Bl -tag -width "delim[0]" 96.It Fa delim[0] 97The escape character, which defaults to 98.Cm \e , 99is used to remove any special meaning from the next character. 100.It Fa delim[1] 101The continuation character, which defaults to 102.Cm \e , 103is used to indicate that the next line should be concatenated with the 104current one if this character is the last character on the current line 105and is not escaped. 106.It Fa delim[2] 107The comment character, which defaults to 108.Cm # , 109if not escaped indicates the beginning of a comment that extends until the 110end of the current line. 111.El 112.It Fa flags 113If non-zero, alter the operation of 114.Fn fparseln . 115The various flags, which may be 116.Em or Ns -ed 117together, are: 118.Bl -tag -width "FPARSELN_UNESCCOMM" 119.It Dv FPARSELN_UNESCCOMM 120Remove escape preceeding an escaped comment. 121.It Dv FPARSELN_UNESCCONT 122Remove escape preceeding an escaped continuation. 123.It Dv FPARSELN_UNESCESC 124Remove escape preceeding an escaped escape. 125.It Dv FPARSELN_UNESCREST 126Remove escape preceeding any other character. 127.It Dv FPARSELN_UNESCALL 128All of the above. 129.El 130.Pp 131.El 132.Sh RETURN VALUES 133Upon successful completion a pointer to the parsed line is returned; 134otherwise, 135.Dv NULL 136is returned. 137.Pp 138The 139.Fn fparseln 140function uses internally 141.Xr fgetln 3 , 142so all error conditions that apply to 143.Xr fgetln 3 , 144apply to 145.Fn fparseln . 146In addition 147.Fn fparseln 148may set 149.Va errno 150to 151.Bq Er ENOMEM 152and return 153.Dv NULL 154if it runs out of memory. 155.Sh SEE ALSO 156.Xr fgetln 3 157.Sh HISTORY 158The 159.Fn fparseln 160function first appeared in 161.Nx 1.4 . 162