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