xref: /freebsd/lib/libc/string/strsep.3 (revision 0de89efe5c443f213c7ea28773ef2dc6cf3af2ed)
1.\" Copyright (c) 1990, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Chris Torek.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"	@(#)strsep.3	8.1 (Berkeley) 6/9/93
36.\"
37.Dd June 9, 1993
38.Dt STRSEP 3
39.Os
40.Sh NAME
41.Nm strsep
42.Nd separate strings
43.Sh SYNOPSIS
44.Fd #include <string.h>
45.Ft char *
46.Fn strsep "char **stringp" "const char *delim"
47.Sh DESCRIPTION
48The
49.Fn strsep
50function locates, in the string referenced by
51.Fa *stringp ,
52the first occurrence of any character in the string
53.Fa delim
54(or the terminating
55.Ql \e0
56character) and replaces it with a
57.Ql \e0 .
58The location of the next character after the delimiter character
59(or NULL, if the end of the string was reached) is stored in
60.Fa *stringp .
61The original value of
62.Fa *stringp
63is returned.
64.Pp
65An ``empty'' field, i.e. one caused by two adjacent delimiter characters,
66can be detected by comparing the location referenced by the pointer returned
67in
68.Fa *stringp
69to
70.Ql \e0 .
71.Pp
72If
73.Fa *stringp
74is initially
75.Dv NULL ,
76.Fn strsep
77returns
78.Dv NULL .
79.Sh EXAMPLES
80The following uses
81.Fn strsep
82to parse a string, containing tokens delimited by white space, into an
83argument vector:
84.Bd -literal -offset indent
85char **ap, *argv[10], *inputstring;
86
87for (ap = argv; (*ap = strsep(&inputstring, " \et")) != NULL;)
88	if (**ap != '\e0')
89		if (++ap >= &argv[10])
90			break;
91.Ed
92.Sh HISTORY
93The
94.Fn strsep
95function
96is intended as a replacement for the
97.Fn strtok
98function.
99While the
100.Fn strtok
101function should be preferred for portability reasons (it conforms to
102.St -ansiC )
103it is unable to handle empty fields, i.e. detect fields delimited by
104two adjacent delimiter characters, or to be used for more than a single
105string at a time.
106The
107.Fn strsep
108function first appeared in
109.Bx 4.4 .
110