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