2 Base Print Library instance Internal Functions definition.
4 Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef __PRINT_LIB_INTERNAL_H__
16 #define __PRINT_LIB_INTERNAL_H__
19 #include <Library/PrintLib.h>
20 #include <Library/BaseLib.h>
21 #include <Library/DebugLib.h>
27 #define PREFIX_SIGN 0x02
28 #define PREFIX_BLANK 0x04
29 #define LONG_TYPE 0x10
30 #define OUTPUT_UNICODE 0x40
31 #define FORMAT_UNICODE 0x100
32 #define PAD_TO_WIDTH 0x200
33 #define ARGUMENT_UNICODE 0x400
34 #define PRECISION 0x800
35 #define ARGUMENT_REVERSED 0x1000
38 // Record date and time information
55 Worker function that produces a Null-terminated string in an output buffer
56 based on a Null-terminated format string and a VA_LIST argument list.
58 VSPrint function to process format and place the results in Buffer. Since a
59 VA_LIST is used this routine allows the nesting of Vararg routines. Thus
60 this is the main print working routine.
62 @param Buffer Character buffer to print the results of the parsing
64 @param BufferSize Maximum number of characters to put into buffer.
65 @param Flags Initial flags value.
66 Can only have FORMAT_UNICODE and OUTPUT_UNICODE set.
67 @param Format Null-terminated format string.
68 @param VaListMarker VA_LIST style variable argument list consumed by processing Format.
69 @param BaseListMarker BASE_LIST style variable argument list consumed by processing Format.
71 @return Number of characters printed not including the Null-terminator.
75 BasePrintLibSPrintMarker (
79 IN CONST CHAR8
*Format
,
80 IN VA_LIST VaListMarker
, OPTIONAL
81 IN BASE_LIST BaseListMarker OPTIONAL
85 Worker function that produces a Null-terminated string in an output buffer
86 based on a Null-terminated format string and variable argument list.
88 VSPrint function to process format and place the results in Buffer. Since a
89 VA_LIST is used this routine allows the nesting of Vararg routines. Thus
90 this is the main print working routine
92 @param StartOfBuffer Character buffer to print the results of the parsing
94 @param BufferSize Maximum number of characters to put into buffer.
96 @param Flags Initial flags value.
97 Can only have FORMAT_UNICODE and OUTPUT_UNICODE set
98 @param FormatString Null-terminated format string.
99 @param ... The variable argument list.
101 @return Number of characters printed.
106 OUT CHAR8
*StartOfBuffer
,
109 IN CONST CHAR8
*FormatString
,
114 Internal function that places the character into the Buffer.
116 Internal function that places ASCII or Unicode character into the Buffer.
118 @param Buffer Buffer to place the Unicode or ASCII string.
119 @param EndBuffer The end of the input Buffer. No characters will be
121 @param Length Count of character to be placed into Buffer.
122 (Negative value indicates no buffer fill.)
123 @param Character Character to be placed into Buffer.
124 @param Increment Character increment in Buffer.
126 @return Buffer Buffer filled with the input Character.
130 BasePrintLibFillBuffer (
139 Internal function that convert a number to a string in Buffer.
141 Print worker function that converts a decimal or hexadecimal number to an ASCII string in Buffer.
143 @param Buffer Location to place the ASCII string of Value.
144 @param Value Value to convert to a Decimal or Hexadecimal string in Buffer.
145 @param Radix Radix of the value
147 @return A pointer to the end of buffer filled with ASCII string.
151 BasePrintLibValueToString (
152 IN OUT CHAR8
*Buffer
,
158 Internal function that converts a decimal value to a Null-terminated string.
160 Converts the decimal number specified by Value to a Null-terminated
161 string specified by Buffer containing at most Width characters.
162 If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.
163 The total number of characters placed in Buffer is returned.
164 If the conversion contains more than Width characters, then only the first
165 Width characters are returned, and the total number of characters
166 required to perform the conversion is returned.
167 Additional conversion parameters are specified in Flags.
168 The Flags bit LEFT_JUSTIFY is always ignored.
169 All conversions are left justified in Buffer.
170 If Width is 0, PREFIX_ZERO is ignored in Flags.
171 If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas
172 are inserted every 3rd digit starting from the right.
173 If Value is < 0, then the fist character in Buffer is a '-'.
174 If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored,
175 then Buffer is padded with '0' characters so the combination of the optional '-'
176 sign character, '0' characters, digit characters for Value, and the Null-terminator
177 add up to Width characters.
179 If Buffer is NULL, then ASSERT().
180 If unsupported bits are set in Flags, then ASSERT().
181 If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
183 @param Buffer Pointer to the output buffer for the produced Null-terminated
185 @param Flags The bitmask of flags that specify left justification, zero pad,
187 @param Value The 64-bit signed value to convert to a string.
188 @param Width The maximum number of characters to place in Buffer, not including
190 @param Increment Character increment in Buffer.
192 @return Total number of characters required to perform the conversion.
196 BasePrintLibConvertValueToString (
197 IN OUT CHAR8
*Buffer
,