remove unnecessary comments introduced by tools from MdePkg. The regular express...

[mirror_edk2.git] / MdePkg / Library / UefiLib / UefiLibPrint.c

diff --git a/MdePkg/Library/UefiLib/UefiLibPrint.c b/MdePkg/Library/UefiLib/UefiLibPrint.c
index f4453e4cd8a2290dd6a8dd534ddff41e28fa9150..87219de7f1235031488948ad692f499f57088f5e 100644 (file)
--- a/MdePkg/Library/UefiLib/UefiLibPrint.c
+++ b/MdePkg/Library/UefiLib/UefiLibPrint.c
@@ -13,10 +13,8 @@
 \r
 **/\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
-#include "CommonHeader.h"\r
+\r
+#include "UefiLibInternal.h"\r
 \r
 /**\r
   Internal function which prints a formatted Unicode string to the console output device\r
@@ -26,18 +24,18 @@
   specified by Console and returns the number of Unicode characters that printed\r
   to it.  If the length of the formatted Unicode string is greater than PcdUefiLibMaxPrintBufferSize,\r
   then only the first PcdUefiLibMaxPrintBufferSize characters are sent to Console.\r
+  If Format is NULL, then ASSERT().\r
+  If Format is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param Format   Null-terminated Unicode format string.\r
   @param Console  The output console.\r
   @param Marker   VA_LIST marker for the variable argument list.\r
-\r
-  If Format is NULL, then ASSERT().\r
-  If Format is not aligned on a 16-bit boundary, then ASSERT().\r
-\r
+  \r
+  @return The number of Unicode characters in the produced\r
+          output buffer not including the Null-terminator.\r
 **/\r
-\r
-STATIC\r
 UINTN\r
+EFIAPI\r
 InternalPrint (\r
   IN  CONST CHAR16                     *Format,\r
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *Console,\r
@@ -58,7 +56,7 @@ InternalPrint (
 \r
   Return = UnicodeVSPrint (Buffer, BufferSize, Format, Marker);\r
 \r
-  if (Console != NULL) {\r
+  if (Console != NULL && Return > 0) {\r
     //\r
     // To be extra safe make sure Console has been initialized\r
     //\r
@@ -79,11 +77,14 @@ InternalPrint (
   characters that printed to ConOut.  If the length of the formatted Unicode\r
   string is greater than PcdUefiLibMaxPrintBufferSize, then only the first\r
   PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.\r
+  If Format is NULL, then ASSERT().\r
+  If Format is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param Format   Null-terminated Unicode format string.\r
   @param ...      VARARG list consumed to process Format.\r
-  If Format is NULL, then ASSERT().\r
-  If Format is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
+  @return The number of Unicode characters in the produced\r
+          output buffer not including the Null-terminator.\r
 \r
 **/\r
 UINTN\r
@@ -114,12 +115,14 @@ Print (
   characters that printed to StdErr.  If the length of the formatted Unicode\r
   string is greater than PcdUefiLibMaxPrintBufferSize, then only the first\r
   PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.\r
+  If Format is NULL, then ASSERT().\r
+  If Format is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param Format   Null-terminated Unicode format string.\r
   @param ...      VARARG list consumed to process Format.\r
-  If Format is NULL, then ASSERT().\r
-  If Format is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
+  @return The number of Unicode characters in the produced\r
+          output buffer not including the Null-terminator.\r
 **/\r
 \r
 UINTN\r
@@ -150,17 +153,22 @@ ErrorPrint (
   specified by Console and returns the number of ASCII characters that printed\r
   to it.  If the length of the formatted ASCII string is greater than PcdUefiLibMaxPrintBufferSize,\r
   then only the first PcdUefiLibMaxPrintBufferSize characters are sent to Console.\r
+  If Format is NULL, then ASSERT().\r
+\r
+  If Format is NULL, then ASSERT().\r
+  If Format is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
 \r
   @param Format   Null-terminated ASCII format string.\r
   @param Console  The output console.\r
   @param Marker   VA_LIST marker for the variable argument list.\r
 \r
-  If Format is NULL, then ASSERT().\r
+  @return The number of Unicode characters in the produced\r
+          output buffer not including the Null-terminator.\r
 \r
 **/\r
-\r
-STATIC\r
 UINTN\r
+EFIAPI\r
 AsciiInternalPrint (\r
   IN  CONST CHAR8                      *Format,\r
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *Console,\r
@@ -201,11 +209,13 @@ AsciiInternalPrint (
   characters that printed to ConOut.  If the length of the formatted ASCII\r
   string is greater than PcdUefiLibMaxPrintBufferSize, then only the first\r
   PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.\r
+  If Format is NULL, then ASSERT().\r
 \r
   @param Format   Null-terminated ASCII format string.\r
   @param ...      VARARG list consumed to process Format.\r
-  If Format is NULL, then ASSERT().\r
-  If Format is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
+  @return The number of Ascii characters in the produced\r
+          output buffer not including the Null-terminator.\r
 \r
 **/\r
 UINTN\r
@@ -217,7 +227,8 @@ AsciiPrint (
 {\r
   VA_LIST Marker;\r
   UINTN   Return;\r
-\r
+  ASSERT (Format != NULL);\r
+  \r
   VA_START (Marker, Format);\r
 \r
   Return = AsciiInternalPrint( Format, gST->ConOut, Marker);\r
@@ -236,11 +247,13 @@ AsciiPrint (
   characters that printed to StdErr.  If the length of the formatted ASCII\r
   string is greater than PcdUefiLibMaxPrintBufferSize, then only the first\r
   PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.\r
+  If Format is NULL, then ASSERT().\r
 \r
   @param Format   Null-terminated ASCII format string.\r
   @param ...      VARARG list consumed to process Format.\r
-  If Format is NULL, then ASSERT().\r
-  If Format is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
+  @return The number of Ascii characters in the produced output\r
+          buffer not including the Null-terminator.\r
 \r
 **/\r
 UINTN\r
@@ -253,6 +266,8 @@ AsciiErrorPrint (
   VA_LIST Marker;\r
   UINTN   Return;\r
 \r
+  ASSERT (Format != NULL);\r
+  \r
   VA_START (Marker, Format);\r
 \r
   Return = AsciiInternalPrint( Format, gST->StdErr, Marker);\r