2 Utility functions for UI presentation.
4 Copyright (c) 2004 - 2013, 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
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.
17 BOOLEAN mHiiPackageListUpdated
;
18 UI_MENU_SELECTION
*gCurrentSelection
;
19 EFI_HII_HANDLE mCurrentHiiHandle
= NULL
;
20 EFI_GUID mCurrentFormSetGuid
= {0, 0, 0, {0, 0, 0, 0, 0, 0, 0, 0}};
21 UINT16 mCurrentFormId
= 0;
24 Clear retangle with specified text attribute.
26 @param LeftColumn Left column of retangle.
27 @param RightColumn Right column of retangle.
28 @param TopRow Start row of retangle.
29 @param BottomRow End row of retangle.
30 @param TextAttribute The character foreground and background.
39 IN UINTN TextAttribute
46 // For now, allocate an arbitrarily long buffer
48 Buffer
= AllocateZeroPool (0x10000);
49 ASSERT (Buffer
!= NULL
);
52 // Set foreground and background as defined
54 gST
->ConOut
->SetAttribute (gST
->ConOut
, TextAttribute
);
57 // Much faster to buffer the long string instead of print it a character at a time
59 SetUnicodeMem (Buffer
, RightColumn
- LeftColumn
, L
' ');
62 // Clear the desired area with the appropriate foreground/background
64 for (Row
= TopRow
; Row
<= BottomRow
; Row
++) {
65 PrintStringAt (LeftColumn
, Row
, Buffer
);
68 gST
->ConOut
->SetCursorPosition (gST
->ConOut
, LeftColumn
, TopRow
);
75 Concatenate a narrow string to another string.
77 @param Destination The destination string.
78 @param Source The source string. The string to be concatenated.
79 to the end of Destination.
84 IN OUT CHAR16
*Destination
,
90 for (Length
= 0; Destination
[Length
] != 0; Length
++)
94 // We now have the length of the original string
95 // We can safely assume for now that we are concatenating a narrow value to this string.
96 // For instance, the string is "XYZ" and cat'ing ">"
97 // If this assumption changes, we need to make this routine a bit more complex
99 Destination
[Length
] = NARROW_CHAR
;
102 StrCpy (Destination
+ Length
, Source
);
106 Count the storage space of a Unicode string.
108 This function handles the Unicode string with NARROW_CHAR
109 and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR
110 does not count in the resultant output. If a WIDE_CHAR is
111 hit, then 2 Unicode character will consume an output storage
112 space with size of CHAR16 till a NARROW_CHAR is hit.
114 If String is NULL, then ASSERT ().
116 @param String The input string to be counted.
118 @return Storage space for the input string.
128 UINTN IncrementValue
;
130 ASSERT (String
!= NULL
);
131 if (String
== NULL
) {
141 // Advance to the null-terminator or to the first width directive
144 (String
[Index
] != NARROW_CHAR
) && (String
[Index
] != WIDE_CHAR
) && (String
[Index
] != 0);
145 Index
++, Count
= Count
+ IncrementValue
150 // We hit the null-terminator, we now have a count
152 if (String
[Index
] == 0) {
156 // We encountered a narrow directive - strip it from the size calculation since it doesn't get printed
157 // and also set the flag that determines what we increment by.(if narrow, increment by 1, if wide increment by 2)
159 if (String
[Index
] == NARROW_CHAR
) {
161 // Skip to the next character
167 // Skip to the next character
172 } while (String
[Index
] != 0);
175 // Increment by one to include the null-terminator in the size
179 return Count
* sizeof (CHAR16
);
183 This function displays the page frame.
185 @param Selection Selection contains the information about
186 the Selection, form and formset to be displayed.
187 Selection action may be updated in retrieve callback.
191 IN UI_MENU_SELECTION
*Selection
199 CHAR16
*StrFrontPageBanner
;
201 EFI_SCREEN_DESCRIPTOR LocalScreen
;
205 ZeroMem (&LocalScreen
, sizeof (EFI_SCREEN_DESCRIPTOR
));
206 gST
->ConOut
->QueryMode (gST
->ConOut
, gST
->ConOut
->Mode
->Mode
, &LocalScreen
.RightColumn
, &LocalScreen
.BottomRow
);
207 ClearLines (0, LocalScreen
.RightColumn
, 0, LocalScreen
.BottomRow
, KEYHELP_BACKGROUND
);
209 if (Selection
->Form
->ModalForm
) {
213 CopyMem (&LocalScreen
, &gScreenDimensions
, sizeof (EFI_SCREEN_DESCRIPTOR
));
216 // For now, allocate an arbitrarily long buffer
218 Buffer
= AllocateZeroPool (0x10000);
219 ASSERT (Buffer
!= NULL
);
221 Character
= BOXDRAW_HORIZONTAL
;
223 for (Index
= 0; Index
+ 2 < (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
); Index
++) {
224 Buffer
[Index
] = Character
;
227 if ((gClassOfVfr
& FORMSET_CLASS_FRONT_PAGE
) == FORMSET_CLASS_FRONT_PAGE
) {
229 // ClearLines(0, LocalScreen.RightColumn, 0, BANNER_HEIGHT-1, BANNER_TEXT | BANNER_BACKGROUND);
232 LocalScreen
.LeftColumn
,
233 LocalScreen
.RightColumn
,
235 FRONT_PAGE_HEADER_HEIGHT
- 1 + LocalScreen
.TopRow
,
236 BANNER_TEXT
| BANNER_BACKGROUND
239 // for (Line = 0; Line < BANNER_HEIGHT; Line++) {
241 for (Line
= (UINT8
) LocalScreen
.TopRow
; Line
< BANNER_HEIGHT
+ (UINT8
) LocalScreen
.TopRow
; Line
++) {
243 // for (Alignment = 0; Alignment < BANNER_COLUMNS; Alignment++) {
245 for (Alignment
= (UINT8
) LocalScreen
.LeftColumn
;
246 Alignment
< BANNER_COLUMNS
+ (UINT8
) LocalScreen
.LeftColumn
;
249 RowIdx
= (UINT8
) (Line
- (UINT8
) LocalScreen
.TopRow
);
250 ColumnIdx
= (UINT8
) (Alignment
- (UINT8
) LocalScreen
.LeftColumn
);
252 ASSERT (RowIdx
< BANNER_HEIGHT
);
253 ASSERT (ColumnIdx
< BANNER_COLUMNS
);
255 if (gBannerData
->Banner
[RowIdx
][ColumnIdx
] != 0x0000) {
256 StrFrontPageBanner
= GetToken (
257 gBannerData
->Banner
[RowIdx
][ColumnIdx
],
264 switch (Alignment
- LocalScreen
.LeftColumn
) {
267 // Handle left column
269 PrintStringAt (LocalScreen
.LeftColumn
+ BANNER_LEFT_COLUMN_INDENT
, Line
, StrFrontPageBanner
);
274 // Handle center column
277 LocalScreen
.LeftColumn
+ (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
) / 3,
285 // Handle right column
288 LocalScreen
.LeftColumn
+ (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
) * 2 / 3,
295 FreePool (StrFrontPageBanner
);
301 LocalScreen
.LeftColumn
,
302 LocalScreen
.RightColumn
,
303 LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- gFooterHeight
,
304 LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- 1,
305 KEYHELP_TEXT
| KEYHELP_BACKGROUND
308 if ((gClassOfVfr
& FORMSET_CLASS_FRONT_PAGE
) != FORMSET_CLASS_FRONT_PAGE
) {
310 LocalScreen
.LeftColumn
,
311 LocalScreen
.RightColumn
,
313 LocalScreen
.TopRow
+ NONE_FRONT_PAGE_HEADER_HEIGHT
- 1,
314 TITLE_TEXT
| TITLE_BACKGROUND
317 // Print Top border line
318 // +------------------------------------------------------------------------------+
320 // +------------------------------------------------------------------------------+
322 Character
= BOXDRAW_DOWN_RIGHT
;
324 PrintChar (Character
);
325 PrintString (Buffer
);
327 Character
= BOXDRAW_DOWN_LEFT
;
328 PrintChar (Character
);
330 Character
= BOXDRAW_VERTICAL
;
331 for (Row
= LocalScreen
.TopRow
+ 1; Row
<= LocalScreen
.TopRow
+ NONE_FRONT_PAGE_HEADER_HEIGHT
- 2; Row
++) {
332 PrintCharAt (LocalScreen
.LeftColumn
, Row
, Character
);
333 PrintCharAt (LocalScreen
.RightColumn
- 1, Row
, Character
);
336 Character
= BOXDRAW_UP_RIGHT
;
337 PrintCharAt (LocalScreen
.LeftColumn
, LocalScreen
.TopRow
+ NONE_FRONT_PAGE_HEADER_HEIGHT
- 1, Character
);
338 PrintString (Buffer
);
340 Character
= BOXDRAW_UP_LEFT
;
341 PrintChar (Character
);
343 if ((gClassOfVfr
& FORMSET_CLASS_PLATFORM_SETUP
) == FORMSET_CLASS_PLATFORM_SETUP
) {
345 // Print Bottom border line
346 // +------------------------------------------------------------------------------+
348 // +------------------------------------------------------------------------------+
350 Character
= BOXDRAW_DOWN_RIGHT
;
351 PrintCharAt (LocalScreen
.LeftColumn
, LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- gFooterHeight
, Character
);
353 PrintString (Buffer
);
355 Character
= BOXDRAW_DOWN_LEFT
;
356 PrintChar (Character
);
357 Character
= BOXDRAW_VERTICAL
;
358 for (Row
= LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- gFooterHeight
+ 1;
359 Row
<= LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- 2;
362 PrintCharAt (LocalScreen
.LeftColumn
, Row
, Character
);
363 PrintCharAt (LocalScreen
.RightColumn
- 1, Row
, Character
);
366 Character
= BOXDRAW_UP_RIGHT
;
367 PrintCharAt (LocalScreen
.LeftColumn
, LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- 1, Character
);
369 PrintString (Buffer
);
371 Character
= BOXDRAW_UP_LEFT
;
372 PrintChar (Character
);
382 Evaluate all expressions in a Form.
384 @param FormSet FormSet this Form belongs to.
385 @param Form The Form.
387 @retval EFI_SUCCESS The expression evaluated successfuly
391 EvaluateFormExpressions (
392 IN FORM_BROWSER_FORMSET
*FormSet
,
393 IN FORM_BROWSER_FORM
*Form
398 FORM_EXPRESSION
*Expression
;
400 Link
= GetFirstNode (&Form
->ExpressionListHead
);
401 while (!IsNull (&Form
->ExpressionListHead
, Link
)) {
402 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
403 Link
= GetNextNode (&Form
->ExpressionListHead
, Link
);
405 if (Expression
->Type
== EFI_HII_EXPRESSION_INCONSISTENT_IF
||
406 Expression
->Type
== EFI_HII_EXPRESSION_NO_SUBMIT_IF
||
407 Expression
->Type
== EFI_HII_EXPRESSION_WRITE
||
408 (Expression
->Type
== EFI_HII_EXPRESSION_READ
&& Form
->FormType
!= STANDARD_MAP_FORM_TYPE
)) {
410 // Postpone Form validation to Question editing or Form submitting or Question Write or Question Read for nonstandard form.
415 Status
= EvaluateExpression (FormSet
, Form
, Expression
);
416 if (EFI_ERROR (Status
)) {
425 +------------------------------------------------------------------------------+
427 +------------------------------------------------------------------------------+
445 +------------------------------------------------------------------------------+
446 ?F1=Scroll Help F9=Reset to Defaults F10=Save and Exit ?
447 | ^"=Move Highlight <Spacebar> Toggles Checkbox Esc=Discard Changes |
448 +------------------------------------------------------------------------------+
454 Display form and wait for user to select one menu option, then return it.
456 @param Selection On input, Selection tell setup browser the information
457 about the Selection, form and formset to be displayed.
458 On output, Selection return the screen item that is selected
460 @retval EFI_SUCESSS This function always return successfully for now.
465 IN OUT UI_MENU_SELECTION
*Selection
469 UINT16 MenuItemCount
;
470 EFI_HII_HANDLE Handle
;
471 EFI_SCREEN_DESCRIPTOR LocalScreen
;
474 CHAR16
*OutputString
;
476 FORM_BROWSER_STATEMENT
*Statement
;
477 UINT16 NumberOfLines
;
479 UI_MENU_OPTION
*MenuOption
;
482 Handle
= Selection
->Handle
;
489 CopyMem (&LocalScreen
, &gScreenDimensions
, sizeof (EFI_SCREEN_DESCRIPTOR
));
491 StringPtr
= GetToken (Selection
->Form
->FormTitle
, Handle
);
493 if ((gClassOfVfr
& FORMSET_CLASS_FRONT_PAGE
) != FORMSET_CLASS_FRONT_PAGE
) {
494 if (Selection
->Form
->ModalForm
) {
495 gST
->ConOut
->SetAttribute (gST
->ConOut
, TITLE_TEXT
| EFI_BACKGROUND_BLACK
);
497 gST
->ConOut
->SetAttribute (gST
->ConOut
, TITLE_TEXT
| TITLE_BACKGROUND
);
500 (LocalScreen
.RightColumn
+ LocalScreen
.LeftColumn
- GetStringWidth (StringPtr
) / 2) / 2,
501 LocalScreen
.TopRow
+ 1,
507 // Remove Buffer allocated for StringPtr after it has been used.
509 FreePool (StringPtr
);
512 // Evaluate all the Expressions in this Form
514 Status
= EvaluateFormExpressions (Selection
->FormSet
, Selection
->Form
);
515 if (EFI_ERROR (Status
)) {
519 Selection
->FormEditable
= FALSE
;
520 Link
= GetFirstNode (&Selection
->Form
->StatementListHead
);
521 while (!IsNull (&Selection
->Form
->StatementListHead
, Link
)) {
522 Statement
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
524 if (EvaluateExpressionList(Statement
->Expression
, FALSE
, NULL
, NULL
) <= ExpressGrayOut
) {
525 StringPtr
= GetToken (Statement
->Prompt
, Handle
);
526 ASSERT (StringPtr
!= NULL
);
528 Width
= GetWidth (Statement
, Handle
);
533 for (; GetLineByWidth (StringPtr
, Width
, &GlyphWidth
,&ArrayEntry
, &OutputString
) != 0x0000;) {
535 // If there is more string to process print on the next row and increment the Skip value
537 if (StrLen (&StringPtr
[ArrayEntry
]) != 0) {
541 FreePool (OutputString
);
545 // We are NOT!! removing this StringPtr buffer via FreePool since it is being used in the menuoptions, we will do
548 MenuOption
= UiAddMenuOption (StringPtr
, Selection
->Handle
, Selection
->Form
, Statement
, NumberOfLines
, MenuItemCount
);
551 if (MenuOption
->IsQuestion
&& !MenuOption
->ReadOnly
) {
553 // At least one item is not readonly, this Form is considered as editable
555 Selection
->FormEditable
= TRUE
;
559 Link
= GetNextNode (&Selection
->Form
->StatementListHead
, Link
);
562 Status
= UiDisplayMenu (Selection
);
570 Initialize the HII String Token to the correct values.
574 InitializeBrowserStrings (
578 gEnterString
= GetToken (STRING_TOKEN (ENTER_STRING
), gHiiHandle
);
579 gEnterCommitString
= GetToken (STRING_TOKEN (ENTER_COMMIT_STRING
), gHiiHandle
);
580 gEnterEscapeString
= GetToken (STRING_TOKEN (ENTER_ESCAPE_STRING
), gHiiHandle
);
581 gEscapeString
= GetToken (STRING_TOKEN (ESCAPE_STRING
), gHiiHandle
);
582 gMoveHighlight
= GetToken (STRING_TOKEN (MOVE_HIGHLIGHT
), gHiiHandle
);
583 gMakeSelection
= GetToken (STRING_TOKEN (MAKE_SELECTION
), gHiiHandle
);
584 gDecNumericInput
= GetToken (STRING_TOKEN (DEC_NUMERIC_INPUT
), gHiiHandle
);
585 gHexNumericInput
= GetToken (STRING_TOKEN (HEX_NUMERIC_INPUT
), gHiiHandle
);
586 gToggleCheckBox
= GetToken (STRING_TOKEN (TOGGLE_CHECK_BOX
), gHiiHandle
);
587 gPromptForData
= GetToken (STRING_TOKEN (PROMPT_FOR_DATA
), gHiiHandle
);
588 gPromptForPassword
= GetToken (STRING_TOKEN (PROMPT_FOR_PASSWORD
), gHiiHandle
);
589 gPromptForNewPassword
= GetToken (STRING_TOKEN (PROMPT_FOR_NEW_PASSWORD
), gHiiHandle
);
590 gConfirmPassword
= GetToken (STRING_TOKEN (CONFIRM_PASSWORD
), gHiiHandle
);
591 gConfirmError
= GetToken (STRING_TOKEN (CONFIRM_ERROR
), gHiiHandle
);
592 gPassowordInvalid
= GetToken (STRING_TOKEN (PASSWORD_INVALID
), gHiiHandle
);
593 gPressEnter
= GetToken (STRING_TOKEN (PRESS_ENTER
), gHiiHandle
);
594 gEmptyString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
595 gAreYouSure
= GetToken (STRING_TOKEN (ARE_YOU_SURE
), gHiiHandle
);
596 gYesResponse
= GetToken (STRING_TOKEN (ARE_YOU_SURE_YES
), gHiiHandle
);
597 gNoResponse
= GetToken (STRING_TOKEN (ARE_YOU_SURE_NO
), gHiiHandle
);
598 gMiniString
= GetToken (STRING_TOKEN (MINI_STRING
), gHiiHandle
);
599 gPlusString
= GetToken (STRING_TOKEN (PLUS_STRING
), gHiiHandle
);
600 gMinusString
= GetToken (STRING_TOKEN (MINUS_STRING
), gHiiHandle
);
601 gAdjustNumber
= GetToken (STRING_TOKEN (ADJUST_NUMBER
), gHiiHandle
);
602 gSaveChanges
= GetToken (STRING_TOKEN (SAVE_CHANGES
), gHiiHandle
);
603 gOptionMismatch
= GetToken (STRING_TOKEN (OPTION_MISMATCH
), gHiiHandle
);
604 gFormSuppress
= GetToken (STRING_TOKEN (FORM_SUPPRESSED
), gHiiHandle
);
605 gProtocolNotFound
= GetToken (STRING_TOKEN (PROTOCOL_NOT_FOUND
), gHiiHandle
);
610 Free up the resource allocated for all strings required
619 FreePool (gEnterString
);
620 FreePool (gEnterCommitString
);
621 FreePool (gEnterEscapeString
);
622 FreePool (gEscapeString
);
623 FreePool (gMoveHighlight
);
624 FreePool (gMakeSelection
);
625 FreePool (gDecNumericInput
);
626 FreePool (gHexNumericInput
);
627 FreePool (gToggleCheckBox
);
628 FreePool (gPromptForData
);
629 FreePool (gPromptForPassword
);
630 FreePool (gPromptForNewPassword
);
631 FreePool (gConfirmPassword
);
632 FreePool (gPassowordInvalid
);
633 FreePool (gConfirmError
);
634 FreePool (gPressEnter
);
635 FreePool (gEmptyString
);
636 FreePool (gAreYouSure
);
637 FreePool (gYesResponse
);
638 FreePool (gNoResponse
);
639 FreePool (gMiniString
);
640 FreePool (gPlusString
);
641 FreePool (gMinusString
);
642 FreePool (gAdjustNumber
);
643 FreePool (gSaveChanges
);
644 FreePool (gOptionMismatch
);
645 FreePool (gFormSuppress
);
646 FreePool (gProtocolNotFound
);
651 Show all registered HotKey help strings on bottom Rows.
655 PrintHotKeyHelpString (
661 UINTN BottomRowOfHotKeyHelp
;
664 EFI_SCREEN_DESCRIPTOR LocalScreen
;
666 BROWSER_HOT_KEY
*HotKey
;
668 CopyMem (&LocalScreen
, &gScreenDimensions
, sizeof (EFI_SCREEN_DESCRIPTOR
));
669 ColumnWidth
= (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
) / 3;
670 BottomRowOfHotKeyHelp
= LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- 3;
673 // Calculate total number of Register HotKeys.
676 Link
= GetFirstNode (&gBrowserHotKeyList
);
677 while (!IsNull (&gBrowserHotKeyList
, Link
)) {
678 HotKey
= BROWSER_HOT_KEY_FROM_LINK (Link
);
680 // Help string can't exceed ColumnWidth. One Row will show three Help information.
682 if (StrLen (HotKey
->HelpString
) > ColumnWidth
) {
683 HotKey
->HelpString
[ColumnWidth
] = L
'\0';
686 // Calculate help information Column and Row.
688 if ((Index
% 3) != 2) {
689 CurrentCol
= LocalScreen
.LeftColumn
+ (2 - Index
% 3) * ColumnWidth
;
691 CurrentCol
= LocalScreen
.LeftColumn
+ 2;
693 CurrentRow
= BottomRowOfHotKeyHelp
- Index
/ 3;
695 // Print HotKey help string on bottom Row.
697 PrintStringAt (CurrentCol
, CurrentRow
, HotKey
->HelpString
);
702 Link
= GetNextNode (&gBrowserHotKeyList
, Link
);
710 Update key's help imformation.
712 @param Selection Tell setup browser the information about the Selection
713 @param MenuOption The Menu option
714 @param Selected Whether or not a tag be selected
719 IN UI_MENU_SELECTION
*Selection
,
720 IN UI_MENU_OPTION
*MenuOption
,
726 UINTN LeftColumnOfHelp
;
727 UINTN RightColumnOfHelp
;
729 UINTN BottomRowOfHelp
;
730 UINTN StartColumnOfHelp
;
731 EFI_SCREEN_DESCRIPTOR LocalScreen
;
732 FORM_BROWSER_STATEMENT
*Statement
;
734 gST
->ConOut
->SetAttribute (gST
->ConOut
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
736 if (Selection
->Form
->ModalForm
) {
740 CopyMem (&LocalScreen
, &gScreenDimensions
, sizeof (EFI_SCREEN_DESCRIPTOR
));
742 SecCol
= LocalScreen
.LeftColumn
+ (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
) / 3;
743 ThdCol
= LocalScreen
.LeftColumn
+ (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
) / 3 * 2;
745 StartColumnOfHelp
= LocalScreen
.LeftColumn
+ 2;
746 LeftColumnOfHelp
= LocalScreen
.LeftColumn
+ 1;
747 RightColumnOfHelp
= LocalScreen
.RightColumn
- 2;
748 TopRowOfHelp
= LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- gFooterHeight
+ 1;
749 BottomRowOfHelp
= LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- 2;
751 Statement
= MenuOption
->ThisTag
;
752 switch (Statement
->Operand
) {
753 case EFI_IFR_ORDERED_LIST_OP
:
754 case EFI_IFR_ONE_OF_OP
:
755 case EFI_IFR_NUMERIC_OP
:
756 case EFI_IFR_TIME_OP
:
757 case EFI_IFR_DATE_OP
:
758 ClearLines (LeftColumnOfHelp
, RightColumnOfHelp
, TopRowOfHelp
, BottomRowOfHelp
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
762 // On system setting, HotKey will show on every form.
764 if (gBrowserSettingScope
== SystemLevel
||
765 (Selection
->FormEditable
&& gFunctionKeySetting
!= NONE_FUNCTION_KEY_SETTING
)) {
766 PrintHotKeyHelpString ();
769 if ((gClassOfVfr
& FORMSET_CLASS_PLATFORM_SETUP
) == FORMSET_CLASS_PLATFORM_SETUP
) {
770 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEscapeString
);
773 if ((Statement
->Operand
== EFI_IFR_DATE_OP
) ||
774 (Statement
->Operand
== EFI_IFR_TIME_OP
)) {
785 PrintStringAt (SecCol
, BottomRowOfHelp
, gEnterString
);
786 PrintStringAt (StartColumnOfHelp
, TopRowOfHelp
, gAdjustNumber
);
788 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
789 if (Statement
->Operand
== EFI_IFR_NUMERIC_OP
&& Statement
->Step
!= 0) {
790 PrintStringAt (StartColumnOfHelp
, TopRowOfHelp
, gAdjustNumber
);
792 PrintStringAt (SecCol
, BottomRowOfHelp
, gEnterString
);
795 PrintStringAt (SecCol
, BottomRowOfHelp
, gEnterCommitString
);
798 // If it is a selected numeric with manual input, display different message
800 if ((Statement
->Operand
== EFI_IFR_NUMERIC_OP
) ||
801 (Statement
->Operand
== EFI_IFR_DATE_OP
) ||
802 (Statement
->Operand
== EFI_IFR_TIME_OP
)) {
806 ((Statement
->Flags
& EFI_IFR_DISPLAY_UINT_HEX
) == EFI_IFR_DISPLAY_UINT_HEX
) ? gHexNumericInput
: gDecNumericInput
808 } else if (Statement
->Operand
!= EFI_IFR_ORDERED_LIST_OP
) {
809 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
812 if (Statement
->Operand
== EFI_IFR_ORDERED_LIST_OP
) {
813 PrintStringAt (StartColumnOfHelp
, TopRowOfHelp
, gPlusString
);
814 PrintStringAt (ThdCol
, TopRowOfHelp
, gMinusString
);
817 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEnterEscapeString
);
821 case EFI_IFR_CHECKBOX_OP
:
822 ClearLines (LeftColumnOfHelp
, RightColumnOfHelp
, TopRowOfHelp
, BottomRowOfHelp
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
825 // On system setting, HotKey will show on every form.
827 if (gBrowserSettingScope
== SystemLevel
||
828 (Selection
->FormEditable
&& gFunctionKeySetting
!= NONE_FUNCTION_KEY_SETTING
)) {
829 PrintHotKeyHelpString ();
831 if ((gClassOfVfr
& FORMSET_CLASS_PLATFORM_SETUP
) == FORMSET_CLASS_PLATFORM_SETUP
) {
832 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEscapeString
);
835 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
836 PrintStringAt (SecCol
, BottomRowOfHelp
, gToggleCheckBox
);
840 case EFI_IFR_PASSWORD_OP
:
841 case EFI_IFR_STRING_OP
:
842 case EFI_IFR_TEXT_OP
:
843 case EFI_IFR_ACTION_OP
:
844 case EFI_IFR_RESET_BUTTON_OP
:
845 case EFI_IFR_SUBTITLE_OP
:
846 ClearLines (LeftColumnOfHelp
, RightColumnOfHelp
, TopRowOfHelp
, BottomRowOfHelp
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
850 // On system setting, HotKey will show on every form.
852 if (gBrowserSettingScope
== SystemLevel
||
853 (Selection
->FormEditable
&& gFunctionKeySetting
!= NONE_FUNCTION_KEY_SETTING
)) {
854 PrintHotKeyHelpString ();
856 if ((gClassOfVfr
& FORMSET_CLASS_PLATFORM_SETUP
) == FORMSET_CLASS_PLATFORM_SETUP
) {
857 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEscapeString
);
860 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
861 if (Statement
->Operand
!= EFI_IFR_TEXT_OP
&& Statement
->Operand
!= EFI_IFR_SUBTITLE_OP
) {
862 PrintStringAt (SecCol
, BottomRowOfHelp
, gEnterString
);
865 if (Statement
->Operand
!= EFI_IFR_REF_OP
) {
867 (LocalScreen
.RightColumn
- GetStringWidth (gEnterCommitString
) / 2) / 2,
871 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEnterEscapeString
);
882 Functions which are registered to receive notification of
883 database events have this prototype. The actual event is encoded
884 in NotifyType. The following table describes how PackageType,
885 PackageGuid, Handle, and Package are used for each of the
888 @param PackageType Package type of the notification.
890 @param PackageGuid If PackageType is
891 EFI_HII_PACKAGE_TYPE_GUID, then this is
892 the pointer to the GUID from the Guid
893 field of EFI_HII_PACKAGE_GUID_HEADER.
894 Otherwise, it must be NULL.
896 @param Package Points to the package referred to by the
897 notification Handle The handle of the package
898 list which contains the specified package.
900 @param Handle The HII handle.
902 @param NotifyType The type of change concerning the
904 EFI_HII_DATABASE_NOTIFY_TYPE.
910 IN UINT8 PackageType
,
911 IN CONST EFI_GUID
*PackageGuid
,
912 IN CONST EFI_HII_PACKAGE_HEADER
*Package
,
913 IN EFI_HII_HANDLE Handle
,
914 IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType
917 mHiiPackageListUpdated
= TRUE
;
923 check whether the formset need to update the NV.
925 @param FormSet FormSet data structure.
927 @retval TRUE Need to update the NV.
928 @retval FALSE No need to update the NV.
932 IN FORM_BROWSER_FORMSET
*FormSet
936 FORM_BROWSER_FORM
*Form
;
938 Link
= GetFirstNode (&FormSet
->FormListHead
);
939 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
940 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
942 if (Form
->NvUpdateRequired
) {
946 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
953 check whether the formset need to update the NV.
955 @param FormSet FormSet data structure.
956 @param SetValue Whether set new value or clear old value.
961 IN FORM_BROWSER_FORMSET
*FormSet
,
966 FORM_BROWSER_FORM
*Form
;
968 Link
= GetFirstNode (&FormSet
->FormListHead
);
969 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
970 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
972 Form
->NvUpdateRequired
= SetValue
;
974 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
978 Find menu which will show next time.
980 @param Selection On input, Selection tell setup browser the information
981 about the Selection, form and formset to be displayed.
982 On output, Selection return the screen item that is selected
984 @param Repaint Whether need to repaint the menu.
985 @param NewLine Whether need to show at new line.
987 @retval TRUE Need return.
988 @retval FALSE No need to return.
992 IN OUT UI_MENU_SELECTION
*Selection
,
997 UI_MENU_LIST
*CurrentMenu
;
1001 BROWSER_SETTING_SCOPE Scope
;
1003 CurrentMenu
= Selection
->CurrentMenu
;
1005 if (CurrentMenu
!= NULL
&& CurrentMenu
->Parent
!= NULL
) {
1007 // we have a parent, so go to the parent menu
1009 if (CompareGuid (&CurrentMenu
->FormSetGuid
, &CurrentMenu
->Parent
->FormSetGuid
)) {
1011 // The parent menu and current menu are in the same formset
1013 Selection
->Action
= UI_ACTION_REFRESH_FORM
;
1016 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
1017 CopyMem (&Selection
->FormSetGuid
, &CurrentMenu
->Parent
->FormSetGuid
, sizeof (EFI_GUID
));
1018 Selection
->Handle
= CurrentMenu
->Parent
->HiiHandle
;
1019 Scope
= FormSetLevel
;
1023 // Form Level Check whether the data is changed.
1025 if ((gBrowserSettingScope
== FormLevel
&& Selection
->Form
->NvUpdateRequired
) ||
1026 (gBrowserSettingScope
== FormSetLevel
&& IsNvUpdateRequired(Selection
->FormSet
) && Scope
== FormSetLevel
)) {
1027 gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
1029 YesResponse
= gYesResponse
[0];
1030 NoResponse
= gNoResponse
[0];
1033 // If NV flag is up, prompt user
1036 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, gSaveChanges
, gAreYouSure
, gEmptyString
);
1039 (Key
.ScanCode
!= SCAN_ESC
) &&
1040 ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (NoResponse
| UPPER_LOWER_CASE_OFFSET
)) &&
1041 ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (YesResponse
| UPPER_LOWER_CASE_OFFSET
))
1044 if (Key
.ScanCode
== SCAN_ESC
) {
1046 // User hits the ESC key, Ingore.
1048 if (Repaint
!= NULL
) {
1051 if (NewLine
!= NULL
) {
1055 Selection
->Action
= UI_ACTION_NONE
;
1059 if ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) == (YesResponse
| UPPER_LOWER_CASE_OFFSET
)) {
1061 // If the user hits the YesResponse key
1063 SubmitForm (Selection
->FormSet
, Selection
->Form
, Scope
);
1066 // If the user hits the NoResponse key
1068 DiscardForm (Selection
->FormSet
, Selection
->Form
, Scope
);
1072 Selection
->Statement
= NULL
;
1074 Selection
->FormId
= CurrentMenu
->Parent
->FormId
;
1075 Selection
->QuestionId
= CurrentMenu
->Parent
->QuestionId
;
1078 // Clear highlight record for this menu
1080 CurrentMenu
->QuestionId
= 0;
1084 if ((gClassOfVfr
& FORMSET_CLASS_FRONT_PAGE
) == FORMSET_CLASS_FRONT_PAGE
) {
1086 // We never exit FrontPage, so skip the ESC
1088 Selection
->Action
= UI_ACTION_NONE
;
1093 // We are going to leave current FormSet, so check uncommited data in this FormSet
1095 if (gBrowserSettingScope
!= SystemLevel
&& IsNvUpdateRequired(Selection
->FormSet
)) {
1096 gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
1098 YesResponse
= gYesResponse
[0];
1099 NoResponse
= gNoResponse
[0];
1102 // If NV flag is up, prompt user
1105 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, gSaveChanges
, gAreYouSure
, gEmptyString
);
1108 (Key
.ScanCode
!= SCAN_ESC
) &&
1109 ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (NoResponse
| UPPER_LOWER_CASE_OFFSET
)) &&
1110 ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (YesResponse
| UPPER_LOWER_CASE_OFFSET
))
1113 if (Key
.ScanCode
== SCAN_ESC
) {
1115 // User hits the ESC key
1117 if (Repaint
!= NULL
) {
1121 if (NewLine
!= NULL
) {
1125 Selection
->Action
= UI_ACTION_NONE
;
1129 if ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) == (YesResponse
| UPPER_LOWER_CASE_OFFSET
)) {
1131 // If the user hits the YesResponse key
1133 SubmitForm (Selection
->FormSet
, Selection
->Form
, FormSetLevel
);
1136 // If the user hits the NoResponse key
1138 DiscardForm (Selection
->FormSet
, Selection
->Form
, FormSetLevel
);
1142 Selection
->Statement
= NULL
;
1143 if (CurrentMenu
!= NULL
) {
1144 CurrentMenu
->QuestionId
= 0;
1147 Selection
->Action
= UI_ACTION_EXIT
;
1152 Call the call back function for the question and process the return action.
1154 @param Selection On input, Selection tell setup browser the information
1155 about the Selection, form and formset to be displayed.
1156 On output, Selection return the screen item that is selected
1158 @param Question The Question which need to call.
1159 @param Action The action request.
1160 @param SkipSaveOrDiscard Whether skip save or discard action.
1162 @retval EFI_SUCCESS The call back function excutes successfully.
1163 @return Other value if the call back function failed to excute.
1166 ProcessCallBackFunction (
1167 IN OUT UI_MENU_SELECTION
*Selection
,
1168 IN FORM_BROWSER_STATEMENT
*Question
,
1169 IN EFI_BROWSER_ACTION Action
,
1170 IN BOOLEAN SkipSaveOrDiscard
1174 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
1175 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
1176 EFI_HII_VALUE
*HiiValue
;
1177 EFI_IFR_TYPE_VALUE
*TypeValue
;
1178 FORM_BROWSER_STATEMENT
*Statement
;
1179 BOOLEAN SubmitFormIsRequired
;
1180 BOOLEAN DiscardFormIsRequired
;
1183 BROWSER_SETTING_SCOPE SettingLevel
;
1185 ConfigAccess
= Selection
->FormSet
->ConfigAccess
;
1186 SubmitFormIsRequired
= FALSE
;
1187 SettingLevel
= FormSetLevel
;
1188 DiscardFormIsRequired
= FALSE
;
1190 Status
= EFI_SUCCESS
;
1191 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
1193 if (ConfigAccess
== NULL
) {
1197 Link
= GetFirstNode (&Selection
->Form
->StatementListHead
);
1198 while (!IsNull (&Selection
->Form
->StatementListHead
, Link
)) {
1199 Statement
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
1200 Link
= GetNextNode (&Selection
->Form
->StatementListHead
, Link
);
1203 // if Question != NULL, only process the question. Else, process all question in this form.
1205 if ((Question
!= NULL
) && (Statement
!= Question
)) {
1209 if ((Statement
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != EFI_IFR_FLAG_CALLBACK
) {
1214 // Check whether Statement is disabled.
1216 if (Statement
->Expression
!= NULL
) {
1217 if (EvaluateExpressionList(Statement
->Expression
, TRUE
, Selection
->FormSet
, Selection
->Form
) == ExpressDisable
) {
1222 HiiValue
= &Statement
->HiiValue
;
1223 TypeValue
= &HiiValue
->Value
;
1224 if (HiiValue
->Type
== EFI_IFR_TYPE_BUFFER
) {
1226 // For OrderedList, passing in the value buffer to Callback()
1228 TypeValue
= (EFI_IFR_TYPE_VALUE
*) Statement
->BufferValue
;
1231 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
1232 Status
= ConfigAccess
->Callback (
1235 Statement
->QuestionId
,
1240 if (!EFI_ERROR (Status
)) {
1242 // Only for EFI_BROWSER_ACTION_CHANGED need to handle this ActionRequest.
1244 if (Action
== EFI_BROWSER_ACTION_CHANGED
) {
1245 switch (ActionRequest
) {
1246 case EFI_BROWSER_ACTION_REQUEST_RESET
:
1247 gResetRequired
= TRUE
;
1248 Selection
->Action
= UI_ACTION_EXIT
;
1251 case EFI_BROWSER_ACTION_REQUEST_SUBMIT
:
1252 SubmitFormIsRequired
= TRUE
;
1253 Selection
->Action
= UI_ACTION_EXIT
;
1256 case EFI_BROWSER_ACTION_REQUEST_EXIT
:
1257 Selection
->Action
= UI_ACTION_EXIT
;
1260 case EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT
:
1261 SubmitFormIsRequired
= TRUE
;
1262 SettingLevel
= FormLevel
;
1266 case EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT
:
1267 DiscardFormIsRequired
= TRUE
;
1268 SettingLevel
= FormLevel
;
1272 case EFI_BROWSER_ACTION_REQUEST_FORM_APPLY
:
1273 SubmitFormIsRequired
= TRUE
;
1274 SettingLevel
= FormLevel
;
1277 case EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD
:
1278 DiscardFormIsRequired
= TRUE
;
1279 SettingLevel
= FormLevel
;
1288 // According the spec, return value from call back of "changing" and
1289 // "retrieve" should update to the question's temp buffer.
1291 if (Action
== EFI_BROWSER_ACTION_CHANGING
|| Action
== EFI_BROWSER_ACTION_RETRIEVE
) {
1292 SetQuestionValue(Selection
->FormSet
, Selection
->Form
, Statement
, GetSetValueWithEditBuffer
);
1296 // According the spec, return fail from call back of "changing" and
1297 // "retrieve", should restore the question's value.
1299 if (Action
== EFI_BROWSER_ACTION_CHANGING
|| Action
== EFI_BROWSER_ACTION_RETRIEVE
) {
1300 GetQuestionValue(Selection
->FormSet
, Selection
->Form
, Statement
, GetSetValueWithEditBuffer
);
1303 if (Status
== EFI_UNSUPPORTED
) {
1305 // If return EFI_UNSUPPORTED, also consider Hii driver suceess deal with it.
1307 Status
= EFI_SUCCESS
;
1312 if (SubmitFormIsRequired
&& !SkipSaveOrDiscard
) {
1313 SubmitForm (Selection
->FormSet
, Selection
->Form
, SettingLevel
);
1316 if (DiscardFormIsRequired
&& !SkipSaveOrDiscard
) {
1317 DiscardForm (Selection
->FormSet
, Selection
->Form
, SettingLevel
);
1321 FindNextMenu (Selection
, NULL
, NULL
);
1328 Call the retrieve type call back function for one question to get the initialize data.
1330 This function only used when in the initialize stage, because in this stage, the
1331 Selection->Form is not ready. For other case, use the ProcessCallBackFunction instead.
1333 @param ConfigAccess The config access protocol produced by the hii driver.
1334 @param Statement The Question which need to call.
1336 @retval EFI_SUCCESS The call back function excutes successfully.
1337 @return Other value if the call back function failed to excute.
1340 ProcessRetrieveForQuestion (
1341 IN EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
,
1342 IN FORM_BROWSER_STATEMENT
*Statement
1346 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
1347 EFI_HII_VALUE
*HiiValue
;
1348 EFI_IFR_TYPE_VALUE
*TypeValue
;
1350 Status
= EFI_SUCCESS
;
1351 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
1353 if ((Statement
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != EFI_IFR_FLAG_CALLBACK
) {
1354 return EFI_UNSUPPORTED
;
1357 HiiValue
= &Statement
->HiiValue
;
1358 TypeValue
= &HiiValue
->Value
;
1359 if (HiiValue
->Type
== EFI_IFR_TYPE_BUFFER
) {
1361 // For OrderedList, passing in the value buffer to Callback()
1363 TypeValue
= (EFI_IFR_TYPE_VALUE
*) Statement
->BufferValue
;
1366 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
1367 Status
= ConfigAccess
->Callback (
1369 EFI_BROWSER_ACTION_RETRIEVE
,
1370 Statement
->QuestionId
,
1379 The worker function that send the displays to the screen. On output,
1380 the selection made by user is returned.
1382 @param Selection On input, Selection tell setup browser the information
1383 about the Selection, form and formset to be displayed.
1384 On output, Selection return the screen item that is selected
1387 @retval EFI_SUCCESS The page is displayed successfully.
1388 @return Other value if the page failed to be diplayed.
1393 IN OUT UI_MENU_SELECTION
*Selection
1398 EFI_HANDLE NotifyHandle
;
1399 FORM_BROWSER_STATEMENT
*Statement
;
1400 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
1403 gMenuRefreshHead
= NULL
;
1404 ConfigAccess
= Selection
->FormSet
->ConfigAccess
;
1407 // Register notify for Form package update
1409 Status
= mHiiDatabase
->RegisterPackageNotify (
1411 EFI_HII_PACKAGE_FORMS
,
1414 EFI_HII_DATABASE_NOTIFY_REMOVE_PACK
,
1417 if (EFI_ERROR (Status
)) {
1422 // Initialize current settings of Questions in this FormSet
1424 Status
= InitializeCurrentSetting (Selection
->FormSet
);
1425 if (EFI_ERROR (Status
)) {
1430 // Update gOldFormSet on maintain back up FormSet list.
1431 // And, make gOldFormSet point to current FormSet.
1433 if (gOldFormSet
!= NULL
) {
1434 RemoveEntryList (&gOldFormSet
->Link
);
1435 DestroyFormSet (gOldFormSet
);
1437 gOldFormSet
= Selection
->FormSet
;
1438 InsertTailList (&gBrowserFormSetList
, &gOldFormSet
->Link
);
1442 // IFR is updated, force to reparse the IFR binary
1444 if (mHiiPackageListUpdated
) {
1445 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
1446 mHiiPackageListUpdated
= FALSE
;
1451 // Initialize Selection->Form
1453 if (Selection
->FormId
== 0) {
1455 // Zero FormId indicates display the first Form in a FormSet
1457 Link
= GetFirstNode (&Selection
->FormSet
->FormListHead
);
1459 Selection
->Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
1460 Selection
->FormId
= Selection
->Form
->FormId
;
1462 Selection
->Form
= IdToForm (Selection
->FormSet
, Selection
->FormId
);
1465 if (Selection
->Form
== NULL
) {
1467 // No Form to display
1469 Status
= EFI_NOT_FOUND
;
1474 // Check Form is suppressed.
1476 if (Selection
->Form
->SuppressExpression
!= NULL
) {
1477 if (EvaluateExpressionList(Selection
->Form
->SuppressExpression
, TRUE
, Selection
->FormSet
, Selection
->Form
) == ExpressSuppress
) {
1479 // Form is suppressed.
1482 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, gFormSuppress
, gPressEnter
, gEmptyString
);
1483 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
1485 Status
= EFI_NOT_FOUND
;
1491 // Before display new form, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_OPEN
1492 // for each question with callback flag.
1493 // New form may be the first form, or the different form after another form close.
1495 if ((ConfigAccess
!= NULL
) &&
1496 ((Selection
->Handle
!= mCurrentHiiHandle
) ||
1497 (!CompareGuid (&Selection
->FormSetGuid
, &mCurrentFormSetGuid
)) ||
1498 (Selection
->FormId
!= mCurrentFormId
))) {
1501 // Keep current form information
1503 mCurrentHiiHandle
= Selection
->Handle
;
1504 CopyGuid (&mCurrentFormSetGuid
, &Selection
->FormSetGuid
);
1505 mCurrentFormId
= Selection
->FormId
;
1507 Status
= ProcessCallBackFunction (Selection
, NULL
, EFI_BROWSER_ACTION_FORM_OPEN
, FALSE
);
1508 if (EFI_ERROR (Status
)) {
1513 // EXIT requests to close form.
1515 if (Selection
->Action
== UI_ACTION_EXIT
) {
1519 // IFR is updated during callback of open form, force to reparse the IFR binary
1521 if (mHiiPackageListUpdated
) {
1522 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
1523 mHiiPackageListUpdated
= FALSE
;
1529 // Load Questions' Value for display
1531 Status
= LoadFormSetConfig (Selection
, Selection
->FormSet
);
1532 if (EFI_ERROR (Status
)) {
1537 // EXIT requests to close form.
1539 if (Selection
->Action
== UI_ACTION_EXIT
) {
1543 // IFR is updated during callback of read value, force to reparse the IFR binary
1545 if (mHiiPackageListUpdated
) {
1546 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
1547 mHiiPackageListUpdated
= FALSE
;
1552 // Displays the Header and Footer borders
1554 DisplayPageFrame (Selection
);
1559 Status
= DisplayForm (Selection
);
1560 if (EFI_ERROR (Status
)) {
1565 // Check Selected Statement (if press ESC, Selection->Statement will be NULL)
1567 Statement
= Selection
->Statement
;
1568 if (Statement
!= NULL
) {
1569 if ((Statement
->QuestionFlags
& EFI_IFR_FLAG_RESET_REQUIRED
) == EFI_IFR_FLAG_RESET_REQUIRED
) {
1570 gResetRequired
= TRUE
;
1573 if ((ConfigAccess
!= NULL
) &&
1574 ((Statement
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) == EFI_IFR_FLAG_CALLBACK
) &&
1575 (Statement
->Operand
!= EFI_IFR_PASSWORD_OP
)) {
1576 Status
= ProcessCallBackFunction(Selection
, Statement
, EFI_BROWSER_ACTION_CHANGING
, FALSE
);
1577 if (Statement
->Operand
== EFI_IFR_REF_OP
&& Selection
->Action
!= UI_ACTION_EXIT
) {
1579 // Process dynamic update ref opcode.
1581 if (!EFI_ERROR (Status
)) {
1582 Status
= ProcessGotoOpCode(Statement
, Selection
, NULL
, NULL
);
1586 // Callback return error status or status return from process goto opcode.
1588 if (EFI_ERROR (Status
)) {
1590 // Cross reference will not be taken
1592 Selection
->FormId
= Selection
->Form
->FormId
;
1593 Selection
->QuestionId
= 0;
1597 if (!EFI_ERROR (Status
) && Statement
->Operand
!= EFI_IFR_REF_OP
) {
1598 ProcessCallBackFunction(Selection
, Statement
, EFI_BROWSER_ACTION_CHANGED
, FALSE
);
1604 // Before exit the form, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_CLOSE
1605 // for each question with callback flag.
1607 if ((ConfigAccess
!= NULL
) &&
1608 ((Selection
->Action
== UI_ACTION_EXIT
) ||
1609 (Selection
->Handle
!= mCurrentHiiHandle
) ||
1610 (!CompareGuid (&Selection
->FormSetGuid
, &mCurrentFormSetGuid
)) ||
1611 (Selection
->FormId
!= mCurrentFormId
))) {
1613 Status
= ProcessCallBackFunction (Selection
, NULL
, EFI_BROWSER_ACTION_FORM_CLOSE
, FALSE
);
1614 if (EFI_ERROR (Status
)) {
1618 } while (Selection
->Action
== UI_ACTION_REFRESH_FORM
);
1622 // Reset current form information to the initial setting when error happens or form exit.
1624 if (EFI_ERROR (Status
) || Selection
->Action
== UI_ACTION_EXIT
) {
1625 mCurrentHiiHandle
= NULL
;
1626 CopyGuid (&mCurrentFormSetGuid
, &gZeroGuid
);
1631 // Unregister notify for Form package update
1633 mHiiDatabase
->UnregisterPackageNotify (