2 Print Library internal worker functions.
4 Copyright (c) 2006 - 2011, 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 #include "PrintLibInternal.h"
17 #define WARNING_STATUS_NUMBER 4
18 #define ERROR_STATUS_NUMBER 24
20 GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 mHexStr
[] = {'0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'};
22 GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8
*mStatusString
[] = {
23 "Success", // RETURN_SUCCESS = 0
24 "Warning Unknown Glyph", // RETURN_WARN_UNKNOWN_GLYPH = 1
25 "Warning Delete Failure", // RETURN_WARN_DELETE_FAILURE = 2
26 "Warning Write Failure", // RETURN_WARN_WRITE_FAILURE = 3
27 "Warning Buffer Too Small", // RETURN_WARN_BUFFER_TOO_SMALL = 4
28 "Load Error", // RETURN_LOAD_ERROR = 1 | MAX_BIT
29 "Invalid Parameter", // RETURN_INVALID_PARAMETER = 2 | MAX_BIT
30 "Unsupported", // RETURN_UNSUPPORTED = 3 | MAX_BIT
31 "Bad Buffer Size", // RETURN_BAD_BUFFER_SIZE = 4 | MAX_BIT
32 "Buffer Too Small", // RETURN_BUFFER_TOO_SMALL, = 5 | MAX_BIT
33 "Not Ready", // RETURN_NOT_READY = 6 | MAX_BIT
34 "Device Error", // RETURN_DEVICE_ERROR = 7 | MAX_BIT
35 "Write Protected", // RETURN_WRITE_PROTECTED = 8 | MAX_BIT
36 "Out of Resources", // RETURN_OUT_OF_RESOURCES = 9 | MAX_BIT
37 "Volume Corrupt", // RETURN_VOLUME_CORRUPTED = 10 | MAX_BIT
38 "Volume Full", // RETURN_VOLUME_FULL = 11 | MAX_BIT
39 "No Media", // RETURN_NO_MEDIA = 12 | MAX_BIT
40 "Media changed", // RETURN_MEDIA_CHANGED = 13 | MAX_BIT
41 "Not Found", // RETURN_NOT_FOUND = 14 | MAX_BIT
42 "Access Denied", // RETURN_ACCESS_DENIED = 15 | MAX_BIT
43 "No Response", // RETURN_NO_RESPONSE = 16 | MAX_BIT
44 "No mapping", // RETURN_NO_MAPPING = 17 | MAX_BIT
45 "Time out", // RETURN_TIMEOUT = 18 | MAX_BIT
46 "Not started", // RETURN_NOT_STARTED = 19 | MAX_BIT
47 "Already started", // RETURN_ALREADY_STARTED = 20 | MAX_BIT
48 "Aborted", // RETURN_ABORTED = 21 | MAX_BIT
49 "ICMP Error", // RETURN_ICMP_ERROR = 22 | MAX_BIT
50 "TFTP Error", // RETURN_TFTP_ERROR = 23 | MAX_BIT
51 "Protocol Error" // RETURN_PROTOCOL_ERROR = 24 | MAX_BIT
56 Internal function that places the character into the Buffer.
58 Internal function that places ASCII or Unicode character into the Buffer.
60 @param Buffer The buffer to place the Unicode or ASCII string.
61 @param EndBuffer The end of the input Buffer. No characters will be
63 @param Length The count of character to be placed into Buffer.
64 (Negative value indicates no buffer fill.)
65 @param Character The character to be placed into Buffer.
66 @param Increment The character increment in Buffer.
72 BasePrintLibFillBuffer (
82 for (Index
= 0; Index
< Length
&& Buffer
< EndBuffer
; Index
++) {
83 *Buffer
= (CHAR8
) Character
;
85 *(Buffer
+ 1) = (CHAR8
)(Character
>> 8);
94 Internal function that convert a number to a string in Buffer.
96 Print worker function that converts a decimal or hexadecimal number to an ASCII string in Buffer.
98 @param Buffer Location to place the ASCII string of Value.
99 @param Value The value to convert to a Decimal or Hexadecimal string in Buffer.
100 @param Radix Radix of the value
102 @return A pointer to the end of buffer filled with ASCII string.
106 BasePrintLibValueToString (
107 IN OUT CHAR8
*Buffer
,
115 // Loop to convert one digit at a time in reverse order
119 Value
= (INT64
)DivU64x32Remainder ((UINT64
)Value
, (UINT32
)Radix
, &Remainder
);
120 *(++Buffer
) = mHexStr
[Remainder
];
121 } while (Value
!= 0);
124 // Return pointer of the end of filled buffer.
130 Internal function that converts a decimal value to a Null-terminated string.
132 Converts the decimal number specified by Value to a Null-terminated
133 string specified by Buffer containing at most Width characters.
134 If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.
135 The total number of characters placed in Buffer is returned.
136 If the conversion contains more than Width characters, then only the first
137 Width characters are returned, and the total number of characters
138 required to perform the conversion is returned.
139 Additional conversion parameters are specified in Flags.
140 The Flags bit LEFT_JUSTIFY is always ignored.
141 All conversions are left justified in Buffer.
142 If Width is 0, PREFIX_ZERO is ignored in Flags.
143 If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas
144 are inserted every 3rd digit starting from the right.
145 If Value is < 0, then the fist character in Buffer is a '-'.
146 If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored,
147 then Buffer is padded with '0' characters so the combination of the optional '-'
148 sign character, '0' characters, digit characters for Value, and the Null-terminator
149 add up to Width characters.
151 If Buffer is NULL, then ASSERT().
152 If unsupported bits are set in Flags, then ASSERT().
153 If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
155 @param Buffer The pointer to the output buffer for the produced Null-terminated
157 @param Flags The bitmask of flags that specify left justification, zero pad,
159 @param Value The 64-bit signed value to convert to a string.
160 @param Width The maximum number of characters to place in Buffer, not including
162 @param Increment The character increment in Buffer.
164 @return Total number of characters required to perform the conversion.
168 BasePrintLibConvertValueToString (
169 IN OUT CHAR8
*Buffer
,
176 CHAR8
*OriginalBuffer
;
178 CHAR8 ValueBuffer
[MAXIMUM_VALUE_CHARACTERS
];
179 CHAR8
*ValueBufferPtr
;
186 // Make sure Buffer is not NULL and Width < MAXIMUM
188 ASSERT (Buffer
!= NULL
);
189 ASSERT (Width
< MAXIMUM_VALUE_CHARACTERS
);
191 // Make sure Flags can only contain supported bits.
193 ASSERT ((Flags
& ~(LEFT_JUSTIFY
| COMMA_TYPE
| PREFIX_ZERO
| RADIX_HEX
)) == 0);
196 // If both COMMA_TYPE and RADIX_HEX are set, then ASSERT ()
198 ASSERT (((Flags
& COMMA_TYPE
) == 0) || ((Flags
& RADIX_HEX
) == 0));
200 OriginalBuffer
= Buffer
;
203 // Width is 0 or COMMA_TYPE is set, PREFIX_ZERO is ignored.
205 if (Width
== 0 || (Flags
& COMMA_TYPE
) != 0) {
206 Flags
&= (~PREFIX_ZERO
);
209 // If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.
212 Width
= MAXIMUM_VALUE_CHARACTERS
- 1;
215 // Set the tag for the end of the input Buffer.
217 EndBuffer
= Buffer
+ Width
* Increment
;
220 // Convert decimal negative
222 if ((Value
< 0) && ((Flags
& RADIX_HEX
) == 0)) {
224 Buffer
= BasePrintLibFillBuffer (Buffer
, EndBuffer
, 1, '-', Increment
);
229 // Count the length of the value string.
231 Radix
= ((Flags
& RADIX_HEX
) == 0)? 10 : 16;
232 ValueBufferPtr
= BasePrintLibValueToString (ValueBuffer
, Value
, Radix
);
233 Count
= ValueBufferPtr
- ValueBuffer
;
238 if ((Flags
& PREFIX_ZERO
) != 0) {
239 Buffer
= BasePrintLibFillBuffer (Buffer
, EndBuffer
, Width
- Count
, '0', Increment
);
243 // Print Comma type for every 3 characters
249 for (Index
= 0; Index
< Count
; Index
++) {
250 Buffer
= BasePrintLibFillBuffer (Buffer
, EndBuffer
, 1, *ValueBufferPtr
--, Increment
);
251 if ((Flags
& COMMA_TYPE
) != 0) {
255 if ((Index
+ 1) < Count
) {
256 Buffer
= BasePrintLibFillBuffer (Buffer
, EndBuffer
, 1, ',', Increment
);
263 // Print Null-terminator
265 BasePrintLibFillBuffer (Buffer
, EndBuffer
+ Increment
, 1, 0, Increment
);
267 return ((Buffer
- OriginalBuffer
) / Increment
);
271 Worker function that produces a Null-terminated string in an output buffer
272 based on a Null-terminated format string and a VA_LIST argument list.
274 VSPrint function to process format and place the results in Buffer. Since a
275 VA_LIST is used this routine allows the nesting of Vararg routines. Thus
276 this is the main print working routine.
278 If COUNT_ONLY_NO_PRINT is set in Flags, Buffer will not be modified at all.
280 @param[out] Buffer The character buffer to print the results of the
281 parsing of Format into.
282 @param[in] BufferSize The maximum number of characters to put into
284 @param[in] Flags Initial flags value.
285 Can only have FORMAT_UNICODE, OUTPUT_UNICODE,
286 and COUNT_ONLY_NO_PRINT set.
287 @param[in] Format A Null-terminated format string.
288 @param[in] VaListMarker VA_LIST style variable argument list consumed by
290 @param[in] BaseListMarker BASE_LIST style variable argument list consumed
291 by processing Format.
293 @return The number of characters printed not including the Null-terminator.
294 If COUNT_ONLY_NO_PRINT was set returns the same, but without any
295 modification to Buffer.
299 BasePrintLibSPrintMarker (
303 IN CONST CHAR8
*Format
,
304 IN VA_LIST VaListMarker
, OPTIONAL
305 IN BASE_LIST BaseListMarker OPTIONAL
308 CHAR8
*OriginalBuffer
;
310 CHAR8 ValueBuffer
[MAXIMUM_VALUE_CHARACTERS
];
311 UINT32 BytesPerOutputCharacter
;
312 UINTN BytesPerFormatCharacter
;
314 UINTN FormatCharacter
;
318 CONST CHAR8
*ArgumentString
;
324 INTN BytesPerArgumentCharacter
;
325 UINTN ArgumentCharacter
;
333 RETURN_STATUS Status
;
337 UINTN LengthToReturn
;
340 // If you change this code be sure to match the 2 versions of this function.
341 // Nearly identical logic is found in the BasePrintLib and
342 // DxePrintLibPrint2Protocol (both PrintLib instances).
345 if (Flags
& COUNT_ONLY_NO_PRINT
) {
346 if (BufferSize
== 0) {
351 // We can run without a Buffer for counting only.
353 if (BufferSize
== 0) {
356 ASSERT (Buffer
!= NULL
);
359 if (Flags
& OUTPUT_UNICODE
) {
360 BytesPerOutputCharacter
= 2;
362 BytesPerOutputCharacter
= 1;
368 // Reserve space for the Null terminator.
371 OriginalBuffer
= Buffer
;
374 // Set the tag for the end of the input Buffer.
376 EndBuffer
= Buffer
+ BufferSize
* BytesPerOutputCharacter
;
378 if ((Flags
& FORMAT_UNICODE
) != 0) {
380 // Make sure format string cannot contain more than PcdMaximumUnicodeStringLength
381 // Unicode characters if PcdMaximumUnicodeStringLength is not zero.
383 ASSERT (StrSize ((CHAR16
*) Format
) != 0);
384 BytesPerFormatCharacter
= 2;
388 // Make sure format string cannot contain more than PcdMaximumAsciiStringLength
389 // Ascii characters if PcdMaximumAsciiStringLength is not zero.
391 ASSERT (AsciiStrSize (Format
) != 0);
392 BytesPerFormatCharacter
= 1;
397 // Get the first character from the format string
399 FormatCharacter
= ((*Format
& 0xff) | (*(Format
+ 1) << 8)) & FormatMask
;
402 // Loop until the end of the format string is reached or the output buffer is full
404 while (FormatCharacter
!= 0 && Buffer
< EndBuffer
) {
406 // Clear all the flag bits except those that may have been passed in
408 Flags
&= (OUTPUT_UNICODE
| FORMAT_UNICODE
| COUNT_ONLY_NO_PRINT
);
411 // Set the default width to zero, and the default precision to 1
421 switch (FormatCharacter
) {
424 // Parse Flags and Width
426 for (Done
= FALSE
; !Done
; ) {
427 Format
+= BytesPerFormatCharacter
;
428 FormatCharacter
= ((*Format
& 0xff) | (*(Format
+ 1) << 8)) & FormatMask
;
429 switch (FormatCharacter
) {
434 Flags
|= LEFT_JUSTIFY
;
437 Flags
|= PREFIX_SIGN
;
440 Flags
|= PREFIX_BLANK
;
450 if ((Flags
& PRECISION
) == 0) {
451 Flags
|= PAD_TO_WIDTH
;
452 if (BaseListMarker
== NULL
) {
453 Width
= VA_ARG (VaListMarker
, UINTN
);
455 Width
= BASE_ARG (BaseListMarker
, UINTN
);
458 if (BaseListMarker
== NULL
) {
459 Precision
= VA_ARG (VaListMarker
, UINTN
);
461 Precision
= BASE_ARG (BaseListMarker
, UINTN
);
466 if ((Flags
& PRECISION
) == 0) {
467 Flags
|= PREFIX_ZERO
;
478 for (Count
= 0; ((FormatCharacter
>= '0') && (FormatCharacter
<= '9')); ){
479 Count
= (Count
* 10) + FormatCharacter
- '0';
480 Format
+= BytesPerFormatCharacter
;
481 FormatCharacter
= ((*Format
& 0xff) | (*(Format
+ 1) << 8)) & FormatMask
;
483 Format
-= BytesPerFormatCharacter
;
484 if ((Flags
& PRECISION
) == 0) {
485 Flags
|= PAD_TO_WIDTH
;
494 // Make no output if Format string terminates unexpectedly when
495 // looking up for flag, width, precision and type.
497 Format
-= BytesPerFormatCharacter
;
500 // break skipped on purpose.
509 // Handle each argument type
511 switch (FormatCharacter
) {
514 // Flag space, +, 0, L & l are invalid for type p.
516 Flags
&= ~(PREFIX_BLANK
| PREFIX_SIGN
| PREFIX_ZERO
| LONG_TYPE
);
517 if (sizeof (VOID
*) > 4) {
521 Flags
|= PREFIX_ZERO
;
523 // break skipped on purpose
528 // break skipped on purpose
531 if ((Flags
& LONG_TYPE
) == 0) {
533 // 'd','x', and 'X' that are not preceded by 'l' or 'L' are assumed to be type "int".
534 // This assumption is made so the format string definition is compatible with the ANSI C
535 // Specification for formatted strings. It is recommended that the Base Types be used
536 // everywhere, but in this one case, compliance with ANSI C is more important, and
537 // provides an implementation that is compatible with that largest possible set of CPU
538 // architectures. This is why the type "int" is used in this one case.
540 if (BaseListMarker
== NULL
) {
541 Value
= VA_ARG (VaListMarker
, int);
543 Value
= BASE_ARG (BaseListMarker
, int);
546 if (BaseListMarker
== NULL
) {
547 Value
= VA_ARG (VaListMarker
, INT64
);
549 Value
= BASE_ARG (BaseListMarker
, INT64
);
552 if ((Flags
& PREFIX_BLANK
) != 0) {
555 if ((Flags
& PREFIX_SIGN
) != 0) {
558 if ((Flags
& COMMA_TYPE
) != 0) {
561 if ((Flags
& RADIX_HEX
) == 0) {
564 Flags
&= (~PREFIX_ZERO
);
568 Flags
|= PREFIX_SIGN
;
575 if ((Flags
& LONG_TYPE
) == 0 && Value
< 0) {
577 // 'd','x', and 'X' that are not preceded by 'l' or 'L' are assumed to be type "int".
578 // This assumption is made so the format string definition is compatible with the ANSI C
579 // Specification for formatted strings. It is recommended that the Base Types be used
580 // everywhere, but in this one case, compliance with ANSI C is more important, and
581 // provides an implementation that is compatible with that largest possible set of CPU
582 // architectures. This is why the type "unsigned int" is used in this one case.
584 Value
= (unsigned int)Value
;
588 // Convert Value to a reversed string
590 Count
= BasePrintLibValueToString (ValueBuffer
, Value
, Radix
) - ValueBuffer
;
591 if (Value
== 0 && Precision
== 0) {
594 ArgumentString
= (CHAR8
*)ValueBuffer
+ Count
;
600 if (Comma
&& Count
!= 0) {
601 Count
+= ((Count
- 1) / 3);
607 Flags
|= ARGUMENT_REVERSED
;
609 if ((Flags
& PREFIX_ZERO
) != 0) {
610 if ((Flags
& LEFT_JUSTIFY
) == 0) {
611 if ((Flags
& PAD_TO_WIDTH
) != 0) {
612 if ((Flags
& PRECISION
) == 0) {
622 Flags
|= ARGUMENT_UNICODE
;
624 // break skipped on purpose
627 if (BaseListMarker
== NULL
) {
628 ArgumentString
= VA_ARG (VaListMarker
, CHAR8
*);
630 ArgumentString
= BASE_ARG (BaseListMarker
, CHAR8
*);
632 if (ArgumentString
== NULL
) {
633 Flags
&= (~ARGUMENT_UNICODE
);
634 ArgumentString
= "<null string>";
637 // Set the default precision for string to be zero if not specified.
639 if ((Flags
& PRECISION
) == 0) {
645 if (BaseListMarker
== NULL
) {
646 Character
= VA_ARG (VaListMarker
, UINTN
) & 0xffff;
648 Character
= BASE_ARG (BaseListMarker
, UINTN
) & 0xffff;
650 ArgumentString
= (CHAR8
*)&Character
;
651 Flags
|= ARGUMENT_UNICODE
;
655 if (BaseListMarker
== NULL
) {
656 TmpGuid
= VA_ARG (VaListMarker
, GUID
*);
658 TmpGuid
= BASE_ARG (BaseListMarker
, GUID
*);
660 if (TmpGuid
== NULL
) {
661 ArgumentString
= "<null guid>";
663 GuidData1
= ReadUnaligned32 (&(TmpGuid
->Data1
));
664 GuidData2
= ReadUnaligned16 (&(TmpGuid
->Data2
));
665 GuidData3
= ReadUnaligned16 (&(TmpGuid
->Data3
));
668 MAXIMUM_VALUE_CHARACTERS
,
670 "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
683 ArgumentString
= ValueBuffer
;
688 if (BaseListMarker
== NULL
) {
689 TmpTime
= VA_ARG (VaListMarker
, TIME
*);
691 TmpTime
= BASE_ARG (BaseListMarker
, TIME
*);
693 if (TmpTime
== NULL
) {
694 ArgumentString
= "<null time>";
698 MAXIMUM_VALUE_CHARACTERS
,
700 "%02d/%02d/%04d %02d:%02d",
707 ArgumentString
= ValueBuffer
;
712 if (BaseListMarker
== NULL
) {
713 Status
= VA_ARG (VaListMarker
, RETURN_STATUS
);
715 Status
= BASE_ARG (BaseListMarker
, RETURN_STATUS
);
717 ArgumentString
= ValueBuffer
;
718 if (RETURN_ERROR (Status
)) {
722 Index
= Status
& ~MAX_BIT
;
723 if (Index
> 0 && Index
<= ERROR_STATUS_NUMBER
) {
724 ArgumentString
= mStatusString
[Index
+ WARNING_STATUS_NUMBER
];
728 if (Index
<= WARNING_STATUS_NUMBER
) {
729 ArgumentString
= mStatusString
[Index
];
732 if (ArgumentString
== ValueBuffer
) {
733 BasePrintLibSPrint ((CHAR8
*) ValueBuffer
, MAXIMUM_VALUE_CHARACTERS
, 0, "%08X", Status
);
738 Format
+= BytesPerFormatCharacter
;
739 FormatCharacter
= ((*Format
& 0xff) | (*(Format
+ 1) << 8)) & FormatMask
;
740 if (FormatCharacter
== '\n') {
742 // Translate '\r\n' to '\r\n'
744 ArgumentString
= "\r\n";
747 // Translate '\r' to '\r'
749 ArgumentString
= "\r";
750 Format
-= BytesPerFormatCharacter
;
756 // Translate '\n' to '\r\n' and '\n\r' to '\r\n'
758 ArgumentString
= "\r\n";
759 Format
+= BytesPerFormatCharacter
;
760 FormatCharacter
= ((*Format
& 0xff) | (*(Format
+ 1) << 8)) & FormatMask
;
761 if (FormatCharacter
!= '\r') {
762 Format
-= BytesPerFormatCharacter
;
769 // if the type is '%' or unknown, then print it to the screen
771 ArgumentString
= (CHAR8
*)&FormatCharacter
;
772 Flags
|= ARGUMENT_UNICODE
;
778 Format
+= BytesPerFormatCharacter
;
779 FormatCharacter
= ((*Format
& 0xff) | (*(Format
+ 1) << 8)) & FormatMask
;
780 if (FormatCharacter
== '\n') {
782 // Translate '\r\n' to '\r\n'
784 ArgumentString
= "\r\n";
787 // Translate '\r' to '\r'
789 ArgumentString
= "\r";
790 Format
-= BytesPerFormatCharacter
;
796 // Translate '\n' to '\r\n' and '\n\r' to '\r\n'
798 ArgumentString
= "\r\n";
799 Format
+= BytesPerFormatCharacter
;
800 FormatCharacter
= ((*Format
& 0xff) | (*(Format
+ 1) << 8)) & FormatMask
;
801 if (FormatCharacter
!= '\r') {
802 Format
-= BytesPerFormatCharacter
;
807 ArgumentString
= (CHAR8
*)&FormatCharacter
;
808 Flags
|= ARGUMENT_UNICODE
;
813 // Retrieve the ArgumentString attriubutes
815 if ((Flags
& ARGUMENT_UNICODE
) != 0) {
816 ArgumentMask
= 0xffff;
817 BytesPerArgumentCharacter
= 2;
820 BytesPerArgumentCharacter
= 1;
822 if ((Flags
& ARGUMENT_REVERSED
) != 0) {
823 BytesPerArgumentCharacter
= -BytesPerArgumentCharacter
;
826 // Compute the number of characters in ArgumentString and store it in Count
827 // ArgumentString is either null-terminated, or it contains Precision characters
829 for (Count
= 0; Count
< Precision
|| ((Flags
& PRECISION
) == 0); Count
++) {
830 ArgumentCharacter
= ((ArgumentString
[Count
* BytesPerArgumentCharacter
] & 0xff) | ((ArgumentString
[Count
* BytesPerArgumentCharacter
+ 1]) << 8)) & ArgumentMask
;
831 if (ArgumentCharacter
== 0) {
837 if (Precision
< Count
) {
842 // Pad before the string
844 if ((Flags
& (PAD_TO_WIDTH
| LEFT_JUSTIFY
)) == (PAD_TO_WIDTH
)) {
845 if (Flags
& COUNT_ONLY_NO_PRINT
) {
846 LengthToReturn
+= ((Width
- Precision
) * BytesPerOutputCharacter
);
848 Buffer
= BasePrintLibFillBuffer (Buffer
, EndBuffer
, Width
- Precision
, ' ', BytesPerOutputCharacter
);
854 if (Flags
& COUNT_ONLY_NO_PRINT
) {
855 LengthToReturn
+= (1 * BytesPerOutputCharacter
);
857 Buffer
= BasePrintLibFillBuffer (Buffer
, EndBuffer
, 1, Prefix
, BytesPerOutputCharacter
);
860 if (Flags
& COUNT_ONLY_NO_PRINT
) {
861 LengthToReturn
+= ((Precision
- Count
) * BytesPerOutputCharacter
);
863 Buffer
= BasePrintLibFillBuffer (Buffer
, EndBuffer
, Precision
- Count
, '0', BytesPerOutputCharacter
);
866 if (Flags
& COUNT_ONLY_NO_PRINT
) {
867 LengthToReturn
+= ((Precision
- Count
) * BytesPerOutputCharacter
);
869 Buffer
= BasePrintLibFillBuffer (Buffer
, EndBuffer
, Precision
- Count
, ' ', BytesPerOutputCharacter
);
872 if (Flags
& COUNT_ONLY_NO_PRINT
) {
873 LengthToReturn
+= (1 * BytesPerOutputCharacter
);
875 Buffer
= BasePrintLibFillBuffer (Buffer
, EndBuffer
, 1, Prefix
, BytesPerOutputCharacter
);
881 // Output the Prefix character if it is present
889 // Copy the string into the output buffer performing the required type conversions
891 while (Index
< Count
) {
892 ArgumentCharacter
= ((*ArgumentString
& 0xff) | (*(ArgumentString
+ 1) << 8)) & ArgumentMask
;
894 if (Flags
& COUNT_ONLY_NO_PRINT
) {
895 LengthToReturn
+= (1 * BytesPerOutputCharacter
);
897 Buffer
= BasePrintLibFillBuffer (Buffer
, EndBuffer
, 1, ArgumentCharacter
, BytesPerOutputCharacter
);
899 ArgumentString
+= BytesPerArgumentCharacter
;
907 if (Flags
& COUNT_ONLY_NO_PRINT
) {
908 LengthToReturn
+= (1 * BytesPerOutputCharacter
);
910 Buffer
= BasePrintLibFillBuffer (Buffer
, EndBuffer
, 1, ',', BytesPerOutputCharacter
);
918 // Pad after the string
920 if ((Flags
& (PAD_TO_WIDTH
| LEFT_JUSTIFY
)) == (PAD_TO_WIDTH
| LEFT_JUSTIFY
)) {
921 if (Flags
& COUNT_ONLY_NO_PRINT
) {
922 LengthToReturn
+= ((Width
- Precision
) * BytesPerOutputCharacter
);
924 Buffer
= BasePrintLibFillBuffer (Buffer
, EndBuffer
, Width
- Precision
, ' ', BytesPerOutputCharacter
);
929 // Get the next character from the format string
931 Format
+= BytesPerFormatCharacter
;
934 // Get the next character from the format string
936 FormatCharacter
= ((*Format
& 0xff) | (*(Format
+ 1) << 8)) & FormatMask
;
939 if (Flags
& COUNT_ONLY_NO_PRINT
) {
940 return (LengthToReturn
/ BytesPerOutputCharacter
);
944 // Null terminate the Unicode or ASCII string
946 BasePrintLibFillBuffer (Buffer
, EndBuffer
+ BytesPerOutputCharacter
, 1, 0, BytesPerOutputCharacter
);
948 // Make sure output buffer cannot contain more than PcdMaximumUnicodeStringLength
949 // Unicode characters if PcdMaximumUnicodeStringLength is not zero.
951 ASSERT ((((Flags
& OUTPUT_UNICODE
) == 0)) || (StrSize ((CHAR16
*) OriginalBuffer
) != 0));
953 // Make sure output buffer cannot contain more than PcdMaximumAsciiStringLength
954 // ASCII characters if PcdMaximumAsciiStringLength is not zero.
956 ASSERT ((((Flags
& OUTPUT_UNICODE
) != 0)) || (AsciiStrSize (OriginalBuffer
) != 0));
958 return ((Buffer
- OriginalBuffer
) / BytesPerOutputCharacter
);
962 Worker function that produces a Null-terminated string in an output buffer
963 based on a Null-terminated format string and variable argument list.
965 VSPrint function to process format and place the results in Buffer. Since a
966 VA_LIST is used this routine allows the nesting of Vararg routines. Thus
967 this is the main print working routine
969 @param StartOfBuffer The character buffer to print the results of the parsing
971 @param BufferSize The maximum number of characters to put into buffer.
973 @param Flags Initial flags value.
974 Can only have FORMAT_UNICODE and OUTPUT_UNICODE set
975 @param FormatString A Null-terminated format string.
976 @param ... The variable argument list.
978 @return The number of characters printed.
984 OUT CHAR8
*StartOfBuffer
,
987 IN CONST CHAR8
*FormatString
,
993 VA_START (Marker
, FormatString
);
994 return BasePrintLibSPrintMarker (StartOfBuffer
, BufferSize
, Flags
, FormatString
, Marker
, NULL
);