mirror of
https://gitlab.freedesktop.org/libbsd/libbsd.git
synced 2025-01-09 19:27:42 +01:00
21f4052c5b
groff(1) has changed the internal layout for the .Lb doc strings, but to preserve backwards compatibility we cannot simply rename them, we need to create new aliases so that these will work with old and new macros. Signed-off-by: Guillem Jover <guillem@hadrons.org>
152 lines
3.6 KiB
Plaintext
152 lines
3.6 KiB
Plaintext
.\" $NetBSD: stringlist.3,v 1.15 2010/05/06 09:46:49 jruoho Exp $
|
|
.\"
|
|
.\" Copyright (c) 1997, 1999 The NetBSD Foundation, Inc.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" This file was contributed to The NetBSD Foundation by Luke Mewburn.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
|
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.Dd May 6, 2010
|
|
.Dt STRINGLIST 3bsd
|
|
.Os
|
|
.Sh NAME
|
|
.Nm stringlist ,
|
|
.Nm sl_init ,
|
|
.Nm sl_add ,
|
|
.Nm sl_free ,
|
|
.Nm sl_find ,
|
|
.Nm sl_delete
|
|
.Nd stringlist manipulation functions
|
|
.Sh LIBRARY
|
|
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
|
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
|
.Lb libbsd
|
|
.Sh SYNOPSIS
|
|
.In stringlist.h
|
|
(See
|
|
.Xr libbsd 7
|
|
for include usage.)
|
|
.Ft StringList *
|
|
.Fn sl_init "void"
|
|
.Ft int
|
|
.Fn sl_add "StringList *sl" "char *item"
|
|
.Ft void
|
|
.Fn sl_free "StringList *sl" "int freeall"
|
|
.Ft char *
|
|
.Fn sl_find "StringList *sl" "const char *item"
|
|
.Ft int
|
|
.Fn sl_delete "StringList *sl" "const char *item" "int freeit"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
functions manipulate stringlists, which are lists of
|
|
strings that extend automatically if necessary.
|
|
.Pp
|
|
The
|
|
.Ar StringList
|
|
structure has the following definition:
|
|
.Bd -literal -offset indent
|
|
typedef struct _stringlist {
|
|
char **sl_str;
|
|
size_t sl_max;
|
|
size_t sl_cur;
|
|
} StringList;
|
|
.Ed
|
|
.Pp
|
|
where:
|
|
.Bl -tag -width "sl_str" -offset indent
|
|
.It Ar sl_str
|
|
is a pointer to the base of the array containing the list,
|
|
.It Ar sl_max
|
|
is the size of
|
|
.Ar sl_str ,
|
|
and
|
|
.It Ar sl_cur
|
|
is the offset in
|
|
.Ar sl_str
|
|
of the current element.
|
|
.El
|
|
.Pp
|
|
The following stringlist manipulation functions are available:
|
|
.Bl -tag -width "sl_delete()" -offset 2n
|
|
.It Fn sl_init
|
|
Create a stringlist.
|
|
Returns a pointer to a
|
|
.Ar StringList ,
|
|
or
|
|
.Dv NULL
|
|
in case of failure.
|
|
.It Fn sl_free
|
|
Releases memory occupied by
|
|
.Ar sl
|
|
and the
|
|
.Ar sl-\*[Gt]sl_str
|
|
array.
|
|
If
|
|
.Ar freeall
|
|
is non-zero, then each of the items within
|
|
.Ar sl-\*[Gt]sl_str
|
|
is released as well.
|
|
.It Fn sl_add
|
|
Add
|
|
.Ar item
|
|
to
|
|
.Ar sl-\*[Gt]sl_str
|
|
at
|
|
.Ar sl-\*[Gt]sl_cur ,
|
|
extending the size of
|
|
.Ar sl-\*[Gt]sl_str .
|
|
Returns zero upon success, \-1 upon failure.
|
|
.It Fn sl_find
|
|
Find
|
|
.Ar item
|
|
in
|
|
.Ar sl ,
|
|
returning
|
|
.Dv NULL
|
|
if it's not found.
|
|
.It Fn sl_delete
|
|
Remove
|
|
.Ar item
|
|
from the list.
|
|
If
|
|
.Ar freeit
|
|
is non-zero, the string is freed.
|
|
Returns
|
|
.Dv 0
|
|
if the name is found
|
|
and
|
|
.Dv \-1
|
|
if the name is not found.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr free 3 ,
|
|
.Xr malloc 3
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
functions appeared in
|
|
.Fx 2.2.6
|
|
and
|
|
.Nx 1.3 .
|