]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/HiiDatabaseDxe/Font.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Add ASSERT() check for StringInfo pointer.
[mirror_edk2.git] / MdeModulePkg / Universal / HiiDatabaseDxe / Font.c
1 /** @file
2 Implementation for EFI_HII_FONT_PROTOCOL.
3
4
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
10
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.
13
14 **/
15
16
17 #include "HiiDatabase.h"
18
19 EFI_GRAPHICS_OUTPUT_BLT_PIXEL mEfiColors[16] = {
20 //
21 // B G R
22 //
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
39 };
40
41
42 /**
43 Insert a character cell information to the list specified by GlyphInfoList.
44
45 This is a internal function.
46
47 @param CharValue Unicode character value, which identifies a glyph
48 block.
49 @param GlyphInfoList HII_GLYPH_INFO list head.
50 @param Cell Incoming character cell information.
51
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
54 task.
55
56 **/
57 EFI_STATUS
58 NewCell (
59 IN CHAR16 CharValue,
60 IN LIST_ENTRY *GlyphInfoList,
61 IN EFI_HII_GLYPH_INFO *Cell
62 )
63 {
64 HII_GLYPH_INFO *GlyphInfo;
65
66 ASSERT (Cell != NULL && GlyphInfoList != NULL);
67
68 GlyphInfo = (HII_GLYPH_INFO *) AllocateZeroPool (sizeof (HII_GLYPH_INFO));
69 if (GlyphInfo == NULL) {
70 return EFI_OUT_OF_RESOURCES;
71 }
72
73 //
74 // GlyphInfoList stores a list of default character cell information, each is
75 // identified by "CharId".
76 //
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);
81
82 return EFI_SUCCESS;
83 }
84
85
86 /**
87 Get a character cell information from the list specified by GlyphInfoList.
88
89 This is a internal function.
90
91 @param CharValue Unicode character value, which identifies a glyph
92 block.
93 @param GlyphInfoList HII_GLYPH_INFO list head.
94 @param Cell Buffer which stores output character cell
95 information.
96
97 @retval EFI_SUCCESS Cell information is added to the GlyphInfoList.
98 @retval EFI_NOT_FOUND The character info specified by CharValue does
99 not exist.
100
101 **/
102 EFI_STATUS
103 GetCell (
104 IN CHAR16 CharValue,
105 IN LIST_ENTRY *GlyphInfoList,
106 OUT EFI_HII_GLYPH_INFO *Cell
107 )
108 {
109 HII_GLYPH_INFO *GlyphInfo;
110 LIST_ENTRY *Link;
111
112 ASSERT (Cell != NULL && GlyphInfoList != NULL);
113
114 //
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.
119 //
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.
123 //
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));
128 return EFI_SUCCESS;
129 }
130 }
131
132 return EFI_NOT_FOUND;
133 }
134
135
136 /**
137 Convert the glyph for a single character into a bitmap.
138
139 This is a internal function.
140
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.
149
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.
154
155 **/
156 EFI_STATUS
157 GetGlyphBuffer (
158 IN HII_DATABASE_PRIVATE_DATA *Private,
159 IN CHAR16 Char,
160 IN EFI_FONT_INFO *StringInfo,
161 OUT UINT8 **GlyphBuffer,
162 OUT EFI_HII_GLYPH_INFO *Cell,
163 OUT UINT8 *Attributes OPTIONAL
164 )
165 {
166 HII_DATABASE_RECORD *Node;
167 LIST_ENTRY *Link;
168 HII_SIMPLE_FONT_PACKAGE_INSTANCE *SimpleFont;
169 LIST_ENTRY *Link1;
170 UINT16 Index;
171 EFI_NARROW_GLYPH Narrow;
172 EFI_WIDE_GLYPH Wide;
173 HII_GLOBAL_FONT_INFO *GlobalFont;
174 UINTN HeaderSize;
175 EFI_NARROW_GLYPH *NarrowPtr;
176 EFI_WIDE_GLYPH *WidePtr;
177
178 if (GlyphBuffer == NULL || Cell == NULL) {
179 return EFI_INVALID_PARAMETER;
180 }
181 if (Private == NULL || Private->Signature != HII_DATABASE_PRIVATE_DATA_SIGNATURE) {
182 return EFI_INVALID_PARAMETER;
183 }
184
185 ZeroMem (Cell, sizeof (EFI_HII_GLYPH_INFO));
186
187 //
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).
192 //
193 if (StringInfo != NULL) {
194 if(!IsFontInfoExisted (Private, StringInfo, NULL, NULL, &GlobalFont)) {
195 return EFI_INVALID_PARAMETER;
196 }
197 if (Attributes != NULL) {
198 *Attributes = PROPORTIONAL_GLYPH;
199 }
200 return FindGlyphBlock (GlobalFont->FontPackage, Char, GlyphBuffer, Cell, NULL);
201 } else {
202 HeaderSize = sizeof (EFI_HII_SIMPLE_FONT_PACKAGE_HDR);
203
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
209 ) {
210 SimpleFont = CR (Link1, HII_SIMPLE_FONT_PACKAGE_INSTANCE, SimpleFontEntry, HII_S_FONT_PACKAGE_SIGNATURE);
211 //
212 // Search the narrow glyph array
213 //
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;
221 }
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);
229 }
230 return EFI_SUCCESS;
231 }
232 }
233 //
234 // Search the wide glyph array
235 //
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;
243 }
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);
252 }
253 return EFI_SUCCESS;
254 }
255 }
256 }
257 }
258 }
259
260 return EFI_NOT_FOUND;
261 }
262
263 /**
264 Convert bitmap data of the glyph to blt structure.
265
266 This is a internal function.
267
268 @param GlyphBuffer Buffer points to bitmap data of glyph.
269 @param Foreground The color of the "on" pixels in the glyph in the
270 bitmap.
271 @param Background The color of the "off" pixels in the glyph in the
272 bitmap.
273 @param ImageWidth Width of the character or character cell, in
274 pixels.
275 @param ImageHeight Height of the character or character cell, in
276 pixels.
277 @param Transparent If TRUE, the Background color is ignored and all
278 "off" pixels in the character's drawn wil use the
279 pixel value from BltBuffer.
280 @param Origin On input, points to the origin of the to be
281 displayed character, on output, points to the
282 next glyph's origin.
283
284 **/
285 VOID
286 NarrowGlyphToBlt (
287 IN UINT8 *GlyphBuffer,
288 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground,
289 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background,
290 IN UINTN ImageWidth,
291 IN UINTN ImageHeight,
292 IN BOOLEAN Transparent,
293 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL **Origin
294 )
295 {
296 UINT8 Xpos;
297 UINT8 Ypos;
298 UINT8 Height;
299 UINT8 Width;
300 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Buffer;
301
302 ASSERT (GlyphBuffer != NULL && Origin != NULL && *Origin != NULL);
303
304 Height = EFI_GLYPH_HEIGHT;
305 Width = EFI_GLYPH_WIDTH;
306
307 ASSERT (Width <= ImageWidth && Height <= ImageHeight);
308
309 Buffer = *Origin;
310
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;
315 } else {
316 if (!Transparent) {
317 Buffer[Ypos * ImageWidth + (Width - Xpos - 1)] = Background;
318 }
319 }
320 }
321 }
322
323 *Origin = Buffer + Width;
324 }
325
326
327 /**
328 Convert bitmap data of the glyph to blt structure.
329
330 This is a internal function.
331
332 @param GlyphBuffer Buffer points to bitmap data of glyph.
333 @param Foreground The color of the "on" pixels in the glyph in the
334 bitmap.
335 @param Background The color of the "off" pixels in the glyph in the
336 bitmap.
337 @param ImageWidth Width of the character or character cell, in
338 pixels.
339 @param ImageHeight Height of the character or character cell, in
340 pixels.
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
348 next glyph's origin.
349
350
351 **/
352 VOID
353 GlyphToBlt (
354 IN UINT8 *GlyphBuffer,
355 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground,
356 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background,
357 IN UINTN ImageWidth,
358 IN UINTN ImageHeight,
359 IN BOOLEAN Transparent,
360 IN CONST EFI_HII_GLYPH_INFO *Cell,
361 IN UINT8 Attributes,
362 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL **Origin
363 )
364 {
365 UINT8 Xpos;
366 UINT8 Ypos;
367 UINT8 Data;
368 UINT8 Index;
369 UINTN OffsetY;
370 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer;
371
372 ASSERT (GlyphBuffer != NULL && Origin != NULL && *Origin != NULL);
373 ASSERT (Cell->Width <= ImageWidth && Cell->Height <= ImageHeight);
374
375 BltBuffer = *Origin;
376
377 //
378 // Since non-spacing key will be printed OR'd with the previous glyph, don't
379 // write 0.
380 //
381 if ((Attributes & EFI_GLYPH_NON_SPACING) == EFI_GLYPH_NON_SPACING) {
382 Transparent = TRUE;
383 }
384
385 //
386 // The glyph's upper left hand corner pixel is the most significant bit of the
387 // first bitmap byte.
388 //
389 for (Ypos = 0; Ypos < Cell->Height; Ypos++) {
390 OffsetY = BITMAP_LEN_1_BIT (Cell->Width, Ypos);
391
392 //
393 // All bits in these bytes are meaningful.
394 //
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;
400 } else {
401 if (!Transparent) {
402 BltBuffer[Ypos * ImageWidth + Xpos * 8 + (8 - Index - 1)] = Background;
403 }
404 }
405 }
406 }
407
408 if (Cell->Width % 8 != 0) {
409 //
410 // There are some padding bits in this byte. Ignore them.
411 //
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;
416 } else {
417 if (!Transparent) {
418 BltBuffer[Ypos * ImageWidth + Xpos * 8 + Index] = Background;
419 }
420 }
421 }
422 } // end of if (Width % 8...)
423
424 } // end of for (Ypos=0...)
425
426 *Origin = BltBuffer + Cell->Width;
427 }
428
429
430 /**
431 Convert bitmap data of the glyph to blt structure.
432
433 This is a internal function.
434
435 @param GlyphBuffer Buffer points to bitmap data of glyph.
436 @param Foreground The color of the "on" pixels in the glyph in the
437 bitmap.
438 @param Background The color of the "off" pixels in the glyph in the
439 bitmap.
440 @param ImageWidth Width of the character or character cell, in
441 pixels.
442 @param ImageHeight Height of the character or character cell, in
443 pixels.
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
451 next glyph's origin.
452
453 @return Points to the address of next origin node in BltBuffer.
454
455 **/
456 VOID
457 GlyphToImage (
458 IN UINT8 *GlyphBuffer,
459 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground,
460 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background,
461 IN UINTN ImageWidth,
462 IN UINTN ImageHeight,
463 IN BOOLEAN Transparent,
464 IN CONST EFI_HII_GLYPH_INFO *Cell,
465 IN UINT8 Attributes,
466 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL **Origin
467 )
468 {
469 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Buffer;
470
471 ASSERT (GlyphBuffer != NULL && Origin != NULL && *Origin != NULL);
472 ASSERT (Cell->Width <= ImageWidth && Cell->Height <= ImageHeight);
473
474 Buffer = *Origin;
475
476 if ((Attributes & EFI_GLYPH_NON_SPACING) == EFI_GLYPH_NON_SPACING) {
477 //
478 // This character is a non-spacing key, print it OR'd with the previous glyph.
479 // without advancing cursor.
480 //
481 Buffer -= Cell->Width;
482 GlyphToBlt (
483 GlyphBuffer,
484 Foreground,
485 Background,
486 ImageWidth,
487 ImageHeight,
488 Transparent,
489 Cell,
490 Attributes,
491 &Buffer
492 );
493
494 } else if ((Attributes & EFI_GLYPH_WIDE) == EFI_GLYPH_WIDE) {
495 //
496 // This character is wide glyph, i.e. 16 pixels * 19 pixels.
497 // Draw it as two narrow glyphs.
498 //
499 NarrowGlyphToBlt (
500 GlyphBuffer,
501 Foreground,
502 Background,
503 ImageWidth,
504 ImageHeight,
505 Transparent,
506 Origin
507 );
508
509 NarrowGlyphToBlt (
510 GlyphBuffer + EFI_GLYPH_HEIGHT,
511 Foreground,
512 Background,
513 ImageWidth,
514 ImageHeight,
515 Transparent,
516 Origin
517 );
518
519 } else if ((Attributes & NARROW_GLYPH) == NARROW_GLYPH) {
520 //
521 // This character is narrow glyph, i.e. 8 pixels * 19 pixels.
522 //
523 NarrowGlyphToBlt (
524 GlyphBuffer,
525 Foreground,
526 Background,
527 ImageWidth,
528 ImageHeight,
529 Transparent,
530 Origin
531 );
532
533 } else if ((Attributes & PROPORTIONAL_GLYPH) == PROPORTIONAL_GLYPH) {
534 //
535 // This character is proportional glyph, i.e. Cell->Width * Cell->Height pixels.
536 //
537 GlyphToBlt (
538 GlyphBuffer,
539 Foreground,
540 Background,
541 ImageWidth,
542 ImageHeight,
543 Transparent,
544 Cell,
545 Attributes,
546 Origin
547 );
548 }
549 }
550
551
552 /**
553 Write the output parameters of FindGlyphBlock().
554
555 This is a internal function.
556
557 @param BufferIn Buffer which stores the bitmap data of the found
558 block.
559 @param BufferLen Length of BufferIn.
560 @param InputCell Buffer which stores cell information of the
561 encoded bitmap.
562 @param GlyphBuffer Output the corresponding bitmap data of the found
563 block. It is the caller's responsiblity to free
564 this buffer.
565 @param Cell Output cell information of the encoded bitmap.
566 @param GlyphBufferLen If not NULL, output the length of GlyphBuffer.
567
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
571 task.
572
573 **/
574 EFI_STATUS
575 WriteOutputParam (
576 IN UINT8 *BufferIn,
577 IN UINTN BufferLen,
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
582 )
583 {
584 if (BufferIn == NULL || BufferLen < 1 || InputCell == NULL) {
585 return EFI_INVALID_PARAMETER;
586 }
587
588 if (Cell != NULL) {
589 CopyMem (Cell, InputCell, sizeof (EFI_HII_GLYPH_INFO));
590 }
591
592 if (GlyphBuffer != NULL) {
593 *GlyphBuffer = (UINT8 *) AllocateZeroPool (BufferLen);
594 if (*GlyphBuffer == NULL) {
595 return EFI_OUT_OF_RESOURCES;
596 }
597 CopyMem (*GlyphBuffer, BufferIn, BufferLen);
598 }
599
600 if (GlyphBufferLen != NULL) {
601 *GlyphBufferLen = BufferLen;
602 }
603
604 return EFI_SUCCESS;
605 }
606
607
608 /**
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.
612
613 @param FontPackage Hii string package instance.
614 @param CharValue Unicode character value, which identifies a glyph
615 block.
616 @param GlyphBuffer Output the corresponding bitmap data of the found
617 block. It is the caller's responsiblity to free
618 this buffer.
619 @param Cell Output cell information of the encoded bitmap.
620 @param GlyphBufferLen If not NULL, output the length of GlyphBuffer.
621
622 @retval EFI_SUCCESS The bitmap data is retrieved successfully.
623 @retval EFI_NOT_FOUND The specified CharValue does not exist in current
624 database.
625 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
626 task.
627
628 **/
629 EFI_STATUS
630 FindGlyphBlock (
631 IN HII_FONT_PACKAGE_INSTANCE *FontPackage,
632 IN CHAR16 CharValue,
633 OUT UINT8 **GlyphBuffer, OPTIONAL
634 OUT EFI_HII_GLYPH_INFO *Cell, OPTIONAL
635 OUT UINTN *GlyphBufferLen OPTIONAL
636 )
637 {
638 EFI_STATUS Status;
639 UINT8 *BlockPtr;
640 UINT16 CharCurrent;
641 UINT16 Length16;
642 UINT32 Length32;
643 EFI_HII_GIBT_GLYPHS_BLOCK Glyphs;
644 UINTN BufferLen;
645 UINT16 Index;
646 EFI_HII_GLYPH_INFO DefaultCell;
647 EFI_HII_GLYPH_INFO LocalCell;
648
649 ASSERT (FontPackage != NULL);
650 ASSERT (FontPackage->Signature == HII_FONT_PACKAGE_SIGNATURE);
651
652 if (CharValue == (CHAR16) (-1)) {
653 //
654 // Collect the cell information specified in font package fixed header.
655 // Use CharValue =0 to represent this particular cell.
656 //
657 Status = NewCell (
658 0,
659 &FontPackage->GlyphInfoList,
660 (EFI_HII_GLYPH_INFO *) ((UINT8 *) FontPackage->FontPkgHdr + 3 * sizeof (UINT32))
661 );
662 if (EFI_ERROR (Status)) {
663 return Status;
664 }
665 }
666
667 BlockPtr = FontPackage->GlyphBlock;
668 CharCurrent = 1;
669 BufferLen = 0;
670
671 while (*BlockPtr != EFI_HII_GIBT_END) {
672 switch (*BlockPtr) {
673 case EFI_HII_GIBT_DEFAULTS:
674 //
675 // Collect all default character cell information specified by
676 // EFI_HII_GIBT_DEFAULTS.
677 //
678 if (CharValue == (CHAR16) (-1)) {
679 Status = NewCell (
680 CharCurrent,
681 &FontPackage->GlyphInfoList,
682 (EFI_HII_GLYPH_INFO *) (BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK))
683 );
684 if (EFI_ERROR (Status)) {
685 return Status;
686 }
687 }
688 BlockPtr += sizeof (EFI_HII_GIBT_DEFAULTS_BLOCK);
689 break;
690
691 case EFI_HII_GIBT_DUPLICATE:
692 if (CharCurrent == CharValue) {
693 CopyMem (&CharValue, BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK), sizeof (CHAR16));
694 CharCurrent = 1;
695 BlockPtr = FontPackage->GlyphBlock;
696 continue;
697 }
698 CharCurrent++;
699 BlockPtr += sizeof (EFI_HII_GIBT_DUPLICATE_BLOCK);
700 break;
701
702 case EFI_HII_GIBT_EXT1:
703 BlockPtr += *(BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK) + sizeof (UINT8));
704 break;
705 case EFI_HII_GIBT_EXT2:
706 CopyMem (
707 &Length16,
708 BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK) + sizeof (UINT8),
709 sizeof (UINT16)
710 );
711 BlockPtr += Length16;
712 break;
713 case EFI_HII_GIBT_EXT4:
714 CopyMem (
715 &Length32,
716 BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK) + sizeof (UINT8),
717 sizeof (UINT32)
718 );
719 BlockPtr += Length32;
720 break;
721
722 case EFI_HII_GIBT_GLYPH:
723 CopyMem (
724 &LocalCell,
725 BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK),
726 sizeof (EFI_HII_GLYPH_INFO)
727 );
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),
732 BufferLen,
733 &LocalCell,
734 GlyphBuffer,
735 Cell,
736 GlyphBufferLen
737 );
738 }
739 CharCurrent++;
740 BlockPtr += sizeof (EFI_HII_GIBT_GLYPH_BLOCK) - sizeof (UINT8) + BufferLen;
741 break;
742
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);
749
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 (
754 BlockPtr,
755 BufferLen,
756 &Glyphs.Cell,
757 GlyphBuffer,
758 Cell,
759 GlyphBufferLen
760 );
761 }
762 BlockPtr += BufferLen;
763 }
764 CharCurrent = (UINT16) (CharCurrent + Glyphs.Count);
765 break;
766
767 case EFI_HII_GIBT_GLYPH_DEFAULT:
768 Status = GetCell (CharCurrent, &FontPackage->GlyphInfoList, &DefaultCell);
769 if (EFI_ERROR (Status)) {
770 return Status;
771 }
772 BufferLen = BITMAP_LEN_1_BIT (DefaultCell.Width, DefaultCell.Height);
773
774 if (CharCurrent == CharValue) {
775 return WriteOutputParam (
776 BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK),
777 BufferLen,
778 &DefaultCell,
779 GlyphBuffer,
780 Cell,
781 GlyphBufferLen
782 );
783 }
784 CharCurrent++;
785 BlockPtr += sizeof (EFI_HII_GLYPH_BLOCK) + BufferLen;
786 break;
787
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)) {
792 return Status;
793 }
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 (
799 BlockPtr,
800 BufferLen,
801 &DefaultCell,
802 GlyphBuffer,
803 Cell,
804 GlyphBufferLen
805 );
806 }
807 BlockPtr += BufferLen;
808 }
809 CharCurrent = (UINT16) (CharCurrent + Length16);
810 break;
811
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);
815 break;
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);
820 break;
821 default:
822 ASSERT (FALSE);
823 break;
824 }
825
826 if (CharValue < CharCurrent) {
827 return EFI_NOT_FOUND;
828 }
829 }
830
831 if (CharValue == (CHAR16) (-1)) {
832 return EFI_SUCCESS;
833 }
834
835 return EFI_NOT_FOUND;
836 }
837
838
839 /**
840 Copy a Font Name to a new created EFI_FONT_INFO structure.
841
842 This is a internal function.
843
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.
847
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
850 task.
851
852 **/
853 EFI_STATUS
854 SaveFontName (
855 IN EFI_STRING FontName,
856 OUT EFI_FONT_INFO **FontInfo
857 )
858 {
859 UINTN FontInfoLen;
860
861 ASSERT (FontName != NULL && FontInfo != NULL);
862
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;
867 }
868
869 StrCpy ((*FontInfo)->FontName, FontName);
870 return EFI_SUCCESS;
871 }
872
873
874 /**
875 Retrieve system default font and color.
876
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
880 this buffer.
881 @param FontInfoSize If not NULL, output the size of buffer FontInfo.
882
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
885 task.
886 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
887
888 **/
889 EFI_STATUS
890 GetSystemFont (
891 IN HII_DATABASE_PRIVATE_DATA *Private,
892 OUT EFI_FONT_DISPLAY_INFO **FontInfo,
893 OUT UINTN *FontInfoSize OPTIONAL
894 )
895 {
896 EFI_FONT_DISPLAY_INFO *Info;
897 UINTN InfoSize;
898
899 if (Private == NULL || Private->Signature != HII_DATABASE_PRIVATE_DATA_SIGNATURE) {
900 return EFI_INVALID_PARAMETER;
901 }
902 if (FontInfo == NULL) {
903 return EFI_INVALID_PARAMETER;
904 }
905
906 //
907 // The standard font always has the name "sysdefault".
908 //
909 InfoSize = sizeof (EFI_FONT_DISPLAY_INFO) - sizeof (CHAR16) + StrSize (L"sysdefault");
910 Info = (EFI_FONT_DISPLAY_INFO *) AllocateZeroPool (InfoSize);
911 if (Info == NULL) {
912 return EFI_OUT_OF_RESOURCES;
913 }
914
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");
921
922 *FontInfo = Info;
923 if (FontInfoSize != NULL) {
924 *FontInfoSize = InfoSize;
925 }
926 return EFI_SUCCESS;
927 }
928
929
930 /**
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.
933
934 This is a internal function.
935
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.
940
941 @param SystemInfoLen If not NULL, output the length of default system
942 info.
943
944 @retval TRUE Yes, it points to system default.
945 @retval FALSE No.
946
947 **/
948 BOOLEAN
949 IsSystemFontInfo (
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
954 )
955 {
956 EFI_STATUS Status;
957 EFI_FONT_DISPLAY_INFO *SystemDefault;
958 UINTN DefaultLen;
959 BOOLEAN Flag;
960
961 ASSERT (Private != NULL && Private->Signature == HII_DATABASE_PRIVATE_DATA_SIGNATURE);
962
963 if (StringInfo == NULL && SystemInfo == NULL) {
964 return TRUE;
965 }
966
967 Status = GetSystemFont (Private, &SystemDefault, &DefaultLen);
968 ASSERT_EFI_ERROR (Status);
969
970 //
971 // Record the system default info.
972 //
973 if (SystemInfo != NULL) {
974 *SystemInfo = SystemDefault;
975 }
976
977 if (SystemInfoLen != NULL) {
978 *SystemInfoLen = DefaultLen;
979 }
980
981 if (StringInfo == NULL) {
982 return TRUE;
983 }
984
985 Flag = FALSE;
986 //
987 // Check the FontInfoMask to see whether it is retrieving system info.
988 //
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) {
991 goto Exit;
992 }
993 }
994 if ((StringInfo->FontInfoMask & (EFI_FONT_INFO_SYS_SIZE | EFI_FONT_INFO_ANY_SIZE)) == 0) {
995 if (StringInfo->FontInfo.FontSize != SystemDefault->FontInfo.FontSize) {
996 goto Exit;
997 }
998 }
999 if ((StringInfo->FontInfoMask & (EFI_FONT_INFO_SYS_STYLE | EFI_FONT_INFO_ANY_STYLE)) == 0) {
1000 if (StringInfo->FontInfo.FontStyle != SystemDefault->FontInfo.FontStyle) {
1001 goto Exit;
1002 }
1003 }
1004 if ((StringInfo->FontInfoMask & EFI_FONT_INFO_SYS_FORE_COLOR) == 0) {
1005 if (CompareMem (
1006 &StringInfo->ForegroundColor,
1007 &SystemDefault->ForegroundColor,
1008 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
1009 ) != 0) {
1010 goto Exit;
1011 }
1012 }
1013 if ((StringInfo->FontInfoMask & EFI_FONT_INFO_SYS_BACK_COLOR) == 0) {
1014 if (CompareMem (
1015 &StringInfo->BackgroundColor,
1016 &SystemDefault->BackgroundColor,
1017 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
1018 ) != 0) {
1019 goto Exit;
1020 }
1021 }
1022
1023 Flag = TRUE;
1024
1025 Exit:
1026 if (SystemInfo == NULL) {
1027 if (SystemDefault != NULL) {
1028 FreePool (SystemDefault);
1029 }
1030 }
1031 return Flag;
1032 }
1033
1034
1035 /**
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.
1040
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
1046 this mask is valid.
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
1051 info.
1052
1053 @retval TRUE Existed
1054 @retval FALSE Not existed
1055
1056 **/
1057 BOOLEAN
1058 IsFontInfoExisted (
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
1064 )
1065 {
1066 HII_GLOBAL_FONT_INFO *GlobalFont;
1067 HII_GLOBAL_FONT_INFO *GlobalFontBackup1;
1068 HII_GLOBAL_FONT_INFO *GlobalFontBackup2;
1069 LIST_ENTRY *Link;
1070 EFI_FONT_INFO_MASK Mask;
1071 BOOLEAN Matched;
1072 BOOLEAN VagueMatched1;
1073 BOOLEAN VagueMatched2;
1074
1075 ASSERT (Private != NULL && Private->Signature == HII_DATABASE_PRIVATE_DATA_SIGNATURE);
1076 ASSERT (FontInfo != NULL);
1077
1078 //
1079 // Matched flag represents an exactly match; VagueMatched1 repensents a RESIZE
1080 // or RESTYLE match; VagueMatched2 represents a RESIZE | RESTYLE match.
1081 //
1082 Matched = FALSE;
1083 VagueMatched1 = FALSE;
1084 VagueMatched2 = FALSE;
1085
1086 Mask = 0;
1087 GlobalFontBackup1 = NULL;
1088 GlobalFontBackup2 = NULL;
1089
1090 // The process of where the system default should be supplied instead of
1091 // the specified font info beyonds this function's scope.
1092 //
1093 if (FontInfoMask != NULL) {
1094 Mask = *FontInfoMask & (~SYS_FONT_INFO_MASK);
1095 }
1096
1097 //
1098 // If not NULL, FontHandle points to the next node of the last searched font
1099 // node by previous call.
1100 //
1101 if (FontHandle == NULL) {
1102 Link = Private->FontInfoList.ForwardLink;
1103 } else {
1104 Link = (LIST_ENTRY *) FontHandle;
1105 }
1106
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;
1113 }
1114 return TRUE;
1115 }
1116 } else {
1117 //
1118 // Check which options could be used to make a match.
1119 //
1120 switch (Mask) {
1121 case EFI_FONT_INFO_ANY_FONT:
1122 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle &&
1123 GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1124 Matched = TRUE;
1125 }
1126 break;
1127 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_ANY_STYLE:
1128 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1129 Matched = TRUE;
1130 }
1131 break;
1132 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_ANY_SIZE:
1133 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1134 Matched = TRUE;
1135 }
1136 break;
1137 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_ANY_SIZE | EFI_FONT_INFO_ANY_STYLE:
1138 Matched = TRUE;
1139 break;
1140 //
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.
1143 //
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) {
1147 Matched = TRUE;
1148 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {
1149 VagueMatched1 = TRUE;
1150 GlobalFontBackup1 = GlobalFont;
1151 }
1152 }
1153 break;
1154 //
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.
1157 //
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) {
1161 Matched = TRUE;
1162 } else {
1163 VagueMatched1 = TRUE;
1164 GlobalFontBackup1 = GlobalFont;
1165 }
1166 }
1167 break;
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) {
1171 Matched = TRUE;
1172 } else {
1173 VagueMatched1 = TRUE;
1174 GlobalFontBackup1 = GlobalFont;
1175 }
1176 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {
1177 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1178 VagueMatched1 = TRUE;
1179 GlobalFontBackup1 = GlobalFont;
1180 } else {
1181 VagueMatched2 = TRUE;
1182 GlobalFontBackup2 = GlobalFont;
1183 }
1184 }
1185 break;
1186 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_ANY_STYLE | EFI_FONT_INFO_RESIZE:
1187 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1188 Matched = TRUE;
1189 } else {
1190 VagueMatched1 = TRUE;
1191 GlobalFontBackup1 = GlobalFont;
1192 }
1193 break;
1194 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_ANY_SIZE | EFI_FONT_INFO_RESTYLE:
1195 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1196 Matched = TRUE;
1197 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {
1198 VagueMatched1 = TRUE;
1199 GlobalFontBackup1 = GlobalFont;
1200 }
1201 break;
1202 case EFI_FONT_INFO_ANY_STYLE:
1203 if ((CompareMem (
1204 GlobalFont->FontInfo->FontName,
1205 FontInfo->FontName,
1206 StrSize (FontInfo->FontName)
1207 ) == 0) &&
1208 GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1209 Matched = TRUE;
1210 }
1211 break;
1212 case EFI_FONT_INFO_ANY_STYLE | EFI_FONT_INFO_ANY_SIZE:
1213 if (CompareMem (
1214 GlobalFont->FontInfo->FontName,
1215 FontInfo->FontName,
1216 StrSize (FontInfo->FontName)
1217 ) == 0) {
1218 Matched = TRUE;
1219 }
1220 break;
1221 case EFI_FONT_INFO_ANY_STYLE | EFI_FONT_INFO_RESIZE:
1222 if (CompareMem (
1223 GlobalFont->FontInfo->FontName,
1224 FontInfo->FontName,
1225 StrSize (FontInfo->FontName)
1226 ) == 0) {
1227 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1228 Matched = TRUE;
1229 } else {
1230 VagueMatched1 = TRUE;
1231 GlobalFontBackup1 = GlobalFont;
1232 }
1233 }
1234 break;
1235 case EFI_FONT_INFO_ANY_SIZE:
1236 if ((CompareMem (
1237 GlobalFont->FontInfo->FontName,
1238 FontInfo->FontName,
1239 StrSize (FontInfo->FontName)
1240 ) == 0) &&
1241 GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1242 Matched = TRUE;
1243 }
1244 break;
1245 case EFI_FONT_INFO_ANY_SIZE | EFI_FONT_INFO_RESTYLE:
1246 if (CompareMem (
1247 GlobalFont->FontInfo->FontName,
1248 FontInfo->FontName,
1249 StrSize (FontInfo->FontName)
1250 ) == 0) {
1251 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1252 Matched = TRUE;
1253 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {
1254 VagueMatched1 = TRUE;
1255 GlobalFontBackup1 = GlobalFont;
1256 }
1257 }
1258 break;
1259 case EFI_FONT_INFO_RESTYLE:
1260 if ((CompareMem (
1261 GlobalFont->FontInfo->FontName,
1262 FontInfo->FontName,
1263 StrSize (FontInfo->FontName)
1264 ) == 0) &&
1265 GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1266
1267 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1268 Matched = TRUE;
1269 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {
1270 VagueMatched1 = TRUE;
1271 GlobalFontBackup1 = GlobalFont;
1272 }
1273 }
1274 break;
1275 case EFI_FONT_INFO_RESIZE:
1276 if ((CompareMem (
1277 GlobalFont->FontInfo->FontName,
1278 FontInfo->FontName,
1279 StrSize (FontInfo->FontName)
1280 ) == 0) &&
1281 GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1282
1283 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1284 Matched = TRUE;
1285 } else {
1286 VagueMatched1 = TRUE;
1287 GlobalFontBackup1 = GlobalFont;
1288 }
1289 }
1290 break;
1291 case EFI_FONT_INFO_RESIZE | EFI_FONT_INFO_RESTYLE:
1292 if (CompareMem (
1293 GlobalFont->FontInfo->FontName,
1294 FontInfo->FontName,
1295 StrSize (FontInfo->FontName)
1296 ) == 0) {
1297 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1298 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1299 Matched = TRUE;
1300 } else {
1301 VagueMatched1 = TRUE;
1302 GlobalFontBackup1 = GlobalFont;
1303 }
1304 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {
1305 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1306 VagueMatched1 = TRUE;
1307 GlobalFontBackup1 = GlobalFont;
1308 } else {
1309 VagueMatched2 = TRUE;
1310 GlobalFontBackup2 = GlobalFont;
1311 }
1312 }
1313 }
1314 break;
1315 default:
1316 break;
1317 }
1318
1319 if (Matched) {
1320 if (GlobalFontInfo != NULL) {
1321 *GlobalFontInfo = GlobalFont;
1322 }
1323 return TRUE;
1324 }
1325 }
1326 }
1327
1328 if (VagueMatched1) {
1329 if (GlobalFontInfo != NULL) {
1330 *GlobalFontInfo = GlobalFontBackup1;
1331 }
1332 return TRUE;
1333 } else if (VagueMatched2) {
1334 if (GlobalFontInfo != NULL) {
1335 *GlobalFontInfo = GlobalFontBackup2;
1336 }
1337 return TRUE;
1338 }
1339
1340 return FALSE;
1341 }
1342
1343
1344 /**
1345 Check whether the unicode represents a line break or not.
1346
1347 This is a internal function.
1348
1349 @param Char Unicode character
1350
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.
1357
1358 **/
1359 INT8
1360 IsLineBreak (
1361 IN CHAR16 Char
1362 )
1363 {
1364 UINT8 Byte1;
1365 UINT8 Byte2;
1366
1367 //
1368 // In little endian, Byte1 is the low byte of Char, Byte2 is the high byte of Char.
1369 //
1370 Byte1 = *((UINT8 *) (&Char));
1371 Byte2 = *(((UINT8 *) (&Char) + 1));
1372
1373 if (Byte2 == 0x20) {
1374 switch (Byte1) {
1375 case 0x00:
1376 case 0x01:
1377 case 0x02:
1378 case 0x03:
1379 case 0x04:
1380 case 0x05:
1381 case 0x06:
1382 case 0x08:
1383 case 0x09:
1384 case 0x0A:
1385 case 0x0B:
1386 case 0x28:
1387 case 0x29:
1388 case 0x5F:
1389 return 0;
1390 case 0x10:
1391 case 0x12:
1392 case 0x13:
1393 return 1;
1394 case 0x14:
1395 //
1396 // BUGBUG: Does it really require line break before it and after it?
1397 //
1398 return 2;
1399 }
1400 } else if (Byte2 == 0x00) {
1401 switch (Byte1) {
1402 case 0x20:
1403 case 0x0C:
1404 case 0x0D:
1405 return 0;
1406 }
1407 }
1408
1409 switch (Char) {
1410 case 0x1680:
1411 return 0;
1412 case 0x058A:
1413 case 0x0F0B:
1414 case 0x1361:
1415 case 0x17D5:
1416 return 1;
1417 }
1418
1419 return -1;
1420 }
1421
1422
1423 /**
1424 Renders a string to a bitmap or to the display.
1425
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
1429 displayed.
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
1433 and color.
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
1437 onto this image and
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
1445 image.
1446 @param BltY Specifies the offset from the left and top edge
1447 of the image of the first character cell in the
1448 image.
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
1456 this buffer.
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.
1469
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..
1475
1476 **/
1477 EFI_STATUS
1478 EFIAPI
1479 HiiStringToImage (
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,
1485 IN UINTN BltX,
1486 IN UINTN BltY,
1487 OUT EFI_HII_ROW_INFO **RowInfoArray OPTIONAL,
1488 OUT UINTN *RowInfoArraySize OPTIONAL,
1489 OUT UINTN *ColumnInfoArray OPTIONAL
1490 )
1491 {
1492 EFI_STATUS Status;
1493 HII_DATABASE_PRIVATE_DATA *Private;
1494 UINT8 **GlyphBuf;
1495 EFI_HII_GLYPH_INFO *Cell;
1496 UINT8 *Attributes;
1497 EFI_IMAGE_OUTPUT *Image;
1498 EFI_STRING StringPtr;
1499 EFI_STRING StringTmp;
1500 EFI_HII_ROW_INFO *RowInfo;
1501 UINTN LineWidth;
1502 UINTN LineHeight;
1503 UINTN BaseLineOffset;
1504 UINT16 MaxRowNum;
1505 UINT16 RowIndex;
1506 UINTN Index;
1507 UINTN Index1;
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;
1513 UINT16 Height;
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;
1521 UINTN RowInfoSize;
1522 BOOLEAN LineBreak;
1523
1524 //
1525 // Check incoming parameters.
1526 //
1527
1528 if (This == NULL || String == NULL || Blt == NULL) {
1529 return EFI_INVALID_PARAMETER;
1530 }
1531 if (*Blt == NULL) {
1532 //
1533 // These two flag cannot be used if Blt is NULL upon entry.
1534 //
1535 if ((Flags & EFI_HII_OUT_FLAG_TRANSPARENT) == EFI_HII_OUT_FLAG_TRANSPARENT) {
1536 return EFI_INVALID_PARAMETER;
1537 }
1538 if ((Flags & EFI_HII_OUT_FLAG_CLIP) == EFI_HII_OUT_FLAG_CLIP) {
1539 return EFI_INVALID_PARAMETER;
1540 }
1541 }
1542 //
1543 // These two flags require that EFI_HII_OUT_FLAG_CLIP be also set.
1544 //
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;
1547 }
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;
1550 }
1551 //
1552 // This flag cannot be used with EFI_HII_OUT_FLAG_CLEAN_X.
1553 //
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;
1556 }
1557
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);
1564
1565 RowInfo = NULL;
1566 Status = EFI_SUCCESS;
1567 StringIn2 = NULL;
1568 SystemDefault = NULL;
1569 StringIn = NULL;
1570
1571 //
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
1574 // EFI_FONT_INFO.
1575 //
1576 StringInfoOut = NULL;
1577 FontHandle = NULL;
1578 Private = HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This);
1579 SysFontFlag = IsSystemFontInfo (Private, (EFI_FONT_DISPLAY_INFO *) StringInfo, &SystemDefault, NULL);
1580
1581 if (SysFontFlag) {
1582 FontInfo = NULL;
1583 Height = SystemDefault->FontInfo.FontSize;
1584 Foreground = SystemDefault->ForegroundColor;
1585 Background = SystemDefault->BackgroundColor;
1586
1587 } else {
1588 //
1589 // StringInfo must not be NULL if it is not system info.
1590 //
1591 ASSERT (StringInfo != NULL);
1592 Status = HiiGetFontInfo (This, &FontHandle, (EFI_FONT_DISPLAY_INFO *) StringInfo, &StringInfoOut, NULL);
1593 if (Status == EFI_NOT_FOUND) {
1594 //
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.
1597 //
1598 SysFontFlag = TRUE;
1599 FontInfo = NULL;
1600 Height = SystemDefault->FontInfo.FontSize;
1601 Foreground = ((EFI_FONT_DISPLAY_INFO *) StringInfo)->ForegroundColor;
1602 Background = ((EFI_FONT_DISPLAY_INFO *) StringInfo)->BackgroundColor;
1603
1604 } else if (Status == EFI_SUCCESS) {
1605 FontInfo = &StringInfoOut->FontInfo;
1606 Height = StringInfoOut->FontInfo.FontSize;
1607 Foreground = StringInfoOut->ForegroundColor;
1608 Background = StringInfoOut->BackgroundColor;
1609 } else {
1610 goto Exit;
1611 }
1612 }
1613
1614 //
1615 // Parse the string to be displayed to drop some ignored characters.
1616 //
1617
1618 StringPtr = String;
1619
1620 //
1621 // Ignore line-break characters only. Hyphens or dash character will be displayed
1622 // without line-break opportunity.
1623 //
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;
1628 goto Exit;
1629 }
1630 StringTmp = StringIn;
1631 while (*StringPtr != 0) {
1632 if (IsLineBreak (*StringPtr) == 0) {
1633 StringPtr++;
1634 } else {
1635 *StringTmp++ = *StringPtr++;
1636 }
1637 }
1638 *StringTmp = 0;
1639 StringPtr = StringIn;
1640 }
1641 //
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.
1644 //
1645 StringIn2 = AllocateZeroPool (StrSize (StringPtr));
1646 if (StringIn2 == NULL) {
1647 Status = EFI_OUT_OF_RESOURCES;
1648 goto Exit;
1649 }
1650 Index = 0;
1651 StringTmp = StringIn2;
1652
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]);
1659 }
1660 GlyphBuf[Index] = NULL;
1661 StringPtr++;
1662 } else {
1663 //
1664 // Unicode 0xFFFD must exist in current hii database if this flag is not set.
1665 //
1666 Status = GetGlyphBuffer (
1667 Private,
1668 REPLACE_UNKNOWN_GLYPH,
1669 FontInfo,
1670 &GlyphBuf[Index],
1671 &Cell[Index],
1672 &Attributes[Index]
1673 );
1674 if (EFI_ERROR (Status)) {
1675 Status = EFI_INVALID_PARAMETER;
1676 goto Exit;
1677 }
1678 *StringTmp++ = *StringPtr++;
1679 Index++;
1680 }
1681 } else if (EFI_ERROR (Status)) {
1682 goto Exit;
1683 } else {
1684 *StringTmp++ = *StringPtr++;
1685 Index++;
1686 }
1687 }
1688 *StringTmp = 0;
1689 StringPtr = StringIn2;
1690
1691 //
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.
1696 //
1697 if (*Blt != NULL) {
1698 Image = *Blt;
1699 BufferPtr = Image->Image.Bitmap + Image->Width * BltY + BltX;
1700 MaxRowNum = (UINT16) (Image->Height / Height);
1701 if (Image->Height % Height != 0) {
1702 MaxRowNum++;
1703 }
1704
1705 RowInfo = (EFI_HII_ROW_INFO *) AllocateZeroPool (MaxRowNum * sizeof (EFI_HII_ROW_INFO));
1706 if (RowInfo == NULL) {
1707 Status = EFI_OUT_OF_RESOURCES;
1708 goto Exit;
1709 }
1710
1711 //
1712 // Format the glyph buffer according to flags.
1713 //
1714
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) {
1717 //
1718 // Don't draw at all if there is only one row and
1719 // the row's bottom-most on pixel cannot fit.
1720 //
1721 if (MaxRowNum == 1 && SysFontFlag) {
1722 Status = EFI_SUCCESS;
1723 goto Exit;
1724 }
1725 }
1726
1727 for (RowIndex = 0, Index = 0; RowIndex < MaxRowNum && StringPtr[Index] != 0; ) {
1728 LineWidth = 0;
1729 LineHeight = 0;
1730 BaseLineOffset = 0;
1731 LineBreak = FALSE;
1732
1733 //
1734 // Calculate how many characters there are in a row.
1735 //
1736 RowInfo[RowIndex].StartIndex = Index;
1737
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;
1742 }
1743
1744 if ((Flags & EFI_HII_IGNORE_LINE_BREAK) == 0 &&
1745 (Flags & EFI_HII_OUT_FLAG_WRAP) == 0 &&
1746 IsLineBreak (StringPtr[Index]) > 0) {
1747 //
1748 // It is a line break that ends this row.
1749 //
1750 Index++;
1751 break;
1752 }
1753
1754 Index++;
1755 }
1756
1757 //
1758 // If this character is the last character of a row, we need not
1759 // draw its (AdvanceX - Width) for next character.
1760 //
1761 Index--;
1762 if (!SysFontFlag) {
1763 LineWidth -= (UINTN) (Cell[Index].AdvanceX - Cell[Index].Width);
1764 }
1765
1766 //
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.
1770 //
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) {
1775 LineBreak = TRUE;
1776 RowInfo[RowIndex].EndIndex = Index1 - 1;
1777 break;
1778 }
1779 }
1780 }
1781 //
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.
1784 //
1785 if (!LineBreak) {
1786 Flags &= (~ (EFI_HII_OUT_FLAGS) EFI_HII_OUT_FLAG_WRAP);
1787 Flags |= EFI_HII_OUT_FLAG_CLIP_CLEAN_X;
1788 }
1789 }
1790
1791 //
1792 // Clip the right-most character if cannot fit when EFI_HII_OUT_FLAG_CLEAN_X is set.
1793 //
1794 if (LineWidth + BltX <= Image->Width ||
1795 (LineWidth + BltX > Image->Width && (Flags & EFI_HII_OUT_FLAG_CLIP_CLEAN_X) == 0)) {
1796 //
1797 // Record right-most character in RowInfo even if it is partially displayed.
1798 //
1799 RowInfo[RowIndex].EndIndex = Index;
1800 RowInfo[RowIndex].LineWidth = LineWidth;
1801 RowInfo[RowIndex].LineHeight = LineHeight;
1802 RowInfo[RowIndex].BaselineOffset = BaseLineOffset;
1803 } else {
1804 //
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.
1807 //
1808 if (Index > 0) {
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;
1814 }
1815 RowInfo[RowIndex].LineHeight = LineHeight;
1816 } else {
1817 //
1818 // There is only one column and it can not be drawn so that return directly.
1819 //
1820 Status = EFI_SUCCESS;
1821 goto Exit;
1822 }
1823 }
1824
1825 //
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.
1828 //
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) {
1832 //
1833 // Don't draw at all if the row's bottom-most on pixel cannot fit.
1834 //
1835 break;
1836 }
1837 }
1838
1839 //
1840 // Draw it to screen or existing bitmap depending on whether
1841 // EFI_HII_DIRECT_TO_SCREEN is set.
1842 //
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;
1847 goto Exit;
1848 }
1849 BufferPtr = BltBuffer;
1850 for (Index1 = RowInfo[RowIndex].StartIndex; Index1 <= RowInfo[RowIndex].EndIndex; Index1++) {
1851 GlyphToImage (
1852 GlyphBuf[Index1],
1853 Foreground,
1854 Background,
1855 RowInfo[RowIndex].LineWidth,
1856 RowInfo[RowIndex].LineHeight,
1857 Transparent,
1858 &Cell[Index1],
1859 Attributes[Index1],
1860 &BufferPtr
1861 );
1862 if (ColumnInfoArray != NULL) {
1863 if (Index1 == RowInfo[RowIndex].StartIndex) {
1864 *ColumnInfoArray = 0;
1865 } else {
1866 *ColumnInfoArray = Cell[Index1 -1].AdvanceX;
1867 }
1868 ColumnInfoArray++;
1869 }
1870 }
1871 Status = Image->Image.Screen->Blt (
1872 Image->Image.Screen,
1873 BltBuffer,
1874 EfiBltBufferToVideo,
1875 0,
1876 0,
1877 BltX,
1878 BltY,
1879 RowInfo[RowIndex].LineWidth,
1880 RowInfo[RowIndex].LineHeight,
1881 0
1882 );
1883 if (EFI_ERROR (Status)) {
1884 FreePool (BltBuffer);
1885 goto Exit;
1886 }
1887
1888 FreePool (BltBuffer);
1889
1890 } else {
1891 for (Index1 = RowInfo[RowIndex].StartIndex; Index1 <= RowInfo[RowIndex].EndIndex; Index1++) {
1892 GlyphToImage (
1893 GlyphBuf[Index1],
1894 Foreground,
1895 Background,
1896 Image->Width,
1897 Image->Height,
1898 Transparent,
1899 &Cell[Index1],
1900 Attributes[Index1],
1901 &BufferPtr
1902 );
1903 if (ColumnInfoArray != NULL) {
1904 if (Index1 == RowInfo[RowIndex].StartIndex) {
1905 *ColumnInfoArray = 0;
1906 } else {
1907 *ColumnInfoArray = Cell[Index1 -1].AdvanceX;
1908 }
1909 ColumnInfoArray++;
1910 }
1911 }
1912 //
1913 // Jump to next row
1914 //
1915 BufferPtr += BltX + Image->Width * (LineHeight - 1);
1916 }
1917
1918 Index++;
1919 RowIndex++;
1920
1921 }
1922
1923 //
1924 // Write output parameters.
1925 //
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;
1931 goto Exit;
1932 }
1933 CopyMem (*RowInfoArray, RowInfo, RowInfoSize);
1934 }
1935 if (RowInfoArraySize != NULL) {
1936 *RowInfoArraySize = RowIndex;
1937 }
1938
1939 } else {
1940 //
1941 // Create a new bitmap and draw the string onto this image.
1942 //
1943 Image = AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT));
1944 if (Image == NULL) {
1945 return EFI_OUT_OF_RESOURCES;
1946 }
1947 Image->Width = 800;
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) {
1951 FreePool (Image);
1952 return EFI_OUT_OF_RESOURCES;
1953 }
1954
1955 //
1956 // Other flags are not permitted when Blt is NULL.
1957 //
1958 Flags &= EFI_HII_OUT_FLAG_WRAP | EFI_HII_IGNORE_IF_NO_GLYPH | EFI_HII_IGNORE_LINE_BREAK;
1959 Status = HiiStringToImage (
1960 This,
1961 Flags,
1962 String,
1963 StringInfo,
1964 &Image,
1965 BltX,
1966 BltY,
1967 RowInfoArray,
1968 RowInfoArraySize,
1969 ColumnInfoArray
1970 );
1971 if (EFI_ERROR (Status)) {
1972 return Status;
1973 }
1974
1975 *Blt = Image;
1976 }
1977
1978 Status = EFI_SUCCESS;
1979
1980 Exit:
1981
1982 for (Index = 0; Index < MAX_STRING_LENGTH; Index++) {
1983 if (GlyphBuf[Index] != NULL) {
1984 FreePool (GlyphBuf[Index]);
1985 }
1986 }
1987 if (StringIn != NULL) {
1988 FreePool (StringIn);
1989 }
1990 if (StringIn2 != NULL) {
1991 FreePool (StringIn2);
1992 }
1993 if (StringInfoOut != NULL) {
1994 FreePool (StringInfoOut);
1995 }
1996 if (RowInfo != NULL) {
1997 FreePool (RowInfo);
1998 }
1999 if (SystemDefault != NULL) {
2000 FreePool (SystemDefault);
2001 }
2002 if (GlyphBuf != NULL) {
2003 FreePool (GlyphBuf);
2004 }
2005 if (Cell != NULL) {
2006 FreePool (Cell);
2007 }
2008 if (Attributes != NULL) {
2009 FreePool (Attributes);
2010 }
2011
2012 return Status;
2013 }
2014
2015
2016 /**
2017 Render a string to a bitmap or the screen containing the contents of the specified string.
2018
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
2024 PackageList.
2025 @param Language Points to the language for the retrieved string.
2026 If NULL, then the current system language is
2027 used.
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
2031 and color.
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
2035 onto this image and
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
2043 image.
2044 @param BltY Specifies the offset from the left and top edge
2045 of the image of the first character cell in the
2046 image.
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
2054 this buffer.
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.
2067
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.
2075
2076 **/
2077 EFI_STATUS
2078 EFIAPI
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,
2087 IN UINTN BltX,
2088 IN UINTN BltY,
2089 OUT EFI_HII_ROW_INFO **RowInfoArray OPTIONAL,
2090 OUT UINTN *RowInfoArraySize OPTIONAL,
2091 OUT UINTN *ColumnInfoArray OPTIONAL
2092 )
2093 {
2094 EFI_STATUS Status;
2095 HII_DATABASE_PRIVATE_DATA *Private;
2096 EFI_HII_STRING_PROTOCOL *HiiString;
2097 EFI_STRING String;
2098 UINTN StringSize;
2099 UINTN FontLen;
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;
2107
2108 if (This == NULL || PackageList == NULL || Blt == NULL || PackageList == NULL) {
2109 return EFI_INVALID_PARAMETER;
2110 }
2111
2112 if (!IsHiiHandleValid (PackageList)) {
2113 return EFI_NOT_FOUND;
2114 }
2115
2116 //
2117 // Initialize string pointers to be NULL
2118 //
2119 SupportedLanguages = NULL;
2120 CurrentLanguage = NULL;
2121 BestLanguage = NULL;
2122 String = NULL;
2123 StringInfo = NULL;
2124 StringFontInfo = NULL;
2125 NewStringInfo = NULL;
2126
2127 //
2128 // Get the string to be displayed.
2129 //
2130 Private = HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This);
2131 HiiString = &Private->HiiString;
2132
2133 //
2134 // Get the size of supported language.
2135 //
2136 SupportedLanguagesSize = 0;
2137 Status = HiiString->GetLanguages (
2138 HiiString,
2139 PackageList,
2140 &TempSupportedLanguages,
2141 &SupportedLanguagesSize
2142 );
2143 if (Status != EFI_BUFFER_TOO_SMALL) {
2144 return Status;
2145 }
2146
2147 SupportedLanguages = AllocatePool (SupportedLanguagesSize);
2148 if (SupportedLanguages == NULL) {
2149 return EFI_OUT_OF_RESOURCES;
2150 }
2151
2152 Status = HiiString->GetLanguages (
2153 HiiString,
2154 PackageList,
2155 SupportedLanguages,
2156 &SupportedLanguagesSize
2157 );
2158 if (EFI_ERROR (Status)) {
2159 goto Exit;
2160 }
2161
2162 if (Language == NULL) {
2163 Language = "";
2164 }
2165 CurrentLanguage = GetEfiGlobalVariable (L"PlatformLang");
2166 BestLanguage = GetBestLanguage (
2167 SupportedLanguages,
2168 FALSE,
2169 Language,
2170 (CurrentLanguage == NULL) ? CurrentLanguage : "",
2171 (CHAR8 *) PcdGetPtr (PcdUefiVariableDefaultPlatformLang),
2172 NULL
2173 );
2174 if (BestLanguage == NULL) {
2175 Status = EFI_NOT_FOUND;
2176 goto Exit;
2177 }
2178
2179 StringSize = MAX_STRING_LENGTH;
2180 String = (EFI_STRING) AllocateZeroPool (StringSize);
2181 if (String == NULL) {
2182 Status = EFI_OUT_OF_RESOURCES;
2183 goto Exit;
2184 }
2185
2186 Status = HiiString->GetString (
2187 HiiString,
2188 BestLanguage,
2189 PackageList,
2190 StringId,
2191 String,
2192 &StringSize,
2193 &StringFontInfo
2194 );
2195 if (Status == EFI_BUFFER_TOO_SMALL) {
2196 FreePool (String);
2197 String = (EFI_STRING) AllocateZeroPool (StringSize);
2198 if (String == NULL) {
2199 Status = EFI_OUT_OF_RESOURCES;
2200 goto Exit;
2201 }
2202 Status = HiiString->GetString (
2203 HiiString,
2204 BestLanguage,
2205 PackageList,
2206 StringId,
2207 String,
2208 &StringSize,
2209 NULL
2210 );
2211 }
2212
2213 if (EFI_ERROR (Status)) {
2214 goto Exit;
2215 }
2216
2217 //
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.
2221 //
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;
2227 goto Exit;
2228 }
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);
2233
2234 Status = HiiStringToImage (
2235 This,
2236 Flags,
2237 String,
2238 NewStringInfo,
2239 Blt,
2240 BltX,
2241 BltY,
2242 RowInfoArray,
2243 RowInfoArraySize,
2244 ColumnInfoArray
2245 );
2246 goto Exit;
2247 }
2248
2249 Status = HiiStringToImage (
2250 This,
2251 Flags,
2252 String,
2253 StringInfo,
2254 Blt,
2255 BltX,
2256 BltY,
2257 RowInfoArray,
2258 RowInfoArraySize,
2259 ColumnInfoArray
2260 );
2261
2262 Exit:
2263 if (SupportedLanguages != NULL) {
2264 FreePool (SupportedLanguages);
2265 }
2266 if (CurrentLanguage != NULL) {
2267 FreePool (CurrentLanguage);
2268 }
2269 if (BestLanguage != NULL) {
2270 FreePool (BestLanguage);
2271 }
2272 if (String != NULL) {
2273 FreePool (String);
2274 }
2275 if (StringFontInfo != NULL) {
2276 FreePool (StringFontInfo);
2277 }
2278 if (NewStringInfo != NULL) {
2279 FreePool (NewStringInfo);
2280 }
2281
2282 return Status;
2283 }
2284
2285
2286 /**
2287 Convert the glyph for a single character into a bitmap.
2288
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
2299 the baseline.
2300
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.
2306
2307 **/
2308 EFI_STATUS
2309 EFIAPI
2310 HiiGetGlyph (
2311 IN CONST EFI_HII_FONT_PROTOCOL *This,
2312 IN CHAR16 Char,
2313 IN CONST EFI_FONT_DISPLAY_INFO *StringInfo,
2314 OUT EFI_IMAGE_OUTPUT **Blt,
2315 OUT UINTN *Baseline OPTIONAL
2316 )
2317 {
2318 EFI_STATUS Status;
2319 HII_DATABASE_PRIVATE_DATA *Private;
2320 EFI_IMAGE_OUTPUT *Image;
2321 UINT8 *GlyphBuffer;
2322 EFI_FONT_DISPLAY_INFO *SystemDefault;
2323 EFI_FONT_DISPLAY_INFO *StringInfoOut;
2324 BOOLEAN Default;
2325 EFI_FONT_HANDLE FontHandle;
2326 EFI_STRING String;
2327 EFI_HII_GLYPH_INFO Cell;
2328 EFI_FONT_INFO *FontInfo;
2329 UINT8 Attributes;
2330 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground;
2331 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background;
2332 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer;
2333
2334 if (This == NULL || Blt == NULL || *Blt != NULL) {
2335 return EFI_INVALID_PARAMETER;
2336 }
2337
2338 Private = HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This);
2339
2340 Default = FALSE;
2341 Image = NULL;
2342 SystemDefault = NULL;
2343 FontHandle = NULL;
2344 String = NULL;
2345 GlyphBuffer = NULL;
2346 StringInfoOut = NULL;
2347 FontInfo = NULL;
2348
2349 ZeroMem (&Foreground, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
2350 ZeroMem (&Background, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
2351
2352 Default = IsSystemFontInfo (Private, (EFI_FONT_DISPLAY_INFO *) StringInfo, &SystemDefault, NULL);
2353
2354 if (!Default) {
2355 //
2356 // Find out a EFI_FONT_DISPLAY_INFO which could display the character in
2357 // the specified color and font.
2358 //
2359 String = (EFI_STRING) AllocateZeroPool (sizeof (CHAR16) * 2);
2360 if (String == NULL) {
2361 Status = EFI_OUT_OF_RESOURCES;
2362 goto Exit;
2363 }
2364 *String = Char;
2365 *(String + 1) = 0;
2366
2367 Status = HiiGetFontInfo (This, &FontHandle, StringInfo, &StringInfoOut, String);
2368 if (EFI_ERROR (Status)) {
2369 goto Exit;
2370 }
2371 FontInfo = &StringInfoOut->FontInfo;
2372 Foreground = StringInfoOut->ForegroundColor;
2373 Background = StringInfoOut->BackgroundColor;
2374 } else {
2375 Foreground = SystemDefault->ForegroundColor;
2376 Background = SystemDefault->BackgroundColor;
2377 }
2378
2379 Status = GetGlyphBuffer (Private, Char, FontInfo, &GlyphBuffer, &Cell, &Attributes);
2380 if (EFI_ERROR (Status)) {
2381 goto Exit;
2382 }
2383
2384 Image = (EFI_IMAGE_OUTPUT *) AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT));
2385 if (Image == NULL) {
2386 Status = EFI_OUT_OF_RESOURCES;
2387 goto Exit;
2388 }
2389 Image->Width = Cell.Width;
2390 Image->Height = Cell.Height;
2391
2392 Image->Image.Bitmap = AllocateZeroPool (Image->Width * Image->Height * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
2393 if (Image->Image.Bitmap == NULL) {
2394 FreePool (Image);
2395 Status = EFI_OUT_OF_RESOURCES;
2396 goto Exit;
2397 }
2398
2399 BltBuffer = Image->Image.Bitmap;
2400 GlyphToImage (
2401 GlyphBuffer,
2402 Foreground,
2403 Background,
2404 Image->Width,
2405 Image->Height,
2406 FALSE,
2407 &Cell,
2408 Attributes,
2409 &BltBuffer
2410 );
2411
2412 *Blt = Image;
2413 if (Baseline != NULL) {
2414 *Baseline = Cell.OffsetY;
2415 }
2416
2417 Status = EFI_SUCCESS;
2418
2419 Exit:
2420
2421 if (Status == EFI_NOT_FOUND) {
2422 //
2423 // Glyph is unknown and replaced with the glyph for unicode character 0xFFFD
2424 //
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;
2429 }
2430 } else {
2431 Status = EFI_WARN_UNKNOWN_GLYPH;
2432 }
2433 }
2434
2435 if (SystemDefault != NULL) {
2436 FreePool (SystemDefault);
2437 }
2438 if (StringInfoOut != NULL) {
2439 FreePool (StringInfoOut);
2440 }
2441 if (String != NULL) {
2442 FreePool (String);
2443 }
2444 if (GlyphBuffer != NULL) {
2445 FreePool (GlyphBuffer);
2446 }
2447
2448 return Status;
2449 }
2450
2451
2452 /**
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.
2456
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
2464 information about.
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
2470 this buffer.
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.
2474
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
2479 request.
2480
2481 **/
2482 EFI_STATUS
2483 EFIAPI
2484 HiiGetFontInfo (
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
2490 )
2491 {
2492 HII_DATABASE_PRIVATE_DATA *Private;
2493 EFI_STATUS Status;
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;
2501
2502 if (This == NULL) {
2503 return EFI_INVALID_PARAMETER;
2504 }
2505
2506 FontInfo = NULL;
2507 SystemDefault = NULL;
2508 LocalFontHandle = NULL;
2509 if (FontHandle != NULL) {
2510 LocalFontHandle = *FontHandle;
2511 }
2512
2513 Private = HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This);
2514
2515 //
2516 // Already searched to the end of the whole list, return directly.
2517 //
2518 if (LocalFontHandle == &Private->FontInfoList) {
2519 LocalFontHandle = NULL;
2520 Status = EFI_NOT_FOUND;
2521 goto Exit;
2522 }
2523
2524 //
2525 // Get default system display info, if StringInfoIn points to
2526 // system display info, return it directly.
2527 //
2528 if (IsSystemFontInfo (Private, (EFI_FONT_DISPLAY_INFO *) StringInfoIn, &SystemDefault, &StringInfoOutLen)) {
2529 //
2530 // System font is the first node. When handle is not NULL, system font can not
2531 // be found any more.
2532 //
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;
2539 goto Exit;
2540 }
2541 }
2542
2543 LocalFontHandle = Private->FontInfoList.ForwardLink;
2544 Status = EFI_SUCCESS;
2545 goto Exit;
2546 } else {
2547 LocalFontHandle = NULL;
2548 Status = EFI_NOT_FOUND;
2549 goto Exit;
2550 }
2551 }
2552
2553 //
2554 // StringInfoIn must not be NULL if it is not system default font info.
2555 //
2556 ASSERT (StringInfoIn != NULL);
2557 //
2558 // Check the font information mask to make sure it is valid.
2559 //
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;
2571 }
2572
2573 //
2574 // Parse the font information mask to find a matching font.
2575 //
2576
2577 CopyMem (&InfoOut, (EFI_FONT_DISPLAY_INFO *) StringInfoIn, sizeof (EFI_FONT_DISPLAY_INFO));
2578
2579 if ((StringInfoIn->FontInfoMask & EFI_FONT_INFO_SYS_FONT) == EFI_FONT_INFO_SYS_FONT) {
2580 Status = SaveFontName (SystemDefault->FontInfo.FontName, &FontInfo);
2581 } else {
2582 Status = SaveFontName (((EFI_FONT_DISPLAY_INFO *) StringInfoIn)->FontInfo.FontName, &FontInfo);
2583 }
2584 if (EFI_ERROR (Status)) {
2585 goto Exit;
2586 }
2587
2588 if ((StringInfoIn->FontInfoMask & EFI_FONT_INFO_SYS_SIZE) == EFI_FONT_INFO_SYS_SIZE) {
2589 InfoOut.FontInfo.FontSize = SystemDefault->FontInfo.FontSize;
2590 }
2591 if ((StringInfoIn->FontInfoMask & EFI_FONT_INFO_SYS_STYLE) == EFI_FONT_INFO_SYS_STYLE) {
2592 InfoOut.FontInfo.FontStyle = SystemDefault->FontInfo.FontStyle;
2593 }
2594 if ((StringInfoIn->FontInfoMask & EFI_FONT_INFO_SYS_FORE_COLOR) == EFI_FONT_INFO_SYS_FORE_COLOR) {
2595 InfoOut.ForegroundColor = SystemDefault->ForegroundColor;
2596 }
2597 if ((StringInfoIn->FontInfoMask & EFI_FONT_INFO_SYS_BACK_COLOR) == EFI_FONT_INFO_SYS_BACK_COLOR) {
2598 InfoOut.BackgroundColor = SystemDefault->BackgroundColor;
2599 }
2600
2601
2602 FontInfo->FontSize = InfoOut.FontInfo.FontSize;
2603 FontInfo->FontStyle = InfoOut.FontInfo.FontStyle;
2604
2605 if (IsFontInfoExisted (Private, FontInfo, &InfoOut.FontInfoMask, LocalFontHandle, &GlobalFont)) {
2606 //
2607 // Test to guarantee all characters are available in the found font.
2608 //
2609 if (String != NULL) {
2610 StringIn = String;
2611 while (*StringIn != 0) {
2612 Status = FindGlyphBlock (GlobalFont->FontPackage, *StringIn, NULL, NULL, NULL);
2613 if (EFI_ERROR (Status)) {
2614 LocalFontHandle = NULL;
2615 goto Exit;
2616 }
2617 StringIn++;
2618 }
2619 }
2620 //
2621 // Write to output parameter
2622 //
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;
2629 goto Exit;
2630 }
2631
2632 CopyMem (*StringInfoOut, &InfoOut, sizeof (EFI_FONT_DISPLAY_INFO));
2633 CopyMem (&(*StringInfoOut)->FontInfo, GlobalFont->FontInfo, GlobalFont->FontInfoSize);
2634 }
2635
2636 LocalFontHandle = GlobalFont->Entry.ForwardLink;
2637 Status = EFI_SUCCESS;
2638 goto Exit;
2639 }
2640
2641 Status = EFI_NOT_FOUND;
2642
2643 Exit:
2644
2645 if (FontHandle != NULL) {
2646 *FontHandle = LocalFontHandle;
2647 }
2648
2649 if (SystemDefault != NULL) {
2650 FreePool (SystemDefault);
2651 }
2652 if (FontInfo != NULL) {
2653 FreePool (FontInfo);
2654 }
2655 return Status;
2656 }
2657
2658
EFI Development Kit II mirror for PVE