2 Utility functions for UI presentation.
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
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.
196 CHAR16
*StrFrontPageBanner
;
198 EFI_SCREEN_DESCRIPTOR LocalScreen
;
202 ZeroMem (&LocalScreen
, sizeof (EFI_SCREEN_DESCRIPTOR
));
203 gST
->ConOut
->QueryMode (gST
->ConOut
, gST
->ConOut
->Mode
->Mode
, &LocalScreen
.RightColumn
, &LocalScreen
.BottomRow
);
204 ClearLines (0, LocalScreen
.RightColumn
, 0, LocalScreen
.BottomRow
, KEYHELP_BACKGROUND
);
206 CopyMem (&LocalScreen
, &gScreenDimensions
, sizeof (EFI_SCREEN_DESCRIPTOR
));
209 // For now, allocate an arbitrarily long buffer
211 Buffer
= AllocateZeroPool (0x10000);
212 ASSERT (Buffer
!= NULL
);
214 Character
= BOXDRAW_HORIZONTAL
;
216 for (Index
= 0; Index
+ 2 < (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
); Index
++) {
217 Buffer
[Index
] = Character
;
220 if ((gClassOfVfr
& FORMSET_CLASS_FRONT_PAGE
) == FORMSET_CLASS_FRONT_PAGE
) {
222 // ClearLines(0, LocalScreen.RightColumn, 0, BANNER_HEIGHT-1, BANNER_TEXT | BANNER_BACKGROUND);
225 LocalScreen
.LeftColumn
,
226 LocalScreen
.RightColumn
,
228 FRONT_PAGE_HEADER_HEIGHT
- 1 + LocalScreen
.TopRow
,
229 BANNER_TEXT
| BANNER_BACKGROUND
232 // for (Line = 0; Line < BANNER_HEIGHT; Line++) {
234 for (Line
= (UINT8
) LocalScreen
.TopRow
; Line
< BANNER_HEIGHT
+ (UINT8
) LocalScreen
.TopRow
; Line
++) {
236 // for (Alignment = 0; Alignment < BANNER_COLUMNS; Alignment++) {
238 for (Alignment
= (UINT8
) LocalScreen
.LeftColumn
;
239 Alignment
< BANNER_COLUMNS
+ (UINT8
) LocalScreen
.LeftColumn
;
242 RowIdx
= (UINT8
) (Line
- (UINT8
) LocalScreen
.TopRow
);
243 ColumnIdx
= (UINT8
) (Alignment
- (UINT8
) LocalScreen
.LeftColumn
);
245 ASSERT (RowIdx
< BANNER_HEIGHT
);
246 ASSERT (ColumnIdx
< BANNER_COLUMNS
);
248 if (gBannerData
->Banner
[RowIdx
][ColumnIdx
] != 0x0000) {
249 StrFrontPageBanner
= GetToken (
250 gBannerData
->Banner
[RowIdx
][ColumnIdx
],
257 switch (Alignment
- LocalScreen
.LeftColumn
) {
260 // Handle left column
262 PrintStringAt (LocalScreen
.LeftColumn
+ BANNER_LEFT_COLUMN_INDENT
, Line
, StrFrontPageBanner
);
267 // Handle center column
270 LocalScreen
.LeftColumn
+ (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
) / 3,
278 // Handle right column
281 LocalScreen
.LeftColumn
+ (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
) * 2 / 3,
288 FreePool (StrFrontPageBanner
);
294 LocalScreen
.LeftColumn
,
295 LocalScreen
.RightColumn
,
296 LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- FOOTER_HEIGHT
,
297 LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- 1,
298 KEYHELP_TEXT
| KEYHELP_BACKGROUND
301 if ((gClassOfVfr
& FORMSET_CLASS_FRONT_PAGE
) != FORMSET_CLASS_FRONT_PAGE
) {
303 LocalScreen
.LeftColumn
,
304 LocalScreen
.RightColumn
,
306 LocalScreen
.TopRow
+ NONE_FRONT_PAGE_HEADER_HEIGHT
- 1,
307 TITLE_TEXT
| TITLE_BACKGROUND
310 // Print Top border line
311 // +------------------------------------------------------------------------------+
313 // +------------------------------------------------------------------------------+
315 Character
= BOXDRAW_DOWN_RIGHT
;
317 PrintChar (Character
);
318 PrintString (Buffer
);
320 Character
= BOXDRAW_DOWN_LEFT
;
321 PrintChar (Character
);
323 Character
= BOXDRAW_VERTICAL
;
324 for (Row
= LocalScreen
.TopRow
+ 1; Row
<= LocalScreen
.TopRow
+ NONE_FRONT_PAGE_HEADER_HEIGHT
- 2; Row
++) {
325 PrintCharAt (LocalScreen
.LeftColumn
, Row
, Character
);
326 PrintCharAt (LocalScreen
.RightColumn
- 1, Row
, Character
);
329 Character
= BOXDRAW_UP_RIGHT
;
330 PrintCharAt (LocalScreen
.LeftColumn
, LocalScreen
.TopRow
+ NONE_FRONT_PAGE_HEADER_HEIGHT
- 1, Character
);
331 PrintString (Buffer
);
333 Character
= BOXDRAW_UP_LEFT
;
334 PrintChar (Character
);
336 if ((gClassOfVfr
& FORMSET_CLASS_PLATFORM_SETUP
) == FORMSET_CLASS_PLATFORM_SETUP
) {
338 // Print Bottom border line
339 // +------------------------------------------------------------------------------+
341 // +------------------------------------------------------------------------------+
343 Character
= BOXDRAW_DOWN_RIGHT
;
344 PrintCharAt (LocalScreen
.LeftColumn
, LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- FOOTER_HEIGHT
, Character
);
346 PrintString (Buffer
);
348 Character
= BOXDRAW_DOWN_LEFT
;
349 PrintChar (Character
);
350 Character
= BOXDRAW_VERTICAL
;
351 for (Row
= LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- FOOTER_HEIGHT
+ 1;
352 Row
<= LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- 2;
355 PrintCharAt (LocalScreen
.LeftColumn
, Row
, Character
);
356 PrintCharAt (LocalScreen
.RightColumn
- 1, Row
, Character
);
359 Character
= BOXDRAW_UP_RIGHT
;
360 PrintCharAt (LocalScreen
.LeftColumn
, LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- 1, Character
);
362 PrintString (Buffer
);
364 Character
= BOXDRAW_UP_LEFT
;
365 PrintChar (Character
);
375 Evaluate all expressions in a Form.
377 @param FormSet FormSet this Form belongs to.
378 @param Form The Form.
380 @retval EFI_SUCCESS The expression evaluated successfuly
384 EvaluateFormExpressions (
385 IN FORM_BROWSER_FORMSET
*FormSet
,
386 IN FORM_BROWSER_FORM
*Form
391 FORM_EXPRESSION
*Expression
;
393 Link
= GetFirstNode (&Form
->ExpressionListHead
);
394 while (!IsNull (&Form
->ExpressionListHead
, Link
)) {
395 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
396 Link
= GetNextNode (&Form
->ExpressionListHead
, Link
);
398 if (Expression
->Type
== EFI_HII_EXPRESSION_INCONSISTENT_IF
||
399 Expression
->Type
== EFI_HII_EXPRESSION_NO_SUBMIT_IF
||
400 Expression
->Type
== EFI_HII_EXPRESSION_WRITE
||
401 (Expression
->Type
== EFI_HII_EXPRESSION_READ
&& Form
->FormType
!= STANDARD_MAP_FORM_TYPE
)) {
403 // Postpone Form validation to Question editing or Form submitting or Question Write or Question Read for nonstandard form.
408 Status
= EvaluateExpression (FormSet
, Form
, Expression
);
409 if (EFI_ERROR (Status
)) {
418 +------------------------------------------------------------------------------+
420 +------------------------------------------------------------------------------+
438 +------------------------------------------------------------------------------+
439 ?F1=Scroll Help F9=Reset to Defaults F10=Save and Exit ?
440 | ^"=Move Highlight <Spacebar> Toggles Checkbox Esc=Discard Changes |
441 +------------------------------------------------------------------------------+
447 Display form and wait for user to select one menu option, then return it.
449 @param Selection On input, Selection tell setup browser the information
450 about the Selection, form and formset to be displayed.
451 On output, Selection return the screen item that is selected
453 @retval EFI_SUCESSS This function always return successfully for now.
458 IN OUT UI_MENU_SELECTION
*Selection
462 UINT16 MenuItemCount
;
463 EFI_HII_HANDLE Handle
;
465 EFI_SCREEN_DESCRIPTOR LocalScreen
;
468 CHAR16
*OutputString
;
470 FORM_BROWSER_STATEMENT
*Statement
;
471 UINT16 NumberOfLines
;
473 UI_MENU_OPTION
*MenuOption
;
475 Handle
= Selection
->Handle
;
482 CopyMem (&LocalScreen
, &gScreenDimensions
, sizeof (EFI_SCREEN_DESCRIPTOR
));
484 StringPtr
= GetToken (Selection
->Form
->FormTitle
, Handle
);
486 if ((gClassOfVfr
& FORMSET_CLASS_FRONT_PAGE
) != FORMSET_CLASS_FRONT_PAGE
) {
487 gST
->ConOut
->SetAttribute (gST
->ConOut
, TITLE_TEXT
| TITLE_BACKGROUND
);
489 (LocalScreen
.RightColumn
+ LocalScreen
.LeftColumn
- GetStringWidth (StringPtr
) / 2) / 2,
490 LocalScreen
.TopRow
+ 1,
496 // Remove Buffer allocated for StringPtr after it has been used.
498 FreePool (StringPtr
);
501 // Evaluate all the Expressions in this Form
503 Status
= EvaluateFormExpressions (Selection
->FormSet
, Selection
->Form
);
504 if (EFI_ERROR (Status
)) {
508 Selection
->FormEditable
= FALSE
;
509 Link
= GetFirstNode (&Selection
->Form
->StatementListHead
);
510 while (!IsNull (&Selection
->Form
->StatementListHead
, Link
)) {
511 Statement
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
513 if (Statement
->SuppressExpression
!= NULL
) {
514 Suppress
= Statement
->SuppressExpression
->Result
.Value
.b
;
519 if (Statement
->DisableExpression
!= NULL
) {
520 Suppress
= (BOOLEAN
) (Suppress
|| Statement
->DisableExpression
->Result
.Value
.b
);
524 StringPtr
= GetToken (Statement
->Prompt
, Handle
);
526 Width
= GetWidth (Statement
, Handle
);
530 for (; GetLineByWidth (StringPtr
, Width
, &ArrayEntry
, &OutputString
) != 0x0000;) {
532 // If there is more string to process print on the next row and increment the Skip value
534 if (StrLen (&StringPtr
[ArrayEntry
]) != 0) {
538 FreePool (OutputString
);
542 // We are NOT!! removing this StringPtr buffer via FreePool since it is being used in the menuoptions, we will do
545 MenuOption
= UiAddMenuOption (StringPtr
, Selection
->Handle
, Statement
, NumberOfLines
, MenuItemCount
);
548 if (MenuOption
->IsQuestion
&& !MenuOption
->ReadOnly
) {
550 // At least one item is not readonly, this Form is considered as editable
552 Selection
->FormEditable
= TRUE
;
556 Link
= GetNextNode (&Selection
->Form
->StatementListHead
, Link
);
559 Status
= UiDisplayMenu (Selection
);
567 Initialize the HII String Token to the correct values.
571 InitializeBrowserStrings (
575 gFunctionNineString
= GetToken (STRING_TOKEN (FUNCTION_NINE_STRING
), gHiiHandle
);
576 gFunctionTenString
= GetToken (STRING_TOKEN (FUNCTION_TEN_STRING
), gHiiHandle
);
577 gEnterString
= GetToken (STRING_TOKEN (ENTER_STRING
), gHiiHandle
);
578 gEnterCommitString
= GetToken (STRING_TOKEN (ENTER_COMMIT_STRING
), gHiiHandle
);
579 gEnterEscapeString
= GetToken (STRING_TOKEN (ENTER_ESCAPE_STRING
), gHiiHandle
);
580 gEscapeString
= GetToken (STRING_TOKEN (ESCAPE_STRING
), gHiiHandle
);
581 gSaveFailed
= GetToken (STRING_TOKEN (SAVE_FAILED
), 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
);
609 Free up the resource allocated for all strings required
618 FreePool (gFunctionNineString
);
619 FreePool (gFunctionTenString
);
620 FreePool (gEnterString
);
621 FreePool (gEnterCommitString
);
622 FreePool (gEnterEscapeString
);
623 FreePool (gEscapeString
);
624 FreePool (gMoveHighlight
);
625 FreePool (gMakeSelection
);
626 FreePool (gDecNumericInput
);
627 FreePool (gHexNumericInput
);
628 FreePool (gToggleCheckBox
);
629 FreePool (gPromptForData
);
630 FreePool (gPromptForPassword
);
631 FreePool (gPromptForNewPassword
);
632 FreePool (gConfirmPassword
);
633 FreePool (gPassowordInvalid
);
634 FreePool (gConfirmError
);
635 FreePool (gPressEnter
);
636 FreePool (gEmptyString
);
637 FreePool (gAreYouSure
);
638 FreePool (gYesResponse
);
639 FreePool (gNoResponse
);
640 FreePool (gMiniString
);
641 FreePool (gPlusString
);
642 FreePool (gMinusString
);
643 FreePool (gAdjustNumber
);
644 FreePool (gSaveChanges
);
645 FreePool (gOptionMismatch
);
646 FreePool (gFormSuppress
);
652 Update key's help imformation.
654 @param Selection Tell setup browser the information about the Selection
655 @param MenuOption The Menu option
656 @param Selected Whether or not a tag be selected
661 IN UI_MENU_SELECTION
*Selection
,
662 IN UI_MENU_OPTION
*MenuOption
,
668 UINTN LeftColumnOfHelp
;
669 UINTN RightColumnOfHelp
;
671 UINTN BottomRowOfHelp
;
672 UINTN StartColumnOfHelp
;
673 EFI_SCREEN_DESCRIPTOR LocalScreen
;
674 FORM_BROWSER_STATEMENT
*Statement
;
676 CopyMem (&LocalScreen
, &gScreenDimensions
, sizeof (EFI_SCREEN_DESCRIPTOR
));
678 SecCol
= LocalScreen
.LeftColumn
+ (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
) / 3;
679 ThdCol
= LocalScreen
.LeftColumn
+ (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
) * 2 / 3;
681 StartColumnOfHelp
= LocalScreen
.LeftColumn
+ 2;
682 LeftColumnOfHelp
= LocalScreen
.LeftColumn
+ 1;
683 RightColumnOfHelp
= LocalScreen
.RightColumn
- 2;
684 TopRowOfHelp
= LocalScreen
.BottomRow
- 4;
685 BottomRowOfHelp
= LocalScreen
.BottomRow
- 3;
687 gST
->ConOut
->SetAttribute (gST
->ConOut
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
689 Statement
= MenuOption
->ThisTag
;
690 switch (Statement
->Operand
) {
691 case EFI_IFR_ORDERED_LIST_OP
:
692 case EFI_IFR_ONE_OF_OP
:
693 case EFI_IFR_NUMERIC_OP
:
694 case EFI_IFR_TIME_OP
:
695 case EFI_IFR_DATE_OP
:
696 ClearLines (LeftColumnOfHelp
, RightColumnOfHelp
, TopRowOfHelp
, BottomRowOfHelp
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
699 if ((gClassOfVfr
& FORMSET_CLASS_PLATFORM_SETUP
) == FORMSET_CLASS_PLATFORM_SETUP
) {
700 if (Selection
->FormEditable
) {
701 PrintStringAt (SecCol
, TopRowOfHelp
, gFunctionNineString
);
702 PrintStringAt (ThdCol
, TopRowOfHelp
, gFunctionTenString
);
704 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEscapeString
);
707 if ((Statement
->Operand
== EFI_IFR_DATE_OP
) ||
708 (Statement
->Operand
== EFI_IFR_TIME_OP
)) {
719 PrintStringAt (SecCol
, BottomRowOfHelp
, gEnterString
);
720 PrintStringAt (StartColumnOfHelp
, TopRowOfHelp
, gAdjustNumber
);
722 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
723 if (Statement
->Operand
== EFI_IFR_NUMERIC_OP
&& Statement
->Step
!= 0) {
724 PrintStringAt (StartColumnOfHelp
, TopRowOfHelp
, gAdjustNumber
);
726 PrintStringAt (SecCol
, BottomRowOfHelp
, gEnterString
);
729 PrintStringAt (SecCol
, BottomRowOfHelp
, gEnterCommitString
);
732 // If it is a selected numeric with manual input, display different message
734 if ((Statement
->Operand
== EFI_IFR_NUMERIC_OP
) ||
735 (Statement
->Operand
== EFI_IFR_DATE_OP
) ||
736 (Statement
->Operand
== EFI_IFR_TIME_OP
)) {
740 ((Statement
->Flags
& EFI_IFR_DISPLAY_UINT_HEX
) == EFI_IFR_DISPLAY_UINT_HEX
) ? gHexNumericInput
: gDecNumericInput
742 } else if (Statement
->Operand
!= EFI_IFR_ORDERED_LIST_OP
) {
743 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
746 if (Statement
->Operand
== EFI_IFR_ORDERED_LIST_OP
) {
747 PrintStringAt (StartColumnOfHelp
, TopRowOfHelp
, gPlusString
);
748 PrintStringAt (ThdCol
, TopRowOfHelp
, gMinusString
);
751 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEnterEscapeString
);
755 case EFI_IFR_CHECKBOX_OP
:
756 ClearLines (LeftColumnOfHelp
, RightColumnOfHelp
, TopRowOfHelp
, BottomRowOfHelp
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
758 if ((gClassOfVfr
& FORMSET_CLASS_PLATFORM_SETUP
) == FORMSET_CLASS_PLATFORM_SETUP
) {
759 if (Selection
->FormEditable
) {
760 PrintStringAt (SecCol
, TopRowOfHelp
, gFunctionNineString
);
761 PrintStringAt (ThdCol
, TopRowOfHelp
, gFunctionTenString
);
763 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEscapeString
);
766 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
767 PrintStringAt (SecCol
, BottomRowOfHelp
, gToggleCheckBox
);
771 case EFI_IFR_PASSWORD_OP
:
772 case EFI_IFR_STRING_OP
:
773 case EFI_IFR_TEXT_OP
:
774 case EFI_IFR_ACTION_OP
:
775 case EFI_IFR_RESET_BUTTON_OP
:
776 case EFI_IFR_SUBTITLE_OP
:
777 ClearLines (LeftColumnOfHelp
, RightColumnOfHelp
, TopRowOfHelp
, BottomRowOfHelp
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
780 if ((gClassOfVfr
& FORMSET_CLASS_PLATFORM_SETUP
) == FORMSET_CLASS_PLATFORM_SETUP
) {
781 if (Selection
->FormEditable
) {
782 PrintStringAt (SecCol
, TopRowOfHelp
, gFunctionNineString
);
783 PrintStringAt (ThdCol
, TopRowOfHelp
, gFunctionTenString
);
785 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEscapeString
);
788 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
789 if (Statement
->Operand
!= EFI_IFR_TEXT_OP
&& Statement
->Operand
!= EFI_IFR_SUBTITLE_OP
) {
790 PrintStringAt (SecCol
, BottomRowOfHelp
, gEnterString
);
793 if (Statement
->Operand
!= EFI_IFR_REF_OP
) {
795 (LocalScreen
.RightColumn
- GetStringWidth (gEnterCommitString
) / 2) / 2,
799 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEnterEscapeString
);
810 Functions which are registered to receive notification of
811 database events have this prototype. The actual event is encoded
812 in NotifyType. The following table describes how PackageType,
813 PackageGuid, Handle, and Package are used for each of the
816 @param PackageType Package type of the notification.
818 @param PackageGuid If PackageType is
819 EFI_HII_PACKAGE_TYPE_GUID, then this is
820 the pointer to the GUID from the Guid
821 field of EFI_HII_PACKAGE_GUID_HEADER.
822 Otherwise, it must be NULL.
824 @param Package Points to the package referred to by the
825 notification Handle The handle of the package
826 list which contains the specified package.
828 @param Handle The HII handle.
830 @param NotifyType The type of change concerning the
832 EFI_HII_DATABASE_NOTIFY_TYPE.
838 IN UINT8 PackageType
,
839 IN CONST EFI_GUID
*PackageGuid
,
840 IN CONST EFI_HII_PACKAGE_HEADER
*Package
,
841 IN EFI_HII_HANDLE Handle
,
842 IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType
845 mHiiPackageListUpdated
= TRUE
;
851 check whether the formset need to update the NV.
853 @param FormSet FormSet data structure.
855 @retval TRUE Need to update the NV.
856 @retval FALSE No need to update the NV.
860 IN FORM_BROWSER_FORMSET
*FormSet
864 FORM_BROWSER_FORM
*Form
;
866 Link
= GetFirstNode (&FormSet
->FormListHead
);
867 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
868 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
870 if (Form
->NvUpdateRequired
) {
874 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
881 check whether the formset need to update the NV.
883 @param FormSet FormSet data structure.
884 @param SetValue Whether set new value or clear old value.
889 IN FORM_BROWSER_FORMSET
*FormSet
,
894 FORM_BROWSER_FORM
*Form
;
896 Link
= GetFirstNode (&FormSet
->FormListHead
);
897 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
898 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
900 Form
->NvUpdateRequired
= SetValue
;
902 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
906 Find menu which will show next time.
908 @param Selection On input, Selection tell setup browser the information
909 about the Selection, form and formset to be displayed.
910 On output, Selection return the screen item that is selected
912 @param Repaint Whether need to repaint the menu.
913 @param NewLine Whether need to show at new line.
915 @retval TRUE Need return.
916 @retval FALSE No need to return.
920 IN OUT UI_MENU_SELECTION
*Selection
,
925 UI_MENU_LIST
*CurrentMenu
;
931 CurrentMenu
= Selection
->CurrentMenu
;
933 if (CurrentMenu
!= NULL
&& CurrentMenu
->Parent
!= NULL
) {
935 // we have a parent, so go to the parent menu
937 if (CompareGuid (&CurrentMenu
->FormSetGuid
, &CurrentMenu
->Parent
->FormSetGuid
)) {
939 // The parent menu and current menu are in the same formset
941 Selection
->Action
= UI_ACTION_REFRESH_FORM
;
943 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
945 Selection
->Statement
= NULL
;
947 Selection
->FormId
= CurrentMenu
->Parent
->FormId
;
948 Selection
->QuestionId
= CurrentMenu
->Parent
->QuestionId
;
951 // Clear highlight record for this menu
953 CurrentMenu
->QuestionId
= 0;
957 if ((gClassOfVfr
& FORMSET_CLASS_FRONT_PAGE
) == FORMSET_CLASS_FRONT_PAGE
) {
959 // We never exit FrontPage, so skip the ESC
961 Selection
->Action
= UI_ACTION_NONE
;
966 // We are going to leave current FormSet, so check uncommited data in this FormSet
968 if (IsNvUpdateRequired(Selection
->FormSet
)) {
969 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
971 YesResponse
= gYesResponse
[0];
972 NoResponse
= gNoResponse
[0];
975 // If NV flag is up, prompt user
978 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, gSaveChanges
, gAreYouSure
, gEmptyString
);
981 (Key
.ScanCode
!= SCAN_ESC
) &&
982 ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (NoResponse
| UPPER_LOWER_CASE_OFFSET
)) &&
983 ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (YesResponse
| UPPER_LOWER_CASE_OFFSET
))
986 if (Key
.ScanCode
== SCAN_ESC
) {
988 // User hits the ESC key
990 if (Repaint
!= NULL
) {
994 if (NewLine
!= NULL
) {
998 Selection
->Action
= UI_ACTION_NONE
;
1003 // If the user hits the YesResponse key
1005 if ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) == (YesResponse
| UPPER_LOWER_CASE_OFFSET
)) {
1006 Status
= SubmitForm (Selection
->FormSet
, Selection
->Form
, FALSE
);
1010 Selection
->Statement
= NULL
;
1011 CurrentMenu
->QuestionId
= 0;
1013 Selection
->Action
= UI_ACTION_EXIT
;
1018 Call the call back function for the question and process the return action.
1020 @param Selection On input, Selection tell setup browser the information
1021 about the Selection, form and formset to be displayed.
1022 On output, Selection return the screen item that is selected
1024 @param Question The Question which need to call.
1025 @param Action The action request.
1026 @param SkipSaveOrDiscard Whether skip save or discard action.
1028 @retval EFI_SUCCESS The call back function excutes successfully.
1029 @return Other value if the call back function failed to excute.
1032 ProcessCallBackFunction (
1033 IN OUT UI_MENU_SELECTION
*Selection
,
1034 IN FORM_BROWSER_STATEMENT
*Question
,
1035 IN EFI_BROWSER_ACTION Action
,
1036 IN BOOLEAN SkipSaveOrDiscard
1040 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
1041 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
1042 EFI_HII_VALUE
*HiiValue
;
1043 EFI_IFR_TYPE_VALUE
*TypeValue
;
1044 FORM_BROWSER_STATEMENT
*Statement
;
1045 BOOLEAN SubmitFormIsRequired
;
1047 BOOLEAN DiscardFormIsRequired
;
1051 ConfigAccess
= Selection
->FormSet
->ConfigAccess
;
1052 SubmitFormIsRequired
= FALSE
;
1054 DiscardFormIsRequired
= FALSE
;
1056 Status
= EFI_SUCCESS
;
1057 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
1059 if (ConfigAccess
== NULL
) {
1063 Link
= GetFirstNode (&Selection
->Form
->StatementListHead
);
1064 while (!IsNull (&Selection
->Form
->StatementListHead
, Link
)) {
1065 Statement
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
1066 Link
= GetNextNode (&Selection
->Form
->StatementListHead
, Link
);
1069 // if Question != NULL, only process the question. Else, process all question in this form.
1071 if ((Question
!= NULL
) && (Statement
!= Question
)) {
1075 if ((Statement
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != EFI_IFR_FLAG_CALLBACK
) {
1080 // Check whether Statement is disabled.
1082 if (Statement
->DisableExpression
!= NULL
) {
1083 Status
= EvaluateExpression (Selection
->FormSet
, Selection
->Form
, Statement
->DisableExpression
);
1084 if (!EFI_ERROR (Status
) &&
1085 (Statement
->DisableExpression
->Result
.Type
== EFI_IFR_TYPE_BOOLEAN
) &&
1086 (Statement
->DisableExpression
->Result
.Value
.b
)) {
1091 HiiValue
= &Statement
->HiiValue
;
1092 TypeValue
= &HiiValue
->Value
;
1093 if (HiiValue
->Type
== EFI_IFR_TYPE_BUFFER
) {
1095 // For OrderedList, passing in the value buffer to Callback()
1097 TypeValue
= (EFI_IFR_TYPE_VALUE
*) Statement
->BufferValue
;
1100 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
1101 Status
= ConfigAccess
->Callback (
1104 Statement
->QuestionId
,
1109 if (!EFI_ERROR (Status
)) {
1110 switch (ActionRequest
) {
1111 case EFI_BROWSER_ACTION_REQUEST_RESET
:
1112 gResetRequired
= TRUE
;
1115 case EFI_BROWSER_ACTION_REQUEST_SUBMIT
:
1116 SubmitFormIsRequired
= TRUE
;
1119 case EFI_BROWSER_ACTION_REQUEST_EXIT
:
1120 Selection
->Action
= UI_ACTION_EXIT
;
1123 case EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT
:
1124 SubmitFormIsRequired
= TRUE
;
1129 case EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT
:
1130 DiscardFormIsRequired
= TRUE
;
1135 case EFI_BROWSER_ACTION_REQUEST_FORM_APPLY
:
1136 SubmitFormIsRequired
= TRUE
;
1140 case EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD
:
1141 DiscardFormIsRequired
= TRUE
;
1148 } else if (Status
== EFI_UNSUPPORTED
) {
1150 // If return EFI_UNSUPPORTED, also consider Hii driver suceess deal with it.
1152 Status
= EFI_SUCCESS
;
1156 if (SubmitFormIsRequired
&& !SkipSaveOrDiscard
) {
1157 SubmitForm (Selection
->FormSet
, Selection
->Form
, SingleForm
);
1160 if (DiscardFormIsRequired
&& !SkipSaveOrDiscard
) {
1161 DiscardForm (Selection
->FormSet
, Selection
->Form
, SingleForm
);
1165 FindNextMenu (Selection
, NULL
, NULL
);
1172 The worker function that send the displays to the screen. On output,
1173 the selection made by user is returned.
1175 @param Selection On input, Selection tell setup browser the information
1176 about the Selection, form and formset to be displayed.
1177 On output, Selection return the screen item that is selected
1180 @retval EFI_SUCCESS The page is displayed successfully.
1181 @return Other value if the page failed to be diplayed.
1186 IN OUT UI_MENU_SELECTION
*Selection
1191 EFI_HANDLE NotifyHandle
;
1192 FORM_BROWSER_STATEMENT
*Statement
;
1193 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
1194 FORM_BROWSER_FORMSET
*FormSet
;
1197 gMenuRefreshHead
= NULL
;
1198 gResetRequired
= FALSE
;
1199 FormSet
= Selection
->FormSet
;
1200 ConfigAccess
= Selection
->FormSet
->ConfigAccess
;
1203 // Register notify for Form package update
1205 Status
= mHiiDatabase
->RegisterPackageNotify (
1207 EFI_HII_PACKAGE_FORMS
,
1210 EFI_HII_DATABASE_NOTIFY_REMOVE_PACK
,
1213 if (EFI_ERROR (Status
)) {
1218 // Initialize current settings of Questions in this FormSet
1220 Status
= InitializeCurrentSetting (Selection
->FormSet
);
1221 if (EFI_ERROR (Status
)) {
1227 // Initialize Selection->Form
1229 if (Selection
->FormId
== 0) {
1231 // Zero FormId indicates display the first Form in a FormSet
1233 Link
= GetFirstNode (&Selection
->FormSet
->FormListHead
);
1235 Selection
->Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
1236 Selection
->FormId
= Selection
->Form
->FormId
;
1238 Selection
->Form
= IdToForm (Selection
->FormSet
, Selection
->FormId
);
1241 if (Selection
->Form
== NULL
) {
1243 // No Form to display
1245 Status
= EFI_NOT_FOUND
;
1250 // Check Form is suppressed.
1252 if (Selection
->Form
->SuppressExpression
!= NULL
) {
1253 Status
= EvaluateExpression (Selection
->FormSet
, Selection
->Form
, Selection
->Form
->SuppressExpression
);
1254 if (EFI_ERROR (Status
) || (Selection
->Form
->SuppressExpression
->Result
.Type
!= EFI_IFR_TYPE_BOOLEAN
)) {
1255 Status
= EFI_INVALID_PARAMETER
;
1259 if (Selection
->Form
->SuppressExpression
->Result
.Value
.b
) {
1261 // Form is suppressed.
1264 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, gFormSuppress
, gPressEnter
, gEmptyString
);
1265 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
1267 Status
= EFI_NOT_FOUND
;
1273 // Reset FormPackage update flag
1275 mHiiPackageListUpdated
= FALSE
;
1278 // Before display new form, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_OPEN
1279 // for each question with callback flag.
1280 // New form may be the first form, or the different form after another form close.
1282 if ((ConfigAccess
!= NULL
) &&
1283 ((Selection
->Handle
!= mCurrentHiiHandle
) ||
1284 (!CompareGuid (&Selection
->FormSetGuid
, &mCurrentFormSetGuid
)) ||
1285 (Selection
->FormId
!= mCurrentFormId
))) {
1288 // Keep current form information
1290 mCurrentHiiHandle
= Selection
->Handle
;
1291 CopyGuid (&mCurrentFormSetGuid
, &Selection
->FormSetGuid
);
1292 mCurrentFormId
= Selection
->FormId
;
1294 Status
= ProcessCallBackFunction (Selection
, NULL
, EFI_BROWSER_ACTION_FORM_OPEN
, FALSE
);
1295 if (EFI_ERROR (Status
)) {
1300 // EXIT requests to close form.
1302 if (Selection
->Action
== UI_ACTION_EXIT
) {
1306 // IFR is updated during callback of open form, force to reparse the IFR binary
1308 if (mHiiPackageListUpdated
) {
1309 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
1310 mHiiPackageListUpdated
= FALSE
;
1316 // Load Questions' Value for display
1318 Status
= LoadFormSetConfig (Selection
, Selection
->FormSet
);
1319 if (EFI_ERROR (Status
)) {
1324 // EXIT requests to close form.
1326 if (Selection
->Action
== UI_ACTION_EXIT
) {
1330 // IFR is updated during callback of read value, force to reparse the IFR binary
1332 if (mHiiPackageListUpdated
) {
1333 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
1334 mHiiPackageListUpdated
= FALSE
;
1339 // Displays the Header and Footer borders
1341 DisplayPageFrame ();
1346 Status
= DisplayForm (Selection
);
1347 if (EFI_ERROR (Status
)) {
1352 // Check Selected Statement (if press ESC, Selection->Statement will be NULL)
1354 Statement
= Selection
->Statement
;
1355 if (Statement
!= NULL
) {
1356 if ((Statement
->QuestionFlags
& EFI_IFR_FLAG_RESET_REQUIRED
) == EFI_IFR_FLAG_RESET_REQUIRED
) {
1357 gResetRequired
= TRUE
;
1361 // Reset FormPackage update flag
1363 mHiiPackageListUpdated
= FALSE
;
1365 if ((ConfigAccess
!= NULL
) &&
1366 ((Statement
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) == EFI_IFR_FLAG_CALLBACK
) &&
1367 (Statement
->Operand
!= EFI_IFR_PASSWORD_OP
)) {
1369 Status
= ProcessCallBackFunction(Selection
, Statement
, EFI_BROWSER_ACTION_CHANGING
, FALSE
);
1370 if ((EFI_ERROR (Status
)) && (Status
!= EFI_UNSUPPORTED
)) {
1372 // Callback return error status other than EFI_UNSUPPORTED
1374 if (Statement
->Operand
== EFI_IFR_REF_OP
) {
1376 // Cross reference will not be taken
1378 Selection
->FormId
= Selection
->Form
->FormId
;
1379 Selection
->QuestionId
= 0;
1385 // Check whether Form Package has been updated during Callback
1387 if (mHiiPackageListUpdated
&& (Selection
->Action
== UI_ACTION_REFRESH_FORM
)) {
1389 // Force to reparse IFR binary of target Formset
1391 mHiiPackageListUpdated
= FALSE
;
1392 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
1397 // Before exit the form, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_CLOSE
1398 // for each question with callback flag.
1400 if ((ConfigAccess
!= NULL
) &&
1401 ((Selection
->Action
== UI_ACTION_EXIT
) ||
1402 (Selection
->Handle
!= mCurrentHiiHandle
) ||
1403 (!CompareGuid (&Selection
->FormSetGuid
, &mCurrentFormSetGuid
)) ||
1404 (Selection
->FormId
!= mCurrentFormId
))) {
1406 Status
= ProcessCallBackFunction (Selection
, NULL
, EFI_BROWSER_ACTION_FORM_CLOSE
, FALSE
);
1407 if (EFI_ERROR (Status
)) {
1411 } while (Selection
->Action
== UI_ACTION_REFRESH_FORM
);
1414 // Record the old formset
1416 if (gOldFormSet
!= NULL
) {
1417 DestroyFormSet (gOldFormSet
);
1419 gOldFormSet
= FormSet
;
1423 // Reset current form information to the initial setting when error happens or form exit.
1425 if (EFI_ERROR (Status
) || Selection
->Action
== UI_ACTION_EXIT
) {
1426 mCurrentHiiHandle
= NULL
;
1427 CopyGuid (&mCurrentFormSetGuid
, &gZeroGuid
);
1432 // Unregister notify for Form package update
1434 mHiiDatabase
->UnregisterPackageNotify (