2 Implementation for EFI_HII_FONT_PROTOCOL.
5 Copyright (c) 2007 - 2012, 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 wil 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 wil 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
&& ((UINTN
) (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 && ((UINTN
) (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 && ((UINTN
) (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 wil 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 responsiblity 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 responsiblity 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
)
707 BaseLine
= (UINT16
) (LocalCell
.Height
+ LocalCell
.OffsetY
);
708 if (MinOffsetY
> LocalCell
.OffsetY
) {
709 MinOffsetY
= LocalCell
.OffsetY
;
713 BlockPtr
= FontPackage
->GlyphBlock
;
717 while (*BlockPtr
!= EFI_HII_GIBT_END
) {
719 case EFI_HII_GIBT_DEFAULTS
:
721 // Collect all default character cell information specified by
722 // EFI_HII_GIBT_DEFAULTS.
724 if (CharValue
== (CHAR16
) (-1)) {
727 &FontPackage
->GlyphInfoList
,
728 (EFI_HII_GLYPH_INFO
*) (BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
))
730 if (EFI_ERROR (Status
)) {
735 BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
),
736 sizeof (EFI_HII_GLYPH_INFO
)
738 if (BaseLine
< LocalCell
.Height
+ LocalCell
.OffsetY
) {
739 BaseLine
= (UINT16
) (LocalCell
.Height
+ LocalCell
.OffsetY
);
741 if (MinOffsetY
> LocalCell
.OffsetY
) {
742 MinOffsetY
= LocalCell
.OffsetY
;
745 BlockPtr
+= sizeof (EFI_HII_GIBT_DEFAULTS_BLOCK
);
748 case EFI_HII_GIBT_DUPLICATE
:
749 if (CharCurrent
== CharValue
) {
750 CopyMem (&CharValue
, BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
), sizeof (CHAR16
));
752 BlockPtr
= FontPackage
->GlyphBlock
;
756 BlockPtr
+= sizeof (EFI_HII_GIBT_DUPLICATE_BLOCK
);
759 case EFI_HII_GIBT_EXT1
:
760 BlockPtr
+= *(BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
) + sizeof (UINT8
));
762 case EFI_HII_GIBT_EXT2
:
765 BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
) + sizeof (UINT8
),
768 BlockPtr
+= Length16
;
770 case EFI_HII_GIBT_EXT4
:
773 BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
) + sizeof (UINT8
),
776 BlockPtr
+= Length32
;
779 case EFI_HII_GIBT_GLYPH
:
782 BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
),
783 sizeof (EFI_HII_GLYPH_INFO
)
785 if (CharValue
== (CHAR16
) (-1)) {
786 if (BaseLine
< LocalCell
.Height
+ LocalCell
.OffsetY
) {
787 BaseLine
= (UINT16
) (LocalCell
.Height
+ LocalCell
.OffsetY
);
789 if (MinOffsetY
> LocalCell
.OffsetY
) {
790 MinOffsetY
= LocalCell
.OffsetY
;
793 BufferLen
= BITMAP_LEN_1_BIT (LocalCell
.Width
, LocalCell
.Height
);
794 if (CharCurrent
== CharValue
) {
795 return WriteOutputParam (
796 BlockPtr
+ sizeof (EFI_HII_GIBT_GLYPH_BLOCK
) - sizeof (UINT8
),
805 BlockPtr
+= sizeof (EFI_HII_GIBT_GLYPH_BLOCK
) - sizeof (UINT8
) + BufferLen
;
808 case EFI_HII_GIBT_GLYPHS
:
809 BlockPtr
+= sizeof (EFI_HII_GLYPH_BLOCK
);
810 CopyMem (&Glyphs
.Cell
, BlockPtr
, sizeof (EFI_HII_GLYPH_INFO
));
811 BlockPtr
+= sizeof (EFI_HII_GLYPH_INFO
);
812 CopyMem (&Glyphs
.Count
, BlockPtr
, sizeof (UINT16
));
813 BlockPtr
+= sizeof (UINT16
);
815 if (CharValue
== (CHAR16
) (-1)) {
816 if (BaseLine
< Glyphs
.Cell
.Height
+ Glyphs
.Cell
.OffsetY
) {
817 BaseLine
= (UINT16
) (Glyphs
.Cell
.Height
+ Glyphs
.Cell
.OffsetY
);
819 if (MinOffsetY
> Glyphs
.Cell
.OffsetY
) {
820 MinOffsetY
= Glyphs
.Cell
.OffsetY
;
824 BufferLen
= BITMAP_LEN_1_BIT (Glyphs
.Cell
.Width
, Glyphs
.Cell
.Height
);
825 for (Index
= 0; Index
< Glyphs
.Count
; Index
++) {
826 if (CharCurrent
+ Index
== CharValue
) {
827 return WriteOutputParam (
836 BlockPtr
+= BufferLen
;
838 CharCurrent
= (UINT16
) (CharCurrent
+ Glyphs
.Count
);
841 case EFI_HII_GIBT_GLYPH_DEFAULT
:
842 Status
= GetCell (CharCurrent
, &FontPackage
->GlyphInfoList
, &DefaultCell
);
843 if (EFI_ERROR (Status
)) {
846 BufferLen
= BITMAP_LEN_1_BIT (DefaultCell
.Width
, DefaultCell
.Height
);
848 if (CharCurrent
== CharValue
) {
849 return WriteOutputParam (
850 BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
),
859 BlockPtr
+= sizeof (EFI_HII_GLYPH_BLOCK
) + BufferLen
;
862 case EFI_HII_GIBT_GLYPHS_DEFAULT
:
863 CopyMem (&Length16
, BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
), sizeof (UINT16
));
864 Status
= GetCell (CharCurrent
, &FontPackage
->GlyphInfoList
, &DefaultCell
);
865 if (EFI_ERROR (Status
)) {
868 BufferLen
= BITMAP_LEN_1_BIT (DefaultCell
.Width
, DefaultCell
.Height
);
869 BlockPtr
+= sizeof (EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK
) - sizeof (UINT8
);
870 for (Index
= 0; Index
< Length16
; Index
++) {
871 if (CharCurrent
+ Index
== CharValue
) {
872 return WriteOutputParam (
881 BlockPtr
+= BufferLen
;
883 CharCurrent
= (UINT16
) (CharCurrent
+ Length16
);
886 case EFI_HII_GIBT_SKIP1
:
887 CharCurrent
= (UINT16
) (CharCurrent
+ (UINT16
) (*(BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
))));
888 BlockPtr
+= sizeof (EFI_HII_GIBT_SKIP1_BLOCK
);
890 case EFI_HII_GIBT_SKIP2
:
891 CopyMem (&Length16
, BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
), sizeof (UINT16
));
892 CharCurrent
= (UINT16
) (CharCurrent
+ Length16
);
893 BlockPtr
+= sizeof (EFI_HII_GIBT_SKIP2_BLOCK
);
900 if (CharValue
< CharCurrent
) {
901 return EFI_NOT_FOUND
;
905 if (CharValue
== (CHAR16
) (-1)) {
906 FontPackage
->BaseLine
= BaseLine
;
907 FontPackage
->Height
= (UINT16
) (BaseLine
- MinOffsetY
);
911 return EFI_NOT_FOUND
;
916 Copy a Font Name to a new created EFI_FONT_INFO structure.
918 This is a internal function.
920 @param FontName NULL-terminated string.
921 @param FontInfo a new EFI_FONT_INFO which stores the FontName.
922 It's caller's responsibility to free this buffer.
924 @retval EFI_SUCCESS FontInfo is allocated and copied with FontName.
925 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
931 IN EFI_STRING FontName
,
932 OUT EFI_FONT_INFO
**FontInfo
937 ASSERT (FontName
!= NULL
&& FontInfo
!= NULL
);
939 FontInfoLen
= sizeof (EFI_FONT_INFO
) - sizeof (CHAR16
) + StrSize (FontName
);
940 *FontInfo
= (EFI_FONT_INFO
*) AllocateZeroPool (FontInfoLen
);
941 if (*FontInfo
== NULL
) {
942 return EFI_OUT_OF_RESOURCES
;
945 StrCpy ((*FontInfo
)->FontName
, FontName
);
951 Retrieve system default font and color.
953 @param Private HII database driver private data.
954 @param FontInfo Points to system default font output-related
955 information. It's caller's responsibility to free
957 @param FontInfoSize If not NULL, output the size of buffer FontInfo.
959 @retval EFI_SUCCESS Cell information is added to the GlyphInfoList.
960 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
962 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
967 IN HII_DATABASE_PRIVATE_DATA
*Private
,
968 OUT EFI_FONT_DISPLAY_INFO
**FontInfo
,
969 OUT UINTN
*FontInfoSize OPTIONAL
972 EFI_FONT_DISPLAY_INFO
*Info
;
975 if (Private
== NULL
|| Private
->Signature
!= HII_DATABASE_PRIVATE_DATA_SIGNATURE
) {
976 return EFI_INVALID_PARAMETER
;
978 if (FontInfo
== NULL
) {
979 return EFI_INVALID_PARAMETER
;
983 // The standard font always has the name "sysdefault".
985 InfoSize
= sizeof (EFI_FONT_DISPLAY_INFO
) - sizeof (CHAR16
) + StrSize (L
"sysdefault");
986 Info
= (EFI_FONT_DISPLAY_INFO
*) AllocateZeroPool (InfoSize
);
988 return EFI_OUT_OF_RESOURCES
;
991 Info
->ForegroundColor
= mHiiEfiColors
[Private
->Attribute
& 0x0f];
992 Info
->BackgroundColor
= mHiiEfiColors
[Private
->Attribute
>> 4];
993 Info
->FontInfoMask
= EFI_FONT_INFO_SYS_FONT
| EFI_FONT_INFO_SYS_SIZE
| EFI_FONT_INFO_SYS_STYLE
;
994 Info
->FontInfo
.FontStyle
= 0;
995 Info
->FontInfo
.FontSize
= EFI_GLYPH_HEIGHT
;
996 StrCpy (Info
->FontInfo
.FontName
, L
"sysdefault");
999 if (FontInfoSize
!= NULL
) {
1000 *FontInfoSize
= InfoSize
;
1007 Check whether EFI_FONT_DISPLAY_INFO points to system default font and color or
1008 returns the system default according to the optional inputs.
1010 This is a internal function.
1012 @param Private HII database driver private data.
1013 @param StringInfo Points to the string output information,
1014 including the color and font.
1015 @param SystemInfo If not NULL, points to system default font and color.
1017 @param SystemInfoLen If not NULL, output the length of default system
1020 @retval TRUE Yes, it points to system default.
1026 IN HII_DATABASE_PRIVATE_DATA
*Private
,
1027 IN EFI_FONT_DISPLAY_INFO
*StringInfo
,
1028 OUT EFI_FONT_DISPLAY_INFO
**SystemInfo
, OPTIONAL
1029 OUT UINTN
*SystemInfoLen OPTIONAL
1033 EFI_FONT_DISPLAY_INFO
*SystemDefault
;
1037 ASSERT (Private
!= NULL
&& Private
->Signature
== HII_DATABASE_PRIVATE_DATA_SIGNATURE
);
1039 if (StringInfo
== NULL
&& SystemInfo
== NULL
) {
1043 Status
= GetSystemFont (Private
, &SystemDefault
, &DefaultLen
);
1044 ASSERT_EFI_ERROR (Status
);
1047 // Record the system default info.
1049 if (SystemInfo
!= NULL
) {
1050 *SystemInfo
= SystemDefault
;
1053 if (SystemInfoLen
!= NULL
) {
1054 *SystemInfoLen
= DefaultLen
;
1057 if (StringInfo
== NULL
) {
1063 // Check the FontInfoMask to see whether it is retrieving system info.
1065 if ((StringInfo
->FontInfoMask
& (EFI_FONT_INFO_SYS_FONT
| EFI_FONT_INFO_ANY_FONT
)) == 0) {
1066 if (StrCmp (StringInfo
->FontInfo
.FontName
, SystemDefault
->FontInfo
.FontName
) != 0) {
1070 if ((StringInfo
->FontInfoMask
& (EFI_FONT_INFO_SYS_SIZE
| EFI_FONT_INFO_ANY_SIZE
)) == 0) {
1071 if (StringInfo
->FontInfo
.FontSize
!= SystemDefault
->FontInfo
.FontSize
) {
1075 if ((StringInfo
->FontInfoMask
& (EFI_FONT_INFO_SYS_STYLE
| EFI_FONT_INFO_ANY_STYLE
)) == 0) {
1076 if (StringInfo
->FontInfo
.FontStyle
!= SystemDefault
->FontInfo
.FontStyle
) {
1080 if ((StringInfo
->FontInfoMask
& EFI_FONT_INFO_SYS_FORE_COLOR
) == 0) {
1082 &StringInfo
->ForegroundColor
,
1083 &SystemDefault
->ForegroundColor
,
1084 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
1089 if ((StringInfo
->FontInfoMask
& EFI_FONT_INFO_SYS_BACK_COLOR
) == 0) {
1091 &StringInfo
->BackgroundColor
,
1092 &SystemDefault
->BackgroundColor
,
1093 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
1102 if (SystemInfo
== NULL
) {
1103 if (SystemDefault
!= NULL
) {
1104 FreePool (SystemDefault
);
1112 This function checks whether EFI_FONT_INFO exists in current database. If
1113 FontInfoMask is specified, check what options can be used to make a match.
1114 Note that the masks relate to where the system default should be supplied
1115 are ignored by this function.
1117 @param Private Hii database private structure.
1118 @param FontInfo Points to EFI_FONT_INFO structure.
1119 @param FontInfoMask If not NULL, describes what options can be used
1120 to make a match between the font requested and
1121 the font available. The caller must guarantee
1123 @param FontHandle On entry, Points to the font handle returned by a
1124 previous call to GetFontInfo() or NULL to start
1125 with the first font.
1126 @param GlobalFontInfo If not NULL, output the corresponding globa font
1129 @retval TRUE Existed
1130 @retval FALSE Not existed
1135 IN HII_DATABASE_PRIVATE_DATA
*Private
,
1136 IN EFI_FONT_INFO
*FontInfo
,
1137 IN EFI_FONT_INFO_MASK
*FontInfoMask
, OPTIONAL
1138 IN EFI_FONT_HANDLE FontHandle
, OPTIONAL
1139 OUT HII_GLOBAL_FONT_INFO
**GlobalFontInfo OPTIONAL
1142 HII_GLOBAL_FONT_INFO
*GlobalFont
;
1143 HII_GLOBAL_FONT_INFO
*GlobalFontBackup1
;
1144 HII_GLOBAL_FONT_INFO
*GlobalFontBackup2
;
1146 EFI_FONT_INFO_MASK Mask
;
1148 BOOLEAN VagueMatched1
;
1149 BOOLEAN VagueMatched2
;
1151 ASSERT (Private
!= NULL
&& Private
->Signature
== HII_DATABASE_PRIVATE_DATA_SIGNATURE
);
1152 ASSERT (FontInfo
!= NULL
);
1155 // Matched flag represents an exactly match; VagueMatched1 repensents a RESIZE
1156 // or RESTYLE match; VagueMatched2 represents a RESIZE | RESTYLE match.
1159 VagueMatched1
= FALSE
;
1160 VagueMatched2
= FALSE
;
1163 GlobalFontBackup1
= NULL
;
1164 GlobalFontBackup2
= NULL
;
1166 // The process of where the system default should be supplied instead of
1167 // the specified font info beyonds this function's scope.
1169 if (FontInfoMask
!= NULL
) {
1170 Mask
= *FontInfoMask
& (~SYS_FONT_INFO_MASK
);
1174 // If not NULL, FontHandle points to the next node of the last searched font
1175 // node by previous call.
1177 if (FontHandle
== NULL
) {
1178 Link
= Private
->FontInfoList
.ForwardLink
;
1180 Link
= (LIST_ENTRY
*) FontHandle
;
1183 for (; Link
!= &Private
->FontInfoList
; Link
= Link
->ForwardLink
) {
1184 GlobalFont
= CR (Link
, HII_GLOBAL_FONT_INFO
, Entry
, HII_GLOBAL_FONT_INFO_SIGNATURE
);
1185 if (FontInfoMask
== NULL
) {
1186 if (CompareMem (GlobalFont
->FontInfo
, FontInfo
, GlobalFont
->FontInfoSize
) == 0) {
1187 if (GlobalFontInfo
!= NULL
) {
1188 *GlobalFontInfo
= GlobalFont
;
1194 // Check which options could be used to make a match.
1197 case EFI_FONT_INFO_ANY_FONT
:
1198 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
&&
1199 GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1203 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_STYLE
:
1204 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1208 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_SIZE
:
1209 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1213 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_SIZE
| EFI_FONT_INFO_ANY_STYLE
:
1217 // If EFI_FONT_INFO_RESTYLE is specified, then the system may attempt to
1218 // remove some of the specified styles to meet the style requested.
1220 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_RESTYLE
:
1221 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1222 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1224 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1225 VagueMatched1
= TRUE
;
1226 GlobalFontBackup1
= GlobalFont
;
1231 // If EFI_FONT_INFO_RESIZE is specified, then the sytem may attempt to
1232 // stretch or shrink a font to meet the size requested.
1234 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_RESIZE
:
1235 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1236 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1239 VagueMatched1
= TRUE
;
1240 GlobalFontBackup1
= GlobalFont
;
1244 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_RESTYLE
| EFI_FONT_INFO_RESIZE
:
1245 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1246 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1249 VagueMatched1
= TRUE
;
1250 GlobalFontBackup1
= GlobalFont
;
1252 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1253 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1254 VagueMatched1
= TRUE
;
1255 GlobalFontBackup1
= GlobalFont
;
1257 VagueMatched2
= TRUE
;
1258 GlobalFontBackup2
= GlobalFont
;
1262 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_STYLE
| EFI_FONT_INFO_RESIZE
:
1263 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1266 VagueMatched1
= TRUE
;
1267 GlobalFontBackup1
= GlobalFont
;
1270 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_SIZE
| EFI_FONT_INFO_RESTYLE
:
1271 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1273 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1274 VagueMatched1
= TRUE
;
1275 GlobalFontBackup1
= GlobalFont
;
1278 case EFI_FONT_INFO_ANY_STYLE
:
1280 GlobalFont
->FontInfo
->FontName
,
1282 StrSize (FontInfo
->FontName
)
1284 GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1288 case EFI_FONT_INFO_ANY_STYLE
| EFI_FONT_INFO_ANY_SIZE
:
1290 GlobalFont
->FontInfo
->FontName
,
1292 StrSize (FontInfo
->FontName
)
1297 case EFI_FONT_INFO_ANY_STYLE
| EFI_FONT_INFO_RESIZE
:
1299 GlobalFont
->FontInfo
->FontName
,
1301 StrSize (FontInfo
->FontName
)
1303 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1306 VagueMatched1
= TRUE
;
1307 GlobalFontBackup1
= GlobalFont
;
1311 case EFI_FONT_INFO_ANY_SIZE
:
1313 GlobalFont
->FontInfo
->FontName
,
1315 StrSize (FontInfo
->FontName
)
1317 GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1321 case EFI_FONT_INFO_ANY_SIZE
| EFI_FONT_INFO_RESTYLE
:
1323 GlobalFont
->FontInfo
->FontName
,
1325 StrSize (FontInfo
->FontName
)
1327 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1329 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1330 VagueMatched1
= TRUE
;
1331 GlobalFontBackup1
= GlobalFont
;
1335 case EFI_FONT_INFO_RESTYLE
:
1337 GlobalFont
->FontInfo
->FontName
,
1339 StrSize (FontInfo
->FontName
)
1341 GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1343 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1345 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1346 VagueMatched1
= TRUE
;
1347 GlobalFontBackup1
= GlobalFont
;
1351 case EFI_FONT_INFO_RESIZE
:
1353 GlobalFont
->FontInfo
->FontName
,
1355 StrSize (FontInfo
->FontName
)
1357 GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1359 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1362 VagueMatched1
= TRUE
;
1363 GlobalFontBackup1
= GlobalFont
;
1367 case EFI_FONT_INFO_RESIZE
| EFI_FONT_INFO_RESTYLE
:
1369 GlobalFont
->FontInfo
->FontName
,
1371 StrSize (FontInfo
->FontName
)
1373 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1374 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1377 VagueMatched1
= TRUE
;
1378 GlobalFontBackup1
= GlobalFont
;
1380 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1381 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1382 VagueMatched1
= TRUE
;
1383 GlobalFontBackup1
= GlobalFont
;
1385 VagueMatched2
= TRUE
;
1386 GlobalFontBackup2
= GlobalFont
;
1396 if (GlobalFontInfo
!= NULL
) {
1397 *GlobalFontInfo
= GlobalFont
;
1404 if (VagueMatched1
) {
1405 if (GlobalFontInfo
!= NULL
) {
1406 *GlobalFontInfo
= GlobalFontBackup1
;
1409 } else if (VagueMatched2
) {
1410 if (GlobalFontInfo
!= NULL
) {
1411 *GlobalFontInfo
= GlobalFontBackup2
;
1421 Check whether the unicode represents a line break or not.
1423 This is a internal function. Please see Section 27.2.6 of the UEFI Specification
1424 for a description of the supported string format.
1426 @param Char Unicode character
1428 @retval 0 Yes, it forces a line break.
1429 @retval 1 Yes, it presents a line break opportunity
1430 @retval 2 Yes, it requires a line break happen before and after it.
1431 @retval -1 No, it is not a link break.
1441 // Mandatory line break characters, which force a line-break
1449 // Space characters, which is taken as a line-break opportunity
1465 // In-Word Break Opportunities
1470 // A space which is not a line-break opportunity
1475 // A hyphen which is not a line-break opportunity
1480 // Hyphen characters which describe line break opportunities after the character
1491 // A hyphen which describes line break opportunities before and after them, but not between a pair of them
1501 Renders a string to a bitmap or to the display.
1503 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
1504 @param Flags Describes how the string is to be drawn.
1505 @param String Points to the null-terminated string to be
1507 @param StringInfo Points to the string output information,
1508 including the color and font. If NULL, then the
1509 string will be output in the default system font
1511 @param Blt If this points to a non-NULL on entry, this
1512 points to the image, which is Width pixels wide
1513 and Height pixels high. The string will be drawn
1515 EFI_HII_OUT_FLAG_CLIP is implied. If this points
1516 to a NULL on entry, then a buffer
1517 will be allocated to hold the generated image and
1518 the pointer updated on exit. It is the caller's
1519 responsibility to free this buffer.
1520 @param BltX Specifies the offset from the left and top edge
1521 of the image of the first character cell in the
1523 @param BltY Specifies the offset from the left and top edge
1524 of the image of the first character cell in the
1526 @param RowInfoArray If this is non-NULL on entry, then on exit, this
1527 will point to an allocated buffer containing
1528 row information and RowInfoArraySize will be
1529 updated to contain the number of elements.
1530 This array describes the characters which were at
1531 least partially drawn and the heights of the
1532 rows. It is the caller's responsibility to free
1534 @param RowInfoArraySize If this is non-NULL on entry, then on exit it
1535 contains the number of elements in RowInfoArray.
1536 @param ColumnInfoArray If this is non-NULL, then on return it will be
1537 filled with the horizontal offset for each
1538 character in the string on the row where it is
1539 displayed. Non-printing characters will have
1540 the offset ~0. The caller is responsible to
1541 allocate a buffer large enough so that there
1542 is one entry for each character in the string,
1543 not including the null-terminator. It is possible
1544 when character display is normalized that some
1545 character cells overlap.
1547 @retval EFI_SUCCESS The string was successfully rendered.
1548 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
1549 RowInfoArray or Blt.
1550 @retval EFI_INVALID_PARAMETER The String or Blt was NULL.
1551 @retval EFI_INVALID_PARAMETER Flags were invalid combination..
1557 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
1558 IN EFI_HII_OUT_FLAGS Flags
,
1559 IN CONST EFI_STRING String
,
1560 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo OPTIONAL
,
1561 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
1564 OUT EFI_HII_ROW_INFO
**RowInfoArray OPTIONAL
,
1565 OUT UINTN
*RowInfoArraySize OPTIONAL
,
1566 OUT UINTN
*ColumnInfoArray OPTIONAL
1570 HII_DATABASE_PRIVATE_DATA
*Private
;
1572 EFI_HII_GLYPH_INFO
*Cell
;
1574 EFI_IMAGE_OUTPUT
*Image
;
1575 EFI_STRING StringPtr
;
1576 EFI_STRING StringTmp
;
1577 EFI_HII_ROW_INFO
*RowInfo
;
1581 UINTN LastLineHeight
;
1582 UINTN BaseLineOffset
;
1588 EFI_FONT_DISPLAY_INFO
*StringInfoOut
;
1589 EFI_FONT_DISPLAY_INFO
*SystemDefault
;
1590 EFI_FONT_HANDLE FontHandle
;
1591 EFI_STRING StringIn
;
1592 EFI_STRING StringIn2
;
1595 EFI_FONT_INFO
*FontInfo
;
1596 BOOLEAN SysFontFlag
;
1597 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
1598 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
1599 BOOLEAN Transparent
;
1600 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
;
1601 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BufferPtr
;
1605 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*RowBufferPtr
;
1606 HII_GLOBAL_FONT_INFO
*GlobalFont
;
1609 // Check incoming parameters.
1612 if (This
== NULL
|| String
== NULL
|| Blt
== NULL
) {
1613 return EFI_INVALID_PARAMETER
;
1617 // These two flag cannot be used if Blt is NULL upon entry.
1619 if ((Flags
& EFI_HII_OUT_FLAG_TRANSPARENT
) == EFI_HII_OUT_FLAG_TRANSPARENT
) {
1620 return EFI_INVALID_PARAMETER
;
1622 if ((Flags
& EFI_HII_OUT_FLAG_CLIP
) == EFI_HII_OUT_FLAG_CLIP
) {
1623 return EFI_INVALID_PARAMETER
;
1627 // These two flags require that EFI_HII_OUT_FLAG_CLIP be also set.
1629 if ((Flags
& (EFI_HII_OUT_FLAG_CLIP
| EFI_HII_OUT_FLAG_CLIP_CLEAN_X
)) == EFI_HII_OUT_FLAG_CLIP_CLEAN_X
) {
1630 return EFI_INVALID_PARAMETER
;
1632 if ((Flags
& (EFI_HII_OUT_FLAG_CLIP
| EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
)) == EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
) {
1633 return EFI_INVALID_PARAMETER
;
1636 // This flag cannot be used with EFI_HII_OUT_FLAG_CLEAN_X.
1638 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
)) {
1639 return EFI_INVALID_PARAMETER
;
1644 // Create a new bitmap and draw the string onto this image.
1646 Image
= AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT
));
1647 if (Image
== NULL
) {
1648 return EFI_OUT_OF_RESOURCES
;
1651 Image
->Height
= 600;
1652 Image
->Image
.Bitmap
= AllocateZeroPool (Image
->Width
* Image
->Height
*sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
1653 if (Image
->Image
.Bitmap
== NULL
) {
1655 return EFI_OUT_OF_RESOURCES
;
1659 // Other flags are not permitted when Blt is NULL.
1661 Flags
&= EFI_HII_OUT_FLAG_WRAP
| EFI_HII_IGNORE_IF_NO_GLYPH
| EFI_HII_IGNORE_LINE_BREAK
;
1665 StrLength
= StrLen(String
);
1666 GlyphBuf
= (UINT8
**) AllocateZeroPool (StrLength
* sizeof (UINT8
*));
1667 ASSERT (GlyphBuf
!= NULL
);
1668 Cell
= (EFI_HII_GLYPH_INFO
*) AllocateZeroPool (StrLength
* sizeof (EFI_HII_GLYPH_INFO
));
1669 ASSERT (Cell
!= NULL
);
1670 Attributes
= (UINT8
*) AllocateZeroPool (StrLength
* sizeof (UINT8
));
1671 ASSERT (Attributes
!= NULL
);
1674 Status
= EFI_SUCCESS
;
1676 SystemDefault
= NULL
;
1680 // Calculate the string output information, including specified color and font .
1681 // If StringInfo does not points to system font info, it must indicate an existing
1684 StringInfoOut
= NULL
;
1686 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
1687 SysFontFlag
= IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, &SystemDefault
, NULL
);
1691 Height
= SystemDefault
->FontInfo
.FontSize
;
1692 BaseLine
= SystemDefault
->FontInfo
.FontSize
;
1693 Foreground
= SystemDefault
->ForegroundColor
;
1694 Background
= SystemDefault
->BackgroundColor
;
1698 // StringInfo must not be NULL if it is not system info.
1700 ASSERT (StringInfo
!= NULL
);
1701 Status
= HiiGetFontInfo (This
, &FontHandle
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, &StringInfoOut
, NULL
);
1702 if (Status
== EFI_NOT_FOUND
) {
1704 // The specified EFI_FONT_DISPLAY_INFO does not exist in current database.
1705 // Use the system font instead. Still use the color specified by StringInfo.
1709 Height
= SystemDefault
->FontInfo
.FontSize
;
1710 BaseLine
= SystemDefault
->FontInfo
.FontSize
;
1711 Foreground
= ((EFI_FONT_DISPLAY_INFO
*) StringInfo
)->ForegroundColor
;
1712 Background
= ((EFI_FONT_DISPLAY_INFO
*) StringInfo
)->BackgroundColor
;
1714 } else if (Status
== EFI_SUCCESS
) {
1715 FontInfo
= &StringInfoOut
->FontInfo
;
1716 IsFontInfoExisted (Private
, FontInfo
, NULL
, NULL
, &GlobalFont
);
1717 Height
= GlobalFont
->FontPackage
->Height
;
1718 BaseLine
= GlobalFont
->FontPackage
->BaseLine
;
1719 Foreground
= StringInfoOut
->ForegroundColor
;
1720 Background
= StringInfoOut
->BackgroundColor
;
1727 // Use the maxinum height of font as the base line.
1728 // And, use the maxinum height as line height.
1730 LineHeight
= Height
;
1731 LastLineHeight
= Height
;
1732 BaseLineOffset
= Height
- BaseLine
;
1735 // Parse the string to be displayed to drop some ignored characters.
1741 // Ignore line-break characters only. Hyphens or dash character will be displayed
1742 // without line-break opportunity.
1744 if ((Flags
& EFI_HII_IGNORE_LINE_BREAK
) == EFI_HII_IGNORE_LINE_BREAK
) {
1745 StringIn
= AllocateZeroPool (StrSize (StringPtr
));
1746 if (StringIn
== NULL
) {
1747 Status
= EFI_OUT_OF_RESOURCES
;
1750 StringTmp
= StringIn
;
1751 while (*StringPtr
!= 0) {
1752 if (IsLineBreak (*StringPtr
) == 0) {
1755 *StringTmp
++ = *StringPtr
++;
1759 StringPtr
= StringIn
;
1762 // If EFI_HII_IGNORE_IF_NO_GLYPH is set, then characters which have no glyphs
1763 // are not drawn. Otherwise they are replaced wth Unicode character 0xFFFD.
1765 StringIn2
= AllocateZeroPool (StrSize (StringPtr
));
1766 if (StringIn2
== NULL
) {
1767 Status
= EFI_OUT_OF_RESOURCES
;
1771 StringTmp
= StringIn2
;
1772 StrLength
= StrLen(StringPtr
);
1773 while (*StringPtr
!= 0 && Index
< StrLength
) {
1774 if (IsLineBreak (*StringPtr
) == 0) {
1775 *StringTmp
++ = *StringPtr
++;
1780 Status
= GetGlyphBuffer (Private
, *StringPtr
, FontInfo
, &GlyphBuf
[Index
], &Cell
[Index
], &Attributes
[Index
]);
1781 if (Status
== EFI_NOT_FOUND
) {
1782 if ((Flags
& EFI_HII_IGNORE_IF_NO_GLYPH
) == EFI_HII_IGNORE_IF_NO_GLYPH
) {
1783 GlyphBuf
[Index
] = NULL
;
1784 ZeroMem (&Cell
[Index
], sizeof (Cell
[Index
]));
1785 Status
= EFI_SUCCESS
;
1788 // Unicode 0xFFFD must exist in current hii database if this flag is not set.
1790 Status
= GetGlyphBuffer (
1792 REPLACE_UNKNOWN_GLYPH
,
1798 if (EFI_ERROR (Status
)) {
1799 Status
= EFI_INVALID_PARAMETER
;
1804 if (EFI_ERROR (Status
)) {
1808 *StringTmp
++ = *StringPtr
++;
1812 StringPtr
= StringIn2
;
1815 // Draw the string according to the specified EFI_HII_OUT_FLAGS and Blt.
1816 // If Blt is not NULL, then EFI_HII_OUT_FLAG_CLIP is implied, render this string
1817 // to an existing image (bitmap or screen depending on flags) pointed by "*Blt".
1818 // Otherwise render this string to a new allocated image and output it.
1821 BufferPtr
= Image
->Image
.Bitmap
+ Image
->Width
* BltY
+ BltX
;
1822 if (Image
->Height
< BltY
) {
1824 // the top edge of the image should be in Image resolution scope.
1826 Status
= EFI_INVALID_PARAMETER
;
1829 MaxRowNum
= (UINT16
) ((Image
->Height
- BltY
) / Height
);
1830 if ((Image
->Height
- BltY
) % Height
!= 0) {
1831 LastLineHeight
= (Image
->Height
- BltY
) % Height
;
1835 RowInfo
= (EFI_HII_ROW_INFO
*) AllocateZeroPool (MaxRowNum
* sizeof (EFI_HII_ROW_INFO
));
1836 if (RowInfo
== NULL
) {
1837 Status
= EFI_OUT_OF_RESOURCES
;
1842 // Format the glyph buffer according to flags.
1844 Transparent
= (BOOLEAN
) ((Flags
& EFI_HII_OUT_FLAG_TRANSPARENT
) == EFI_HII_OUT_FLAG_TRANSPARENT
? TRUE
: FALSE
);
1846 for (RowIndex
= 0, Index
= 0; RowIndex
< MaxRowNum
&& StringPtr
[Index
] != 0; ) {
1851 // Clip the final row if the row's bottom-most on pixel cannot fit when
1852 // EFI_HII_OUT_FLAG_CLEAN_Y is set.
1854 if (RowIndex
== MaxRowNum
- 1) {
1855 if ((Flags
& EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
) == EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
&& LastLineHeight
< LineHeight
) {
1857 // Don't draw at all if the row's bottom-most on pixel cannot fit.
1861 LineHeight
= LastLineHeight
;
1865 // Calculate how many characters there are in a row.
1867 RowInfo
[RowIndex
].StartIndex
= Index
;
1869 while (LineWidth
+ BltX
< Image
->Width
&& StringPtr
[Index
] != 0) {
1870 if ((Flags
& EFI_HII_IGNORE_LINE_BREAK
) == 0 &&
1871 IsLineBreak (StringPtr
[Index
]) == 0) {
1873 // It forces a line break that ends this row.
1881 // If the glyph of the character is existing, then accumulate the actual printed width
1883 LineWidth
+= (UINTN
) Cell
[Index
].AdvanceX
;
1889 // Record index of next char.
1893 // Return to the previous char.
1896 if (LineBreak
&& Index
> 0 ) {
1898 // Return the previous non line break char.
1904 // If this character is the last character of a row, we need not
1905 // draw its (AdvanceX - Width - OffsetX) for next character.
1907 LineWidth
-= (UINTN
) (Cell
[Index
].AdvanceX
- Cell
[Index
].Width
- Cell
[Index
].OffsetX
);
1910 // Clip the right-most character if cannot fit when EFI_HII_OUT_FLAG_CLEAN_X is set.
1912 if (LineWidth
+ BltX
<= Image
->Width
||
1913 (LineWidth
+ BltX
> Image
->Width
&& (Flags
& EFI_HII_OUT_FLAG_CLIP_CLEAN_X
) == 0)) {
1915 // Record right-most character in RowInfo even if it is partially displayed.
1917 RowInfo
[RowIndex
].EndIndex
= Index
;
1918 RowInfo
[RowIndex
].LineWidth
= LineWidth
;
1919 RowInfo
[RowIndex
].LineHeight
= LineHeight
;
1920 RowInfo
[RowIndex
].BaselineOffset
= BaseLineOffset
;
1923 // When EFI_HII_OUT_FLAG_CLEAN_X is set, it will not draw a character
1924 // if its right-most on pixel cannot fit.
1926 if (Index
> RowInfo
[RowIndex
].StartIndex
) {
1928 // Don't draw the last char on this row. And, don't draw the second last char (AdvanceX - Width - OffsetX).
1930 LineWidth
-= (UINTN
) (Cell
[Index
].Width
+ Cell
[Index
].OffsetX
);
1931 LineWidth
-= (UINTN
) (Cell
[Index
- 1].AdvanceX
- Cell
[Index
- 1].Width
- Cell
[Index
- 1].OffsetX
);
1932 RowInfo
[RowIndex
].EndIndex
= Index
- 1;
1933 RowInfo
[RowIndex
].LineWidth
= LineWidth
;
1934 RowInfo
[RowIndex
].LineHeight
= LineHeight
;
1935 RowInfo
[RowIndex
].BaselineOffset
= BaseLineOffset
;
1938 // There is no enough column to draw any character, so set current line width to zero.
1939 // And go to draw Next line if LineBreak is set.
1941 RowInfo
[RowIndex
].LineWidth
= 0;
1947 // EFI_HII_OUT_FLAG_WRAP will wrap the text at the right-most line-break
1948 // opportunity prior to a character whose right-most extent would exceed Width.
1949 // Search the right-most line-break opportunity here.
1951 if ((Flags
& EFI_HII_OUT_FLAG_WRAP
) == EFI_HII_OUT_FLAG_WRAP
&&
1952 (RowInfo
[RowIndex
].LineWidth
+ BltX
> Image
->Width
|| StringPtr
[NextIndex
] != 0) &&
1954 if ((Flags
& EFI_HII_IGNORE_LINE_BREAK
) == 0) {
1955 LineWidth
= RowInfo
[RowIndex
].LineWidth
;
1956 for (Index1
= RowInfo
[RowIndex
].EndIndex
; Index1
>= RowInfo
[RowIndex
].StartIndex
; Index1
--) {
1957 if (Index1
== RowInfo
[RowIndex
].EndIndex
) {
1958 LineWidth
-= (Cell
[Index1
].Width
+ Cell
[Index1
].OffsetX
);
1960 LineWidth
-= Cell
[Index1
].AdvanceX
;
1962 if (IsLineBreak (StringPtr
[Index1
]) > 0) {
1964 if (Index1
> RowInfo
[RowIndex
].StartIndex
) {
1965 RowInfo
[RowIndex
].EndIndex
= Index1
- 1;
1968 // relocate to the character after the right-most line break opportunity of this line
1970 NextIndex
= Index1
+ 1;
1974 // If don't find a line break opportunity from EndIndex to StartIndex,
1977 if (Index1
== RowInfo
[RowIndex
].StartIndex
)
1982 // Update LineWidth to the real width
1984 if (IsLineBreak (StringPtr
[Index1
]) > 0) {
1985 if (Index1
== RowInfo
[RowIndex
].StartIndex
) {
1988 LineWidth
-= (UINTN
) (Cell
[Index1
- 1].AdvanceX
- Cell
[Index1
- 1].Width
- Cell
[Index1
- 1].OffsetX
);
1990 RowInfo
[RowIndex
].LineWidth
= LineWidth
;
1994 // If no line-break opportunity can be found, then the text will
1995 // behave as if EFI_HII_OUT_FLAG_CLEAN_X is set.
1998 LineWidth
= RowInfo
[RowIndex
].LineWidth
;
1999 Index1
= RowInfo
[RowIndex
].EndIndex
;
2000 if (LineWidth
+ BltX
> Image
->Width
) {
2001 if (Index1
> RowInfo
[RowIndex
].StartIndex
) {
2003 // Don't draw the last char on this row. And, don't draw the second last char (AdvanceX - Width - OffsetX).
2005 LineWidth
-= (UINTN
) (Cell
[Index1
].Width
+ Cell
[Index1
].OffsetX
);
2006 LineWidth
-= (UINTN
) (Cell
[Index1
- 1].AdvanceX
- Cell
[Index1
- 1].Width
- Cell
[Index1
- 1].OffsetX
);
2007 RowInfo
[RowIndex
].EndIndex
= Index1
- 1;
2008 RowInfo
[RowIndex
].LineWidth
= LineWidth
;
2011 // There is no enough column to draw any character, so set current line width to zero.
2012 // And go to draw Next line if LineBreak is set.
2014 RowInfo
[RowIndex
].LineWidth
= 0;
2022 // LineWidth can't exceed Image width.
2024 if (RowInfo
[RowIndex
].LineWidth
+ BltX
> Image
->Width
) {
2025 RowInfo
[RowIndex
].LineWidth
= Image
->Width
- BltX
;
2029 // Draw it to screen or existing bitmap depending on whether
2030 // EFI_HII_DIRECT_TO_SCREEN is set.
2033 if ((Flags
& EFI_HII_DIRECT_TO_SCREEN
) == EFI_HII_DIRECT_TO_SCREEN
) {
2035 if (RowInfo
[RowIndex
].LineWidth
!= 0) {
2036 BltBuffer
= AllocateZeroPool (RowInfo
[RowIndex
].LineWidth
* RowInfo
[RowIndex
].LineHeight
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
2037 if (BltBuffer
== NULL
) {
2038 Status
= EFI_OUT_OF_RESOURCES
;
2042 // Set BufferPtr to Origin by adding baseline to the starting position.
2044 BufferPtr
= BltBuffer
+ BaseLine
* RowInfo
[RowIndex
].LineWidth
;
2046 for (Index1
= RowInfo
[RowIndex
].StartIndex
; Index1
<= RowInfo
[RowIndex
].EndIndex
; Index1
++) {
2047 if (RowInfo
[RowIndex
].LineWidth
> 0 && RowInfo
[RowIndex
].LineWidth
> LineOffset
) {
2049 // Only BLT these character which have corrsponding glyph in font basebase.
2055 (UINT16
) RowInfo
[RowIndex
].LineWidth
,
2057 RowInfo
[RowIndex
].LineWidth
- LineOffset
,
2058 RowInfo
[RowIndex
].LineHeight
,
2065 if (ColumnInfoArray
!= NULL
) {
2066 if ((GlyphBuf
[Index1
] == NULL
&& Cell
[Index1
].AdvanceX
== 0)
2067 || RowInfo
[RowIndex
].LineWidth
== 0) {
2068 *ColumnInfoArray
= (UINTN
) ~0;
2070 *ColumnInfoArray
= LineOffset
+ Cell
[Index1
].OffsetX
+ BltX
;
2074 LineOffset
+= Cell
[Index1
].AdvanceX
;
2077 if (BltBuffer
!= NULL
) {
2078 Status
= Image
->Image
.Screen
->Blt (
2079 Image
->Image
.Screen
,
2081 EfiBltBufferToVideo
,
2086 RowInfo
[RowIndex
].LineWidth
,
2087 RowInfo
[RowIndex
].LineHeight
,
2090 if (EFI_ERROR (Status
)) {
2091 FreePool (BltBuffer
);
2095 FreePool (BltBuffer
);
2099 // Save the starting position for calculate the starting postition of next row.
2101 RowBufferPtr
= BufferPtr
;
2103 // Set BufferPtr to Origin by adding baseline to the starting position.
2105 BufferPtr
= BufferPtr
+ BaseLine
* Image
->Width
;
2106 for (Index1
= RowInfo
[RowIndex
].StartIndex
; Index1
<= RowInfo
[RowIndex
].EndIndex
; Index1
++) {
2107 if (RowInfo
[RowIndex
].LineWidth
> 0 && RowInfo
[RowIndex
].LineWidth
> LineOffset
) {
2109 // Only BLT these character which have corrsponding glyph in font basebase.
2117 RowInfo
[RowIndex
].LineWidth
- LineOffset
,
2118 RowInfo
[RowIndex
].LineHeight
,
2125 if (ColumnInfoArray
!= NULL
) {
2126 if ((GlyphBuf
[Index1
] == NULL
&& Cell
[Index1
].AdvanceX
== 0)
2127 || RowInfo
[RowIndex
].LineWidth
== 0) {
2128 *ColumnInfoArray
= (UINTN
) ~0;
2130 *ColumnInfoArray
= LineOffset
+ Cell
[Index1
].OffsetX
+ BltX
;
2134 LineOffset
+= Cell
[Index1
].AdvanceX
;
2138 // Jump to starting position of next row.
2140 if (RowIndex
== 0) {
2141 BufferPtr
= RowBufferPtr
- BltX
+ LineHeight
* Image
->Width
;
2143 BufferPtr
= RowBufferPtr
+ LineHeight
* Image
->Width
;
2149 // Recalculate the start point of X/Y axis to draw multi-lines with the order of top-to-down
2152 BltY
+= RowInfo
[RowIndex
].LineHeight
;
2159 // If there is not a mandatory line break or line break opportunity, only render one line to image
2166 // Write output parameters.
2168 RowInfoSize
= RowIndex
* sizeof (EFI_HII_ROW_INFO
);
2169 if (RowInfoArray
!= NULL
) {
2170 if (RowInfoSize
> 0) {
2171 *RowInfoArray
= AllocateZeroPool (RowInfoSize
);
2172 if (*RowInfoArray
== NULL
) {
2173 Status
= EFI_OUT_OF_RESOURCES
;
2176 CopyMem (*RowInfoArray
, RowInfo
, RowInfoSize
);
2178 *RowInfoArray
= NULL
;
2181 if (RowInfoArraySize
!= NULL
) {
2182 *RowInfoArraySize
= RowIndex
;
2185 Status
= EFI_SUCCESS
;
2189 for (Index
= 0; Index
< StrLength
; Index
++) {
2190 if (GlyphBuf
[Index
] != NULL
) {
2191 FreePool (GlyphBuf
[Index
]);
2194 if (StringIn
!= NULL
) {
2195 FreePool (StringIn
);
2197 if (StringIn2
!= NULL
) {
2198 FreePool (StringIn2
);
2200 if (StringInfoOut
!= NULL
) {
2201 FreePool (StringInfoOut
);
2203 if (RowInfo
!= NULL
) {
2206 if (SystemDefault
!= NULL
) {
2207 FreePool (SystemDefault
);
2209 if (GlyphBuf
!= NULL
) {
2210 FreePool (GlyphBuf
);
2215 if (Attributes
!= NULL
) {
2216 FreePool (Attributes
);
2224 Render a string to a bitmap or the screen containing the contents of the specified string.
2226 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
2227 @param Flags Describes how the string is to be drawn.
2228 @param PackageList The package list in the HII database to search
2229 for the specified string.
2230 @param StringId The string's id, which is unique within
2232 @param Language Points to the language for the retrieved string.
2233 If NULL, then the current system language is
2235 @param StringInfo Points to the string output information,
2236 including the color and font. If NULL, then the
2237 string will be output in the default system font
2239 @param Blt If this points to a non-NULL on entry, this
2240 points to the image, which is Width pixels wide
2241 and Height pixels high. The string will be drawn
2243 EFI_HII_OUT_FLAG_CLIP is implied. If this points
2244 to a NULL on entry, then a buffer
2245 will be allocated to hold the generated image and
2246 the pointer updated on exit. It is the caller's
2247 responsibility to free this buffer.
2248 @param BltX Specifies the offset from the left and top edge
2249 of the image of the first character cell in the
2251 @param BltY Specifies the offset from the left and top edge
2252 of the image of the first character cell in the
2254 @param RowInfoArray If this is non-NULL on entry, then on exit, this
2255 will point to an allocated buffer containing
2256 row information and RowInfoArraySize will be
2257 updated to contain the number of elements.
2258 This array describes the characters which were at
2259 least partially drawn and the heights of the
2260 rows. It is the caller's responsibility to free
2262 @param RowInfoArraySize If this is non-NULL on entry, then on exit it
2263 contains the number of elements in RowInfoArray.
2264 @param ColumnInfoArray If this is non-NULL, then on return it will be
2265 filled with the horizontal offset for each
2266 character in the string on the row where it is
2267 displayed. Non-printing characters will have
2268 the offset ~0. The caller is responsible to
2269 allocate a buffer large enough so that there
2270 is one entry for each character in the string,
2271 not including the null-terminator. It is possible
2272 when character display is normalized that some
2273 character cells overlap.
2275 @retval EFI_SUCCESS The string was successfully rendered.
2276 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
2277 RowInfoArray or Blt.
2278 @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.
2279 @retval EFI_INVALID_PARAMETER Flags were invalid combination.
2280 @retval EFI_NOT_FOUND The specified PackageList is not in the Database or the stringid is not
2281 in the specified PackageList.
2286 HiiStringIdToImage (
2287 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
2288 IN EFI_HII_OUT_FLAGS Flags
,
2289 IN EFI_HII_HANDLE PackageList
,
2290 IN EFI_STRING_ID StringId
,
2291 IN CONST CHAR8
* Language
,
2292 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo OPTIONAL
,
2293 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
2296 OUT EFI_HII_ROW_INFO
**RowInfoArray OPTIONAL
,
2297 OUT UINTN
*RowInfoArraySize OPTIONAL
,
2298 OUT UINTN
*ColumnInfoArray OPTIONAL
2302 HII_DATABASE_PRIVATE_DATA
*Private
;
2303 EFI_HII_STRING_PROTOCOL
*HiiString
;
2307 EFI_FONT_INFO
*StringFontInfo
;
2308 EFI_FONT_DISPLAY_INFO
*NewStringInfo
;
2309 CHAR8 TempSupportedLanguages
;
2310 CHAR8
*SupportedLanguages
;
2311 UINTN SupportedLanguagesSize
;
2312 CHAR8
*CurrentLanguage
;
2313 CHAR8
*BestLanguage
;
2315 if (This
== NULL
|| PackageList
== NULL
|| Blt
== NULL
|| PackageList
== NULL
) {
2316 return EFI_INVALID_PARAMETER
;
2319 if (!IsHiiHandleValid (PackageList
)) {
2320 return EFI_NOT_FOUND
;
2324 // Initialize string pointers to be NULL
2326 SupportedLanguages
= NULL
;
2327 CurrentLanguage
= NULL
;
2328 BestLanguage
= NULL
;
2330 StringFontInfo
= NULL
;
2331 NewStringInfo
= NULL
;
2334 // Get the string to be displayed.
2336 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2337 HiiString
= &Private
->HiiString
;
2340 // Get the size of supported language.
2342 SupportedLanguagesSize
= 0;
2343 Status
= HiiString
->GetLanguages (
2346 &TempSupportedLanguages
,
2347 &SupportedLanguagesSize
2349 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
2353 SupportedLanguages
= AllocatePool (SupportedLanguagesSize
);
2354 if (SupportedLanguages
== NULL
) {
2355 return EFI_OUT_OF_RESOURCES
;
2358 Status
= HiiString
->GetLanguages (
2362 &SupportedLanguagesSize
2364 if (EFI_ERROR (Status
)) {
2368 if (Language
== NULL
) {
2371 GetEfiGlobalVariable2 (L
"PlatformLang", (VOID
**)&CurrentLanguage
, NULL
);
2372 BestLanguage
= GetBestLanguage (
2376 (CurrentLanguage
== NULL
) ? CurrentLanguage
: "",
2377 (CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLang
),
2380 if (BestLanguage
== NULL
) {
2381 Status
= EFI_NOT_FOUND
;
2385 StringSize
= MAX_STRING_LENGTH
;
2386 String
= (EFI_STRING
) AllocateZeroPool (StringSize
);
2387 if (String
== NULL
) {
2388 Status
= EFI_OUT_OF_RESOURCES
;
2392 Status
= HiiString
->GetString (
2401 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2403 String
= (EFI_STRING
) AllocateZeroPool (StringSize
);
2404 if (String
== NULL
) {
2405 Status
= EFI_OUT_OF_RESOURCES
;
2408 Status
= HiiString
->GetString (
2419 if (EFI_ERROR (Status
)) {
2424 // When StringInfo specifies that string will be output in the system default font and color,
2425 // use particular stringfontinfo described in string package instead if exists.
2426 // StringFontInfo equals NULL means system default font attaches with the string block.
2428 if (StringFontInfo
!= NULL
&& IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, NULL
, NULL
)) {
2429 FontLen
= sizeof (EFI_FONT_DISPLAY_INFO
) - sizeof (CHAR16
) + StrSize (StringFontInfo
->FontName
);
2430 NewStringInfo
= AllocateZeroPool (FontLen
);
2431 if (NewStringInfo
== NULL
) {
2432 Status
= EFI_OUT_OF_RESOURCES
;
2435 NewStringInfo
->FontInfoMask
= EFI_FONT_INFO_SYS_FORE_COLOR
| EFI_FONT_INFO_SYS_BACK_COLOR
;
2436 NewStringInfo
->FontInfo
.FontStyle
= StringFontInfo
->FontStyle
;
2437 NewStringInfo
->FontInfo
.FontSize
= StringFontInfo
->FontSize
;
2438 StrCpy (NewStringInfo
->FontInfo
.FontName
, StringFontInfo
->FontName
);
2440 Status
= HiiStringToImage (
2455 Status
= HiiStringToImage (
2469 if (SupportedLanguages
!= NULL
) {
2470 FreePool (SupportedLanguages
);
2472 if (CurrentLanguage
!= NULL
) {
2473 FreePool (CurrentLanguage
);
2475 if (BestLanguage
!= NULL
) {
2476 FreePool (BestLanguage
);
2478 if (String
!= NULL
) {
2481 if (StringFontInfo
!= NULL
) {
2482 FreePool (StringFontInfo
);
2484 if (NewStringInfo
!= NULL
) {
2485 FreePool (NewStringInfo
);
2493 Convert the glyph for a single character into a bitmap.
2495 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
2496 @param Char Character to retrieve.
2497 @param StringInfo Points to the string font and color information
2498 or NULL if the string should use the default
2499 system font and color.
2500 @param Blt Thus must point to a NULL on entry. A buffer will
2501 be allocated to hold the output and the pointer
2502 updated on exit. It is the caller's
2503 responsibility to free this buffer.
2504 @param Baseline Number of pixels from the bottom of the bitmap to
2507 @retval EFI_SUCCESS Glyph bitmap created.
2508 @retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer Blt.
2509 @retval EFI_WARN_UNKNOWN_GLYPH The glyph was unknown and was replaced with the
2510 glyph for Unicode character 0xFFFD.
2511 @retval EFI_INVALID_PARAMETER Blt is NULL or *Blt is not NULL.
2517 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
2519 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo
,
2520 OUT EFI_IMAGE_OUTPUT
**Blt
,
2521 OUT UINTN
*Baseline OPTIONAL
2525 HII_DATABASE_PRIVATE_DATA
*Private
;
2526 EFI_IMAGE_OUTPUT
*Image
;
2528 EFI_FONT_DISPLAY_INFO
*SystemDefault
;
2529 EFI_FONT_DISPLAY_INFO
*StringInfoOut
;
2531 EFI_FONT_HANDLE FontHandle
;
2533 EFI_HII_GLYPH_INFO Cell
;
2534 EFI_FONT_INFO
*FontInfo
;
2536 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
2537 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
2538 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
;
2541 if (This
== NULL
|| Blt
== NULL
|| *Blt
!= NULL
) {
2542 return EFI_INVALID_PARAMETER
;
2545 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2549 SystemDefault
= NULL
;
2553 StringInfoOut
= NULL
;
2556 ZeroMem (&Foreground
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
2557 ZeroMem (&Background
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
2559 Default
= IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, &SystemDefault
, NULL
);
2563 // Find out a EFI_FONT_DISPLAY_INFO which could display the character in
2564 // the specified color and font.
2566 String
= (EFI_STRING
) AllocateZeroPool (sizeof (CHAR16
) * 2);
2567 if (String
== NULL
) {
2568 Status
= EFI_OUT_OF_RESOURCES
;
2574 Status
= HiiGetFontInfo (This
, &FontHandle
, StringInfo
, &StringInfoOut
, String
);
2575 if (EFI_ERROR (Status
)) {
2578 ASSERT (StringInfoOut
!= NULL
);
2579 FontInfo
= &StringInfoOut
->FontInfo
;
2580 Foreground
= StringInfoOut
->ForegroundColor
;
2581 Background
= StringInfoOut
->BackgroundColor
;
2583 Foreground
= SystemDefault
->ForegroundColor
;
2584 Background
= SystemDefault
->BackgroundColor
;
2587 Status
= GetGlyphBuffer (Private
, Char
, FontInfo
, &GlyphBuffer
, &Cell
, &Attributes
);
2588 if (EFI_ERROR (Status
)) {
2592 Image
= (EFI_IMAGE_OUTPUT
*) AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT
));
2593 if (Image
== NULL
) {
2594 Status
= EFI_OUT_OF_RESOURCES
;
2597 Image
->Width
= Cell
.Width
;
2598 Image
->Height
= Cell
.Height
;
2600 if (Image
->Width
* Image
->Height
> 0) {
2601 Image
->Image
.Bitmap
= AllocateZeroPool (Image
->Width
* Image
->Height
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
2602 if (Image
->Image
.Bitmap
== NULL
) {
2604 Status
= EFI_OUT_OF_RESOURCES
;
2609 // Set BaseLine to the char height.
2611 BaseLine
= (UINT16
) (Cell
.Height
+ Cell
.OffsetY
);
2613 // Set BltBuffer to the position of Origin.
2615 BltBuffer
= Image
->Image
.Bitmap
+ (Cell
.Height
+ Cell
.OffsetY
) * Image
->Width
- Cell
.OffsetX
;
2622 Cell
.Width
+ Cell
.OffsetX
,
2623 BaseLine
- Cell
.OffsetY
,
2632 if (Baseline
!= NULL
) {
2633 *Baseline
= Cell
.OffsetY
;
2636 Status
= EFI_SUCCESS
;
2640 if (Status
== EFI_NOT_FOUND
) {
2642 // Glyph is unknown and replaced with the glyph for unicode character 0xFFFD
2644 if (Char
!= REPLACE_UNKNOWN_GLYPH
) {
2645 Status
= HiiGetGlyph (This
, REPLACE_UNKNOWN_GLYPH
, StringInfo
, Blt
, Baseline
);
2646 if (!EFI_ERROR (Status
)) {
2647 Status
= EFI_WARN_UNKNOWN_GLYPH
;
2650 Status
= EFI_WARN_UNKNOWN_GLYPH
;
2654 if (SystemDefault
!= NULL
) {
2655 FreePool (SystemDefault
);
2657 if (StringInfoOut
!= NULL
) {
2658 FreePool (StringInfoOut
);
2660 if (String
!= NULL
) {
2663 if (GlyphBuffer
!= NULL
) {
2664 FreePool (GlyphBuffer
);
2672 This function iterates through fonts which match the specified font, using
2673 the specified criteria. If String is non-NULL, then all of the characters in
2674 the string must exist in order for a candidate font to be returned.
2676 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
2677 @param FontHandle On entry, points to the font handle returned by a
2678 previous call to GetFontInfo() or NULL to start
2679 with the first font. On return, points to the
2680 returned font handle or points to NULL if there
2681 are no more matching fonts.
2682 @param StringInfoIn Upon entry, points to the font to return information
2683 about. If NULL, then the information about the system
2684 default font will be returned.
2685 @param StringInfoOut Upon return, contains the matching font's information.
2686 If NULL, then no information is returned. This buffer
2687 is allocated with a call to the Boot Service AllocatePool().
2688 It is the caller's responsibility to call the Boot
2689 Service FreePool() when the caller no longer requires
2690 the contents of StringInfoOut.
2691 @param String Points to the string which will be tested to
2692 determine if all characters are available. If
2693 NULL, then any font is acceptable.
2695 @retval EFI_SUCCESS Matching font returned successfully.
2696 @retval EFI_NOT_FOUND No matching font was found.
2697 @retval EFI_INVALID_PARAMETER StringInfoIn->FontInfoMask is an invalid combination.
2698 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the
2705 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
2706 IN OUT EFI_FONT_HANDLE
*FontHandle
,
2707 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfoIn
, OPTIONAL
2708 OUT EFI_FONT_DISPLAY_INFO
**StringInfoOut
,
2709 IN CONST EFI_STRING String OPTIONAL
2712 HII_DATABASE_PRIVATE_DATA
*Private
;
2714 EFI_FONT_DISPLAY_INFO
*SystemDefault
;
2715 EFI_FONT_DISPLAY_INFO InfoOut
;
2716 UINTN StringInfoOutLen
;
2717 EFI_FONT_INFO
*FontInfo
;
2718 HII_GLOBAL_FONT_INFO
*GlobalFont
;
2719 EFI_STRING StringIn
;
2720 EFI_FONT_HANDLE LocalFontHandle
;
2723 return EFI_INVALID_PARAMETER
;
2727 SystemDefault
= NULL
;
2728 LocalFontHandle
= NULL
;
2729 if (FontHandle
!= NULL
) {
2730 LocalFontHandle
= *FontHandle
;
2733 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2736 // Already searched to the end of the whole list, return directly.
2738 if (LocalFontHandle
== &Private
->FontInfoList
) {
2739 LocalFontHandle
= NULL
;
2740 Status
= EFI_NOT_FOUND
;
2745 // Get default system display info, if StringInfoIn points to
2746 // system display info, return it directly.
2748 if (IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfoIn
, &SystemDefault
, &StringInfoOutLen
)) {
2750 // System font is the first node. When handle is not NULL, system font can not
2751 // be found any more.
2753 if (LocalFontHandle
== NULL
) {
2754 if (StringInfoOut
!= NULL
) {
2755 *StringInfoOut
= AllocateCopyPool (StringInfoOutLen
, SystemDefault
);
2756 if (*StringInfoOut
== NULL
) {
2757 Status
= EFI_OUT_OF_RESOURCES
;
2758 LocalFontHandle
= NULL
;
2763 LocalFontHandle
= Private
->FontInfoList
.ForwardLink
;
2764 Status
= EFI_SUCCESS
;
2767 LocalFontHandle
= NULL
;
2768 Status
= EFI_NOT_FOUND
;
2774 // StringInfoIn must not be NULL if it is not system default font info.
2776 ASSERT (StringInfoIn
!= NULL
);
2778 // Check the font information mask to make sure it is valid.
2780 if (((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_SYS_FONT
| EFI_FONT_INFO_ANY_FONT
)) ==
2781 (EFI_FONT_INFO_SYS_FONT
| EFI_FONT_INFO_ANY_FONT
)) ||
2782 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_SYS_SIZE
| EFI_FONT_INFO_ANY_SIZE
)) ==
2783 (EFI_FONT_INFO_SYS_SIZE
| EFI_FONT_INFO_ANY_SIZE
)) ||
2784 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_SYS_STYLE
| EFI_FONT_INFO_ANY_STYLE
)) ==
2785 (EFI_FONT_INFO_SYS_STYLE
| EFI_FONT_INFO_ANY_STYLE
)) ||
2786 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_RESIZE
| EFI_FONT_INFO_ANY_SIZE
)) ==
2787 (EFI_FONT_INFO_RESIZE
| EFI_FONT_INFO_ANY_SIZE
)) ||
2788 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_RESTYLE
| EFI_FONT_INFO_ANY_STYLE
)) ==
2789 (EFI_FONT_INFO_RESTYLE
| EFI_FONT_INFO_ANY_STYLE
))) {
2790 return EFI_INVALID_PARAMETER
;
2794 // Parse the font information mask to find a matching font.
2797 CopyMem (&InfoOut
, (EFI_FONT_DISPLAY_INFO
*) StringInfoIn
, sizeof (EFI_FONT_DISPLAY_INFO
));
2799 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_FONT
) == EFI_FONT_INFO_SYS_FONT
) {
2800 Status
= SaveFontName (SystemDefault
->FontInfo
.FontName
, &FontInfo
);
2802 Status
= SaveFontName (((EFI_FONT_DISPLAY_INFO
*) StringInfoIn
)->FontInfo
.FontName
, &FontInfo
);
2804 if (EFI_ERROR (Status
)) {
2808 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_SIZE
) == EFI_FONT_INFO_SYS_SIZE
) {
2809 InfoOut
.FontInfo
.FontSize
= SystemDefault
->FontInfo
.FontSize
;
2811 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_STYLE
) == EFI_FONT_INFO_SYS_STYLE
) {
2812 InfoOut
.FontInfo
.FontStyle
= SystemDefault
->FontInfo
.FontStyle
;
2814 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_FORE_COLOR
) == EFI_FONT_INFO_SYS_FORE_COLOR
) {
2815 InfoOut
.ForegroundColor
= SystemDefault
->ForegroundColor
;
2817 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_BACK_COLOR
) == EFI_FONT_INFO_SYS_BACK_COLOR
) {
2818 InfoOut
.BackgroundColor
= SystemDefault
->BackgroundColor
;
2821 ASSERT (FontInfo
!= NULL
);
2822 FontInfo
->FontSize
= InfoOut
.FontInfo
.FontSize
;
2823 FontInfo
->FontStyle
= InfoOut
.FontInfo
.FontStyle
;
2825 if (IsFontInfoExisted (Private
, FontInfo
, &InfoOut
.FontInfoMask
, LocalFontHandle
, &GlobalFont
)) {
2827 // Test to guarantee all characters are available in the found font.
2829 if (String
!= NULL
) {
2831 while (*StringIn
!= 0) {
2832 Status
= FindGlyphBlock (GlobalFont
->FontPackage
, *StringIn
, NULL
, NULL
, NULL
);
2833 if (EFI_ERROR (Status
)) {
2834 LocalFontHandle
= NULL
;
2841 // Write to output parameter
2843 if (StringInfoOut
!= NULL
) {
2844 StringInfoOutLen
= sizeof (EFI_FONT_DISPLAY_INFO
) - sizeof (EFI_FONT_INFO
) + GlobalFont
->FontInfoSize
;
2845 *StringInfoOut
= (EFI_FONT_DISPLAY_INFO
*) AllocateZeroPool (StringInfoOutLen
);
2846 if (*StringInfoOut
== NULL
) {
2847 Status
= EFI_OUT_OF_RESOURCES
;
2848 LocalFontHandle
= NULL
;
2852 CopyMem (*StringInfoOut
, &InfoOut
, sizeof (EFI_FONT_DISPLAY_INFO
));
2853 CopyMem (&(*StringInfoOut
)->FontInfo
, GlobalFont
->FontInfo
, GlobalFont
->FontInfoSize
);
2856 LocalFontHandle
= GlobalFont
->Entry
.ForwardLink
;
2857 Status
= EFI_SUCCESS
;
2861 Status
= EFI_NOT_FOUND
;
2865 if (FontHandle
!= NULL
) {
2866 *FontHandle
= LocalFontHandle
;
2869 if (SystemDefault
!= NULL
) {
2870 FreePool (SystemDefault
);
2872 if (FontInfo
!= NULL
) {
2873 FreePool (FontInfo
);