2 Utility functions for UI presentation.
4 Copyright (c) 2004 - 2009, Intel Corporation
5 All rights reserved. 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.
18 BOOLEAN mHiiPackageListUpdated
;
19 UI_MENU_SELECTION
*gCurrentSelection
;
23 Clear retangle with specified text attribute.
25 @param LeftColumn Left column of retangle.
26 @param RightColumn Right column of retangle.
27 @param TopRow Start row of retangle.
28 @param BottomRow End row of retangle.
29 @param TextAttribute The character foreground and background.
38 IN UINTN TextAttribute
45 // For now, allocate an arbitrarily long buffer
47 Buffer
= AllocateZeroPool (0x10000);
48 ASSERT (Buffer
!= NULL
);
51 // Set foreground and background as defined
53 gST
->ConOut
->SetAttribute (gST
->ConOut
, TextAttribute
);
56 // Much faster to buffer the long string instead of print it a character at a time
58 SetUnicodeMem (Buffer
, RightColumn
- LeftColumn
, L
' ');
61 // Clear the desired area with the appropriate foreground/background
63 for (Row
= TopRow
; Row
<= BottomRow
; Row
++) {
64 PrintStringAt (LeftColumn
, Row
, Buffer
);
67 gST
->ConOut
->SetCursorPosition (gST
->ConOut
, LeftColumn
, TopRow
);
74 Concatenate a narrow string to another string.
76 @param Destination The destination string.
77 @param Source The source string. The string to be concatenated.
78 to the end of Destination.
83 IN OUT CHAR16
*Destination
,
89 for (Length
= 0; Destination
[Length
] != 0; Length
++)
93 // We now have the length of the original string
94 // We can safely assume for now that we are concatenating a narrow value to this string.
95 // For instance, the string is "XYZ" and cat'ing ">"
96 // If this assumption changes, we need to make this routine a bit more complex
98 Destination
[Length
] = NARROW_CHAR
;
101 StrCpy (Destination
+ Length
, Source
);
105 Count the storage space of a Unicode string.
107 This function handles the Unicode string with NARROW_CHAR
108 and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR
109 does not count in the resultant output. If a WIDE_CHAR is
110 hit, then 2 Unicode character will consume an output storage
111 space with size of CHAR16 till a NARROW_CHAR is hit.
113 @param String The input string to be counted.
115 @return Storage space for the input string.
125 UINTN IncrementValue
;
133 // Advance to the null-terminator or to the first width directive
136 (String
[Index
] != NARROW_CHAR
) && (String
[Index
] != WIDE_CHAR
) && (String
[Index
] != 0);
137 Index
++, Count
= Count
+ IncrementValue
142 // We hit the null-terminator, we now have a count
144 if (String
[Index
] == 0) {
148 // We encountered a narrow directive - strip it from the size calculation since it doesn't get printed
149 // and also set the flag that determines what we increment by.(if narrow, increment by 1, if wide increment by 2)
151 if (String
[Index
] == NARROW_CHAR
) {
153 // Skip to the next character
159 // Skip to the next character
164 } while (String
[Index
] != 0);
167 // Increment by one to include the null-terminator in the size
171 return Count
* sizeof (CHAR16
);
175 This function displays the page frame.
188 CHAR16
*StrFrontPageBanner
;
190 EFI_SCREEN_DESCRIPTOR LocalScreen
;
194 ZeroMem (&LocalScreen
, sizeof (EFI_SCREEN_DESCRIPTOR
));
195 gST
->ConOut
->QueryMode (gST
->ConOut
, gST
->ConOut
->Mode
->Mode
, &LocalScreen
.RightColumn
, &LocalScreen
.BottomRow
);
196 ClearLines (0, LocalScreen
.RightColumn
, 0, LocalScreen
.BottomRow
, KEYHELP_BACKGROUND
);
198 CopyMem (&LocalScreen
, &gScreenDimensions
, sizeof (EFI_SCREEN_DESCRIPTOR
));
201 // For now, allocate an arbitrarily long buffer
203 Buffer
= AllocateZeroPool (0x10000);
204 ASSERT (Buffer
!= NULL
);
206 Character
= BOXDRAW_HORIZONTAL
;
208 for (Index
= 0; Index
+ 2 < (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
); Index
++) {
209 Buffer
[Index
] = Character
;
212 if (gClassOfVfr
== FORMSET_CLASS_FRONT_PAGE
) {
214 // ClearLines(0, LocalScreen.RightColumn, 0, BANNER_HEIGHT-1, BANNER_TEXT | BANNER_BACKGROUND);
217 LocalScreen
.LeftColumn
,
218 LocalScreen
.RightColumn
,
220 FRONT_PAGE_HEADER_HEIGHT
- 1 + LocalScreen
.TopRow
,
221 BANNER_TEXT
| BANNER_BACKGROUND
224 // for (Line = 0; Line < BANNER_HEIGHT; Line++) {
226 for (Line
= (UINT8
) LocalScreen
.TopRow
; Line
< BANNER_HEIGHT
+ (UINT8
) LocalScreen
.TopRow
; Line
++) {
228 // for (Alignment = 0; Alignment < BANNER_COLUMNS; Alignment++) {
230 for (Alignment
= (UINT8
) LocalScreen
.LeftColumn
;
231 Alignment
< BANNER_COLUMNS
+ (UINT8
) LocalScreen
.LeftColumn
;
234 RowIdx
= (UINT8
) (Line
- (UINT8
) LocalScreen
.TopRow
);
235 ColumnIdx
= (UINT8
) (Alignment
- (UINT8
) LocalScreen
.LeftColumn
);
237 ASSERT (RowIdx
< BANNER_HEIGHT
);
238 ASSERT (ColumnIdx
< BANNER_COLUMNS
);
240 if (gBannerData
->Banner
[RowIdx
][ColumnIdx
] != 0x0000) {
241 StrFrontPageBanner
= GetToken (
242 gBannerData
->Banner
[RowIdx
][ColumnIdx
],
249 switch (Alignment
- LocalScreen
.LeftColumn
) {
252 // Handle left column
254 PrintStringAt (LocalScreen
.LeftColumn
, Line
, StrFrontPageBanner
);
259 // Handle center column
262 LocalScreen
.LeftColumn
+ (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
) / 3,
270 // Handle right column
273 LocalScreen
.LeftColumn
+ (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
) * 2 / 3,
280 FreePool (StrFrontPageBanner
);
286 LocalScreen
.LeftColumn
,
287 LocalScreen
.RightColumn
,
288 LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- FOOTER_HEIGHT
,
289 LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- 1,
290 KEYHELP_TEXT
| KEYHELP_BACKGROUND
293 if (gClassOfVfr
!= FORMSET_CLASS_FRONT_PAGE
) {
295 LocalScreen
.LeftColumn
,
296 LocalScreen
.RightColumn
,
298 LocalScreen
.TopRow
+ NONE_FRONT_PAGE_HEADER_HEIGHT
- 1,
299 TITLE_TEXT
| TITLE_BACKGROUND
302 // Print Top border line
303 // +------------------------------------------------------------------------------+
305 // +------------------------------------------------------------------------------+
307 Character
= BOXDRAW_DOWN_RIGHT
;
309 PrintChar (Character
);
310 PrintString (Buffer
);
312 Character
= BOXDRAW_DOWN_LEFT
;
313 PrintChar (Character
);
315 Character
= BOXDRAW_VERTICAL
;
316 for (Row
= LocalScreen
.TopRow
+ 1; Row
<= LocalScreen
.TopRow
+ NONE_FRONT_PAGE_HEADER_HEIGHT
- 2; Row
++) {
317 PrintCharAt (LocalScreen
.LeftColumn
, Row
, Character
);
318 PrintCharAt (LocalScreen
.RightColumn
- 1, Row
, Character
);
321 Character
= BOXDRAW_UP_RIGHT
;
322 PrintCharAt (LocalScreen
.LeftColumn
, LocalScreen
.TopRow
+ NONE_FRONT_PAGE_HEADER_HEIGHT
- 1, Character
);
323 PrintString (Buffer
);
325 Character
= BOXDRAW_UP_LEFT
;
326 PrintChar (Character
);
328 if (gClassOfVfr
== FORMSET_CLASS_PLATFORM_SETUP
) {
330 // Print Bottom border line
331 // +------------------------------------------------------------------------------+
333 // +------------------------------------------------------------------------------+
335 Character
= BOXDRAW_DOWN_RIGHT
;
336 PrintCharAt (LocalScreen
.LeftColumn
, LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- FOOTER_HEIGHT
, Character
);
338 PrintString (Buffer
);
340 Character
= BOXDRAW_DOWN_LEFT
;
341 PrintChar (Character
);
342 Character
= BOXDRAW_VERTICAL
;
343 for (Row
= LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- FOOTER_HEIGHT
+ 1;
344 Row
<= LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- 2;
347 PrintCharAt (LocalScreen
.LeftColumn
, Row
, Character
);
348 PrintCharAt (LocalScreen
.RightColumn
- 1, Row
, Character
);
351 Character
= BOXDRAW_UP_RIGHT
;
352 PrintCharAt (LocalScreen
.LeftColumn
, LocalScreen
.BottomRow
- STATUS_BAR_HEIGHT
- 1, Character
);
354 PrintString (Buffer
);
356 Character
= BOXDRAW_UP_LEFT
;
357 PrintChar (Character
);
367 Evaluate all expressions in a Form.
369 @param FormSet FormSet this Form belongs to.
370 @param Form The Form.
372 @retval EFI_SUCCESS The expression evaluated successfuly
376 EvaluateFormExpressions (
377 IN FORM_BROWSER_FORMSET
*FormSet
,
378 IN FORM_BROWSER_FORM
*Form
383 FORM_EXPRESSION
*Expression
;
385 Link
= GetFirstNode (&Form
->ExpressionListHead
);
386 while (!IsNull (&Form
->ExpressionListHead
, Link
)) {
387 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
388 Link
= GetNextNode (&Form
->ExpressionListHead
, Link
);
390 if (Expression
->Type
== EFI_HII_EXPRESSION_INCONSISTENT_IF
||
391 Expression
->Type
== EFI_HII_EXPRESSION_NO_SUBMIT_IF
) {
393 // Postpone Form validation to Question editing or Form submiting
398 Status
= EvaluateExpression (FormSet
, Form
, Expression
);
399 if (EFI_ERROR (Status
)) {
408 +------------------------------------------------------------------------------+
410 +------------------------------------------------------------------------------+
428 +------------------------------------------------------------------------------+
429 ?F1=Scroll Help F9=Reset to Defaults F10=Save and Exit ?
430 | ^"=Move Highlight <Spacebar> Toggles Checkbox Esc=Discard Changes |
431 +------------------------------------------------------------------------------+
437 Display form and wait for user to select one menu option, then return it.
439 @param Selection On input, Selection tell setup browser the information
440 about the Selection, form and formset to be displayed.
441 On output, Selection return the screen item that is selected
443 @retval EFI_SUCESSS This function always return successfully for now.
448 IN OUT UI_MENU_SELECTION
*Selection
452 UINT16 MenuItemCount
;
453 EFI_HII_HANDLE Handle
;
455 EFI_SCREEN_DESCRIPTOR LocalScreen
;
458 CHAR16
*OutputString
;
460 FORM_BROWSER_STATEMENT
*Statement
;
461 UINT16 NumberOfLines
;
463 UI_MENU_OPTION
*MenuOption
;
465 Handle
= Selection
->Handle
;
472 CopyMem (&LocalScreen
, &gScreenDimensions
, sizeof (EFI_SCREEN_DESCRIPTOR
));
474 StringPtr
= GetToken (Selection
->Form
->FormTitle
, Handle
);
476 if (gClassOfVfr
!= FORMSET_CLASS_FRONT_PAGE
) {
477 gST
->ConOut
->SetAttribute (gST
->ConOut
, TITLE_TEXT
| TITLE_BACKGROUND
);
479 (LocalScreen
.RightColumn
+ LocalScreen
.LeftColumn
- GetStringWidth (StringPtr
) / 2) / 2,
480 LocalScreen
.TopRow
+ 1,
486 // Remove Buffer allocated for StringPtr after it has been used.
488 FreePool (StringPtr
);
491 // Evaluate all the Expressions in this Form
493 Status
= EvaluateFormExpressions (Selection
->FormSet
, Selection
->Form
);
494 if (EFI_ERROR (Status
)) {
498 Selection
->FormEditable
= FALSE
;
499 Link
= GetFirstNode (&Selection
->Form
->StatementListHead
);
500 while (!IsNull (&Selection
->Form
->StatementListHead
, Link
)) {
501 Statement
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
503 if (Statement
->SuppressExpression
!= NULL
) {
504 Suppress
= Statement
->SuppressExpression
->Result
.Value
.b
;
509 if (Statement
->DisableExpression
!= NULL
) {
510 Suppress
= (BOOLEAN
) (Suppress
|| Statement
->DisableExpression
->Result
.Value
.b
);
514 StringPtr
= GetToken (Statement
->Prompt
, Handle
);
516 Width
= GetWidth (Statement
, Handle
);
520 for (; GetLineByWidth (StringPtr
, Width
, &ArrayEntry
, &OutputString
) != 0x0000;) {
522 // If there is more string to process print on the next row and increment the Skip value
524 if (StrLen (&StringPtr
[ArrayEntry
]) != 0) {
528 FreePool (OutputString
);
532 // We are NOT!! removing this StringPtr buffer via FreePool since it is being used in the menuoptions, we will do
535 MenuOption
= UiAddMenuOption (StringPtr
, Selection
->Handle
, Statement
, NumberOfLines
, MenuItemCount
);
538 if (MenuOption
->IsQuestion
&& !MenuOption
->ReadOnly
) {
540 // At least one item is not readonly, this Form is considered as editable
542 Selection
->FormEditable
= TRUE
;
546 Link
= GetNextNode (&Selection
->Form
->StatementListHead
, Link
);
549 Status
= UiDisplayMenu (Selection
);
557 Initialize the HII String Token to the correct values.
561 InitializeBrowserStrings (
565 gFunctionNineString
= GetToken (STRING_TOKEN (FUNCTION_NINE_STRING
), gHiiHandle
);
566 gFunctionTenString
= GetToken (STRING_TOKEN (FUNCTION_TEN_STRING
), gHiiHandle
);
567 gEnterString
= GetToken (STRING_TOKEN (ENTER_STRING
), gHiiHandle
);
568 gEnterCommitString
= GetToken (STRING_TOKEN (ENTER_COMMIT_STRING
), gHiiHandle
);
569 gEnterEscapeString
= GetToken (STRING_TOKEN (ENTER_ESCAPE_STRING
), gHiiHandle
);
570 gEscapeString
= GetToken (STRING_TOKEN (ESCAPE_STRING
), gHiiHandle
);
571 gSaveFailed
= GetToken (STRING_TOKEN (SAVE_FAILED
), gHiiHandle
);
572 gMoveHighlight
= GetToken (STRING_TOKEN (MOVE_HIGHLIGHT
), gHiiHandle
);
573 gMakeSelection
= GetToken (STRING_TOKEN (MAKE_SELECTION
), gHiiHandle
);
574 gDecNumericInput
= GetToken (STRING_TOKEN (DEC_NUMERIC_INPUT
), gHiiHandle
);
575 gHexNumericInput
= GetToken (STRING_TOKEN (HEX_NUMERIC_INPUT
), gHiiHandle
);
576 gToggleCheckBox
= GetToken (STRING_TOKEN (TOGGLE_CHECK_BOX
), gHiiHandle
);
577 gPromptForData
= GetToken (STRING_TOKEN (PROMPT_FOR_DATA
), gHiiHandle
);
578 gPromptForPassword
= GetToken (STRING_TOKEN (PROMPT_FOR_PASSWORD
), gHiiHandle
);
579 gPromptForNewPassword
= GetToken (STRING_TOKEN (PROMPT_FOR_NEW_PASSWORD
), gHiiHandle
);
580 gConfirmPassword
= GetToken (STRING_TOKEN (CONFIRM_PASSWORD
), gHiiHandle
);
581 gConfirmError
= GetToken (STRING_TOKEN (CONFIRM_ERROR
), gHiiHandle
);
582 gPassowordInvalid
= GetToken (STRING_TOKEN (PASSWORD_INVALID
), gHiiHandle
);
583 gPressEnter
= GetToken (STRING_TOKEN (PRESS_ENTER
), gHiiHandle
);
584 gEmptyString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
585 gAreYouSure
= GetToken (STRING_TOKEN (ARE_YOU_SURE
), gHiiHandle
);
586 gYesResponse
= GetToken (STRING_TOKEN (ARE_YOU_SURE_YES
), gHiiHandle
);
587 gNoResponse
= GetToken (STRING_TOKEN (ARE_YOU_SURE_NO
), gHiiHandle
);
588 gMiniString
= GetToken (STRING_TOKEN (MINI_STRING
), gHiiHandle
);
589 gPlusString
= GetToken (STRING_TOKEN (PLUS_STRING
), gHiiHandle
);
590 gMinusString
= GetToken (STRING_TOKEN (MINUS_STRING
), gHiiHandle
);
591 gAdjustNumber
= GetToken (STRING_TOKEN (ADJUST_NUMBER
), gHiiHandle
);
592 gSaveChanges
= GetToken (STRING_TOKEN (SAVE_CHANGES
), gHiiHandle
);
593 gOptionMismatch
= GetToken (STRING_TOKEN (OPTION_MISMATCH
), gHiiHandle
);
598 Free up the resource allocated for all strings required
607 FreePool (gFunctionNineString
);
608 FreePool (gFunctionTenString
);
609 FreePool (gEnterString
);
610 FreePool (gEnterCommitString
);
611 FreePool (gEnterEscapeString
);
612 FreePool (gEscapeString
);
613 FreePool (gMoveHighlight
);
614 FreePool (gMakeSelection
);
615 FreePool (gDecNumericInput
);
616 FreePool (gHexNumericInput
);
617 FreePool (gToggleCheckBox
);
618 FreePool (gPromptForData
);
619 FreePool (gPromptForPassword
);
620 FreePool (gPromptForNewPassword
);
621 FreePool (gConfirmPassword
);
622 FreePool (gPassowordInvalid
);
623 FreePool (gConfirmError
);
624 FreePool (gPressEnter
);
625 FreePool (gEmptyString
);
626 FreePool (gAreYouSure
);
627 FreePool (gYesResponse
);
628 FreePool (gNoResponse
);
629 FreePool (gMiniString
);
630 FreePool (gPlusString
);
631 FreePool (gMinusString
);
632 FreePool (gAdjustNumber
);
633 FreePool (gSaveChanges
);
634 FreePool (gOptionMismatch
);
640 Update key's help imformation.
642 @param Selection Tell setup browser the information about the Selection
643 @param MenuOption The Menu option
644 @param Selected Whether or not a tag be selected
649 IN UI_MENU_SELECTION
*Selection
,
650 IN UI_MENU_OPTION
*MenuOption
,
656 UINTN LeftColumnOfHelp
;
657 UINTN RightColumnOfHelp
;
659 UINTN BottomRowOfHelp
;
660 UINTN StartColumnOfHelp
;
661 EFI_SCREEN_DESCRIPTOR LocalScreen
;
662 FORM_BROWSER_STATEMENT
*Statement
;
664 CopyMem (&LocalScreen
, &gScreenDimensions
, sizeof (EFI_SCREEN_DESCRIPTOR
));
666 SecCol
= LocalScreen
.LeftColumn
+ (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
) / 3;
667 ThdCol
= LocalScreen
.LeftColumn
+ (LocalScreen
.RightColumn
- LocalScreen
.LeftColumn
) * 2 / 3;
669 StartColumnOfHelp
= LocalScreen
.LeftColumn
+ 2;
670 LeftColumnOfHelp
= LocalScreen
.LeftColumn
+ 1;
671 RightColumnOfHelp
= LocalScreen
.RightColumn
- 2;
672 TopRowOfHelp
= LocalScreen
.BottomRow
- 4;
673 BottomRowOfHelp
= LocalScreen
.BottomRow
- 3;
675 gST
->ConOut
->SetAttribute (gST
->ConOut
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
677 Statement
= MenuOption
->ThisTag
;
678 switch (Statement
->Operand
) {
679 case EFI_IFR_ORDERED_LIST_OP
:
680 case EFI_IFR_ONE_OF_OP
:
681 case EFI_IFR_NUMERIC_OP
:
682 case EFI_IFR_TIME_OP
:
683 case EFI_IFR_DATE_OP
:
684 ClearLines (LeftColumnOfHelp
, RightColumnOfHelp
, TopRowOfHelp
, BottomRowOfHelp
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
687 if (gClassOfVfr
== FORMSET_CLASS_PLATFORM_SETUP
) {
688 if (Selection
->FormEditable
) {
689 PrintStringAt (SecCol
, TopRowOfHelp
, gFunctionNineString
);
690 PrintStringAt (ThdCol
, TopRowOfHelp
, gFunctionTenString
);
692 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEscapeString
);
695 if ((Statement
->Operand
== EFI_IFR_DATE_OP
) ||
696 (Statement
->Operand
== EFI_IFR_TIME_OP
)) {
707 PrintStringAt (SecCol
, BottomRowOfHelp
, gAdjustNumber
);
709 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
710 if (Statement
->Operand
== EFI_IFR_NUMERIC_OP
&& Statement
->Step
!= 0) {
711 PrintStringAt (SecCol
, BottomRowOfHelp
, gAdjustNumber
);
713 PrintStringAt (SecCol
, BottomRowOfHelp
, gEnterString
);
717 PrintStringAt (SecCol
, BottomRowOfHelp
, gEnterCommitString
);
720 // If it is a selected numeric with manual input, display different message
722 if ((Statement
->Operand
== EFI_IFR_NUMERIC_OP
) && (Statement
->Step
== 0)) {
726 ((Statement
->Flags
& EFI_IFR_DISPLAY_UINT_HEX
) == EFI_IFR_DISPLAY_UINT_HEX
) ? gHexNumericInput
: gDecNumericInput
728 } else if (Statement
->Operand
!= EFI_IFR_ORDERED_LIST_OP
) {
729 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
732 if (Statement
->Operand
== EFI_IFR_ORDERED_LIST_OP
) {
733 PrintStringAt (StartColumnOfHelp
, TopRowOfHelp
, gPlusString
);
734 PrintStringAt (ThdCol
, TopRowOfHelp
, gMinusString
);
737 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEnterEscapeString
);
741 case EFI_IFR_CHECKBOX_OP
:
742 ClearLines (LeftColumnOfHelp
, RightColumnOfHelp
, TopRowOfHelp
, BottomRowOfHelp
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
744 if (gClassOfVfr
== FORMSET_CLASS_PLATFORM_SETUP
) {
745 if (Selection
->FormEditable
) {
746 PrintStringAt (SecCol
, TopRowOfHelp
, gFunctionNineString
);
747 PrintStringAt (ThdCol
, TopRowOfHelp
, gFunctionTenString
);
749 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEscapeString
);
752 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
753 PrintStringAt (SecCol
, BottomRowOfHelp
, gToggleCheckBox
);
757 case EFI_IFR_PASSWORD_OP
:
758 case EFI_IFR_STRING_OP
:
759 case EFI_IFR_TEXT_OP
:
760 case EFI_IFR_ACTION_OP
:
761 case EFI_IFR_RESET_BUTTON_OP
:
762 ClearLines (LeftColumnOfHelp
, RightColumnOfHelp
, TopRowOfHelp
, BottomRowOfHelp
, KEYHELP_TEXT
| KEYHELP_BACKGROUND
);
765 if (gClassOfVfr
== FORMSET_CLASS_PLATFORM_SETUP
) {
766 if (Selection
->FormEditable
) {
767 PrintStringAt (SecCol
, TopRowOfHelp
, gFunctionNineString
);
768 PrintStringAt (ThdCol
, TopRowOfHelp
, gFunctionTenString
);
770 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEscapeString
);
773 PrintAt (StartColumnOfHelp
, BottomRowOfHelp
, L
"%c%c%s", ARROW_UP
, ARROW_DOWN
, gMoveHighlight
);
774 if (Statement
->Operand
!= EFI_IFR_TEXT_OP
) {
775 PrintStringAt (SecCol
, BottomRowOfHelp
, gEnterString
);
778 if (Statement
->Operand
!= EFI_IFR_REF_OP
) {
780 (LocalScreen
.RightColumn
- GetStringWidth (gEnterCommitString
) / 2) / 2,
784 PrintStringAt (ThdCol
, BottomRowOfHelp
, gEnterEscapeString
);
795 Functions which are registered to receive notification of
796 database events have this prototype. The actual event is encoded
797 in NotifyType. The following table describes how PackageType,
798 PackageGuid, Handle, and Package are used for each of the
801 @param PackageType Package type of the notification.
803 @param PackageGuid If PackageType is
804 EFI_HII_PACKAGE_TYPE_GUID, then this is
805 the pointer to the GUID from the Guid
806 field of EFI_HII_PACKAGE_GUID_HEADER.
807 Otherwise, it must be NULL.
809 @param Package Points to the package referred to by the
810 notification Handle The handle of the package
811 list which contains the specified package.
813 @param Handle The HII handle.
815 @param NotifyType The type of change concerning the
817 EFI_HII_DATABASE_NOTIFY_TYPE.
823 IN UINT8 PackageType
,
824 IN CONST EFI_GUID
*PackageGuid
,
825 IN CONST EFI_HII_PACKAGE_HEADER
*Package
,
826 IN EFI_HII_HANDLE Handle
,
827 IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType
830 mHiiPackageListUpdated
= TRUE
;
836 The worker function that send the displays to the screen. On output,
837 the selection made by user is returned.
839 @param Selection On input, Selection tell setup browser the information
840 about the Selection, form and formset to be displayed.
841 On output, Selection return the screen item that is selected
844 @retval EFI_SUCCESS The page is displayed successfully.
845 @return Other value if the page failed to be diplayed.
850 IN OUT UI_MENU_SELECTION
*Selection
855 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
856 EFI_HANDLE NotifyHandle
;
857 EFI_HII_VALUE
*HiiValue
;
858 FORM_BROWSER_STATEMENT
*Statement
;
859 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
860 FORM_BROWSER_FORMSET
*FormSet
;
862 gMenuRefreshHead
= NULL
;
863 gResetRequired
= FALSE
;
864 FormSet
= Selection
->FormSet
;
867 // Register notify for Form package update
869 Status
= mHiiDatabase
->RegisterPackageNotify (
871 EFI_HII_PACKAGE_FORMS
,
874 EFI_HII_DATABASE_NOTIFY_REMOVE_PACK
,
877 if (EFI_ERROR (Status
)) {
882 // Before display the formset, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_OPEN
884 ConfigAccess
= Selection
->FormSet
->ConfigAccess
;
885 if ((ConfigAccess
!= NULL
) && (Selection
->Action
!= UI_ACTION_REFRESH_FORMSET
)) {
886 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
887 mHiiPackageListUpdated
= FALSE
;
888 Status
= ConfigAccess
->Callback (
890 EFI_BROWSER_ACTION_FORM_OPEN
,
892 EFI_IFR_TYPE_UNDEFINED
,
897 if (!EFI_ERROR (Status
)) {
898 switch (ActionRequest
) {
899 case EFI_BROWSER_ACTION_REQUEST_RESET
:
900 gResetRequired
= TRUE
;
903 case EFI_BROWSER_ACTION_REQUEST_SUBMIT
:
905 // Till now there is no uncommitted data, so ignore this request
909 case EFI_BROWSER_ACTION_REQUEST_EXIT
:
910 Selection
->Action
= UI_ACTION_EXIT
;
918 if (mHiiPackageListUpdated
) {
920 // IFR is updated during callback, force to reparse the IFR binary
922 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
928 // Initialize current settings of Questions in this FormSet
930 Status
= InitializeCurrentSetting (Selection
->FormSet
);
931 if (EFI_ERROR (Status
)) {
932 Selection
->Action
= UI_ACTION_EXIT
;
938 // Initialize Selection->Form
940 if (Selection
->FormId
== 0) {
942 // Zero FormId indicates display the first Form in a FormSet
944 Link
= GetFirstNode (&Selection
->FormSet
->FormListHead
);
946 Selection
->Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
947 Selection
->FormId
= Selection
->Form
->FormId
;
949 Selection
->Form
= IdToForm (Selection
->FormSet
, Selection
->FormId
);
952 if (Selection
->Form
== NULL
) {
954 // No Form to display
956 return EFI_NOT_FOUND
;
960 // Load Questions' Value for display
962 Status
= LoadFormSetConfig (Selection
->FormSet
);
963 if (EFI_ERROR (Status
)) {
968 // Displays the Header and Footer borders
975 Status
= DisplayForm (Selection
);
976 if (EFI_ERROR (Status
)) {
981 // Check Selected Statement (if press ESC, Selection->Statement will be NULL)
983 Statement
= Selection
->Statement
;
984 if (Statement
!= NULL
) {
985 if ((Statement
->QuestionFlags
& EFI_IFR_FLAG_RESET_REQUIRED
) == EFI_IFR_FLAG_RESET_REQUIRED
) {
986 gResetRequired
= TRUE
;
990 // Reset FormPackage update flag
992 mHiiPackageListUpdated
= FALSE
;
994 if (((Statement
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) == EFI_IFR_FLAG_CALLBACK
) && (Statement
->Operand
!= EFI_IFR_PASSWORD_OP
)) {
995 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
997 HiiValue
= &Statement
->HiiValue
;
998 if (HiiValue
->Type
== EFI_IFR_TYPE_STRING
) {
1000 // Create String in HII database for Configuration Driver to retrieve
1002 HiiValue
->Value
.string
= NewString ((CHAR16
*) Statement
->BufferValue
, Selection
->FormSet
->HiiHandle
);
1005 if (ConfigAccess
== NULL
) {
1006 return EFI_UNSUPPORTED
;
1008 Status
= ConfigAccess
->Callback (
1010 EFI_BROWSER_ACTION_CHANGING
,
1011 Statement
->QuestionId
,
1017 if (HiiValue
->Type
== EFI_IFR_TYPE_STRING
) {
1019 // Clean the String in HII Database
1021 DeleteString (HiiValue
->Value
.string
, Selection
->FormSet
->HiiHandle
);
1024 if (!EFI_ERROR (Status
)) {
1025 switch (ActionRequest
) {
1026 case EFI_BROWSER_ACTION_REQUEST_RESET
:
1027 gResetRequired
= TRUE
;
1030 case EFI_BROWSER_ACTION_REQUEST_SUBMIT
:
1031 SubmitForm (Selection
->FormSet
, Selection
->Form
);
1034 case EFI_BROWSER_ACTION_REQUEST_EXIT
:
1035 Selection
->Action
= UI_ACTION_EXIT
;
1036 gNvUpdateRequired
= FALSE
;
1042 } else if (Status
!= EFI_UNSUPPORTED
) {
1044 // Callback return error status other than EFI_UNSUPPORTED
1046 if (Statement
->Operand
== EFI_IFR_REF_OP
) {
1048 // Cross reference will not be taken
1050 Selection
->FormId
= Selection
->Form
->FormId
;
1051 Selection
->QuestionId
= 0;
1057 // Check whether Form Package has been updated during Callback
1059 if (mHiiPackageListUpdated
&& (Selection
->Action
== UI_ACTION_REFRESH_FORM
)) {
1061 // Force to reparse IFR binary of target Formset
1063 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
1066 } while (Selection
->Action
== UI_ACTION_REFRESH_FORM
);
1069 // Before exit the formset, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_CLOSE
1071 if ((ConfigAccess
!= NULL
) && (Selection
->Action
== UI_ACTION_EXIT
)) {
1072 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
1073 Status
= ConfigAccess
->Callback (
1075 EFI_BROWSER_ACTION_FORM_CLOSE
,
1077 EFI_IFR_TYPE_UNDEFINED
,
1082 if (!EFI_ERROR (Status
)) {
1083 switch (ActionRequest
) {
1084 case EFI_BROWSER_ACTION_REQUEST_RESET
:
1085 gResetRequired
= TRUE
;
1088 case EFI_BROWSER_ACTION_REQUEST_SUBMIT
:
1089 SubmitForm (Selection
->FormSet
, Selection
->Form
);
1092 case EFI_BROWSER_ACTION_REQUEST_EXIT
:
1093 gNvUpdateRequired
= FALSE
;
1103 // Record the old formset
1105 if (gOldFormSet
!= NULL
) {
1106 DestroyFormSet (gOldFormSet
);
1108 gOldFormSet
= FormSet
;
1112 // Unregister notify for Form package update
1114 Status
= mHiiDatabase
->UnregisterPackageNotify (