1.\" $NetBSD: stringlist.3,v 1.12 2006/07/30 00:21:26 wiz Exp $ 2.\" 3.\" Copyright (c) 1997, 1999 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 FOUNDATION OR CONTRIBUTORS 28.\" BE 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 July 27, 2006 37.Os 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.Nm sl_delete 46.Nd stringlist manipulation functions 47.Sh LIBRARY 48.Lb libc 49.Sh SYNOPSIS 50.In stringlist.h 51.Ft StringList * 52.Fn sl_init 53.Ft int 54.Fn sl_add "StringList *sl" "char *item" 55.Ft void 56.Fn sl_free "StringList *sl" "int freeall" 57.Ft char * 58.Fn sl_find "StringList *sl" "const char *item" 59.Ft int 60.Fn sl_delete "StringList *sl" "const char *item" "int freeit" 61.Sh DESCRIPTION 62The 63.Nm 64functions manipulate stringlists, which are lists of 65strings that extend automatically if necessary. 66.Pp 67The 68.Ar StringList 69structure has the following definition: 70.Bd -literal -offset indent 71typedef struct _stringlist { 72 char **sl_str; 73 size_t sl_max; 74 size_t sl_cur; 75} StringList; 76.Ed 77.Pp 78.Bl -tag -width "sl_str" -offset indent 79.It Ar sl_str 80a pointer to the base of the array containing the list. 81.It Ar sl_max 82the size of 83.Ar sl_str . 84.It Ar sl_cur 85the offset in 86.Ar sl_str 87of the current element. 88.El 89.Pp 90The following stringlist manipulation functions are available: 91.Bl -tag -width "sl_init()" 92.It Fn sl_init 93Create a stringlist. 94Returns a pointer to a 95.Ar StringList , 96or 97.Dv NULL 98in case of failure. 99.It Fn sl_free 100Releases memory occupied by 101.Ar sl 102and the 103.Ar sl-\*[Gt]sl_str 104array. 105If 106.Ar freeall 107is non-zero, then each of the items within 108.Ar sl-\*[Gt]sl_str 109is released as well. 110.It Fn sl_add 111Add 112.Ar item 113to 114.Ar sl-\*[Gt]sl_str 115at 116.Ar sl-\*[Gt]sl_cur , 117extending the size of 118.Ar sl-\*[Gt]sl_str . 119Returns zero upon success, \-1 upon failure. 120.It Fn sl_find 121Find 122.Ar item 123in 124.Ar sl , 125returning 126.Dv NULL 127if it's not found. 128.It Fn sl_delete 129Remove 130.Ar item 131from the list. 132If 133.Ar freeit 134is non-zero, the string is freed. 135Returns 136.Dv 0 137if the name is found 138and 139.Dv \-1 140if the name is not found. 141.El 142.Sh SEE ALSO 143.Xr free 3 , 144.Xr malloc 3 145.Sh HISTORY 146The 147.Nm 148functions appeared in 149.Nx 1.3 . 150