add function header

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@350 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 288 insertions, 0 deletions

diff --git a/MdePkg/Include/Library/PrintLib.h b/MdePkg/Include/Library/PrintLib.h
index 3eb84f311b..9c65459a59 100644
--- a/MdePkg/Include/Library/PrintLib.h
+++ b/MdePkg/Include/Library/PrintLib.h
@@ -24,6 +24,34 @@
 #define COMMA_TYPE        0x08

 #define PREFIX_ZERO       0x20

 

+/**

+  Produces a Null-terminated Unicode string in an output buffer based on 

+  a Null-terminated Unicode format string and a VA_LIST argument list

+  

+  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer

+  and BufferSize.  

+  The Unicode string is produced by parsing the format string specified by FormatString.  

+  Arguments are pulled from the variable argument list specified by Marker based on the 

+  contents of the format string.  

+  The length of the produced output buffer is returned.

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

+

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          Unicode string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  @param  Marker          VA_LIST marker for the variable argument list.

+  

+  @return return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 UnicodeVSPrint (

@@ -33,6 +61,32 @@ UnicodeVSPrint (
   IN  VA_LIST       Marker

   );

 

+/**

+  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated 

+  Unicode format string and variable argument list.

+  

+  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer

+  and BufferSize.

+  The Unicode string is produced by parsing the format string specified by FormatString.

+  Arguments are pulled from the variable argument list based on the contents of the format string.

+  The length of the produced output buffer is returned.  

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

+

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          Unicode string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  

+  @return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 UnicodeSPrint (

@@ -42,6 +96,34 @@ UnicodeSPrint (
   ...

   );

 

+/**

+  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated

+  ASCII format string and a VA_LIST argument list

+  

+  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer

+  and BufferSize.

+  The Unicode string is produced by parsing the format string specified by FormatString.

+  Arguments are pulled from the variable argument list specified by Marker based on the 

+  contents of the format string.

+  The length of the produced output buffer is returned.

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

+

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          Unicode string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  @param  Marker          VA_LIST marker for the variable argument list.

+  

+  @return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 UnicodeVSPrintAsciiFormat (

@@ -51,7 +133,33 @@ UnicodeVSPrintAsciiFormat (
   IN  VA_LIST      Marker

   );

 

+/**

+  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated 

+  ASCII format string and  variable argument list.

+  

+  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer

+  and BufferSize.

+  The Unicode string is produced by parsing the format string specified by FormatString.

+  Arguments are pulled from the variable argument list based on the contents of the 

+  format string.

+  The length of the produced output buffer is returned.

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

 

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          Unicode string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  

+  @return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 UnicodeSPrintAsciiFormat (

@@ -61,6 +169,34 @@ UnicodeSPrintAsciiFormat (
   ...

   );

 

+/**

+  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated

+  ASCII format string and a VA_LIST argument list.

+  

+  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer

+  and BufferSize.

+  The ASCII string is produced by parsing the format string specified by FormatString.

+  Arguments are pulled from the variable argument list specified by Marker based on 

+  the contents of the format string.

+  The length of the produced output buffer is returned.

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          ASCII string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  @param  Marker          VA_LIST marker for the variable argument list.

+  

+  @return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 AsciiVSPrint (

@@ -70,6 +206,33 @@ AsciiVSPrint (
   IN  VA_LIST       Marker

   );

 

+/**

+  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated

+  ASCII format string and  variable argument list.

+  

+  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer

+  and BufferSize.

+  The ASCII string is produced by parsing the format string specified by FormatString.

+  Arguments are pulled from the variable argument list based on the contents of the 

+  format string.

+  The length of the produced output buffer is returned.

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          ASCII string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  

+  @return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 AsciiSPrint (

@@ -79,6 +242,34 @@ AsciiSPrint (
   ...

   );

 

+/**

+  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated

+  ASCII format string and a VA_LIST argument list.

+  

+  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer

+  and BufferSize.

+  The ASCII string is produced by parsing the format string specified by FormatString.

+  Arguments are pulled from the variable argument list specified by Marker based on 

+  the contents of the format string.

+  The length of the produced output buffer is returned.

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          ASCII string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  @param  Marker          VA_LIST marker for the variable argument list.

+  

+  @return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 AsciiVSPrintUnicodeFormat (

@@ -88,6 +279,33 @@ AsciiVSPrintUnicodeFormat (
   IN  VA_LIST       Marker

   );

 

+/**

+  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated

+  ASCII format string and  variable argument list.

+  

+  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer

+  and BufferSize.

+  The ASCII string is produced by parsing the format string specified by FormatString.

+  Arguments are pulled from the variable argument list based on the contents of the 

+  format string.

+  The length of the produced output buffer is returned.

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          ASCII string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  

+  @return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 AsciiSPrintUnicodeFormat (

@@ -97,6 +315,41 @@ AsciiSPrintUnicodeFormat (
   ...

   );

 

+/**

+  Converts a decimal value to a Null-terminated Unicode string.

+  

+  Converts the decimal number specified by Value to a Null-terminated Unicode 

+  string specified by Buffer containing at most Width characters.

+  If Width is 0 then a width of  MAXIMUM_VALUE_CHARACTERS is assumed.

+  The total number of characters placed in Buffer is returned.

+  If the conversion contains more than Width characters, then only the first

+  Width characters are returned, and the total number of characters 

+  required to perform the conversion is returned.

+  Additional conversion parameters are specified in Flags.  

+  The Flags bit LEFT_JUSTIFY is always ignored.

+  All conversions are left justified in Buffer.

+  If Width is 0, PREFIX_ZERO is ignored in Flags.

+  If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas

+  are inserted every 3rd digit starting from the right.

+  If Value is < 0, then the fist character in Buffer is a '-'.

+  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, 

+  then Buffer is padded with '0' characters so the combination of the optional '-' 

+  sign character, '0' characters, digit characters for Value, and the Null-terminator

+  add up to Width characters.

+

+  If Buffer is NULL, then ASSERT().

+  If unsupported bits are set in Flags, then ASSERT().

+  If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()

+

+  @param  Buffer  Pointer to the output buffer for the produced Null-terminated

+                  Unicode string.

+  @param  Flags   The bitmask of flags that specify left justification, zero pad, and commas.

+  @param  Value   The 64-bit signed value to convert to a string.

+  @param  Width	  The maximum number of Unicode characters to place in Buffer.

+  

+  @return Total number of characters required to perform the conversion.

+

+**/

 UINTN

 EFIAPI

 UnicodeValueToString (

@@ -106,6 +359,41 @@ UnicodeValueToString (
   IN UINTN       Width

   );

 

+/**

+  Converts a decimal value to a Null-terminated ASCII string.

+  

+  Converts the decimal number specified by Value to a Null-terminated ASCII string 

+  specified by Buffer containing at most Width characters.

+  If Width is 0 then a width of  MAXIMUM_VALUE_CHARACTERS is assumed.

+  The total number of characters placed in Buffer is returned.

+  If the conversion contains more than Width characters, then only the first Width

+  characters are returned, and the total number of characters required to perform

+  the conversion is returned.

+  Additional conversion parameters are specified in Flags.  

+  The Flags bit LEFT_JUSTIFY is always ignored.

+  All conversions are left justified in Buffer.

+  If Width is 0, PREFIX_ZERO is ignored in Flags.

+  If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas 

+  are inserted every 3rd digit starting from the right.

+  If Value is < 0, then the fist character in Buffer is a '-'.

+  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, then Buffer

+  is padded with '0' characters so the combination of the optional '-'

+  sign character, '0' characters, digit characters for Value, and the 

+  Null-terminator add up to Width characters.

+

+  If Buffer is NULL, then ASSERT().

+  If unsupported bits are set in Flags, then ASSERT().

+  If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()

+

+  @param  Buffer  Pointer to the output buffer for the produced Null-terminated

+                  ASCII string.

+  @param  Flags   The bitmask of flags that specify left justification, zero pad, and commas.

+  @param  Value   The 64-bit signed value to convert to a string.

+  @param  Width	  The maximum number of ASCII characters to place in Buffer.

+  

+  @return Total number of characters required to perform the conversion.

+

+**/

 UINTN

 EFIAPI

 AsciiValueToString (