]> 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
MdeModulePkg:Add line break character
[mirror_edk2.git] / MdeModulePkg / Universal / HiiDatabaseDxe / Font.c
1 /** @file
2 Implementation for EFI_HII_FONT_PROTOCOL.
3
4
5 Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
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 mHiiEfiColors[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 if (Cell->AdvanceX == 0) {
80 Cell->AdvanceX = Cell->Width;
81 }
82 CopyMem (&GlyphInfo->Cell, Cell, sizeof (EFI_HII_GLYPH_INFO));
83 InsertTailList (GlyphInfoList, &GlyphInfo->Entry);
84
85 return EFI_SUCCESS;
86 }
87
88
89 /**
90 Get a character cell information from the list specified by GlyphInfoList.
91
92 This is a internal function.
93
94 @param CharValue Unicode character value, which identifies a glyph
95 block.
96 @param GlyphInfoList HII_GLYPH_INFO list head.
97 @param Cell Buffer which stores output character cell
98 information.
99
100 @retval EFI_SUCCESS Cell information is added to the GlyphInfoList.
101 @retval EFI_NOT_FOUND The character info specified by CharValue does
102 not exist.
103
104 **/
105 EFI_STATUS
106 GetCell (
107 IN CHAR16 CharValue,
108 IN LIST_ENTRY *GlyphInfoList,
109 OUT EFI_HII_GLYPH_INFO *Cell
110 )
111 {
112 HII_GLYPH_INFO *GlyphInfo;
113 LIST_ENTRY *Link;
114
115 ASSERT (Cell != NULL && GlyphInfoList != NULL);
116
117 //
118 // Since the EFI_HII_GIBT_DEFAULTS block won't increment CharValueCurrent,
119 // the value of "CharId" of a default character cell which is used for a
120 // EFI_HII_GIBT_GLYPH_DEFAULT or EFI_HII_GIBT_GLYPHS_DEFAULT should be
121 // less or equal to the value of "CharValueCurrent" of this default block.
122 //
123 // For instance, if the CharId of a GlyphInfoList is {1, 3, 7}, a default glyph
124 // with CharValue equals "7" uses the GlyphInfo with CharId = 7;
125 // a default glyph with CharValue equals "6" uses the GlyphInfo with CharId = 3.
126 //
127 for (Link = GlyphInfoList->BackLink; Link != GlyphInfoList; Link = Link->BackLink) {
128 GlyphInfo = CR (Link, HII_GLYPH_INFO, Entry, HII_GLYPH_INFO_SIGNATURE);
129 if (GlyphInfo->CharId <= CharValue) {
130 CopyMem (Cell, &GlyphInfo->Cell, sizeof (EFI_HII_GLYPH_INFO));
131 return EFI_SUCCESS;
132 }
133 }
134
135 return EFI_NOT_FOUND;
136 }
137
138
139 /**
140 Convert the glyph for a single character into a bitmap.
141
142 This is a internal function.
143
144 @param Private HII database driver private data.
145 @param Char Character to retrieve.
146 @param StringInfo Points to the string font and color information
147 or NULL if the string should use the default
148 system font and color.
149 @param GlyphBuffer Buffer to store the retrieved bitmap data.
150 @param Cell Points to EFI_HII_GLYPH_INFO structure.
151 @param Attributes If not NULL, output the glyph attributes if any.
152
153 @retval EFI_SUCCESS Glyph bitmap outputted.
154 @retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer GlyphBuffer.
155 @retval EFI_NOT_FOUND The glyph was unknown can not be found.
156 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
157
158 **/
159 EFI_STATUS
160 GetGlyphBuffer (
161 IN HII_DATABASE_PRIVATE_DATA *Private,
162 IN CHAR16 Char,
163 IN EFI_FONT_INFO *StringInfo,
164 OUT UINT8 **GlyphBuffer,
165 OUT EFI_HII_GLYPH_INFO *Cell,
166 OUT UINT8 *Attributes OPTIONAL
167 )
168 {
169 HII_DATABASE_RECORD *Node;
170 LIST_ENTRY *Link;
171 HII_SIMPLE_FONT_PACKAGE_INSTANCE *SimpleFont;
172 LIST_ENTRY *Link1;
173 UINT16 Index;
174 EFI_NARROW_GLYPH Narrow;
175 EFI_WIDE_GLYPH Wide;
176 HII_GLOBAL_FONT_INFO *GlobalFont;
177 UINTN HeaderSize;
178 EFI_NARROW_GLYPH *NarrowPtr;
179 EFI_WIDE_GLYPH *WidePtr;
180
181 if (GlyphBuffer == NULL || Cell == NULL) {
182 return EFI_INVALID_PARAMETER;
183 }
184 if (Private == NULL || Private->Signature != HII_DATABASE_PRIVATE_DATA_SIGNATURE) {
185 return EFI_INVALID_PARAMETER;
186 }
187
188 ZeroMem (Cell, sizeof (EFI_HII_GLYPH_INFO));
189
190 //
191 // If StringInfo is not NULL, it must point to an existing EFI_FONT_INFO rather
192 // than system default font and color.
193 // If NULL, try to find the character in simplified font packages since
194 // default system font is the fixed font (narrow or wide glyph).
195 //
196 if (StringInfo != NULL) {
197 if(!IsFontInfoExisted (Private, StringInfo, NULL, NULL, &GlobalFont)) {
198 return EFI_INVALID_PARAMETER;
199 }
200 if (Attributes != NULL) {
201 *Attributes = PROPORTIONAL_GLYPH;
202 }
203 return FindGlyphBlock (GlobalFont->FontPackage, Char, GlyphBuffer, Cell, NULL);
204 } else {
205 HeaderSize = sizeof (EFI_HII_SIMPLE_FONT_PACKAGE_HDR);
206
207 for (Link = Private->DatabaseList.ForwardLink; Link != &Private->DatabaseList; Link = Link->ForwardLink) {
208 Node = CR (Link, HII_DATABASE_RECORD, DatabaseEntry, HII_DATABASE_RECORD_SIGNATURE);
209 for (Link1 = Node->PackageList->SimpleFontPkgHdr.ForwardLink;
210 Link1 != &Node->PackageList->SimpleFontPkgHdr;
211 Link1 = Link1->ForwardLink
212 ) {
213 SimpleFont = CR (Link1, HII_SIMPLE_FONT_PACKAGE_INSTANCE, SimpleFontEntry, HII_S_FONT_PACKAGE_SIGNATURE);
214 //
215 // Search the narrow glyph array
216 //
217 NarrowPtr = (EFI_NARROW_GLYPH *) ((UINT8 *) (SimpleFont->SimpleFontPkgHdr) + HeaderSize);
218 for (Index = 0; Index < SimpleFont->SimpleFontPkgHdr->NumberOfNarrowGlyphs; Index++) {
219 CopyMem (&Narrow, NarrowPtr + Index,sizeof (EFI_NARROW_GLYPH));
220 if (Narrow.UnicodeWeight == Char) {
221 *GlyphBuffer = (UINT8 *) AllocateZeroPool (EFI_GLYPH_HEIGHT);
222 if (*GlyphBuffer == NULL) {
223 return EFI_OUT_OF_RESOURCES;
224 }
225 Cell->Width = EFI_GLYPH_WIDTH;
226 Cell->Height = EFI_GLYPH_HEIGHT;
227 Cell->AdvanceX = Cell->Width;
228 CopyMem (*GlyphBuffer, Narrow.GlyphCol1, Cell->Height);
229 if (Attributes != NULL) {
230 *Attributes = (UINT8) (Narrow.Attributes | NARROW_GLYPH);
231 }
232 return EFI_SUCCESS;
233 }
234 }
235 //
236 // Search the wide glyph array
237 //
238 WidePtr = (EFI_WIDE_GLYPH *) (NarrowPtr + SimpleFont->SimpleFontPkgHdr->NumberOfNarrowGlyphs);
239 for (Index = 0; Index < SimpleFont->SimpleFontPkgHdr->NumberOfWideGlyphs; Index++) {
240 CopyMem (&Wide, WidePtr + Index, sizeof (EFI_WIDE_GLYPH));
241 if (Wide.UnicodeWeight == Char) {
242 *GlyphBuffer = (UINT8 *) AllocateZeroPool (EFI_GLYPH_HEIGHT * 2);
243 if (*GlyphBuffer == NULL) {
244 return EFI_OUT_OF_RESOURCES;
245 }
246 Cell->Width = EFI_GLYPH_WIDTH * 2;
247 Cell->Height = EFI_GLYPH_HEIGHT;
248 Cell->AdvanceX = Cell->Width;
249 CopyMem (*GlyphBuffer, Wide.GlyphCol1, EFI_GLYPH_HEIGHT);
250 CopyMem (*GlyphBuffer + EFI_GLYPH_HEIGHT, Wide.GlyphCol2, EFI_GLYPH_HEIGHT);
251 if (Attributes != NULL) {
252 *Attributes = (UINT8) (Wide.Attributes | EFI_GLYPH_WIDE);
253 }
254 return EFI_SUCCESS;
255 }
256 }
257 }
258 }
259 }
260
261 return EFI_NOT_FOUND;
262 }
263
264 /**
265 Convert bitmap data of the glyph to blt structure.
266
267 This is a internal function.
268
269 @param GlyphBuffer Buffer points to bitmap data of glyph.
270 @param Foreground The color of the "on" pixels in the glyph in the
271 bitmap.
272 @param Background The color of the "off" pixels in the glyph in the
273 bitmap.
274 @param ImageWidth Width of the whole image in pixels.
275 @param RowWidth The width of the text on the line, in pixels.
276 @param RowHeight The height of the line, in pixels.
277 @param Transparent If TRUE, the Background color is ignored and all
278 "off" pixels in the character's drawn wil use the
279 pixel value from BltBuffer.
280 @param Origin On input, points to the origin of the to be
281 displayed character, on output, points to the
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 UINT16 ImageWidth,
291 IN UINTN RowWidth,
292 IN UINTN RowHeight,
293 IN BOOLEAN Transparent,
294 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL **Origin
295 )
296 {
297 UINT8 Xpos;
298 UINT8 Ypos;
299 UINT8 Height;
300 UINT8 Width;
301 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Buffer;
302
303 ASSERT (GlyphBuffer != NULL && Origin != NULL && *Origin != NULL);
304
305 Height = EFI_GLYPH_HEIGHT;
306 Width = EFI_GLYPH_WIDTH;
307
308 //
309 // Move position to the left-top corner of char.
310 //
311 Buffer = *Origin - EFI_GLYPH_HEIGHT * ImageWidth;
312
313 //
314 // Char may be partially displayed when CLIP_X or CLIP_Y is not set.
315 //
316 if (RowHeight < Height) {
317 Height = (UINT8) RowHeight;
318 }
319 if (RowWidth < Width) {
320 Width = (UINT8) RowWidth;
321 }
322
323 for (Ypos = 0; Ypos < Height; Ypos++) {
324 for (Xpos = 0; Xpos < Width; Xpos++) {
325 if ((GlyphBuffer[Ypos] & (1 << (EFI_GLYPH_WIDTH - Xpos - 1))) != 0) {
326 Buffer[Ypos * ImageWidth + Xpos] = Foreground;
327 } else {
328 if (!Transparent) {
329 Buffer[Ypos * ImageWidth + Xpos] = Background;
330 }
331 }
332 }
333 }
334
335 *Origin = *Origin + EFI_GLYPH_WIDTH;
336 }
337
338
339 /**
340 Convert bitmap data of the glyph to blt structure.
341
342 This is a internal function.
343
344 @param GlyphBuffer Buffer points to bitmap data of glyph.
345 @param Foreground The color of the "on" pixels in the glyph in the
346 bitmap.
347 @param Background The color of the "off" pixels in the glyph in the
348 bitmap.
349 @param ImageWidth Width of the whole image in pixels.
350 @param BaseLine BaseLine in the line.
351 @param RowWidth The width of the text on the line, in pixels.
352 @param RowHeight The height of the line, in pixels.
353 @param Transparent If TRUE, the Background color is ignored and all
354 "off" pixels in the character's drawn wil use the
355 pixel value from BltBuffer.
356 @param Cell Points to EFI_HII_GLYPH_INFO structure.
357 @param Attributes The attribute of incoming glyph in GlyphBuffer.
358 @param Origin On input, points to the origin of the to be
359 displayed character, on output, points to the
360 next glyph's origin.
361
362
363 **/
364 VOID
365 GlyphToBlt (
366 IN UINT8 *GlyphBuffer,
367 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground,
368 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background,
369 IN UINT16 ImageWidth,
370 IN UINT16 BaseLine,
371 IN UINTN RowWidth,
372 IN UINTN RowHeight,
373 IN BOOLEAN Transparent,
374 IN CONST EFI_HII_GLYPH_INFO *Cell,
375 IN UINT8 Attributes,
376 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL **Origin
377 )
378 {
379 UINT16 Xpos;
380 UINT16 Ypos;
381 UINT8 Data;
382 UINT16 Index;
383 UINT16 YposOffset;
384 UINTN OffsetY;
385 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer;
386
387 ASSERT (Origin != NULL && *Origin != NULL && Cell != NULL);
388
389 //
390 // Only adjust origin position if char has no bitmap.
391 //
392 if (GlyphBuffer == NULL) {
393 *Origin = *Origin + Cell->AdvanceX;
394 return;
395 }
396 //
397 // Move position to the left-top corner of char.
398 //
399 BltBuffer = *Origin + Cell->OffsetX - (Cell->OffsetY + Cell->Height) * ImageWidth;
400 YposOffset = (UINT16) (BaseLine - (Cell->OffsetY + Cell->Height));
401
402 //
403 // Since non-spacing key will be printed OR'd with the previous glyph, don't
404 // write 0.
405 //
406 if ((Attributes & EFI_GLYPH_NON_SPACING) == EFI_GLYPH_NON_SPACING) {
407 Transparent = TRUE;
408 }
409
410 //
411 // The glyph's upper left hand corner pixel is the most significant bit of the
412 // first bitmap byte.
413 //
414 for (Ypos = 0; Ypos < Cell->Height && ((UINTN) (Ypos + YposOffset) < RowHeight); Ypos++) {
415 OffsetY = BITMAP_LEN_1_BIT (Cell->Width, Ypos);
416
417 //
418 // All bits in these bytes are meaningful.
419 //
420 for (Xpos = 0; Xpos < Cell->Width / 8; Xpos++) {
421 Data = *(GlyphBuffer + OffsetY + Xpos);
422 for (Index = 0; Index < 8 && ((UINTN) (Xpos * 8 + Index + Cell->OffsetX) < RowWidth); Index++) {
423 if ((Data & (1 << (8 - Index - 1))) != 0) {
424 BltBuffer[Ypos * ImageWidth + Xpos * 8 + Index] = Foreground;
425 } else {
426 if (!Transparent) {
427 BltBuffer[Ypos * ImageWidth + Xpos * 8 + Index] = Background;
428 }
429 }
430 }
431 }
432
433 if (Cell->Width % 8 != 0) {
434 //
435 // There are some padding bits in this byte. Ignore them.
436 //
437 Data = *(GlyphBuffer + OffsetY + Xpos);
438 for (Index = 0; Index < Cell->Width % 8 && ((UINTN) (Xpos * 8 + Index + Cell->OffsetX) < RowWidth); Index++) {
439 if ((Data & (1 << (8 - Index - 1))) != 0) {
440 BltBuffer[Ypos * ImageWidth + Xpos * 8 + Index] = Foreground;
441 } else {
442 if (!Transparent) {
443 BltBuffer[Ypos * ImageWidth + Xpos * 8 + Index] = Background;
444 }
445 }
446 }
447 } // end of if (Width % 8...)
448
449 } // end of for (Ypos=0...)
450
451 *Origin = *Origin + Cell->AdvanceX;
452 }
453
454
455 /**
456 Convert bitmap data of the glyph to blt structure.
457
458 This is a internal function.
459
460 @param GlyphBuffer Buffer points to bitmap data of glyph.
461 @param Foreground The color of the "on" pixels in the glyph in the
462 bitmap.
463 @param Background The color of the "off" pixels in the glyph in the
464 bitmap.
465 @param ImageWidth Width of the whole image in pixels.
466 @param BaseLine BaseLine in the line.
467 @param RowWidth The width of the text on the line, in pixels.
468 @param RowHeight The height of the line, in pixels.
469 @param Transparent If TRUE, the Background color is ignored and all
470 "off" pixels in the character's drawn wil use the
471 pixel value from BltBuffer.
472 @param Cell Points to EFI_HII_GLYPH_INFO structure.
473 @param Attributes The attribute of incoming glyph in GlyphBuffer.
474 @param Origin On input, points to the origin of the to be
475 displayed character, on output, points to the
476 next glyph's origin.
477
478 @return Points to the address of next origin node in BltBuffer.
479
480 **/
481 VOID
482 GlyphToImage (
483 IN UINT8 *GlyphBuffer,
484 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground,
485 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background,
486 IN UINT16 ImageWidth,
487 IN UINT16 BaseLine,
488 IN UINTN RowWidth,
489 IN UINTN RowHeight,
490 IN BOOLEAN Transparent,
491 IN CONST EFI_HII_GLYPH_INFO *Cell,
492 IN UINT8 Attributes,
493 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL **Origin
494 )
495 {
496 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Buffer;
497
498 ASSERT (Origin != NULL && *Origin != NULL && Cell != NULL);
499
500 Buffer = *Origin;
501
502 if ((Attributes & EFI_GLYPH_NON_SPACING) == EFI_GLYPH_NON_SPACING) {
503 //
504 // This character is a non-spacing key, print it OR'd with the previous glyph.
505 // without advancing cursor.
506 //
507 Buffer -= Cell->AdvanceX;
508 GlyphToBlt (
509 GlyphBuffer,
510 Foreground,
511 Background,
512 ImageWidth,
513 BaseLine,
514 RowWidth,
515 RowHeight,
516 Transparent,
517 Cell,
518 Attributes,
519 &Buffer
520 );
521
522 } else if ((Attributes & EFI_GLYPH_WIDE) == EFI_GLYPH_WIDE) {
523 //
524 // This character is wide glyph, i.e. 16 pixels * 19 pixels.
525 // Draw it as two narrow glyphs.
526 //
527 NarrowGlyphToBlt (
528 GlyphBuffer,
529 Foreground,
530 Background,
531 ImageWidth,
532 RowWidth,
533 RowHeight,
534 Transparent,
535 Origin
536 );
537
538 NarrowGlyphToBlt (
539 GlyphBuffer + EFI_GLYPH_HEIGHT,
540 Foreground,
541 Background,
542 ImageWidth,
543 RowWidth,
544 RowHeight,
545 Transparent,
546 Origin
547 );
548
549 } else if ((Attributes & NARROW_GLYPH) == NARROW_GLYPH) {
550 //
551 // This character is narrow glyph, i.e. 8 pixels * 19 pixels.
552 //
553 NarrowGlyphToBlt (
554 GlyphBuffer,
555 Foreground,
556 Background,
557 ImageWidth,
558 RowWidth,
559 RowHeight,
560 Transparent,
561 Origin
562 );
563
564 } else if ((Attributes & PROPORTIONAL_GLYPH) == PROPORTIONAL_GLYPH) {
565 //
566 // This character is proportional glyph, i.e. Cell->Width * Cell->Height pixels.
567 //
568 GlyphToBlt (
569 GlyphBuffer,
570 Foreground,
571 Background,
572 ImageWidth,
573 BaseLine,
574 RowWidth,
575 RowHeight,
576 Transparent,
577 Cell,
578 Attributes,
579 Origin
580 );
581 }
582 }
583
584
585 /**
586 Write the output parameters of FindGlyphBlock().
587
588 This is a internal function.
589
590 @param BufferIn Buffer which stores the bitmap data of the found
591 block.
592 @param BufferLen Length of BufferIn.
593 @param InputCell Buffer which stores cell information of the
594 encoded bitmap.
595 @param GlyphBuffer Output the corresponding bitmap data of the found
596 block. It is the caller's responsiblity to free
597 this buffer.
598 @param Cell Output cell information of the encoded bitmap.
599 @param GlyphBufferLen If not NULL, output the length of GlyphBuffer.
600
601 @retval EFI_SUCCESS The operation is performed successfully.
602 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
603 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
604 task.
605
606 **/
607 EFI_STATUS
608 WriteOutputParam (
609 IN UINT8 *BufferIn,
610 IN UINTN BufferLen,
611 IN EFI_HII_GLYPH_INFO *InputCell,
612 OUT UINT8 **GlyphBuffer, OPTIONAL
613 OUT EFI_HII_GLYPH_INFO *Cell, OPTIONAL
614 OUT UINTN *GlyphBufferLen OPTIONAL
615 )
616 {
617 if (BufferIn == NULL || InputCell == NULL) {
618 return EFI_INVALID_PARAMETER;
619 }
620
621 if (Cell != NULL) {
622 CopyMem (Cell, InputCell, sizeof (EFI_HII_GLYPH_INFO));
623 }
624
625 if (GlyphBuffer != NULL && BufferLen > 0) {
626 *GlyphBuffer = (UINT8 *) AllocateZeroPool (BufferLen);
627 if (*GlyphBuffer == NULL) {
628 return EFI_OUT_OF_RESOURCES;
629 }
630 CopyMem (*GlyphBuffer, BufferIn, BufferLen);
631 }
632
633 if (GlyphBufferLen != NULL) {
634 *GlyphBufferLen = BufferLen;
635 }
636
637 return EFI_SUCCESS;
638 }
639
640
641 /**
642 Parse all glyph blocks to find a glyph block specified by CharValue.
643 If CharValue = (CHAR16) (-1), collect all default character cell information
644 within this font package and backup its information.
645
646 @param FontPackage Hii string package instance.
647 @param CharValue Unicode character value, which identifies a glyph
648 block.
649 @param GlyphBuffer Output the corresponding bitmap data of the found
650 block. It is the caller's responsiblity to free
651 this buffer.
652 @param Cell Output cell information of the encoded bitmap.
653 @param GlyphBufferLen If not NULL, output the length of GlyphBuffer.
654
655 @retval EFI_SUCCESS The bitmap data is retrieved successfully.
656 @retval EFI_NOT_FOUND The specified CharValue does not exist in current
657 database.
658 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
659 task.
660
661 **/
662 EFI_STATUS
663 FindGlyphBlock (
664 IN HII_FONT_PACKAGE_INSTANCE *FontPackage,
665 IN CHAR16 CharValue,
666 OUT UINT8 **GlyphBuffer, OPTIONAL
667 OUT EFI_HII_GLYPH_INFO *Cell, OPTIONAL
668 OUT UINTN *GlyphBufferLen OPTIONAL
669 )
670 {
671 EFI_STATUS Status;
672 UINT8 *BlockPtr;
673 UINT16 CharCurrent;
674 UINT16 Length16;
675 UINT32 Length32;
676 EFI_HII_GIBT_GLYPHS_BLOCK Glyphs;
677 UINTN BufferLen;
678 UINT16 Index;
679 EFI_HII_GLYPH_INFO DefaultCell;
680 EFI_HII_GLYPH_INFO LocalCell;
681 INT16 MinOffsetY;
682 UINT16 BaseLine;
683
684 ASSERT (FontPackage != NULL);
685 ASSERT (FontPackage->Signature == HII_FONT_PACKAGE_SIGNATURE);
686 BaseLine = 0;
687 MinOffsetY = 0;
688
689 if (CharValue == (CHAR16) (-1)) {
690 //
691 // Collect the cell information specified in font package fixed header.
692 // Use CharValue =0 to represent this particular cell.
693 //
694 Status = NewCell (
695 0,
696 &FontPackage->GlyphInfoList,
697 (EFI_HII_GLYPH_INFO *) ((UINT8 *) FontPackage->FontPkgHdr + 3 * sizeof (UINT32))
698 );
699 if (EFI_ERROR (Status)) {
700 return Status;
701 }
702 CopyMem (
703 &LocalCell,
704 (UINT8 *) FontPackage->FontPkgHdr + 3 * sizeof (UINT32),
705 sizeof (EFI_HII_GLYPH_INFO)
706 );
707 BaseLine = (UINT16) (LocalCell.Height + LocalCell.OffsetY);
708 if (MinOffsetY > LocalCell.OffsetY) {
709 MinOffsetY = LocalCell.OffsetY;
710 }
711 }
712
713 BlockPtr = FontPackage->GlyphBlock;
714 CharCurrent = 1;
715 BufferLen = 0;
716
717 while (*BlockPtr != EFI_HII_GIBT_END) {
718 switch (*BlockPtr) {
719 case EFI_HII_GIBT_DEFAULTS:
720 //
721 // Collect all default character cell information specified by
722 // EFI_HII_GIBT_DEFAULTS.
723 //
724 if (CharValue == (CHAR16) (-1)) {
725 Status = NewCell (
726 CharCurrent,
727 &FontPackage->GlyphInfoList,
728 (EFI_HII_GLYPH_INFO *) (BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK))
729 );
730 if (EFI_ERROR (Status)) {
731 return Status;
732 }
733 CopyMem (
734 &LocalCell,
735 BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK),
736 sizeof (EFI_HII_GLYPH_INFO)
737 );
738 if (BaseLine < LocalCell.Height + LocalCell.OffsetY) {
739 BaseLine = (UINT16) (LocalCell.Height + LocalCell.OffsetY);
740 }
741 if (MinOffsetY > LocalCell.OffsetY) {
742 MinOffsetY = LocalCell.OffsetY;
743 }
744 }
745 BlockPtr += sizeof (EFI_HII_GIBT_DEFAULTS_BLOCK);
746 break;
747
748 case EFI_HII_GIBT_DUPLICATE:
749 if (CharCurrent == CharValue) {
750 CopyMem (&CharValue, BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK), sizeof (CHAR16));
751 CharCurrent = 1;
752 BlockPtr = FontPackage->GlyphBlock;
753 continue;
754 }
755 CharCurrent++;
756 BlockPtr += sizeof (EFI_HII_GIBT_DUPLICATE_BLOCK);
757 break;
758
759 case EFI_HII_GIBT_EXT1:
760 BlockPtr += *(UINT8*)((UINTN)BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK) + sizeof (UINT8));
761 break;
762 case EFI_HII_GIBT_EXT2:
763 CopyMem (
764 &Length16,
765 (UINT8*)((UINTN)BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK) + sizeof (UINT8)),
766 sizeof (UINT16)
767 );
768 BlockPtr += Length16;
769 break;
770 case EFI_HII_GIBT_EXT4:
771 CopyMem (
772 &Length32,
773 (UINT8*)((UINTN)BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK) + sizeof (UINT8)),
774 sizeof (UINT32)
775 );
776 BlockPtr += Length32;
777 break;
778
779 case EFI_HII_GIBT_GLYPH:
780 CopyMem (
781 &LocalCell,
782 BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK),
783 sizeof (EFI_HII_GLYPH_INFO)
784 );
785 if (CharValue == (CHAR16) (-1)) {
786 if (BaseLine < LocalCell.Height + LocalCell.OffsetY) {
787 BaseLine = (UINT16) (LocalCell.Height + LocalCell.OffsetY);
788 }
789 if (MinOffsetY > LocalCell.OffsetY) {
790 MinOffsetY = LocalCell.OffsetY;
791 }
792 }
793 BufferLen = BITMAP_LEN_1_BIT (LocalCell.Width, LocalCell.Height);
794 if (CharCurrent == CharValue) {
795 return WriteOutputParam (
796 (UINT8*)((UINTN)BlockPtr + sizeof (EFI_HII_GIBT_GLYPH_BLOCK) - sizeof (UINT8)),
797 BufferLen,
798 &LocalCell,
799 GlyphBuffer,
800 Cell,
801 GlyphBufferLen
802 );
803 }
804 CharCurrent++;
805 BlockPtr += sizeof (EFI_HII_GIBT_GLYPH_BLOCK) - sizeof (UINT8) + BufferLen;
806 break;
807
808 case EFI_HII_GIBT_GLYPHS:
809 BlockPtr += sizeof (EFI_HII_GLYPH_BLOCK);
810 CopyMem (&Glyphs.Cell, BlockPtr, sizeof (EFI_HII_GLYPH_INFO));
811 BlockPtr += sizeof (EFI_HII_GLYPH_INFO);
812 CopyMem (&Glyphs.Count, BlockPtr, sizeof (UINT16));
813 BlockPtr += sizeof (UINT16);
814
815 if (CharValue == (CHAR16) (-1)) {
816 if (BaseLine < Glyphs.Cell.Height + Glyphs.Cell.OffsetY) {
817 BaseLine = (UINT16) (Glyphs.Cell.Height + Glyphs.Cell.OffsetY);
818 }
819 if (MinOffsetY > Glyphs.Cell.OffsetY) {
820 MinOffsetY = Glyphs.Cell.OffsetY;
821 }
822 }
823
824 BufferLen = BITMAP_LEN_1_BIT (Glyphs.Cell.Width, Glyphs.Cell.Height);
825 for (Index = 0; Index < Glyphs.Count; Index++) {
826 if (CharCurrent + Index == CharValue) {
827 return WriteOutputParam (
828 BlockPtr,
829 BufferLen,
830 &Glyphs.Cell,
831 GlyphBuffer,
832 Cell,
833 GlyphBufferLen
834 );
835 }
836 BlockPtr += BufferLen;
837 }
838 CharCurrent = (UINT16) (CharCurrent + Glyphs.Count);
839 break;
840
841 case EFI_HII_GIBT_GLYPH_DEFAULT:
842 Status = GetCell (CharCurrent, &FontPackage->GlyphInfoList, &DefaultCell);
843 if (EFI_ERROR (Status)) {
844 return Status;
845 }
846 BufferLen = BITMAP_LEN_1_BIT (DefaultCell.Width, DefaultCell.Height);
847
848 if (CharCurrent == CharValue) {
849 return WriteOutputParam (
850 BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK),
851 BufferLen,
852 &DefaultCell,
853 GlyphBuffer,
854 Cell,
855 GlyphBufferLen
856 );
857 }
858 CharCurrent++;
859 BlockPtr += sizeof (EFI_HII_GLYPH_BLOCK) + BufferLen;
860 break;
861
862 case EFI_HII_GIBT_GLYPHS_DEFAULT:
863 CopyMem (&Length16, BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK), sizeof (UINT16));
864 Status = GetCell (CharCurrent, &FontPackage->GlyphInfoList, &DefaultCell);
865 if (EFI_ERROR (Status)) {
866 return Status;
867 }
868 BufferLen = BITMAP_LEN_1_BIT (DefaultCell.Width, DefaultCell.Height);
869 BlockPtr += sizeof (EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK) - sizeof (UINT8);
870 for (Index = 0; Index < Length16; Index++) {
871 if (CharCurrent + Index == CharValue) {
872 return WriteOutputParam (
873 BlockPtr,
874 BufferLen,
875 &DefaultCell,
876 GlyphBuffer,
877 Cell,
878 GlyphBufferLen
879 );
880 }
881 BlockPtr += BufferLen;
882 }
883 CharCurrent = (UINT16) (CharCurrent + Length16);
884 break;
885
886 case EFI_HII_GIBT_SKIP1:
887 CharCurrent = (UINT16) (CharCurrent + (UINT16) (*(BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK))));
888 BlockPtr += sizeof (EFI_HII_GIBT_SKIP1_BLOCK);
889 break;
890 case EFI_HII_GIBT_SKIP2:
891 CopyMem (&Length16, BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK), sizeof (UINT16));
892 CharCurrent = (UINT16) (CharCurrent + Length16);
893 BlockPtr += sizeof (EFI_HII_GIBT_SKIP2_BLOCK);
894 break;
895 default:
896 ASSERT (FALSE);
897 break;
898 }
899
900 if (CharValue < CharCurrent) {
901 return EFI_NOT_FOUND;
902 }
903 }
904
905 if (CharValue == (CHAR16) (-1)) {
906 FontPackage->BaseLine = BaseLine;
907 FontPackage->Height = (UINT16) (BaseLine - MinOffsetY);
908 return EFI_SUCCESS;
909 }
910
911 return EFI_NOT_FOUND;
912 }
913
914
915 /**
916 Copy a Font Name to a new created EFI_FONT_INFO structure.
917
918 This is a internal function.
919
920 @param FontName NULL-terminated string.
921 @param FontInfo a new EFI_FONT_INFO which stores the FontName.
922 It's caller's responsibility to free this buffer.
923
924 @retval EFI_SUCCESS FontInfo is allocated and copied with FontName.
925 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
926 task.
927
928 **/
929 EFI_STATUS
930 SaveFontName (
931 IN EFI_STRING FontName,
932 OUT EFI_FONT_INFO **FontInfo
933 )
934 {
935 UINTN FontInfoLen;
936
937 ASSERT (FontName != NULL && FontInfo != NULL);
938
939 FontInfoLen = sizeof (EFI_FONT_INFO) - sizeof (CHAR16) + StrSize (FontName);
940 *FontInfo = (EFI_FONT_INFO *) AllocateZeroPool (FontInfoLen);
941 if (*FontInfo == NULL) {
942 return EFI_OUT_OF_RESOURCES;
943 }
944
945 StrCpy ((*FontInfo)->FontName, FontName);
946 return EFI_SUCCESS;
947 }
948
949
950 /**
951 Retrieve system default font and color.
952
953 @param Private HII database driver private data.
954 @param FontInfo Points to system default font output-related
955 information. It's caller's responsibility to free
956 this buffer.
957 @param FontInfoSize If not NULL, output the size of buffer FontInfo.
958
959 @retval EFI_SUCCESS Cell information is added to the GlyphInfoList.
960 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
961 task.
962 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
963
964 **/
965 EFI_STATUS
966 GetSystemFont (
967 IN HII_DATABASE_PRIVATE_DATA *Private,
968 OUT EFI_FONT_DISPLAY_INFO **FontInfo,
969 OUT UINTN *FontInfoSize OPTIONAL
970 )
971 {
972 EFI_FONT_DISPLAY_INFO *Info;
973 UINTN InfoSize;
974
975 if (Private == NULL || Private->Signature != HII_DATABASE_PRIVATE_DATA_SIGNATURE) {
976 return EFI_INVALID_PARAMETER;
977 }
978 if (FontInfo == NULL) {
979 return EFI_INVALID_PARAMETER;
980 }
981
982 //
983 // The standard font always has the name "sysdefault".
984 //
985 InfoSize = sizeof (EFI_FONT_DISPLAY_INFO) - sizeof (CHAR16) + StrSize (L"sysdefault");
986 Info = (EFI_FONT_DISPLAY_INFO *) AllocateZeroPool (InfoSize);
987 if (Info == NULL) {
988 return EFI_OUT_OF_RESOURCES;
989 }
990
991 Info->ForegroundColor = mHiiEfiColors[Private->Attribute & 0x0f];
992 Info->BackgroundColor = mHiiEfiColors[Private->Attribute >> 4];
993 Info->FontInfoMask = EFI_FONT_INFO_SYS_FONT | EFI_FONT_INFO_SYS_SIZE | EFI_FONT_INFO_SYS_STYLE;
994 Info->FontInfo.FontStyle = 0;
995 Info->FontInfo.FontSize = EFI_GLYPH_HEIGHT;
996 StrCpy (Info->FontInfo.FontName, L"sysdefault");
997
998 *FontInfo = Info;
999 if (FontInfoSize != NULL) {
1000 *FontInfoSize = InfoSize;
1001 }
1002 return EFI_SUCCESS;
1003 }
1004
1005
1006 /**
1007 Check whether EFI_FONT_DISPLAY_INFO points to system default font and color or
1008 returns the system default according to the optional inputs.
1009
1010 This is a internal function.
1011
1012 @param Private HII database driver private data.
1013 @param StringInfo Points to the string output information,
1014 including the color and font.
1015 @param SystemInfo If not NULL, points to system default font and color.
1016
1017 @param SystemInfoLen If not NULL, output the length of default system
1018 info.
1019
1020 @retval TRUE Yes, it points to system default.
1021 @retval FALSE No.
1022
1023 **/
1024 BOOLEAN
1025 IsSystemFontInfo (
1026 IN HII_DATABASE_PRIVATE_DATA *Private,
1027 IN EFI_FONT_DISPLAY_INFO *StringInfo,
1028 OUT EFI_FONT_DISPLAY_INFO **SystemInfo, OPTIONAL
1029 OUT UINTN *SystemInfoLen OPTIONAL
1030 )
1031 {
1032 EFI_STATUS Status;
1033 EFI_FONT_DISPLAY_INFO *SystemDefault;
1034 UINTN DefaultLen;
1035 BOOLEAN Flag;
1036
1037 ASSERT (Private != NULL && Private->Signature == HII_DATABASE_PRIVATE_DATA_SIGNATURE);
1038
1039 if (StringInfo == NULL && SystemInfo == NULL) {
1040 return TRUE;
1041 }
1042
1043 SystemDefault = NULL;
1044 DefaultLen = 0;
1045
1046 Status = GetSystemFont (Private, &SystemDefault, &DefaultLen);
1047 ASSERT_EFI_ERROR (Status);
1048 ASSERT ((SystemDefault != NULL) && (DefaultLen != 0));
1049
1050 //
1051 // Record the system default info.
1052 //
1053 if (SystemInfo != NULL) {
1054 *SystemInfo = SystemDefault;
1055 }
1056
1057 if (SystemInfoLen != NULL) {
1058 *SystemInfoLen = DefaultLen;
1059 }
1060
1061 if (StringInfo == NULL) {
1062 return TRUE;
1063 }
1064
1065 Flag = FALSE;
1066 //
1067 // Check the FontInfoMask to see whether it is retrieving system info.
1068 //
1069 if ((StringInfo->FontInfoMask & (EFI_FONT_INFO_SYS_FONT | EFI_FONT_INFO_ANY_FONT)) == 0) {
1070 if (StrCmp (StringInfo->FontInfo.FontName, SystemDefault->FontInfo.FontName) != 0) {
1071 goto Exit;
1072 }
1073 }
1074 if ((StringInfo->FontInfoMask & (EFI_FONT_INFO_SYS_SIZE | EFI_FONT_INFO_ANY_SIZE)) == 0) {
1075 if (StringInfo->FontInfo.FontSize != SystemDefault->FontInfo.FontSize) {
1076 goto Exit;
1077 }
1078 }
1079 if ((StringInfo->FontInfoMask & (EFI_FONT_INFO_SYS_STYLE | EFI_FONT_INFO_ANY_STYLE)) == 0) {
1080 if (StringInfo->FontInfo.FontStyle != SystemDefault->FontInfo.FontStyle) {
1081 goto Exit;
1082 }
1083 }
1084 if ((StringInfo->FontInfoMask & EFI_FONT_INFO_SYS_FORE_COLOR) == 0) {
1085 if (CompareMem (
1086 &StringInfo->ForegroundColor,
1087 &SystemDefault->ForegroundColor,
1088 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
1089 ) != 0) {
1090 goto Exit;
1091 }
1092 }
1093 if ((StringInfo->FontInfoMask & EFI_FONT_INFO_SYS_BACK_COLOR) == 0) {
1094 if (CompareMem (
1095 &StringInfo->BackgroundColor,
1096 &SystemDefault->BackgroundColor,
1097 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
1098 ) != 0) {
1099 goto Exit;
1100 }
1101 }
1102
1103 Flag = TRUE;
1104
1105 Exit:
1106 if (SystemInfo == NULL) {
1107 if (SystemDefault != NULL) {
1108 FreePool (SystemDefault);
1109 }
1110 }
1111 return Flag;
1112 }
1113
1114
1115 /**
1116 This function checks whether EFI_FONT_INFO exists in current database. If
1117 FontInfoMask is specified, check what options can be used to make a match.
1118 Note that the masks relate to where the system default should be supplied
1119 are ignored by this function.
1120
1121 @param Private Hii database private structure.
1122 @param FontInfo Points to EFI_FONT_INFO structure.
1123 @param FontInfoMask If not NULL, describes what options can be used
1124 to make a match between the font requested and
1125 the font available. The caller must guarantee
1126 this mask is valid.
1127 @param FontHandle On entry, Points to the font handle returned by a
1128 previous call to GetFontInfo() or NULL to start
1129 with the first font.
1130 @param GlobalFontInfo If not NULL, output the corresponding globa font
1131 info.
1132
1133 @retval TRUE Existed
1134 @retval FALSE Not existed
1135
1136 **/
1137 BOOLEAN
1138 IsFontInfoExisted (
1139 IN HII_DATABASE_PRIVATE_DATA *Private,
1140 IN EFI_FONT_INFO *FontInfo,
1141 IN EFI_FONT_INFO_MASK *FontInfoMask, OPTIONAL
1142 IN EFI_FONT_HANDLE FontHandle, OPTIONAL
1143 OUT HII_GLOBAL_FONT_INFO **GlobalFontInfo OPTIONAL
1144 )
1145 {
1146 HII_GLOBAL_FONT_INFO *GlobalFont;
1147 HII_GLOBAL_FONT_INFO *GlobalFontBackup1;
1148 HII_GLOBAL_FONT_INFO *GlobalFontBackup2;
1149 LIST_ENTRY *Link;
1150 EFI_FONT_INFO_MASK Mask;
1151 BOOLEAN Matched;
1152 BOOLEAN VagueMatched1;
1153 BOOLEAN VagueMatched2;
1154
1155 ASSERT (Private != NULL && Private->Signature == HII_DATABASE_PRIVATE_DATA_SIGNATURE);
1156 ASSERT (FontInfo != NULL);
1157
1158 //
1159 // Matched flag represents an exactly match; VagueMatched1 repensents a RESIZE
1160 // or RESTYLE match; VagueMatched2 represents a RESIZE | RESTYLE match.
1161 //
1162 Matched = FALSE;
1163 VagueMatched1 = FALSE;
1164 VagueMatched2 = FALSE;
1165
1166 Mask = 0;
1167 GlobalFontBackup1 = NULL;
1168 GlobalFontBackup2 = NULL;
1169
1170 // The process of where the system default should be supplied instead of
1171 // the specified font info beyonds this function's scope.
1172 //
1173 if (FontInfoMask != NULL) {
1174 Mask = *FontInfoMask & (~SYS_FONT_INFO_MASK);
1175 }
1176
1177 //
1178 // If not NULL, FontHandle points to the next node of the last searched font
1179 // node by previous call.
1180 //
1181 if (FontHandle == NULL) {
1182 Link = Private->FontInfoList.ForwardLink;
1183 } else {
1184 Link = (LIST_ENTRY *) FontHandle;
1185 }
1186
1187 for (; Link != &Private->FontInfoList; Link = Link->ForwardLink) {
1188 GlobalFont = CR (Link, HII_GLOBAL_FONT_INFO, Entry, HII_GLOBAL_FONT_INFO_SIGNATURE);
1189 if (FontInfoMask == NULL) {
1190 if (CompareMem (GlobalFont->FontInfo, FontInfo, GlobalFont->FontInfoSize) == 0) {
1191 if (GlobalFontInfo != NULL) {
1192 *GlobalFontInfo = GlobalFont;
1193 }
1194 return TRUE;
1195 }
1196 } else {
1197 //
1198 // Check which options could be used to make a match.
1199 //
1200 switch (Mask) {
1201 case EFI_FONT_INFO_ANY_FONT:
1202 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle &&
1203 GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1204 Matched = TRUE;
1205 }
1206 break;
1207 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_ANY_STYLE:
1208 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1209 Matched = TRUE;
1210 }
1211 break;
1212 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_ANY_SIZE:
1213 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1214 Matched = TRUE;
1215 }
1216 break;
1217 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_ANY_SIZE | EFI_FONT_INFO_ANY_STYLE:
1218 Matched = TRUE;
1219 break;
1220 //
1221 // If EFI_FONT_INFO_RESTYLE is specified, then the system may attempt to
1222 // remove some of the specified styles to meet the style requested.
1223 //
1224 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_RESTYLE:
1225 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1226 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1227 Matched = TRUE;
1228 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {
1229 VagueMatched1 = TRUE;
1230 GlobalFontBackup1 = GlobalFont;
1231 }
1232 }
1233 break;
1234 //
1235 // If EFI_FONT_INFO_RESIZE is specified, then the sytem may attempt to
1236 // stretch or shrink a font to meet the size requested.
1237 //
1238 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_RESIZE:
1239 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1240 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1241 Matched = TRUE;
1242 } else {
1243 VagueMatched1 = TRUE;
1244 GlobalFontBackup1 = GlobalFont;
1245 }
1246 }
1247 break;
1248 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_RESTYLE | EFI_FONT_INFO_RESIZE:
1249 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1250 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1251 Matched = TRUE;
1252 } else {
1253 VagueMatched1 = TRUE;
1254 GlobalFontBackup1 = GlobalFont;
1255 }
1256 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {
1257 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1258 VagueMatched1 = TRUE;
1259 GlobalFontBackup1 = GlobalFont;
1260 } else {
1261 VagueMatched2 = TRUE;
1262 GlobalFontBackup2 = GlobalFont;
1263 }
1264 }
1265 break;
1266 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_ANY_STYLE | EFI_FONT_INFO_RESIZE:
1267 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1268 Matched = TRUE;
1269 } else {
1270 VagueMatched1 = TRUE;
1271 GlobalFontBackup1 = GlobalFont;
1272 }
1273 break;
1274 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_ANY_SIZE | EFI_FONT_INFO_RESTYLE:
1275 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1276 Matched = TRUE;
1277 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {
1278 VagueMatched1 = TRUE;
1279 GlobalFontBackup1 = GlobalFont;
1280 }
1281 break;
1282 case EFI_FONT_INFO_ANY_STYLE:
1283 if ((CompareMem (
1284 GlobalFont->FontInfo->FontName,
1285 FontInfo->FontName,
1286 StrSize (FontInfo->FontName)
1287 ) == 0) &&
1288 GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1289 Matched = TRUE;
1290 }
1291 break;
1292 case EFI_FONT_INFO_ANY_STYLE | EFI_FONT_INFO_ANY_SIZE:
1293 if (CompareMem (
1294 GlobalFont->FontInfo->FontName,
1295 FontInfo->FontName,
1296 StrSize (FontInfo->FontName)
1297 ) == 0) {
1298 Matched = TRUE;
1299 }
1300 break;
1301 case EFI_FONT_INFO_ANY_STYLE | EFI_FONT_INFO_RESIZE:
1302 if (CompareMem (
1303 GlobalFont->FontInfo->FontName,
1304 FontInfo->FontName,
1305 StrSize (FontInfo->FontName)
1306 ) == 0) {
1307 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1308 Matched = TRUE;
1309 } else {
1310 VagueMatched1 = TRUE;
1311 GlobalFontBackup1 = GlobalFont;
1312 }
1313 }
1314 break;
1315 case EFI_FONT_INFO_ANY_SIZE:
1316 if ((CompareMem (
1317 GlobalFont->FontInfo->FontName,
1318 FontInfo->FontName,
1319 StrSize (FontInfo->FontName)
1320 ) == 0) &&
1321 GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1322 Matched = TRUE;
1323 }
1324 break;
1325 case EFI_FONT_INFO_ANY_SIZE | EFI_FONT_INFO_RESTYLE:
1326 if (CompareMem (
1327 GlobalFont->FontInfo->FontName,
1328 FontInfo->FontName,
1329 StrSize (FontInfo->FontName)
1330 ) == 0) {
1331 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1332 Matched = TRUE;
1333 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {
1334 VagueMatched1 = TRUE;
1335 GlobalFontBackup1 = GlobalFont;
1336 }
1337 }
1338 break;
1339 case EFI_FONT_INFO_RESTYLE:
1340 if ((CompareMem (
1341 GlobalFont->FontInfo->FontName,
1342 FontInfo->FontName,
1343 StrSize (FontInfo->FontName)
1344 ) == 0) &&
1345 GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1346
1347 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1348 Matched = TRUE;
1349 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {
1350 VagueMatched1 = TRUE;
1351 GlobalFontBackup1 = GlobalFont;
1352 }
1353 }
1354 break;
1355 case EFI_FONT_INFO_RESIZE:
1356 if ((CompareMem (
1357 GlobalFont->FontInfo->FontName,
1358 FontInfo->FontName,
1359 StrSize (FontInfo->FontName)
1360 ) == 0) &&
1361 GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1362
1363 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1364 Matched = TRUE;
1365 } else {
1366 VagueMatched1 = TRUE;
1367 GlobalFontBackup1 = GlobalFont;
1368 }
1369 }
1370 break;
1371 case EFI_FONT_INFO_RESIZE | EFI_FONT_INFO_RESTYLE:
1372 if (CompareMem (
1373 GlobalFont->FontInfo->FontName,
1374 FontInfo->FontName,
1375 StrSize (FontInfo->FontName)
1376 ) == 0) {
1377 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {
1378 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1379 Matched = TRUE;
1380 } else {
1381 VagueMatched1 = TRUE;
1382 GlobalFontBackup1 = GlobalFont;
1383 }
1384 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {
1385 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {
1386 VagueMatched1 = TRUE;
1387 GlobalFontBackup1 = GlobalFont;
1388 } else {
1389 VagueMatched2 = TRUE;
1390 GlobalFontBackup2 = GlobalFont;
1391 }
1392 }
1393 }
1394 break;
1395 default:
1396 break;
1397 }
1398
1399 if (Matched) {
1400 if (GlobalFontInfo != NULL) {
1401 *GlobalFontInfo = GlobalFont;
1402 }
1403 return TRUE;
1404 }
1405 }
1406 }
1407
1408 if (VagueMatched1) {
1409 if (GlobalFontInfo != NULL) {
1410 *GlobalFontInfo = GlobalFontBackup1;
1411 }
1412 return TRUE;
1413 } else if (VagueMatched2) {
1414 if (GlobalFontInfo != NULL) {
1415 *GlobalFontInfo = GlobalFontBackup2;
1416 }
1417 return TRUE;
1418 }
1419
1420 return FALSE;
1421 }
1422
1423
1424 /**
1425 Check whether the unicode represents a line break or not.
1426
1427 This is a internal function. Please see Section 27.2.6 of the UEFI Specification
1428 for a description of the supported string format.
1429
1430 @param Char Unicode character
1431
1432 @retval 0 Yes, it forces a line break.
1433 @retval 1 Yes, it presents a line break opportunity
1434 @retval 2 Yes, it requires a line break happen before and after it.
1435 @retval -1 No, it is not a link break.
1436
1437 **/
1438 INT8
1439 IsLineBreak (
1440 IN CHAR16 Char
1441 )
1442 {
1443 switch (Char) {
1444 //
1445 // Mandatory line break characters, which force a line-break
1446 //
1447 case 0x000A:
1448 case 0x000C:
1449 case 0x000D:
1450 case 0x2028:
1451 case 0x2029:
1452 return 0;
1453 //
1454 // Space characters, which is taken as a line-break opportunity
1455 //
1456 case 0x0020:
1457 case 0x1680:
1458 case 0x2000:
1459 case 0x2001:
1460 case 0x2002:
1461 case 0x2003:
1462 case 0x2004:
1463 case 0x2005:
1464 case 0x2006:
1465 case 0x2008:
1466 case 0x2009:
1467 case 0x200A:
1468 case 0x205F:
1469 //
1470 // In-Word Break Opportunities
1471 //
1472 case 0x200B:
1473 return 1;
1474 //
1475 // A space which is not a line-break opportunity
1476 //
1477 case 0x00A0:
1478 case 0x202F:
1479 //
1480 // A hyphen which is not a line-break opportunity
1481 //
1482 case 0x2011:
1483 return -1;
1484 //
1485 // Hyphen characters which describe line break opportunities after the character
1486 //
1487 case 0x058A:
1488 case 0x2010:
1489 case 0x2012:
1490 case 0x2013:
1491 case 0x0F0B:
1492 case 0x1361:
1493 case 0x17D5:
1494 return 1;
1495 //
1496 // A hyphen which describes line break opportunities before and after them, but not between a pair of them
1497 //
1498 case 0x2014:
1499 return 2;
1500 }
1501 return -1;
1502 }
1503
1504
1505 /**
1506 Renders a string to a bitmap or to the display.
1507
1508 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
1509 @param Flags Describes how the string is to be drawn.
1510 @param String Points to the null-terminated string to be
1511 displayed.
1512 @param StringInfo Points to the string output information,
1513 including the color and font. If NULL, then the
1514 string will be output in the default system font
1515 and color.
1516 @param Blt If this points to a non-NULL on entry, this
1517 points to the image, which is Width pixels wide
1518 and Height pixels high. The string will be drawn
1519 onto this image and
1520 EFI_HII_OUT_FLAG_CLIP is implied. If this points
1521 to a NULL on entry, then a buffer
1522 will be allocated to hold the generated image and
1523 the pointer updated on exit. It is the caller's
1524 responsibility to free this buffer.
1525 @param BltX Specifies the offset from the left and top edge
1526 of the image of the first character cell in the
1527 image.
1528 @param BltY Specifies the offset from the left and top edge
1529 of the image of the first character cell in the
1530 image.
1531 @param RowInfoArray If this is non-NULL on entry, then on exit, this
1532 will point to an allocated buffer containing
1533 row information and RowInfoArraySize will be
1534 updated to contain the number of elements.
1535 This array describes the characters which were at
1536 least partially drawn and the heights of the
1537 rows. It is the caller's responsibility to free
1538 this buffer.
1539 @param RowInfoArraySize If this is non-NULL on entry, then on exit it
1540 contains the number of elements in RowInfoArray.
1541 @param ColumnInfoArray If this is non-NULL, then on return it will be
1542 filled with the horizontal offset for each
1543 character in the string on the row where it is
1544 displayed. Non-printing characters will have
1545 the offset ~0. The caller is responsible to
1546 allocate a buffer large enough so that there
1547 is one entry for each character in the string,
1548 not including the null-terminator. It is possible
1549 when character display is normalized that some
1550 character cells overlap.
1551
1552 @retval EFI_SUCCESS The string was successfully rendered.
1553 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
1554 RowInfoArray or Blt.
1555 @retval EFI_INVALID_PARAMETER The String or Blt was NULL.
1556 @retval EFI_INVALID_PARAMETER Flags were invalid combination..
1557
1558 **/
1559 EFI_STATUS
1560 EFIAPI
1561 HiiStringToImage (
1562 IN CONST EFI_HII_FONT_PROTOCOL *This,
1563 IN EFI_HII_OUT_FLAGS Flags,
1564 IN CONST EFI_STRING String,
1565 IN CONST EFI_FONT_DISPLAY_INFO *StringInfo OPTIONAL,
1566 IN OUT EFI_IMAGE_OUTPUT **Blt,
1567 IN UINTN BltX,
1568 IN UINTN BltY,
1569 OUT EFI_HII_ROW_INFO **RowInfoArray OPTIONAL,
1570 OUT UINTN *RowInfoArraySize OPTIONAL,
1571 OUT UINTN *ColumnInfoArray OPTIONAL
1572 )
1573 {
1574 EFI_STATUS Status;
1575 HII_DATABASE_PRIVATE_DATA *Private;
1576 UINT8 **GlyphBuf;
1577 EFI_HII_GLYPH_INFO *Cell;
1578 UINT8 *Attributes;
1579 EFI_IMAGE_OUTPUT *Image;
1580 EFI_STRING StringPtr;
1581 EFI_STRING StringTmp;
1582 EFI_HII_ROW_INFO *RowInfo;
1583 UINTN LineWidth;
1584 UINTN LineHeight;
1585 UINTN LineOffset;
1586 UINTN LastLineHeight;
1587 UINTN BaseLineOffset;
1588 UINT16 MaxRowNum;
1589 UINT16 RowIndex;
1590 UINTN Index;
1591 UINTN NextIndex;
1592 UINTN Index1;
1593 EFI_FONT_DISPLAY_INFO *StringInfoOut;
1594 EFI_FONT_DISPLAY_INFO *SystemDefault;
1595 EFI_FONT_HANDLE FontHandle;
1596 EFI_STRING StringIn;
1597 EFI_STRING StringIn2;
1598 UINT16 Height;
1599 UINT16 BaseLine;
1600 EFI_FONT_INFO *FontInfo;
1601 BOOLEAN SysFontFlag;
1602 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground;
1603 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background;
1604 BOOLEAN Transparent;
1605 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer;
1606 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BufferPtr;
1607 UINTN RowInfoSize;
1608 BOOLEAN LineBreak;
1609 UINTN StrLength;
1610 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *RowBufferPtr;
1611 HII_GLOBAL_FONT_INFO *GlobalFont;
1612
1613 //
1614 // Check incoming parameters.
1615 //
1616
1617 if (This == NULL || String == NULL || Blt == NULL) {
1618 return EFI_INVALID_PARAMETER;
1619 }
1620 if (*Blt == NULL) {
1621 //
1622 // These two flag cannot be used if Blt is NULL upon entry.
1623 //
1624 if ((Flags & EFI_HII_OUT_FLAG_TRANSPARENT) == EFI_HII_OUT_FLAG_TRANSPARENT) {
1625 return EFI_INVALID_PARAMETER;
1626 }
1627 if ((Flags & EFI_HII_OUT_FLAG_CLIP) == EFI_HII_OUT_FLAG_CLIP) {
1628 return EFI_INVALID_PARAMETER;
1629 }
1630 }
1631 //
1632 // These two flags require that EFI_HII_OUT_FLAG_CLIP be also set.
1633 //
1634 if ((Flags & (EFI_HII_OUT_FLAG_CLIP | EFI_HII_OUT_FLAG_CLIP_CLEAN_X)) == EFI_HII_OUT_FLAG_CLIP_CLEAN_X) {
1635 return EFI_INVALID_PARAMETER;
1636 }
1637 if ((Flags & (EFI_HII_OUT_FLAG_CLIP | EFI_HII_OUT_FLAG_CLIP_CLEAN_Y)) == EFI_HII_OUT_FLAG_CLIP_CLEAN_Y) {
1638 return EFI_INVALID_PARAMETER;
1639 }
1640 //
1641 // This flag cannot be used with EFI_HII_OUT_FLAG_CLEAN_X.
1642 //
1643 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)) {
1644 return EFI_INVALID_PARAMETER;
1645 }
1646
1647 if (*Blt == NULL) {
1648 //
1649 // Create a new bitmap and draw the string onto this image.
1650 //
1651 Image = AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT));
1652 if (Image == NULL) {
1653 return EFI_OUT_OF_RESOURCES;
1654 }
1655 Image->Width = 800;
1656 Image->Height = 600;
1657 Image->Image.Bitmap = AllocateZeroPool (Image->Width * Image->Height *sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
1658 if (Image->Image.Bitmap == NULL) {
1659 FreePool (Image);
1660 return EFI_OUT_OF_RESOURCES;
1661 }
1662
1663 //
1664 // Other flags are not permitted when Blt is NULL.
1665 //
1666 Flags &= EFI_HII_OUT_FLAG_WRAP | EFI_HII_IGNORE_IF_NO_GLYPH | EFI_HII_IGNORE_LINE_BREAK;
1667 *Blt = Image;
1668 }
1669
1670 StrLength = StrLen(String);
1671 GlyphBuf = (UINT8 **) AllocateZeroPool (StrLength * sizeof (UINT8 *));
1672 ASSERT (GlyphBuf != NULL);
1673 Cell = (EFI_HII_GLYPH_INFO *) AllocateZeroPool (StrLength * sizeof (EFI_HII_GLYPH_INFO));
1674 ASSERT (Cell != NULL);
1675 Attributes = (UINT8 *) AllocateZeroPool (StrLength * sizeof (UINT8));
1676 ASSERT (Attributes != NULL);
1677
1678 RowInfo = NULL;
1679 Status = EFI_SUCCESS;
1680 StringIn2 = NULL;
1681 SystemDefault = NULL;
1682 StringIn = NULL;
1683
1684 //
1685 // Calculate the string output information, including specified color and font .
1686 // If StringInfo does not points to system font info, it must indicate an existing
1687 // EFI_FONT_INFO.
1688 //
1689 StringInfoOut = NULL;
1690 FontHandle = NULL;
1691 Private = HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This);
1692 SysFontFlag = IsSystemFontInfo (Private, (EFI_FONT_DISPLAY_INFO *) StringInfo, &SystemDefault, NULL);
1693
1694 if (SysFontFlag) {
1695 ASSERT (SystemDefault != NULL);
1696 FontInfo = NULL;
1697 Height = SystemDefault->FontInfo.FontSize;
1698 BaseLine = SystemDefault->FontInfo.FontSize;
1699 Foreground = SystemDefault->ForegroundColor;
1700 Background = SystemDefault->BackgroundColor;
1701
1702 } else {
1703 //
1704 // StringInfo must not be NULL if it is not system info.
1705 //
1706 ASSERT (StringInfo != NULL);
1707 Status = HiiGetFontInfo (This, &FontHandle, (EFI_FONT_DISPLAY_INFO *) StringInfo, &StringInfoOut, NULL);
1708 if (Status == EFI_NOT_FOUND) {
1709 //
1710 // The specified EFI_FONT_DISPLAY_INFO does not exist in current database.
1711 // Use the system font instead. Still use the color specified by StringInfo.
1712 //
1713 SysFontFlag = TRUE;
1714 FontInfo = NULL;
1715 Height = SystemDefault->FontInfo.FontSize;
1716 BaseLine = SystemDefault->FontInfo.FontSize;
1717 Foreground = ((EFI_FONT_DISPLAY_INFO *) StringInfo)->ForegroundColor;
1718 Background = ((EFI_FONT_DISPLAY_INFO *) StringInfo)->BackgroundColor;
1719
1720 } else if (Status == EFI_SUCCESS) {
1721 FontInfo = &StringInfoOut->FontInfo;
1722 IsFontInfoExisted (Private, FontInfo, NULL, NULL, &GlobalFont);
1723 Height = GlobalFont->FontPackage->Height;
1724 BaseLine = GlobalFont->FontPackage->BaseLine;
1725 Foreground = StringInfoOut->ForegroundColor;
1726 Background = StringInfoOut->BackgroundColor;
1727 } else {
1728 goto Exit;
1729 }
1730 }
1731
1732 //
1733 // Use the maxinum height of font as the base line.
1734 // And, use the maxinum height as line height.
1735 //
1736 LineHeight = Height;
1737 LastLineHeight = Height;
1738 BaseLineOffset = Height - BaseLine;
1739
1740 //
1741 // Parse the string to be displayed to drop some ignored characters.
1742 //
1743
1744 StringPtr = String;
1745
1746 //
1747 // Ignore line-break characters only. Hyphens or dash character will be displayed
1748 // without line-break opportunity.
1749 //
1750 if ((Flags & EFI_HII_IGNORE_LINE_BREAK) == EFI_HII_IGNORE_LINE_BREAK) {
1751 StringIn = AllocateZeroPool (StrSize (StringPtr));
1752 if (StringIn == NULL) {
1753 Status = EFI_OUT_OF_RESOURCES;
1754 goto Exit;
1755 }
1756 StringTmp = StringIn;
1757 while (*StringPtr != 0) {
1758 if (IsLineBreak (*StringPtr) == 0) {
1759 StringPtr++;
1760 } else {
1761 *StringTmp++ = *StringPtr++;
1762 }
1763 }
1764 *StringTmp = 0;
1765 StringPtr = StringIn;
1766 }
1767 //
1768 // If EFI_HII_IGNORE_IF_NO_GLYPH is set, then characters which have no glyphs
1769 // are not drawn. Otherwise they are replaced wth Unicode character 0xFFFD.
1770 //
1771 StringIn2 = AllocateZeroPool (StrSize (StringPtr));
1772 if (StringIn2 == NULL) {
1773 Status = EFI_OUT_OF_RESOURCES;
1774 goto Exit;
1775 }
1776 Index = 0;
1777 StringTmp = StringIn2;
1778 StrLength = StrLen(StringPtr);
1779 while (*StringPtr != 0 && Index < StrLength) {
1780 if (IsLineBreak (*StringPtr) == 0) {
1781 *StringTmp++ = *StringPtr++;
1782 Index++;
1783 continue;
1784 }
1785
1786 Status = GetGlyphBuffer (Private, *StringPtr, FontInfo, &GlyphBuf[Index], &Cell[Index], &Attributes[Index]);
1787 if (Status == EFI_NOT_FOUND) {
1788 if ((Flags & EFI_HII_IGNORE_IF_NO_GLYPH) == EFI_HII_IGNORE_IF_NO_GLYPH) {
1789 GlyphBuf[Index] = NULL;
1790 ZeroMem (&Cell[Index], sizeof (Cell[Index]));
1791 Status = EFI_SUCCESS;
1792 } else {
1793 //
1794 // Unicode 0xFFFD must exist in current hii database if this flag is not set.
1795 //
1796 Status = GetGlyphBuffer (
1797 Private,
1798 REPLACE_UNKNOWN_GLYPH,
1799 FontInfo,
1800 &GlyphBuf[Index],
1801 &Cell[Index],
1802 &Attributes[Index]
1803 );
1804 if (EFI_ERROR (Status)) {
1805 Status = EFI_INVALID_PARAMETER;
1806 }
1807 }
1808 }
1809
1810 if (EFI_ERROR (Status)) {
1811 goto Exit;
1812 }
1813
1814 *StringTmp++ = *StringPtr++;
1815 Index++;
1816 }
1817 *StringTmp = 0;
1818 StringPtr = StringIn2;
1819
1820 //
1821 // Draw the string according to the specified EFI_HII_OUT_FLAGS and Blt.
1822 // If Blt is not NULL, then EFI_HII_OUT_FLAG_CLIP is implied, render this string
1823 // to an existing image (bitmap or screen depending on flags) pointed by "*Blt".
1824 // Otherwise render this string to a new allocated image and output it.
1825 //
1826 Image = *Blt;
1827 BufferPtr = Image->Image.Bitmap + Image->Width * BltY + BltX;
1828 if (Image->Height < BltY) {
1829 //
1830 // the top edge of the image should be in Image resolution scope.
1831 //
1832 Status = EFI_INVALID_PARAMETER;
1833 goto Exit;
1834 }
1835 MaxRowNum = (UINT16) ((Image->Height - BltY) / Height);
1836 if ((Image->Height - BltY) % Height != 0) {
1837 LastLineHeight = (Image->Height - BltY) % Height;
1838 MaxRowNum++;
1839 }
1840
1841 RowInfo = (EFI_HII_ROW_INFO *) AllocateZeroPool (MaxRowNum * sizeof (EFI_HII_ROW_INFO));
1842 if (RowInfo == NULL) {
1843 Status = EFI_OUT_OF_RESOURCES;
1844 goto Exit;
1845 }
1846
1847 //
1848 // Format the glyph buffer according to flags.
1849 //
1850 Transparent = (BOOLEAN) ((Flags & EFI_HII_OUT_FLAG_TRANSPARENT) == EFI_HII_OUT_FLAG_TRANSPARENT ? TRUE : FALSE);
1851
1852 for (RowIndex = 0, Index = 0; RowIndex < MaxRowNum && StringPtr[Index] != 0; ) {
1853 LineWidth = 0;
1854 LineBreak = FALSE;
1855
1856 //
1857 // Clip the final row if the row's bottom-most on pixel cannot fit when
1858 // EFI_HII_OUT_FLAG_CLEAN_Y is set.
1859 //
1860 if (RowIndex == MaxRowNum - 1) {
1861 if ((Flags & EFI_HII_OUT_FLAG_CLIP_CLEAN_Y) == EFI_HII_OUT_FLAG_CLIP_CLEAN_Y && LastLineHeight < LineHeight ) {
1862 //
1863 // Don't draw at all if the row's bottom-most on pixel cannot fit.
1864 //
1865 break;
1866 }
1867 LineHeight = LastLineHeight;
1868 }
1869
1870 //
1871 // Calculate how many characters there are in a row.
1872 //
1873 RowInfo[RowIndex].StartIndex = Index;
1874
1875 while (LineWidth + BltX < Image->Width && StringPtr[Index] != 0) {
1876 if ((Flags & EFI_HII_IGNORE_LINE_BREAK) == 0 &&
1877 IsLineBreak (StringPtr[Index]) == 0) {
1878 //
1879 // It forces a line break that ends this row.
1880 //
1881 Index++;
1882 LineBreak = TRUE;
1883 break;
1884 }
1885
1886 //
1887 // If the glyph of the character is existing, then accumulate the actual printed width
1888 //
1889 LineWidth += (UINTN) Cell[Index].AdvanceX;
1890
1891 Index++;
1892 }
1893
1894 //
1895 // Record index of next char.
1896 //
1897 NextIndex = Index;
1898 //
1899 // Return to the previous char.
1900 //
1901 Index--;
1902 if (LineBreak && Index > 0 ) {
1903 //
1904 // Return the previous non line break char.
1905 //
1906 Index --;
1907 }
1908
1909 //
1910 // If this character is the last character of a row, we need not
1911 // draw its (AdvanceX - Width - OffsetX) for next character.
1912 //
1913 LineWidth -= (UINTN) (Cell[Index].AdvanceX - Cell[Index].Width - Cell[Index].OffsetX);
1914
1915 //
1916 // Clip the right-most character if cannot fit when EFI_HII_OUT_FLAG_CLEAN_X is set.
1917 //
1918 if (LineWidth + BltX <= Image->Width ||
1919 (LineWidth + BltX > Image->Width && (Flags & EFI_HII_OUT_FLAG_CLIP_CLEAN_X) == 0)) {
1920 //
1921 // Record right-most character in RowInfo even if it is partially displayed.
1922 //
1923 RowInfo[RowIndex].EndIndex = Index;
1924 RowInfo[RowIndex].LineWidth = LineWidth;
1925 RowInfo[RowIndex].LineHeight = LineHeight;
1926 RowInfo[RowIndex].BaselineOffset = BaseLineOffset;
1927 } else {
1928 //
1929 // When EFI_HII_OUT_FLAG_CLEAN_X is set, it will not draw a character
1930 // if its right-most on pixel cannot fit.
1931 //
1932 if (Index > RowInfo[RowIndex].StartIndex) {
1933 //
1934 // Don't draw the last char on this row. And, don't draw the second last char (AdvanceX - Width - OffsetX).
1935 //
1936 LineWidth -= (UINTN) (Cell[Index].Width + Cell[Index].OffsetX);
1937 LineWidth -= (UINTN) (Cell[Index - 1].AdvanceX - Cell[Index - 1].Width - Cell[Index - 1].OffsetX);
1938 RowInfo[RowIndex].EndIndex = Index - 1;
1939 RowInfo[RowIndex].LineWidth = LineWidth;
1940 RowInfo[RowIndex].LineHeight = LineHeight;
1941 RowInfo[RowIndex].BaselineOffset = BaseLineOffset;
1942 } else {
1943 //
1944 // There is no enough column to draw any character, so set current line width to zero.
1945 // And go to draw Next line if LineBreak is set.
1946 //
1947 RowInfo[RowIndex].LineWidth = 0;
1948 goto NextLine;
1949 }
1950 }
1951
1952 //
1953 // EFI_HII_OUT_FLAG_WRAP will wrap the text at the right-most line-break
1954 // opportunity prior to a character whose right-most extent would exceed Width.
1955 // Search the right-most line-break opportunity here.
1956 //
1957 if ((Flags & EFI_HII_OUT_FLAG_WRAP) == EFI_HII_OUT_FLAG_WRAP &&
1958 (RowInfo[RowIndex].LineWidth + BltX > Image->Width || StringPtr[NextIndex] != 0) &&
1959 !LineBreak) {
1960 if ((Flags & EFI_HII_IGNORE_LINE_BREAK) == 0) {
1961 LineWidth = RowInfo[RowIndex].LineWidth;
1962 for (Index1 = RowInfo[RowIndex].EndIndex; Index1 >= RowInfo[RowIndex].StartIndex; Index1--) {
1963 if (Index1 == RowInfo[RowIndex].EndIndex) {
1964 LineWidth -= (Cell[Index1].Width + Cell[Index1].OffsetX);
1965 } else {
1966 LineWidth -= Cell[Index1].AdvanceX;
1967 }
1968 if (IsLineBreak (StringPtr[Index1]) > 0) {
1969 LineBreak = TRUE;
1970 if (Index1 > RowInfo[RowIndex].StartIndex) {
1971 RowInfo[RowIndex].EndIndex = Index1 - 1;
1972 }
1973 //
1974 // relocate to the character after the right-most line break opportunity of this line
1975 //
1976 NextIndex = Index1 + 1;
1977 break;
1978 }
1979 //
1980 // If don't find a line break opportunity from EndIndex to StartIndex,
1981 // then jump out.
1982 //
1983 if (Index1 == RowInfo[RowIndex].StartIndex)
1984 break;
1985 }
1986
1987 //
1988 // Update LineWidth to the real width
1989 //
1990 if (IsLineBreak (StringPtr[Index1]) > 0) {
1991 if (Index1 == RowInfo[RowIndex].StartIndex) {
1992 LineWidth = 0;
1993 } else {
1994 LineWidth -= (UINTN) (Cell[Index1 - 1].AdvanceX - Cell[Index1 - 1].Width - Cell[Index1 - 1].OffsetX);
1995 }
1996 RowInfo[RowIndex].LineWidth = LineWidth;
1997 }
1998 }
1999 //
2000 // If no line-break opportunity can be found, then the text will
2001 // behave as if EFI_HII_OUT_FLAG_CLEAN_X is set.
2002 //
2003 if (!LineBreak) {
2004 LineWidth = RowInfo[RowIndex].LineWidth;
2005 Index1 = RowInfo[RowIndex].EndIndex;
2006 if (LineWidth + BltX > Image->Width) {
2007 if (Index1 > RowInfo[RowIndex].StartIndex) {
2008 //
2009 // Don't draw the last char on this row. And, don't draw the second last char (AdvanceX - Width - OffsetX).
2010 //
2011 LineWidth -= (UINTN) (Cell[Index1].Width + Cell[Index1].OffsetX);
2012 LineWidth -= (UINTN) (Cell[Index1 - 1].AdvanceX - Cell[Index1 - 1].Width - Cell[Index1 - 1].OffsetX);
2013 RowInfo[RowIndex].EndIndex = Index1 - 1;
2014 RowInfo[RowIndex].LineWidth = LineWidth;
2015 } else {
2016 //
2017 // There is no enough column to draw any character, so set current line width to zero.
2018 // And go to draw Next line if LineBreak is set.
2019 //
2020 RowInfo[RowIndex].LineWidth = 0;
2021 goto NextLine;
2022 }
2023 }
2024 }
2025 }
2026
2027 //
2028 // LineWidth can't exceed Image width.
2029 //
2030 if (RowInfo[RowIndex].LineWidth + BltX > Image->Width) {
2031 RowInfo[RowIndex].LineWidth = Image->Width - BltX;
2032 }
2033
2034 //
2035 // Draw it to screen or existing bitmap depending on whether
2036 // EFI_HII_DIRECT_TO_SCREEN is set.
2037 //
2038 LineOffset = 0;
2039 if ((Flags & EFI_HII_DIRECT_TO_SCREEN) == EFI_HII_DIRECT_TO_SCREEN) {
2040 BltBuffer = NULL;
2041 if (RowInfo[RowIndex].LineWidth != 0) {
2042 BltBuffer = AllocateZeroPool (RowInfo[RowIndex].LineWidth * RowInfo[RowIndex].LineHeight * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
2043 if (BltBuffer == NULL) {
2044 Status = EFI_OUT_OF_RESOURCES;
2045 goto Exit;
2046 }
2047 //
2048 // Set BufferPtr to Origin by adding baseline to the starting position.
2049 //
2050 BufferPtr = BltBuffer + BaseLine * RowInfo[RowIndex].LineWidth;
2051 }
2052 for (Index1 = RowInfo[RowIndex].StartIndex; Index1 <= RowInfo[RowIndex].EndIndex; Index1++) {
2053 if (RowInfo[RowIndex].LineWidth > 0 && RowInfo[RowIndex].LineWidth > LineOffset) {
2054 //
2055 // Only BLT these character which have corrsponding glyph in font basebase.
2056 //
2057 GlyphToImage (
2058 GlyphBuf[Index1],
2059 Foreground,
2060 Background,
2061 (UINT16) RowInfo[RowIndex].LineWidth,
2062 BaseLine,
2063 RowInfo[RowIndex].LineWidth - LineOffset,
2064 RowInfo[RowIndex].LineHeight,
2065 Transparent,
2066 &Cell[Index1],
2067 Attributes[Index1],
2068 &BufferPtr
2069 );
2070 }
2071 if (ColumnInfoArray != NULL) {
2072 if ((GlyphBuf[Index1] == NULL && Cell[Index1].AdvanceX == 0)
2073 || RowInfo[RowIndex].LineWidth == 0) {
2074 *ColumnInfoArray = (UINTN) ~0;
2075 } else {
2076 *ColumnInfoArray = LineOffset + Cell[Index1].OffsetX + BltX;
2077 }
2078 ColumnInfoArray++;
2079 }
2080 LineOffset += Cell[Index1].AdvanceX;
2081 }
2082
2083 if (BltBuffer != NULL) {
2084 Status = Image->Image.Screen->Blt (
2085 Image->Image.Screen,
2086 BltBuffer,
2087 EfiBltBufferToVideo,
2088 0,
2089 0,
2090 BltX,
2091 BltY,
2092 RowInfo[RowIndex].LineWidth,
2093 RowInfo[RowIndex].LineHeight,
2094 0
2095 );
2096 if (EFI_ERROR (Status)) {
2097 FreePool (BltBuffer);
2098 goto Exit;
2099 }
2100
2101 FreePool (BltBuffer);
2102 }
2103 } else {
2104 //
2105 // Save the starting position for calculate the starting postition of next row.
2106 //
2107 RowBufferPtr = BufferPtr;
2108 //
2109 // Set BufferPtr to Origin by adding baseline to the starting position.
2110 //
2111 BufferPtr = BufferPtr + BaseLine * Image->Width;
2112 for (Index1 = RowInfo[RowIndex].StartIndex; Index1 <= RowInfo[RowIndex].EndIndex; Index1++) {
2113 if (RowInfo[RowIndex].LineWidth > 0 && RowInfo[RowIndex].LineWidth > LineOffset) {
2114 //
2115 // Only BLT these character which have corrsponding glyph in font basebase.
2116 //
2117 GlyphToImage (
2118 GlyphBuf[Index1],
2119 Foreground,
2120 Background,
2121 Image->Width,
2122 BaseLine,
2123 RowInfo[RowIndex].LineWidth - LineOffset,
2124 RowInfo[RowIndex].LineHeight,
2125 Transparent,
2126 &Cell[Index1],
2127 Attributes[Index1],
2128 &BufferPtr
2129 );
2130 }
2131 if (ColumnInfoArray != NULL) {
2132 if ((GlyphBuf[Index1] == NULL && Cell[Index1].AdvanceX == 0)
2133 || RowInfo[RowIndex].LineWidth == 0) {
2134 *ColumnInfoArray = (UINTN) ~0;
2135 } else {
2136 *ColumnInfoArray = LineOffset + Cell[Index1].OffsetX + BltX;
2137 }
2138 ColumnInfoArray++;
2139 }
2140 LineOffset += Cell[Index1].AdvanceX;
2141 }
2142
2143 //
2144 // Jump to starting position of next row.
2145 //
2146 if (RowIndex == 0) {
2147 BufferPtr = RowBufferPtr - BltX + LineHeight * Image->Width;
2148 } else {
2149 BufferPtr = RowBufferPtr + LineHeight * Image->Width;
2150 }
2151 }
2152
2153 NextLine:
2154 //
2155 // Recalculate the start point of X/Y axis to draw multi-lines with the order of top-to-down
2156 //
2157 BltX = 0;
2158 BltY += RowInfo[RowIndex].LineHeight;
2159
2160 RowIndex++;
2161 Index = NextIndex;
2162
2163 if (!LineBreak) {
2164 //
2165 // If there is not a mandatory line break or line break opportunity, only render one line to image
2166 //
2167 break;
2168 }
2169 }
2170
2171 //
2172 // Write output parameters.
2173 //
2174 RowInfoSize = RowIndex * sizeof (EFI_HII_ROW_INFO);
2175 if (RowInfoArray != NULL) {
2176 if (RowInfoSize > 0) {
2177 *RowInfoArray = AllocateZeroPool (RowInfoSize);
2178 if (*RowInfoArray == NULL) {
2179 Status = EFI_OUT_OF_RESOURCES;
2180 goto Exit;
2181 }
2182 CopyMem (*RowInfoArray, RowInfo, RowInfoSize);
2183 } else {
2184 *RowInfoArray = NULL;
2185 }
2186 }
2187 if (RowInfoArraySize != NULL) {
2188 *RowInfoArraySize = RowIndex;
2189 }
2190
2191 Status = EFI_SUCCESS;
2192
2193 Exit:
2194
2195 for (Index = 0; Index < StrLength; Index++) {
2196 if (GlyphBuf[Index] != NULL) {
2197 FreePool (GlyphBuf[Index]);
2198 }
2199 }
2200 if (StringIn != NULL) {
2201 FreePool (StringIn);
2202 }
2203 if (StringIn2 != NULL) {
2204 FreePool (StringIn2);
2205 }
2206 if (StringInfoOut != NULL) {
2207 FreePool (StringInfoOut);
2208 }
2209 if (RowInfo != NULL) {
2210 FreePool (RowInfo);
2211 }
2212 if (SystemDefault != NULL) {
2213 FreePool (SystemDefault);
2214 }
2215 if (GlyphBuf != NULL) {
2216 FreePool (GlyphBuf);
2217 }
2218 if (Cell != NULL) {
2219 FreePool (Cell);
2220 }
2221 if (Attributes != NULL) {
2222 FreePool (Attributes);
2223 }
2224
2225 return Status;
2226 }
2227
2228
2229 /**
2230 Render a string to a bitmap or the screen containing the contents of the specified string.
2231
2232 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
2233 @param Flags Describes how the string is to be drawn.
2234 @param PackageList The package list in the HII database to search
2235 for the specified string.
2236 @param StringId The string's id, which is unique within
2237 PackageList.
2238 @param Language Points to the language for the retrieved string.
2239 If NULL, then the current system language is
2240 used.
2241 @param StringInfo Points to the string output information,
2242 including the color and font. If NULL, then the
2243 string will be output in the default system font
2244 and color.
2245 @param Blt If this points to a non-NULL on entry, this
2246 points to the image, which is Width pixels wide
2247 and Height pixels high. The string will be drawn
2248 onto this image and
2249 EFI_HII_OUT_FLAG_CLIP is implied. If this points
2250 to a NULL on entry, then a buffer
2251 will be allocated to hold the generated image and
2252 the pointer updated on exit. It is the caller's
2253 responsibility to free this buffer.
2254 @param BltX Specifies the offset from the left and top edge
2255 of the image of the first character cell in the
2256 image.
2257 @param BltY Specifies the offset from the left and top edge
2258 of the image of the first character cell in the
2259 image.
2260 @param RowInfoArray If this is non-NULL on entry, then on exit, this
2261 will point to an allocated buffer containing
2262 row information and RowInfoArraySize will be
2263 updated to contain the number of elements.
2264 This array describes the characters which were at
2265 least partially drawn and the heights of the
2266 rows. It is the caller's responsibility to free
2267 this buffer.
2268 @param RowInfoArraySize If this is non-NULL on entry, then on exit it
2269 contains the number of elements in RowInfoArray.
2270 @param ColumnInfoArray If this is non-NULL, then on return it will be
2271 filled with the horizontal offset for each
2272 character in the string on the row where it is
2273 displayed. Non-printing characters will have
2274 the offset ~0. The caller is responsible to
2275 allocate a buffer large enough so that there
2276 is one entry for each character in the string,
2277 not including the null-terminator. It is possible
2278 when character display is normalized that some
2279 character cells overlap.
2280
2281 @retval EFI_SUCCESS The string was successfully rendered.
2282 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
2283 RowInfoArray or Blt.
2284 @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.
2285 @retval EFI_INVALID_PARAMETER Flags were invalid combination.
2286 @retval EFI_NOT_FOUND The specified PackageList is not in the Database or the stringid is not
2287 in the specified PackageList.
2288
2289 **/
2290 EFI_STATUS
2291 EFIAPI
2292 HiiStringIdToImage (
2293 IN CONST EFI_HII_FONT_PROTOCOL *This,
2294 IN EFI_HII_OUT_FLAGS Flags,
2295 IN EFI_HII_HANDLE PackageList,
2296 IN EFI_STRING_ID StringId,
2297 IN CONST CHAR8* Language,
2298 IN CONST EFI_FONT_DISPLAY_INFO *StringInfo OPTIONAL,
2299 IN OUT EFI_IMAGE_OUTPUT **Blt,
2300 IN UINTN BltX,
2301 IN UINTN BltY,
2302 OUT EFI_HII_ROW_INFO **RowInfoArray OPTIONAL,
2303 OUT UINTN *RowInfoArraySize OPTIONAL,
2304 OUT UINTN *ColumnInfoArray OPTIONAL
2305 )
2306 {
2307 EFI_STATUS Status;
2308 HII_DATABASE_PRIVATE_DATA *Private;
2309 EFI_HII_STRING_PROTOCOL *HiiString;
2310 EFI_STRING String;
2311 UINTN StringSize;
2312 UINTN FontLen;
2313 EFI_FONT_INFO *StringFontInfo;
2314 EFI_FONT_DISPLAY_INFO *NewStringInfo;
2315 CHAR8 TempSupportedLanguages;
2316 CHAR8 *SupportedLanguages;
2317 UINTN SupportedLanguagesSize;
2318 CHAR8 *CurrentLanguage;
2319 CHAR8 *BestLanguage;
2320
2321 if (This == NULL || PackageList == NULL || Blt == NULL || PackageList == NULL) {
2322 return EFI_INVALID_PARAMETER;
2323 }
2324
2325 if (!IsHiiHandleValid (PackageList)) {
2326 return EFI_NOT_FOUND;
2327 }
2328
2329 //
2330 // Initialize string pointers to be NULL
2331 //
2332 SupportedLanguages = NULL;
2333 CurrentLanguage = NULL;
2334 BestLanguage = NULL;
2335 String = NULL;
2336 StringFontInfo = NULL;
2337 NewStringInfo = NULL;
2338
2339 //
2340 // Get the string to be displayed.
2341 //
2342 Private = HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This);
2343 HiiString = &Private->HiiString;
2344
2345 //
2346 // Get the size of supported language.
2347 //
2348 SupportedLanguagesSize = 0;
2349 Status = HiiString->GetLanguages (
2350 HiiString,
2351 PackageList,
2352 &TempSupportedLanguages,
2353 &SupportedLanguagesSize
2354 );
2355 if (Status != EFI_BUFFER_TOO_SMALL) {
2356 return Status;
2357 }
2358
2359 SupportedLanguages = AllocatePool (SupportedLanguagesSize);
2360 if (SupportedLanguages == NULL) {
2361 return EFI_OUT_OF_RESOURCES;
2362 }
2363
2364 Status = HiiString->GetLanguages (
2365 HiiString,
2366 PackageList,
2367 SupportedLanguages,
2368 &SupportedLanguagesSize
2369 );
2370 if (EFI_ERROR (Status)) {
2371 goto Exit;
2372 }
2373
2374 if (Language == NULL) {
2375 Language = "";
2376 }
2377 GetEfiGlobalVariable2 (L"PlatformLang", (VOID**)&CurrentLanguage, NULL);
2378 BestLanguage = GetBestLanguage (
2379 SupportedLanguages,
2380 FALSE,
2381 Language,
2382 (CurrentLanguage == NULL) ? CurrentLanguage : "",
2383 (CHAR8 *) PcdGetPtr (PcdUefiVariableDefaultPlatformLang),
2384 NULL
2385 );
2386 if (BestLanguage == NULL) {
2387 Status = EFI_NOT_FOUND;
2388 goto Exit;
2389 }
2390
2391 StringSize = MAX_STRING_LENGTH;
2392 String = (EFI_STRING) AllocateZeroPool (StringSize);
2393 if (String == NULL) {
2394 Status = EFI_OUT_OF_RESOURCES;
2395 goto Exit;
2396 }
2397
2398 Status = HiiString->GetString (
2399 HiiString,
2400 BestLanguage,
2401 PackageList,
2402 StringId,
2403 String,
2404 &StringSize,
2405 &StringFontInfo
2406 );
2407 if (Status == EFI_BUFFER_TOO_SMALL) {
2408 FreePool (String);
2409 String = (EFI_STRING) AllocateZeroPool (StringSize);
2410 if (String == NULL) {
2411 Status = EFI_OUT_OF_RESOURCES;
2412 goto Exit;
2413 }
2414 Status = HiiString->GetString (
2415 HiiString,
2416 BestLanguage,
2417 PackageList,
2418 StringId,
2419 String,
2420 &StringSize,
2421 NULL
2422 );
2423 }
2424
2425 if (EFI_ERROR (Status)) {
2426 goto Exit;
2427 }
2428
2429 //
2430 // When StringInfo specifies that string will be output in the system default font and color,
2431 // use particular stringfontinfo described in string package instead if exists.
2432 // StringFontInfo equals NULL means system default font attaches with the string block.
2433 //
2434 if (StringFontInfo != NULL && IsSystemFontInfo (Private, (EFI_FONT_DISPLAY_INFO *) StringInfo, NULL, NULL)) {
2435 FontLen = sizeof (EFI_FONT_DISPLAY_INFO) - sizeof (CHAR16) + StrSize (StringFontInfo->FontName);
2436 NewStringInfo = AllocateZeroPool (FontLen);
2437 if (NewStringInfo == NULL) {
2438 Status = EFI_OUT_OF_RESOURCES;
2439 goto Exit;
2440 }
2441 NewStringInfo->FontInfoMask = EFI_FONT_INFO_SYS_FORE_COLOR | EFI_FONT_INFO_SYS_BACK_COLOR;
2442 NewStringInfo->FontInfo.FontStyle = StringFontInfo->FontStyle;
2443 NewStringInfo->FontInfo.FontSize = StringFontInfo->FontSize;
2444 StrCpy (NewStringInfo->FontInfo.FontName, StringFontInfo->FontName);
2445
2446 Status = HiiStringToImage (
2447 This,
2448 Flags,
2449 String,
2450 NewStringInfo,
2451 Blt,
2452 BltX,
2453 BltY,
2454 RowInfoArray,
2455 RowInfoArraySize,
2456 ColumnInfoArray
2457 );
2458 goto Exit;
2459 }
2460
2461 Status = HiiStringToImage (
2462 This,
2463 Flags,
2464 String,
2465 StringInfo,
2466 Blt,
2467 BltX,
2468 BltY,
2469 RowInfoArray,
2470 RowInfoArraySize,
2471 ColumnInfoArray
2472 );
2473
2474 Exit:
2475 if (SupportedLanguages != NULL) {
2476 FreePool (SupportedLanguages);
2477 }
2478 if (CurrentLanguage != NULL) {
2479 FreePool (CurrentLanguage);
2480 }
2481 if (BestLanguage != NULL) {
2482 FreePool (BestLanguage);
2483 }
2484 if (String != NULL) {
2485 FreePool (String);
2486 }
2487 if (StringFontInfo != NULL) {
2488 FreePool (StringFontInfo);
2489 }
2490 if (NewStringInfo != NULL) {
2491 FreePool (NewStringInfo);
2492 }
2493
2494 return Status;
2495 }
2496
2497
2498 /**
2499 Convert the glyph for a single character into a bitmap.
2500
2501 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
2502 @param Char Character to retrieve.
2503 @param StringInfo Points to the string font and color information
2504 or NULL if the string should use the default
2505 system font and color.
2506 @param Blt Thus must point to a NULL on entry. A buffer will
2507 be allocated to hold the output and the pointer
2508 updated on exit. It is the caller's
2509 responsibility to free this buffer.
2510 @param Baseline Number of pixels from the bottom of the bitmap to
2511 the baseline.
2512
2513 @retval EFI_SUCCESS Glyph bitmap created.
2514 @retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer Blt.
2515 @retval EFI_WARN_UNKNOWN_GLYPH The glyph was unknown and was replaced with the
2516 glyph for Unicode character 0xFFFD.
2517 @retval EFI_INVALID_PARAMETER Blt is NULL or *Blt is not NULL.
2518
2519 **/
2520 EFI_STATUS
2521 EFIAPI
2522 HiiGetGlyph (
2523 IN CONST EFI_HII_FONT_PROTOCOL *This,
2524 IN CHAR16 Char,
2525 IN CONST EFI_FONT_DISPLAY_INFO *StringInfo,
2526 OUT EFI_IMAGE_OUTPUT **Blt,
2527 OUT UINTN *Baseline OPTIONAL
2528 )
2529 {
2530 EFI_STATUS Status;
2531 HII_DATABASE_PRIVATE_DATA *Private;
2532 EFI_IMAGE_OUTPUT *Image;
2533 UINT8 *GlyphBuffer;
2534 EFI_FONT_DISPLAY_INFO *SystemDefault;
2535 EFI_FONT_DISPLAY_INFO *StringInfoOut;
2536 BOOLEAN Default;
2537 EFI_FONT_HANDLE FontHandle;
2538 EFI_STRING String;
2539 EFI_HII_GLYPH_INFO Cell;
2540 EFI_FONT_INFO *FontInfo;
2541 UINT8 Attributes;
2542 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground;
2543 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background;
2544 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer;
2545 UINT16 BaseLine;
2546
2547 if (This == NULL || Blt == NULL || *Blt != NULL) {
2548 return EFI_INVALID_PARAMETER;
2549 }
2550
2551 Private = HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This);
2552
2553 Default = FALSE;
2554 Image = NULL;
2555 SystemDefault = NULL;
2556 FontHandle = NULL;
2557 String = NULL;
2558 GlyphBuffer = NULL;
2559 StringInfoOut = NULL;
2560 FontInfo = NULL;
2561
2562 ZeroMem (&Foreground, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
2563 ZeroMem (&Background, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
2564
2565 Default = IsSystemFontInfo (Private, (EFI_FONT_DISPLAY_INFO *) StringInfo, &SystemDefault, NULL);
2566
2567 if (!Default) {
2568 //
2569 // Find out a EFI_FONT_DISPLAY_INFO which could display the character in
2570 // the specified color and font.
2571 //
2572 String = (EFI_STRING) AllocateZeroPool (sizeof (CHAR16) * 2);
2573 if (String == NULL) {
2574 Status = EFI_OUT_OF_RESOURCES;
2575 goto Exit;
2576 }
2577 *String = Char;
2578 *(String + 1) = 0;
2579
2580 Status = HiiGetFontInfo (This, &FontHandle, StringInfo, &StringInfoOut, String);
2581 if (EFI_ERROR (Status)) {
2582 goto Exit;
2583 }
2584 ASSERT (StringInfoOut != NULL);
2585 FontInfo = &StringInfoOut->FontInfo;
2586 Foreground = StringInfoOut->ForegroundColor;
2587 Background = StringInfoOut->BackgroundColor;
2588 } else {
2589 ASSERT (SystemDefault != NULL);
2590 Foreground = SystemDefault->ForegroundColor;
2591 Background = SystemDefault->BackgroundColor;
2592 }
2593
2594 Status = GetGlyphBuffer (Private, Char, FontInfo, &GlyphBuffer, &Cell, &Attributes);
2595 if (EFI_ERROR (Status)) {
2596 goto Exit;
2597 }
2598
2599 Image = (EFI_IMAGE_OUTPUT *) AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT));
2600 if (Image == NULL) {
2601 Status = EFI_OUT_OF_RESOURCES;
2602 goto Exit;
2603 }
2604 Image->Width = Cell.Width;
2605 Image->Height = Cell.Height;
2606
2607 if (Image->Width * Image->Height > 0) {
2608 Image->Image.Bitmap = AllocateZeroPool (Image->Width * Image->Height * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
2609 if (Image->Image.Bitmap == NULL) {
2610 FreePool (Image);
2611 Status = EFI_OUT_OF_RESOURCES;
2612 goto Exit;
2613 }
2614
2615 //
2616 // Set BaseLine to the char height.
2617 //
2618 BaseLine = (UINT16) (Cell.Height + Cell.OffsetY);
2619 //
2620 // Set BltBuffer to the position of Origin.
2621 //
2622 BltBuffer = Image->Image.Bitmap + (Cell.Height + Cell.OffsetY) * Image->Width - Cell.OffsetX;
2623 GlyphToImage (
2624 GlyphBuffer,
2625 Foreground,
2626 Background,
2627 Image->Width,
2628 BaseLine,
2629 Cell.Width + Cell.OffsetX,
2630 BaseLine - Cell.OffsetY,
2631 FALSE,
2632 &Cell,
2633 Attributes,
2634 &BltBuffer
2635 );
2636 }
2637
2638 *Blt = Image;
2639 if (Baseline != NULL) {
2640 *Baseline = Cell.OffsetY;
2641 }
2642
2643 Status = EFI_SUCCESS;
2644
2645 Exit:
2646
2647 if (Status == EFI_NOT_FOUND) {
2648 //
2649 // Glyph is unknown and replaced with the glyph for unicode character 0xFFFD
2650 //
2651 if (Char != REPLACE_UNKNOWN_GLYPH) {
2652 Status = HiiGetGlyph (This, REPLACE_UNKNOWN_GLYPH, StringInfo, Blt, Baseline);
2653 if (!EFI_ERROR (Status)) {
2654 Status = EFI_WARN_UNKNOWN_GLYPH;
2655 }
2656 } else {
2657 Status = EFI_WARN_UNKNOWN_GLYPH;
2658 }
2659 }
2660
2661 if (SystemDefault != NULL) {
2662 FreePool (SystemDefault);
2663 }
2664 if (StringInfoOut != NULL) {
2665 FreePool (StringInfoOut);
2666 }
2667 if (String != NULL) {
2668 FreePool (String);
2669 }
2670 if (GlyphBuffer != NULL) {
2671 FreePool (GlyphBuffer);
2672 }
2673
2674 return Status;
2675 }
2676
2677
2678 /**
2679 This function iterates through fonts which match the specified font, using
2680 the specified criteria. If String is non-NULL, then all of the characters in
2681 the string must exist in order for a candidate font to be returned.
2682
2683 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
2684 @param FontHandle On entry, points to the font handle returned by a
2685 previous call to GetFontInfo() or NULL to start
2686 with the first font. On return, points to the
2687 returned font handle or points to NULL if there
2688 are no more matching fonts.
2689 @param StringInfoIn Upon entry, points to the font to return information
2690 about. If NULL, then the information about the system
2691 default font will be returned.
2692 @param StringInfoOut Upon return, contains the matching font's information.
2693 If NULL, then no information is returned. This buffer
2694 is allocated with a call to the Boot Service AllocatePool().
2695 It is the caller's responsibility to call the Boot
2696 Service FreePool() when the caller no longer requires
2697 the contents of StringInfoOut.
2698 @param String Points to the string which will be tested to
2699 determine if all characters are available. If
2700 NULL, then any font is acceptable.
2701
2702 @retval EFI_SUCCESS Matching font returned successfully.
2703 @retval EFI_NOT_FOUND No matching font was found.
2704 @retval EFI_INVALID_PARAMETER StringInfoIn->FontInfoMask is an invalid combination.
2705 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the
2706 request.
2707
2708 **/
2709 EFI_STATUS
2710 EFIAPI
2711 HiiGetFontInfo (
2712 IN CONST EFI_HII_FONT_PROTOCOL *This,
2713 IN OUT EFI_FONT_HANDLE *FontHandle,
2714 IN CONST EFI_FONT_DISPLAY_INFO *StringInfoIn, OPTIONAL
2715 OUT EFI_FONT_DISPLAY_INFO **StringInfoOut,
2716 IN CONST EFI_STRING String OPTIONAL
2717 )
2718 {
2719 HII_DATABASE_PRIVATE_DATA *Private;
2720 EFI_STATUS Status;
2721 EFI_FONT_DISPLAY_INFO *SystemDefault;
2722 EFI_FONT_DISPLAY_INFO InfoOut;
2723 UINTN StringInfoOutLen;
2724 EFI_FONT_INFO *FontInfo;
2725 HII_GLOBAL_FONT_INFO *GlobalFont;
2726 EFI_STRING StringIn;
2727 EFI_FONT_HANDLE LocalFontHandle;
2728
2729 if (This == NULL) {
2730 return EFI_INVALID_PARAMETER;
2731 }
2732
2733 StringInfoOutLen = 0;
2734 FontInfo = NULL;
2735 SystemDefault = NULL;
2736 LocalFontHandle = NULL;
2737 if (FontHandle != NULL) {
2738 LocalFontHandle = *FontHandle;
2739 }
2740
2741 Private = HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This);
2742
2743 //
2744 // Already searched to the end of the whole list, return directly.
2745 //
2746 if (LocalFontHandle == &Private->FontInfoList) {
2747 LocalFontHandle = NULL;
2748 Status = EFI_NOT_FOUND;
2749 goto Exit;
2750 }
2751
2752 //
2753 // Get default system display info, if StringInfoIn points to
2754 // system display info, return it directly.
2755 //
2756 if (IsSystemFontInfo (Private, (EFI_FONT_DISPLAY_INFO *) StringInfoIn, &SystemDefault, &StringInfoOutLen)) {
2757 //
2758 // System font is the first node. When handle is not NULL, system font can not
2759 // be found any more.
2760 //
2761 if (LocalFontHandle == NULL) {
2762 if (StringInfoOut != NULL) {
2763 *StringInfoOut = AllocateCopyPool (StringInfoOutLen, SystemDefault);
2764 if (*StringInfoOut == NULL) {
2765 Status = EFI_OUT_OF_RESOURCES;
2766 LocalFontHandle = NULL;
2767 goto Exit;
2768 }
2769 }
2770
2771 LocalFontHandle = Private->FontInfoList.ForwardLink;
2772 Status = EFI_SUCCESS;
2773 goto Exit;
2774 } else {
2775 LocalFontHandle = NULL;
2776 Status = EFI_NOT_FOUND;
2777 goto Exit;
2778 }
2779 }
2780
2781 //
2782 // StringInfoIn must not be NULL if it is not system default font info.
2783 //
2784 ASSERT (StringInfoIn != NULL);
2785 //
2786 // Check the font information mask to make sure it is valid.
2787 //
2788 if (((StringInfoIn->FontInfoMask & (EFI_FONT_INFO_SYS_FONT | EFI_FONT_INFO_ANY_FONT)) ==
2789 (EFI_FONT_INFO_SYS_FONT | EFI_FONT_INFO_ANY_FONT)) ||
2790 ((StringInfoIn->FontInfoMask & (EFI_FONT_INFO_SYS_SIZE | EFI_FONT_INFO_ANY_SIZE)) ==
2791 (EFI_FONT_INFO_SYS_SIZE | EFI_FONT_INFO_ANY_SIZE)) ||
2792 ((StringInfoIn->FontInfoMask & (EFI_FONT_INFO_SYS_STYLE | EFI_FONT_INFO_ANY_STYLE)) ==
2793 (EFI_FONT_INFO_SYS_STYLE | EFI_FONT_INFO_ANY_STYLE)) ||
2794 ((StringInfoIn->FontInfoMask & (EFI_FONT_INFO_RESIZE | EFI_FONT_INFO_ANY_SIZE)) ==
2795 (EFI_FONT_INFO_RESIZE | EFI_FONT_INFO_ANY_SIZE)) ||
2796 ((StringInfoIn->FontInfoMask & (EFI_FONT_INFO_RESTYLE | EFI_FONT_INFO_ANY_STYLE)) ==
2797 (EFI_FONT_INFO_RESTYLE | EFI_FONT_INFO_ANY_STYLE))) {
2798 return EFI_INVALID_PARAMETER;
2799 }
2800
2801 //
2802 // Parse the font information mask to find a matching font.
2803 //
2804
2805 CopyMem (&InfoOut, (EFI_FONT_DISPLAY_INFO *) StringInfoIn, sizeof (EFI_FONT_DISPLAY_INFO));
2806
2807 if ((StringInfoIn->FontInfoMask & EFI_FONT_INFO_SYS_FONT) == EFI_FONT_INFO_SYS_FONT) {
2808 Status = SaveFontName (SystemDefault->FontInfo.FontName, &FontInfo);
2809 } else {
2810 Status = SaveFontName (((EFI_FONT_DISPLAY_INFO *) StringInfoIn)->FontInfo.FontName, &FontInfo);
2811 }
2812 if (EFI_ERROR (Status)) {
2813 goto Exit;
2814 }
2815
2816 if ((StringInfoIn->FontInfoMask & EFI_FONT_INFO_SYS_SIZE) == EFI_FONT_INFO_SYS_SIZE) {
2817 InfoOut.FontInfo.FontSize = SystemDefault->FontInfo.FontSize;
2818 }
2819 if ((StringInfoIn->FontInfoMask & EFI_FONT_INFO_SYS_STYLE) == EFI_FONT_INFO_SYS_STYLE) {
2820 InfoOut.FontInfo.FontStyle = SystemDefault->FontInfo.FontStyle;
2821 }
2822 if ((StringInfoIn->FontInfoMask & EFI_FONT_INFO_SYS_FORE_COLOR) == EFI_FONT_INFO_SYS_FORE_COLOR) {
2823 InfoOut.ForegroundColor = SystemDefault->ForegroundColor;
2824 }
2825 if ((StringInfoIn->FontInfoMask & EFI_FONT_INFO_SYS_BACK_COLOR) == EFI_FONT_INFO_SYS_BACK_COLOR) {
2826 InfoOut.BackgroundColor = SystemDefault->BackgroundColor;
2827 }
2828
2829 ASSERT (FontInfo != NULL);
2830 FontInfo->FontSize = InfoOut.FontInfo.FontSize;
2831 FontInfo->FontStyle = InfoOut.FontInfo.FontStyle;
2832
2833 if (IsFontInfoExisted (Private, FontInfo, &InfoOut.FontInfoMask, LocalFontHandle, &GlobalFont)) {
2834 //
2835 // Test to guarantee all characters are available in the found font.
2836 //
2837 if (String != NULL) {
2838 StringIn = String;
2839 while (*StringIn != 0) {
2840 Status = FindGlyphBlock (GlobalFont->FontPackage, *StringIn, NULL, NULL, NULL);
2841 if (EFI_ERROR (Status)) {
2842 LocalFontHandle = NULL;
2843 goto Exit;
2844 }
2845 StringIn++;
2846 }
2847 }
2848 //
2849 // Write to output parameter
2850 //
2851 if (StringInfoOut != NULL) {
2852 StringInfoOutLen = sizeof (EFI_FONT_DISPLAY_INFO) - sizeof (EFI_FONT_INFO) + GlobalFont->FontInfoSize;
2853 *StringInfoOut = (EFI_FONT_DISPLAY_INFO *) AllocateZeroPool (StringInfoOutLen);
2854 if (*StringInfoOut == NULL) {
2855 Status = EFI_OUT_OF_RESOURCES;
2856 LocalFontHandle = NULL;
2857 goto Exit;
2858 }
2859
2860 CopyMem (*StringInfoOut, &InfoOut, sizeof (EFI_FONT_DISPLAY_INFO));
2861 CopyMem (&(*StringInfoOut)->FontInfo, GlobalFont->FontInfo, GlobalFont->FontInfoSize);
2862 }
2863
2864 LocalFontHandle = GlobalFont->Entry.ForwardLink;
2865 Status = EFI_SUCCESS;
2866 goto Exit;
2867 }
2868
2869 Status = EFI_NOT_FOUND;
2870
2871 Exit:
2872
2873 if (FontHandle != NULL) {
2874 *FontHandle = LocalFontHandle;
2875 }
2876
2877 if (SystemDefault != NULL) {
2878 FreePool (SystemDefault);
2879 }
2880 if (FontInfo != NULL) {
2881 FreePool (FontInfo);
2882 }
2883 return Status;
2884 }
2885
2886
EFI Development Kit II mirror for PVE