/** @file\r
Base Print Library instance Internal Functions definition.\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation\r
- All rights reserved. This program and the accompanying materials\r
+ Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+ This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
- 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
// Print primitives\r
//\r
-#define PREFIX_SIGN 0x02\r
-#define PREFIX_BLANK 0x04\r
-#define LONG_TYPE 0x10\r
-#define OUTPUT_UNICODE 0x40\r
-#define FORMAT_UNICODE 0x100\r
-#define PAD_TO_WIDTH 0x200\r
-#define ARGUMENT_UNICODE 0x400\r
-#define PRECISION 0x800\r
-#define ARGUMENT_REVERSED 0x1000\r
+#define PREFIX_SIGN BIT1\r
+#define PREFIX_BLANK BIT2\r
+#define LONG_TYPE BIT4\r
+#define OUTPUT_UNICODE BIT6\r
+#define FORMAT_UNICODE BIT8\r
+#define PAD_TO_WIDTH BIT9\r
+#define ARGUMENT_UNICODE BIT10\r
+#define PRECISION BIT11\r
+#define ARGUMENT_REVERSED BIT12\r
+#define COUNT_ONLY_NO_PRINT BIT13\r
\r
//\r
// Record date and time information\r
VA_LIST is used this routine allows the nesting of Vararg routines. Thus \r
this is the main print working routine.\r
\r
- @param Buffer 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 Initial flags value.\r
- Can only have FORMAT_UNICODE and OUTPUT_UNICODE set.\r
- @param Format Null-terminated format string.\r
- @param VaListMarker VA_LIST style variable argument list consumed by processing Format.\r
- @param BaseListMarker BASE_LIST style variable argument list consumed by processing Format.\r
-\r
- @return Number of characters printed not including the Null-terminator.\r
+ If COUNT_ONLY_NO_PRINT is set in Flags, Buffer will not be modified at all.\r
+\r
+ @param[out] Buffer The character buffer to print the results of the \r
+ parsing of Format into.\r
+ @param[in] BufferSize The maximum number of characters to put into \r
+ buffer.\r
+ @param[in] Flags Initial flags value.\r
+ Can only have FORMAT_UNICODE, OUTPUT_UNICODE, \r
+ and COUNT_ONLY_NO_PRINT set.\r
+ @param[in] Format A Null-terminated format string.\r
+ @param[in] VaListMarker VA_LIST style variable argument list consumed by\r
+ processing Format.\r
+ @param[in] BaseListMarker BASE_LIST style variable argument list consumed\r
+ by processing Format.\r
+\r
+ @return The number of characters printed not including the Null-terminator.\r
+ If COUNT_ONLY_NO_PRINT was set returns the same, but without any\r
+ modification to Buffer.\r
\r
**/\r
UINTN\r
VA_LIST is used this routine allows the nesting of Vararg routines. Thus \r
this is the main print working routine\r
\r
- @param StartOfBuffer Character buffer to print the results of the parsing\r
+ @param StartOfBuffer The 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 BufferSize The maximum number of characters to put into buffer.\r
Zero means no limit.\r
@param Flags Initial flags value.\r
Can only have FORMAT_UNICODE and OUTPUT_UNICODE set\r
@param FormatString Null-terminated format string.\r
@param ... The variable argument list.\r
\r
- @return Number of characters printed.\r
+ @return The number of characters printed.\r
\r
**/\r
UINTN\r
+EFIAPI\r
BasePrintLibSPrint (\r
OUT CHAR8 *StartOfBuffer,\r
IN UINTN BufferSize,\r
@param Buffer Buffer to place the Unicode or ASCII string.\r
@param EndBuffer The end of the input Buffer. No characters will be\r
placed after that. \r
- @param Length Count of character to be placed into Buffer.\r
+ @param Length The count of character to be placed into Buffer.\r
(Negative value indicates no buffer fill.)\r
- @param Character Character to be placed into Buffer.\r
- @param Increment Character increment in Buffer.\r
+ @param Character The character to be placed into Buffer.\r
+ @param Increment The character increment in Buffer.\r
\r
@return Buffer Buffer filled with the input Character.\r
\r
Print worker function that converts a decimal or hexadecimal number to an ASCII string in Buffer.\r
\r
@param Buffer Location to place the ASCII string of Value.\r
- @param Value Value to convert to a Decimal or Hexadecimal string in Buffer.\r
+ @param Value The value to convert to a Decimal or Hexadecimal string in Buffer.\r
@param Radix Radix of the value\r
\r
@return A pointer to the end of buffer filled with ASCII string.\r
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
+ @param Buffer The pointer to the output buffer for the produced Null-terminated\r
string.\r
@param Flags The bitmask of flags that specify left justification, zero pad,\r
and commas.\r
projects / mirror_edk2.git / blobdiff