]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/SetupBrowserDxe/Ui.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Adjust the start position of the opcode string before saving it to avoid show menu...
[mirror_edk2.git] / MdeModulePkg / Universal / SetupBrowserDxe / Ui.c
1 /** @file
2 Utility functions for User Interface functions.
3
4 Copyright (c) 2004 - 2011, 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 "Setup.h"
16
17 LIST_ENTRY gMenuOption;
18 LIST_ENTRY gMenuList = INITIALIZE_LIST_HEAD_VARIABLE (gMenuList);
19 MENU_REFRESH_ENTRY *gMenuRefreshHead; // Menu list used for refresh timer opcode.
20 MENU_REFRESH_ENTRY *gMenuEventGuidRefreshHead; // Menu list used for refresh event guid opcode.
21
22 //
23 // Search table for UiDisplayMenu()
24 //
25 SCAN_CODE_TO_SCREEN_OPERATION gScanCodeToOperation[] = {
26 {
27 SCAN_UP,
28 UiUp,
29 },
30 {
31 SCAN_DOWN,
32 UiDown,
33 },
34 {
35 SCAN_PAGE_UP,
36 UiPageUp,
37 },
38 {
39 SCAN_PAGE_DOWN,
40 UiPageDown,
41 },
42 {
43 SCAN_ESC,
44 UiReset,
45 },
46 {
47 SCAN_LEFT,
48 UiLeft,
49 },
50 {
51 SCAN_RIGHT,
52 UiRight,
53 },
54 {
55 SCAN_F9,
56 UiDefault,
57 },
58 {
59 SCAN_F10,
60 UiSave
61 }
62 };
63
64 SCREEN_OPERATION_T0_CONTROL_FLAG gScreenOperationToControlFlag[] = {
65 {
66 UiNoOperation,
67 CfUiNoOperation,
68 },
69 {
70 UiDefault,
71 CfUiDefault,
72 },
73 {
74 UiSelect,
75 CfUiSelect,
76 },
77 {
78 UiUp,
79 CfUiUp,
80 },
81 {
82 UiDown,
83 CfUiDown,
84 },
85 {
86 UiLeft,
87 CfUiLeft,
88 },
89 {
90 UiRight,
91 CfUiRight,
92 },
93 {
94 UiReset,
95 CfUiReset,
96 },
97 {
98 UiSave,
99 CfUiSave,
100 },
101 {
102 UiPageUp,
103 CfUiPageUp,
104 },
105 {
106 UiPageDown,
107 CfUiPageDown
108 }
109 };
110
111 BOOLEAN mInputError;
112 BOOLEAN GetLineByWidthFinished = FALSE;
113
114
115 /**
116 Set Buffer to Value for Size bytes.
117
118 @param Buffer Memory to set.
119 @param Size Number of bytes to set
120 @param Value Value of the set operation.
121
122 **/
123 VOID
124 SetUnicodeMem (
125 IN VOID *Buffer,
126 IN UINTN Size,
127 IN CHAR16 Value
128 )
129 {
130 CHAR16 *Ptr;
131
132 Ptr = Buffer;
133 while ((Size--) != 0) {
134 *(Ptr++) = Value;
135 }
136 }
137
138
139 /**
140 Initialize Menu option list.
141
142 **/
143 VOID
144 UiInitMenu (
145 VOID
146 )
147 {
148 InitializeListHead (&gMenuOption);
149 }
150
151
152 /**
153 Free Menu option linked list.
154
155 **/
156 VOID
157 UiFreeMenu (
158 VOID
159 )
160 {
161 UI_MENU_OPTION *MenuOption;
162
163 while (!IsListEmpty (&gMenuOption)) {
164 MenuOption = MENU_OPTION_FROM_LINK (gMenuOption.ForwardLink);
165 RemoveEntryList (&MenuOption->Link);
166
167 //
168 // We allocated space for this description when we did a GetToken, free it here
169 //
170 if (MenuOption->Skip != 0) {
171 //
172 // For date/time, MenuOption->Description is shared by three Menu Options
173 // Data format : [01/02/2004] [11:22:33]
174 // Line number : 0 0 1 0 0 1
175 //
176 FreePool (MenuOption->Description);
177 }
178 FreePool (MenuOption);
179 }
180 }
181
182
183 /**
184 Create a menu with specified formset GUID and form ID, and add it as a child
185 of the given parent menu.
186
187 @param Parent The parent of menu to be added.
188 @param FormSetGuid The Formset Guid of menu to be added.
189 @param FormId The Form ID of menu to be added.
190
191 @return A pointer to the newly added menu or NULL if memory is insufficient.
192
193 **/
194 UI_MENU_LIST *
195 UiAddMenuList (
196 IN OUT UI_MENU_LIST *Parent,
197 IN EFI_GUID *FormSetGuid,
198 IN UINT16 FormId
199 )
200 {
201 UI_MENU_LIST *MenuList;
202
203 MenuList = AllocateZeroPool (sizeof (UI_MENU_LIST));
204 if (MenuList == NULL) {
205 return NULL;
206 }
207
208 MenuList->Signature = UI_MENU_LIST_SIGNATURE;
209 InitializeListHead (&MenuList->ChildListHead);
210
211 CopyMem (&MenuList->FormSetGuid, FormSetGuid, sizeof (EFI_GUID));
212 MenuList->FormId = FormId;
213 MenuList->Parent = Parent;
214
215 if (Parent == NULL) {
216 //
217 // If parent is not specified, it is the root Form of a Formset
218 //
219 InsertTailList (&gMenuList, &MenuList->Link);
220 } else {
221 InsertTailList (&Parent->ChildListHead, &MenuList->Link);
222 }
223
224 return MenuList;
225 }
226
227
228 /**
229 Search Menu with given FormId in the parent menu and all its child menus.
230
231 @param Parent The parent of menu to search.
232 @param FormId The Form ID of menu to search.
233
234 @return A pointer to menu found or NULL if not found.
235
236 **/
237 UI_MENU_LIST *
238 UiFindChildMenuList (
239 IN UI_MENU_LIST *Parent,
240 IN UINT16 FormId
241 )
242 {
243 LIST_ENTRY *Link;
244 UI_MENU_LIST *Child;
245 UI_MENU_LIST *MenuList;
246
247 if (Parent->FormId == FormId) {
248 return Parent;
249 }
250
251 Link = GetFirstNode (&Parent->ChildListHead);
252 while (!IsNull (&Parent->ChildListHead, Link)) {
253 Child = UI_MENU_LIST_FROM_LINK (Link);
254
255 MenuList = UiFindChildMenuList (Child, FormId);
256 if (MenuList != NULL) {
257 return MenuList;
258 }
259
260 Link = GetNextNode (&Parent->ChildListHead, Link);
261 }
262
263 return NULL;
264 }
265
266
267 /**
268 Search Menu with given FormSetGuid and FormId in all cached menu list.
269
270 @param FormSetGuid The Formset GUID of the menu to search.
271 @param FormId The Form ID of menu to search.
272
273 @return A pointer to menu found or NULL if not found.
274
275 **/
276 UI_MENU_LIST *
277 UiFindMenuList (
278 IN EFI_GUID *FormSetGuid,
279 IN UINT16 FormId
280 )
281 {
282 LIST_ENTRY *Link;
283 UI_MENU_LIST *MenuList;
284 UI_MENU_LIST *Child;
285
286 Link = GetFirstNode (&gMenuList);
287 while (!IsNull (&gMenuList, Link)) {
288 MenuList = UI_MENU_LIST_FROM_LINK (Link);
289
290 if (CompareGuid (FormSetGuid, &MenuList->FormSetGuid)) {
291 //
292 // This is the formset we are looking for, find the form in this formset
293 //
294 Child = UiFindChildMenuList (MenuList, FormId);
295 if (Child != NULL) {
296 return Child;
297 }
298 }
299
300 Link = GetNextNode (&gMenuList, Link);
301 }
302
303 return NULL;
304 }
305
306
307 /**
308 Free Menu option linked list.
309
310 **/
311 VOID
312 UiFreeRefreshList (
313 VOID
314 )
315 {
316 MENU_REFRESH_ENTRY *OldMenuRefreshEntry;
317
318 while (gMenuRefreshHead != NULL) {
319 OldMenuRefreshEntry = gMenuRefreshHead->Next;
320 FreePool (gMenuRefreshHead);
321 gMenuRefreshHead = OldMenuRefreshEntry;
322 }
323
324 while (gMenuEventGuidRefreshHead != NULL) {
325 OldMenuRefreshEntry = gMenuEventGuidRefreshHead->Next;
326 if (gMenuEventGuidRefreshHead != NULL) {
327 gBS->CloseEvent(gMenuEventGuidRefreshHead->Event);
328 }
329 FreePool (gMenuEventGuidRefreshHead);
330 gMenuEventGuidRefreshHead = OldMenuRefreshEntry;
331 }
332 }
333
334
335
336 /**
337 Refresh question.
338
339 @param MenuRefreshEntry Menu refresh structure which has info about the refresh question.
340 **/
341 EFI_STATUS
342 RefreshQuestion (
343 IN MENU_REFRESH_ENTRY *MenuRefreshEntry
344 )
345 {
346 CHAR16 *OptionString;
347 UINTN Index;
348 EFI_STATUS Status;
349 UI_MENU_SELECTION *Selection;
350 FORM_BROWSER_STATEMENT *Question;
351
352 Selection = MenuRefreshEntry->Selection;
353 Question = MenuRefreshEntry->MenuOption->ThisTag;
354
355 Status = GetQuestionValue (Selection->FormSet, Selection->Form, Question, FALSE);
356 if (EFI_ERROR (Status)) {
357 return Status;
358 }
359
360 OptionString = NULL;
361 ProcessOptions (Selection, MenuRefreshEntry->MenuOption, FALSE, &OptionString);
362
363 if (OptionString != NULL) {
364 //
365 // If leading spaces on OptionString - remove the spaces
366 //
367 for (Index = 0; OptionString[Index] == L' '; Index++)
368 ;
369
370 //
371 // If old Text is longer than new string, need to clean the old string before paint the newer.
372 // This option is no need for time/date opcode, because time/data opcode has fixed string length.
373 //
374 if ((MenuRefreshEntry->MenuOption->ThisTag->Operand != EFI_IFR_DATE_OP) &&
375 (MenuRefreshEntry->MenuOption->ThisTag->Operand != EFI_IFR_TIME_OP)) {
376 ClearLines (
377 MenuRefreshEntry->CurrentColumn,
378 MenuRefreshEntry->CurrentColumn + gOptionBlockWidth - 1,
379 MenuRefreshEntry->CurrentRow,
380 MenuRefreshEntry->CurrentRow,
381 PcdGet8 (PcdBrowserFieldTextColor) | FIELD_BACKGROUND
382 );
383 }
384
385 gST->ConOut->SetAttribute (gST->ConOut, MenuRefreshEntry->CurrentAttribute);
386 PrintStringAt (MenuRefreshEntry->CurrentColumn, MenuRefreshEntry->CurrentRow, &OptionString[Index]);
387 FreePool (OptionString);
388 }
389
390 //
391 // Question value may be changed, need invoke its Callback()
392 //
393 Status = ProcessCallBackFunction (Selection, Question, EFI_BROWSER_ACTION_CHANGING, FALSE);
394
395 return Status;
396 }
397
398 /**
399 Refresh the question which has refresh guid event attribute.
400
401 @param Event The event which has this function related.
402 @param Context The input context info related to this event or the status code return to the caller.
403 **/
404 VOID
405 EFIAPI
406 RefreshQuestionNotify(
407 IN EFI_EVENT Event,
408 IN VOID *Context
409 )
410 {
411 MENU_REFRESH_ENTRY *MenuRefreshEntry;
412 UI_MENU_SELECTION *Selection;
413
414 //
415 // Reset FormPackage update flag
416 //
417 mHiiPackageListUpdated = FALSE;
418
419 MenuRefreshEntry = (MENU_REFRESH_ENTRY *)Context;
420 ASSERT (MenuRefreshEntry != NULL);
421 Selection = MenuRefreshEntry->Selection;
422
423 RefreshQuestion (MenuRefreshEntry);
424
425 if (mHiiPackageListUpdated) {
426 //
427 // Package list is updated, force to reparse IFR binary of target Formset
428 //
429 mHiiPackageListUpdated = FALSE;
430 Selection->Action = UI_ACTION_REFRESH_FORMSET;
431 }
432 }
433
434
435 /**
436 Refresh screen.
437
438 **/
439 EFI_STATUS
440 RefreshForm (
441 VOID
442 )
443 {
444 MENU_REFRESH_ENTRY *MenuRefreshEntry;
445 EFI_STATUS Status;
446 UI_MENU_SELECTION *Selection;
447
448 if (gMenuRefreshHead != NULL) {
449 //
450 // call from refresh interval process.
451 //
452 MenuRefreshEntry = gMenuRefreshHead;
453 Selection = MenuRefreshEntry->Selection;
454 //
455 // Reset FormPackage update flag
456 //
457 mHiiPackageListUpdated = FALSE;
458
459 do {
460 Status = RefreshQuestion (MenuRefreshEntry);
461 if (EFI_ERROR (Status)) {
462 return Status;
463 }
464
465 MenuRefreshEntry = MenuRefreshEntry->Next;
466
467 } while (MenuRefreshEntry != NULL);
468
469 if (mHiiPackageListUpdated) {
470 //
471 // Package list is updated, force to reparse IFR binary of target Formset
472 //
473 mHiiPackageListUpdated = FALSE;
474 Selection->Action = UI_ACTION_REFRESH_FORMSET;
475 return EFI_SUCCESS;
476 }
477 }
478
479 return EFI_TIMEOUT;
480 }
481
482
483 /**
484 Wait for a given event to fire, or for an optional timeout to expire.
485
486 @param Event The event to wait for
487 @param Timeout An optional timeout value in 100 ns units.
488 @param RefreshInterval Menu refresh interval (in seconds).
489
490 @retval EFI_SUCCESS Event fired before Timeout expired.
491 @retval EFI_TIME_OUT Timout expired before Event fired.
492
493 **/
494 EFI_STATUS
495 UiWaitForSingleEvent (
496 IN EFI_EVENT Event,
497 IN UINT64 Timeout, OPTIONAL
498 IN UINT8 RefreshInterval OPTIONAL
499 )
500 {
501 EFI_STATUS Status;
502 UINTN Index;
503 EFI_EVENT TimerEvent;
504 EFI_EVENT WaitList[2];
505
506 if (Timeout != 0) {
507 //
508 // Create a timer event
509 //
510 Status = gBS->CreateEvent (EVT_TIMER, 0, NULL, NULL, &TimerEvent);
511 if (!EFI_ERROR (Status)) {
512 //
513 // Set the timer event
514 //
515 gBS->SetTimer (
516 TimerEvent,
517 TimerRelative,
518 Timeout
519 );
520
521 //
522 // Wait for the original event or the timer
523 //
524 WaitList[0] = Event;
525 WaitList[1] = TimerEvent;
526 Status = gBS->WaitForEvent (2, WaitList, &Index);
527 gBS->CloseEvent (TimerEvent);
528
529 //
530 // If the timer expired, change the return to timed out
531 //
532 if (!EFI_ERROR (Status) && Index == 1) {
533 Status = EFI_TIMEOUT;
534 }
535 }
536 } else {
537 //
538 // Update screen every second
539 //
540 if (RefreshInterval == 0) {
541 Timeout = ONE_SECOND;
542 } else {
543 Timeout = RefreshInterval * ONE_SECOND;
544 }
545
546 do {
547 Status = gBS->CreateEvent (EVT_TIMER, 0, NULL, NULL, &TimerEvent);
548
549 //
550 // Set the timer event
551 //
552 gBS->SetTimer (
553 TimerEvent,
554 TimerRelative,
555 Timeout
556 );
557
558 //
559 // Wait for the original event or the timer
560 //
561 WaitList[0] = Event;
562 WaitList[1] = TimerEvent;
563 Status = gBS->WaitForEvent (2, WaitList, &Index);
564
565 //
566 // If the timer expired, update anything that needs a refresh and keep waiting
567 //
568 if (!EFI_ERROR (Status) && Index == 1) {
569 Status = EFI_TIMEOUT;
570 if (RefreshInterval != 0) {
571 Status = RefreshForm ();
572 }
573 }
574
575 gBS->CloseEvent (TimerEvent);
576 } while (Status == EFI_TIMEOUT);
577 }
578
579 return Status;
580 }
581
582
583 /**
584 Add one menu option by specified description and context.
585
586 @param String String description for this option.
587 @param Handle Hii handle for the package list.
588 @param Statement Statement of this Menu Option.
589 @param NumberOfLines Display lines for this Menu Option.
590 @param MenuItemCount The index for this Option in the Menu.
591
592 @retval Pointer Pointer to the added Menu Option.
593
594 **/
595 UI_MENU_OPTION *
596 UiAddMenuOption (
597 IN CHAR16 *String,
598 IN EFI_HII_HANDLE Handle,
599 IN FORM_BROWSER_STATEMENT *Statement,
600 IN UINT16 NumberOfLines,
601 IN UINT16 MenuItemCount
602 )
603 {
604 UI_MENU_OPTION *MenuOption;
605 UINTN Index;
606 UINTN Count;
607
608 Count = 1;
609 MenuOption = NULL;
610
611 if (Statement->Operand == EFI_IFR_DATE_OP || Statement->Operand == EFI_IFR_TIME_OP) {
612 //
613 // Add three MenuOptions for Date/Time
614 // Data format : [01/02/2004] [11:22:33]
615 // Line number : 0 0 1 0 0 1
616 //
617 NumberOfLines = 0;
618 Count = 3;
619
620 if (Statement->Storage == NULL) {
621 //
622 // For RTC type of date/time, set default refresh interval to be 1 second
623 //
624 if (Statement->RefreshInterval == 0) {
625 Statement->RefreshInterval = 1;
626 }
627 }
628 }
629
630 for (Index = 0; Index < Count; Index++) {
631 MenuOption = AllocateZeroPool (sizeof (UI_MENU_OPTION));
632 ASSERT (MenuOption);
633
634 MenuOption->Signature = UI_MENU_OPTION_SIGNATURE;
635 MenuOption->Description = String;
636 MenuOption->Handle = Handle;
637 MenuOption->ThisTag = Statement;
638 MenuOption->EntryNumber = MenuItemCount;
639
640 if (Index == 2) {
641 //
642 // Override LineNumber for the MenuOption in Date/Time sequence
643 //
644 MenuOption->Skip = 1;
645 } else {
646 MenuOption->Skip = NumberOfLines;
647 }
648 MenuOption->Sequence = Index;
649
650 if (Statement->GrayOutExpression != NULL) {
651 MenuOption->GrayOut = Statement->GrayOutExpression->Result.Value.b;
652 }
653
654 switch (Statement->Operand) {
655 case EFI_IFR_ORDERED_LIST_OP:
656 case EFI_IFR_ONE_OF_OP:
657 case EFI_IFR_NUMERIC_OP:
658 case EFI_IFR_TIME_OP:
659 case EFI_IFR_DATE_OP:
660 case EFI_IFR_CHECKBOX_OP:
661 case EFI_IFR_PASSWORD_OP:
662 case EFI_IFR_STRING_OP:
663 //
664 // User could change the value of these items
665 //
666 MenuOption->IsQuestion = TRUE;
667 break;
668
669 case EFI_IFR_TEXT_OP:
670 if (FeaturePcdGet (PcdBrowserGrayOutTextStatement)) {
671 //
672 // Initializing GrayOut option as TRUE for Text setup options
673 // so that those options will be Gray in colour and un selectable.
674 //
675 MenuOption->GrayOut = TRUE;
676 }
677
678 default:
679 MenuOption->IsQuestion = FALSE;
680 break;
681 }
682
683 if ((Statement->ValueExpression != NULL) ||
684 ((Statement->QuestionFlags & EFI_IFR_FLAG_READ_ONLY) != 0)) {
685 MenuOption->ReadOnly = TRUE;
686 }
687
688 InsertTailList (&gMenuOption, &MenuOption->Link);
689 }
690
691 return MenuOption;
692 }
693
694
695 /**
696 Routine used to abstract a generic dialog interface and return the selected key or string
697
698 @param NumberOfLines The number of lines for the dialog box
699 @param HotKey Defines whether a single character is parsed
700 (TRUE) and returned in KeyValue or a string is
701 returned in StringBuffer. Two special characters
702 are considered when entering a string, a SCAN_ESC
703 and an CHAR_CARRIAGE_RETURN. SCAN_ESC terminates
704 string input and returns
705 @param MaximumStringSize The maximum size in bytes of a typed in string
706 (each character is a CHAR16) and the minimum
707 string returned is two bytes
708 @param StringBuffer The passed in pointer to the buffer which will
709 hold the typed in string if HotKey is FALSE
710 @param KeyValue The EFI_KEY value returned if HotKey is TRUE..
711 @param ... A series of (quantity == NumberOfLines) text
712 strings which will be used to construct the dialog
713 box
714
715 @retval EFI_SUCCESS Displayed dialog and received user interaction
716 @retval EFI_INVALID_PARAMETER One of the parameters was invalid (e.g.
717 (StringBuffer == NULL) && (HotKey == FALSE))
718 @retval EFI_DEVICE_ERROR User typed in an ESC character to exit the routine
719
720 **/
721 EFI_STATUS
722 EFIAPI
723 CreateDialog (
724 IN UINTN NumberOfLines,
725 IN BOOLEAN HotKey,
726 IN UINTN MaximumStringSize,
727 OUT CHAR16 *StringBuffer,
728 OUT EFI_INPUT_KEY *KeyValue,
729 ...
730 )
731 {
732 VA_LIST Marker;
733 UINTN Count;
734 EFI_INPUT_KEY Key;
735 UINTN LargestString;
736 CHAR16 *TempString;
737 CHAR16 *BufferedString;
738 CHAR16 *StackString;
739 CHAR16 KeyPad[2];
740 UINTN Start;
741 UINTN Top;
742 UINTN Index;
743 EFI_STATUS Status;
744 BOOLEAN SelectionComplete;
745 UINTN InputOffset;
746 UINTN CurrentAttribute;
747 UINTN DimensionsWidth;
748 UINTN DimensionsHeight;
749
750 DimensionsWidth = gScreenDimensions.RightColumn - gScreenDimensions.LeftColumn;
751 DimensionsHeight = gScreenDimensions.BottomRow - gScreenDimensions.TopRow;
752
753 SelectionComplete = FALSE;
754 InputOffset = 0;
755 TempString = AllocateZeroPool (MaximumStringSize * 2);
756 BufferedString = AllocateZeroPool (MaximumStringSize * 2);
757 CurrentAttribute = gST->ConOut->Mode->Attribute;
758
759 ASSERT (TempString);
760 ASSERT (BufferedString);
761
762 VA_START (Marker, KeyValue);
763
764 //
765 // Zero the outgoing buffer
766 //
767 ZeroMem (StringBuffer, MaximumStringSize);
768
769 if (HotKey) {
770 if (KeyValue == NULL) {
771 return EFI_INVALID_PARAMETER;
772 }
773 } else {
774 if (StringBuffer == NULL) {
775 return EFI_INVALID_PARAMETER;
776 }
777 }
778 //
779 // Disable cursor
780 //
781 gST->ConOut->EnableCursor (gST->ConOut, FALSE);
782
783 LargestString = 0;
784
785 //
786 // Determine the largest string in the dialog box
787 // Notice we are starting with 1 since String is the first string
788 //
789 for (Count = 0; Count < NumberOfLines; Count++) {
790 StackString = VA_ARG (Marker, CHAR16 *);
791
792 if (StackString[0] == L' ') {
793 InputOffset = Count + 1;
794 }
795
796 if ((GetStringWidth (StackString) / 2) > LargestString) {
797 //
798 // Size of the string visually and subtract the width by one for the null-terminator
799 //
800 LargestString = (GetStringWidth (StackString) / 2);
801 }
802 }
803 VA_END (Marker);
804
805 Start = (DimensionsWidth - LargestString - 2) / 2 + gScreenDimensions.LeftColumn + 1;
806 Top = ((DimensionsHeight - NumberOfLines - 2) / 2) + gScreenDimensions.TopRow - 1;
807
808 Count = 0;
809
810 //
811 // Display the Popup
812 //
813 VA_START (Marker, KeyValue);
814 CreateSharedPopUp (LargestString, NumberOfLines, Marker);
815 VA_END (Marker);
816
817 //
818 // Take the first key typed and report it back?
819 //
820 if (HotKey) {
821 Status = WaitForKeyStroke (&Key);
822 ASSERT_EFI_ERROR (Status);
823 CopyMem (KeyValue, &Key, sizeof (EFI_INPUT_KEY));
824
825 } else {
826 do {
827 Status = WaitForKeyStroke (&Key);
828
829 switch (Key.UnicodeChar) {
830 case CHAR_NULL:
831 switch (Key.ScanCode) {
832 case SCAN_ESC:
833 FreePool (TempString);
834 FreePool (BufferedString);
835 gST->ConOut->SetAttribute (gST->ConOut, CurrentAttribute);
836 gST->ConOut->EnableCursor (gST->ConOut, TRUE);
837 return EFI_DEVICE_ERROR;
838
839 default:
840 break;
841 }
842
843 break;
844
845 case CHAR_CARRIAGE_RETURN:
846 SelectionComplete = TRUE;
847 FreePool (TempString);
848 FreePool (BufferedString);
849 gST->ConOut->SetAttribute (gST->ConOut, CurrentAttribute);
850 gST->ConOut->EnableCursor (gST->ConOut, TRUE);
851 return EFI_SUCCESS;
852 break;
853
854 case CHAR_BACKSPACE:
855 if (StringBuffer[0] != CHAR_NULL) {
856 for (Index = 0; StringBuffer[Index] != CHAR_NULL; Index++) {
857 TempString[Index] = StringBuffer[Index];
858 }
859 //
860 // Effectively truncate string by 1 character
861 //
862 TempString[Index - 1] = CHAR_NULL;
863 StrCpy (StringBuffer, TempString);
864 }
865
866 default:
867 //
868 // If it is the beginning of the string, don't worry about checking maximum limits
869 //
870 if ((StringBuffer[0] == CHAR_NULL) && (Key.UnicodeChar != CHAR_BACKSPACE)) {
871 StrnCpy (StringBuffer, &Key.UnicodeChar, 1);
872 StrnCpy (TempString, &Key.UnicodeChar, 1);
873 } else if ((GetStringWidth (StringBuffer) < MaximumStringSize) && (Key.UnicodeChar != CHAR_BACKSPACE)) {
874 KeyPad[0] = Key.UnicodeChar;
875 KeyPad[1] = CHAR_NULL;
876 StrCat (StringBuffer, KeyPad);
877 StrCat (TempString, KeyPad);
878 }
879 //
880 // If the width of the input string is now larger than the screen, we nee to
881 // adjust the index to start printing portions of the string
882 //
883 SetUnicodeMem (BufferedString, LargestString, L' ');
884
885 PrintStringAt (Start + 1, Top + InputOffset, BufferedString);
886
887 if ((GetStringWidth (StringBuffer) / 2) > (DimensionsWidth - 2)) {
888 Index = (GetStringWidth (StringBuffer) / 2) - DimensionsWidth + 2;
889 } else {
890 Index = 0;
891 }
892
893 for (Count = 0; Index + 1 < GetStringWidth (StringBuffer) / 2; Index++, Count++) {
894 BufferedString[Count] = StringBuffer[Index];
895 }
896
897 PrintStringAt (Start + 1, Top + InputOffset, BufferedString);
898 break;
899 }
900 } while (!SelectionComplete);
901 }
902
903 gST->ConOut->SetAttribute (gST->ConOut, CurrentAttribute);
904 gST->ConOut->EnableCursor (gST->ConOut, TRUE);
905 return EFI_SUCCESS;
906 }
907
908 /**
909 Draw a pop up windows based on the dimension, number of lines and
910 strings specified.
911
912 @param RequestedWidth The width of the pop-up.
913 @param NumberOfLines The number of lines.
914 @param Marker The variable argument list for the list of string to be printed.
915
916 **/
917 VOID
918 CreateSharedPopUp (
919 IN UINTN RequestedWidth,
920 IN UINTN NumberOfLines,
921 IN VA_LIST Marker
922 )
923 {
924 UINTN Index;
925 UINTN Count;
926 CHAR16 Character;
927 UINTN Start;
928 UINTN End;
929 UINTN Top;
930 UINTN Bottom;
931 CHAR16 *String;
932 UINTN DimensionsWidth;
933 UINTN DimensionsHeight;
934
935 DimensionsWidth = gScreenDimensions.RightColumn - gScreenDimensions.LeftColumn;
936 DimensionsHeight = gScreenDimensions.BottomRow - gScreenDimensions.TopRow;
937
938 gST->ConOut->SetAttribute (gST->ConOut, POPUP_TEXT | POPUP_BACKGROUND);
939
940 if ((RequestedWidth + 2) > DimensionsWidth) {
941 RequestedWidth = DimensionsWidth - 2;
942 }
943
944 //
945 // Subtract the PopUp width from total Columns, allow for one space extra on
946 // each end plus a border.
947 //
948 Start = (DimensionsWidth - RequestedWidth - 2) / 2 + gScreenDimensions.LeftColumn + 1;
949 End = Start + RequestedWidth + 1;
950
951 Top = ((DimensionsHeight - NumberOfLines - 2) / 2) + gScreenDimensions.TopRow - 1;
952 Bottom = Top + NumberOfLines + 2;
953
954 Character = BOXDRAW_DOWN_RIGHT;
955 PrintCharAt (Start, Top, Character);
956 Character = BOXDRAW_HORIZONTAL;
957 for (Index = Start; Index + 2 < End; Index++) {
958 PrintChar (Character);
959 }
960
961 Character = BOXDRAW_DOWN_LEFT;
962 PrintChar (Character);
963 Character = BOXDRAW_VERTICAL;
964
965 Count = 0;
966 for (Index = Top; Index + 2 < Bottom; Index++, Count++) {
967 String = VA_ARG (Marker, CHAR16*);
968
969 //
970 // This will clear the background of the line - we never know who might have been
971 // here before us. This differs from the next clear in that it used the non-reverse
972 // video for normal printing.
973 //
974 if (GetStringWidth (String) / 2 > 1) {
975 ClearLines (Start, End, Index + 1, Index + 1, POPUP_TEXT | POPUP_BACKGROUND);
976 }
977
978 //
979 // Passing in a space results in the assumption that this is where typing will occur
980 //
981 if (String[0] == L' ') {
982 ClearLines (Start + 1, End - 1, Index + 1, Index + 1, POPUP_INVERSE_TEXT | POPUP_INVERSE_BACKGROUND);
983 }
984
985 //
986 // Passing in a NULL results in a blank space
987 //
988 if (String[0] == CHAR_NULL) {
989 ClearLines (Start, End, Index + 1, Index + 1, POPUP_TEXT | POPUP_BACKGROUND);
990 }
991
992 PrintStringAt (
993 ((DimensionsWidth - GetStringWidth (String) / 2) / 2) + gScreenDimensions.LeftColumn + 1,
994 Index + 1,
995 String
996 );
997 gST->ConOut->SetAttribute (gST->ConOut, POPUP_TEXT | POPUP_BACKGROUND);
998 PrintCharAt (Start, Index + 1, Character);
999 PrintCharAt (End - 1, Index + 1, Character);
1000 }
1001
1002 Character = BOXDRAW_UP_RIGHT;
1003 PrintCharAt (Start, Bottom - 1, Character);
1004 Character = BOXDRAW_HORIZONTAL;
1005 for (Index = Start; Index + 2 < End; Index++) {
1006 PrintChar (Character);
1007 }
1008
1009 Character = BOXDRAW_UP_LEFT;
1010 PrintChar (Character);
1011 }
1012
1013 /**
1014 Draw a pop up windows based on the dimension, number of lines and
1015 strings specified.
1016
1017 @param RequestedWidth The width of the pop-up.
1018 @param NumberOfLines The number of lines.
1019 @param ... A series of text strings that displayed in the pop-up.
1020
1021 **/
1022 VOID
1023 EFIAPI
1024 CreateMultiStringPopUp (
1025 IN UINTN RequestedWidth,
1026 IN UINTN NumberOfLines,
1027 ...
1028 )
1029 {
1030 VA_LIST Marker;
1031
1032 VA_START (Marker, NumberOfLines);
1033
1034 CreateSharedPopUp (RequestedWidth, NumberOfLines, Marker);
1035
1036 VA_END (Marker);
1037 }
1038
1039
1040 /**
1041 Update status bar on the bottom of menu.
1042
1043 @param Selection Current Selction info.
1044 @param MessageType The type of message to be shown.
1045 @param Flags The flags in Question header.
1046 @param State Set or clear.
1047
1048 **/
1049 VOID
1050 UpdateStatusBar (
1051 IN UI_MENU_SELECTION *Selection,
1052 IN UINTN MessageType,
1053 IN UINT8 Flags,
1054 IN BOOLEAN State
1055 )
1056 {
1057 UINTN Index;
1058 CHAR16 *NvUpdateMessage;
1059 CHAR16 *InputErrorMessage;
1060
1061 NvUpdateMessage = GetToken (STRING_TOKEN (NV_UPDATE_MESSAGE), gHiiHandle);
1062 InputErrorMessage = GetToken (STRING_TOKEN (INPUT_ERROR_MESSAGE), gHiiHandle);
1063
1064 switch (MessageType) {
1065 case INPUT_ERROR:
1066 if (State) {
1067 gST->ConOut->SetAttribute (gST->ConOut, ERROR_TEXT);
1068 PrintStringAt (
1069 gScreenDimensions.LeftColumn + gPromptBlockWidth,
1070 gScreenDimensions.BottomRow - 1,
1071 InputErrorMessage
1072 );
1073 mInputError = TRUE;
1074 } else {
1075 gST->ConOut->SetAttribute (gST->ConOut, PcdGet8 (PcdBrowserFieldTextHighlightColor));
1076 for (Index = 0; Index < (GetStringWidth (InputErrorMessage) - 2) / 2; Index++) {
1077 PrintAt (gScreenDimensions.LeftColumn + gPromptBlockWidth + Index, gScreenDimensions.BottomRow - 1, L" ");
1078 }
1079
1080 mInputError = FALSE;
1081 }
1082 break;
1083
1084 case NV_UPDATE_REQUIRED:
1085 if ((gClassOfVfr & FORMSET_CLASS_FRONT_PAGE) != FORMSET_CLASS_FRONT_PAGE) {
1086 if (State) {
1087 gST->ConOut->SetAttribute (gST->ConOut, INFO_TEXT);
1088 PrintStringAt (
1089 gScreenDimensions.LeftColumn + gPromptBlockWidth + gOptionBlockWidth,
1090 gScreenDimensions.BottomRow - 1,
1091 NvUpdateMessage
1092 );
1093 gResetRequired = (BOOLEAN) (gResetRequired | ((Flags & EFI_IFR_FLAG_RESET_REQUIRED) == EFI_IFR_FLAG_RESET_REQUIRED));
1094
1095 if (Selection != NULL) {
1096 Selection->Form->NvUpdateRequired = TRUE;
1097 }
1098 } else {
1099 gST->ConOut->SetAttribute (gST->ConOut, PcdGet8 (PcdBrowserFieldTextHighlightColor));
1100 for (Index = 0; Index < (GetStringWidth (NvUpdateMessage) - 2) / 2; Index++) {
1101 PrintAt (
1102 (gScreenDimensions.LeftColumn + gPromptBlockWidth + gOptionBlockWidth + Index),
1103 gScreenDimensions.BottomRow - 1,
1104 L" "
1105 );
1106 }
1107
1108 if (Selection != NULL) {
1109 Selection->Form->NvUpdateRequired = FALSE;
1110 }
1111 }
1112 }
1113 break;
1114
1115 case REFRESH_STATUS_BAR:
1116 if (mInputError) {
1117 UpdateStatusBar (Selection, INPUT_ERROR, Flags, TRUE);
1118 }
1119
1120 if (IsNvUpdateRequired(Selection->FormSet)) {
1121 UpdateStatusBar (NULL, NV_UPDATE_REQUIRED, Flags, TRUE);
1122 }
1123 break;
1124
1125 default:
1126 break;
1127 }
1128
1129 FreePool (InputErrorMessage);
1130 FreePool (NvUpdateMessage);
1131 return ;
1132 }
1133
1134
1135 /**
1136 Get the supported width for a particular op-code
1137
1138 @param Statement The FORM_BROWSER_STATEMENT structure passed in.
1139 @param Handle The handle in the HII database being used
1140
1141 @return Returns the number of CHAR16 characters that is support.
1142
1143 **/
1144 UINT16
1145 GetWidth (
1146 IN FORM_BROWSER_STATEMENT *Statement,
1147 IN EFI_HII_HANDLE Handle
1148 )
1149 {
1150 CHAR16 *String;
1151 UINTN Size;
1152 UINT16 Width;
1153
1154 Size = 0;
1155
1156 //
1157 // See if the second text parameter is really NULL
1158 //
1159 if ((Statement->Operand == EFI_IFR_TEXT_OP) && (Statement->TextTwo != 0)) {
1160 String = GetToken (Statement->TextTwo, Handle);
1161 Size = StrLen (String);
1162 FreePool (String);
1163 }
1164
1165 if ((Statement->Operand == EFI_IFR_SUBTITLE_OP) ||
1166 (Statement->Operand == EFI_IFR_REF_OP) ||
1167 (Statement->Operand == EFI_IFR_PASSWORD_OP) ||
1168 (Statement->Operand == EFI_IFR_ACTION_OP) ||
1169 (Statement->Operand == EFI_IFR_RESET_BUTTON_OP) ||
1170 //
1171 // Allow a wide display if text op-code and no secondary text op-code
1172 //
1173 ((Statement->Operand == EFI_IFR_TEXT_OP) && (Size == 0))
1174 ) {
1175 Width = (UINT16) (gPromptBlockWidth + gOptionBlockWidth);
1176 } else {
1177 Width = (UINT16) gPromptBlockWidth;
1178 }
1179
1180 if (Statement->InSubtitle) {
1181 Width -= SUBTITLE_INDENT;
1182 }
1183
1184 return (UINT16) (Width - LEFT_SKIPPED_COLUMNS);
1185 }
1186
1187 /**
1188 Will copy LineWidth amount of a string in the OutputString buffer and return the
1189 number of CHAR16 characters that were copied into the OutputString buffer.
1190
1191 @param InputString String description for this option.
1192 @param LineWidth Width of the desired string to extract in CHAR16
1193 characters
1194 @param Index Where in InputString to start the copy process
1195 @param OutputString Buffer to copy the string into
1196
1197 @return Returns the number of CHAR16 characters that were copied into the OutputString buffer.
1198
1199 **/
1200 UINT16
1201 GetLineByWidth (
1202 IN CHAR16 *InputString,
1203 IN UINT16 LineWidth,
1204 IN OUT UINTN *Index,
1205 OUT CHAR16 **OutputString
1206 )
1207 {
1208 UINT16 Count;
1209 UINT16 Count2;
1210
1211 if (GetLineByWidthFinished) {
1212 GetLineByWidthFinished = FALSE;
1213 return (UINT16) 0;
1214 }
1215
1216 Count = LineWidth;
1217 Count2 = 0;
1218
1219 *OutputString = AllocateZeroPool (((UINTN) (LineWidth + 1) * 2));
1220
1221 //
1222 // Ensure we have got a valid buffer
1223 //
1224 if (*OutputString != NULL) {
1225
1226 //
1227 //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.
1228 //To avoid displaying this empty line in screen, just skip the two CHARs here.
1229 //
1230 if ((InputString[*Index] == NARROW_CHAR) && (InputString[*Index + 1] == CHAR_CARRIAGE_RETURN)) {
1231 *Index = *Index + 2;
1232 }
1233
1234 //
1235 // Fast-forward the string and see if there is a carriage-return in the string
1236 //
1237 for (; (InputString[*Index + Count2] != CHAR_CARRIAGE_RETURN) && (Count2 != LineWidth); Count2++)
1238 ;
1239
1240 //
1241 // Copy the desired LineWidth of data to the output buffer.
1242 // Also make sure that we don't copy more than the string.
1243 // Also make sure that if there are linefeeds, we account for them.
1244 //
1245 if ((StrSize (&InputString[*Index]) <= ((UINTN) (LineWidth + 1) * 2)) &&
1246 (StrSize (&InputString[*Index]) <= ((UINTN) (Count2 + 1) * 2))
1247 ) {
1248 //
1249 // Convert to CHAR16 value and show that we are done with this operation
1250 //
1251 LineWidth = (UINT16) ((StrSize (&InputString[*Index]) - 2) / 2);
1252 if (LineWidth != 0) {
1253 GetLineByWidthFinished = TRUE;
1254 }
1255 } else {
1256 if (Count2 == LineWidth) {
1257 //
1258 // Rewind the string from the maximum size until we see a space to break the line
1259 //
1260 for (; (InputString[*Index + LineWidth] != CHAR_SPACE) && (LineWidth != 0); LineWidth--)
1261 ;
1262 if (LineWidth == 0) {
1263 LineWidth = Count;
1264 }
1265 } else {
1266 LineWidth = Count2;
1267 }
1268 }
1269
1270 CopyMem (*OutputString, &InputString[*Index], LineWidth * 2);
1271
1272 //
1273 // If currently pointing to a space, increment the index to the first non-space character
1274 //
1275 for (;
1276 (InputString[*Index + LineWidth] == CHAR_SPACE) || (InputString[*Index + LineWidth] == CHAR_CARRIAGE_RETURN);
1277 (*Index)++
1278 )
1279 ;
1280 *Index = (UINT16) (*Index + LineWidth);
1281 return LineWidth;
1282 } else {
1283 return (UINT16) 0;
1284 }
1285 }
1286
1287
1288 /**
1289 Update display lines for a Menu Option.
1290
1291 @param Selection The user's selection.
1292 @param MenuOption The MenuOption to be checked.
1293 @param OptionalString The option string.
1294 @param SkipValue The number of lins to skip.
1295
1296 **/
1297 VOID
1298 UpdateOptionSkipLines (
1299 IN UI_MENU_SELECTION *Selection,
1300 IN UI_MENU_OPTION *MenuOption,
1301 OUT CHAR16 **OptionalString,
1302 IN UINTN SkipValue
1303 )
1304 {
1305 UINTN Index;
1306 UINT16 Width;
1307 UINTN Row;
1308 UINTN OriginalRow;
1309 CHAR16 *OutputString;
1310 CHAR16 *OptionString;
1311
1312 Row = 0;
1313 OptionString = *OptionalString;
1314 OutputString = NULL;
1315
1316 ProcessOptions (Selection, MenuOption, FALSE, &OptionString);
1317
1318 if (OptionString != NULL) {
1319 Width = (UINT16) gOptionBlockWidth;
1320
1321 OriginalRow = Row;
1322
1323 for (Index = 0; GetLineByWidth (OptionString, Width, &Index, &OutputString) != 0x0000;) {
1324 //
1325 // If there is more string to process print on the next row and increment the Skip value
1326 //
1327 if (StrLen (&OptionString[Index]) != 0) {
1328 if (SkipValue == 0) {
1329 Row++;
1330 //
1331 // Since the Number of lines for this menu entry may or may not be reflected accurately
1332 // since the prompt might be 1 lines and option might be many, and vice versa, we need to do
1333 // some testing to ensure we are keeping this in-sync.
1334 //
1335 // If the difference in rows is greater than or equal to the skip value, increase the skip value
1336 //
1337 if ((Row - OriginalRow) >= MenuOption->Skip) {
1338 MenuOption->Skip++;
1339 }
1340 }
1341 }
1342
1343 FreePool (OutputString);
1344 if (SkipValue != 0) {
1345 SkipValue--;
1346 }
1347 }
1348
1349 Row = OriginalRow;
1350 }
1351
1352 *OptionalString = OptionString;
1353 }
1354
1355
1356 /**
1357 Check whether this Menu Option could be highlighted.
1358
1359 This is an internal function.
1360
1361 @param MenuOption The MenuOption to be checked.
1362
1363 @retval TRUE This Menu Option is selectable.
1364 @retval FALSE This Menu Option could not be selected.
1365
1366 **/
1367 BOOLEAN
1368 IsSelectable (
1369 UI_MENU_OPTION *MenuOption
1370 )
1371 {
1372 if ((MenuOption->ThisTag->Operand == EFI_IFR_SUBTITLE_OP) ||
1373 MenuOption->GrayOut || MenuOption->ReadOnly) {
1374 return FALSE;
1375 } else {
1376 return TRUE;
1377 }
1378 }
1379
1380
1381 /**
1382 Determine if the menu is the last menu that can be selected.
1383
1384 This is an internal function.
1385
1386 @param Direction The scroll direction. False is down. True is up.
1387 @param CurrentPos The current focus.
1388
1389 @return FALSE -- the menu isn't the last menu that can be selected.
1390 @return TRUE -- the menu is the last menu that can be selected.
1391
1392 **/
1393 BOOLEAN
1394 ValueIsScroll (
1395 IN BOOLEAN Direction,
1396 IN LIST_ENTRY *CurrentPos
1397 )
1398 {
1399 LIST_ENTRY *Temp;
1400
1401 Temp = Direction ? CurrentPos->BackLink : CurrentPos->ForwardLink;
1402
1403 if (Temp == &gMenuOption) {
1404 return TRUE;
1405 }
1406
1407 return FALSE;
1408 }
1409
1410
1411 /**
1412 Move to next selectable statement.
1413
1414 This is an internal function.
1415
1416 @param GoUp The navigation direction. TRUE: up, FALSE: down.
1417 @param CurrentPosition Current position.
1418 @param GapToTop Gap position to top or bottom.
1419
1420 @return The row distance from current MenuOption to next selectable MenuOption.
1421
1422 **/
1423 INTN
1424 MoveToNextStatement (
1425 IN BOOLEAN GoUp,
1426 IN OUT LIST_ENTRY **CurrentPosition,
1427 IN UINTN GapToTop
1428 )
1429 {
1430 INTN Distance;
1431 LIST_ENTRY *Pos;
1432 UI_MENU_OPTION *NextMenuOption;
1433 UI_MENU_OPTION *PreMenuOption;
1434
1435 Distance = 0;
1436 Pos = *CurrentPosition;
1437 PreMenuOption = MENU_OPTION_FROM_LINK (Pos);
1438
1439 while (TRUE) {
1440 NextMenuOption = MENU_OPTION_FROM_LINK (Pos);
1441 if (GoUp && (PreMenuOption != NextMenuOption)) {
1442 //
1443 // Current Position doesn't need to be caculated when go up.
1444 // Caculate distanct at first when go up
1445 //
1446 if ((UINTN) Distance + NextMenuOption->Skip > GapToTop) {
1447 NextMenuOption = PreMenuOption;
1448 break;
1449 }
1450 Distance += NextMenuOption->Skip;
1451 }
1452 if (IsSelectable (NextMenuOption)) {
1453 break;
1454 }
1455 if ((GoUp ? Pos->BackLink : Pos->ForwardLink) == &gMenuOption) {
1456 //
1457 // Arrive at top.
1458 //
1459 Distance = -1;
1460 break;
1461 }
1462 if (!GoUp) {
1463 //
1464 // Caculate distanct at later when go down
1465 //
1466 if ((UINTN) Distance + NextMenuOption->Skip > GapToTop) {
1467 NextMenuOption = PreMenuOption;
1468 break;
1469 }
1470 Distance += NextMenuOption->Skip;
1471 }
1472 PreMenuOption = NextMenuOption;
1473 Pos = (GoUp ? Pos->BackLink : Pos->ForwardLink);
1474 }
1475
1476 *CurrentPosition = &NextMenuOption->Link;
1477 return Distance;
1478 }
1479
1480
1481 /**
1482 Adjust Data and Time position accordingly.
1483 Data format : [01/02/2004] [11:22:33]
1484 Line number : 0 0 1 0 0 1
1485
1486 This is an internal function.
1487
1488 @param DirectionUp the up or down direction. False is down. True is
1489 up.
1490 @param CurrentPosition Current position. On return: Point to the last
1491 Option (Year or Second) if up; Point to the first
1492 Option (Month or Hour) if down.
1493
1494 @return Return line number to pad. It is possible that we stand on a zero-advance
1495 @return data or time opcode, so pad one line when we judge if we are going to scroll outside.
1496
1497 **/
1498 UINTN
1499 AdjustDateAndTimePosition (
1500 IN BOOLEAN DirectionUp,
1501 IN OUT LIST_ENTRY **CurrentPosition
1502 )
1503 {
1504 UINTN Count;
1505 LIST_ENTRY *NewPosition;
1506 UI_MENU_OPTION *MenuOption;
1507 UINTN PadLineNumber;
1508
1509 PadLineNumber = 0;
1510 NewPosition = *CurrentPosition;
1511 MenuOption = MENU_OPTION_FROM_LINK (NewPosition);
1512
1513 if ((MenuOption->ThisTag->Operand == EFI_IFR_DATE_OP) ||
1514 (MenuOption->ThisTag->Operand == EFI_IFR_TIME_OP)) {
1515 //
1516 // Calculate the distance from current position to the last Date/Time MenuOption
1517 //
1518 Count = 0;
1519 while (MenuOption->Skip == 0) {
1520 Count++;
1521 NewPosition = NewPosition->ForwardLink;
1522 MenuOption = MENU_OPTION_FROM_LINK (NewPosition);
1523 PadLineNumber = 1;
1524 }
1525
1526 NewPosition = *CurrentPosition;
1527 if (DirectionUp) {
1528 //
1529 // Since the behavior of hitting the up arrow on a Date/Time MenuOption is intended
1530 // to be one that back to the previous set of MenuOptions, we need to advance to the first
1531 // Date/Time MenuOption and leave the remaining logic in CfUiUp intact so the appropriate
1532 // checking can be done.
1533 //
1534 while (Count++ < 2) {
1535 NewPosition = NewPosition->BackLink;
1536 }
1537 } else {
1538 //
1539 // Since the behavior of hitting the down arrow on a Date/Time MenuOption is intended
1540 // to be one that progresses to the next set of MenuOptions, we need to advance to the last
1541 // Date/Time MenuOption and leave the remaining logic in CfUiDown intact so the appropriate
1542 // checking can be done.
1543 //
1544 while (Count-- > 0) {
1545 NewPosition = NewPosition->ForwardLink;
1546 }
1547 }
1548
1549 *CurrentPosition = NewPosition;
1550 }
1551
1552 return PadLineNumber;
1553 }
1554
1555 /**
1556 Find HII Handle in the HII database associated with given Device Path.
1557
1558 If DevicePath is NULL, then ASSERT.
1559
1560 @param DevicePath Device Path associated with the HII package list
1561 handle.
1562
1563 @retval Handle HII package list Handle associated with the Device
1564 Path.
1565 @retval NULL Hii Package list handle is not found.
1566
1567 **/
1568 EFI_HII_HANDLE
1569 EFIAPI
1570 DevicePathToHiiHandle (
1571 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath
1572 )
1573 {
1574 EFI_STATUS Status;
1575 EFI_DEVICE_PATH_PROTOCOL *TmpDevicePath;
1576 UINTN BufferSize;
1577 UINTN HandleCount;
1578 UINTN Index;
1579 EFI_HANDLE Handle;
1580 EFI_HANDLE DriverHandle;
1581 EFI_HII_HANDLE *HiiHandles;
1582 EFI_HII_HANDLE HiiHandle;
1583
1584 ASSERT (DevicePath != NULL);
1585
1586 TmpDevicePath = DevicePath;
1587 //
1588 // Locate Device Path Protocol handle buffer
1589 //
1590 Status = gBS->LocateDevicePath (
1591 &gEfiDevicePathProtocolGuid,
1592 &TmpDevicePath,
1593 &DriverHandle
1594 );
1595 if (EFI_ERROR (Status) || !IsDevicePathEnd (TmpDevicePath)) {
1596 return NULL;
1597 }
1598
1599 //
1600 // Retrieve all HII Handles from HII database
1601 //
1602 BufferSize = 0x1000;
1603 HiiHandles = AllocatePool (BufferSize);
1604 ASSERT (HiiHandles != NULL);
1605 Status = mHiiDatabase->ListPackageLists (
1606 mHiiDatabase,
1607 EFI_HII_PACKAGE_TYPE_ALL,
1608 NULL,
1609 &BufferSize,
1610 HiiHandles
1611 );
1612 if (Status == EFI_BUFFER_TOO_SMALL) {
1613 FreePool (HiiHandles);
1614 HiiHandles = AllocatePool (BufferSize);
1615 ASSERT (HiiHandles != NULL);
1616
1617 Status = mHiiDatabase->ListPackageLists (
1618 mHiiDatabase,
1619 EFI_HII_PACKAGE_TYPE_ALL,
1620 NULL,
1621 &BufferSize,
1622 HiiHandles
1623 );
1624 }
1625
1626 if (EFI_ERROR (Status)) {
1627 FreePool (HiiHandles);
1628 return NULL;
1629 }
1630
1631 //
1632 // Search Hii Handle by Driver Handle
1633 //
1634 HiiHandle = NULL;
1635 HandleCount = BufferSize / sizeof (EFI_HII_HANDLE);
1636 for (Index = 0; Index < HandleCount; Index++) {
1637 Status = mHiiDatabase->GetPackageListHandle (
1638 mHiiDatabase,
1639 HiiHandles[Index],
1640 &Handle
1641 );
1642 if (!EFI_ERROR (Status) && (Handle == DriverHandle)) {
1643 HiiHandle = HiiHandles[Index];
1644 break;
1645 }
1646 }
1647
1648 FreePool (HiiHandles);
1649 return HiiHandle;
1650 }
1651
1652 /**
1653 Display menu and wait for user to select one menu option, then return it.
1654 If AutoBoot is enabled, then if user doesn't select any option,
1655 after period of time, it will automatically return the first menu option.
1656
1657 @param Selection Menu selection.
1658
1659 @retval EFI_SUCESSS This function always return successfully for now.
1660
1661 **/
1662 EFI_STATUS
1663 UiDisplayMenu (
1664 IN OUT UI_MENU_SELECTION *Selection
1665 )
1666 {
1667 INTN SkipValue;
1668 INTN Difference;
1669 INTN OldSkipValue;
1670 UINTN DistanceValue;
1671 UINTN Row;
1672 UINTN Col;
1673 UINTN Temp;
1674 UINTN Temp2;
1675 UINTN TopRow;
1676 UINTN BottomRow;
1677 UINTN OriginalRow;
1678 UINTN Index;
1679 UINT32 Count;
1680 UINT16 Width;
1681 CHAR16 *StringPtr;
1682 CHAR16 *OptionString;
1683 CHAR16 *OutputString;
1684 CHAR16 *FormattedString;
1685 BOOLEAN NewLine;
1686 BOOLEAN Repaint;
1687 BOOLEAN SavedValue;
1688 BOOLEAN UpArrow;
1689 BOOLEAN DownArrow;
1690 BOOLEAN InitializedFlag;
1691 EFI_STATUS Status;
1692 EFI_INPUT_KEY Key;
1693 LIST_ENTRY *Link;
1694 LIST_ENTRY *NewPos;
1695 LIST_ENTRY *TopOfScreen;
1696 LIST_ENTRY *SavedListEntry;
1697 UI_MENU_OPTION *MenuOption;
1698 UI_MENU_OPTION *NextMenuOption;
1699 UI_MENU_OPTION *SavedMenuOption;
1700 UI_MENU_OPTION *PreviousMenuOption;
1701 UI_CONTROL_FLAG ControlFlag;
1702 EFI_SCREEN_DESCRIPTOR LocalScreen;
1703 MENU_REFRESH_ENTRY *MenuRefreshEntry;
1704 MENU_REFRESH_ENTRY *MenuUpdateEntry;
1705 UI_SCREEN_OPERATION ScreenOperation;
1706 UINT8 MinRefreshInterval;
1707 UINTN BufferSize;
1708 UINT16 DefaultId;
1709 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
1710 FORM_BROWSER_STATEMENT *Statement;
1711 CHAR16 TemStr[2];
1712 UINT8 *DevicePathBuffer;
1713 UINT8 DigitUint8;
1714 UI_MENU_LIST *CurrentMenu;
1715 UI_MENU_LIST *MenuList;
1716 FORM_BROWSER_FORM *RefForm;
1717 UINTN ModalSkipColumn;
1718
1719 CopyMem (&LocalScreen, &gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));
1720
1721 Status = EFI_SUCCESS;
1722 FormattedString = NULL;
1723 OptionString = NULL;
1724 ScreenOperation = UiNoOperation;
1725 NewLine = TRUE;
1726 MinRefreshInterval = 0;
1727 DefaultId = 0;
1728
1729 OutputString = NULL;
1730 UpArrow = FALSE;
1731 DownArrow = FALSE;
1732 SkipValue = 0;
1733 OldSkipValue = 0;
1734 MenuRefreshEntry = gMenuRefreshHead;
1735
1736 NextMenuOption = NULL;
1737 PreviousMenuOption = NULL;
1738 SavedMenuOption = NULL;
1739 RefForm = NULL;
1740 ModalSkipColumn = (LocalScreen.RightColumn - LocalScreen.LeftColumn) / 6;
1741
1742 ZeroMem (&Key, sizeof (EFI_INPUT_KEY));
1743
1744 if ((gClassOfVfr & FORMSET_CLASS_FRONT_PAGE) == FORMSET_CLASS_FRONT_PAGE){
1745 TopRow = LocalScreen.TopRow + FRONT_PAGE_HEADER_HEIGHT + SCROLL_ARROW_HEIGHT;
1746 Row = LocalScreen.TopRow + FRONT_PAGE_HEADER_HEIGHT + SCROLL_ARROW_HEIGHT;
1747 } else {
1748 TopRow = LocalScreen.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT + SCROLL_ARROW_HEIGHT;
1749 Row = LocalScreen.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT + SCROLL_ARROW_HEIGHT;
1750 }
1751
1752 if (Selection->Form->ModalForm) {
1753 Col = LocalScreen.LeftColumn + LEFT_SKIPPED_COLUMNS + ModalSkipColumn;
1754 } else {
1755 Col = LocalScreen.LeftColumn + LEFT_SKIPPED_COLUMNS;
1756 }
1757
1758 BottomRow = LocalScreen.BottomRow - STATUS_BAR_HEIGHT - FOOTER_HEIGHT - SCROLL_ARROW_HEIGHT - 1;
1759
1760 Selection->TopRow = TopRow;
1761 Selection->BottomRow = BottomRow;
1762 Selection->PromptCol = Col;
1763 Selection->OptionCol = gPromptBlockWidth + 1 + LocalScreen.LeftColumn;
1764 Selection->Statement = NULL;
1765
1766 TopOfScreen = gMenuOption.ForwardLink;
1767 Repaint = TRUE;
1768 MenuOption = NULL;
1769
1770 //
1771 // Find current Menu
1772 //
1773 CurrentMenu = UiFindMenuList (&Selection->FormSetGuid, Selection->FormId);
1774 if (CurrentMenu == NULL) {
1775 //
1776 // Current menu not found, add it to the menu tree
1777 //
1778 CurrentMenu = UiAddMenuList (NULL, &Selection->FormSetGuid, Selection->FormId);
1779 }
1780 ASSERT (CurrentMenu != NULL);
1781 Selection->CurrentMenu = CurrentMenu;
1782
1783 if (Selection->QuestionId == 0) {
1784 //
1785 // Highlight not specified, fetch it from cached menu
1786 //
1787 Selection->QuestionId = CurrentMenu->QuestionId;
1788 }
1789
1790 //
1791 // Init option as the current user's selection
1792 //
1793 InitializedFlag = TRUE;
1794 NewPos = gMenuOption.ForwardLink;
1795
1796 gST->ConOut->EnableCursor (gST->ConOut, FALSE);
1797 UpdateStatusBar (Selection, REFRESH_STATUS_BAR, (UINT8) 0, TRUE);
1798
1799 ControlFlag = CfInitialization;
1800 Selection->Action = UI_ACTION_NONE;
1801 while (TRUE) {
1802 switch (ControlFlag) {
1803 case CfInitialization:
1804 if (IsListEmpty (&gMenuOption)) {
1805 ControlFlag = CfReadKey;
1806 } else {
1807 ControlFlag = CfCheckSelection;
1808 }
1809 break;
1810
1811 case CfCheckSelection:
1812 if (Selection->Action != UI_ACTION_NONE) {
1813 ControlFlag = CfExit;
1814 } else {
1815 ControlFlag = CfRepaint;
1816 }
1817 break;
1818
1819 case CfRepaint:
1820 ControlFlag = CfRefreshHighLight;
1821
1822 if (Repaint) {
1823 //
1824 // Display menu
1825 //
1826 DownArrow = FALSE;
1827 UpArrow = FALSE;
1828 Row = TopRow;
1829
1830 Temp = (UINTN) SkipValue;
1831 Temp2 = (UINTN) SkipValue;
1832
1833 if (Selection->Form->ModalForm) {
1834 ClearLines (
1835 LocalScreen.LeftColumn + ModalSkipColumn,
1836 LocalScreen.LeftColumn + ModalSkipColumn + gPromptBlockWidth + gOptionBlockWidth,
1837 TopRow - SCROLL_ARROW_HEIGHT,
1838 BottomRow + SCROLL_ARROW_HEIGHT,
1839 PcdGet8 (PcdBrowserFieldTextColor) | FIELD_BACKGROUND
1840 );
1841 } else {
1842 ClearLines (
1843 LocalScreen.LeftColumn,
1844 LocalScreen.RightColumn,
1845 TopRow - SCROLL_ARROW_HEIGHT,
1846 BottomRow + SCROLL_ARROW_HEIGHT,
1847 PcdGet8 (PcdBrowserFieldTextColor) | FIELD_BACKGROUND
1848 );
1849 }
1850 UiFreeRefreshList ();
1851 MinRefreshInterval = 0;
1852
1853 for (Link = TopOfScreen; Link != &gMenuOption; Link = Link->ForwardLink) {
1854 MenuOption = MENU_OPTION_FROM_LINK (Link);
1855 MenuOption->Row = Row;
1856 MenuOption->Col = Col;
1857 if (Selection->Form->ModalForm) {
1858 MenuOption->OptCol = gPromptBlockWidth + 1 + LocalScreen.LeftColumn + ModalSkipColumn;
1859 } else {
1860 MenuOption->OptCol = gPromptBlockWidth + 1 + LocalScreen.LeftColumn;
1861 }
1862
1863 Statement = MenuOption->ThisTag;
1864 if (Statement->InSubtitle) {
1865 MenuOption->Col += SUBTITLE_INDENT;
1866 }
1867
1868 if (MenuOption->GrayOut) {
1869 gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT_GRAYED | FIELD_BACKGROUND);
1870 } else {
1871 if (Statement->Operand == EFI_IFR_SUBTITLE_OP) {
1872 gST->ConOut->SetAttribute (gST->ConOut, PcdGet8 (PcdBrowserSubtitleTextColor) | FIELD_BACKGROUND);
1873 }
1874 }
1875
1876 Width = GetWidth (Statement, MenuOption->Handle);
1877 OriginalRow = Row;
1878
1879 if (Statement->Operand == EFI_IFR_REF_OP && MenuOption->Col >= 2) {
1880 //
1881 // Print Arrow for Goto button.
1882 //
1883 PrintAt (
1884 MenuOption->Col - 2,
1885 Row,
1886 L"%c",
1887 GEOMETRICSHAPE_RIGHT_TRIANGLE
1888 );
1889 }
1890
1891 for (Index = 0; GetLineByWidth (MenuOption->Description, Width, &Index, &OutputString) != 0x0000;) {
1892 if ((Temp == 0) && (Row <= BottomRow)) {
1893 PrintStringAt (MenuOption->Col, Row, OutputString);
1894 }
1895 //
1896 // If there is more string to process print on the next row and increment the Skip value
1897 //
1898 if (StrLen (&MenuOption->Description[Index]) != 0) {
1899 if (Temp == 0) {
1900 Row++;
1901 }
1902 }
1903
1904 FreePool (OutputString);
1905 if (Temp != 0) {
1906 Temp--;
1907 }
1908 }
1909
1910 Temp = 0;
1911 Row = OriginalRow;
1912
1913 Status = ProcessOptions (Selection, MenuOption, FALSE, &OptionString);
1914 if (EFI_ERROR (Status)) {
1915 //
1916 // Repaint to clear possible error prompt pop-up
1917 //
1918 Repaint = TRUE;
1919 NewLine = TRUE;
1920 ControlFlag = CfRepaint;
1921 break;
1922 }
1923
1924 if (OptionString != NULL) {
1925 if (Statement->Operand == EFI_IFR_DATE_OP || Statement->Operand == EFI_IFR_TIME_OP) {
1926 //
1927 // If leading spaces on OptionString - remove the spaces
1928 //
1929 for (Index = 0; OptionString[Index] == L' '; Index++) {
1930 MenuOption->OptCol++;
1931 }
1932
1933 for (Count = 0; OptionString[Index] != CHAR_NULL; Index++) {
1934 OptionString[Count] = OptionString[Index];
1935 Count++;
1936 }
1937
1938 OptionString[Count] = CHAR_NULL;
1939 }
1940
1941 Width = (UINT16) gOptionBlockWidth;
1942 OriginalRow = Row;
1943
1944 for (Index = 0; GetLineByWidth (OptionString, Width, &Index, &OutputString) != 0x0000;) {
1945 if ((Temp2 == 0) && (Row <= BottomRow)) {
1946 PrintStringAt (MenuOption->OptCol, Row, OutputString);
1947 }
1948 //
1949 // If there is more string to process print on the next row and increment the Skip value
1950 //
1951 if (StrLen (&OptionString[Index]) != 0) {
1952 if (Temp2 == 0) {
1953 Row++;
1954 //
1955 // Since the Number of lines for this menu entry may or may not be reflected accurately
1956 // since the prompt might be 1 lines and option might be many, and vice versa, we need to do
1957 // some testing to ensure we are keeping this in-sync.
1958 //
1959 // If the difference in rows is greater than or equal to the skip value, increase the skip value
1960 //
1961 if ((Row - OriginalRow) >= MenuOption->Skip) {
1962 MenuOption->Skip++;
1963 }
1964 }
1965 }
1966
1967 FreePool (OutputString);
1968 if (Temp2 != 0) {
1969 Temp2--;
1970 }
1971 }
1972
1973 Temp2 = 0;
1974 Row = OriginalRow;
1975
1976 FreePool (OptionString);
1977 }
1978
1979 //
1980 // If Question has refresh guid, register the op-code.
1981 //
1982 if (!CompareGuid (&Statement->RefreshGuid, &gZeroGuid)) {
1983 if (gMenuEventGuidRefreshHead == NULL) {
1984 MenuUpdateEntry = AllocateZeroPool (sizeof (MENU_REFRESH_ENTRY));
1985 gMenuEventGuidRefreshHead = MenuUpdateEntry;
1986 } else {
1987 MenuUpdateEntry = gMenuEventGuidRefreshHead;
1988 while (MenuUpdateEntry->Next != NULL) {
1989 MenuUpdateEntry = MenuUpdateEntry->Next;
1990 }
1991 MenuUpdateEntry->Next = AllocateZeroPool (sizeof (MENU_REFRESH_ENTRY));
1992 MenuUpdateEntry = MenuUpdateEntry->Next;
1993 }
1994 ASSERT (MenuUpdateEntry != NULL);
1995 Status = gBS->CreateEventEx (EVT_NOTIFY_SIGNAL, TPL_NOTIFY, RefreshQuestionNotify, MenuUpdateEntry, &Statement->RefreshGuid, &MenuUpdateEntry->Event);
1996 ASSERT (!EFI_ERROR (Status));
1997 MenuUpdateEntry->MenuOption = MenuOption;
1998 MenuUpdateEntry->Selection = Selection;
1999 MenuUpdateEntry->CurrentColumn = MenuOption->OptCol;
2000 MenuUpdateEntry->CurrentRow = MenuOption->Row;
2001 if (MenuOption->GrayOut) {
2002 MenuUpdateEntry->CurrentAttribute = FIELD_TEXT_GRAYED | FIELD_BACKGROUND;
2003 } else {
2004 MenuUpdateEntry->CurrentAttribute = PcdGet8 (PcdBrowserFieldTextColor) | FIELD_BACKGROUND;
2005 }
2006 }
2007
2008 //
2009 // If Question request refresh, register the op-code
2010 //
2011 if (Statement->RefreshInterval != 0) {
2012 //
2013 // Menu will be refreshed at minimal interval of all Questions
2014 // which have refresh request
2015 //
2016 if (MinRefreshInterval == 0 || Statement->RefreshInterval < MinRefreshInterval) {
2017 MinRefreshInterval = Statement->RefreshInterval;
2018 }
2019
2020 if (gMenuRefreshHead == NULL) {
2021 MenuRefreshEntry = AllocateZeroPool (sizeof (MENU_REFRESH_ENTRY));
2022 gMenuRefreshHead = MenuRefreshEntry;
2023 } else {
2024 MenuRefreshEntry = gMenuRefreshHead;
2025 while (MenuRefreshEntry->Next != NULL) {
2026 MenuRefreshEntry = MenuRefreshEntry->Next;
2027 }
2028 MenuRefreshEntry->Next = AllocateZeroPool (sizeof (MENU_REFRESH_ENTRY));
2029 MenuRefreshEntry = MenuRefreshEntry->Next;
2030 }
2031 ASSERT (MenuRefreshEntry != NULL);
2032 MenuRefreshEntry->MenuOption = MenuOption;
2033 MenuRefreshEntry->Selection = Selection;
2034 MenuRefreshEntry->CurrentColumn = MenuOption->OptCol;
2035 MenuRefreshEntry->CurrentRow = MenuOption->Row;
2036 if (MenuOption->GrayOut) {
2037 MenuRefreshEntry->CurrentAttribute = FIELD_TEXT_GRAYED | FIELD_BACKGROUND;
2038 } else {
2039 MenuRefreshEntry->CurrentAttribute = PcdGet8 (PcdBrowserFieldTextColor) | FIELD_BACKGROUND;
2040 }
2041 }
2042
2043 //
2044 // If this is a text op with secondary text information
2045 //
2046 if ((Statement->Operand == EFI_IFR_TEXT_OP) && (Statement->TextTwo != 0)) {
2047 StringPtr = GetToken (Statement->TextTwo, MenuOption->Handle);
2048
2049 Width = (UINT16) gOptionBlockWidth;
2050 OriginalRow = Row;
2051
2052 for (Index = 0; GetLineByWidth (StringPtr, Width, &Index, &OutputString) != 0x0000;) {
2053 if ((Temp == 0) && (Row <= BottomRow)) {
2054 PrintStringAt (MenuOption->OptCol, Row, OutputString);
2055 }
2056 //
2057 // If there is more string to process print on the next row and increment the Skip value
2058 //
2059 if (StrLen (&StringPtr[Index]) != 0) {
2060 if (Temp2 == 0) {
2061 Row++;
2062 //
2063 // Since the Number of lines for this menu entry may or may not be reflected accurately
2064 // since the prompt might be 1 lines and option might be many, and vice versa, we need to do
2065 // some testing to ensure we are keeping this in-sync.
2066 //
2067 // If the difference in rows is greater than or equal to the skip value, increase the skip value
2068 //
2069 if ((Row - OriginalRow) >= MenuOption->Skip) {
2070 MenuOption->Skip++;
2071 }
2072 }
2073 }
2074
2075 FreePool (OutputString);
2076 if (Temp2 != 0) {
2077 Temp2--;
2078 }
2079 }
2080
2081 Row = OriginalRow;
2082 FreePool (StringPtr);
2083 }
2084 gST->ConOut->SetAttribute (gST->ConOut, PcdGet8 (PcdBrowserFieldTextColor) | FIELD_BACKGROUND);
2085
2086 //
2087 // Need to handle the bottom of the display
2088 //
2089 if (MenuOption->Skip > 1) {
2090 Row += MenuOption->Skip - SkipValue;
2091 SkipValue = 0;
2092 } else {
2093 Row += MenuOption->Skip;
2094 }
2095
2096 if (Row > BottomRow) {
2097 if (!ValueIsScroll (FALSE, Link)) {
2098 DownArrow = TRUE;
2099 }
2100
2101 Row = BottomRow + 1;
2102 break;
2103 }
2104 }
2105
2106 if (!ValueIsScroll (TRUE, TopOfScreen)) {
2107 UpArrow = TRUE;
2108 }
2109
2110 if (UpArrow) {
2111 gST->ConOut->SetAttribute (gST->ConOut, ARROW_TEXT | ARROW_BACKGROUND);
2112 PrintAt (
2113 LocalScreen.LeftColumn + gPromptBlockWidth + gOptionBlockWidth + 1,
2114 TopRow - SCROLL_ARROW_HEIGHT,
2115 L"%c",
2116 ARROW_UP
2117 );
2118 gST->ConOut->SetAttribute (gST->ConOut, PcdGet8 (PcdBrowserFieldTextColor) | FIELD_BACKGROUND);
2119 }
2120
2121 if (DownArrow) {
2122 gST->ConOut->SetAttribute (gST->ConOut, ARROW_TEXT | ARROW_BACKGROUND);
2123 PrintAt (
2124 LocalScreen.LeftColumn + gPromptBlockWidth + gOptionBlockWidth + 1,
2125 BottomRow + SCROLL_ARROW_HEIGHT,
2126 L"%c",
2127 ARROW_DOWN
2128 );
2129 gST->ConOut->SetAttribute (gST->ConOut, PcdGet8 (PcdBrowserFieldTextColor) | FIELD_BACKGROUND);
2130 }
2131
2132 MenuOption = NULL;
2133 }
2134 break;
2135
2136 case CfRefreshHighLight:
2137 //
2138 // MenuOption: Last menu option that need to remove hilight
2139 // MenuOption is set to NULL in Repaint
2140 // NewPos: Current menu option that need to hilight
2141 //
2142 ControlFlag = CfUpdateHelpString;
2143 if (InitializedFlag) {
2144 InitializedFlag = FALSE;
2145 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);
2146 }
2147
2148 //
2149 // Repaint flag is normally reset when finish processing CfUpdateHelpString. Temporarily
2150 // reset Repaint flag because we may break halfway and skip CfUpdateHelpString processing.
2151 //
2152 SavedValue = Repaint;
2153 Repaint = FALSE;
2154
2155 if (Selection->QuestionId != 0) {
2156 NewPos = gMenuOption.ForwardLink;
2157 SavedMenuOption = MENU_OPTION_FROM_LINK (NewPos);
2158
2159 while (SavedMenuOption->ThisTag->QuestionId != Selection->QuestionId && NewPos->ForwardLink != &gMenuOption) {
2160 NewPos = NewPos->ForwardLink;
2161 SavedMenuOption = MENU_OPTION_FROM_LINK (NewPos);
2162 }
2163 if (SavedMenuOption->ThisTag->QuestionId == Selection->QuestionId) {
2164 //
2165 // Target Question found, find its MenuOption
2166 //
2167 Link = TopOfScreen;
2168
2169 for (Index = TopRow; Index <= BottomRow && Link != NewPos;) {
2170 SavedMenuOption = MENU_OPTION_FROM_LINK (Link);
2171 Index += SavedMenuOption->Skip;
2172 Link = Link->ForwardLink;
2173 }
2174
2175 if (Link != NewPos || Index > BottomRow) {
2176 //
2177 // NewPos is not in the current page, simply scroll page so that NewPos is in the end of the page
2178 //
2179 Link = NewPos;
2180 for (Index = TopRow; Index <= BottomRow; ) {
2181 Link = Link->BackLink;
2182 SavedMenuOption = MENU_OPTION_FROM_LINK (Link);
2183 Index += SavedMenuOption->Skip;
2184 }
2185 TopOfScreen = Link->ForwardLink;
2186
2187 Repaint = TRUE;
2188 NewLine = TRUE;
2189 ControlFlag = CfRepaint;
2190 break;
2191 }
2192 } else {
2193 //
2194 // Target Question not found, highlight the default menu option
2195 //
2196 NewPos = TopOfScreen;
2197 }
2198
2199 Selection->QuestionId = 0;
2200 }
2201
2202 if (NewPos != NULL && (MenuOption == NULL || NewPos != &MenuOption->Link)) {
2203 if (MenuOption != NULL) {
2204 //
2205 // Remove highlight on last Menu Option
2206 //
2207 gST->ConOut->SetCursorPosition (gST->ConOut, MenuOption->Col, MenuOption->Row);
2208 ProcessOptions (Selection, MenuOption, FALSE, &OptionString);
2209 gST->ConOut->SetAttribute (gST->ConOut, PcdGet8 (PcdBrowserFieldTextColor) | FIELD_BACKGROUND);
2210 if (OptionString != NULL) {
2211 if ((MenuOption->ThisTag->Operand == EFI_IFR_DATE_OP) ||
2212 (MenuOption->ThisTag->Operand == EFI_IFR_TIME_OP)
2213 ) {
2214 //
2215 // If leading spaces on OptionString - remove the spaces
2216 //
2217 for (Index = 0; OptionString[Index] == L' '; Index++)
2218 ;
2219
2220 for (Count = 0; OptionString[Index] != CHAR_NULL; Index++) {
2221 OptionString[Count] = OptionString[Index];
2222 Count++;
2223 }
2224
2225 OptionString[Count] = CHAR_NULL;
2226 }
2227
2228 Width = (UINT16) gOptionBlockWidth;
2229 OriginalRow = MenuOption->Row;
2230
2231 for (Index = 0; GetLineByWidth (OptionString, Width, &Index, &OutputString) != 0x0000;) {
2232 if (MenuOption->Row >= TopRow && MenuOption->Row <= BottomRow) {
2233 PrintStringAt (MenuOption->OptCol, MenuOption->Row, OutputString);
2234 }
2235 //
2236 // If there is more string to process print on the next row and increment the Skip value
2237 //
2238 if (StrLen (&OptionString[Index]) != 0) {
2239 MenuOption->Row++;
2240 }
2241
2242 FreePool (OutputString);
2243 }
2244
2245 MenuOption->Row = OriginalRow;
2246
2247 FreePool (OptionString);
2248 } else {
2249 if (NewLine) {
2250 if (MenuOption->GrayOut) {
2251 gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT_GRAYED | FIELD_BACKGROUND);
2252 } else if (MenuOption->ThisTag->Operand == EFI_IFR_SUBTITLE_OP) {
2253 gST->ConOut->SetAttribute (gST->ConOut, PcdGet8 (PcdBrowserSubtitleTextColor) | FIELD_BACKGROUND);
2254 }
2255
2256 OriginalRow = MenuOption->Row;
2257 Width = GetWidth (MenuOption->ThisTag, MenuOption->Handle);
2258
2259 for (Index = 0; GetLineByWidth (MenuOption->Description, Width, &Index, &OutputString) != 0x0000;) {
2260 if (MenuOption->Row >= TopRow && MenuOption->Row <= BottomRow) {
2261 PrintStringAt (MenuOption->Col, MenuOption->Row, OutputString);
2262 }
2263 //
2264 // If there is more string to process print on the next row and increment the Skip value
2265 //
2266 if (StrLen (&MenuOption->Description[Index]) != 0) {
2267 MenuOption->Row++;
2268 }
2269
2270 FreePool (OutputString);
2271 }
2272
2273 MenuOption->Row = OriginalRow;
2274 gST->ConOut->SetAttribute (gST->ConOut, PcdGet8 (PcdBrowserFieldTextColor) | FIELD_BACKGROUND);
2275 }
2276 }
2277 }
2278
2279 //
2280 // This is the current selected statement
2281 //
2282 MenuOption = MENU_OPTION_FROM_LINK (NewPos);
2283 Statement = MenuOption->ThisTag;
2284 Selection->Statement = Statement;
2285 if (!IsSelectable (MenuOption)) {
2286 Repaint = SavedValue;
2287 UpdateKeyHelp (Selection, MenuOption, FALSE);
2288 break;
2289 }
2290
2291 //
2292 // Record highlight for current menu
2293 //
2294 CurrentMenu->QuestionId = Statement->QuestionId;
2295
2296 //
2297 // Set reverse attribute
2298 //
2299 gST->ConOut->SetAttribute (gST->ConOut, PcdGet8 (PcdBrowserFieldTextHighlightColor) | PcdGet8 (PcdBrowserFieldBackgroundHighlightColor));
2300 gST->ConOut->SetCursorPosition (gST->ConOut, MenuOption->Col, MenuOption->Row);
2301
2302 //
2303 // Assuming that we have a refresh linked-list created, lets annotate the
2304 // appropriate entry that we are highlighting with its new attribute. Just prior to this
2305 // lets reset all of the entries' attribute so we do not get multiple highlights in he refresh
2306 //
2307 if (gMenuRefreshHead != NULL) {
2308 for (MenuRefreshEntry = gMenuRefreshHead; MenuRefreshEntry != NULL; MenuRefreshEntry = MenuRefreshEntry->Next) {
2309 if (MenuRefreshEntry->MenuOption->GrayOut) {
2310 MenuRefreshEntry->CurrentAttribute = FIELD_TEXT_GRAYED | FIELD_BACKGROUND;
2311 } else {
2312 MenuRefreshEntry->CurrentAttribute = PcdGet8 (PcdBrowserFieldTextColor) | FIELD_BACKGROUND;
2313 }
2314 if (MenuRefreshEntry->MenuOption == MenuOption) {
2315 MenuRefreshEntry->CurrentAttribute = PcdGet8 (PcdBrowserFieldTextHighlightColor) | PcdGet8 (PcdBrowserFieldBackgroundHighlightColor);
2316 }
2317 }
2318 }
2319
2320 ProcessOptions (Selection, MenuOption, FALSE, &OptionString);
2321 if (OptionString != NULL) {
2322 if (Statement->Operand == EFI_IFR_DATE_OP || Statement->Operand == EFI_IFR_TIME_OP) {
2323 //
2324 // If leading spaces on OptionString - remove the spaces
2325 //
2326 for (Index = 0; OptionString[Index] == L' '; Index++)
2327 ;
2328
2329 for (Count = 0; OptionString[Index] != CHAR_NULL; Index++) {
2330 OptionString[Count] = OptionString[Index];
2331 Count++;
2332 }
2333
2334 OptionString[Count] = CHAR_NULL;
2335 }
2336 Width = (UINT16) gOptionBlockWidth;
2337
2338 OriginalRow = MenuOption->Row;
2339
2340 for (Index = 0; GetLineByWidth (OptionString, Width, &Index, &OutputString) != 0x0000;) {
2341 if (MenuOption->Row >= TopRow && MenuOption->Row <= BottomRow) {
2342 PrintStringAt (MenuOption->OptCol, MenuOption->Row, OutputString);
2343 }
2344 //
2345 // If there is more string to process print on the next row and increment the Skip value
2346 //
2347 if (StrLen (&OptionString[Index]) != 0) {
2348 MenuOption->Row++;
2349 }
2350
2351 FreePool (OutputString);
2352 }
2353
2354 MenuOption->Row = OriginalRow;
2355
2356 FreePool (OptionString);
2357 } else {
2358 if (NewLine) {
2359 OriginalRow = MenuOption->Row;
2360
2361 Width = GetWidth (Statement, MenuOption->Handle);
2362
2363 for (Index = 0; GetLineByWidth (MenuOption->Description, Width, &Index, &OutputString) != 0x0000;) {
2364 if (MenuOption->Row >= TopRow && MenuOption->Row <= BottomRow) {
2365 PrintStringAt (MenuOption->Col, MenuOption->Row, OutputString);
2366 }
2367 //
2368 // If there is more string to process print on the next row and increment the Skip value
2369 //
2370 if (StrLen (&MenuOption->Description[Index]) != 0) {
2371 MenuOption->Row++;
2372 }
2373
2374 FreePool (OutputString);
2375 }
2376
2377 MenuOption->Row = OriginalRow;
2378
2379 }
2380 }
2381
2382 UpdateKeyHelp (Selection, MenuOption, FALSE);
2383
2384 //
2385 // Clear reverse attribute
2386 //
2387 gST->ConOut->SetAttribute (gST->ConOut, PcdGet8 (PcdBrowserFieldTextColor) | FIELD_BACKGROUND);
2388 }
2389 //
2390 // Repaint flag will be used when process CfUpdateHelpString, so restore its value
2391 // if we didn't break halfway when process CfRefreshHighLight.
2392 //
2393 Repaint = SavedValue;
2394 break;
2395
2396 case CfUpdateHelpString:
2397 ControlFlag = CfPrepareToReadKey;
2398 if (Selection->Form->ModalForm) {
2399 break;
2400 }
2401
2402 if (Repaint || NewLine) {
2403 //
2404 // Don't print anything if it is a NULL help token
2405 //
2406 ASSERT(MenuOption != NULL);
2407 if (MenuOption->ThisTag->Help == 0 || !IsSelectable (MenuOption)) {
2408 StringPtr = L"\0";
2409 } else {
2410 StringPtr = GetToken (MenuOption->ThisTag->Help, MenuOption->Handle);
2411 }
2412
2413 ProcessHelpString (StringPtr, &FormattedString, BottomRow - TopRow);
2414
2415 gST->ConOut->SetAttribute (gST->ConOut, HELP_TEXT | FIELD_BACKGROUND);
2416
2417 for (Index = 0; Index < BottomRow - TopRow; Index++) {
2418 //
2419 // Pad String with spaces to simulate a clearing of the previous line
2420 //
2421 for (; GetStringWidth (&FormattedString[Index * gHelpBlockWidth * 2]) / 2 < gHelpBlockWidth;) {
2422 StrCat (&FormattedString[Index * gHelpBlockWidth * 2], L" ");
2423 }
2424
2425 PrintStringAt (
2426 LocalScreen.RightColumn - gHelpBlockWidth,
2427 Index + TopRow,
2428 &FormattedString[Index * gHelpBlockWidth * 2]
2429 );
2430 }
2431 }
2432 //
2433 // Reset this flag every time we finish using it.
2434 //
2435 Repaint = FALSE;
2436 NewLine = FALSE;
2437 break;
2438
2439 case CfPrepareToReadKey:
2440 ControlFlag = CfReadKey;
2441 ScreenOperation = UiNoOperation;
2442 break;
2443
2444 case CfReadKey:
2445 ControlFlag = CfScreenOperation;
2446
2447 //
2448 // Wait for user's selection
2449 //
2450 do {
2451 Status = UiWaitForSingleEvent (gST->ConIn->WaitForKey, 0, MinRefreshInterval);
2452 } while (Status == EFI_TIMEOUT);
2453
2454 if (Selection->Action == UI_ACTION_REFRESH_FORMSET) {
2455 //
2456 // IFR is updated in Callback of refresh opcode, re-parse it
2457 //
2458 Selection->Statement = NULL;
2459 return EFI_SUCCESS;
2460 }
2461
2462 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
2463 //
2464 // If we encounter error, continue to read another key in.
2465 //
2466 if (EFI_ERROR (Status)) {
2467 ControlFlag = CfReadKey;
2468 break;
2469 }
2470
2471 switch (Key.UnicodeChar) {
2472 case CHAR_CARRIAGE_RETURN:
2473 ScreenOperation = UiSelect;
2474 gDirection = 0;
2475 break;
2476
2477 //
2478 // We will push the adjustment of these numeric values directly to the input handler
2479 // NOTE: we won't handle manual input numeric
2480 //
2481 case '+':
2482 case '-':
2483 //
2484 // If the screen has no menu items, and the user didn't select UiReset
2485 // ignore the selection and go back to reading keys.
2486 //
2487 if(IsListEmpty (&gMenuOption)) {
2488 ControlFlag = CfReadKey;
2489 break;
2490 }
2491
2492 ASSERT(MenuOption != NULL);
2493 Statement = MenuOption->ThisTag;
2494 if ((Statement->Operand == EFI_IFR_DATE_OP)
2495 || (Statement->Operand == EFI_IFR_TIME_OP)
2496 || ((Statement->Operand == EFI_IFR_NUMERIC_OP) && (Statement->Step != 0))
2497 ){
2498 if (Key.UnicodeChar == '+') {
2499 gDirection = SCAN_RIGHT;
2500 } else {
2501 gDirection = SCAN_LEFT;
2502 }
2503 Status = ProcessOptions (Selection, MenuOption, TRUE, &OptionString);
2504 if (EFI_ERROR (Status)) {
2505 //
2506 // Repaint to clear possible error prompt pop-up
2507 //
2508 Repaint = TRUE;
2509 NewLine = TRUE;
2510 } else {
2511 Selection->Action = UI_ACTION_REFRESH_FORM;
2512 }
2513 if (OptionString != NULL) {
2514 FreePool (OptionString);
2515 }
2516 }
2517 break;
2518
2519 case '^':
2520 ScreenOperation = UiUp;
2521 break;
2522
2523 case 'V':
2524 case 'v':
2525 ScreenOperation = UiDown;
2526 break;
2527
2528 case ' ':
2529 if ((gClassOfVfr & FORMSET_CLASS_FRONT_PAGE) != FORMSET_CLASS_FRONT_PAGE) {
2530 //
2531 // If the screen has no menu items, and the user didn't select UiReset
2532 // ignore the selection and go back to reading keys.
2533 //
2534 if(IsListEmpty (&gMenuOption)) {
2535 ControlFlag = CfReadKey;
2536 break;
2537 }
2538
2539 ASSERT(MenuOption != NULL);
2540 if (MenuOption->ThisTag->Operand == EFI_IFR_CHECKBOX_OP && !MenuOption->GrayOut) {
2541 ScreenOperation = UiSelect;
2542 }
2543 }
2544 break;
2545
2546 case CHAR_NULL:
2547 if (((Key.ScanCode == SCAN_F9) && ((gFunctionKeySetting & FUNCTION_NINE) != FUNCTION_NINE)) ||
2548 ((Key.ScanCode == SCAN_F10) && ((gFunctionKeySetting & FUNCTION_TEN) != FUNCTION_TEN))
2549 ) {
2550 //
2551 // If the function key has been disabled, just ignore the key.
2552 //
2553 } else {
2554 for (Index = 0; Index < sizeof (gScanCodeToOperation) / sizeof (gScanCodeToOperation[0]); Index++) {
2555 if (Selection->Form->ModalForm &&
2556 (Key.ScanCode == SCAN_F9 || Key.ScanCode == SCAN_F10 || Key.ScanCode == SCAN_ESC)) {
2557 ControlFlag = CfReadKey;
2558 break;
2559 }
2560
2561 if (Key.ScanCode == gScanCodeToOperation[Index].ScanCode) {
2562 if (Key.ScanCode == SCAN_F9) {
2563 //
2564 // Reset to standard default
2565 //
2566 DefaultId = EFI_HII_DEFAULT_CLASS_STANDARD;
2567 }
2568 ScreenOperation = gScanCodeToOperation[Index].ScreenOperation;
2569 break;
2570 }
2571 }
2572 }
2573 break;
2574 }
2575 break;
2576
2577 case CfScreenOperation:
2578 if (ScreenOperation != UiReset) {
2579 //
2580 // If the screen has no menu items, and the user didn't select UiReset
2581 // ignore the selection and go back to reading keys.
2582 //
2583 if (IsListEmpty (&gMenuOption)) {
2584 ControlFlag = CfReadKey;
2585 break;
2586 }
2587 }
2588
2589 for (Index = 0;
2590 Index < sizeof (gScreenOperationToControlFlag) / sizeof (gScreenOperationToControlFlag[0]);
2591 Index++
2592 ) {
2593 if (ScreenOperation == gScreenOperationToControlFlag[Index].ScreenOperation) {
2594 ControlFlag = gScreenOperationToControlFlag[Index].ControlFlag;
2595 break;
2596 }
2597 }
2598 break;
2599
2600 case CfUiSelect:
2601 ControlFlag = CfCheckSelection;
2602
2603 ASSERT(MenuOption != NULL);
2604 Statement = MenuOption->ThisTag;
2605 if (Statement->Operand == EFI_IFR_TEXT_OP) {
2606 break;
2607 }
2608
2609 //
2610 // Keep highlight on current MenuOption
2611 //
2612 Selection->QuestionId = Statement->QuestionId;
2613
2614 switch (Statement->Operand) {
2615 case EFI_IFR_REF_OP:
2616 if (Statement->RefDevicePath != 0) {
2617 if (Selection->Form->ModalForm) {
2618 break;
2619 }
2620 //
2621 // Goto another Hii Package list
2622 //
2623 Selection->Action = UI_ACTION_REFRESH_FORMSET;
2624
2625 StringPtr = GetToken (Statement->RefDevicePath, Selection->FormSet->HiiHandle);
2626 if (StringPtr == NULL) {
2627 //
2628 // No device path string not found, exit
2629 //
2630 Selection->Action = UI_ACTION_EXIT;
2631 Selection->Statement = NULL;
2632 break;
2633 }
2634 BufferSize = StrLen (StringPtr) / 2;
2635 DevicePath = AllocatePool (BufferSize);
2636 ASSERT (DevicePath != NULL);
2637
2638 //
2639 // Convert from Device Path String to DevicePath Buffer in the reverse order.
2640 //
2641 DevicePathBuffer = (UINT8 *) DevicePath;
2642 for (Index = 0; StringPtr[Index] != L'\0'; Index ++) {
2643 TemStr[0] = StringPtr[Index];
2644 DigitUint8 = (UINT8) StrHexToUint64 (TemStr);
2645 if (DigitUint8 == 0 && TemStr[0] != L'0') {
2646 //
2647 // Invalid Hex Char as the tail.
2648 //
2649 break;
2650 }
2651 if ((Index & 1) == 0) {
2652 DevicePathBuffer [Index/2] = DigitUint8;
2653 } else {
2654 DevicePathBuffer [Index/2] = (UINT8) ((DevicePathBuffer [Index/2] << 4) + DigitUint8);
2655 }
2656 }
2657
2658 Selection->Handle = DevicePathToHiiHandle (DevicePath);
2659 if (Selection->Handle == NULL) {
2660 //
2661 // If target Hii Handle not found, exit
2662 //
2663 Selection->Action = UI_ACTION_EXIT;
2664 Selection->Statement = NULL;
2665 break;
2666 }
2667
2668 FreePool (StringPtr);
2669 FreePool (DevicePath);
2670
2671 CopyMem (&Selection->FormSetGuid, &Statement->RefFormSetId, sizeof (EFI_GUID));
2672 Selection->FormId = Statement->RefFormId;
2673 Selection->QuestionId = Statement->RefQuestionId;
2674 } else if (!CompareGuid (&Statement->RefFormSetId, &gZeroGuid)) {
2675 if (Selection->Form->ModalForm) {
2676 break;
2677 }
2678 //
2679 // Goto another Formset, check for uncommitted data
2680 //
2681 Selection->Action = UI_ACTION_REFRESH_FORMSET;
2682
2683 CopyMem (&Selection->FormSetGuid, &Statement->RefFormSetId, sizeof (EFI_GUID));
2684 Selection->FormId = Statement->RefFormId;
2685 Selection->QuestionId = Statement->RefQuestionId;
2686 } else if (Statement->RefFormId != 0) {
2687 //
2688 // Check whether target From is suppressed.
2689 //
2690 RefForm = IdToForm (Selection->FormSet, Statement->RefFormId);
2691
2692 if ((RefForm != NULL) && (RefForm->SuppressExpression != NULL)) {
2693 Status = EvaluateExpression (Selection->FormSet, RefForm, RefForm->SuppressExpression);
2694 if (EFI_ERROR (Status)) {
2695 return Status;
2696 }
2697
2698 if (RefForm->SuppressExpression->Result.Value.b) {
2699 //
2700 // Form is suppressed.
2701 //
2702 do {
2703 CreateDialog (4, TRUE, 0, NULL, &Key, gEmptyString, gFormSuppress, gPressEnter, gEmptyString);
2704 } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);
2705
2706 Repaint = TRUE;
2707 break;
2708 }
2709 }
2710
2711 //
2712 // Goto another form inside this formset,
2713 //
2714 Selection->Action = UI_ACTION_REFRESH_FORM;
2715
2716 //
2717 // Link current form so that we can always go back when someone hits the ESC
2718 //
2719 MenuList = UiFindMenuList (&Selection->FormSetGuid, Statement->RefFormId);
2720 if (MenuList == NULL) {
2721 MenuList = UiAddMenuList (CurrentMenu, &Selection->FormSetGuid, Statement->RefFormId);
2722 }
2723
2724 Selection->FormId = Statement->RefFormId;
2725 Selection->QuestionId = Statement->RefQuestionId;
2726 } else if (Statement->RefQuestionId != 0) {
2727 //
2728 // Goto another Question
2729 //
2730 Selection->QuestionId = Statement->RefQuestionId;
2731
2732 if ((Statement->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != 0) {
2733 Selection->Action = UI_ACTION_REFRESH_FORM;
2734 } else {
2735 Repaint = TRUE;
2736 NewLine = TRUE;
2737 break;
2738 }
2739 }
2740 break;
2741
2742 case EFI_IFR_ACTION_OP:
2743 //
2744 // Process the Config string <ConfigResp>
2745 //
2746 Status = ProcessQuestionConfig (Selection, Statement);
2747
2748 if (EFI_ERROR (Status)) {
2749 break;
2750 }
2751
2752 //
2753 // The action button may change some Question value, so refresh the form
2754 //
2755 Selection->Action = UI_ACTION_REFRESH_FORM;
2756 break;
2757
2758 case EFI_IFR_RESET_BUTTON_OP:
2759 //
2760 // Reset Question to default value specified by DefaultId
2761 //
2762 ControlFlag = CfUiDefault;
2763 DefaultId = Statement->DefaultId;
2764 break;
2765
2766 default:
2767 //
2768 // Editable Questions: oneof, ordered list, checkbox, numeric, string, password
2769 //
2770 UpdateKeyHelp (Selection, MenuOption, TRUE);
2771 Status = ProcessOptions (Selection, MenuOption, TRUE, &OptionString);
2772
2773 if (EFI_ERROR (Status)) {
2774 Repaint = TRUE;
2775 NewLine = TRUE;
2776 UpdateKeyHelp (Selection, MenuOption, FALSE);
2777 } else {
2778 Selection->Action = UI_ACTION_REFRESH_FORM;
2779 }
2780
2781 if (OptionString != NULL) {
2782 FreePool (OptionString);
2783 }
2784 break;
2785 }
2786 break;
2787
2788 case CfUiReset:
2789 //
2790 // We come here when someone press ESC
2791 //
2792 ControlFlag = CfCheckSelection;
2793 if (FindNextMenu (Selection, &Repaint, &NewLine)) {
2794 return EFI_SUCCESS;
2795 }
2796 break;
2797
2798 case CfUiLeft:
2799 ControlFlag = CfCheckSelection;
2800 ASSERT(MenuOption != NULL);
2801 if ((MenuOption->ThisTag->Operand == EFI_IFR_DATE_OP) || (MenuOption->ThisTag->Operand == EFI_IFR_TIME_OP)) {
2802 if (MenuOption->Sequence != 0) {
2803 //
2804 // In the middle or tail of the Date/Time op-code set, go left.
2805 //
2806 ASSERT(NewPos != NULL);
2807 NewPos = NewPos->BackLink;
2808 }
2809 }
2810 break;
2811
2812 case CfUiRight:
2813 ControlFlag = CfCheckSelection;
2814 ASSERT(MenuOption != NULL);
2815 if ((MenuOption->ThisTag->Operand == EFI_IFR_DATE_OP) || (MenuOption->ThisTag->Operand == EFI_IFR_TIME_OP)) {
2816 if (MenuOption->Sequence != 2) {
2817 //
2818 // In the middle or tail of the Date/Time op-code set, go left.
2819 //
2820 ASSERT(NewPos != NULL);
2821 NewPos = NewPos->ForwardLink;
2822 }
2823 }
2824 break;
2825
2826 case CfUiUp:
2827 ControlFlag = CfCheckSelection;
2828
2829 SavedListEntry = NewPos;
2830
2831 ASSERT(NewPos != NULL);
2832 //
2833 // Adjust Date/Time position before we advance forward.
2834 //
2835 AdjustDateAndTimePosition (TRUE, &NewPos);
2836 if (NewPos->BackLink != &gMenuOption) {
2837 MenuOption = MENU_OPTION_FROM_LINK (NewPos);
2838 NewLine = TRUE;
2839 NewPos = NewPos->BackLink;
2840
2841 PreviousMenuOption = MENU_OPTION_FROM_LINK (NewPos);
2842 DistanceValue = PreviousMenuOption->Skip;
2843 Difference = 0;
2844 if (MenuOption->Row >= DistanceValue + TopRow) {
2845 Difference = MoveToNextStatement (TRUE, &NewPos, MenuOption->Row - TopRow - DistanceValue);
2846 }
2847 NextMenuOption = MENU_OPTION_FROM_LINK (NewPos);
2848
2849 ASSERT (MenuOption != NULL);
2850 if (Difference < 0) {
2851 //
2852 // We hit the begining MenuOption that can be focused
2853 // so we simply scroll to the top.
2854 //
2855 if (TopOfScreen != gMenuOption.ForwardLink) {
2856 TopOfScreen = gMenuOption.ForwardLink;
2857 Repaint = TRUE;
2858 } else {
2859 //
2860 // Scroll up to the last page when we have arrived at top page.
2861 //
2862 NewPos = &gMenuOption;
2863 TopOfScreen = &gMenuOption;
2864 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);
2865 ScreenOperation = UiPageUp;
2866 ControlFlag = CfScreenOperation;
2867 break;
2868 }
2869 } else if (MenuOption->Row < TopRow + DistanceValue + Difference) {
2870 //
2871 // Previous focus MenuOption is above the TopOfScreen, so we need to scroll
2872 //
2873 TopOfScreen = NewPos;
2874 Repaint = TRUE;
2875 SkipValue = 0;
2876 OldSkipValue = 0;
2877 } else if (!IsSelectable (NextMenuOption)) {
2878 //
2879 // Continue to go up until scroll to next page or the selectable option is found.
2880 //
2881 ScreenOperation = UiUp;
2882 ControlFlag = CfScreenOperation;
2883 }
2884
2885 //
2886 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.
2887 //
2888 AdjustDateAndTimePosition (TRUE, &TopOfScreen);
2889 AdjustDateAndTimePosition (TRUE, &NewPos);
2890 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);
2891 UpdateStatusBar (Selection, INPUT_ERROR, MenuOption->ThisTag->QuestionFlags, FALSE);
2892 } else {
2893 //
2894 // Scroll up to the last page.
2895 //
2896 NewPos = &gMenuOption;
2897 TopOfScreen = &gMenuOption;
2898 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);
2899 ScreenOperation = UiPageUp;
2900 ControlFlag = CfScreenOperation;
2901 }
2902 break;
2903
2904 case CfUiPageUp:
2905 ControlFlag = CfCheckSelection;
2906
2907 ASSERT(NewPos != NULL);
2908 if (NewPos->BackLink == &gMenuOption) {
2909 NewLine = FALSE;
2910 Repaint = FALSE;
2911 break;
2912 }
2913
2914 NewLine = TRUE;
2915 Repaint = TRUE;
2916 Link = TopOfScreen;
2917 Index = BottomRow;
2918 while ((Index >= TopRow) && (Link->BackLink != &gMenuOption)) {
2919 Link = Link->BackLink;
2920 PreviousMenuOption = MENU_OPTION_FROM_LINK (Link);
2921 if (Index < PreviousMenuOption->Skip) {
2922 Index = 0;
2923 break;
2924 }
2925 Index = Index - PreviousMenuOption->Skip;
2926 }
2927
2928 if ((Link->BackLink == &gMenuOption) && (Index >= TopRow)) {
2929 if (TopOfScreen == &gMenuOption) {
2930 TopOfScreen = gMenuOption.ForwardLink;
2931 NewPos = gMenuOption.BackLink;
2932 MoveToNextStatement (TRUE, &NewPos, BottomRow - TopRow);
2933 Repaint = FALSE;
2934 } else if (TopOfScreen != Link) {
2935 TopOfScreen = Link;
2936 NewPos = Link;
2937 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);
2938 } else {
2939 //
2940 // Finally we know that NewPos is the last MenuOption can be focused.
2941 //
2942 Repaint = FALSE;
2943 NewPos = Link;
2944 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);
2945 }
2946 } else {
2947 if (Index + 1 < TopRow) {
2948 //
2949 // Back up the previous option.
2950 //
2951 Link = Link->ForwardLink;
2952 }
2953
2954 //
2955 // Move to the option in Next page.
2956 //
2957 if (TopOfScreen == &gMenuOption) {
2958 NewPos = gMenuOption.BackLink;
2959 MoveToNextStatement (TRUE, &NewPos, BottomRow - TopRow);
2960 } else {
2961 NewPos = Link;
2962 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);
2963 }
2964
2965 //
2966 // There are more MenuOption needing scrolling up.
2967 //
2968 TopOfScreen = Link;
2969 MenuOption = NULL;
2970 }
2971
2972 //
2973 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.
2974 // Don't do this when we are already in the first page.
2975 //
2976 AdjustDateAndTimePosition (TRUE, &TopOfScreen);
2977 AdjustDateAndTimePosition (TRUE, &NewPos);
2978 break;
2979
2980 case CfUiPageDown:
2981 ControlFlag = CfCheckSelection;
2982
2983 ASSERT (NewPos != NULL);
2984 if (NewPos->ForwardLink == &gMenuOption) {
2985 NewLine = FALSE;
2986 Repaint = FALSE;
2987 break;
2988 }
2989
2990 NewLine = TRUE;
2991 Repaint = TRUE;
2992 Link = TopOfScreen;
2993 NextMenuOption = MENU_OPTION_FROM_LINK (Link);
2994 Index = TopRow;
2995 while ((Index <= BottomRow) && (Link->ForwardLink != &gMenuOption)) {
2996 Index = Index + NextMenuOption->Skip;
2997 Link = Link->ForwardLink;
2998 NextMenuOption = MENU_OPTION_FROM_LINK (Link);
2999 }
3000
3001 if ((Link->ForwardLink == &gMenuOption) && (Index <= BottomRow)) {
3002 //
3003 // Finally we know that NewPos is the last MenuOption can be focused.
3004 //
3005 Repaint = FALSE;
3006 MoveToNextStatement (TRUE, &Link, Index - TopRow);
3007 } else {
3008 if (Index - 1 > BottomRow) {
3009 //
3010 // Back up the previous option.
3011 //
3012 Link = Link->BackLink;
3013 }
3014 //
3015 // There are more MenuOption needing scrolling down.
3016 //
3017 TopOfScreen = Link;
3018 MenuOption = NULL;
3019 //
3020 // Move to the option in Next page.
3021 //
3022 MoveToNextStatement (FALSE, &Link, BottomRow - TopRow);
3023 }
3024
3025 //
3026 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.
3027 // Don't do this when we are already in the last page.
3028 //
3029 NewPos = Link;
3030 AdjustDateAndTimePosition (TRUE, &TopOfScreen);
3031 AdjustDateAndTimePosition (TRUE, &NewPos);
3032 break;
3033
3034 case CfUiDown:
3035 ControlFlag = CfCheckSelection;
3036 //
3037 // Since the behavior of hitting the down arrow on a Date/Time op-code is intended
3038 // to be one that progresses to the next set of op-codes, we need to advance to the last
3039 // Date/Time op-code and leave the remaining logic in UiDown intact so the appropriate
3040 // checking can be done. The only other logic we need to introduce is that if a Date/Time
3041 // op-code is the last entry in the menu, we need to rewind back to the first op-code of
3042 // the Date/Time op-code.
3043 //
3044 SavedListEntry = NewPos;
3045 AdjustDateAndTimePosition (FALSE, &NewPos);
3046
3047 if (NewPos->ForwardLink != &gMenuOption) {
3048 MenuOption = MENU_OPTION_FROM_LINK (NewPos);
3049 NewLine = TRUE;
3050 NewPos = NewPos->ForwardLink;
3051
3052 Difference = 0;
3053 if (BottomRow >= MenuOption->Row + MenuOption->Skip) {
3054 Difference = MoveToNextStatement (FALSE, &NewPos, BottomRow - MenuOption->Row - MenuOption->Skip);
3055 //
3056 // We hit the end of MenuOption that can be focused
3057 // so we simply scroll to the first page.
3058 //
3059 if (Difference < 0) {
3060 //
3061 // Scroll to the first page.
3062 //
3063 if (TopOfScreen != gMenuOption.ForwardLink) {
3064 TopOfScreen = gMenuOption.ForwardLink;
3065 Repaint = TRUE;
3066 MenuOption = NULL;
3067 } else {
3068 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);
3069 }
3070 NewPos = gMenuOption.ForwardLink;
3071 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);
3072
3073 //
3074 // If we are at the end of the list and sitting on a Date/Time op, rewind to the head.
3075 //
3076 AdjustDateAndTimePosition (TRUE, &TopOfScreen);
3077 AdjustDateAndTimePosition (TRUE, &NewPos);
3078 break;
3079 }
3080 }
3081 NextMenuOption = MENU_OPTION_FROM_LINK (NewPos);
3082
3083 //
3084 // An option might be multi-line, so we need to reflect that data in the overall skip value
3085 //
3086 UpdateOptionSkipLines (Selection, NextMenuOption, &OptionString, (UINTN) SkipValue);
3087 DistanceValue = Difference + NextMenuOption->Skip;
3088
3089 Temp = MenuOption->Row + MenuOption->Skip + DistanceValue - 1;
3090 if ((MenuOption->Row + MenuOption->Skip == BottomRow + 1) &&
3091 (NextMenuOption->ThisTag->Operand == EFI_IFR_DATE_OP ||
3092 NextMenuOption->ThisTag->Operand == EFI_IFR_TIME_OP)
3093 ) {
3094 Temp ++;
3095 }
3096
3097 //
3098 // If we are going to scroll, update TopOfScreen
3099 //
3100 if (Temp > BottomRow) {
3101 do {
3102 //
3103 // Is the current top of screen a zero-advance op-code?
3104 // If so, keep moving forward till we hit a >0 advance op-code
3105 //
3106 SavedMenuOption = MENU_OPTION_FROM_LINK (TopOfScreen);
3107
3108 //
3109 // If bottom op-code is more than one line or top op-code is more than one line
3110 //
3111 if ((DistanceValue > 1) || (MenuOption->Skip > 1)) {
3112 //
3113 // Is the bottom op-code greater than or equal in size to the top op-code?
3114 //
3115 if ((Temp - BottomRow) >= (SavedMenuOption->Skip - OldSkipValue)) {
3116 //
3117 // Skip the top op-code
3118 //
3119 TopOfScreen = TopOfScreen->ForwardLink;
3120 Difference = (Temp - BottomRow) - (SavedMenuOption->Skip - OldSkipValue);
3121
3122 OldSkipValue = Difference;
3123
3124 SavedMenuOption = MENU_OPTION_FROM_LINK (TopOfScreen);
3125
3126 //
3127 // If we have a remainder, skip that many more op-codes until we drain the remainder
3128 //
3129 while (Difference >= (INTN) SavedMenuOption->Skip) {
3130 //
3131 // Since the Difference is greater than or equal to this op-code's skip value, skip it
3132 //
3133 Difference = Difference - (INTN) SavedMenuOption->Skip;
3134 TopOfScreen = TopOfScreen->ForwardLink;
3135 SavedMenuOption = MENU_OPTION_FROM_LINK (TopOfScreen);
3136 }
3137 //
3138 // Since we will act on this op-code in the next routine, and increment the
3139 // SkipValue, set the skips to one less than what is required.
3140 //
3141 SkipValue = Difference - 1;
3142
3143 } else {
3144 //
3145 // Since we will act on this op-code in the next routine, and increment the
3146 // SkipValue, set the skips to one less than what is required.
3147 //
3148 SkipValue = OldSkipValue + (Temp - BottomRow) - 1;
3149 }
3150 } else {
3151 if ((OldSkipValue + 1) == (INTN) SavedMenuOption->Skip) {
3152 TopOfScreen = TopOfScreen->ForwardLink;
3153 break;
3154 } else {
3155 SkipValue = OldSkipValue;
3156 }
3157 }
3158 //
3159 // If the op-code at the top of the screen is more than one line, let's not skip it yet
3160 // Let's set a skip flag to smoothly scroll the top of the screen.
3161 //
3162 if (SavedMenuOption->Skip > 1) {
3163 if (SavedMenuOption == NextMenuOption) {
3164 SkipValue = 0;
3165 } else {
3166 SkipValue++;
3167 }
3168 } else if (SavedMenuOption->Skip == 1) {
3169 SkipValue = 0;
3170 } else {
3171 SkipValue = 0;
3172 TopOfScreen = TopOfScreen->ForwardLink;
3173 }
3174 } while (SavedMenuOption->Skip == 0);
3175
3176 Repaint = TRUE;
3177 OldSkipValue = SkipValue;
3178 } else if (!IsSelectable (NextMenuOption)) {
3179 //
3180 // Continue to go down until scroll to next page or the selectable option is found.
3181 //
3182 ScreenOperation = UiDown;
3183 ControlFlag = CfScreenOperation;
3184 }
3185
3186 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);
3187
3188 UpdateStatusBar (Selection, INPUT_ERROR, MenuOption->ThisTag->QuestionFlags, FALSE);
3189
3190 } else {
3191 //
3192 // Scroll to the first page.
3193 //
3194 if (TopOfScreen != gMenuOption.ForwardLink) {
3195 TopOfScreen = gMenuOption.ForwardLink;
3196 Repaint = TRUE;
3197 MenuOption = NULL;
3198 } else {
3199 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);
3200 }
3201 NewLine = TRUE;
3202 NewPos = gMenuOption.ForwardLink;
3203 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow);
3204 }
3205
3206 //
3207 // If we are at the end of the list and sitting on a Date/Time op, rewind to the head.
3208 //
3209 AdjustDateAndTimePosition (TRUE, &TopOfScreen);
3210 AdjustDateAndTimePosition (TRUE, &NewPos);
3211 break;
3212
3213 case CfUiSave:
3214 ControlFlag = CfCheckSelection;
3215
3216 //
3217 // Submit the form
3218 //
3219 Status = SubmitForm (Selection->FormSet, Selection->Form, FALSE);
3220
3221 if (!EFI_ERROR (Status)) {
3222 ASSERT(MenuOption != NULL);
3223 UpdateStatusBar (Selection, INPUT_ERROR, MenuOption->ThisTag->QuestionFlags, FALSE);
3224 UpdateStatusBar (Selection, NV_UPDATE_REQUIRED, MenuOption->ThisTag->QuestionFlags, FALSE);
3225 } else {
3226 do {
3227 CreateDialog (4, TRUE, 0, NULL, &Key, gEmptyString, gSaveFailed, gPressEnter, gEmptyString);
3228 } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);
3229
3230 Repaint = TRUE;
3231 NewLine = TRUE;
3232 }
3233 break;
3234
3235 case CfUiDefault:
3236 ControlFlag = CfCheckSelection;
3237 if (!Selection->FormEditable) {
3238 //
3239 // This Form is not editable, ignore the F9 (reset to default)
3240 //
3241 break;
3242 }
3243
3244 Status = ExtractFormDefault (Selection->FormSet, Selection->Form, DefaultId);
3245
3246 if (!EFI_ERROR (Status)) {
3247 Selection->Action = UI_ACTION_REFRESH_FORM;
3248 Selection->Statement = NULL;
3249
3250 //
3251 // Show NV update flag on status bar
3252 //
3253 UpdateNvInfoInForm(Selection->FormSet, TRUE);
3254 gResetRequired = TRUE;
3255 }
3256 break;
3257
3258 case CfUiNoOperation:
3259 ControlFlag = CfCheckSelection;
3260 break;
3261
3262 case CfExit:
3263 UiFreeRefreshList ();
3264
3265 gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_LIGHTGRAY, EFI_BLACK));
3266 gST->ConOut->SetCursorPosition (gST->ConOut, 0, Row + 4);
3267 gST->ConOut->EnableCursor (gST->ConOut, TRUE);
3268 gST->ConOut->OutputString (gST->ConOut, L"\n");
3269
3270 return EFI_SUCCESS;
3271
3272 default:
3273 break;
3274 }
3275 }
3276 }
EFI Development Kit II mirror for PVE