[mirror_edk2.git] / MdePkg / Library / BasePrintLib / PrintLib.c

/** @file\r
  Base Print Library instance implementation.\r
\r
  Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
  Portions copyright (c) 2008 - 2009, Apple Inc. 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
**/\r
\r
#include "PrintLibInternal.h"\r
\r
//\r
// Declare a VA_LIST global variable that is used in calls to BasePrintLibSPrintMarker()\r
// when the BASE_LIST parameter is valid and the VA_LIST parameter is ignored.  \r
// A NULL VA_LIST can not be passed into  BasePrintLibSPrintMarker() because some \r
// compilers define VA_LIST to be a structure.\r
//\r
VA_LIST gNullVaList;\r
\r
#define ASSERT_UNICODE_BUFFER(Buffer) ASSERT ((((UINTN) (Buffer)) & 0x01) == 0)\r
\r
/**\r
  Produces a Null-terminated Unicode string in an output buffer based on\r
  a Null-terminated Unicode format string and a VA_LIST argument list.\r
\r
  This function is similar as vsnprintf_s defined in C11.\r
\r
  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
  and BufferSize.\r
  The Unicode string is produced by parsing the format string specified by FormatString.\r
  Arguments are pulled from the variable argument list specified by Marker based on the\r
  contents of the format string.\r
  The number of Unicode characters in the produced output buffer is returned not including\r
  the Null-terminator.\r
\r
  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
\r
  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
  buffer is unmodified and 0 is returned.\r
  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
  If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.\r
\r
  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                          Unicode string.\r
  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
  @param  FormatString    A Null-terminated Unicode format string.\r
  @param  Marker          VA_LIST marker for the variable argument list.\r
\r
  @return The number of Unicode characters in the produced output buffer not including the\r
          Null-terminator.\r
\r
**/\r
UINTN\r
EFIAPI\r
UnicodeVSPrint (\r
  OUT CHAR16        *StartOfBuffer,\r
  IN  UINTN         BufferSize,\r
  IN  CONST CHAR16  *FormatString,\r
  IN  VA_LIST       Marker\r
  )\r
{\r
  ASSERT_UNICODE_BUFFER (StartOfBuffer);\r
  ASSERT_UNICODE_BUFFER (FormatString);\r
  return BasePrintLibSPrintMarker ((CHAR8 *)StartOfBuffer, BufferSize >> 1, FORMAT_UNICODE | OUTPUT_UNICODE, (CHAR8 *)FormatString, Marker, NULL);\r
}\r
\r
/**\r
  Produces a Null-terminated Unicode string in an output buffer based on\r
  a Null-terminated Unicode format string and a BASE_LIST argument list.\r
\r
  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
  and BufferSize.\r
  The Unicode string is produced by parsing the format string specified by FormatString.\r
  Arguments are pulled from the variable argument list specified by Marker based on the\r
  contents of the format string.\r
  The number of Unicode characters in the produced output buffer is returned not including\r
  the Null-terminator.\r
\r
  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
\r
  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
  buffer is unmodified and 0 is returned.\r
  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
  If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.\r
\r
  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                          Unicode string.\r
  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
  @param  FormatString    A Null-terminated Unicode format string.\r
  @param  Marker          BASE_LIST marker for the variable argument list.\r
\r
  @return The number of Unicode characters in the produced output buffer not including the\r
          Null-terminator.\r
\r
**/\r
UINTN\r
EFIAPI\r
UnicodeBSPrint (\r
  OUT CHAR16        *StartOfBuffer,\r
  IN  UINTN         BufferSize,\r
  IN  CONST CHAR16  *FormatString,\r
  IN  BASE_LIST     Marker\r
  )\r
{\r
  ASSERT_UNICODE_BUFFER (StartOfBuffer);\r
  ASSERT_UNICODE_BUFFER (FormatString);\r
  return BasePrintLibSPrintMarker ((CHAR8 *)StartOfBuffer, BufferSize >> 1, FORMAT_UNICODE | OUTPUT_UNICODE, (CHAR8 *)FormatString, gNullVaList, Marker);\r
}\r
\r
/**\r
  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
  Unicode format string and variable argument list.\r
\r
  This function is similar as snprintf_s defined in C11.\r
\r
  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
  and BufferSize.\r
  The Unicode string is produced by parsing the format string specified by FormatString.\r
  Arguments are pulled from the variable argument list based on the contents of the format string.\r
  The number of Unicode characters in the produced output buffer is returned not including\r
  the Null-terminator.\r
\r
  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
\r
  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
  buffer is unmodified and 0 is returned.\r
  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
  If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.\r
\r
  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                          Unicode string.\r
  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
  @param  FormatString    A Null-terminated Unicode format string.\r
  @param  ...             Variable argument list whose contents are accessed based on the\r
                          format string specified by FormatString.\r
\r
  @return The number of Unicode characters in the produced output buffer not including the\r
          Null-terminator.\r
\r
**/\r
UINTN\r
EFIAPI\r
UnicodeSPrint (\r
  OUT CHAR16        *StartOfBuffer,\r
  IN  UINTN         BufferSize,\r
  IN  CONST CHAR16  *FormatString,\r
  ...\r
  )\r
{\r
  VA_LIST Marker;\r
  UINTN   NumberOfPrinted;\r
\r
  VA_START (Marker, FormatString);\r
  NumberOfPrinted = UnicodeVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
  VA_END (Marker);\r
  return NumberOfPrinted;\r
}\r
\r
/**\r
  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
  ASCII format string and a VA_LIST argument list.\r
\r
  This function is similar as vsnprintf_s defined in C11.\r
\r
  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
  and BufferSize.\r
  The Unicode string is produced by parsing the format string specified by FormatString.\r
  Arguments are pulled from the variable argument list specified by Marker based on the\r
  contents of the format string.\r
  The number of Unicode characters in the produced output buffer is returned not including\r
  the Null-terminator.\r
\r
  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
\r
  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
  buffer is unmodified and 0 is returned.\r
  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                          Unicode string.\r
  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
  @param  FormatString    A Null-terminated ASCII format string.\r
  @param  Marker          VA_LIST marker for the variable argument list.\r
\r
  @return The number of Unicode characters in the produced output buffer not including the\r
          Null-terminator.\r
\r
**/\r
UINTN\r
EFIAPI\r
UnicodeVSPrintAsciiFormat (\r
  OUT CHAR16       *StartOfBuffer,\r
  IN  UINTN        BufferSize,\r
  IN  CONST CHAR8  *FormatString,\r
  IN  VA_LIST      Marker\r
  )\r
{\r
  ASSERT_UNICODE_BUFFER (StartOfBuffer);\r
  return BasePrintLibSPrintMarker ((CHAR8 *)StartOfBuffer, BufferSize >> 1, OUTPUT_UNICODE, FormatString, Marker, NULL);\r
}\r
\r
/**\r
  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
  ASCII format string and a BASE_LIST argument list.\r
\r
  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
  and BufferSize.\r
  The Unicode string is produced by parsing the format string specified by FormatString.\r
  Arguments are pulled from the variable argument list specified by Marker based on the\r
  contents of the format string.\r
  The number of Unicode characters in the produced output buffer is returned not including\r
  the Null-terminator.\r
\r
  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
\r
  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
  buffer is unmodified and 0 is returned.\r
  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                          Unicode string.\r
  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
  @param  FormatString    A Null-terminated ASCII format string.\r
  @param  Marker          BASE_LIST marker for the variable argument list.\r
\r
  @return The number of Unicode characters in the produced output buffer not including the\r
          Null-terminator.\r
\r
**/\r
UINTN\r
EFIAPI\r
UnicodeBSPrintAsciiFormat (\r
  OUT CHAR16       *StartOfBuffer,\r
  IN  UINTN        BufferSize,\r
  IN  CONST CHAR8  *FormatString,\r
  IN  BASE_LIST    Marker\r
  )\r
{\r
  ASSERT_UNICODE_BUFFER (StartOfBuffer);\r
  return BasePrintLibSPrintMarker ((CHAR8 *)StartOfBuffer, BufferSize >> 1, OUTPUT_UNICODE, FormatString, gNullVaList, Marker);\r
}\r
\r
/**\r
  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
  ASCII format string and  variable argument list.\r
\r
  This function is similar as snprintf_s defined in C11.\r
\r
  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
  and BufferSize.\r
  The Unicode string is produced by parsing the format string specified by FormatString.\r
  Arguments are pulled from the variable argument list based on the contents of the\r
  format string.\r
  The number of Unicode characters in the produced output buffer is returned not including\r
  the Null-terminator.\r
\r
  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
\r
  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
  buffer is unmodified and 0 is returned.\r
  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                          Unicode string.\r
  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
  @param  FormatString    A Null-terminated ASCII format string.\r
  @param  ...             Variable argument list whose contents are accessed based on the\r
                          format string specified by FormatString.\r
\r
  @return The number of Unicode characters in the produced output buffer not including the\r
          Null-terminator.\r
\r
**/\r
UINTN\r
EFIAPI\r
UnicodeSPrintAsciiFormat (\r
  OUT CHAR16       *StartOfBuffer,\r
  IN  UINTN        BufferSize,\r
  IN  CONST CHAR8  *FormatString,\r
  ...\r
  )\r
{\r
  VA_LIST Marker;\r
  UINTN   NumberOfPrinted;\r
\r
  VA_START (Marker, FormatString);\r
  NumberOfPrinted = UnicodeVSPrintAsciiFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
  VA_END (Marker);\r
  return NumberOfPrinted;\r
}\r
\r
#ifndef DISABLE_NEW_DEPRECATED_INTERFACES\r
\r
/**\r
  [ATTENTION] This function is deprecated for security reason.\r
\r
  Converts a decimal value to a Null-terminated Unicode string.\r
  \r
  Converts the decimal number specified by Value to a Null-terminated Unicode \r
  string specified by Buffer containing at most Width characters. No padding of spaces \r
  is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
  The number of Unicode characters in Buffer is returned not including the Null-terminator.\r
  If the conversion contains more than Width characters, then only the first\r
  Width characters are returned, and the total number of characters \r
  required to perform the conversion is returned.\r
  Additional conversion parameters are specified in Flags.  \r
  \r
  The Flags bit LEFT_JUSTIFY is always ignored.\r
  All conversions are left justified in Buffer.\r
  If Width is 0, PREFIX_ZERO is ignored in Flags.\r
  If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r
  are inserted every 3rd digit starting from the right.\r
  If RADIX_HEX is set in Flags, then the output buffer will be \r
  formatted in hexadecimal format.\r
  If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in Buffer is a '-'.\r
  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r
  then Buffer is padded with '0' characters so the combination of the optional '-' \r
  sign character, '0' characters, digit characters for Value, and the Null-terminator\r
  add up to Width characters.\r
  If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().\r
  If Buffer is NULL, then ASSERT().\r
  If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
  If unsupported bits are set in Flags, then ASSERT().\r
  If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().\r
  If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
\r
  @param  Buffer  The pointer to the output buffer for the produced Null-terminated\r
                  Unicode string.\r
  @param  Flags   The bitmask of flags that specify left justification, zero pad, and commas.\r
  @param  Value   The 64-bit signed value to convert to a string.\r
  @param  Width   The maximum number of Unicode characters to place in Buffer, not including\r
                  the Null-terminator.\r
  \r
  @return The number of Unicode characters in Buffer not including the Null-terminator.\r
\r
**/\r
UINTN\r
EFIAPI\r
UnicodeValueToString (\r
  IN OUT CHAR16  *Buffer,\r
  IN UINTN       Flags,\r
  IN INT64       Value,\r
  IN UINTN       Width\r
  )\r
{\r
  ASSERT_UNICODE_BUFFER(Buffer);\r
  return BasePrintLibConvertValueToString ((CHAR8 *)Buffer, Flags, Value, Width, 2);\r
}\r
\r
#endif\r
\r
/**\r
  Converts a decimal value to a Null-terminated Unicode string.\r
\r
  Converts the decimal number specified by Value to a Null-terminated Unicode\r
  string specified by Buffer containing at most Width characters. No padding of\r
  spaces is ever performed. If Width is 0 then a width of\r
  MAXIMUM_VALUE_CHARACTERS is assumed. If the conversion contains more than\r
  Width characters, then only the first Width characters are placed in Buffer.\r
  Additional conversion parameters are specified in Flags.\r
\r
  The Flags bit LEFT_JUSTIFY is always ignored.\r
  All conversions are left justified in Buffer.\r
  If Width is 0, PREFIX_ZERO is ignored in Flags.\r
  If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and\r
  commas are inserted every 3rd digit starting from the right.\r
  If RADIX_HEX is set in Flags, then the output buffer will be formatted in\r
  hexadecimal format.\r
  If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in\r
  Buffer is a '-'.\r
  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, then\r
  Buffer is padded with '0' characters so the combination of the optional '-'\r
  sign character, '0' characters, digit characters for Value, and the\r
  Null-terminator add up to Width characters.\r
\r
  If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
  If an error would be returned, then the function will also ASSERT().\r
\r
  @param  Buffer      The pointer to the output buffer for the produced\r
                      Null-terminated Unicode string.\r
  @param  BufferSize  The size of Buffer in bytes, including the\r
                      Null-terminator.\r
  @param  Flags       The bitmask of flags that specify left justification,\r
                      zero pad, and commas.\r
  @param  Value       The 64-bit signed value to convert to a string.\r
  @param  Width       The maximum number of Unicode characters to place in\r
                      Buffer, not including the Null-terminator.\r
\r
  @retval RETURN_SUCCESS           The decimal value is converted.\r
  @retval RETURN_BUFFER_TOO_SMALL  If BufferSize cannot hold the converted\r
                                   value.\r
  @retval RETURN_INVALID_PARAMETER If Buffer is NULL.\r
                                   If PcdMaximumUnicodeStringLength is not\r
                                   zero, and BufferSize is greater than\r
                                   (PcdMaximumUnicodeStringLength *\r
                                   sizeof (CHAR16) + 1).\r
                                   If unsupported bits are set in Flags.\r
                                   If both COMMA_TYPE and RADIX_HEX are set in\r
                                   Flags.\r
                                   If Width >= MAXIMUM_VALUE_CHARACTERS.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
UnicodeValueToStringS (\r
  IN OUT CHAR16  *Buffer,\r
  IN UINTN       BufferSize,\r
  IN UINTN       Flags,\r
  IN INT64       Value,\r
  IN UINTN       Width\r
  )\r
{\r
  ASSERT_UNICODE_BUFFER(Buffer);\r
  return BasePrintLibConvertValueToStringS ((CHAR8 *)Buffer, BufferSize, Flags, Value, Width, 2);\r
}\r
\r
/**\r
  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
  ASCII format string and a VA_LIST argument list.\r
\r
  This function is similar as vsnprintf_s defined in C11.\r
\r
  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
  and BufferSize.\r
  The ASCII string is produced by parsing the format string specified by FormatString.\r
  Arguments are pulled from the variable argument list specified by Marker based on\r
  the contents of the format string.\r
  The number of ASCII characters in the produced output buffer is returned not including\r
  the Null-terminator.\r
\r
  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
  is unmodified and 0 is returned.\r
  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                          ASCII string.\r
  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
  @param  FormatString    A Null-terminated ASCII format string.\r
  @param  Marker          VA_LIST marker for the variable argument list.\r
\r
  @return The number of ASCII characters in the produced output buffer not including the\r
          Null-terminator.\r
\r
**/\r
UINTN\r
EFIAPI\r
AsciiVSPrint (\r
  OUT CHAR8         *StartOfBuffer,\r
  IN  UINTN         BufferSize,\r
  IN  CONST CHAR8   *FormatString,\r
  IN  VA_LIST       Marker\r
  )\r
{\r
  return BasePrintLibSPrintMarker (StartOfBuffer, BufferSize, 0, FormatString, Marker, NULL);\r
}\r
\r
/**\r
  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
  ASCII format string and a BASE_LIST argument list.\r
\r
  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
  and BufferSize.\r
  The ASCII string is produced by parsing the format string specified by FormatString.\r
  Arguments are pulled from the variable argument list specified by Marker based on\r
  the contents of the format string.\r
  The number of ASCII characters in the produced output buffer is returned not including\r
  the Null-terminator.\r
\r
  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
  is unmodified and 0 is returned.\r
  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                          ASCII string.\r
  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
  @param  FormatString    A Null-terminated ASCII format string.\r
  @param  Marker          BASE_LIST marker for the variable argument list.\r
\r
  @return The number of ASCII characters in the produced output buffer not including the\r
          Null-terminator.\r
\r
**/\r
UINTN\r
EFIAPI\r
AsciiBSPrint (\r
  OUT CHAR8         *StartOfBuffer,\r
  IN  UINTN         BufferSize,\r
  IN  CONST CHAR8   *FormatString,\r
  IN  BASE_LIST     Marker\r
  )\r
{\r
  return BasePrintLibSPrintMarker (StartOfBuffer, BufferSize, 0, FormatString, gNullVaList, Marker);\r
}\r
\r
/**\r
  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
  ASCII format string and  variable argument list.\r
\r
  This function is similar as snprintf_s defined in C11.\r
\r
  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
  and BufferSize.\r
  The ASCII string is produced by parsing the format string specified by FormatString.\r
  Arguments are pulled from the variable argument list based on the contents of the\r
  format string.\r
  The number of ASCII characters in the produced output buffer is returned not including\r
  the Null-terminator.\r
\r
  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
  is unmodified and 0 is returned.\r
  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                          ASCII string.\r
  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
  @param  FormatString    A Null-terminated ASCII format string.\r
  @param  ...             Variable argument list whose contents are accessed based on the\r
                          format string specified by FormatString.\r
\r
  @return The number of ASCII characters in the produced output buffer not including the\r
          Null-terminator.\r
\r
**/\r
UINTN\r
EFIAPI\r
AsciiSPrint (\r
  OUT CHAR8        *StartOfBuffer,\r
  IN  UINTN        BufferSize,\r
  IN  CONST CHAR8  *FormatString,\r
  ...\r
  )\r
{\r
  VA_LIST Marker;\r
  UINTN   NumberOfPrinted;\r
\r
  VA_START (Marker, FormatString);\r
  NumberOfPrinted = AsciiVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
  VA_END (Marker);\r
  return NumberOfPrinted;\r
}\r
\r
/**\r
  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
  Unicode format string and a VA_LIST argument list.\r
\r
  This function is similar as vsnprintf_s defined in C11.\r
\r
  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
  and BufferSize.\r
  The ASCII string is produced by parsing the format string specified by FormatString.\r
  Arguments are pulled from the variable argument list specified by Marker based on\r
  the contents of the format string.\r
  The number of ASCII characters in the produced output buffer is returned not including\r
  the Null-terminator.\r
\r
  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
\r
  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
  is unmodified and 0 is returned.\r
  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                          ASCII string.\r
  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
  @param  FormatString    A Null-terminated Unicode format string.\r
  @param  Marker          VA_LIST marker for the variable argument list.\r
\r
  @return The number of ASCII characters in the produced output buffer not including the\r
          Null-terminator.\r
\r
**/\r
UINTN\r
EFIAPI\r
AsciiVSPrintUnicodeFormat (\r
  OUT CHAR8         *StartOfBuffer,\r
  IN  UINTN         BufferSize,\r
  IN  CONST CHAR16  *FormatString,\r
  IN  VA_LIST       Marker\r
  )\r
{\r
  ASSERT_UNICODE_BUFFER (FormatString);\r
  return BasePrintLibSPrintMarker (StartOfBuffer, BufferSize, FORMAT_UNICODE, (CHAR8 *)FormatString, Marker, NULL);\r
}\r
\r
/**\r
  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
  Unicode format string and a BASE_LIST argument list.\r
\r
  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
  and BufferSize.\r
  The ASCII string is produced by parsing the format string specified by FormatString.\r
  Arguments are pulled from the variable argument list specified by Marker based on\r
  the contents of the format string.\r
  The number of ASCII characters in the produced output buffer is returned not including\r
  the Null-terminator.\r
\r
  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
\r
  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
  is unmodified and 0 is returned.\r
  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                          ASCII string.\r
  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
  @param  FormatString    A Null-terminated Unicode format string.\r
  @param  Marker          BASE_LIST marker for the variable argument list.\r
\r
  @return The number of ASCII characters in the produced output buffer not including the\r
          Null-terminator.\r
\r
**/\r
UINTN\r
EFIAPI\r
AsciiBSPrintUnicodeFormat (\r
  OUT CHAR8         *StartOfBuffer,\r
  IN  UINTN         BufferSize,\r
  IN  CONST CHAR16  *FormatString,\r
  IN  BASE_LIST     Marker\r
  )\r
{\r
  ASSERT_UNICODE_BUFFER (FormatString);\r
  return BasePrintLibSPrintMarker (StartOfBuffer, BufferSize, FORMAT_UNICODE, (CHAR8 *)FormatString, gNullVaList, Marker);\r
}\r
\r
/**\r
  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
  Unicode format string and  variable argument list.\r
\r
  This function is similar as snprintf_s defined in C11.\r
\r
  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
  and BufferSize.\r
  The ASCII string is produced by parsing the format string specified by FormatString.\r
  Arguments are pulled from the variable argument list based on the contents of the\r
  format string.\r
  The number of ASCII characters in the produced output buffer is returned not including\r
  the Null-terminator.\r
\r
  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
\r
  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
  unmodified and 0 is returned.\r
  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
  is unmodified and 0 is returned.\r
  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                          ASCII string.\r
  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
  @param  FormatString    A Null-terminated Unicode format string.\r
  @param  ...             Variable argument list whose contents are accessed based on the\r
                          format string specified by FormatString.\r
\r
  @return The number of ASCII characters in the produced output buffer not including the\r
          Null-terminator.\r
\r
**/\r
UINTN\r
EFIAPI\r
AsciiSPrintUnicodeFormat (\r
  OUT CHAR8         *StartOfBuffer,\r
  IN  UINTN         BufferSize,\r
  IN  CONST CHAR16  *FormatString,\r
  ...\r
  )\r
{\r
  VA_LIST Marker;\r
  UINTN   NumberOfPrinted;\r
\r
  VA_START (Marker, FormatString);\r
  NumberOfPrinted = AsciiVSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
  VA_END (Marker);\r
  return NumberOfPrinted;\r
}\r
\r
\r
#ifndef DISABLE_NEW_DEPRECATED_INTERFACES\r
\r
/**\r
  [ATTENTION] This function is deprecated for security reason.\r
\r
  Converts a decimal value to a Null-terminated ASCII string.\r
  \r
  Converts the decimal number specified by Value to a Null-terminated ASCII string \r
  specified by Buffer containing at most Width characters. No padding of spaces \r
  is ever performed.\r
  If Width is 0 then a width of  MAXIMUM_VALUE_CHARACTERS is assumed.\r
  The number of ASCII characters in Buffer is returned not including the Null-terminator.\r
  If the conversion contains more than Width characters, then only the first Width\r
  characters are returned, and the total number of characters required to perform\r
  the conversion is returned.\r
  Additional conversion parameters are specified in Flags.  \r
  The Flags bit LEFT_JUSTIFY is always ignored.\r
  All conversions are left justified in Buffer.\r
  If Width is 0, PREFIX_ZERO is ignored in Flags.\r
  If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r
  are inserted every 3rd digit starting from the right.\r
  If RADIX_HEX is set in Flags, then the output buffer will be \r
  formatted in hexadecimal format.\r
  If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in Buffer is a '-'.\r
  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r
  then Buffer is padded with '0' characters so the combination of the optional '-' \r
  sign character, '0' characters, digit characters for Value, and the Null-terminator\r
  add up to Width characters.\r
  \r
  If Buffer is NULL, then ASSERT().\r
  If unsupported bits are set in Flags, then ASSERT().\r
  If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().\r
  If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
\r
  @param  Buffer  The pointer to the output buffer for the produced Null-terminated\r
                  ASCII string.\r
  @param  Flags   The bitmask of flags that specify left justification, zero pad, and commas.\r
  @param  Value   The 64-bit signed value to convert to a string.\r
  @param  Width   The maximum number of ASCII characters to place in Buffer, not including\r
                  the Null-terminator.\r
  \r
  @return The number of ASCII characters in Buffer not including the Null-terminator.\r
\r
**/\r
UINTN\r
EFIAPI\r
AsciiValueToString (\r
  OUT CHAR8      *Buffer,\r
  IN  UINTN      Flags,\r
  IN  INT64      Value,\r
  IN  UINTN      Width\r
  )\r
{\r
  return BasePrintLibConvertValueToString (Buffer, Flags, Value, Width, 1);\r
}\r
\r
#endif\r
\r
/**\r
  Converts a decimal value to a Null-terminated Ascii string.\r
\r
  Converts the decimal number specified by Value to a Null-terminated Ascii\r
  string specified by Buffer containing at most Width characters. No padding of\r
  spaces is ever performed. If Width is 0 then a width of\r
  MAXIMUM_VALUE_CHARACTERS is assumed. If the conversion contains more than\r
  Width characters, then only the first Width characters are placed in Buffer.\r
  Additional conversion parameters are specified in Flags.\r
\r
  The Flags bit LEFT_JUSTIFY is always ignored.\r
  All conversions are left justified in Buffer.\r
  If Width is 0, PREFIX_ZERO is ignored in Flags.\r
  If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and\r
  commas are inserted every 3rd digit starting from the right.\r
  If RADIX_HEX is set in Flags, then the output buffer will be formatted in\r
  hexadecimal format.\r
  If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in\r
  Buffer is a '-'.\r
  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, then\r
  Buffer is padded with '0' characters so the combination of the optional '-'\r
  sign character, '0' characters, digit characters for Value, and the\r
  Null-terminator add up to Width characters.\r
\r
  If an error would be returned, then the function will ASSERT().\r
\r
  @param  Buffer      The pointer to the output buffer for the produced\r
                      Null-terminated Ascii string.\r
  @param  BufferSize  The size of Buffer in bytes, including the\r
                      Null-terminator.\r
  @param  Flags       The bitmask of flags that specify left justification,\r
                      zero pad, and commas.\r
  @param  Value       The 64-bit signed value to convert to a string.\r
  @param  Width       The maximum number of Ascii characters to place in\r
                      Buffer, not including the Null-terminator.\r
\r
  @retval RETURN_SUCCESS           The decimal value is converted.\r
  @retval RETURN_BUFFER_TOO_SMALL  If BufferSize cannot hold the converted\r
                                   value.\r
  @retval RETURN_INVALID_PARAMETER If Buffer is NULL.\r
                                   If PcdMaximumAsciiStringLength is not\r
                                   zero, and BufferSize is greater than\r
                                   PcdMaximumAsciiStringLength.\r
                                   If unsupported bits are set in Flags.\r
                                   If both COMMA_TYPE and RADIX_HEX are set in\r
                                   Flags.\r
                                   If Width >= MAXIMUM_VALUE_CHARACTERS.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
AsciiValueToStringS (\r
  IN OUT CHAR8   *Buffer,\r
  IN UINTN       BufferSize,\r
  IN UINTN       Flags,\r
  IN INT64       Value,\r
  IN UINTN       Width\r
  )\r
{\r
  return BasePrintLibConvertValueToStringS (Buffer, BufferSize, Flags, Value, Width, 1);\r
}\r
\r
/**\r
  Returns the number of characters that would be produced by if the formatted \r
  output were produced not including the Null-terminator.\r
\r
  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
\r
  If FormatString is NULL, then ASSERT() and 0 is returned.\r
  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more\r
  than PcdMaximumUnicodeStringLength Unicode characters not including the\r
  Null-terminator, then ASSERT() and 0 is returned.\r
\r
  @param[in]  FormatString    A Null-terminated Unicode format string.\r
  @param[in]  Marker          VA_LIST marker for the variable argument list.\r
\r
  @return The number of characters that would be produced, not including the \r
          Null-terminator.\r
**/\r
UINTN\r
EFIAPI\r
SPrintLength (\r
  IN  CONST CHAR16   *FormatString,\r
  IN  VA_LIST       Marker\r
  )\r
{\r
  ASSERT_UNICODE_BUFFER (FormatString);\r
  return BasePrintLibSPrintMarker (NULL, 0, FORMAT_UNICODE | OUTPUT_UNICODE | COUNT_ONLY_NO_PRINT, (CHAR8 *)FormatString, Marker, NULL);\r
}\r
\r
/**\r
  Returns the number of characters that would be produced by if the formatted \r
  output were produced not including the Null-terminator.\r
\r
  If FormatString is NULL, then ASSERT() and 0 is returned.\r
  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more\r
  than PcdMaximumAsciiStringLength Ascii characters not including the\r
  Null-terminator, then ASSERT() and 0 is returned.\r
\r
  @param[in]  FormatString    A Null-terminated ASCII format string.\r
  @param[in]  Marker          VA_LIST marker for the variable argument list.\r
\r
  @return The number of characters that would be produced, not including the \r
          Null-terminator.\r
**/\r
UINTN\r
EFIAPI\r
SPrintLengthAsciiFormat (\r
  IN  CONST CHAR8   *FormatString,\r
  IN  VA_LIST       Marker\r
  )\r
{\r
  return BasePrintLibSPrintMarker (NULL, 0, OUTPUT_UNICODE | COUNT_ONLY_NO_PRINT, (CHAR8 *)FormatString, Marker, NULL);\r
}\r