protocol related to this implementation, not in the public spec. So, this \r
library instance is only for this code base.\r
\r
-Copyright (c) 2009, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2009 - 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
**/\r
\r
#include <Uefi.h>\r
-\r
+#include <Base.h>\r
#include <Protocol/Print2.h>\r
\r
#include <Library/PrintLib.h>\r
{\r
return mPrint2Protocol->AsciiValueToString (Buffer, Flags, Value, Width);\r
}\r
+\r
+#define PREFIX_SIGN BIT1\r
+#define PREFIX_BLANK BIT2\r
+#define LONG_TYPE BIT4\r
+#define OUTPUT_UNICODE BIT6\r
+#define FORMAT_UNICODE BIT8\r
+#define PAD_TO_WIDTH BIT9\r
+#define ARGUMENT_UNICODE BIT10\r
+#define PRECISION BIT11\r
+#define ARGUMENT_REVERSED BIT12\r
+#define COUNT_ONLY_NO_PRINT BIT13\r
+\r
+//\r
+// Record date and time information\r
+//\r
+typedef struct {\r
+ UINT16 Year;\r
+ UINT8 Month;\r
+ UINT8 Day;\r
+ UINT8 Hour;\r
+ UINT8 Minute;\r
+ UINT8 Second;\r
+ UINT8 Pad1;\r
+ UINT32 Nanosecond;\r
+ INT16 TimeZone;\r
+ UINT8 Daylight;\r
+ UINT8 Pad2;\r
+} TIME;\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
+/**\r
+ Internal function that convert a number to a string in Buffer.\r
+\r
+ 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 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
+\r
+**/\r
+CHAR8 *\r
+InternalPrintLibValueToString (\r
+ IN OUT CHAR8 *Buffer, \r
+ IN INT64 Value, \r
+ IN UINTN Radix\r
+ )\r
+{\r
+ UINT32 Remainder;\r
+\r
+ //\r
+ // Loop to convert one digit at a time in reverse order\r
+ //\r
+ *Buffer = 0;\r
+ do {\r
+ Value = (INT64)DivU64x32Remainder ((UINT64)Value, (UINT32)Radix, &Remainder);\r
+ *(++Buffer) = mHexStr[Remainder];\r
+ } while (Value != 0);\r
+\r
+ //\r
+ // Return pointer of the end of filled buffer.\r
+ //\r
+ return Buffer;\r
+}\r
+\r
+/**\r
+ Worker function that produces a Null-terminated string in an output buffer \r
+ based on a Null-terminated format string and a VA_LIST argument list.\r
+\r
+ VSPrint function to process format and place the results in Buffer. Since a \r
+ VA_LIST is used this routine allows the nesting of Vararg routines. Thus \r
+ this is the main print working routine.\r
+\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
+InternalPrintLibSPrintMarker (\r
+ OUT CHAR8 *Buffer,\r
+ IN UINTN BufferSize,\r
+ IN UINTN Flags,\r
+ IN CONST CHAR8 *Format,\r
+ IN VA_LIST VaListMarker, OPTIONAL\r
+ IN BASE_LIST BaseListMarker OPTIONAL\r
+ );\r
+\r
+/**\r
+ Worker function that produces a Null-terminated string in an output buffer \r
+ based on a Null-terminated format string and variable argument list.\r
+\r
+ VSPrint function to process format and place the results in Buffer. Since a \r
+ 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 The character buffer to print the results of the parsing\r
+ of Format into.\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 A Null-terminated format string.\r
+ @param ... The variable argument list.\r
+\r
+ @return The number of characters printed.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+InternalPrintLibSPrint (\r
+ OUT CHAR8 *StartOfBuffer,\r
+ IN UINTN BufferSize,\r
+ IN UINTN Flags,\r
+ IN CONST CHAR8 *FormatString,\r
+ ...\r
+ )\r
+{\r
+ VA_LIST Marker;\r
+\r
+ VA_START (Marker, FormatString);\r
+ return InternalPrintLibSPrintMarker (StartOfBuffer, BufferSize, Flags, FormatString, Marker, NULL);\r
+}\r
+\r
+#define WARNING_STATUS_NUMBER 4\r
+#define ERROR_STATUS_NUMBER 24\r
+\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 *mStatusString[] = {\r
+ "Success", // RETURN_SUCCESS = 0\r
+ "Warning Unknown Glyph", // RETURN_WARN_UNKNOWN_GLYPH = 1\r
+ "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
+ "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
+ "Bad Buffer Size", // RETURN_BAD_BUFFER_SIZE = 4 | MAX_BIT\r
+ "Buffer Too Small", // RETURN_BUFFER_TOO_SMALL, = 5 | MAX_BIT\r
+ "Not Ready", // RETURN_NOT_READY = 6 | MAX_BIT\r
+ "Device Error", // RETURN_DEVICE_ERROR = 7 | MAX_BIT\r
+ "Write Protected", // RETURN_WRITE_PROTECTED = 8 | MAX_BIT\r
+ "Out of Resources", // RETURN_OUT_OF_RESOURCES = 9 | MAX_BIT\r
+ "Volume Corrupt", // RETURN_VOLUME_CORRUPTED = 10 | MAX_BIT\r
+ "Volume Full", // RETURN_VOLUME_FULL = 11 | MAX_BIT\r
+ "No Media", // RETURN_NO_MEDIA = 12 | MAX_BIT\r
+ "Media changed", // RETURN_MEDIA_CHANGED = 13 | MAX_BIT\r
+ "Not Found", // RETURN_NOT_FOUND = 14 | MAX_BIT\r
+ "Access Denied", // RETURN_ACCESS_DENIED = 15 | MAX_BIT\r
+ "No Response", // RETURN_NO_RESPONSE = 16 | MAX_BIT\r
+ "No mapping", // RETURN_NO_MAPPING = 17 | MAX_BIT\r
+ "Time out", // RETURN_TIMEOUT = 18 | MAX_BIT\r
+ "Not started", // RETURN_NOT_STARTED = 19 | MAX_BIT\r
+ "Already started", // RETURN_ALREADY_STARTED = 20 | MAX_BIT\r
+ "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
+};\r
+\r
+/**\r
+ Worker function that produces a Null-terminated string in an output buffer \r
+ based on a Null-terminated format string and a VA_LIST argument list.\r
+\r
+ VSPrint function to process format and place the results in Buffer. Since a \r
+ VA_LIST is used this routine allows the nesting of Vararg routines. Thus \r
+ this is the main print working routine.\r
+\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
+InternalPrintLibSPrintMarker (\r
+ OUT CHAR8 *Buffer,\r
+ IN UINTN BufferSize,\r
+ IN UINTN Flags,\r
+ IN CONST CHAR8 *Format,\r
+ IN VA_LIST VaListMarker, OPTIONAL\r
+ IN BASE_LIST BaseListMarker OPTIONAL\r
+ )\r
+{\r
+ CHAR8 *OriginalBuffer;\r
+ CHAR8 *EndBuffer;\r
+ CHAR8 ValueBuffer[MAXIMUM_VALUE_CHARACTERS];\r
+ UINT32 BytesPerOutputCharacter;\r
+ UINTN BytesPerFormatCharacter;\r
+ UINTN FormatMask;\r
+ UINTN FormatCharacter;\r
+ UINTN Width;\r
+ UINTN Precision;\r
+ INT64 Value;\r
+ CONST CHAR8 *ArgumentString;\r
+ UINTN Character;\r
+ GUID *TmpGuid;\r
+ TIME *TmpTime;\r
+ UINTN Count;\r
+ UINTN ArgumentMask;\r
+ INTN BytesPerArgumentCharacter;\r
+ UINTN ArgumentCharacter;\r
+ BOOLEAN Done;\r
+ UINTN Index;\r
+ CHAR8 Prefix;\r
+ BOOLEAN ZeroPad;\r
+ BOOLEAN Comma;\r
+ 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
+ ASSERT(Flags & COUNT_ONLY_NO_PRINT);\r
+\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
+ 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
+ if ((Flags & FORMAT_UNICODE) != 0) {\r
+ //\r
+ // Make sure format string cannot contain more than PcdMaximumUnicodeStringLength\r
+ // Unicode characters if PcdMaximumUnicodeStringLength is not zero. \r
+ //\r
+ ASSERT (StrSize ((CHAR16 *) Format) != 0);\r
+ BytesPerFormatCharacter = 2;\r
+ FormatMask = 0xffff;\r
+ } else {\r
+ //\r
+ // Make sure format string cannot contain more than PcdMaximumAsciiStringLength\r
+ // Ascii characters if PcdMaximumAsciiStringLength is not zero. \r
+ //\r
+ ASSERT (AsciiStrSize (Format) != 0);\r
+ BytesPerFormatCharacter = 1;\r
+ FormatMask = 0xff;\r
+ }\r
+\r
+ //\r
+ // Get the first character from the format string\r
+ //\r
+ FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+\r
+ //\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
+ //\r
+ // Clear all the flag bits except those that may have been passed in\r
+ //\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
+ //\r
+ Width = 0;\r
+ Precision = 1;\r
+ Prefix = 0;\r
+ Comma = FALSE;\r
+ ZeroPad = FALSE;\r
+ Count = 0;\r
+ Digits = 0;\r
+\r
+ switch (FormatCharacter) {\r
+ case '%':\r
+ //\r
+ // Parse Flags and Width\r
+ //\r
+ for (Done = FALSE; !Done; ) {\r
+ Format += BytesPerFormatCharacter;\r
+ FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ switch (FormatCharacter) {\r
+ case '.': \r
+ Flags |= PRECISION; \r
+ break;\r
+ case '-': \r
+ Flags |= LEFT_JUSTIFY; \r
+ break;\r
+ case '+': \r
+ Flags |= PREFIX_SIGN; \r
+ break;\r
+ case ' ': \r
+ Flags |= PREFIX_BLANK; \r
+ break;\r
+ case ',': \r
+ Flags |= COMMA_TYPE; \r
+ break;\r
+ case 'L':\r
+ case 'l': \r
+ Flags |= LONG_TYPE; \r
+ break;\r
+ case '*':\r
+ if ((Flags & PRECISION) == 0) {\r
+ Flags |= PAD_TO_WIDTH;\r
+ if (BaseListMarker == NULL) {\r
+ Width = VA_ARG (VaListMarker, UINTN);\r
+ } else {\r
+ Width = BASE_ARG (BaseListMarker, UINTN);\r
+ }\r
+ } else {\r
+ if (BaseListMarker == NULL) {\r
+ Precision = VA_ARG (VaListMarker, UINTN);\r
+ } else {\r
+ Precision = BASE_ARG (BaseListMarker, UINTN);\r
+ }\r
+ }\r
+ break;\r
+ case '0':\r
+ if ((Flags & PRECISION) == 0) {\r
+ Flags |= PREFIX_ZERO;\r
+ }\r
+ case '1':\r
+ case '2':\r
+ case '3':\r
+ case '4':\r
+ case '5':\r
+ case '6':\r
+ case '7':\r
+ case '8':\r
+ case '9':\r
+ for (Count = 0; ((FormatCharacter >= '0') && (FormatCharacter <= '9')); ){\r
+ Count = (Count * 10) + FormatCharacter - '0';\r
+ Format += BytesPerFormatCharacter;\r
+ FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ }\r
+ Format -= BytesPerFormatCharacter;\r
+ if ((Flags & PRECISION) == 0) {\r
+ Flags |= PAD_TO_WIDTH;\r
+ Width = Count;\r
+ } else {\r
+ Precision = Count;\r
+ }\r
+ break;\r
+ \r
+ case '\0':\r
+ //\r
+ // Make no output if Format string terminates unexpectedly when\r
+ // looking up for flag, width, precision and type. \r
+ //\r
+ Format -= BytesPerFormatCharacter;\r
+ Precision = 0;\r
+ //\r
+ // break skipped on purpose.\r
+ //\r
+ default:\r
+ Done = TRUE;\r
+ break;\r
+ }\r
+ } \r
+\r
+ //\r
+ // Handle each argument type\r
+ //\r
+ switch (FormatCharacter) {\r
+ case 'p':\r
+ //\r
+ // Flag space, +, 0, L & l are invalid for type p.\r
+ //\r
+ Flags &= ~(PREFIX_BLANK | PREFIX_SIGN | PREFIX_ZERO | LONG_TYPE);\r
+ if (sizeof (VOID *) > 4) {\r
+ Flags |= LONG_TYPE;\r
+ }\r
+ case 'X':\r
+ Flags |= PREFIX_ZERO;\r
+ //\r
+ // break skipped on purpose\r
+ //\r
+ case 'x':\r
+ Flags |= RADIX_HEX;\r
+ //\r
+ // break skipped on purpose\r
+ //\r
+ case 'd':\r
+ if ((Flags & LONG_TYPE) == 0) {\r
+ //\r
+ // 'd','x', and 'X' that are not preceded by 'l' or 'L' are assumed to be type "int".\r
+ // This assumption is made so the format string definition is compatible with the ANSI C\r
+ // Specification for formatted strings. It is recommended that the Base Types be used \r
+ // everywhere, but in this one case, compliance with ANSI C is more important, and \r
+ // provides an implementation that is compatible with that largest possible set of CPU \r
+ // architectures. This is why the type "int" is used in this one case.\r
+ //\r
+ if (BaseListMarker == NULL) {\r
+ Value = VA_ARG (VaListMarker, int);\r
+ } else {\r
+ Value = BASE_ARG (BaseListMarker, int);\r
+ }\r
+ } else {\r
+ if (BaseListMarker == NULL) {\r
+ Value = VA_ARG (VaListMarker, INT64);\r
+ } else {\r
+ Value = BASE_ARG (BaseListMarker, INT64);\r
+ }\r
+ }\r
+ if ((Flags & PREFIX_BLANK) != 0) {\r
+ Prefix = ' ';\r
+ }\r
+ if ((Flags & PREFIX_SIGN) != 0) {\r
+ Prefix = '+';\r
+ }\r
+ if ((Flags & COMMA_TYPE) != 0) {\r
+ Comma = TRUE;\r
+ }\r
+ if ((Flags & RADIX_HEX) == 0) {\r
+ Radix = 10;\r
+ if (Comma) {\r
+ Flags &= (~PREFIX_ZERO);\r
+ Precision = 1;\r
+ }\r
+ if (Value < 0) {\r
+ Flags |= PREFIX_SIGN;\r
+ Prefix = '-';\r
+ Value = -Value;\r
+ }\r
+ } else {\r
+ Radix = 16;\r
+ Comma = FALSE;\r
+ if ((Flags & LONG_TYPE) == 0 && Value < 0) {\r
+ //\r
+ // 'd','x', and 'X' that are not preceded by 'l' or 'L' are assumed to be type "int".\r
+ // This assumption is made so the format string definition is compatible with the ANSI C\r
+ // Specification for formatted strings. It is recommended that the Base Types be used \r
+ // everywhere, but in this one case, compliance with ANSI C is more important, and \r
+ // provides an implementation that is compatible with that largest possible set of CPU \r
+ // architectures. This is why the type "unsigned int" is used in this one case.\r
+ //\r
+ Value = (unsigned int)Value;\r
+ }\r
+ }\r
+ //\r
+ // Convert Value to a reversed string\r
+ //\r
+ Count = InternalPrintLibValueToString (ValueBuffer, Value, Radix) - ValueBuffer;\r
+ if (Value == 0 && Precision == 0) {\r
+ Count = 0;\r
+ }\r
+ ArgumentString = (CHAR8 *)ValueBuffer + Count;\r
+ \r
+ Digits = Count % 3;\r
+ if (Digits != 0) {\r
+ Digits = 3 - Digits;\r
+ }\r
+ if (Comma && Count != 0) {\r
+ Count += ((Count - 1) / 3);\r
+ }\r
+ if (Prefix != 0) {\r
+ Count++;\r
+ Precision++;\r
+ }\r
+ Flags |= ARGUMENT_REVERSED;\r
+ ZeroPad = TRUE;\r
+ if ((Flags & PREFIX_ZERO) != 0) {\r
+ if ((Flags & LEFT_JUSTIFY) == 0) {\r
+ if ((Flags & PAD_TO_WIDTH) != 0) {\r
+ if ((Flags & PRECISION) == 0) {\r
+ Precision = Width;\r
+ }\r
+ }\r
+ }\r
+ }\r
+ break;\r
+\r
+ case 's':\r
+ case 'S':\r
+ Flags |= ARGUMENT_UNICODE;\r
+ //\r
+ // break skipped on purpose\r
+ //\r
+ case 'a':\r
+ if (BaseListMarker == NULL) {\r
+ ArgumentString = VA_ARG (VaListMarker, CHAR8 *);\r
+ } else {\r
+ ArgumentString = BASE_ARG (BaseListMarker, CHAR8 *);\r
+ }\r
+ if (ArgumentString == NULL) {\r
+ Flags &= (~ARGUMENT_UNICODE);\r
+ ArgumentString = "<null string>";\r
+ }\r
+ //\r
+ // Set the default precision for string to be zero if not specified.\r
+ //\r
+ if ((Flags & PRECISION) == 0) {\r
+ Precision = 0;\r
+ }\r
+ break;\r
+\r
+ case 'c':\r
+ if (BaseListMarker == NULL) {\r
+ Character = VA_ARG (VaListMarker, UINTN) & 0xffff;\r
+ } else {\r
+ Character = BASE_ARG (BaseListMarker, UINTN) & 0xffff;\r
+ }\r
+ ArgumentString = (CHAR8 *)&Character;\r
+ Flags |= ARGUMENT_UNICODE;\r
+ break;\r
+\r
+ case 'g':\r
+ if (BaseListMarker == NULL) {\r
+ TmpGuid = VA_ARG (VaListMarker, GUID *);\r
+ } else {\r
+ TmpGuid = BASE_ARG (BaseListMarker, GUID *);\r
+ }\r
+ 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
+ InternalPrintLibSPrint (\r
+ ValueBuffer,\r
+ MAXIMUM_VALUE_CHARACTERS, \r
+ 0,\r
+ "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",\r
+ GuidData1,\r
+ GuidData2,\r
+ GuidData3,\r
+ TmpGuid->Data4[0],\r
+ TmpGuid->Data4[1],\r
+ TmpGuid->Data4[2],\r
+ TmpGuid->Data4[3],\r
+ TmpGuid->Data4[4],\r
+ TmpGuid->Data4[5],\r
+ TmpGuid->Data4[6],\r
+ TmpGuid->Data4[7]\r
+ );\r
+ ArgumentString = ValueBuffer;\r
+ }\r
+ break;\r
+\r
+ case 't':\r
+ if (BaseListMarker == NULL) {\r
+ TmpTime = VA_ARG (VaListMarker, TIME *); \r
+ } else {\r
+ TmpTime = BASE_ARG (BaseListMarker, TIME *); \r
+ }\r
+ if (TmpTime == NULL) {\r
+ ArgumentString = "<null time>";\r
+ } else {\r
+ InternalPrintLibSPrint (\r
+ ValueBuffer,\r
+ MAXIMUM_VALUE_CHARACTERS,\r
+ 0,\r
+ "%02d/%02d/%04d %02d:%02d",\r
+ TmpTime->Month,\r
+ TmpTime->Day,\r
+ TmpTime->Year,\r
+ TmpTime->Hour,\r
+ TmpTime->Minute\r
+ );\r
+ ArgumentString = ValueBuffer;\r
+ }\r
+ break;\r
+\r
+ case 'r':\r
+ if (BaseListMarker == NULL) {\r
+ Status = VA_ARG (VaListMarker, RETURN_STATUS);\r
+ } else {\r
+ Status = BASE_ARG (BaseListMarker, RETURN_STATUS);\r
+ }\r
+ ArgumentString = ValueBuffer;\r
+ if (RETURN_ERROR (Status)) {\r
+ //\r
+ // Clear error bit\r
+ //\r
+ Index = Status & ~MAX_BIT;\r
+ if (Index > 0 && Index <= ERROR_STATUS_NUMBER) {\r
+ ArgumentString = mStatusString [Index + WARNING_STATUS_NUMBER];\r
+ }\r
+ } else {\r
+ Index = Status;\r
+ if (Index <= WARNING_STATUS_NUMBER) {\r
+ ArgumentString = mStatusString [Index];\r
+ }\r
+ }\r
+ if (ArgumentString == ValueBuffer) {\r
+ InternalPrintLibSPrint ((CHAR8 *) ValueBuffer, MAXIMUM_VALUE_CHARACTERS, 0, "%08X", Status);\r
+ }\r
+ break;\r
+\r
+ case '\r':\r
+ Format += BytesPerFormatCharacter;\r
+ FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ if (FormatCharacter == '\n') {\r
+ //\r
+ // Translate '\r\n' to '\r\n'\r
+ //\r
+ ArgumentString = "\r\n";\r
+ } else {\r
+ //\r
+ // Translate '\r' to '\r'\r
+ //\r
+ ArgumentString = "\r";\r
+ Format -= BytesPerFormatCharacter;\r
+ }\r
+ break;\r
+\r
+ case '\n':\r
+ //\r
+ // Translate '\n' to '\r\n' and '\n\r' to '\r\n'\r
+ //\r
+ ArgumentString = "\r\n";\r
+ Format += BytesPerFormatCharacter;\r
+ FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ if (FormatCharacter != '\r') {\r
+ Format -= BytesPerFormatCharacter;\r
+ }\r
+ break;\r
+\r
+ case '%':\r
+ default:\r
+ //\r
+ // if the type is '%' or unknown, then print it to the screen\r
+ //\r
+ ArgumentString = (CHAR8 *)&FormatCharacter;\r
+ Flags |= ARGUMENT_UNICODE;\r
+ break;\r
+ }\r
+ break;\r
+ \r
+ case '\r':\r
+ Format += BytesPerFormatCharacter;\r
+ FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ if (FormatCharacter == '\n') {\r
+ //\r
+ // Translate '\r\n' to '\r\n'\r
+ //\r
+ ArgumentString = "\r\n";\r
+ } else {\r
+ //\r
+ // Translate '\r' to '\r'\r
+ //\r
+ ArgumentString = "\r";\r
+ Format -= BytesPerFormatCharacter;\r
+ }\r
+ break;\r
+\r
+ case '\n':\r
+ //\r
+ // Translate '\n' to '\r\n' and '\n\r' to '\r\n'\r
+ //\r
+ ArgumentString = "\r\n";\r
+ Format += BytesPerFormatCharacter;\r
+ FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ if (FormatCharacter != '\r') {\r
+ Format -= BytesPerFormatCharacter;\r
+ }\r
+ break;\r
+\r
+ default:\r
+ ArgumentString = (CHAR8 *)&FormatCharacter;\r
+ Flags |= ARGUMENT_UNICODE;\r
+ break;\r
+ }\r
+\r
+ //\r
+ // Retrieve the ArgumentString attriubutes\r
+ //\r
+ if ((Flags & ARGUMENT_UNICODE) != 0) {\r
+ ArgumentMask = 0xffff;\r
+ BytesPerArgumentCharacter = 2;\r
+ } else {\r
+ ArgumentMask = 0xff;\r
+ BytesPerArgumentCharacter = 1;\r
+ }\r
+ if ((Flags & ARGUMENT_REVERSED) != 0) {\r
+ BytesPerArgumentCharacter = -BytesPerArgumentCharacter;\r
+ } else {\r
+ //\r
+ // Compute the number of characters in ArgumentString and store it in Count\r
+ // ArgumentString is either null-terminated, or it contains Precision characters\r
+ //\r
+ for (Count = 0; Count < Precision || ((Flags & PRECISION) == 0); Count++) {\r
+ ArgumentCharacter = ((ArgumentString[Count * BytesPerArgumentCharacter] & 0xff) | ((ArgumentString[Count * BytesPerArgumentCharacter + 1]) << 8)) & ArgumentMask;\r
+ if (ArgumentCharacter == 0) {\r
+ break;\r
+ }\r
+ }\r
+ }\r
+\r
+ if (Precision < Count) {\r
+ Precision = Count;\r
+ }\r
+\r
+ //\r
+ // Pad before the string\r
+ //\r
+ if ((Flags & (PAD_TO_WIDTH | LEFT_JUSTIFY)) == (PAD_TO_WIDTH)) {\r
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += ((Width - Precision) * BytesPerOutputCharacter);\r
+ } else {\r
+// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
+ }\r
+ }\r
+\r
+ if (ZeroPad) {\r
+ if (Prefix != 0) {\r
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += (1 * BytesPerOutputCharacter);\r
+ } else {\r
+// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
+ }\r
+ }\r
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += ((Precision - Count) * BytesPerOutputCharacter);\r
+ } else {\r
+// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Precision - Count, '0', BytesPerOutputCharacter);\r
+ }\r
+ } else {\r
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += ((Precision - Count) * BytesPerOutputCharacter);\r
+ } else {\r
+// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Precision - Count, ' ', BytesPerOutputCharacter);\r
+ }\r
+ if (Prefix != 0) {\r
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += (1 * BytesPerOutputCharacter);\r
+ } else {\r
+// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
+ }\r
+ }\r
+ }\r
+\r
+ //\r
+ // Output the Prefix character if it is present\r
+ //\r
+ Index = 0;\r
+ if (Prefix != 0) {\r
+ Index++;\r
+ }\r
+\r
+ //\r
+ // Copy the string into the output buffer performing the required type conversions\r
+ //\r
+ while (Index < Count) {\r
+ ArgumentCharacter = ((*ArgumentString & 0xff) | (*(ArgumentString + 1) << 8)) & ArgumentMask;\r
+\r
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += (1 * BytesPerOutputCharacter);\r
+ } else {\r
+// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ArgumentCharacter, BytesPerOutputCharacter);\r
+ }\r
+ ArgumentString += BytesPerArgumentCharacter;\r
+ Index++;\r
+ if (Comma) {\r
+ Digits++;\r
+ if (Digits == 3) {\r
+ Digits = 0;\r
+ Index++;\r
+ if (Index < Count) {\r
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += (1 * BytesPerOutputCharacter);\r
+ } else {\r
+// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ',', BytesPerOutputCharacter);\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+\r
+ //\r
+ // Pad after the string\r
+ //\r
+ if ((Flags & (PAD_TO_WIDTH | LEFT_JUSTIFY)) == (PAD_TO_WIDTH | LEFT_JUSTIFY)) {\r
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += ((Width - Precision) * BytesPerOutputCharacter);\r
+ } else {\r
+// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
+ }\r
+ }\r
+\r
+ //\r
+ // Get the next character from the format string\r
+ //\r
+ Format += BytesPerFormatCharacter;\r
+\r
+ //\r
+ // Get the next character from the format string\r
+ //\r
+ FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ }\r
+\r
+ return (LengthToReturn / BytesPerOutputCharacter);\r
+}\r
+\r
+/**\r
+ Returns the number of characters that would be produced by if the formatted \r
+ output were produced not including the Null-terminator.\r
+\r
+ If FormatString is NULL, then ASSERT().\r
+ If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ @param[in] FormatString A Null-terminated Unicode format string.\r
+ @param[in] Marker VA_LIST marker for the variable argument list.\r
+\r
+ @return The number of characters that would be produced, not including the \r
+ Null-terminator.\r
+**/\r
+UINTN\r
+EFIAPI\r
+SPrintLength (\r
+ IN CONST CHAR16 *FormatString,\r
+ IN VA_LIST Marker\r
+ )\r
+{\r
+ ASSERT(FormatString != NULL);\r
+ return InternalPrintLibSPrintMarker (NULL, 0, FORMAT_UNICODE | OUTPUT_UNICODE | COUNT_ONLY_NO_PRINT, (CHAR8 *)FormatString, Marker, NULL);\r
+}\r
+\r
+/**\r
+ Returns the number of characters that would be produced by if the formatted \r
+ output were produced not including the Null-terminator.\r
+\r
+ If FormatString is NULL, then ASSERT().\r
+\r
+ @param[in] FormatString A Null-terminated ASCII format string.\r
+ @param[in] Marker VA_LIST marker for the variable argument list.\r
+\r
+ @return The number of characters that would be produced, not including the \r
+ Null-terminator.\r
+**/\r
+UINTN\r
+EFIAPI\r
+SPrintLengthAsciiFormat (\r
+ IN CONST CHAR8 *FormatString,\r
+ IN VA_LIST Marker\r
+ )\r
+{\r
+ ASSERT(FormatString != NULL);\r
+ return InternalPrintLibSPrintMarker (NULL, 0, OUTPUT_UNICODE | COUNT_ONLY_NO_PRINT, (CHAR8 *)FormatString, Marker, NULL);\r
+}\r
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 The character buffer to print the results of the parsing\r
- of Format into.\r
- @param BufferSize The 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 A 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
+ 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
CHAR8 *OriginalBuffer;\r
CHAR8 *EndBuffer;\r
CHAR8 ValueBuffer[MAXIMUM_VALUE_CHARACTERS];\r
- UINTN BytesPerOutputCharacter;\r
+ UINT32 BytesPerOutputCharacter;\r
UINTN BytesPerFormatCharacter;\r
UINTN FormatMask;\r
UINTN FormatCharacter;\r
UINT32 GuidData1;\r
UINT16 GuidData2;\r
UINT16 GuidData3;\r
+ UINT32 LengthToReturn;\r
\r
- if (BufferSize == 0) {\r
- return 0;\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 (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
//\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
// 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
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += ((Width - Precision) * BytesPerOutputCharacter);\r
+ } else {\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
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += (1 * BytesPerOutputCharacter);\r
+ } else {\r
+ Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
+ }\r
+ }\r
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += ((Precision - Count) * BytesPerOutputCharacter);\r
+ } else {\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
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += ((Precision - Count) * BytesPerOutputCharacter);\r
+ } else {\r
+ Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Precision - Count, ' ', BytesPerOutputCharacter);\r
+ }\r
if (Prefix != 0) {\r
- Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += (1 * BytesPerOutputCharacter);\r
+ } else {\r
+ Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
+ }\r
}\r
}\r
\r
while (Index < Count) {\r
ArgumentCharacter = ((*ArgumentString & 0xff) | (*(ArgumentString + 1) << 8)) & ArgumentMask;\r
\r
- Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ArgumentCharacter, BytesPerOutputCharacter);\r
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += (1 * BytesPerOutputCharacter);\r
+ } else {\r
+ Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ArgumentCharacter, BytesPerOutputCharacter);\r
+ }\r
ArgumentString += BytesPerArgumentCharacter;\r
Index++;\r
if (Comma) {\r
Digits = 0;\r
Index++;\r
if (Index < Count) {\r
- Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ',', BytesPerOutputCharacter);\r
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += (1 * BytesPerOutputCharacter);\r
+ } else {\r
+ Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ',', BytesPerOutputCharacter);\r
+ }\r
}\r
}\r
}\r
// 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
+ if (Flags & COUNT_ONLY_NO_PRINT) {\r
+ LengthToReturn += ((Width - Precision) * BytesPerOutputCharacter);\r
+ } else {\r
+ Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
+ }\r
}\r
\r
//\r
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
projects / mirror_edk2.git / commitdiff