lib/libc/locale/isspace.3

   1 .\" Copyright (c) 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 .\" the American National Standards Committee X3, on Information
   6 .\" 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 .Dd December 19, 2022
  33 .Dt ISSPACE 3
  34 .Os
  35 .Sh NAME
  36 .Nm isspace ,
  37 .Nm isspace_l
  38 .Nd white-space character test
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In ctype.h
  43 .Ft int
  44 .Fn isspace "int c"
  45 .Ft int
  46 .Fn isspace_l "int c" "locale_t loc"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn isspace
  50 and
  51 .Fn isspace_l
  52 functions test for white-space characters.
  53 For any locale, this includes the following standard characters:
  54 .Bl -column \&`\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___
  55 .It "\&``\et''" Ta "``\en''" Ta "``\ev''" Ta "``\ef''" Ta "``\er''" Ta "`` ''"
  56 .El
  57 .Pp
  58 In the "C" locale,
  59 .Fn isspace
  60 and
  61 .Fn isspace_l
  62 return non-zero for these characters only.
  63 The value of the argument must be representable as an
  64 .Vt "unsigned char"
  65 or the value of
  66 .Dv EOF .
  67 .Pp
  68 The
  69 .Fn isspace_l
  70 function takes an explicit locale argument, whereas the
  71 .Fn isspace
  72 function uses the current global or per-thread locale.
  73 .Sh RETURN VALUES
  74 The
  75 .Fn isspace
  76 and
  77 .Fn isspace_l
  78 functions return zero if the character tests false and
  79 return non-zero if the character tests true.
  80 .Sh COMPATIBILITY
  81 The
  82 .Bx 4.4
  83 extension of accepting arguments outside of the range of the
  84 .Vt "unsigned char"
  85 type in locales with large character sets is considered obsolete
  86 and may not be supported in future releases.
  87 The
  88 .Fn iswspace
  89 or
  90 .Fn iswspace_l
  91 function should be used instead.
  92 .Sh SEE ALSO
  93 .Xr ctype 3 ,
  94 .Xr ctype_l 3 ,
  95 .Xr iswspace 3 ,
  96 .Xr iswspace_l 3 ,
  97 .Xr multibyte 3 ,
  98 .Xr xlocale 3 ,
  99 .Xr ascii 7
 100 .Sh STANDARDS
 101 The
 102 .Fn isspace
 103 function conforms to
 104 .St -isoC .
 105 The
 106 .Fn isspace_l
 107 function conforms to
 108 .St -p1003.1-2008 .
 109 .Sh HISTORY
 110 The
 111 .Fn isspace
 112 function first appeared in
 113 .At v7 .