88 lines
2.8 KiB
Groff
88 lines
2.8 KiB
Groff
.\" Copyright (c) 2007-2008 Roy Marples
|
|
.\"
|
|
.\" 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 AUTHOR 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 AUTHOR 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 Mar 16, 2008
|
|
.Dt RC_STRLIST 3 SMM
|
|
.Os OpenRC
|
|
.Sh NAME
|
|
.Nm rc_stringlist_add , rc_stringlist_addu , rc_stringlist_delete ,
|
|
.Nm rc_stringlist_free , rc_stringlist_new , rc_stringlist_sort
|
|
.Nd RC string list functions
|
|
.Sh LIBRARY
|
|
Run Command library (librc, -lrc)
|
|
.Sh SYNOPSIS
|
|
.In rc.h
|
|
.Ft "RC_STRINGLIST *" Fn rc_stringlist_new void
|
|
.Ft "RC_STRING *" Fn rc_stringlist_add "RC_STRINGLIST *list" "const char *item"
|
|
.Ft "RC_STRING *" Fn rc_stringlist_addu "RC_STRINGLIST *list" "const char *item"
|
|
.Ft bool Fn rc_stringlist_delete RC_STRINGLIST "const char *item"
|
|
.Ft void Fn rc_stringlist_free "RC_STRINGLIST *list"
|
|
.Ft void Fn rc_stringlist_sort "RC_STRINGLIST *list"
|
|
.Sh DESCRIPTION
|
|
These functions provide an easy means of manipulating string lists. They are
|
|
basically wrappers around TAILQ macros found in
|
|
.Xr queue 3 .
|
|
.Pp
|
|
.Fn rc_stringlist_new
|
|
creates a new list head to store the list.
|
|
.Pp
|
|
.Fn rc_stringlist_add
|
|
adds a malloced copy of
|
|
.Fa item
|
|
to
|
|
.Fa list .
|
|
It returns a pointer to the new item on success, or NULL on failure and sets
|
|
.Va errno
|
|
accordingly.
|
|
.Fn rc_stringlist_addu
|
|
only works if
|
|
.Fa list
|
|
does not already contain
|
|
.Fa item .
|
|
.Pp
|
|
.Fn rc_stringlist_delete
|
|
removes and frees
|
|
.Fa item
|
|
from
|
|
.Fa list ,
|
|
retuning true on success, otherwise false.
|
|
.Pp
|
|
.Fn rc_stringlist_sort
|
|
sorts the
|
|
.Fa list
|
|
according to C locale.
|
|
.Pp
|
|
.Fn rc_stringlist_free
|
|
frees each item on
|
|
.Fa list
|
|
and the
|
|
.Fa list
|
|
itself.
|
|
.Sh SEE ALSO
|
|
.Xr malloc 3 ,
|
|
.Xr free 3 ,
|
|
.Xr queue 3 ,
|
|
.Xr strcmp 3
|
|
.Sh AUTHORS
|
|
.An Roy Marples <roy@marples.name>
|