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