/** @file\r
- Library header file that defines print services\r
-\r
- Copyright (c) 2006 - 2008, Intel Corporation \r
- All rights reserved. This program and the accompanying materials \r
- are licensed and made available under the terms and conditions of the BSD License \r
- which accompanies this distribution. The full text of the license may be found at \r
- 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
+ Provides services to print a formatted string to a buffer. All combinations of\r
+ Unicode and ASCII strings are supported.\r
+\r
+Copyright (c) 2006 - 2009, Intel Corporation\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution. The full text of the license may be found at\r
+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
+ The Print Library functions provide a simple means to produce formatted output \r
+ strings. Many of the output functions use a format string to describe how to \r
+ format the output of variable arguments. The format string consists of normal \r
+ text and argument descriptors. There are no restrictions for how the normal \r
+ text and argument descriptors can be mixed. The following end of line(EOL) \r
+ translations must be performed on the contents of the format string:\r
+ \r
+ - '\\r' is translated to '\\r'\r
+ - '\\r\\n' is translated to '\\r\\n'\r
+ - '\\n' is translated to '\\r\\n' \r
+ - '\\n\\r' is translated to '\\r\\n'\r
+ \r
+ This does not follow the ANSI C standard for sprint(). The format of argument \r
+ descriptors is described below. The ANSI C standard for sprint() has been \r
+ followed for some of the format types, and has not been followed for others. \r
+ The exceptions are noted below.\r
+\r
+ %[flags][width][.precision]type\r
+\r
+ [flags]:\r
+ - - \r
+ - The field is left justified. If not flag is not specified, then the \r
+ field is right justified.\r
+ - space \r
+ - Prefix a space character to a number. Only valid for types X, x, and d.\r
+ - + \r
+ - Prefix a plus character to a number. Only valid for types X, x, and d. \r
+ If both space and + are specified, then space is ignored.\r
+ - 0\r
+ - Pad with 0 characters to the left of a number. Only valid for types \r
+ X, x, and d.\r
+ - ,\r
+ - Place a comma every 3rd digit of the number. Only valid for type d.\r
+ If 0 is also specified, then 0 is ignored.\r
+ - L, l\r
+ - The number being printed is a UINT64. Only valid for types X, x, and d.\r
+ If this flag is not specified, then the number being printed is a int.\r
+ - NOTE: All invalid flags are ignored.\r
+\r
+ [width]:\r
+\r
+ - *\r
+ - The width of the field is specified by a UINTN argument in the \r
+ argument list.\r
+ - number\r
+ - The number specified as a decimal value represents the width of \r
+ the field.\r
+ - NOTE: If [width] is not specified, then a field width of 0 is assumed.\r
+\r
+ [.precision]:\r
+\r
+ - *\r
+ - The precision of the field is specified by a UINTN argument in the \r
+ argument list.\r
+ - number\r
+ - The number specified as a decimal value represents the precision of \r
+ the field.\r
+ - NOTE: If [.precision] is not specified, then a precision of 0 is assumed.\r
+\r
+ type:\r
+\r
+ - %\r
+ - Print a %%.\r
+ - c\r
+ - The argument is a Unicode character. ASCII characters can be printed \r
+ using this type too by making sure bits 8..15 of the argument are set to 0.\r
+ - x\r
+ - The argument is a hexadecimal number. The characters used are 0..9 and \r
+ A..F. If the flag 'L' is not specified, then the argument is assumed \r
+ to be an int. This does not follow ANSI C.\r
+ - X\r
+ - The argument is a hexadecimal number and the number is padded with \r
+ zeros. This is equivalent to a format string of "0x". If the flag \r
+ 'L' is not specified, then the argument is assumed to be an int. \r
+ This does not follow ANSI C.\r
+ - d\r
+ - The argument is a decimal number. If the flag 'L' is not specified, \r
+ then the argument is assumed to be an int. \r
+ - p\r
+ - The argument is a pointer that is a (VOID *), and it is printed as a \r
+ hexadecimal number The characters used are 0..9 and A..F.\r
+ - a\r
+ - The argument is a pointer to an ASCII string. \r
+ This does not follow ANSI C.\r
+ - S, s\r
+ - The argument is a pointer to a Unicode string. \r
+ This does not follow ANSI C.\r
+ - g\r
+ - The argument is a pointer to a GUID structure. The GUID is printed \r
+ in the format XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX. \r
+ This does not follow ANSI C.\r
+ - t\r
+ - The argument is a pointer to an EFI_TIME structure. The time and \r
+ date are printed in the format "mm/dd/yyyy hh:mm" where mm is the \r
+ month zero padded, dd is the day zero padded, yyyy is the year zero \r
+ padded, hh is the hour zero padded, and mm is minutes zero padded. \r
+ This does not follow ANSI C. \r
+ - r\r
+ - The argument is a RETURN_STATUS value. This value is converted to \r
+ a string following the table below. This does not follow ANSI C. \r
+ - RETURN_SUCCESS \r
+ - "Success"\r
+ - RETURN_LOAD_ERROR \r
+ - "Load Error"\r
+ - RETURN_INVALID_PARAMETER \r
+ - "Invalid Parameter"\r
+ - RETURN_UNSUPPORTED \r
+ - "Unsupported"\r
+ - RETURN_BAD_BUFFER_SIZE \r
+ - "Bad Buffer Size"\r
+ - RETURN_BUFFER_TOO_SMALL \r
+ - "Buffer Too Small"\r
+ - RETURN_NOT_READY \r
+ - "Not Ready"\r
+ - RETURN_DEVICE_ERROR \r
+ - "Device Error"\r
+ - RETURN_WRITE_PROTECTED \r
+ - "Write Protected"\r
+ - RETURN_OUT_OF_RESOURCES \r
+ - "Out of Resources"\r
+ - RETURN_VOLUME_CORRUPTED \r
+ - "Volume Corrupt"\r
+ - RETURN_VOLUME_FULL \r
+ - "Volume Full"\r
+ - RETURN_NO_MEDIA \r
+ - "No Media"\r
+ - RETURN_MEDIA_CHANGED \r
+ - "Media changed"\r
+ - RETURN_NOT_FOUND \r
+ - "Not Found"\r
+ - RETURN_ACCESS_DENIED \r
+ - "Access Denied"\r
+ - RETURN_NO_RESPONSE \r
+ - "No Response"\r
+ - RETURN_NO_MAPPING \r
+ - "No mapping"\r
+ - RETURN_TIMEOUT \r
+ - "Time out"\r
+ - RETURN_NOT_STARTED \r
+ - "Not started"\r
+ - RETURN_ALREADY_STARTED \r
+ - "Already started"\r
+ - RETURN_ABORTED \r
+ - "Aborted"\r
+ - RETURN_ICMP_ERROR \r
+ - "ICMP Error"\r
+ - RETURN_TFTP_ERROR \r
+ - "TFTP Error"\r
+ - RETURN_PROTOCOL_ERROR \r
+ - "Protocol Error"\r
+ - RETURN_WARN_UNKNOWN_GLYPH \r
+ - "Warning Unknown Glyph"\r
+ - RETURN_WARN_DELETE_FAILURE \r
+ - "Warning Delete Failure"\r
+ - RETURN_WARN_WRITE_FAILURE \r
+ - "Warning Write Failure"\r
+ - RETURN_WARN_BUFFER_TOO_SMALL \r
+ - "Warning Buffer Too Small"\r
\r
**/\r
\r
\r
///\r
/// Define the maximum number of characters that are required to\r
-/// encode a decimal, hexidecimal, GUID, or TIME value with a NULL \r
+/// encode a decimal, hexadecimal, GUID, or TIME value with a NULL \r
/// terminator.\r
/// \r
/// Maximum Length Decimal String = 28\r
/// "-9,223,372,036,854,775,808"\r
-/// Maximum Length Hexidecimal String = 17\r
+/// Maximum Length Hexadecimal String = 17\r
/// "FFFFFFFFFFFFFFFF"\r
/// Maximum Length GUID = 37\r
/// "00000000-0000-0000-0000-000000000000"\r
IN VA_LIST 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 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
+ 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 StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
+ If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, 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 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
+UnicodeBSPrint (\r
+ OUT CHAR16 *StartOfBuffer,\r
+ IN UINTN BufferSize,\r
+ IN CONST CHAR16 *FormatString,\r
+ IN BASE_LIST 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
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 ... The variable argument list.\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
IN VA_LIST 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 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
+ 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 StartOfBuffer is not aligned on a 16-bit boundary, 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 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
/**\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
Unicode string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
@param FormatString Null-terminated ASCII format string.\r
- @param ... The variable argument list.\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
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 HEX_RADIX is set in Flags, then the output buffer will be \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 HEX_RADIX is not set in Flags, then the fist character in Buffer is a '-'.\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 HEX_RADIX are set in Flags, then ASSERT().\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 HEX_RADIX 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 Pointer to the output buffer for the produced Null-terminated\r
IN VA_LIST 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 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
+ 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 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
/**\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
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
@param FormatString Null-terminated ASCII format string.\r
- @param ... The variable argument list. \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
IN VA_LIST 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 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
+ 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 BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, 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 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
/**\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
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 ... The variable argument list.\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
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 HEX_RADIX is set in Flags, then the output buffer will be \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 HEX_RADIX is not set in Flags, then the fist character in Buffer is a '-'.\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
\r
If Buffer is NULL, then ASSERT().\r
If unsupported bits are set in Flags, then ASSERT().\r
- If both COMMA_TYPE and HEX_RADIX 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 Pointer to the output buffer for the produced Null-terminated\r
UINTN\r
EFIAPI\r
AsciiValueToString (\r
- IN OUT CHAR8 *Buffer,\r
- IN UINTN Flags,\r
- IN INT64 Value,\r
- IN UINTN Width\r
+ OUT CHAR8 *Buffer,\r
+ IN UINTN Flags,\r
+ IN INT64 Value,\r
+ IN UINTN Width\r
);\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff