/** @file\r
- Print Library.\r
+ Base Print Library instance implementation.\r
\r
- Copyright (c) 2006, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials\r
+ Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
+ Portions copyright (c) 2008 - 2009, Apple Inc. 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
\r
- Module Name: PrintLib.c\r
-\r
**/\r
\r
#include "PrintLibInternal.h"\r
\r
-typedef struct {\r
- RETURN_STATUS Status;\r
- CHAR8 *String;\r
-} STATUS_LOOKUP_TABLE_ENTRY;\r
-\r
-static CONST STATUS_LOOKUP_TABLE_ENTRY StatusString[] = {\r
- { RETURN_SUCCESS, "Success" },\r
- { RETURN_LOAD_ERROR, "Load Error" },\r
- { RETURN_INVALID_PARAMETER, "Invalid Parameter" },\r
- { RETURN_UNSUPPORTED, "Unsupported" },\r
- { RETURN_BAD_BUFFER_SIZE, "Bad Buffer Size" },\r
- { RETURN_BUFFER_TOO_SMALL, "Buffer Too Small" },\r
- { RETURN_NOT_READY, "Not Ready" },\r
- { RETURN_DEVICE_ERROR, "Device Error" },\r
- { RETURN_WRITE_PROTECTED, "Write Protected" },\r
- { RETURN_OUT_OF_RESOURCES, "Out of Resources" },\r
- { RETURN_VOLUME_CORRUPTED, "Volume Corrupt" },\r
- { RETURN_VOLUME_FULL, "Volume Full" },\r
- { RETURN_NO_MEDIA, "No Media" },\r
- { RETURN_MEDIA_CHANGED, "Media changed" },\r
- { RETURN_NOT_FOUND, "Not Found" },\r
- { RETURN_ACCESS_DENIED, "Access Denied" },\r
- { RETURN_NO_RESPONSE, "No Response" },\r
- { RETURN_NO_MAPPING, "No mapping" },\r
- { RETURN_TIMEOUT, "Time out" },\r
- { RETURN_NOT_STARTED, "Not started" },\r
- { RETURN_ALREADY_STARTED, "Already started" },\r
- { RETURN_ABORTED, "Aborted" },\r
- { RETURN_ICMP_ERROR, "ICMP Error" },\r
- { RETURN_TFTP_ERROR, "TFTP Error" },\r
- { RETURN_PROTOCOL_ERROR, "Protocol Error" },\r
- { RETURN_WARN_UNKNOWN_GLYPH, "Warning Unknown Glyph" },\r
- { RETURN_WARN_DELETE_FAILURE, "Warning Delete Failure" },\r
- { RETURN_WARN_WRITE_FAILURE, "Warning Write Failure" },\r
- { RETURN_WARN_BUFFER_TOO_SMALL, "Warning Buffer Too Small" },\r
- { 0, NULL }\r
-};\r
+//\r
+// Declare a VA_LIST global variable that is used in calls to BasePrintLibSPrintMarker()\r
+// when the BASE_LIST parameter is valid and the VA_LIST parameter is ignored. \r
+// A NULL VA_LIST can not be passed into BasePrintLibSPrintMarker() because some \r
+// compilers define VA_LIST to be a structure.\r
+//\r
+VA_LIST gNullVaList;\r
\r
+#define ASSERT_UNICODE_BUFFER(Buffer) ASSERT ((((UINTN) (Buffer)) & 0x01) == 0)\r
\r
/**\r
- VSPrint function to process format and place the results in Buffer. Since a \r
- VA_LIST is used this rountine allows the nesting of Vararg routines. Thus \r
- this is the main print working routine\r
-\r
- @param StartOfBuffer Unicode buffer to print the results of the parsing of Format into.\r
- \r
- @param BufferSize Maximum number of characters to put into buffer. Zero means\r
- no limit.\r
- \r
- @param Flags Intial flags value. Can only have FORMAT_UNICODE and OUTPUT_UNICODE set\r
- \r
- @param FormatString Unicode format string see file header for more details.\r
- \r
- @param Marker Vararg list consumed by processing Format.\r
-\r
- @return Number of characters printed.\r
+ Produces a Null-terminated Unicode string in an output buffer based on\r
+ a Null-terminated Unicode format string and a VA_LIST argument list.\r
+\r
+ This function is similar as vsnprintf_s defined in C11.\r
+\r
+ Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The Unicode string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list specified by Marker based on the\r
+ contents of the format string.\r
+ The number of Unicode characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+\r
+ If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+ If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+ (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+ buffer is unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
+ Unicode string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString A Null-terminated Unicode format string.\r
+ @param Marker VA_LIST marker for the variable argument list.\r
+\r
+ @return The number of Unicode characters in the produced output buffer not including the\r
+ Null-terminator.\r
\r
**/\r
UINTN\r
-BasePrintLibVSPrint (\r
- OUT CHAR8 *Buffer,\r
- IN UINTN BufferSize,\r
- IN UINTN Flags,\r
- IN CONST CHAR8 *Format,\r
- IN VA_LIST Marker\r
+EFIAPI\r
+UnicodeVSPrint (\r
+ OUT CHAR16 *StartOfBuffer,\r
+ IN UINTN BufferSize,\r
+ IN CONST CHAR16 *FormatString,\r
+ IN VA_LIST Marker\r
)\r
{\r
- CHAR8 *OriginalBuffer;\r
- CHAR8 ValueBuffer[MAXIMUM_VALUE_CHARACTERS];\r
- UINTN BytesPerOutputCharacter;\r
- UINTN BytesPerFormatCharacter;\r
- UINTN FormatMask;\r
- UINTN FormatCharacter;\r
- UINTN Width;\r
- UINTN Precision;\r
- INT64 Value;\r
- 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
-\r
- OriginalBuffer = Buffer;\r
-\r
- if ((Flags & OUTPUT_UNICODE) != 0) {\r
- BytesPerOutputCharacter = 2;\r
- } else {\r
- BytesPerOutputCharacter = 1;\r
- }\r
- if ((Flags & FORMAT_UNICODE) != 0) {\r
- BytesPerFormatCharacter = 2;\r
- FormatMask = 0xffff;\r
- } else {\r
- BytesPerFormatCharacter = 1;\r
- FormatMask = 0xff;\r
- }\r
-\r
- //\r
- // Reserve space for the Null terminator.\r
- // If BufferSize is 0, this will set BufferSize to the max unsigned value\r
- //\r
- BufferSize--;\r
-\r
- //\r
- // Get the first character from the format string\r
- //\r
- FormatCharacter = (*Format | (*(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 && BufferSize > 0) {\r
- //\r
- // Clear all the flag bits except those that may have been passed in\r
- //\r
- Flags &= (OUTPUT_UNICODE | FORMAT_UNICODE);\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 | (*(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
- Width = VA_ARG (Marker, UINTN);\r
- } else {\r
- Precision = VA_ARG (Marker, UINTN);\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 | (*(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
- default:\r
- Done = TRUE;\r
- break;\r
- }\r
- } \r
-\r
- //\r
- // Limit the maximum field width to the remaining characters in the output buffer\r
- //\r
- if (Width > BufferSize) {\r
- Width = BufferSize;\r
- }\r
-\r
- //\r
- // Handle each argument type\r
- //\r
- switch (FormatCharacter) {\r
- case 'X':\r
- Flags |= PREFIX_ZERO;\r
- //\r
- // break skiped on purpose\r
- //\r
- case 'x':\r
- Flags |= RADIX_HEX;\r
- //\r
- // break skiped on purpose\r
- //\r
- case 'd':\r
- if ((Flags & LONG_TYPE) == 0) {\r
- Value = (VA_ARG (Marker, INTN));\r
- } else {\r
- Value = VA_ARG (Marker, INT64);\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
- Value = (UINTN)Value;\r
- }\r
- }\r
- //\r
- // Convert Value to a reversed string\r
- //\r
- Count = BasePrintLibValueToString (ValueBuffer, Value, Radix);\r
- if (Value == 0 && Precision == 0) {\r
- Count = 0;\r
- }\r
- ArgumentString = (CHAR8 *)ValueBuffer + Count;\r
- Digits = 3 - (Count % 3);\r
- if (Comma && Count != 0) {\r
- Count += ((Count - 1) / 3);\r
- }\r
- if (Prefix != 0) {\r
- Count++;\r
- }\r
- Flags |= ARGUMENT_REVERSED;\r
- ZeroPad = TRUE;\r
- if ((Flags & PREFIX_ZERO) != 0) {\r
- if ((Flags & PAD_TO_WIDTH) != 0) {\r
- if ((Flags & PRECISION) == 0) {\r
- Precision = Width;\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
- ArgumentString = (CHAR8 *)VA_ARG (Marker, CHAR8 *);\r
- if (ArgumentString == NULL) {\r
- Flags &= (~ARGUMENT_UNICODE);\r
- ArgumentString = "<null string>";\r
- }\r
- break;\r
-\r
- case 'c':\r
- Character = VA_ARG (Marker, UINTN) & 0xffff;\r
- ArgumentString = (CHAR8 *)&Character;\r
- Flags |= ARGUMENT_UNICODE;\r
- break;\r
-\r
- case 'g':\r
- TmpGuid = VA_ARG (Marker, GUID *);\r
- if (TmpGuid == NULL) {\r
- ArgumentString = "<null guid>";\r
- } else {\r
- BasePrintLibSPrint (\r
- ValueBuffer,\r
- 0, \r
- 0,\r
- "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",\r
- TmpGuid->Data1, \r
- TmpGuid->Data2,\r
- TmpGuid->Data3,\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
- TmpTime = VA_ARG (Marker, TIME *); \r
- if (TmpTime == NULL) {\r
- ArgumentString = "<null time>";\r
- } else {\r
- BasePrintLibSPrint (\r
- ValueBuffer,\r
- 0,\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
- Status = VA_ARG (Marker, RETURN_STATUS);\r
- ArgumentString = ValueBuffer;\r
- for (Index = 0; StatusString[Index].String != NULL; Index++) {\r
- if (Status == StatusString[Index].Status) {\r
- ArgumentString = StatusString[Index].String;\r
- }\r
- }\r
- if (ArgumentString == ValueBuffer) {\r
- BasePrintLibSPrint ((CHAR8 *) ValueBuffer, 0, 0, "%08X", Status);\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
- case '\n':\r
- ArgumentString = "\r\n";\r
- break;\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
- //\r
- // Limit the length of the string to append to the remaining characters in the output buffer\r
- //\r
- if (Count > BufferSize) {\r
- Count = BufferSize;\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
- Buffer = BasePrintLibFillBuffer (Buffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
- }\r
-\r
- if (ZeroPad) {\r
- if (Prefix != 0) {\r
- Buffer = BasePrintLibFillBuffer (Buffer, 1, Prefix, BytesPerOutputCharacter);\r
- }\r
- Buffer = BasePrintLibFillBuffer (Buffer, Precision - Count, '0', BytesPerOutputCharacter);\r
- } else {\r
- Buffer = BasePrintLibFillBuffer (Buffer, Precision - Count, ' ', BytesPerOutputCharacter);\r
- if (Prefix != 0) {\r
- Buffer = BasePrintLibFillBuffer (Buffer, 1, Prefix, BytesPerOutputCharacter);\r
- }\r
- }\r
-\r
- //\r
- // Output the Prefix character if it is present\r
- //\r
- Index = 0;\r
- if (Prefix) {\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
- Buffer = BasePrintLibFillBuffer (Buffer, 1, ArgumentCharacter, BytesPerOutputCharacter);\r
- ArgumentString += BytesPerArgumentCharacter;\r
- Index++;\r
- if (Comma) {\r
- Digits++;\r
- if (Digits == 3) {\r
- Digits = 0;\r
- Index++;\r
- if (Index < Count) {\r
- Buffer = BasePrintLibFillBuffer (Buffer, 1, ',', BytesPerOutputCharacter);\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
- Buffer = BasePrintLibFillBuffer (Buffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
- }\r
-\r
- //\r
- // Reduce the number of characters\r
- //\r
- BufferSize -= Count;\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 | (*(Format + 1) << 8)) & FormatMask;\r
- }\r
-\r
- //\r
- // Null terminate the Unicode or ASCII string\r
- //\r
- Buffer = BasePrintLibFillBuffer (Buffer, 1, 0, BytesPerOutputCharacter);\r
- \r
- return ((Buffer - OriginalBuffer) / BytesPerOutputCharacter);\r
+ ASSERT_UNICODE_BUFFER (StartOfBuffer);\r
+ ASSERT_UNICODE_BUFFER (FormatString);\r
+ return BasePrintLibSPrintMarker ((CHAR8 *)StartOfBuffer, BufferSize >> 1, FORMAT_UNICODE | OUTPUT_UNICODE, (CHAR8 *)FormatString, Marker, NULL);\r
}\r
\r
-UINTN\r
-BasePrintLibSPrint (\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 BasePrintLibVSPrint (StartOfBuffer, BufferSize, Flags, FormatString, Marker);\r
-}\r
+/**\r
+ Produces a Null-terminated Unicode string in an output buffer based on\r
+ a Null-terminated Unicode format string and a BASE_LIST argument list.\r
+\r
+ Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The Unicode string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list specified by Marker based on the\r
+ contents of the format string.\r
+ The number of Unicode characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+\r
+ If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+ If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+ (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+ buffer is unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
+ Unicode string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString A Null-terminated Unicode format string.\r
+ @param Marker BASE_LIST marker for the variable argument list.\r
+\r
+ @return The number of Unicode characters in the produced output buffer not including the\r
+ Null-terminator.\r
\r
+**/\r
UINTN\r
EFIAPI\r
-UnicodeVSPrint (\r
+UnicodeBSPrint (\r
OUT CHAR16 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR16 *FormatString,\r
- IN VA_LIST Marker\r
+ IN BASE_LIST Marker\r
)\r
{\r
- return BasePrintLibVSPrint ((CHAR8 *)StartOfBuffer, BufferSize >> 1, FORMAT_UNICODE | OUTPUT_UNICODE, (CHAR8 *)FormatString, Marker);\r
+ ASSERT_UNICODE_BUFFER (StartOfBuffer);\r
+ ASSERT_UNICODE_BUFFER (FormatString);\r
+ return BasePrintLibSPrintMarker ((CHAR8 *)StartOfBuffer, BufferSize >> 1, FORMAT_UNICODE | OUTPUT_UNICODE, (CHAR8 *)FormatString, gNullVaList, Marker);\r
}\r
\r
+/**\r
+ Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
+ Unicode format string and variable argument list.\r
+\r
+ This function is similar as snprintf_s defined in C11.\r
+\r
+ Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The Unicode string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list based on the contents of the format string.\r
+ The number of Unicode characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+\r
+ If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+ If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+ (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+ buffer is unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
+ Unicode string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString A Null-terminated Unicode format string.\r
+ @param ... Variable argument list whose contents are accessed based on the\r
+ format string specified by FormatString.\r
+\r
+ @return The number of Unicode characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
UINTN\r
EFIAPI\r
UnicodeSPrint (\r
)\r
{\r
VA_LIST Marker;\r
+ UINTN NumberOfPrinted;\r
\r
VA_START (Marker, FormatString);\r
- return UnicodeVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ NumberOfPrinted = UnicodeVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ VA_END (Marker);\r
+ return NumberOfPrinted;\r
}\r
\r
+/**\r
+ Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
+ ASCII format string and a VA_LIST argument list.\r
+\r
+ This function is similar as vsnprintf_s defined in C11.\r
+\r
+ Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The Unicode string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list specified by Marker based on the\r
+ contents of the format string.\r
+ The number of Unicode characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+\r
+ If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+ (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+ buffer is unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
+ Unicode string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString A Null-terminated ASCII format string.\r
+ @param Marker VA_LIST marker for the variable argument list.\r
+\r
+ @return The number of Unicode characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
UINTN\r
EFIAPI\r
UnicodeVSPrintAsciiFormat (\r
IN VA_LIST Marker\r
)\r
{\r
- return BasePrintLibVSPrint ((CHAR8 *)StartOfBuffer, BufferSize >> 1, OUTPUT_UNICODE,FormatString, Marker);\r
+ ASSERT_UNICODE_BUFFER (StartOfBuffer);\r
+ return BasePrintLibSPrintMarker ((CHAR8 *)StartOfBuffer, BufferSize >> 1, OUTPUT_UNICODE, FormatString, Marker, NULL);\r
}\r
\r
+/**\r
+ Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
+ ASCII format string and a BASE_LIST argument list.\r
+\r
+ Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The Unicode string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list specified by Marker based on the\r
+ contents of the format string.\r
+ The number of Unicode characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+\r
+ If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+ (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+ buffer is unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
+ Unicode string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString A Null-terminated ASCII format string.\r
+ @param Marker BASE_LIST marker for the variable argument list.\r
+\r
+ @return The number of Unicode characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+UnicodeBSPrintAsciiFormat (\r
+ OUT CHAR16 *StartOfBuffer,\r
+ IN UINTN BufferSize,\r
+ IN CONST CHAR8 *FormatString,\r
+ IN BASE_LIST Marker\r
+ )\r
+{\r
+ ASSERT_UNICODE_BUFFER (StartOfBuffer);\r
+ return BasePrintLibSPrintMarker ((CHAR8 *)StartOfBuffer, BufferSize >> 1, OUTPUT_UNICODE, FormatString, gNullVaList, Marker);\r
+}\r
+\r
+/**\r
+ Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
+ ASCII format string and variable argument list.\r
+\r
+ This function is similar as snprintf_s defined in C11.\r
+\r
+ Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The Unicode string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list based on the contents of the\r
+ format string.\r
+ The number of Unicode characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+\r
+ If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+ (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+ buffer is unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
+ Unicode string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString A Null-terminated ASCII format string.\r
+ @param ... Variable argument list whose contents are accessed based on the\r
+ format string specified by FormatString.\r
+\r
+ @return The number of Unicode characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
UINTN\r
EFIAPI\r
UnicodeSPrintAsciiFormat (\r
)\r
{\r
VA_LIST Marker;\r
+ UINTN NumberOfPrinted;\r
\r
VA_START (Marker, FormatString);\r
- return UnicodeVSPrintAsciiFormat (StartOfBuffer, BufferSize >> 1, FormatString, Marker);\r
+ NumberOfPrinted = UnicodeVSPrintAsciiFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ VA_END (Marker);\r
+ return NumberOfPrinted;\r
+}\r
+\r
+/**\r
+ Converts a decimal value to a Null-terminated Unicode string.\r
+ \r
+ Converts the decimal number specified by Value to a Null-terminated Unicode \r
+ string specified by Buffer containing at most Width characters. No padding of spaces \r
+ is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
+ The number of Unicode characters in Buffer is returned not including the Null-terminator.\r
+ If the conversion contains more than Width characters, then only the first\r
+ Width characters are returned, and the total number of characters \r
+ required to perform the conversion is returned.\r
+ Additional conversion parameters are specified in Flags. \r
+ \r
+ The Flags bit LEFT_JUSTIFY is always ignored.\r
+ All conversions are left justified in Buffer.\r
+ If Width is 0, PREFIX_ZERO is ignored in Flags.\r
+ If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r
+ are inserted every 3rd digit starting from the right.\r
+ If RADIX_HEX is set in Flags, then the output buffer will be \r
+ formatted in hexadecimal format.\r
+ If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in Buffer is a '-'.\r
+ If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r
+ then Buffer is padded with '0' characters so the combination of the optional '-' \r
+ sign character, '0' characters, digit characters for Value, and the Null-terminator\r
+ add up to Width characters.\r
+ If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().\r
+ If Buffer is NULL, then ASSERT().\r
+ If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
+ If unsupported bits are set in Flags, then ASSERT().\r
+ If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().\r
+ If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
+\r
+ @param Buffer The pointer to the output buffer for the produced Null-terminated\r
+ Unicode string.\r
+ @param Flags The bitmask of flags that specify left justification, zero pad, and commas.\r
+ @param Value The 64-bit signed value to convert to a string.\r
+ @param Width The maximum number of Unicode characters to place in Buffer, not including\r
+ the Null-terminator.\r
+ \r
+ @return The number of Unicode characters in Buffer not including the Null-terminator.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+UnicodeValueToString (\r
+ IN OUT CHAR16 *Buffer,\r
+ IN UINTN Flags,\r
+ IN INT64 Value,\r
+ IN UINTN Width\r
+ )\r
+{\r
+ ASSERT_UNICODE_BUFFER(Buffer);\r
+ return BasePrintLibConvertValueToString ((CHAR8 *)Buffer, Flags, Value, Width, 2);\r
}\r
\r
+/**\r
+ Converts a decimal value to a Null-terminated Unicode string.\r
+\r
+ Converts the decimal number specified by Value to a Null-terminated Unicode\r
+ string specified by Buffer containing at most Width characters. No padding of\r
+ spaces is ever performed. If Width is 0 then a width of\r
+ MAXIMUM_VALUE_CHARACTERS is assumed. If the conversion contains more than\r
+ Width characters, then only the first Width characters are placed in Buffer.\r
+ Additional conversion parameters are specified in Flags.\r
+\r
+ The Flags bit LEFT_JUSTIFY is always ignored.\r
+ All conversions are left justified in Buffer.\r
+ If Width is 0, PREFIX_ZERO is ignored in Flags.\r
+ If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and\r
+ commas are inserted every 3rd digit starting from the right.\r
+ If RADIX_HEX is set in Flags, then the output buffer will be formatted in\r
+ hexadecimal format.\r
+ If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in\r
+ Buffer is a '-'.\r
+ If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, then\r
+ Buffer is padded with '0' characters so the combination of the optional '-'\r
+ sign character, '0' characters, digit characters for Value, and the\r
+ Null-terminator add up to Width characters.\r
+\r
+ If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
+ If an error would be returned, then the function will also ASSERT().\r
+\r
+ @param Buffer The pointer to the output buffer for the produced\r
+ Null-terminated Unicode string.\r
+ @param BufferSize The size of Buffer in bytes, including the\r
+ Null-terminator.\r
+ @param Flags The bitmask of flags that specify left justification,\r
+ zero pad, and commas.\r
+ @param Value The 64-bit signed value to convert to a string.\r
+ @param Width The maximum number of Unicode characters to place in\r
+ Buffer, not including the Null-terminator.\r
+\r
+ @retval RETURN_SUCCESS The decimal value is converted.\r
+ @retval RETURN_BUFFER_TOO_SMALL If BufferSize cannot hold the converted\r
+ value.\r
+ @retval RETURN_INVALID_PARAMETER If Buffer is NULL.\r
+ If PcdMaximumUnicodeStringLength is not\r
+ zero, and BufferSize is greater than\r
+ (PcdMaximumUnicodeStringLength *\r
+ sizeof (CHAR16) + 1).\r
+ If unsupported bits are set in Flags.\r
+ If both COMMA_TYPE and RADIX_HEX are set in\r
+ Flags.\r
+ If Width >= MAXIMUM_VALUE_CHARACTERS.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+UnicodeValueToStringS (\r
+ IN OUT CHAR16 *Buffer,\r
+ IN UINTN BufferSize,\r
+ IN UINTN Flags,\r
+ IN INT64 Value,\r
+ IN UINTN Width\r
+ )\r
+{\r
+ ASSERT_UNICODE_BUFFER(Buffer);\r
+ return BasePrintLibConvertValueToStringS ((CHAR8 *)Buffer, BufferSize, Flags, Value, Width, 2);\r
+}\r
+\r
+/**\r
+ Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
+ ASCII format string and a VA_LIST argument list.\r
+\r
+ This function is similar as vsnprintf_s defined in C11.\r
+\r
+ Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The ASCII string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list specified by Marker based on\r
+ the contents of the format string.\r
+ The number of ASCII characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+ (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+ is unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
+ ASCII string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString A Null-terminated ASCII format string.\r
+ @param Marker VA_LIST marker for the variable argument list.\r
+\r
+ @return The number of ASCII characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
UINTN\r
EFIAPI\r
AsciiVSPrint (\r
IN VA_LIST Marker\r
)\r
{\r
- return BasePrintLibVSPrint (StartOfBuffer, BufferSize, 0, FormatString, Marker);\r
+ return BasePrintLibSPrintMarker (StartOfBuffer, BufferSize, 0, FormatString, Marker, NULL);\r
}\r
\r
+/**\r
+ Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
+ ASCII format string and a BASE_LIST argument list.\r
+\r
+ Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The ASCII string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list specified by Marker based on\r
+ the contents of the format string.\r
+ The number of ASCII characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+ (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+ is unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
+ ASCII string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString A Null-terminated ASCII format string.\r
+ @param Marker BASE_LIST marker for the variable argument list.\r
+\r
+ @return The number of ASCII characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+AsciiBSPrint (\r
+ OUT CHAR8 *StartOfBuffer,\r
+ IN UINTN BufferSize,\r
+ IN CONST CHAR8 *FormatString,\r
+ IN BASE_LIST Marker\r
+ )\r
+{\r
+ return BasePrintLibSPrintMarker (StartOfBuffer, BufferSize, 0, FormatString, gNullVaList, Marker);\r
+}\r
+\r
+/**\r
+ Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
+ ASCII format string and variable argument list.\r
+\r
+ This function is similar as snprintf_s defined in C11.\r
+\r
+ Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The ASCII string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list based on the contents of the\r
+ format string.\r
+ The number of ASCII characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+ (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+ is unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
+ ASCII string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString A Null-terminated ASCII format string.\r
+ @param ... Variable argument list whose contents are accessed based on the\r
+ format string specified by FormatString.\r
+\r
+ @return The number of ASCII characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
UINTN\r
EFIAPI\r
AsciiSPrint (\r
)\r
{\r
VA_LIST Marker;\r
+ UINTN NumberOfPrinted;\r
\r
VA_START (Marker, FormatString);\r
- return AsciiVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ NumberOfPrinted = AsciiVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ VA_END (Marker);\r
+ return NumberOfPrinted;\r
}\r
\r
+/**\r
+ Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
+ Unicode format string and a VA_LIST argument list.\r
+\r
+ This function is similar as vsnprintf_s defined in C11.\r
+\r
+ Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The ASCII string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list specified by Marker based on\r
+ the contents of the format string.\r
+ The number of ASCII characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+\r
+ If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+ (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+ is unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
+ ASCII string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString A Null-terminated Unicode format string.\r
+ @param Marker VA_LIST marker for the variable argument list.\r
+\r
+ @return The number of ASCII characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
UINTN\r
EFIAPI\r
AsciiVSPrintUnicodeFormat (\r
IN VA_LIST Marker\r
)\r
{\r
- return BasePrintLibVSPrint (StartOfBuffer, BufferSize, FORMAT_UNICODE, (CHAR8 *)FormatString, Marker);\r
+ ASSERT_UNICODE_BUFFER (FormatString);\r
+ return BasePrintLibSPrintMarker (StartOfBuffer, BufferSize, FORMAT_UNICODE, (CHAR8 *)FormatString, Marker, NULL);\r
+}\r
+\r
+/**\r
+ Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
+ Unicode format string and a BASE_LIST argument list.\r
+\r
+ Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The ASCII string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list specified by Marker based on\r
+ the contents of the format string.\r
+ The number of ASCII characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+\r
+ If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+ (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+ is unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
+ ASCII string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString A Null-terminated Unicode format string.\r
+ @param Marker BASE_LIST marker for the variable argument list.\r
+\r
+ @return The number of ASCII characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+AsciiBSPrintUnicodeFormat (\r
+ OUT CHAR8 *StartOfBuffer,\r
+ IN UINTN BufferSize,\r
+ IN CONST CHAR16 *FormatString,\r
+ IN BASE_LIST Marker\r
+ )\r
+{\r
+ ASSERT_UNICODE_BUFFER (FormatString);\r
+ return BasePrintLibSPrintMarker (StartOfBuffer, BufferSize, FORMAT_UNICODE, (CHAR8 *)FormatString, gNullVaList, Marker);\r
}\r
\r
+/**\r
+ Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
+ Unicode format string and variable argument list.\r
+\r
+ This function is similar as snprintf_s defined in C11.\r
+\r
+ Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The ASCII string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list based on the contents of the\r
+ format string.\r
+ The number of ASCII characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+\r
+ If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+ (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+ is unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
+ ASCII string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString A Null-terminated Unicode format string.\r
+ @param ... Variable argument list whose contents are accessed based on the\r
+ format string specified by FormatString.\r
+\r
+ @return The number of ASCII characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
UINTN\r
EFIAPI\r
AsciiSPrintUnicodeFormat (\r
)\r
{\r
VA_LIST Marker;\r
+ UINTN NumberOfPrinted;\r
\r
VA_START (Marker, FormatString);\r
- return AsciiVSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ NumberOfPrinted = AsciiVSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ VA_END (Marker);\r
+ return NumberOfPrinted;\r
+}\r
+\r
+\r
+/**\r
+ Converts a decimal value to a Null-terminated ASCII string.\r
+ \r
+ Converts the decimal number specified by Value to a Null-terminated ASCII string \r
+ specified by Buffer containing at most Width characters. No padding of spaces \r
+ is ever performed.\r
+ If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
+ The number of ASCII characters in Buffer is returned not including the Null-terminator.\r
+ If the conversion contains more than Width characters, then only the first Width\r
+ characters are returned, and the total number of characters required to perform\r
+ the conversion is returned.\r
+ Additional conversion parameters are specified in Flags. \r
+ The Flags bit LEFT_JUSTIFY is always ignored.\r
+ All conversions are left justified in Buffer.\r
+ If Width is 0, PREFIX_ZERO is ignored in Flags.\r
+ If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r
+ are inserted every 3rd digit starting from the right.\r
+ If RADIX_HEX is set in Flags, then the output buffer will be \r
+ formatted in hexadecimal format.\r
+ If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in Buffer is a '-'.\r
+ If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r
+ then Buffer is padded with '0' characters so the combination of the optional '-' \r
+ sign character, '0' characters, digit characters for Value, and the Null-terminator\r
+ add up to Width characters.\r
+ \r
+ If Buffer is NULL, then ASSERT().\r
+ If unsupported bits are set in Flags, then ASSERT().\r
+ If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().\r
+ If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
+\r
+ @param Buffer The pointer to the output buffer for the produced Null-terminated\r
+ ASCII string.\r
+ @param Flags The bitmask of flags that specify left justification, zero pad, and commas.\r
+ @param Value The 64-bit signed value to convert to a string.\r
+ @param Width The maximum number of ASCII characters to place in Buffer, not including\r
+ the Null-terminator.\r
+ \r
+ @return The number of ASCII characters in Buffer not including the Null-terminator.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+AsciiValueToString (\r
+ OUT CHAR8 *Buffer,\r
+ IN UINTN Flags,\r
+ IN INT64 Value,\r
+ IN UINTN Width\r
+ )\r
+{\r
+ return BasePrintLibConvertValueToString (Buffer, Flags, Value, Width, 1);\r
+}\r
+\r
+/**\r
+ Converts a decimal value to a Null-terminated Ascii string.\r
+\r
+ Converts the decimal number specified by Value to a Null-terminated Ascii\r
+ string specified by Buffer containing at most Width characters. No padding of\r
+ spaces is ever performed. If Width is 0 then a width of\r
+ MAXIMUM_VALUE_CHARACTERS is assumed. If the conversion contains more than\r
+ Width characters, then only the first Width characters are placed in Buffer.\r
+ Additional conversion parameters are specified in Flags.\r
+\r
+ The Flags bit LEFT_JUSTIFY is always ignored.\r
+ All conversions are left justified in Buffer.\r
+ If Width is 0, PREFIX_ZERO is ignored in Flags.\r
+ If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and\r
+ commas are inserted every 3rd digit starting from the right.\r
+ If RADIX_HEX is set in Flags, then the output buffer will be formatted in\r
+ hexadecimal format.\r
+ If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in\r
+ Buffer is a '-'.\r
+ If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, then\r
+ Buffer is padded with '0' characters so the combination of the optional '-'\r
+ sign character, '0' characters, digit characters for Value, and the\r
+ Null-terminator add up to Width characters.\r
+\r
+ If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
+ If an error would be returned, then the function will also ASSERT().\r
+\r
+ @param Buffer The pointer to the output buffer for the produced\r
+ Null-terminated Ascii string.\r
+ @param BufferSize The size of Buffer in bytes, including the\r
+ Null-terminator.\r
+ @param Flags The bitmask of flags that specify left justification,\r
+ zero pad, and commas.\r
+ @param Value The 64-bit signed value to convert to a string.\r
+ @param Width The maximum number of Ascii characters to place in\r
+ Buffer, not including the Null-terminator.\r
+\r
+ @retval RETURN_SUCCESS The decimal value is converted.\r
+ @retval RETURN_BUFFER_TOO_SMALL If BufferSize cannot hold the converted\r
+ value.\r
+ @retval RETURN_INVALID_PARAMETER If Buffer is NULL.\r
+ If PcdMaximumAsciiStringLength is not\r
+ zero, and BufferSize is greater than\r
+ PcdMaximumAsciiStringLength.\r
+ If unsupported bits are set in Flags.\r
+ If both COMMA_TYPE and RADIX_HEX are set in\r
+ Flags.\r
+ If Width >= MAXIMUM_VALUE_CHARACTERS.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+AsciiValueToStringS (\r
+ IN OUT CHAR8 *Buffer,\r
+ IN UINTN BufferSize,\r
+ IN UINTN Flags,\r
+ IN INT64 Value,\r
+ IN UINTN Width\r
+ )\r
+{\r
+ return BasePrintLibConvertValueToStringS (Buffer, BufferSize, Flags, Value, Width, 1);\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 not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If FormatString is NULL, then ASSERT() and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more\r
+ than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ Null-terminator, then ASSERT() and 0 is returned.\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_UNICODE_BUFFER (FormatString);\r
+ return BasePrintLibSPrintMarker (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() and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more\r
+ than PcdMaximumAsciiStringLength Ascii characters not including the\r
+ Null-terminator, then ASSERT() and 0 is returned.\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
+ return BasePrintLibSPrintMarker (NULL, 0, OUTPUT_UNICODE | COUNT_ONLY_NO_PRINT, (CHAR8 *)FormatString, Marker, NULL);\r
}\r
projects / mirror_edk2.git / blobdiff