added some comments in BaseLib

[mirror_edk2.git] / MdePkg / Include / Library / PrintLib.h

/** @file\r
  Library that provides print services\r
\r
  Copyright (c) 2006, Intel Corporation                                                         \r
  All rights reserved. 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:  PrintLib.h\r
\r
**/\r
\r
#ifndef __PRINT_LIB_H__\r
#define __PRINT_LIB_H__\r
\r
///\r
/// Define the maximum number of characters that are required to\r
/// encode a decimal, hexidecimal, GUID, or TIME value with a NULL \r
/// terminator.\r
///  \r
///  Maximum Length Decimal String     = 28\r
///    "-9,223,372,036,854,775,808"\r
///  Maximum Length Hexidecimal String = 17\r
///    "FFFFFFFFFFFFFFFF"\r
///  Maximum Length GUID               = 37\r
///    "00000000-0000-0000-0000-000000000000"\r
///  Maximum Length TIME               = 18\r
///    "12/12/2006  12:12"\r
///\r
#define MAXIMUM_VALUE_CHARACTERS  38\r
\r
///\r
/// Flags bitmask values use in UnicodeValueToString() and \r
/// AcsiiValueToString()\r
///\r
#define LEFT_JUSTIFY      0x01\r
#define COMMA_TYPE        0x08\r
#define PREFIX_ZERO       0x20\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
  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
  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
  If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
  ASSERT().\r
  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
  contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
  Null-terminator, then ASSERT().\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    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
/**\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
  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
  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
  If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
  ASSERT().\r
  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
  contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
  Null-terminator, then ASSERT().\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    Null-terminated Unicode format string.\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
/**\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
  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
  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
  If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
  ASSERT().\r
  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
  contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
  Null-terminator, then ASSERT().\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    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
UnicodeVSPrintAsciiFormat (\r
  OUT CHAR16       *StartOfBuffer,\r
  IN  UINTN        BufferSize,\r
  IN  CONST CHAR8  *FormatString,\r
  IN  VA_LIST      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
  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
  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
  If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
  ASSERT().\r
  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
  contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
  Null-terminator, then ASSERT().\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    Null-terminated Unicode format string.\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
/**\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
  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
  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
  If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
  ASSERT().\r
  If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
  contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
  Null-terminator, then ASSERT().\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    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
AsciiVSPrint (\r
  OUT CHAR8         *StartOfBuffer,\r
  IN  UINTN         BufferSize,\r
  IN  CONST CHAR8   *FormatString,\r
  IN  VA_LIST       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
  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
  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
  If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
  ASSERT().\r
  If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
  contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
  Null-terminator, then ASSERT().\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    Null-terminated Unicode format string.\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
/**\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
  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
  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
  If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
  ASSERT().\r
  If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
  contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
  Null-terminator, then ASSERT().\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    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
/**\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
  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
  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
  If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
  ASSERT().\r
  If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
  contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
  Null-terminator, then ASSERT().\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    Null-terminated Unicode format string.\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
/**\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.\r
  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
  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 Value is < 0, 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 Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
\r
  @param  Buffer  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
/**\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.\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 Value is < 0, then the fist character in Buffer is a '-'.\r
  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, then Buffer\r
  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 NULL, then ASSERT().\r
  If unsupported bits are set in Flags, then ASSERT().\r
  If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
\r
  @param  Buffer  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
  IN OUT CHAR8  *Buffer,\r
  IN UINTN      Flags,\r
  IN INT64      Value,\r
  IN UINTN      Width\r
  );\r
\r
#endif\r