\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
+#define WARNING_STATUS_NUMBER 4\r
+#define ERROR_STATUS_NUMBER 24\r
\r
+STATIC CONST CHAR8 *StatusString [] = {\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 rountine allows the nesting of Vararg routines. Thus \r
- this is the main print working routine\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
+ @param Buffer Character buffer to print the results of the parsing\r
+ of Format into.\r
+ @param BufferSize Maximum number of characters to put into buffer.\r
+ @param Flags Intial flags value.\r
+ Can only have FORMAT_UNICODE and OUTPUT_UNICODE set.\r
+ @param Format Null-terminated format string.\r
+ @param Marker Vararg list consumed by processing Format.\r
\r
- @return Number of characters printed.\r
+ @return Number of characters printed not including the Null-terminator.\r
\r
**/\r
UINTN\r
)\r
{\r
CHAR8 *OriginalBuffer;\r
+ CHAR8 *EndBuffer;\r
CHAR8 ValueBuffer[MAXIMUM_VALUE_CHARACTERS];\r
UINTN BytesPerOutputCharacter;\r
UINTN BytesPerFormatCharacter;\r
UINTN Width;\r
UINTN Precision;\r
INT64 Value;\r
- CHAR8 *ArgumentString;\r
+ CONST CHAR8 *ArgumentString;\r
UINTN Character;\r
GUID *TmpGuid;\r
TIME *TmpTime;\r
UINTN Radix;\r
RETURN_STATUS Status;\r
\r
- OriginalBuffer = Buffer;\r
+ if (BufferSize == 0) {\r
+ return 0;\r
+ }\r
+ ASSERT (Buffer != NULL);\r
\r
if ((Flags & OUTPUT_UNICODE) != 0) {\r
BytesPerOutputCharacter = 2;\r
} else {\r
BytesPerOutputCharacter = 1;\r
}\r
+\r
+ //\r
+ // Reserve space for the Null terminator.\r
+ //\r
+ BufferSize--;\r
+ OriginalBuffer = Buffer;\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
- // 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
//\r
// Get the first character from the format string\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
+ while (FormatCharacter != 0 && Buffer < EndBuffer) {\r
//\r
// Clear all the flag bits except those that may have been passed in\r
//\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
- // 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 '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 skiped on purpose\r
+ // break skipped on purpose\r
//\r
case 'x':\r
Flags |= RADIX_HEX;\r
//\r
- // break skiped on purpose\r
+ // break skipped on purpose\r
//\r
case 'd':\r
if ((Flags & LONG_TYPE) == 0) {\r
- Value = (VA_ARG (Marker, INTN));\r
+ Value = (VA_ARG (Marker, int));\r
} else {\r
Value = VA_ARG (Marker, INT64);\r
}\r
Radix = 16;\r
Comma = FALSE;\r
if ((Flags & LONG_TYPE) == 0 && Value < 0) {\r
- Value = (UINTN)Value;\r
+ Value = (unsigned int)Value;\r
}\r
}\r
//\r
Count = 0;\r
}\r
ArgumentString = (CHAR8 *)ValueBuffer + Count;\r
- Digits = 3 - (Count % 3);\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 & PAD_TO_WIDTH) != 0) {\r
- if ((Flags & PRECISION) == 0) {\r
- Precision = Width;\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
} else {\r
BasePrintLibSPrint (\r
ValueBuffer,\r
- 0, \r
+ MAXIMUM_VALUE_CHARACTERS, \r
0,\r
"%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",\r
TmpGuid->Data1,\r
} else {\r
BasePrintLibSPrint (\r
ValueBuffer,\r
- 0,\r
+ MAXIMUM_VALUE_CHARACTERS,\r
0,\r
"%02d/%02d/%04d %02d:%02d",\r
TmpTime->Month,\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
+ 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 = StatusString [Index + WARNING_STATUS_NUMBER];\r
+ }\r
+ } else {\r
+ Index = Status;\r
+ if (Index <= WARNING_STATUS_NUMBER) {\r
+ ArgumentString = StatusString [Index];\r
}\r
}\r
if (ArgumentString == ValueBuffer) {\r
- BasePrintLibSPrint ((CHAR8 *) ValueBuffer, 0, 0, "%08X", Status);\r
+ BasePrintLibSPrint ((CHAR8 *) ValueBuffer, MAXIMUM_VALUE_CHARACTERS, 0, "%08X", Status);\r
}\r
break;\r
\r
+ case '\n':\r
+ ArgumentString = "\n\r";\r
+ break;\r
+\r
case '%':\r
default:\r
//\r
break;\r
}\r
break;\r
+ \r
case '\n':\r
- ArgumentString = "\r\n";\r
+ ArgumentString = "\n\r";\r
break;\r
+\r
default:\r
ArgumentString = (CHAR8 *)&FormatCharacter;\r
Flags |= ARGUMENT_UNICODE;\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
// Pad before the string\r
//\r
if ((Flags & (PAD_TO_WIDTH | LEFT_JUSTIFY)) == (PAD_TO_WIDTH)) {\r
- Buffer = BasePrintLibFillBuffer (Buffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
+ Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
}\r
\r
if (ZeroPad) {\r
if (Prefix != 0) {\r
- Buffer = BasePrintLibFillBuffer (Buffer, 1, Prefix, BytesPerOutputCharacter);\r
+ Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
}\r
- Buffer = BasePrintLibFillBuffer (Buffer, Precision - Count, '0', BytesPerOutputCharacter);\r
+ Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Precision - Count, '0', BytesPerOutputCharacter);\r
} else {\r
- Buffer = BasePrintLibFillBuffer (Buffer, Precision - Count, ' ', BytesPerOutputCharacter);\r
+ Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Precision - Count, ' ', BytesPerOutputCharacter);\r
if (Prefix != 0) {\r
- Buffer = BasePrintLibFillBuffer (Buffer, 1, Prefix, BytesPerOutputCharacter);\r
+ Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
}\r
}\r
\r
// Output the Prefix character if it is present\r
//\r
Index = 0;\r
- if (Prefix) {\r
+ if (Prefix != 0) {\r
Index++;\r
}\r
\r
while (Index < Count) {\r
ArgumentCharacter = ((*ArgumentString & 0xff) | (*(ArgumentString + 1) << 8)) & ArgumentMask;\r
\r
- Buffer = BasePrintLibFillBuffer (Buffer, 1, ArgumentCharacter, BytesPerOutputCharacter);\r
+ Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ArgumentCharacter, BytesPerOutputCharacter);\r
ArgumentString += BytesPerArgumentCharacter;\r
Index++;\r
if (Comma) {\r
Digits = 0;\r
Index++;\r
if (Index < Count) {\r
- Buffer = BasePrintLibFillBuffer (Buffer, 1, ',', BytesPerOutputCharacter);\r
+ Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ',', BytesPerOutputCharacter);\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
+ Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 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
//\r
// Null terminate the Unicode or ASCII string\r
//\r
- Buffer = BasePrintLibFillBuffer (Buffer, 1, 0, BytesPerOutputCharacter);\r
- \r
+ BasePrintLibFillBuffer (Buffer, EndBuffer + BytesPerOutputCharacter, 1, 0, BytesPerOutputCharacter);\r
+ //\r
+ // Make sure output buffer cannot contain more than PcdMaximumUnicodeStringLength\r
+ // Unicode characters if PcdMaximumUnicodeStringLength is not zero. \r
+ //\r
+ ASSERT ((((Flags & OUTPUT_UNICODE) == 0)) || (StrSize ((CHAR16 *) OriginalBuffer) != 0));\r
+ //\r
+ // Make sure output buffer cannot contain more than PcdMaximumAsciiStringLength\r
+ // ASCII characters if PcdMaximumAsciiStringLength is not zero. \r
+ //\r
+ ASSERT ((((Flags & OUTPUT_UNICODE) != 0)) || (AsciiStrSize (OriginalBuffer) != 0));\r
+\r
return ((Buffer - OriginalBuffer) / BytesPerOutputCharacter);\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 rountine allows the nesting of Vararg routines. Thus \r
+ this is the main print working routine.\r
+\r
+ @param Buffer Character buffer to print the results of the parsing\r
+ of Format into.\r
+ @param BufferSize Maximum number of characters to put into buffer.\r
+ Zero means no limit.\r
+ @param Flags Intial flags value.\r
+ Can only have FORMAT_UNICODE and OUTPUT_UNICODE set\r
+ @param FormatString Null-terminated format string.\r
+\r
+ @return Number of characters printed not including the Null-terminator.\r
+\r
+**/\r
UINTN\r
BasePrintLibSPrint (\r
OUT CHAR8 *StartOfBuffer,\r
return BasePrintLibVSPrint (StartOfBuffer, BufferSize, Flags, FormatString, Marker);\r
}\r
\r
+/**\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
+ 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
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
+ contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ Null-terminator, then ASSERT().\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 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
EFIAPI\r
UnicodeVSPrint (\r
return BasePrintLibVSPrint ((CHAR8 *)StartOfBuffer, BufferSize >> 1, FORMAT_UNICODE | OUTPUT_UNICODE, (CHAR8 *)FormatString, 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
+ 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
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
+ contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ Null-terminator, then ASSERT().\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 Null-terminated Unicode format string.\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
return UnicodeVSPrint (StartOfBuffer, BufferSize, FormatString, 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 a VA_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
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
+ contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ Null-terminator, then ASSERT().\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 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
EFIAPI\r
UnicodeVSPrintAsciiFormat (\r
return BasePrintLibVSPrint ((CHAR8 *)StartOfBuffer, BufferSize >> 1, OUTPUT_UNICODE,FormatString, 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
+ 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
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
+ contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ Null-terminator, then ASSERT().\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 Null-terminated Unicode format string.\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
VA_LIST Marker;\r
\r
VA_START (Marker, FormatString);\r
- return UnicodeVSPrintAsciiFormat (StartOfBuffer, BufferSize >> 1, FormatString, Marker);\r
+ return UnicodeVSPrintAsciiFormat (StartOfBuffer, BufferSize, FormatString, 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 a VA_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
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
+ contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
+ Null-terminator, then ASSERT().\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 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
AsciiVSPrint (\r
return BasePrintLibVSPrint (StartOfBuffer, BufferSize, 0, FormatString, 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
+ 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
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
+ contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
+ Null-terminator, then ASSERT().\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 Null-terminated Unicode format string.\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
return AsciiVSPrint (StartOfBuffer, BufferSize, FormatString, 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 a VA_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
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
+ contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
+ Null-terminator, then ASSERT().\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 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
return BasePrintLibVSPrint (StartOfBuffer, BufferSize, FORMAT_UNICODE, (CHAR8 *)FormatString, 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
+ 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
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
+ contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
+ Null-terminator, then ASSERT().\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 Null-terminated Unicode format string.\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
return AsciiVSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, Marker);\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.\r
+ 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
+ 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 Value is < 0, 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 Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
+\r
+ @param Buffer 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
return BasePrintLibConvertValueToString ((CHAR8 *)Buffer, Flags, Value, Width, 2);\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.\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 Value is < 0, then the fist character in Buffer is a '-'.\r
+ If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, then Buffer\r
+ 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 NULL, then ASSERT().\r
+ If unsupported bits are set in Flags, then ASSERT().\r
+ If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
+\r
+ @param Buffer Pointer to the output buffer for the produced Null-terminated\r
+ 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
projects / mirror_edk2.git / blobdiff