#include "PrintLibInternal.h"

Macros
#define	WARNING_STATUS_NUMBER 7

#define	ERROR_STATUS_NUMBER 35

#define	RSIZE_MAX (PcdGet32 (PcdMaximumUnicodeStringLength))

#define	ASCII_RSIZE_MAX (PcdGet32 (PcdMaximumAsciiStringLength))

#define	SAFE_PRINT_CONSTRAINT_CHECK(Expression, RetVal)

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

CHAR8 *	BasePrintLibValueToString (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)

RETURN_STATUS	BasePrintLibConvertValueToStringS (IN OUT CHAR8 *Buffer, IN UINTN BufferSize, 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 OPTIONAL, IN BASE_LIST BaseListMarker OPTIONAL)

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	mWarningString [][24+1]

GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8	mErrorString [][20+1]

Detailed Description

Print Library internal worker functions.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file PrintLibInternal.c.

Macro Definition Documentation

◆ ASCII_RSIZE_MAX

#define ASCII_RSIZE_MAX (PcdGet32 (PcdMaximumAsciiStringLength))

Definition at line 18 of file PrintLibInternal.c.

◆ ERROR_STATUS_NUMBER

#define ERROR_STATUS_NUMBER 35

Definition at line 12 of file PrintLibInternal.c.

◆ RSIZE_MAX

#define RSIZE_MAX (PcdGet32 (PcdMaximumUnicodeStringLength))

Definition at line 17 of file PrintLibInternal.c.

◆ SAFE_PRINT_CONSTRAINT_CHECK

#define SAFE_PRINT_CONSTRAINT_CHECK	(	Expression,
		RetVal
	)

Value:

  do { \
    ASSERT (Expression); \
    if (!(Expression)) { \
      return RetVal; \
    } \
  } while (FALSE)

Definition at line 20 of file PrintLibInternal.c.

◆ WARNING_STATUS_NUMBER

#define WARNING_STATUS_NUMBER 7

Definition at line 11 of file PrintLibInternal.c.

Function Documentation

◆ BasePrintLibConvertValueToString()

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.

Definition at line 199 of file PrintLibInternal.c.

◆ BasePrintLibConvertValueToStringS()

RETURN_STATUS BasePrintLibConvertValueToStringS	(	IN OUT CHAR8 *	Buffer,
		IN UINTN	BufferSize,
		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. If the conversion contains more than Width characters, then only the first Width characters are placed in Buffer. 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 an error would be returned, the function will ASSERT().

Parameters

Buffer	The pointer to the output buffer for the produced Null-terminated string.
BufferSize	The size of Buffer in bytes, including the Null-terminator.
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.

Return values

RETURN_SUCCESS	The decimal value is converted.
RETURN_BUFFER_TOO_SMALL	If BufferSize cannot hold the converted value.
RETURN_INVALID_PARAMETER	If Buffer is NULL. If Increment is 1 and PcdMaximumAsciiStringLength is not zero, BufferSize is greater than PcdMaximumAsciiStringLength. If Increment is not 1 and PcdMaximumUnicodeStringLength is not zero, BufferSize is greater than (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1). If unsupported bits are set in Flags. If both COMMA_TYPE and RADIX_HEX are set in Flags. If Width >= MAXIMUM_VALUE_CHARACTERS.

Definition at line 356 of file PrintLibInternal.c.

◆ BasePrintLibFillBuffer()

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.

Definition at line 102 of file PrintLibInternal.c.

◆ BasePrintLibSPrint()

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.

Definition at line 1311 of file PrintLibInternal.c.

◆ BasePrintLibSPrintMarker()

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

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.

Definition at line 540 of file PrintLibInternal.c.

◆ BasePrintLibValueToString()

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.

Definition at line 137 of file PrintLibInternal.c.

Variable Documentation

◆ mErrorString

GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 mErrorString[][20+1]

Definition at line 47 of file PrintLibInternal.c.

◆ mHexStr

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

Definition at line 28 of file PrintLibInternal.c.

◆ mWarningString

GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 mWarningString[][24+1]

Initial value:

= {
  "Success",                      
  "Warning Unknown Glyph",        
  "Warning Delete Failure",       
  "Warning Write Failure",        
  "Warning Buffer Too Small",     
  "Warning Stale Data",           
  "Warning File System",          
  "Warning Reset Required",       
}

Definition at line 33 of file PrintLibInternal.c.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ ASCII_RSIZE_MAX

◆ ERROR_STATUS_NUMBER

◆ RSIZE_MAX

◆ SAFE_PRINT_CONSTRAINT_CHECK

◆ WARNING_STATUS_NUMBER

Function Documentation

◆ BasePrintLibConvertValueToString()

◆ BasePrintLibConvertValueToStringS()

◆ BasePrintLibFillBuffer()

◆ BasePrintLibSPrint()

◆ BasePrintLibSPrintMarker()

◆ BasePrintLibValueToString()

Variable Documentation

◆ mErrorString

◆ mHexStr

◆ mWarningString