MdePkg/Library/BasePrintLib/PrintLibInternal.c File Reference


Defines

#define WARNING_STATUS_NUMBER   5
#define ERROR_STATUS_NUMBER   33

Functions

CHAR8BasePrintLibFillBuffer (OUT CHAR8 *Buffer, IN CHAR8 *EndBuffer, IN INTN Length, IN UINTN Character, IN INTN Increment)
CHAR8BasePrintLibValueToString (IN OUT CHAR8 *Buffer, IN INT64 Value, IN UINTN Radix)
UINTN BasePrintLibConvertValueToString (IN OUT CHAR8 *Buffer, IN UINTN Flags, IN INT64 Value, IN UINTN Width, IN UINTN Increment)
UINTN BasePrintLibSPrintMarker (OUT CHAR8 *Buffer, IN UINTN BufferSize, IN UINTN Flags, IN CONST CHAR8 *Format, IN VA_LIST VaListMarker, IN BASE_LIST BaseListMarker)
UINTN EFIAPI BasePrintLibSPrint (OUT CHAR8 *StartOfBuffer, IN UINTN BufferSize, IN UINTN Flags, IN CONST CHAR8 *FormatString,...)

Variables

GLOBAL_REMOVE_IF_UNREFERENCED
CONST CHAR8 
mHexStr [] = {'0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'}
GLOBAL_REMOVE_IF_UNREFERENCED
CONST CHAR8 *CONST 
mStatusString []

Detailed Description

Print Library internal worker functions.

Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define ERROR_STATUS_NUMBER   33

#define WARNING_STATUS_NUMBER   5


Function Documentation

UINTN BasePrintLibConvertValueToString ( IN OUT CHAR8 Buffer,
IN UINTN  Flags,
IN INT64  Value,
IN UINTN  Width,
IN UINTN  Increment 
)

Internal function that converts a decimal value to a Null-terminated string.

Converts the decimal number specified by Value to a Null-terminated string specified by Buffer containing at most Width characters. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed. The total number of characters placed in Buffer is returned. If the conversion contains more than Width characters, then only the first Width characters are returned, and the total number of characters required to perform the conversion is returned. Additional conversion parameters are specified in Flags. The Flags bit LEFT_JUSTIFY is always ignored. All conversions are left justified in Buffer. If Width is 0, PREFIX_ZERO is ignored in Flags. If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas are inserted every 3rd digit starting from the right. If Value is < 0, then the fist character in Buffer is a '-'. If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, then Buffer is padded with '0' characters so the combination of the optional '-' sign character, '0' characters, digit characters for Value, and the Null-terminator add up to Width characters.

If Buffer is NULL, then ASSERT(). If unsupported bits are set in Flags, then ASSERT(). If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()

Parameters:
Buffer The pointer to the output buffer for the produced Null-terminated string.
Flags The bitmask of flags that specify left justification, zero pad, and commas.
Value The 64-bit signed value to convert to a string.
Width The maximum number of characters to place in Buffer, not including the Null-terminator.
Increment The character increment in Buffer.
Returns:
Total number of characters required to perform the conversion.

References ASSERT, BasePrintLibFillBuffer(), BasePrintLibValueToString(), COMMA_TYPE, LEFT_JUSTIFY, MAXIMUM_VALUE_CHARACTERS, NULL, PREFIX_ZERO, and RADIX_HEX.

Referenced by AsciiValueToString(), and UnicodeValueToString().

CHAR8* BasePrintLibFillBuffer ( OUT CHAR8 Buffer,
IN CHAR8 EndBuffer,
IN INTN  Length,
IN UINTN  Character,
IN INTN  Increment 
)

Internal function that places the character into the Buffer.

Internal function that places ASCII or Unicode character into the Buffer.

Parameters:
Buffer The buffer to place the Unicode or ASCII string.
EndBuffer The end of the input Buffer. No characters will be placed after that.
Length The count of character to be placed into Buffer. (Negative value indicates no buffer fill.)
Character The character to be placed into Buffer.
Increment The character increment in Buffer.
Returns:
Buffer.

Referenced by BasePrintLibConvertValueToString(), and BasePrintLibSPrintMarker().

UINTN EFIAPI BasePrintLibSPrint ( OUT CHAR8 StartOfBuffer,
IN UINTN  BufferSize,
IN UINTN  Flags,
IN CONST CHAR8 FormatString,
  ... 
)

Worker function that produces a Null-terminated string in an output buffer based on a Null-terminated format string and variable argument list.

VSPrint function to process format and place the results in Buffer. Since a VA_LIST is used this routine allows the nesting of Vararg routines. Thus this is the main print working routine

Parameters:
StartOfBuffer The character buffer to print the results of the parsing of Format into.
BufferSize The maximum number of characters to put into buffer. Zero means no limit.
Flags Initial flags value. Can only have FORMAT_UNICODE and OUTPUT_UNICODE set
FormatString A Null-terminated format string.
... The variable argument list.
Returns:
The number of characters printed.

References BasePrintLibSPrintMarker(), NULL, VA_END, and VA_START.

Referenced by BasePrintLibSPrintMarker().

UINTN BasePrintLibSPrintMarker ( OUT CHAR8 Buffer,
IN UINTN  BufferSize,
IN UINTN  Flags,
IN CONST CHAR8 Format,
IN VA_LIST  VaListMarker,
IN BASE_LIST  BaseListMarker 
)

Worker function that produces a Null-terminated string in an output buffer based on a Null-terminated format string and a VA_LIST argument list.

VSPrint function to process format and place the results in Buffer. Since a VA_LIST is used this routine allows the nesting of Vararg routines. Thus this is the main print working routine.

If COUNT_ONLY_NO_PRINT is set in Flags, Buffer will not be modified at all.

Parameters:
[out] Buffer The character buffer to print the results of the parsing of Format into.
[in] BufferSize The maximum number of characters to put into buffer.
[in] Flags Initial flags value. Can only have FORMAT_UNICODE, OUTPUT_UNICODE, and COUNT_ONLY_NO_PRINT set.
[in] Format A Null-terminated format string.
[in] VaListMarker VA_LIST style variable argument list consumed by processing Format.
[in] BaseListMarker BASE_LIST style variable argument list consumed by processing Format.
Returns:
The number of characters printed not including the Null-terminator. If COUNT_ONLY_NO_PRINT was set returns the same, but without any modification to Buffer.

References ARGUMENT_REVERSED, ARGUMENT_UNICODE, AsciiStrSize(), ASSERT, BASE_ARG, BasePrintLibFillBuffer(), BasePrintLibSPrint(), BasePrintLibValueToString(), COMMA_TYPE, CONST, COUNT_ONLY_NO_PRINT, GUID::Data1, GUID::Data2, GUID::Data3, GUID::Data4, TIME::Day, ERROR_STATUS_NUMBER, FALSE, FORMAT_UNICODE, TIME::Hour, LEFT_JUSTIFY, LONG_TYPE, MAX_BIT, MAXIMUM_VALUE_CHARACTERS, TIME::Minute, TIME::Month, mStatusString, NULL, OUTPUT_UNICODE, PAD_TO_WIDTH, PRECISION, PREFIX_BLANK, PREFIX_SIGN, PREFIX_ZERO, RADIX_HEX, ReadUnaligned16(), ReadUnaligned32(), RETURN_ERROR, StrSize(), TRUE, UNSIGNED_TYPE, VA_ARG, VOID, WARNING_STATUS_NUMBER, and TIME::Year.

Referenced by AsciiBSPrint(), AsciiBSPrintUnicodeFormat(), AsciiVSPrint(), AsciiVSPrintUnicodeFormat(), BasePrintLibSPrint(), SPrintLength(), SPrintLengthAsciiFormat(), UnicodeBSPrint(), UnicodeBSPrintAsciiFormat(), UnicodeVSPrint(), and UnicodeVSPrintAsciiFormat().

CHAR8* BasePrintLibValueToString ( IN OUT CHAR8 Buffer,
IN INT64  Value,
IN UINTN  Radix 
)

Internal function that convert a number to a string in Buffer.

Print worker function that converts a decimal or hexadecimal number to an ASCII string in Buffer.

Parameters:
Buffer Location to place the ASCII string of Value.
Value The value to convert to a Decimal or Hexadecimal string in Buffer.
Radix Radix of the value
Returns:
A pointer to the end of buffer filled with ASCII string.

References DivU64x32Remainder(), and mHexStr.

Referenced by BasePrintLibConvertValueToString(), and BasePrintLibSPrintMarker().


Variable Documentation

GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 mHexStr[] = {'0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'}

GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8* CONST mStatusString[]


Generated on Thu Sep 24 23:14:23 2015 for MdePkg[ALL] by  doxygen 1.5.7.1