]>
Commit | Line | Data |
---|---|---|
e1f414b6 | 1 | /** @file\r |
eceb3a4c | 2 | Base Print Library instance Internal Functions definition.\r |
e1f414b6 | 3 | \r |
eceb3a4c | 4 | Copyright (c) 2006 - 2008, Intel Corporation\r |
e1f414b6 | 5 | All rights reserved. This program and the accompanying materials\r |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
e1f414b6 | 13 | **/\r |
14 | \r | |
eceb3a4c LG |
15 | #ifndef __PRINT_LIB_INTERNAL_H__\r |
16 | #define __PRINT_LIB_INTERNAL_H__\r | |
e1f414b6 | 17 | \r |
f734a10a A |
18 | #include <Base.h>\r |
19 | #include <Library/PrintLib.h>\r | |
20 | #include <Library/BaseLib.h>\r | |
21 | #include <Library/DebugLib.h>\r | |
22 | \r | |
e1f414b6 | 23 | \r |
24 | //\r | |
25 | // Print primitives\r | |
26 | //\r | |
e1f414b6 | 27 | #define PREFIX_SIGN 0x02\r |
28 | #define PREFIX_BLANK 0x04\r | |
e1f414b6 | 29 | #define LONG_TYPE 0x10\r |
e1f414b6 | 30 | #define OUTPUT_UNICODE 0x40\r |
e1f414b6 | 31 | #define FORMAT_UNICODE 0x100\r |
32 | #define PAD_TO_WIDTH 0x200\r | |
33 | #define ARGUMENT_UNICODE 0x400\r | |
34 | #define PRECISION 0x800\r | |
35 | #define ARGUMENT_REVERSED 0x1000\r | |
36 | \r | |
37 | //\r | |
38 | // Record date and time information\r | |
39 | //\r | |
40 | typedef struct {\r | |
41 | UINT16 Year;\r | |
42 | UINT8 Month;\r | |
43 | UINT8 Day;\r | |
44 | UINT8 Hour;\r | |
45 | UINT8 Minute;\r | |
46 | UINT8 Second;\r | |
47 | UINT8 Pad1;\r | |
48 | UINT32 Nanosecond;\r | |
49 | INT16 TimeZone;\r | |
50 | UINT8 Daylight;\r | |
51 | UINT8 Pad2;\r | |
52 | } TIME;\r | |
53 | \r | |
54 | /**\r | |
55 | Worker function that produces a Null-terminated string in an output buffer \r | |
56 | based on a Null-terminated format string and a VA_LIST argument list.\r | |
57 | \r | |
58 | VSPrint function to process format and place the results in Buffer. Since a \r | |
59 | VA_LIST is used this rountine allows the nesting of Vararg routines. Thus \r | |
60 | this is the main print working routine.\r | |
61 | \r | |
62 | @param Buffer Character buffer to print the results of the parsing\r | |
63 | of Format into.\r | |
64 | @param BufferSize Maximum number of characters to put into buffer.\r | |
65 | @param Flags Intial flags value.\r | |
66 | Can only have FORMAT_UNICODE and OUTPUT_UNICODE set.\r | |
67 | @param Format Null-terminated format string.\r | |
68 | @param Marker Vararg list consumed by processing Format.\r | |
69 | \r | |
70 | @return Number of characters printed not including the Null-terminator.\r | |
71 | \r | |
72 | **/\r | |
73 | UINTN\r | |
74 | BasePrintLibVSPrint (\r | |
75 | OUT CHAR8 *Buffer,\r | |
76 | IN UINTN BufferSize,\r | |
77 | IN UINTN Flags,\r | |
78 | IN CONST CHAR8 *Format,\r | |
79 | IN VA_LIST Marker\r | |
80 | );\r | |
81 | \r | |
82 | /**\r | |
83 | Worker function that produces a Null-terminated string in an output buffer \r | |
84 | based on a Null-terminated format string and variable argument list.\r | |
85 | \r | |
86 | VSPrint function to process format and place the results in Buffer. Since a \r | |
87 | VA_LIST is used this rountine allows the nesting of Vararg routines. Thus \r | |
88 | this is the main print working routine\r | |
89 | \r | |
eceb3a4c | 90 | @param StartOfBuffer Character buffer to print the results of the parsing\r |
e1f414b6 | 91 | of Format into.\r |
92 | @param BufferSize Maximum number of characters to put into buffer.\r | |
93 | Zero means no limit.\r | |
94 | @param Flags Intial flags value.\r | |
95 | Can only have FORMAT_UNICODE and OUTPUT_UNICODE set\r | |
96 | @param FormatString Null-terminated format string.\r | |
eceb3a4c | 97 | @param ... The variable argument list.\r |
e1f414b6 | 98 | \r |
99 | @return Number of characters printed.\r | |
100 | \r | |
101 | **/\r | |
102 | UINTN\r | |
103 | BasePrintLibSPrint (\r | |
eceb3a4c | 104 | OUT CHAR8 *StartOfBuffer,\r |
e1f414b6 | 105 | IN UINTN BufferSize,\r |
106 | IN UINTN Flags,\r | |
107 | IN CONST CHAR8 *FormatString,\r | |
108 | ...\r | |
109 | );\r | |
110 | \r | |
111 | /**\r | |
112 | Internal function that places the character into the Buffer.\r | |
113 | \r | |
114 | Internal function that places ASCII or Unicode character into the Buffer.\r | |
115 | \r | |
116 | @param Buffer Buffer to place the Unicode or ASCII string.\r | |
117 | @param EndBuffer The end of the input Buffer. No characters will be\r | |
118 | placed after that. \r | |
119 | @param Length Count of character to be placed into Buffer.\r | |
120 | @param Character Character to be placed into Buffer.\r | |
121 | @param Increment Character increment in Buffer.\r | |
122 | \r | |
eceb3a4c | 123 | @return Buffer Buffer filled with the input Character.\r |
e1f414b6 | 124 | \r |
125 | **/\r | |
126 | CHAR8 *\r | |
127 | BasePrintLibFillBuffer (\r | |
eceb3a4c LG |
128 | OUT CHAR8 *Buffer,\r |
129 | IN CHAR8 *EndBuffer,\r | |
130 | IN INTN Length,\r | |
131 | IN UINTN Character,\r | |
132 | IN INTN Increment\r | |
e1f414b6 | 133 | );\r |
134 | \r | |
135 | /**\r | |
136 | Internal function that convert a decimal number to a string in Buffer.\r | |
137 | \r | |
138 | Print worker function that convert a decimal number to a string in Buffer.\r | |
139 | \r | |
140 | @param Buffer Location to place the Unicode or ASCII string of Value.\r | |
141 | @param Value Value to convert to a Decimal or Hexidecimal string in Buffer.\r | |
142 | @param Radix Radix of the value\r | |
143 | \r | |
144 | @return Number of characters printed.\r | |
145 | \r | |
146 | **/\r | |
147 | UINTN\r | |
e1f414b6 | 148 | BasePrintLibValueToString (\r |
149 | IN OUT CHAR8 *Buffer, \r | |
150 | IN INT64 Value, \r | |
151 | IN UINTN Radix\r | |
152 | );\r | |
153 | \r | |
154 | /**\r | |
155 | Internal function that converts a decimal value to a Null-terminated string.\r | |
156 | \r | |
157 | Converts the decimal number specified by Value to a Null-terminated \r | |
158 | string specified by Buffer containing at most Width characters.\r | |
159 | If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r | |
160 | The total number of characters placed in Buffer is returned.\r | |
161 | If the conversion contains more than Width characters, then only the first\r | |
162 | Width characters are returned, and the total number of characters \r | |
163 | required to perform the conversion is returned.\r | |
164 | Additional conversion parameters are specified in Flags. \r | |
165 | The Flags bit LEFT_JUSTIFY is always ignored.\r | |
166 | All conversions are left justified in Buffer.\r | |
167 | If Width is 0, PREFIX_ZERO is ignored in Flags.\r | |
168 | If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r | |
169 | are inserted every 3rd digit starting from the right.\r | |
170 | If Value is < 0, then the fist character in Buffer is a '-'.\r | |
171 | If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r | |
172 | then Buffer is padded with '0' characters so the combination of the optional '-' \r | |
173 | sign character, '0' characters, digit characters for Value, and the Null-terminator\r | |
174 | add up to Width characters.\r | |
175 | \r | |
176 | If Buffer is NULL, then ASSERT().\r | |
177 | If unsupported bits are set in Flags, then ASSERT().\r | |
178 | If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r | |
179 | \r | |
180 | @param Buffer Pointer to the output buffer for the produced Null-terminated\r | |
181 | string.\r | |
182 | @param Flags The bitmask of flags that specify left justification, zero pad,\r | |
183 | and commas.\r | |
184 | @param Value The 64-bit signed value to convert to a string.\r | |
185 | @param Width The maximum number of characters to place in Buffer, not including\r | |
186 | the Null-terminator.\r | |
187 | @param Increment Character increment in Buffer.\r | |
188 | \r | |
189 | @return Total number of characters required to perform the conversion.\r | |
190 | \r | |
191 | **/\r | |
192 | UINTN\r | |
193 | BasePrintLibConvertValueToString (\r | |
194 | IN OUT CHAR8 *Buffer,\r | |
195 | IN UINTN Flags,\r | |
196 | IN INT64 Value,\r | |
197 | IN UINTN Width,\r | |
198 | IN UINTN Increment\r | |
199 | );\r | |
200 | \r | |
201 | #endif\r |