1.\" $NetBSD: stringlist.3,v 1.2 1997/04/09 08:59:25 kleink Exp $ 2.\" 3.\" Copyright (c) 1997 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This file was contributed to The NetBSD Foundation by Luke Mewburn. 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. All advertising materials mentioning features or use of this software 17.\" must display the following acknowledgement: 18.\" This product includes software developed by the NetBSD 19.\" Foundation, Inc. and its contributors. 20.\" 4. Neither the name of The NetBSD Foundation nor the names of its 21.\" contributors may be used to endorse or promote products derived 22.\" from this software without specific prior written permission. 23.\" 24.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 25.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 26.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 27.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE 28.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 29.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 30.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 31.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 32.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 33.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 34.\" POSSIBILITY OF SUCH DAMAGE. 35.\" 36.Dd February 24, 1997 37.Os NetBSD 1.3 38.Dt STRINGLIST 3 39.Sh NAME 40.Nm stringlist , 41.Nm sl_init , 42.Nm sl_add , 43.Nm sl_free , 44.Nm sl_find 45.Nd stringlist manipulation functions 46.Sh SYNOPSIS 47.Fd #include <stringlist.h> 48.Ft StringList * 49.Fn sl_init 50.Ft void 51.Fn sl_add "StringList *sl" "char *item" 52.Ft void 53.Fn sl_free "StringList *sl" "int freeall" 54.Ft char * 55.Fn sl_find "StringList *sl" "char *item" 56.Sh DESCRIPTION 57The 58.Nm 59functions manipulate stringlists, which are lists of 60strings that extend automatically if necessary. 61.Pp 62The 63.Ar StringList 64structure has the following definition: 65.Bd -literal -offset indent 66typedef struct _stringlist { 67 char **sl_str; 68 size_t sl_max; 69 size_t sl_cur; 70} StringList; 71.Ed 72.Pp 73.Bl -tag -width "sl_str" -offset indent 74.It Ar sl_str 75a pointer to the base of the array containing the list. 76.It Ar sl_max 77the size of 78.Ar sl_str . 79.It Ar sl_cur 80the offset in 81.Ar sl_str 82of the current element. 83.El 84.Pp 85The following stringlist manipulation functions are available: 86.Bl -tag -width "sl_init()" 87.It Fn sl_init 88Create a stringlist. 89Returns a pointer to a 90.Ar StringList . 91.It Fn sl_free 92Releases memory occupied by 93.Ar sl 94and the 95.Ar sl->sl_str 96array. 97If 98.Ar freeall 99is non-zero, then each of the items within 100.Ar sl->sl_str 101is released as well. 102.It Fn sl_add 103Add 104.Ar item 105to 106.Ar sl->sl_str 107at 108.Ar sl->sl_cur , 109extending the size of 110.Ar sl->sl_str 111.It Fn sl_find 112Find 113.Ar item 114in 115.Ar sl , 116returning NULL if it's not found. 117.El 118.Sh SEE ALSO 119.Xr free 3 , 120.Xr malloc 3 121