mirror of https://github.com/acidanthera/audk.git
188 lines
7.8 KiB
C
188 lines
7.8 KiB
C
/** @file
|
|
Single-byte character classification and case conversion macros and
|
|
function declarations.
|
|
|
|
The header <ctype.h> declares several functions useful for testing and mapping
|
|
characters. In all cases, the argument is an int, the value of which shall be
|
|
representable as an unsigned char or shall equal the value of the macro EOF.
|
|
If the argument has any other value, the behavior is undefined.
|
|
|
|
The behavior of these functions is affected by the current locale. The
|
|
default is the "C" locale.
|
|
|
|
The term "printing character" refers to a member of a locale-specific
|
|
set of characters, each of which occupies one printing position on a display
|
|
device; the term control character refers to a member of a locale-specific
|
|
set of characters that are not printing characters.
|
|
|
|
Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
|
|
This program and the accompanying materials are licensed and made available under
|
|
the terms and conditions of the BSD License that accompanies this distribution.
|
|
The full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php.
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
#ifndef _CTYPE_H
|
|
#define _CTYPE_H
|
|
#include <sys/EfiCdefs.h>
|
|
#include <sys/_ctype.h>
|
|
|
|
__BEGIN_DECLS
|
|
// Declarations for the classification Functions
|
|
|
|
/** The isalnum function tests for any character for which isalpha or isdigit
|
|
is true.
|
|
|
|
@return Returns nonzero (true) if and only if the value of the argument c
|
|
conforms to that in the description of the function.
|
|
**/
|
|
int isalnum(int c);
|
|
|
|
/** The isalpha function tests for any character for which isupper or islower
|
|
is true, or any character that is one of a locale-specific set of
|
|
alphabetic characters for which none of iscntrl, isdigit, ispunct, or
|
|
isspace is true. In the "C" locale, isalpha returns true only for the
|
|
characters for which isupper or islower is true.
|
|
|
|
@return Returns nonzero (true) if and only if the value of the argument c
|
|
conforms to that in the description of the function.
|
|
**/
|
|
int isalpha(int c);
|
|
|
|
/** The iscntrl function tests for any control character.
|
|
|
|
@return Returns nonzero (true) if and only if the value of the argument c
|
|
conforms to that in the description of the function.
|
|
**/
|
|
int iscntrl(int c);
|
|
|
|
/** The isdigit function tests for any decimal-digit character.
|
|
|
|
@return Returns nonzero (true) if and only if the value of the argument c
|
|
conforms to that in the description of the function.
|
|
**/
|
|
int isdigit(int c);
|
|
|
|
/** The isgraph function tests for any printing character except space (' ').
|
|
|
|
@return Returns nonzero (true) if and only if the value of the argument c
|
|
conforms to that in the description of the function.
|
|
**/
|
|
int isgraph(int c);
|
|
|
|
/** The islower function tests for any character that is a lowercase letter or
|
|
is one of a locale-specific set of characters for which none of iscntrl,
|
|
isdigit, ispunct, or isspace is true. In the "C" locale, islower returns
|
|
true only for the lowercase letters.
|
|
|
|
@return Returns nonzero (true) if and only if the value of the argument c
|
|
conforms to that in the description of the function.
|
|
**/
|
|
int islower(int c);
|
|
|
|
/** The isprint function tests for any printing character including space (' ').
|
|
|
|
@return Returns nonzero (true) if and only if the value of the argument c
|
|
conforms to that in the description of the function.
|
|
**/
|
|
int isprint(int c);
|
|
|
|
/** The ispunct function tests for any printing character that is one of a
|
|
locale-specific set of punctuation characters for which neither isspace nor
|
|
isalnum is true. In the "C" locale, ispunct returns true for every printing
|
|
character for which neither isspace nor isalnum is true.
|
|
|
|
@return Returns nonzero (true) if and only if the value of the argument c
|
|
conforms to that in the description of the function.
|
|
**/
|
|
int ispunct(int c);
|
|
|
|
/** The isspace function tests for any character that is a standard white-space
|
|
character or is one of a locale-specific set of characters for which
|
|
isalnum is false. The standard white-space characters are the following:
|
|
space (' '), form feed ('\f'), new-line ('\n'), carriage return ('\r'),
|
|
horizontal tab ('\t'), and vertical tab ('\v'). In the "C" locale, isspace
|
|
returns true only for the standard white-space characters.
|
|
|
|
@return Returns nonzero (true) if and only if the value of the argument c
|
|
conforms to that in the description of the function.
|
|
**/
|
|
int isspace(int c);
|
|
|
|
/** The isupper function tests for any character that is an uppercase letter or
|
|
is one of a locale-specific set of characters for which none of iscntrl,
|
|
isdigit, ispunct, or isspace is true. In the "C" locale, isupper returns
|
|
true only for the uppercase letters.
|
|
|
|
@return Returns nonzero (true) if and only if the value of the argument c
|
|
conforms to that in the description of the function.
|
|
**/
|
|
int isupper(int c);
|
|
|
|
/** The isxdigit function tests for any hexadecimal-digit character.
|
|
|
|
@return Returns nonzero (true) if and only if the value of the argument c
|
|
conforms to that in the description of the function.
|
|
**/
|
|
int isxdigit(int c);
|
|
|
|
/** The isascii function tests that a character is one of the 128 ASCII characters.
|
|
|
|
@param[in] c The character to test.
|
|
@return Returns nonzero (true) if c is a valid ASCII character. Otherwize,
|
|
zero (false) is returned.
|
|
**/
|
|
int isascii(int c);
|
|
|
|
/** The tolower function converts an uppercase letter to a corresponding
|
|
lowercase letter.
|
|
|
|
@return If the argument is a character for which isupper is true and
|
|
there are one or more corresponding characters, as specified by
|
|
the current locale, for which islower is true, the tolower
|
|
function returns one of the corresponding characters (always the
|
|
same one for any given locale); otherwise, the argument is
|
|
returned unchanged.
|
|
**/
|
|
int tolower(int c);
|
|
|
|
/** The toupper function converts a lowercase letter to a corresponding
|
|
uppercase letter.
|
|
|
|
@return If the argument is a character for which islower is true and
|
|
there are one or more corresponding characters, as specified by
|
|
the current locale, for which isupper is true, the toupper
|
|
function returns one of the corresponding characters (always the
|
|
same one for any given locale); otherwise, the argument is
|
|
returned unchanged.
|
|
**/
|
|
int toupper(int c);
|
|
|
|
int isblank(int);
|
|
|
|
__END_DECLS
|
|
|
|
// Character Classification Macros
|
|
// Undefine individually or define NO_CTYPE_MACROS, before including <ctype.h>,
|
|
// in order to use the Function version of the character classification macros.
|
|
#ifndef NO_CTYPE_MACROS
|
|
#define isalnum(c) (__isCClass( (int)c, (_CD | _CU | _CL | _XA)))
|
|
#define isalpha(c) (__isCClass( (int)c, (_CU | _CL | _XA)))
|
|
#define iscntrl(c) (__isCClass( (int)c, (_CC)))
|
|
#define isdigit(c) (__isCClass( (int)c, (_CD)))
|
|
#define isgraph(c) (__isCClass( (int)c, (_CG)))
|
|
#define islower(c) (__isCClass( (int)c, (_CL)))
|
|
#define isprint(c) (__isCClass( (int)c, (_CS | _CG)))
|
|
#define ispunct(c) (__isCClass( (int)c, (_CP)))
|
|
#define isspace(c) (__isCClass( (int)c, (_CW)))
|
|
#define isupper(c) (__isCClass( (int)c, (_CU)))
|
|
#define isxdigit(c) (__isCClass( (int)c, (_CD | _CX)))
|
|
#define tolower(c) (__toLower((int)c))
|
|
#define toupper(c) (__toUpper((int)c))
|
|
#endif /* NO_CTYPE_MACROS */
|
|
|
|
#endif /* _CTYPE_H */
|