Refine code to make it more safely.

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Library / EfiCommonLib / ValueToString.c

/*++\r
\r
Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  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
Module Name:\r
\r
  ValueToString.c\r
\r
Abstract:\r
\r
  Routines changing value to Hex or Dec string\r
\r
--*/\r
\r
#include "Tiano.h"\r
#include "EfiDriverLib.h"\r
\r
static CHAR16 mHexStr[] = { L'0', L'1', L'2', L'3', L'4', L'5', L'6', L'7',\r
                            L'8', L'9', L'A', L'B', L'C', L'D', L'E', L'F' };\r
\r
UINTN\r
EfiValueToHexStr (\r
  IN  OUT CHAR16  *Buffer, \r
  IN  UINT64      Value, \r
  IN  UINTN       Flags, \r
  IN  UINTN       Width\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  VSPrint worker function that prints a Value as a hex number in Buffer\r
\r
Arguments:\r
\r
  Buffer - Location to place ascii hex string of Value.\r
\r
  Value  - Hex value to convert to a string in Buffer.\r
\r
  Flags  - Flags to use in printing Hex string, see file header for details.\r
\r
  Width  - Width of hex value.\r
\r
Returns: \r
\r
  Number of characters printed.  \r
\r
--*/\r
{\r
  CHAR16  TempBuffer[CHARACTER_NUMBER_FOR_VALUE];\r
  CHAR16  *TempStr;\r
  CHAR16  Prefix;\r
  CHAR16  *BufferPtr;\r
  UINTN   Count;\r
  UINTN   Index;\r
\r
  TempStr   = TempBuffer;\r
  BufferPtr = Buffer;\r
\r
  //\r
  // Count starts at one since we will null terminate. Each iteration of the\r
  // loop picks off one nibble. Oh yea TempStr ends up backwards\r
  //\r
  Count = 0;\r
  \r
  if (Width > CHARACTER_NUMBER_FOR_VALUE - 1) {\r
    Width = CHARACTER_NUMBER_FOR_VALUE - 1;\r
  }\r
\r
  do {\r
    Index = ((UINTN)Value & 0xf);\r
    *(TempStr++) = mHexStr[Index];\r
    Value = RShiftU64 (Value, 4);\r
    Count++;\r
  } while (Value != 0);\r
\r
  if (Flags & PREFIX_ZERO) {\r
    Prefix = '0';\r
  } else { \r
    Prefix = ' ';\r
  }\r
\r
  Index = Count;\r
  if (!(Flags & LEFT_JUSTIFY)) {\r
    for (; Index < Width; Index++) {\r
      *(TempStr++) = Prefix;\r
    }\r
  }\r
\r
  //\r
  // Reverse temp string into Buffer.\r
  //\r
  if (Width > 0 && (UINTN) (TempStr - TempBuffer) > Width) {\r
    TempStr = TempBuffer + Width;\r
  }\r
  Index = 0;\r
  while (TempStr != TempBuffer) {\r
    *(BufferPtr++) = *(--TempStr);\r
    Index++;\r
  }\r
    \r
  *BufferPtr = 0;\r
  return Index;\r
}\r
\r
\r
UINTN\r
EfiValueToString (\r
  IN  OUT CHAR16  *Buffer, \r
  IN  INT64       Value, \r
  IN  UINTN       Flags,\r
  IN  UINTN       Width\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  VSPrint worker function that prints a Value as a decimal number in Buffer\r
\r
Arguments:\r
\r
  Buffer - Location to place ascii decimal number string of Value.\r
\r
  Value  - Decimal value to convert to a string in Buffer.\r
\r
  Flags  - Flags to use in printing decimal string, see file header for details.\r
\r
  Width  - Width of hex value.\r
\r
Returns: \r
\r
  Number of characters printed.  \r
\r
--*/\r
{\r
  CHAR16    TempBuffer[CHARACTER_NUMBER_FOR_VALUE];\r
  CHAR16    *TempStr;\r
  CHAR16    *BufferPtr;\r
  UINTN     Count;\r
  UINTN     ValueCharNum;\r
  UINTN     Remainder;\r
  CHAR16    Prefix;\r
  UINTN     Index;\r
  BOOLEAN   ValueIsNegative;\r
\r
  TempStr         = TempBuffer;\r
  BufferPtr       = Buffer;\r
  Count           = 0;\r
  ValueCharNum    = 0;\r
  ValueIsNegative = FALSE;\r
  Remainder       = 0;\r
\r
  if (Width > CHARACTER_NUMBER_FOR_VALUE - 1) {\r
    Width = CHARACTER_NUMBER_FOR_VALUE - 1;\r
  }\r
\r
  if (Value < 0) {\r
    Value           = -Value;\r
    ValueIsNegative = TRUE;\r
  }\r
\r
  do {\r
    Value = (INT64)DivU64x32 ((UINT64)Value, 10, &Remainder);\r
    *(TempStr++) = (CHAR16)(Remainder + '0');\r
    ValueCharNum++;\r
    Count++;\r
    if ((Flags & COMMA_TYPE) == COMMA_TYPE) {\r
      if (ValueCharNum % 3 == 0 && Value != 0) {\r
        *(TempStr++) = ',';\r
        Count++;\r
      }\r
    }\r
  } while (Value != 0);\r
\r
  if (ValueIsNegative) {\r
    *(TempStr++)    = '-';\r
    Count++;\r
  }\r
\r
  if ((Flags & PREFIX_ZERO) && !ValueIsNegative) {\r
    Prefix = '0';\r
  } else { \r
    Prefix = ' ';\r
  }                   \r
\r
  Index = Count;\r
  if (!(Flags & LEFT_JUSTIFY)) {\r
    for (; Index < Width; Index++) {\r
      *(TempStr++) = Prefix;\r
    }\r
  }\r
\r
  //\r
  // Reverse temp string into Buffer.\r
  //\r
  if (Width > 0 && (UINTN) (TempStr - TempBuffer) > Width) {\r
    TempStr = TempBuffer + Width;\r
  }\r
  Index = 0;\r
  while (TempStr != TempBuffer) {\r
    *(BufferPtr++) = *(--TempStr);\r
    Index++;\r
  }\r
\r
  *BufferPtr = 0;\r
  return Index;\r
}\r