lib/libc/locale/isupper.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 .\" 4. 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 .\"     @(#)isupper.3   8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: head/lib/libc/locale/isupper.3 233992 2012-04-07 09:05:30Z joel $
  34 .\"
  35 .Dd December 25, 2013
  36 .Dt ISUPPER 3
  37 .Os
  38 .Sh NAME
  39 .Nm isupper ,
  40 .Nm isupper_l
  41 .Nd upper-case character test
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In ctype.h
  46 .Ft int
  47 .Fn isupper "int c"
  48 .Ft int
  49 .Ft isupper_l "int c" "locale_t locale"
  50 .Sh DESCRIPTION
  51 The
  52 .Fn isupper
  53 and
  54 .Fn isupper_l
  55 functions tests for any upper-case letter.
  56 The value of the argument must be representable as an
  57 .Vt "unsigned char"
  58 or the value of
  59 .Dv EOF .
  60 .Pp
  61 In the ASCII character set, this includes the following characters
  62 (with their numeric values shown in octal):
  63 .Bl -column \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__
  64 .It "\&101\ ``A''" Ta "102\ ``B''" Ta "103\ ``C''" Ta "104\ ``D''" Ta "105\ ``E''"
  65 .It "\&106\ ``F''" Ta "107\ ``G''" Ta "110\ ``H''" Ta "111\ ``I''" Ta "112\ ``J''"
  66 .It "\&113\ ``K''" Ta "114\ ``L''" Ta "115\ ``M''" Ta "116\ ``N''" Ta "117\ ``O''"
  67 .It "\&120\ ``P''" Ta "121\ ``Q''" Ta "122\ ``R''" Ta "123\ ``S''" Ta "124\ ``T''"
  68 .It "\&125\ ``U''" Ta "126\ ``V''" Ta "127\ ``W''" Ta "130\ ``X''" Ta "131\ ``Y''"
  69 .It "\&132\ ``Z''" Ta \& Ta \& Ta \& Ta \&
  70 .El
  71 .Pp
  72 The _l-suffixed version takes an explicit
  73 .Fa locale
  74 argument, whereas the
  75 non-suffixed version uses the current global or per-thread locale.
  76 .Sh RETURN VALUES
  77 The
  78 .Fn isupper
  79 and
  80 .Fn isupper_l
  81 functions return zero if the character tests false and
  82 returns non-zero if the character tests true.
  83 .Sh COMPATIBILITY
  84 The
  85 .Bx 4.4
  86 extension of accepting arguments outside of the range of the
  87 .Vt "unsigned char"
  88 type in locales with large character sets is considered obsolete
  89 and may not be supported in future releases.
  90 The
  91 .Fn iswupper
  92 and
  93 .Fn iswupper_l
  94 functions should be used instead.
  95 .Sh SEE ALSO
  96 .Xr ctype 3 ,
  97 .Xr ctype_l 3 ,
  98 .Xr iswupper 3 ,
  99 .Xr iswupper_l 3 ,
 100 .Xr toupper 3 ,
 101 .Xr xlocale 3 ,
 102 .Xr ascii 7
 103 .Sh STANDARDS
 104 The
 105 .Fn isupper
 106 function conforms to
 107 .St -isoC .
 108 The
 109 .Fn isupper_l
 110 function conforms to
 111 .St -p1003.1-2008 .