Clean up code.

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

diff --git a/MdePkg/Library/BasePrintLib/PrintLibInternal.c b/MdePkg/Library/BasePrintLib/PrintLibInternal.c
index de1b25fa7a71e728973cbff93202dd0dc4c5f9bb..e61aed9fda649c9ed279445b22d15c0961b4eb6e 100644 (file)
--- a/MdePkg/Library/BasePrintLib/PrintLibInternal.c
+++ b/MdePkg/Library/BasePrintLib/PrintLibInternal.c
@@ -1,7 +1,7 @@
 /** @file\r
   Print Library internal worker functions.\r
 \r
-  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2012, 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
@@ -14,8 +14,8 @@
 \r
 #include "PrintLibInternal.h"\r
 \r
-#define WARNING_STATUS_NUMBER         4\r
-#define ERROR_STATUS_NUMBER           24\r
+#define WARNING_STATUS_NUMBER         5\r
+#define ERROR_STATUS_NUMBER           33\r
 \r
 GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 mHexStr[] = {'0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'};\r
 \r
@@ -25,6 +25,7 @@ GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 *mStatusString[] = {
   "Warning Delete Failure",       //  RETURN_WARN_DELETE_FAILURE    = 2\r
   "Warning Write Failure",        //  RETURN_WARN_WRITE_FAILURE     = 3\r
   "Warning Buffer Too Small",     //  RETURN_WARN_BUFFER_TOO_SMALL  = 4\r
+  "Warning Stale Data",           //  RETURN_WARN_STALE_DATA        = 5\r
   "Load Error",                   //  RETURN_LOAD_ERROR             = 1  | MAX_BIT\r
   "Invalid Parameter",            //  RETURN_INVALID_PARAMETER      = 2  | MAX_BIT\r
   "Unsupported",                  //  RETURN_UNSUPPORTED            = 3  | MAX_BIT\r
@@ -48,7 +49,16 @@ GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 *mStatusString[] = {
   "Aborted",                      //  RETURN_ABORTED                = 21 | MAX_BIT\r
   "ICMP Error",                   //  RETURN_ICMP_ERROR             = 22 | MAX_BIT\r
   "TFTP Error",                   //  RETURN_TFTP_ERROR             = 23 | MAX_BIT\r
-  "Protocol Error"                //  RETURN_PROTOCOL_ERROR         = 24 | MAX_BIT\r
+  "Protocol Error",               //  RETURN_PROTOCOL_ERROR         = 24 | MAX_BIT\r
+  "Incompatible Version",         //  RETURN_INCOMPATIBLE_VERSION   = 25 | MAX_BIT\r
+  "Security Violation",           //  RETURN_SECURITY_VIOLATION     = 26 | MAX_BIT\r
+  "CRC Error",                    //  RETURN_CRC_ERROR              = 27 | MAX_BIT\r
+  "End of Media",                 //  RETURN_END_OF_MEDIA           = 28 | MAX_BIT\r
+  "Reserved (29)",                //  RESERVED                      = 29 | MAX_BIT\r
+  "Reserved (30)",                //  RESERVED                      = 30 | MAX_BIT\r
+  "End of File",                  //  RETURN_END_OF_FILE            = 31 | MAX_BIT\r
+  "Invalid Language",             //  RETURN_INVALID_LANGUAGE       = 32 | MAX_BIT\r
+  "Compromised Data"              //  RETURN_COMPROMISED_DATA       = 33 | MAX_BIT\r
 };\r
 \r
 \r
@@ -334,7 +344,7 @@ BasePrintLibSPrintMarker (
   UINT32            GuidData1;\r
   UINT16            GuidData2;\r
   UINT16            GuidData3;\r
-  UINT32            LengthToReturn;\r
+  UINTN             LengthToReturn;\r
 \r
   //\r
   // If you change this code be sure to match the 2 versions of this function.\r
@@ -342,7 +352,7 @@ BasePrintLibSPrintMarker (
   // DxePrintLibPrint2Protocol (both PrintLib instances).\r
   //\r
 \r
-  if (Flags & COUNT_ONLY_NO_PRINT) {\r
+  if ((Flags & COUNT_ONLY_NO_PRINT) != 0) {\r
     if (BufferSize == 0) {\r
       Buffer = NULL;\r
     }\r
@@ -356,24 +366,28 @@ BasePrintLibSPrintMarker (
     ASSERT (Buffer != NULL);\r
   }\r
 \r
-  if (Flags & OUTPUT_UNICODE) {\r
+  if ((Flags & OUTPUT_UNICODE) != 0) {\r
     BytesPerOutputCharacter = 2;\r
   } else {\r
     BytesPerOutputCharacter = 1;\r
   }\r
 \r
   LengthToReturn = 0;\r
+  EndBuffer = NULL;\r
+  OriginalBuffer = NULL;\r
 \r
   //\r
   // Reserve space for the Null terminator.\r
   //\r
-  BufferSize--;\r
-  OriginalBuffer = Buffer;\r
+  if (Buffer != NULL) {\r
+    BufferSize--;\r
+    OriginalBuffer = Buffer;\r
 \r
-  //\r
-  // Set the tag for the end of the input Buffer.\r
-  //\r
-  EndBuffer      = Buffer + BufferSize * BytesPerOutputCharacter;\r
+    //\r
+    // Set the tag for the end of the input Buffer.\r
+    //\r
+    EndBuffer = Buffer + BufferSize * BytesPerOutputCharacter;\r
+  }\r
 \r
   if ((Flags & FORMAT_UNICODE) != 0) {\r
     //\r
@@ -401,7 +415,10 @@ BasePrintLibSPrintMarker (
   //\r
   // Loop until the end of the format string is reached or the output buffer is full\r
   //\r
-  while (FormatCharacter != 0 && Buffer < EndBuffer) {\r
+  while (FormatCharacter != 0) {\r
+    if ((Buffer != NULL) && (Buffer >= EndBuffer)) {\r
+      break;\r
+    }\r
     //\r
     // Clear all the flag bits except those that may have been passed in\r
     //\r
@@ -517,6 +534,9 @@ BasePrintLibSPrintMarker (
         if (sizeof (VOID *) > 4) {\r
           Flags |= LONG_TYPE;\r
         }\r
+        //\r
+        // break skipped on purpose\r
+        //\r
       case 'X':\r
         Flags |= PREFIX_ZERO;\r
         //\r
@@ -843,7 +863,7 @@ BasePrintLibSPrintMarker (
     //\r
     if ((Flags & (PAD_TO_WIDTH | LEFT_JUSTIFY)) == (PAD_TO_WIDTH)) {\r
       LengthToReturn += ((Width - Precision) * BytesPerOutputCharacter);\r
-      if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+      if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
         Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
       }\r
     }\r
@@ -851,22 +871,22 @@ BasePrintLibSPrintMarker (
     if (ZeroPad) {\r
       if (Prefix != 0) {\r
         LengthToReturn += (1 * BytesPerOutputCharacter);\r
-        if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+        if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
           Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
         }\r
       }\r
       LengthToReturn += ((Precision - Count) * BytesPerOutputCharacter);\r
-      if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+      if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
         Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Precision - Count, '0', BytesPerOutputCharacter);\r
       }\r
     } else {\r
       LengthToReturn += ((Precision - Count) * BytesPerOutputCharacter);\r
-      if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+      if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
         Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Precision - Count, ' ', BytesPerOutputCharacter);\r
       }\r
       if (Prefix != 0) {\r
         LengthToReturn += (1 * BytesPerOutputCharacter);\r
-        if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+        if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
           Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
         }\r
       }\r
@@ -887,7 +907,7 @@ BasePrintLibSPrintMarker (
       ArgumentCharacter = ((*ArgumentString & 0xff) | (*(ArgumentString + 1) << 8)) & ArgumentMask;\r
 \r
       LengthToReturn += (1 * BytesPerOutputCharacter);\r
-      if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+      if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
         Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ArgumentCharacter, BytesPerOutputCharacter);\r
       }\r
       ArgumentString    += BytesPerArgumentCharacter;\r
@@ -899,7 +919,7 @@ BasePrintLibSPrintMarker (
           Index++;\r
           if (Index < Count) {\r
             LengthToReturn += (1 * BytesPerOutputCharacter);\r
-            if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+            if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
               Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ',', BytesPerOutputCharacter);\r
             }\r
           }\r
@@ -912,7 +932,7 @@ BasePrintLibSPrintMarker (
     //\r
     if ((Flags & (PAD_TO_WIDTH | LEFT_JUSTIFY)) == (PAD_TO_WIDTH | LEFT_JUSTIFY)) {\r
       LengthToReturn += ((Width - Precision) * BytesPerOutputCharacter);\r
-      if ((Flags & COUNT_ONLY_NO_PRINT) == 0) {\r
+      if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
         Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
       }\r
     }\r
@@ -928,10 +948,11 @@ BasePrintLibSPrintMarker (
     FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
   }\r
 \r
-  if (Flags & COUNT_ONLY_NO_PRINT) {\r
+  if ((Flags & COUNT_ONLY_NO_PRINT) != 0) {\r
     return (LengthToReturn / BytesPerOutputCharacter);\r
   }\r
 \r
+  ASSERT (Buffer != NULL);\r
   //\r
   // Null terminate the Unicode or ASCII string\r
   //\r
@@ -981,7 +1002,10 @@ BasePrintLibSPrint (
   )\r
 {\r
   VA_LIST  Marker;\r
+  UINTN    NumberOfPrinted;\r
 \r
   VA_START (Marker, FormatString);\r
-  return BasePrintLibSPrintMarker (StartOfBuffer, BufferSize, Flags, FormatString, Marker, NULL);\r
+  NumberOfPrinted = BasePrintLibSPrintMarker (StartOfBuffer, BufferSize, Flags, FormatString, Marker, NULL);\r
+  VA_END (Marker);\r
+  return NumberOfPrinted;\r
 }\r