2 Implementation for EFI_HII_FONT_PROTOCOL.
5 Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include "HiiDatabase.h"
19 EFI_GRAPHICS_OUTPUT_BLT_PIXEL mHiiEfiColors
[16] = {
23 {0x00, 0x00, 0x00, 0x00}, // BLACK
24 {0x98, 0x00, 0x00, 0x00}, // BLUE
25 {0x00, 0x98, 0x00, 0x00}, // GREEN
26 {0x98, 0x98, 0x00, 0x00}, // CYAN
27 {0x00, 0x00, 0x98, 0x00}, // RED
28 {0x98, 0x00, 0x98, 0x00}, // MAGENTA
29 {0x00, 0x98, 0x98, 0x00}, // BROWN
30 {0x98, 0x98, 0x98, 0x00}, // LIGHTGRAY
31 {0x30, 0x30, 0x30, 0x00}, // DARKGRAY - BRIGHT BLACK
32 {0xff, 0x00, 0x00, 0x00}, // LIGHTBLUE
33 {0x00, 0xff, 0x00, 0x00}, // LIGHTGREEN
34 {0xff, 0xff, 0x00, 0x00}, // LIGHTCYAN
35 {0x00, 0x00, 0xff, 0x00}, // LIGHTRED
36 {0xff, 0x00, 0xff, 0x00}, // LIGHTMAGENTA
37 {0x00, 0xff, 0xff, 0x00}, // YELLOW
38 {0xff, 0xff, 0xff, 0x00}, // WHITE
43 Insert a character cell information to the list specified by GlyphInfoList.
45 This is a internal function.
47 @param CharValue Unicode character value, which identifies a glyph
49 @param GlyphInfoList HII_GLYPH_INFO list head.
50 @param Cell Incoming character cell information.
52 @retval EFI_SUCCESS Cell information is added to the GlyphInfoList.
53 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
60 IN LIST_ENTRY
*GlyphInfoList
,
61 IN EFI_HII_GLYPH_INFO
*Cell
64 HII_GLYPH_INFO
*GlyphInfo
;
66 ASSERT (Cell
!= NULL
&& GlyphInfoList
!= NULL
);
68 GlyphInfo
= (HII_GLYPH_INFO
*) AllocateZeroPool (sizeof (HII_GLYPH_INFO
));
69 if (GlyphInfo
== NULL
) {
70 return EFI_OUT_OF_RESOURCES
;
74 // GlyphInfoList stores a list of default character cell information, each is
75 // identified by "CharId".
77 GlyphInfo
->Signature
= HII_GLYPH_INFO_SIGNATURE
;
78 GlyphInfo
->CharId
= CharValue
;
79 if (Cell
->AdvanceX
== 0) {
80 Cell
->AdvanceX
= Cell
->Width
;
82 CopyMem (&GlyphInfo
->Cell
, Cell
, sizeof (EFI_HII_GLYPH_INFO
));
83 InsertTailList (GlyphInfoList
, &GlyphInfo
->Entry
);
90 Get a character cell information from the list specified by GlyphInfoList.
92 This is a internal function.
94 @param CharValue Unicode character value, which identifies a glyph
96 @param GlyphInfoList HII_GLYPH_INFO list head.
97 @param Cell Buffer which stores output character cell
100 @retval EFI_SUCCESS Cell information is added to the GlyphInfoList.
101 @retval EFI_NOT_FOUND The character info specified by CharValue does
108 IN LIST_ENTRY
*GlyphInfoList
,
109 OUT EFI_HII_GLYPH_INFO
*Cell
112 HII_GLYPH_INFO
*GlyphInfo
;
115 ASSERT (Cell
!= NULL
&& GlyphInfoList
!= NULL
);
118 // Since the EFI_HII_GIBT_DEFAULTS block won't increment CharValueCurrent,
119 // the value of "CharId" of a default character cell which is used for a
120 // EFI_HII_GIBT_GLYPH_DEFAULT or EFI_HII_GIBT_GLYPHS_DEFAULT should be
121 // less or equal to the value of "CharValueCurrent" of this default block.
123 // For instance, if the CharId of a GlyphInfoList is {1, 3, 7}, a default glyph
124 // with CharValue equals "7" uses the GlyphInfo with CharId = 7;
125 // a default glyph with CharValue equals "6" uses the GlyphInfo with CharId = 3.
127 for (Link
= GlyphInfoList
->BackLink
; Link
!= GlyphInfoList
; Link
= Link
->BackLink
) {
128 GlyphInfo
= CR (Link
, HII_GLYPH_INFO
, Entry
, HII_GLYPH_INFO_SIGNATURE
);
129 if (GlyphInfo
->CharId
<= CharValue
) {
130 CopyMem (Cell
, &GlyphInfo
->Cell
, sizeof (EFI_HII_GLYPH_INFO
));
135 return EFI_NOT_FOUND
;
140 Convert the glyph for a single character into a bitmap.
142 This is a internal function.
144 @param Private HII database driver private data.
145 @param Char Character to retrieve.
146 @param StringInfo Points to the string font and color information
147 or NULL if the string should use the default
148 system font and color.
149 @param GlyphBuffer Buffer to store the retrieved bitmap data.
150 @param Cell Points to EFI_HII_GLYPH_INFO structure.
151 @param Attributes If not NULL, output the glyph attributes if any.
153 @retval EFI_SUCCESS Glyph bitmap outputted.
154 @retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer GlyphBuffer.
155 @retval EFI_NOT_FOUND The glyph was unknown can not be found.
156 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
161 IN HII_DATABASE_PRIVATE_DATA
*Private
,
163 IN EFI_FONT_INFO
*StringInfo
,
164 OUT UINT8
**GlyphBuffer
,
165 OUT EFI_HII_GLYPH_INFO
*Cell
,
166 OUT UINT8
*Attributes OPTIONAL
169 HII_DATABASE_RECORD
*Node
;
171 HII_SIMPLE_FONT_PACKAGE_INSTANCE
*SimpleFont
;
174 EFI_NARROW_GLYPH Narrow
;
176 HII_GLOBAL_FONT_INFO
*GlobalFont
;
178 EFI_NARROW_GLYPH
*NarrowPtr
;
179 EFI_WIDE_GLYPH
*WidePtr
;
181 if (GlyphBuffer
== NULL
|| Cell
== NULL
) {
182 return EFI_INVALID_PARAMETER
;
184 if (Private
== NULL
|| Private
->Signature
!= HII_DATABASE_PRIVATE_DATA_SIGNATURE
) {
185 return EFI_INVALID_PARAMETER
;
188 ZeroMem (Cell
, sizeof (EFI_HII_GLYPH_INFO
));
191 // If StringInfo is not NULL, it must point to an existing EFI_FONT_INFO rather
192 // than system default font and color.
193 // If NULL, try to find the character in simplified font packages since
194 // default system font is the fixed font (narrow or wide glyph).
196 if (StringInfo
!= NULL
) {
197 if(!IsFontInfoExisted (Private
, StringInfo
, NULL
, NULL
, &GlobalFont
)) {
198 return EFI_INVALID_PARAMETER
;
200 if (Attributes
!= NULL
) {
201 *Attributes
= PROPORTIONAL_GLYPH
;
203 return FindGlyphBlock (GlobalFont
->FontPackage
, Char
, GlyphBuffer
, Cell
, NULL
);
205 HeaderSize
= sizeof (EFI_HII_SIMPLE_FONT_PACKAGE_HDR
);
207 for (Link
= Private
->DatabaseList
.ForwardLink
; Link
!= &Private
->DatabaseList
; Link
= Link
->ForwardLink
) {
208 Node
= CR (Link
, HII_DATABASE_RECORD
, DatabaseEntry
, HII_DATABASE_RECORD_SIGNATURE
);
209 for (Link1
= Node
->PackageList
->SimpleFontPkgHdr
.ForwardLink
;
210 Link1
!= &Node
->PackageList
->SimpleFontPkgHdr
;
211 Link1
= Link1
->ForwardLink
213 SimpleFont
= CR (Link1
, HII_SIMPLE_FONT_PACKAGE_INSTANCE
, SimpleFontEntry
, HII_S_FONT_PACKAGE_SIGNATURE
);
215 // Search the narrow glyph array
217 NarrowPtr
= (EFI_NARROW_GLYPH
*) ((UINT8
*) (SimpleFont
->SimpleFontPkgHdr
) + HeaderSize
);
218 for (Index
= 0; Index
< SimpleFont
->SimpleFontPkgHdr
->NumberOfNarrowGlyphs
; Index
++) {
219 CopyMem (&Narrow
, NarrowPtr
+ Index
,sizeof (EFI_NARROW_GLYPH
));
220 if (Narrow
.UnicodeWeight
== Char
) {
221 *GlyphBuffer
= (UINT8
*) AllocateZeroPool (EFI_GLYPH_HEIGHT
);
222 if (*GlyphBuffer
== NULL
) {
223 return EFI_OUT_OF_RESOURCES
;
225 Cell
->Width
= EFI_GLYPH_WIDTH
;
226 Cell
->Height
= EFI_GLYPH_HEIGHT
;
227 Cell
->AdvanceX
= Cell
->Width
;
228 CopyMem (*GlyphBuffer
, Narrow
.GlyphCol1
, Cell
->Height
);
229 if (Attributes
!= NULL
) {
230 *Attributes
= (UINT8
) (Narrow
.Attributes
| NARROW_GLYPH
);
236 // Search the wide glyph array
238 WidePtr
= (EFI_WIDE_GLYPH
*) (NarrowPtr
+ SimpleFont
->SimpleFontPkgHdr
->NumberOfNarrowGlyphs
);
239 for (Index
= 0; Index
< SimpleFont
->SimpleFontPkgHdr
->NumberOfWideGlyphs
; Index
++) {
240 CopyMem (&Wide
, WidePtr
+ Index
, sizeof (EFI_WIDE_GLYPH
));
241 if (Wide
.UnicodeWeight
== Char
) {
242 *GlyphBuffer
= (UINT8
*) AllocateZeroPool (EFI_GLYPH_HEIGHT
* 2);
243 if (*GlyphBuffer
== NULL
) {
244 return EFI_OUT_OF_RESOURCES
;
246 Cell
->Width
= EFI_GLYPH_WIDTH
* 2;
247 Cell
->Height
= EFI_GLYPH_HEIGHT
;
248 Cell
->AdvanceX
= Cell
->Width
;
249 CopyMem (*GlyphBuffer
, Wide
.GlyphCol1
, EFI_GLYPH_HEIGHT
);
250 CopyMem (*GlyphBuffer
+ EFI_GLYPH_HEIGHT
, Wide
.GlyphCol2
, EFI_GLYPH_HEIGHT
);
251 if (Attributes
!= NULL
) {
252 *Attributes
= (UINT8
) (Wide
.Attributes
| EFI_GLYPH_WIDE
);
261 return EFI_NOT_FOUND
;
265 Convert bitmap data of the glyph to blt structure.
267 This is a internal function.
269 @param GlyphBuffer Buffer points to bitmap data of glyph.
270 @param Foreground The color of the "on" pixels in the glyph in the
272 @param Background The color of the "off" pixels in the glyph in the
274 @param ImageWidth Width of the whole image in pixels.
275 @param RowWidth The width of the text on the line, in pixels.
276 @param RowHeight The height of the line, in pixels.
277 @param Transparent If TRUE, the Background color is ignored and all
278 "off" pixels in the character's drawn will use the
279 pixel value from BltBuffer.
280 @param Origin On input, points to the origin of the to be
281 displayed character, on output, points to the
287 IN UINT8
*GlyphBuffer
,
288 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
,
289 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
,
290 IN UINT16 ImageWidth
,
293 IN BOOLEAN Transparent
,
294 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
**Origin
301 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Buffer
;
303 ASSERT (GlyphBuffer
!= NULL
&& Origin
!= NULL
&& *Origin
!= NULL
);
305 Height
= EFI_GLYPH_HEIGHT
;
306 Width
= EFI_GLYPH_WIDTH
;
309 // Move position to the left-top corner of char.
311 Buffer
= *Origin
- EFI_GLYPH_HEIGHT
* ImageWidth
;
314 // Char may be partially displayed when CLIP_X or CLIP_Y is not set.
316 if (RowHeight
< Height
) {
317 Height
= (UINT8
) RowHeight
;
319 if (RowWidth
< Width
) {
320 Width
= (UINT8
) RowWidth
;
323 for (Ypos
= 0; Ypos
< Height
; Ypos
++) {
324 for (Xpos
= 0; Xpos
< Width
; Xpos
++) {
325 if ((GlyphBuffer
[Ypos
] & (1 << (EFI_GLYPH_WIDTH
- Xpos
- 1))) != 0) {
326 Buffer
[Ypos
* ImageWidth
+ Xpos
] = Foreground
;
329 Buffer
[Ypos
* ImageWidth
+ Xpos
] = Background
;
335 *Origin
= *Origin
+ EFI_GLYPH_WIDTH
;
340 Convert bitmap data of the glyph to blt structure.
342 This is a internal function.
344 @param GlyphBuffer Buffer points to bitmap data of glyph.
345 @param Foreground The color of the "on" pixels in the glyph in the
347 @param Background The color of the "off" pixels in the glyph in the
349 @param ImageWidth Width of the whole image in pixels.
350 @param BaseLine BaseLine in the line.
351 @param RowWidth The width of the text on the line, in pixels.
352 @param RowHeight The height of the line, in pixels.
353 @param Transparent If TRUE, the Background color is ignored and all
354 "off" pixels in the character's drawn will use the
355 pixel value from BltBuffer.
356 @param Cell Points to EFI_HII_GLYPH_INFO structure.
357 @param Attributes The attribute of incoming glyph in GlyphBuffer.
358 @param Origin On input, points to the origin of the to be
359 displayed character, on output, points to the
366 IN UINT8
*GlyphBuffer
,
367 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
,
368 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
,
369 IN UINT16 ImageWidth
,
373 IN BOOLEAN Transparent
,
374 IN CONST EFI_HII_GLYPH_INFO
*Cell
,
376 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
**Origin
385 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
;
387 ASSERT (Origin
!= NULL
&& *Origin
!= NULL
&& Cell
!= NULL
);
390 // Only adjust origin position if char has no bitmap.
392 if (GlyphBuffer
== NULL
) {
393 *Origin
= *Origin
+ Cell
->AdvanceX
;
397 // Move position to the left-top corner of char.
399 BltBuffer
= *Origin
+ Cell
->OffsetX
- (Cell
->OffsetY
+ Cell
->Height
) * ImageWidth
;
400 YposOffset
= (UINT16
) (BaseLine
- (Cell
->OffsetY
+ Cell
->Height
));
403 // Since non-spacing key will be printed OR'd with the previous glyph, don't
406 if ((Attributes
& EFI_GLYPH_NON_SPACING
) == EFI_GLYPH_NON_SPACING
) {
411 // The glyph's upper left hand corner pixel is the most significant bit of the
412 // first bitmap byte.
414 for (Ypos
= 0; Ypos
< Cell
->Height
&& (((UINT32
) Ypos
+ YposOffset
) < RowHeight
); Ypos
++) {
415 OffsetY
= BITMAP_LEN_1_BIT (Cell
->Width
, Ypos
);
418 // All bits in these bytes are meaningful.
420 for (Xpos
= 0; Xpos
< Cell
->Width
/ 8; Xpos
++) {
421 Data
= *(GlyphBuffer
+ OffsetY
+ Xpos
);
422 for (Index
= 0; Index
< 8 && (((UINT32
) Xpos
* 8 + Index
+ Cell
->OffsetX
) < RowWidth
); Index
++) {
423 if ((Data
& (1 << (8 - Index
- 1))) != 0) {
424 BltBuffer
[Ypos
* ImageWidth
+ Xpos
* 8 + Index
] = Foreground
;
427 BltBuffer
[Ypos
* ImageWidth
+ Xpos
* 8 + Index
] = Background
;
433 if (Cell
->Width
% 8 != 0) {
435 // There are some padding bits in this byte. Ignore them.
437 Data
= *(GlyphBuffer
+ OffsetY
+ Xpos
);
438 for (Index
= 0; Index
< Cell
->Width
% 8 && (((UINT32
) Xpos
* 8 + Index
+ Cell
->OffsetX
) < RowWidth
); Index
++) {
439 if ((Data
& (1 << (8 - Index
- 1))) != 0) {
440 BltBuffer
[Ypos
* ImageWidth
+ Xpos
* 8 + Index
] = Foreground
;
443 BltBuffer
[Ypos
* ImageWidth
+ Xpos
* 8 + Index
] = Background
;
447 } // end of if (Width % 8...)
449 } // end of for (Ypos=0...)
451 *Origin
= *Origin
+ Cell
->AdvanceX
;
456 Convert bitmap data of the glyph to blt structure.
458 This is a internal function.
460 @param GlyphBuffer Buffer points to bitmap data of glyph.
461 @param Foreground The color of the "on" pixels in the glyph in the
463 @param Background The color of the "off" pixels in the glyph in the
465 @param ImageWidth Width of the whole image in pixels.
466 @param BaseLine BaseLine in the line.
467 @param RowWidth The width of the text on the line, in pixels.
468 @param RowHeight The height of the line, in pixels.
469 @param Transparent If TRUE, the Background color is ignored and all
470 "off" pixels in the character's drawn will use the
471 pixel value from BltBuffer.
472 @param Cell Points to EFI_HII_GLYPH_INFO structure.
473 @param Attributes The attribute of incoming glyph in GlyphBuffer.
474 @param Origin On input, points to the origin of the to be
475 displayed character, on output, points to the
478 @return Points to the address of next origin node in BltBuffer.
483 IN UINT8
*GlyphBuffer
,
484 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
,
485 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
,
486 IN UINT16 ImageWidth
,
490 IN BOOLEAN Transparent
,
491 IN CONST EFI_HII_GLYPH_INFO
*Cell
,
493 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
**Origin
496 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Buffer
;
498 ASSERT (Origin
!= NULL
&& *Origin
!= NULL
&& Cell
!= NULL
);
502 if ((Attributes
& EFI_GLYPH_NON_SPACING
) == EFI_GLYPH_NON_SPACING
) {
504 // This character is a non-spacing key, print it OR'd with the previous glyph.
505 // without advancing cursor.
507 Buffer
-= Cell
->AdvanceX
;
522 } else if ((Attributes
& EFI_GLYPH_WIDE
) == EFI_GLYPH_WIDE
) {
524 // This character is wide glyph, i.e. 16 pixels * 19 pixels.
525 // Draw it as two narrow glyphs.
539 GlyphBuffer
+ EFI_GLYPH_HEIGHT
,
549 } else if ((Attributes
& NARROW_GLYPH
) == NARROW_GLYPH
) {
551 // This character is narrow glyph, i.e. 8 pixels * 19 pixels.
564 } else if ((Attributes
& PROPORTIONAL_GLYPH
) == PROPORTIONAL_GLYPH
) {
566 // This character is proportional glyph, i.e. Cell->Width * Cell->Height pixels.
586 Write the output parameters of FindGlyphBlock().
588 This is a internal function.
590 @param BufferIn Buffer which stores the bitmap data of the found
592 @param BufferLen Length of BufferIn.
593 @param InputCell Buffer which stores cell information of the
595 @param GlyphBuffer Output the corresponding bitmap data of the found
596 block. It is the caller's responsibility to free
598 @param Cell Output cell information of the encoded bitmap.
599 @param GlyphBufferLen If not NULL, output the length of GlyphBuffer.
601 @retval EFI_SUCCESS The operation is performed successfully.
602 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
603 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
611 IN EFI_HII_GLYPH_INFO
*InputCell
,
612 OUT UINT8
**GlyphBuffer
, OPTIONAL
613 OUT EFI_HII_GLYPH_INFO
*Cell
, OPTIONAL
614 OUT UINTN
*GlyphBufferLen OPTIONAL
617 if (BufferIn
== NULL
|| InputCell
== NULL
) {
618 return EFI_INVALID_PARAMETER
;
622 CopyMem (Cell
, InputCell
, sizeof (EFI_HII_GLYPH_INFO
));
625 if (GlyphBuffer
!= NULL
&& BufferLen
> 0) {
626 *GlyphBuffer
= (UINT8
*) AllocateZeroPool (BufferLen
);
627 if (*GlyphBuffer
== NULL
) {
628 return EFI_OUT_OF_RESOURCES
;
630 CopyMem (*GlyphBuffer
, BufferIn
, BufferLen
);
633 if (GlyphBufferLen
!= NULL
) {
634 *GlyphBufferLen
= BufferLen
;
642 Parse all glyph blocks to find a glyph block specified by CharValue.
643 If CharValue = (CHAR16) (-1), collect all default character cell information
644 within this font package and backup its information.
646 @param FontPackage Hii string package instance.
647 @param CharValue Unicode character value, which identifies a glyph
649 @param GlyphBuffer Output the corresponding bitmap data of the found
650 block. It is the caller's responsibility to free
652 @param Cell Output cell information of the encoded bitmap.
653 @param GlyphBufferLen If not NULL, output the length of GlyphBuffer.
655 @retval EFI_SUCCESS The bitmap data is retrieved successfully.
656 @retval EFI_NOT_FOUND The specified CharValue does not exist in current
658 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
664 IN HII_FONT_PACKAGE_INSTANCE
*FontPackage
,
666 OUT UINT8
**GlyphBuffer
, OPTIONAL
667 OUT EFI_HII_GLYPH_INFO
*Cell
, OPTIONAL
668 OUT UINTN
*GlyphBufferLen OPTIONAL
676 EFI_HII_GIBT_GLYPHS_BLOCK Glyphs
;
679 EFI_HII_GLYPH_INFO DefaultCell
;
680 EFI_HII_GLYPH_INFO LocalCell
;
684 ASSERT (FontPackage
!= NULL
);
685 ASSERT (FontPackage
->Signature
== HII_FONT_PACKAGE_SIGNATURE
);
689 if (CharValue
== (CHAR16
) (-1)) {
691 // Collect the cell information specified in font package fixed header.
692 // Use CharValue =0 to represent this particular cell.
696 &FontPackage
->GlyphInfoList
,
697 (EFI_HII_GLYPH_INFO
*) ((UINT8
*) FontPackage
->FontPkgHdr
+ 3 * sizeof (UINT32
))
699 if (EFI_ERROR (Status
)) {
704 (UINT8
*) FontPackage
->FontPkgHdr
+ 3 * sizeof (UINT32
),
705 sizeof (EFI_HII_GLYPH_INFO
)
709 BlockPtr
= FontPackage
->GlyphBlock
;
713 while (*BlockPtr
!= EFI_HII_GIBT_END
) {
715 case EFI_HII_GIBT_DEFAULTS
:
717 // Collect all default character cell information specified by
718 // EFI_HII_GIBT_DEFAULTS.
720 if (CharValue
== (CHAR16
) (-1)) {
723 &FontPackage
->GlyphInfoList
,
724 (EFI_HII_GLYPH_INFO
*) (BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
))
726 if (EFI_ERROR (Status
)) {
731 BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
),
732 sizeof (EFI_HII_GLYPH_INFO
)
734 if (BaseLine
< LocalCell
.Height
+ LocalCell
.OffsetY
) {
735 BaseLine
= (UINT16
) (LocalCell
.Height
+ LocalCell
.OffsetY
);
737 if (MinOffsetY
> LocalCell
.OffsetY
) {
738 MinOffsetY
= LocalCell
.OffsetY
;
741 BlockPtr
+= sizeof (EFI_HII_GIBT_DEFAULTS_BLOCK
);
744 case EFI_HII_GIBT_DUPLICATE
:
745 if (CharCurrent
== CharValue
) {
746 CopyMem (&CharValue
, BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
), sizeof (CHAR16
));
748 BlockPtr
= FontPackage
->GlyphBlock
;
752 BlockPtr
+= sizeof (EFI_HII_GIBT_DUPLICATE_BLOCK
);
755 case EFI_HII_GIBT_EXT1
:
756 BlockPtr
+= *(UINT8
*)((UINTN
)BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
) + sizeof (UINT8
));
758 case EFI_HII_GIBT_EXT2
:
761 (UINT8
*)((UINTN
)BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
) + sizeof (UINT8
)),
764 BlockPtr
+= Length16
;
766 case EFI_HII_GIBT_EXT4
:
769 (UINT8
*)((UINTN
)BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
) + sizeof (UINT8
)),
772 BlockPtr
+= Length32
;
775 case EFI_HII_GIBT_GLYPH
:
778 BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
),
779 sizeof (EFI_HII_GLYPH_INFO
)
781 if (CharValue
== (CHAR16
) (-1)) {
782 if (BaseLine
< LocalCell
.Height
+ LocalCell
.OffsetY
) {
783 BaseLine
= (UINT16
) (LocalCell
.Height
+ LocalCell
.OffsetY
);
785 if (MinOffsetY
> LocalCell
.OffsetY
) {
786 MinOffsetY
= LocalCell
.OffsetY
;
789 BufferLen
= BITMAP_LEN_1_BIT (LocalCell
.Width
, LocalCell
.Height
);
790 if (CharCurrent
== CharValue
) {
791 return WriteOutputParam (
792 (UINT8
*)((UINTN
)BlockPtr
+ sizeof (EFI_HII_GIBT_GLYPH_BLOCK
) - sizeof (UINT8
)),
801 BlockPtr
+= sizeof (EFI_HII_GIBT_GLYPH_BLOCK
) - sizeof (UINT8
) + BufferLen
;
804 case EFI_HII_GIBT_GLYPHS
:
805 BlockPtr
+= sizeof (EFI_HII_GLYPH_BLOCK
);
806 CopyMem (&Glyphs
.Cell
, BlockPtr
, sizeof (EFI_HII_GLYPH_INFO
));
807 BlockPtr
+= sizeof (EFI_HII_GLYPH_INFO
);
808 CopyMem (&Glyphs
.Count
, BlockPtr
, sizeof (UINT16
));
809 BlockPtr
+= sizeof (UINT16
);
811 if (CharValue
== (CHAR16
) (-1)) {
812 if (BaseLine
< Glyphs
.Cell
.Height
+ Glyphs
.Cell
.OffsetY
) {
813 BaseLine
= (UINT16
) (Glyphs
.Cell
.Height
+ Glyphs
.Cell
.OffsetY
);
815 if (MinOffsetY
> Glyphs
.Cell
.OffsetY
) {
816 MinOffsetY
= Glyphs
.Cell
.OffsetY
;
820 BufferLen
= BITMAP_LEN_1_BIT (Glyphs
.Cell
.Width
, Glyphs
.Cell
.Height
);
821 for (Index
= 0; Index
< Glyphs
.Count
; Index
++) {
822 if (CharCurrent
+ Index
== CharValue
) {
823 return WriteOutputParam (
832 BlockPtr
+= BufferLen
;
834 CharCurrent
= (UINT16
) (CharCurrent
+ Glyphs
.Count
);
837 case EFI_HII_GIBT_GLYPH_DEFAULT
:
838 Status
= GetCell (CharCurrent
, &FontPackage
->GlyphInfoList
, &DefaultCell
);
839 if (EFI_ERROR (Status
)) {
842 if (CharValue
== (CHAR16
) (-1)) {
843 if (BaseLine
< DefaultCell
.Height
+ DefaultCell
.OffsetY
) {
844 BaseLine
= (UINT16
) (DefaultCell
.Height
+ DefaultCell
.OffsetY
);
846 if (MinOffsetY
> DefaultCell
.OffsetY
) {
847 MinOffsetY
= DefaultCell
.OffsetY
;
850 BufferLen
= BITMAP_LEN_1_BIT (DefaultCell
.Width
, DefaultCell
.Height
);
852 if (CharCurrent
== CharValue
) {
853 return WriteOutputParam (
854 BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
),
863 BlockPtr
+= sizeof (EFI_HII_GLYPH_BLOCK
) + BufferLen
;
866 case EFI_HII_GIBT_GLYPHS_DEFAULT
:
867 CopyMem (&Length16
, BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
), sizeof (UINT16
));
868 Status
= GetCell (CharCurrent
, &FontPackage
->GlyphInfoList
, &DefaultCell
);
869 if (EFI_ERROR (Status
)) {
872 if (CharValue
== (CHAR16
) (-1)) {
873 if (BaseLine
< DefaultCell
.Height
+ DefaultCell
.OffsetY
) {
874 BaseLine
= (UINT16
) (DefaultCell
.Height
+ DefaultCell
.OffsetY
);
876 if (MinOffsetY
> DefaultCell
.OffsetY
) {
877 MinOffsetY
= DefaultCell
.OffsetY
;
880 BufferLen
= BITMAP_LEN_1_BIT (DefaultCell
.Width
, DefaultCell
.Height
);
881 BlockPtr
+= sizeof (EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK
) - sizeof (UINT8
);
882 for (Index
= 0; Index
< Length16
; Index
++) {
883 if (CharCurrent
+ Index
== CharValue
) {
884 return WriteOutputParam (
893 BlockPtr
+= BufferLen
;
895 CharCurrent
= (UINT16
) (CharCurrent
+ Length16
);
898 case EFI_HII_GIBT_SKIP1
:
899 CharCurrent
= (UINT16
) (CharCurrent
+ (UINT16
) (*(BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
))));
900 BlockPtr
+= sizeof (EFI_HII_GIBT_SKIP1_BLOCK
);
902 case EFI_HII_GIBT_SKIP2
:
903 CopyMem (&Length16
, BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
), sizeof (UINT16
));
904 CharCurrent
= (UINT16
) (CharCurrent
+ Length16
);
905 BlockPtr
+= sizeof (EFI_HII_GIBT_SKIP2_BLOCK
);
912 if (CharValue
< CharCurrent
) {
913 return EFI_NOT_FOUND
;
917 if (CharValue
== (CHAR16
) (-1)) {
918 FontPackage
->BaseLine
= BaseLine
;
919 FontPackage
->Height
= (UINT16
) (BaseLine
- MinOffsetY
);
923 return EFI_NOT_FOUND
;
928 Copy a Font Name to a new created EFI_FONT_INFO structure.
930 This is a internal function.
932 @param FontName NULL-terminated string.
933 @param FontInfo a new EFI_FONT_INFO which stores the FontName.
934 It's caller's responsibility to free this buffer.
936 @retval EFI_SUCCESS FontInfo is allocated and copied with FontName.
937 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
943 IN EFI_STRING FontName
,
944 OUT EFI_FONT_INFO
**FontInfo
950 ASSERT (FontName
!= NULL
&& FontInfo
!= NULL
);
952 NameSize
= StrSize (FontName
);
953 FontInfoLen
= sizeof (EFI_FONT_INFO
) - sizeof (CHAR16
) + NameSize
;
954 *FontInfo
= (EFI_FONT_INFO
*) AllocateZeroPool (FontInfoLen
);
955 if (*FontInfo
== NULL
) {
956 return EFI_OUT_OF_RESOURCES
;
959 StrCpyS ((*FontInfo
)->FontName
, NameSize
/ sizeof (CHAR16
), FontName
);
965 Retrieve system default font and color.
967 @param Private HII database driver private data.
968 @param FontInfo Points to system default font output-related
969 information. It's caller's responsibility to free
971 @param FontInfoSize If not NULL, output the size of buffer FontInfo.
973 @retval EFI_SUCCESS Cell information is added to the GlyphInfoList.
974 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
976 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
981 IN HII_DATABASE_PRIVATE_DATA
*Private
,
982 OUT EFI_FONT_DISPLAY_INFO
**FontInfo
,
983 OUT UINTN
*FontInfoSize OPTIONAL
986 EFI_FONT_DISPLAY_INFO
*Info
;
990 if (Private
== NULL
|| Private
->Signature
!= HII_DATABASE_PRIVATE_DATA_SIGNATURE
) {
991 return EFI_INVALID_PARAMETER
;
993 if (FontInfo
== NULL
) {
994 return EFI_INVALID_PARAMETER
;
998 // The standard font always has the name "sysdefault".
1000 NameSize
= StrSize (L
"sysdefault");
1001 InfoSize
= sizeof (EFI_FONT_DISPLAY_INFO
) - sizeof (CHAR16
) + NameSize
;
1002 Info
= (EFI_FONT_DISPLAY_INFO
*) AllocateZeroPool (InfoSize
);
1004 return EFI_OUT_OF_RESOURCES
;
1007 Info
->ForegroundColor
= mHiiEfiColors
[Private
->Attribute
& 0x0f];
1008 Info
->BackgroundColor
= mHiiEfiColors
[Private
->Attribute
>> 4];
1009 Info
->FontInfoMask
= EFI_FONT_INFO_SYS_FONT
| EFI_FONT_INFO_SYS_SIZE
| EFI_FONT_INFO_SYS_STYLE
;
1010 Info
->FontInfo
.FontStyle
= 0;
1011 Info
->FontInfo
.FontSize
= EFI_GLYPH_HEIGHT
;
1012 StrCpyS (Info
->FontInfo
.FontName
, NameSize
/ sizeof (CHAR16
), L
"sysdefault");
1015 if (FontInfoSize
!= NULL
) {
1016 *FontInfoSize
= InfoSize
;
1023 Check whether EFI_FONT_DISPLAY_INFO points to system default font and color or
1024 returns the system default according to the optional inputs.
1026 This is a internal function.
1028 @param Private HII database driver private data.
1029 @param StringInfo Points to the string output information,
1030 including the color and font.
1031 @param SystemInfo If not NULL, points to system default font and color.
1033 @param SystemInfoLen If not NULL, output the length of default system
1036 @retval TRUE Yes, it points to system default.
1042 IN HII_DATABASE_PRIVATE_DATA
*Private
,
1043 IN EFI_FONT_DISPLAY_INFO
*StringInfo
,
1044 OUT EFI_FONT_DISPLAY_INFO
**SystemInfo
, OPTIONAL
1045 OUT UINTN
*SystemInfoLen OPTIONAL
1049 EFI_FONT_DISPLAY_INFO
*SystemDefault
;
1053 ASSERT (Private
!= NULL
&& Private
->Signature
== HII_DATABASE_PRIVATE_DATA_SIGNATURE
);
1055 if (StringInfo
== NULL
&& SystemInfo
== NULL
) {
1059 SystemDefault
= NULL
;
1062 Status
= GetSystemFont (Private
, &SystemDefault
, &DefaultLen
);
1063 ASSERT_EFI_ERROR (Status
);
1064 ASSERT ((SystemDefault
!= NULL
) && (DefaultLen
!= 0));
1067 // Record the system default info.
1069 if (SystemInfo
!= NULL
) {
1070 *SystemInfo
= SystemDefault
;
1073 if (SystemInfoLen
!= NULL
) {
1074 *SystemInfoLen
= DefaultLen
;
1077 if (StringInfo
== NULL
) {
1083 // Check the FontInfoMask to see whether it is retrieving system info.
1085 if ((StringInfo
->FontInfoMask
& (EFI_FONT_INFO_SYS_FONT
| EFI_FONT_INFO_ANY_FONT
)) == 0) {
1086 if (StrCmp (StringInfo
->FontInfo
.FontName
, SystemDefault
->FontInfo
.FontName
) != 0) {
1090 if ((StringInfo
->FontInfoMask
& (EFI_FONT_INFO_SYS_SIZE
| EFI_FONT_INFO_ANY_SIZE
)) == 0) {
1091 if (StringInfo
->FontInfo
.FontSize
!= SystemDefault
->FontInfo
.FontSize
) {
1095 if ((StringInfo
->FontInfoMask
& (EFI_FONT_INFO_SYS_STYLE
| EFI_FONT_INFO_ANY_STYLE
)) == 0) {
1096 if (StringInfo
->FontInfo
.FontStyle
!= SystemDefault
->FontInfo
.FontStyle
) {
1100 if ((StringInfo
->FontInfoMask
& EFI_FONT_INFO_SYS_FORE_COLOR
) == 0) {
1102 &StringInfo
->ForegroundColor
,
1103 &SystemDefault
->ForegroundColor
,
1104 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
1109 if ((StringInfo
->FontInfoMask
& EFI_FONT_INFO_SYS_BACK_COLOR
) == 0) {
1111 &StringInfo
->BackgroundColor
,
1112 &SystemDefault
->BackgroundColor
,
1113 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
1122 if (SystemInfo
== NULL
) {
1123 if (SystemDefault
!= NULL
) {
1124 FreePool (SystemDefault
);
1132 This function checks whether EFI_FONT_INFO exists in current database. If
1133 FontInfoMask is specified, check what options can be used to make a match.
1134 Note that the masks relate to where the system default should be supplied
1135 are ignored by this function.
1137 @param Private Hii database private structure.
1138 @param FontInfo Points to EFI_FONT_INFO structure.
1139 @param FontInfoMask If not NULL, describes what options can be used
1140 to make a match between the font requested and
1141 the font available. The caller must guarantee
1143 @param FontHandle On entry, Points to the font handle returned by a
1144 previous call to GetFontInfo() or NULL to start
1145 with the first font.
1146 @param GlobalFontInfo If not NULL, output the corresponding global font
1149 @retval TRUE Existed
1150 @retval FALSE Not existed
1155 IN HII_DATABASE_PRIVATE_DATA
*Private
,
1156 IN EFI_FONT_INFO
*FontInfo
,
1157 IN EFI_FONT_INFO_MASK
*FontInfoMask
, OPTIONAL
1158 IN EFI_FONT_HANDLE FontHandle
, OPTIONAL
1159 OUT HII_GLOBAL_FONT_INFO
**GlobalFontInfo OPTIONAL
1162 HII_GLOBAL_FONT_INFO
*GlobalFont
;
1163 HII_GLOBAL_FONT_INFO
*GlobalFontBackup1
;
1164 HII_GLOBAL_FONT_INFO
*GlobalFontBackup2
;
1166 EFI_FONT_INFO_MASK Mask
;
1168 BOOLEAN VagueMatched1
;
1169 BOOLEAN VagueMatched2
;
1171 ASSERT (Private
!= NULL
&& Private
->Signature
== HII_DATABASE_PRIVATE_DATA_SIGNATURE
);
1172 ASSERT (FontInfo
!= NULL
);
1175 // Matched flag represents an exactly match; VagueMatched1 represents a RESIZE
1176 // or RESTYLE match; VagueMatched2 represents a RESIZE | RESTYLE match.
1179 VagueMatched1
= FALSE
;
1180 VagueMatched2
= FALSE
;
1183 GlobalFontBackup1
= NULL
;
1184 GlobalFontBackup2
= NULL
;
1186 // The process of where the system default should be supplied instead of
1187 // the specified font info beyonds this function's scope.
1189 if (FontInfoMask
!= NULL
) {
1190 Mask
= *FontInfoMask
& (~SYS_FONT_INFO_MASK
);
1194 // If not NULL, FontHandle points to the next node of the last searched font
1195 // node by previous call.
1197 if (FontHandle
== NULL
) {
1198 Link
= Private
->FontInfoList
.ForwardLink
;
1200 Link
= (LIST_ENTRY
*) FontHandle
;
1203 for (; Link
!= &Private
->FontInfoList
; Link
= Link
->ForwardLink
) {
1204 GlobalFont
= CR (Link
, HII_GLOBAL_FONT_INFO
, Entry
, HII_GLOBAL_FONT_INFO_SIGNATURE
);
1205 if (FontInfoMask
== NULL
) {
1206 if (CompareMem (GlobalFont
->FontInfo
, FontInfo
, GlobalFont
->FontInfoSize
) == 0) {
1207 if (GlobalFontInfo
!= NULL
) {
1208 *GlobalFontInfo
= GlobalFont
;
1214 // Check which options could be used to make a match.
1217 case EFI_FONT_INFO_ANY_FONT
:
1218 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
&&
1219 GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1223 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_STYLE
:
1224 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1228 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_SIZE
:
1229 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1233 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_SIZE
| EFI_FONT_INFO_ANY_STYLE
:
1237 // If EFI_FONT_INFO_RESTYLE is specified, then the system may attempt to
1238 // remove some of the specified styles to meet the style requested.
1240 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_RESTYLE
:
1241 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1242 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1244 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1245 VagueMatched1
= TRUE
;
1246 GlobalFontBackup1
= GlobalFont
;
1251 // If EFI_FONT_INFO_RESIZE is specified, then the system may attempt to
1252 // stretch or shrink a font to meet the size requested.
1254 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_RESIZE
:
1255 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1256 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1259 VagueMatched1
= TRUE
;
1260 GlobalFontBackup1
= GlobalFont
;
1264 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_RESTYLE
| EFI_FONT_INFO_RESIZE
:
1265 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1266 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1269 VagueMatched1
= TRUE
;
1270 GlobalFontBackup1
= GlobalFont
;
1272 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1273 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1274 VagueMatched1
= TRUE
;
1275 GlobalFontBackup1
= GlobalFont
;
1277 VagueMatched2
= TRUE
;
1278 GlobalFontBackup2
= GlobalFont
;
1282 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_STYLE
| EFI_FONT_INFO_RESIZE
:
1283 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1286 VagueMatched1
= TRUE
;
1287 GlobalFontBackup1
= GlobalFont
;
1290 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_SIZE
| EFI_FONT_INFO_RESTYLE
:
1291 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1293 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1294 VagueMatched1
= TRUE
;
1295 GlobalFontBackup1
= GlobalFont
;
1298 case EFI_FONT_INFO_ANY_STYLE
:
1300 GlobalFont
->FontInfo
->FontName
,
1302 StrSize (FontInfo
->FontName
)
1304 GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1308 case EFI_FONT_INFO_ANY_STYLE
| EFI_FONT_INFO_ANY_SIZE
:
1310 GlobalFont
->FontInfo
->FontName
,
1312 StrSize (FontInfo
->FontName
)
1317 case EFI_FONT_INFO_ANY_STYLE
| EFI_FONT_INFO_RESIZE
:
1319 GlobalFont
->FontInfo
->FontName
,
1321 StrSize (FontInfo
->FontName
)
1323 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1326 VagueMatched1
= TRUE
;
1327 GlobalFontBackup1
= GlobalFont
;
1331 case EFI_FONT_INFO_ANY_SIZE
:
1333 GlobalFont
->FontInfo
->FontName
,
1335 StrSize (FontInfo
->FontName
)
1337 GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1341 case EFI_FONT_INFO_ANY_SIZE
| EFI_FONT_INFO_RESTYLE
:
1343 GlobalFont
->FontInfo
->FontName
,
1345 StrSize (FontInfo
->FontName
)
1347 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1349 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1350 VagueMatched1
= TRUE
;
1351 GlobalFontBackup1
= GlobalFont
;
1355 case EFI_FONT_INFO_RESTYLE
:
1357 GlobalFont
->FontInfo
->FontName
,
1359 StrSize (FontInfo
->FontName
)
1361 GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1363 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1365 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1366 VagueMatched1
= TRUE
;
1367 GlobalFontBackup1
= GlobalFont
;
1371 case EFI_FONT_INFO_RESIZE
:
1373 GlobalFont
->FontInfo
->FontName
,
1375 StrSize (FontInfo
->FontName
)
1377 GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1379 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1382 VagueMatched1
= TRUE
;
1383 GlobalFontBackup1
= GlobalFont
;
1387 case EFI_FONT_INFO_RESIZE
| EFI_FONT_INFO_RESTYLE
:
1389 GlobalFont
->FontInfo
->FontName
,
1391 StrSize (FontInfo
->FontName
)
1393 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1394 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1397 VagueMatched1
= TRUE
;
1398 GlobalFontBackup1
= GlobalFont
;
1400 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1401 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1402 VagueMatched1
= TRUE
;
1403 GlobalFontBackup1
= GlobalFont
;
1405 VagueMatched2
= TRUE
;
1406 GlobalFontBackup2
= GlobalFont
;
1416 if (GlobalFontInfo
!= NULL
) {
1417 *GlobalFontInfo
= GlobalFont
;
1424 if (VagueMatched1
) {
1425 if (GlobalFontInfo
!= NULL
) {
1426 *GlobalFontInfo
= GlobalFontBackup1
;
1429 } else if (VagueMatched2
) {
1430 if (GlobalFontInfo
!= NULL
) {
1431 *GlobalFontInfo
= GlobalFontBackup2
;
1441 Check whether the unicode represents a line break or not.
1443 This is a internal function. Please see Section 27.2.6 of the UEFI Specification
1444 for a description of the supported string format.
1446 @param Char Unicode character
1448 @retval 0 Yes, it forces a line break.
1449 @retval 1 Yes, it presents a line break opportunity
1450 @retval 2 Yes, it requires a line break happen before and after it.
1451 @retval -1 No, it is not a link break.
1461 // Mandatory line break characters, which force a line-break
1470 // Space characters, which is taken as a line-break opportunity
1486 // In-Word Break Opportunities
1491 // A space which is not a line-break opportunity
1496 // A hyphen which is not a line-break opportunity
1501 // Hyphen characters which describe line break opportunities after the character
1512 // A hyphen which describes line break opportunities before and after them, but not between a pair of them
1522 Renders a string to a bitmap or to the display.
1524 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
1525 @param Flags Describes how the string is to be drawn.
1526 @param String Points to the null-terminated string to be
1528 @param StringInfo Points to the string output information,
1529 including the color and font. If NULL, then the
1530 string will be output in the default system font
1532 @param Blt If this points to a non-NULL on entry, this
1533 points to the image, which is Width pixels wide
1534 and Height pixels high. The string will be drawn
1536 EFI_HII_OUT_FLAG_CLIP is implied. If this points
1537 to a NULL on entry, then a buffer
1538 will be allocated to hold the generated image and
1539 the pointer updated on exit. It is the caller's
1540 responsibility to free this buffer.
1541 @param BltX Specifies the offset from the left and top edge
1542 of the image of the first character cell in the
1544 @param BltY Specifies the offset from the left and top edge
1545 of the image of the first character cell in the
1547 @param RowInfoArray If this is non-NULL on entry, then on exit, this
1548 will point to an allocated buffer containing
1549 row information and RowInfoArraySize will be
1550 updated to contain the number of elements.
1551 This array describes the characters which were at
1552 least partially drawn and the heights of the
1553 rows. It is the caller's responsibility to free
1555 @param RowInfoArraySize If this is non-NULL on entry, then on exit it
1556 contains the number of elements in RowInfoArray.
1557 @param ColumnInfoArray If this is non-NULL, then on return it will be
1558 filled with the horizontal offset for each
1559 character in the string on the row where it is
1560 displayed. Non-printing characters will have
1561 the offset ~0. The caller is responsible to
1562 allocate a buffer large enough so that there
1563 is one entry for each character in the string,
1564 not including the null-terminator. It is possible
1565 when character display is normalized that some
1566 character cells overlap.
1568 @retval EFI_SUCCESS The string was successfully rendered.
1569 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
1570 RowInfoArray or Blt.
1571 @retval EFI_INVALID_PARAMETER The String or Blt was NULL.
1572 @retval EFI_INVALID_PARAMETER Flags were invalid combination..
1578 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
1579 IN EFI_HII_OUT_FLAGS Flags
,
1580 IN CONST EFI_STRING String
,
1581 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo OPTIONAL
,
1582 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
1585 OUT EFI_HII_ROW_INFO
**RowInfoArray OPTIONAL
,
1586 OUT UINTN
*RowInfoArraySize OPTIONAL
,
1587 OUT UINTN
*ColumnInfoArray OPTIONAL
1591 HII_DATABASE_PRIVATE_DATA
*Private
;
1593 EFI_HII_GLYPH_INFO
*Cell
;
1595 EFI_IMAGE_OUTPUT
*Image
;
1596 EFI_STRING StringPtr
;
1597 EFI_STRING StringTmp
;
1598 EFI_HII_ROW_INFO
*RowInfo
;
1602 UINTN LastLineHeight
;
1603 UINTN BaseLineOffset
;
1609 EFI_FONT_DISPLAY_INFO
*StringInfoOut
;
1610 EFI_FONT_DISPLAY_INFO
*SystemDefault
;
1611 EFI_FONT_HANDLE FontHandle
;
1612 EFI_STRING StringIn
;
1613 EFI_STRING StringIn2
;
1616 EFI_FONT_INFO
*FontInfo
;
1617 BOOLEAN SysFontFlag
;
1618 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
1619 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
1620 BOOLEAN Transparent
;
1621 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
;
1622 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BufferPtr
;
1626 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*RowBufferPtr
;
1627 HII_GLOBAL_FONT_INFO
*GlobalFont
;
1628 UINT32 PreInitBkgnd
;
1631 // Check incoming parameters.
1634 if (This
== NULL
|| String
== NULL
|| Blt
== NULL
) {
1635 return EFI_INVALID_PARAMETER
;
1639 // These two flag cannot be used if Blt is NULL upon entry.
1641 if ((Flags
& EFI_HII_OUT_FLAG_TRANSPARENT
) == EFI_HII_OUT_FLAG_TRANSPARENT
) {
1642 return EFI_INVALID_PARAMETER
;
1644 if ((Flags
& EFI_HII_OUT_FLAG_CLIP
) == EFI_HII_OUT_FLAG_CLIP
) {
1645 return EFI_INVALID_PARAMETER
;
1649 // These two flags require that EFI_HII_OUT_FLAG_CLIP be also set.
1651 if ((Flags
& (EFI_HII_OUT_FLAG_CLIP
| EFI_HII_OUT_FLAG_CLIP_CLEAN_X
)) == EFI_HII_OUT_FLAG_CLIP_CLEAN_X
) {
1652 return EFI_INVALID_PARAMETER
;
1654 if ((Flags
& (EFI_HII_OUT_FLAG_CLIP
| EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
)) == EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
) {
1655 return EFI_INVALID_PARAMETER
;
1658 // This flag cannot be used with EFI_HII_OUT_FLAG_CLEAN_X.
1660 if ((Flags
& (EFI_HII_OUT_FLAG_WRAP
| EFI_HII_OUT_FLAG_CLIP_CLEAN_X
)) == (EFI_HII_OUT_FLAG_WRAP
| EFI_HII_OUT_FLAG_CLIP_CLEAN_X
)) {
1661 return EFI_INVALID_PARAMETER
;
1666 // Create a new bitmap and draw the string onto this image.
1668 Image
= AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT
));
1669 if (Image
== NULL
) {
1670 return EFI_OUT_OF_RESOURCES
;
1673 Image
->Height
= 600;
1674 Image
->Image
.Bitmap
= AllocateZeroPool (Image
->Width
* Image
->Height
*sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
1675 if (Image
->Image
.Bitmap
== NULL
) {
1677 return EFI_OUT_OF_RESOURCES
;
1681 // Other flags are not permitted when Blt is NULL.
1683 Flags
&= EFI_HII_OUT_FLAG_WRAP
| EFI_HII_IGNORE_IF_NO_GLYPH
| EFI_HII_IGNORE_LINE_BREAK
;
1687 StrLength
= StrLen(String
);
1688 GlyphBuf
= (UINT8
**) AllocateZeroPool (StrLength
* sizeof (UINT8
*));
1689 ASSERT (GlyphBuf
!= NULL
);
1690 Cell
= (EFI_HII_GLYPH_INFO
*) AllocateZeroPool (StrLength
* sizeof (EFI_HII_GLYPH_INFO
));
1691 ASSERT (Cell
!= NULL
);
1692 Attributes
= (UINT8
*) AllocateZeroPool (StrLength
* sizeof (UINT8
));
1693 ASSERT (Attributes
!= NULL
);
1696 Status
= EFI_SUCCESS
;
1698 SystemDefault
= NULL
;
1702 // Calculate the string output information, including specified color and font .
1703 // If StringInfo does not points to system font info, it must indicate an existing
1706 StringInfoOut
= NULL
;
1708 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
1709 SysFontFlag
= IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, &SystemDefault
, NULL
);
1712 ASSERT (SystemDefault
!= NULL
);
1714 Height
= SystemDefault
->FontInfo
.FontSize
;
1715 BaseLine
= SystemDefault
->FontInfo
.FontSize
;
1716 Foreground
= SystemDefault
->ForegroundColor
;
1717 Background
= SystemDefault
->BackgroundColor
;
1721 // StringInfo must not be NULL if it is not system info.
1723 ASSERT (StringInfo
!= NULL
);
1724 Status
= HiiGetFontInfo (This
, &FontHandle
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, &StringInfoOut
, NULL
);
1725 if (Status
== EFI_NOT_FOUND
) {
1727 // The specified EFI_FONT_DISPLAY_INFO does not exist in current database.
1728 // Use the system font instead. Still use the color specified by StringInfo.
1732 Height
= SystemDefault
->FontInfo
.FontSize
;
1733 BaseLine
= SystemDefault
->FontInfo
.FontSize
;
1734 Foreground
= ((EFI_FONT_DISPLAY_INFO
*) StringInfo
)->ForegroundColor
;
1735 Background
= ((EFI_FONT_DISPLAY_INFO
*) StringInfo
)->BackgroundColor
;
1737 } else if (Status
== EFI_SUCCESS
) {
1738 FontInfo
= &StringInfoOut
->FontInfo
;
1739 IsFontInfoExisted (Private
, FontInfo
, NULL
, NULL
, &GlobalFont
);
1740 Height
= GlobalFont
->FontPackage
->Height
;
1741 BaseLine
= GlobalFont
->FontPackage
->BaseLine
;
1742 Foreground
= StringInfoOut
->ForegroundColor
;
1743 Background
= StringInfoOut
->BackgroundColor
;
1750 // Use the maximum height of font as the base line.
1751 // And, use the maximum height as line height.
1753 LineHeight
= Height
;
1754 LastLineHeight
= Height
;
1755 BaseLineOffset
= Height
- BaseLine
;
1758 // Parse the string to be displayed to drop some ignored characters.
1764 // Ignore line-break characters only. Hyphens or dash character will be displayed
1765 // without line-break opportunity.
1767 if ((Flags
& EFI_HII_IGNORE_LINE_BREAK
) == EFI_HII_IGNORE_LINE_BREAK
) {
1768 StringIn
= AllocateZeroPool (StrSize (StringPtr
));
1769 if (StringIn
== NULL
) {
1770 Status
= EFI_OUT_OF_RESOURCES
;
1773 StringTmp
= StringIn
;
1774 while (*StringPtr
!= 0) {
1775 if (IsLineBreak (*StringPtr
) == 0) {
1778 *StringTmp
++ = *StringPtr
++;
1782 StringPtr
= StringIn
;
1785 // If EFI_HII_IGNORE_IF_NO_GLYPH is set, then characters which have no glyphs
1786 // are not drawn. Otherwise they are replaced with Unicode character 0xFFFD.
1788 StringIn2
= AllocateZeroPool (StrSize (StringPtr
));
1789 if (StringIn2
== NULL
) {
1790 Status
= EFI_OUT_OF_RESOURCES
;
1794 StringTmp
= StringIn2
;
1795 StrLength
= StrLen(StringPtr
);
1796 while (*StringPtr
!= 0 && Index
< StrLength
) {
1797 if (IsLineBreak (*StringPtr
) == 0) {
1798 *StringTmp
++ = *StringPtr
++;
1803 Status
= GetGlyphBuffer (Private
, *StringPtr
, FontInfo
, &GlyphBuf
[Index
], &Cell
[Index
], &Attributes
[Index
]);
1804 if (Status
== EFI_NOT_FOUND
) {
1805 if ((Flags
& EFI_HII_IGNORE_IF_NO_GLYPH
) == EFI_HII_IGNORE_IF_NO_GLYPH
) {
1806 GlyphBuf
[Index
] = NULL
;
1807 ZeroMem (&Cell
[Index
], sizeof (Cell
[Index
]));
1808 Status
= EFI_SUCCESS
;
1811 // Unicode 0xFFFD must exist in current hii database if this flag is not set.
1813 Status
= GetGlyphBuffer (
1815 REPLACE_UNKNOWN_GLYPH
,
1821 if (EFI_ERROR (Status
)) {
1822 Status
= EFI_INVALID_PARAMETER
;
1827 if (EFI_ERROR (Status
)) {
1831 *StringTmp
++ = *StringPtr
++;
1835 StringPtr
= StringIn2
;
1838 // Draw the string according to the specified EFI_HII_OUT_FLAGS and Blt.
1839 // If Blt is not NULL, then EFI_HII_OUT_FLAG_CLIP is implied, render this string
1840 // to an existing image (bitmap or screen depending on flags) pointed by "*Blt".
1841 // Otherwise render this string to a new allocated image and output it.
1844 BufferPtr
= Image
->Image
.Bitmap
+ Image
->Width
* BltY
+ BltX
;
1845 if (Image
->Height
< BltY
) {
1847 // the top edge of the image should be in Image resolution scope.
1849 Status
= EFI_INVALID_PARAMETER
;
1852 MaxRowNum
= (UINT16
) ((Image
->Height
- BltY
) / Height
);
1853 if ((Image
->Height
- BltY
) % Height
!= 0) {
1854 LastLineHeight
= (Image
->Height
- BltY
) % Height
;
1858 RowInfo
= (EFI_HII_ROW_INFO
*) AllocateZeroPool (MaxRowNum
* sizeof (EFI_HII_ROW_INFO
));
1859 if (RowInfo
== NULL
) {
1860 Status
= EFI_OUT_OF_RESOURCES
;
1865 // Format the glyph buffer according to flags.
1867 Transparent
= (BOOLEAN
) ((Flags
& EFI_HII_OUT_FLAG_TRANSPARENT
) == EFI_HII_OUT_FLAG_TRANSPARENT
? TRUE
: FALSE
);
1869 for (RowIndex
= 0, Index
= 0; RowIndex
< MaxRowNum
&& StringPtr
[Index
] != 0; ) {
1874 // Clip the final row if the row's bottom-most on pixel cannot fit when
1875 // EFI_HII_OUT_FLAG_CLEAN_Y is set.
1877 if (RowIndex
== MaxRowNum
- 1) {
1878 if ((Flags
& EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
) == EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
&& LastLineHeight
< LineHeight
) {
1880 // Don't draw at all if the row's bottom-most on pixel cannot fit.
1884 LineHeight
= LastLineHeight
;
1888 // Calculate how many characters there are in a row.
1890 RowInfo
[RowIndex
].StartIndex
= Index
;
1892 while (LineWidth
+ BltX
< Image
->Width
&& StringPtr
[Index
] != 0) {
1893 if ((Flags
& EFI_HII_IGNORE_LINE_BREAK
) == 0 &&
1894 IsLineBreak (StringPtr
[Index
]) == 0) {
1896 // It forces a line break that ends this row.
1904 // If the glyph of the character is existing, then accumulate the actual printed width
1906 LineWidth
+= (UINTN
) Cell
[Index
].AdvanceX
;
1912 // Record index of next char.
1916 // Return to the previous char.
1919 if (LineBreak
&& Index
> 0 ) {
1921 // Return the previous non line break char.
1927 // If this character is the last character of a row, we need not
1928 // draw its (AdvanceX - Width - OffsetX) for next character.
1930 LineWidth
-= (Cell
[Index
].AdvanceX
- Cell
[Index
].Width
- Cell
[Index
].OffsetX
);
1933 // Clip the right-most character if cannot fit when EFI_HII_OUT_FLAG_CLEAN_X is set.
1935 if (LineWidth
+ BltX
<= Image
->Width
||
1936 (LineWidth
+ BltX
> Image
->Width
&& (Flags
& EFI_HII_OUT_FLAG_CLIP_CLEAN_X
) == 0)) {
1938 // Record right-most character in RowInfo even if it is partially displayed.
1940 RowInfo
[RowIndex
].EndIndex
= Index
;
1941 RowInfo
[RowIndex
].LineWidth
= LineWidth
;
1942 RowInfo
[RowIndex
].LineHeight
= LineHeight
;
1943 RowInfo
[RowIndex
].BaselineOffset
= BaseLineOffset
;
1946 // When EFI_HII_OUT_FLAG_CLEAN_X is set, it will not draw a character
1947 // if its right-most on pixel cannot fit.
1949 if (Index
> RowInfo
[RowIndex
].StartIndex
) {
1951 // Don't draw the last char on this row. And, don't draw the second last char (AdvanceX - Width - OffsetX).
1953 LineWidth
-= (Cell
[Index
].Width
+ Cell
[Index
].OffsetX
);
1954 LineWidth
-= (Cell
[Index
- 1].AdvanceX
- Cell
[Index
- 1].Width
- Cell
[Index
- 1].OffsetX
);
1955 RowInfo
[RowIndex
].EndIndex
= Index
- 1;
1956 RowInfo
[RowIndex
].LineWidth
= LineWidth
;
1957 RowInfo
[RowIndex
].LineHeight
= LineHeight
;
1958 RowInfo
[RowIndex
].BaselineOffset
= BaseLineOffset
;
1961 // There is no enough column to draw any character, so set current line width to zero.
1962 // And go to draw Next line if LineBreak is set.
1964 RowInfo
[RowIndex
].LineWidth
= 0;
1970 // EFI_HII_OUT_FLAG_WRAP will wrap the text at the right-most line-break
1971 // opportunity prior to a character whose right-most extent would exceed Width.
1972 // Search the right-most line-break opportunity here.
1974 if ((Flags
& EFI_HII_OUT_FLAG_WRAP
) == EFI_HII_OUT_FLAG_WRAP
&&
1975 (RowInfo
[RowIndex
].LineWidth
+ BltX
> Image
->Width
|| StringPtr
[NextIndex
] != 0) &&
1977 if ((Flags
& EFI_HII_IGNORE_LINE_BREAK
) == 0) {
1978 LineWidth
= RowInfo
[RowIndex
].LineWidth
;
1979 for (Index1
= RowInfo
[RowIndex
].EndIndex
; Index1
>= RowInfo
[RowIndex
].StartIndex
; Index1
--) {
1980 if (Index1
== RowInfo
[RowIndex
].EndIndex
) {
1981 LineWidth
-= (Cell
[Index1
].Width
+ Cell
[Index1
].OffsetX
);
1983 LineWidth
-= Cell
[Index1
].AdvanceX
;
1985 if (IsLineBreak (StringPtr
[Index1
]) > 0) {
1987 if (Index1
> RowInfo
[RowIndex
].StartIndex
) {
1988 RowInfo
[RowIndex
].EndIndex
= Index1
- 1;
1991 // relocate to the character after the right-most line break opportunity of this line
1993 NextIndex
= Index1
+ 1;
1997 // If don't find a line break opportunity from EndIndex to StartIndex,
2000 if (Index1
== RowInfo
[RowIndex
].StartIndex
)
2005 // Update LineWidth to the real width
2007 if (IsLineBreak (StringPtr
[Index1
]) > 0) {
2008 if (Index1
== RowInfo
[RowIndex
].StartIndex
) {
2011 LineWidth
-= (Cell
[Index1
- 1].AdvanceX
- Cell
[Index1
- 1].Width
- Cell
[Index1
- 1].OffsetX
);
2013 RowInfo
[RowIndex
].LineWidth
= LineWidth
;
2017 // If no line-break opportunity can be found, then the text will
2018 // behave as if EFI_HII_OUT_FLAG_CLEAN_X is set.
2021 LineWidth
= RowInfo
[RowIndex
].LineWidth
;
2022 Index1
= RowInfo
[RowIndex
].EndIndex
;
2023 if (LineWidth
+ BltX
> Image
->Width
) {
2024 if (Index1
> RowInfo
[RowIndex
].StartIndex
) {
2026 // Don't draw the last char on this row. And, don't draw the second last char (AdvanceX - Width - OffsetX).
2028 LineWidth
-= (Cell
[Index1
].Width
+ Cell
[Index1
].OffsetX
);
2029 LineWidth
-= (Cell
[Index1
- 1].AdvanceX
- Cell
[Index1
- 1].Width
- Cell
[Index1
- 1].OffsetX
);
2030 RowInfo
[RowIndex
].EndIndex
= Index1
- 1;
2031 RowInfo
[RowIndex
].LineWidth
= LineWidth
;
2034 // There is no enough column to draw any character, so set current line width to zero.
2035 // And go to draw Next line if LineBreak is set.
2037 RowInfo
[RowIndex
].LineWidth
= 0;
2045 // LineWidth can't exceed Image width.
2047 if (RowInfo
[RowIndex
].LineWidth
+ BltX
> Image
->Width
) {
2048 RowInfo
[RowIndex
].LineWidth
= Image
->Width
- BltX
;
2052 // Draw it to screen or existing bitmap depending on whether
2053 // EFI_HII_DIRECT_TO_SCREEN is set.
2056 if ((Flags
& EFI_HII_DIRECT_TO_SCREEN
) == EFI_HII_DIRECT_TO_SCREEN
) {
2058 if (RowInfo
[RowIndex
].LineWidth
!= 0) {
2059 BltBuffer
= AllocatePool (RowInfo
[RowIndex
].LineWidth
* RowInfo
[RowIndex
].LineHeight
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
2060 if (BltBuffer
== NULL
) {
2061 Status
= EFI_OUT_OF_RESOURCES
;
2065 // Initialize the background color.
2067 PreInitBkgnd
= Background
.Blue
| Background
.Green
<< 8 | Background
.Red
<< 16;
2068 SetMem32 (BltBuffer
,RowInfo
[RowIndex
].LineWidth
* RowInfo
[RowIndex
].LineHeight
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
),PreInitBkgnd
);
2070 // Set BufferPtr to Origin by adding baseline to the starting position.
2072 BufferPtr
= BltBuffer
+ BaseLine
* RowInfo
[RowIndex
].LineWidth
;
2074 for (Index1
= RowInfo
[RowIndex
].StartIndex
; Index1
<= RowInfo
[RowIndex
].EndIndex
; Index1
++) {
2075 if (RowInfo
[RowIndex
].LineWidth
> 0 && RowInfo
[RowIndex
].LineWidth
> LineOffset
) {
2077 // Only BLT these character which have corresponding glyph in font database.
2083 (UINT16
) RowInfo
[RowIndex
].LineWidth
,
2085 RowInfo
[RowIndex
].LineWidth
- LineOffset
,
2086 RowInfo
[RowIndex
].LineHeight
,
2093 if (ColumnInfoArray
!= NULL
) {
2094 if ((GlyphBuf
[Index1
] == NULL
&& Cell
[Index1
].AdvanceX
== 0)
2095 || RowInfo
[RowIndex
].LineWidth
== 0) {
2096 *ColumnInfoArray
= (UINTN
) ~0;
2098 *ColumnInfoArray
= LineOffset
+ Cell
[Index1
].OffsetX
+ BltX
;
2102 LineOffset
+= Cell
[Index1
].AdvanceX
;
2105 if (BltBuffer
!= NULL
) {
2106 Status
= Image
->Image
.Screen
->Blt (
2107 Image
->Image
.Screen
,
2109 EfiBltBufferToVideo
,
2114 RowInfo
[RowIndex
].LineWidth
,
2115 RowInfo
[RowIndex
].LineHeight
,
2118 if (EFI_ERROR (Status
)) {
2119 FreePool (BltBuffer
);
2123 FreePool (BltBuffer
);
2127 // Save the starting position for calculate the starting position of next row.
2129 RowBufferPtr
= BufferPtr
;
2131 // Set BufferPtr to Origin by adding baseline to the starting position.
2133 BufferPtr
= BufferPtr
+ BaseLine
* Image
->Width
;
2134 for (Index1
= RowInfo
[RowIndex
].StartIndex
; Index1
<= RowInfo
[RowIndex
].EndIndex
; Index1
++) {
2135 if (RowInfo
[RowIndex
].LineWidth
> 0 && RowInfo
[RowIndex
].LineWidth
> LineOffset
) {
2137 // Only BLT these character which have corresponding glyph in font database.
2145 RowInfo
[RowIndex
].LineWidth
- LineOffset
,
2146 RowInfo
[RowIndex
].LineHeight
,
2153 if (ColumnInfoArray
!= NULL
) {
2154 if ((GlyphBuf
[Index1
] == NULL
&& Cell
[Index1
].AdvanceX
== 0)
2155 || RowInfo
[RowIndex
].LineWidth
== 0) {
2156 *ColumnInfoArray
= (UINTN
) ~0;
2158 *ColumnInfoArray
= LineOffset
+ Cell
[Index1
].OffsetX
+ BltX
;
2162 LineOffset
+= Cell
[Index1
].AdvanceX
;
2166 // Jump to starting position of next row.
2168 if (RowIndex
== 0) {
2169 BufferPtr
= RowBufferPtr
- BltX
+ LineHeight
* Image
->Width
;
2171 BufferPtr
= RowBufferPtr
+ LineHeight
* Image
->Width
;
2177 // Recalculate the start point of Y axis to draw multi-lines with the order of top-to-down
2179 BltY
+= RowInfo
[RowIndex
].LineHeight
;
2186 // If there is not a mandatory line break or line break opportunity, only render one line to image
2193 // Write output parameters.
2195 RowInfoSize
= RowIndex
* sizeof (EFI_HII_ROW_INFO
);
2196 if (RowInfoArray
!= NULL
) {
2197 if (RowInfoSize
> 0) {
2198 *RowInfoArray
= AllocateZeroPool (RowInfoSize
);
2199 if (*RowInfoArray
== NULL
) {
2200 Status
= EFI_OUT_OF_RESOURCES
;
2203 CopyMem (*RowInfoArray
, RowInfo
, RowInfoSize
);
2205 *RowInfoArray
= NULL
;
2208 if (RowInfoArraySize
!= NULL
) {
2209 *RowInfoArraySize
= RowIndex
;
2212 Status
= EFI_SUCCESS
;
2216 for (Index
= 0; Index
< StrLength
; Index
++) {
2217 if (GlyphBuf
[Index
] != NULL
) {
2218 FreePool (GlyphBuf
[Index
]);
2221 if (StringIn
!= NULL
) {
2222 FreePool (StringIn
);
2224 if (StringIn2
!= NULL
) {
2225 FreePool (StringIn2
);
2227 if (StringInfoOut
!= NULL
) {
2228 FreePool (StringInfoOut
);
2230 if (RowInfo
!= NULL
) {
2233 if (SystemDefault
!= NULL
) {
2234 FreePool (SystemDefault
);
2236 if (GlyphBuf
!= NULL
) {
2237 FreePool (GlyphBuf
);
2242 if (Attributes
!= NULL
) {
2243 FreePool (Attributes
);
2251 Render a string to a bitmap or the screen containing the contents of the specified string.
2253 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
2254 @param Flags Describes how the string is to be drawn.
2255 @param PackageList The package list in the HII database to search
2256 for the specified string.
2257 @param StringId The string's id, which is unique within
2259 @param Language Points to the language for the retrieved string.
2260 If NULL, then the current system language is
2262 @param StringInfo Points to the string output information,
2263 including the color and font. If NULL, then the
2264 string will be output in the default system font
2266 @param Blt If this points to a non-NULL on entry, this
2267 points to the image, which is Width pixels wide
2268 and Height pixels high. The string will be drawn
2270 EFI_HII_OUT_FLAG_CLIP is implied. If this points
2271 to a NULL on entry, then a buffer
2272 will be allocated to hold the generated image and
2273 the pointer updated on exit. It is the caller's
2274 responsibility to free this buffer.
2275 @param BltX Specifies the offset from the left and top edge
2276 of the image of the first character cell in the
2278 @param BltY Specifies the offset from the left and top edge
2279 of the image of the first character cell in the
2281 @param RowInfoArray If this is non-NULL on entry, then on exit, this
2282 will point to an allocated buffer containing
2283 row information and RowInfoArraySize will be
2284 updated to contain the number of elements.
2285 This array describes the characters which were at
2286 least partially drawn and the heights of the
2287 rows. It is the caller's responsibility to free
2289 @param RowInfoArraySize If this is non-NULL on entry, then on exit it
2290 contains the number of elements in RowInfoArray.
2291 @param ColumnInfoArray If this is non-NULL, then on return it will be
2292 filled with the horizontal offset for each
2293 character in the string on the row where it is
2294 displayed. Non-printing characters will have
2295 the offset ~0. The caller is responsible to
2296 allocate a buffer large enough so that there
2297 is one entry for each character in the string,
2298 not including the null-terminator. It is possible
2299 when character display is normalized that some
2300 character cells overlap.
2302 @retval EFI_SUCCESS The string was successfully rendered.
2303 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
2304 RowInfoArray or Blt.
2305 @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.
2306 @retval EFI_INVALID_PARAMETER Flags were invalid combination.
2307 @retval EFI_NOT_FOUND The specified PackageList is not in the Database or the string id is not
2308 in the specified PackageList.
2313 HiiStringIdToImage (
2314 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
2315 IN EFI_HII_OUT_FLAGS Flags
,
2316 IN EFI_HII_HANDLE PackageList
,
2317 IN EFI_STRING_ID StringId
,
2318 IN CONST CHAR8
* Language
,
2319 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo OPTIONAL
,
2320 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
2323 OUT EFI_HII_ROW_INFO
**RowInfoArray OPTIONAL
,
2324 OUT UINTN
*RowInfoArraySize OPTIONAL
,
2325 OUT UINTN
*ColumnInfoArray OPTIONAL
2329 HII_DATABASE_PRIVATE_DATA
*Private
;
2330 EFI_HII_STRING_PROTOCOL
*HiiString
;
2335 EFI_FONT_INFO
*StringFontInfo
;
2336 EFI_FONT_DISPLAY_INFO
*NewStringInfo
;
2337 CHAR8 TempSupportedLanguages
;
2338 CHAR8
*SupportedLanguages
;
2339 UINTN SupportedLanguagesSize
;
2340 CHAR8
*CurrentLanguage
;
2341 CHAR8
*BestLanguage
;
2343 if (This
== NULL
|| PackageList
== NULL
|| Blt
== NULL
|| PackageList
== NULL
) {
2344 return EFI_INVALID_PARAMETER
;
2347 if (!IsHiiHandleValid (PackageList
)) {
2348 return EFI_NOT_FOUND
;
2352 // Initialize string pointers to be NULL
2354 SupportedLanguages
= NULL
;
2355 CurrentLanguage
= NULL
;
2356 BestLanguage
= NULL
;
2358 StringFontInfo
= NULL
;
2359 NewStringInfo
= NULL
;
2362 // Get the string to be displayed.
2364 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2365 HiiString
= &Private
->HiiString
;
2368 // Get the size of supported language.
2370 SupportedLanguagesSize
= 0;
2371 Status
= HiiString
->GetLanguages (
2374 &TempSupportedLanguages
,
2375 &SupportedLanguagesSize
2377 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
2381 SupportedLanguages
= AllocatePool (SupportedLanguagesSize
);
2382 if (SupportedLanguages
== NULL
) {
2383 return EFI_OUT_OF_RESOURCES
;
2386 Status
= HiiString
->GetLanguages (
2390 &SupportedLanguagesSize
2392 if (EFI_ERROR (Status
)) {
2396 if (Language
== NULL
) {
2399 GetEfiGlobalVariable2 (L
"PlatformLang", (VOID
**)&CurrentLanguage
, NULL
);
2400 BestLanguage
= GetBestLanguage (
2404 (CurrentLanguage
== NULL
) ? CurrentLanguage
: "",
2405 (CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLang
),
2408 if (BestLanguage
== NULL
) {
2409 Status
= EFI_NOT_FOUND
;
2413 StringSize
= MAX_STRING_LENGTH
;
2414 String
= (EFI_STRING
) AllocateZeroPool (StringSize
);
2415 if (String
== NULL
) {
2416 Status
= EFI_OUT_OF_RESOURCES
;
2420 Status
= HiiString
->GetString (
2429 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2431 String
= (EFI_STRING
) AllocateZeroPool (StringSize
);
2432 if (String
== NULL
) {
2433 Status
= EFI_OUT_OF_RESOURCES
;
2436 Status
= HiiString
->GetString (
2447 if (EFI_ERROR (Status
)) {
2452 // When StringInfo specifies that string will be output in the system default font and color,
2453 // use particular stringfontinfo described in string package instead if exists.
2454 // StringFontInfo equals NULL means system default font attaches with the string block.
2456 if (StringFontInfo
!= NULL
&& IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, NULL
, NULL
)) {
2457 NameSize
= StrSize (StringFontInfo
->FontName
);
2458 FontLen
= sizeof (EFI_FONT_DISPLAY_INFO
) - sizeof (CHAR16
) + NameSize
;
2459 NewStringInfo
= AllocateZeroPool (FontLen
);
2460 if (NewStringInfo
== NULL
) {
2461 Status
= EFI_OUT_OF_RESOURCES
;
2464 NewStringInfo
->FontInfoMask
= EFI_FONT_INFO_SYS_FORE_COLOR
| EFI_FONT_INFO_SYS_BACK_COLOR
;
2465 NewStringInfo
->FontInfo
.FontStyle
= StringFontInfo
->FontStyle
;
2466 NewStringInfo
->FontInfo
.FontSize
= StringFontInfo
->FontSize
;
2467 StrCpyS (NewStringInfo
->FontInfo
.FontName
, NameSize
/ sizeof (CHAR16
), StringFontInfo
->FontName
);
2469 Status
= HiiStringToImage (
2484 Status
= HiiStringToImage (
2498 if (SupportedLanguages
!= NULL
) {
2499 FreePool (SupportedLanguages
);
2501 if (CurrentLanguage
!= NULL
) {
2502 FreePool (CurrentLanguage
);
2504 if (BestLanguage
!= NULL
) {
2505 FreePool (BestLanguage
);
2507 if (String
!= NULL
) {
2510 if (StringFontInfo
!= NULL
) {
2511 FreePool (StringFontInfo
);
2513 if (NewStringInfo
!= NULL
) {
2514 FreePool (NewStringInfo
);
2522 Convert the glyph for a single character into a bitmap.
2524 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
2525 @param Char Character to retrieve.
2526 @param StringInfo Points to the string font and color information
2527 or NULL if the string should use the default
2528 system font and color.
2529 @param Blt Thus must point to a NULL on entry. A buffer will
2530 be allocated to hold the output and the pointer
2531 updated on exit. It is the caller's
2532 responsibility to free this buffer.
2533 @param Baseline Number of pixels from the bottom of the bitmap to
2536 @retval EFI_SUCCESS Glyph bitmap created.
2537 @retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer Blt.
2538 @retval EFI_WARN_UNKNOWN_GLYPH The glyph was unknown and was replaced with the
2539 glyph for Unicode character 0xFFFD.
2540 @retval EFI_INVALID_PARAMETER Blt is NULL or *Blt is not NULL.
2546 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
2548 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo
,
2549 OUT EFI_IMAGE_OUTPUT
**Blt
,
2550 OUT UINTN
*Baseline OPTIONAL
2554 HII_DATABASE_PRIVATE_DATA
*Private
;
2555 EFI_IMAGE_OUTPUT
*Image
;
2557 EFI_FONT_DISPLAY_INFO
*SystemDefault
;
2558 EFI_FONT_DISPLAY_INFO
*StringInfoOut
;
2560 EFI_FONT_HANDLE FontHandle
;
2562 EFI_HII_GLYPH_INFO Cell
;
2563 EFI_FONT_INFO
*FontInfo
;
2565 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
2566 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
2567 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
;
2570 if (This
== NULL
|| Blt
== NULL
|| *Blt
!= NULL
) {
2571 return EFI_INVALID_PARAMETER
;
2574 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2578 SystemDefault
= NULL
;
2582 StringInfoOut
= NULL
;
2585 ZeroMem (&Foreground
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
2586 ZeroMem (&Background
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
2588 Default
= IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, &SystemDefault
, NULL
);
2592 // Find out a EFI_FONT_DISPLAY_INFO which could display the character in
2593 // the specified color and font.
2595 String
= (EFI_STRING
) AllocateZeroPool (sizeof (CHAR16
) * 2);
2596 if (String
== NULL
) {
2597 Status
= EFI_OUT_OF_RESOURCES
;
2603 Status
= HiiGetFontInfo (This
, &FontHandle
, StringInfo
, &StringInfoOut
, String
);
2604 if (EFI_ERROR (Status
)) {
2607 ASSERT (StringInfoOut
!= NULL
);
2608 FontInfo
= &StringInfoOut
->FontInfo
;
2609 Foreground
= StringInfoOut
->ForegroundColor
;
2610 Background
= StringInfoOut
->BackgroundColor
;
2612 ASSERT (SystemDefault
!= NULL
);
2613 Foreground
= SystemDefault
->ForegroundColor
;
2614 Background
= SystemDefault
->BackgroundColor
;
2617 Status
= GetGlyphBuffer (Private
, Char
, FontInfo
, &GlyphBuffer
, &Cell
, &Attributes
);
2618 if (EFI_ERROR (Status
)) {
2622 Image
= (EFI_IMAGE_OUTPUT
*) AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT
));
2623 if (Image
== NULL
) {
2624 Status
= EFI_OUT_OF_RESOURCES
;
2627 Image
->Width
= Cell
.Width
;
2628 Image
->Height
= Cell
.Height
;
2630 if (Image
->Width
* Image
->Height
> 0) {
2631 Image
->Image
.Bitmap
= AllocateZeroPool (Image
->Width
* Image
->Height
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
2632 if (Image
->Image
.Bitmap
== NULL
) {
2634 Status
= EFI_OUT_OF_RESOURCES
;
2639 // Set BaseLine to the char height.
2641 BaseLine
= (UINT16
) (Cell
.Height
+ Cell
.OffsetY
);
2643 // Set BltBuffer to the position of Origin.
2645 BltBuffer
= Image
->Image
.Bitmap
+ (Cell
.Height
+ Cell
.OffsetY
) * Image
->Width
- Cell
.OffsetX
;
2652 Cell
.Width
+ Cell
.OffsetX
,
2653 BaseLine
- Cell
.OffsetY
,
2662 if (Baseline
!= NULL
) {
2663 *Baseline
= Cell
.OffsetY
;
2666 Status
= EFI_SUCCESS
;
2670 if (Status
== EFI_NOT_FOUND
) {
2672 // Glyph is unknown and replaced with the glyph for unicode character 0xFFFD
2674 if (Char
!= REPLACE_UNKNOWN_GLYPH
) {
2675 Status
= HiiGetGlyph (This
, REPLACE_UNKNOWN_GLYPH
, StringInfo
, Blt
, Baseline
);
2676 if (!EFI_ERROR (Status
)) {
2677 Status
= EFI_WARN_UNKNOWN_GLYPH
;
2680 Status
= EFI_WARN_UNKNOWN_GLYPH
;
2684 if (SystemDefault
!= NULL
) {
2685 FreePool (SystemDefault
);
2687 if (StringInfoOut
!= NULL
) {
2688 FreePool (StringInfoOut
);
2690 if (String
!= NULL
) {
2693 if (GlyphBuffer
!= NULL
) {
2694 FreePool (GlyphBuffer
);
2702 This function iterates through fonts which match the specified font, using
2703 the specified criteria. If String is non-NULL, then all of the characters in
2704 the string must exist in order for a candidate font to be returned.
2706 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
2707 @param FontHandle On entry, points to the font handle returned by a
2708 previous call to GetFontInfo() or NULL to start
2709 with the first font. On return, points to the
2710 returned font handle or points to NULL if there
2711 are no more matching fonts.
2712 @param StringInfoIn Upon entry, points to the font to return information
2713 about. If NULL, then the information about the system
2714 default font will be returned.
2715 @param StringInfoOut Upon return, contains the matching font's information.
2716 If NULL, then no information is returned. This buffer
2717 is allocated with a call to the Boot Service AllocatePool().
2718 It is the caller's responsibility to call the Boot
2719 Service FreePool() when the caller no longer requires
2720 the contents of StringInfoOut.
2721 @param String Points to the string which will be tested to
2722 determine if all characters are available. If
2723 NULL, then any font is acceptable.
2725 @retval EFI_SUCCESS Matching font returned successfully.
2726 @retval EFI_NOT_FOUND No matching font was found.
2727 @retval EFI_INVALID_PARAMETER StringInfoIn->FontInfoMask is an invalid combination.
2728 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the
2735 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
2736 IN OUT EFI_FONT_HANDLE
*FontHandle
,
2737 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfoIn
, OPTIONAL
2738 OUT EFI_FONT_DISPLAY_INFO
**StringInfoOut
,
2739 IN CONST EFI_STRING String OPTIONAL
2742 HII_DATABASE_PRIVATE_DATA
*Private
;
2744 EFI_FONT_DISPLAY_INFO
*SystemDefault
;
2745 EFI_FONT_DISPLAY_INFO InfoOut
;
2746 UINTN StringInfoOutLen
;
2747 EFI_FONT_INFO
*FontInfo
;
2748 HII_GLOBAL_FONT_INFO
*GlobalFont
;
2749 EFI_STRING StringIn
;
2750 EFI_FONT_HANDLE LocalFontHandle
;
2753 return EFI_INVALID_PARAMETER
;
2756 StringInfoOutLen
= 0;
2758 SystemDefault
= NULL
;
2759 LocalFontHandle
= NULL
;
2760 if (FontHandle
!= NULL
) {
2761 LocalFontHandle
= *FontHandle
;
2764 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2767 // Already searched to the end of the whole list, return directly.
2769 if (LocalFontHandle
== &Private
->FontInfoList
) {
2770 LocalFontHandle
= NULL
;
2771 Status
= EFI_NOT_FOUND
;
2776 // Get default system display info, if StringInfoIn points to
2777 // system display info, return it directly.
2779 if (IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfoIn
, &SystemDefault
, &StringInfoOutLen
)) {
2781 // System font is the first node. When handle is not NULL, system font can not
2782 // be found any more.
2784 if (LocalFontHandle
== NULL
) {
2785 if (StringInfoOut
!= NULL
) {
2786 *StringInfoOut
= AllocateCopyPool (StringInfoOutLen
, SystemDefault
);
2787 if (*StringInfoOut
== NULL
) {
2788 Status
= EFI_OUT_OF_RESOURCES
;
2789 LocalFontHandle
= NULL
;
2794 LocalFontHandle
= Private
->FontInfoList
.ForwardLink
;
2795 Status
= EFI_SUCCESS
;
2798 LocalFontHandle
= NULL
;
2799 Status
= EFI_NOT_FOUND
;
2805 // StringInfoIn must not be NULL if it is not system default font info.
2807 ASSERT (StringInfoIn
!= NULL
);
2809 // Check the font information mask to make sure it is valid.
2811 if (((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_SYS_FONT
| EFI_FONT_INFO_ANY_FONT
)) ==
2812 (EFI_FONT_INFO_SYS_FONT
| EFI_FONT_INFO_ANY_FONT
)) ||
2813 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_SYS_SIZE
| EFI_FONT_INFO_ANY_SIZE
)) ==
2814 (EFI_FONT_INFO_SYS_SIZE
| EFI_FONT_INFO_ANY_SIZE
)) ||
2815 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_SYS_STYLE
| EFI_FONT_INFO_ANY_STYLE
)) ==
2816 (EFI_FONT_INFO_SYS_STYLE
| EFI_FONT_INFO_ANY_STYLE
)) ||
2817 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_RESIZE
| EFI_FONT_INFO_ANY_SIZE
)) ==
2818 (EFI_FONT_INFO_RESIZE
| EFI_FONT_INFO_ANY_SIZE
)) ||
2819 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_RESTYLE
| EFI_FONT_INFO_ANY_STYLE
)) ==
2820 (EFI_FONT_INFO_RESTYLE
| EFI_FONT_INFO_ANY_STYLE
))) {
2821 return EFI_INVALID_PARAMETER
;
2825 // Parse the font information mask to find a matching font.
2828 CopyMem (&InfoOut
, (EFI_FONT_DISPLAY_INFO
*) StringInfoIn
, sizeof (EFI_FONT_DISPLAY_INFO
));
2830 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_FONT
) == EFI_FONT_INFO_SYS_FONT
) {
2831 Status
= SaveFontName (SystemDefault
->FontInfo
.FontName
, &FontInfo
);
2833 Status
= SaveFontName (((EFI_FONT_DISPLAY_INFO
*) StringInfoIn
)->FontInfo
.FontName
, &FontInfo
);
2835 if (EFI_ERROR (Status
)) {
2839 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_SIZE
) == EFI_FONT_INFO_SYS_SIZE
) {
2840 InfoOut
.FontInfo
.FontSize
= SystemDefault
->FontInfo
.FontSize
;
2842 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_STYLE
) == EFI_FONT_INFO_SYS_STYLE
) {
2843 InfoOut
.FontInfo
.FontStyle
= SystemDefault
->FontInfo
.FontStyle
;
2845 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_FORE_COLOR
) == EFI_FONT_INFO_SYS_FORE_COLOR
) {
2846 InfoOut
.ForegroundColor
= SystemDefault
->ForegroundColor
;
2848 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_BACK_COLOR
) == EFI_FONT_INFO_SYS_BACK_COLOR
) {
2849 InfoOut
.BackgroundColor
= SystemDefault
->BackgroundColor
;
2852 ASSERT (FontInfo
!= NULL
);
2853 FontInfo
->FontSize
= InfoOut
.FontInfo
.FontSize
;
2854 FontInfo
->FontStyle
= InfoOut
.FontInfo
.FontStyle
;
2856 if (IsFontInfoExisted (Private
, FontInfo
, &InfoOut
.FontInfoMask
, LocalFontHandle
, &GlobalFont
)) {
2858 // Test to guarantee all characters are available in the found font.
2860 if (String
!= NULL
) {
2862 while (*StringIn
!= 0) {
2863 Status
= FindGlyphBlock (GlobalFont
->FontPackage
, *StringIn
, NULL
, NULL
, NULL
);
2864 if (EFI_ERROR (Status
)) {
2865 LocalFontHandle
= NULL
;
2872 // Write to output parameter
2874 if (StringInfoOut
!= NULL
) {
2875 StringInfoOutLen
= sizeof (EFI_FONT_DISPLAY_INFO
) - sizeof (EFI_FONT_INFO
) + GlobalFont
->FontInfoSize
;
2876 *StringInfoOut
= (EFI_FONT_DISPLAY_INFO
*) AllocateZeroPool (StringInfoOutLen
);
2877 if (*StringInfoOut
== NULL
) {
2878 Status
= EFI_OUT_OF_RESOURCES
;
2879 LocalFontHandle
= NULL
;
2883 CopyMem (*StringInfoOut
, &InfoOut
, sizeof (EFI_FONT_DISPLAY_INFO
));
2884 CopyMem (&(*StringInfoOut
)->FontInfo
, GlobalFont
->FontInfo
, GlobalFont
->FontInfoSize
);
2887 LocalFontHandle
= GlobalFont
->Entry
.ForwardLink
;
2888 Status
= EFI_SUCCESS
;
2892 Status
= EFI_NOT_FOUND
;
2896 if (FontHandle
!= NULL
) {
2897 *FontHandle
= LocalFontHandle
;
2900 if (SystemDefault
!= NULL
) {
2901 FreePool (SystemDefault
);
2903 if (FontInfo
!= NULL
) {
2904 FreePool (FontInfo
);