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

[mirror_edk2.git] / StdLib / Include / limits.h

/** @file\r
  The header <limits.h> defines several macros that expand to various limits and\r
  parameters of the standard integer types.\r
\r
  The values given below shall be replaced by constant expressions suitable for\r
  use in #if preprocessing directives. Moreover, except for CHAR_BIT and\r
  MB_LEN_MAX, the following shall be replaced by expressions that have the same\r
  type as would an expression that is an object of the corresponding type\r
  converted according to the integer promotions. Their implementation-defined\r
  values shall be equal or greater in magnitude (absolute value) to those\r
  documented, with the same sign.\r
\r
  If the value of an object of type char is treated as a signed integer when\r
  used in an expression, the value of CHAR_MIN shall be the same as that of\r
  SCHAR_MIN and the value of CHAR_MAX shall be the same as that of SCHAR_MAX.\r
  Otherwise, the value of CHAR_MIN shall be 0 and the value of CHAR_MAX shall\r
  be the same as that of UCHAR_MAX.)\r
  The value UCHAR_MAX shall equal 2^(CHAR_BIT - 1).\r
\r
  Copyright (c) 2010, 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.php.\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
**/\r
#ifndef _LIMITS_H\r
#define _LIMITS_H\r
#include  <sys/EfiCdefs.h>\r
#include  <Library/PcdLib.h>\r
\r
/* Get the architecturally defined limits for this compilation unit. */\r
#include  <machine/limits.h>\r
\r
/* Define the values required by Specification. */\r
\r
/** maximum number of bytes in a multibyte character, for any supported locale **/\r
#define MB_LEN_MAX  2 /* 16-bit UTC-2 */\r
\r
/** Number of bits for smallest object that is not a bit-field (byte). **/\r
#define CHAR_BIT    __CHAR_BIT\r
\r
/** minimum value for an object of type signed char **/\r
#define SCHAR_MIN   __SCHAR_MIN\r
\r
/** maximum value for an object of type signed char **/\r
#define SCHAR_MAX   __SCHAR_MAX\r
\r
/** maximum value for an object of type unsigned char **/\r
#define UCHAR_MAX   __UCHAR_MAX\r
\r
#ifdef __CHAR_UNSIGNED__\r
  /** maximum value for an object of type char **/\r
  #define CHAR_MAX  UCHAR_MAX\r
  /** minimum value for an object of type char **/\r
  #define CHAR_MIN  0\r
#else\r
  /** maximum value for an object of type char **/\r
  #define CHAR_MAX  SCHAR_MAX\r
  /** minimum value for an object of type char **/\r
  #define CHAR_MIN  SCHAR_MIN\r
#endif\r
\r
/** minimum value for an object of type short int **/\r
#define SHRT_MIN    __SHRT_MIN\r
\r
/** maximum value for an object of type short int **/\r
#define SHRT_MAX    __SHRT_MAX\r
\r
/** maximum value for an object of type unsigned short int **/\r
#define USHRT_MAX   __USHRT_MAX\r
\r
/** minimum value for an object of type int **/\r
#define INT_MIN     __INT_MIN\r
\r
/** maximum value for an object of type int **/\r
#define INT_MAX     __INT_MAX\r
\r
/** maximum value for an object of type unsigned int **/\r
#define UINT_MAX    __UINT_MAX\r
\r
/** minimum value for an object of type long int **/\r
#define LONG_MIN    __LONG_MIN\r
\r
/** maximum value for an object of type long int **/\r
#define LONG_MAX    __LONG_MAX\r
\r
/** maximum value for an object of type unsigned long int **/\r
#define ULONG_MAX   __ULONG_MAX\r
\r
/** minimum value for an object of type long long int **/\r
#define LLONG_MIN   __LLONG_MIN\r
\r
/** maximum value for an object of type long long int **/\r
#define LLONG_MAX   __LLONG_MAX\r
\r
/** maximum value for an object of type unsigned long long int **/\r
#define ULLONG_MAX  __ULLONG_MAX\r
\r
/* Object limits used in the Standard Libraries */\r
#if (PcdGet32(PcdMaximumAsciiStringLength) > 0)\r
  #define ASCII_STRING_MAX    PcdGet32(PcdMaximumAsciiStringLength)\r
#else\r
  #define ASCII_STRING_MAX    256\r
#endif\r
\r
#if (PcdGet32(PcdMaximumUnicodeStringLength) > 0)\r
  #define UNICODE_STRING_MAX    PcdGet32(PcdMaximumUnicodeStringLength)\r
#else\r
  #define UNICODE_STRING_MAX    512\r
#endif\r
\r
/* Limits for BSD Compatibility */\r
#define NL_TEXTMAX    2048\r
#include  <sys/syslimits.h>\r
\r
#endif  /* _LIMITS_H */\r