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