summaryrefslogtreecommitdiffstats
path: root/lib/libc/string/strspn.3
diff options
context:
space:
mode:
authorallanjude <allanjude@FreeBSD.org>2015-04-16 00:24:21 +0000
committerallanjude <allanjude@FreeBSD.org>2015-04-16 00:24:21 +0000
commit8c0a1c61dbe6ed8885a003f2227099fc8398ad47 (patch)
tree9c7b495086f3b62025c2fc7faa23fb166e35963b /lib/libc/string/strspn.3
parent489ab0737e2b05f1aae06dd82ce25b9f94e8d195 (diff)
downloadFreeBSD-src-8c0a1c61dbe6ed8885a003f2227099fc8398ad47.zip
FreeBSD-src-8c0a1c61dbe6ed8885a003f2227099fc8398ad47.tar.gz
MFC: r266671, r266725:
Merge strcspn.3 into strspn.3 and clarify the explaination Approved by: eadler (mentor, implicit) Sponsored by: ScaleEngine Inc.
Diffstat (limited to 'lib/libc/string/strspn.3')
-rw-r--r--lib/libc/string/strspn.345
1 files changed, 36 insertions, 9 deletions
diff --git a/lib/libc/string/strspn.3 b/lib/libc/string/strspn.3
index 2ba6a6b..542b190 100644
--- a/lib/libc/string/strspn.3
+++ b/lib/libc/string/strspn.3
@@ -32,11 +32,12 @@
.\" @(#)strspn.3 8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
-.Dd June 4, 1993
+.Dd May 24, 2014
.Dt STRSPN 3
.Os
.Sh NAME
-.Nm strspn
+.Nm strspn ,
+.Nm strcspn
.Nd span a string
.Sh LIBRARY
.Lb libc
@@ -44,6 +45,8 @@
.In string.h
.Ft size_t
.Fn strspn "const char *s" "const char *charset"
+.Ft size_t
+.Fn strcspn "const char *s" "const char *charset"
.Sh DESCRIPTION
The
.Fn strspn
@@ -54,22 +57,44 @@ as long as the characters from
.Fa s
occur in the null-terminated string
.Fa charset .
-In other words, it computes the string array index in
-.Fa s
+In other words, it computes the string array index
of the first character of
.Fa s
which is not in
.Fa charset ,
else the index of the first null character.
+.Pp
+The
+.Fn strcspn
+function
+spans the initial part of the null-terminated string
+.Fa s
+as long as the characters from
+.Fa s
+.Sy do not
+occur in the null-terminated string
+.Fa charset
+.Po it spans the
+.Sy complement
+of
+.Fa charset
+.Pc .
+In other words, it computes the string array index
+of the first character of
+.Fa s
+which is also in
+.Fa charset ,
+else the index of the first null character.
.Sh RETURN VALUES
The
.Fn strspn
-function
-returns the number of characters spanned.
+and
+.Fn strcspn
+functions
+return the number of characters spanned.
.Sh SEE ALSO
.Xr memchr 3 ,
.Xr strchr 3 ,
-.Xr strcspn 3 ,
.Xr strpbrk 3 ,
.Xr strrchr 3 ,
.Xr strsep 3 ,
@@ -79,6 +104,8 @@ returns the number of characters spanned.
.Sh STANDARDS
The
.Fn strspn
-function
-conforms to
+and
+.Fn strcspn
+functions
+conform to
.St -isoC .
OpenPOWER on IntegriCloud