]>
git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Library/BasePrintLib/PrintLibInternal.h
2 Base Print Library instance Internal Functions definition.
4 Copyright (c) 2006 - 2008, Intel Corporation
5 All rights reserved. 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 rountine 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 Intial flags value.
66 Can only have FORMAT_UNICODE and OUTPUT_UNICODE set.
67 @param Format Null-terminated format string.
68 @param Marker Vararg list consumed by processing Format.
70 @return Number of characters printed not including the Null-terminator.
78 IN CONST CHAR8
*Format
,
83 Worker function that produces a Null-terminated string in an output buffer
84 based on a Null-terminated format string and variable argument list.
86 VSPrint function to process format and place the results in Buffer. Since a
87 VA_LIST is used this rountine allows the nesting of Vararg routines. Thus
88 this is the main print working routine
90 @param StartOfBuffer Character buffer to print the results of the parsing
92 @param BufferSize Maximum number of characters to put into buffer.
94 @param Flags Intial flags value.
95 Can only have FORMAT_UNICODE and OUTPUT_UNICODE set
96 @param FormatString Null-terminated format string.
97 @param ... The variable argument list.
99 @return Number of characters printed.
104 OUT CHAR8
*StartOfBuffer
,
107 IN CONST CHAR8
*FormatString
,
112 Internal function that places the character into the Buffer.
114 Internal function that places ASCII or Unicode character into the Buffer.
116 @param Buffer Buffer to place the Unicode or ASCII string.
117 @param EndBuffer The end of the input Buffer. No characters will be
119 @param Length Count of character to be placed into Buffer.
120 @param Character Character to be placed into Buffer.
121 @param Increment Character increment in Buffer.
123 @return Buffer Buffer filled with the input Character.
127 BasePrintLibFillBuffer (
136 Internal function that convert a decimal number to a string in Buffer.
138 Print worker function that convert a decimal number to a string in Buffer.
140 @param Buffer Location to place the Unicode or ASCII string of Value.
141 @param Value Value to convert to a Decimal or Hexidecimal string in Buffer.
142 @param Radix Radix of the value
144 @return Number of characters printed.
148 BasePrintLibValueToString (
149 IN OUT CHAR8
*Buffer
,
155 Internal function that converts a decimal value to a Null-terminated string.
157 Converts the decimal number specified by Value to a Null-terminated
158 string specified by Buffer containing at most Width characters.
159 If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.
160 The total number of characters placed in Buffer is returned.
161 If the conversion contains more than Width characters, then only the first
162 Width characters are returned, and the total number of characters
163 required to perform the conversion is returned.
164 Additional conversion parameters are specified in Flags.
165 The Flags bit LEFT_JUSTIFY is always ignored.
166 All conversions are left justified in Buffer.
167 If Width is 0, PREFIX_ZERO is ignored in Flags.
168 If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas
169 are inserted every 3rd digit starting from the right.
170 If Value is < 0, then the fist character in Buffer is a '-'.
171 If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored,
172 then Buffer is padded with '0' characters so the combination of the optional '-'
173 sign character, '0' characters, digit characters for Value, and the Null-terminator
174 add up to Width characters.
176 If Buffer is NULL, then ASSERT().
177 If unsupported bits are set in Flags, then ASSERT().
178 If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
180 @param Buffer Pointer to the output buffer for the produced Null-terminated
182 @param Flags The bitmask of flags that specify left justification, zero pad,
184 @param Value The 64-bit signed value to convert to a string.
185 @param Width The maximum number of characters to place in Buffer, not including
187 @param Increment Character increment in Buffer.
189 @return Total number of characters required to perform the conversion.
193 BasePrintLibConvertValueToString (
194 IN OUT CHAR8
*Buffer
,