2 Implementation for EFI_HII_FONT_PROTOCOL.
5 Copyright (c) 2007 - 2009, 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 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 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
= mHiiEfiColors
[Private
->Attribute
& 0x0f];
916 Info
->BackgroundColor
= mHiiEfiColors
[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 if (SystemDefault
!= NULL
) {
1028 FreePool (SystemDefault
);
1036 This function checks whether EFI_FONT_INFO exists in current database. If
1037 FontInfoMask is specified, check what options can be used to make a match.
1038 Note that the masks relate to where the system default should be supplied
1039 are ignored by this function.
1041 @param Private Hii database private structure.
1042 @param FontInfo Points to EFI_FONT_INFO structure.
1043 @param FontInfoMask If not NULL, describes what options can be used
1044 to make a match between the font requested and
1045 the font available. The caller must guarantee
1047 @param FontHandle On entry, Points to the font handle returned by a
1048 previous call to GetFontInfo() or NULL to start
1049 with the first font.
1050 @param GlobalFontInfo If not NULL, output the corresponding globa font
1053 @retval TRUE Existed
1054 @retval FALSE Not existed
1059 IN HII_DATABASE_PRIVATE_DATA
*Private
,
1060 IN EFI_FONT_INFO
*FontInfo
,
1061 IN EFI_FONT_INFO_MASK
*FontInfoMask
, OPTIONAL
1062 IN EFI_FONT_HANDLE FontHandle
, OPTIONAL
1063 OUT HII_GLOBAL_FONT_INFO
**GlobalFontInfo OPTIONAL
1066 HII_GLOBAL_FONT_INFO
*GlobalFont
;
1067 HII_GLOBAL_FONT_INFO
*GlobalFontBackup1
;
1068 HII_GLOBAL_FONT_INFO
*GlobalFontBackup2
;
1070 EFI_FONT_INFO_MASK Mask
;
1072 BOOLEAN VagueMatched1
;
1073 BOOLEAN VagueMatched2
;
1075 ASSERT (Private
!= NULL
&& Private
->Signature
== HII_DATABASE_PRIVATE_DATA_SIGNATURE
);
1076 ASSERT (FontInfo
!= NULL
);
1079 // Matched flag represents an exactly match; VagueMatched1 repensents a RESIZE
1080 // or RESTYLE match; VagueMatched2 represents a RESIZE | RESTYLE match.
1083 VagueMatched1
= FALSE
;
1084 VagueMatched2
= FALSE
;
1087 GlobalFontBackup1
= NULL
;
1088 GlobalFontBackup2
= NULL
;
1090 // The process of where the system default should be supplied instead of
1091 // the specified font info beyonds this function's scope.
1093 if (FontInfoMask
!= NULL
) {
1094 Mask
= *FontInfoMask
& (~SYS_FONT_INFO_MASK
);
1098 // If not NULL, FontHandle points to the next node of the last searched font
1099 // node by previous call.
1101 if (FontHandle
== NULL
) {
1102 Link
= Private
->FontInfoList
.ForwardLink
;
1104 Link
= (LIST_ENTRY
*) FontHandle
;
1107 for (; Link
!= &Private
->FontInfoList
; Link
= Link
->ForwardLink
) {
1108 GlobalFont
= CR (Link
, HII_GLOBAL_FONT_INFO
, Entry
, HII_GLOBAL_FONT_INFO_SIGNATURE
);
1109 if (FontInfoMask
== NULL
) {
1110 if (CompareMem (GlobalFont
->FontInfo
, FontInfo
, GlobalFont
->FontInfoSize
) == 0) {
1111 if (GlobalFontInfo
!= NULL
) {
1112 *GlobalFontInfo
= GlobalFont
;
1118 // Check which options could be used to make a match.
1121 case EFI_FONT_INFO_ANY_FONT
:
1122 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
&&
1123 GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1127 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_STYLE
:
1128 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1132 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_SIZE
:
1133 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1137 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_SIZE
| EFI_FONT_INFO_ANY_STYLE
:
1141 // If EFI_FONT_INFO_RESTYLE is specified, then the system may attempt to
1142 // remove some of the specified styles to meet the style requested.
1144 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_RESTYLE
:
1145 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1146 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1148 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1149 VagueMatched1
= TRUE
;
1150 GlobalFontBackup1
= GlobalFont
;
1155 // If EFI_FONT_INFO_RESIZE is specified, then the sytem may attempt to
1156 // stretch or shrink a font to meet the size requested.
1158 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_RESIZE
:
1159 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1160 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1163 VagueMatched1
= TRUE
;
1164 GlobalFontBackup1
= GlobalFont
;
1168 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_RESTYLE
| EFI_FONT_INFO_RESIZE
:
1169 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1170 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1173 VagueMatched1
= TRUE
;
1174 GlobalFontBackup1
= GlobalFont
;
1176 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1177 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1178 VagueMatched1
= TRUE
;
1179 GlobalFontBackup1
= GlobalFont
;
1181 VagueMatched2
= TRUE
;
1182 GlobalFontBackup2
= GlobalFont
;
1186 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_STYLE
| EFI_FONT_INFO_RESIZE
:
1187 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1190 VagueMatched1
= TRUE
;
1191 GlobalFontBackup1
= GlobalFont
;
1194 case EFI_FONT_INFO_ANY_FONT
| EFI_FONT_INFO_ANY_SIZE
| EFI_FONT_INFO_RESTYLE
:
1195 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1197 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1198 VagueMatched1
= TRUE
;
1199 GlobalFontBackup1
= GlobalFont
;
1202 case EFI_FONT_INFO_ANY_STYLE
:
1204 GlobalFont
->FontInfo
->FontName
,
1206 StrSize (FontInfo
->FontName
)
1208 GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1212 case EFI_FONT_INFO_ANY_STYLE
| EFI_FONT_INFO_ANY_SIZE
:
1214 GlobalFont
->FontInfo
->FontName
,
1216 StrSize (FontInfo
->FontName
)
1221 case EFI_FONT_INFO_ANY_STYLE
| EFI_FONT_INFO_RESIZE
:
1223 GlobalFont
->FontInfo
->FontName
,
1225 StrSize (FontInfo
->FontName
)
1227 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1230 VagueMatched1
= TRUE
;
1231 GlobalFontBackup1
= GlobalFont
;
1235 case EFI_FONT_INFO_ANY_SIZE
:
1237 GlobalFont
->FontInfo
->FontName
,
1239 StrSize (FontInfo
->FontName
)
1241 GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1245 case EFI_FONT_INFO_ANY_SIZE
| EFI_FONT_INFO_RESTYLE
:
1247 GlobalFont
->FontInfo
->FontName
,
1249 StrSize (FontInfo
->FontName
)
1251 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1253 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1254 VagueMatched1
= TRUE
;
1255 GlobalFontBackup1
= GlobalFont
;
1259 case EFI_FONT_INFO_RESTYLE
:
1261 GlobalFont
->FontInfo
->FontName
,
1263 StrSize (FontInfo
->FontName
)
1265 GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1267 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1269 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1270 VagueMatched1
= TRUE
;
1271 GlobalFontBackup1
= GlobalFont
;
1275 case EFI_FONT_INFO_RESIZE
:
1277 GlobalFont
->FontInfo
->FontName
,
1279 StrSize (FontInfo
->FontName
)
1281 GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1283 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1286 VagueMatched1
= TRUE
;
1287 GlobalFontBackup1
= GlobalFont
;
1291 case EFI_FONT_INFO_RESIZE
| EFI_FONT_INFO_RESTYLE
:
1293 GlobalFont
->FontInfo
->FontName
,
1295 StrSize (FontInfo
->FontName
)
1297 if (GlobalFont
->FontInfo
->FontStyle
== FontInfo
->FontStyle
) {
1298 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1301 VagueMatched1
= TRUE
;
1302 GlobalFontBackup1
= GlobalFont
;
1304 } else if ((GlobalFont
->FontInfo
->FontStyle
& FontInfo
->FontStyle
) == FontInfo
->FontStyle
) {
1305 if (GlobalFont
->FontInfo
->FontSize
== FontInfo
->FontSize
) {
1306 VagueMatched1
= TRUE
;
1307 GlobalFontBackup1
= GlobalFont
;
1309 VagueMatched2
= TRUE
;
1310 GlobalFontBackup2
= GlobalFont
;
1320 if (GlobalFontInfo
!= NULL
) {
1321 *GlobalFontInfo
= GlobalFont
;
1328 if (VagueMatched1
) {
1329 if (GlobalFontInfo
!= NULL
) {
1330 *GlobalFontInfo
= GlobalFontBackup1
;
1333 } else if (VagueMatched2
) {
1334 if (GlobalFontInfo
!= NULL
) {
1335 *GlobalFontInfo
= GlobalFontBackup2
;
1345 Check whether the unicode represents a line break or not.
1347 This is a internal function.
1349 @param Char Unicode character
1351 @retval 0 Yes, it is a line break.
1352 @retval 1 Yes, it is a hyphen that desires a line break
1353 after this character.
1354 @retval 2 Yes, it is a dash that desires a line break
1355 before and after it.
1356 @retval -1 No, it is not a link break.
1368 // In little endian, Byte1 is the low byte of Char, Byte2 is the high byte of Char.
1370 Byte1
= *((UINT8
*) (&Char
));
1371 Byte2
= *(((UINT8
*) (&Char
) + 1));
1373 if (Byte2
== 0x20) {
1396 // BUGBUG: Does it really require line break before it and after it?
1400 } else if (Byte2
== 0x00) {
1424 Renders a string to a bitmap or to the display.
1426 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
1427 @param Flags Describes how the string is to be drawn.
1428 @param String Points to the null-terminated string to be
1430 @param StringInfo Points to the string output information,
1431 including the color and font. If NULL, then the
1432 string will be output in the default system font
1434 @param Blt If this points to a non-NULL on entry, this
1435 points to the image, which is Width pixels wide
1436 and Height pixels high. The string will be drawn
1438 EFI_HII_OUT_FLAG_CLIP is implied. If this points
1439 to a NULL on entry, then a buffer
1440 will be allocated to hold the generated image and
1441 the pointer updated on exit. It is the caller's
1442 responsibility to free this buffer.
1443 @param BltX Specifies the offset from the left and top edge
1444 of the image of the first character cell in the
1446 @param BltY Specifies the offset from the left and top edge
1447 of the image of the first character cell in the
1449 @param RowInfoArray If this is non-NULL on entry, then on exit, this
1450 will point to an allocated buffer containing
1451 row information and RowInfoArraySize will be
1452 updated to contain the number of elements.
1453 This array describes the characters which were at
1454 least partially drawn and the heights of the
1455 rows. It is the caller's responsibility to free
1457 @param RowInfoArraySize If this is non-NULL on entry, then on exit it
1458 contains the number of elements in RowInfoArray.
1459 @param ColumnInfoArray If this is non-NULL, then on return it will be
1460 filled with the horizontal offset for each
1461 character in the string on the row where it is
1462 displayed. Non-printing characters will have
1463 the offset ~0. The caller is responsible to
1464 allocate a buffer large enough so that there
1465 is one entry for each character in the string,
1466 not including the null-terminator. It is possible
1467 when character display is normalized that some
1468 character cells overlap.
1470 @retval EFI_SUCCESS The string was successfully rendered.
1471 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
1472 RowInfoArray or Blt.
1473 @retval EFI_INVALID_PARAMETER The String or Blt was NULL.
1474 @retval EFI_INVALID_PARAMETER Flags were invalid combination..
1480 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
1481 IN EFI_HII_OUT_FLAGS Flags
,
1482 IN CONST EFI_STRING String
,
1483 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo OPTIONAL
,
1484 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
1487 OUT EFI_HII_ROW_INFO
**RowInfoArray OPTIONAL
,
1488 OUT UINTN
*RowInfoArraySize OPTIONAL
,
1489 OUT UINTN
*ColumnInfoArray OPTIONAL
1493 HII_DATABASE_PRIVATE_DATA
*Private
;
1495 EFI_HII_GLYPH_INFO
*Cell
;
1497 EFI_IMAGE_OUTPUT
*Image
;
1498 EFI_STRING StringPtr
;
1499 EFI_STRING StringTmp
;
1500 EFI_HII_ROW_INFO
*RowInfo
;
1503 UINTN BaseLineOffset
;
1508 EFI_FONT_DISPLAY_INFO
*StringInfoOut
;
1509 EFI_FONT_DISPLAY_INFO
*SystemDefault
;
1510 EFI_FONT_HANDLE FontHandle
;
1511 EFI_STRING StringIn
;
1512 EFI_STRING StringIn2
;
1514 EFI_FONT_INFO
*FontInfo
;
1515 BOOLEAN SysFontFlag
;
1516 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
1517 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
1518 BOOLEAN Transparent
;
1519 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
;
1520 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BufferPtr
;
1525 // Check incoming parameters.
1528 if (This
== NULL
|| String
== NULL
|| Blt
== NULL
) {
1529 return EFI_INVALID_PARAMETER
;
1533 // These two flag cannot be used if Blt is NULL upon entry.
1535 if ((Flags
& EFI_HII_OUT_FLAG_TRANSPARENT
) == EFI_HII_OUT_FLAG_TRANSPARENT
) {
1536 return EFI_INVALID_PARAMETER
;
1538 if ((Flags
& EFI_HII_OUT_FLAG_CLIP
) == EFI_HII_OUT_FLAG_CLIP
) {
1539 return EFI_INVALID_PARAMETER
;
1543 // These two flags require that EFI_HII_OUT_FLAG_CLIP be also set.
1545 if ((Flags
& (EFI_HII_OUT_FLAG_CLIP
| EFI_HII_OUT_FLAG_CLIP_CLEAN_X
)) == EFI_HII_OUT_FLAG_CLIP_CLEAN_X
) {
1546 return EFI_INVALID_PARAMETER
;
1548 if ((Flags
& (EFI_HII_OUT_FLAG_CLIP
| EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
)) == EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
) {
1549 return EFI_INVALID_PARAMETER
;
1552 // This flag cannot be used with EFI_HII_OUT_FLAG_CLEAN_X.
1554 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
)) {
1555 return EFI_INVALID_PARAMETER
;
1558 GlyphBuf
= (UINT8
**) AllocateZeroPool (MAX_STRING_LENGTH
* sizeof (UINT8
*));
1559 ASSERT (GlyphBuf
!= NULL
);
1560 Cell
= (EFI_HII_GLYPH_INFO
*) AllocateZeroPool (MAX_STRING_LENGTH
* sizeof (EFI_HII_GLYPH_INFO
));
1561 ASSERT (Cell
!= NULL
);
1562 Attributes
= (UINT8
*) AllocateZeroPool (MAX_STRING_LENGTH
* sizeof (UINT8
));
1563 ASSERT (Attributes
!= NULL
);
1566 Status
= EFI_SUCCESS
;
1568 SystemDefault
= NULL
;
1572 // Calculate the string output information, including specified color and font .
1573 // If StringInfo does not points to system font info, it must indicate an existing
1576 StringInfoOut
= NULL
;
1578 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
1579 SysFontFlag
= IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, &SystemDefault
, NULL
);
1583 Height
= SystemDefault
->FontInfo
.FontSize
;
1584 Foreground
= SystemDefault
->ForegroundColor
;
1585 Background
= SystemDefault
->BackgroundColor
;
1589 // StringInfo must not be NULL if it is not system info.
1591 ASSERT (StringInfo
!= NULL
);
1592 Status
= HiiGetFontInfo (This
, &FontHandle
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, &StringInfoOut
, NULL
);
1593 if (Status
== EFI_NOT_FOUND
) {
1595 // The specified EFI_FONT_DISPLAY_INFO does not exist in current database.
1596 // Use the system font instead. Still use the color specified by StringInfo.
1600 Height
= SystemDefault
->FontInfo
.FontSize
;
1601 Foreground
= ((EFI_FONT_DISPLAY_INFO
*) StringInfo
)->ForegroundColor
;
1602 Background
= ((EFI_FONT_DISPLAY_INFO
*) StringInfo
)->BackgroundColor
;
1604 } else if (Status
== EFI_SUCCESS
) {
1605 FontInfo
= &StringInfoOut
->FontInfo
;
1606 Height
= StringInfoOut
->FontInfo
.FontSize
;
1607 Foreground
= StringInfoOut
->ForegroundColor
;
1608 Background
= StringInfoOut
->BackgroundColor
;
1615 // Parse the string to be displayed to drop some ignored characters.
1621 // Ignore line-break characters only. Hyphens or dash character will be displayed
1622 // without line-break opportunity.
1624 if ((Flags
& EFI_HII_IGNORE_LINE_BREAK
) == EFI_HII_IGNORE_LINE_BREAK
) {
1625 StringIn
= AllocateZeroPool (StrSize (StringPtr
));
1626 if (StringIn
== NULL
) {
1627 Status
= EFI_OUT_OF_RESOURCES
;
1630 StringTmp
= StringIn
;
1631 while (*StringPtr
!= 0) {
1632 if (IsLineBreak (*StringPtr
) == 0) {
1635 *StringTmp
++ = *StringPtr
++;
1639 StringPtr
= StringIn
;
1642 // If EFI_HII_IGNORE_IF_NO_GLYPH is set, then characters which have no glyphs
1643 // are not drawn. Otherwise they are replaced wth Unicode character 0xFFFD.
1645 StringIn2
= AllocateZeroPool (StrSize (StringPtr
));
1646 if (StringIn2
== NULL
) {
1647 Status
= EFI_OUT_OF_RESOURCES
;
1651 StringTmp
= StringIn2
;
1653 while (*StringPtr
!= 0 && Index
< MAX_STRING_LENGTH
) {
1654 Status
= GetGlyphBuffer (Private
, *StringPtr
, FontInfo
, &GlyphBuf
[Index
], &Cell
[Index
], &Attributes
[Index
]);
1655 if (Status
== EFI_NOT_FOUND
) {
1656 if ((Flags
& EFI_HII_IGNORE_IF_NO_GLYPH
) == EFI_HII_IGNORE_IF_NO_GLYPH
) {
1657 if (GlyphBuf
[Index
] != NULL
) {
1658 FreePool (GlyphBuf
[Index
]);
1660 GlyphBuf
[Index
] = NULL
;
1664 // Unicode 0xFFFD must exist in current hii database if this flag is not set.
1666 Status
= GetGlyphBuffer (
1668 REPLACE_UNKNOWN_GLYPH
,
1674 if (EFI_ERROR (Status
)) {
1675 Status
= EFI_INVALID_PARAMETER
;
1678 *StringTmp
++ = *StringPtr
++;
1681 } else if (EFI_ERROR (Status
)) {
1684 *StringTmp
++ = *StringPtr
++;
1689 StringPtr
= StringIn2
;
1692 // Draw the string according to the specified EFI_HII_OUT_FLAGS and Blt.
1693 // If Blt is not NULL, then EFI_HII_OUT_FLAG_CLIP is implied, render this string
1694 // to an existing image (bitmap or screen depending on flags) pointed by "*Blt".
1695 // Otherwise render this string to a new allocated image and output it.
1699 BufferPtr
= Image
->Image
.Bitmap
+ Image
->Width
* BltY
+ BltX
;
1700 MaxRowNum
= (UINT16
) (Image
->Height
/ Height
);
1701 if (Image
->Height
% Height
!= 0) {
1705 RowInfo
= (EFI_HII_ROW_INFO
*) AllocateZeroPool (MaxRowNum
* sizeof (EFI_HII_ROW_INFO
));
1706 if (RowInfo
== NULL
) {
1707 Status
= EFI_OUT_OF_RESOURCES
;
1712 // Format the glyph buffer according to flags.
1715 Transparent
= (BOOLEAN
) ((Flags
& EFI_HII_OUT_FLAG_TRANSPARENT
) == EFI_HII_OUT_FLAG_TRANSPARENT
? TRUE
: FALSE
);
1716 if ((Flags
& EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
) == EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
) {
1718 // Don't draw at all if there is only one row and
1719 // the row's bottom-most on pixel cannot fit.
1721 if (MaxRowNum
== 1 && SysFontFlag
) {
1722 Status
= EFI_SUCCESS
;
1727 for (RowIndex
= 0, Index
= 0; RowIndex
< MaxRowNum
&& StringPtr
[Index
] != 0; ) {
1734 // Calculate how many characters there are in a row.
1736 RowInfo
[RowIndex
].StartIndex
= Index
;
1738 while (LineWidth
+ BltX
< Image
->Width
&& StringPtr
[Index
] != 0) {
1739 LineWidth
+= (UINTN
) Cell
[Index
].AdvanceX
;
1740 if (LineHeight
< Cell
[Index
].Height
) {
1741 LineHeight
= (UINTN
) Cell
[Index
].Height
;
1744 if ((Flags
& EFI_HII_IGNORE_LINE_BREAK
) == 0 &&
1745 (Flags
& EFI_HII_OUT_FLAG_WRAP
) == 0 &&
1746 IsLineBreak (StringPtr
[Index
]) > 0) {
1748 // It is a line break that ends this row.
1758 // If this character is the last character of a row, we need not
1759 // draw its (AdvanceX - Width) for next character.
1763 LineWidth
-= (UINTN
) (Cell
[Index
].AdvanceX
- Cell
[Index
].Width
);
1767 // EFI_HII_OUT_FLAG_WRAP will wrap the text at the right-most line-break
1768 // opportunity prior to a character whose right-most extent would exceed Width.
1769 // Search the right-most line-break opportunity here.
1771 if ((Flags
& EFI_HII_OUT_FLAG_WRAP
) == EFI_HII_OUT_FLAG_WRAP
) {
1772 if ((Flags
& EFI_HII_IGNORE_LINE_BREAK
) == 0) {
1773 for (Index1
= RowInfo
[RowIndex
].EndIndex
; Index1
>= RowInfo
[RowIndex
].StartIndex
; Index1
--) {
1774 if (IsLineBreak (StringPtr
[Index1
]) > 0) {
1776 RowInfo
[RowIndex
].EndIndex
= Index1
- 1;
1782 // If no line-break opportunity can be found, then the text will
1783 // behave as if EFI_HII_OUT_FLAG_CLEAN_X is set.
1786 Flags
&= (~ (EFI_HII_OUT_FLAGS
) EFI_HII_OUT_FLAG_WRAP
);
1787 Flags
|= EFI_HII_OUT_FLAG_CLIP_CLEAN_X
;
1792 // Clip the right-most character if cannot fit when EFI_HII_OUT_FLAG_CLEAN_X is set.
1794 if (LineWidth
+ BltX
<= Image
->Width
||
1795 (LineWidth
+ BltX
> Image
->Width
&& (Flags
& EFI_HII_OUT_FLAG_CLIP_CLEAN_X
) == 0)) {
1797 // Record right-most character in RowInfo even if it is partially displayed.
1799 RowInfo
[RowIndex
].EndIndex
= Index
;
1800 RowInfo
[RowIndex
].LineWidth
= LineWidth
;
1801 RowInfo
[RowIndex
].LineHeight
= LineHeight
;
1802 RowInfo
[RowIndex
].BaselineOffset
= BaseLineOffset
;
1805 // When EFI_HII_OUT_FLAG_CLEAN_X is set, it will not draw a character
1806 // if its right-most on pixel cannot fit.
1809 RowInfo
[RowIndex
].EndIndex
= Index
- 1;
1810 RowInfo
[RowIndex
].LineWidth
= LineWidth
- Cell
[Index
].AdvanceX
;
1811 RowInfo
[RowIndex
].BaselineOffset
= BaseLineOffset
;
1812 if (LineHeight
> Cell
[Index
- 1].Height
) {
1813 LineHeight
= Cell
[Index
- 1].Height
;
1815 RowInfo
[RowIndex
].LineHeight
= LineHeight
;
1818 // There is only one column and it can not be drawn so that return directly.
1820 Status
= EFI_SUCCESS
;
1826 // Clip the final row if the row's bottom-most on pixel cannot fit when
1827 // EFI_HII_OUT_FLAG_CLEAN_Y is set.
1829 if (RowIndex
== MaxRowNum
- 1 && Image
->Height
< LineHeight
) {
1830 LineHeight
= Image
->Height
;
1831 if ((Flags
& EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
) == EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
) {
1833 // Don't draw at all if the row's bottom-most on pixel cannot fit.
1840 // Draw it to screen or existing bitmap depending on whether
1841 // EFI_HII_DIRECT_TO_SCREEN is set.
1843 if ((Flags
& EFI_HII_DIRECT_TO_SCREEN
) == EFI_HII_DIRECT_TO_SCREEN
) {
1844 BltBuffer
= AllocateZeroPool (RowInfo
[RowIndex
].LineWidth
* RowInfo
[RowIndex
].LineHeight
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
1845 if (BltBuffer
== NULL
) {
1846 Status
= EFI_OUT_OF_RESOURCES
;
1849 BufferPtr
= BltBuffer
;
1850 for (Index1
= RowInfo
[RowIndex
].StartIndex
; Index1
<= RowInfo
[RowIndex
].EndIndex
; Index1
++) {
1855 RowInfo
[RowIndex
].LineWidth
,
1856 RowInfo
[RowIndex
].LineHeight
,
1862 if (ColumnInfoArray
!= NULL
) {
1863 if (Index1
== RowInfo
[RowIndex
].StartIndex
) {
1864 *ColumnInfoArray
= 0;
1866 *ColumnInfoArray
= Cell
[Index1
-1].AdvanceX
;
1871 Status
= Image
->Image
.Screen
->Blt (
1872 Image
->Image
.Screen
,
1874 EfiBltBufferToVideo
,
1879 RowInfo
[RowIndex
].LineWidth
,
1880 RowInfo
[RowIndex
].LineHeight
,
1883 if (EFI_ERROR (Status
)) {
1884 FreePool (BltBuffer
);
1888 FreePool (BltBuffer
);
1891 for (Index1
= RowInfo
[RowIndex
].StartIndex
; Index1
<= RowInfo
[RowIndex
].EndIndex
; Index1
++) {
1903 if (ColumnInfoArray
!= NULL
) {
1904 if (Index1
== RowInfo
[RowIndex
].StartIndex
) {
1905 *ColumnInfoArray
= 0;
1907 *ColumnInfoArray
= Cell
[Index1
-1].AdvanceX
;
1915 BufferPtr
+= BltX
+ Image
->Width
* (LineHeight
- 1);
1924 // Write output parameters.
1926 RowInfoSize
= RowIndex
* sizeof (EFI_HII_ROW_INFO
);
1927 if (RowInfoArray
!= NULL
) {
1928 *RowInfoArray
= AllocateZeroPool (RowInfoSize
);
1929 if (*RowInfoArray
== NULL
) {
1930 Status
= EFI_OUT_OF_RESOURCES
;
1933 CopyMem (*RowInfoArray
, RowInfo
, RowInfoSize
);
1935 if (RowInfoArraySize
!= NULL
) {
1936 *RowInfoArraySize
= RowIndex
;
1941 // Create a new bitmap and draw the string onto this image.
1943 Image
= AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT
));
1944 if (Image
== NULL
) {
1945 return EFI_OUT_OF_RESOURCES
;
1948 Image
->Height
= 600;
1949 Image
->Image
.Bitmap
= AllocateZeroPool (Image
->Width
* Image
->Height
*sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
1950 if (Image
->Image
.Bitmap
== NULL
) {
1952 return EFI_OUT_OF_RESOURCES
;
1956 // Other flags are not permitted when Blt is NULL.
1958 Flags
&= EFI_HII_OUT_FLAG_WRAP
| EFI_HII_IGNORE_IF_NO_GLYPH
| EFI_HII_IGNORE_LINE_BREAK
;
1959 Status
= HiiStringToImage (
1971 if (EFI_ERROR (Status
)) {
1978 Status
= EFI_SUCCESS
;
1982 for (Index
= 0; Index
< MAX_STRING_LENGTH
; Index
++) {
1983 if (GlyphBuf
[Index
] != NULL
) {
1984 FreePool (GlyphBuf
[Index
]);
1987 if (StringIn
!= NULL
) {
1988 FreePool (StringIn
);
1990 if (StringIn2
!= NULL
) {
1991 FreePool (StringIn2
);
1993 if (StringInfoOut
!= NULL
) {
1994 FreePool (StringInfoOut
);
1996 if (RowInfo
!= NULL
) {
1999 if (SystemDefault
!= NULL
) {
2000 FreePool (SystemDefault
);
2002 if (GlyphBuf
!= NULL
) {
2003 FreePool (GlyphBuf
);
2008 if (Attributes
!= NULL
) {
2009 FreePool (Attributes
);
2017 Render a string to a bitmap or the screen containing the contents of the specified string.
2019 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
2020 @param Flags Describes how the string is to be drawn.
2021 @param PackageList The package list in the HII database to search
2022 for the specified string.
2023 @param StringId The string's id, which is unique within
2025 @param Language Points to the language for the retrieved string.
2026 If NULL, then the current system language is
2028 @param StringInfo Points to the string output information,
2029 including the color and font. If NULL, then the
2030 string will be output in the default system font
2032 @param Blt If this points to a non-NULL on entry, this
2033 points to the image, which is Width pixels wide
2034 and Height pixels high. The string will be drawn
2036 EFI_HII_OUT_FLAG_CLIP is implied. If this points
2037 to a NULL on entry, then a buffer
2038 will be allocated to hold the generated image and
2039 the pointer updated on exit. It is the caller's
2040 responsibility to free this buffer.
2041 @param BltX Specifies the offset from the left and top edge
2042 of the image of the first character cell in the
2044 @param BltY Specifies the offset from the left and top edge
2045 of the image of the first character cell in the
2047 @param RowInfoArray If this is non-NULL on entry, then on exit, this
2048 will point to an allocated buffer containing
2049 row information and RowInfoArraySize will be
2050 updated to contain the number of elements.
2051 This array describes the characters which were at
2052 least partially drawn and the heights of the
2053 rows. It is the caller's responsibility to free
2055 @param RowInfoArraySize If this is non-NULL on entry, then on exit it
2056 contains the number of elements in RowInfoArray.
2057 @param ColumnInfoArray If this is non-NULL, then on return it will be
2058 filled with the horizontal offset for each
2059 character in the string on the row where it is
2060 displayed. Non-printing characters will have
2061 the offset ~0. The caller is responsible to
2062 allocate a buffer large enough so that there
2063 is one entry for each character in the string,
2064 not including the null-terminator. It is possible
2065 when character display is normalized that some
2066 character cells overlap.
2068 @retval EFI_SUCCESS The string was successfully rendered.
2069 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
2070 RowInfoArray or Blt.
2071 @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.
2072 @retval EFI_INVALID_PARAMETER Flags were invalid combination.
2073 @retval EFI_NOT_FOUND The specified PackageList is not in the Database or the stringid is not
2074 in the specified PackageList.
2079 HiiStringIdToImage (
2080 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
2081 IN EFI_HII_OUT_FLAGS Flags
,
2082 IN EFI_HII_HANDLE PackageList
,
2083 IN EFI_STRING_ID StringId
,
2084 IN CONST CHAR8
* Language
,
2085 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo OPTIONAL
,
2086 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
2089 OUT EFI_HII_ROW_INFO
**RowInfoArray OPTIONAL
,
2090 OUT UINTN
*RowInfoArraySize OPTIONAL
,
2091 OUT UINTN
*ColumnInfoArray OPTIONAL
2095 HII_DATABASE_PRIVATE_DATA
*Private
;
2096 EFI_HII_STRING_PROTOCOL
*HiiString
;
2100 EFI_FONT_INFO
*StringFontInfo
;
2101 EFI_FONT_DISPLAY_INFO
*NewStringInfo
;
2102 CHAR8 TempSupportedLanguages
;
2103 CHAR8
*SupportedLanguages
;
2104 UINTN SupportedLanguagesSize
;
2105 CHAR8
*CurrentLanguage
;
2106 CHAR8
*BestLanguage
;
2108 if (This
== NULL
|| PackageList
== NULL
|| Blt
== NULL
|| PackageList
== NULL
) {
2109 return EFI_INVALID_PARAMETER
;
2112 if (!IsHiiHandleValid (PackageList
)) {
2113 return EFI_NOT_FOUND
;
2117 // Initialize string pointers to be NULL
2119 SupportedLanguages
= NULL
;
2120 CurrentLanguage
= NULL
;
2121 BestLanguage
= NULL
;
2124 StringFontInfo
= NULL
;
2125 NewStringInfo
= NULL
;
2128 // Get the string to be displayed.
2130 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2131 HiiString
= &Private
->HiiString
;
2134 // Get the size of supported language.
2136 SupportedLanguagesSize
= 0;
2137 Status
= HiiString
->GetLanguages (
2140 &TempSupportedLanguages
,
2141 &SupportedLanguagesSize
2143 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
2147 SupportedLanguages
= AllocatePool (SupportedLanguagesSize
);
2148 if (SupportedLanguages
== NULL
) {
2149 return EFI_OUT_OF_RESOURCES
;
2152 Status
= HiiString
->GetLanguages (
2156 &SupportedLanguagesSize
2158 if (EFI_ERROR (Status
)) {
2162 if (Language
== NULL
) {
2165 CurrentLanguage
= GetEfiGlobalVariable (L
"PlatformLang");
2166 BestLanguage
= GetBestLanguage (
2170 (CurrentLanguage
== NULL
) ? CurrentLanguage
: "",
2171 (CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLang
),
2174 if (BestLanguage
== NULL
) {
2175 Status
= EFI_NOT_FOUND
;
2179 StringSize
= MAX_STRING_LENGTH
;
2180 String
= (EFI_STRING
) AllocateZeroPool (StringSize
);
2181 if (String
== NULL
) {
2182 Status
= EFI_OUT_OF_RESOURCES
;
2186 Status
= HiiString
->GetString (
2195 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2197 String
= (EFI_STRING
) AllocateZeroPool (StringSize
);
2198 if (String
== NULL
) {
2199 Status
= EFI_OUT_OF_RESOURCES
;
2202 Status
= HiiString
->GetString (
2213 if (EFI_ERROR (Status
)) {
2218 // When StringInfo specifies that string will be output in the system default font and color,
2219 // use particular stringfontinfo described in string package instead if exists.
2220 // StringFontInfo equals NULL means system default font attaches with the string block.
2222 if (StringFontInfo
!= NULL
&& IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, NULL
, NULL
)) {
2223 FontLen
= sizeof (EFI_FONT_DISPLAY_INFO
) - sizeof (CHAR16
) + StrSize (StringFontInfo
->FontName
);
2224 NewStringInfo
= AllocateZeroPool (FontLen
);
2225 if (NewStringInfo
== NULL
) {
2226 Status
= EFI_OUT_OF_RESOURCES
;
2229 NewStringInfo
->FontInfoMask
= EFI_FONT_INFO_SYS_FORE_COLOR
| EFI_FONT_INFO_SYS_BACK_COLOR
;
2230 NewStringInfo
->FontInfo
.FontStyle
= StringFontInfo
->FontStyle
;
2231 NewStringInfo
->FontInfo
.FontSize
= StringFontInfo
->FontSize
;
2232 StrCpy (NewStringInfo
->FontInfo
.FontName
, StringFontInfo
->FontName
);
2234 Status
= HiiStringToImage (
2249 Status
= HiiStringToImage (
2263 if (SupportedLanguages
!= NULL
) {
2264 FreePool (SupportedLanguages
);
2266 if (CurrentLanguage
!= NULL
) {
2267 FreePool (CurrentLanguage
);
2269 if (BestLanguage
!= NULL
) {
2270 FreePool (BestLanguage
);
2272 if (String
!= NULL
) {
2275 if (StringFontInfo
!= NULL
) {
2276 FreePool (StringFontInfo
);
2278 if (NewStringInfo
!= NULL
) {
2279 FreePool (NewStringInfo
);
2287 Convert the glyph for a single character into a bitmap.
2289 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
2290 @param Char Character to retrieve.
2291 @param StringInfo Points to the string font and color information
2292 or NULL if the string should use the default
2293 system font and color.
2294 @param Blt Thus must point to a NULL on entry. A buffer will
2295 be allocated to hold the output and the pointer
2296 updated on exit. It is the caller's
2297 responsibility to free this buffer.
2298 @param Baseline Number of pixels from the bottom of the bitmap to
2301 @retval EFI_SUCCESS Glyph bitmap created.
2302 @retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer Blt.
2303 @retval EFI_WARN_UNKNOWN_GLYPH The glyph was unknown and was replaced with the
2304 glyph for Unicode character 0xFFFD.
2305 @retval EFI_INVALID_PARAMETER Blt is NULL or *Blt is not NULL.
2311 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
2313 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo
,
2314 OUT EFI_IMAGE_OUTPUT
**Blt
,
2315 OUT UINTN
*Baseline OPTIONAL
2319 HII_DATABASE_PRIVATE_DATA
*Private
;
2320 EFI_IMAGE_OUTPUT
*Image
;
2322 EFI_FONT_DISPLAY_INFO
*SystemDefault
;
2323 EFI_FONT_DISPLAY_INFO
*StringInfoOut
;
2325 EFI_FONT_HANDLE FontHandle
;
2327 EFI_HII_GLYPH_INFO Cell
;
2328 EFI_FONT_INFO
*FontInfo
;
2330 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
2331 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
2332 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
;
2334 if (This
== NULL
|| Blt
== NULL
|| *Blt
!= NULL
) {
2335 return EFI_INVALID_PARAMETER
;
2338 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2342 SystemDefault
= NULL
;
2346 StringInfoOut
= NULL
;
2349 ZeroMem (&Foreground
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
2350 ZeroMem (&Background
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
2352 Default
= IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfo
, &SystemDefault
, NULL
);
2356 // Find out a EFI_FONT_DISPLAY_INFO which could display the character in
2357 // the specified color and font.
2359 String
= (EFI_STRING
) AllocateZeroPool (sizeof (CHAR16
) * 2);
2360 if (String
== NULL
) {
2361 Status
= EFI_OUT_OF_RESOURCES
;
2367 Status
= HiiGetFontInfo (This
, &FontHandle
, StringInfo
, &StringInfoOut
, String
);
2368 if (EFI_ERROR (Status
)) {
2371 FontInfo
= &StringInfoOut
->FontInfo
;
2372 Foreground
= StringInfoOut
->ForegroundColor
;
2373 Background
= StringInfoOut
->BackgroundColor
;
2375 Foreground
= SystemDefault
->ForegroundColor
;
2376 Background
= SystemDefault
->BackgroundColor
;
2379 Status
= GetGlyphBuffer (Private
, Char
, FontInfo
, &GlyphBuffer
, &Cell
, &Attributes
);
2380 if (EFI_ERROR (Status
)) {
2384 Image
= (EFI_IMAGE_OUTPUT
*) AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT
));
2385 if (Image
== NULL
) {
2386 Status
= EFI_OUT_OF_RESOURCES
;
2389 Image
->Width
= Cell
.Width
;
2390 Image
->Height
= Cell
.Height
;
2392 Image
->Image
.Bitmap
= AllocateZeroPool (Image
->Width
* Image
->Height
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
2393 if (Image
->Image
.Bitmap
== NULL
) {
2395 Status
= EFI_OUT_OF_RESOURCES
;
2399 BltBuffer
= Image
->Image
.Bitmap
;
2413 if (Baseline
!= NULL
) {
2414 *Baseline
= Cell
.OffsetY
;
2417 Status
= EFI_SUCCESS
;
2421 if (Status
== EFI_NOT_FOUND
) {
2423 // Glyph is unknown and replaced with the glyph for unicode character 0xFFFD
2425 if (Char
!= REPLACE_UNKNOWN_GLYPH
) {
2426 Status
= HiiGetGlyph (This
, REPLACE_UNKNOWN_GLYPH
, StringInfo
, Blt
, Baseline
);
2427 if (!EFI_ERROR (Status
)) {
2428 Status
= EFI_WARN_UNKNOWN_GLYPH
;
2431 Status
= EFI_WARN_UNKNOWN_GLYPH
;
2435 if (SystemDefault
!= NULL
) {
2436 FreePool (SystemDefault
);
2438 if (StringInfoOut
!= NULL
) {
2439 FreePool (StringInfoOut
);
2441 if (String
!= NULL
) {
2444 if (GlyphBuffer
!= NULL
) {
2445 FreePool (GlyphBuffer
);
2453 This function iterates through fonts which match the specified font, using
2454 the specified criteria. If String is non-NULL, then all of the characters in
2455 the string must exist in order for a candidate font to be returned.
2457 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
2458 @param FontHandle On entry, points to the font handle returned by a
2459 previous call to GetFontInfo() or NULL to start
2460 with the first font. On return, points to the
2461 returned font handle or points to NULL if there
2462 are no more matching fonts.
2463 @param StringInfoIn Upon entry, points to the font to return
2465 If NULL, then the information about the system default
2466 font will be returned.
2467 @param StringInfoOut Upon return, contains the matching font's
2468 information. If NULL, then no information is
2469 returned. It's caller's responsibility to free
2471 @param String Points to the string which will be tested to
2472 determine if all characters are available. If
2473 NULL, then any font is acceptable.
2475 @retval EFI_SUCCESS Matching font returned successfully.
2476 @retval EFI_NOT_FOUND No matching font was found.
2477 @retval EFI_INVALID_PARAMETER StringInfoIn->FontInfoMask is an invalid combination.
2478 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the
2485 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
2486 IN OUT EFI_FONT_HANDLE
*FontHandle
,
2487 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfoIn
, OPTIONAL
2488 OUT EFI_FONT_DISPLAY_INFO
**StringInfoOut
,
2489 IN CONST EFI_STRING String OPTIONAL
2492 HII_DATABASE_PRIVATE_DATA
*Private
;
2494 EFI_FONT_DISPLAY_INFO
*SystemDefault
;
2495 EFI_FONT_DISPLAY_INFO InfoOut
;
2496 UINTN StringInfoOutLen
;
2497 EFI_FONT_INFO
*FontInfo
;
2498 HII_GLOBAL_FONT_INFO
*GlobalFont
;
2499 EFI_STRING StringIn
;
2500 EFI_FONT_HANDLE LocalFontHandle
;
2503 return EFI_INVALID_PARAMETER
;
2507 SystemDefault
= NULL
;
2508 LocalFontHandle
= NULL
;
2509 if (FontHandle
!= NULL
) {
2510 LocalFontHandle
= *FontHandle
;
2513 Private
= HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2516 // Already searched to the end of the whole list, return directly.
2518 if (LocalFontHandle
== &Private
->FontInfoList
) {
2519 LocalFontHandle
= NULL
;
2520 Status
= EFI_NOT_FOUND
;
2525 // Get default system display info, if StringInfoIn points to
2526 // system display info, return it directly.
2528 if (IsSystemFontInfo (Private
, (EFI_FONT_DISPLAY_INFO
*) StringInfoIn
, &SystemDefault
, &StringInfoOutLen
)) {
2530 // System font is the first node. When handle is not NULL, system font can not
2531 // be found any more.
2533 if (LocalFontHandle
== NULL
) {
2534 if (StringInfoOut
!= NULL
) {
2535 *StringInfoOut
= AllocateCopyPool (StringInfoOutLen
, SystemDefault
);
2536 if (*StringInfoOut
== NULL
) {
2537 Status
= EFI_OUT_OF_RESOURCES
;
2538 LocalFontHandle
= NULL
;
2543 LocalFontHandle
= Private
->FontInfoList
.ForwardLink
;
2544 Status
= EFI_SUCCESS
;
2547 LocalFontHandle
= NULL
;
2548 Status
= EFI_NOT_FOUND
;
2554 // StringInfoIn must not be NULL if it is not system default font info.
2556 ASSERT (StringInfoIn
!= NULL
);
2558 // Check the font information mask to make sure it is valid.
2560 if (((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_SYS_FONT
| EFI_FONT_INFO_ANY_FONT
)) ==
2561 (EFI_FONT_INFO_SYS_FONT
| EFI_FONT_INFO_ANY_FONT
)) ||
2562 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_SYS_SIZE
| EFI_FONT_INFO_ANY_SIZE
)) ==
2563 (EFI_FONT_INFO_SYS_SIZE
| EFI_FONT_INFO_ANY_SIZE
)) ||
2564 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_SYS_STYLE
| EFI_FONT_INFO_ANY_STYLE
)) ==
2565 (EFI_FONT_INFO_SYS_STYLE
| EFI_FONT_INFO_ANY_STYLE
)) ||
2566 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_RESIZE
| EFI_FONT_INFO_ANY_SIZE
)) ==
2567 (EFI_FONT_INFO_RESIZE
| EFI_FONT_INFO_ANY_SIZE
)) ||
2568 ((StringInfoIn
->FontInfoMask
& (EFI_FONT_INFO_RESTYLE
| EFI_FONT_INFO_ANY_STYLE
)) ==
2569 (EFI_FONT_INFO_RESTYLE
| EFI_FONT_INFO_ANY_STYLE
))) {
2570 return EFI_INVALID_PARAMETER
;
2574 // Parse the font information mask to find a matching font.
2577 CopyMem (&InfoOut
, (EFI_FONT_DISPLAY_INFO
*) StringInfoIn
, sizeof (EFI_FONT_DISPLAY_INFO
));
2579 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_FONT
) == EFI_FONT_INFO_SYS_FONT
) {
2580 Status
= SaveFontName (SystemDefault
->FontInfo
.FontName
, &FontInfo
);
2582 Status
= SaveFontName (((EFI_FONT_DISPLAY_INFO
*) StringInfoIn
)->FontInfo
.FontName
, &FontInfo
);
2584 if (EFI_ERROR (Status
)) {
2588 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_SIZE
) == EFI_FONT_INFO_SYS_SIZE
) {
2589 InfoOut
.FontInfo
.FontSize
= SystemDefault
->FontInfo
.FontSize
;
2591 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_STYLE
) == EFI_FONT_INFO_SYS_STYLE
) {
2592 InfoOut
.FontInfo
.FontStyle
= SystemDefault
->FontInfo
.FontStyle
;
2594 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_FORE_COLOR
) == EFI_FONT_INFO_SYS_FORE_COLOR
) {
2595 InfoOut
.ForegroundColor
= SystemDefault
->ForegroundColor
;
2597 if ((StringInfoIn
->FontInfoMask
& EFI_FONT_INFO_SYS_BACK_COLOR
) == EFI_FONT_INFO_SYS_BACK_COLOR
) {
2598 InfoOut
.BackgroundColor
= SystemDefault
->BackgroundColor
;
2602 FontInfo
->FontSize
= InfoOut
.FontInfo
.FontSize
;
2603 FontInfo
->FontStyle
= InfoOut
.FontInfo
.FontStyle
;
2605 if (IsFontInfoExisted (Private
, FontInfo
, &InfoOut
.FontInfoMask
, LocalFontHandle
, &GlobalFont
)) {
2607 // Test to guarantee all characters are available in the found font.
2609 if (String
!= NULL
) {
2611 while (*StringIn
!= 0) {
2612 Status
= FindGlyphBlock (GlobalFont
->FontPackage
, *StringIn
, NULL
, NULL
, NULL
);
2613 if (EFI_ERROR (Status
)) {
2614 LocalFontHandle
= NULL
;
2621 // Write to output parameter
2623 if (StringInfoOut
!= NULL
) {
2624 StringInfoOutLen
= sizeof (EFI_FONT_DISPLAY_INFO
) - sizeof (EFI_FONT_INFO
) + GlobalFont
->FontInfoSize
;
2625 *StringInfoOut
= (EFI_FONT_DISPLAY_INFO
*) AllocateZeroPool (StringInfoOutLen
);
2626 if (*StringInfoOut
== NULL
) {
2627 Status
= EFI_OUT_OF_RESOURCES
;
2628 LocalFontHandle
= NULL
;
2632 CopyMem (*StringInfoOut
, &InfoOut
, sizeof (EFI_FONT_DISPLAY_INFO
));
2633 CopyMem (&(*StringInfoOut
)->FontInfo
, GlobalFont
->FontInfo
, GlobalFont
->FontInfoSize
);
2636 LocalFontHandle
= GlobalFont
->Entry
.ForwardLink
;
2637 Status
= EFI_SUCCESS
;
2641 Status
= EFI_NOT_FOUND
;
2645 if (FontHandle
!= NULL
) {
2646 *FontHandle
= LocalFontHandle
;
2649 if (SystemDefault
!= NULL
) {
2650 FreePool (SystemDefault
);
2652 if (FontInfo
!= NULL
) {
2653 FreePool (FontInfo
);