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