]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/DisplayEngineDxe/FormDisplay.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Adjust skip value when paint text two string for text opcode.
[mirror_edk2.git] / MdeModulePkg / Universal / DisplayEngineDxe / FormDisplay.c
CommitLineData
7c6c064c
ED		 1/** @file\r
2Entry and initialization module for the browser.\r
3\r
4Copyright (c) 2007 - 2013, Intel Corporation. All rights reserved.<BR>\r
5This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#include "FormDisplay.h"\r
16\r
17//\r
18// Search table for UiDisplayMenu()\r
19//\r
20SCAN_CODE_TO_SCREEN_OPERATION gScanCodeToOperation[] = {\r
21 {\r
22 SCAN_UP,\r
23 UiUp,\r
24 },\r
25 {\r
26 SCAN_DOWN,\r
27 UiDown,\r
28 },\r
29 {\r
30 SCAN_PAGE_UP,\r
31 UiPageUp,\r
32 },\r
33 {\r
34 SCAN_PAGE_DOWN,\r
35 UiPageDown,\r
36 },\r
37 {\r
38 SCAN_ESC,\r
39 UiReset,\r
40 },\r
41 {\r
42 SCAN_LEFT,\r
43 UiLeft,\r
44 },\r
45 {\r
46 SCAN_RIGHT,\r
47 UiRight,\r
48 }\r
49};\r
50\r
51UINTN mScanCodeNumber = sizeof (gScanCodeToOperation) / sizeof (gScanCodeToOperation[0]);\r
52\r
53SCREEN_OPERATION_T0_CONTROL_FLAG gScreenOperationToControlFlag[] = {\r
54 {\r
55 UiNoOperation,\r
56 CfUiNoOperation,\r
57 },\r
58 {\r
59 UiSelect,\r
60 CfUiSelect,\r
61 },\r
62 {\r
63 UiUp,\r
64 CfUiUp,\r
65 },\r
66 {\r
67 UiDown,\r
68 CfUiDown,\r
69 },\r
70 {\r
71 UiLeft,\r
72 CfUiLeft,\r
73 },\r
74 {\r
75 UiRight,\r
76 CfUiRight,\r
77 },\r
78 {\r
79 UiReset,\r
80 CfUiReset,\r
81 },\r
82 {\r
83 UiPageUp,\r
84 CfUiPageUp,\r
85 },\r
86 {\r
87 UiPageDown,\r
88 CfUiPageDown\r
89 }, \r
90 {\r
91 UiHotKey,\r
92 CfUiHotKey\r
93 }\r
94};\r
95\r
96EFI_GUID gDisplayEngineGuid = {\r
97 0xE38C1029, 0xE38F, 0x45b9, {0x8F, 0x0D, 0xE2, 0xE6, 0x0B, 0xC9, 0xB2, 0x62}\r
98};\r
99\r
5a9f73bf 100FORM_ENTRY_INFO gFormEntryInfo;\r
7c6c064c
ED		 101UINTN gSequence;\r
102EFI_SCREEN_DESCRIPTOR gStatementDimensions;\r
7c6c064c
ED		 103BOOLEAN mStatementLayoutIsChanged = TRUE;\r
104USER_INPUT *gUserInput;\r
105FORM_DISPLAY_ENGINE_FORM *gFormData;\r
106EFI_HII_HANDLE gHiiHandle;\r
107UINT16 gDirection;\r
108LIST_ENTRY gMenuOption;\r
109DISPLAY_HIGHLIGHT_MENU_INFO gHighligthMenuInfo = {0};\r
5a9f73bf
ED		 110BOOLEAN mIsFirstForm = TRUE;\r
111FORM_ENTRY_INFO gOldFormEntry = {0};\r
7c6c064c
ED		 112\r
113//\r
114// Browser Global Strings\r
115//\r
116CHAR16 *gFormNotFound;\r
117CHAR16 *gNoSubmitIf;\r
118CHAR16 *gBrwoserError;\r
119CHAR16 *gSaveFailed;\r
120CHAR16 *gPromptForData;\r
121CHAR16 *gPromptForPassword;\r
122CHAR16 *gPromptForNewPassword;\r
123CHAR16 *gConfirmPassword;\r
124CHAR16 *gConfirmError;\r
125CHAR16 *gPassowordInvalid;\r
126CHAR16 *gPressEnter;\r
127CHAR16 *gEmptyString;\r
128CHAR16 *gMiniString;\r
129CHAR16 *gOptionMismatch;\r
130CHAR16 *gFormSuppress;\r
131CHAR16 *gProtocolNotFound;\r
132\r
af047db7 133CHAR16 gModalSkipColumn;\r
7c6c064c
ED		 134CHAR16 gPromptBlockWidth;\r
135CHAR16 gOptionBlockWidth;\r
136CHAR16 gHelpBlockWidth;\r
137CHAR16 *mUnknownString;\r
138\r
139FORM_DISPLAY_DRIVER_PRIVATE_DATA mPrivateData = {\r
140 FORM_DISPLAY_DRIVER_SIGNATURE,\r
141 NULL,\r
142 {\r
143 FormDisplay,\r
5a9f73bf 144 DriverClearDisplayPage,\r
7c6c064c
ED		 145 ConfirmDataChange\r
146 }\r
147};\r
148\r
149\r
150/**\r
151 Get the string based on the StringId and HII Package List Handle.\r
152\r
153 @param Token The String's ID.\r
154 @param HiiHandle The package list in the HII database to search for\r
155 the specified string.\r
156\r
157 @return The output string.\r
158\r
159**/\r
160CHAR16 *\r
161GetToken (\r
162 IN EFI_STRING_ID Token,\r
163 IN EFI_HII_HANDLE HiiHandle\r
164 )\r
165{\r
166 EFI_STRING String;\r
167\r
168 String = HiiGetString (HiiHandle, Token, NULL);\r
169 if (String == NULL) {\r
170 String = AllocateCopyPool (StrSize (mUnknownString), mUnknownString);\r
171 ASSERT (String != NULL);\r
172 }\r
173\r
174 return (CHAR16 *) String;\r
175}\r
176\r
177\r
178/**\r
179 Initialize the HII String Token to the correct values.\r
180\r
181**/\r
182VOID\r
183InitializeDisplayStrings (\r
184 VOID\r
185 )\r
186{\r
187 mUnknownString = GetToken (STRING_TOKEN (UNKNOWN_STRING), gHiiHandle);\r
188 gSaveFailed = GetToken (STRING_TOKEN (SAVE_FAILED), gHiiHandle);\r
189 gPromptForData = GetToken (STRING_TOKEN (PROMPT_FOR_DATA), gHiiHandle);\r
190 gPromptForPassword = GetToken (STRING_TOKEN (PROMPT_FOR_PASSWORD), gHiiHandle);\r
191 gPromptForNewPassword = GetToken (STRING_TOKEN (PROMPT_FOR_NEW_PASSWORD), gHiiHandle);\r
192 gConfirmPassword = GetToken (STRING_TOKEN (CONFIRM_PASSWORD), gHiiHandle);\r
193 gConfirmError = GetToken (STRING_TOKEN (CONFIRM_ERROR), gHiiHandle);\r
194 gPassowordInvalid = GetToken (STRING_TOKEN (PASSWORD_INVALID), gHiiHandle);\r
195 gPressEnter = GetToken (STRING_TOKEN (PRESS_ENTER), gHiiHandle);\r
196 gEmptyString = GetToken (STRING_TOKEN (EMPTY_STRING), gHiiHandle);\r
197 gMiniString = GetToken (STRING_TOKEN (MINI_STRING), gHiiHandle);\r
198 gOptionMismatch = GetToken (STRING_TOKEN (OPTION_MISMATCH), gHiiHandle);\r
199 gFormSuppress = GetToken (STRING_TOKEN (FORM_SUPPRESSED), gHiiHandle);\r
200 gProtocolNotFound = GetToken (STRING_TOKEN (PROTOCOL_NOT_FOUND), gHiiHandle);\r
201 gFormNotFound = GetToken (STRING_TOKEN (STATUS_BROWSER_FORM_NOT_FOUND), gHiiHandle);\r
202 gNoSubmitIf = GetToken (STRING_TOKEN (STATUS_BROWSER_NO_SUBMIT_IF), gHiiHandle);\r
203 gBrwoserError = GetToken (STRING_TOKEN (STATUS_BROWSER_ERROR), gHiiHandle);\r
204}\r
205\r
206/**\r
207 Free up the resource allocated for all strings required\r
208 by Setup Browser.\r
209\r
210**/\r
211VOID\r
212FreeDisplayStrings (\r
213 VOID\r
214 )\r
215{\r
216 FreePool (mUnknownString);\r
217 FreePool (gEmptyString);\r
218 FreePool (gSaveFailed);\r
219 FreePool (gPromptForData);\r
220 FreePool (gPromptForPassword);\r
221 FreePool (gPromptForNewPassword);\r
222 FreePool (gConfirmPassword);\r
223 FreePool (gConfirmError);\r
224 FreePool (gPassowordInvalid);\r
225 FreePool (gPressEnter);\r
226 FreePool (gMiniString);\r
227 FreePool (gOptionMismatch);\r
228 FreePool (gFormSuppress);\r
229 FreePool (gProtocolNotFound);\r
230 FreePool (gBrwoserError);\r
231 FreePool (gNoSubmitIf);\r
232 FreePool (gFormNotFound);\r
233}\r
234\r
235/**\r
236 Get prompt string id from the opcode data buffer.\r
237\r
238 @param OpCode The input opcode buffer.\r
239\r
240 @return The prompt string id.\r
241\r
242**/\r
243EFI_STRING_ID\r
244GetPrompt (\r
245 IN EFI_IFR_OP_HEADER *OpCode\r
246 )\r
247{\r
248 EFI_IFR_STATEMENT_HEADER *Header;\r
249\r
250 if (OpCode->Length <= sizeof (EFI_IFR_OP_HEADER)) {\r
251 return 0;\r
252 }\r
253\r
254 Header = (EFI_IFR_STATEMENT_HEADER *) (OpCode + 1);\r
255\r
256 return Header->Prompt;\r
257}\r
258\r
259/**\r
260 Get the supported width for a particular op-code\r
261\r
6f05c023 262 @param MenuOption The menu option.\r
af047db7 263 @param AdjustWidth The width which is saved for the space.\r
7c6c064c
ED		 264\r
265 @return Returns the number of CHAR16 characters that is support.\r
266\r
267**/\r
268UINT16\r
269GetWidth (\r
6f05c023
ED		 270 IN UI_MENU_OPTION *MenuOption,\r
271 OUT UINT16 *AdjustWidth\r
7c6c064c
ED		 272 )\r
273{\r
6f05c023
ED		 274 CHAR16 *String;\r
275 UINTN Size;\r
276 EFI_IFR_TEXT *TestOp;\r
277 UINT16 ReturnWidth;\r
278 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
279\r
280 Statement = MenuOption->ThisTag;\r
7c6c064c 281\r
af047db7
ED		 282 //\r
283 // For modal form, clean the entire row.\r
284 //\r
285 if ((gFormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
ae4f5746
ED		 286 if (AdjustWidth != NULL) {\r
287 *AdjustWidth = LEFT_SKIPPED_COLUMNS;\r
288 }\r
289 return (UINT16)(gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn - 2 * (gModalSkipColumn + LEFT_SKIPPED_COLUMNS));\r
af047db7
ED		 290 }\r
291\r
7c6c064c
ED		 292 Size = 0;\r
293\r
294 //\r
295 // See if the second text parameter is really NULL\r
296 //\r
297 if (Statement->OpCode->OpCode == EFI_IFR_TEXT_OP) {\r
298 TestOp = (EFI_IFR_TEXT *) Statement->OpCode;\r
299 if (TestOp->TextTwo != 0) {\r
300 String = GetToken (TestOp->TextTwo, gFormData->HiiHandle);\r
301 Size = StrLen (String);\r
302 FreePool (String);\r
303 }\r
304 }\r
305\r
306 if ((Statement->OpCode->OpCode == EFI_IFR_SUBTITLE_OP) ||\r
307 (Statement->OpCode->OpCode == EFI_IFR_REF_OP) ||\r
308 (Statement->OpCode->OpCode == EFI_IFR_PASSWORD_OP) ||\r
309 (Statement->OpCode->OpCode == EFI_IFR_ACTION_OP) ||\r
310 (Statement->OpCode->OpCode == EFI_IFR_RESET_BUTTON_OP) ||\r
311 //\r
312 // Allow a wide display if text op-code and no secondary text op-code\r
313 //\r
314 ((Statement->OpCode->OpCode == EFI_IFR_TEXT_OP) && (Size == 0))\r
315 ) {\r
af047db7
ED		 316 \r
317 //\r
318 // Return the space width.\r
319 // \r
320 if (AdjustWidth != NULL) {\r
321 *AdjustWidth = 2;\r
322 }\r
323 //\r
324 // Keep consistent with current behavior.\r
325 //\r
6f05c023
ED		 326 ReturnWidth = (UINT16) (gPromptBlockWidth + gOptionBlockWidth - 2);\r
327 } else {\r
328 if (AdjustWidth != NULL) {\r
329 *AdjustWidth = 1;\r
330 }\r
331\r
332 ReturnWidth = (UINT16) (gPromptBlockWidth - 1);\r
7c6c064c
ED		 333 }\r
334\r
6f05c023
ED		 335 //\r
336 // For nest in statement, should the subtitle indent.\r
337 //\r
338 if (MenuOption->NestInStatement) {\r
339 ReturnWidth -= SUBTITLE_INDENT;\r
af047db7 340 }\r
6f05c023
ED		 341\r
342 return ReturnWidth;\r
7c6c064c
ED		 343}\r
344\r
345/**\r
346 Will copy LineWidth amount of a string in the OutputString buffer and return the\r
347 number of CHAR16 characters that were copied into the OutputString buffer.\r
348 The output string format is:\r
349 Glyph Info + String info + '\0'.\r
350\r
351 In the code, it deals \r,\n,\r\n same as \n\r, also it not process the \r or \g.\r
352\r
353 @param InputString String description for this option.\r
354 @param LineWidth Width of the desired string to extract in CHAR16\r
355 characters\r
356 @param GlyphWidth The glyph width of the begin of the char in the string.\r
357 @param Index Where in InputString to start the copy process\r
358 @param OutputString Buffer to copy the string into\r
359\r
360 @return Returns the number of CHAR16 characters that were copied into the OutputString \r
361 buffer, include extra glyph info and '\0' info.\r
362\r
363**/\r
364UINT16\r
365GetLineByWidth (\r
366 IN CHAR16 *InputString,\r
367 IN UINT16 LineWidth,\r
368 IN OUT UINT16 *GlyphWidth,\r
369 IN OUT UINTN *Index,\r
370 OUT CHAR16 **OutputString\r
371 )\r
372{\r
373 UINT16 StrOffset;\r
374 UINT16 GlyphOffset;\r
375 UINT16 OriginalGlyphWidth;\r
376 BOOLEAN ReturnFlag;\r
377 UINT16 LastSpaceOffset;\r
378 UINT16 LastGlyphWidth;\r
379\r
380 if (InputString == NULL || Index == NULL || OutputString == NULL) {\r
381 return 0;\r
382 }\r
383\r
384 if (LineWidth == 0 || *GlyphWidth == 0) {\r
385 return 0;\r
386 }\r
387\r
388 //\r
389 // Save original glyph width.\r
390 //\r
391 OriginalGlyphWidth = *GlyphWidth;\r
392 LastGlyphWidth = OriginalGlyphWidth;\r
393 ReturnFlag = FALSE;\r
394 LastSpaceOffset = 0;\r
395\r
396 //\r
397 // NARROW_CHAR can not be printed in screen, so if a line only contain the two CHARs: 'NARROW_CHAR + CHAR_CARRIAGE_RETURN' , it is a empty line in Screen.\r
398 // To avoid displaying this empty line in screen, just skip the two CHARs here.\r
399 //\r
400 if ((InputString[*Index] == NARROW_CHAR) && (InputString[*Index + 1] == CHAR_CARRIAGE_RETURN)) {\r
401 *Index = *Index + 2;\r
402 }\r
403\r
404 //\r
405 // Fast-forward the string and see if there is a carriage-return in the string\r
406 //\r
407 for (StrOffset = 0, GlyphOffset = 0; GlyphOffset <= LineWidth; StrOffset++) {\r
408 switch (InputString[*Index + StrOffset]) {\r
409 case NARROW_CHAR:\r
410 *GlyphWidth = 1;\r
411 break;\r
412\r
413 case WIDE_CHAR:\r
414 *GlyphWidth = 2;\r
415 break;\r
416\r
417 case CHAR_CARRIAGE_RETURN:\r
418 case CHAR_LINEFEED:\r
419 case CHAR_NULL:\r
420 ReturnFlag = TRUE;\r
421 break;\r
422\r
423 default:\r
424 GlyphOffset = GlyphOffset + *GlyphWidth;\r
425\r
426 //\r
427 // Record the last space info in this line. Will be used in rewind.\r
428 //\r
429 if ((InputString[*Index + StrOffset] == CHAR_SPACE) && (GlyphOffset <= LineWidth)) {\r
430 LastSpaceOffset = StrOffset;\r
431 LastGlyphWidth = *GlyphWidth;\r
432 }\r
433 break;\r
434 }\r
435\r
436 if (ReturnFlag) {\r
437 break;\r
438 }\r
439 } \r
440\r
441 //\r
442 // Rewind the string from the maximum size until we see a space to break the line\r
443 //\r
444 if (GlyphOffset > LineWidth) {\r
445 //\r
446 // Rewind the string to last space char in this line.\r
447 //\r
448 if (LastSpaceOffset != 0) {\r
449 StrOffset = LastSpaceOffset;\r
450 *GlyphWidth = LastGlyphWidth;\r
451 } else {\r
452 //\r
453 // Roll back to last char in the line width.\r
454 //\r
455 StrOffset--;\r
456 }\r
457 }\r
458\r
459 //\r
460 // The CHAR_NULL has process last time, this time just return 0 to stand for the end.\r
461 //\r
462 if (StrOffset == 0 && (InputString[*Index + StrOffset] == CHAR_NULL)) {\r
463 return 0;\r
464 }\r
465\r
466 //\r
467 // Need extra glyph info and '\0' info, so +2.\r
468 //\r
469 *OutputString = AllocateZeroPool (((UINTN) (StrOffset + 2) * sizeof(CHAR16)));\r
470 if (*OutputString == NULL) {\r
471 return 0;\r
472 }\r
473\r
474 //\r
475 // Save the glyph info at the begin of the string, will used by Print function.\r
476 //\r
477 if (OriginalGlyphWidth == 1) {\r
478 *(*OutputString) = NARROW_CHAR;\r
479 } else {\r
480 *(*OutputString) = WIDE_CHAR;\r
481 }\r
482\r
483 CopyMem ((*OutputString) + 1, &InputString[*Index], StrOffset * sizeof(CHAR16));\r
484\r
485 if (InputString[*Index + StrOffset] == CHAR_SPACE) {\r
486 //\r
487 // Skip the space info at the begin of next line.\r
488 // \r
489 *Index = (UINT16) (*Index + StrOffset + 1);\r
490 } else if (InputString[*Index + StrOffset] == CHAR_LINEFEED) {\r
491 //\r
492 // Skip the /n or /n/r info.\r
493 //\r
494 if (InputString[*Index + StrOffset + 1] == CHAR_CARRIAGE_RETURN) {\r
495 *Index = (UINT16) (*Index + StrOffset + 2);\r
496 } else {\r
497 *Index = (UINT16) (*Index + StrOffset + 1);\r
498 }\r
499 } else if (InputString[*Index + StrOffset] == CHAR_CARRIAGE_RETURN) {\r
500 //\r
501 // Skip the /r or /r/n info.\r
502 // \r
503 if (InputString[*Index + StrOffset + 1] == CHAR_LINEFEED) {\r
504 *Index = (UINT16) (*Index + StrOffset + 2);\r
505 } else {\r
506 *Index = (UINT16) (*Index + StrOffset + 1);\r
507 }\r
508 } else {\r
509 *Index = (UINT16) (*Index + StrOffset);\r
510 }\r
511\r
512 //\r
513 // Include extra glyph info and '\0' info, so +2.\r
514 //\r
515 return StrOffset + 2;\r
516}\r
517\r
518/**\r
519 Add one menu option by specified description and context.\r
520\r
521 @param Statement Statement of this Menu Option.\r
522 @param MenuItemCount The index for this Option in the Menu.\r
523 @param NestIn Whether this statement is nest in another statement.\r
524\r
525**/\r
526VOID\r
527UiAddMenuOption (\r
528 IN FORM_DISPLAY_ENGINE_STATEMENT *Statement,\r
529 IN UINT16 *MenuItemCount,\r
530 IN BOOLEAN NestIn\r
531 )\r
532{\r
533 UI_MENU_OPTION *MenuOption;\r
534 UINTN Index;\r
535 UINTN Count;\r
536 CHAR16 *String;\r
537 UINT16 NumberOfLines;\r
538 UINT16 GlyphWidth;\r
539 UINT16 Width;\r
540 UINTN ArrayEntry;\r
541 CHAR16 *OutputString;\r
542 EFI_STRING_ID PromptId;\r
543\r
544 NumberOfLines = 1;\r
545 ArrayEntry = 0;\r
546 GlyphWidth = 1;\r
547 Count = 1;\r
548 MenuOption = NULL;\r
549\r
550 PromptId = GetPrompt (Statement->OpCode);\r
551 ASSERT (PromptId != 0);\r
552\r
553 String = GetToken (PromptId, gFormData->HiiHandle);\r
554 ASSERT (String != NULL);\r
555\r
7c6c064c 556 if (Statement->OpCode->OpCode == EFI_IFR_DATE_OP || Statement->OpCode->OpCode == EFI_IFR_TIME_OP) {\r
7c6c064c
ED		 557 Count = 3;\r
558 }\r
559\r
560 for (Index = 0; Index < Count; Index++) {\r
561 MenuOption = AllocateZeroPool (sizeof (UI_MENU_OPTION));\r
562 ASSERT (MenuOption);\r
563\r
564 MenuOption->Signature = UI_MENU_OPTION_SIGNATURE;\r
565 MenuOption->Description = String;\r
566 MenuOption->Handle = gFormData->HiiHandle;\r
567 MenuOption->ThisTag = Statement;\r
568 MenuOption->NestInStatement = NestIn;\r
569 MenuOption->EntryNumber = *MenuItemCount;\r
570\r
7c6c064c
ED		 571 MenuOption->Sequence = Index;\r
572\r
573 if ((Statement->Attribute & HII_DISPLAY_GRAYOUT) != 0) {\r
574 MenuOption->GrayOut = TRUE;\r
575 } else {\r
576 MenuOption->GrayOut = FALSE;\r
577 }\r
578\r
579 if ((Statement->Attribute & HII_DISPLAY_LOCK) != 0 || (gFormData->Attribute & HII_DISPLAY_LOCK) != 0) {\r
580 MenuOption->GrayOut = TRUE;\r
581 }\r
582\r
583 //\r
584 // If the form or the question has the lock attribute, deal same as grayout.\r
585 //\r
586 if ((gFormData->Attribute & HII_DISPLAY_LOCK) != 0 || (Statement->Attribute & HII_DISPLAY_LOCK) != 0) {\r
587 MenuOption->GrayOut = TRUE;\r
588 }\r
589\r
590 switch (Statement->OpCode->OpCode) {\r
591 case EFI_IFR_ORDERED_LIST_OP:\r
592 case EFI_IFR_ONE_OF_OP:\r
593 case EFI_IFR_NUMERIC_OP:\r
594 case EFI_IFR_TIME_OP:\r
595 case EFI_IFR_DATE_OP:\r
596 case EFI_IFR_CHECKBOX_OP:\r
597 case EFI_IFR_PASSWORD_OP:\r
598 case EFI_IFR_STRING_OP:\r
599 //\r
600 // User could change the value of these items\r
601 //\r
602 MenuOption->IsQuestion = TRUE;\r
603 break;\r
604 case EFI_IFR_TEXT_OP:\r
605 if (FeaturePcdGet (PcdBrowserGrayOutTextStatement)) {\r
606 //\r
607 // Initializing GrayOut option as TRUE for Text setup options \r
608 // so that those options will be Gray in colour and un selectable.\r
609 //\r
610 MenuOption->GrayOut = TRUE;\r
611 }\r
612 break;\r
613 default:\r
614 MenuOption->IsQuestion = FALSE;\r
615 break;\r
616 }\r
617\r
618 if ((Statement->Attribute & HII_DISPLAY_READONLY) != 0) {\r
619 MenuOption->ReadOnly = TRUE;\r
620 if (FeaturePcdGet (PcdBrowerGrayOutReadOnlyMenu)) {\r
621 MenuOption->GrayOut = TRUE;\r
622 }\r
623 }\r
624\r
6f05c023
ED		 625 if (Index == 0 && \r
626 (Statement->OpCode->OpCode != EFI_IFR_DATE_OP) && \r
627 (Statement->OpCode->OpCode != EFI_IFR_TIME_OP)) {\r
628 Width = GetWidth (MenuOption, NULL);\r
629 for (; GetLineByWidth (String, Width, &GlyphWidth,&ArrayEntry, &OutputString) != 0x0000;) {\r
630 //\r
631 // If there is more string to process print on the next row and increment the Skip value\r
632 //\r
633 if (StrLen (&String[ArrayEntry]) != 0) {\r
634 NumberOfLines++;\r
635 }\r
636 FreePool (OutputString);\r
637 }\r
638 } else {\r
639 //\r
640 // Add three MenuOptions for Date/Time\r
641 // Data format : [01/02/2004] [11:22:33]\r
642 // Line number : 0 0 1 0 0 1\r
643 // \r
644 NumberOfLines = 0;\r
645 }\r
646\r
647 if (Index == 2) {\r
648 //\r
649 // Override LineNumber for the MenuOption in Date/Time sequence\r
650 //\r
651 MenuOption->Skip = 1;\r
652 } else {\r
653 MenuOption->Skip = NumberOfLines;\r
654 }\r
655\r
7c6c064c
ED		 656 InsertTailList (&gMenuOption, &MenuOption->Link);\r
657 }\r
658\r
659 (*MenuItemCount)++;\r
660}\r
661\r
662/**\r
663 Create the menu list base on the form data info.\r
664\r
665**/\r
666VOID\r
667ConvertStatementToMenu (\r
668 VOID\r
669 )\r
670{\r
671 UINT16 MenuItemCount;\r
672 LIST_ENTRY *Link;\r
673 LIST_ENTRY *NestLink;\r
674 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
675 FORM_DISPLAY_ENGINE_STATEMENT *NestStatement;\r
676\r
677 MenuItemCount = 0;\r
678 InitializeListHead (&gMenuOption);\r
679\r
680 Link = GetFirstNode (&gFormData->StatementListHead);\r
681 while (!IsNull (&gFormData->StatementListHead, Link)) {\r
682 Statement = FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK (Link);\r
683 Link = GetNextNode (&gFormData->StatementListHead, Link);\r
684\r
685 //\r
686 // Skip the opcode not recognized by Display core.\r
687 //\r
688 if (Statement->OpCode->OpCode == EFI_IFR_GUID_OP) {\r
689 continue;\r
690 }\r
691\r
692 UiAddMenuOption (Statement, &MenuItemCount, FALSE);\r
693\r
694 //\r
695 // Check the statement nest in this host statement.\r
696 //\r
697 NestLink = GetFirstNode (&Statement->NestStatementList);\r
698 while (!IsNull (&Statement->NestStatementList, NestLink)) {\r
699 NestStatement = FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK (NestLink);\r
700 NestLink = GetNextNode (&Statement->NestStatementList, NestLink);\r
701\r
702 UiAddMenuOption (NestStatement, &MenuItemCount, TRUE);\r
703 }\r
704 }\r
705}\r
706\r
707/**\r
708 Count the storage space of a Unicode string.\r
709\r
710 This function handles the Unicode string with NARROW_CHAR\r
711 and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR\r
712 does not count in the resultant output. If a WIDE_CHAR is\r
713 hit, then 2 Unicode character will consume an output storage\r
714 space with size of CHAR16 till a NARROW_CHAR is hit.\r
715\r
716 If String is NULL, then ASSERT ().\r
717\r
718 @param String The input string to be counted.\r
719\r
720 @return Storage space for the input string.\r
721\r
722**/\r
723UINTN\r
724GetStringWidth (\r
725 IN CHAR16 *String\r
726 )\r
727{\r
728 UINTN Index;\r
729 UINTN Count;\r
730 UINTN IncrementValue;\r
731\r
732 ASSERT (String != NULL);\r
733 if (String == NULL) {\r
734 return 0;\r
735 }\r
736\r
737 Index = 0;\r
738 Count = 0;\r
739 IncrementValue = 1;\r
740\r
741 do {\r
742 //\r
743 // Advance to the null-terminator or to the first width directive\r
744 //\r
745 for (;\r
746 (String[Index] != NARROW_CHAR) && (String[Index] != WIDE_CHAR) && (String[Index] != 0);\r
747 Index++, Count = Count + IncrementValue\r
748 )\r
749 ;\r
750\r
751 //\r
752 // We hit the null-terminator, we now have a count\r
753 //\r
754 if (String[Index] == 0) {\r
755 break;\r
756 }\r
757 //\r
758 // We encountered a narrow directive - strip it from the size calculation since it doesn't get printed\r
759 // and also set the flag that determines what we increment by.(if narrow, increment by 1, if wide increment by 2)\r
760 //\r
761 if (String[Index] == NARROW_CHAR) {\r
762 //\r
763 // Skip to the next character\r
764 //\r
765 Index++;\r
766 IncrementValue = 1;\r
767 } else {\r
768 //\r
769 // Skip to the next character\r
770 //\r
771 Index++;\r
772 IncrementValue = 2;\r
773 }\r
774 } while (String[Index] != 0);\r
775\r
776 //\r
777 // Increment by one to include the null-terminator in the size\r
778 //\r
779 Count++;\r
780\r
781 return Count * sizeof (CHAR16);\r
782}\r
783\r
784/**\r
785 Base on the input option string to update the skip value for a menu option.\r
786\r
787 @param MenuOption The MenuOption to be checked.\r
788 @param OptionString The input option string.\r
789\r
790**/\r
791VOID\r
792UpdateSkipInfoForMenu (\r
793 IN UI_MENU_OPTION *MenuOption,\r
794 IN CHAR16 *OptionString\r
795 )\r
796{\r
797 UINTN Index;\r
798 UINT16 Width;\r
799 UINTN Row;\r
800 CHAR16 *OutputString;\r
801 UINT16 GlyphWidth;\r
802\r
803 Width = (UINT16) gOptionBlockWidth;\r
804 GlyphWidth = 1;\r
805 Row = 1;\r
806\r
807 for (Index = 0; GetLineByWidth (OptionString, Width, &GlyphWidth, &Index, &OutputString) != 0x0000;) {\r
808 if (StrLen (&OptionString[Index]) != 0) {\r
809 Row++;\r
810 }\r
811\r
812 FreePool (OutputString);\r
813 }\r
814\r
815 if ((Row > MenuOption->Skip) && \r
816 (MenuOption->ThisTag->OpCode->OpCode != EFI_IFR_DATE_OP) && \r
817 (MenuOption->ThisTag->OpCode->OpCode != EFI_IFR_TIME_OP)) {\r
818 MenuOption->Skip = Row;\r
819 }\r
820}\r
821\r
822/**\r
823 Update display lines for a Menu Option.\r
824\r
825 @param MenuOption The MenuOption to be checked.\r
826\r
827**/\r
828VOID\r
829UpdateOptionSkipLines (\r
830 IN UI_MENU_OPTION *MenuOption\r
831 )\r
832{\r
833 CHAR16 *OptionString;\r
834\r
835 OptionString = NULL;\r
836\r
837 ProcessOptions (MenuOption, FALSE, &OptionString, TRUE);\r
838 if (OptionString != NULL) {\r
839 UpdateSkipInfoForMenu (MenuOption, OptionString);\r
840\r
841 FreePool (OptionString);\r
842 }\r
843\r
844 if ((MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TEXT_OP) && (((EFI_IFR_TEXT*)MenuOption->ThisTag->OpCode)->TextTwo != 0)) {\r
845 OptionString = GetToken (((EFI_IFR_TEXT*)MenuOption->ThisTag->OpCode)->TextTwo, gFormData->HiiHandle);\r
846\r
847 if (OptionString != NULL) {\r
848 UpdateSkipInfoForMenu (MenuOption, OptionString);\r
849\r
850 FreePool (OptionString);\r
851 }\r
852 }\r
853}\r
854\r
855/**\r
856 Check whether this Menu Option could be highlighted.\r
857\r
858 This is an internal function.\r
859\r
860 @param MenuOption The MenuOption to be checked.\r
861\r
862 @retval TRUE This Menu Option is selectable.\r
863 @retval FALSE This Menu Option could not be selected.\r
864\r
865**/\r
866BOOLEAN\r
867IsSelectable (\r
868 UI_MENU_OPTION *MenuOption\r
869 )\r
870{\r
871 if ((MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_SUBTITLE_OP) ||\r
872 MenuOption->GrayOut || MenuOption->ReadOnly) {\r
873 return FALSE;\r
874 } else {\r
875 return TRUE;\r
876 }\r
877}\r
878\r
879/**\r
880 Move to next selectable statement.\r
881\r
882 This is an internal function.\r
883\r
884 @param GoUp The navigation direction. TRUE: up, FALSE: down.\r
885 @param CurrentPosition Current position.\r
886 @param GapToTop Gap position to top or bottom.\r
887\r
888 @return The row distance from current MenuOption to next selectable MenuOption.\r
889\r
890 @retval -1 Reach the begin of the menu, still can't find the selectable menu.\r
891 @retval Value Find the selectable menu, maybe the truly selectable, maybe the l\r
892 last menu showing at current form.\r
893\r
894**/\r
895INTN\r
896MoveToNextStatement (\r
897 IN BOOLEAN GoUp,\r
898 IN OUT LIST_ENTRY **CurrentPosition,\r
899 IN UINTN GapToTop\r
900 )\r
901{\r
902 INTN Distance;\r
903 LIST_ENTRY *Pos;\r
904 UI_MENU_OPTION *NextMenuOption;\r
905 UI_MENU_OPTION *PreMenuOption;\r
906\r
907 Distance = 0;\r
908 Pos = *CurrentPosition;\r
909 PreMenuOption = MENU_OPTION_FROM_LINK (Pos);\r
910\r
911 while (TRUE) {\r
912 NextMenuOption = MENU_OPTION_FROM_LINK (Pos);\r
913 //\r
914 // NextMenuOption->Row == 0 means this menu has not calculate\r
915 // the NextMenuOption->Skip value yet, just calculate here.\r
916 //\r
917 if (NextMenuOption->Row == 0) {\r
918 UpdateOptionSkipLines (NextMenuOption);\r
919 }\r
920 \r
921 if (GoUp && (PreMenuOption != NextMenuOption)) {\r
922 //\r
923 // In this case, still can't find the selectable menu,\r
924 // return the last one in the showing form.\r
925 //\r
926 if ((UINTN) Distance + NextMenuOption->Skip > GapToTop) {\r
927 NextMenuOption = PreMenuOption;\r
928 break;\r
929 }\r
930\r
931 //\r
932 // Current Position doesn't need to be caculated when go up.\r
933 // Caculate distanct at first when go up\r
934 // \r
935 Distance += NextMenuOption->Skip;\r
936 }\r
937\r
938 if (IsSelectable (NextMenuOption)) {\r
939 break;\r
940 }\r
941\r
942 //\r
943 // Arrive at begin of the menu list.\r
944 //\r
945 if ((GoUp ? Pos->BackLink : Pos->ForwardLink) == &gMenuOption) {\r
946 Distance = -1;\r
947 break;\r
948 }\r
949\r
950 if (!GoUp) {\r
951 //\r
952 // In this case, still can't find the selectable menu,\r
953 // return the last one in the showing form.\r
954 //\r
955 if ((UINTN) Distance + NextMenuOption->Skip > GapToTop) {\r
956 NextMenuOption = PreMenuOption;\r
957 break;\r
958 }\r
959\r
960 Distance += NextMenuOption->Skip;\r
961 }\r
962\r
963 PreMenuOption = NextMenuOption;\r
964 Pos = (GoUp ? Pos->BackLink : Pos->ForwardLink);\r
965 }\r
966\r
967 *CurrentPosition = &NextMenuOption->Link;\r
968 return Distance;\r
969}\r
970\r
971\r
972/**\r
973 Process option string for date/time opcode.\r
974\r
975 @param MenuOption Menu option point to date/time.\r
976 @param OptionString Option string input for process.\r
977 @param AddOptCol Whether need to update MenuOption->OptCol. \r
978\r
979**/\r
980VOID \r
981ProcessStringForDateTime (\r
982 UI_MENU_OPTION *MenuOption,\r
983 CHAR16 *OptionString,\r
984 BOOLEAN AddOptCol\r
985 )\r
986{\r
987 UINTN Index;\r
988 UINTN Count;\r
989 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
990 EFI_IFR_DATE *Date;\r
991 EFI_IFR_TIME *Time;\r
992\r
993 ASSERT (MenuOption != NULL && OptionString != NULL);\r
994 \r
995 Statement = MenuOption->ThisTag;\r
996 Date = NULL;\r
997 Time = NULL;\r
998 if (Statement->OpCode->OpCode == EFI_IFR_DATE_OP) {\r
999 Date = (EFI_IFR_DATE *) Statement->OpCode;\r
1000 } else if (Statement->OpCode->OpCode == EFI_IFR_TIME_OP) {\r
1001 Time = (EFI_IFR_TIME *) Statement->OpCode;\r
1002 }\r
1003 \r
1004 //\r
1005 // If leading spaces on OptionString - remove the spaces\r
1006 //\r
1007 for (Index = 0; OptionString[Index] == L' '; Index++) {\r
1008 //\r
1009 // Base on the blockspace to get the option column info.\r
1010 //\r
1011 if (AddOptCol) {\r
1012 MenuOption->OptCol++;\r
1013 }\r
1014 }\r
1015 \r
1016 for (Count = 0; OptionString[Index] != CHAR_NULL; Index++) {\r
1017 OptionString[Count] = OptionString[Index];\r
1018 Count++;\r
1019 }\r
1020 OptionString[Count] = CHAR_NULL;\r
1021 \r
1022 //\r
1023 // Enable to suppress field in the opcode base on the flag.\r
1024 //\r
1025 if (Statement->OpCode->OpCode == EFI_IFR_DATE_OP) {\r
1026 //\r
1027 // OptionString format is: <**: **: ****>\r
1028 // |month|day|year|\r
1029 // 4 3 5\r
1030 //\r
1031 if ((Date->Flags & EFI_QF_DATE_MONTH_SUPPRESS) && (MenuOption->Sequence == 0)) {\r
1032 //\r
1033 // At this point, only "<**:" in the optionstring. \r
1034 // Clean the day's ** field, after clean, the format is "< :"\r
1035 //\r
1036 SetUnicodeMem (&OptionString[1], 2, L' ');\r
1037 } else if ((Date->Flags & EFI_QF_DATE_DAY_SUPPRESS) && (MenuOption->Sequence == 1)) {\r
1038 //\r
1039 // At this point, only "**:" in the optionstring. \r
1040 // Clean the month's "**" field, after clean, the format is " :"\r
1041 // \r
1042 SetUnicodeMem (&OptionString[0], 2, L' ');\r
1043 } else if ((Date->Flags & EFI_QF_DATE_YEAR_SUPPRESS) && (MenuOption->Sequence == 2)) {\r
1044 //\r
1045 // At this point, only "****>" in the optionstring. \r
1046 // Clean the year's "****" field, after clean, the format is " >"\r
1047 // \r
1048 SetUnicodeMem (&OptionString[0], 4, L' ');\r
1049 }\r
1050 } else if (Statement->OpCode->OpCode == EFI_IFR_TIME_OP) {\r
1051 //\r
1052 // OptionString format is: <**: **: **>\r
1053 // |hour|minute|second|\r
1054 // 4 3 3\r
1055 //\r
1056 if ((Time->Flags & QF_TIME_HOUR_SUPPRESS) && (MenuOption->Sequence == 0)) {\r
1057 //\r
1058 // At this point, only "<**:" in the optionstring. \r
1059 // Clean the hour's ** field, after clean, the format is "< :"\r
1060 //\r
1061 SetUnicodeMem (&OptionString[1], 2, L' ');\r
1062 } else if ((Time->Flags & QF_TIME_MINUTE_SUPPRESS) && (MenuOption->Sequence == 1)) {\r
1063 //\r
1064 // At this point, only "**:" in the optionstring. \r
1065 // Clean the minute's "**" field, after clean, the format is " :"\r
1066 // \r
1067 SetUnicodeMem (&OptionString[0], 2, L' ');\r
1068 } else if ((Time->Flags & QF_TIME_SECOND_SUPPRESS) && (MenuOption->Sequence == 2)) {\r
1069 //\r
1070 // At this point, only "**>" in the optionstring. \r
1071 // Clean the second's "**" field, after clean, the format is " >"\r
1072 // \r
1073 SetUnicodeMem (&OptionString[0], 2, L' ');\r
1074 }\r
1075 }\r
1076}\r
1077\r
1078\r
1079/**\r
1080 Adjust Data and Time position accordingly.\r
1081 Data format : [01/02/2004] [11:22:33]\r
1082 Line number : 0 0 1 0 0 1\r
1083\r
1084 This is an internal function.\r
1085\r
1086 @param DirectionUp the up or down direction. False is down. True is\r
1087 up.\r
1088 @param CurrentPosition Current position. On return: Point to the last\r
1089 Option (Year or Second) if up; Point to the first\r
1090 Option (Month or Hour) if down.\r
1091\r
1092 @return Return line number to pad. It is possible that we stand on a zero-advance\r
1093 @return data or time opcode, so pad one line when we judge if we are going to scroll outside.\r
1094\r
1095**/\r
1096UINTN\r
1097AdjustDateAndTimePosition (\r
1098 IN BOOLEAN DirectionUp,\r
1099 IN OUT LIST_ENTRY **CurrentPosition\r
1100 )\r
1101{\r
1102 UINTN Count;\r
1103 LIST_ENTRY *NewPosition;\r
1104 UI_MENU_OPTION *MenuOption;\r
1105 UINTN PadLineNumber;\r
1106\r
1107 PadLineNumber = 0;\r
1108 NewPosition = *CurrentPosition;\r
1109 MenuOption = MENU_OPTION_FROM_LINK (NewPosition);\r
1110\r
1111 if ((MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_DATE_OP) ||\r
1112 (MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TIME_OP)) {\r
1113 //\r
1114 // Calculate the distance from current position to the last Date/Time MenuOption\r
1115 //\r
1116 Count = 0;\r
1117 while (MenuOption->Skip == 0) {\r
1118 Count++;\r
1119 NewPosition = NewPosition->ForwardLink;\r
1120 MenuOption = MENU_OPTION_FROM_LINK (NewPosition);\r
1121 PadLineNumber = 1;\r
1122 }\r
1123\r
1124 NewPosition = *CurrentPosition;\r
1125 if (DirectionUp) {\r
1126 //\r
1127 // Since the behavior of hitting the up arrow on a Date/Time MenuOption is intended\r
1128 // to be one that back to the previous set of MenuOptions, we need to advance to the first\r
1129 // Date/Time MenuOption and leave the remaining logic in CfUiUp intact so the appropriate\r
1130 // checking can be done.\r
1131 //\r
1132 while (Count++ < 2) {\r
1133 NewPosition = NewPosition->BackLink;\r
1134 }\r
1135 } else {\r
1136 //\r
1137 // Since the behavior of hitting the down arrow on a Date/Time MenuOption is intended\r
1138 // to be one that progresses to the next set of MenuOptions, we need to advance to the last\r
1139 // Date/Time MenuOption and leave the remaining logic in CfUiDown intact so the appropriate\r
1140 // checking can be done.\r
1141 //\r
1142 while (Count-- > 0) {\r
1143 NewPosition = NewPosition->ForwardLink;\r
1144 }\r
1145 }\r
1146\r
1147 *CurrentPosition = NewPosition;\r
1148 }\r
1149\r
1150 return PadLineNumber;\r
1151}\r
1152\r
1153/**\r
1154 Get step info from numeric opcode.\r
1155 \r
1156 @param[in] OpCode The input numeric op code.\r
1157\r
1158 @return step info for this opcode.\r
1159**/\r
1160UINT64\r
1161GetFieldFromNum (\r
1162 IN EFI_IFR_OP_HEADER *OpCode\r
1163 )\r
1164{\r
1165 EFI_IFR_NUMERIC *NumericOp;\r
1166 UINT64 Step;\r
1167\r
1168 NumericOp = (EFI_IFR_NUMERIC *) OpCode;\r
1169 \r
1170 switch (NumericOp->Flags & EFI_IFR_NUMERIC_SIZE) {\r
1171 case EFI_IFR_NUMERIC_SIZE_1:\r
1172 Step = NumericOp->data.u8.Step;\r
1173 break;\r
1174 \r
1175 case EFI_IFR_NUMERIC_SIZE_2:\r
1176 Step = NumericOp->data.u16.Step;\r
1177 break;\r
1178 \r
1179 case EFI_IFR_NUMERIC_SIZE_4:\r
1180 Step = NumericOp->data.u32.Step;\r
1181 break;\r
1182 \r
1183 case EFI_IFR_NUMERIC_SIZE_8:\r
1184 Step = NumericOp->data.u64.Step;\r
1185 break;\r
1186 \r
1187 default:\r
1188 Step = 0;\r
1189 break;\r
1190 }\r
1191\r
1192 return Step;\r
1193}\r
1194\r
1195/**\r
1196 Find the registered HotKey based on KeyData.\r
1197 \r
1198 @param[in] KeyData A pointer to a buffer that describes the keystroke\r
1199 information for the hot key.\r
1200\r
1201 @return The registered HotKey context. If no found, NULL will return.\r
1202**/\r
1203BROWSER_HOT_KEY *\r
1204GetHotKeyFromRegisterList (\r
1205 IN EFI_INPUT_KEY *KeyData\r
1206 )\r
1207{\r
1208 LIST_ENTRY *Link;\r
1209 BROWSER_HOT_KEY *HotKey;\r
1210\r
1211 Link = GetFirstNode (&gFormData->HotKeyListHead);\r
1212 while (!IsNull (&gFormData->HotKeyListHead, Link)) {\r
1213 HotKey = BROWSER_HOT_KEY_FROM_LINK (Link);\r
1214 \r
1215 if (HotKey->KeyData->ScanCode == KeyData->ScanCode) {\r
1216 return HotKey;\r
1217 }\r
1218\r
1219 Link = GetNextNode (&gFormData->HotKeyListHead, Link);\r
1220 }\r
1221 \r
1222 return NULL;\r
1223}\r
1224\r
1225\r
1226/**\r
1227 Determine if the menu is the last menu that can be selected.\r
1228\r
1229 This is an internal function.\r
1230\r
1231 @param Direction The scroll direction. False is down. True is up.\r
1232 @param CurrentPos The current focus.\r
1233\r
1234 @return FALSE -- the menu isn't the last menu that can be selected.\r
1235 @return TRUE -- the menu is the last menu that can be selected.\r
1236\r
1237**/\r
1238BOOLEAN\r
1239ValueIsScroll (\r
1240 IN BOOLEAN Direction,\r
1241 IN LIST_ENTRY *CurrentPos\r
1242 )\r
1243{\r
1244 LIST_ENTRY *Temp;\r
1245\r
1246 Temp = Direction ? CurrentPos->BackLink : CurrentPos->ForwardLink;\r
1247\r
1248 if (Temp == &gMenuOption) {\r
1249 return TRUE;\r
1250 }\r
1251\r
1252 return FALSE;\r
1253}\r
1254\r
1255/**\r
1256 Wait for a given event to fire, or for an optional timeout to expire.\r
1257\r
1258 @param Event The event to wait for\r
1259\r
1260 @retval UI_EVENT_TYPE The type of the event which is trigged.\r
1261\r
1262**/\r
1263UI_EVENT_TYPE\r
1264UiWaitForEvent (\r
1265 IN EFI_EVENT Event\r
1266 )\r
1267{\r
1268 EFI_STATUS Status;\r
1269 UINTN Index;\r
1270 UINTN EventNum;\r
1271 UINT64 Timeout;\r
1272 EFI_EVENT TimerEvent;\r
1273 EFI_EVENT WaitList[3];\r
1274 UI_EVENT_TYPE EventType;\r
1275\r
1276 TimerEvent = NULL;\r
1277 Timeout = FormExitTimeout(gFormData);\r
1278\r
1279 if (Timeout != 0) {\r
1280 Status = gBS->CreateEvent (EVT_TIMER, 0, NULL, NULL, &TimerEvent);\r
1281\r
1282 //\r
1283 // Set the timer event\r
1284 //\r
1285 gBS->SetTimer (\r
1286 TimerEvent,\r
1287 TimerRelative,\r
1288 Timeout\r
1289 );\r
1290 }\r
1291 \r
1292 WaitList[0] = Event;\r
1293 EventNum = 1;\r
1294 if (gFormData->FormRefreshEvent != NULL) {\r
1295 WaitList[EventNum] = gFormData->FormRefreshEvent;\r
1296 EventNum ++;\r
1297 } \r
1298\r
1299 if (Timeout != 0) {\r
1300 WaitList[EventNum] = TimerEvent;\r
1301 EventNum ++;\r
1302 }\r
1303\r
1304 Status = gBS->WaitForEvent (EventNum, WaitList, &Index);\r
1305 ASSERT_EFI_ERROR (Status);\r
1306\r
1307 switch (Index) {\r
1308 case 0:\r
1309 EventType = UIEventKey;\r
1310 break;\r
1311\r
1312 case 1:\r
1313 if (gFormData->FormRefreshEvent != NULL) {\r
1314 EventType = UIEventDriver;\r
1315 } else {\r
1316 ASSERT (Timeout != 0 && EventNum == 2);\r
1317 EventType = UIEventTimeOut;\r
1318 }\r
1319 break;\r
1320\r
1321 default:\r
1322 ASSERT (Index == 2 && EventNum == 3);\r
1323 EventType = UIEventTimeOut;\r
1324 break;\r
1325 }\r
1326\r
1327 if (Timeout != 0) {\r
1328 gBS->CloseEvent (TimerEvent);\r
1329 }\r
1330 \r
1331 return EventType;\r
1332}\r
1333\r
1334/**\r
1335 Get question id info from the input opcode header.\r
1336\r
1337 @param OpCode The input opcode header pointer.\r
1338\r
1339 @retval The question id for this opcode.\r
1340\r
1341**/\r
1342EFI_QUESTION_ID\r
1343GetQuestionIdInfo (\r
1344 IN EFI_IFR_OP_HEADER *OpCode\r
1345 )\r
1346{\r
1347 EFI_IFR_QUESTION_HEADER *QuestionHeader;\r
1348\r
1349 if (OpCode->Length < sizeof (EFI_IFR_OP_HEADER) + sizeof (EFI_IFR_QUESTION_HEADER)) {\r
1350 return 0;\r
1351 }\r
1352\r
1353 QuestionHeader = (EFI_IFR_QUESTION_HEADER *)((UINT8 *) OpCode + sizeof(EFI_IFR_OP_HEADER));\r
1354\r
1355 return QuestionHeader->QuestionId;\r
1356}\r
1357\r
1358/**\r
1359 Find the first menu which will be show at the top.\r
1360\r
1361 @param FormData The data info for this form.\r
1362 @param TopOfScreen The link_entry pointer to top menu.\r
1363 @param HighlightMenu The menu which will be highlight.\r
1364 @param SkipValue The skip value for the top menu.\r
1365\r
1366**/\r
1367VOID\r
1368FindTopMenu (\r
1369 IN FORM_DISPLAY_ENGINE_FORM *FormData,\r
1370 OUT LIST_ENTRY **TopOfScreen,\r
1371 OUT LIST_ENTRY **HighlightMenu,\r
1372 OUT INTN *SkipValue\r
1373 )\r
1374{\r
1375 LIST_ENTRY *Link;\r
1376 LIST_ENTRY *NewPos;\r
1377 UINTN TopRow;\r
1378 UINTN BottomRow;\r
1379 UINTN Index;\r
1380 UI_MENU_OPTION *SavedMenuOption;\r
1381 UINTN EndRow;\r
1382\r
1383 TopRow = gStatementDimensions.TopRow + SCROLL_ARROW_HEIGHT;\r
1384 BottomRow = gStatementDimensions.BottomRow - SCROLL_ARROW_HEIGHT;\r
1385\r
1386 //\r
1387 // If not has input highlight statement, just return the first one in this form.\r
1388 //\r
1389 if (FormData->HighLightedStatement == NULL) {\r
1390 *TopOfScreen = gMenuOption.ForwardLink;\r
1391 *HighlightMenu = gMenuOption.ForwardLink;\r
1392 if (!IsListEmpty (&gMenuOption)) {\r
1393 MoveToNextStatement (FALSE, HighlightMenu, BottomRow - TopRow);\r
1394 }\r
1395 *SkipValue = 0;\r
1396 return;\r
1397 }\r
1398\r
1399 //\r
1400 // Now base on the input highlight menu to find the top menu in this page.\r
1401 // Will base on the highlight menu show at the bottom to find the top menu.\r
1402 //\r
1403 NewPos = gMenuOption.ForwardLink;\r
1404 SavedMenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
1405\r
1406 while ((SavedMenuOption->ThisTag != FormData->HighLightedStatement) ||\r
1407 (SavedMenuOption->Sequence != gSequence)) {\r
1408 NewPos = NewPos->ForwardLink;\r
1409 if (NewPos == &gMenuOption) {\r
1410 //\r
1411 // Not Found it, break\r
1412 //\r
1413 break;\r
1414 }\r
1415 SavedMenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
1416 }\r
1417 ASSERT (SavedMenuOption->ThisTag == FormData->HighLightedStatement);\r
1418\r
1419 *HighlightMenu = NewPos;\r
1420\r
1421 AdjustDateAndTimePosition(FALSE, &NewPos);\r
1422 SavedMenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
1423 UpdateOptionSkipLines (SavedMenuOption);\r
1424\r
1425 //\r
1426 // If highlight opcode is date/time, keep the highlight row info not change.\r
1427 //\r
1428 if ((SavedMenuOption->ThisTag->OpCode->OpCode == EFI_IFR_DATE_OP || SavedMenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TIME_OP) &&\r
1429 (gHighligthMenuInfo.QuestionId != 0) && \r
1430 (gHighligthMenuInfo.QuestionId == GetQuestionIdInfo(SavedMenuOption->ThisTag->OpCode))) {\r
1431 //\r
1432 // Still show the highlight menu before exit from display engine.\r
1433 //\r
1434 EndRow = gHighligthMenuInfo.DisplayRow + SavedMenuOption->Skip;\r
1435 } else {\r
1436 EndRow = BottomRow;\r
1437 }\r
1438\r
1439 //\r
1440 // Base on the selected menu will show at the bottome of next page, \r
1441 // select the menu show at the top of the next page. \r
1442 //\r
1443 Link = NewPos;\r
1444 for (Index = TopRow + SavedMenuOption->Skip; Index <= EndRow; ) {\r
1445 Link = Link->BackLink;\r
1446 //\r
1447 // Already find the first menu in this form, means highlight menu \r
1448 // will show in first page of this form.\r
1449 //\r
1450 if (Link == &gMenuOption) {\r
1451 *TopOfScreen = gMenuOption.ForwardLink;\r
1452 *SkipValue = 0;\r
1453 return;\r
1454 }\r
1455 SavedMenuOption = MENU_OPTION_FROM_LINK (Link);\r
1456 UpdateOptionSkipLines (SavedMenuOption);\r
1457 Index += SavedMenuOption->Skip;\r
1458 }\r
1459\r
1460 //\r
1461 // Found the menu which will show at the top of the page.\r
1462 //\r
1463 if (Link == NewPos) {\r
1464 //\r
1465 // The menu can show more than one pages, just show the menu at the top of the page.\r
1466 //\r
1467 *SkipValue = 0;\r
1468 *TopOfScreen = Link;\r
1469 } else {\r
1470 //\r
1471 // Check whether need to skip some line for menu shows at the top of the page.\r
1472 //\r
1473 *SkipValue = Index - EndRow;\r
1474 if (*SkipValue > 0 && *SkipValue < (INTN) SavedMenuOption->Skip) {\r
1475 *TopOfScreen = Link;\r
1476 } else {\r
1477 *SkipValue = 0;\r
1478 *TopOfScreen = Link->ForwardLink;\r
1479 }\r
1480 }\r
1481}\r
1482\r
af047db7
ED		 1483/**\r
1484 Update highlight menu info.\r
1485\r
1486 @param MenuOption The menu opton which is highlight.\r
1487\r
1488**/\r
1489VOID\r
1490UpdateHighlightMenuInfo (\r
1491 IN UI_MENU_OPTION *MenuOption\r
1492 )\r
1493{\r
1494 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
1495\r
1496 //\r
1497 // This is the current selected statement\r
1498 //\r
1499 Statement = MenuOption->ThisTag;\r
1500\r
1501 //\r
1502 // Get the highlight statement.\r
1503 //\r
1504 gUserInput->SelectedStatement = Statement;\r
1505 gSequence = (UINT16) MenuOption->Sequence;\r
1506\r
1507 //\r
1508 // Record highlight row info for date/time opcode.\r
1509 //\r
1510 if (Statement->OpCode->OpCode == EFI_IFR_DATE_OP || Statement->OpCode->OpCode == EFI_IFR_TIME_OP) {\r
1511 gHighligthMenuInfo.QuestionId = GetQuestionIdInfo(Statement->OpCode);\r
1512 gHighligthMenuInfo.DisplayRow = (UINT16) MenuOption->Row;\r
1513 } else {\r
1514 gHighligthMenuInfo.QuestionId = 0;\r
1515 gHighligthMenuInfo.DisplayRow = 0;\r
1516 }\r
1517\r
1518 RefreshKeyHelp(gFormData, Statement, FALSE);\r
1519}\r
1520\r
1521/**\r
1522 Update attribut for this menu.\r
1523\r
1524 @param MenuOption The menu opton which this attribut used to.\r
1525 @param Highlight Whether this menu will be highlight.\r
1526\r
1527**/\r
1528VOID\r
1529SetDisplayAttribute (\r
1530 IN UI_MENU_OPTION *MenuOption,\r
1531 IN BOOLEAN Highlight\r
1532 )\r
1533{\r
1534 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
1535 \r
1536 Statement = MenuOption->ThisTag;\r
1537\r
1538 if (Highlight) {\r
1539 gST->ConOut->SetAttribute (gST->ConOut, GetHighlightTextColor ());\r
1540 return;\r
1541 }\r
1542\r
1543 if (MenuOption->GrayOut) {\r
1544 gST->ConOut->SetAttribute (gST->ConOut, GetGrayedTextColor ());\r
1545 } else {\r
1546 if (Statement->OpCode->OpCode == EFI_IFR_SUBTITLE_OP) {\r
1547 gST->ConOut->SetAttribute (gST->ConOut, GetSubTitleTextColor ());\r
1548 } else {\r
1549 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
1550 }\r
1551 }\r
1552}\r
1553\r
1554/**\r
1555 Print string for this menu option.\r
1556\r
1557 @param MenuOption The menu opton which this attribut used to.\r
1558 @param Col The column that this string will be print at.\r
1559 @param Row The row that this string will be print at.\r
1560 @param String The string which need to print.\r
1561 @param Width The width need to print, if string is less than the\r
1562 width, the block space will be used.\r
1563 @param Highlight Whether this menu will be highlight.\r
1564\r
1565**/\r
1566VOID\r
1567DisplayMenuString (\r
1568 IN UI_MENU_OPTION *MenuOption,\r
1569 IN UINTN Col,\r
1570 IN UINTN Row,\r
1571 IN CHAR16 *String,\r
1572 IN UINTN Width,\r
1573 IN BOOLEAN Highlight\r
1574 )\r
1575{\r
1576 UINTN Length;\r
1577\r
1578 //\r
1579 // Print string with normal color.\r
1580 //\r
1581 if (!Highlight) {\r
1582 PrintStringAtWithWidth (Col, Row, String, Width);\r
1583 return;\r
1584 }\r
1585 \r
1586 //\r
1587 // Print the highlight menu string.\r
1588 // First print the highlight string.\r
1589 // \r
1590 SetDisplayAttribute(MenuOption, TRUE);\r
1591 Length = PrintStringAt (Col, Row, String);\r
1592\r
1593 //\r
1594 // Second, clean the empty after the string.\r
1595 //\r
1596 SetDisplayAttribute(MenuOption, FALSE);\r
1597 PrintStringAtWithWidth (Col + Length, Row, L"", Width - Length);\r
1598}\r
1599\r
28401a65
ED		 1600/**\r
1601 Check whether this menu can has option string.\r
1602\r
1603 @param MenuOption The menu opton which this attribut used to.\r
1604\r
1605 @retval TRUE This menu option can have option string.\r
1606 @retval FALSE This menu option can't have option string.\r
1607\r
1608**/\r
1609BOOLEAN \r
1610HasOptionString (\r
1611 IN UI_MENU_OPTION *MenuOption\r
1612 )\r
1613{\r
1614 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
1615 CHAR16 *String;\r
1616 UINTN Size;\r
1617 EFI_IFR_TEXT *TestOp;\r
1618\r
1619 Size = 0;\r
1620 Statement = MenuOption->ThisTag;\r
1621\r
1622 //\r
1623 // See if the second text parameter is really NULL\r
1624 //\r
1625 if (Statement->OpCode->OpCode == EFI_IFR_TEXT_OP) {\r
1626 TestOp = (EFI_IFR_TEXT *) Statement->OpCode;\r
1627 if (TestOp->TextTwo != 0) {\r
1628 String = GetToken (TestOp->TextTwo, gFormData->HiiHandle);\r
1629 Size = StrLen (String);\r
1630 FreePool (String);\r
1631 }\r
1632 }\r
1633\r
1634 if ((Statement->OpCode->OpCode == EFI_IFR_SUBTITLE_OP) ||\r
1635 (Statement->OpCode->OpCode == EFI_IFR_REF_OP) ||\r
1636 (Statement->OpCode->OpCode == EFI_IFR_PASSWORD_OP) ||\r
1637 (Statement->OpCode->OpCode == EFI_IFR_ACTION_OP) ||\r
1638 (Statement->OpCode->OpCode == EFI_IFR_RESET_BUTTON_OP) ||\r
1639 //\r
1640 // Allow a wide display if text op-code and no secondary text op-code\r
1641 //\r
1642 ((Statement->OpCode->OpCode == EFI_IFR_TEXT_OP) && (Size == 0))\r
1643 ) {\r
1644\r
1645 return FALSE;\r
1646 }\r
1647\r
1648 return TRUE;\r
1649}\r
1650\r
1651\r
af047db7
ED		 1652/**\r
1653 Print string for this menu option.\r
1654\r
1655 @param MenuOption The menu opton which this attribut used to.\r
1656 @param SkipWidth The skip width between the left to the start of the prompt.\r
1657 @param BeginCol The begin column for one menu.\r
1658 @param SkipLine The skip line for this menu. \r
1659 @param BottomRow The bottom row for this form.\r
1660 @param Highlight Whether this menu will be highlight.\r
1661\r
1662 @retval EFI_SUCESSS Process the user selection success.\r
1663\r
1664**/\r
1665EFI_STATUS\r
1666DisplayOneMenu (\r
1667 IN UI_MENU_OPTION *MenuOption,\r
1668 IN UINTN SkipWidth,\r
1669 IN UINTN BeginCol,\r
1670 IN UINTN SkipLine,\r
1671 IN UINTN BottomRow,\r
1672 IN BOOLEAN Highlight\r
1673 )\r
1674{\r
1675 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
1676 UINTN Index;\r
1677 UINT16 Width;\r
1678 UINT16 PromptWidth;\r
1679 CHAR16 *StringPtr;\r
1680 CHAR16 *OptionString;\r
1681 CHAR16 *OutputString;\r
af047db7
ED		 1682 UINT16 GlyphWidth;\r
1683 UINTN Temp;\r
1684 UINTN Temp2;\r
1685 UINTN Temp3;\r
1686 EFI_STATUS Status;\r
1687 UINTN Row;\r
1688 UINTN Col;\r
1689 UINTN PromptLineNum;\r
28401a65 1690 UINTN OptionLineNum;\r
af047db7 1691 CHAR16 AdjustValue;\r
28401a65 1692 UINTN MaxRow;\r
af047db7
ED		 1693\r
1694 Statement = MenuOption->ThisTag;\r
af047db7
ED		 1695 Temp = SkipLine;\r
1696 Temp2 = SkipLine;\r
1697 Temp3 = SkipLine;\r
28401a65
ED		 1698 AdjustValue = 0;\r
1699 PromptLineNum = 0;\r
1700 OptionLineNum = 0;\r
1701 MaxRow = 0;\r
af047db7
ED		 1702\r
1703 //\r
1704 // Set default color.\r
1705 //\r
1706 SetDisplayAttribute (MenuOption, FALSE);\r
1707\r
1708 //\r
1709 // 1. Paint the option string.\r
1710 //\r
1711 Status = ProcessOptions (MenuOption, FALSE, &OptionString, FALSE);\r
1712 if (EFI_ERROR (Status)) {\r
1713 return Status;\r
1714 }\r
1715\r
1716 if (OptionString != NULL) {\r
1717 if (Statement->OpCode->OpCode == EFI_IFR_DATE_OP || Statement->OpCode->OpCode == EFI_IFR_TIME_OP) {\r
1718 //\r
1719 // Adjust option string for date/time opcode.\r
1720 //\r
1721 ProcessStringForDateTime(MenuOption, OptionString, TRUE);\r
1722 }\r
1723 \r
1724 Width = (UINT16) gOptionBlockWidth - 1;\r
28401a65 1725 Row = MenuOption->Row;\r
af047db7 1726 GlyphWidth = 1;\r
28401a65 1727 OptionLineNum = 0;\r
af047db7
ED		 1728 \r
1729 for (Index = 0; GetLineByWidth (OptionString, Width, &GlyphWidth, &Index, &OutputString) != 0x0000;) {\r
1730 if (((Temp2 == 0)) && (Row <= BottomRow)) {\r
1731 if (Statement->OpCode->OpCode == EFI_IFR_DATE_OP || Statement->OpCode->OpCode == EFI_IFR_TIME_OP) {\r
1732 //\r
1733 // For date/time question, it has three menu options for this qustion.\r
1734 // The first/second menu options with the skip value is 0. the last one\r
1735 // with skip value is 1.\r
1736 //\r
1737 if (MenuOption->Skip != 0) {\r
1738 //\r
1739 // For date/ time, print the last past (year for date and second for time)\r
1740 // - 7 means skip [##/##/ for date and [##:##: for time.\r
1741 //\r
1742 DisplayMenuString (MenuOption,MenuOption->OptCol, Row, OutputString, Width + 1 - 7, Highlight);\r
1743 } else {\r
1744 //\r
1745 // For date/ time, print the first and second past (year for date and second for time)\r
1746 // \r
1747 DisplayMenuString (MenuOption, MenuOption->OptCol, Row, OutputString, StrLen (OutputString), Highlight);\r
1748 }\r
1749 } else {\r
1750 DisplayMenuString (MenuOption, MenuOption->OptCol, Row, OutputString, Width + 1, Highlight);\r
1751 }\r
28401a65 1752 OptionLineNum++;\r
af047db7
ED		 1753 }\r
1754 \r
1755 //\r
1756 // If there is more string to process print on the next row and increment the Skip value\r
1757 //\r
1758 if (StrLen (&OptionString[Index]) != 0) {\r
1759 if (Temp2 == 0) {\r
1760 Row++;\r
1761 //\r
1762 // Since the Number of lines for this menu entry may or may not be reflected accurately\r
1763 // since the prompt might be 1 lines and option might be many, and vice versa, we need to do\r
1764 // some testing to ensure we are keeping this in-sync.\r
1765 //\r
1766 // If the difference in rows is greater than or equal to the skip value, increase the skip value\r
1767 //\r
28401a65 1768 if ((Row - MenuOption->Row) >= MenuOption->Skip) {\r
af047db7
ED		 1769 MenuOption->Skip++;\r
1770 }\r
1771 }\r
1772 }\r
1773 \r
1774 FreePool (OutputString);\r
1775 if (Temp2 != 0) {\r
1776 Temp2--;\r
1777 }\r
1778 }\r
1779 \r
af047db7
ED		 1780 Highlight = FALSE;\r
1781\r
1782 FreePool (OptionString);\r
1783 }\r
af047db7
ED		 1784\r
1785 //\r
28401a65 1786 // 2. Paint the description.\r
af047db7 1787 //\r
6f05c023 1788 PromptWidth = GetWidth (MenuOption, &AdjustValue);\r
28401a65 1789 Row = MenuOption->Row;\r
af047db7
ED		 1790 GlyphWidth = 1;\r
1791 PromptLineNum = 0;\r
1792\r
1793 if (MenuOption->Description == NULL || MenuOption->Description[0] == '\0') {\r
28401a65
ED		 1794 PrintStringAtWithWidth (BeginCol, Row, L"", PromptWidth + AdjustValue + SkipWidth);\r
1795 PromptLineNum++;\r
af047db7
ED		 1796 } else {\r
1797 for (Index = 0; GetLineByWidth (MenuOption->Description, PromptWidth, &GlyphWidth, &Index, &OutputString) != 0x0000;) { \r
1798 if ((Temp == 0) && (Row <= BottomRow)) { \r
1799 //\r
1800 // 1.Clean the start LEFT_SKIPPED_COLUMNS \r
1801 //\r
1802 PrintStringAtWithWidth (BeginCol, Row, L"", SkipWidth);\r
1803 \r
1804 if (Statement->OpCode->OpCode == EFI_IFR_REF_OP && MenuOption->Col >= 2) {\r
1805 //\r
1806 // Print Arrow for Goto button.\r
1807 //\r
1808 PrintCharAt (\r
1809 MenuOption->Col - 2,\r
1810 Row,\r
1811 GEOMETRICSHAPE_RIGHT_TRIANGLE\r
1812 );\r
1813 }\r
1814 DisplayMenuString (MenuOption, MenuOption->Col, Row, OutputString, PromptWidth + AdjustValue, Highlight);\r
1815 PromptLineNum ++;\r
1816 }\r
1817 //\r
1818 // If there is more string to process print on the next row and increment the Skip value\r
1819 //\r
1820 if (StrLen (&MenuOption->Description[Index]) != 0) {\r
1821 if (Temp == 0) {\r
1822 Row++;\r
1823 }\r
1824 }\r
1825\r
1826 FreePool (OutputString);\r
1827 if (Temp != 0) {\r
1828 Temp--;\r
1829 }\r
1830 }\r
1831\r
1832 Highlight = FALSE;\r
af047db7 1833 }\r
af047db7
ED		 1834\r
1835\r
1836 //\r
28401a65 1837 // 3. If this is a text op with secondary text information\r
af047db7
ED		 1838 //\r
1839 if ((Statement->OpCode->OpCode == EFI_IFR_TEXT_OP) && (((EFI_IFR_TEXT*)Statement->OpCode)->TextTwo != 0)) {\r
1840 StringPtr = GetToken (((EFI_IFR_TEXT*)Statement->OpCode)->TextTwo, gFormData->HiiHandle);\r
1841 \r
1842 Width = (UINT16) gOptionBlockWidth - 1;\r
28401a65 1843 Row = MenuOption->Row;\r
af047db7 1844 GlyphWidth = 1;\r
28401a65 1845 OptionLineNum = 0;\r
af047db7
ED		 1846\r
1847 for (Index = 0; GetLineByWidth (StringPtr, Width, &GlyphWidth, &Index, &OutputString) != 0x0000;) { \r
1848 if ((Temp3 == 0) && (Row <= BottomRow)) {\r
1849 DisplayMenuString (MenuOption, MenuOption->OptCol, Row, OutputString, Width + 1, Highlight);\r
28401a65 1850 OptionLineNum++;\r
af047db7
ED		 1851 }\r
1852 //\r
1853 // If there is more string to process print on the next row and increment the Skip value\r
1854 //\r
1855 if (StrLen (&StringPtr[Index]) != 0) {\r
1856 if (Temp3 == 0) {\r
1857 Row++;\r
a6a2a956
ED		 1858 //\r
1859 // If the rows for text two is greater than or equal to the skip value, increase the skip value\r
1860 //\r
1861 if ((Row - MenuOption->Row) >= MenuOption->Skip) {\r
1862 MenuOption->Skip++;\r
1863 }\r
af047db7
ED		 1864 }\r
1865 }\r
1866 \r
1867 FreePool (OutputString);\r
1868 if (Temp3 != 0) {\r
1869 Temp3--;\r
1870 }\r
1871 }\r
28401a65 1872\r
af047db7
ED		 1873 FreePool (StringPtr);\r
1874 }\r
1875\r
28401a65
ED		 1876 //\r
1877 // 4.Line number for Option string and prompt string are not equal.\r
1878 // Clean the column whose line number is less.\r
1879 //\r
1880 if (HasOptionString(MenuOption) && (OptionLineNum != PromptLineNum)) {\r
1881 Col = OptionLineNum < PromptLineNum ? MenuOption->OptCol : BeginCol;\r
1882 Row = (OptionLineNum < PromptLineNum ? OptionLineNum : PromptLineNum) + MenuOption->Row;\r
1883 Width = (UINT16) (OptionLineNum < PromptLineNum ? gOptionBlockWidth : PromptWidth + AdjustValue + SkipWidth);\r
1884 MaxRow = (OptionLineNum < PromptLineNum ? PromptLineNum : OptionLineNum) + MenuOption->Row - 1;\r
1885 \r
1886 while (Row <= MaxRow) {\r
1887 DisplayMenuString (MenuOption, Col, Row++, L"", Width, FALSE);\r
1888 }\r
1889 }\r
1890\r
af047db7
ED		 1891 return EFI_SUCCESS;\r
1892}\r
1893\r
7c6c064c
ED		 1894/**\r
1895 Display menu and wait for user to select one menu option, then return it.\r
1896 If AutoBoot is enabled, then if user doesn't select any option,\r
1897 after period of time, it will automatically return the first menu option.\r
1898\r
1899 @param FormData The current form data info.\r
1900\r
1901 @retval EFI_SUCESSS Process the user selection success.\r
1902 @retval EFI_NOT_FOUND Process option string for orderedlist/Oneof fail.\r
1903\r
1904**/\r
1905EFI_STATUS\r
1906UiDisplayMenu (\r
1907 IN FORM_DISPLAY_ENGINE_FORM *FormData\r
1908 )\r
1909{\r
1910 INTN SkipValue;\r
1911 INTN Difference;\r
1912 UINTN DistanceValue;\r
1913 UINTN Row;\r
1914 UINTN Col;\r
7c6c064c
ED		 1915 UINTN Temp;\r
1916 UINTN Temp2;\r
7c6c064c
ED		 1917 UINTN TopRow;\r
1918 UINTN BottomRow;\r
1919 UINTN OriginalRow;\r
1920 UINTN Index;\r
1921 UINT16 Width;\r
1922 CHAR16 *StringPtr;\r
1923 CHAR16 *OptionString;\r
1924 CHAR16 *OutputString;\r
1925 CHAR16 *HelpString;\r
1926 CHAR16 *HelpHeaderString;\r
1927 CHAR16 *HelpBottomString;\r
1928 BOOLEAN NewLine;\r
1929 BOOLEAN Repaint;\r
1930 BOOLEAN UpArrow;\r
1931 BOOLEAN DownArrow;\r
1932 EFI_STATUS Status;\r
1933 EFI_INPUT_KEY Key;\r
1934 LIST_ENTRY *Link;\r
1935 LIST_ENTRY *NewPos;\r
1936 LIST_ENTRY *TopOfScreen;\r
1937 LIST_ENTRY *SavedListEntry;\r
1938 UI_MENU_OPTION *MenuOption;\r
1939 UI_MENU_OPTION *NextMenuOption;\r
1940 UI_MENU_OPTION *SavedMenuOption;\r
1941 UI_MENU_OPTION *PreviousMenuOption;\r
1942 UI_CONTROL_FLAG ControlFlag;\r
1943 UI_SCREEN_OPERATION ScreenOperation;\r
1944 UINT16 DefaultId;\r
1945 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
7c6c064c
ED		 1946 BROWSER_HOT_KEY *HotKey;\r
1947 UINTN HelpPageIndex;\r
1948 UINTN HelpPageCount;\r
1949 UINTN RowCount;\r
1950 UINTN HelpLine;\r
1951 UINTN HelpHeaderLine;\r
1952 UINTN HelpBottomLine;\r
1953 BOOLEAN MultiHelpPage;\r
1954 UINT16 GlyphWidth;\r
1955 UINT16 EachLineWidth;\r
1956 UINT16 HeaderLineWidth;\r
1957 UINT16 BottomLineWidth;\r
1958 EFI_STRING_ID HelpInfo;\r
1959 UI_EVENT_TYPE EventType;\r
1960 FORM_DISPLAY_ENGINE_STATEMENT *InitialHighlight;\r
af047db7 1961 BOOLEAN SkipHighLight;\r
7c6c064c
ED		 1962\r
1963 EventType = UIEventNone;\r
1964 Status = EFI_SUCCESS;\r
1965 HelpString = NULL;\r
1966 HelpHeaderString = NULL;\r
1967 HelpBottomString = NULL;\r
1968 OptionString = NULL;\r
1969 ScreenOperation = UiNoOperation;\r
1970 NewLine = TRUE;\r
1971 DefaultId = 0;\r
1972 HelpPageCount = 0;\r
1973 HelpLine = 0;\r
1974 RowCount = 0;\r
1975 HelpBottomLine = 0;\r
1976 HelpHeaderLine = 0;\r
1977 HelpPageIndex = 0;\r
1978 MultiHelpPage = FALSE;\r
1979 EachLineWidth = 0;\r
1980 HeaderLineWidth = 0;\r
1981 BottomLineWidth = 0;\r
1982 OutputString = NULL;\r
1983 UpArrow = FALSE;\r
1984 DownArrow = FALSE;\r
1985 SkipValue = 0;\r
af047db7 1986 SkipHighLight = FALSE;\r
7c6c064c
ED		 1987\r
1988 NextMenuOption = NULL;\r
1989 PreviousMenuOption = NULL;\r
1990 SavedMenuOption = NULL;\r
1991 HotKey = NULL;\r
1992 Repaint = TRUE;\r
1993 MenuOption = NULL;\r
af047db7 1994 gModalSkipColumn = (CHAR16) (gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn) / 6;\r
7c6c064c
ED		 1995 InitialHighlight = gFormData->HighLightedStatement;\r
1996\r
1997 ZeroMem (&Key, sizeof (EFI_INPUT_KEY));\r
1998\r
af047db7
ED		 1999 //\r
2000 // Left right\r
2001 // |<-.->|<-.........->|<- .........->|<-...........->|\r
2002 // Skip Prompt Option Help \r
2003 //\r
2004 Width = (CHAR16) ((gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn) / 3);\r
2005 gOptionBlockWidth = Width + 1; \r
2006 gHelpBlockWidth = (CHAR16) (Width - LEFT_SKIPPED_COLUMNS);\r
2007 gPromptBlockWidth = (CHAR16) (gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn - 2 * Width - 1);\r
7c6c064c
ED		 2008\r
2009 TopRow = gStatementDimensions.TopRow + SCROLL_ARROW_HEIGHT;\r
2010 BottomRow = gStatementDimensions.BottomRow - SCROLL_ARROW_HEIGHT - 1;\r
2011\r
2012 Row = TopRow;\r
2013 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
af047db7 2014 Col = gStatementDimensions.LeftColumn + LEFT_SKIPPED_COLUMNS + gModalSkipColumn;\r
7c6c064c
ED		 2015 } else {\r
2016 Col = gStatementDimensions.LeftColumn + LEFT_SKIPPED_COLUMNS;\r
2017 }\r
2018\r
2019 FindTopMenu(FormData, &TopOfScreen, &NewPos, &SkipValue);\r
2020\r
2021 gST->ConOut->EnableCursor (gST->ConOut, FALSE);\r
2022\r
2023 ControlFlag = CfInitialization;\r
2024 while (TRUE) {\r
2025 switch (ControlFlag) {\r
2026 case CfInitialization:\r
af047db7
ED		 2027 if ((gOldFormEntry.HiiHandle != FormData->HiiHandle) || \r
2028 (!CompareGuid (&gOldFormEntry.FormSetGuid, &FormData->FormSetGuid))) {\r
2029 //\r
2030 // Clear Statement range if different formset is painted.\r
2031 //\r
2032 ClearLines (\r
2033 gStatementDimensions.LeftColumn,\r
2034 gStatementDimensions.RightColumn,\r
2035 TopRow - SCROLL_ARROW_HEIGHT,\r
2036 BottomRow + SCROLL_ARROW_HEIGHT,\r
2037 GetFieldTextColor ()\r
2038 );\r
7c6c064c 2039\r
7c6c064c 2040 }\r
af047db7 2041 ControlFlag = CfRepaint;\r
7c6c064c
ED		 2042 break;\r
2043\r
2044 case CfRepaint:\r
2045 ControlFlag = CfRefreshHighLight;\r
2046\r
2047 if (Repaint) {\r
2048 //\r
2049 // Display menu\r
2050 //\r
2051 DownArrow = FALSE;\r
2052 UpArrow = FALSE;\r
2053 Row = TopRow;\r
2054\r
af047db7
ED		 2055 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
2056 \r
7c6c064c 2057 //\r
af047db7 2058 // 1. Check whether need to print the arrow up.\r
7c6c064c 2059 //\r
af047db7
ED		 2060 if (!ValueIsScroll (TRUE, TopOfScreen)) {\r
2061 UpArrow = TRUE;\r
2062 }\r
af047db7 2063\r
ae4f5746
ED		 2064 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
2065 PrintStringAtWithWidth(gStatementDimensions.LeftColumn + gModalSkipColumn, TopRow - 1, L"", gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn - 2 * gModalSkipColumn);\r
2066 } else {\r
2067 PrintStringAtWithWidth(gStatementDimensions.LeftColumn, TopRow - 1, L"", gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn);\r
2068 }\r
af047db7
ED		 2069 if (UpArrow) {\r
2070 gST->ConOut->SetAttribute (gST->ConOut, GetArrowColor ());\r
2071 PrintCharAt (\r
2072 gStatementDimensions.LeftColumn + gPromptBlockWidth + gOptionBlockWidth + 1,\r
7c6c064c 2073 TopRow - SCROLL_ARROW_HEIGHT,\r
af047db7 2074 ARROW_UP\r
7c6c064c 2075 );\r
af047db7 2076 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
7c6c064c
ED		 2077 }\r
2078\r
2079 //\r
2080 // 2.Paint the menu.\r
2081 //\r
2082 for (Link = TopOfScreen; Link != &gMenuOption; Link = Link->ForwardLink) {\r
2083 MenuOption = MENU_OPTION_FROM_LINK (Link);\r
2084 MenuOption->Row = Row;\r
2085 MenuOption->Col = Col;\r
2086 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
af047db7 2087 MenuOption->OptCol = gStatementDimensions.LeftColumn + LEFT_SKIPPED_COLUMNS + gPromptBlockWidth + gModalSkipColumn;\r
7c6c064c 2088 } else {\r
af047db7 2089 MenuOption->OptCol = gStatementDimensions.LeftColumn + LEFT_SKIPPED_COLUMNS + gPromptBlockWidth;\r
7c6c064c
ED		 2090 }\r
2091\r
7c6c064c
ED		 2092 if (MenuOption->NestInStatement) {\r
2093 MenuOption->Col += SUBTITLE_INDENT;\r
2094 }\r
2095\r
7c6c064c 2096 //\r
af047db7 2097 // Save the highlight menu, will be used in CfRefreshHighLight case.\r
7c6c064c 2098 //\r
af047db7
ED		 2099 if (Link == NewPos) {\r
2100 SavedMenuOption = MenuOption;\r
2101 SkipHighLight = TRUE;\r
7c6c064c 2102 }\r
ae4f5746
ED		 2103\r
2104 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
72f2eca2 2105 Status = DisplayOneMenu (MenuOption, \r
6f05c023 2106 MenuOption->Col - gStatementDimensions.LeftColumn,\r
ae4f5746
ED		 2107 gStatementDimensions.LeftColumn + gModalSkipColumn, \r
2108 Link == TopOfScreen ? SkipValue : 0, \r
2109 BottomRow,\r
571c73b5 2110 (BOOLEAN) ((Link == NewPos) && IsSelectable(MenuOption))\r
ae4f5746
ED		 2111 );\r
2112 } else {\r
72f2eca2 2113 Status = DisplayOneMenu (MenuOption, \r
6f05c023 2114 MenuOption->Col - gStatementDimensions.LeftColumn,\r
ae4f5746
ED		 2115 gStatementDimensions.LeftColumn, \r
2116 Link == TopOfScreen ? SkipValue : 0, \r
2117 BottomRow,\r
571c73b5 2118 (BOOLEAN) ((Link == NewPos) && IsSelectable(MenuOption))\r
ae4f5746
ED		 2119 ); \r
2120 }\r
7c6c064c 2121\r
72f2eca2
ED		 2122 if (EFI_ERROR (Status)) {\r
2123 return Status;\r
2124 }\r
7c6c064c
ED		 2125 //\r
2126 // 3. Update the row info which will be used by next menu.\r
2127 //\r
2128 if (Link == TopOfScreen) {\r
2129 Row += MenuOption->Skip - SkipValue;\r
2130 } else {\r
2131 Row += MenuOption->Skip;\r
2132 }\r
2133\r
2134 if (Row > BottomRow) {\r
2135 if (!ValueIsScroll (FALSE, Link)) {\r
2136 DownArrow = TRUE;\r
2137 }\r
2138\r
2139 Row = BottomRow + 1;\r
2140 break;\r
2141 }\r
2142 }\r
2143\r
af047db7
ED		 2144 //\r
2145 // 3. Menus in this form may not cover all form, clean the remain field.\r
2146 //\r
2147 while (Row <= BottomRow) {\r
2148 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
ae4f5746 2149 PrintStringAtWithWidth(gStatementDimensions.LeftColumn + gModalSkipColumn, Row++, L"", gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn - 2 * gModalSkipColumn);\r
af047db7
ED		 2150 } else {\r
2151 PrintStringAtWithWidth(gStatementDimensions.LeftColumn, Row++, L"", gStatementDimensions.RightColumn - gHelpBlockWidth - gStatementDimensions.LeftColumn);\r
2152 }\r
7c6c064c
ED		 2153 }\r
2154\r
af047db7
ED		 2155 //\r
2156 // 4. Print the down arrow row.\r
2157 //\r
ae4f5746
ED		 2158 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
2159 PrintStringAtWithWidth(gStatementDimensions.LeftColumn + gModalSkipColumn, BottomRow + 1, L"", gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn - 2 * + gModalSkipColumn);\r
2160 } else {\r
2161 PrintStringAtWithWidth(gStatementDimensions.LeftColumn, BottomRow + 1, L"", gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn);\r
2162 }\r
7c6c064c
ED		 2163 if (DownArrow) {\r
2164 gST->ConOut->SetAttribute (gST->ConOut, GetArrowColor ());\r
2165 PrintCharAt (\r
2166 gStatementDimensions.LeftColumn + gPromptBlockWidth + gOptionBlockWidth + 1,\r
2167 BottomRow + SCROLL_ARROW_HEIGHT,\r
2168 ARROW_DOWN\r
2169 );\r
2170 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
2171 }\r
2172\r
2173 MenuOption = NULL;\r
2174 }\r
2175 break;\r
2176\r
2177 case CfRefreshHighLight:\r
2178\r
2179 //\r
2180 // MenuOption: Last menu option that need to remove hilight\r
2181 // MenuOption is set to NULL in Repaint\r
2182 // NewPos: Current menu option that need to hilight\r
2183 //\r
2184 ControlFlag = CfUpdateHelpString;\r
2185\r
af047db7
ED		 2186 if (SkipHighLight) {\r
2187 MenuOption = SavedMenuOption;\r
2188 SkipHighLight = FALSE;\r
2189 UpdateHighlightMenuInfo (MenuOption);\r
2190 break;\r
2191 }\r
2192\r
8924aecd
ED		 2193 if (IsListEmpty (&gMenuOption)) {\r
2194 //\r
2195 // No menu option, just update the hotkey filed.\r
2196 //\r
2197 RefreshKeyHelp(gFormData, NULL, FALSE);\r
2198 break;\r
2199 }\r
2200\r
7c6c064c
ED		 2201 if (MenuOption != NULL && TopOfScreen == &MenuOption->Link) {\r
2202 Temp = SkipValue;\r
2203 } else {\r
2204 Temp = 0;\r
2205 }\r
2206 if (NewPos == TopOfScreen) {\r
2207 Temp2 = SkipValue;\r
2208 } else {\r
2209 Temp2 = 0;\r
2210 }\r
2211\r
2212 if (NewPos != NULL && (MenuOption == NULL || NewPos != &MenuOption->Link)) {\r
2213 if (MenuOption != NULL) {\r
2214 //\r
2215 // Remove highlight on last Menu Option\r
2216 //\r
2217 gST->ConOut->SetCursorPosition (gST->ConOut, MenuOption->Col, MenuOption->Row);\r
2218 ProcessOptions (MenuOption, FALSE, &OptionString, TRUE);\r
2219 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
2220 if (OptionString != NULL) {\r
2221 if ((MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_DATE_OP) ||\r
2222 (MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TIME_OP)\r
2223 ) {\r
2224 ProcessStringForDateTime(MenuOption, OptionString, FALSE);\r
2225 }\r
2226\r
6f05c023 2227 Width = (UINT16) gOptionBlockWidth - 1;\r
7c6c064c
ED		 2228 OriginalRow = MenuOption->Row;\r
2229 GlyphWidth = 1;\r
2230\r
2231 for (Index = 0; GetLineByWidth (OptionString, Width, &GlyphWidth, &Index, &OutputString) != 0x0000;) {\r
2232 if ((Temp == 0) && (MenuOption->Row >= TopRow) && (MenuOption->Row <= BottomRow)) {\r
2233 PrintStringAt (MenuOption->OptCol, MenuOption->Row, OutputString);\r
2234 }\r
2235 //\r
2236 // If there is more string to process print on the next row and increment the Skip value\r
2237 //\r
2238 if (StrLen (&OptionString[Index]) != 0) {\r
2239 if (Temp == 0) {\r
2240 MenuOption->Row++;\r
2241 }\r
2242 }\r
2243\r
2244 FreePool (OutputString);\r
2245 if (Temp != 0) {\r
2246 Temp--;\r
2247 }\r
2248 }\r
2249\r
2250 MenuOption->Row = OriginalRow;\r
2251\r
2252 FreePool (OptionString);\r
2253 } else {\r
2254 if (NewLine) {\r
2255 if (MenuOption->GrayOut) {\r
2256 gST->ConOut->SetAttribute (gST->ConOut, GetGrayedTextColor ());\r
2257 } else if (MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_SUBTITLE_OP) {\r
2258 gST->ConOut->SetAttribute (gST->ConOut, GetSubTitleTextColor ());\r
2259 }\r
2260\r
2261 OriginalRow = MenuOption->Row;\r
6f05c023 2262 Width = GetWidth (MenuOption, NULL);\r
7c6c064c
ED		 2263 GlyphWidth = 1;\r
2264\r
2265 for (Index = 0; GetLineByWidth (MenuOption->Description, Width, &GlyphWidth, &Index, &OutputString) != 0x0000;) {\r
2266 if ((Temp == 0) && (MenuOption->Row >= TopRow) && (MenuOption->Row <= BottomRow)) {\r
2267 PrintStringAt (MenuOption->Col, MenuOption->Row, OutputString);\r
2268 }\r
2269 //\r
2270 // If there is more string to process print on the next row and increment the Skip value\r
2271 //\r
2272 if (StrLen (&MenuOption->Description[Index]) != 0) {\r
2273 if (Temp == 0) {\r
2274 MenuOption->Row++;\r
2275 }\r
2276 }\r
2277\r
2278 FreePool (OutputString);\r
2279 if (Temp != 0) {\r
2280 Temp--;\r
2281 }\r
2282 }\r
2283\r
2284 MenuOption->Row = OriginalRow;\r
2285 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
2286 }\r
2287 }\r
2288 }\r
2289\r
2290 //\r
2291 // This is the current selected statement\r
2292 //\r
2293 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
2294 Statement = MenuOption->ThisTag;\r
2295\r
af047db7 2296 UpdateHighlightMenuInfo (MenuOption);\r
7c6c064c
ED		 2297\r
2298 if (!IsSelectable (MenuOption)) {\r
7c6c064c
ED		 2299 break;\r
2300 }\r
2301\r
2302 //\r
2303 // Set reverse attribute\r
2304 //\r
2305 gST->ConOut->SetAttribute (gST->ConOut, GetHighlightTextColor ());\r
2306 gST->ConOut->SetCursorPosition (gST->ConOut, MenuOption->Col, MenuOption->Row);\r
2307\r
2308 ProcessOptions (MenuOption, FALSE, &OptionString, TRUE);\r
2309 if (OptionString != NULL) {\r
2310 if (Statement->OpCode->OpCode == EFI_IFR_DATE_OP || Statement->OpCode->OpCode == EFI_IFR_TIME_OP) {\r
2311 ProcessStringForDateTime(MenuOption, OptionString, FALSE);\r
2312 }\r
6f05c023 2313 Width = (UINT16) gOptionBlockWidth - 1;\r
7c6c064c
ED		 2314\r
2315 OriginalRow = MenuOption->Row;\r
2316 GlyphWidth = 1;\r
2317\r
2318 for (Index = 0; GetLineByWidth (OptionString, Width, &GlyphWidth, &Index, &OutputString) != 0x0000;) {\r
2319 if ((Temp2 == 0) && (MenuOption->Row >= TopRow) && (MenuOption->Row <= BottomRow) ) {\r
2320 PrintStringAt (MenuOption->OptCol, MenuOption->Row, OutputString);\r
2321 }\r
2322 //\r
2323 // If there is more string to process print on the next row and increment the Skip value\r
2324 //\r
2325 if (StrLen (&OptionString[Index]) != 0) {\r
2326 if (Temp2 == 0) {\r
2327 MenuOption->Row++;\r
2328 }\r
2329 }\r
2330\r
2331 FreePool (OutputString);\r
2332 if (Temp2 != 0) {\r
2333 Temp2--;\r
2334 }\r
2335 }\r
2336\r
2337 MenuOption->Row = OriginalRow;\r
2338\r
2339 FreePool (OptionString);\r
2340 } else {\r
2341 if (NewLine) {\r
2342 OriginalRow = MenuOption->Row;\r
2343\r
6f05c023 2344 Width = GetWidth (MenuOption, NULL);\r
7c6c064c
ED		 2345 GlyphWidth = 1;\r
2346\r
2347 for (Index = 0; GetLineByWidth (MenuOption->Description, Width, &GlyphWidth, &Index, &OutputString) != 0x0000;) {\r
2348 if ((Temp2 == 0) && (MenuOption->Row >= TopRow) && (MenuOption->Row <= BottomRow) ) {\r
2349 PrintStringAt (MenuOption->Col, MenuOption->Row, OutputString);\r
2350 }\r
2351 //\r
2352 // If there is more string to process print on the next row and increment the Skip value\r
2353 //\r
2354 if (StrLen (&MenuOption->Description[Index]) != 0) {\r
2355 if (Temp2 == 0) {\r
2356 MenuOption->Row++;\r
2357 }\r
2358 }\r
2359\r
2360 FreePool (OutputString);\r
2361 if (Temp2 != 0) {\r
2362 Temp2--;\r
2363 }\r
2364 }\r
2365\r
2366 MenuOption->Row = OriginalRow;\r
2367\r
2368 }\r
2369 }\r
2370\r
7c6c064c
ED		 2371 //\r
2372 // Clear reverse attribute\r
2373 //\r
2374 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
2375 }\r
2376 break;\r
2377\r
2378 case CfUpdateHelpString:\r
2379 ControlFlag = CfPrepareToReadKey;\r
2380 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
2381 break;\r
2382 }\r
2383\r
2384 if (Repaint || NewLine) {\r
8924aecd
ED		 2385 if (IsListEmpty (&gMenuOption)) {\r
2386 //\r
2387 // Don't print anything if no mwnu option.\r
2388 //\r
7c6c064c
ED		 2389 StringPtr = GetToken (STRING_TOKEN (EMPTY_STRING), gHiiHandle);\r
2390 } else {\r
8924aecd
ED		 2391 //\r
2392 // Don't print anything if it is a NULL help token\r
2393 //\r
2394 ASSERT(MenuOption != NULL);\r
2395 HelpInfo = ((EFI_IFR_STATEMENT_HEADER *) ((CHAR8 *)MenuOption->ThisTag->OpCode + sizeof (EFI_IFR_OP_HEADER)))->Help;\r
2396 if (HelpInfo == 0 || !IsSelectable (MenuOption)) {\r
2397 StringPtr = GetToken (STRING_TOKEN (EMPTY_STRING), gHiiHandle);\r
2398 } else {\r
2399 StringPtr = GetToken (HelpInfo, gFormData->HiiHandle);\r
2400 }\r
7c6c064c
ED		 2401 }\r
2402\r
2403 RowCount = BottomRow - TopRow + 1;\r
2404 HelpPageIndex = 0;\r
2405 //\r
2406 // 1.Calculate how many line the help string need to print.\r
2407 //\r
2408 if (HelpString != NULL) {\r
2409 FreePool (HelpString);\r
2410 HelpString = NULL;\r
2411 }\r
2412 HelpLine = ProcessHelpString (StringPtr, &HelpString, &EachLineWidth, RowCount);\r
2413 FreePool (StringPtr);\r
2414\r
2415 if (HelpLine > RowCount) {\r
2416 MultiHelpPage = TRUE;\r
2417 StringPtr = GetToken (STRING_TOKEN(ADJUST_HELP_PAGE_UP), gHiiHandle);\r
2418 if (HelpHeaderString != NULL) {\r
2419 FreePool (HelpHeaderString);\r
2420 HelpHeaderString = NULL;\r
2421 }\r
2422 HelpHeaderLine = ProcessHelpString (StringPtr, &HelpHeaderString, &HeaderLineWidth, 0);\r
2423 FreePool (StringPtr);\r
2424 StringPtr = GetToken (STRING_TOKEN(ADJUST_HELP_PAGE_DOWN), gHiiHandle);\r
2425 if (HelpBottomString != NULL) {\r
2426 FreePool (HelpBottomString);\r
2427 HelpBottomString = NULL;\r
2428 }\r
2429 HelpBottomLine = ProcessHelpString (StringPtr, &HelpBottomString, &BottomLineWidth, 0);\r
2430 FreePool (StringPtr);\r
2431 //\r
2432 // Calculate the help page count.\r
2433 //\r
2434 if (HelpLine > 2 * RowCount - 2) {\r
2435 HelpPageCount = (HelpLine - RowCount + 1) / (RowCount - 2) + 1;\r
2436 if ((HelpLine - RowCount + 1) % (RowCount - 2) > 1) {\r
2437 HelpPageCount += 1;\r
2438 }\r
2439 } else {\r
2440 HelpPageCount = 2;\r
2441 }\r
2442 } else {\r
2443 MultiHelpPage = FALSE;\r
2444 }\r
2445 }\r
2446\r
2447 //\r
2448 // Check whether need to show the 'More(U/u)' at the begin.\r
2449 // Base on current direct info, here shows aligned to the right side of the column.\r
2450 // If the direction is multi line and aligned to right side may have problem, so \r
2451 // add ASSERT code here.\r
2452 //\r
2453 if (HelpPageIndex > 0) {\r
2454 gST->ConOut->SetAttribute (gST->ConOut, GetInfoTextColor ());\r
2455 for (Index = 0; Index < HelpHeaderLine; Index++) {\r
2456 ASSERT (HelpHeaderLine == 1);\r
2457 ASSERT (GetStringWidth (HelpHeaderString) / 2 < (UINTN) (gHelpBlockWidth - 1));\r
2458 PrintStringAtWithWidth (\r
2459 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2460 Index + TopRow,\r
2461 gEmptyString,\r
2462 gHelpBlockWidth\r
2463 );\r
2464 PrintStringAt (\r
2465 gStatementDimensions.RightColumn - GetStringWidth (HelpHeaderString) / 2 - 1,\r
2466 Index + TopRow,\r
2467 &HelpHeaderString[Index * HeaderLineWidth]\r
2468 );\r
2469 }\r
2470 }\r
2471\r
2472 gST->ConOut->SetAttribute (gST->ConOut, GetHelpTextColor ());\r
2473 //\r
2474 // Print the help string info.\r
2475 //\r
2476 if (!MultiHelpPage) {\r
2477 for (Index = 0; Index < HelpLine; Index++) {\r
2478 PrintStringAtWithWidth (\r
2479 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2480 Index + TopRow,\r
2481 &HelpString[Index * EachLineWidth],\r
2482 gHelpBlockWidth\r
2483 );\r
2484 }\r
2485 for (; Index < RowCount; Index ++) {\r
2486 PrintStringAtWithWidth (\r
2487 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2488 Index + TopRow,\r
2489 gEmptyString,\r
2490 gHelpBlockWidth\r
2491 );\r
2492 }\r
2493 gST->ConOut->SetCursorPosition(gST->ConOut, gStatementDimensions.RightColumn-1, BottomRow);\r
2494 } else {\r
2495 if (HelpPageIndex == 0) {\r
2496 for (Index = 0; Index < RowCount - HelpBottomLine; Index++) {\r
2497 PrintStringAtWithWidth (\r
2498 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2499 Index + TopRow,\r
2500 &HelpString[Index * EachLineWidth],\r
2501 gHelpBlockWidth\r
2502 );\r
2503 }\r
2504 } else {\r
2505 for (Index = 0; (Index < RowCount - HelpBottomLine - HelpHeaderLine) && \r
2506 (Index + HelpPageIndex * (RowCount - 2) + 1 < HelpLine); Index++) {\r
2507 PrintStringAtWithWidth (\r
2508 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2509 Index + TopRow + HelpHeaderLine,\r
2510 &HelpString[(Index + HelpPageIndex * (RowCount - 2) + 1)* EachLineWidth],\r
2511 gHelpBlockWidth\r
2512 );\r
2513 }\r
2514 if (HelpPageIndex == HelpPageCount - 1) {\r
2515 for (; Index < RowCount - HelpHeaderLine; Index ++) {\r
2516 PrintStringAtWithWidth (\r
2517 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2518 Index + TopRow + HelpHeaderLine,\r
2519 gEmptyString,\r
2520 gHelpBlockWidth\r
2521 );\r
2522 }\r
2523 gST->ConOut->SetCursorPosition(gST->ConOut, gStatementDimensions.RightColumn-1, BottomRow);\r
2524 }\r
2525 } \r
2526 }\r
2527\r
2528 //\r
2529 // Check whether need to print the 'More(D/d)' at the bottom.\r
2530 // Base on current direct info, here shows aligned to the right side of the column.\r
2531 // If the direction is multi line and aligned to right side may have problem, so \r
2532 // add ASSERT code here.\r
2533 //\r
2534 if (HelpPageIndex < HelpPageCount - 1 && MultiHelpPage) {\r
2535 gST->ConOut->SetAttribute (gST->ConOut, GetInfoTextColor ());\r
2536 for (Index = 0; Index < HelpBottomLine; Index++) {\r
2537 ASSERT (HelpBottomLine == 1);\r
2538 ASSERT (GetStringWidth (HelpBottomString) / 2 < (UINTN) (gHelpBlockWidth - 1)); \r
2539 PrintStringAtWithWidth (\r
2540 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2541 BottomRow + Index - HelpBottomLine + 1,\r
2542 gEmptyString,\r
2543 gHelpBlockWidth\r
2544 );\r
2545 PrintStringAt (\r
2546 gStatementDimensions.RightColumn - GetStringWidth (HelpBottomString) / 2 - 1,\r
2547 BottomRow + Index - HelpBottomLine + 1,\r
2548 &HelpBottomString[Index * BottomLineWidth]\r
2549 );\r
2550 }\r
2551 }\r
2552 //\r
2553 // Reset this flag every time we finish using it.\r
2554 //\r
2555 Repaint = FALSE;\r
2556 NewLine = FALSE;\r
2557 break;\r
2558\r
2559 case CfPrepareToReadKey:\r
2560 ControlFlag = CfReadKey;\r
2561 ScreenOperation = UiNoOperation;\r
2562 break;\r
2563\r
2564 case CfReadKey:\r
2565 ControlFlag = CfScreenOperation;\r
2566\r
2567 //\r
2568 // Wait for user's selection\r
2569 //\r
2570 while (TRUE) {\r
2571 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
2572 if (!EFI_ERROR (Status)) {\r
2573 EventType = UIEventKey;\r
2574 break;\r
2575 }\r
2576\r
2577 //\r
2578 // If we encounter error, continue to read another key in.\r
2579 //\r
2580 if (Status != EFI_NOT_READY) {\r
2581 continue;\r
2582 }\r
2583 \r
2584 EventType = UiWaitForEvent(gST->ConIn->WaitForKey);\r
2585 if (EventType == UIEventKey) {\r
2586 gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
2587 }\r
2588 break;\r
2589 }\r
2590\r
2591 if (EventType == UIEventDriver) {\r
2592 gUserInput->Action = BROWSER_ACTION_NONE;\r
2593 ControlFlag = CfExit;\r
2594 break;\r
2595 }\r
2596 \r
2597 if (EventType == UIEventTimeOut) {\r
2598 gUserInput->Action = BROWSER_ACTION_FORM_EXIT;\r
2599 ControlFlag = CfExit;\r
2600 break;\r
2601 }\r
2602\r
2603 switch (Key.UnicodeChar) {\r
2604 case CHAR_CARRIAGE_RETURN:\r
2605 if(MenuOption == NULL || MenuOption->GrayOut || MenuOption->ReadOnly) {\r
2606 ControlFlag = CfReadKey;\r
2607 break;\r
2608 }\r
2609\r
2610 ScreenOperation = UiSelect;\r
2611 gDirection = 0;\r
2612 break;\r
2613\r
2614 //\r
2615 // We will push the adjustment of these numeric values directly to the input handler\r
2616 // NOTE: we won't handle manual input numeric\r
2617 //\r
2618 case '+':\r
2619 case '-':\r
2620 //\r
2621 // If the screen has no menu items, and the user didn't select UiReset\r
2622 // ignore the selection and go back to reading keys.\r
2623 //\r
2624 if(IsListEmpty (&gMenuOption) || MenuOption->GrayOut || MenuOption->ReadOnly) {\r
2625 ControlFlag = CfReadKey;\r
2626 break;\r
2627 }\r
2628\r
2629 ASSERT(MenuOption != NULL);\r
2630 Statement = MenuOption->ThisTag;\r
2631 if ((Statement->OpCode->OpCode == EFI_IFR_DATE_OP)\r
2632 || (Statement->OpCode->OpCode == EFI_IFR_TIME_OP)\r
2633 || ((Statement->OpCode->OpCode == EFI_IFR_NUMERIC_OP) && (GetFieldFromNum(Statement->OpCode) != 0))\r
2634 ){\r
2635 if (Key.UnicodeChar == '+') {\r
2636 gDirection = SCAN_RIGHT;\r
2637 } else {\r
2638 gDirection = SCAN_LEFT;\r
2639 }\r
2640 \r
2641 Status = ProcessOptions (MenuOption, TRUE, &OptionString, TRUE);\r
2642 if (OptionString != NULL) {\r
2643 FreePool (OptionString);\r
2644 }\r
2645 if (EFI_ERROR (Status)) {\r
2646 //\r
2647 // Repaint to clear possible error prompt pop-up\r
2648 //\r
2649 Repaint = TRUE;\r
2650 NewLine = TRUE;\r
2651 } else {\r
2652 ControlFlag = CfExit;\r
2653 }\r
2654 }\r
2655 break;\r
2656\r
2657 case '^':\r
2658 ScreenOperation = UiUp;\r
2659 break;\r
2660\r
2661 case 'V':\r
2662 case 'v':\r
2663 ScreenOperation = UiDown;\r
2664 break;\r
2665\r
2666 case ' ':\r
2667 if(IsListEmpty (&gMenuOption)) {\r
2668 ControlFlag = CfReadKey;\r
2669 break;\r
2670 }\r
2671 \r
2672 ASSERT(MenuOption != NULL);\r
2673 if (MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_CHECKBOX_OP && !MenuOption->GrayOut && !MenuOption->ReadOnly) {\r
2674 ScreenOperation = UiSelect;\r
2675 }\r
2676 break;\r
2677\r
2678 case 'D':\r
2679 case 'd':\r
2680 if (!MultiHelpPage) {\r
2681 ControlFlag = CfReadKey;\r
2682 break;\r
2683 }\r
2684 ControlFlag = CfUpdateHelpString;\r
2685 HelpPageIndex = HelpPageIndex < HelpPageCount - 1 ? HelpPageIndex + 1 : HelpPageCount - 1;\r
2686 break;\r
2687\r
2688 case 'U':\r
2689 case 'u':\r
2690 if (!MultiHelpPage) {\r
2691 ControlFlag = CfReadKey;\r
2692 break;\r
2693 }\r
2694 ControlFlag = CfUpdateHelpString;\r
2695 HelpPageIndex = HelpPageIndex > 0 ? HelpPageIndex - 1 : 0;\r
2696 break;\r
2697\r
2698 case CHAR_NULL:\r
2699 for (Index = 0; Index < mScanCodeNumber; Index++) {\r
2700 if (Key.ScanCode == gScanCodeToOperation[Index].ScanCode) {\r
2701 ScreenOperation = gScanCodeToOperation[Index].ScreenOperation;\r
2702 break;\r
2703 }\r
2704 }\r
2705 \r
2706 if (((FormData->Attribute & HII_DISPLAY_MODAL) != 0) && (Key.ScanCode == SCAN_ESC || Index == mScanCodeNumber)) {\r
2707 //\r
2708 // ModalForm has no ESC key and Hot Key.\r
2709 //\r
2710 ControlFlag = CfReadKey;\r
2711 } else if (Index == mScanCodeNumber) {\r
2712 //\r
2713 // Check whether Key matches the registered hot key.\r
2714 //\r
2715 HotKey = NULL;\r
2716 HotKey = GetHotKeyFromRegisterList (&Key);\r
2717 if (HotKey != NULL) {\r
2718 ScreenOperation = UiHotKey;\r
2719 }\r
2720 }\r
2721 break;\r
2722 }\r
2723 break;\r
2724\r
2725 case CfScreenOperation:\r
8924aecd 2726 if ((ScreenOperation != UiReset) && (ScreenOperation != UiHotKey)) {\r
7c6c064c 2727 //\r
8924aecd 2728 // If the screen has no menu items, and the user didn't select UiReset or UiHotKey\r
7c6c064c
ED		 2729 // ignore the selection and go back to reading keys.\r
2730 //\r
2731 if (IsListEmpty (&gMenuOption)) {\r
2732 ControlFlag = CfReadKey;\r
2733 break;\r
2734 }\r
2735 }\r
2736\r
2737 for (Index = 0;\r
2738 Index < sizeof (gScreenOperationToControlFlag) / sizeof (gScreenOperationToControlFlag[0]);\r
2739 Index++\r
2740 ) {\r
2741 if (ScreenOperation == gScreenOperationToControlFlag[Index].ScreenOperation) {\r
2742 ControlFlag = gScreenOperationToControlFlag[Index].ControlFlag;\r
2743 break;\r
2744 }\r
2745 }\r
2746 break;\r
2747\r
2748 case CfUiSelect:\r
2749 ControlFlag = CfRepaint;\r
2750\r
2751 ASSERT(MenuOption != NULL);\r
2752 Statement = MenuOption->ThisTag;\r
2753 if (Statement->OpCode->OpCode == EFI_IFR_TEXT_OP) {\r
2754 break;\r
2755 }\r
2756\r
2757 switch (Statement->OpCode->OpCode) {\r
2758 case EFI_IFR_REF_OP:\r
2759 case EFI_IFR_ACTION_OP:\r
2760 case EFI_IFR_RESET_BUTTON_OP:\r
2761 ControlFlag = CfExit;\r
2762 break;\r
2763\r
2764 default:\r
2765 //\r
2766 // Editable Questions: oneof, ordered list, checkbox, numeric, string, password\r
2767 //\r
2768 RefreshKeyHelp (gFormData, Statement, TRUE);\r
2769 Status = ProcessOptions (MenuOption, TRUE, &OptionString, TRUE);\r
2770 \r
2771 if (OptionString != NULL) {\r
2772 FreePool (OptionString);\r
2773 }\r
2774 \r
2775 if (EFI_ERROR (Status)) {\r
2776 Repaint = TRUE;\r
2777 NewLine = TRUE;\r
2778 RefreshKeyHelp (gFormData, Statement, FALSE);\r
2779 break;\r
2780 } else {\r
2781 ControlFlag = CfExit;\r
2782 break;\r
2783 }\r
2784 }\r
2785 break;\r
2786\r
2787 case CfUiReset:\r
2788 //\r
2789 // We come here when someone press ESC\r
2790 // If the policy is not exit front page when user press ESC, process here.\r
2791 //\r
2792 if (!FormExitPolicy()) {\r
2793 Repaint = TRUE;\r
2794 NewLine = TRUE;\r
2795 ControlFlag = CfRepaint;\r
2796 break;\r
2797 }\r
2798\r
2799 //\r
2800 // When user press ESC, it will try to show another menu, should clean the gSequence info.\r
2801 //\r
2802 if (gSequence != 0) {\r
2803 gSequence = 0;\r
2804 }\r
2805\r
2806 gUserInput->Action = BROWSER_ACTION_FORM_EXIT;\r
2807 ControlFlag = CfExit;\r
2808 break;\r
2809\r
2810 case CfUiHotKey:\r
2811 ControlFlag = CfRepaint;\r
2812 \r
2813 gUserInput->Action = HotKey->Action;\r
2814 ControlFlag = CfExit;\r
2815 break;\r
2816\r
2817 case CfUiLeft:\r
2818 ControlFlag = CfRepaint;\r
2819 ASSERT(MenuOption != NULL);\r
2820 if ((MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_DATE_OP) || (MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TIME_OP)) {\r
2821 if (MenuOption->Sequence != 0) {\r
2822 //\r
2823 // In the middle or tail of the Date/Time op-code set, go left.\r
2824 //\r
2825 ASSERT(NewPos != NULL);\r
2826 NewPos = NewPos->BackLink;\r
2827 }\r
2828 }\r
2829 break;\r
2830\r
2831 case CfUiRight:\r
2832 ControlFlag = CfRepaint;\r
2833 ASSERT(MenuOption != NULL);\r
2834 if ((MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_DATE_OP) || (MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TIME_OP)) {\r
2835 if (MenuOption->Sequence != 2) {\r
2836 //\r
2837 // In the middle or tail of the Date/Time op-code set, go left.\r
2838 //\r
2839 ASSERT(NewPos != NULL);\r
2840 NewPos = NewPos->ForwardLink;\r
2841 }\r
2842 }\r
2843 break;\r
2844\r
2845 case CfUiUp:\r
2846 ControlFlag = CfRepaint;\r
2847\r
2848 SavedListEntry = NewPos;\r
2849\r
2850 ASSERT(NewPos != NULL);\r
2851 //\r
2852 // Adjust Date/Time position before we advance forward.\r
2853 //\r
2854 AdjustDateAndTimePosition (TRUE, &NewPos);\r
2855 if (NewPos->BackLink != &gMenuOption) {\r
2856 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
2857 ASSERT (MenuOption != NULL);\r
2858 NewLine = TRUE;\r
2859 NewPos = NewPos->BackLink;\r
2860\r
2861 PreviousMenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
2862 if (PreviousMenuOption->Row == 0) {\r
2863 UpdateOptionSkipLines (PreviousMenuOption);\r
2864 }\r
2865 DistanceValue = PreviousMenuOption->Skip;\r
2866 Difference = 0;\r
2867 if (MenuOption->Row >= DistanceValue + TopRow) {\r
2868 Difference = MoveToNextStatement (TRUE, &NewPos, MenuOption->Row - TopRow - DistanceValue);\r
2869 }\r
2870 NextMenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
2871 \r
2872 if (Difference < 0) {\r
2873 //\r
2874 // We hit the begining MenuOption that can be focused\r
2875 // so we simply scroll to the top.\r
2876 //\r
2877 if (TopOfScreen != gMenuOption.ForwardLink) {\r
2878 TopOfScreen = gMenuOption.ForwardLink;\r
2879 Repaint = TRUE;\r
2880 } else {\r
2881 //\r
2882 // Scroll up to the last page when we have arrived at top page.\r
2883 //\r
2884 NewPos = &gMenuOption;\r
2885 TopOfScreen = &gMenuOption;\r
2886 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);\r
2887 ScreenOperation = UiPageUp;\r
2888 ControlFlag = CfScreenOperation;\r
2889 break;\r
2890 }\r
2891 } else if (MenuOption->Row < TopRow + DistanceValue + Difference) {\r
2892 //\r
2893 // Previous focus MenuOption is above the TopOfScreen, so we need to scroll\r
2894 //\r
2895 TopOfScreen = NewPos;\r
2896 Repaint = TRUE;\r
2897 SkipValue = 0;\r
2898 } else if (!IsSelectable (NextMenuOption)) {\r
2899 //\r
2900 // Continue to go up until scroll to next page or the selectable option is found.\r
2901 //\r
2902 ScreenOperation = UiUp;\r
2903 ControlFlag = CfScreenOperation;\r
2904 }\r
2905\r
2906 //\r
2907 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.\r
2908 //\r
2909 AdjustDateAndTimePosition (TRUE, &TopOfScreen);\r
2910 AdjustDateAndTimePosition (TRUE, &NewPos);\r
2911 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);\r
2912 UpdateStatusBar (INPUT_ERROR, FALSE);\r
2913 } else {\r
6f05c023
ED		 2914 if (NewPos->ForwardLink == &gMenuOption) {\r
2915 NewLine = FALSE;\r
2916 Repaint = FALSE;\r
2917 break;\r
2918 }\r
7c6c064c
ED		 2919 //\r
2920 // Scroll up to the last page.\r
2921 //\r
2922 NewPos = &gMenuOption;\r
2923 TopOfScreen = &gMenuOption;\r
2924 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);\r
2925 ScreenOperation = UiPageUp;\r
2926 ControlFlag = CfScreenOperation;\r
6f05c023 2927 SkipValue = 0;\r
7c6c064c
ED		 2928 }\r
2929 break;\r
2930\r
2931 case CfUiPageUp:\r
2932 //\r
2933 // SkipValue means lines is skipped when show the top menu option.\r
2934 //\r
2935 ControlFlag = CfRepaint;\r
2936\r
2937 ASSERT(NewPos != NULL);\r
2938 //\r
2939 // Already at the first menu option, Check the skip value.\r
2940 //\r
2941 if (NewPos->BackLink == &gMenuOption) {\r
2942 if (SkipValue == 0) {\r
2943 NewLine = FALSE;\r
2944 Repaint = FALSE;\r
2945 } else {\r
2946 NewLine = TRUE;\r
2947 Repaint = TRUE;\r
2948 SkipValue = 0;\r
2949 }\r
2950 break;\r
2951 }\r
2952\r
2953 NewLine = TRUE;\r
2954 Repaint = TRUE;\r
2955\r
2956 //\r
2957 // SkipValue > (BottomRow - TopRow + 1) means current menu has more than one\r
2958 // form of options to be show, so just update the SkipValue to show the next\r
2959 // parts of options.\r
2960 //\r
2961 if (SkipValue > (INTN) (BottomRow - TopRow + 1)) {\r
2962 SkipValue -= BottomRow - TopRow + 1;\r
2963 break;\r
2964 }\r
2965\r
2966 Link = TopOfScreen;\r
2967 //\r
2968 // First minus the menu of the top screen, it's value is SkipValue.\r
2969 //\r
2970 Index = (BottomRow + 1) - SkipValue;\r
2971 while ((Index > TopRow) && (Link->BackLink != &gMenuOption)) {\r
2972 Link = Link->BackLink;\r
2973 PreviousMenuOption = MENU_OPTION_FROM_LINK (Link);\r
2974 if (PreviousMenuOption->Row == 0) {\r
2975 UpdateOptionSkipLines (PreviousMenuOption);\r
2976 } \r
2977 if (Index < PreviousMenuOption->Skip) {\r
2978 break;\r
2979 }\r
2980 Index = Index - PreviousMenuOption->Skip;\r
2981 }\r
2982 \r
2983 if ((Link->BackLink == &gMenuOption) && (Index >= TopRow)) {\r
7c6c064c
ED		 2984 if (TopOfScreen == &gMenuOption) {\r
2985 TopOfScreen = gMenuOption.ForwardLink;\r
2986 NewPos = gMenuOption.BackLink;\r
2987 MoveToNextStatement (TRUE, &NewPos, BottomRow - TopRow);\r
6f05c023
ED		 2988 if (Index < PreviousMenuOption->Skip) {\r
2989 Repaint = TRUE;\r
2990 SkipValue = PreviousMenuOption->Skip - (Index - TopRow);\r
2991 } else {\r
2992 Repaint = FALSE;\r
2993 SkipValue = 0;\r
2994 }\r
7c6c064c
ED		 2995 } else if (TopOfScreen != Link) {\r
2996 TopOfScreen = Link;\r
2997 NewPos = Link;\r
2998 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);\r
6f05c023 2999 SkipValue = 0;\r
7c6c064c
ED		 3000 } else {\r
3001 //\r
3002 // Finally we know that NewPos is the last MenuOption can be focused.\r
3003 //\r
6f05c023
ED		 3004 if (SkipValue == 0) {\r
3005 Repaint = FALSE;\r
3006 }\r
7c6c064c
ED		 3007 NewPos = Link;\r
3008 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);\r
6f05c023 3009 SkipValue = 0;\r
7c6c064c
ED		 3010 }\r
3011 } else {\r
3012 if (Index > TopRow) {\r
3013 //\r
3014 // At here, only case "Index < PreviousMenuOption->Skip" can reach here.\r
3015 //\r
3016 SkipValue = PreviousMenuOption->Skip - (Index - TopRow);\r
3017 } else if (Index == TopRow) {\r
3018 SkipValue = 0;\r
3019 } else {\r
3020 SkipValue = TopRow - Index;\r
3021 }\r
3022\r
3023 //\r
3024 // Move to the option in Next page.\r
3025 //\r
3026 if (TopOfScreen == &gMenuOption) {\r
3027 NewPos = gMenuOption.BackLink;\r
3028 MoveToNextStatement (TRUE, &NewPos, BottomRow - TopRow);\r
3029 } else {\r
3030 NewPos = Link;\r
3031 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);\r
3032 }\r
3033\r
3034 //\r
3035 // There are more MenuOption needing scrolling up.\r
3036 //\r
3037 TopOfScreen = Link;\r
3038 MenuOption = NULL;\r
3039 }\r
3040\r
3041 //\r
3042 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.\r
3043 // Don't do this when we are already in the first page.\r
3044 //\r
3045 AdjustDateAndTimePosition (TRUE, &TopOfScreen);\r
3046 AdjustDateAndTimePosition (TRUE, &NewPos);\r
3047 break;\r
3048\r
3049 case CfUiPageDown:\r
3050 //\r
3051 // SkipValue means lines is skipped when show the top menu option.\r
3052 //\r
3053 ControlFlag = CfRepaint;\r
3054\r
3055 ASSERT (NewPos != NULL);\r
3056 if (NewPos->ForwardLink == &gMenuOption) {\r
6f05c023
ED		 3057 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
3058 if (SkipValue + BottomRow - TopRow + 1 < MenuOption->Skip) {\r
3059 SkipValue += BottomRow - TopRow + 1;\r
3060 NewLine = TRUE;\r
3061 Repaint = TRUE;\r
3062 break;\r
3063 }\r
7c6c064c
ED		 3064 NewLine = FALSE;\r
3065 Repaint = FALSE;\r
3066 break;\r
3067 }\r
3068\r
3069 NewLine = TRUE;\r
3070 Repaint = TRUE;\r
3071 Link = TopOfScreen;\r
3072 NextMenuOption = MENU_OPTION_FROM_LINK (Link);\r
3073 Index = TopRow + NextMenuOption->Skip - SkipValue;\r
3074 //\r
3075 // Count to the menu option which will show at the top of the next form.\r
3076 //\r
3077 while ((Index <= BottomRow + 1) && (Link->ForwardLink != &gMenuOption)) {\r
3078 Link = Link->ForwardLink;\r
3079 NextMenuOption = MENU_OPTION_FROM_LINK (Link);\r
3080 Index = Index + NextMenuOption->Skip;\r
3081 }\r
3082\r
3083 if ((Link->ForwardLink == &gMenuOption) && (Index <= BottomRow + 1)) {\r
3084 //\r
3085 // Finally we know that NewPos is the last MenuOption can be focused.\r
3086 //\r
3087 Repaint = FALSE;\r
3088 MoveToNextStatement (TRUE, &Link, Index - TopRow);\r
3089 } else {\r
3090 //\r
3091 // Calculate the skip line for top of screen menu.\r
3092 //\r
3093 if (Link == TopOfScreen) {\r
3094 //\r
3095 // The top of screen menu option occupies the entire form.\r
3096 //\r
3097 SkipValue += BottomRow - TopRow + 1;\r
3098 } else {\r
3099 SkipValue = NextMenuOption->Skip - (Index - (BottomRow + 1));\r
3100 }\r
3101\r
3102 TopOfScreen = Link;\r
3103 MenuOption = NULL;\r
3104 //\r
3105 // Move to the Next selectable menu.\r
3106 //\r
3107 MoveToNextStatement (FALSE, &Link, BottomRow - TopRow);\r
3108 }\r
3109\r
3110 //\r
3111 // Save the menu as the next highlight menu.\r
3112 //\r
3113 NewPos = Link;\r
3114\r
3115 //\r
3116 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.\r
3117 // Don't do this when we are already in the last page.\r
3118 //\r
3119 AdjustDateAndTimePosition (TRUE, &TopOfScreen);\r
3120 AdjustDateAndTimePosition (TRUE, &NewPos);\r
3121 break;\r
3122\r
3123 case CfUiDown:\r
3124 //\r
3125 // SkipValue means lines is skipped when show the top menu option.\r
3126 // NewPos points to the menu which is highlighted now.\r
3127 //\r
3128 ControlFlag = CfRepaint;\r
3129\r
3130 //\r
3131 // Since the behavior of hitting the down arrow on a Date/Time op-code is intended\r
3132 // to be one that progresses to the next set of op-codes, we need to advance to the last\r
3133 // Date/Time op-code and leave the remaining logic in UiDown intact so the appropriate\r
3134 // checking can be done. The only other logic we need to introduce is that if a Date/Time\r
3135 // op-code is the last entry in the menu, we need to rewind back to the first op-code of\r
3136 // the Date/Time op-code.\r
3137 //\r
3138 SavedListEntry = NewPos;\r
3139 AdjustDateAndTimePosition (FALSE, &NewPos);\r
3140\r
3141 if (NewPos->ForwardLink != &gMenuOption) {\r
6f05c023
ED		 3142 if (NewPos == TopOfScreen) {\r
3143 Temp2 = SkipValue;\r
3144 } else {\r
3145 Temp2 = 0;\r
3146 }\r
3147\r
7c6c064c
ED		 3148 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
3149 NewLine = TRUE;\r
3150 NewPos = NewPos->ForwardLink;\r
3151\r
3152 Difference = 0;\r
3153 //\r
3154 // Current menu not at the bottom of the form.\r
3155 //\r
6f05c023 3156 if (BottomRow >= MenuOption->Row + MenuOption->Skip - Temp2) {\r
7c6c064c
ED		 3157 //\r
3158 // Find the next selectable menu.\r
3159 //\r
6f05c023 3160 Difference = MoveToNextStatement (FALSE, &NewPos, BottomRow - MenuOption->Row - MenuOption->Skip + Temp2);\r
7c6c064c
ED		 3161 //\r
3162 // We hit the end of MenuOption that can be focused\r
3163 // so we simply scroll to the first page.\r
3164 //\r
3165 if (Difference < 0) {\r
3166 //\r
3167 // Scroll to the first page.\r
3168 //\r
3169 if (TopOfScreen != gMenuOption.ForwardLink) {\r
3170 TopOfScreen = gMenuOption.ForwardLink;\r
3171 Repaint = TRUE;\r
3172 MenuOption = NULL;\r
3173 } else {\r
3174 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);\r
3175 }\r
3176 NewPos = gMenuOption.ForwardLink;\r
3177 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);\r
3178\r
3179 SkipValue = 0;\r
3180 //\r
3181 // If we are at the end of the list and sitting on a Date/Time op, rewind to the head.\r
3182 //\r
3183 AdjustDateAndTimePosition (TRUE, &TopOfScreen);\r
3184 AdjustDateAndTimePosition (TRUE, &NewPos);\r
3185 break;\r
3186 }\r
3187 }\r
3188 NextMenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
3189 if (NextMenuOption->Row == 0) {\r
3190 UpdateOptionSkipLines (NextMenuOption);\r
3191 }\r
6f05c023 3192 DistanceValue = Difference + NextMenuOption->Skip - Temp2;\r
7c6c064c
ED		 3193\r
3194 Temp = MenuOption->Row + MenuOption->Skip + DistanceValue - 1;\r
6f05c023 3195 if ((MenuOption->Row + MenuOption->Skip - Temp2 == BottomRow + 1) &&\r
7c6c064c
ED		 3196 (NextMenuOption->ThisTag->OpCode->OpCode == EFI_IFR_DATE_OP ||\r
3197 NextMenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TIME_OP)\r
3198 ) {\r
3199 Temp ++;\r
3200 }\r
3201\r
3202 //\r
3203 // If we are going to scroll, update TopOfScreen\r
3204 //\r
3205 if (Temp > BottomRow) {\r
3206 do {\r
3207 //\r
3208 // Is the current top of screen a zero-advance op-code?\r
3209 // If so, keep moving forward till we hit a >0 advance op-code\r
3210 //\r
3211 SavedMenuOption = MENU_OPTION_FROM_LINK (TopOfScreen);\r
3212\r
3213 //\r
3214 // If bottom op-code is more than one line or top op-code is more than one line\r
3215 //\r
3216 if ((DistanceValue > 1) || (SavedMenuOption->Skip > 1)) {\r
3217 //\r
3218 // Is the bottom op-code greater than or equal in size to the top op-code?\r
3219 //\r
3220 if ((Temp - BottomRow) >= (SavedMenuOption->Skip - SkipValue)) {\r
3221 //\r
3222 // Skip the top op-code\r
3223 //\r
3224 TopOfScreen = TopOfScreen->ForwardLink;\r
3225 Difference = (Temp - BottomRow) - (SavedMenuOption->Skip - SkipValue);\r
3226\r
3227 SavedMenuOption = MENU_OPTION_FROM_LINK (TopOfScreen);\r
3228\r
3229 //\r
3230 // If we have a remainder, skip that many more op-codes until we drain the remainder\r
3231 //\r
3232 while (Difference >= (INTN) SavedMenuOption->Skip) {\r
3233 //\r
3234 // Since the Difference is greater than or equal to this op-code's skip value, skip it\r
3235 //\r
3236 Difference = Difference - (INTN) SavedMenuOption->Skip;\r
3237 TopOfScreen = TopOfScreen->ForwardLink;\r
3238 SavedMenuOption = MENU_OPTION_FROM_LINK (TopOfScreen);\r
3239 }\r
3240 //\r
3241 // Since we will act on this op-code in the next routine, and increment the\r
3242 // SkipValue, set the skips to one less than what is required.\r
3243 //\r
3244 SkipValue = Difference - 1;\r
3245 } else {\r
3246 //\r
3247 // Since we will act on this op-code in the next routine, and increment the\r
3248 // SkipValue, set the skips to one less than what is required.\r
3249 //\r
3250 SkipValue += (Temp - BottomRow) - 1;\r
3251 }\r
3252 } else {\r
3253 if ((SkipValue + 1) == (INTN) SavedMenuOption->Skip) {\r
3254 TopOfScreen = TopOfScreen->ForwardLink;\r
3255 break;\r
3256 }\r
3257 }\r
3258 //\r
3259 // If the op-code at the top of the screen is more than one line, let's not skip it yet\r
3260 // Let's set a skip flag to smoothly scroll the top of the screen.\r
3261 //\r
3262 if (SavedMenuOption->Skip > 1) {\r
3263 if (SavedMenuOption == NextMenuOption) {\r
3264 SkipValue = 0;\r
3265 } else {\r
3266 SkipValue++;\r
3267 }\r
3268 } else if (SavedMenuOption->Skip == 1) {\r
3269 SkipValue = 0;\r
3270 } else {\r
3271 SkipValue = 0;\r
3272 TopOfScreen = TopOfScreen->ForwardLink;\r
3273 }\r
3274 } while (SavedMenuOption->Skip == 0);\r
3275\r
3276 Repaint = TRUE;\r
3277 } else if (!IsSelectable (NextMenuOption)) {\r
3278 //\r
3279 // Continue to go down until scroll to next page or the selectable option is found.\r
3280 //\r
3281 ScreenOperation = UiDown;\r
3282 ControlFlag = CfScreenOperation;\r
3283 }\r
3284\r
3285 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);\r
3286\r
3287 UpdateStatusBar (INPUT_ERROR, FALSE);\r
3288\r
3289 } else {\r
3290 //\r
3291 // Scroll to the first page.\r
3292 //\r
6f05c023 3293 if (TopOfScreen != gMenuOption.ForwardLink || SkipValue != 0) {\r
7c6c064c
ED		 3294 TopOfScreen = gMenuOption.ForwardLink;\r
3295 Repaint = TRUE;\r
3296 MenuOption = NULL;\r
3297 } else {\r
3298 //\r
3299 // Need to remove the current highlight menu.\r
3300 // MenuOption saved the last highlight menu info.\r
3301 //\r
3302 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);\r
3303 }\r
3304\r
3305 SkipValue = 0;\r
3306 NewLine = TRUE;\r
3307 //\r
3308 // Get the next highlight menu.\r
3309 //\r
3310 NewPos = gMenuOption.ForwardLink;\r
3311 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);\r
3312 }\r
3313\r
3314 //\r
3315 // If we are at the end of the list and sitting on a Date/Time op, rewind to the head.\r
3316 //\r
3317 AdjustDateAndTimePosition (TRUE, &TopOfScreen);\r
3318 AdjustDateAndTimePosition (TRUE, &NewPos);\r
3319 break;\r
3320\r
3321 case CfUiNoOperation:\r
3322 ControlFlag = CfRepaint;\r
3323 break;\r
3324\r
3325 case CfExit:\r
5a9f73bf 3326 gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_LIGHTGRAY, EFI_BLACK));\r
7c6c064c
ED		 3327 if (HelpString != NULL) {\r
3328 FreePool (HelpString);\r
3329 }\r
3330 if (HelpHeaderString != NULL) {\r
3331 FreePool (HelpHeaderString);\r
3332 }\r
3333 if (HelpBottomString != NULL) {\r
3334 FreePool (HelpBottomString);\r
3335 }\r
3336 return EFI_SUCCESS;\r
3337\r
3338 default:\r
3339 break;\r
3340 }\r
3341 }\r
3342}\r
3343\r
3344/**\r
3345\r
3346 Base on the browser status info to show an pop up message.\r
3347\r
3348**/\r
3349VOID\r
3350BrowserStatusProcess (\r
3351 VOID\r
3352 )\r
3353{\r
3354 CHAR16 *ErrorInfo;\r
3355 EFI_INPUT_KEY Key;\r
3356\r
3357 if (gFormData->BrowserStatus == BROWSER_SUCCESS) {\r
3358 return;\r
3359 }\r
3360\r
3361 if (gFormData->ErrorString != NULL) {\r
3362 ErrorInfo = gFormData->ErrorString;\r
3363 } else {\r
3364 switch (gFormData->BrowserStatus) {\r
3365 case BROWSER_SUBMIT_FAIL:\r
3366 ErrorInfo = gSaveFailed;\r
3367 break;\r
3368\r
3369 case BROWSER_NO_SUBMIT_IF:\r
3370 ErrorInfo = gNoSubmitIf;\r
3371 break;\r
3372\r
3373 case BROWSER_FORM_NOT_FOUND:\r
3374 ErrorInfo = gFormNotFound;\r
3375 break;\r
3376\r
3377 case BROWSER_FORM_SUPPRESS:\r
3378 ErrorInfo = gFormSuppress;\r
3379 break;\r
3380\r
3381 case BROWSER_PROTOCOL_NOT_FOUND:\r
3382 ErrorInfo = gProtocolNotFound;\r
3383 break;\r
3384\r
3385 default:\r
3386 ErrorInfo = gBrwoserError;\r
3387 break;\r
3388 }\r
3389 }\r
3390\r
3391 //\r
3392 // Error occur, prompt error message.\r
3393 //\r
3394 do {\r
3395 CreateDialog (&Key, gEmptyString, ErrorInfo, gPressEnter, gEmptyString, NULL);\r
3396 } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);\r
3397}\r
3398\r
3399/**\r
3400 Display one form, and return user input.\r
3401 \r
3402 @param FormData Form Data to be shown.\r
3403 @param UserInputData User input data.\r
3404 \r
3405 @retval EFI_SUCCESS 1.Form Data is shown, and user input is got.\r
3406 2.Error info has show and return.\r
3407 @retval EFI_INVALID_PARAMETER The input screen dimension is not valid\r
3408 @retval EFI_NOT_FOUND New form data has some error.\r
3409**/\r
3410EFI_STATUS\r
3411EFIAPI \r
3412FormDisplay (\r
3413 IN FORM_DISPLAY_ENGINE_FORM *FormData,\r
3414 OUT USER_INPUT *UserInputData\r
3415 )\r
3416{\r
3417 EFI_STATUS Status;\r
3418\r
3419 ASSERT (FormData != NULL);\r
3420 if (FormData == NULL) {\r
3421 return EFI_INVALID_PARAMETER;\r
3422 }\r
3423\r
3424 gUserInput = UserInputData;\r
3425 gFormData = FormData;\r
3426\r
3427 //\r
3428 // Process the status info first.\r
3429 //\r
3430 BrowserStatusProcess();\r
3431 if (UserInputData == NULL) {\r
3432 //\r
3433 // UserInputData == NULL, means only need to print the error info, return here.\r
3434 //\r
3435 return EFI_SUCCESS;\r
3436 }\r
3437\r
3438 ConvertStatementToMenu();\r
3439\r
3440 Status = DisplayPageFrame (FormData, &gStatementDimensions);\r
3441 if (EFI_ERROR (Status)) {\r
3442 return Status;\r
3443 }\r
3444\r
5a9f73bf
ED		 3445 //\r
3446 // Check whether layout is changed.\r
3447 //\r
3448 if (mIsFirstForm \r
3449 || (gOldFormEntry.HiiHandle != FormData->HiiHandle)\r
3450 || (!CompareGuid (&gOldFormEntry.FormSetGuid, &FormData->FormSetGuid))\r
3451 || (gOldFormEntry.FormId != FormData->FormId)) {\r
7c6c064c 3452 mStatementLayoutIsChanged = TRUE;\r
5a9f73bf
ED		 3453 } else {\r
3454 mStatementLayoutIsChanged = FALSE;\r
7c6c064c
ED		 3455 }\r
3456\r
3457 Status = UiDisplayMenu(FormData);\r
5a9f73bf
ED		 3458 \r
3459 //\r
3460 // Backup last form info.\r
3461 //\r
3462 mIsFirstForm = FALSE;\r
3463 gOldFormEntry.HiiHandle = FormData->HiiHandle;\r
3464 CopyGuid (&gOldFormEntry.FormSetGuid, &FormData->FormSetGuid);\r
3465 gOldFormEntry.FormId = FormData->FormId;\r
7c6c064c
ED		 3466\r
3467 return Status;\r
3468}\r
3469\r
5a9f73bf
ED		 3470/**\r
3471 Clear Screen to the initial state.\r
3472**/\r
3473VOID\r
3474EFIAPI \r
3475DriverClearDisplayPage (\r
3476 VOID\r
3477 )\r
3478{\r
3479 ClearDisplayPage ();\r
3480 mIsFirstForm = TRUE;\r
3481}\r
3482\r
3483/**\r
3484 Set Buffer to Value for Size bytes.\r
3485\r
3486 @param Buffer Memory to set.\r
3487 @param Size Number of bytes to set\r
3488 @param Value Value of the set operation.\r
3489\r
3490**/\r
3491VOID\r
3492SetUnicodeMem (\r
3493 IN VOID *Buffer,\r
3494 IN UINTN Size,\r
3495 IN CHAR16 Value\r
3496 )\r
3497{\r
3498 CHAR16 *Ptr;\r
3499\r
3500 Ptr = Buffer;\r
3501 while ((Size--) != 0) {\r
3502 *(Ptr++) = Value;\r
3503 }\r
3504}\r
3505\r
7c6c064c
ED		 3506/**\r
3507 Initialize Setup Browser driver.\r
3508\r
3509 @param ImageHandle The image handle.\r
3510 @param SystemTable The system table.\r
3511\r
3512 @retval EFI_SUCCESS The Setup Browser module is initialized correctly..\r
3513 @return Other value if failed to initialize the Setup Browser module.\r
3514\r
3515**/\r
3516EFI_STATUS\r
3517EFIAPI\r
3518InitializeDisplayEngine (\r
3519 IN EFI_HANDLE ImageHandle,\r
3520 IN EFI_SYSTEM_TABLE *SystemTable\r
3521 )\r
3522{\r
3523 EFI_STATUS Status;\r
3524 EFI_INPUT_KEY HotKey;\r
3525 EFI_STRING NewString;\r
3526 EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL *FormBrowserEx2;\r
3527\r
3528 //\r
3529 // Publish our HII data\r
3530 //\r
3531 gHiiHandle = HiiAddPackages (\r
3532 &gDisplayEngineGuid,\r
3533 ImageHandle,\r
3534 DisplayEngineStrings,\r
3535 NULL\r
3536 );\r
3537 ASSERT (gHiiHandle != NULL);\r
3538\r
3539 //\r
3540 // Install Form Display protocol\r
3541 //\r
3542 Status = gBS->InstallProtocolInterface (\r
3543 &mPrivateData.Handle,\r
3544 &gEdkiiFormDisplayEngineProtocolGuid,\r
3545 EFI_NATIVE_INTERFACE,\r
3546 &mPrivateData.FromDisplayProt\r
3547 );\r
3548 ASSERT_EFI_ERROR (Status);\r
3549\r
3550 InitializeDisplayStrings();\r
5a9f73bf
ED		 3551 \r
3552 ZeroMem (&gHighligthMenuInfo, sizeof (gHighligthMenuInfo));\r
3553 ZeroMem (&gOldFormEntry, sizeof (gOldFormEntry));\r
7c6c064c
ED		 3554\r
3555 //\r
3556 // Use BrowserEx2 protocol to register HotKey.\r
3557 // \r
3558 Status = gBS->LocateProtocol (&gEdkiiFormBrowserEx2ProtocolGuid, NULL, (VOID **) &FormBrowserEx2);\r
3559 if (!EFI_ERROR (Status)) {\r
3560 //\r
3561 // Register the default HotKey F9 and F10 again.\r
3562 //\r
3563 HotKey.UnicodeChar = CHAR_NULL;\r
3564 HotKey.ScanCode = SCAN_F10;\r
3565 NewString = HiiGetString (gHiiHandle, STRING_TOKEN (FUNCTION_TEN_STRING), NULL);\r
3566 ASSERT (NewString != NULL);\r
3567 FormBrowserEx2->RegisterHotKey (&HotKey, BROWSER_ACTION_SUBMIT, 0, NewString);\r
3568\r
3569 HotKey.ScanCode = SCAN_F9;\r
3570 NewString = HiiGetString (gHiiHandle, STRING_TOKEN (FUNCTION_NINE_STRING), NULL);\r
3571 ASSERT (NewString != NULL);\r
3572 FormBrowserEx2->RegisterHotKey (&HotKey, BROWSER_ACTION_DEFAULT, EFI_HII_DEFAULT_CLASS_STANDARD, NewString);\r
3573 }\r
3574\r
3575 return EFI_SUCCESS;\r
3576}\r
3577\r
3578/**\r
3579 This is the default unload handle for display core drivers.\r
3580\r
3581 @param[in] ImageHandle The drivers' driver image.\r
3582\r
3583 @retval EFI_SUCCESS The image is unloaded.\r
3584 @retval Others Failed to unload the image.\r
3585\r
3586**/\r
3587EFI_STATUS\r
3588EFIAPI\r
3589UnloadDisplayEngine (\r
3590 IN EFI_HANDLE ImageHandle\r
3591 )\r
3592{\r
3593 HiiRemovePackages(gHiiHandle);\r
3594\r
3595 FreeDisplayStrings ();\r
3596\r
3597 return EFI_SUCCESS;\r
3598}\r
EFI Development Kit II mirror for PVE