2 Implementation for EFI_HII_FONT_PROTOCOL.
5 Copyright (c) 2007 - 2008, Intel Corporation
6 All rights reserved. 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 STATIC EFI_GRAPHICS_OUTPUT_BLT_PIXEL mEfiColors
[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 CopyMem (&GlyphInfo
->Cell
, Cell
, sizeof (EFI_HII_GLYPH_INFO
));
80 InsertTailList (GlyphInfoList
, &GlyphInfo
->Entry
);
87 Get a character cell information from the list specified by GlyphInfoList.
89 This is a internal function.
91 @param CharValue Unicode character value, which identifies a glyph
93 @param GlyphInfoList HII_GLYPH_INFO list head.
94 @param Cell Buffer which stores output character cell
97 @retval EFI_SUCCESS Cell information is added to the GlyphInfoList.
98 @retval EFI_NOT_FOUND The character info specified by CharValue does
105 IN LIST_ENTRY
*GlyphInfoList
,
106 OUT EFI_HII_GLYPH_INFO
*Cell
109 HII_GLYPH_INFO
*GlyphInfo
;
112 ASSERT (Cell
!= NULL
&& GlyphInfoList
!= NULL
);
115 // Since the EFI_HII_GIBT_DEFAULTS block won't increment CharValueCurrent,
116 // the value of "CharId" of a default character cell which is used for a
117 // EFI_HII_GIBT_GLYPH_DEFAULT or EFI_HII_GIBT_GLYPHS_DEFAULT should be
118 // less or equal to the value of "CharValueCurrent" of this default block.
120 // For instance, if the CharId of a GlyphInfoList is {1, 3, 7}, a default glyph
121 // with CharValue equals "7" uses the GlyphInfo with CharId = 7;
122 // a default glyph with CharValue equals "6" uses the GlyphInfo with CharId = 3.
124 for (Link
= GlyphInfoList
->BackLink
; Link
!= GlyphInfoList
; Link
= Link
->BackLink
) {
125 GlyphInfo
= CR (Link
, HII_GLYPH_INFO
, Entry
, HII_GLYPH_INFO_SIGNATURE
);
126 if (GlyphInfo
->CharId
<= CharValue
) {
127 CopyMem (Cell
, &GlyphInfo
->Cell
, sizeof (EFI_HII_GLYPH_INFO
));
132 return EFI_NOT_FOUND
;
137 Convert the glyph for a single character into a bitmap.
139 This is a internal function.
141 @param Private HII database driver private data.
142 @param Char Character to retrieve.
143 @param StringInfo Points to the string font and color information
144 or NULL if the string should use the default
145 system font and color.
146 @param GlyphBuffer Buffer to store the retrieved bitmap data.
147 @param Cell Points to EFI_HII_GLYPH_INFO structure.
148 @param Attributes If not NULL, output the glyph attributes if any.
150 @retval EFI_SUCCESS Glyph bitmap outputted.
151 @retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer GlyphBuffer.
152 @retval EFI_NOT_FOUND The glyph was unknown can not be found.
153 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
158 IN HII_DATABASE_PRIVATE_DATA
*Private
,
160 IN EFI_FONT_INFO
*StringInfo
,
161 OUT UINT8
**GlyphBuffer
,
162 OUT EFI_HII_GLYPH_INFO
*Cell
,
163 OUT UINT8
*Attributes OPTIONAL
166 HII_DATABASE_RECORD
*Node
;
168 HII_SIMPLE_FONT_PACKAGE_INSTANCE
*SimpleFont
;
171 EFI_NARROW_GLYPH Narrow
;
173 HII_GLOBAL_FONT_INFO
*GlobalFont
;
175 EFI_NARROW_GLYPH
*NarrowPtr
;
176 EFI_WIDE_GLYPH
*WidePtr
;
178 if (GlyphBuffer
== NULL
|| Cell
== NULL
) {
179 return EFI_INVALID_PARAMETER
;
181 if (Private
== NULL
|| Private
->Signature
!= HII_DATABASE_PRIVATE_DATA_SIGNATURE
) {
182 return EFI_INVALID_PARAMETER
;
185 ZeroMem (Cell
, sizeof (EFI_HII_GLYPH_INFO
));
188 // If StringInfo is not NULL, it must point to an existing EFI_FONT_INFO rather
189 // than system default font and color.
190 // If NULL, try to find the character in simplified font packages since
191 // default system font is the fixed font (narrow or wide glyph).
193 if (StringInfo
!= NULL
) {
194 if(!IsFontInfoExisted (Private
, StringInfo
, NULL
, NULL
, &GlobalFont
)) {
195 return EFI_INVALID_PARAMETER
;
197 if (Attributes
!= NULL
) {
198 *Attributes
= PROPORTIONAL_GLYPH
;
200 return FindGlyphBlock (GlobalFont
->FontPackage
, Char
, GlyphBuffer
, Cell
, NULL
);
202 HeaderSize
= sizeof (EFI_HII_SIMPLE_FONT_PACKAGE_HDR
);
204 for (Link
= Private
->DatabaseList
.ForwardLink
; Link
!= &Private
->DatabaseList
; Link
= Link
->ForwardLink
) {
205 Node
= CR (Link
, HII_DATABASE_RECORD
, DatabaseEntry
, HII_DATABASE_RECORD_SIGNATURE
);
206 for (Link1
= Node
->PackageList
->SimpleFontPkgHdr
.ForwardLink
;
207 Link1
!= &Node
->PackageList
->SimpleFontPkgHdr
;
208 Link1
= Link1
->ForwardLink
210 SimpleFont
= CR (Link1
, HII_SIMPLE_FONT_PACKAGE_INSTANCE
, SimpleFontEntry
, HII_S_FONT_PACKAGE_SIGNATURE
);
212 // Search the narrow glyph array
214 NarrowPtr
= (EFI_NARROW_GLYPH
*) ((UINT8
*) (SimpleFont
->SimpleFontPkgHdr
) + HeaderSize
);
215 for (Index
= 0; Index
< SimpleFont
->SimpleFontPkgHdr
->NumberOfNarrowGlyphs
; Index
++) {
216 CopyMem (&Narrow
, NarrowPtr
+ Index
,sizeof (EFI_NARROW_GLYPH
));
217 if (Narrow
.UnicodeWeight
== Char
) {
218 *GlyphBuffer
= (UINT8
*) AllocateZeroPool (EFI_GLYPH_HEIGHT
);
219 if (*GlyphBuffer
== NULL
) {
220 return EFI_OUT_OF_RESOURCES
;
222 Cell
->Width
= EFI_GLYPH_WIDTH
;
223 Cell
->Height
= EFI_GLYPH_HEIGHT
;
224 Cell
->OffsetY
= NARROW_BASELINE
;
225 Cell
->AdvanceX
= Cell
->Width
;
226 CopyMem (*GlyphBuffer
, Narrow
.GlyphCol1
, Cell
->Height
);
227 if (Attributes
!= NULL
) {
228 *Attributes
= (UINT8
) (Narrow
.Attributes
| NARROW_GLYPH
);
234 // Search the wide glyph array
236 WidePtr
= (EFI_WIDE_GLYPH
*) (NarrowPtr
+ SimpleFont
->SimpleFontPkgHdr
->NumberOfNarrowGlyphs
);
237 for (Index
= 0; Index
< SimpleFont
->SimpleFontPkgHdr
->NumberOfWideGlyphs
; Index
++) {
238 CopyMem (&Wide
, WidePtr
+ Index
, sizeof (EFI_WIDE_GLYPH
));
239 if (Wide
.UnicodeWeight
== Char
) {
240 *GlyphBuffer
= (UINT8
*) AllocateZeroPool (EFI_GLYPH_HEIGHT
* 2);
241 if (*GlyphBuffer
== NULL
) {
242 return EFI_OUT_OF_RESOURCES
;
244 Cell
->Width
= EFI_GLYPH_WIDTH
* 2;
245 Cell
->Height
= EFI_GLYPH_HEIGHT
;
246 Cell
->OffsetY
= WIDE_BASELINE
;
247 Cell
->AdvanceX
= Cell
->Width
;
248 CopyMem (*GlyphBuffer
, Wide
.GlyphCol1
, EFI_GLYPH_HEIGHT
);
249 CopyMem (*GlyphBuffer
+ EFI_GLYPH_HEIGHT
, Wide
.GlyphCol2
, EFI_GLYPH_HEIGHT
);
250 if (Attributes
!= NULL
) {
251 *Attributes
= (UINT8
) (Wide
.Attributes
| EFI_GLYPH_WIDE
);
260 return EFI_NOT_FOUND
;
264 Convert bitmap data of the glyph to blt structure.
266 This is a internal function.
268 @param GlyphBuffer Buffer points to bitmap data of glyph.
269 @param Foreground The color of the "on" pixels in the glyph in the
271 @param Background The color of the "off" pixels in the glyph in the
273 @param ImageWidth Width of the character or character cell, in
275 @param ImageHeight Height of the character or character cell, in
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
,
291 IN UINTN ImageHeight
,
292 IN BOOLEAN Transparent
,
293 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
**Origin
300 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Buffer
;
302 ASSERT (GlyphBuffer
!= NULL
&& Origin
!= NULL
&& *Origin
!= NULL
);
304 Height
= EFI_GLYPH_HEIGHT
;
305 Width
= EFI_GLYPH_WIDTH
;
307 ASSERT (Width
<= ImageWidth
&& Height
<= ImageHeight
);
311 for (Ypos
= 0; Ypos
< Height
; Ypos
++) {
312 for (Xpos
= 0; Xpos
< Width
; Xpos
++) {
313 if ((GlyphBuffer
[Ypos
] & (1 << Xpos
)) != 0) {
314 Buffer
[Ypos
* ImageWidth
+ (Width
- Xpos
- 1)] = Foreground
;
317 Buffer
[Ypos
* ImageWidth
+ (Width
- Xpos
- 1)] = Background
;
323 *Origin
= Buffer
+ Width
;
328 Convert bitmap data of the glyph to blt structure.
330 This is a internal function.
332 @param GlyphBuffer Buffer points to bitmap data of glyph.
333 @param Foreground The color of the "on" pixels in the glyph in the
335 @param Background The color of the "off" pixels in the glyph in the
337 @param ImageWidth Width of the character or character cell, in
339 @param ImageHeight Height of the character or character cell, in
341 @param Transparent If TRUE, the Background color is ignored and all
342 "off" pixels in the character's drawn wil use the
343 pixel value from BltBuffer.
344 @param Cell Points to EFI_HII_GLYPH_INFO structure.
345 @param Attributes The attribute of incoming glyph in GlyphBuffer.
346 @param Origin On input, points to the origin of the to be
347 displayed character, on output, points to the
354 IN UINT8
*GlyphBuffer
,
355 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
,
356 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
,
358 IN UINTN ImageHeight
,
359 IN BOOLEAN Transparent
,
360 IN CONST EFI_HII_GLYPH_INFO
*Cell
,
362 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
**Origin
370 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
;
372 ASSERT (GlyphBuffer
!= NULL
&& Origin
!= NULL
&& *Origin
!= NULL
);
373 ASSERT (Cell
->Width
<= ImageWidth
&& Cell
->Height
<= ImageHeight
);
378 // Since non-spacing key will be printed OR'd with the previous glyph, don't
381 if ((Attributes
& EFI_GLYPH_NON_SPACING
) == EFI_GLYPH_NON_SPACING
) {
386 // The glyph's upper left hand corner pixel is the most significant bit of the
387 // first bitmap byte.
389 for (Ypos
= 0; Ypos
< Cell
->Height
; Ypos
++) {
390 OffsetY
= BITMAP_LEN_1_BIT (Cell
->Width
, Ypos
);
393 // All bits in these bytes are meaningful.
395 for (Xpos
= 0; Xpos
< Cell
->Width
/ 8; Xpos
++) {
396 Data
= *(GlyphBuffer
+ OffsetY
+ Xpos
);
397 for (Index
= 0; Index
< 8; Index
++) {
398 if ((Data
& (1 << Index
)) != 0) {
399 BltBuffer
[Ypos
* ImageWidth
+ Xpos
* 8 + (8 - Index
- 1)] = Foreground
;
402 BltBuffer
[Ypos
* ImageWidth
+ Xpos
* 8 + (8 - Index
- 1)] = Background
;
408 if (Cell
->Width
% 8 != 0) {
410 // There are some padding bits in this byte. Ignore them.
412 Data
= *(GlyphBuffer
+ OffsetY
+ Xpos
);
413 for (Index
= 0; Index
< Cell
->Width
% 8; Index
++) {
414 if ((Data
& (1 << (8 - Index
- 1))) != 0) {
415 BltBuffer
[Ypos
* ImageWidth
+ Xpos
* 8 + Index
] = Foreground
;
418 BltBuffer
[Ypos
* ImageWidth
+ Xpos
* 8 + Index
] = Background
;
422 } // end of if (Width % 8...)
424 } // end of for (Ypos=0...)
426 *Origin
= BltBuffer
+ Cell
->Width
;
431 Convert bitmap data of the glyph to blt structure.
433 This is a internal function.
435 @param GlyphBuffer Buffer points to bitmap data of glyph.
436 @param Foreground The color of the "on" pixels in the glyph in the
438 @param Background The color of the "off" pixels in the glyph in the
440 @param ImageWidth Width of the character or character cell, in
442 @param ImageHeight Height of the character or character cell, in
444 @param Transparent If TRUE, the Background color is ignored and all
445 "off" pixels in the character's drawn wil use the
446 pixel value from BltBuffer.
447 @param Cell Points to EFI_HII_GLYPH_INFO structure.
448 @param Attributes The attribute of incoming glyph in GlyphBuffer.
449 @param Origin On input, points to the origin of the to be
450 displayed character, on output, points to the
453 @return Points to the address of next origin node in BltBuffer.
458 IN UINT8
*GlyphBuffer
,
459 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
,
460 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
,
462 IN UINTN ImageHeight
,
463 IN BOOLEAN Transparent
,
464 IN CONST EFI_HII_GLYPH_INFO
*Cell
,
466 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
**Origin
469 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Buffer
;
471 ASSERT (GlyphBuffer
!= NULL
&& Origin
!= NULL
&& *Origin
!= NULL
);
472 ASSERT (Cell
->Width
<= ImageWidth
&& Cell
->Height
<= ImageHeight
);
476 if ((Attributes
& EFI_GLYPH_NON_SPACING
) == EFI_GLYPH_NON_SPACING
) {
478 // This character is a non-spacing key, print it OR'd with the previous glyph.
479 // without advancing cursor.
481 Buffer
-= Cell
->Width
;
494 } else if ((Attributes
& EFI_GLYPH_WIDE
) == EFI_GLYPH_WIDE
) {
496 // This character is wide glyph, i.e. 16 pixels * 19 pixels.
497 // Draw it as two narrow glyphs.
510 GlyphBuffer
+ EFI_GLYPH_HEIGHT
,
519 } else if ((Attributes
& NARROW_GLYPH
) == NARROW_GLYPH
) {
521 // This character is narrow glyph, i.e. 8 pixels * 19 pixels.
533 } else if ((Attributes
& PROPORTIONAL_GLYPH
) == PROPORTIONAL_GLYPH
) {
535 // This character is proportional glyph, i.e. Cell->Width * Cell->Height pixels.
553 Write the output parameters of FindGlyphBlock().
555 This is a internal function.
557 @param BufferIn Buffer which stores the bitmap data of the found
559 @param BufferLen Length of BufferIn.
560 @param InputCell Buffer which stores cell information of the
562 @param GlyphBuffer Output the corresponding bitmap data of the found
563 block. It is the caller's responsiblity to free
565 @param Cell Output cell information of the encoded bitmap.
566 @param GlyphBufferLen If not NULL, output the length of GlyphBuffer.
568 @retval EFI_SUCCESS The operation is performed successfully.
569 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
570 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
578 IN EFI_HII_GLYPH_INFO
*InputCell
,
579 OUT UINT8
**GlyphBuffer
, OPTIONAL
580 OUT EFI_HII_GLYPH_INFO
*Cell
, OPTIONAL
581 OUT UINTN
*GlyphBufferLen OPTIONAL
584 if (BufferIn
== NULL
|| BufferLen
< 1 || InputCell
== NULL
) {
585 return EFI_INVALID_PARAMETER
;
589 CopyMem (Cell
, InputCell
, sizeof (EFI_HII_GLYPH_INFO
));
592 if (GlyphBuffer
!= NULL
) {
593 *GlyphBuffer
= (UINT8
*) AllocateZeroPool (BufferLen
);
594 if (*GlyphBuffer
== NULL
) {
595 return EFI_OUT_OF_RESOURCES
;
597 CopyMem (*GlyphBuffer
, BufferIn
, BufferLen
);
600 if (GlyphBufferLen
!= NULL
) {
601 *GlyphBufferLen
= BufferLen
;
609 Parse all glyph blocks to find a glyph block specified by CharValue.
610 If CharValue = (CHAR16) (-1), collect all default character cell information
611 within this font package and backup its information.
613 @param FontPackage Hii string package instance.
614 @param CharValue Unicode character value, which identifies a glyph
616 @param GlyphBuffer Output the corresponding bitmap data of the found
617 block. It is the caller's responsiblity to free
619 @param Cell Output cell information of the encoded bitmap.
620 @param GlyphBufferLen If not NULL, output the length of GlyphBuffer.
622 @retval EFI_SUCCESS The bitmap data is retrieved successfully.
623 @retval EFI_NOT_FOUND The specified CharValue does not exist in current
625 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
631 IN HII_FONT_PACKAGE_INSTANCE
*FontPackage
,
633 OUT UINT8
**GlyphBuffer
, OPTIONAL
634 OUT EFI_HII_GLYPH_INFO
*Cell
, OPTIONAL
635 OUT UINTN
*GlyphBufferLen OPTIONAL
643 EFI_HII_GIBT_GLYPHS_BLOCK Glyphs
;
646 EFI_HII_GLYPH_INFO DefaultCell
;
647 EFI_HII_GLYPH_INFO LocalCell
;
649 ASSERT (FontPackage
!= NULL
);
650 ASSERT (FontPackage
->Signature
== HII_FONT_PACKAGE_SIGNATURE
);
652 if (CharValue
== (CHAR16
) (-1)) {
654 // Collect the cell information specified in font package fixed header.
655 // Use CharValue =0 to represent this particular cell.
659 &FontPackage
->GlyphInfoList
,
660 (EFI_HII_GLYPH_INFO
*) ((UINT8
*) FontPackage
->FontPkgHdr
+ 3 * sizeof (UINT32
))
662 if (EFI_ERROR (Status
)) {
667 BlockPtr
= FontPackage
->GlyphBlock
;
671 while (*BlockPtr
!= EFI_HII_GIBT_END
) {
673 case EFI_HII_GIBT_DEFAULTS
:
675 // Collect all default character cell information specified by
676 // EFI_HII_GIBT_DEFAULTS.
678 if (CharValue
== (CHAR16
) (-1)) {
681 &FontPackage
->GlyphInfoList
,
682 (EFI_HII_GLYPH_INFO
*) (BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
))
684 if (EFI_ERROR (Status
)) {
688 BlockPtr
+= sizeof (EFI_HII_GIBT_DEFAULTS_BLOCK
);
691 case EFI_HII_GIBT_DUPLICATE
:
692 if (CharCurrent
== CharValue
) {
693 CopyMem (&CharValue
, BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
), sizeof (CHAR16
));
695 BlockPtr
= FontPackage
->GlyphBlock
;
699 BlockPtr
+= sizeof (EFI_HII_GIBT_DUPLICATE_BLOCK
);
702 case EFI_HII_GIBT_EXT1
:
703 BlockPtr
+= *(BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
) + sizeof (UINT8
));
705 case EFI_HII_GIBT_EXT2
:
708 BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
) + sizeof (UINT8
),
711 BlockPtr
+= Length16
;
713 case EFI_HII_GIBT_EXT4
:
716 BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
) + sizeof (UINT8
),
719 BlockPtr
+= Length32
;
722 case EFI_HII_GIBT_GLYPH
:
725 BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
),
726 sizeof (EFI_HII_GLYPH_INFO
)
728 BufferLen
= BITMAP_LEN_1_BIT (LocalCell
.Width
, LocalCell
.Height
);
729 if (CharCurrent
== CharValue
) {
730 return WriteOutputParam (
731 BlockPtr
+ sizeof (EFI_HII_GIBT_GLYPH_BLOCK
) - sizeof (UINT8
),
740 BlockPtr
+= sizeof (EFI_HII_GIBT_GLYPH_BLOCK
) - sizeof (UINT8
) + BufferLen
;
743 case EFI_HII_GIBT_GLYPHS
:
744 BlockPtr
+= sizeof (EFI_HII_GLYPH_BLOCK
);
745 CopyMem (&Glyphs
.Cell
, BlockPtr
, sizeof (EFI_HII_GLYPH_INFO
));
746 BlockPtr
+= sizeof (EFI_HII_GLYPH_INFO
);
747 CopyMem (&Glyphs
.Count
, BlockPtr
, sizeof (UINT16
));
748 BlockPtr
+= sizeof (UINT16
);
750 BufferLen
= BITMAP_LEN_1_BIT (Glyphs
.Cell
.Width
, Glyphs
.Cell
.Height
);
751 for (Index
= 0; Index
< Glyphs
.Count
; Index
++) {
752 if (CharCurrent
+ Index
== CharValue
) {
753 return WriteOutputParam (
762 BlockPtr
+= BufferLen
;
764 CharCurrent
= (UINT16
) (CharCurrent
+ Glyphs
.Count
);
767 case EFI_HII_GIBT_GLYPH_DEFAULT
:
768 Status
= GetCell (CharCurrent
, &FontPackage
->GlyphInfoList
, &DefaultCell
);
769 if (EFI_ERROR (Status
)) {
772 BufferLen
= BITMAP_LEN_1_BIT (DefaultCell
.Width
, DefaultCell
.Height
);
774 if (CharCurrent
== CharValue
) {
775 return WriteOutputParam (
776 BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
),
785 BlockPtr
+= sizeof (EFI_HII_GLYPH_BLOCK
) + BufferLen
;
788 case EFI_HII_GIBT_GLYPHS_DEFAULT
:
789 CopyMem (&Length16
, BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
), sizeof (UINT16
));
790 Status
= GetCell (CharCurrent
, &FontPackage
->GlyphInfoList
, &DefaultCell
);
791 if (EFI_ERROR (Status
)) {
794 BufferLen
= BITMAP_LEN_1_BIT (DefaultCell
.Width
, DefaultCell
.Height
);
795 BlockPtr
+= sizeof (EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK
) - sizeof (UINT8
);
796 for (Index
= 0; Index
< Length16
; Index
++) {
797 if (CharCurrent
+ Index
== CharValue
) {
798 return WriteOutputParam (
807 BlockPtr
+= BufferLen
;
809 CharCurrent
= (UINT16
) (CharCurrent
+ Length16
);
812 case EFI_HII_GIBT_SKIP1
:
813 CharCurrent
= (UINT16
) (CharCurrent
+ (UINT16
) (*(BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
))));
814 BlockPtr
+= sizeof (EFI_HII_GIBT_SKIP1_BLOCK
);
816 case EFI_HII_GIBT_SKIP2
:
817 CopyMem (&Length16
, BlockPtr
+ sizeof (EFI_HII_GLYPH_BLOCK
), sizeof (UINT16
));
818 CharCurrent
= (UINT16
) (CharCurrent
+ Length16
);
819 BlockPtr
+= sizeof (EFI_HII_GIBT_SKIP2_BLOCK
);
826 if (CharValue
< CharCurrent
) {
827 return EFI_NOT_FOUND
;
831 if (CharValue
== (CHAR16
) (-1)) {
835 return EFI_NOT_FOUND
;
840 Copy a Font Name to a new created EFI_FONT_INFO structure.
842 This is a internal function.
844 @param FontName NULL-terminated string.
845 @param FontInfo a new EFI_FONT_INFO which stores the FontName.
846 It's caller's responsibility to free this buffer.
848 @retval EFI_SUCCESS FontInfo is allocated and copied with FontName.
849 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
855 IN EFI_STRING FontName
,
856 OUT EFI_FONT_INFO
**FontInfo
861 ASSERT (FontName
!= NULL
&& FontInfo
!= NULL
);
863 FontInfoLen
= sizeof (EFI_FONT_INFO
) - sizeof (CHAR16
) + StrSize (FontName
);
864 *FontInfo
= (EFI_FONT_INFO
*) AllocateZeroPool (FontInfoLen
);
865 if (*FontInfo
== NULL
) {
866 return EFI_OUT_OF_RESOURCES
;
869 StrCpy ((*FontInfo
)->FontName
, FontName
);
875 Retrieve system default font and color.
877 @param Private HII database driver private data.
878 @param FontInfo Points to system default font output-related
879 information. It's caller's responsibility to free
881 @param FontInfoSize If not NULL, output the size of buffer FontInfo.
883 @retval EFI_SUCCESS Cell information is added to the GlyphInfoList.
884 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
886 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
891 IN HII_DATABASE_PRIVATE_DATA
*Private
,
892 OUT EFI_FONT_DISPLAY_INFO
**FontInfo
,
893 OUT UINTN
*FontInfoSize OPTIONAL
896 EFI_FONT_DISPLAY_INFO
*Info
;
899 if (Private
== NULL
|| Private
->Signature
!= HII_DATABASE_PRIVATE_DATA_SIGNATURE
) {
900 return EFI_INVALID_PARAMETER
;
902 if (FontInfo
== NULL
) {
903 return EFI_INVALID_PARAMETER
;
907 // The standard font always has the name "sysdefault".
909 InfoSize
= sizeof (EFI_FONT_DISPLAY_INFO
) - sizeof (CHAR16
) + StrSize (L
"sysdefault");
910 Info
= (EFI_FONT_DISPLAY_INFO
*) AllocateZeroPool (InfoSize
);
912 return EFI_OUT_OF_RESOURCES
;
915 Info
->ForegroundColor
= mEfiColors
[Private
->Attribute
& 0x0f];
916 Info
->BackgroundColor
= mEfiColors
[Private
->Attribute
>> 4];
917 Info
->FontInfoMask
= EFI_FONT_INFO_SYS_FONT
| EFI_FONT_INFO_SYS_SIZE
| EFI_FONT_INFO_SYS_STYLE
;
918 Info
->FontInfo
.FontStyle
= 0;
919 Info
->FontInfo
.FontSize
= EFI_GLYPH_HEIGHT
;
920 StrCpy (Info
->FontInfo
.FontName
, L
"sysdefault");
923 if (FontInfoSize
!= NULL
) {
924 *FontInfoSize
= InfoSize
;
931 Check whether EFI_FONT_DISPLAY_INFO points to system default font and color or
932 returns the system default according to the optional inputs.
934 This is a internal function.
936 @param Private HII database driver private data.
937 @param StringInfo Points to the string output information,
938 including the color and font.
939 @param SystemInfo If not NULL, points to system default font and color.
941 @param SystemInfoLen If not NULL, output the length of default system
944 @retval TRUE Yes, it points to system default.
950 IN HII_DATABASE_PRIVATE_DATA
*Private
,
951 IN EFI_FONT_DISPLAY_INFO
*StringInfo
,
952 OUT EFI_FONT_DISPLAY_INFO
**SystemInfo
, OPTIONAL
953 OUT UINTN
*SystemInfoLen OPTIONAL
957 EFI_FONT_DISPLAY_INFO
*SystemDefault
;
961 ASSERT (Private
!= NULL
&& Private
->Signature
== HII_DATABASE_PRIVATE_DATA_SIGNATURE
);
963 if (StringInfo
== NULL
&& SystemInfo
== NULL
) {
967 Status
= GetSystemFont (Private
, &SystemDefault
, &DefaultLen
);
968 ASSERT_EFI_ERROR (Status
);
971 // Record the system default info.
973 if (SystemInfo
!= NULL
) {
974 *SystemInfo
= SystemDefault
;
977 if (SystemInfoLen
!= NULL
) {
978 *SystemInfoLen
= DefaultLen
;
981 if (StringInfo
== NULL
) {
987 // Check the FontInfoMask to see whether it is retrieving system info.
989 if ((StringInfo
->FontInfoMask
& (EFI_FONT_INFO_SYS_FONT
| EFI_FONT_INFO_ANY_FONT
)) == 0) {
990 if (StrCmp (StringInfo
->FontInfo
.FontName
, SystemDefault
->FontInfo
.FontName
) != 0) {
994 if ((StringInfo
->FontInfoMask
& (EFI_FONT_INFO_SYS_SIZE
| EFI_FONT_INFO_ANY_SIZE
)) == 0) {
995 if (StringInfo
->FontInfo
.FontSize
!= SystemDefault
->FontInfo
.FontSize
) {
999 if ((StringInfo
->FontInfoMask
& (EFI_FONT_INFO_SYS_STYLE
| EFI_FONT_INFO_ANY_STYLE
)) == 0) {
1000 if (StringInfo
->FontInfo
.FontStyle
!= SystemDefault
->FontInfo
.FontStyle
) {
1004 if ((StringInfo
->FontInfoMask
& EFI_FONT_INFO_SYS_FORE_COLOR
) == 0) {
1006 &StringInfo
->ForegroundColor
,
1007 &SystemDefault
->ForegroundColor
,
1008 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
1013 if ((StringInfo
->FontInfoMask
& EFI_FONT_INFO_SYS_BACK_COLOR
) == 0) {
1015 &StringInfo
->BackgroundColor
,
1016 &SystemDefault
->BackgroundColor
,
1017 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
1026 if (SystemInfo
== NULL
) {
1027 SafeFreePool (SystemDefault
);
1034 This function checks whether EFI_FONT_INFO exists in current database. If
1035 FontInfoMask is specified, check what options can be used to make a match.
1036 Note that the masks relate to where the system default should be supplied
1037 are ignored by this function.
1039 @param Private Hii database private structure.
1040 @param FontInfo Points to EFI_FONT_INFO structure.
1041 @param FontInfoMask If not NULL, describes what options can be used
1042 to make a match between the font requested and
1043 the font available. The caller must guarantee
1045 @param FontHandle On entry, Points to the font handle returned by a
1046 previous call to GetFontInfo() or NULL to start
1047 with the first font.
1048 @param GlobalFontInfo If not NULL, output the corresponding globa font
1051 @retval TRUE Existed
1052 @retval FALSE Not existed
1057 IN HII_DATABASE_PRIVATE_DATA
*Private
,
1058 IN EFI_FONT_INFO
*FontInfo
,
1059 IN EFI_FONT_INFO_MASK
*FontInfoMask
, OPTIONAL
1060 IN EFI_FONT_HANDLE FontHandle
, OPTIONAL
1061 OUT HII_GLOBAL_FONT_INFO
**GlobalFontInfo OPTIONAL
1064 HII_GLOBAL_FONT_INFO
*GlobalFont
;
1065 HII_GLOBAL_FONT_INFO
*GlobalFontBackup1
;
1066 HII_GLOBAL_FONT_INFO
*GlobalFontBackup2
;
1068 EFI_FONT_INFO_MASK Mask
;
1070 BOOLEAN VagueMatched1
;
1071 BOOLEAN VagueMatched2
;
1073 ASSERT (Private
!= NULL
&& Private
->Signature
== HII_DATABASE_PRIVATE_DATA_SIGNATURE
);
1074 ASSERT (FontInfo
!= NULL
);
1077 // Matched flag represents an exactly match; VagueMatched1 repensents a RESIZE
1078 // or RESTYLE match; VagueMatched2 represents a RESIZE | RESTYLE match.
1081 VagueMatched1
= FALSE
;
1082 VagueMatched2
= FALSE
;
1085 GlobalFontBackup1
= NULL
;
1086 GlobalFontBackup2
= NULL
;
1088 // The process of where the system default should be supplied instead of
1089 // the specified font info beyonds this function's scope.
1091 if (FontInfoMask
!= NULL
) {
1092 Mask
= *FontInfoMask
& (~SYS_FONT_INFO_MASK
);
1096 // If not NULL, FontHandle points to the next node of the last searched font
1097 // node by previous call.
1099 if (FontHandle
== NULL
) {
1100 Link
= Private
->FontInfoList
.ForwardLink
;
1102 Link
= (LIST_ENTRY
*) FontHandle
;
1105 for (; Link
!= &Private
->FontInfoList
; Link
= Link
->ForwardLink
) {
1106 GlobalFont
= CR (Link
, HII_GLOBAL_FONT_INFO
, Entry
, HII_GLOBAL_FONT_INFO_SIGNATURE
);
1107 if (FontInfoMask
== NULL
) {
1108 if (CompareMem (GlobalFont
->FontInfo
, FontInfo
, GlobalFont
->FontInfoSize
) == 0) {
1109 if (GlobalFontInfo
!= NULL
) {
1110 *GlobalFontInfo
= GlobalFont
;
1116 // Check which options could be used to make a match.
1119 case EFI_FONT_INFO_ANY_FONT
:
1120 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
&&
1121 GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1125 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_STYLE
:
1126 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1130 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_SIZE
:
1131 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1135 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_SIZE
| EFI_FONT_INFO_ANY_STYLE
:
1139 // If EFI_FONT_INFO_RESTYLE is specified, then the system may attempt to
1140 // remove some of the specified styles to meet the style requested.
1142 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_RESTYLE
:
1143 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1144 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1146 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1147 VagueMatched1
= TRUE
;
1148 GlobalFontBackup1
= GlobalFont
;
1153 // If EFI_FONT_INFO_RESIZE is specified, then the sytem may attempt to
1154 // stretch or shrink a font to meet the size requested.
1156 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_RESIZE
:
1157 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1158 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1161 VagueMatched1
= TRUE
;
1162 GlobalFontBackup1
= GlobalFont
;
1166 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_RESTYLE
| EFI_FONT_INFO_RESIZE
:
1167 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1168 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1171 VagueMatched1
= TRUE
;
1172 GlobalFontBackup1
= GlobalFont
;
1174 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1175 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1176 VagueMatched1
= TRUE
;
1177 GlobalFontBackup1
= GlobalFont
;
1179 VagueMatched2
= TRUE
;
1180 GlobalFontBackup2
= GlobalFont
;
1184 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_STYLE
| EFI_FONT_INFO_RESIZE
:
1185 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1188 VagueMatched1
= TRUE
;
1189 GlobalFontBackup1
= GlobalFont
;
1192 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_SIZE
| EFI_FONT_INFO_RESTYLE
:
1193 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1195 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1196 VagueMatched1
= TRUE
;
1197 GlobalFontBackup1
= GlobalFont
;
1200 case EFI_FONT_INFO_ANY_STYLE
:
1202 GlobalFont
->FontInfo
->FontName
,
1204 StrSize (FontInfo
->FontName
)
1206 GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1210 case EFI_FONT_INFO_ANY_STYLE
| EFI_FONT_INFO_ANY_SIZE
:
1212 GlobalFont
->FontInfo
->FontName
,
1214 StrSize (FontInfo
->FontName
)
1219 case EFI_FONT_INFO_ANY_STYLE
| EFI_FONT_INFO_RESIZE
:
1221 GlobalFont
->FontInfo
->FontName
,
1223 StrSize (FontInfo
->FontName
)
1225 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1228 VagueMatched1
= TRUE
;
1229 GlobalFontBackup1
= GlobalFont
;
1233 case EFI_FONT_INFO_ANY_SIZE
:
1235 GlobalFont
->FontInfo
->FontName
,
1237 StrSize (FontInfo
->FontName
)
1239 GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1243 case EFI_FONT_INFO_ANY_SIZE
| EFI_FONT_INFO_RESTYLE
:
1245 GlobalFont
->FontInfo
->FontName
,
1247 StrSize (FontInfo
->FontName
)
1249 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1251 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1252 VagueMatched1
= TRUE
;
1253 GlobalFontBackup1
= GlobalFont
;
1257 case EFI_FONT_INFO_RESTYLE
:
1259 GlobalFont
->FontInfo
->FontName
,
1261 StrSize (FontInfo
->FontName
)
1263 GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1265 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1267 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1268 VagueMatched1
= TRUE
;
1269 GlobalFontBackup1
= GlobalFont
;
1273 case EFI_FONT_INFO_RESIZE
:
1275 GlobalFont
->FontInfo
->FontName
,
1277 StrSize (FontInfo
->FontName
)
1279 GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1281 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1284 VagueMatched1
= TRUE
;
1285 GlobalFontBackup1
= GlobalFont
;
1289 case EFI_FONT_INFO_RESIZE
| EFI_FONT_INFO_RESTYLE
:
1291 GlobalFont
->FontInfo
->FontName
,
1293 StrSize (FontInfo
->FontName
)
1295 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1296 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1299 VagueMatched1
= TRUE
;
1300 GlobalFontBackup1
= GlobalFont
;
1302 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1303 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1304 VagueMatched1
= TRUE
;
1305 GlobalFontBackup1
= GlobalFont
;
1307 VagueMatched2
= TRUE
;
1308 GlobalFontBackup2
= GlobalFont
;
1318 if (GlobalFontInfo
!= NULL
) {
1319 *GlobalFontInfo
= GlobalFont
;
1326 if (VagueMatched1
) {
1327 if (GlobalFontInfo
!= NULL
) {
1328 *GlobalFontInfo
= GlobalFontBackup1
;
1331 } else if (VagueMatched2
) {
1332 if (GlobalFontInfo
!= NULL
) {
1333 *GlobalFontInfo
= GlobalFontBackup2
;
1343 Check whether the unicode represents a line break or not.
1345 This is a internal function.
1347 @param Char Unicode character
1349 @retval 0 Yes, it is a line break.
1350 @retval 1 Yes, it is a hyphen that desires a line break
1351 after this character.
1352 @retval 2 Yes, it is a dash that desires a line break
1353 before and after it.
1354 @retval -1 No, it is not a link break.
1366 // In little endian, Byte1 is the low byte of Char, Byte2 is the high byte of Char.
1368 Byte1
= *((UINT8
*) (&Char
));
1369 Byte2
= *(((UINT8
*) (&Char
) + 1));
1371 if (Byte2
== 0x20) {
1394 // BUGBUG: Does it really require line break before it and after it?
1398 } else if (Byte2
== 0x00) {
1422 Renders a string to a bitmap or to the display.
1424 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
1425 @param Flags Describes how the string is to be drawn.
1426 @param String Points to the null-terminated string to be
1428 @param StringInfo Points to the string output information,
1429 including the color and font. If NULL, then the
1430 string will be output in the default system font
1432 @param Blt If this points to a non-NULL on entry, this
1433 points to the image, which is Width pixels wide
1434 and Height pixels high. The string will be drawn
1436 EFI_HII_OUT_FLAG_CLIP is implied. If this points
1437 to a NULL on entry, then a buffer
1438 will be allocated to hold the generated image and
1439 the pointer updated on exit. It is the caller's
1440 responsibility to free this buffer.
1441 @param BltX Specifies the offset from the left and top edge
1442 of the image of the first character cell in the
1444 @param BltY Specifies the offset from the left and top edge
1445 of the image of the first character cell in the
1447 @param RowInfoArray If this is non-NULL on entry, then on exit, this
1448 will point to an allocated buffer containing
1449 row information and RowInfoArraySize will be
1450 updated to contain the number of elements.
1451 This array describes the characters which were at
1452 least partially drawn and the heights of the
1453 rows. It is the caller's responsibility to free
1455 @param RowInfoArraySize If this is non-NULL on entry, then on exit it
1456 contains the number of elements in RowInfoArray.
1457 @param ColumnInfoArray If this is non-NULL, then on return it will be
1458 filled with the horizontal offset for each
1459 character in the string on the row where it is
1460 displayed. Non-printing characters will have
1461 the offset ~0. The caller is responsible to
1462 allocate a buffer large enough so that there
1463 is one entry for each character in the string,
1464 not including the null-terminator. It is possible
1465 when character display is normalized that some
1466 character cells overlap.
1468 @retval EFI_SUCCESS The string was successfully rendered.
1469 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
1470 RowInfoArray or Blt.
1471 @retval EFI_INVALID_PARAMETER The String or Blt was NULL.
1472 @retval EFI_INVALID_PARAMETER Flags were invalid combination..
1478 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
1479 IN EFI_HII_OUT_FLAGS Flags
,
1480 IN CONST EFI_STRING String
,
1481 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo OPTIONAL
,
1482 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
1485 OUT EFI_HII_ROW_INFO
**RowInfoArray OPTIONAL
,
1486 OUT UINTN
*RowInfoArraySize OPTIONAL
,
1487 OUT UINTN
*ColumnInfoArray OPTIONAL
1491 HII_DATABASE_PRIVATE_DATA
*Private
;
1493 EFI_HII_GLYPH_INFO
*Cell
;
1495 EFI_IMAGE_OUTPUT
*Image
;
1496 EFI_STRING StringPtr
;
1497 EFI_STRING StringTmp
;
1498 EFI_HII_ROW_INFO
*RowInfo
;
1501 UINTN BaseLineOffset
;
1506 EFI_FONT_DISPLAY_INFO
*StringInfoOut
;
1507 EFI_FONT_DISPLAY_INFO
*SystemDefault
;
1508 EFI_FONT_HANDLE FontHandle
;
1509 EFI_STRING StringIn
;
1510 EFI_STRING StringIn2
;
1512 EFI_FONT_INFO
*FontInfo
;
1513 BOOLEAN SysFontFlag
;
1514 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
1515 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
1516 BOOLEAN Transparent
;
1517 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
;
1518 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BufferPtr
;
1523 // Check incoming parameters.
1526 if (This
== NULL
|| String
== NULL
|| Blt
== NULL
) {
1527 return EFI_INVALID_PARAMETER
;
1531 // These two flag cannot be used if Blt is NULL upon entry.
1533 if ((Flags
& EFI_HII_OUT_FLAG_TRANSPARENT
) == EFI_HII_OUT_FLAG_TRANSPARENT
) {
1534 return EFI_INVALID_PARAMETER
;
1536 if ((Flags
& EFI_HII_OUT_FLAG_CLIP
) == EFI_HII_OUT_FLAG_CLIP
) {
1537 return EFI_INVALID_PARAMETER
;
1541 // These two flags require that EFI_HII_OUT_FLAG_CLIP be also set.
1543 if ((Flags
& (EFI_HII_OUT_FLAG_CLIP
| EFI_HII_OUT_FLAG_CLIP_CLEAN_X
)) == EFI_HII_OUT_FLAG_CLIP_CLEAN_X
) {
1544 return EFI_INVALID_PARAMETER
;
1546 if ((Flags
& (EFI_HII_OUT_FLAG_CLIP
| EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
)) == EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
) {
1547 return EFI_INVALID_PARAMETER
;
1550 // This flag cannot be used with EFI_HII_OUT_FLAG_CLEAN_X.
1552 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
)) {
1553 return EFI_INVALID_PARAMETER
;
1556 GlyphBuf
= (UINT8
**) AllocateZeroPool (MAX_STRING_LENGTH
* sizeof (UINT8
*));
1557 ASSERT (GlyphBuf
!= NULL
);
1558 Cell
= (EFI_HII_GLYPH_INFO
*) AllocateZeroPool (MAX_STRING_LENGTH
* sizeof (EFI_HII_GLYPH_INFO
));
1559 ASSERT (Cell
!= NULL
);
1560 Attributes
= (UINT8
*) AllocateZeroPool (MAX_STRING_LENGTH
* sizeof (UINT8
));
1561 ASSERT (Attributes
!= NULL
);
1564 Status
= EFI_SUCCESS
;
1566 SystemDefault
= NULL
;
1569 // Calculate the string output information, including specified color and font .
1570 // If StringInfo does not points to system font info, it must indicate an existing
1573 StringInfoOut
= NULL
;
1575 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
1576 SysFontFlag
= IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, &SystemDefault
, NULL
);
1580 Height
= SystemDefault
->FontInfo
.FontSize
;
1581 Foreground
= SystemDefault
->ForegroundColor
;
1582 Background
= SystemDefault
->BackgroundColor
;
1585 Status
= HiiGetFontInfo (This
, &FontHandle
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, &StringInfoOut
, NULL
);
1586 if (Status
== EFI_NOT_FOUND
) {
1588 // The specified EFI_FONT_DISPLAY_INFO does not exist in current database.
1589 // Use the system font instead. Still use the color specified by StringInfo.
1593 Height
= SystemDefault
->FontInfo
.FontSize
;
1594 Foreground
= ((EFI_FONT_DISPLAY_INFO
*) StringInfo
)->ForegroundColor
;
1595 Background
= ((EFI_FONT_DISPLAY_INFO
*) StringInfo
)->BackgroundColor
;
1598 FontInfo
= &StringInfoOut
->FontInfo
;
1599 Height
= StringInfoOut
->FontInfo
.FontSize
;
1600 Foreground
= StringInfoOut
->ForegroundColor
;
1601 Background
= StringInfoOut
->BackgroundColor
;
1606 // Parse the string to be displayed to drop some ignored characters.
1613 // Ignore line-break characters only. Hyphens or dash character will be displayed
1614 // without line-break opportunity.
1616 if ((Flags
& EFI_HII_IGNORE_LINE_BREAK
) == EFI_HII_IGNORE_LINE_BREAK
) {
1617 StringIn
= AllocateZeroPool (StrSize (StringPtr
));
1618 if (StringIn
== NULL
) {
1619 Status
= EFI_OUT_OF_RESOURCES
;
1622 StringTmp
= StringIn
;
1623 while (*StringPtr
!= 0) {
1624 if (IsLineBreak (*StringPtr
) == 0) {
1627 *StringTmp
++ = *StringPtr
++;
1631 StringPtr
= StringIn
;
1634 // If EFI_HII_IGNORE_IF_NO_GLYPH is set, then characters which have no glyphs
1635 // are not drawn. Otherwise they are replaced wth Unicode character 0xFFFD.
1637 StringIn2
= AllocateZeroPool (StrSize (StringPtr
));
1638 if (StringIn2
== NULL
) {
1639 Status
= EFI_OUT_OF_RESOURCES
;
1643 StringTmp
= StringIn2
;
1645 while (*StringPtr
!= 0 && Index
< MAX_STRING_LENGTH
) {
1646 Status
= GetGlyphBuffer (Private
, *StringPtr
, FontInfo
, &GlyphBuf
[Index
], &Cell
[Index
], &Attributes
[Index
]);
1647 if (Status
== EFI_NOT_FOUND
) {
1648 if ((Flags
& EFI_HII_IGNORE_IF_NO_GLYPH
) == EFI_HII_IGNORE_IF_NO_GLYPH
) {
1649 SafeFreePool (GlyphBuf
[Index
]);
1650 GlyphBuf
[Index
] = NULL
;
1654 // Unicode 0xFFFD must exist in current hii database if this flag is not set.
1656 Status
= GetGlyphBuffer (
1658 REPLACE_UNKNOWN_GLYPH
,
1664 if (EFI_ERROR (Status
)) {
1665 Status
= EFI_INVALID_PARAMETER
;
1668 *StringTmp
++ = *StringPtr
++;
1671 } else if (EFI_ERROR (Status
)) {
1674 *StringTmp
++ = *StringPtr
++;
1679 StringPtr
= StringIn2
;
1682 // Draw the string according to the specified EFI_HII_OUT_FLAGS and Blt.
1683 // If Blt is not NULL, then EFI_HII_OUT_FLAG_CLIP is implied, render this string
1684 // to an existing image (bitmap or screen depending on flags) pointed by "*Blt".
1685 // Otherwise render this string to a new allocated image and output it.
1689 BufferPtr
= Image
->Image
.Bitmap
+ Image
->Width
* BltY
+ BltX
;
1690 MaxRowNum
= (UINT16
) (Image
->Height
/ Height
);
1691 if (Image
->Height
% Height
!= 0) {
1695 RowInfo
= (EFI_HII_ROW_INFO
*) AllocateZeroPool (MaxRowNum
* sizeof (EFI_HII_ROW_INFO
));
1696 if (RowInfo
== NULL
) {
1697 Status
= EFI_OUT_OF_RESOURCES
;
1702 // Format the glyph buffer according to flags.
1705 Transparent
= (BOOLEAN
) ((Flags
& EFI_HII_OUT_FLAG_TRANSPARENT
) == EFI_HII_OUT_FLAG_TRANSPARENT
? TRUE
: FALSE
);
1706 if ((Flags
& EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
) == EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
) {
1708 // Don't draw at all if there is only one row and
1709 // the row's bottom-most on pixel cannot fit.
1711 if (MaxRowNum
== 1 && SysFontFlag
) {
1712 Status
= EFI_SUCCESS
;
1717 for (RowIndex
= 0, Index
= 0; RowIndex
< MaxRowNum
&& StringPtr
[Index
] != 0; ) {
1724 // Calculate how many characters there are in a row.
1726 RowInfo
[RowIndex
].StartIndex
= Index
;
1728 while (LineWidth
+ BltX
< Image
->Width
&& StringPtr
[Index
] != 0) {
1729 LineWidth
+= (UINTN
) Cell
[Index
].AdvanceX
;
1730 if (LineHeight
< Cell
[Index
].Height
) {
1731 LineHeight
= (UINTN
) Cell
[Index
].Height
;
1734 if ((Flags
& EFI_HII_IGNORE_LINE_BREAK
) == 0 &&
1735 (Flags
& EFI_HII_OUT_FLAG_WRAP
) == 0 &&
1736 IsLineBreak (StringPtr
[Index
]) > 0) {
1738 // It is a line break that ends this row.
1748 // If this character is the last character of a row, we need not
1749 // draw its (AdvanceX - Width) for next character.
1753 LineWidth
-= (UINTN
) (Cell
[Index
].AdvanceX
- Cell
[Index
].Width
);
1757 // EFI_HII_OUT_FLAG_WRAP will wrap the text at the right-most line-break
1758 // opportunity prior to a character whose right-most extent would exceed Width.
1759 // Search the right-most line-break opportunity here.
1761 if ((Flags
& EFI_HII_OUT_FLAG_WRAP
) == EFI_HII_OUT_FLAG_WRAP
) {
1762 if ((Flags
& EFI_HII_IGNORE_LINE_BREAK
) == 0) {
1763 for (Index1
= RowInfo
[RowIndex
].EndIndex
; Index1
>= RowInfo
[RowIndex
].StartIndex
; Index1
--) {
1764 if (IsLineBreak (StringPtr
[Index1
]) > 0) {
1766 RowInfo
[RowIndex
].EndIndex
= Index1
- 1;
1772 // If no line-break opportunity can be found, then the text will
1773 // behave as if EFI_HII_OUT_FLAG_CLEAN_X is set.
1776 Flags
&= (~ (EFI_HII_OUT_FLAGS
) EFI_HII_OUT_FLAG_WRAP
);
1777 Flags
|= EFI_HII_OUT_FLAG_CLIP_CLEAN_X
;
1782 // Clip the right-most character if cannot fit when EFI_HII_OUT_FLAG_CLEAN_X is set.
1784 if (LineWidth
+ BltX
<= Image
->Width
||
1785 (LineWidth
+ BltX
> Image
->Width
&& (Flags
& EFI_HII_OUT_FLAG_CLIP_CLEAN_X
) == 0)) {
1787 // Record right-most character in RowInfo even if it is partially displayed.
1789 RowInfo
[RowIndex
].EndIndex
= Index
;
1790 RowInfo
[RowIndex
].LineWidth
= LineWidth
;
1791 RowInfo
[RowIndex
].LineHeight
= LineHeight
;
1792 RowInfo
[RowIndex
].BaselineOffset
= BaseLineOffset
;
1795 // When EFI_HII_OUT_FLAG_CLEAN_X is set, it will not draw a character
1796 // if its right-most on pixel cannot fit.
1799 RowInfo
[RowIndex
].EndIndex
= Index
- 1;
1800 RowInfo
[RowIndex
].LineWidth
= LineWidth
- Cell
[Index
].AdvanceX
;
1801 RowInfo
[RowIndex
].BaselineOffset
= BaseLineOffset
;
1802 if (LineHeight
> Cell
[Index
- 1].Height
) {
1803 LineHeight
= Cell
[Index
- 1].Height
;
1805 RowInfo
[RowIndex
].LineHeight
= LineHeight
;
1808 // There is only one column and it can not be drawn so that return directly.
1810 Status
= EFI_SUCCESS
;
1816 // Clip the final row if the row's bottom-most on pixel cannot fit when
1817 // EFI_HII_OUT_FLAG_CLEAN_Y is set.
1819 if (RowIndex
== MaxRowNum
- 1 && Image
->Height
< LineHeight
) {
1820 LineHeight
= Image
->Height
;
1821 if ((Flags
& EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
) == EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
) {
1823 // Don't draw at all if the row's bottom-most on pixel cannot fit.
1830 // Draw it to screen or existing bitmap depending on whether
1831 // EFI_HII_DIRECT_TO_SCREEN is set.
1833 if ((Flags
& EFI_HII_DIRECT_TO_SCREEN
) == EFI_HII_DIRECT_TO_SCREEN
) {
1834 BltBuffer
= AllocateZeroPool (RowInfo
[RowIndex
].LineWidth
* RowInfo
[RowIndex
].LineHeight
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
1835 if (BltBuffer
== NULL
) {
1836 Status
= EFI_OUT_OF_RESOURCES
;
1839 BufferPtr
= BltBuffer
;
1840 for (Index1
= RowInfo
[RowIndex
].StartIndex
; Index1
<= RowInfo
[RowIndex
].EndIndex
; Index1
++) {
1845 RowInfo
[RowIndex
].LineWidth
,
1846 RowInfo
[RowIndex
].LineHeight
,
1852 if (ColumnInfoArray
!= NULL
) {
1853 if (Index1
== RowInfo
[RowIndex
].StartIndex
) {
1854 *ColumnInfoArray
= 0;
1856 *ColumnInfoArray
= Cell
[Index1
-1].AdvanceX
;
1861 Status
= Image
->Image
.Screen
->Blt (
1862 Image
->Image
.Screen
,
1864 EfiBltBufferToVideo
,
1869 RowInfo
[RowIndex
].LineWidth
,
1870 RowInfo
[RowIndex
].LineHeight
,
1873 if (EFI_ERROR (Status
)) {
1874 SafeFreePool (BltBuffer
);
1878 SafeFreePool (BltBuffer
);
1881 for (Index1
= RowInfo
[RowIndex
].StartIndex
; Index1
<= RowInfo
[RowIndex
].EndIndex
; Index1
++) {
1893 if (ColumnInfoArray
!= NULL
) {
1894 if (Index1
== RowInfo
[RowIndex
].StartIndex
) {
1895 *ColumnInfoArray
= 0;
1897 *ColumnInfoArray
= Cell
[Index1
-1].AdvanceX
;
1905 BufferPtr
+= BltX
+ Image
->Width
* (LineHeight
- 1);
1914 // Write output parameters.
1916 RowInfoSize
= RowIndex
* sizeof (EFI_HII_ROW_INFO
);
1917 if (RowInfoArray
!= NULL
) {
1918 *RowInfoArray
= AllocateZeroPool (RowInfoSize
);
1919 if (*RowInfoArray
== NULL
) {
1920 Status
= EFI_OUT_OF_RESOURCES
;
1923 CopyMem (*RowInfoArray
, RowInfo
, RowInfoSize
);
1925 if (RowInfoArraySize
!= NULL
) {
1926 *RowInfoArraySize
= RowIndex
;
1931 // Create a new bitmap and draw the string onto this image.
1933 Image
= AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT
));
1934 if (Image
== NULL
) {
1935 return EFI_OUT_OF_RESOURCES
;
1938 Image
->Height
= 600;
1939 Image
->Image
.Bitmap
= AllocateZeroPool (Image
->Width
* Image
->Height
*sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
1940 if (Image
->Image
.Bitmap
== NULL
) {
1941 SafeFreePool (Image
);
1942 return EFI_OUT_OF_RESOURCES
;
1946 // Other flags are not permitted when Blt is NULL.
1948 Flags
&= EFI_HII_OUT_FLAG_WRAP
| EFI_HII_IGNORE_IF_NO_GLYPH
| EFI_HII_IGNORE_LINE_BREAK
;
1949 Status
= HiiStringToImage (
1961 if (EFI_ERROR (Status
)) {
1968 Status
= EFI_SUCCESS
;
1972 for (Index
= 0; Index
< MAX_STRING_LENGTH
; Index
++) {
1973 SafeFreePool (GlyphBuf
[Index
]);
1975 SafeFreePool (StringIn
);
1976 SafeFreePool (StringIn2
);
1977 SafeFreePool (StringInfoOut
);
1978 SafeFreePool (RowInfo
);
1979 SafeFreePool (SystemDefault
);
1980 SafeFreePool (GlyphBuf
);
1981 SafeFreePool (Cell
);
1982 SafeFreePool (Attributes
);
1989 Render a string to a bitmap or the screen containing the contents of the specified string.
1991 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
1992 @param Flags Describes how the string is to be drawn.
1993 @param PackageList The package list in the HII database to search
1994 for the specified string.
1995 @param StringId The string's id, which is unique within
1997 @param Language Points to the language for the retrieved string.
1998 If NULL, then the current system language is
2000 @param StringInfo Points to the string output information,
2001 including the color and font. If NULL, then the
2002 string will be output in the default system font
2004 @param Blt If this points to a non-NULL on entry, this
2005 points to the image, which is Width pixels wide
2006 and Height pixels high. The string will be drawn
2008 EFI_HII_OUT_FLAG_CLIP is implied. If this points
2009 to a NULL on entry, then a buffer
2010 will be allocated to hold the generated image and
2011 the pointer updated on exit. It is the caller's
2012 responsibility to free this buffer.
2013 @param BltX Specifies the offset from the left and top edge
2014 of the image of the first character cell in the
2016 @param BltY Specifies the offset from the left and top edge
2017 of the image of the first character cell in the
2019 @param RowInfoArray If this is non-NULL on entry, then on exit, this
2020 will point to an allocated buffer containing
2021 row information and RowInfoArraySize will be
2022 updated to contain the number of elements.
2023 This array describes the characters which were at
2024 least partially drawn and the heights of the
2025 rows. It is the caller's responsibility to free
2027 @param RowInfoArraySize If this is non-NULL on entry, then on exit it
2028 contains the number of elements in RowInfoArray.
2029 @param ColumnInfoArray If this is non-NULL, then on return it will be
2030 filled with the horizontal offset for each
2031 character in the string on the row where it is
2032 displayed. Non-printing characters will have
2033 the offset ~0. The caller is responsible to
2034 allocate a buffer large enough so that there
2035 is one entry for each character in the string,
2036 not including the null-terminator. It is possible
2037 when character display is normalized that some
2038 character cells overlap.
2040 @retval EFI_SUCCESS The string was successfully rendered.
2041 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
2042 RowInfoArray or Blt.
2043 @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.
2044 @retval EFI_INVALID_PARAMETER Flags were invalid combination.
2045 @retval EFI_NOT_FOUND The specified PackageList is not in the Database or the stringid is not
2046 in the specified PackageList.
2051 HiiStringIdToImage (
2052 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
2053 IN EFI_HII_OUT_FLAGS Flags
,
2054 IN EFI_HII_HANDLE PackageList
,
2055 IN EFI_STRING_ID StringId
,
2056 IN CONST CHAR8
* Language
,
2057 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo OPTIONAL
,
2058 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
2061 OUT EFI_HII_ROW_INFO
**RowInfoArray OPTIONAL
,
2062 OUT UINTN
*RowInfoArraySize OPTIONAL
,
2063 OUT UINTN
*ColumnInfoArray OPTIONAL
2067 HII_DATABASE_PRIVATE_DATA
*Private
;
2071 EFI_FONT_INFO
*StringFontInfo
;
2072 EFI_FONT_DISPLAY_INFO
*NewStringInfo
;
2073 CHAR8 CurrentLang
[RFC_3066_ENTRY_SIZE
];
2075 if (This
== NULL
|| PackageList
== NULL
|| Blt
== NULL
|| PackageList
== NULL
) {
2076 return EFI_INVALID_PARAMETER
;
2079 if (!IsHiiHandleValid (PackageList
)) {
2080 return EFI_NOT_FOUND
;
2084 // When Language points to NULL, current system language is used.
2086 if (Language
!= NULL
) {
2087 AsciiStrCpy (CurrentLang
, (CHAR8
*) Language
);
2089 HiiLibGetCurrentLanguage (CurrentLang
);
2093 // Get the string to be displayed.
2096 StringSize
= MAX_STRING_LENGTH
;
2097 String
= (EFI_STRING
) AllocateZeroPool (StringSize
);
2098 if (String
== NULL
) {
2099 return EFI_OUT_OF_RESOURCES
;
2102 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2103 StringFontInfo
= NULL
;
2104 NewStringInfo
= NULL
;
2106 Status
= Private
->HiiString
.GetString (
2107 &Private
->HiiString
,
2115 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2116 SafeFreePool (String
);
2117 String
= (EFI_STRING
) AllocateZeroPool (StringSize
);
2118 if (String
== NULL
) {
2119 return EFI_OUT_OF_RESOURCES
;
2121 Status
= Private
->HiiString
.GetString (
2122 &Private
->HiiString
,
2133 if (EFI_ERROR (Status
)) {
2138 // When StringInfo specifies that string will be output in the system default font and color,
2139 // use particular stringfontinfo described in string package instead if exists.
2140 // StringFontInfo equals NULL means system default font attaches with the string block.
2142 if (StringFontInfo
!= NULL
&& IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, NULL
, NULL
)) {
2143 FontLen
= sizeof (EFI_FONT_DISPLAY_INFO
) - sizeof (CHAR16
) + StrSize (StringFontInfo
->FontName
);
2144 NewStringInfo
= AllocateZeroPool (FontLen
);
2145 if (NewStringInfo
== NULL
) {
2146 Status
= EFI_OUT_OF_RESOURCES
;
2149 NewStringInfo
->FontInfoMask
= EFI_FONT_INFO_SYS_FORE_COLOR
| EFI_FONT_INFO_SYS_BACK_COLOR
;
2150 NewStringInfo
->FontInfo
.FontStyle
= StringFontInfo
->FontStyle
;
2151 NewStringInfo
->FontInfo
.FontSize
= StringFontInfo
->FontSize
;
2152 StrCpy (NewStringInfo
->FontInfo
.FontName
, StringFontInfo
->FontName
);
2154 Status
= HiiStringToImage (
2169 Status
= HiiStringToImage (
2183 SafeFreePool (String
);
2184 SafeFreePool (StringFontInfo
);
2185 SafeFreePool (NewStringInfo
);
2192 Convert the glyph for a single character into a bitmap.
2194 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
2195 @param Char Character to retrieve.
2196 @param StringInfo Points to the string font and color information
2197 or NULL if the string should use the default
2198 system font and color.
2199 @param Blt Thus must point to a NULL on entry. A buffer will
2200 be allocated to hold the output and the pointer
2201 updated on exit. It is the caller's
2202 responsibility to free this buffer.
2203 @param Baseline Number of pixels from the bottom of the bitmap to
2206 @retval EFI_SUCCESS Glyph bitmap created.
2207 @retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer Blt.
2208 @retval EFI_WARN_UNKNOWN_GLYPH The glyph was unknown and was replaced with the
2209 glyph for Unicode character 0xFFFD.
2210 @retval EFI_INVALID_PARAMETER Blt is NULL or *Blt is not NULL.
2216 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
2218 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo
,
2219 OUT EFI_IMAGE_OUTPUT
**Blt
,
2220 OUT UINTN
*Baseline OPTIONAL
2224 HII_DATABASE_PRIVATE_DATA
*Private
;
2225 EFI_IMAGE_OUTPUT
*Image
;
2227 EFI_FONT_DISPLAY_INFO
*SystemDefault
;
2228 EFI_FONT_DISPLAY_INFO
*StringInfoOut
;
2230 EFI_FONT_HANDLE FontHandle
;
2232 EFI_HII_GLYPH_INFO Cell
;
2233 EFI_FONT_INFO
*FontInfo
;
2235 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
2236 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
2237 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
;
2239 if (This
== NULL
|| Blt
== NULL
|| *Blt
!= NULL
) {
2240 return EFI_INVALID_PARAMETER
;
2243 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2247 SystemDefault
= NULL
;
2251 StringInfoOut
= NULL
;
2254 ZeroMem (&Foreground
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
2255 ZeroMem (&Background
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
2257 Default
= IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, &SystemDefault
, NULL
);
2261 // Find out a EFI_FONT_DISPLAY_INFO which could display the character in
2262 // the specified color and font.
2264 String
= (EFI_STRING
) AllocateZeroPool (sizeof (CHAR16
) * 2);
2265 if (String
== NULL
) {
2266 Status
= EFI_OUT_OF_RESOURCES
;
2272 Status
= HiiGetFontInfo (This
, &FontHandle
, StringInfo
, &StringInfoOut
, String
);
2273 if (EFI_ERROR (Status
)) {
2276 FontInfo
= &StringInfoOut
->FontInfo
;
2277 Foreground
= StringInfoOut
->ForegroundColor
;
2278 Background
= StringInfoOut
->BackgroundColor
;
2280 Foreground
= SystemDefault
->ForegroundColor
;
2281 Background
= SystemDefault
->BackgroundColor
;
2284 Status
= GetGlyphBuffer (Private
, Char
, FontInfo
, &GlyphBuffer
, &Cell
, &Attributes
);
2285 if (EFI_ERROR (Status
)) {
2289 Image
= (EFI_IMAGE_OUTPUT
*) AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT
));
2290 if (Image
== NULL
) {
2291 Status
= EFI_OUT_OF_RESOURCES
;
2294 Image
->Width
= Cell
.Width
;
2295 Image
->Height
= Cell
.Height
;
2297 Image
->Image
.Bitmap
= AllocateZeroPool (Image
->Width
* Image
->Height
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
2298 if (Image
->Image
.Bitmap
== NULL
) {
2299 SafeFreePool (Image
);
2300 Status
= EFI_OUT_OF_RESOURCES
;
2304 BltBuffer
= Image
->Image
.Bitmap
;
2318 if (Baseline
!= NULL
) {
2319 *Baseline
= Cell
.OffsetY
;
2322 Status
= EFI_SUCCESS
;
2326 if (Status
== EFI_NOT_FOUND
) {
2328 // Glyph is unknown and replaced with the glyph for unicode character 0xFFFD
2330 if (Char
!= REPLACE_UNKNOWN_GLYPH
) {
2331 Status
= HiiGetGlyph (This
, REPLACE_UNKNOWN_GLYPH
, StringInfo
, Blt
, Baseline
);
2332 if (!EFI_ERROR (Status
)) {
2333 Status
= EFI_WARN_UNKNOWN_GLYPH
;
2336 Status
= EFI_WARN_UNKNOWN_GLYPH
;
2340 SafeFreePool (SystemDefault
);
2341 SafeFreePool (StringInfoOut
);
2342 SafeFreePool (String
);
2343 SafeFreePool (GlyphBuffer
);
2350 This function iterates through fonts which match the specified font, using
2351 the specified criteria. If String is non-NULL, then all of the characters in
2352 the string must exist in order for a candidate font to be returned.
2354 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
2355 @param FontHandle On entry, points to the font handle returned by a
2356 previous call to GetFontInfo() or NULL to start
2357 with the first font. On return, points to the
2358 returned font handle or points to NULL if there
2359 are no more matching fonts.
2360 @param StringInfoIn Upon entry, points to the font to return
2362 If NULL, then the information about the system default
2363 font will be returned.
2364 @param StringInfoOut Upon return, contains the matching font's
2365 information. If NULL, then no information is
2366 returned. It's caller's responsibility to free
2368 @param String Points to the string which will be tested to
2369 determine if all characters are available. If
2370 NULL, then any font is acceptable.
2372 @retval EFI_SUCCESS Matching font returned successfully.
2373 @retval EFI_NOT_FOUND No matching font was found.
2374 @retval EFI_INVALID_PARAMETER StringInfoIn->FontInfoMask is an invalid combination.
2375 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the
2382 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
2383 IN OUT EFI_FONT_HANDLE
*FontHandle
,
2384 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfoIn
, OPTIONAL
2385 OUT EFI_FONT_DISPLAY_INFO
**StringInfoOut
,
2386 IN CONST EFI_STRING String OPTIONAL
2389 HII_DATABASE_PRIVATE_DATA
*Private
;
2391 EFI_FONT_DISPLAY_INFO
*SystemDefault
;
2392 EFI_FONT_DISPLAY_INFO InfoOut
;
2393 UINTN StringInfoOutLen
;
2394 EFI_FONT_INFO
*FontInfo
;
2395 HII_GLOBAL_FONT_INFO
*GlobalFont
;
2396 EFI_STRING StringIn
;
2397 EFI_FONT_HANDLE LocalFontHandle
;
2400 return EFI_INVALID_PARAMETER
;
2404 SystemDefault
= NULL
;
2405 LocalFontHandle
= NULL
;
2406 if (FontHandle
!= NULL
) {
2407 LocalFontHandle
= *FontHandle
;
2410 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2413 // Already searched to the end of the whole list, return directly.
2415 if (LocalFontHandle
== &Private
->FontInfoList
) {
2416 LocalFontHandle
= NULL
;
2417 Status
= EFI_NOT_FOUND
;
2422 // Get default system display info, if StringInfoIn points to
2423 // system display info, return it directly.
2425 if (IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfoIn
, &SystemDefault
, &StringInfoOutLen
)) {
2427 // System font is the first node. When handle is not NULL, system font can not
2428 // be found any more.
2430 if (LocalFontHandle
== NULL
) {
2431 if (StringInfoOut
!= NULL
) {
2432 *StringInfoOut
= AllocateCopyPool (StringInfoOutLen
, SystemDefault
);
2433 if (*StringInfoOut
== NULL
) {
2434 Status
= EFI_OUT_OF_RESOURCES
;
2435 LocalFontHandle
= NULL
;
2440 LocalFontHandle
= Private
->FontInfoList
.ForwardLink
;
2441 Status
= EFI_SUCCESS
;
2444 LocalFontHandle
= NULL
;
2445 Status
= EFI_NOT_FOUND
;
2451 // Check the font information mask to make sure it is valid.
2453 if (((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_SYS_FONT
| EFI_FONT_INFO_ANY_FONT
)) ==
2454 (EFI_FONT_INFO_SYS_FONT
| EFI_FONT_INFO_ANY_FONT
)) ||
2455 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_SYS_SIZE
| EFI_FONT_INFO_ANY_SIZE
)) ==
2456 (EFI_FONT_INFO_SYS_SIZE
| EFI_FONT_INFO_ANY_SIZE
)) ||
2457 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_SYS_STYLE
| EFI_FONT_INFO_ANY_STYLE
)) ==
2458 (EFI_FONT_INFO_SYS_STYLE
| EFI_FONT_INFO_ANY_STYLE
)) ||
2459 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_RESIZE
| EFI_FONT_INFO_ANY_SIZE
)) ==
2460 (EFI_FONT_INFO_RESIZE
| EFI_FONT_INFO_ANY_SIZE
)) ||
2461 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_RESTYLE
| EFI_FONT_INFO_ANY_STYLE
)) ==
2462 (EFI_FONT_INFO_RESTYLE
| EFI_FONT_INFO_ANY_STYLE
))) {
2463 return EFI_INVALID_PARAMETER
;
2467 // Parse the font information mask to find a matching font.
2470 CopyMem (&InfoOut
, (EFI_FONT_DISPLAY_INFO
*) StringInfoIn
, sizeof (EFI_FONT_DISPLAY_INFO
));
2472 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_FONT
) == EFI_FONT_INFO_SYS_FONT
) {
2473 Status
= SaveFontName (SystemDefault
->FontInfo
.FontName
, &FontInfo
);
2475 Status
= SaveFontName (((EFI_FONT_DISPLAY_INFO
*) StringInfoIn
)->FontInfo
.FontName
, &FontInfo
);
2477 if (EFI_ERROR (Status
)) {
2481 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_SIZE
) == EFI_FONT_INFO_SYS_SIZE
) {
2482 InfoOut
.FontInfo
.FontSize
= SystemDefault
->FontInfo
.FontSize
;
2484 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_STYLE
) == EFI_FONT_INFO_SYS_STYLE
) {
2485 InfoOut
.FontInfo
.FontStyle
= SystemDefault
->FontInfo
.FontStyle
;
2487 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_FORE_COLOR
) == EFI_FONT_INFO_SYS_FORE_COLOR
) {
2488 InfoOut
.ForegroundColor
= SystemDefault
->ForegroundColor
;
2490 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_BACK_COLOR
) == EFI_FONT_INFO_SYS_BACK_COLOR
) {
2491 InfoOut
.BackgroundColor
= SystemDefault
->BackgroundColor
;
2495 FontInfo
->FontSize
= InfoOut
.FontInfo
.FontSize
;
2496 FontInfo
->FontStyle
= InfoOut
.FontInfo
.FontStyle
;
2498 if (IsFontInfoExisted (Private
, FontInfo
, &InfoOut
.FontInfoMask
, LocalFontHandle
, &GlobalFont
)) {
2500 // Test to guarantee all characters are available in the found font.
2502 if (String
!= NULL
) {
2504 while (*StringIn
!= 0) {
2505 Status
= FindGlyphBlock (GlobalFont
->FontPackage
, *StringIn
, NULL
, NULL
, NULL
);
2506 if (EFI_ERROR (Status
)) {
2507 LocalFontHandle
= NULL
;
2514 // Write to output parameter
2516 if (StringInfoOut
!= NULL
) {
2517 StringInfoOutLen
= sizeof (EFI_FONT_DISPLAY_INFO
) - sizeof (EFI_FONT_INFO
) + GlobalFont
->FontInfoSize
;
2518 *StringInfoOut
= (EFI_FONT_DISPLAY_INFO
*) AllocateZeroPool (StringInfoOutLen
);
2519 if (*StringInfoOut
== NULL
) {
2520 Status
= EFI_OUT_OF_RESOURCES
;
2521 LocalFontHandle
= NULL
;
2525 CopyMem (*StringInfoOut
, &InfoOut
, sizeof (EFI_FONT_DISPLAY_INFO
));
2526 CopyMem (&(*StringInfoOut
)->FontInfo
, GlobalFont
->FontInfo
, GlobalFont
->FontInfoSize
);
2529 LocalFontHandle
= GlobalFont
->Entry
.ForwardLink
;
2530 Status
= EFI_SUCCESS
;
2534 Status
= EFI_NOT_FOUND
;
2538 if (FontHandle
!= NULL
) {
2539 *FontHandle
= LocalFontHandle
;
2542 SafeFreePool (SystemDefault
);
2543 SafeFreePool (FontInfo
);