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