23000311adcc743ab755fbcbfe16ec52ef553b33
[dragonfly.git] / lib / libc / string / strsep.3
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 .\" $FreeBSD: src/lib/libc/string/strsep.3,v 1.6.2.6 2002/08/09 16:58:28 archie Exp $
37 .\" $DragonFly: src/lib/libc/string/strsep.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
38 .\"
39 .Dd June 9, 1993
40 .Dt STRSEP 3
41 .Os
42 .Sh NAME
43 .Nm strsep
44 .Nd separate strings
45 .Sh LIBRARY
46 .Lb libc
47 .Sh SYNOPSIS
48 .In string.h
49 .Ft char *
50 .Fn strsep "char **stringp" "const char *delim"
51 .Sh DESCRIPTION
52 The
53 .Fn strsep
54 function locates, in the string referenced by
55 .Fa *stringp ,
56 the first occurrence of any character in the string
57 .Fa delim
58 (or the terminating
59 .Ql \e0
60 character) and replaces it with a
61 .Ql \e0 .
62 The location of the next character after the delimiter character
63 (or NULL, if the end of the string was reached) is stored in
64 .Fa *stringp .
65 The original value of
66 .Fa *stringp
67 is returned.
68 .Pp
69 An ``empty'' field (i.e., a character in the string
70 .Fa delim
71 occurs as the first character of
72 .Fa *stringp )
73 can be detected by comparing the location referenced by the returned pointer
74 to
75 .Ql \e0 .
76 .Pp
77 If
78 .Fa *stringp
79 is initially
80 .Dv NULL ,
81 .Fn strsep
82 returns
83 .Dv NULL .
84 .Sh EXAMPLES
85 The following uses
86 .Fn strsep
87 to parse a string, containing tokens delimited by white space, into an
88 argument vector:
89 .Bd -literal -offset indent
90 char **ap, *argv[10], *inputstring;
91
92 for (ap = argv; (*ap = strsep(&inputstring, " \et")) != NULL;)
93         if (**ap != '\e0')
94                 if (++ap >= &argv[10])
95                         break;
96 .Ed
97 .Sh SEE ALSO
98 .Xr memchr 3 ,
99 .Xr strchr 3 ,
100 .Xr strcspn 3 ,
101 .Xr strpbrk 3 ,
102 .Xr strrchr 3 ,
103 .Xr strspn 3 ,
104 .Xr strstr 3 ,
105 .Xr strtok 3
106 .Sh HISTORY
107 The
108 .Fn strsep
109 function
110 is intended as a replacement for the
111 .Fn strtok
112 function.
113 While the
114 .Fn strtok
115 function should be preferred for portability reasons (it conforms to
116 .St -isoC )
117 it is unable to handle empty fields, i.e. detect fields delimited by
118 two adjacent delimiter characters, or to be used for more than a single
119 string at a time.
120 The
121 .Fn strsep
122 function first appeared in
123 .Bx 4.4 .