]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/BasePrintLib/PrintLibInternal.c
clarify the logic of the print length counting functions in both PrintLib library...
[mirror_edk2.git] / MdePkg / Library / BasePrintLib / PrintLibInternal.c
index 22d63eb1e6748f915e6ed5753ecd1994944e3724..de1b25fa7a71e728973cbff93202dd0dc4c5f9bb 100644 (file)
@@ -1,11 +1,11 @@
 /** @file\r
   Print Library internal worker functions.\r
 \r
-  Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2006 - 2011, 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
+  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
@@ -57,15 +57,15 @@ GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 *mStatusString[] = {
 \r
   Internal function that places ASCII or Unicode character into the Buffer.\r
 \r
-  @param  Buffer      Buffer to place the Unicode or ASCII string.\r
+  @param  Buffer      The buffer to place the Unicode or ASCII string.\r
   @param  EndBuffer   The end of the input Buffer. No characters will be\r
                       placed after that. \r
-  @param  Length      Count of character to be placed into Buffer.\r
+  @param  Length      The count of character to be placed into Buffer.\r
                       (Negative value indicates no buffer fill.)\r
-  @param  Character   Character to be placed into Buffer.\r
-  @param  Increment   Character increment in Buffer.\r
+  @param  Character   The character to be placed into Buffer.\r
+  @param  Increment   The character increment in Buffer.\r
 \r
-  @return Buffer      Buffer filled with the input Character.\r
+  @return Buffer.\r
 \r
 **/\r
 CHAR8 *\r
@@ -96,7 +96,7 @@ BasePrintLibFillBuffer (
   Print worker function that converts a decimal or hexadecimal number to an ASCII string in Buffer.\r
 \r
   @param  Buffer    Location to place the ASCII string of Value.\r
-  @param  Value     Value to convert to a Decimal or Hexadecimal string in Buffer.\r
+  @param  Value     The value to convert to a Decimal or Hexadecimal string in Buffer.\r
   @param  Radix     Radix of the value\r
 \r
   @return A pointer to the end of buffer filled with ASCII string.\r
@@ -152,14 +152,14 @@ BasePrintLibValueToString (
   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
+  @param  Buffer    The pointer to the output buffer for the produced Null-terminated\r
                     string.\r
   @param  Flags     The bitmask of flags that specify left justification, zero pad,\r
                     and commas.\r
   @param  Value     The 64-bit signed value to convert to a string.\r
   @param  Width     The maximum number of characters to place in Buffer, not including\r
                     the Null-terminator.\r
-  @param  Increment Character increment in Buffer.\r
+  @param  Increment The character increment in Buffer.\r
   \r
   @return Total number of characters required to perform the conversion.\r
 \r
@@ -275,16 +275,24 @@ BasePrintLibConvertValueToString (
   VA_LIST is used this routine allows the nesting of Vararg routines. Thus \r
   this is the main print working routine.\r
 \r
-  @param  Buffer          Character buffer to print the results of the parsing\r
-                          of Format into.\r
-  @param  BufferSize      Maximum number of characters to put into buffer.\r
-  @param  Flags           Initial flags value.\r
-                          Can only have FORMAT_UNICODE and OUTPUT_UNICODE set.\r
-  @param  Format          Null-terminated format string.\r
-  @param  VaListMarker    VA_LIST style variable argument list consumed by processing Format.\r
-  @param  BaseListMarker  BASE_LIST style variable argument list consumed by processing Format.\r
-\r
-  @return Number of characters printed not including the Null-terminator.\r
+  If COUNT_ONLY_NO_PRINT is set in Flags, Buffer will not be modified at all.\r
+\r
+  @param[out] Buffer          The character buffer to print the results of the \r
+                              parsing of Format into.\r
+  @param[in]  BufferSize      The maximum number of characters to put into \r
+                              buffer.\r
+  @param[in]  Flags           Initial flags value.\r
+                              Can only have FORMAT_UNICODE, OUTPUT_UNICODE, \r
+                              and COUNT_ONLY_NO_PRINT set.\r
+  @param[in]  Format          A Null-terminated format string.\r
+  @param[in]  VaListMarker    VA_LIST style variable argument list consumed by\r
+                              processing Format.\r
+  @param[in]  BaseListMarker  BASE_LIST style variable argument list consumed\r
+                              by processing Format.\r
+\r
+  @return The number of characters printed not including the Null-terminator.\r
+          If COUNT_ONLY_NO_PRINT was set returns the same, but without any\r
+          modification to Buffer.\r
 \r
 **/\r
 UINTN\r
@@ -300,7 +308,7 @@ BasePrintLibSPrintMarker (
   CHAR8             *OriginalBuffer;\r
   CHAR8             *EndBuffer;\r
   CHAR8             ValueBuffer[MAXIMUM_VALUE_CHARACTERS];\r
-  UINT            BytesPerOutputCharacter;\r
+  UINT32            BytesPerOutputCharacter;\r
   UINTN             BytesPerFormatCharacter;\r
   UINTN             FormatMask;\r
   UINTN             FormatCharacter;\r
@@ -323,18 +331,39 @@ BasePrintLibSPrintMarker (
   UINTN             Digits;\r
   UINTN             Radix;\r
   RETURN_STATUS     Status;\r
+  UINT32            GuidData1;\r
+  UINT16            GuidData2;\r
+  UINT16            GuidData3;\r
+  UINT32            LengthToReturn;\r
+\r
+  //\r
+  // If you change this code be sure to match the 2 versions of this function.\r
+  // Nearly identical logic is found in the BasePrintLib and \r
+  // DxePrintLibPrint2Protocol (both PrintLib instances).\r
+  //\r
 \r
-  if (BufferSize == 0) {\r
-    return 0;\r
+  if (Flags & COUNT_ONLY_NO_PRINT) {\r
+    if (BufferSize == 0) {\r
+      Buffer = NULL;\r
+    }\r
+  } else {\r
+    //\r
+    // We can run without a Buffer for counting only.\r
+    //\r
+    if (BufferSize == 0) {\r
+      return 0;\r
+    }\r
+    ASSERT (Buffer != NULL);\r
   }\r
-  ASSERT (Buffer != NULL);\r
 \r
-  if ((Flags & OUTPUT_UNICODE) != 0) {\r
+  if (Flags & OUTPUT_UNICODE) {\r
     BytesPerOutputCharacter = 2;\r
   } else {\r
     BytesPerOutputCharacter = 1;\r
   }\r
 \r
+  LengthToReturn = 0;\r
+\r
   //\r
   // Reserve space for the Null terminator.\r
   //\r
@@ -376,7 +405,7 @@ BasePrintLibSPrintMarker (
     //\r
     // Clear all the flag bits except those that may have been passed in\r
     //\r
-    Flags &= (OUTPUT_UNICODE | FORMAT_UNICODE);\r
+    Flags &= (OUTPUT_UNICODE | FORMAT_UNICODE | COUNT_ONLY_NO_PRINT);\r
 \r
     //\r
     // Set the default width to zero, and the default precision to 1\r
@@ -631,14 +660,17 @@ BasePrintLibSPrintMarker (
         if (TmpGuid == NULL) {\r
           ArgumentString = "<null guid>";\r
         } else {\r
+          GuidData1 = ReadUnaligned32 (&(TmpGuid->Data1));\r
+          GuidData2 = ReadUnaligned16 (&(TmpGuid->Data2));\r
+          GuidData3 = ReadUnaligned16 (&(TmpGuid->Data3));\r
           BasePrintLibSPrint (\r
             ValueBuffer,\r
             MAXIMUM_VALUE_CHARACTERS, \r
             0,\r
             "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",\r
-            TmpGuid->Data1,\r
-            TmpGuid->Data2,\r
-            TmpGuid->Data3,\r
+            GuidData1,\r
+            GuidData2,\r
+            GuidData3,\r
             TmpGuid->Data4[0],\r
             TmpGuid->Data4[1],\r
             TmpGuid->Data4[2],\r
@@ -810,18 +842,33 @@ BasePrintLibSPrintMarker (
     // Pad before the string\r
     //\r
     if ((Flags & (PAD_TO_WIDTH | LEFT_JUSTIFY)) == (PAD_TO_WIDTH)) {\r
-      Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
+      LengthToReturn += ((Width - Precision) * BytesPerOutputCharacter);\r
+      if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+        Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
+      }\r
     }\r
 \r
     if (ZeroPad) {\r
       if (Prefix != 0) {\r
-        Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
+        LengthToReturn += (1 * BytesPerOutputCharacter);\r
+        if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+          Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
+        }\r
+      }\r
+      LengthToReturn += ((Precision - Count) * BytesPerOutputCharacter);\r
+      if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+        Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Precision - Count, '0', BytesPerOutputCharacter);\r
       }\r
-      Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Precision - Count, '0', BytesPerOutputCharacter);\r
     } else {\r
-      Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Precision - Count, ' ', BytesPerOutputCharacter);\r
+      LengthToReturn += ((Precision - Count) * BytesPerOutputCharacter);\r
+      if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+        Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Precision - Count, ' ', BytesPerOutputCharacter);\r
+      }\r
       if (Prefix != 0) {\r
-        Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
+        LengthToReturn += (1 * BytesPerOutputCharacter);\r
+        if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+          Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
+        }\r
       }\r
     }\r
 \r
@@ -839,7 +886,10 @@ BasePrintLibSPrintMarker (
     while (Index < Count) {\r
       ArgumentCharacter = ((*ArgumentString & 0xff) | (*(ArgumentString + 1) << 8)) & ArgumentMask;\r
 \r
-      Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ArgumentCharacter, BytesPerOutputCharacter);\r
+      LengthToReturn += (1 * BytesPerOutputCharacter);\r
+      if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+        Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ArgumentCharacter, BytesPerOutputCharacter);\r
+      }\r
       ArgumentString    += BytesPerArgumentCharacter;\r
       Index++;\r
       if (Comma) {\r
@@ -848,7 +898,10 @@ BasePrintLibSPrintMarker (
           Digits = 0;\r
           Index++;\r
           if (Index < Count) {\r
-            Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ',', BytesPerOutputCharacter);\r
+            LengthToReturn += (1 * BytesPerOutputCharacter);\r
+            if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+              Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ',', BytesPerOutputCharacter);\r
+            }\r
           }\r
         }\r
       }\r
@@ -858,7 +911,10 @@ BasePrintLibSPrintMarker (
     // Pad after the string\r
     //\r
     if ((Flags & (PAD_TO_WIDTH | LEFT_JUSTIFY)) == (PAD_TO_WIDTH | LEFT_JUSTIFY)) {\r
-      Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
+      LengthToReturn += ((Width - Precision) * BytesPerOutputCharacter);\r
+      if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+        Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
+      }\r
     }\r
 \r
     //\r
@@ -872,6 +928,10 @@ BasePrintLibSPrintMarker (
     FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
   }\r
 \r
+  if (Flags & COUNT_ONLY_NO_PRINT) {\r
+    return (LengthToReturn / BytesPerOutputCharacter);\r
+  }\r
+\r
   //\r
   // Null terminate the Unicode or ASCII string\r
   //\r
@@ -898,19 +958,20 @@ BasePrintLibSPrintMarker (
   VA_LIST is used this routine allows the nesting of Vararg routines. Thus \r
   this is the main print working routine\r
 \r
-  @param  StartOfBuffer Character buffer to print the results of the parsing\r
+  @param  StartOfBuffer The character buffer to print the results of the parsing\r
                         of Format into.\r
-  @param  BufferSize    Maximum number of characters to put into buffer.\r
+  @param  BufferSize    The maximum number of characters to put into buffer.\r
                         Zero means no limit.\r
   @param  Flags         Initial flags value.\r
                         Can only have FORMAT_UNICODE and OUTPUT_UNICODE set\r
-  @param  FormatString  Null-terminated format string.\r
+  @param  FormatString  Null-terminated format string.\r
   @param  ...           The variable argument list.\r
 \r
-  @return Number of characters printed.\r
+  @return The number of characters printed.\r
 \r
 **/\r
 UINTN\r
+EFIAPI\r
 BasePrintLibSPrint (\r
   OUT CHAR8        *StartOfBuffer,\r
   IN  UINTN        BufferSize,\r