]> 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
MdeModulePkg/HiiDatabase: Remove the incorrect calculation of font baseline
[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
3a2718d7 5Copyright (c) 2007 - 2016, 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
93e3992d 707 }\r
708\r
709 BlockPtr = FontPackage->GlyphBlock;\r
710 CharCurrent = 1;\r
711 BufferLen = 0;\r
712\r
713 while (*BlockPtr != EFI_HII_GIBT_END) {\r
714 switch (*BlockPtr) {\r
715 case EFI_HII_GIBT_DEFAULTS:\r
716 //\r
717 // Collect all default character cell information specified by\r
718 // EFI_HII_GIBT_DEFAULTS.\r
719 //\r
720 if (CharValue == (CHAR16) (-1)) {\r
721 Status = NewCell (\r
722 CharCurrent,\r
723 &FontPackage->GlyphInfoList,\r
724 (EFI_HII_GLYPH_INFO *) (BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK))\r
725 );\r
726 if (EFI_ERROR (Status)) {\r
727 return Status;\r
728 }\r
f6cf5cf8
LG		 729 CopyMem (\r
730 &LocalCell,\r
731 BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK),\r
732 sizeof (EFI_HII_GLYPH_INFO)\r
733 );\r
734 if (BaseLine < LocalCell.Height + LocalCell.OffsetY) {\r
735 BaseLine = (UINT16) (LocalCell.Height + LocalCell.OffsetY);\r
736 }\r
737 if (MinOffsetY > LocalCell.OffsetY) {\r
738 MinOffsetY = LocalCell.OffsetY;\r
739 }\r
93e3992d 740 }\r
741 BlockPtr += sizeof (EFI_HII_GIBT_DEFAULTS_BLOCK);\r
742 break;\r
743\r
744 case EFI_HII_GIBT_DUPLICATE:\r
745 if (CharCurrent == CharValue) {\r
746 CopyMem (&CharValue, BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK), sizeof (CHAR16));\r
747 CharCurrent = 1;\r
748 BlockPtr = FontPackage->GlyphBlock;\r
749 continue;\r
750 }\r
751 CharCurrent++;\r
752 BlockPtr += sizeof (EFI_HII_GIBT_DUPLICATE_BLOCK);\r
753 break;\r
754\r
755 case EFI_HII_GIBT_EXT1:\r
6e1e5405 756 BlockPtr += *(UINT8*)((UINTN)BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK) + sizeof (UINT8));\r
93e3992d 757 break;\r
758 case EFI_HII_GIBT_EXT2:\r
759 CopyMem (\r
760 &Length16,\r
6e1e5405 761 (UINT8*)((UINTN)BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK) + sizeof (UINT8)),\r
93e3992d 762 sizeof (UINT16)\r
763 );\r
764 BlockPtr += Length16;\r
765 break;\r
766 case EFI_HII_GIBT_EXT4:\r
767 CopyMem (\r
768 &Length32,\r
6e1e5405 769 (UINT8*)((UINTN)BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK) + sizeof (UINT8)),\r
93e3992d 770 sizeof (UINT32)\r
771 );\r
772 BlockPtr += Length32;\r
773 break;\r
774\r
775 case EFI_HII_GIBT_GLYPH:\r
776 CopyMem (\r
777 &LocalCell,\r
778 BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK),\r
779 sizeof (EFI_HII_GLYPH_INFO)\r
780 );\r
f6cf5cf8
LG		 781 if (CharValue == (CHAR16) (-1)) {\r
782 if (BaseLine < LocalCell.Height + LocalCell.OffsetY) {\r
783 BaseLine = (UINT16) (LocalCell.Height + LocalCell.OffsetY);\r
784 }\r
785 if (MinOffsetY > LocalCell.OffsetY) {\r
786 MinOffsetY = LocalCell.OffsetY;\r
787 }\r
788 }\r
93e3992d 789 BufferLen = BITMAP_LEN_1_BIT (LocalCell.Width, LocalCell.Height);\r
790 if (CharCurrent == CharValue) {\r
791 return WriteOutputParam (\r
6e1e5405 792 (UINT8*)((UINTN)BlockPtr + sizeof (EFI_HII_GIBT_GLYPH_BLOCK) - sizeof (UINT8)),\r
93e3992d 793 BufferLen,\r
794 &LocalCell,\r
795 GlyphBuffer,\r
796 Cell,\r
797 GlyphBufferLen\r
798 );\r
799 }\r
800 CharCurrent++;\r
801 BlockPtr += sizeof (EFI_HII_GIBT_GLYPH_BLOCK) - sizeof (UINT8) + BufferLen;\r
802 break;\r
803\r
804 case EFI_HII_GIBT_GLYPHS:\r
805 BlockPtr += sizeof (EFI_HII_GLYPH_BLOCK);\r
806 CopyMem (&Glyphs.Cell, BlockPtr, sizeof (EFI_HII_GLYPH_INFO));\r
807 BlockPtr += sizeof (EFI_HII_GLYPH_INFO);\r
808 CopyMem (&Glyphs.Count, BlockPtr, sizeof (UINT16));\r
809 BlockPtr += sizeof (UINT16);\r
810\r
f6cf5cf8
LG		 811 if (CharValue == (CHAR16) (-1)) {\r
812 if (BaseLine < Glyphs.Cell.Height + Glyphs.Cell.OffsetY) {\r
813 BaseLine = (UINT16) (Glyphs.Cell.Height + Glyphs.Cell.OffsetY);\r
814 }\r
815 if (MinOffsetY > Glyphs.Cell.OffsetY) {\r
816 MinOffsetY = Glyphs.Cell.OffsetY;\r
817 }\r
818 }\r
819\r
93e3992d 820 BufferLen = BITMAP_LEN_1_BIT (Glyphs.Cell.Width, Glyphs.Cell.Height);\r
821 for (Index = 0; Index < Glyphs.Count; Index++) {\r
822 if (CharCurrent + Index == CharValue) {\r
823 return WriteOutputParam (\r
824 BlockPtr,\r
825 BufferLen,\r
826 &Glyphs.Cell,\r
827 GlyphBuffer,\r
828 Cell,\r
829 GlyphBufferLen\r
830 );\r
831 }\r
832 BlockPtr += BufferLen;\r
833 }\r
834 CharCurrent = (UINT16) (CharCurrent + Glyphs.Count);\r
835 break;\r
836\r
837 case EFI_HII_GIBT_GLYPH_DEFAULT:\r
838 Status = GetCell (CharCurrent, &FontPackage->GlyphInfoList, &DefaultCell);\r
839 if (EFI_ERROR (Status)) {\r
840 return Status;\r
841 }\r
842 BufferLen = BITMAP_LEN_1_BIT (DefaultCell.Width, DefaultCell.Height);\r
843\r
844 if (CharCurrent == CharValue) {\r
845 return WriteOutputParam (\r
846 BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK),\r
847 BufferLen,\r
848 &DefaultCell,\r
849 GlyphBuffer,\r
850 Cell,\r
851 GlyphBufferLen\r
852 );\r
853 }\r
854 CharCurrent++;\r
855 BlockPtr += sizeof (EFI_HII_GLYPH_BLOCK) + BufferLen;\r
856 break;\r
857\r
858 case EFI_HII_GIBT_GLYPHS_DEFAULT:\r
859 CopyMem (&Length16, BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK), sizeof (UINT16));\r
860 Status = GetCell (CharCurrent, &FontPackage->GlyphInfoList, &DefaultCell);\r
861 if (EFI_ERROR (Status)) {\r
862 return Status;\r
863 }\r
864 BufferLen = BITMAP_LEN_1_BIT (DefaultCell.Width, DefaultCell.Height);\r
865 BlockPtr += sizeof (EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK) - sizeof (UINT8);\r
866 for (Index = 0; Index < Length16; Index++) {\r
867 if (CharCurrent + Index == CharValue) {\r
868 return WriteOutputParam (\r
869 BlockPtr,\r
870 BufferLen,\r
871 &DefaultCell,\r
872 GlyphBuffer,\r
873 Cell,\r
874 GlyphBufferLen\r
875 );\r
876 }\r
877 BlockPtr += BufferLen;\r
878 }\r
879 CharCurrent = (UINT16) (CharCurrent + Length16);\r
880 break;\r
881\r
882 case EFI_HII_GIBT_SKIP1:\r
883 CharCurrent = (UINT16) (CharCurrent + (UINT16) (*(BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK))));\r
884 BlockPtr += sizeof (EFI_HII_GIBT_SKIP1_BLOCK);\r
885 break;\r
886 case EFI_HII_GIBT_SKIP2:\r
887 CopyMem (&Length16, BlockPtr + sizeof (EFI_HII_GLYPH_BLOCK), sizeof (UINT16));\r
888 CharCurrent = (UINT16) (CharCurrent + Length16);\r
889 BlockPtr += sizeof (EFI_HII_GIBT_SKIP2_BLOCK);\r
890 break;\r
891 default:\r
892 ASSERT (FALSE);\r
893 break;\r
894 }\r
895\r
896 if (CharValue < CharCurrent) {\r
897 return EFI_NOT_FOUND;\r
898 }\r
899 }\r
900\r
901 if (CharValue == (CHAR16) (-1)) {\r
f6cf5cf8
LG		 902 FontPackage->BaseLine = BaseLine;\r
903 FontPackage->Height = (UINT16) (BaseLine - MinOffsetY);\r
93e3992d 904 return EFI_SUCCESS;\r
905 }\r
906\r
907 return EFI_NOT_FOUND;\r
908}\r
909\r
910\r
911/**\r
912 Copy a Font Name to a new created EFI_FONT_INFO structure.\r
913\r
e90b081a 914 This is a internal function.\r
915\r
93e3992d 916 @param FontName NULL-terminated string.\r
917 @param FontInfo a new EFI_FONT_INFO which stores the FontName.\r
918 It's caller's responsibility to free this buffer.\r
919\r
920 @retval EFI_SUCCESS FontInfo is allocated and copied with FontName.\r
921 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the\r
922 task.\r
923\r
924**/\r
93e3992d 925EFI_STATUS\r
926SaveFontName (\r
927 IN EFI_STRING FontName,\r
928 OUT EFI_FONT_INFO **FontInfo\r
929 )\r
930{\r
931 UINTN FontInfoLen;\r
5ad66ec6 932 UINTN NameSize;\r
93e3992d 933\r
934 ASSERT (FontName != NULL && FontInfo != NULL);\r
935\r
5ad66ec6
DB		 936 NameSize = StrSize (FontName);\r
937 FontInfoLen = sizeof (EFI_FONT_INFO) - sizeof (CHAR16) + NameSize;\r
93e3992d 938 *FontInfo = (EFI_FONT_INFO *) AllocateZeroPool (FontInfoLen);\r
939 if (*FontInfo == NULL) {\r
940 return EFI_OUT_OF_RESOURCES;\r
941 }\r
942\r
5ad66ec6 943 StrCpyS ((*FontInfo)->FontName, NameSize / sizeof (CHAR16), FontName);\r
93e3992d 944 return EFI_SUCCESS;\r
945}\r
946\r
947\r
948/**\r
949 Retrieve system default font and color.\r
950\r
951 @param Private HII database driver private data.\r
952 @param FontInfo Points to system default font output-related\r
953 information. It's caller's responsibility to free\r
954 this buffer.\r
955 @param FontInfoSize If not NULL, output the size of buffer FontInfo.\r
956\r
957 @retval EFI_SUCCESS Cell information is added to the GlyphInfoList.\r
958 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the\r
959 task.\r
960 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.\r
961\r
962**/\r
963EFI_STATUS\r
964GetSystemFont (\r
965 IN HII_DATABASE_PRIVATE_DATA *Private,\r
966 OUT EFI_FONT_DISPLAY_INFO **FontInfo,\r
967 OUT UINTN *FontInfoSize OPTIONAL\r
968 )\r
969{\r
970 EFI_FONT_DISPLAY_INFO *Info;\r
971 UINTN InfoSize;\r
5ad66ec6 972 UINTN NameSize;\r
93e3992d 973\r
974 if (Private == NULL || Private->Signature != HII_DATABASE_PRIVATE_DATA_SIGNATURE) {\r
975 return EFI_INVALID_PARAMETER;\r
976 }\r
977 if (FontInfo == NULL) {\r
978 return EFI_INVALID_PARAMETER;\r
979 }\r
980\r
981 //\r
982 // The standard font always has the name "sysdefault".\r
983 //\r
5ad66ec6
DB		 984 NameSize = StrSize (L"sysdefault");\r
985 InfoSize = sizeof (EFI_FONT_DISPLAY_INFO) - sizeof (CHAR16) + NameSize;\r
93e3992d 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
5ad66ec6 996 StrCpyS (Info->FontInfo.FontName, NameSize / sizeof (CHAR16), L"sysdefault");\r
93e3992d 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
523f48e7
ED		 1043 SystemDefault = NULL;\r
1044 DefaultLen = 0;\r
1045\r
93e3992d 1046 Status = GetSystemFont (Private, &SystemDefault, &DefaultLen);\r
1047 ASSERT_EFI_ERROR (Status);\r
523f48e7 1048 ASSERT ((SystemDefault != NULL) && (DefaultLen != 0));\r
93e3992d 1049\r
813acf3a 1050 //\r
1051 // Record the system default info.\r
1052 //\r
93e3992d 1053 if (SystemInfo != NULL) {\r
1054 *SystemInfo = SystemDefault;\r
93e3992d 1055 }\r
1056\r
1057 if (SystemInfoLen != NULL) {\r
1058 *SystemInfoLen = DefaultLen;\r
1059 }\r
1060\r
813acf3a 1061 if (StringInfo == NULL) {\r
93e3992d 1062 return TRUE;\r
1063 }\r
1064\r
813acf3a 1065 Flag = FALSE;\r
1066 //\r
1067 // Check the FontInfoMask to see whether it is retrieving system info.\r
1068 //\r
1069 if ((StringInfo->FontInfoMask & (EFI_FONT_INFO_SYS_FONT | EFI_FONT_INFO_ANY_FONT)) == 0) {\r
1070 if (StrCmp (StringInfo->FontInfo.FontName, SystemDefault->FontInfo.FontName) != 0) {\r
1071 goto Exit;\r
1072 }\r
1073 }\r
1074 if ((StringInfo->FontInfoMask & (EFI_FONT_INFO_SYS_SIZE | EFI_FONT_INFO_ANY_SIZE)) == 0) {\r
1075 if (StringInfo->FontInfo.FontSize != SystemDefault->FontInfo.FontSize) {\r
1076 goto Exit;\r
1077 }\r
1078 }\r
1079 if ((StringInfo->FontInfoMask & (EFI_FONT_INFO_SYS_STYLE | EFI_FONT_INFO_ANY_STYLE)) == 0) {\r
1080 if (StringInfo->FontInfo.FontStyle != SystemDefault->FontInfo.FontStyle) {\r
1081 goto Exit;\r
1082 }\r
1083 }\r
1084 if ((StringInfo->FontInfoMask & EFI_FONT_INFO_SYS_FORE_COLOR) == 0) {\r
1085 if (CompareMem (\r
1086 &StringInfo->ForegroundColor, \r
1087 &SystemDefault->ForegroundColor, \r
1088 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
1089 ) != 0) {\r
1090 goto Exit;\r
1091 }\r
1092 }\r
1093 if ((StringInfo->FontInfoMask & EFI_FONT_INFO_SYS_BACK_COLOR) == 0) {\r
1094 if (CompareMem (\r
1095 &StringInfo->BackgroundColor, \r
1096 &SystemDefault->BackgroundColor, \r
1097 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
1098 ) != 0) {\r
1099 goto Exit;\r
1100 }\r
1101 }\r
1102\r
1103 Flag = TRUE;\r
1104\r
1105Exit:\r
1106 if (SystemInfo == NULL) {\r
676df92c 1107 if (SystemDefault != NULL) {\r
1108 FreePool (SystemDefault);\r
1109 }\r
813acf3a 1110 }\r
1111 return Flag;\r
93e3992d 1112}\r
1113\r
1114\r
1115/**\r
1116 This function checks whether EFI_FONT_INFO exists in current database. If\r
1117 FontInfoMask is specified, check what options can be used to make a match.\r
1118 Note that the masks relate to where the system default should be supplied\r
1119 are ignored by this function.\r
1120\r
1121 @param Private Hii database private structure.\r
1122 @param FontInfo Points to EFI_FONT_INFO structure.\r
1123 @param FontInfoMask If not NULL, describes what options can be used\r
1124 to make a match between the font requested and\r
1125 the font available. The caller must guarantee\r
1126 this mask is valid.\r
1127 @param FontHandle On entry, Points to the font handle returned by a\r
1128 previous call to GetFontInfo() or NULL to start\r
1129 with the first font.\r
1130 @param GlobalFontInfo If not NULL, output the corresponding globa font\r
1131 info.\r
1132\r
1133 @retval TRUE Existed\r
1134 @retval FALSE Not existed\r
1135\r
1136**/\r
1137BOOLEAN\r
1138IsFontInfoExisted (\r
1139 IN HII_DATABASE_PRIVATE_DATA *Private,\r
1140 IN EFI_FONT_INFO *FontInfo,\r
1141 IN EFI_FONT_INFO_MASK *FontInfoMask, OPTIONAL\r
1142 IN EFI_FONT_HANDLE FontHandle, OPTIONAL\r
1143 OUT HII_GLOBAL_FONT_INFO **GlobalFontInfo OPTIONAL\r
1144 )\r
1145{\r
1146 HII_GLOBAL_FONT_INFO *GlobalFont;\r
1147 HII_GLOBAL_FONT_INFO *GlobalFontBackup1;\r
1148 HII_GLOBAL_FONT_INFO *GlobalFontBackup2;\r
1149 LIST_ENTRY *Link;\r
1150 EFI_FONT_INFO_MASK Mask;\r
1151 BOOLEAN Matched;\r
1152 BOOLEAN VagueMatched1;\r
1153 BOOLEAN VagueMatched2;\r
1154\r
1155 ASSERT (Private != NULL && Private->Signature == HII_DATABASE_PRIVATE_DATA_SIGNATURE);\r
1156 ASSERT (FontInfo != NULL);\r
1157\r
1158 //\r
1159 // Matched flag represents an exactly match; VagueMatched1 repensents a RESIZE\r
1160 // or RESTYLE match; VagueMatched2 represents a RESIZE | RESTYLE match.\r
1161 //\r
1162 Matched = FALSE;\r
1163 VagueMatched1 = FALSE;\r
1164 VagueMatched2 = FALSE;\r
1165\r
1166 Mask = 0;\r
1167 GlobalFontBackup1 = NULL;\r
1168 GlobalFontBackup2 = NULL;\r
1169\r
1170 // The process of where the system default should be supplied instead of\r
1171 // the specified font info beyonds this function's scope.\r
1172 //\r
1173 if (FontInfoMask != NULL) {\r
1174 Mask = *FontInfoMask & (~SYS_FONT_INFO_MASK);\r
1175 }\r
1176\r
1177 //\r
1178 // If not NULL, FontHandle points to the next node of the last searched font\r
1179 // node by previous call.\r
1180 //\r
1181 if (FontHandle == NULL) {\r
1182 Link = Private->FontInfoList.ForwardLink;\r
1183 } else {\r
1184 Link = (LIST_ENTRY *) FontHandle;\r
1185 }\r
1186\r
1187 for (; Link != &Private->FontInfoList; Link = Link->ForwardLink) {\r
1188 GlobalFont = CR (Link, HII_GLOBAL_FONT_INFO, Entry, HII_GLOBAL_FONT_INFO_SIGNATURE);\r
1189 if (FontInfoMask == NULL) {\r
1190 if (CompareMem (GlobalFont->FontInfo, FontInfo, GlobalFont->FontInfoSize) == 0) {\r
1191 if (GlobalFontInfo != NULL) {\r
1192 *GlobalFontInfo = GlobalFont;\r
1193 }\r
1194 return TRUE;\r
1195 }\r
1196 } else {\r
1197 //\r
1198 // Check which options could be used to make a match.\r
1199 //\r
1200 switch (Mask) {\r
1201 case EFI_FONT_INFO_ANY_FONT:\r
1202 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle &&\r
1203 GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {\r
1204 Matched = TRUE;\r
1205 }\r
1206 break;\r
1207 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_ANY_STYLE:\r
1208 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {\r
1209 Matched = TRUE;\r
1210 }\r
1211 break;\r
1212 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_ANY_SIZE:\r
1213 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {\r
1214 Matched = TRUE;\r
1215 }\r
1216 break;\r
1217 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_ANY_SIZE | EFI_FONT_INFO_ANY_STYLE:\r
1218 Matched = TRUE;\r
1219 break;\r
1220 //\r
1221 // If EFI_FONT_INFO_RESTYLE is specified, then the system may attempt to\r
1222 // remove some of the specified styles to meet the style requested.\r
1223 //\r
1224 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_RESTYLE:\r
1225 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {\r
1226 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {\r
1227 Matched = TRUE;\r
1228 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {\r
1229 VagueMatched1 = TRUE;\r
1230 GlobalFontBackup1 = GlobalFont;\r
1231 }\r
1232 }\r
1233 break;\r
1234 //\r
1235 // If EFI_FONT_INFO_RESIZE is specified, then the sytem may attempt to\r
1236 // stretch or shrink a font to meet the size requested.\r
1237 //\r
1238 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_RESIZE:\r
1239 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {\r
1240 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {\r
1241 Matched = TRUE;\r
1242 } else {\r
1243 VagueMatched1 = TRUE;\r
1244 GlobalFontBackup1 = GlobalFont;\r
1245 }\r
1246 }\r
1247 break;\r
1248 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_RESTYLE | EFI_FONT_INFO_RESIZE:\r
1249 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {\r
1250 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {\r
1251 Matched = TRUE;\r
1252 } else {\r
1253 VagueMatched1 = TRUE;\r
1254 GlobalFontBackup1 = GlobalFont;\r
1255 }\r
1256 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {\r
1257 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {\r
1258 VagueMatched1 = TRUE;\r
1259 GlobalFontBackup1 = GlobalFont;\r
1260 } else {\r
1261 VagueMatched2 = TRUE;\r
1262 GlobalFontBackup2 = GlobalFont;\r
1263 }\r
1264 }\r
1265 break;\r
1266 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_ANY_STYLE | EFI_FONT_INFO_RESIZE:\r
1267 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {\r
1268 Matched = TRUE;\r
1269 } else {\r
1270 VagueMatched1 = TRUE;\r
1271 GlobalFontBackup1 = GlobalFont;\r
1272 }\r
1273 break;\r
1274 case EFI_FONT_INFO_ANY_FONT | EFI_FONT_INFO_ANY_SIZE | EFI_FONT_INFO_RESTYLE:\r
1275 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {\r
1276 Matched = TRUE;\r
1277 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {\r
1278 VagueMatched1 = TRUE;\r
1279 GlobalFontBackup1 = GlobalFont;\r
1280 }\r
1281 break;\r
1282 case EFI_FONT_INFO_ANY_STYLE:\r
1283 if ((CompareMem (\r
1284 GlobalFont->FontInfo->FontName,\r
1285 FontInfo->FontName,\r
1286 StrSize (FontInfo->FontName)\r
1287 ) == 0) &&\r
1288 GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {\r
1289 Matched = TRUE;\r
1290 }\r
1291 break;\r
1292 case EFI_FONT_INFO_ANY_STYLE | EFI_FONT_INFO_ANY_SIZE:\r
1293 if (CompareMem (\r
1294 GlobalFont->FontInfo->FontName,\r
1295 FontInfo->FontName,\r
1296 StrSize (FontInfo->FontName)\r
1297 ) == 0) {\r
1298 Matched = TRUE;\r
1299 }\r
1300 break;\r
1301 case EFI_FONT_INFO_ANY_STYLE | EFI_FONT_INFO_RESIZE:\r
1302 if (CompareMem (\r
1303 GlobalFont->FontInfo->FontName,\r
1304 FontInfo->FontName,\r
1305 StrSize (FontInfo->FontName)\r
1306 ) == 0) {\r
1307 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {\r
1308 Matched = TRUE;\r
1309 } else {\r
1310 VagueMatched1 = TRUE;\r
1311 GlobalFontBackup1 = GlobalFont;\r
1312 }\r
1313 }\r
1314 break;\r
1315 case EFI_FONT_INFO_ANY_SIZE:\r
1316 if ((CompareMem (\r
1317 GlobalFont->FontInfo->FontName,\r
1318 FontInfo->FontName,\r
1319 StrSize (FontInfo->FontName)\r
1320 ) == 0) &&\r
1321 GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {\r
1322 Matched = TRUE;\r
1323 }\r
1324 break;\r
1325 case EFI_FONT_INFO_ANY_SIZE | EFI_FONT_INFO_RESTYLE:\r
1326 if (CompareMem (\r
1327 GlobalFont->FontInfo->FontName,\r
1328 FontInfo->FontName,\r
1329 StrSize (FontInfo->FontName)\r
1330 ) == 0) {\r
1331 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {\r
1332 Matched = TRUE;\r
1333 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {\r
1334 VagueMatched1 = TRUE;\r
1335 GlobalFontBackup1 = GlobalFont;\r
1336 }\r
1337 }\r
1338 break;\r
1339 case EFI_FONT_INFO_RESTYLE:\r
1340 if ((CompareMem (\r
1341 GlobalFont->FontInfo->FontName,\r
1342 FontInfo->FontName,\r
1343 StrSize (FontInfo->FontName)\r
1344 ) == 0) &&\r
1345 GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {\r
1346\r
1347 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {\r
1348 Matched = TRUE;\r
1349 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {\r
1350 VagueMatched1 = TRUE;\r
1351 GlobalFontBackup1 = GlobalFont;\r
1352 }\r
1353 }\r
1354 break;\r
1355 case EFI_FONT_INFO_RESIZE:\r
1356 if ((CompareMem (\r
1357 GlobalFont->FontInfo->FontName,\r
1358 FontInfo->FontName,\r
1359 StrSize (FontInfo->FontName)\r
1360 ) == 0) &&\r
1361 GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {\r
1362\r
1363 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {\r
1364 Matched = TRUE;\r
1365 } else {\r
1366 VagueMatched1 = TRUE;\r
1367 GlobalFontBackup1 = GlobalFont;\r
1368 }\r
1369 }\r
1370 break;\r
1371 case EFI_FONT_INFO_RESIZE | EFI_FONT_INFO_RESTYLE:\r
1372 if (CompareMem (\r
1373 GlobalFont->FontInfo->FontName,\r
1374 FontInfo->FontName,\r
1375 StrSize (FontInfo->FontName)\r
1376 ) == 0) {\r
1377 if (GlobalFont->FontInfo->FontStyle == FontInfo->FontStyle) {\r
1378 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {\r
1379 Matched = TRUE;\r
1380 } else {\r
1381 VagueMatched1 = TRUE;\r
1382 GlobalFontBackup1 = GlobalFont;\r
1383 }\r
1384 } else if ((GlobalFont->FontInfo->FontStyle & FontInfo->FontStyle) == FontInfo->FontStyle) {\r
1385 if (GlobalFont->FontInfo->FontSize == FontInfo->FontSize) {\r
1386 VagueMatched1 = TRUE;\r
1387 GlobalFontBackup1 = GlobalFont;\r
1388 } else {\r
1389 VagueMatched2 = TRUE;\r
1390 GlobalFontBackup2 = GlobalFont;\r
1391 }\r
1392 }\r
1393 }\r
1394 break;\r
1395 default:\r
1396 break;\r
1397 }\r
1398\r
1399 if (Matched) {\r
1400 if (GlobalFontInfo != NULL) {\r
1401 *GlobalFontInfo = GlobalFont;\r
1402 }\r
1403 return TRUE;\r
1404 }\r
1405 }\r
1406 }\r
1407\r
1408 if (VagueMatched1) {\r
1409 if (GlobalFontInfo != NULL) {\r
1410 *GlobalFontInfo = GlobalFontBackup1;\r
1411 }\r
1412 return TRUE;\r
1413 } else if (VagueMatched2) {\r
1414 if (GlobalFontInfo != NULL) {\r
1415 *GlobalFontInfo = GlobalFontBackup2;\r
1416 }\r
1417 return TRUE;\r
1418 }\r
1419\r
1420 return FALSE;\r
1421}\r
1422\r
1423\r
1424/**\r
1425 Check whether the unicode represents a line break or not.\r
1426\r
4772ce75 1427 This is a internal function. Please see Section 27.2.6 of the UEFI Specification\r
1428 for a description of the supported string format.\r
e90b081a 1429\r
93e3992d 1430 @param Char Unicode character\r
1431\r
4772ce75 1432 @retval 0 Yes, it forces a line break.\r
1433 @retval 1 Yes, it presents a line break opportunity\r
1434 @retval 2 Yes, it requires a line break happen before and after it.\r
93e3992d 1435 @retval -1 No, it is not a link break.\r
1436\r
1437**/\r
93e3992d 1438INT8\r
1439IsLineBreak (\r
1440 IN CHAR16 Char\r
1441 )\r
1442{\r
93e3992d 1443 switch (Char) {\r
4772ce75 1444 //\r
1445 // Mandatory line break characters, which force a line-break\r
1446 //\r
2d9cdfd8 1447 case 0x000A:\r
4772ce75 1448 case 0x000C:\r
1449 case 0x000D:\r
1450 case 0x2028:\r
1451 case 0x2029:\r
93e3992d 1452 return 0;\r
4772ce75 1453 //\r
1454 // Space characters, which is taken as a line-break opportunity\r
1455 //\r
1456 case 0x0020:\r
1457 case 0x1680:\r
1458 case 0x2000:\r
1459 case 0x2001:\r
1460 case 0x2002:\r
1461 case 0x2003:\r
1462 case 0x2004:\r
1463 case 0x2005:\r
1464 case 0x2006:\r
1465 case 0x2008:\r
1466 case 0x2009:\r
1467 case 0x200A:\r
1468 case 0x205F:\r
1469 //\r
1470 // In-Word Break Opportunities\r
1471 //\r
1472 case 0x200B:\r
1473 return 1;\r
1474 //\r
1475 // A space which is not a line-break opportunity\r
1476 //\r
1477 case 0x00A0:\r
1478 case 0x202F:\r
1479 //\r
1480 // A hyphen which is not a line-break opportunity\r
1481 //\r
1482 case 0x2011:\r
1483 return -1;\r
1484 //\r
1485 // Hyphen characters which describe line break opportunities after the character\r
1486 //\r
93e3992d 1487 case 0x058A:\r
4772ce75 1488 case 0x2010:\r
1489 case 0x2012:\r
1490 case 0x2013:\r
93e3992d 1491 case 0x0F0B:\r
1492 case 0x1361:\r
1493 case 0x17D5:\r
1494 return 1;\r
4772ce75 1495 //\r
1496 // A hyphen which describes line break opportunities before and after them, but not between a pair of them\r
1497 //\r
1498 case 0x2014:\r
1499 return 2;\r
93e3992d 1500 }\r
93e3992d 1501 return -1;\r
1502}\r
1503\r
1504\r
1505/**\r
1506 Renders a string to a bitmap or to the display.\r
1507\r
1508 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.\r
1509 @param Flags Describes how the string is to be drawn.\r
1510 @param String Points to the null-terminated string to be\r
1511 displayed.\r
1512 @param StringInfo Points to the string output information,\r
1513 including the color and font. If NULL, then the\r
1514 string will be output in the default system font\r
1515 and color.\r
1516 @param Blt If this points to a non-NULL on entry, this\r
1517 points to the image, which is Width pixels wide\r
1518 and Height pixels high. The string will be drawn\r
1519 onto this image and\r
1520 EFI_HII_OUT_FLAG_CLIP is implied. If this points\r
1521 to a NULL on entry, then a buffer\r
1522 will be allocated to hold the generated image and\r
ac644614 1523 the pointer updated on exit. It is the caller's\r
93e3992d 1524 responsibility to free this buffer.\r
e90b081a 1525 @param BltX Specifies the offset from the left and top edge\r
1526 of the image of the first character cell in the\r
1527 image.\r
1528 @param BltY Specifies the offset from the left and top edge\r
93e3992d 1529 of the image of the first character cell in the\r
1530 image.\r
1531 @param RowInfoArray If this is non-NULL on entry, then on exit, this\r
1532 will point to an allocated buffer containing\r
1533 row information and RowInfoArraySize will be\r
1534 updated to contain the number of elements.\r
1535 This array describes the characters which were at\r
1536 least partially drawn and the heights of the\r
ac644614 1537 rows. It is the caller's responsibility to free\r
93e3992d 1538 this buffer.\r
1539 @param RowInfoArraySize If this is non-NULL on entry, then on exit it\r
1540 contains the number of elements in RowInfoArray.\r
1541 @param ColumnInfoArray If this is non-NULL, then on return it will be\r
1542 filled with the horizontal offset for each\r
1543 character in the string on the row where it is\r
1544 displayed. Non-printing characters will have\r
1545 the offset ~0. The caller is responsible to\r
1546 allocate a buffer large enough so that there\r
1547 is one entry for each character in the string,\r
1548 not including the null-terminator. It is possible\r
1549 when character display is normalized that some\r
1550 character cells overlap.\r
1551\r
1552 @retval EFI_SUCCESS The string was successfully rendered.\r
1553 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for\r
1554 RowInfoArray or Blt.\r
1555 @retval EFI_INVALID_PARAMETER The String or Blt was NULL.\r
813acf3a 1556 @retval EFI_INVALID_PARAMETER Flags were invalid combination..\r
93e3992d 1557\r
1558**/\r
1559EFI_STATUS\r
1560EFIAPI\r
1561HiiStringToImage (\r
1562 IN CONST EFI_HII_FONT_PROTOCOL *This,\r
1563 IN EFI_HII_OUT_FLAGS Flags,\r
1564 IN CONST EFI_STRING String,\r
1565 IN CONST EFI_FONT_DISPLAY_INFO *StringInfo OPTIONAL,\r
1566 IN OUT EFI_IMAGE_OUTPUT **Blt,\r
1567 IN UINTN BltX,\r
1568 IN UINTN BltY,\r
1569 OUT EFI_HII_ROW_INFO **RowInfoArray OPTIONAL,\r
1570 OUT UINTN *RowInfoArraySize OPTIONAL,\r
1571 OUT UINTN *ColumnInfoArray OPTIONAL\r
1572 )\r
1573{\r
1574 EFI_STATUS Status;\r
1575 HII_DATABASE_PRIVATE_DATA *Private;\r
1576 UINT8 **GlyphBuf;\r
1577 EFI_HII_GLYPH_INFO *Cell;\r
1578 UINT8 *Attributes;\r
1579 EFI_IMAGE_OUTPUT *Image;\r
1580 EFI_STRING StringPtr;\r
1581 EFI_STRING StringTmp;\r
1582 EFI_HII_ROW_INFO *RowInfo;\r
1583 UINTN LineWidth;\r
1584 UINTN LineHeight;\r
f6cf5cf8
LG		 1585 UINTN LineOffset;\r
1586 UINTN LastLineHeight;\r
93e3992d 1587 UINTN BaseLineOffset;\r
1588 UINT16 MaxRowNum;\r
1589 UINT16 RowIndex;\r
1590 UINTN Index;\r
f6cf5cf8 1591 UINTN NextIndex;\r
93e3992d 1592 UINTN Index1;\r
1593 EFI_FONT_DISPLAY_INFO *StringInfoOut;\r
1594 EFI_FONT_DISPLAY_INFO *SystemDefault;\r
1595 EFI_FONT_HANDLE FontHandle;\r
1596 EFI_STRING StringIn;\r
1597 EFI_STRING StringIn2;\r
1598 UINT16 Height;\r
f6cf5cf8 1599 UINT16 BaseLine;\r
93e3992d 1600 EFI_FONT_INFO *FontInfo;\r
1601 BOOLEAN SysFontFlag;\r
1602 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground;\r
1603 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background;\r
1604 BOOLEAN Transparent;\r
1605 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer;\r
1606 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BufferPtr;\r
1607 UINTN RowInfoSize;\r
1608 BOOLEAN LineBreak;\r
4772ce75 1609 UINTN StrLength;\r
f6cf5cf8
LG		 1610 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *RowBufferPtr;\r
1611 HII_GLOBAL_FONT_INFO *GlobalFont;\r
0672c2cd 1612 UINT32 PreInitBkgnd;\r
93e3992d 1613\r
1614 //\r
1615 // Check incoming parameters.\r
1616 //\r
1617\r
1618 if (This == NULL || String == NULL || Blt == NULL) {\r
1619 return EFI_INVALID_PARAMETER;\r
1620 }\r
1621 if (*Blt == NULL) {\r
1622 //\r
1623 // These two flag cannot be used if Blt is NULL upon entry.\r
1624 //\r
1625 if ((Flags & EFI_HII_OUT_FLAG_TRANSPARENT) == EFI_HII_OUT_FLAG_TRANSPARENT) {\r
1626 return EFI_INVALID_PARAMETER;\r
1627 }\r
1628 if ((Flags & EFI_HII_OUT_FLAG_CLIP) == EFI_HII_OUT_FLAG_CLIP) {\r
1629 return EFI_INVALID_PARAMETER;\r
1630 }\r
1631 }\r
1632 //\r
1633 // These two flags require that EFI_HII_OUT_FLAG_CLIP be also set.\r
1634 //\r
813acf3a 1635 if ((Flags & (EFI_HII_OUT_FLAG_CLIP | EFI_HII_OUT_FLAG_CLIP_CLEAN_X)) == EFI_HII_OUT_FLAG_CLIP_CLEAN_X) {\r
93e3992d 1636 return EFI_INVALID_PARAMETER;\r
1637 }\r
813acf3a 1638 if ((Flags & (EFI_HII_OUT_FLAG_CLIP | EFI_HII_OUT_FLAG_CLIP_CLEAN_Y)) == EFI_HII_OUT_FLAG_CLIP_CLEAN_Y) {\r
93e3992d 1639 return EFI_INVALID_PARAMETER;\r
1640 }\r
1641 //\r
1642 // This flag cannot be used with EFI_HII_OUT_FLAG_CLEAN_X.\r
1643 //\r
813acf3a 1644 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 1645 return EFI_INVALID_PARAMETER;\r
1646 }\r
1647\r
4772ce75 1648 if (*Blt == NULL) {\r
1649 //\r
1650 // Create a new bitmap and draw the string onto this image.\r
1651 //\r
1652 Image = AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT));\r
1653 if (Image == NULL) {\r
1654 return EFI_OUT_OF_RESOURCES;\r
1655 }\r
1656 Image->Width = 800;\r
1657 Image->Height = 600;\r
1658 Image->Image.Bitmap = AllocateZeroPool (Image->Width * Image->Height *sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));\r
1659 if (Image->Image.Bitmap == NULL) {\r
1660 FreePool (Image);\r
1661 return EFI_OUT_OF_RESOURCES;\r
1662 }\r
1663\r
1664 //\r
1665 // Other flags are not permitted when Blt is NULL.\r
1666 //\r
1667 Flags &= EFI_HII_OUT_FLAG_WRAP | EFI_HII_IGNORE_IF_NO_GLYPH | EFI_HII_IGNORE_LINE_BREAK;\r
1668 *Blt = Image;\r
1669 }\r
1670\r
1671 StrLength = StrLen(String);\r
1672 GlyphBuf = (UINT8 **) AllocateZeroPool (StrLength * sizeof (UINT8 *));\r
93e3992d 1673 ASSERT (GlyphBuf != NULL);\r
4772ce75 1674 Cell = (EFI_HII_GLYPH_INFO *) AllocateZeroPool (StrLength * sizeof (EFI_HII_GLYPH_INFO));\r
93e3992d 1675 ASSERT (Cell != NULL);\r
4772ce75 1676 Attributes = (UINT8 *) AllocateZeroPool (StrLength * sizeof (UINT8));\r
93e3992d 1677 ASSERT (Attributes != NULL);\r
1678\r
1679 RowInfo = NULL;\r
1680 Status = EFI_SUCCESS;\r
1681 StringIn2 = NULL;\r
1682 SystemDefault = NULL;\r
96ff65a1 1683 StringIn = NULL;\r
93e3992d 1684\r
1685 //\r
1686 // Calculate the string output information, including specified color and font .\r
1687 // If StringInfo does not points to system font info, it must indicate an existing\r
1688 // EFI_FONT_INFO.\r
1689 //\r
1690 StringInfoOut = NULL;\r
1691 FontHandle = NULL;\r
1692 Private = HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
1693 SysFontFlag = IsSystemFontInfo (Private, (EFI_FONT_DISPLAY_INFO *) StringInfo, &SystemDefault, NULL);\r
1694\r
1695 if (SysFontFlag) {\r
523f48e7 1696 ASSERT (SystemDefault != NULL);\r
93e3992d 1697 FontInfo = NULL;\r
1698 Height = SystemDefault->FontInfo.FontSize;\r
f6cf5cf8 1699 BaseLine = SystemDefault->FontInfo.FontSize;\r
93e3992d 1700 Foreground = SystemDefault->ForegroundColor;\r
1701 Background = SystemDefault->BackgroundColor;\r
1702\r
1703 } else {\r
7b06dc8a 1704 //\r
1705 // StringInfo must not be NULL if it is not system info.\r
1706 //\r
1707 ASSERT (StringInfo != NULL);\r
93e3992d 1708 Status = HiiGetFontInfo (This, &FontHandle, (EFI_FONT_DISPLAY_INFO *) StringInfo, &StringInfoOut, NULL);\r
1709 if (Status == EFI_NOT_FOUND) {\r
1710 //\r
1711 // The specified EFI_FONT_DISPLAY_INFO does not exist in current database.\r
1712 // Use the system font instead. Still use the color specified by StringInfo.\r
1713 //\r
1714 SysFontFlag = TRUE;\r
1715 FontInfo = NULL;\r
1716 Height = SystemDefault->FontInfo.FontSize;\r
f6cf5cf8 1717 BaseLine = SystemDefault->FontInfo.FontSize;\r
93e3992d 1718 Foreground = ((EFI_FONT_DISPLAY_INFO *) StringInfo)->ForegroundColor;\r
1719 Background = ((EFI_FONT_DISPLAY_INFO *) StringInfo)->BackgroundColor;\r
1720\r
96ff65a1 1721 } else if (Status == EFI_SUCCESS) {\r
93e3992d 1722 FontInfo = &StringInfoOut->FontInfo;\r
f6cf5cf8
LG		 1723 IsFontInfoExisted (Private, FontInfo, NULL, NULL, &GlobalFont);\r
1724 Height = GlobalFont->FontPackage->Height;\r
1725 BaseLine = GlobalFont->FontPackage->BaseLine;\r
93e3992d 1726 Foreground = StringInfoOut->ForegroundColor;\r
1727 Background = StringInfoOut->BackgroundColor;\r
96ff65a1 1728 } else {\r
1729 goto Exit;\r
93e3992d 1730 }\r
1731 }\r
f6cf5cf8
LG		 1732 \r
1733 //\r
1734 // Use the maxinum height of font as the base line.\r
1735 // And, use the maxinum height as line height.\r
1736 //\r
1737 LineHeight = Height;\r
1738 LastLineHeight = Height;\r
1739 BaseLineOffset = Height - BaseLine;\r
1740 \r
93e3992d 1741 //\r
1742 // Parse the string to be displayed to drop some ignored characters.\r
1743 //\r
1744\r
1745 StringPtr = String;\r
93e3992d 1746\r
1747 //\r
1748 // Ignore line-break characters only. Hyphens or dash character will be displayed\r
1749 // without line-break opportunity.\r
1750 //\r
1751 if ((Flags & EFI_HII_IGNORE_LINE_BREAK) == EFI_HII_IGNORE_LINE_BREAK) {\r
1752 StringIn = AllocateZeroPool (StrSize (StringPtr));\r
1753 if (StringIn == NULL) {\r
1754 Status = EFI_OUT_OF_RESOURCES;\r
1755 goto Exit;\r
1756 }\r
1757 StringTmp = StringIn;\r
1758 while (*StringPtr != 0) {\r
1759 if (IsLineBreak (*StringPtr) == 0) {\r
1760 StringPtr++;\r
1761 } else {\r
1762 *StringTmp++ = *StringPtr++;\r
1763 }\r
1764 }\r
1765 *StringTmp = 0;\r
1766 StringPtr = StringIn;\r
1767 }\r
1768 //\r
1769 // If EFI_HII_IGNORE_IF_NO_GLYPH is set, then characters which have no glyphs\r
1770 // are not drawn. Otherwise they are replaced wth Unicode character 0xFFFD.\r
1771 //\r
1772 StringIn2 = AllocateZeroPool (StrSize (StringPtr));\r
1773 if (StringIn2 == NULL) {\r
1774 Status = EFI_OUT_OF_RESOURCES;\r
1775 goto Exit;\r
1776 }\r
1777 Index = 0;\r
1778 StringTmp = StringIn2;\r
4772ce75 1779 StrLength = StrLen(StringPtr);\r
1780 while (*StringPtr != 0 && Index < StrLength) {\r
f6cf5cf8
LG		 1781 if (IsLineBreak (*StringPtr) == 0) {\r
1782 *StringTmp++ = *StringPtr++;\r
1783 Index++;\r
1784 continue;\r
1785 }\r
1786 \r
93e3992d 1787 Status = GetGlyphBuffer (Private, *StringPtr, FontInfo, &GlyphBuf[Index], &Cell[Index], &Attributes[Index]);\r
1788 if (Status == EFI_NOT_FOUND) {\r
1789 if ((Flags & EFI_HII_IGNORE_IF_NO_GLYPH) == EFI_HII_IGNORE_IF_NO_GLYPH) {\r
93e3992d 1790 GlyphBuf[Index] = NULL;\r
f6cf5cf8
LG		 1791 ZeroMem (&Cell[Index], sizeof (Cell[Index]));\r
1792 Status = EFI_SUCCESS;\r
93e3992d 1793 } else {\r
1794 //\r
1795 // Unicode 0xFFFD must exist in current hii database if this flag is not set.\r
1796 //\r
1797 Status = GetGlyphBuffer (\r
1798 Private,\r
1799 REPLACE_UNKNOWN_GLYPH,\r
1800 FontInfo,\r
1801 &GlyphBuf[Index],\r
1802 &Cell[Index],\r
1803 &Attributes[Index]\r
1804 );\r
1805 if (EFI_ERROR (Status)) {\r
1806 Status = EFI_INVALID_PARAMETER;\r
93e3992d 1807 }\r
93e3992d 1808 }\r
f6cf5cf8
LG		 1809 }\r
1810\r
1811 if (EFI_ERROR (Status)) {\r
93e3992d 1812 goto Exit;\r
93e3992d 1813 }\r
f6cf5cf8
LG		 1814\r
1815 *StringTmp++ = *StringPtr++;\r
1816 Index++;\r
93e3992d 1817 }\r
1818 *StringTmp = 0;\r
1819 StringPtr = StringIn2;\r
1820\r
1821 //\r
1822 // Draw the string according to the specified EFI_HII_OUT_FLAGS and Blt.\r
1823 // If Blt is not NULL, then EFI_HII_OUT_FLAG_CLIP is implied, render this string\r
1824 // to an existing image (bitmap or screen depending on flags) pointed by "*Blt".\r
1825 // Otherwise render this string to a new allocated image and output it.\r
1826 //\r
4772ce75 1827 Image = *Blt;\r
1828 BufferPtr = Image->Image.Bitmap + Image->Width * BltY + BltX;\r
5cfe4234
LG		 1829 if (Image->Height < BltY) {\r
1830 //\r
1831 // the top edge of the image should be in Image resolution scope.\r
1832 //\r
1833 Status = EFI_INVALID_PARAMETER;\r
1834 goto Exit;\r
1835 }\r
f6cf5cf8
LG		 1836 MaxRowNum = (UINT16) ((Image->Height - BltY) / Height);\r
1837 if ((Image->Height - BltY) % Height != 0) {\r
1838 LastLineHeight = (Image->Height - BltY) % Height;\r
4772ce75 1839 MaxRowNum++;\r
1840 }\r
93e3992d 1841\r
4772ce75 1842 RowInfo = (EFI_HII_ROW_INFO *) AllocateZeroPool (MaxRowNum * sizeof (EFI_HII_ROW_INFO));\r
1843 if (RowInfo == NULL) {\r
1844 Status = EFI_OUT_OF_RESOURCES;\r
1845 goto Exit;\r
1846 }\r
1847\r
1848 //\r
1849 // Format the glyph buffer according to flags.\r
1850 //\r
4772ce75 1851 Transparent = (BOOLEAN) ((Flags & EFI_HII_OUT_FLAG_TRANSPARENT) == EFI_HII_OUT_FLAG_TRANSPARENT ? TRUE : FALSE);\r
4772ce75 1852\r
1853 for (RowIndex = 0, Index = 0; RowIndex < MaxRowNum && StringPtr[Index] != 0; ) {\r
1854 LineWidth = 0;\r
4772ce75 1855 LineBreak = FALSE;\r
93e3992d 1856\r
f6cf5cf8
LG		 1857 //\r
1858 // Clip the final row if the row's bottom-most on pixel cannot fit when\r
1859 // EFI_HII_OUT_FLAG_CLEAN_Y is set.\r
1860 //\r
1861 if (RowIndex == MaxRowNum - 1) {\r
1862 if ((Flags & EFI_HII_OUT_FLAG_CLIP_CLEAN_Y) == EFI_HII_OUT_FLAG_CLIP_CLEAN_Y && LastLineHeight < LineHeight ) {\r
1863 //\r
1864 // Don't draw at all if the row's bottom-most on pixel cannot fit.\r
1865 //\r
1866 break;\r
1867 }\r
1868 LineHeight = LastLineHeight;\r
1869 }\r
1870\r
93e3992d 1871 //\r
4772ce75 1872 // Calculate how many characters there are in a row.\r
93e3992d 1873 //\r
4772ce75 1874 RowInfo[RowIndex].StartIndex = Index;\r
93e3992d 1875\r
4772ce75 1876 while (LineWidth + BltX < Image->Width && StringPtr[Index] != 0) {\r
1877 if ((Flags & EFI_HII_IGNORE_LINE_BREAK) == 0 &&\r
4772ce75 1878 IsLineBreak (StringPtr[Index]) == 0) {\r
1879 //\r
1880 // It forces a line break that ends this row.\r
1881 //\r
1882 Index++;\r
35c218d7 1883 LineBreak = TRUE;\r
4772ce75 1884 break;\r
93e3992d 1885 }\r
93e3992d 1886\r
1887 //\r
4772ce75 1888 // If the glyph of the character is existing, then accumulate the actual printed width\r
93e3992d 1889 //\r
f6cf5cf8 1890 LineWidth += (UINTN) Cell[Index].AdvanceX;\r
93e3992d 1891\r
4772ce75 1892 Index++;\r
1893 }\r
93e3992d 1894\r
4772ce75 1895 //\r
f6cf5cf8
LG		 1896 // Record index of next char.\r
1897 //\r
1898 NextIndex = Index;\r
1899 //\r
1900 // Return to the previous char.\r
4772ce75 1901 //\r
1902 Index--;\r
f6cf5cf8
LG		 1903 if (LineBreak && Index > 0 ) {\r
1904 //\r
1905 // Return the previous non line break char.\r
1906 //\r
1907 Index --;\r
4772ce75 1908 }\r
93e3992d 1909\r
f6cf5cf8
LG		 1910 //\r
1911 // If this character is the last character of a row, we need not\r
1912 // draw its (AdvanceX - Width - OffsetX) for next character.\r
1913 //\r
1914 LineWidth -= (UINTN) (Cell[Index].AdvanceX - Cell[Index].Width - Cell[Index].OffsetX);\r
1915\r
4772ce75 1916 //\r
1917 // Clip the right-most character if cannot fit when EFI_HII_OUT_FLAG_CLEAN_X is set.\r
1918 //\r
1919 if (LineWidth + BltX <= Image->Width ||\r
1920 (LineWidth + BltX > Image->Width && (Flags & EFI_HII_OUT_FLAG_CLIP_CLEAN_X) == 0)) {\r
93e3992d 1921 //\r
4772ce75 1922 // Record right-most character in RowInfo even if it is partially displayed.\r
93e3992d 1923 //\r
4772ce75 1924 RowInfo[RowIndex].EndIndex = Index;\r
1925 RowInfo[RowIndex].LineWidth = LineWidth;\r
1926 RowInfo[RowIndex].LineHeight = LineHeight;\r
1927 RowInfo[RowIndex].BaselineOffset = BaseLineOffset;\r
1928 } else {\r
93e3992d 1929 //\r
4772ce75 1930 // When EFI_HII_OUT_FLAG_CLEAN_X is set, it will not draw a character\r
1931 // if its right-most on pixel cannot fit.\r
93e3992d 1932 //\r
fbf82a2c 1933 if (Index > RowInfo[RowIndex].StartIndex) {\r
f6cf5cf8
LG		 1934 //\r
1935 // Don't draw the last char on this row. And, don't draw the second last char (AdvanceX - Width - OffsetX).\r
1936 //\r
1937 LineWidth -= (UINTN) (Cell[Index].Width + Cell[Index].OffsetX);\r
1938 LineWidth -= (UINTN) (Cell[Index - 1].AdvanceX - Cell[Index - 1].Width - Cell[Index - 1].OffsetX);\r
4772ce75 1939 RowInfo[RowIndex].EndIndex = Index - 1;\r
f6cf5cf8 1940 RowInfo[RowIndex].LineWidth = LineWidth;\r
4772ce75 1941 RowInfo[RowIndex].LineHeight = LineHeight;\r
f6cf5cf8 1942 RowInfo[RowIndex].BaselineOffset = BaseLineOffset;\r
4772ce75 1943 } else {\r
93e3992d 1944 //\r
fbf82a2c
LG		 1945 // There is no enough column to draw any character, so set current line width to zero.\r
1946 // And go to draw Next line if LineBreak is set.\r
93e3992d 1947 //\r
fbf82a2c
LG		 1948 RowInfo[RowIndex].LineWidth = 0;\r
1949 goto NextLine;\r
93e3992d 1950 }\r
4772ce75 1951 }\r
93e3992d 1952\r
4772ce75 1953 //\r
1954 // EFI_HII_OUT_FLAG_WRAP will wrap the text at the right-most line-break\r
1955 // opportunity prior to a character whose right-most extent would exceed Width.\r
1956 // Search the right-most line-break opportunity here.\r
1957 //\r
fbf82a2c
LG		 1958 if ((Flags & EFI_HII_OUT_FLAG_WRAP) == EFI_HII_OUT_FLAG_WRAP && \r
1959 (RowInfo[RowIndex].LineWidth + BltX > Image->Width || StringPtr[NextIndex] != 0) && \r
1960 !LineBreak) {\r
4772ce75 1961 if ((Flags & EFI_HII_IGNORE_LINE_BREAK) == 0) {\r
f6cf5cf8 1962 LineWidth = RowInfo[RowIndex].LineWidth;\r
4772ce75 1963 for (Index1 = RowInfo[RowIndex].EndIndex; Index1 >= RowInfo[RowIndex].StartIndex; Index1--) {\r
f6cf5cf8
LG		 1964 if (Index1 == RowInfo[RowIndex].EndIndex) {\r
1965 LineWidth -= (Cell[Index1].Width + Cell[Index1].OffsetX);\r
1966 } else {\r
1967 LineWidth -= Cell[Index1].AdvanceX;\r
1968 }\r
4772ce75 1969 if (IsLineBreak (StringPtr[Index1]) > 0) {\r
1970 LineBreak = TRUE;\r
f6cf5cf8
LG		 1971 if (Index1 > RowInfo[RowIndex].StartIndex) {\r
1972 RowInfo[RowIndex].EndIndex = Index1 - 1;\r
1973 }\r
4772ce75 1974 //\r
1975 // relocate to the character after the right-most line break opportunity of this line\r
1976 //\r
f6cf5cf8 1977 NextIndex = Index1 + 1;\r
4772ce75 1978 break;\r
1979 }\r
35c218d7 1980 //\r
1981 // If don't find a line break opportunity from EndIndex to StartIndex,\r
1982 // then jump out.\r
1983 //\r
1984 if (Index1 == RowInfo[RowIndex].StartIndex)\r
1985 break;\r
4772ce75 1986 }\r
f6cf5cf8
LG		 1987\r
1988 //\r
1989 // Update LineWidth to the real width\r
1990 //\r
1991 if (IsLineBreak (StringPtr[Index1]) > 0) {\r
1992 if (Index1 == RowInfo[RowIndex].StartIndex) {\r
1993 LineWidth = 0;\r
1994 } else {\r
1995 LineWidth -= (UINTN) (Cell[Index1 - 1].AdvanceX - Cell[Index1 - 1].Width - Cell[Index1 - 1].OffsetX);\r
1996 }\r
1997 RowInfo[RowIndex].LineWidth = LineWidth;\r
1998 }\r
4772ce75 1999 }\r
93e3992d 2000 //\r
4772ce75 2001 // If no line-break opportunity can be found, then the text will\r
2002 // behave as if EFI_HII_OUT_FLAG_CLEAN_X is set.\r
93e3992d 2003 //\r
4772ce75 2004 if (!LineBreak) {\r
fbf82a2c
LG		 2005 LineWidth = RowInfo[RowIndex].LineWidth;\r
2006 Index1 = RowInfo[RowIndex].EndIndex;\r
2007 if (LineWidth + BltX > Image->Width) {\r
2008 if (Index1 > RowInfo[RowIndex].StartIndex) {\r
2009 //\r
2010 // Don't draw the last char on this row. And, don't draw the second last char (AdvanceX - Width - OffsetX).\r
2011 //\r
2012 LineWidth -= (UINTN) (Cell[Index1].Width + Cell[Index1].OffsetX);\r
2013 LineWidth -= (UINTN) (Cell[Index1 - 1].AdvanceX - Cell[Index1 - 1].Width - Cell[Index1 - 1].OffsetX);\r
2014 RowInfo[RowIndex].EndIndex = Index1 - 1;\r
2015 RowInfo[RowIndex].LineWidth = LineWidth;\r
2016 } else {\r
2017 //\r
2018 // There is no enough column to draw any character, so set current line width to zero.\r
2019 // And go to draw Next line if LineBreak is set.\r
2020 //\r
2021 RowInfo[RowIndex].LineWidth = 0;\r
2022 goto NextLine;\r
2023 }\r
2024 }\r
4772ce75 2025 }\r
2026 }\r
f6cf5cf8 2027 \r
4772ce75 2028 //\r
f6cf5cf8 2029 // LineWidth can't exceed Image width.\r
4772ce75 2030 //\r
f6cf5cf8
LG		 2031 if (RowInfo[RowIndex].LineWidth + BltX > Image->Width) {\r
2032 RowInfo[RowIndex].LineWidth = Image->Width - BltX;\r
4772ce75 2033 }\r
93e3992d 2034\r
4772ce75 2035 //\r
2036 // Draw it to screen or existing bitmap depending on whether\r
2037 // EFI_HII_DIRECT_TO_SCREEN is set.\r
2038 //\r
f6cf5cf8 2039 LineOffset = 0;\r
4772ce75 2040 if ((Flags & EFI_HII_DIRECT_TO_SCREEN) == EFI_HII_DIRECT_TO_SCREEN) {\r
f6cf5cf8
LG		 2041 BltBuffer = NULL;\r
2042 if (RowInfo[RowIndex].LineWidth != 0) {\r
2043 BltBuffer = AllocateZeroPool (RowInfo[RowIndex].LineWidth * RowInfo[RowIndex].LineHeight * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));\r
2044 if (BltBuffer == NULL) {\r
2045 Status = EFI_OUT_OF_RESOURCES;\r
2046 goto Exit;\r
2047 }\r
2048 //\r
0672c2cd
DB		 2049 // Initialize the background color.\r
2050 //\r
2051 PreInitBkgnd = Background.Blue | Background.Green << 8 | Background.Red << 16;\r
2052 SetMem32 (BltBuffer,RowInfo[RowIndex].LineWidth * RowInfo[RowIndex].LineHeight * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL),PreInitBkgnd);\r
2053 //\r
f6cf5cf8
LG		 2054 // Set BufferPtr to Origin by adding baseline to the starting position.\r
2055 //\r
2056 BufferPtr = BltBuffer + BaseLine * RowInfo[RowIndex].LineWidth;\r
4772ce75 2057 }\r
4772ce75 2058 for (Index1 = RowInfo[RowIndex].StartIndex; Index1 <= RowInfo[RowIndex].EndIndex; Index1++) {\r
f6cf5cf8 2059 if (RowInfo[RowIndex].LineWidth > 0 && RowInfo[RowIndex].LineWidth > LineOffset) {\r
93e3992d 2060 //\r
4772ce75 2061 // Only BLT these character which have corrsponding glyph in font basebase.\r
93e3992d 2062 //\r
93e3992d 2063 GlyphToImage (\r
2064 GlyphBuf[Index1],\r
2065 Foreground,\r
2066 Background,\r
f6cf5cf8
LG		 2067 (UINT16) RowInfo[RowIndex].LineWidth,\r
2068 BaseLine,\r
2069 RowInfo[RowIndex].LineWidth - LineOffset,\r
93e3992d 2070 RowInfo[RowIndex].LineHeight,\r
2071 Transparent,\r
50b39985 2072 &Cell[Index1],\r
93e3992d 2073 Attributes[Index1],\r
2074 &BufferPtr\r
4772ce75 2075 );\r
93e3992d 2076 }\r
4772ce75 2077 if (ColumnInfoArray != NULL) {\r
f6cf5cf8
LG		 2078 if ((GlyphBuf[Index1] == NULL && Cell[Index1].AdvanceX == 0) \r
2079 || RowInfo[RowIndex].LineWidth == 0) {\r
2080 *ColumnInfoArray = (UINTN) ~0;\r
4772ce75 2081 } else {\r
f6cf5cf8 2082 *ColumnInfoArray = LineOffset + Cell[Index1].OffsetX + BltX;\r
4772ce75 2083 }\r
2084 ColumnInfoArray++;\r
93e3992d 2085 }\r
f6cf5cf8 2086 LineOffset += Cell[Index1].AdvanceX;\r
4772ce75 2087 }\r
93e3992d 2088\r
f6cf5cf8
LG		 2089 if (BltBuffer != NULL) {\r
2090 Status = Image->Image.Screen->Blt (\r
2091 Image->Image.Screen,\r
2092 BltBuffer,\r
2093 EfiBltBufferToVideo,\r
2094 0,\r
2095 0,\r
2096 BltX,\r
2097 BltY,\r
2098 RowInfo[RowIndex].LineWidth,\r
2099 RowInfo[RowIndex].LineHeight,\r
2100 0\r
2101 );\r
2102 if (EFI_ERROR (Status)) {\r
2103 FreePool (BltBuffer);\r
2104 goto Exit;\r
2105 }\r
2106 \r
676df92c 2107 FreePool (BltBuffer);\r
4772ce75 2108 }\r
4772ce75 2109 } else {\r
f6cf5cf8
LG		 2110 //\r
2111 // Save the starting position for calculate the starting postition of next row. \r
2112 //\r
2113 RowBufferPtr = BufferPtr;\r
2114 //\r
2115 // Set BufferPtr to Origin by adding baseline to the starting position.\r
2116 //\r
2117 BufferPtr = BufferPtr + BaseLine * Image->Width;\r
4772ce75 2118 for (Index1 = RowInfo[RowIndex].StartIndex; Index1 <= RowInfo[RowIndex].EndIndex; Index1++) {\r
f6cf5cf8 2119 if (RowInfo[RowIndex].LineWidth > 0 && RowInfo[RowIndex].LineWidth > LineOffset) {\r
4772ce75 2120 //\r
2121 // Only BLT these character which have corrsponding glyph in font basebase.\r
2122 //\r
93e3992d 2123 GlyphToImage (\r
2124 GlyphBuf[Index1],\r
2125 Foreground,\r
2126 Background,\r
2127 Image->Width,\r
f6cf5cf8
LG		 2128 BaseLine,\r
2129 RowInfo[RowIndex].LineWidth - LineOffset,\r
2130 RowInfo[RowIndex].LineHeight,\r
93e3992d 2131 Transparent,\r
50b39985 2132 &Cell[Index1],\r
93e3992d 2133 Attributes[Index1],\r
2134 &BufferPtr\r
4772ce75 2135 );\r
2136 }\r
2137 if (ColumnInfoArray != NULL) {\r
f6cf5cf8
LG		 2138 if ((GlyphBuf[Index1] == NULL && Cell[Index1].AdvanceX == 0) \r
2139 || RowInfo[RowIndex].LineWidth == 0) {\r
2140 *ColumnInfoArray = (UINTN) ~0;\r
4772ce75 2141 } else {\r
f6cf5cf8 2142 *ColumnInfoArray = LineOffset + Cell[Index1].OffsetX + BltX;\r
93e3992d 2143 }\r
4772ce75 2144 ColumnInfoArray++;\r
93e3992d 2145 }\r
f6cf5cf8 2146 LineOffset += Cell[Index1].AdvanceX;\r
93e3992d 2147 }\r
f6cf5cf8 2148\r
4772ce75 2149 //\r
f6cf5cf8 2150 // Jump to starting position of next row.\r
4772ce75 2151 //\r
f6cf5cf8
LG		 2152 if (RowIndex == 0) {\r
2153 BufferPtr = RowBufferPtr - BltX + LineHeight * Image->Width;\r
2154 } else {\r
2155 BufferPtr = RowBufferPtr + LineHeight * Image->Width;\r
2156 }\r
93e3992d 2157 }\r
2158\r
fbf82a2c 2159NextLine:\r
f6cf5cf8 2160 //\r
3a2718d7 2161 // Recalculate the start point of Y axis to draw multi-lines with the order of top-to-down\r
f6cf5cf8 2162 //\r
f6cf5cf8
LG		 2163 BltY += RowInfo[RowIndex].LineHeight;\r
2164\r
4772ce75 2165 RowIndex++;\r
f6cf5cf8 2166 Index = NextIndex;\r
93e3992d 2167\r
35c218d7 2168 if (!LineBreak) {\r
4772ce75 2169 //\r
35c218d7 2170 // If there is not a mandatory line break or line break opportunity, only render one line to image\r
4772ce75 2171 //\r
2172 break;\r
93e3992d 2173 }\r
4772ce75 2174 }\r
93e3992d 2175\r
4772ce75 2176 //\r
2177 // Write output parameters.\r
2178 //\r
2179 RowInfoSize = RowIndex * sizeof (EFI_HII_ROW_INFO);\r
2180 if (RowInfoArray != NULL) {\r
f6cf5cf8
LG		 2181 if (RowInfoSize > 0) {\r
2182 *RowInfoArray = AllocateZeroPool (RowInfoSize);\r
2183 if (*RowInfoArray == NULL) {\r
2184 Status = EFI_OUT_OF_RESOURCES;\r
2185 goto Exit;\r
2186 }\r
2187 CopyMem (*RowInfoArray, RowInfo, RowInfoSize);\r
2188 } else {\r
2189 *RowInfoArray = NULL;\r
93e3992d 2190 }\r
4772ce75 2191 }\r
2192 if (RowInfoArraySize != NULL) {\r
2193 *RowInfoArraySize = RowIndex;\r
93e3992d 2194 }\r
2195\r
2196 Status = EFI_SUCCESS;\r
2197\r
2198Exit:\r
2199\r
4772ce75 2200 for (Index = 0; Index < StrLength; Index++) {\r
676df92c 2201 if (GlyphBuf[Index] != NULL) {\r
2202 FreePool (GlyphBuf[Index]);\r
2203 }\r
2204 }\r
2205 if (StringIn != NULL) {\r
2206 FreePool (StringIn);\r
2207 }\r
2208 if (StringIn2 != NULL) {\r
2209 FreePool (StringIn2);\r
2210 }\r
2211 if (StringInfoOut != NULL) {\r
2212 FreePool (StringInfoOut);\r
2213 }\r
2214 if (RowInfo != NULL) {\r
2215 FreePool (RowInfo);\r
2216 }\r
2217 if (SystemDefault != NULL) {\r
2218 FreePool (SystemDefault);\r
2219 }\r
2220 if (GlyphBuf != NULL) {\r
2221 FreePool (GlyphBuf);\r
2222 }\r
2223 if (Cell != NULL) {\r
2224 FreePool (Cell);\r
2225 }\r
2226 if (Attributes != NULL) {\r
2227 FreePool (Attributes);\r
93e3992d 2228 }\r
93e3992d 2229\r
2230 return Status;\r
2231}\r
2232\r
2233\r
2234/**\r
2235 Render a string to a bitmap or the screen containing the contents of the specified string.\r
2236\r
2237 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.\r
2238 @param Flags Describes how the string is to be drawn.\r
2239 @param PackageList The package list in the HII database to search\r
2240 for the specified string.\r
ac644614 2241 @param StringId The string's id, which is unique within\r
93e3992d 2242 PackageList.\r
2243 @param Language Points to the language for the retrieved string.\r
2244 If NULL, then the current system language is\r
2245 used.\r
2246 @param StringInfo Points to the string output information,\r
2247 including the color and font. If NULL, then the\r
2248 string will be output in the default system font\r
2249 and color.\r
2250 @param Blt If this points to a non-NULL on entry, this\r
2251 points to the image, which is Width pixels wide\r
2252 and Height pixels high. The string will be drawn\r
2253 onto this image and\r
2254 EFI_HII_OUT_FLAG_CLIP is implied. If this points\r
2255 to a NULL on entry, then a buffer\r
2256 will be allocated to hold the generated image and\r
ac644614 2257 the pointer updated on exit. It is the caller's\r
93e3992d 2258 responsibility to free this buffer.\r
e90b081a 2259 @param BltX Specifies the offset from the left and top edge\r
2260 of the image of the first character cell in the\r
2261 image.\r
2262 @param BltY Specifies the offset from the left and top edge\r
93e3992d 2263 of the image of the first character cell in the\r
2264 image.\r
2265 @param RowInfoArray If this is non-NULL on entry, then on exit, this\r
2266 will point to an allocated buffer containing\r
2267 row information and RowInfoArraySize will be\r
2268 updated to contain the number of elements.\r
2269 This array describes the characters which were at\r
2270 least partially drawn and the heights of the\r
ac644614 2271 rows. It is the caller's responsibility to free\r
93e3992d 2272 this buffer.\r
2273 @param RowInfoArraySize If this is non-NULL on entry, then on exit it\r
2274 contains the number of elements in RowInfoArray.\r
2275 @param ColumnInfoArray If this is non-NULL, then on return it will be\r
2276 filled with the horizontal offset for each\r
2277 character in the string on the row where it is\r
2278 displayed. Non-printing characters will have\r
2279 the offset ~0. The caller is responsible to\r
2280 allocate a buffer large enough so that there\r
2281 is one entry for each character in the string,\r
2282 not including the null-terminator. It is possible\r
2283 when character display is normalized that some\r
2284 character cells overlap.\r
2285\r
2286 @retval EFI_SUCCESS The string was successfully rendered.\r
2287 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for\r
2288 RowInfoArray or Blt.\r
813acf3a 2289 @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.\r
2290 @retval EFI_INVALID_PARAMETER Flags were invalid combination.\r
2291 @retval EFI_NOT_FOUND The specified PackageList is not in the Database or the stringid is not \r
2292 in the specified PackageList. \r
93e3992d 2293\r
2294**/\r
2295EFI_STATUS\r
2296EFIAPI\r
2297HiiStringIdToImage (\r
2298 IN CONST EFI_HII_FONT_PROTOCOL *This,\r
2299 IN EFI_HII_OUT_FLAGS Flags,\r
2300 IN EFI_HII_HANDLE PackageList,\r
2301 IN EFI_STRING_ID StringId,\r
2302 IN CONST CHAR8* Language,\r
2303 IN CONST EFI_FONT_DISPLAY_INFO *StringInfo OPTIONAL,\r
2304 IN OUT EFI_IMAGE_OUTPUT **Blt,\r
2305 IN UINTN BltX,\r
2306 IN UINTN BltY,\r
2307 OUT EFI_HII_ROW_INFO **RowInfoArray OPTIONAL,\r
2308 OUT UINTN *RowInfoArraySize OPTIONAL,\r
2309 OUT UINTN *ColumnInfoArray OPTIONAL\r
2310 )\r
2311{\r
2312 EFI_STATUS Status;\r
2313 HII_DATABASE_PRIVATE_DATA *Private;\r
bf9af1b9 2314 EFI_HII_STRING_PROTOCOL *HiiString;\r
93e3992d 2315 EFI_STRING String;\r
2316 UINTN StringSize;\r
813acf3a 2317 UINTN FontLen;\r
5ad66ec6 2318 UINTN NameSize;\r
813acf3a 2319 EFI_FONT_INFO *StringFontInfo;\r
2320 EFI_FONT_DISPLAY_INFO *NewStringInfo;\r
bf9af1b9 2321 CHAR8 TempSupportedLanguages;\r
2322 CHAR8 *SupportedLanguages;\r
2323 UINTN SupportedLanguagesSize;\r
2324 CHAR8 *CurrentLanguage;\r
2325 CHAR8 *BestLanguage;\r
93e3992d 2326\r
2327 if (This == NULL || PackageList == NULL || Blt == NULL || PackageList == NULL) {\r
2328 return EFI_INVALID_PARAMETER;\r
2329 }\r
2330\r
2331 if (!IsHiiHandleValid (PackageList)) {\r
2332 return EFI_NOT_FOUND;\r
2333 }\r
2334\r
813acf3a 2335 //\r
bf9af1b9 2336 // Initialize string pointers to be NULL\r
813acf3a 2337 //\r
bf9af1b9 2338 SupportedLanguages = NULL;\r
2339 CurrentLanguage = NULL;\r
2340 BestLanguage = NULL;\r
2341 String = NULL;\r
bf9af1b9 2342 StringFontInfo = NULL;\r
2343 NewStringInfo = NULL;\r
93e3992d 2344\r
2345 //\r
2346 // Get the string to be displayed.\r
2347 //\r
bf9af1b9 2348 Private = HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
2349 HiiString = &Private->HiiString;\r
2350\r
2351 //\r
2352 // Get the size of supported language.\r
2353 //\r
2354 SupportedLanguagesSize = 0;\r
2355 Status = HiiString->GetLanguages (\r
2356 HiiString,\r
2357 PackageList,\r
2358 &TempSupportedLanguages,\r
2359 &SupportedLanguagesSize\r
2360 );\r
2361 if (Status != EFI_BUFFER_TOO_SMALL) {\r
2362 return Status;\r
2363 }\r
2364\r
2365 SupportedLanguages = AllocatePool (SupportedLanguagesSize);\r
2366 if (SupportedLanguages == NULL) {\r
2367 return EFI_OUT_OF_RESOURCES;\r
2368 }\r
93e3992d 2369\r
bf9af1b9 2370 Status = HiiString->GetLanguages (\r
2371 HiiString,\r
2372 PackageList,\r
2373 SupportedLanguages,\r
2374 &SupportedLanguagesSize\r
2375 );\r
2376 if (EFI_ERROR (Status)) {\r
2377 goto Exit;\r
2378 }\r
2379 \r
2380 if (Language == NULL) {\r
2381 Language = "";\r
2382 }\r
f01b91ae 2383 GetEfiGlobalVariable2 (L"PlatformLang", (VOID**)&CurrentLanguage, NULL);\r
bf9af1b9 2384 BestLanguage = GetBestLanguage (\r
2385 SupportedLanguages,\r
2386 FALSE,\r
2387 Language,\r
2388 (CurrentLanguage == NULL) ? CurrentLanguage : "",\r
2389 (CHAR8 *) PcdGetPtr (PcdUefiVariableDefaultPlatformLang),\r
2390 NULL\r
2391 );\r
2392 if (BestLanguage == NULL) {\r
2393 Status = EFI_NOT_FOUND;\r
2394 goto Exit;\r
2395 }\r
2396 \r
93e3992d 2397 StringSize = MAX_STRING_LENGTH;\r
2398 String = (EFI_STRING) AllocateZeroPool (StringSize);\r
2399 if (String == NULL) {\r
bf9af1b9 2400 Status = EFI_OUT_OF_RESOURCES;\r
2401 goto Exit;\r
93e3992d 2402 }\r
2403\r
bf9af1b9 2404 Status = HiiString->GetString (\r
2405 HiiString,\r
2406 BestLanguage,\r
2407 PackageList,\r
2408 StringId,\r
2409 String,\r
2410 &StringSize,\r
2411 &StringFontInfo\r
2412 );\r
93e3992d 2413 if (Status == EFI_BUFFER_TOO_SMALL) {\r
676df92c 2414 FreePool (String);\r
93e3992d 2415 String = (EFI_STRING) AllocateZeroPool (StringSize);\r
2416 if (String == NULL) {\r
bf9af1b9 2417 Status = EFI_OUT_OF_RESOURCES;\r
2418 goto Exit;\r
93e3992d 2419 }\r
bf9af1b9 2420 Status = HiiString->GetString (\r
2421 HiiString,\r
2422 BestLanguage,\r
2423 PackageList,\r
2424 StringId,\r
2425 String,\r
2426 &StringSize,\r
2427 NULL\r
2428 );\r
93e3992d 2429 }\r
2430\r
2431 if (EFI_ERROR (Status)) {\r
bf9af1b9 2432 goto Exit;\r
813acf3a 2433 }\r
2434 \r
2435 //\r
2436 // When StringInfo specifies that string will be output in the system default font and color,\r
2437 // use particular stringfontinfo described in string package instead if exists. \r
2438 // StringFontInfo equals NULL means system default font attaches with the string block.\r
2439 //\r
2440 if (StringFontInfo != NULL && IsSystemFontInfo (Private, (EFI_FONT_DISPLAY_INFO *) StringInfo, NULL, NULL)) {\r
5ad66ec6
DB		 2441 NameSize = StrSize (StringFontInfo->FontName);\r
2442 FontLen = sizeof (EFI_FONT_DISPLAY_INFO) - sizeof (CHAR16) + NameSize;\r
813acf3a 2443 NewStringInfo = AllocateZeroPool (FontLen);\r
2444 if (NewStringInfo == NULL) { \r
2445 Status = EFI_OUT_OF_RESOURCES;\r
2446 goto Exit;\r
2447 }\r
2448 NewStringInfo->FontInfoMask = EFI_FONT_INFO_SYS_FORE_COLOR | EFI_FONT_INFO_SYS_BACK_COLOR;\r
2449 NewStringInfo->FontInfo.FontStyle = StringFontInfo->FontStyle;\r
2450 NewStringInfo->FontInfo.FontSize = StringFontInfo->FontSize; \r
5ad66ec6 2451 StrCpyS (NewStringInfo->FontInfo.FontName, NameSize / sizeof (CHAR16), StringFontInfo->FontName);\r
813acf3a 2452 \r
2453 Status = HiiStringToImage (\r
2454 This, \r
2455 Flags, \r
2456 String, \r
2457 NewStringInfo, \r
2458 Blt, \r
2459 BltX, \r
2460 BltY, \r
2461 RowInfoArray,\r
2462 RowInfoArraySize,\r
2463 ColumnInfoArray\r
2464 );\r
2465 goto Exit;\r
93e3992d 2466 }\r
2467\r
813acf3a 2468 Status = HiiStringToImage (\r
93e3992d 2469 This,\r
2470 Flags,\r
2471 String,\r
2472 StringInfo,\r
2473 Blt,\r
2474 BltX,\r
2475 BltY,\r
2476 RowInfoArray,\r
2477 RowInfoArraySize,\r
2478 ColumnInfoArray\r
2479 );\r
2480\r
813acf3a 2481Exit:\r
bf9af1b9 2482 if (SupportedLanguages != NULL) {\r
2483 FreePool (SupportedLanguages);\r
2484 }\r
2485 if (CurrentLanguage != NULL) {\r
2486 FreePool (CurrentLanguage);\r
2487 }\r
2488 if (BestLanguage != NULL) {\r
2489 FreePool (BestLanguage);\r
2490 }\r
676df92c 2491 if (String != NULL) {\r
2492 FreePool (String);\r
2493 }\r
2494 if (StringFontInfo != NULL) {\r
2495 FreePool (StringFontInfo);\r
2496 }\r
2497 if (NewStringInfo != NULL) {\r
2498 FreePool (NewStringInfo);\r
2499 }\r
813acf3a 2500\r
2501 return Status;\r
93e3992d 2502}\r
2503\r
2504\r
2505/**\r
2506 Convert the glyph for a single character into a bitmap.\r
2507\r
2508 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.\r
2509 @param Char Character to retrieve.\r
2510 @param StringInfo Points to the string font and color information\r
2511 or NULL if the string should use the default\r
2512 system font and color.\r
2513 @param Blt Thus must point to a NULL on entry. A buffer will\r
2514 be allocated to hold the output and the pointer\r
ac644614 2515 updated on exit. It is the caller's\r
93e3992d 2516 responsibility to free this buffer.\r
2517 @param Baseline Number of pixels from the bottom of the bitmap to\r
2518 the baseline.\r
2519\r
2520 @retval EFI_SUCCESS Glyph bitmap created.\r
2521 @retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer Blt.\r
2522 @retval EFI_WARN_UNKNOWN_GLYPH The glyph was unknown and was replaced with the\r
2523 glyph for Unicode character 0xFFFD.\r
2524 @retval EFI_INVALID_PARAMETER Blt is NULL or *Blt is not NULL.\r
2525\r
2526**/\r
2527EFI_STATUS\r
2528EFIAPI\r
2529HiiGetGlyph (\r
2530 IN CONST EFI_HII_FONT_PROTOCOL *This,\r
2531 IN CHAR16 Char,\r
2532 IN CONST EFI_FONT_DISPLAY_INFO *StringInfo,\r
2533 OUT EFI_IMAGE_OUTPUT **Blt,\r
2534 OUT UINTN *Baseline OPTIONAL\r
2535 )\r
2536{\r
2537 EFI_STATUS Status;\r
2538 HII_DATABASE_PRIVATE_DATA *Private;\r
2539 EFI_IMAGE_OUTPUT *Image;\r
2540 UINT8 *GlyphBuffer;\r
2541 EFI_FONT_DISPLAY_INFO *SystemDefault;\r
2542 EFI_FONT_DISPLAY_INFO *StringInfoOut;\r
2543 BOOLEAN Default;\r
2544 EFI_FONT_HANDLE FontHandle;\r
2545 EFI_STRING String;\r
2546 EFI_HII_GLYPH_INFO Cell;\r
2547 EFI_FONT_INFO *FontInfo;\r
2548 UINT8 Attributes;\r
2549 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground;\r
2550 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background;\r
2551 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer;\r
f6cf5cf8 2552 UINT16 BaseLine;\r
93e3992d 2553\r
2554 if (This == NULL || Blt == NULL || *Blt != NULL) {\r
2555 return EFI_INVALID_PARAMETER;\r
2556 }\r
2557\r
2558 Private = HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
2559\r
2560 Default = FALSE;\r
2561 Image = NULL;\r
2562 SystemDefault = NULL;\r
2563 FontHandle = NULL;\r
2564 String = NULL;\r
2565 GlyphBuffer = NULL;\r
2566 StringInfoOut = NULL;\r
2567 FontInfo = NULL;\r
2568\r
2569 ZeroMem (&Foreground, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));\r
2570 ZeroMem (&Background, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));\r
2571\r
2572 Default = IsSystemFontInfo (Private, (EFI_FONT_DISPLAY_INFO *) StringInfo, &SystemDefault, NULL);\r
2573\r
2574 if (!Default) {\r
2575 //\r
2576 // Find out a EFI_FONT_DISPLAY_INFO which could display the character in\r
2577 // the specified color and font.\r
2578 //\r
2579 String = (EFI_STRING) AllocateZeroPool (sizeof (CHAR16) * 2);\r
2580 if (String == NULL) {\r
2581 Status = EFI_OUT_OF_RESOURCES;\r
2582 goto Exit;\r
2583 }\r
2584 *String = Char;\r
2585 *(String + 1) = 0;\r
2586\r
2587 Status = HiiGetFontInfo (This, &FontHandle, StringInfo, &StringInfoOut, String);\r
2588 if (EFI_ERROR (Status)) {\r
2589 goto Exit;\r
2590 }\r
1b2bf3ca 2591 ASSERT (StringInfoOut != NULL);\r
93e3992d 2592 FontInfo = &StringInfoOut->FontInfo;\r
2593 Foreground = StringInfoOut->ForegroundColor;\r
2594 Background = StringInfoOut->BackgroundColor;\r
2595 } else {\r
523f48e7 2596 ASSERT (SystemDefault != NULL);\r
93e3992d 2597 Foreground = SystemDefault->ForegroundColor;\r
2598 Background = SystemDefault->BackgroundColor;\r
2599 }\r
2600\r
2601 Status = GetGlyphBuffer (Private, Char, FontInfo, &GlyphBuffer, &Cell, &Attributes);\r
2602 if (EFI_ERROR (Status)) {\r
2603 goto Exit;\r
2604 }\r
2605\r
2606 Image = (EFI_IMAGE_OUTPUT *) AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT));\r
2607 if (Image == NULL) {\r
2608 Status = EFI_OUT_OF_RESOURCES;\r
2609 goto Exit;\r
2610 }\r
2611 Image->Width = Cell.Width;\r
2612 Image->Height = Cell.Height;\r
2613\r
f6cf5cf8
LG		 2614 if (Image->Width * Image->Height > 0) {\r
2615 Image->Image.Bitmap = AllocateZeroPool (Image->Width * Image->Height * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));\r
2616 if (Image->Image.Bitmap == NULL) {\r
2617 FreePool (Image);\r
2618 Status = EFI_OUT_OF_RESOURCES;\r
2619 goto Exit;\r
2620 }\r
93e3992d 2621\r
f6cf5cf8
LG		 2622 //\r
2623 // Set BaseLine to the char height.\r
2624 //\r
2625 BaseLine = (UINT16) (Cell.Height + Cell.OffsetY);\r
2626 //\r
2627 // Set BltBuffer to the position of Origin. \r
2628 //\r
2629 BltBuffer = Image->Image.Bitmap + (Cell.Height + Cell.OffsetY) * Image->Width - Cell.OffsetX;\r
2630 GlyphToImage (\r
2631 GlyphBuffer,\r
2632 Foreground,\r
2633 Background,\r
2634 Image->Width,\r
2635 BaseLine,\r
2636 Cell.Width + Cell.OffsetX,\r
2637 BaseLine - Cell.OffsetY,\r
2638 FALSE,\r
2639 &Cell,\r
2640 Attributes,\r
2641 &BltBuffer\r
2642 );\r
2643 }\r
93e3992d 2644\r
2645 *Blt = Image;\r
2646 if (Baseline != NULL) {\r
2647 *Baseline = Cell.OffsetY;\r
2648 }\r
2649\r
2650 Status = EFI_SUCCESS;\r
2651\r
2652Exit:\r
2653\r
2654 if (Status == EFI_NOT_FOUND) {\r
2655 //\r
2656 // Glyph is unknown and replaced with the glyph for unicode character 0xFFFD\r
2657 //\r
2658 if (Char != REPLACE_UNKNOWN_GLYPH) {\r
2659 Status = HiiGetGlyph (This, REPLACE_UNKNOWN_GLYPH, StringInfo, Blt, Baseline);\r
2660 if (!EFI_ERROR (Status)) {\r
2661 Status = EFI_WARN_UNKNOWN_GLYPH;\r
2662 }\r
2663 } else {\r
2664 Status = EFI_WARN_UNKNOWN_GLYPH;\r
2665 }\r
2666 }\r
2667\r
676df92c 2668 if (SystemDefault != NULL) {\r
2669 FreePool (SystemDefault);\r
2670 }\r
2671 if (StringInfoOut != NULL) {\r
2672 FreePool (StringInfoOut);\r
2673 }\r
2674 if (String != NULL) {\r
2675 FreePool (String);\r
2676 }\r
2677 if (GlyphBuffer != NULL) {\r
2678 FreePool (GlyphBuffer);\r
2679 }\r
93e3992d 2680\r
2681 return Status;\r
2682}\r
2683\r
2684\r
2685/**\r
2686 This function iterates through fonts which match the specified font, using\r
2687 the specified criteria. If String is non-NULL, then all of the characters in\r
2688 the string must exist in order for a candidate font to be returned.\r
2689\r
2690 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.\r
2691 @param FontHandle On entry, points to the font handle returned by a\r
2692 previous call to GetFontInfo() or NULL to start\r
2693 with the first font. On return, points to the\r
2694 returned font handle or points to NULL if there\r
2695 are no more matching fonts.\r
c0a3c3da
ED		 2696 @param StringInfoIn Upon entry, points to the font to return information\r
2697 about. If NULL, then the information about the system\r
2698 default font will be returned.\r
2699 @param StringInfoOut Upon return, contains the matching font's information.\r
2700 If NULL, then no information is returned. This buffer\r
2701 is allocated with a call to the Boot Service AllocatePool().\r
2702 It is the caller's responsibility to call the Boot \r
2703 Service FreePool() when the caller no longer requires\r
2704 the contents of StringInfoOut.\r
93e3992d 2705 @param String Points to the string which will be tested to\r
2706 determine if all characters are available. If\r
2707 NULL, then any font is acceptable.\r
2708\r
2709 @retval EFI_SUCCESS Matching font returned successfully.\r
2710 @retval EFI_NOT_FOUND No matching font was found.\r
813acf3a 2711 @retval EFI_INVALID_PARAMETER StringInfoIn->FontInfoMask is an invalid combination.\r
93e3992d 2712 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the\r
2713 request.\r
2714\r
2715**/\r
2716EFI_STATUS\r
2717EFIAPI\r
2718HiiGetFontInfo (\r
2719 IN CONST EFI_HII_FONT_PROTOCOL *This,\r
2720 IN OUT EFI_FONT_HANDLE *FontHandle,\r
813acf3a 2721 IN CONST EFI_FONT_DISPLAY_INFO *StringInfoIn, OPTIONAL\r
93e3992d 2722 OUT EFI_FONT_DISPLAY_INFO **StringInfoOut,\r
2723 IN CONST EFI_STRING String OPTIONAL\r
2724 )\r
2725{\r
2726 HII_DATABASE_PRIVATE_DATA *Private;\r
2727 EFI_STATUS Status;\r
2728 EFI_FONT_DISPLAY_INFO *SystemDefault;\r
2729 EFI_FONT_DISPLAY_INFO InfoOut;\r
2730 UINTN StringInfoOutLen;\r
2731 EFI_FONT_INFO *FontInfo;\r
2732 HII_GLOBAL_FONT_INFO *GlobalFont;\r
2733 EFI_STRING StringIn;\r
2734 EFI_FONT_HANDLE LocalFontHandle;\r
2735\r
813acf3a 2736 if (This == NULL) {\r
93e3992d 2737 return EFI_INVALID_PARAMETER;\r
2738 }\r
2739\r
523f48e7 2740 StringInfoOutLen = 0;\r
93e3992d 2741 FontInfo = NULL;\r
813acf3a 2742 SystemDefault = NULL;\r
93e3992d 2743 LocalFontHandle = NULL;\r
2744 if (FontHandle != NULL) {\r
2745 LocalFontHandle = *FontHandle;\r
2746 }\r
2747\r
813acf3a 2748 Private = HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
2749\r
2750 //\r
2751 // Already searched to the end of the whole list, return directly.\r
2752 //\r
2753 if (LocalFontHandle == &Private->FontInfoList) {\r
2754 LocalFontHandle = NULL;\r
2755 Status = EFI_NOT_FOUND;\r
2756 goto Exit;\r
2757 }\r
2758\r
93e3992d 2759 //\r
2760 // Get default system display info, if StringInfoIn points to\r
2761 // system display info, return it directly.\r
2762 //\r
93e3992d 2763 if (IsSystemFontInfo (Private, (EFI_FONT_DISPLAY_INFO *) StringInfoIn, &SystemDefault, &StringInfoOutLen)) {\r
813acf3a 2764 //\r
2765 // System font is the first node. When handle is not NULL, system font can not\r
2766 // be found any more.\r
2767 //\r
2768 if (LocalFontHandle == NULL) {\r
2769 if (StringInfoOut != NULL) {\r
2770 *StringInfoOut = AllocateCopyPool (StringInfoOutLen, SystemDefault);\r
2771 if (*StringInfoOut == NULL) {\r
2772 Status = EFI_OUT_OF_RESOURCES;\r
2773 LocalFontHandle = NULL;\r
2774 goto Exit;\r
2775 }\r
93e3992d 2776 }\r
813acf3a 2777\r
2778 LocalFontHandle = Private->FontInfoList.ForwardLink;\r
2779 Status = EFI_SUCCESS;\r
2780 goto Exit;\r
2781 } else {\r
2782 LocalFontHandle = NULL;\r
2783 Status = EFI_NOT_FOUND;\r
2784 goto Exit;\r
93e3992d 2785 }\r
813acf3a 2786 }\r
bd37f971 2787 \r
2788 //\r
2789 // StringInfoIn must not be NULL if it is not system default font info.\r
2790 //\r
2791 ASSERT (StringInfoIn != NULL);\r
813acf3a 2792 //\r
2793 // Check the font information mask to make sure it is valid.\r
2794 //\r
2795 if (((StringInfoIn->FontInfoMask & (EFI_FONT_INFO_SYS_FONT | EFI_FONT_INFO_ANY_FONT)) == \r
2796 (EFI_FONT_INFO_SYS_FONT | EFI_FONT_INFO_ANY_FONT)) ||\r
2797 ((StringInfoIn->FontInfoMask & (EFI_FONT_INFO_SYS_SIZE | EFI_FONT_INFO_ANY_SIZE)) == \r
2798 (EFI_FONT_INFO_SYS_SIZE | EFI_FONT_INFO_ANY_SIZE)) ||\r
2799 ((StringInfoIn->FontInfoMask & (EFI_FONT_INFO_SYS_STYLE | EFI_FONT_INFO_ANY_STYLE)) == \r
2800 (EFI_FONT_INFO_SYS_STYLE | EFI_FONT_INFO_ANY_STYLE)) ||\r
2801 ((StringInfoIn->FontInfoMask & (EFI_FONT_INFO_RESIZE | EFI_FONT_INFO_ANY_SIZE)) == \r
2802 (EFI_FONT_INFO_RESIZE | EFI_FONT_INFO_ANY_SIZE)) || \r
2803 ((StringInfoIn->FontInfoMask & (EFI_FONT_INFO_RESTYLE | EFI_FONT_INFO_ANY_STYLE)) == \r
2804 (EFI_FONT_INFO_RESTYLE | EFI_FONT_INFO_ANY_STYLE))) {\r
2805 return EFI_INVALID_PARAMETER;\r
93e3992d 2806 }\r
2807\r
2808 //\r
2809 // Parse the font information mask to find a matching font.\r
2810 //\r
2811\r
2812 CopyMem (&InfoOut, (EFI_FONT_DISPLAY_INFO *) StringInfoIn, sizeof (EFI_FONT_DISPLAY_INFO));\r
2813\r
2814 if ((StringInfoIn->FontInfoMask & EFI_FONT_INFO_SYS_FONT) == EFI_FONT_INFO_SYS_FONT) {\r
2815 Status = SaveFontName (SystemDefault->FontInfo.FontName, &FontInfo);\r
2816 } else {\r
2817 Status = SaveFontName (((EFI_FONT_DISPLAY_INFO *) StringInfoIn)->FontInfo.FontName, &FontInfo);\r
2818 }\r
2819 if (EFI_ERROR (Status)) {\r
2820 goto Exit;\r
2821 }\r
2822\r
2823 if ((StringInfoIn->FontInfoMask & EFI_FONT_INFO_SYS_SIZE) == EFI_FONT_INFO_SYS_SIZE) {\r
2824 InfoOut.FontInfo.FontSize = SystemDefault->FontInfo.FontSize;\r
813acf3a 2825 } \r
2826 if ((StringInfoIn->FontInfoMask & EFI_FONT_INFO_SYS_STYLE) == EFI_FONT_INFO_SYS_STYLE) {\r
93e3992d 2827 InfoOut.FontInfo.FontStyle = SystemDefault->FontInfo.FontStyle;\r
813acf3a 2828 }\r
2829 if ((StringInfoIn->FontInfoMask & EFI_FONT_INFO_SYS_FORE_COLOR) == EFI_FONT_INFO_SYS_FORE_COLOR) {\r
93e3992d 2830 InfoOut.ForegroundColor = SystemDefault->ForegroundColor;\r
813acf3a 2831 }\r
2832 if ((StringInfoIn->FontInfoMask & EFI_FONT_INFO_SYS_BACK_COLOR) == EFI_FONT_INFO_SYS_BACK_COLOR) {\r
93e3992d 2833 InfoOut.BackgroundColor = SystemDefault->BackgroundColor;\r
2834 }\r
813acf3a 2835 \r
1b2bf3ca 2836 ASSERT (FontInfo != NULL);\r
93e3992d 2837 FontInfo->FontSize = InfoOut.FontInfo.FontSize;\r
2838 FontInfo->FontStyle = InfoOut.FontInfo.FontStyle;\r
2839\r
2840 if (IsFontInfoExisted (Private, FontInfo, &InfoOut.FontInfoMask, LocalFontHandle, &GlobalFont)) {\r
08e6463a 2841 //\r
2842 // Test to guarantee all characters are available in the found font.\r
2843 // \r
93e3992d 2844 if (String != NULL) {\r
93e3992d 2845 StringIn = String;\r
2846 while (*StringIn != 0) {\r
2847 Status = FindGlyphBlock (GlobalFont->FontPackage, *StringIn, NULL, NULL, NULL);\r
2848 if (EFI_ERROR (Status)) {\r
2849 LocalFontHandle = NULL;\r
2850 goto Exit;\r
2851 }\r
2852 StringIn++;\r
2853 }\r
08e6463a 2854 }\r
2855 //\r
2856 // Write to output parameter\r
2857 //\r
2858 if (StringInfoOut != NULL) {\r
2859 StringInfoOutLen = sizeof (EFI_FONT_DISPLAY_INFO) - sizeof (EFI_FONT_INFO) + GlobalFont->FontInfoSize;\r
2860 *StringInfoOut = (EFI_FONT_DISPLAY_INFO *) AllocateZeroPool (StringInfoOutLen); \r
2861 if (*StringInfoOut == NULL) {\r
2862 Status = EFI_OUT_OF_RESOURCES;\r
2863 LocalFontHandle = NULL;\r
2864 goto Exit;\r
93e3992d 2865 }\r
08e6463a 2866 \r
2867 CopyMem (*StringInfoOut, &InfoOut, sizeof (EFI_FONT_DISPLAY_INFO));\r
2868 CopyMem (&(*StringInfoOut)->FontInfo, GlobalFont->FontInfo, GlobalFont->FontInfoSize);\r
93e3992d 2869 }\r
08e6463a 2870 \r
2871 LocalFontHandle = GlobalFont->Entry.ForwardLink; \r
2872 Status = EFI_SUCCESS;\r
2873 goto Exit;\r
2874 } \r
93e3992d 2875\r
2876 Status = EFI_NOT_FOUND;\r
2877\r
2878Exit:\r
2879\r
2880 if (FontHandle != NULL) {\r
2881 *FontHandle = LocalFontHandle;\r
2882 }\r
2883\r
676df92c 2884 if (SystemDefault != NULL) {\r
2885 FreePool (SystemDefault);\r
2886 }\r
2887 if (FontInfo != NULL) {\r
2888 FreePool (FontInfo);\r
2889 }\r
93e3992d 2890 return Status;\r
2891}\r
2892\r
813acf3a 2893\r
EFI Development Kit II mirror for PVE