Code scrub for the Debug library, PostCode library, Print library, and ExtractGuidedS...

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

diff --git a/MdePkg/Library/BasePrintLib/PrintLibInternal.c b/MdePkg/Library/BasePrintLib/PrintLibInternal.c
index 4a9b15fec17530f0ee0e2ca292693a3aa44a6938..572819e041b31f8f89c6b0c3f7b7fe7a60a711f2 100644 (file)
--- a/MdePkg/Library/BasePrintLib/PrintLibInternal.c
+++ b/MdePkg/Library/BasePrintLib/PrintLibInternal.c
@@ -1,7 +1,7 @@
 /** @file\r
-  Print Library worker functions.\r
+  Print Library internal worker functions.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
+  Copyright (c) 2006 - 2008, Intel Corporation<BR>\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
@@ -34,16 +34,16 @@ GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 mHexStr[] = {'0','1','2','3','4','5','
   @param  Character   Character to be placed into Buffer.\r
   @param  Increment   Character increment in Buffer.\r
 \r
-  @return Number of characters printed.\r
+  @return Buffer      Buffer filled with the input Character.\r
 \r
 **/\r
 CHAR8 *\r
 BasePrintLibFillBuffer (\r
-  CHAR8   *Buffer,\r
-  CHAR8   *EndBuffer,\r
-  INTN    Length,\r
-  UINTN   Character,\r
-  INTN    Increment\r
+  OUT CHAR8   *Buffer,\r
+  IN  CHAR8   *EndBuffer,\r
+  IN  INTN    Length,\r
+  IN  UINTN   Character,\r
+  IN  INTN    Increment\r
   )\r
 {\r
   INTN  Index;\r
@@ -69,7 +69,6 @@ BasePrintLibFillBuffer (
 \r
 **/\r
 UINTN\r
-EFIAPI\r
 BasePrintLibValueToString (\r
   IN OUT CHAR8  *Buffer,\r
   IN INT64      Value,\r
@@ -89,6 +88,10 @@ BasePrintLibValueToString (
     *(Buffer++) = mHexStr[Remainder];\r
     Digits++;\r
   } while (Value != 0);\r
+\r
+  //\r
+  // the length of Buffer string converted from Value\r
+  //\r
   return Digits;\r
 }\r
 \r
@@ -149,6 +152,9 @@ BasePrintLibConvertValueToString (
   UINTN  Index;\r
   UINTN  Radix;\r
 \r
+  //\r
+  // Make sure Buffer is not NULL and Width < MAXIMUM\r
+  //\r
   ASSERT (Buffer != NULL);\r
   ASSERT (Width < MAXIMUM_VALUE_CHARACTERS);\r
   //\r
@@ -162,11 +168,16 @@ BasePrintLibConvertValueToString (
   ASSERT (((Flags & COMMA_TYPE) != 0 && (Flags & RADIX_HEX) != 0) == FALSE);\r
 \r
   OriginalBuffer = Buffer;\r
-\r
+  \r
+  //\r
+  // Width is 0 or COMMA_TYPE is set, PREFIX_ZERO is ignored.\r
+  //\r
   if (Width == 0 || (Flags & COMMA_TYPE) != 0) {\r
     Flags &= (~PREFIX_ZERO);\r
   }\r
-\r
+  //\r
+  // If Width is 0 then a width of  MAXIMUM_VALUE_CHARACTERS is assumed.\r
+  //\r
   if (Width == 0) {\r
     Width = MAXIMUM_VALUE_CHARACTERS - 1;\r
   }\r
@@ -174,20 +185,32 @@ BasePrintLibConvertValueToString (
   // Set the tag for the end of the input Buffer.\r
   //\r
   EndBuffer = Buffer + Width * Increment;\r
-\r
+  \r
+  //\r
+  // Convert decimal negative\r
+  //\r
   if ((Value < 0) && ((Flags & RADIX_HEX) == 0)) {\r
     Value = -Value;\r
     Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, '-', Increment);\r
     Width--;\r
   }\r
-\r
+  \r
+  //\r
+  // Count the length of the value string.\r
+  //\r
   Radix = ((Flags & RADIX_HEX) == 0)? 10 : 16;\r
   Count = BasePrintLibValueToString (ValueBuffer, Value, Radix);\r
-\r
+  \r
+  //\r
+  // Append Zero\r
+  //\r
   if ((Flags & PREFIX_ZERO) != 0) {\r
     Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Width - Count, '0', Increment);\r
   }\r
-\r
+  \r
+  //\r
+  // Print Comma type for every 3 characters\r
+  //\r
   Digits = Count % 3;\r
   if (Digits != 0) {\r
     Digits = 3 - Digits;\r
@@ -204,7 +227,10 @@ BasePrintLibConvertValueToString (
       }\r
     }\r
   }\r
-\r
+  \r
+  //\r
+  // Print Null-terminator\r
+  //\r
   BasePrintLibFillBuffer (Buffer, EndBuffer + Increment, 1, 0, Increment);\r
 \r
   return ((Buffer - OriginalBuffer) / Increment);\r