diff options
Diffstat (limited to 'src/lib/libc/string/strcspn.3')
| -rw-r--r-- | src/lib/libc/string/strcspn.3 | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/src/lib/libc/string/strcspn.3 b/src/lib/libc/string/strcspn.3 new file mode 100644 index 0000000000..21c727344d --- /dev/null +++ b/src/lib/libc/string/strcspn.3 | |||
| @@ -0,0 +1,100 @@ | |||
| 1 | .\" Copyright (c) 1990, 1991 The Regents of the University of California. | ||
| 2 | .\" All rights reserved. | ||
| 3 | .\" | ||
| 4 | .\" This code is derived from software contributed to Berkeley by | ||
| 5 | .\" Chris Torek and the American National Standards Committee X3, | ||
| 6 | .\" on Information Processing Systems. | ||
| 7 | .\" | ||
| 8 | .\" Redistribution and use in source and binary forms, with or without | ||
| 9 | .\" modification, are permitted provided that the following conditions | ||
| 10 | .\" are met: | ||
| 11 | .\" 1. Redistributions of source code must retain the above copyright | ||
| 12 | .\" notice, this list of conditions and the following disclaimer. | ||
| 13 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
| 14 | .\" notice, this list of conditions and the following disclaimer in the | ||
| 15 | .\" documentation and/or other materials provided with the distribution. | ||
| 16 | .\" 3. Neither the name of the University nor the names of its contributors | ||
| 17 | .\" may be used to endorse or promote products derived from this software | ||
| 18 | .\" without specific prior written permission. | ||
| 19 | .\" | ||
| 20 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | ||
| 21 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| 22 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| 23 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | ||
| 24 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
| 25 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
| 26 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
| 27 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
| 28 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
| 29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
| 30 | .\" SUCH DAMAGE. | ||
| 31 | .\" | ||
| 32 | .\" $OpenBSD: strcspn.3,v 1.9 2007/08/08 07:20:45 ray Exp $ | ||
| 33 | .\" | ||
| 34 | .Dd $Mdocdate: August 8 2007 $ | ||
| 35 | .Dt STRCSPN 3 | ||
| 36 | .Os | ||
| 37 | .Sh NAME | ||
| 38 | .Nm strcspn | ||
| 39 | .Nd span the complement of a string | ||
| 40 | .Sh SYNOPSIS | ||
| 41 | .Fd #include <string.h> | ||
| 42 | .Ft size_t | ||
| 43 | .Fn strcspn "const char *s" "const char *charset" | ||
| 44 | .Sh DESCRIPTION | ||
| 45 | The | ||
| 46 | .Fn strcspn | ||
| 47 | function spans the initial part of the NUL-terminated string | ||
| 48 | .Fa s | ||
| 49 | as long as the characters from | ||
| 50 | .Fa s | ||
| 51 | do not occur in string | ||
| 52 | .Fa charset | ||
| 53 | (it spans the | ||
| 54 | .Em complement | ||
| 55 | of | ||
| 56 | .Fa charset ) . | ||
| 57 | .Sh RETURN VALUES | ||
| 58 | The | ||
| 59 | .Fn strcspn | ||
| 60 | function returns the number of characters spanned. | ||
| 61 | .Sh EXAMPLES | ||
| 62 | The following call to | ||
| 63 | .Fn strcspn | ||
| 64 | will return 3, since the first three characters of string | ||
| 65 | .Fa s | ||
| 66 | do not occur in string | ||
| 67 | .Fa charset : | ||
| 68 | .Bd -literal -offset indent | ||
| 69 | char *s = "foobar"; | ||
| 70 | char *charset = "bar"; | ||
| 71 | size_t span; | ||
| 72 | |||
| 73 | span = strcspn(s, charset); | ||
| 74 | .Ed | ||
| 75 | .Pp | ||
| 76 | The following removes the first (if any) newline character from string | ||
| 77 | .Fa line . | ||
| 78 | This is useful for trimming the newline after a | ||
| 79 | .Xr fgets 3 | ||
| 80 | call. | ||
| 81 | .Bd -literal -offset indent | ||
| 82 | char line[BUFSIZ]; | ||
| 83 | |||
| 84 | if (fgets(line, sizeof(line), fp) != NULL) | ||
| 85 | line[strcspn(line, "\en")] = '\e0'; | ||
| 86 | .Ed | ||
| 87 | .Sh SEE ALSO | ||
| 88 | .Xr memchr 3 , | ||
| 89 | .Xr strchr 3 , | ||
| 90 | .Xr strpbrk 3 , | ||
| 91 | .Xr strrchr 3 , | ||
| 92 | .Xr strsep 3 , | ||
| 93 | .Xr strspn 3 , | ||
| 94 | .Xr strstr 3 , | ||
| 95 | .Xr strtok 3 | ||
| 96 | .Sh STANDARDS | ||
| 97 | The | ||
| 98 | .Fn strcspn | ||
| 99 | function conforms to | ||
| 100 | .St -ansiC . | ||
