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.
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
- FOOTER_HEIGHT
,
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
- FOOTER_HEIGHT
, Character
);
353 PrintString (Buffer
);
355 Character
= BOXDRAW_DOWN_LEFT
;
356 PrintChar (Character
);
357 Character
= BOXDRAW_VERTICAL
;
358 for (Row
= LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- FOOTER_HEIGHT
+ 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
;
472 EFI_SCREEN_DESCRIPTOR LocalScreen
;
475 CHAR16
*OutputString
;
477 FORM_BROWSER_STATEMENT
*Statement
;
478 UINT16 NumberOfLines
;
480 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 (Statement
->SuppressExpression
!= NULL
) {
525 Suppress
= Statement
->SuppressExpression
->Result
.Value
.b
;
530 if (Statement
->DisableExpression
!= NULL
) {
531 Suppress
= (BOOLEAN
) (Suppress
|| Statement
->DisableExpression
->Result
.Value
.b
);
535 StringPtr
= GetToken (Statement
->Prompt
, Handle
);
537 Width
= GetWidth (Statement
, Handle
);
541 for (; GetLineByWidth (StringPtr
, Width
, &ArrayEntry
, &OutputString
) != 0x0000;) {
543 // If there is more string to process print on the next row and increment the Skip value
545 if (StrLen (&StringPtr
[ArrayEntry
]) != 0) {
549 FreePool (OutputString
);
553 // We are NOT!! removing this StringPtr buffer via FreePool since it is being used in the menuoptions, we will do
556 MenuOption
= UiAddMenuOption (StringPtr
, Selection
->Handle
, Statement
, NumberOfLines
, MenuItemCount
);
559 if (MenuOption
->IsQuestion
&& !MenuOption
->ReadOnly
) {
561 // At least one item is not readonly, this Form is considered as editable
563 Selection
->FormEditable
= TRUE
;
567 Link
= GetNextNode (&Selection
->Form
->StatementListHead
, Link
);
570 Status
= UiDisplayMenu (Selection
);
578 Initialize the HII String Token to the correct values.
582 InitializeBrowserStrings (
586 gFunctionNineString
= GetToken (STRING_TOKEN (FUNCTION_NINE_STRING
), gHiiHandle
);
587 gFunctionTenString
= GetToken (STRING_TOKEN (FUNCTION_TEN_STRING
), gHiiHandle
);
588 gEnterString
= GetToken (STRING_TOKEN (ENTER_STRING
), gHiiHandle
);
589 gEnterCommitString
= GetToken (STRING_TOKEN (ENTER_COMMIT_STRING
), gHiiHandle
);
590 gEnterEscapeString
= GetToken (STRING_TOKEN (ENTER_ESCAPE_STRING
), gHiiHandle
);
591 gEscapeString
= GetToken (STRING_TOKEN (ESCAPE_STRING
), gHiiHandle
);
592 gSaveFailed
= GetToken (STRING_TOKEN (SAVE_FAILED
), gHiiHandle
);
593 gMoveHighlight
= GetToken (STRING_TOKEN (MOVE_HIGHLIGHT
), gHiiHandle
);
594 gMakeSelection
= GetToken (STRING_TOKEN (MAKE_SELECTION
), gHiiHandle
);
595 gDecNumericInput
= GetToken (STRING_TOKEN (DEC_NUMERIC_INPUT
), gHiiHandle
);
596 gHexNumericInput
= GetToken (STRING_TOKEN (HEX_NUMERIC_INPUT
), gHiiHandle
);
597 gToggleCheckBox
= GetToken (STRING_TOKEN (TOGGLE_CHECK_BOX
), gHiiHandle
);
598 gPromptForData
= GetToken (STRING_TOKEN (PROMPT_FOR_DATA
), gHiiHandle
);
599 gPromptForPassword
= GetToken (STRING_TOKEN (PROMPT_FOR_PASSWORD
), gHiiHandle
);
600 gPromptForNewPassword
= GetToken (STRING_TOKEN (PROMPT_FOR_NEW_PASSWORD
), gHiiHandle
);
601 gConfirmPassword
= GetToken (STRING_TOKEN (CONFIRM_PASSWORD
), gHiiHandle
);
602 gConfirmError
= GetToken (STRING_TOKEN (CONFIRM_ERROR
), gHiiHandle
);
603 gPassowordInvalid
= GetToken (STRING_TOKEN (PASSWORD_INVALID
), gHiiHandle
);
604 gPressEnter
= GetToken (STRING_TOKEN (PRESS_ENTER
), gHiiHandle
);
605 gEmptyString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
606 gAreYouSure
= GetToken (STRING_TOKEN (ARE_YOU_SURE
), gHiiHandle
);
607 gYesResponse
= GetToken (STRING_TOKEN (ARE_YOU_SURE_YES
), gHiiHandle
);
608 gNoResponse
= GetToken (STRING_TOKEN (ARE_YOU_SURE_NO
), gHiiHandle
);
609 gMiniString
= GetToken (STRING_TOKEN (MINI_STRING
), gHiiHandle
);
610 gPlusString
= GetToken (STRING_TOKEN (PLUS_STRING
), gHiiHandle
);
611 gMinusString
= GetToken (STRING_TOKEN (MINUS_STRING
), gHiiHandle
);
612 gAdjustNumber
= GetToken (STRING_TOKEN (ADJUST_NUMBER
), gHiiHandle
);
613 gSaveChanges
= GetToken (STRING_TOKEN (SAVE_CHANGES
), gHiiHandle
);
614 gOptionMismatch
= GetToken (STRING_TOKEN (OPTION_MISMATCH
), gHiiHandle
);
615 gFormSuppress
= GetToken (STRING_TOKEN (FORM_SUPPRESSED
), gHiiHandle
);
620 Free up the resource allocated for all strings required
629 FreePool (gFunctionNineString
);
630 FreePool (gFunctionTenString
);
631 FreePool (gEnterString
);
632 FreePool (gEnterCommitString
);
633 FreePool (gEnterEscapeString
);
634 FreePool (gEscapeString
);
635 FreePool (gMoveHighlight
);
636 FreePool (gMakeSelection
);
637 FreePool (gDecNumericInput
);
638 FreePool (gHexNumericInput
);
639 FreePool (gToggleCheckBox
);
640 FreePool (gPromptForData
);
641 FreePool (gPromptForPassword
);
642 FreePool (gPromptForNewPassword
);
643 FreePool (gConfirmPassword
);
644 FreePool (gPassowordInvalid
);
645 FreePool (gConfirmError
);
646 FreePool (gPressEnter
);
647 FreePool (gEmptyString
);
648 FreePool (gAreYouSure
);
649 FreePool (gYesResponse
);
650 FreePool (gNoResponse
);
651 FreePool (gMiniString
);
652 FreePool (gPlusString
);
653 FreePool (gMinusString
);
654 FreePool (gAdjustNumber
);
655 FreePool (gSaveChanges
);
656 FreePool (gOptionMismatch
);
657 FreePool (gFormSuppress
);
663 Update key's help imformation.
665 @param Selection Tell setup browser the information about the Selection
666 @param MenuOption The Menu option
667 @param Selected Whether or not a tag be selected
672 IN UI_MENU_SELECTION
*Selection
,
673 IN UI_MENU_OPTION
*MenuOption
,
679 UINTN LeftColumnOfHelp
;
680 UINTN RightColumnOfHelp
;
682 UINTN BottomRowOfHelp
;
683 UINTN StartColumnOfHelp
;
684 EFI_SCREEN_DESCRIPTOR LocalScreen
;
685 FORM_BROWSER_STATEMENT
*Statement
;
687 gST
->ConOut
->SetAttribute (gST
->ConOut
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
689 if (Selection
->Form
->ModalForm
) {
693 CopyMem (&LocalScreen
, &gScreenDimensions
, sizeof (EFI_SCREEN_DESCRIPTOR
));
695 SecCol
= LocalScreen
.LeftColumn
+ (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
) / 3;
696 ThdCol
= LocalScreen
.LeftColumn
+ (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
) * 2 / 3;
698 StartColumnOfHelp
= LocalScreen
.LeftColumn
+ 2;
699 LeftColumnOfHelp
= LocalScreen
.LeftColumn
+ 1;
700 RightColumnOfHelp
= LocalScreen
.RightColumn
- 2;
701 TopRowOfHelp
= LocalScreen
.BottomRow
- 4;
702 BottomRowOfHelp
= LocalScreen
.BottomRow
- 3;
704 Statement
= MenuOption
->ThisTag
;
705 switch (Statement
->Operand
) {
706 case EFI_IFR_ORDERED_LIST_OP
:
707 case EFI_IFR_ONE_OF_OP
:
708 case EFI_IFR_NUMERIC_OP
:
709 case EFI_IFR_TIME_OP
:
710 case EFI_IFR_DATE_OP
:
711 ClearLines (LeftColumnOfHelp
, RightColumnOfHelp
, TopRowOfHelp
, BottomRowOfHelp
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
714 if ((gClassOfVfr
& FORMSET_CLASS_PLATFORM_SETUP
) == FORMSET_CLASS_PLATFORM_SETUP
) {
715 if (Selection
->FormEditable
) {
716 PrintStringAt (SecCol
, TopRowOfHelp
, gFunctionNineString
);
717 PrintStringAt (ThdCol
, TopRowOfHelp
, gFunctionTenString
);
719 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEscapeString
);
722 if ((Statement
->Operand
== EFI_IFR_DATE_OP
) ||
723 (Statement
->Operand
== EFI_IFR_TIME_OP
)) {
734 PrintStringAt (SecCol
, BottomRowOfHelp
, gEnterString
);
735 PrintStringAt (StartColumnOfHelp
, TopRowOfHelp
, gAdjustNumber
);
737 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
738 if (Statement
->Operand
== EFI_IFR_NUMERIC_OP
&& Statement
->Step
!= 0) {
739 PrintStringAt (StartColumnOfHelp
, TopRowOfHelp
, gAdjustNumber
);
741 PrintStringAt (SecCol
, BottomRowOfHelp
, gEnterString
);
744 PrintStringAt (SecCol
, BottomRowOfHelp
, gEnterCommitString
);
747 // If it is a selected numeric with manual input, display different message
749 if ((Statement
->Operand
== EFI_IFR_NUMERIC_OP
) ||
750 (Statement
->Operand
== EFI_IFR_DATE_OP
) ||
751 (Statement
->Operand
== EFI_IFR_TIME_OP
)) {
755 ((Statement
->Flags
& EFI_IFR_DISPLAY_UINT_HEX
) == EFI_IFR_DISPLAY_UINT_HEX
) ? gHexNumericInput
: gDecNumericInput
757 } else if (Statement
->Operand
!= EFI_IFR_ORDERED_LIST_OP
) {
758 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
761 if (Statement
->Operand
== EFI_IFR_ORDERED_LIST_OP
) {
762 PrintStringAt (StartColumnOfHelp
, TopRowOfHelp
, gPlusString
);
763 PrintStringAt (ThdCol
, TopRowOfHelp
, gMinusString
);
766 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEnterEscapeString
);
770 case EFI_IFR_CHECKBOX_OP
:
771 ClearLines (LeftColumnOfHelp
, RightColumnOfHelp
, TopRowOfHelp
, BottomRowOfHelp
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
773 if ((gClassOfVfr
& FORMSET_CLASS_PLATFORM_SETUP
) == FORMSET_CLASS_PLATFORM_SETUP
) {
774 if (Selection
->FormEditable
) {
775 PrintStringAt (SecCol
, TopRowOfHelp
, gFunctionNineString
);
776 PrintStringAt (ThdCol
, TopRowOfHelp
, gFunctionTenString
);
778 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEscapeString
);
781 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
782 PrintStringAt (SecCol
, BottomRowOfHelp
, gToggleCheckBox
);
786 case EFI_IFR_PASSWORD_OP
:
787 case EFI_IFR_STRING_OP
:
788 case EFI_IFR_TEXT_OP
:
789 case EFI_IFR_ACTION_OP
:
790 case EFI_IFR_RESET_BUTTON_OP
:
791 case EFI_IFR_SUBTITLE_OP
:
792 ClearLines (LeftColumnOfHelp
, RightColumnOfHelp
, TopRowOfHelp
, BottomRowOfHelp
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
795 if ((gClassOfVfr
& FORMSET_CLASS_PLATFORM_SETUP
) == FORMSET_CLASS_PLATFORM_SETUP
) {
796 if (Selection
->FormEditable
) {
797 PrintStringAt (SecCol
, TopRowOfHelp
, gFunctionNineString
);
798 PrintStringAt (ThdCol
, TopRowOfHelp
, gFunctionTenString
);
800 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEscapeString
);
803 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
804 if (Statement
->Operand
!= EFI_IFR_TEXT_OP
&& Statement
->Operand
!= EFI_IFR_SUBTITLE_OP
) {
805 PrintStringAt (SecCol
, BottomRowOfHelp
, gEnterString
);
808 if (Statement
->Operand
!= EFI_IFR_REF_OP
) {
810 (LocalScreen
.RightColumn
- GetStringWidth (gEnterCommitString
) / 2) / 2,
814 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEnterEscapeString
);
825 Functions which are registered to receive notification of
826 database events have this prototype. The actual event is encoded
827 in NotifyType. The following table describes how PackageType,
828 PackageGuid, Handle, and Package are used for each of the
831 @param PackageType Package type of the notification.
833 @param PackageGuid If PackageType is
834 EFI_HII_PACKAGE_TYPE_GUID, then this is
835 the pointer to the GUID from the Guid
836 field of EFI_HII_PACKAGE_GUID_HEADER.
837 Otherwise, it must be NULL.
839 @param Package Points to the package referred to by the
840 notification Handle The handle of the package
841 list which contains the specified package.
843 @param Handle The HII handle.
845 @param NotifyType The type of change concerning the
847 EFI_HII_DATABASE_NOTIFY_TYPE.
853 IN UINT8 PackageType
,
854 IN CONST EFI_GUID
*PackageGuid
,
855 IN CONST EFI_HII_PACKAGE_HEADER
*Package
,
856 IN EFI_HII_HANDLE Handle
,
857 IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType
860 mHiiPackageListUpdated
= TRUE
;
866 check whether the formset need to update the NV.
868 @param FormSet FormSet data structure.
870 @retval TRUE Need to update the NV.
871 @retval FALSE No need to update the NV.
875 IN FORM_BROWSER_FORMSET
*FormSet
879 FORM_BROWSER_FORM
*Form
;
881 Link
= GetFirstNode (&FormSet
->FormListHead
);
882 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
883 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
885 if (Form
->NvUpdateRequired
) {
889 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
896 check whether the formset need to update the NV.
898 @param FormSet FormSet data structure.
899 @param SetValue Whether set new value or clear old value.
904 IN FORM_BROWSER_FORMSET
*FormSet
,
909 FORM_BROWSER_FORM
*Form
;
911 Link
= GetFirstNode (&FormSet
->FormListHead
);
912 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
913 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
915 Form
->NvUpdateRequired
= SetValue
;
917 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
921 Find menu which will show next time.
923 @param Selection On input, Selection tell setup browser the information
924 about the Selection, form and formset to be displayed.
925 On output, Selection return the screen item that is selected
927 @param Repaint Whether need to repaint the menu.
928 @param NewLine Whether need to show at new line.
930 @retval TRUE Need return.
931 @retval FALSE No need to return.
935 IN OUT UI_MENU_SELECTION
*Selection
,
940 UI_MENU_LIST
*CurrentMenu
;
946 CurrentMenu
= Selection
->CurrentMenu
;
948 if (CurrentMenu
!= NULL
&& CurrentMenu
->Parent
!= NULL
) {
950 // we have a parent, so go to the parent menu
952 if (CompareGuid (&CurrentMenu
->FormSetGuid
, &CurrentMenu
->Parent
->FormSetGuid
)) {
954 // The parent menu and current menu are in the same formset
956 Selection
->Action
= UI_ACTION_REFRESH_FORM
;
958 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
960 Selection
->Statement
= NULL
;
962 Selection
->FormId
= CurrentMenu
->Parent
->FormId
;
963 Selection
->QuestionId
= CurrentMenu
->Parent
->QuestionId
;
966 // Clear highlight record for this menu
968 CurrentMenu
->QuestionId
= 0;
972 if ((gClassOfVfr
& FORMSET_CLASS_FRONT_PAGE
) == FORMSET_CLASS_FRONT_PAGE
) {
974 // We never exit FrontPage, so skip the ESC
976 Selection
->Action
= UI_ACTION_NONE
;
981 // We are going to leave current FormSet, so check uncommited data in this FormSet
983 if (IsNvUpdateRequired(Selection
->FormSet
)) {
984 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
986 YesResponse
= gYesResponse
[0];
987 NoResponse
= gNoResponse
[0];
990 // If NV flag is up, prompt user
993 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, gSaveChanges
, gAreYouSure
, gEmptyString
);
996 (Key
.ScanCode
!= SCAN_ESC
) &&
997 ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (NoResponse
| UPPER_LOWER_CASE_OFFSET
)) &&
998 ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (YesResponse
| UPPER_LOWER_CASE_OFFSET
))
1001 if (Key
.ScanCode
== SCAN_ESC
) {
1003 // User hits the ESC key
1005 if (Repaint
!= NULL
) {
1009 if (NewLine
!= NULL
) {
1013 Selection
->Action
= UI_ACTION_NONE
;
1018 // If the user hits the YesResponse key
1020 if ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) == (YesResponse
| UPPER_LOWER_CASE_OFFSET
)) {
1021 Status
= SubmitForm (Selection
->FormSet
, Selection
->Form
, FALSE
);
1025 Selection
->Statement
= NULL
;
1026 if (CurrentMenu
!= NULL
) {
1027 CurrentMenu
->QuestionId
= 0;
1030 Selection
->Action
= UI_ACTION_EXIT
;
1035 Call the call back function for the question and process the return action.
1037 @param Selection On input, Selection tell setup browser the information
1038 about the Selection, form and formset to be displayed.
1039 On output, Selection return the screen item that is selected
1041 @param Question The Question which need to call.
1042 @param Action The action request.
1043 @param SkipSaveOrDiscard Whether skip save or discard action.
1045 @retval EFI_SUCCESS The call back function excutes successfully.
1046 @return Other value if the call back function failed to excute.
1049 ProcessCallBackFunction (
1050 IN OUT UI_MENU_SELECTION
*Selection
,
1051 IN FORM_BROWSER_STATEMENT
*Question
,
1052 IN EFI_BROWSER_ACTION Action
,
1053 IN BOOLEAN SkipSaveOrDiscard
1057 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
1058 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
1059 EFI_HII_VALUE
*HiiValue
;
1060 EFI_IFR_TYPE_VALUE
*TypeValue
;
1061 FORM_BROWSER_STATEMENT
*Statement
;
1062 BOOLEAN SubmitFormIsRequired
;
1064 BOOLEAN DiscardFormIsRequired
;
1068 ConfigAccess
= Selection
->FormSet
->ConfigAccess
;
1069 SubmitFormIsRequired
= FALSE
;
1071 DiscardFormIsRequired
= FALSE
;
1073 Status
= EFI_SUCCESS
;
1074 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
1076 if (ConfigAccess
== NULL
) {
1080 Link
= GetFirstNode (&Selection
->Form
->StatementListHead
);
1081 while (!IsNull (&Selection
->Form
->StatementListHead
, Link
)) {
1082 Statement
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
1083 Link
= GetNextNode (&Selection
->Form
->StatementListHead
, Link
);
1086 // if Question != NULL, only process the question. Else, process all question in this form.
1088 if ((Question
!= NULL
) && (Statement
!= Question
)) {
1092 if ((Statement
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != EFI_IFR_FLAG_CALLBACK
) {
1097 // Check whether Statement is disabled.
1099 if (Statement
->DisableExpression
!= NULL
) {
1100 Status
= EvaluateExpression (Selection
->FormSet
, Selection
->Form
, Statement
->DisableExpression
);
1101 if (!EFI_ERROR (Status
) &&
1102 (Statement
->DisableExpression
->Result
.Type
== EFI_IFR_TYPE_BOOLEAN
) &&
1103 (Statement
->DisableExpression
->Result
.Value
.b
)) {
1108 HiiValue
= &Statement
->HiiValue
;
1109 TypeValue
= &HiiValue
->Value
;
1110 if (HiiValue
->Type
== EFI_IFR_TYPE_BUFFER
) {
1112 // For OrderedList, passing in the value buffer to Callback()
1114 TypeValue
= (EFI_IFR_TYPE_VALUE
*) Statement
->BufferValue
;
1117 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
1118 Status
= ConfigAccess
->Callback (
1121 Statement
->QuestionId
,
1126 if (!EFI_ERROR (Status
)) {
1127 switch (ActionRequest
) {
1128 case EFI_BROWSER_ACTION_REQUEST_RESET
:
1129 gResetRequired
= TRUE
;
1132 case EFI_BROWSER_ACTION_REQUEST_SUBMIT
:
1133 SubmitFormIsRequired
= TRUE
;
1136 case EFI_BROWSER_ACTION_REQUEST_EXIT
:
1137 Selection
->Action
= UI_ACTION_EXIT
;
1140 case EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT
:
1141 SubmitFormIsRequired
= TRUE
;
1146 case EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT
:
1147 DiscardFormIsRequired
= TRUE
;
1152 case EFI_BROWSER_ACTION_REQUEST_FORM_APPLY
:
1153 SubmitFormIsRequired
= TRUE
;
1157 case EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD
:
1158 DiscardFormIsRequired
= TRUE
;
1165 } else if (Status
== EFI_UNSUPPORTED
) {
1167 // If return EFI_UNSUPPORTED, also consider Hii driver suceess deal with it.
1169 Status
= EFI_SUCCESS
;
1173 if (SubmitFormIsRequired
&& !SkipSaveOrDiscard
) {
1174 SubmitForm (Selection
->FormSet
, Selection
->Form
, SingleForm
);
1177 if (DiscardFormIsRequired
&& !SkipSaveOrDiscard
) {
1178 DiscardForm (Selection
->FormSet
, Selection
->Form
, SingleForm
);
1182 FindNextMenu (Selection
, NULL
, NULL
);
1189 The worker function that send the displays to the screen. On output,
1190 the selection made by user is returned.
1192 @param Selection On input, Selection tell setup browser the information
1193 about the Selection, form and formset to be displayed.
1194 On output, Selection return the screen item that is selected
1197 @retval EFI_SUCCESS The page is displayed successfully.
1198 @return Other value if the page failed to be diplayed.
1203 IN OUT UI_MENU_SELECTION
*Selection
1208 EFI_HANDLE NotifyHandle
;
1209 FORM_BROWSER_STATEMENT
*Statement
;
1210 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
1211 FORM_BROWSER_FORMSET
*FormSet
;
1214 gMenuRefreshHead
= NULL
;
1215 gResetRequired
= FALSE
;
1216 FormSet
= Selection
->FormSet
;
1217 ConfigAccess
= Selection
->FormSet
->ConfigAccess
;
1220 // Register notify for Form package update
1222 Status
= mHiiDatabase
->RegisterPackageNotify (
1224 EFI_HII_PACKAGE_FORMS
,
1227 EFI_HII_DATABASE_NOTIFY_REMOVE_PACK
,
1230 if (EFI_ERROR (Status
)) {
1235 // Initialize current settings of Questions in this FormSet
1237 Status
= InitializeCurrentSetting (Selection
->FormSet
);
1238 if (EFI_ERROR (Status
)) {
1244 // Initialize Selection->Form
1246 if (Selection
->FormId
== 0) {
1248 // Zero FormId indicates display the first Form in a FormSet
1250 Link
= GetFirstNode (&Selection
->FormSet
->FormListHead
);
1252 Selection
->Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
1253 Selection
->FormId
= Selection
->Form
->FormId
;
1255 Selection
->Form
= IdToForm (Selection
->FormSet
, Selection
->FormId
);
1258 if (Selection
->Form
== NULL
) {
1260 // No Form to display
1262 Status
= EFI_NOT_FOUND
;
1267 // Check Form is suppressed.
1269 if (Selection
->Form
->SuppressExpression
!= NULL
) {
1270 Status
= EvaluateExpression (Selection
->FormSet
, Selection
->Form
, Selection
->Form
->SuppressExpression
);
1271 if (EFI_ERROR (Status
) || (Selection
->Form
->SuppressExpression
->Result
.Type
!= EFI_IFR_TYPE_BOOLEAN
)) {
1272 Status
= EFI_INVALID_PARAMETER
;
1276 if (Selection
->Form
->SuppressExpression
->Result
.Value
.b
) {
1278 // Form is suppressed.
1281 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, gFormSuppress
, gPressEnter
, gEmptyString
);
1282 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
1284 Status
= EFI_NOT_FOUND
;
1290 // Reset FormPackage update flag
1292 mHiiPackageListUpdated
= FALSE
;
1295 // Before display new form, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_OPEN
1296 // for each question with callback flag.
1297 // New form may be the first form, or the different form after another form close.
1299 if ((ConfigAccess
!= NULL
) &&
1300 ((Selection
->Handle
!= mCurrentHiiHandle
) ||
1301 (!CompareGuid (&Selection
->FormSetGuid
, &mCurrentFormSetGuid
)) ||
1302 (Selection
->FormId
!= mCurrentFormId
))) {
1305 // Keep current form information
1307 mCurrentHiiHandle
= Selection
->Handle
;
1308 CopyGuid (&mCurrentFormSetGuid
, &Selection
->FormSetGuid
);
1309 mCurrentFormId
= Selection
->FormId
;
1311 Status
= ProcessCallBackFunction (Selection
, NULL
, EFI_BROWSER_ACTION_FORM_OPEN
, FALSE
);
1312 if (EFI_ERROR (Status
)) {
1317 // EXIT requests to close form.
1319 if (Selection
->Action
== UI_ACTION_EXIT
) {
1323 // IFR is updated during callback of open form, force to reparse the IFR binary
1325 if (mHiiPackageListUpdated
) {
1326 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
1327 mHiiPackageListUpdated
= FALSE
;
1333 // Load Questions' Value for display
1335 Status
= LoadFormSetConfig (Selection
, Selection
->FormSet
);
1336 if (EFI_ERROR (Status
)) {
1341 // EXIT requests to close form.
1343 if (Selection
->Action
== UI_ACTION_EXIT
) {
1347 // IFR is updated during callback of read value, force to reparse the IFR binary
1349 if (mHiiPackageListUpdated
) {
1350 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
1351 mHiiPackageListUpdated
= FALSE
;
1356 // Displays the Header and Footer borders
1358 DisplayPageFrame (Selection
);
1363 Status
= DisplayForm (Selection
);
1364 if (EFI_ERROR (Status
)) {
1369 // Check Selected Statement (if press ESC, Selection->Statement will be NULL)
1371 Statement
= Selection
->Statement
;
1372 if (Statement
!= NULL
) {
1373 if ((Statement
->QuestionFlags
& EFI_IFR_FLAG_RESET_REQUIRED
) == EFI_IFR_FLAG_RESET_REQUIRED
) {
1374 gResetRequired
= TRUE
;
1378 // Reset FormPackage update flag
1380 mHiiPackageListUpdated
= FALSE
;
1382 if ((ConfigAccess
!= NULL
) &&
1383 ((Statement
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) == EFI_IFR_FLAG_CALLBACK
) &&
1384 (Statement
->Operand
!= EFI_IFR_PASSWORD_OP
)) {
1386 Status
= ProcessCallBackFunction(Selection
, Statement
, EFI_BROWSER_ACTION_CHANGING
, FALSE
);
1387 if ((EFI_ERROR (Status
)) && (Status
!= EFI_UNSUPPORTED
)) {
1389 // Callback return error status other than EFI_UNSUPPORTED
1391 if (Statement
->Operand
== EFI_IFR_REF_OP
) {
1393 // Cross reference will not be taken
1395 Selection
->FormId
= Selection
->Form
->FormId
;
1396 Selection
->QuestionId
= 0;
1402 // Check whether Form Package has been updated during Callback
1404 if (mHiiPackageListUpdated
&& (Selection
->Action
== UI_ACTION_REFRESH_FORM
)) {
1406 // Force to reparse IFR binary of target Formset
1408 mHiiPackageListUpdated
= FALSE
;
1409 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
1414 // Before exit the form, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_CLOSE
1415 // for each question with callback flag.
1417 if ((ConfigAccess
!= NULL
) &&
1418 ((Selection
->Action
== UI_ACTION_EXIT
) ||
1419 (Selection
->Handle
!= mCurrentHiiHandle
) ||
1420 (!CompareGuid (&Selection
->FormSetGuid
, &mCurrentFormSetGuid
)) ||
1421 (Selection
->FormId
!= mCurrentFormId
))) {
1423 Status
= ProcessCallBackFunction (Selection
, NULL
, EFI_BROWSER_ACTION_FORM_CLOSE
, FALSE
);
1424 if (EFI_ERROR (Status
)) {
1428 } while (Selection
->Action
== UI_ACTION_REFRESH_FORM
);
1431 // Record the old formset
1433 if (gOldFormSet
!= NULL
) {
1434 DestroyFormSet (gOldFormSet
);
1436 gOldFormSet
= FormSet
;
1440 // Reset current form information to the initial setting when error happens or form exit.
1442 if (EFI_ERROR (Status
) || Selection
->Action
== UI_ACTION_EXIT
) {
1443 mCurrentHiiHandle
= NULL
;
1444 CopyGuid (&mCurrentFormSetGuid
, &gZeroGuid
);
1449 // Unregister notify for Form package update
1451 mHiiDatabase
->UnregisterPackageNotify (