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