mirror of https://github.com/acidanthera/audk.git
407 lines
18 KiB
C
407 lines
18 KiB
C
|
/** @file
|
||
|
|
Library that provides print services
|
||
|
|
|
||
|
|
Copyright (c) 2006, 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.
|
||
|
|
|
||
|
|
Module Name: PrintLib.h
|
||
|
|
|
||
|
|
**/
|
||
|
|
|
||
|
|
#ifndef __PRINT_LIB_H__
|
||
|
|
#define __PRINT_LIB_H__
|
||
|
|
|
||
|
|
//
|
||
|
|
// Print primitives
|
||
|
|
//
|
||
|
|
#define LEFT_JUSTIFY 0x01
|
||
|
|
#define COMMA_TYPE 0x08
|
||
|
|
#define PREFIX_ZERO 0x20
|
||
|
|
|
||
|
|
/**
|
||
|
|
Produces a Null-terminated Unicode string in an output buffer based on
|
||
|
|
a Null-terminated Unicode format string and a VA_LIST argument list
|
||
|
|
|
||
|
|
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
|
||
|
|
and BufferSize.
|
||
|
|
The Unicode string is produced by parsing the format string specified by FormatString.
|
||
|
|
Arguments are pulled from the variable argument list specified by Marker based on the
|
||
|
|
contents of the format string.
|
||
|
|
The length of the produced output buffer is returned.
|
||
|
|
If BufferSize is 0, then no output buffer is produced and 0 is returned.
|
||
|
|
|
||
|
|
If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().
|
||
|
|
If BufferSize is not 0 and FormatString is NULL, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
|
||
|
|
PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
|
||
|
|
contains more than PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().
|
||
|
|
|
||
|
|
@param StartOfBuffer APointer to the output buffer for the produced Null-terminated
|
||
|
|
Unicode string.
|
||
|
|
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
|
||
|
|
@param FormatString Null-terminated Unicode format string.
|
||
|
|
@param Marker VA_LIST marker for the variable argument list.
|
||
|
|
|
||
|
|
@return return Length of the produced output buffer.
|
||
|
|
|
||
|
|
**/
|
||
|
|
UINTN
|
||
|
|
EFIAPI
|
||
|
|
UnicodeVSPrint (
|
||
|
|
OUT CHAR16 *StartOfBuffer,
|
||
|
|
IN UINTN BufferSize,
|
||
|
|
IN CONST CHAR16 *FormatString,
|
||
|
|
IN VA_LIST Marker
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated
|
||
|
|
Unicode format string and variable argument list.
|
||
|
|
|
||
|
|
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
|
||
|
|
and BufferSize.
|
||
|
|
The Unicode string is produced by parsing the format string specified by FormatString.
|
||
|
|
Arguments are pulled from the variable argument list based on the contents of the format string.
|
||
|
|
The length of the produced output buffer is returned.
|
||
|
|
If BufferSize is 0, then no output buffer is produced and 0 is returned.
|
||
|
|
|
||
|
|
If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().
|
||
|
|
If BufferSize is not 0 and FormatString is NULL, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
|
||
|
|
PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
|
||
|
|
contains more than PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().
|
||
|
|
|
||
|
|
@param StartOfBuffer APointer to the output buffer for the produced Null-terminated
|
||
|
|
Unicode string.
|
||
|
|
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
|
||
|
|
@param FormatString Null-terminated Unicode format string.
|
||
|
|
|
||
|
|
@return Length of the produced output buffer.
|
||
|
|
|
||
|
|
**/
|
||
|
|
UINTN
|
||
|
|
EFIAPI
|
||
|
|
UnicodeSPrint (
|
||
|
|
OUT CHAR16 *StartOfBuffer,
|
||
|
|
IN UINTN BufferSize,
|
||
|
|
IN CONST CHAR16 *FormatString,
|
||
|
|
...
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated
|
||
|
|
ASCII format string and a VA_LIST argument list
|
||
|
|
|
||
|
|
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
|
||
|
|
and BufferSize.
|
||
|
|
The Unicode string is produced by parsing the format string specified by FormatString.
|
||
|
|
Arguments are pulled from the variable argument list specified by Marker based on the
|
||
|
|
contents of the format string.
|
||
|
|
The length of the produced output buffer is returned.
|
||
|
|
If BufferSize is 0, then no output buffer is produced and 0 is returned.
|
||
|
|
|
||
|
|
If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().
|
||
|
|
If BufferSize is not 0 and FormatString is NULL, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
|
||
|
|
PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
|
||
|
|
contains more than PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().
|
||
|
|
|
||
|
|
@param StartOfBuffer APointer to the output buffer for the produced Null-terminated
|
||
|
|
Unicode string.
|
||
|
|
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
|
||
|
|
@param FormatString Null-terminated Unicode format string.
|
||
|
|
@param Marker VA_LIST marker for the variable argument list.
|
||
|
|
|
||
|
|
@return Length of the produced output buffer.
|
||
|
|
|
||
|
|
**/
|
||
|
|
UINTN
|
||
|
|
EFIAPI
|
||
|
|
UnicodeVSPrintAsciiFormat (
|
||
|
|
OUT CHAR16 *StartOfBuffer,
|
||
|
|
IN UINTN BufferSize,
|
||
|
|
IN CONST CHAR8 *FormatString,
|
||
|
|
IN VA_LIST Marker
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated
|
||
|
|
ASCII format string and variable argument list.
|
||
|
|
|
||
|
|
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
|
||
|
|
and BufferSize.
|
||
|
|
The Unicode string is produced by parsing the format string specified by FormatString.
|
||
|
|
Arguments are pulled from the variable argument list based on the contents of the
|
||
|
|
format string.
|
||
|
|
The length of the produced output buffer is returned.
|
||
|
|
If BufferSize is 0, then no output buffer is produced and 0 is returned.
|
||
|
|
|
||
|
|
If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().
|
||
|
|
If BufferSize is not 0 and FormatString is NULL, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
|
||
|
|
PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
|
||
|
|
contains more than PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().
|
||
|
|
|
||
|
|
@param StartOfBuffer APointer to the output buffer for the produced Null-terminated
|
||
|
|
Unicode string.
|
||
|
|
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
|
||
|
|
@param FormatString Null-terminated Unicode format string.
|
||
|
|
|
||
|
|
@return Length of the produced output buffer.
|
||
|
|
|
||
|
|
**/
|
||
|
|
UINTN
|
||
|
|
EFIAPI
|
||
|
|
UnicodeSPrintAsciiFormat (
|
||
|
|
OUT CHAR16 *StartOfBuffer,
|
||
|
|
IN UINTN BufferSize,
|
||
|
|
IN CONST CHAR8 *FormatString,
|
||
|
|
...
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
|
||
|
|
ASCII format string and a VA_LIST argument list.
|
||
|
|
|
||
|
|
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer
|
||
|
|
and BufferSize.
|
||
|
|
The ASCII string is produced by parsing the format string specified by FormatString.
|
||
|
|
Arguments are pulled from the variable argument list specified by Marker based on
|
||
|
|
the contents of the format string.
|
||
|
|
The length of the produced output buffer is returned.
|
||
|
|
If BufferSize is 0, then no output buffer is produced and 0 is returned.
|
||
|
|
|
||
|
|
If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().
|
||
|
|
If BufferSize is not 0 and FormatString is NULL, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
|
||
|
|
PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
|
||
|
|
contains more than PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().
|
||
|
|
|
||
|
|
@param StartOfBuffer APointer to the output buffer for the produced Null-terminated
|
||
|
|
ASCII string.
|
||
|
|
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
|
||
|
|
@param FormatString Null-terminated Unicode format string.
|
||
|
|
@param Marker VA_LIST marker for the variable argument list.
|
||
|
|
|
||
|
|
@return Length of the produced output buffer.
|
||
|
|
|
||
|
|
**/
|
||
|
|
UINTN
|
||
|
|
EFIAPI
|
||
|
|
AsciiVSPrint (
|
||
|
|
OUT CHAR8 *StartOfBuffer,
|
||
|
|
IN UINTN BufferSize,
|
||
|
|
IN CONST CHAR8 *FormatString,
|
||
|
|
IN VA_LIST Marker
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
|
||
|
|
ASCII format string and variable argument list.
|
||
|
|
|
||
|
|
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer
|
||
|
|
and BufferSize.
|
||
|
|
The ASCII string is produced by parsing the format string specified by FormatString.
|
||
|
|
Arguments are pulled from the variable argument list based on the contents of the
|
||
|
|
format string.
|
||
|
|
The length of the produced output buffer is returned.
|
||
|
|
If BufferSize is 0, then no output buffer is produced and 0 is returned.
|
||
|
|
|
||
|
|
If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().
|
||
|
|
If BufferSize is not 0 and FormatString is NULL, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
|
||
|
|
PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
|
||
|
|
contains more than PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().
|
||
|
|
|
||
|
|
@param StartOfBuffer APointer to the output buffer for the produced Null-terminated
|
||
|
|
ASCII string.
|
||
|
|
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
|
||
|
|
@param FormatString Null-terminated Unicode format string.
|
||
|
|
|
||
|
|
@return Length of the produced output buffer.
|
||
|
|
|
||
|
|
**/
|
||
|
|
UINTN
|
||
|
|
EFIAPI
|
||
|
|
AsciiSPrint (
|
||
|
|
OUT CHAR8 *StartOfBuffer,
|
||
|
|
IN UINTN BufferSize,
|
||
|
|
IN CONST CHAR8 *FormatString,
|
||
|
|
...
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
|
||
|
|
ASCII format string and a VA_LIST argument list.
|
||
|
|
|
||
|
|
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer
|
||
|
|
and BufferSize.
|
||
|
|
The ASCII string is produced by parsing the format string specified by FormatString.
|
||
|
|
Arguments are pulled from the variable argument list specified by Marker based on
|
||
|
|
the contents of the format string.
|
||
|
|
The length of the produced output buffer is returned.
|
||
|
|
If BufferSize is 0, then no output buffer is produced and 0 is returned.
|
||
|
|
|
||
|
|
If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().
|
||
|
|
If BufferSize is not 0 and FormatString is NULL, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
|
||
|
|
PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
|
||
|
|
contains more than PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().
|
||
|
|
|
||
|
|
@param StartOfBuffer APointer to the output buffer for the produced Null-terminated
|
||
|
|
ASCII string.
|
||
|
|
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
|
||
|
|
@param FormatString Null-terminated Unicode format string.
|
||
|
|
@param Marker VA_LIST marker for the variable argument list.
|
||
|
|
|
||
|
|
@return Length of the produced output buffer.
|
||
|
|
|
||
|
|
**/
|
||
|
|
UINTN
|
||
|
|
EFIAPI
|
||
|
|
AsciiVSPrintUnicodeFormat (
|
||
|
|
OUT CHAR8 *StartOfBuffer,
|
||
|
|
IN UINTN BufferSize,
|
||
|
|
IN CONST CHAR16 *FormatString,
|
||
|
|
IN VA_LIST Marker
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
|
||
|
|
ASCII format string and variable argument list.
|
||
|
|
|
||
|
|
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer
|
||
|
|
and BufferSize.
|
||
|
|
The ASCII string is produced by parsing the format string specified by FormatString.
|
||
|
|
Arguments are pulled from the variable argument list based on the contents of the
|
||
|
|
format string.
|
||
|
|
The length of the produced output buffer is returned.
|
||
|
|
If BufferSize is 0, then no output buffer is produced and 0 is returned.
|
||
|
|
|
||
|
|
If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().
|
||
|
|
If BufferSize is not 0 and FormatString is NULL, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
|
||
|
|
PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().
|
||
|
|
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
|
||
|
|
contains more than PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().
|
||
|
|
|
||
|
|
@param StartOfBuffer APointer to the output buffer for the produced Null-terminated
|
||
|
|
ASCII string.
|
||
|
|
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
|
||
|
|
@param FormatString Null-terminated Unicode format string.
|
||
|
|
|
||
|
|
@return Length of the produced output buffer.
|
||
|
|
|
||
|
|
**/
|
||
|
|
UINTN
|
||
|
|
EFIAPI
|
||
|
|
AsciiSPrintUnicodeFormat (
|
||
|
|
OUT CHAR8 *StartOfBuffer,
|
||
|
|
IN UINTN BufferSize,
|
||
|
|
IN CONST CHAR16 *FormatString,
|
||
|
|
...
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Converts a decimal value to a Null-terminated Unicode string.
|
||
|
|
|
||
|
|
Converts the decimal number specified by Value to a Null-terminated Unicode
|
||
|
|
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()
|
||
|
|
|
||
|
|
@param Buffer Pointer to the output buffer for the produced Null-terminated
|
||
|
|
Unicode string.
|
||
|
|
@param Flags The bitmask of flags that specify left justification, zero pad, and commas.
|
||
|
|
@param Value The 64-bit signed value to convert to a string.
|
||
|
|
@param Width The maximum number of Unicode characters to place in Buffer.
|
||
|
|
|
||
|
|
@return Total number of characters required to perform the conversion.
|
||
|
|
|
||
|
|
**/
|
||
|
|
UINTN
|
||
|
|
EFIAPI
|
||
|
|
UnicodeValueToString (
|
||
|
|
IN OUT CHAR16 *Buffer,
|
||
|
|
IN UINTN Flags,
|
||
|
|
IN INT64 Value,
|
||
|
|
IN UINTN Width
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Converts a decimal value to a Null-terminated ASCII string.
|
||
|
|
|
||
|
|
Converts the decimal number specified by Value to a Null-terminated ASCII 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()
|
||
|
|
|
||
|
|
@param Buffer Pointer to the output buffer for the produced Null-terminated
|
||
|
|
ASCII string.
|
||
|
|
@param Flags The bitmask of flags that specify left justification, zero pad, and commas.
|
||
|
|
@param Value The 64-bit signed value to convert to a string.
|
||
|
|
@param Width The maximum number of ASCII characters to place in Buffer.
|
||
|
|
|
||
|
|
@return Total number of characters required to perform the conversion.
|
||
|
|
|
||
|
|
**/
|
||
|
|
UINTN
|
||
|
|
EFIAPI
|
||
|
|
AsciiValueToString (
|
||
|
|
IN OUT CHAR8 *Buffer,
|
||
|
|
IN UINTN Flags,
|
||
|
|
IN INT64 Value,
|
||
|
|
IN UINTN Width
|
||
|
|
);
|
||
|
|
|
||
|
|
#endif
|