Update or add comments to files and functions for use by Doxygen.

[mirror_edk2.git] / StdLib / Include / sys / _ctype.h

/** @file\r
  Implementation specific support for Single-byte character classification and\r
  case conversion macros and function declarations.\r
\r
  This file is intended to only be included by <ctype.h>.\r
\r
  Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials are licensed and made available under\r
  the terms and conditions of the BSD License that accompanies this distribution.\r
  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
**/\r
#ifndef _CTYPE_H\r
#error  This file, <sys/_ctype.h>, may only be included by <ctype.h>.\r
#endif\r
\r
__BEGIN_DECLS\r
extern const UINT16 *_cClass;  ///< Locale independent pointer to Character Classification Table.\r
extern const UINT8  *_uConvT;  ///< Locale independent pointer to Lowercase to Uppercase Conversion Table.\r
extern const UINT8  *_lConvT;  ///< Locale independent pointer to Uppercase to Lowercase Conversion Table.\r
\r
extern  int  __isCClass( int _c, unsigned int mask);   ///< Internal character classification function.\r
__END_DECLS\r
\r
\r
/** Character Class bit masks.\r
@{\r
**/\r
#define _CC   0x0001U     ///< Control Characters\r
#define _CW   0x0002U     ///< White Space\r
#define _CP   0x0004U     ///< Punctuation\r
#define _CD   0x0008U     ///< Digits [0-9]\r
#define _CU   0x0010U     ///< Uppercase Letter [A-Z]\r
#define _CL   0x0020U     ///< Lowercase Letter [a-z]\r
#define _CX   0x0040U     ///< Hexadecimal Digits [A-Fa-f]\r
#define _C0   0x0080U\r
#define _CS   0x0100U     ///< Space Characters, ' ' in C locale\r
#define _CG   0x0200U     ///< Graphic Characters\r
#define _CB   0x0400U     ///< Blank Characters, ' ' and '\t' in C locale\r
#define _C4   0x0800U\r
#define _XA   0x1000U     ///< eXtra Alpha characters not in _CU or _CL\r
#define _C6   0x2000U\r
#define _C7   0x4000U\r
#define _C8   0x8000U\r
/// @}\r
\r
#ifndef NO_CTYPE_MACROS\r
  #define __isCClass( _c, mask)   (((_c) < 0 || (_c) > 127) ? 0 : (_cClass[(_c)] & (mask)))\r
  #define __toLower( _c)          ((__isCClass( ((int)_c), (_CU))) ? _lConvT[(_c)] : (_c))\r
  #define __toUpper( _c)          ((__isCClass( ((int)_c), (_CL))) ? _uConvT[(_c)] : (_c))\r
#endif  /* NO_CTYPE_MACROS */\r
\r
/* Macros used by implementation functions */\r
#define __isHexLetter(_c)         (__isCClass( (int)c, (_CX)))\r
\r
#ifdef _CTYPE_PRIVATE\r
  #define _CTYPE_NUM_CHARS  (256)\r
\r
  #define _CTYPE_ID   "BSDCTYPE"\r
  #define _CTYPE_REV    2\r
\r
  extern const UINT16  _C_CharClassTable[];\r
  extern const UINT8   _C_ToUpperTable[];\r
  extern const UINT8   _C_ToLowerTable[];\r
#endif\r