]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/DisplayEngineDxe/FormDisplay.c
Updated OvmfPkg to use suitable CPU Exception Handler Library instances.
[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
1858 }\r
1859 }\r
1860 \r
1861 FreePool (OutputString);\r
1862 if (Temp3 != 0) {\r
1863 Temp3--;\r
1864 }\r
1865 }\r
28401a65 1866\r
af047db7
ED
1867 FreePool (StringPtr);\r
1868 }\r
1869\r
28401a65
ED
1870 //\r
1871 // 4.Line number for Option string and prompt string are not equal.\r
1872 // Clean the column whose line number is less.\r
1873 //\r
1874 if (HasOptionString(MenuOption) && (OptionLineNum != PromptLineNum)) {\r
1875 Col = OptionLineNum < PromptLineNum ? MenuOption->OptCol : BeginCol;\r
1876 Row = (OptionLineNum < PromptLineNum ? OptionLineNum : PromptLineNum) + MenuOption->Row;\r
1877 Width = (UINT16) (OptionLineNum < PromptLineNum ? gOptionBlockWidth : PromptWidth + AdjustValue + SkipWidth);\r
1878 MaxRow = (OptionLineNum < PromptLineNum ? PromptLineNum : OptionLineNum) + MenuOption->Row - 1;\r
1879 \r
1880 while (Row <= MaxRow) {\r
1881 DisplayMenuString (MenuOption, Col, Row++, L"", Width, FALSE);\r
1882 }\r
1883 }\r
1884\r
af047db7
ED
1885 return EFI_SUCCESS;\r
1886}\r
1887\r
7c6c064c
ED
1888/**\r
1889 Display menu and wait for user to select one menu option, then return it.\r
1890 If AutoBoot is enabled, then if user doesn't select any option,\r
1891 after period of time, it will automatically return the first menu option.\r
1892\r
1893 @param FormData The current form data info.\r
1894\r
1895 @retval EFI_SUCESSS Process the user selection success.\r
1896 @retval EFI_NOT_FOUND Process option string for orderedlist/Oneof fail.\r
1897\r
1898**/\r
1899EFI_STATUS\r
1900UiDisplayMenu (\r
1901 IN FORM_DISPLAY_ENGINE_FORM *FormData\r
1902 )\r
1903{\r
1904 INTN SkipValue;\r
1905 INTN Difference;\r
1906 UINTN DistanceValue;\r
1907 UINTN Row;\r
1908 UINTN Col;\r
7c6c064c
ED
1909 UINTN Temp;\r
1910 UINTN Temp2;\r
7c6c064c
ED
1911 UINTN TopRow;\r
1912 UINTN BottomRow;\r
1913 UINTN OriginalRow;\r
1914 UINTN Index;\r
1915 UINT16 Width;\r
1916 CHAR16 *StringPtr;\r
1917 CHAR16 *OptionString;\r
1918 CHAR16 *OutputString;\r
1919 CHAR16 *HelpString;\r
1920 CHAR16 *HelpHeaderString;\r
1921 CHAR16 *HelpBottomString;\r
1922 BOOLEAN NewLine;\r
1923 BOOLEAN Repaint;\r
1924 BOOLEAN UpArrow;\r
1925 BOOLEAN DownArrow;\r
1926 EFI_STATUS Status;\r
1927 EFI_INPUT_KEY Key;\r
1928 LIST_ENTRY *Link;\r
1929 LIST_ENTRY *NewPos;\r
1930 LIST_ENTRY *TopOfScreen;\r
1931 LIST_ENTRY *SavedListEntry;\r
1932 UI_MENU_OPTION *MenuOption;\r
1933 UI_MENU_OPTION *NextMenuOption;\r
1934 UI_MENU_OPTION *SavedMenuOption;\r
1935 UI_MENU_OPTION *PreviousMenuOption;\r
1936 UI_CONTROL_FLAG ControlFlag;\r
1937 UI_SCREEN_OPERATION ScreenOperation;\r
1938 UINT16 DefaultId;\r
1939 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
7c6c064c
ED
1940 BROWSER_HOT_KEY *HotKey;\r
1941 UINTN HelpPageIndex;\r
1942 UINTN HelpPageCount;\r
1943 UINTN RowCount;\r
1944 UINTN HelpLine;\r
1945 UINTN HelpHeaderLine;\r
1946 UINTN HelpBottomLine;\r
1947 BOOLEAN MultiHelpPage;\r
1948 UINT16 GlyphWidth;\r
1949 UINT16 EachLineWidth;\r
1950 UINT16 HeaderLineWidth;\r
1951 UINT16 BottomLineWidth;\r
1952 EFI_STRING_ID HelpInfo;\r
1953 UI_EVENT_TYPE EventType;\r
1954 FORM_DISPLAY_ENGINE_STATEMENT *InitialHighlight;\r
af047db7 1955 BOOLEAN SkipHighLight;\r
7c6c064c
ED
1956\r
1957 EventType = UIEventNone;\r
1958 Status = EFI_SUCCESS;\r
1959 HelpString = NULL;\r
1960 HelpHeaderString = NULL;\r
1961 HelpBottomString = NULL;\r
1962 OptionString = NULL;\r
1963 ScreenOperation = UiNoOperation;\r
1964 NewLine = TRUE;\r
1965 DefaultId = 0;\r
1966 HelpPageCount = 0;\r
1967 HelpLine = 0;\r
1968 RowCount = 0;\r
1969 HelpBottomLine = 0;\r
1970 HelpHeaderLine = 0;\r
1971 HelpPageIndex = 0;\r
1972 MultiHelpPage = FALSE;\r
1973 EachLineWidth = 0;\r
1974 HeaderLineWidth = 0;\r
1975 BottomLineWidth = 0;\r
1976 OutputString = NULL;\r
1977 UpArrow = FALSE;\r
1978 DownArrow = FALSE;\r
1979 SkipValue = 0;\r
af047db7 1980 SkipHighLight = FALSE;\r
7c6c064c
ED
1981\r
1982 NextMenuOption = NULL;\r
1983 PreviousMenuOption = NULL;\r
1984 SavedMenuOption = NULL;\r
1985 HotKey = NULL;\r
1986 Repaint = TRUE;\r
1987 MenuOption = NULL;\r
af047db7 1988 gModalSkipColumn = (CHAR16) (gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn) / 6;\r
7c6c064c
ED
1989 InitialHighlight = gFormData->HighLightedStatement;\r
1990\r
1991 ZeroMem (&Key, sizeof (EFI_INPUT_KEY));\r
1992\r
af047db7
ED
1993 //\r
1994 // Left right\r
1995 // |<-.->|<-.........->|<- .........->|<-...........->|\r
1996 // Skip Prompt Option Help \r
1997 //\r
1998 Width = (CHAR16) ((gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn) / 3);\r
1999 gOptionBlockWidth = Width + 1; \r
2000 gHelpBlockWidth = (CHAR16) (Width - LEFT_SKIPPED_COLUMNS);\r
2001 gPromptBlockWidth = (CHAR16) (gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn - 2 * Width - 1);\r
7c6c064c
ED
2002\r
2003 TopRow = gStatementDimensions.TopRow + SCROLL_ARROW_HEIGHT;\r
2004 BottomRow = gStatementDimensions.BottomRow - SCROLL_ARROW_HEIGHT - 1;\r
2005\r
2006 Row = TopRow;\r
2007 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
af047db7 2008 Col = gStatementDimensions.LeftColumn + LEFT_SKIPPED_COLUMNS + gModalSkipColumn;\r
7c6c064c
ED
2009 } else {\r
2010 Col = gStatementDimensions.LeftColumn + LEFT_SKIPPED_COLUMNS;\r
2011 }\r
2012\r
2013 FindTopMenu(FormData, &TopOfScreen, &NewPos, &SkipValue);\r
2014\r
2015 gST->ConOut->EnableCursor (gST->ConOut, FALSE);\r
2016\r
2017 ControlFlag = CfInitialization;\r
2018 while (TRUE) {\r
2019 switch (ControlFlag) {\r
2020 case CfInitialization:\r
af047db7
ED
2021 if ((gOldFormEntry.HiiHandle != FormData->HiiHandle) || \r
2022 (!CompareGuid (&gOldFormEntry.FormSetGuid, &FormData->FormSetGuid))) {\r
2023 //\r
2024 // Clear Statement range if different formset is painted.\r
2025 //\r
2026 ClearLines (\r
2027 gStatementDimensions.LeftColumn,\r
2028 gStatementDimensions.RightColumn,\r
2029 TopRow - SCROLL_ARROW_HEIGHT,\r
2030 BottomRow + SCROLL_ARROW_HEIGHT,\r
2031 GetFieldTextColor ()\r
2032 );\r
7c6c064c 2033\r
7c6c064c 2034 }\r
af047db7 2035 ControlFlag = CfRepaint;\r
7c6c064c
ED
2036 break;\r
2037\r
2038 case CfRepaint:\r
2039 ControlFlag = CfRefreshHighLight;\r
2040\r
2041 if (Repaint) {\r
2042 //\r
2043 // Display menu\r
2044 //\r
2045 DownArrow = FALSE;\r
2046 UpArrow = FALSE;\r
2047 Row = TopRow;\r
2048\r
af047db7
ED
2049 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
2050 \r
7c6c064c 2051 //\r
af047db7 2052 // 1. Check whether need to print the arrow up.\r
7c6c064c 2053 //\r
af047db7
ED
2054 if (!ValueIsScroll (TRUE, TopOfScreen)) {\r
2055 UpArrow = TRUE;\r
2056 }\r
af047db7 2057\r
ae4f5746
ED
2058 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
2059 PrintStringAtWithWidth(gStatementDimensions.LeftColumn + gModalSkipColumn, TopRow - 1, L"", gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn - 2 * gModalSkipColumn);\r
2060 } else {\r
2061 PrintStringAtWithWidth(gStatementDimensions.LeftColumn, TopRow - 1, L"", gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn);\r
2062 }\r
af047db7
ED
2063 if (UpArrow) {\r
2064 gST->ConOut->SetAttribute (gST->ConOut, GetArrowColor ());\r
2065 PrintCharAt (\r
2066 gStatementDimensions.LeftColumn + gPromptBlockWidth + gOptionBlockWidth + 1,\r
7c6c064c 2067 TopRow - SCROLL_ARROW_HEIGHT,\r
af047db7 2068 ARROW_UP\r
7c6c064c 2069 );\r
af047db7 2070 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
7c6c064c
ED
2071 }\r
2072\r
2073 //\r
2074 // 2.Paint the menu.\r
2075 //\r
2076 for (Link = TopOfScreen; Link != &gMenuOption; Link = Link->ForwardLink) {\r
2077 MenuOption = MENU_OPTION_FROM_LINK (Link);\r
2078 MenuOption->Row = Row;\r
2079 MenuOption->Col = Col;\r
2080 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
af047db7 2081 MenuOption->OptCol = gStatementDimensions.LeftColumn + LEFT_SKIPPED_COLUMNS + gPromptBlockWidth + gModalSkipColumn;\r
7c6c064c 2082 } else {\r
af047db7 2083 MenuOption->OptCol = gStatementDimensions.LeftColumn + LEFT_SKIPPED_COLUMNS + gPromptBlockWidth;\r
7c6c064c
ED
2084 }\r
2085\r
7c6c064c
ED
2086 if (MenuOption->NestInStatement) {\r
2087 MenuOption->Col += SUBTITLE_INDENT;\r
2088 }\r
2089\r
7c6c064c 2090 //\r
af047db7 2091 // Save the highlight menu, will be used in CfRefreshHighLight case.\r
7c6c064c 2092 //\r
af047db7
ED
2093 if (Link == NewPos) {\r
2094 SavedMenuOption = MenuOption;\r
2095 SkipHighLight = TRUE;\r
7c6c064c 2096 }\r
ae4f5746
ED
2097\r
2098 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
72f2eca2 2099 Status = DisplayOneMenu (MenuOption, \r
6f05c023 2100 MenuOption->Col - gStatementDimensions.LeftColumn,\r
ae4f5746
ED
2101 gStatementDimensions.LeftColumn + gModalSkipColumn, \r
2102 Link == TopOfScreen ? SkipValue : 0, \r
2103 BottomRow,\r
571c73b5 2104 (BOOLEAN) ((Link == NewPos) && IsSelectable(MenuOption))\r
ae4f5746
ED
2105 );\r
2106 } else {\r
72f2eca2 2107 Status = DisplayOneMenu (MenuOption, \r
6f05c023 2108 MenuOption->Col - gStatementDimensions.LeftColumn,\r
ae4f5746
ED
2109 gStatementDimensions.LeftColumn, \r
2110 Link == TopOfScreen ? SkipValue : 0, \r
2111 BottomRow,\r
571c73b5 2112 (BOOLEAN) ((Link == NewPos) && IsSelectable(MenuOption))\r
ae4f5746
ED
2113 ); \r
2114 }\r
7c6c064c 2115\r
72f2eca2
ED
2116 if (EFI_ERROR (Status)) {\r
2117 return Status;\r
2118 }\r
7c6c064c
ED
2119 //\r
2120 // 3. Update the row info which will be used by next menu.\r
2121 //\r
2122 if (Link == TopOfScreen) {\r
2123 Row += MenuOption->Skip - SkipValue;\r
2124 } else {\r
2125 Row += MenuOption->Skip;\r
2126 }\r
2127\r
2128 if (Row > BottomRow) {\r
2129 if (!ValueIsScroll (FALSE, Link)) {\r
2130 DownArrow = TRUE;\r
2131 }\r
2132\r
2133 Row = BottomRow + 1;\r
2134 break;\r
2135 }\r
2136 }\r
2137\r
af047db7
ED
2138 //\r
2139 // 3. Menus in this form may not cover all form, clean the remain field.\r
2140 //\r
2141 while (Row <= BottomRow) {\r
2142 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
ae4f5746 2143 PrintStringAtWithWidth(gStatementDimensions.LeftColumn + gModalSkipColumn, Row++, L"", gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn - 2 * gModalSkipColumn);\r
af047db7
ED
2144 } else {\r
2145 PrintStringAtWithWidth(gStatementDimensions.LeftColumn, Row++, L"", gStatementDimensions.RightColumn - gHelpBlockWidth - gStatementDimensions.LeftColumn);\r
2146 }\r
7c6c064c
ED
2147 }\r
2148\r
af047db7
ED
2149 //\r
2150 // 4. Print the down arrow row.\r
2151 //\r
ae4f5746
ED
2152 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
2153 PrintStringAtWithWidth(gStatementDimensions.LeftColumn + gModalSkipColumn, BottomRow + 1, L"", gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn - 2 * + gModalSkipColumn);\r
2154 } else {\r
2155 PrintStringAtWithWidth(gStatementDimensions.LeftColumn, BottomRow + 1, L"", gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn);\r
2156 }\r
7c6c064c
ED
2157 if (DownArrow) {\r
2158 gST->ConOut->SetAttribute (gST->ConOut, GetArrowColor ());\r
2159 PrintCharAt (\r
2160 gStatementDimensions.LeftColumn + gPromptBlockWidth + gOptionBlockWidth + 1,\r
2161 BottomRow + SCROLL_ARROW_HEIGHT,\r
2162 ARROW_DOWN\r
2163 );\r
2164 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
2165 }\r
2166\r
2167 MenuOption = NULL;\r
2168 }\r
2169 break;\r
2170\r
2171 case CfRefreshHighLight:\r
2172\r
2173 //\r
2174 // MenuOption: Last menu option that need to remove hilight\r
2175 // MenuOption is set to NULL in Repaint\r
2176 // NewPos: Current menu option that need to hilight\r
2177 //\r
2178 ControlFlag = CfUpdateHelpString;\r
2179\r
af047db7
ED
2180 if (SkipHighLight) {\r
2181 MenuOption = SavedMenuOption;\r
2182 SkipHighLight = FALSE;\r
2183 UpdateHighlightMenuInfo (MenuOption);\r
2184 break;\r
2185 }\r
2186\r
8924aecd
ED
2187 if (IsListEmpty (&gMenuOption)) {\r
2188 //\r
2189 // No menu option, just update the hotkey filed.\r
2190 //\r
2191 RefreshKeyHelp(gFormData, NULL, FALSE);\r
2192 break;\r
2193 }\r
2194\r
7c6c064c
ED
2195 if (MenuOption != NULL && TopOfScreen == &MenuOption->Link) {\r
2196 Temp = SkipValue;\r
2197 } else {\r
2198 Temp = 0;\r
2199 }\r
2200 if (NewPos == TopOfScreen) {\r
2201 Temp2 = SkipValue;\r
2202 } else {\r
2203 Temp2 = 0;\r
2204 }\r
2205\r
2206 if (NewPos != NULL && (MenuOption == NULL || NewPos != &MenuOption->Link)) {\r
2207 if (MenuOption != NULL) {\r
2208 //\r
2209 // Remove highlight on last Menu Option\r
2210 //\r
2211 gST->ConOut->SetCursorPosition (gST->ConOut, MenuOption->Col, MenuOption->Row);\r
2212 ProcessOptions (MenuOption, FALSE, &OptionString, TRUE);\r
2213 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
2214 if (OptionString != NULL) {\r
2215 if ((MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_DATE_OP) ||\r
2216 (MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TIME_OP)\r
2217 ) {\r
2218 ProcessStringForDateTime(MenuOption, OptionString, FALSE);\r
2219 }\r
2220\r
6f05c023 2221 Width = (UINT16) gOptionBlockWidth - 1;\r
7c6c064c
ED
2222 OriginalRow = MenuOption->Row;\r
2223 GlyphWidth = 1;\r
2224\r
2225 for (Index = 0; GetLineByWidth (OptionString, Width, &GlyphWidth, &Index, &OutputString) != 0x0000;) {\r
2226 if ((Temp == 0) && (MenuOption->Row >= TopRow) && (MenuOption->Row <= BottomRow)) {\r
2227 PrintStringAt (MenuOption->OptCol, MenuOption->Row, OutputString);\r
2228 }\r
2229 //\r
2230 // If there is more string to process print on the next row and increment the Skip value\r
2231 //\r
2232 if (StrLen (&OptionString[Index]) != 0) {\r
2233 if (Temp == 0) {\r
2234 MenuOption->Row++;\r
2235 }\r
2236 }\r
2237\r
2238 FreePool (OutputString);\r
2239 if (Temp != 0) {\r
2240 Temp--;\r
2241 }\r
2242 }\r
2243\r
2244 MenuOption->Row = OriginalRow;\r
2245\r
2246 FreePool (OptionString);\r
2247 } else {\r
2248 if (NewLine) {\r
2249 if (MenuOption->GrayOut) {\r
2250 gST->ConOut->SetAttribute (gST->ConOut, GetGrayedTextColor ());\r
2251 } else if (MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_SUBTITLE_OP) {\r
2252 gST->ConOut->SetAttribute (gST->ConOut, GetSubTitleTextColor ());\r
2253 }\r
2254\r
2255 OriginalRow = MenuOption->Row;\r
6f05c023 2256 Width = GetWidth (MenuOption, NULL);\r
7c6c064c
ED
2257 GlyphWidth = 1;\r
2258\r
2259 for (Index = 0; GetLineByWidth (MenuOption->Description, Width, &GlyphWidth, &Index, &OutputString) != 0x0000;) {\r
2260 if ((Temp == 0) && (MenuOption->Row >= TopRow) && (MenuOption->Row <= BottomRow)) {\r
2261 PrintStringAt (MenuOption->Col, MenuOption->Row, OutputString);\r
2262 }\r
2263 //\r
2264 // If there is more string to process print on the next row and increment the Skip value\r
2265 //\r
2266 if (StrLen (&MenuOption->Description[Index]) != 0) {\r
2267 if (Temp == 0) {\r
2268 MenuOption->Row++;\r
2269 }\r
2270 }\r
2271\r
2272 FreePool (OutputString);\r
2273 if (Temp != 0) {\r
2274 Temp--;\r
2275 }\r
2276 }\r
2277\r
2278 MenuOption->Row = OriginalRow;\r
2279 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
2280 }\r
2281 }\r
2282 }\r
2283\r
2284 //\r
2285 // This is the current selected statement\r
2286 //\r
2287 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
2288 Statement = MenuOption->ThisTag;\r
2289\r
af047db7 2290 UpdateHighlightMenuInfo (MenuOption);\r
7c6c064c
ED
2291\r
2292 if (!IsSelectable (MenuOption)) {\r
7c6c064c
ED
2293 break;\r
2294 }\r
2295\r
2296 //\r
2297 // Set reverse attribute\r
2298 //\r
2299 gST->ConOut->SetAttribute (gST->ConOut, GetHighlightTextColor ());\r
2300 gST->ConOut->SetCursorPosition (gST->ConOut, MenuOption->Col, MenuOption->Row);\r
2301\r
2302 ProcessOptions (MenuOption, FALSE, &OptionString, TRUE);\r
2303 if (OptionString != NULL) {\r
2304 if (Statement->OpCode->OpCode == EFI_IFR_DATE_OP || Statement->OpCode->OpCode == EFI_IFR_TIME_OP) {\r
2305 ProcessStringForDateTime(MenuOption, OptionString, FALSE);\r
2306 }\r
6f05c023 2307 Width = (UINT16) gOptionBlockWidth - 1;\r
7c6c064c
ED
2308\r
2309 OriginalRow = MenuOption->Row;\r
2310 GlyphWidth = 1;\r
2311\r
2312 for (Index = 0; GetLineByWidth (OptionString, Width, &GlyphWidth, &Index, &OutputString) != 0x0000;) {\r
2313 if ((Temp2 == 0) && (MenuOption->Row >= TopRow) && (MenuOption->Row <= BottomRow) ) {\r
2314 PrintStringAt (MenuOption->OptCol, MenuOption->Row, OutputString);\r
2315 }\r
2316 //\r
2317 // If there is more string to process print on the next row and increment the Skip value\r
2318 //\r
2319 if (StrLen (&OptionString[Index]) != 0) {\r
2320 if (Temp2 == 0) {\r
2321 MenuOption->Row++;\r
2322 }\r
2323 }\r
2324\r
2325 FreePool (OutputString);\r
2326 if (Temp2 != 0) {\r
2327 Temp2--;\r
2328 }\r
2329 }\r
2330\r
2331 MenuOption->Row = OriginalRow;\r
2332\r
2333 FreePool (OptionString);\r
2334 } else {\r
2335 if (NewLine) {\r
2336 OriginalRow = MenuOption->Row;\r
2337\r
6f05c023 2338 Width = GetWidth (MenuOption, NULL);\r
7c6c064c
ED
2339 GlyphWidth = 1;\r
2340\r
2341 for (Index = 0; GetLineByWidth (MenuOption->Description, Width, &GlyphWidth, &Index, &OutputString) != 0x0000;) {\r
2342 if ((Temp2 == 0) && (MenuOption->Row >= TopRow) && (MenuOption->Row <= BottomRow) ) {\r
2343 PrintStringAt (MenuOption->Col, MenuOption->Row, OutputString);\r
2344 }\r
2345 //\r
2346 // If there is more string to process print on the next row and increment the Skip value\r
2347 //\r
2348 if (StrLen (&MenuOption->Description[Index]) != 0) {\r
2349 if (Temp2 == 0) {\r
2350 MenuOption->Row++;\r
2351 }\r
2352 }\r
2353\r
2354 FreePool (OutputString);\r
2355 if (Temp2 != 0) {\r
2356 Temp2--;\r
2357 }\r
2358 }\r
2359\r
2360 MenuOption->Row = OriginalRow;\r
2361\r
2362 }\r
2363 }\r
2364\r
7c6c064c
ED
2365 //\r
2366 // Clear reverse attribute\r
2367 //\r
2368 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
2369 }\r
2370 break;\r
2371\r
2372 case CfUpdateHelpString:\r
2373 ControlFlag = CfPrepareToReadKey;\r
2374 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
2375 break;\r
2376 }\r
2377\r
2378 if (Repaint || NewLine) {\r
8924aecd
ED
2379 if (IsListEmpty (&gMenuOption)) {\r
2380 //\r
2381 // Don't print anything if no mwnu option.\r
2382 //\r
7c6c064c
ED
2383 StringPtr = GetToken (STRING_TOKEN (EMPTY_STRING), gHiiHandle);\r
2384 } else {\r
8924aecd
ED
2385 //\r
2386 // Don't print anything if it is a NULL help token\r
2387 //\r
2388 ASSERT(MenuOption != NULL);\r
2389 HelpInfo = ((EFI_IFR_STATEMENT_HEADER *) ((CHAR8 *)MenuOption->ThisTag->OpCode + sizeof (EFI_IFR_OP_HEADER)))->Help;\r
2390 if (HelpInfo == 0 || !IsSelectable (MenuOption)) {\r
2391 StringPtr = GetToken (STRING_TOKEN (EMPTY_STRING), gHiiHandle);\r
2392 } else {\r
2393 StringPtr = GetToken (HelpInfo, gFormData->HiiHandle);\r
2394 }\r
7c6c064c
ED
2395 }\r
2396\r
2397 RowCount = BottomRow - TopRow + 1;\r
2398 HelpPageIndex = 0;\r
2399 //\r
2400 // 1.Calculate how many line the help string need to print.\r
2401 //\r
2402 if (HelpString != NULL) {\r
2403 FreePool (HelpString);\r
2404 HelpString = NULL;\r
2405 }\r
2406 HelpLine = ProcessHelpString (StringPtr, &HelpString, &EachLineWidth, RowCount);\r
2407 FreePool (StringPtr);\r
2408\r
2409 if (HelpLine > RowCount) {\r
2410 MultiHelpPage = TRUE;\r
2411 StringPtr = GetToken (STRING_TOKEN(ADJUST_HELP_PAGE_UP), gHiiHandle);\r
2412 if (HelpHeaderString != NULL) {\r
2413 FreePool (HelpHeaderString);\r
2414 HelpHeaderString = NULL;\r
2415 }\r
2416 HelpHeaderLine = ProcessHelpString (StringPtr, &HelpHeaderString, &HeaderLineWidth, 0);\r
2417 FreePool (StringPtr);\r
2418 StringPtr = GetToken (STRING_TOKEN(ADJUST_HELP_PAGE_DOWN), gHiiHandle);\r
2419 if (HelpBottomString != NULL) {\r
2420 FreePool (HelpBottomString);\r
2421 HelpBottomString = NULL;\r
2422 }\r
2423 HelpBottomLine = ProcessHelpString (StringPtr, &HelpBottomString, &BottomLineWidth, 0);\r
2424 FreePool (StringPtr);\r
2425 //\r
2426 // Calculate the help page count.\r
2427 //\r
2428 if (HelpLine > 2 * RowCount - 2) {\r
2429 HelpPageCount = (HelpLine - RowCount + 1) / (RowCount - 2) + 1;\r
2430 if ((HelpLine - RowCount + 1) % (RowCount - 2) > 1) {\r
2431 HelpPageCount += 1;\r
2432 }\r
2433 } else {\r
2434 HelpPageCount = 2;\r
2435 }\r
2436 } else {\r
2437 MultiHelpPage = FALSE;\r
2438 }\r
2439 }\r
2440\r
2441 //\r
2442 // Check whether need to show the 'More(U/u)' at the begin.\r
2443 // Base on current direct info, here shows aligned to the right side of the column.\r
2444 // If the direction is multi line and aligned to right side may have problem, so \r
2445 // add ASSERT code here.\r
2446 //\r
2447 if (HelpPageIndex > 0) {\r
2448 gST->ConOut->SetAttribute (gST->ConOut, GetInfoTextColor ());\r
2449 for (Index = 0; Index < HelpHeaderLine; Index++) {\r
2450 ASSERT (HelpHeaderLine == 1);\r
2451 ASSERT (GetStringWidth (HelpHeaderString) / 2 < (UINTN) (gHelpBlockWidth - 1));\r
2452 PrintStringAtWithWidth (\r
2453 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2454 Index + TopRow,\r
2455 gEmptyString,\r
2456 gHelpBlockWidth\r
2457 );\r
2458 PrintStringAt (\r
2459 gStatementDimensions.RightColumn - GetStringWidth (HelpHeaderString) / 2 - 1,\r
2460 Index + TopRow,\r
2461 &HelpHeaderString[Index * HeaderLineWidth]\r
2462 );\r
2463 }\r
2464 }\r
2465\r
2466 gST->ConOut->SetAttribute (gST->ConOut, GetHelpTextColor ());\r
2467 //\r
2468 // Print the help string info.\r
2469 //\r
2470 if (!MultiHelpPage) {\r
2471 for (Index = 0; Index < HelpLine; Index++) {\r
2472 PrintStringAtWithWidth (\r
2473 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2474 Index + TopRow,\r
2475 &HelpString[Index * EachLineWidth],\r
2476 gHelpBlockWidth\r
2477 );\r
2478 }\r
2479 for (; Index < RowCount; Index ++) {\r
2480 PrintStringAtWithWidth (\r
2481 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2482 Index + TopRow,\r
2483 gEmptyString,\r
2484 gHelpBlockWidth\r
2485 );\r
2486 }\r
2487 gST->ConOut->SetCursorPosition(gST->ConOut, gStatementDimensions.RightColumn-1, BottomRow);\r
2488 } else {\r
2489 if (HelpPageIndex == 0) {\r
2490 for (Index = 0; Index < RowCount - HelpBottomLine; Index++) {\r
2491 PrintStringAtWithWidth (\r
2492 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2493 Index + TopRow,\r
2494 &HelpString[Index * EachLineWidth],\r
2495 gHelpBlockWidth\r
2496 );\r
2497 }\r
2498 } else {\r
2499 for (Index = 0; (Index < RowCount - HelpBottomLine - HelpHeaderLine) && \r
2500 (Index + HelpPageIndex * (RowCount - 2) + 1 < HelpLine); Index++) {\r
2501 PrintStringAtWithWidth (\r
2502 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2503 Index + TopRow + HelpHeaderLine,\r
2504 &HelpString[(Index + HelpPageIndex * (RowCount - 2) + 1)* EachLineWidth],\r
2505 gHelpBlockWidth\r
2506 );\r
2507 }\r
2508 if (HelpPageIndex == HelpPageCount - 1) {\r
2509 for (; Index < RowCount - HelpHeaderLine; Index ++) {\r
2510 PrintStringAtWithWidth (\r
2511 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2512 Index + TopRow + HelpHeaderLine,\r
2513 gEmptyString,\r
2514 gHelpBlockWidth\r
2515 );\r
2516 }\r
2517 gST->ConOut->SetCursorPosition(gST->ConOut, gStatementDimensions.RightColumn-1, BottomRow);\r
2518 }\r
2519 } \r
2520 }\r
2521\r
2522 //\r
2523 // Check whether need to print the 'More(D/d)' at the bottom.\r
2524 // Base on current direct info, here shows aligned to the right side of the column.\r
2525 // If the direction is multi line and aligned to right side may have problem, so \r
2526 // add ASSERT code here.\r
2527 //\r
2528 if (HelpPageIndex < HelpPageCount - 1 && MultiHelpPage) {\r
2529 gST->ConOut->SetAttribute (gST->ConOut, GetInfoTextColor ());\r
2530 for (Index = 0; Index < HelpBottomLine; Index++) {\r
2531 ASSERT (HelpBottomLine == 1);\r
2532 ASSERT (GetStringWidth (HelpBottomString) / 2 < (UINTN) (gHelpBlockWidth - 1)); \r
2533 PrintStringAtWithWidth (\r
2534 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2535 BottomRow + Index - HelpBottomLine + 1,\r
2536 gEmptyString,\r
2537 gHelpBlockWidth\r
2538 );\r
2539 PrintStringAt (\r
2540 gStatementDimensions.RightColumn - GetStringWidth (HelpBottomString) / 2 - 1,\r
2541 BottomRow + Index - HelpBottomLine + 1,\r
2542 &HelpBottomString[Index * BottomLineWidth]\r
2543 );\r
2544 }\r
2545 }\r
2546 //\r
2547 // Reset this flag every time we finish using it.\r
2548 //\r
2549 Repaint = FALSE;\r
2550 NewLine = FALSE;\r
2551 break;\r
2552\r
2553 case CfPrepareToReadKey:\r
2554 ControlFlag = CfReadKey;\r
2555 ScreenOperation = UiNoOperation;\r
2556 break;\r
2557\r
2558 case CfReadKey:\r
2559 ControlFlag = CfScreenOperation;\r
2560\r
2561 //\r
2562 // Wait for user's selection\r
2563 //\r
2564 while (TRUE) {\r
2565 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
2566 if (!EFI_ERROR (Status)) {\r
2567 EventType = UIEventKey;\r
2568 break;\r
2569 }\r
2570\r
2571 //\r
2572 // If we encounter error, continue to read another key in.\r
2573 //\r
2574 if (Status != EFI_NOT_READY) {\r
2575 continue;\r
2576 }\r
2577 \r
2578 EventType = UiWaitForEvent(gST->ConIn->WaitForKey);\r
2579 if (EventType == UIEventKey) {\r
2580 gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
2581 }\r
2582 break;\r
2583 }\r
2584\r
2585 if (EventType == UIEventDriver) {\r
2586 gUserInput->Action = BROWSER_ACTION_NONE;\r
2587 ControlFlag = CfExit;\r
2588 break;\r
2589 }\r
2590 \r
2591 if (EventType == UIEventTimeOut) {\r
2592 gUserInput->Action = BROWSER_ACTION_FORM_EXIT;\r
2593 ControlFlag = CfExit;\r
2594 break;\r
2595 }\r
2596\r
2597 switch (Key.UnicodeChar) {\r
2598 case CHAR_CARRIAGE_RETURN:\r
2599 if(MenuOption == NULL || MenuOption->GrayOut || MenuOption->ReadOnly) {\r
2600 ControlFlag = CfReadKey;\r
2601 break;\r
2602 }\r
2603\r
2604 ScreenOperation = UiSelect;\r
2605 gDirection = 0;\r
2606 break;\r
2607\r
2608 //\r
2609 // We will push the adjustment of these numeric values directly to the input handler\r
2610 // NOTE: we won't handle manual input numeric\r
2611 //\r
2612 case '+':\r
2613 case '-':\r
2614 //\r
2615 // If the screen has no menu items, and the user didn't select UiReset\r
2616 // ignore the selection and go back to reading keys.\r
2617 //\r
2618 if(IsListEmpty (&gMenuOption) || MenuOption->GrayOut || MenuOption->ReadOnly) {\r
2619 ControlFlag = CfReadKey;\r
2620 break;\r
2621 }\r
2622\r
2623 ASSERT(MenuOption != NULL);\r
2624 Statement = MenuOption->ThisTag;\r
2625 if ((Statement->OpCode->OpCode == EFI_IFR_DATE_OP)\r
2626 || (Statement->OpCode->OpCode == EFI_IFR_TIME_OP)\r
2627 || ((Statement->OpCode->OpCode == EFI_IFR_NUMERIC_OP) && (GetFieldFromNum(Statement->OpCode) != 0))\r
2628 ){\r
2629 if (Key.UnicodeChar == '+') {\r
2630 gDirection = SCAN_RIGHT;\r
2631 } else {\r
2632 gDirection = SCAN_LEFT;\r
2633 }\r
2634 \r
2635 Status = ProcessOptions (MenuOption, TRUE, &OptionString, TRUE);\r
2636 if (OptionString != NULL) {\r
2637 FreePool (OptionString);\r
2638 }\r
2639 if (EFI_ERROR (Status)) {\r
2640 //\r
2641 // Repaint to clear possible error prompt pop-up\r
2642 //\r
2643 Repaint = TRUE;\r
2644 NewLine = TRUE;\r
2645 } else {\r
2646 ControlFlag = CfExit;\r
2647 }\r
2648 }\r
2649 break;\r
2650\r
2651 case '^':\r
2652 ScreenOperation = UiUp;\r
2653 break;\r
2654\r
2655 case 'V':\r
2656 case 'v':\r
2657 ScreenOperation = UiDown;\r
2658 break;\r
2659\r
2660 case ' ':\r
2661 if(IsListEmpty (&gMenuOption)) {\r
2662 ControlFlag = CfReadKey;\r
2663 break;\r
2664 }\r
2665 \r
2666 ASSERT(MenuOption != NULL);\r
2667 if (MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_CHECKBOX_OP && !MenuOption->GrayOut && !MenuOption->ReadOnly) {\r
2668 ScreenOperation = UiSelect;\r
2669 }\r
2670 break;\r
2671\r
2672 case 'D':\r
2673 case 'd':\r
2674 if (!MultiHelpPage) {\r
2675 ControlFlag = CfReadKey;\r
2676 break;\r
2677 }\r
2678 ControlFlag = CfUpdateHelpString;\r
2679 HelpPageIndex = HelpPageIndex < HelpPageCount - 1 ? HelpPageIndex + 1 : HelpPageCount - 1;\r
2680 break;\r
2681\r
2682 case 'U':\r
2683 case 'u':\r
2684 if (!MultiHelpPage) {\r
2685 ControlFlag = CfReadKey;\r
2686 break;\r
2687 }\r
2688 ControlFlag = CfUpdateHelpString;\r
2689 HelpPageIndex = HelpPageIndex > 0 ? HelpPageIndex - 1 : 0;\r
2690 break;\r
2691\r
2692 case CHAR_NULL:\r
2693 for (Index = 0; Index < mScanCodeNumber; Index++) {\r
2694 if (Key.ScanCode == gScanCodeToOperation[Index].ScanCode) {\r
2695 ScreenOperation = gScanCodeToOperation[Index].ScreenOperation;\r
2696 break;\r
2697 }\r
2698 }\r
2699 \r
2700 if (((FormData->Attribute & HII_DISPLAY_MODAL) != 0) && (Key.ScanCode == SCAN_ESC || Index == mScanCodeNumber)) {\r
2701 //\r
2702 // ModalForm has no ESC key and Hot Key.\r
2703 //\r
2704 ControlFlag = CfReadKey;\r
2705 } else if (Index == mScanCodeNumber) {\r
2706 //\r
2707 // Check whether Key matches the registered hot key.\r
2708 //\r
2709 HotKey = NULL;\r
2710 HotKey = GetHotKeyFromRegisterList (&Key);\r
2711 if (HotKey != NULL) {\r
2712 ScreenOperation = UiHotKey;\r
2713 }\r
2714 }\r
2715 break;\r
2716 }\r
2717 break;\r
2718\r
2719 case CfScreenOperation:\r
8924aecd 2720 if ((ScreenOperation != UiReset) && (ScreenOperation != UiHotKey)) {\r
7c6c064c 2721 //\r
8924aecd 2722 // If the screen has no menu items, and the user didn't select UiReset or UiHotKey\r
7c6c064c
ED
2723 // ignore the selection and go back to reading keys.\r
2724 //\r
2725 if (IsListEmpty (&gMenuOption)) {\r
2726 ControlFlag = CfReadKey;\r
2727 break;\r
2728 }\r
2729 }\r
2730\r
2731 for (Index = 0;\r
2732 Index < sizeof (gScreenOperationToControlFlag) / sizeof (gScreenOperationToControlFlag[0]);\r
2733 Index++\r
2734 ) {\r
2735 if (ScreenOperation == gScreenOperationToControlFlag[Index].ScreenOperation) {\r
2736 ControlFlag = gScreenOperationToControlFlag[Index].ControlFlag;\r
2737 break;\r
2738 }\r
2739 }\r
2740 break;\r
2741\r
2742 case CfUiSelect:\r
2743 ControlFlag = CfRepaint;\r
2744\r
2745 ASSERT(MenuOption != NULL);\r
2746 Statement = MenuOption->ThisTag;\r
2747 if (Statement->OpCode->OpCode == EFI_IFR_TEXT_OP) {\r
2748 break;\r
2749 }\r
2750\r
2751 switch (Statement->OpCode->OpCode) {\r
2752 case EFI_IFR_REF_OP:\r
2753 case EFI_IFR_ACTION_OP:\r
2754 case EFI_IFR_RESET_BUTTON_OP:\r
2755 ControlFlag = CfExit;\r
2756 break;\r
2757\r
2758 default:\r
2759 //\r
2760 // Editable Questions: oneof, ordered list, checkbox, numeric, string, password\r
2761 //\r
2762 RefreshKeyHelp (gFormData, Statement, TRUE);\r
2763 Status = ProcessOptions (MenuOption, TRUE, &OptionString, TRUE);\r
2764 \r
2765 if (OptionString != NULL) {\r
2766 FreePool (OptionString);\r
2767 }\r
2768 \r
2769 if (EFI_ERROR (Status)) {\r
2770 Repaint = TRUE;\r
2771 NewLine = TRUE;\r
2772 RefreshKeyHelp (gFormData, Statement, FALSE);\r
2773 break;\r
2774 } else {\r
2775 ControlFlag = CfExit;\r
2776 break;\r
2777 }\r
2778 }\r
2779 break;\r
2780\r
2781 case CfUiReset:\r
2782 //\r
2783 // We come here when someone press ESC\r
2784 // If the policy is not exit front page when user press ESC, process here.\r
2785 //\r
2786 if (!FormExitPolicy()) {\r
2787 Repaint = TRUE;\r
2788 NewLine = TRUE;\r
2789 ControlFlag = CfRepaint;\r
2790 break;\r
2791 }\r
2792\r
2793 //\r
2794 // When user press ESC, it will try to show another menu, should clean the gSequence info.\r
2795 //\r
2796 if (gSequence != 0) {\r
2797 gSequence = 0;\r
2798 }\r
2799\r
2800 gUserInput->Action = BROWSER_ACTION_FORM_EXIT;\r
2801 ControlFlag = CfExit;\r
2802 break;\r
2803\r
2804 case CfUiHotKey:\r
2805 ControlFlag = CfRepaint;\r
2806 \r
2807 gUserInput->Action = HotKey->Action;\r
2808 ControlFlag = CfExit;\r
2809 break;\r
2810\r
2811 case CfUiLeft:\r
2812 ControlFlag = CfRepaint;\r
2813 ASSERT(MenuOption != NULL);\r
2814 if ((MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_DATE_OP) || (MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TIME_OP)) {\r
2815 if (MenuOption->Sequence != 0) {\r
2816 //\r
2817 // In the middle or tail of the Date/Time op-code set, go left.\r
2818 //\r
2819 ASSERT(NewPos != NULL);\r
2820 NewPos = NewPos->BackLink;\r
2821 }\r
2822 }\r
2823 break;\r
2824\r
2825 case CfUiRight:\r
2826 ControlFlag = CfRepaint;\r
2827 ASSERT(MenuOption != NULL);\r
2828 if ((MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_DATE_OP) || (MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TIME_OP)) {\r
2829 if (MenuOption->Sequence != 2) {\r
2830 //\r
2831 // In the middle or tail of the Date/Time op-code set, go left.\r
2832 //\r
2833 ASSERT(NewPos != NULL);\r
2834 NewPos = NewPos->ForwardLink;\r
2835 }\r
2836 }\r
2837 break;\r
2838\r
2839 case CfUiUp:\r
2840 ControlFlag = CfRepaint;\r
2841\r
2842 SavedListEntry = NewPos;\r
2843\r
2844 ASSERT(NewPos != NULL);\r
2845 //\r
2846 // Adjust Date/Time position before we advance forward.\r
2847 //\r
2848 AdjustDateAndTimePosition (TRUE, &NewPos);\r
2849 if (NewPos->BackLink != &gMenuOption) {\r
2850 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
2851 ASSERT (MenuOption != NULL);\r
2852 NewLine = TRUE;\r
2853 NewPos = NewPos->BackLink;\r
2854\r
2855 PreviousMenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
2856 if (PreviousMenuOption->Row == 0) {\r
2857 UpdateOptionSkipLines (PreviousMenuOption);\r
2858 }\r
2859 DistanceValue = PreviousMenuOption->Skip;\r
2860 Difference = 0;\r
2861 if (MenuOption->Row >= DistanceValue + TopRow) {\r
2862 Difference = MoveToNextStatement (TRUE, &NewPos, MenuOption->Row - TopRow - DistanceValue);\r
2863 }\r
2864 NextMenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
2865 \r
2866 if (Difference < 0) {\r
2867 //\r
2868 // We hit the begining MenuOption that can be focused\r
2869 // so we simply scroll to the top.\r
2870 //\r
2871 if (TopOfScreen != gMenuOption.ForwardLink) {\r
2872 TopOfScreen = gMenuOption.ForwardLink;\r
2873 Repaint = TRUE;\r
2874 } else {\r
2875 //\r
2876 // Scroll up to the last page when we have arrived at top page.\r
2877 //\r
2878 NewPos = &gMenuOption;\r
2879 TopOfScreen = &gMenuOption;\r
2880 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);\r
2881 ScreenOperation = UiPageUp;\r
2882 ControlFlag = CfScreenOperation;\r
2883 break;\r
2884 }\r
2885 } else if (MenuOption->Row < TopRow + DistanceValue + Difference) {\r
2886 //\r
2887 // Previous focus MenuOption is above the TopOfScreen, so we need to scroll\r
2888 //\r
2889 TopOfScreen = NewPos;\r
2890 Repaint = TRUE;\r
2891 SkipValue = 0;\r
2892 } else if (!IsSelectable (NextMenuOption)) {\r
2893 //\r
2894 // Continue to go up until scroll to next page or the selectable option is found.\r
2895 //\r
2896 ScreenOperation = UiUp;\r
2897 ControlFlag = CfScreenOperation;\r
2898 }\r
2899\r
2900 //\r
2901 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.\r
2902 //\r
2903 AdjustDateAndTimePosition (TRUE, &TopOfScreen);\r
2904 AdjustDateAndTimePosition (TRUE, &NewPos);\r
2905 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);\r
2906 UpdateStatusBar (INPUT_ERROR, FALSE);\r
2907 } else {\r
6f05c023
ED
2908 if (NewPos->ForwardLink == &gMenuOption) {\r
2909 NewLine = FALSE;\r
2910 Repaint = FALSE;\r
2911 break;\r
2912 }\r
7c6c064c
ED
2913 //\r
2914 // Scroll up to the last page.\r
2915 //\r
2916 NewPos = &gMenuOption;\r
2917 TopOfScreen = &gMenuOption;\r
2918 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);\r
2919 ScreenOperation = UiPageUp;\r
2920 ControlFlag = CfScreenOperation;\r
6f05c023 2921 SkipValue = 0;\r
7c6c064c
ED
2922 }\r
2923 break;\r
2924\r
2925 case CfUiPageUp:\r
2926 //\r
2927 // SkipValue means lines is skipped when show the top menu option.\r
2928 //\r
2929 ControlFlag = CfRepaint;\r
2930\r
2931 ASSERT(NewPos != NULL);\r
2932 //\r
2933 // Already at the first menu option, Check the skip value.\r
2934 //\r
2935 if (NewPos->BackLink == &gMenuOption) {\r
2936 if (SkipValue == 0) {\r
2937 NewLine = FALSE;\r
2938 Repaint = FALSE;\r
2939 } else {\r
2940 NewLine = TRUE;\r
2941 Repaint = TRUE;\r
2942 SkipValue = 0;\r
2943 }\r
2944 break;\r
2945 }\r
2946\r
2947 NewLine = TRUE;\r
2948 Repaint = TRUE;\r
2949\r
2950 //\r
2951 // SkipValue > (BottomRow - TopRow + 1) means current menu has more than one\r
2952 // form of options to be show, so just update the SkipValue to show the next\r
2953 // parts of options.\r
2954 //\r
2955 if (SkipValue > (INTN) (BottomRow - TopRow + 1)) {\r
2956 SkipValue -= BottomRow - TopRow + 1;\r
2957 break;\r
2958 }\r
2959\r
2960 Link = TopOfScreen;\r
2961 //\r
2962 // First minus the menu of the top screen, it's value is SkipValue.\r
2963 //\r
2964 Index = (BottomRow + 1) - SkipValue;\r
2965 while ((Index > TopRow) && (Link->BackLink != &gMenuOption)) {\r
2966 Link = Link->BackLink;\r
2967 PreviousMenuOption = MENU_OPTION_FROM_LINK (Link);\r
2968 if (PreviousMenuOption->Row == 0) {\r
2969 UpdateOptionSkipLines (PreviousMenuOption);\r
2970 } \r
2971 if (Index < PreviousMenuOption->Skip) {\r
2972 break;\r
2973 }\r
2974 Index = Index - PreviousMenuOption->Skip;\r
2975 }\r
2976 \r
2977 if ((Link->BackLink == &gMenuOption) && (Index >= TopRow)) {\r
7c6c064c
ED
2978 if (TopOfScreen == &gMenuOption) {\r
2979 TopOfScreen = gMenuOption.ForwardLink;\r
2980 NewPos = gMenuOption.BackLink;\r
2981 MoveToNextStatement (TRUE, &NewPos, BottomRow - TopRow);\r
6f05c023
ED
2982 if (Index < PreviousMenuOption->Skip) {\r
2983 Repaint = TRUE;\r
2984 SkipValue = PreviousMenuOption->Skip - (Index - TopRow);\r
2985 } else {\r
2986 Repaint = FALSE;\r
2987 SkipValue = 0;\r
2988 }\r
7c6c064c
ED
2989 } else if (TopOfScreen != Link) {\r
2990 TopOfScreen = Link;\r
2991 NewPos = Link;\r
2992 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);\r
6f05c023 2993 SkipValue = 0;\r
7c6c064c
ED
2994 } else {\r
2995 //\r
2996 // Finally we know that NewPos is the last MenuOption can be focused.\r
2997 //\r
6f05c023
ED
2998 if (SkipValue == 0) {\r
2999 Repaint = FALSE;\r
3000 }\r
7c6c064c
ED
3001 NewPos = Link;\r
3002 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);\r
6f05c023 3003 SkipValue = 0;\r
7c6c064c
ED
3004 }\r
3005 } else {\r
3006 if (Index > TopRow) {\r
3007 //\r
3008 // At here, only case "Index < PreviousMenuOption->Skip" can reach here.\r
3009 //\r
3010 SkipValue = PreviousMenuOption->Skip - (Index - TopRow);\r
3011 } else if (Index == TopRow) {\r
3012 SkipValue = 0;\r
3013 } else {\r
3014 SkipValue = TopRow - Index;\r
3015 }\r
3016\r
3017 //\r
3018 // Move to the option in Next page.\r
3019 //\r
3020 if (TopOfScreen == &gMenuOption) {\r
3021 NewPos = gMenuOption.BackLink;\r
3022 MoveToNextStatement (TRUE, &NewPos, BottomRow - TopRow);\r
3023 } else {\r
3024 NewPos = Link;\r
3025 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);\r
3026 }\r
3027\r
3028 //\r
3029 // There are more MenuOption needing scrolling up.\r
3030 //\r
3031 TopOfScreen = Link;\r
3032 MenuOption = NULL;\r
3033 }\r
3034\r
3035 //\r
3036 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.\r
3037 // Don't do this when we are already in the first page.\r
3038 //\r
3039 AdjustDateAndTimePosition (TRUE, &TopOfScreen);\r
3040 AdjustDateAndTimePosition (TRUE, &NewPos);\r
3041 break;\r
3042\r
3043 case CfUiPageDown:\r
3044 //\r
3045 // SkipValue means lines is skipped when show the top menu option.\r
3046 //\r
3047 ControlFlag = CfRepaint;\r
3048\r
3049 ASSERT (NewPos != NULL);\r
3050 if (NewPos->ForwardLink == &gMenuOption) {\r
6f05c023
ED
3051 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
3052 if (SkipValue + BottomRow - TopRow + 1 < MenuOption->Skip) {\r
3053 SkipValue += BottomRow - TopRow + 1;\r
3054 NewLine = TRUE;\r
3055 Repaint = TRUE;\r
3056 break;\r
3057 }\r
7c6c064c
ED
3058 NewLine = FALSE;\r
3059 Repaint = FALSE;\r
3060 break;\r
3061 }\r
3062\r
3063 NewLine = TRUE;\r
3064 Repaint = TRUE;\r
3065 Link = TopOfScreen;\r
3066 NextMenuOption = MENU_OPTION_FROM_LINK (Link);\r
3067 Index = TopRow + NextMenuOption->Skip - SkipValue;\r
3068 //\r
3069 // Count to the menu option which will show at the top of the next form.\r
3070 //\r
3071 while ((Index <= BottomRow + 1) && (Link->ForwardLink != &gMenuOption)) {\r
3072 Link = Link->ForwardLink;\r
3073 NextMenuOption = MENU_OPTION_FROM_LINK (Link);\r
3074 Index = Index + NextMenuOption->Skip;\r
3075 }\r
3076\r
3077 if ((Link->ForwardLink == &gMenuOption) && (Index <= BottomRow + 1)) {\r
3078 //\r
3079 // Finally we know that NewPos is the last MenuOption can be focused.\r
3080 //\r
3081 Repaint = FALSE;\r
3082 MoveToNextStatement (TRUE, &Link, Index - TopRow);\r
3083 } else {\r
3084 //\r
3085 // Calculate the skip line for top of screen menu.\r
3086 //\r
3087 if (Link == TopOfScreen) {\r
3088 //\r
3089 // The top of screen menu option occupies the entire form.\r
3090 //\r
3091 SkipValue += BottomRow - TopRow + 1;\r
3092 } else {\r
3093 SkipValue = NextMenuOption->Skip - (Index - (BottomRow + 1));\r
3094 }\r
3095\r
3096 TopOfScreen = Link;\r
3097 MenuOption = NULL;\r
3098 //\r
3099 // Move to the Next selectable menu.\r
3100 //\r
3101 MoveToNextStatement (FALSE, &Link, BottomRow - TopRow);\r
3102 }\r
3103\r
3104 //\r
3105 // Save the menu as the next highlight menu.\r
3106 //\r
3107 NewPos = Link;\r
3108\r
3109 //\r
3110 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.\r
3111 // Don't do this when we are already in the last page.\r
3112 //\r
3113 AdjustDateAndTimePosition (TRUE, &TopOfScreen);\r
3114 AdjustDateAndTimePosition (TRUE, &NewPos);\r
3115 break;\r
3116\r
3117 case CfUiDown:\r
3118 //\r
3119 // SkipValue means lines is skipped when show the top menu option.\r
3120 // NewPos points to the menu which is highlighted now.\r
3121 //\r
3122 ControlFlag = CfRepaint;\r
3123\r
3124 //\r
3125 // Since the behavior of hitting the down arrow on a Date/Time op-code is intended\r
3126 // to be one that progresses to the next set of op-codes, we need to advance to the last\r
3127 // Date/Time op-code and leave the remaining logic in UiDown intact so the appropriate\r
3128 // checking can be done. The only other logic we need to introduce is that if a Date/Time\r
3129 // op-code is the last entry in the menu, we need to rewind back to the first op-code of\r
3130 // the Date/Time op-code.\r
3131 //\r
3132 SavedListEntry = NewPos;\r
3133 AdjustDateAndTimePosition (FALSE, &NewPos);\r
3134\r
3135 if (NewPos->ForwardLink != &gMenuOption) {\r
6f05c023
ED
3136 if (NewPos == TopOfScreen) {\r
3137 Temp2 = SkipValue;\r
3138 } else {\r
3139 Temp2 = 0;\r
3140 }\r
3141\r
7c6c064c
ED
3142 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
3143 NewLine = TRUE;\r
3144 NewPos = NewPos->ForwardLink;\r
3145\r
3146 Difference = 0;\r
3147 //\r
3148 // Current menu not at the bottom of the form.\r
3149 //\r
6f05c023 3150 if (BottomRow >= MenuOption->Row + MenuOption->Skip - Temp2) {\r
7c6c064c
ED
3151 //\r
3152 // Find the next selectable menu.\r
3153 //\r
6f05c023 3154 Difference = MoveToNextStatement (FALSE, &NewPos, BottomRow - MenuOption->Row - MenuOption->Skip + Temp2);\r
7c6c064c
ED
3155 //\r
3156 // We hit the end of MenuOption that can be focused\r
3157 // so we simply scroll to the first page.\r
3158 //\r
3159 if (Difference < 0) {\r
3160 //\r
3161 // Scroll to the first page.\r
3162 //\r
3163 if (TopOfScreen != gMenuOption.ForwardLink) {\r
3164 TopOfScreen = gMenuOption.ForwardLink;\r
3165 Repaint = TRUE;\r
3166 MenuOption = NULL;\r
3167 } else {\r
3168 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);\r
3169 }\r
3170 NewPos = gMenuOption.ForwardLink;\r
3171 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);\r
3172\r
3173 SkipValue = 0;\r
3174 //\r
3175 // If we are at the end of the list and sitting on a Date/Time op, rewind to the head.\r
3176 //\r
3177 AdjustDateAndTimePosition (TRUE, &TopOfScreen);\r
3178 AdjustDateAndTimePosition (TRUE, &NewPos);\r
3179 break;\r
3180 }\r
3181 }\r
3182 NextMenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
3183 if (NextMenuOption->Row == 0) {\r
3184 UpdateOptionSkipLines (NextMenuOption);\r
3185 }\r
6f05c023 3186 DistanceValue = Difference + NextMenuOption->Skip - Temp2;\r
7c6c064c
ED
3187\r
3188 Temp = MenuOption->Row + MenuOption->Skip + DistanceValue - 1;\r
6f05c023 3189 if ((MenuOption->Row + MenuOption->Skip - Temp2 == BottomRow + 1) &&\r
7c6c064c
ED
3190 (NextMenuOption->ThisTag->OpCode->OpCode == EFI_IFR_DATE_OP ||\r
3191 NextMenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TIME_OP)\r
3192 ) {\r
3193 Temp ++;\r
3194 }\r
3195\r
3196 //\r
3197 // If we are going to scroll, update TopOfScreen\r
3198 //\r
3199 if (Temp > BottomRow) {\r
3200 do {\r
3201 //\r
3202 // Is the current top of screen a zero-advance op-code?\r
3203 // If so, keep moving forward till we hit a >0 advance op-code\r
3204 //\r
3205 SavedMenuOption = MENU_OPTION_FROM_LINK (TopOfScreen);\r
3206\r
3207 //\r
3208 // If bottom op-code is more than one line or top op-code is more than one line\r
3209 //\r
3210 if ((DistanceValue > 1) || (SavedMenuOption->Skip > 1)) {\r
3211 //\r
3212 // Is the bottom op-code greater than or equal in size to the top op-code?\r
3213 //\r
3214 if ((Temp - BottomRow) >= (SavedMenuOption->Skip - SkipValue)) {\r
3215 //\r
3216 // Skip the top op-code\r
3217 //\r
3218 TopOfScreen = TopOfScreen->ForwardLink;\r
3219 Difference = (Temp - BottomRow) - (SavedMenuOption->Skip - SkipValue);\r
3220\r
3221 SavedMenuOption = MENU_OPTION_FROM_LINK (TopOfScreen);\r
3222\r
3223 //\r
3224 // If we have a remainder, skip that many more op-codes until we drain the remainder\r
3225 //\r
3226 while (Difference >= (INTN) SavedMenuOption->Skip) {\r
3227 //\r
3228 // Since the Difference is greater than or equal to this op-code's skip value, skip it\r
3229 //\r
3230 Difference = Difference - (INTN) SavedMenuOption->Skip;\r
3231 TopOfScreen = TopOfScreen->ForwardLink;\r
3232 SavedMenuOption = MENU_OPTION_FROM_LINK (TopOfScreen);\r
3233 }\r
3234 //\r
3235 // Since we will act on this op-code in the next routine, and increment the\r
3236 // SkipValue, set the skips to one less than what is required.\r
3237 //\r
3238 SkipValue = Difference - 1;\r
3239 } else {\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 += (Temp - BottomRow) - 1;\r
3245 }\r
3246 } else {\r
3247 if ((SkipValue + 1) == (INTN) SavedMenuOption->Skip) {\r
3248 TopOfScreen = TopOfScreen->ForwardLink;\r
3249 break;\r
3250 }\r
3251 }\r
3252 //\r
3253 // If the op-code at the top of the screen is more than one line, let's not skip it yet\r
3254 // Let's set a skip flag to smoothly scroll the top of the screen.\r
3255 //\r
3256 if (SavedMenuOption->Skip > 1) {\r
3257 if (SavedMenuOption == NextMenuOption) {\r
3258 SkipValue = 0;\r
3259 } else {\r
3260 SkipValue++;\r
3261 }\r
3262 } else if (SavedMenuOption->Skip == 1) {\r
3263 SkipValue = 0;\r
3264 } else {\r
3265 SkipValue = 0;\r
3266 TopOfScreen = TopOfScreen->ForwardLink;\r
3267 }\r
3268 } while (SavedMenuOption->Skip == 0);\r
3269\r
3270 Repaint = TRUE;\r
3271 } else if (!IsSelectable (NextMenuOption)) {\r
3272 //\r
3273 // Continue to go down until scroll to next page or the selectable option is found.\r
3274 //\r
3275 ScreenOperation = UiDown;\r
3276 ControlFlag = CfScreenOperation;\r
3277 }\r
3278\r
3279 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);\r
3280\r
3281 UpdateStatusBar (INPUT_ERROR, FALSE);\r
3282\r
3283 } else {\r
3284 //\r
3285 // Scroll to the first page.\r
3286 //\r
6f05c023 3287 if (TopOfScreen != gMenuOption.ForwardLink || SkipValue != 0) {\r
7c6c064c
ED
3288 TopOfScreen = gMenuOption.ForwardLink;\r
3289 Repaint = TRUE;\r
3290 MenuOption = NULL;\r
3291 } else {\r
3292 //\r
3293 // Need to remove the current highlight menu.\r
3294 // MenuOption saved the last highlight menu info.\r
3295 //\r
3296 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);\r
3297 }\r
3298\r
3299 SkipValue = 0;\r
3300 NewLine = TRUE;\r
3301 //\r
3302 // Get the next highlight menu.\r
3303 //\r
3304 NewPos = gMenuOption.ForwardLink;\r
3305 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);\r
3306 }\r
3307\r
3308 //\r
3309 // If we are at the end of the list and sitting on a Date/Time op, rewind to the head.\r
3310 //\r
3311 AdjustDateAndTimePosition (TRUE, &TopOfScreen);\r
3312 AdjustDateAndTimePosition (TRUE, &NewPos);\r
3313 break;\r
3314\r
3315 case CfUiNoOperation:\r
3316 ControlFlag = CfRepaint;\r
3317 break;\r
3318\r
3319 case CfExit:\r
5a9f73bf 3320 gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_LIGHTGRAY, EFI_BLACK));\r
7c6c064c
ED
3321 if (HelpString != NULL) {\r
3322 FreePool (HelpString);\r
3323 }\r
3324 if (HelpHeaderString != NULL) {\r
3325 FreePool (HelpHeaderString);\r
3326 }\r
3327 if (HelpBottomString != NULL) {\r
3328 FreePool (HelpBottomString);\r
3329 }\r
3330 return EFI_SUCCESS;\r
3331\r
3332 default:\r
3333 break;\r
3334 }\r
3335 }\r
3336}\r
3337\r
3338/**\r
3339\r
3340 Base on the browser status info to show an pop up message.\r
3341\r
3342**/\r
3343VOID\r
3344BrowserStatusProcess (\r
3345 VOID\r
3346 )\r
3347{\r
3348 CHAR16 *ErrorInfo;\r
3349 EFI_INPUT_KEY Key;\r
3350\r
3351 if (gFormData->BrowserStatus == BROWSER_SUCCESS) {\r
3352 return;\r
3353 }\r
3354\r
3355 if (gFormData->ErrorString != NULL) {\r
3356 ErrorInfo = gFormData->ErrorString;\r
3357 } else {\r
3358 switch (gFormData->BrowserStatus) {\r
3359 case BROWSER_SUBMIT_FAIL:\r
3360 ErrorInfo = gSaveFailed;\r
3361 break;\r
3362\r
3363 case BROWSER_NO_SUBMIT_IF:\r
3364 ErrorInfo = gNoSubmitIf;\r
3365 break;\r
3366\r
3367 case BROWSER_FORM_NOT_FOUND:\r
3368 ErrorInfo = gFormNotFound;\r
3369 break;\r
3370\r
3371 case BROWSER_FORM_SUPPRESS:\r
3372 ErrorInfo = gFormSuppress;\r
3373 break;\r
3374\r
3375 case BROWSER_PROTOCOL_NOT_FOUND:\r
3376 ErrorInfo = gProtocolNotFound;\r
3377 break;\r
3378\r
3379 default:\r
3380 ErrorInfo = gBrwoserError;\r
3381 break;\r
3382 }\r
3383 }\r
3384\r
3385 //\r
3386 // Error occur, prompt error message.\r
3387 //\r
3388 do {\r
3389 CreateDialog (&Key, gEmptyString, ErrorInfo, gPressEnter, gEmptyString, NULL);\r
3390 } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);\r
3391}\r
3392\r
3393/**\r
3394 Display one form, and return user input.\r
3395 \r
3396 @param FormData Form Data to be shown.\r
3397 @param UserInputData User input data.\r
3398 \r
3399 @retval EFI_SUCCESS 1.Form Data is shown, and user input is got.\r
3400 2.Error info has show and return.\r
3401 @retval EFI_INVALID_PARAMETER The input screen dimension is not valid\r
3402 @retval EFI_NOT_FOUND New form data has some error.\r
3403**/\r
3404EFI_STATUS\r
3405EFIAPI \r
3406FormDisplay (\r
3407 IN FORM_DISPLAY_ENGINE_FORM *FormData,\r
3408 OUT USER_INPUT *UserInputData\r
3409 )\r
3410{\r
3411 EFI_STATUS Status;\r
3412\r
3413 ASSERT (FormData != NULL);\r
3414 if (FormData == NULL) {\r
3415 return EFI_INVALID_PARAMETER;\r
3416 }\r
3417\r
3418 gUserInput = UserInputData;\r
3419 gFormData = FormData;\r
3420\r
3421 //\r
3422 // Process the status info first.\r
3423 //\r
3424 BrowserStatusProcess();\r
3425 if (UserInputData == NULL) {\r
3426 //\r
3427 // UserInputData == NULL, means only need to print the error info, return here.\r
3428 //\r
3429 return EFI_SUCCESS;\r
3430 }\r
3431\r
3432 ConvertStatementToMenu();\r
3433\r
3434 Status = DisplayPageFrame (FormData, &gStatementDimensions);\r
3435 if (EFI_ERROR (Status)) {\r
3436 return Status;\r
3437 }\r
3438\r
5a9f73bf
ED
3439 //\r
3440 // Check whether layout is changed.\r
3441 //\r
3442 if (mIsFirstForm \r
3443 || (gOldFormEntry.HiiHandle != FormData->HiiHandle)\r
3444 || (!CompareGuid (&gOldFormEntry.FormSetGuid, &FormData->FormSetGuid))\r
3445 || (gOldFormEntry.FormId != FormData->FormId)) {\r
7c6c064c 3446 mStatementLayoutIsChanged = TRUE;\r
5a9f73bf
ED
3447 } else {\r
3448 mStatementLayoutIsChanged = FALSE;\r
7c6c064c
ED
3449 }\r
3450\r
3451 Status = UiDisplayMenu(FormData);\r
5a9f73bf
ED
3452 \r
3453 //\r
3454 // Backup last form info.\r
3455 //\r
3456 mIsFirstForm = FALSE;\r
3457 gOldFormEntry.HiiHandle = FormData->HiiHandle;\r
3458 CopyGuid (&gOldFormEntry.FormSetGuid, &FormData->FormSetGuid);\r
3459 gOldFormEntry.FormId = FormData->FormId;\r
7c6c064c
ED
3460\r
3461 return Status;\r
3462}\r
3463\r
5a9f73bf
ED
3464/**\r
3465 Clear Screen to the initial state.\r
3466**/\r
3467VOID\r
3468EFIAPI \r
3469DriverClearDisplayPage (\r
3470 VOID\r
3471 )\r
3472{\r
3473 ClearDisplayPage ();\r
3474 mIsFirstForm = TRUE;\r
3475}\r
3476\r
3477/**\r
3478 Set Buffer to Value for Size bytes.\r
3479\r
3480 @param Buffer Memory to set.\r
3481 @param Size Number of bytes to set\r
3482 @param Value Value of the set operation.\r
3483\r
3484**/\r
3485VOID\r
3486SetUnicodeMem (\r
3487 IN VOID *Buffer,\r
3488 IN UINTN Size,\r
3489 IN CHAR16 Value\r
3490 )\r
3491{\r
3492 CHAR16 *Ptr;\r
3493\r
3494 Ptr = Buffer;\r
3495 while ((Size--) != 0) {\r
3496 *(Ptr++) = Value;\r
3497 }\r
3498}\r
3499\r
7c6c064c
ED
3500/**\r
3501 Initialize Setup Browser driver.\r
3502\r
3503 @param ImageHandle The image handle.\r
3504 @param SystemTable The system table.\r
3505\r
3506 @retval EFI_SUCCESS The Setup Browser module is initialized correctly..\r
3507 @return Other value if failed to initialize the Setup Browser module.\r
3508\r
3509**/\r
3510EFI_STATUS\r
3511EFIAPI\r
3512InitializeDisplayEngine (\r
3513 IN EFI_HANDLE ImageHandle,\r
3514 IN EFI_SYSTEM_TABLE *SystemTable\r
3515 )\r
3516{\r
3517 EFI_STATUS Status;\r
3518 EFI_INPUT_KEY HotKey;\r
3519 EFI_STRING NewString;\r
3520 EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL *FormBrowserEx2;\r
3521\r
3522 //\r
3523 // Publish our HII data\r
3524 //\r
3525 gHiiHandle = HiiAddPackages (\r
3526 &gDisplayEngineGuid,\r
3527 ImageHandle,\r
3528 DisplayEngineStrings,\r
3529 NULL\r
3530 );\r
3531 ASSERT (gHiiHandle != NULL);\r
3532\r
3533 //\r
3534 // Install Form Display protocol\r
3535 //\r
3536 Status = gBS->InstallProtocolInterface (\r
3537 &mPrivateData.Handle,\r
3538 &gEdkiiFormDisplayEngineProtocolGuid,\r
3539 EFI_NATIVE_INTERFACE,\r
3540 &mPrivateData.FromDisplayProt\r
3541 );\r
3542 ASSERT_EFI_ERROR (Status);\r
3543\r
3544 InitializeDisplayStrings();\r
5a9f73bf
ED
3545 \r
3546 ZeroMem (&gHighligthMenuInfo, sizeof (gHighligthMenuInfo));\r
3547 ZeroMem (&gOldFormEntry, sizeof (gOldFormEntry));\r
7c6c064c
ED
3548\r
3549 //\r
3550 // Use BrowserEx2 protocol to register HotKey.\r
3551 // \r
3552 Status = gBS->LocateProtocol (&gEdkiiFormBrowserEx2ProtocolGuid, NULL, (VOID **) &FormBrowserEx2);\r
3553 if (!EFI_ERROR (Status)) {\r
3554 //\r
3555 // Register the default HotKey F9 and F10 again.\r
3556 //\r
3557 HotKey.UnicodeChar = CHAR_NULL;\r
3558 HotKey.ScanCode = SCAN_F10;\r
3559 NewString = HiiGetString (gHiiHandle, STRING_TOKEN (FUNCTION_TEN_STRING), NULL);\r
3560 ASSERT (NewString != NULL);\r
3561 FormBrowserEx2->RegisterHotKey (&HotKey, BROWSER_ACTION_SUBMIT, 0, NewString);\r
3562\r
3563 HotKey.ScanCode = SCAN_F9;\r
3564 NewString = HiiGetString (gHiiHandle, STRING_TOKEN (FUNCTION_NINE_STRING), NULL);\r
3565 ASSERT (NewString != NULL);\r
3566 FormBrowserEx2->RegisterHotKey (&HotKey, BROWSER_ACTION_DEFAULT, EFI_HII_DEFAULT_CLASS_STANDARD, NewString);\r
3567 }\r
3568\r
3569 return EFI_SUCCESS;\r
3570}\r
3571\r
3572/**\r
3573 This is the default unload handle for display core drivers.\r
3574\r
3575 @param[in] ImageHandle The drivers' driver image.\r
3576\r
3577 @retval EFI_SUCCESS The image is unloaded.\r
3578 @retval Others Failed to unload the image.\r
3579\r
3580**/\r
3581EFI_STATUS\r
3582EFIAPI\r
3583UnloadDisplayEngine (\r
3584 IN EFI_HANDLE ImageHandle\r
3585 )\r
3586{\r
3587 HiiRemovePackages(gHiiHandle);\r
3588\r
3589 FreeDisplayStrings ();\r
3590\r
3591 return EFI_SUCCESS;\r
3592}\r