2 Entry and initialization module for the browser.
4 Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>
5 Copyright (c) 2014, Hewlett-Packard Development Company, L.P.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "FormDisplay.h"
19 // Search table for UiDisplayMenu()
21 SCAN_CODE_TO_SCREEN_OPERATION gScanCodeToOperation
[] = {
52 UINTN mScanCodeNumber
= sizeof (gScanCodeToOperation
) / sizeof (gScanCodeToOperation
[0]);
54 SCREEN_OPERATION_T0_CONTROL_FLAG gScreenOperationToControlFlag
[] = {
97 EFI_GUID gDisplayEngineGuid
= {
98 0xE38C1029, 0xE38F, 0x45b9, {0x8F, 0x0D, 0xE2, 0xE6, 0x0B, 0xC9, 0xB2, 0x62}
102 EFI_SCREEN_DESCRIPTOR gStatementDimensions
;
103 BOOLEAN mStatementLayoutIsChanged
= TRUE
;
104 USER_INPUT
*gUserInput
;
105 FORM_DISPLAY_ENGINE_FORM
*gFormData
;
106 EFI_HII_HANDLE gHiiHandle
;
108 LIST_ENTRY gMenuOption
;
109 DISPLAY_HIGHLIGHT_MENU_INFO gHighligthMenuInfo
= {0};
110 BOOLEAN mIsFirstForm
= TRUE
;
111 FORM_ENTRY_INFO gOldFormEntry
= {0};
114 // Browser Global Strings
116 CHAR16
*gReconnectConfirmChanges
;
117 CHAR16
*gReconnectFail
;
118 CHAR16
*gReconnectRequired
;
120 CHAR16
*gFormNotFound
;
122 CHAR16
*gBrowserError
;
124 CHAR16
*gNoSubmitIfFailed
;
125 CHAR16
*gSaveProcess
;
126 CHAR16
*gSaveNoSubmitProcess
;
127 CHAR16
*gDiscardChange
;
128 CHAR16
*gJumpToFormSet
;
130 CHAR16
*gPromptForData
;
131 CHAR16
*gPromptForPassword
;
132 CHAR16
*gPromptForNewPassword
;
133 CHAR16
*gConfirmPassword
;
134 CHAR16
*gConfirmError
;
135 CHAR16
*gPassowordInvalid
;
137 CHAR16
*gEmptyString
;
139 CHAR16
*gOptionMismatch
;
140 CHAR16
*gFormSuppress
;
141 CHAR16
*gProtocolNotFound
;
142 CHAR16
*gConfirmDefaultMsg
;
143 CHAR16
*gConfirmSubmitMsg
;
144 CHAR16
*gConfirmDiscardMsg
;
145 CHAR16
*gConfirmResetMsg
;
146 CHAR16
*gConfirmExitMsg
;
147 CHAR16
*gConfirmSubmitMsg2nd
;
148 CHAR16
*gConfirmDefaultMsg2nd
;
149 CHAR16
*gConfirmResetMsg2nd
;
150 CHAR16
*gConfirmExitMsg2nd
;
152 CHAR16
*gConfirmOptYes
;
153 CHAR16
*gConfirmOptNo
;
154 CHAR16
*gConfirmMsgConnect
;
155 CHAR16
*gConfirmMsgEnd
;
156 CHAR16 gModalSkipColumn
;
157 CHAR16 gPromptBlockWidth
;
158 CHAR16 gOptionBlockWidth
;
159 CHAR16 gHelpBlockWidth
;
160 CHAR16
*mUnknownString
;
162 FORM_DISPLAY_DRIVER_PRIVATE_DATA mPrivateData
= {
163 FORM_DISPLAY_DRIVER_SIGNATURE
,
167 DriverClearDisplayPage
,
174 Get the string based on the StringId and HII Package List Handle.
176 @param Token The String's ID.
177 @param HiiHandle The package list in the HII database to search for
178 the specified string.
180 @return The output string.
185 IN EFI_STRING_ID Token
,
186 IN EFI_HII_HANDLE HiiHandle
191 String
= HiiGetString (HiiHandle
, Token
, NULL
);
192 if (String
== NULL
) {
193 String
= AllocateCopyPool (StrSize (mUnknownString
), mUnknownString
);
194 ASSERT (String
!= NULL
);
197 return (CHAR16
*) String
;
202 Initialize the HII String Token to the correct values.
206 InitializeDisplayStrings (
210 gReconnectConfirmChanges
= GetToken (STRING_TOKEN (RECONNECT_CONFIRM_CHANGES
), gHiiHandle
);
211 mUnknownString
= GetToken (STRING_TOKEN (UNKNOWN_STRING
), gHiiHandle
);
212 gSaveFailed
= GetToken (STRING_TOKEN (SAVE_FAILED
), gHiiHandle
);
213 gNoSubmitIfFailed
= GetToken (STRING_TOKEN (NO_SUBMIT_IF_CHECK_FAILED
), gHiiHandle
);
214 gReconnectFail
= GetToken (STRING_TOKEN (RECONNECT_FAILED
), gHiiHandle
);
215 gReconnectRequired
= GetToken (STRING_TOKEN (RECONNECT_REQUIRED
), gHiiHandle
);
216 gChangesOpt
= GetToken (STRING_TOKEN (RECONNECT_CHANGES_OPTIONS
), gHiiHandle
);
217 gSaveProcess
= GetToken (STRING_TOKEN (DISCARD_OR_JUMP
), gHiiHandle
);
218 gSaveNoSubmitProcess
= GetToken (STRING_TOKEN (DISCARD_OR_CHECK
), gHiiHandle
);
219 gDiscardChange
= GetToken (STRING_TOKEN (DISCARD_OR_JUMP_DISCARD
), gHiiHandle
);
220 gJumpToFormSet
= GetToken (STRING_TOKEN (DISCARD_OR_JUMP_JUMP
), gHiiHandle
);
221 gCheckError
= GetToken (STRING_TOKEN (DISCARD_OR_CHECK_CHECK
), gHiiHandle
);
222 gPromptForData
= GetToken (STRING_TOKEN (PROMPT_FOR_DATA
), gHiiHandle
);
223 gPromptForPassword
= GetToken (STRING_TOKEN (PROMPT_FOR_PASSWORD
), gHiiHandle
);
224 gPromptForNewPassword
= GetToken (STRING_TOKEN (PROMPT_FOR_NEW_PASSWORD
), gHiiHandle
);
225 gConfirmPassword
= GetToken (STRING_TOKEN (CONFIRM_PASSWORD
), gHiiHandle
);
226 gConfirmError
= GetToken (STRING_TOKEN (CONFIRM_ERROR
), gHiiHandle
);
227 gPassowordInvalid
= GetToken (STRING_TOKEN (PASSWORD_INVALID
), gHiiHandle
);
228 gPressEnter
= GetToken (STRING_TOKEN (PRESS_ENTER
), gHiiHandle
);
229 gEmptyString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
230 gMiniString
= GetToken (STRING_TOKEN (MINI_STRING
), gHiiHandle
);
231 gOptionMismatch
= GetToken (STRING_TOKEN (OPTION_MISMATCH
), gHiiHandle
);
232 gFormSuppress
= GetToken (STRING_TOKEN (FORM_SUPPRESSED
), gHiiHandle
);
233 gProtocolNotFound
= GetToken (STRING_TOKEN (PROTOCOL_NOT_FOUND
), gHiiHandle
);
234 gFormNotFound
= GetToken (STRING_TOKEN (STATUS_BROWSER_FORM_NOT_FOUND
), gHiiHandle
);
235 gNoSubmitIf
= GetToken (STRING_TOKEN (STATUS_BROWSER_NO_SUBMIT_IF
), gHiiHandle
);
236 gBrowserError
= GetToken (STRING_TOKEN (STATUS_BROWSER_ERROR
), gHiiHandle
);
237 gConfirmDefaultMsg
= GetToken (STRING_TOKEN (CONFIRM_DEFAULT_MESSAGE
), gHiiHandle
);
238 gConfirmDiscardMsg
= GetToken (STRING_TOKEN (CONFIRM_DISCARD_MESSAGE
), gHiiHandle
);
239 gConfirmSubmitMsg
= GetToken (STRING_TOKEN (CONFIRM_SUBMIT_MESSAGE
), gHiiHandle
);
240 gConfirmResetMsg
= GetToken (STRING_TOKEN (CONFIRM_RESET_MESSAGE
), gHiiHandle
);
241 gConfirmExitMsg
= GetToken (STRING_TOKEN (CONFIRM_EXIT_MESSAGE
), gHiiHandle
);
242 gConfirmDefaultMsg2nd
= GetToken (STRING_TOKEN (CONFIRM_DEFAULT_MESSAGE_2ND
), gHiiHandle
);
243 gConfirmSubmitMsg2nd
= GetToken (STRING_TOKEN (CONFIRM_SUBMIT_MESSAGE_2ND
), gHiiHandle
);
244 gConfirmResetMsg2nd
= GetToken (STRING_TOKEN (CONFIRM_RESET_MESSAGE_2ND
), gHiiHandle
);
245 gConfirmExitMsg2nd
= GetToken (STRING_TOKEN (CONFIRM_EXIT_MESSAGE_2ND
), gHiiHandle
);
246 gConfirmOpt
= GetToken (STRING_TOKEN (CONFIRM_OPTION
), gHiiHandle
);
247 gConfirmOptYes
= GetToken (STRING_TOKEN (CONFIRM_OPTION_YES
), gHiiHandle
);
248 gConfirmOptNo
= GetToken (STRING_TOKEN (CONFIRM_OPTION_NO
), gHiiHandle
);
249 gConfirmMsgConnect
= GetToken (STRING_TOKEN (CONFIRM_OPTION_CONNECT
), gHiiHandle
);
250 gConfirmMsgEnd
= GetToken (STRING_TOKEN (CONFIRM_OPTION_END
), gHiiHandle
);
254 Free up the resource allocated for all strings required
263 FreePool (mUnknownString
);
264 FreePool (gEmptyString
);
265 FreePool (gSaveFailed
);
266 FreePool (gNoSubmitIfFailed
);
267 FreePool (gReconnectFail
);
268 FreePool (gReconnectRequired
);
269 FreePool (gChangesOpt
);
270 FreePool (gReconnectConfirmChanges
);
271 FreePool (gSaveProcess
);
272 FreePool (gSaveNoSubmitProcess
);
273 FreePool (gDiscardChange
);
274 FreePool (gJumpToFormSet
);
275 FreePool (gCheckError
);
276 FreePool (gPromptForData
);
277 FreePool (gPromptForPassword
);
278 FreePool (gPromptForNewPassword
);
279 FreePool (gConfirmPassword
);
280 FreePool (gConfirmError
);
281 FreePool (gPassowordInvalid
);
282 FreePool (gPressEnter
);
283 FreePool (gMiniString
);
284 FreePool (gOptionMismatch
);
285 FreePool (gFormSuppress
);
286 FreePool (gProtocolNotFound
);
287 FreePool (gBrowserError
);
288 FreePool (gNoSubmitIf
);
289 FreePool (gFormNotFound
);
290 FreePool (gConfirmDefaultMsg
);
291 FreePool (gConfirmSubmitMsg
);
292 FreePool (gConfirmDiscardMsg
);
293 FreePool (gConfirmResetMsg
);
294 FreePool (gConfirmExitMsg
);
295 FreePool (gConfirmDefaultMsg2nd
);
296 FreePool (gConfirmSubmitMsg2nd
);
297 FreePool (gConfirmResetMsg2nd
);
298 FreePool (gConfirmExitMsg2nd
);
299 FreePool (gConfirmOpt
);
300 FreePool (gConfirmOptYes
);
301 FreePool (gConfirmOptNo
);
302 FreePool (gConfirmMsgConnect
);
303 FreePool (gConfirmMsgEnd
);
307 Get prompt string id from the opcode data buffer.
309 @param OpCode The input opcode buffer.
311 @return The prompt string id.
316 IN EFI_IFR_OP_HEADER
*OpCode
319 EFI_IFR_STATEMENT_HEADER
*Header
;
321 if (OpCode
->Length
<= sizeof (EFI_IFR_OP_HEADER
)) {
325 Header
= (EFI_IFR_STATEMENT_HEADER
*) (OpCode
+ 1);
327 return Header
->Prompt
;
331 Get the supported width for a particular op-code
333 @param MenuOption The menu option.
334 @param AdjustWidth The width which is saved for the space.
336 @return Returns the number of CHAR16 characters that is support.
341 IN UI_MENU_OPTION
*MenuOption
,
342 OUT UINT16
*AdjustWidth
347 EFI_IFR_TEXT
*TestOp
;
349 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
351 Statement
= MenuOption
->ThisTag
;
354 // For modal form, clean the entire row.
356 if ((gFormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
357 if (AdjustWidth
!= NULL
) {
358 *AdjustWidth
= LEFT_SKIPPED_COLUMNS
;
360 return (UINT16
)(gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
- 2 * (gModalSkipColumn
+ LEFT_SKIPPED_COLUMNS
));
366 // See if the second text parameter is really NULL
368 if (Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) {
369 TestOp
= (EFI_IFR_TEXT
*) Statement
->OpCode
;
370 if (TestOp
->TextTwo
!= 0) {
371 String
= GetToken (TestOp
->TextTwo
, gFormData
->HiiHandle
);
372 Size
= StrLen (String
);
377 if ((Statement
->OpCode
->OpCode
== EFI_IFR_SUBTITLE_OP
) ||
378 (Statement
->OpCode
->OpCode
== EFI_IFR_REF_OP
) ||
379 (Statement
->OpCode
->OpCode
== EFI_IFR_PASSWORD_OP
) ||
380 (Statement
->OpCode
->OpCode
== EFI_IFR_ACTION_OP
) ||
381 (Statement
->OpCode
->OpCode
== EFI_IFR_RESET_BUTTON_OP
) ||
383 // Allow a wide display if text op-code and no secondary text op-code
385 ((Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) && (Size
== 0))
389 // Return the space width.
391 if (AdjustWidth
!= NULL
) {
395 // Keep consistent with current behavior.
397 ReturnWidth
= (UINT16
) (gPromptBlockWidth
+ gOptionBlockWidth
- 2);
399 if (AdjustWidth
!= NULL
) {
403 ReturnWidth
= (UINT16
) (gPromptBlockWidth
- 1);
407 // For nest in statement, should the subtitle indent.
409 if (MenuOption
->NestInStatement
) {
410 ReturnWidth
-= SUBTITLE_INDENT
;
417 Will copy LineWidth amount of a string in the OutputString buffer and return the
418 number of CHAR16 characters that were copied into the OutputString buffer.
419 The output string format is:
420 Glyph Info + String info + '\0'.
422 In the code, it deals \r,\n,\r\n same as \n\r, also it not process the \r or \g.
424 @param InputString String description for this option.
425 @param LineWidth Width of the desired string to extract in CHAR16
427 @param GlyphWidth The glyph width of the begin of the char in the string.
428 @param Index Where in InputString to start the copy process
429 @param OutputString Buffer to copy the string into
431 @return Returns the number of CHAR16 characters that were copied into the OutputString
432 buffer, include extra glyph info and '\0' info.
437 IN CHAR16
*InputString
,
439 IN OUT UINT16
*GlyphWidth
,
441 OUT CHAR16
**OutputString
446 UINT16 OriginalGlyphWidth
;
448 UINT16 LastSpaceOffset
;
449 UINT16 LastGlyphWidth
;
451 if (InputString
== NULL
|| Index
== NULL
|| OutputString
== NULL
) {
455 if (LineWidth
== 0 || *GlyphWidth
== 0) {
460 // Save original glyph width.
462 OriginalGlyphWidth
= *GlyphWidth
;
463 LastGlyphWidth
= OriginalGlyphWidth
;
468 // NARROW_CHAR can not be printed in screen, so if a line only contain the two CHARs: 'NARROW_CHAR + CHAR_CARRIAGE_RETURN' , it is a empty line in Screen.
469 // To avoid displaying this empty line in screen, just skip the two CHARs here.
471 if ((InputString
[*Index
] == NARROW_CHAR
) && (InputString
[*Index
+ 1] == CHAR_CARRIAGE_RETURN
)) {
476 // Fast-forward the string and see if there is a carriage-return in the string
478 for (StrOffset
= 0, GlyphOffset
= 0; GlyphOffset
<= LineWidth
; StrOffset
++) {
479 switch (InputString
[*Index
+ StrOffset
]) {
488 case CHAR_CARRIAGE_RETURN
:
495 GlyphOffset
= GlyphOffset
+ *GlyphWidth
;
498 // Record the last space info in this line. Will be used in rewind.
500 if ((InputString
[*Index
+ StrOffset
] == CHAR_SPACE
) && (GlyphOffset
<= LineWidth
)) {
501 LastSpaceOffset
= StrOffset
;
502 LastGlyphWidth
= *GlyphWidth
;
513 // Rewind the string from the maximum size until we see a space to break the line
515 if (GlyphOffset
> LineWidth
) {
517 // Rewind the string to last space char in this line.
519 if (LastSpaceOffset
!= 0) {
520 StrOffset
= LastSpaceOffset
;
521 *GlyphWidth
= LastGlyphWidth
;
524 // Roll back to last char in the line width.
531 // The CHAR_NULL has process last time, this time just return 0 to stand for the end.
533 if (StrOffset
== 0 && (InputString
[*Index
+ StrOffset
] == CHAR_NULL
)) {
538 // Need extra glyph info and '\0' info, so +2.
540 *OutputString
= AllocateZeroPool (((UINTN
) (StrOffset
+ 2) * sizeof(CHAR16
)));
541 if (*OutputString
== NULL
) {
546 // Save the glyph info at the begin of the string, will used by Print function.
548 if (OriginalGlyphWidth
== 1) {
549 *(*OutputString
) = NARROW_CHAR
;
551 *(*OutputString
) = WIDE_CHAR
;
554 CopyMem ((*OutputString
) + 1, &InputString
[*Index
], StrOffset
* sizeof(CHAR16
));
556 if (InputString
[*Index
+ StrOffset
] == CHAR_SPACE
) {
558 // Skip the space info at the begin of next line.
560 *Index
= (UINT16
) (*Index
+ StrOffset
+ 1);
561 } else if (InputString
[*Index
+ StrOffset
] == CHAR_LINEFEED
) {
563 // Skip the /n or /n/r info.
565 if (InputString
[*Index
+ StrOffset
+ 1] == CHAR_CARRIAGE_RETURN
) {
566 *Index
= (UINT16
) (*Index
+ StrOffset
+ 2);
568 *Index
= (UINT16
) (*Index
+ StrOffset
+ 1);
570 } else if (InputString
[*Index
+ StrOffset
] == CHAR_CARRIAGE_RETURN
) {
572 // Skip the /r or /r/n info.
574 if (InputString
[*Index
+ StrOffset
+ 1] == CHAR_LINEFEED
) {
575 *Index
= (UINT16
) (*Index
+ StrOffset
+ 2);
577 *Index
= (UINT16
) (*Index
+ StrOffset
+ 1);
580 *Index
= (UINT16
) (*Index
+ StrOffset
);
584 // Include extra glyph info and '\0' info, so +2.
586 return StrOffset
+ 2;
590 Add one menu option by specified description and context.
592 @param Statement Statement of this Menu Option.
593 @param MenuItemCount The index for this Option in the Menu.
594 @param NestIn Whether this statement is nest in another statement.
599 IN FORM_DISPLAY_ENGINE_STATEMENT
*Statement
,
600 IN UINT16
*MenuItemCount
,
604 UI_MENU_OPTION
*MenuOption
;
608 UINT16 NumberOfLines
;
612 CHAR16
*OutputString
;
613 EFI_STRING_ID PromptId
;
621 PromptId
= GetPrompt (Statement
->OpCode
);
622 ASSERT (PromptId
!= 0);
624 String
= GetToken (PromptId
, gFormData
->HiiHandle
);
625 ASSERT (String
!= NULL
);
627 if (Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
|| Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
) {
631 for (Index
= 0; Index
< Count
; Index
++) {
632 MenuOption
= AllocateZeroPool (sizeof (UI_MENU_OPTION
));
635 MenuOption
->Signature
= UI_MENU_OPTION_SIGNATURE
;
636 MenuOption
->Description
= String
;
637 MenuOption
->Handle
= gFormData
->HiiHandle
;
638 MenuOption
->ThisTag
= Statement
;
639 MenuOption
->NestInStatement
= NestIn
;
640 MenuOption
->EntryNumber
= *MenuItemCount
;
642 MenuOption
->Sequence
= Index
;
644 if ((Statement
->Attribute
& HII_DISPLAY_GRAYOUT
) != 0) {
645 MenuOption
->GrayOut
= TRUE
;
647 MenuOption
->GrayOut
= FALSE
;
650 if ((Statement
->Attribute
& HII_DISPLAY_LOCK
) != 0 || (gFormData
->Attribute
& HII_DISPLAY_LOCK
) != 0) {
651 MenuOption
->GrayOut
= TRUE
;
655 // If the form or the question has the lock attribute, deal same as grayout.
657 if ((gFormData
->Attribute
& HII_DISPLAY_LOCK
) != 0 || (Statement
->Attribute
& HII_DISPLAY_LOCK
) != 0) {
658 MenuOption
->GrayOut
= TRUE
;
661 switch (Statement
->OpCode
->OpCode
) {
662 case EFI_IFR_ORDERED_LIST_OP
:
663 case EFI_IFR_ONE_OF_OP
:
664 case EFI_IFR_NUMERIC_OP
:
665 case EFI_IFR_TIME_OP
:
666 case EFI_IFR_DATE_OP
:
667 case EFI_IFR_CHECKBOX_OP
:
668 case EFI_IFR_PASSWORD_OP
:
669 case EFI_IFR_STRING_OP
:
671 // User could change the value of these items
673 MenuOption
->IsQuestion
= TRUE
;
675 case EFI_IFR_TEXT_OP
:
676 if (FeaturePcdGet (PcdBrowserGrayOutTextStatement
)) {
678 // Initializing GrayOut option as TRUE for Text setup options
679 // so that those options will be Gray in colour and un selectable.
681 MenuOption
->GrayOut
= TRUE
;
685 MenuOption
->IsQuestion
= FALSE
;
689 if ((Statement
->Attribute
& HII_DISPLAY_READONLY
) != 0) {
690 MenuOption
->ReadOnly
= TRUE
;
691 if (FeaturePcdGet (PcdBrowerGrayOutReadOnlyMenu
)) {
692 MenuOption
->GrayOut
= TRUE
;
697 (Statement
->OpCode
->OpCode
!= EFI_IFR_DATE_OP
) &&
698 (Statement
->OpCode
->OpCode
!= EFI_IFR_TIME_OP
)) {
699 Width
= GetWidth (MenuOption
, NULL
);
700 for (; GetLineByWidth (String
, Width
, &GlyphWidth
,&ArrayEntry
, &OutputString
) != 0x0000;) {
702 // If there is more string to process print on the next row and increment the Skip value
704 if (StrLen (&String
[ArrayEntry
]) != 0) {
707 FreePool (OutputString
);
711 // Add three MenuOptions for Date/Time
712 // Data format : [01/02/2004] [11:22:33]
713 // Line number : 0 0 1 0 0 1
720 // Override LineNumber for the MenuOption in Date/Time sequence
722 MenuOption
->Skip
= 1;
724 MenuOption
->Skip
= NumberOfLines
;
727 InsertTailList (&gMenuOption
, &MenuOption
->Link
);
734 Create the menu list base on the form data info.
738 ConvertStatementToMenu (
742 UINT16 MenuItemCount
;
744 LIST_ENTRY
*NestLink
;
745 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
746 FORM_DISPLAY_ENGINE_STATEMENT
*NestStatement
;
749 InitializeListHead (&gMenuOption
);
751 Link
= GetFirstNode (&gFormData
->StatementListHead
);
752 while (!IsNull (&gFormData
->StatementListHead
, Link
)) {
753 Statement
= FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK (Link
);
754 Link
= GetNextNode (&gFormData
->StatementListHead
, Link
);
757 // Skip the opcode not recognized by Display core.
759 if (Statement
->OpCode
->OpCode
== EFI_IFR_GUID_OP
) {
763 UiAddMenuOption (Statement
, &MenuItemCount
, FALSE
);
766 // Check the statement nest in this host statement.
768 NestLink
= GetFirstNode (&Statement
->NestStatementList
);
769 while (!IsNull (&Statement
->NestStatementList
, NestLink
)) {
770 NestStatement
= FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK (NestLink
);
771 NestLink
= GetNextNode (&Statement
->NestStatementList
, NestLink
);
774 // Skip the opcode not recognized by Display core.
776 if (NestStatement
->OpCode
->OpCode
== EFI_IFR_GUID_OP
) {
780 UiAddMenuOption (NestStatement
, &MenuItemCount
, TRUE
);
786 Count the storage space of a Unicode string.
788 This function handles the Unicode string with NARROW_CHAR
789 and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR
790 does not count in the resultant output. If a WIDE_CHAR is
791 hit, then 2 Unicode character will consume an output storage
792 space with size of CHAR16 till a NARROW_CHAR is hit.
794 If String is NULL, then ASSERT ().
796 @param String The input string to be counted.
798 @return Storage space for the input string.
808 UINTN IncrementValue
;
810 ASSERT (String
!= NULL
);
811 if (String
== NULL
) {
821 // Advance to the null-terminator or to the first width directive
824 (String
[Index
] != NARROW_CHAR
) && (String
[Index
] != WIDE_CHAR
) && (String
[Index
] != 0);
825 Index
++, Count
= Count
+ IncrementValue
830 // We hit the null-terminator, we now have a count
832 if (String
[Index
] == 0) {
836 // We encountered a narrow directive - strip it from the size calculation since it doesn't get printed
837 // and also set the flag that determines what we increment by.(if narrow, increment by 1, if wide increment by 2)
839 if (String
[Index
] == NARROW_CHAR
) {
841 // Skip to the next character
847 // Skip to the next character
852 } while (String
[Index
] != 0);
855 // Increment by one to include the null-terminator in the size
859 return Count
* sizeof (CHAR16
);
863 Base on the input option string to update the skip value for a menu option.
865 @param MenuOption The MenuOption to be checked.
866 @param OptionString The input option string.
870 UpdateSkipInfoForMenu (
871 IN UI_MENU_OPTION
*MenuOption
,
872 IN CHAR16
*OptionString
878 CHAR16
*OutputString
;
881 Width
= (UINT16
) gOptionBlockWidth
;
885 for (Index
= 0; GetLineByWidth (OptionString
, Width
, &GlyphWidth
, &Index
, &OutputString
) != 0x0000;) {
886 if (StrLen (&OptionString
[Index
]) != 0) {
890 FreePool (OutputString
);
893 if ((Row
> MenuOption
->Skip
) &&
894 (MenuOption
->ThisTag
->OpCode
->OpCode
!= EFI_IFR_DATE_OP
) &&
895 (MenuOption
->ThisTag
->OpCode
->OpCode
!= EFI_IFR_TIME_OP
)) {
896 MenuOption
->Skip
= Row
;
901 Update display lines for a Menu Option.
903 @param MenuOption The MenuOption to be checked.
907 UpdateOptionSkipLines (
908 IN UI_MENU_OPTION
*MenuOption
911 CHAR16
*OptionString
;
915 ProcessOptions (MenuOption
, FALSE
, &OptionString
, TRUE
);
916 if (OptionString
!= NULL
) {
917 UpdateSkipInfoForMenu (MenuOption
, OptionString
);
919 FreePool (OptionString
);
922 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) && (((EFI_IFR_TEXT
*)MenuOption
->ThisTag
->OpCode
)->TextTwo
!= 0)) {
923 OptionString
= GetToken (((EFI_IFR_TEXT
*)MenuOption
->ThisTag
->OpCode
)->TextTwo
, gFormData
->HiiHandle
);
925 if (OptionString
!= NULL
) {
926 UpdateSkipInfoForMenu (MenuOption
, OptionString
);
928 FreePool (OptionString
);
934 Check whether this Menu Option could be print.
936 Check Prompt string, option string or text two string not NULL.
938 This is an internal function.
940 @param MenuOption The MenuOption to be checked.
942 @retval TRUE This Menu Option is printable.
943 @retval FALSE This Menu Option could not be printable.
948 UI_MENU_OPTION
*MenuOption
952 EFI_STRING OptionString
;
956 if (MenuOption
->Description
[0] != '\0') {
960 Status
= ProcessOptions (MenuOption
, FALSE
, &OptionString
, FALSE
);
961 if (EFI_ERROR (Status
)) {
964 if (OptionString
!= NULL
&& OptionString
[0] != '\0') {
965 FreePool (OptionString
);
969 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) && (((EFI_IFR_TEXT
*)MenuOption
->ThisTag
->OpCode
)->TextTwo
!= 0)) {
970 OptionString
= GetToken (((EFI_IFR_TEXT
*)MenuOption
->ThisTag
->OpCode
)->TextTwo
, gFormData
->HiiHandle
);
971 ASSERT (OptionString
!= NULL
);
972 if (OptionString
[0] != '\0'){
973 FreePool (OptionString
);
982 Check whether this Menu Option could be highlighted.
984 This is an internal function.
986 @param MenuOption The MenuOption to be checked.
988 @retval TRUE This Menu Option is selectable.
989 @retval FALSE This Menu Option could not be selected.
994 UI_MENU_OPTION
*MenuOption
997 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_SUBTITLE_OP
) ||
998 MenuOption
->GrayOut
|| MenuOption
->ReadOnly
|| !PrintableMenu (MenuOption
)) {
1006 Move to next selectable statement.
1008 This is an internal function.
1010 @param GoUp The navigation direction. TRUE: up, FALSE: down.
1011 @param CurrentPosition Current position.
1012 @param GapToTop Gap position to top or bottom.
1013 @param FindInForm Whether find menu in current form or beyond.
1015 @return The row distance from current MenuOption to next selectable MenuOption.
1017 @retval -1 Reach the begin of the menu, still can't find the selectable menu.
1018 @retval Value Find the selectable menu, maybe the truly selectable, maybe the
1019 first menu showing beyond current form or last menu showing in
1021 The value is the line number between the new selected menu and the
1022 current select menu, not include the new selected menu.
1026 MoveToNextStatement (
1028 IN OUT LIST_ENTRY
**CurrentPosition
,
1030 IN BOOLEAN FindInForm
1035 UI_MENU_OPTION
*NextMenuOption
;
1036 UI_MENU_OPTION
*PreMenuOption
;
1039 Pos
= *CurrentPosition
;
1041 if (Pos
== &gMenuOption
) {
1045 PreMenuOption
= MENU_OPTION_FROM_LINK (Pos
);
1048 NextMenuOption
= MENU_OPTION_FROM_LINK (Pos
);
1050 // NextMenuOption->Row == 0 means this menu has not calculate
1051 // the NextMenuOption->Skip value yet, just calculate here.
1053 if (NextMenuOption
->Row
== 0) {
1054 UpdateOptionSkipLines (NextMenuOption
);
1057 if (IsSelectable (NextMenuOption
)) {
1062 // In this case, still can't find the selectable menu,
1063 // return the first one beyond the showing form.
1065 if ((UINTN
) Distance
+ NextMenuOption
->Skip
> GapToTop
) {
1067 NextMenuOption
= PreMenuOption
;
1072 Distance
+= NextMenuOption
->Skip
;
1075 // Arrive at begin of the menu list.
1077 if ((GoUp
? Pos
->BackLink
: Pos
->ForwardLink
) == &gMenuOption
) {
1082 Pos
= (GoUp
? Pos
->BackLink
: Pos
->ForwardLink
);
1083 PreMenuOption
= NextMenuOption
;
1086 *CurrentPosition
= &NextMenuOption
->Link
;
1092 Process option string for date/time opcode.
1094 @param MenuOption Menu option point to date/time.
1095 @param OptionString Option string input for process.
1096 @param AddOptCol Whether need to update MenuOption->OptCol.
1100 ProcessStringForDateTime (
1101 UI_MENU_OPTION
*MenuOption
,
1102 CHAR16
*OptionString
,
1108 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
1112 ASSERT (MenuOption
!= NULL
&& OptionString
!= NULL
);
1114 Statement
= MenuOption
->ThisTag
;
1117 if (Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
) {
1118 Date
= (EFI_IFR_DATE
*) Statement
->OpCode
;
1119 } else if (Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
) {
1120 Time
= (EFI_IFR_TIME
*) Statement
->OpCode
;
1124 // If leading spaces on OptionString - remove the spaces
1126 for (Index
= 0; OptionString
[Index
] == L
' '; Index
++) {
1128 // Base on the blockspace to get the option column info.
1131 MenuOption
->OptCol
++;
1135 for (Count
= 0; OptionString
[Index
] != CHAR_NULL
; Index
++) {
1136 OptionString
[Count
] = OptionString
[Index
];
1139 OptionString
[Count
] = CHAR_NULL
;
1142 // Enable to suppress field in the opcode base on the flag.
1144 if (Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
) {
1146 // OptionString format is: <**: **: ****>
1150 if ((Date
->Flags
& EFI_QF_DATE_MONTH_SUPPRESS
) && (MenuOption
->Sequence
== 0)) {
1152 // At this point, only "<**:" in the optionstring.
1153 // Clean the day's ** field, after clean, the format is "< :"
1155 SetUnicodeMem (&OptionString
[1], 2, L
' ');
1156 } else if ((Date
->Flags
& EFI_QF_DATE_DAY_SUPPRESS
) && (MenuOption
->Sequence
== 1)) {
1158 // At this point, only "**:" in the optionstring.
1159 // Clean the month's "**" field, after clean, the format is " :"
1161 SetUnicodeMem (&OptionString
[0], 2, L
' ');
1162 } else if ((Date
->Flags
& EFI_QF_DATE_YEAR_SUPPRESS
) && (MenuOption
->Sequence
== 2)) {
1164 // At this point, only "****>" in the optionstring.
1165 // Clean the year's "****" field, after clean, the format is " >"
1167 SetUnicodeMem (&OptionString
[0], 4, L
' ');
1169 } else if (Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
) {
1171 // OptionString format is: <**: **: **>
1172 // |hour|minute|second|
1175 if ((Time
->Flags
& QF_TIME_HOUR_SUPPRESS
) && (MenuOption
->Sequence
== 0)) {
1177 // At this point, only "<**:" in the optionstring.
1178 // Clean the hour's ** field, after clean, the format is "< :"
1180 SetUnicodeMem (&OptionString
[1], 2, L
' ');
1181 } else if ((Time
->Flags
& QF_TIME_MINUTE_SUPPRESS
) && (MenuOption
->Sequence
== 1)) {
1183 // At this point, only "**:" in the optionstring.
1184 // Clean the minute's "**" field, after clean, the format is " :"
1186 SetUnicodeMem (&OptionString
[0], 2, L
' ');
1187 } else if ((Time
->Flags
& QF_TIME_SECOND_SUPPRESS
) && (MenuOption
->Sequence
== 2)) {
1189 // At this point, only "**>" in the optionstring.
1190 // Clean the second's "**" field, after clean, the format is " >"
1192 SetUnicodeMem (&OptionString
[0], 2, L
' ');
1199 Adjust Data and Time position accordingly.
1200 Data format : [01/02/2004] [11:22:33]
1201 Line number : 0 0 1 0 0 1
1203 This is an internal function.
1205 @param DirectionUp the up or down direction. False is down. True is
1207 @param CurrentPosition Current position. On return: Point to the last
1208 Option (Year or Second) if up; Point to the first
1209 Option (Month or Hour) if down.
1211 @return Return line number to pad. It is possible that we stand on a zero-advance
1212 @return data or time opcode, so pad one line when we judge if we are going to scroll outside.
1216 AdjustDateAndTimePosition (
1217 IN BOOLEAN DirectionUp
,
1218 IN OUT LIST_ENTRY
**CurrentPosition
1222 LIST_ENTRY
*NewPosition
;
1223 UI_MENU_OPTION
*MenuOption
;
1224 UINTN PadLineNumber
;
1227 NewPosition
= *CurrentPosition
;
1228 MenuOption
= MENU_OPTION_FROM_LINK (NewPosition
);
1230 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_DATE_OP
) ||
1231 (MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_TIME_OP
)) {
1233 // Calculate the distance from current position to the last Date/Time MenuOption
1236 while (MenuOption
->Skip
== 0) {
1238 NewPosition
= NewPosition
->ForwardLink
;
1239 MenuOption
= MENU_OPTION_FROM_LINK (NewPosition
);
1243 NewPosition
= *CurrentPosition
;
1246 // Since the behavior of hitting the up arrow on a Date/Time MenuOption is intended
1247 // to be one that back to the previous set of MenuOptions, we need to advance to the first
1248 // Date/Time MenuOption and leave the remaining logic in CfUiUp intact so the appropriate
1249 // checking can be done.
1251 while (Count
++ < 2) {
1252 NewPosition
= NewPosition
->BackLink
;
1256 // Since the behavior of hitting the down arrow on a Date/Time MenuOption is intended
1257 // to be one that progresses to the next set of MenuOptions, we need to advance to the last
1258 // Date/Time MenuOption and leave the remaining logic in CfUiDown intact so the appropriate
1259 // checking can be done.
1261 while (Count
-- > 0) {
1262 NewPosition
= NewPosition
->ForwardLink
;
1266 *CurrentPosition
= NewPosition
;
1269 return PadLineNumber
;
1273 Get step info from numeric opcode.
1275 @param[in] OpCode The input numeric op code.
1277 @return step info for this opcode.
1281 IN EFI_IFR_OP_HEADER
*OpCode
1284 EFI_IFR_NUMERIC
*NumericOp
;
1287 NumericOp
= (EFI_IFR_NUMERIC
*) OpCode
;
1289 switch (NumericOp
->Flags
& EFI_IFR_NUMERIC_SIZE
) {
1290 case EFI_IFR_NUMERIC_SIZE_1
:
1291 Step
= NumericOp
->data
.u8
.Step
;
1294 case EFI_IFR_NUMERIC_SIZE_2
:
1295 Step
= NumericOp
->data
.u16
.Step
;
1298 case EFI_IFR_NUMERIC_SIZE_4
:
1299 Step
= NumericOp
->data
.u32
.Step
;
1302 case EFI_IFR_NUMERIC_SIZE_8
:
1303 Step
= NumericOp
->data
.u64
.Step
;
1315 Find the registered HotKey based on KeyData.
1317 @param[in] KeyData A pointer to a buffer that describes the keystroke
1318 information for the hot key.
1320 @return The registered HotKey context. If no found, NULL will return.
1323 GetHotKeyFromRegisterList (
1324 IN EFI_INPUT_KEY
*KeyData
1328 BROWSER_HOT_KEY
*HotKey
;
1330 Link
= GetFirstNode (&gFormData
->HotKeyListHead
);
1331 while (!IsNull (&gFormData
->HotKeyListHead
, Link
)) {
1332 HotKey
= BROWSER_HOT_KEY_FROM_LINK (Link
);
1334 if (HotKey
->KeyData
->ScanCode
== KeyData
->ScanCode
) {
1338 Link
= GetNextNode (&gFormData
->HotKeyListHead
, Link
);
1346 Determine if the menu is the last menu that can be selected.
1348 This is an internal function.
1350 @param Direction The scroll direction. False is down. True is up.
1351 @param CurrentPos The current focus.
1353 @return FALSE -- the menu isn't the last menu that can be selected.
1354 @return TRUE -- the menu is the last menu that can be selected.
1359 IN BOOLEAN Direction
,
1360 IN LIST_ENTRY
*CurrentPos
1365 Temp
= Direction
? CurrentPos
->BackLink
: CurrentPos
->ForwardLink
;
1367 if (Temp
== &gMenuOption
) {
1375 Wait for a given event to fire, or for an optional timeout to expire.
1377 @param Event The event to wait for
1379 @retval UI_EVENT_TYPE The type of the event which is trigged.
1391 EFI_EVENT TimerEvent
;
1392 EFI_EVENT WaitList
[3];
1393 UI_EVENT_TYPE EventType
;
1396 Timeout
= FormExitTimeout(gFormData
);
1399 Status
= gBS
->CreateEvent (EVT_TIMER
, 0, NULL
, NULL
, &TimerEvent
);
1402 // Set the timer event
1411 WaitList
[0] = Event
;
1413 if (gFormData
->FormRefreshEvent
!= NULL
) {
1414 WaitList
[EventNum
] = gFormData
->FormRefreshEvent
;
1419 WaitList
[EventNum
] = TimerEvent
;
1423 Status
= gBS
->WaitForEvent (EventNum
, WaitList
, &Index
);
1424 ASSERT_EFI_ERROR (Status
);
1428 EventType
= UIEventKey
;
1432 if (gFormData
->FormRefreshEvent
!= NULL
) {
1433 EventType
= UIEventDriver
;
1435 ASSERT (Timeout
!= 0 && EventNum
== 2);
1436 EventType
= UIEventTimeOut
;
1441 ASSERT (Index
== 2 && EventNum
== 3);
1442 EventType
= UIEventTimeOut
;
1447 gBS
->CloseEvent (TimerEvent
);
1454 Get question id info from the input opcode header.
1456 @param OpCode The input opcode header pointer.
1458 @retval The question id for this opcode.
1463 IN EFI_IFR_OP_HEADER
*OpCode
1466 EFI_IFR_QUESTION_HEADER
*QuestionHeader
;
1468 if (OpCode
->Length
< sizeof (EFI_IFR_OP_HEADER
) + sizeof (EFI_IFR_QUESTION_HEADER
)) {
1472 QuestionHeader
= (EFI_IFR_QUESTION_HEADER
*)((UINT8
*) OpCode
+ sizeof(EFI_IFR_OP_HEADER
));
1474 return QuestionHeader
->QuestionId
;
1479 Find the top of screen menu base on the current menu.
1481 @param CurPos Current input menu.
1482 @param Rows Totol screen rows.
1483 @param SkipValue SkipValue for this new form.
1485 @retval TopOfScreen Top of screen menu for the new form.
1489 FindTopOfScreenMenu (
1490 IN LIST_ENTRY
*CurPos
,
1492 OUT UINTN
*SkipValue
1496 LIST_ENTRY
*TopOfScreen
;
1497 UI_MENU_OPTION
*PreviousMenuOption
;
1500 PreviousMenuOption
= NULL
;
1502 while (Link
->BackLink
!= &gMenuOption
) {
1503 Link
= Link
->BackLink
;
1504 PreviousMenuOption
= MENU_OPTION_FROM_LINK (Link
);
1505 if (PreviousMenuOption
->Row
== 0) {
1506 UpdateOptionSkipLines (PreviousMenuOption
);
1508 if (Rows
<= PreviousMenuOption
->Skip
) {
1511 Rows
= Rows
- PreviousMenuOption
->Skip
;
1514 if (Link
->BackLink
== &gMenuOption
) {
1515 TopOfScreen
= gMenuOption
.ForwardLink
;
1516 if (PreviousMenuOption
!= NULL
&& Rows
< PreviousMenuOption
->Skip
) {
1517 *SkipValue
= PreviousMenuOption
->Skip
- Rows
;
1523 *SkipValue
= PreviousMenuOption
->Skip
- Rows
;
1530 Get the index info for this opcode.
1532 @param OpCode The input opcode for the statement.
1534 @retval The index of this statement.
1538 GetIndexInfoForOpcode (
1539 IN EFI_IFR_OP_HEADER
*OpCode
1543 UI_MENU_OPTION
*MenuOption
;
1546 NewPos
= gMenuOption
.ForwardLink
;
1549 for (NewPos
= gMenuOption
.ForwardLink
; NewPos
!= &gMenuOption
; NewPos
= NewPos
->ForwardLink
){
1550 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1552 if (CompareMem (MenuOption
->ThisTag
->OpCode
, OpCode
, OpCode
->Length
) == 0) {
1553 if (MenuOption
->ThisTag
->OpCode
== OpCode
) {
1565 Is this the saved highlight statement.
1567 @param HighLightedStatement The input highlight statement.
1569 @retval TRUE This is the highlight statement.
1570 @retval FALSE This is not the highlight statement.
1574 IsSavedHighlightStatement (
1575 IN FORM_DISPLAY_ENGINE_STATEMENT
*HighLightedStatement
1578 if ((gFormData
->HiiHandle
== gHighligthMenuInfo
.HiiHandle
) &&
1579 (gFormData
->FormId
== gHighligthMenuInfo
.FormId
)) {
1580 if (gHighligthMenuInfo
.HLTQuestionId
!= 0) {
1581 return (BOOLEAN
) (gHighligthMenuInfo
.HLTQuestionId
== GetQuestionIdInfo (HighLightedStatement
->OpCode
));
1583 if (CompareMem (gHighligthMenuInfo
.HLTOpCode
, HighLightedStatement
->OpCode
, gHighligthMenuInfo
.HLTOpCode
->Length
) == 0) {
1584 if (gHighligthMenuInfo
.HLTIndex
== 0 || gHighligthMenuInfo
.HLTIndex
== GetIndexInfoForOpcode(HighLightedStatement
->OpCode
)) {
1597 Is this the highlight menu.
1599 @param MenuOption The input Menu option.
1601 @retval TRUE This is the highlight menu option.
1602 @retval FALSE This is not the highlight menu option.
1606 IsHighLightMenuOption (
1607 IN UI_MENU_OPTION
*MenuOption
1610 if (gHighligthMenuInfo
.HLTQuestionId
!= 0) {
1611 if (GetQuestionIdInfo(MenuOption
->ThisTag
->OpCode
) == gHighligthMenuInfo
.HLTQuestionId
) {
1612 return (BOOLEAN
) (MenuOption
->Sequence
== gHighligthMenuInfo
.HLTSequence
);
1615 if(CompareMem (gHighligthMenuInfo
.HLTOpCode
, MenuOption
->ThisTag
->OpCode
, gHighligthMenuInfo
.HLTOpCode
->Length
) == 0) {
1616 if (gHighligthMenuInfo
.HLTIndex
== 0 || gHighligthMenuInfo
.HLTIndex
== GetIndexInfoForOpcode(MenuOption
->ThisTag
->OpCode
)) {
1617 return (BOOLEAN
) (MenuOption
->Sequence
== gHighligthMenuInfo
.HLTSequence
);
1628 Find the highlight menu.
1630 If the input is NULL, base on the record highlight info in
1631 gHighligthMenuInfo to find the last highlight menu.
1633 @param HighLightedStatement The input highlight statement.
1635 @retval The highlight menu index.
1639 FindHighLightMenuOption (
1640 IN FORM_DISPLAY_ENGINE_STATEMENT
*HighLightedStatement
1644 UI_MENU_OPTION
*MenuOption
;
1646 NewPos
= gMenuOption
.ForwardLink
;
1647 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1649 if (HighLightedStatement
!= NULL
) {
1650 while (MenuOption
->ThisTag
!= HighLightedStatement
) {
1651 NewPos
= NewPos
->ForwardLink
;
1652 if (NewPos
== &gMenuOption
) {
1654 // Not Found it, break
1658 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1662 // Must find the highlight statement.
1664 ASSERT (NewPos
!= &gMenuOption
);
1667 while (!IsHighLightMenuOption (MenuOption
)) {
1668 NewPos
= NewPos
->ForwardLink
;
1669 if (NewPos
== &gMenuOption
) {
1671 // Not Found it, break
1675 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1679 // Highlight statement has disappear (suppressed/disableed)
1681 if (NewPos
== &gMenuOption
) {
1690 Is this the Top of screen menu.
1692 @param MenuOption The input Menu option.
1694 @retval TRUE This is the Top of screen menu option.
1695 @retval FALSE This is not the Top of screen menu option.
1699 IsTopOfScreeMenuOption (
1700 IN UI_MENU_OPTION
*MenuOption
1703 if (gHighligthMenuInfo
.TOSQuestionId
!= 0) {
1704 return (BOOLEAN
) (GetQuestionIdInfo(MenuOption
->ThisTag
->OpCode
) == gHighligthMenuInfo
.TOSQuestionId
);
1707 if(CompareMem (gHighligthMenuInfo
.TOSOpCode
, MenuOption
->ThisTag
->OpCode
, gHighligthMenuInfo
.TOSOpCode
->Length
) == 0) {
1708 if (gHighligthMenuInfo
.TOSIndex
== 0 || gHighligthMenuInfo
.TOSIndex
== GetIndexInfoForOpcode(MenuOption
->ThisTag
->OpCode
)) {
1719 Find the Top of screen menu.
1721 If the input is NULL, base on the record highlight info in
1722 gHighligthMenuInfo to find the last highlight menu.
1724 @param HighLightedStatement The input highlight statement.
1726 @retval The highlight menu index.
1730 FindTopOfScreenMenuOption (
1735 UI_MENU_OPTION
*MenuOption
;
1737 NewPos
= gMenuOption
.ForwardLink
;
1738 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1740 while (!IsTopOfScreeMenuOption(MenuOption
)) {
1741 NewPos
= NewPos
->ForwardLink
;
1742 if (NewPos
== &gMenuOption
) {
1744 // Not Found it, break
1748 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1752 // Last time top of screen menu has disappeared.
1754 if (NewPos
== &gMenuOption
) {
1762 Find the first menu which will be show at the top.
1764 @param FormData The data info for this form.
1765 @param TopOfScreen The link_entry pointer to top menu.
1766 @param HighlightMenu The menu which will be highlight.
1767 @param SkipValue The skip value for the top menu.
1772 IN FORM_DISPLAY_ENGINE_FORM
*FormData
,
1773 OUT LIST_ENTRY
**TopOfScreen
,
1774 OUT LIST_ENTRY
**HighlightMenu
,
1775 OUT UINTN
*SkipValue
1780 UI_MENU_OPTION
*MenuOption
;
1783 TopRow
= gStatementDimensions
.TopRow
+ SCROLL_ARROW_HEIGHT
;
1784 BottomRow
= gStatementDimensions
.BottomRow
- SCROLL_ARROW_HEIGHT
;
1788 // Reenter caused by option mismatch or auto exit caused by refresh form(refresh interval/guid),
1789 // base on the record highlight info to find the highlight menu.
1791 ASSERT (gFormData
->HiiHandle
== gHighligthMenuInfo
.HiiHandle
&&
1792 gFormData
->FormId
== gHighligthMenuInfo
.FormId
);
1794 *HighlightMenu
= FindHighLightMenuOption(NULL
);
1795 if (*HighlightMenu
!= NULL
) {
1797 // Update skip info for this highlight menu.
1799 MenuOption
= MENU_OPTION_FROM_LINK (*HighlightMenu
);
1800 UpdateOptionSkipLines (MenuOption
);
1803 // Found the last time highlight menu.
1805 *TopOfScreen
= FindTopOfScreenMenuOption();
1806 if (*TopOfScreen
!= NULL
) {
1808 // Found the last time selectable top of screen menu.
1810 AdjustDateAndTimePosition(TRUE
, TopOfScreen
);
1811 MenuOption
= MENU_OPTION_FROM_LINK (*TopOfScreen
);
1812 UpdateOptionSkipLines (MenuOption
);
1814 *SkipValue
= gHighligthMenuInfo
.SkipValue
;
1817 // Not found last time top of screen menu, so base on current highlight menu
1818 // to find the new top of screen menu.
1819 // Make the current highlight menu at the bottom of the form to calculate the
1820 // top of screen menu.
1822 if (MenuOption
->Skip
>= BottomRow
- TopRow
) {
1823 *TopOfScreen
= *HighlightMenu
;
1826 *TopOfScreen
= FindTopOfScreenMenu(*HighlightMenu
, BottomRow
- TopRow
- MenuOption
->Skip
, &TmpValue
);
1829 *SkipValue
= TmpValue
;
1833 // Last time highlight menu has disappear, find the first highlightable menu as the defalut one.
1835 *HighlightMenu
= gMenuOption
.ForwardLink
;
1836 if (!IsListEmpty (&gMenuOption
)) {
1837 MoveToNextStatement (FALSE
, HighlightMenu
, BottomRow
- TopRow
, TRUE
);
1839 *TopOfScreen
= gMenuOption
.ForwardLink
;
1844 } else if (FormData
->HighLightedStatement
!= NULL
) {
1845 if (IsSavedHighlightStatement (FormData
->HighLightedStatement
)) {
1847 // Input highlight menu is same as last time highlight menu.
1848 // Base on last time highlight menu to set the top of screen menu and highlight menu.
1850 *HighlightMenu
= FindHighLightMenuOption(NULL
);
1851 ASSERT (*HighlightMenu
!= NULL
);
1854 // Update skip info for this highlight menu.
1856 MenuOption
= MENU_OPTION_FROM_LINK (*HighlightMenu
);
1857 UpdateOptionSkipLines (MenuOption
);
1859 *TopOfScreen
= FindTopOfScreenMenuOption();
1860 if (*TopOfScreen
== NULL
) {
1862 // Not found last time top of screen menu, so base on current highlight menu
1863 // to find the new top of screen menu.
1864 // Make the current highlight menu at the bottom of the form to calculate the
1865 // top of screen menu.
1867 if (MenuOption
->Skip
>= BottomRow
- TopRow
) {
1868 *TopOfScreen
= *HighlightMenu
;
1871 *TopOfScreen
= FindTopOfScreenMenu(*HighlightMenu
, BottomRow
- TopRow
- MenuOption
->Skip
, &TmpValue
);
1874 *SkipValue
= TmpValue
;
1876 AdjustDateAndTimePosition(TRUE
, TopOfScreen
);
1877 MenuOption
= MENU_OPTION_FROM_LINK (*TopOfScreen
);
1878 UpdateOptionSkipLines (MenuOption
);
1880 *SkipValue
= gHighligthMenuInfo
.SkipValue
;
1882 AdjustDateAndTimePosition(TRUE
, TopOfScreen
);
1885 // Input highlight menu is not save as last time highlight menu.
1887 *HighlightMenu
= FindHighLightMenuOption(FormData
->HighLightedStatement
);
1888 MenuOption
= MENU_OPTION_FROM_LINK (*HighlightMenu
);
1889 UpdateOptionSkipLines (MenuOption
);
1892 // Make the current highlight menu at the bottom of the form to calculate the
1893 // top of screen menu.
1895 if (MenuOption
->Skip
>= BottomRow
- TopRow
) {
1896 *TopOfScreen
= *HighlightMenu
;
1899 *TopOfScreen
= FindTopOfScreenMenu(*HighlightMenu
, BottomRow
- TopRow
- MenuOption
->Skip
, &TmpValue
);
1902 *SkipValue
= TmpValue
;
1904 AdjustDateAndTimePosition(TRUE
, TopOfScreen
);
1907 // If not has input highlight statement, just return the first one in this form.
1909 *TopOfScreen
= gMenuOption
.ForwardLink
;
1910 *HighlightMenu
= gMenuOption
.ForwardLink
;
1911 if (!IsListEmpty (&gMenuOption
)) {
1912 MoveToNextStatement (FALSE
, HighlightMenu
, BottomRow
- TopRow
, TRUE
);
1918 // First enter to show the menu, update highlight info.
1920 UpdateHighlightMenuInfo (*HighlightMenu
, *TopOfScreen
, *SkipValue
);
1924 Record the highlight menu and top of screen menu info.
1926 @param Highlight The menu opton which is highlight.
1927 @param TopOfScreen The menu opton which is at the top of the form.
1928 @param SkipValue The skip line info for the top of screen menu.
1932 UpdateHighlightMenuInfo (
1933 IN LIST_ENTRY
*Highlight
,
1934 IN LIST_ENTRY
*TopOfScreen
,
1938 UI_MENU_OPTION
*MenuOption
;
1939 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
1941 gHighligthMenuInfo
.HiiHandle
= gFormData
->HiiHandle
;
1942 gHighligthMenuInfo
.FormId
= gFormData
->FormId
;
1943 gHighligthMenuInfo
.SkipValue
= (UINT16
)SkipValue
;
1945 if (!IsListEmpty (&gMenuOption
)) {
1946 MenuOption
= MENU_OPTION_FROM_LINK (Highlight
);
1947 Statement
= MenuOption
->ThisTag
;
1949 gUserInput
->SelectedStatement
= Statement
;
1951 gHighligthMenuInfo
.HLTSequence
= MenuOption
->Sequence
;
1952 gHighligthMenuInfo
.HLTQuestionId
= GetQuestionIdInfo(Statement
->OpCode
);
1953 if (gHighligthMenuInfo
.HLTQuestionId
== 0) {
1955 // if question id == 0, save the opcode buffer..
1957 if (gHighligthMenuInfo
.HLTOpCode
!= NULL
) {
1958 FreePool (gHighligthMenuInfo
.HLTOpCode
);
1960 gHighligthMenuInfo
.HLTOpCode
= AllocateCopyPool (Statement
->OpCode
->Length
, Statement
->OpCode
);
1961 ASSERT (gHighligthMenuInfo
.HLTOpCode
!= NULL
);
1963 gHighligthMenuInfo
.HLTIndex
= GetIndexInfoForOpcode(Statement
->OpCode
);
1966 MenuOption
= MENU_OPTION_FROM_LINK (TopOfScreen
);
1967 Statement
= MenuOption
->ThisTag
;
1969 gHighligthMenuInfo
.TOSQuestionId
= GetQuestionIdInfo(Statement
->OpCode
);
1970 if (gHighligthMenuInfo
.TOSQuestionId
== 0) {
1972 // if question id == 0, save the opcode buffer..
1974 if (gHighligthMenuInfo
.TOSOpCode
!= NULL
) {
1975 FreePool (gHighligthMenuInfo
.TOSOpCode
);
1977 gHighligthMenuInfo
.TOSOpCode
= AllocateCopyPool (Statement
->OpCode
->Length
, Statement
->OpCode
);
1978 ASSERT (gHighligthMenuInfo
.TOSOpCode
!= NULL
);
1980 gHighligthMenuInfo
.TOSIndex
= GetIndexInfoForOpcode(Statement
->OpCode
);
1983 gUserInput
->SelectedStatement
= NULL
;
1985 gHighligthMenuInfo
.HLTSequence
= 0;
1986 gHighligthMenuInfo
.HLTQuestionId
= 0;
1987 if (gHighligthMenuInfo
.HLTOpCode
!= NULL
) {
1988 FreePool (gHighligthMenuInfo
.HLTOpCode
);
1990 gHighligthMenuInfo
.HLTOpCode
= NULL
;
1991 gHighligthMenuInfo
.HLTIndex
= 0;
1993 gHighligthMenuInfo
.TOSQuestionId
= 0;
1994 if (gHighligthMenuInfo
.TOSOpCode
!= NULL
) {
1995 FreePool (gHighligthMenuInfo
.TOSOpCode
);
1997 gHighligthMenuInfo
.TOSOpCode
= NULL
;
1998 gHighligthMenuInfo
.TOSIndex
= 0;
2003 Update attribut for this menu.
2005 @param MenuOption The menu opton which this attribut used to.
2006 @param Highlight Whether this menu will be highlight.
2010 SetDisplayAttribute (
2011 IN UI_MENU_OPTION
*MenuOption
,
2012 IN BOOLEAN Highlight
2015 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
2017 Statement
= MenuOption
->ThisTag
;
2020 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetHighlightTextColor ());
2024 if (MenuOption
->GrayOut
) {
2025 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetGrayedTextColor ());
2027 if (Statement
->OpCode
->OpCode
== EFI_IFR_SUBTITLE_OP
) {
2028 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetSubTitleTextColor ());
2030 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetFieldTextColor ());
2036 Print string for this menu option.
2038 @param MenuOption The menu opton which this attribut used to.
2039 @param Col The column that this string will be print at.
2040 @param Row The row that this string will be print at.
2041 @param String The string which need to print.
2042 @param Width The width need to print, if string is less than the
2043 width, the block space will be used.
2044 @param Highlight Whether this menu will be highlight.
2049 IN UI_MENU_OPTION
*MenuOption
,
2054 IN BOOLEAN Highlight
2060 // Print string with normal color.
2063 PrintStringAtWithWidth (Col
, Row
, String
, Width
);
2068 // Print the highlight menu string.
2069 // First print the highlight string.
2071 SetDisplayAttribute(MenuOption
, TRUE
);
2072 Length
= PrintStringAt (Col
, Row
, String
);
2075 // Second, clean the empty after the string.
2077 SetDisplayAttribute(MenuOption
, FALSE
);
2078 PrintStringAtWithWidth (Col
+ Length
, Row
, L
"", Width
- Length
);
2082 Check whether this menu can has option string.
2084 @param MenuOption The menu opton which this attribut used to.
2086 @retval TRUE This menu option can have option string.
2087 @retval FALSE This menu option can't have option string.
2092 IN UI_MENU_OPTION
*MenuOption
2095 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
2098 EFI_IFR_TEXT
*TestOp
;
2101 Statement
= MenuOption
->ThisTag
;
2104 // See if the second text parameter is really NULL
2106 if (Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) {
2107 TestOp
= (EFI_IFR_TEXT
*) Statement
->OpCode
;
2108 if (TestOp
->TextTwo
!= 0) {
2109 String
= GetToken (TestOp
->TextTwo
, gFormData
->HiiHandle
);
2110 Size
= StrLen (String
);
2115 if ((Statement
->OpCode
->OpCode
== EFI_IFR_SUBTITLE_OP
) ||
2116 (Statement
->OpCode
->OpCode
== EFI_IFR_REF_OP
) ||
2117 (Statement
->OpCode
->OpCode
== EFI_IFR_PASSWORD_OP
) ||
2118 (Statement
->OpCode
->OpCode
== EFI_IFR_ACTION_OP
) ||
2119 (Statement
->OpCode
->OpCode
== EFI_IFR_RESET_BUTTON_OP
) ||
2121 // Allow a wide display if text op-code and no secondary text op-code
2123 ((Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) && (Size
== 0))
2133 Double confirm with user about the action.
2135 @param Action The user input action.
2137 @retval TRUE User confirm with the input or not need user confirm.
2138 @retval FALSE User want ignore this input.
2155 CatLen
= StrLen (gConfirmMsgConnect
);
2158 // Below action need extra popup dialog to confirm.
2160 CheckFlags
= BROWSER_ACTION_DISCARD
|
2161 BROWSER_ACTION_DEFAULT
|
2162 BROWSER_ACTION_SUBMIT
|
2163 BROWSER_ACTION_RESET
|
2164 BROWSER_ACTION_EXIT
;
2167 // Not need to confirm with user, just return TRUE.
2169 if ((Action
& CheckFlags
) == 0) {
2173 if ((Action
& BROWSER_ACTION_DISCARD
) == BROWSER_ACTION_DISCARD
) {
2174 CfmStrLen
+= StrLen (gConfirmDiscardMsg
);
2177 if ((Action
& BROWSER_ACTION_DEFAULT
) == BROWSER_ACTION_DEFAULT
) {
2178 if (CfmStrLen
!= 0) {
2179 CfmStrLen
+= CatLen
;
2182 CfmStrLen
+= StrLen (gConfirmDefaultMsg
);
2185 if ((Action
& BROWSER_ACTION_SUBMIT
) == BROWSER_ACTION_SUBMIT
) {
2186 if (CfmStrLen
!= 0) {
2187 CfmStrLen
+= CatLen
;
2190 CfmStrLen
+= StrLen (gConfirmSubmitMsg
);
2193 if ((Action
& BROWSER_ACTION_RESET
) == BROWSER_ACTION_RESET
) {
2194 if (CfmStrLen
!= 0) {
2195 CfmStrLen
+= CatLen
;
2198 CfmStrLen
+= StrLen (gConfirmResetMsg
);
2201 if ((Action
& BROWSER_ACTION_EXIT
) == BROWSER_ACTION_EXIT
) {
2202 if (CfmStrLen
!= 0) {
2203 CfmStrLen
+= CatLen
;
2206 CfmStrLen
+= StrLen (gConfirmExitMsg
);
2210 // Allocate buffer to save the string.
2211 // String + "?" + "\0"
2213 MaxLen
= CfmStrLen
+ 1 + 1;
2214 CfmStr
= AllocateZeroPool (MaxLen
* sizeof (CHAR16
));
2215 ASSERT (CfmStr
!= NULL
);
2217 if ((Action
& BROWSER_ACTION_DISCARD
) == BROWSER_ACTION_DISCARD
) {
2218 StrCpyS (CfmStr
, MaxLen
, gConfirmDiscardMsg
);
2221 if ((Action
& BROWSER_ACTION_DEFAULT
) == BROWSER_ACTION_DEFAULT
) {
2222 if (CfmStr
[0] != 0) {
2223 StrCatS (CfmStr
, MaxLen
, gConfirmMsgConnect
);
2224 StrCatS (CfmStr
, MaxLen
, gConfirmDefaultMsg2nd
);
2226 StrCpyS (CfmStr
, MaxLen
, gConfirmDefaultMsg
);
2230 if ((Action
& BROWSER_ACTION_SUBMIT
) == BROWSER_ACTION_SUBMIT
) {
2231 if (CfmStr
[0] != 0) {
2232 StrCatS (CfmStr
, MaxLen
, gConfirmMsgConnect
);
2233 StrCatS (CfmStr
, MaxLen
, gConfirmSubmitMsg2nd
);
2235 StrCpyS (CfmStr
, MaxLen
, gConfirmSubmitMsg
);
2239 if ((Action
& BROWSER_ACTION_RESET
) == BROWSER_ACTION_RESET
) {
2240 if (CfmStr
[0] != 0) {
2241 StrCatS (CfmStr
, MaxLen
, gConfirmMsgConnect
);
2242 StrCatS (CfmStr
, MaxLen
, gConfirmResetMsg2nd
);
2244 StrCpyS (CfmStr
, MaxLen
, gConfirmResetMsg
);
2248 if ((Action
& BROWSER_ACTION_EXIT
) == BROWSER_ACTION_EXIT
) {
2249 if (CfmStr
[0] != 0) {
2250 StrCatS (CfmStr
, MaxLen
, gConfirmMsgConnect
);
2251 StrCatS (CfmStr
, MaxLen
, gConfirmExitMsg2nd
);
2253 StrCpyS (CfmStr
, MaxLen
, gConfirmExitMsg
);
2257 StrCatS (CfmStr
, MaxLen
, gConfirmMsgEnd
);
2260 CreateDialog (&Key
, gEmptyString
, CfmStr
, gConfirmOpt
, gEmptyString
, NULL
);
2261 } while (((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (gConfirmOptYes
[0] | UPPER_LOWER_CASE_OFFSET
)) &&
2262 ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (gConfirmOptNo
[0] | UPPER_LOWER_CASE_OFFSET
)));
2264 if ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) == (gConfirmOptYes
[0] | UPPER_LOWER_CASE_OFFSET
)) {
2276 Print string for this menu option.
2278 @param MenuOption The menu opton which this attribut used to.
2279 @param SkipWidth The skip width between the left to the start of the prompt.
2280 @param BeginCol The begin column for one menu.
2281 @param SkipLine The skip line for this menu.
2282 @param BottomRow The bottom row for this form.
2283 @param Highlight Whether this menu will be highlight.
2284 @param UpdateCol Whether need to update the column info for Date/Time.
2286 @retval EFI_SUCESSS Process the user selection success.
2291 IN UI_MENU_OPTION
*MenuOption
,
2296 IN BOOLEAN Highlight
,
2297 IN BOOLEAN UpdateCol
2300 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
2305 CHAR16
*OptionString
;
2306 CHAR16
*OutputString
;
2313 BOOLEAN IsProcessingFirstRow
;
2315 UINTN PromptLineNum
;
2316 UINTN OptionLineNum
;
2320 Statement
= MenuOption
->ThisTag
;
2328 IsProcessingFirstRow
= TRUE
;
2331 // Set default color.
2333 SetDisplayAttribute (MenuOption
, FALSE
);
2336 // 1. Paint the option string.
2338 Status
= ProcessOptions (MenuOption
, FALSE
, &OptionString
, FALSE
);
2339 if (EFI_ERROR (Status
)) {
2343 if (OptionString
!= NULL
) {
2344 if (Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
|| Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
) {
2346 // Adjust option string for date/time opcode.
2348 ProcessStringForDateTime(MenuOption
, OptionString
, UpdateCol
);
2351 Width
= (UINT16
) gOptionBlockWidth
- 1;
2352 Row
= MenuOption
->Row
;
2356 for (Index
= 0; GetLineByWidth (OptionString
, Width
, &GlyphWidth
, &Index
, &OutputString
) != 0x0000;) {
2357 if (((Temp2
== 0)) && (Row
<= BottomRow
)) {
2358 if (Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
|| Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
) {
2360 // For date/time question, it has three menu options for this qustion.
2361 // The first/second menu options with the skip value is 0. the last one
2362 // with skip value is 1.
2364 if (MenuOption
->Skip
!= 0) {
2366 // For date/ time, print the last past (year for date and second for time)
2367 // - 7 means skip [##/##/ for date and [##:##: for time.
2369 DisplayMenuString (MenuOption
,MenuOption
->OptCol
, Row
, OutputString
, Width
+ 1 - 7, Highlight
);
2372 // For date/ time, print the first and second past (year for date and second for time)
2373 // The OutputString has a NARROW_CHAR or WIDE_CHAR at the begin of the string,
2374 // so need to - 1 to remove it, otherwise, it will clean 1 extr char follow it.
2375 DisplayMenuString (MenuOption
, MenuOption
->OptCol
, Row
, OutputString
, StrLen (OutputString
) - 1, Highlight
);
2378 DisplayMenuString (MenuOption
, MenuOption
->OptCol
, Row
, OutputString
, Width
+ 1, Highlight
);
2384 // If there is more string to process print on the next row and increment the Skip value
2386 if (StrLen (&OptionString
[Index
]) != 0) {
2390 // Since the Number of lines for this menu entry may or may not be reflected accurately
2391 // since the prompt might be 1 lines and option might be many, and vice versa, we need to do
2392 // some testing to ensure we are keeping this in-sync.
2394 // If the difference in rows is greater than or equal to the skip value, increase the skip value
2396 if ((Row
- MenuOption
->Row
) >= MenuOption
->Skip
) {
2402 FreePool (OutputString
);
2410 FreePool (OptionString
);
2414 // 2. Paint the description.
2416 PromptWidth
= GetWidth (MenuOption
, &AdjustValue
);
2417 Row
= MenuOption
->Row
;
2421 if (MenuOption
->Description
== NULL
|| MenuOption
->Description
[0] == '\0') {
2422 PrintStringAtWithWidth (BeginCol
, Row
, L
"", PromptWidth
+ AdjustValue
+ SkipWidth
);
2425 for (Index
= 0; GetLineByWidth (MenuOption
->Description
, PromptWidth
, &GlyphWidth
, &Index
, &OutputString
) != 0x0000;) {
2426 if ((Temp
== 0) && (Row
<= BottomRow
)) {
2428 // 1.Clean the start LEFT_SKIPPED_COLUMNS
2430 PrintStringAtWithWidth (BeginCol
, Row
, L
"", SkipWidth
);
2432 if (Statement
->OpCode
->OpCode
== EFI_IFR_REF_OP
&& MenuOption
->Col
>= 2 && IsProcessingFirstRow
) {
2434 // Print Arrow for Goto button.
2437 MenuOption
->Col
- 2,
2439 GEOMETRICSHAPE_RIGHT_TRIANGLE
2441 IsProcessingFirstRow
= FALSE
;
2443 DisplayMenuString (MenuOption
, MenuOption
->Col
, Row
, OutputString
, PromptWidth
+ AdjustValue
, Highlight
);
2447 // If there is more string to process print on the next row and increment the Skip value
2449 if (StrLen (&MenuOption
->Description
[Index
]) != 0) {
2455 FreePool (OutputString
);
2466 // 3. If this is a text op with secondary text information
2468 if ((Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) && (((EFI_IFR_TEXT
*)Statement
->OpCode
)->TextTwo
!= 0)) {
2469 StringPtr
= GetToken (((EFI_IFR_TEXT
*)Statement
->OpCode
)->TextTwo
, gFormData
->HiiHandle
);
2471 Width
= (UINT16
) gOptionBlockWidth
- 1;
2472 Row
= MenuOption
->Row
;
2476 for (Index
= 0; GetLineByWidth (StringPtr
, Width
, &GlyphWidth
, &Index
, &OutputString
) != 0x0000;) {
2477 if ((Temp3
== 0) && (Row
<= BottomRow
)) {
2478 DisplayMenuString (MenuOption
, MenuOption
->OptCol
, Row
, OutputString
, Width
+ 1, Highlight
);
2482 // If there is more string to process print on the next row and increment the Skip value
2484 if (StrLen (&StringPtr
[Index
]) != 0) {
2488 // If the rows for text two is greater than or equal to the skip value, increase the skip value
2490 if ((Row
- MenuOption
->Row
) >= MenuOption
->Skip
) {
2496 FreePool (OutputString
);
2502 FreePool (StringPtr
);
2506 // 4.Line number for Option string and prompt string are not equal.
2507 // Clean the column whose line number is less.
2509 if (HasOptionString(MenuOption
) && (OptionLineNum
!= PromptLineNum
)) {
2510 Col
= OptionLineNum
< PromptLineNum
? MenuOption
->OptCol
: BeginCol
;
2511 Row
= (OptionLineNum
< PromptLineNum
? OptionLineNum
: PromptLineNum
) + MenuOption
->Row
;
2512 Width
= (UINT16
) (OptionLineNum
< PromptLineNum
? gOptionBlockWidth
: PromptWidth
+ AdjustValue
+ SkipWidth
);
2513 MaxRow
= (OptionLineNum
< PromptLineNum
? PromptLineNum
: OptionLineNum
) + MenuOption
->Row
- 1;
2515 while (Row
<= MaxRow
) {
2516 DisplayMenuString (MenuOption
, Col
, Row
++, L
"", Width
, FALSE
);
2524 Display menu and wait for user to select one menu option, then return it.
2525 If AutoBoot is enabled, then if user doesn't select any option,
2526 after period of time, it will automatically return the first menu option.
2528 @param FormData The current form data info.
2530 @retval EFI_SUCESSS Process the user selection success.
2531 @retval EFI_NOT_FOUND Process option string for orderedlist/Oneof fail.
2536 IN FORM_DISPLAY_ENGINE_FORM
*FormData
2541 UINTN DistanceValue
;
2550 CHAR16
*StringRightPtr
;
2551 CHAR16
*StringErrorPtr
;
2552 CHAR16
*OptionString
;
2554 CHAR16
*HelpHeaderString
;
2555 CHAR16
*HelpBottomString
;
2564 LIST_ENTRY
*TopOfScreen
;
2565 LIST_ENTRY
*SavedListEntry
;
2566 UI_MENU_OPTION
*MenuOption
;
2567 UI_MENU_OPTION
*NextMenuOption
;
2568 UI_MENU_OPTION
*SavedMenuOption
;
2569 UI_CONTROL_FLAG ControlFlag
;
2570 UI_SCREEN_OPERATION ScreenOperation
;
2571 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
2572 BROWSER_HOT_KEY
*HotKey
;
2573 UINTN HelpPageIndex
;
2574 UINTN HelpPageCount
;
2577 UINTN HelpHeaderLine
;
2578 UINTN HelpBottomLine
;
2579 BOOLEAN MultiHelpPage
;
2580 UINT16 EachLineWidth
;
2581 UINT16 HeaderLineWidth
;
2582 UINT16 BottomLineWidth
;
2583 EFI_STRING_ID HelpInfo
;
2584 UI_EVENT_TYPE EventType
;
2585 BOOLEAN SkipHighLight
;
2586 EFI_HII_VALUE
*StatementValue
;
2588 EventType
= UIEventNone
;
2589 Status
= EFI_SUCCESS
;
2591 HelpHeaderString
= NULL
;
2592 HelpBottomString
= NULL
;
2593 OptionString
= NULL
;
2594 ScreenOperation
= UiNoOperation
;
2602 MultiHelpPage
= FALSE
;
2604 HeaderLineWidth
= 0;
2605 BottomLineWidth
= 0;
2609 SkipHighLight
= FALSE
;
2611 NextMenuOption
= NULL
;
2612 SavedMenuOption
= NULL
;
2616 gModalSkipColumn
= (CHAR16
) (gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
) / 6;
2618 ZeroMem (&Key
, sizeof (EFI_INPUT_KEY
));
2620 TopRow
= gStatementDimensions
.TopRow
+ SCROLL_ARROW_HEIGHT
;
2621 BottomRow
= gStatementDimensions
.BottomRow
- SCROLL_ARROW_HEIGHT
- 1;
2624 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2625 Col
= gStatementDimensions
.LeftColumn
+ LEFT_SKIPPED_COLUMNS
+ gModalSkipColumn
;
2627 Col
= gStatementDimensions
.LeftColumn
+ LEFT_SKIPPED_COLUMNS
;
2630 FindTopMenu(FormData
, &TopOfScreen
, &NewPos
, &SkipValue
);
2631 if (!IsListEmpty (&gMenuOption
)) {
2632 NextMenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
2633 gUserInput
->SelectedStatement
= NextMenuOption
->ThisTag
;
2636 gST
->ConOut
->EnableCursor (gST
->ConOut
, FALSE
);
2638 ControlFlag
= CfInitialization
;
2640 switch (ControlFlag
) {
2641 case CfInitialization
:
2642 if ((gOldFormEntry
.HiiHandle
!= FormData
->HiiHandle
) ||
2643 (!CompareGuid (&gOldFormEntry
.FormSetGuid
, &FormData
->FormSetGuid
))) {
2645 // Clear Statement range if different formset is painted.
2648 gStatementDimensions
.LeftColumn
,
2649 gStatementDimensions
.RightColumn
,
2650 TopRow
- SCROLL_ARROW_HEIGHT
,
2651 BottomRow
+ SCROLL_ARROW_HEIGHT
,
2652 GetFieldTextColor ()
2656 ControlFlag
= CfRepaint
;
2660 ControlFlag
= CfRefreshHighLight
;
2670 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetFieldTextColor ());
2673 // 1. Check whether need to print the arrow up.
2675 if (!ValueIsScroll (TRUE
, TopOfScreen
)) {
2679 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2680 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
+ gModalSkipColumn
, TopRow
- 1, L
"", gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
- 2 * gModalSkipColumn
);
2682 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
, TopRow
- 1, L
"", gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
);
2685 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetArrowColor ());
2687 gStatementDimensions
.LeftColumn
+ gPromptBlockWidth
+ gOptionBlockWidth
+ 1,
2688 TopRow
- SCROLL_ARROW_HEIGHT
,
2691 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetFieldTextColor ());
2695 // 2.Paint the menu.
2697 for (Link
= TopOfScreen
; Link
!= &gMenuOption
; Link
= Link
->ForwardLink
) {
2698 MenuOption
= MENU_OPTION_FROM_LINK (Link
);
2699 MenuOption
->Row
= Row
;
2700 MenuOption
->Col
= Col
;
2701 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2702 MenuOption
->OptCol
= gStatementDimensions
.LeftColumn
+ LEFT_SKIPPED_COLUMNS
+ gPromptBlockWidth
+ gModalSkipColumn
;
2704 MenuOption
->OptCol
= gStatementDimensions
.LeftColumn
+ LEFT_SKIPPED_COLUMNS
+ gPromptBlockWidth
;
2707 if (MenuOption
->NestInStatement
) {
2708 MenuOption
->Col
+= SUBTITLE_INDENT
;
2712 // Save the highlight menu, will be used in CfRefreshHighLight case.
2714 if (Link
== NewPos
) {
2715 SavedMenuOption
= MenuOption
;
2716 SkipHighLight
= TRUE
;
2719 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2720 Status
= DisplayOneMenu (MenuOption
,
2721 MenuOption
->Col
- gStatementDimensions
.LeftColumn
,
2722 gStatementDimensions
.LeftColumn
+ gModalSkipColumn
,
2723 Link
== TopOfScreen
? SkipValue
: 0,
2725 (BOOLEAN
) ((Link
== NewPos
) && IsSelectable(MenuOption
)),
2729 Status
= DisplayOneMenu (MenuOption
,
2730 MenuOption
->Col
- gStatementDimensions
.LeftColumn
,
2731 gStatementDimensions
.LeftColumn
,
2732 Link
== TopOfScreen
? SkipValue
: 0,
2734 (BOOLEAN
) ((Link
== NewPos
) && IsSelectable(MenuOption
)),
2739 if (EFI_ERROR (Status
)) {
2747 // 3. Update the row info which will be used by next menu.
2749 if (Link
== TopOfScreen
) {
2750 Row
+= MenuOption
->Skip
- SkipValue
;
2752 Row
+= MenuOption
->Skip
;
2755 if (Row
> BottomRow
) {
2756 if (!ValueIsScroll (FALSE
, Link
)) {
2760 Row
= BottomRow
+ 1;
2766 // 3. Menus in this form may not cover all form, clean the remain field.
2768 while (Row
<= BottomRow
) {
2769 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2770 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
+ gModalSkipColumn
, Row
++, L
"", gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
- 2 * gModalSkipColumn
);
2772 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
, Row
++, L
"", gStatementDimensions
.RightColumn
- gHelpBlockWidth
- gStatementDimensions
.LeftColumn
);
2777 // 4. Print the down arrow row.
2779 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2780 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
+ gModalSkipColumn
, BottomRow
+ 1, L
"", gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
- 2 * + gModalSkipColumn
);
2782 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
, BottomRow
+ 1, L
"", gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
);
2785 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetArrowColor ());
2787 gStatementDimensions
.LeftColumn
+ gPromptBlockWidth
+ gOptionBlockWidth
+ 1,
2788 BottomRow
+ SCROLL_ARROW_HEIGHT
,
2791 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetFieldTextColor ());
2798 case CfRefreshHighLight
:
2801 // MenuOption: Last menu option that need to remove hilight
2802 // MenuOption is set to NULL in Repaint
2803 // NewPos: Current menu option that need to hilight
2805 ControlFlag
= CfUpdateHelpString
;
2807 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
2809 if (SkipHighLight
) {
2810 SkipHighLight
= FALSE
;
2811 MenuOption
= SavedMenuOption
;
2812 RefreshKeyHelp(gFormData
, SavedMenuOption
->ThisTag
, FALSE
);
2816 if (IsListEmpty (&gMenuOption
)) {
2818 // No menu option, just update the hotkey filed.
2820 RefreshKeyHelp(gFormData
, NULL
, FALSE
);
2824 if (MenuOption
!= NULL
&& TopOfScreen
== &MenuOption
->Link
) {
2829 if (NewPos
== TopOfScreen
) {
2835 if (NewPos
!= NULL
&& (MenuOption
== NULL
|| NewPos
!= &MenuOption
->Link
)) {
2836 if (MenuOption
!= NULL
) {
2838 // Remove the old highlight menu.
2840 Status
= DisplayOneMenu (MenuOption
,
2841 MenuOption
->Col
- gStatementDimensions
.LeftColumn
,
2842 gStatementDimensions
.LeftColumn
,
2851 // This is the current selected statement
2853 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
2854 RefreshKeyHelp(gFormData
, MenuOption
->ThisTag
, FALSE
);
2856 if (!IsSelectable (MenuOption
)) {
2860 Status
= DisplayOneMenu (MenuOption
,
2861 MenuOption
->Col
- gStatementDimensions
.LeftColumn
,
2862 gStatementDimensions
.LeftColumn
,
2871 case CfUpdateHelpString
:
2872 ControlFlag
= CfPrepareToReadKey
;
2873 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2878 // NewLine means only update highlight menu (remove old highlight and highlith
2879 // the new one), not need to full repain the form.
2881 if (Repaint
|| NewLine
) {
2882 if (IsListEmpty (&gMenuOption
)) {
2884 // Don't print anything if no mwnu option.
2886 StringPtr
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2889 // Don't print anything if it is a NULL help token
2891 ASSERT(MenuOption
!= NULL
);
2892 HelpInfo
= ((EFI_IFR_STATEMENT_HEADER
*) ((CHAR8
*)MenuOption
->ThisTag
->OpCode
+ sizeof (EFI_IFR_OP_HEADER
)))->Help
;
2893 Statement
= MenuOption
->ThisTag
;
2894 StatementValue
= &Statement
->CurrentValue
;
2895 if (HelpInfo
== 0 || !IsSelectable (MenuOption
)) {
2896 if ((Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
&& StatementValue
->Value
.date
.Month
== 0xff)||(Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
&& StatementValue
->Value
.time
.Hour
== 0xff)){
2897 StringPtr
= GetToken (STRING_TOKEN (GET_TIME_FAIL
), gHiiHandle
);
2899 StringPtr
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2902 if ((Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
&& StatementValue
->Value
.date
.Month
== 0xff)||(Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
&& StatementValue
->Value
.time
.Hour
== 0xff)){
2903 StringRightPtr
= GetToken (HelpInfo
, gFormData
->HiiHandle
);
2904 StringErrorPtr
= GetToken (STRING_TOKEN (GET_TIME_FAIL
), gHiiHandle
);
2905 StringPtr
= AllocateZeroPool ((StrLen (StringRightPtr
) + StrLen (StringErrorPtr
)+ 1 ) * sizeof (CHAR16
));
2906 StrCpyS (StringPtr
, StrLen (StringRightPtr
) + StrLen (StringErrorPtr
) + 1, StringRightPtr
);
2907 StrCatS (StringPtr
, StrLen (StringRightPtr
) + StrLen (StringErrorPtr
) + 1, StringErrorPtr
);
2908 FreePool (StringRightPtr
);
2909 FreePool (StringErrorPtr
);
2911 StringPtr
= GetToken (HelpInfo
, gFormData
->HiiHandle
);
2916 RowCount
= BottomRow
- TopRow
+ 1;
2919 // 1.Calculate how many line the help string need to print.
2921 if (HelpString
!= NULL
) {
2922 FreePool (HelpString
);
2925 HelpLine
= ProcessHelpString (StringPtr
, &HelpString
, &EachLineWidth
, RowCount
);
2926 FreePool (StringPtr
);
2928 if (HelpLine
> RowCount
) {
2929 MultiHelpPage
= TRUE
;
2930 StringPtr
= GetToken (STRING_TOKEN(ADJUST_HELP_PAGE_UP
), gHiiHandle
);
2931 if (HelpHeaderString
!= NULL
) {
2932 FreePool (HelpHeaderString
);
2933 HelpHeaderString
= NULL
;
2935 HelpHeaderLine
= ProcessHelpString (StringPtr
, &HelpHeaderString
, &HeaderLineWidth
, 0);
2936 FreePool (StringPtr
);
2937 StringPtr
= GetToken (STRING_TOKEN(ADJUST_HELP_PAGE_DOWN
), gHiiHandle
);
2938 if (HelpBottomString
!= NULL
) {
2939 FreePool (HelpBottomString
);
2940 HelpBottomString
= NULL
;
2942 HelpBottomLine
= ProcessHelpString (StringPtr
, &HelpBottomString
, &BottomLineWidth
, 0);
2943 FreePool (StringPtr
);
2945 // Calculate the help page count.
2947 if (HelpLine
> 2 * RowCount
- 2) {
2948 HelpPageCount
= (HelpLine
- RowCount
+ 1) / (RowCount
- 2) + 1;
2949 if ((HelpLine
- RowCount
+ 1) % (RowCount
- 2) > 1) {
2956 MultiHelpPage
= FALSE
;
2961 // Check whether need to show the 'More(U/u)' at the begin.
2962 // Base on current direct info, here shows aligned to the right side of the column.
2963 // If the direction is multi line and aligned to right side may have problem, so
2964 // add ASSERT code here.
2966 if (HelpPageIndex
> 0) {
2967 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetInfoTextColor ());
2968 for (Index
= 0; Index
< HelpHeaderLine
; Index
++) {
2969 ASSERT (HelpHeaderLine
== 1);
2970 ASSERT (GetStringWidth (HelpHeaderString
) / 2 < (UINTN
) (gHelpBlockWidth
- 1));
2971 PrintStringAtWithWidth (
2972 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
2978 gStatementDimensions
.RightColumn
- GetStringWidth (HelpHeaderString
) / 2 - 1,
2980 &HelpHeaderString
[Index
* HeaderLineWidth
]
2985 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetHelpTextColor ());
2987 // Print the help string info.
2989 if (!MultiHelpPage
) {
2990 for (Index
= 0; Index
< HelpLine
; Index
++) {
2991 PrintStringAtWithWidth (
2992 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
2994 &HelpString
[Index
* EachLineWidth
],
2998 for (; Index
< RowCount
; Index
++) {
2999 PrintStringAtWithWidth (
3000 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
3006 gST
->ConOut
->SetCursorPosition(gST
->ConOut
, gStatementDimensions
.RightColumn
-1, BottomRow
);
3008 if (HelpPageIndex
== 0) {
3009 for (Index
= 0; Index
< RowCount
- HelpBottomLine
; Index
++) {
3010 PrintStringAtWithWidth (
3011 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
3013 &HelpString
[Index
* EachLineWidth
],
3018 for (Index
= 0; (Index
< RowCount
- HelpBottomLine
- HelpHeaderLine
) &&
3019 (Index
+ HelpPageIndex
* (RowCount
- 2) + 1 < HelpLine
); Index
++) {
3020 PrintStringAtWithWidth (
3021 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
3022 Index
+ TopRow
+ HelpHeaderLine
,
3023 &HelpString
[(Index
+ HelpPageIndex
* (RowCount
- 2) + 1)* EachLineWidth
],
3027 if (HelpPageIndex
== HelpPageCount
- 1) {
3028 for (; Index
< RowCount
- HelpHeaderLine
; Index
++) {
3029 PrintStringAtWithWidth (
3030 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
3031 Index
+ TopRow
+ HelpHeaderLine
,
3036 gST
->ConOut
->SetCursorPosition(gST
->ConOut
, gStatementDimensions
.RightColumn
-1, BottomRow
);
3042 // Check whether need to print the 'More(D/d)' at the bottom.
3043 // Base on current direct info, here shows aligned to the right side of the column.
3044 // If the direction is multi line and aligned to right side may have problem, so
3045 // add ASSERT code here.
3047 if (HelpPageIndex
< HelpPageCount
- 1 && MultiHelpPage
) {
3048 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetInfoTextColor ());
3049 for (Index
= 0; Index
< HelpBottomLine
; Index
++) {
3050 ASSERT (HelpBottomLine
== 1);
3051 ASSERT (GetStringWidth (HelpBottomString
) / 2 < (UINTN
) (gHelpBlockWidth
- 1));
3052 PrintStringAtWithWidth (
3053 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
3054 BottomRow
+ Index
- HelpBottomLine
+ 1,
3059 gStatementDimensions
.RightColumn
- GetStringWidth (HelpBottomString
) / 2 - 1,
3060 BottomRow
+ Index
- HelpBottomLine
+ 1,
3061 &HelpBottomString
[Index
* BottomLineWidth
]
3066 // Reset this flag every time we finish using it.
3072 case CfPrepareToReadKey
:
3073 ControlFlag
= CfReadKey
;
3074 ScreenOperation
= UiNoOperation
;
3078 ControlFlag
= CfScreenOperation
;
3081 // Wait for user's selection
3084 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3085 if (!EFI_ERROR (Status
)) {
3086 EventType
= UIEventKey
;
3091 // If we encounter error, continue to read another key in.
3093 if (Status
!= EFI_NOT_READY
) {
3097 EventType
= UiWaitForEvent(gST
->ConIn
->WaitForKey
);
3098 if (EventType
== UIEventKey
) {
3099 gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3104 if (EventType
== UIEventDriver
) {
3106 gUserInput
->Action
= BROWSER_ACTION_NONE
;
3107 ControlFlag
= CfExit
;
3111 if (EventType
== UIEventTimeOut
) {
3112 gUserInput
->Action
= BROWSER_ACTION_FORM_EXIT
;
3113 ControlFlag
= CfExit
;
3117 switch (Key
.UnicodeChar
) {
3118 case CHAR_CARRIAGE_RETURN
:
3119 if(MenuOption
== NULL
|| MenuOption
->GrayOut
|| MenuOption
->ReadOnly
) {
3120 ControlFlag
= CfReadKey
;
3124 ScreenOperation
= UiSelect
;
3129 // We will push the adjustment of these numeric values directly to the input handler
3130 // NOTE: we won't handle manual input numeric
3135 // If the screen has no menu items, and the user didn't select UiReset
3136 // ignore the selection and go back to reading keys.
3138 ASSERT(MenuOption
!= NULL
);
3139 if(IsListEmpty (&gMenuOption
) || MenuOption
->GrayOut
|| MenuOption
->ReadOnly
) {
3140 ControlFlag
= CfReadKey
;
3144 Statement
= MenuOption
->ThisTag
;
3145 if ((Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
)
3146 || (Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
)
3147 || ((Statement
->OpCode
->OpCode
== EFI_IFR_NUMERIC_OP
) && (GetFieldFromNum(Statement
->OpCode
) != 0))
3149 if (Key
.UnicodeChar
== '+') {
3150 gDirection
= SCAN_RIGHT
;
3152 gDirection
= SCAN_LEFT
;
3155 Status
= ProcessOptions (MenuOption
, TRUE
, &OptionString
, TRUE
);
3156 if (OptionString
!= NULL
) {
3157 FreePool (OptionString
);
3159 if (EFI_ERROR (Status
)) {
3161 // Repaint to clear possible error prompt pop-up
3166 ControlFlag
= CfExit
;
3172 ScreenOperation
= UiUp
;
3177 ScreenOperation
= UiDown
;
3181 if(IsListEmpty (&gMenuOption
)) {
3182 ControlFlag
= CfReadKey
;
3186 ASSERT(MenuOption
!= NULL
);
3187 if (MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_CHECKBOX_OP
&& !MenuOption
->GrayOut
&& !MenuOption
->ReadOnly
) {
3188 ScreenOperation
= UiSelect
;
3194 if (!MultiHelpPage
) {
3195 ControlFlag
= CfReadKey
;
3198 ControlFlag
= CfUpdateHelpString
;
3199 HelpPageIndex
= HelpPageIndex
< HelpPageCount
- 1 ? HelpPageIndex
+ 1 : HelpPageCount
- 1;
3204 if (!MultiHelpPage
) {
3205 ControlFlag
= CfReadKey
;
3208 ControlFlag
= CfUpdateHelpString
;
3209 HelpPageIndex
= HelpPageIndex
> 0 ? HelpPageIndex
- 1 : 0;
3213 for (Index
= 0; Index
< mScanCodeNumber
; Index
++) {
3214 if (Key
.ScanCode
== gScanCodeToOperation
[Index
].ScanCode
) {
3215 ScreenOperation
= gScanCodeToOperation
[Index
].ScreenOperation
;
3220 if (((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) && (Key
.ScanCode
== SCAN_ESC
|| Index
== mScanCodeNumber
)) {
3222 // ModalForm has no ESC key and Hot Key.
3224 ControlFlag
= CfReadKey
;
3225 } else if (Index
== mScanCodeNumber
) {
3227 // Check whether Key matches the registered hot key.
3230 HotKey
= GetHotKeyFromRegisterList (&Key
);
3231 if (HotKey
!= NULL
) {
3232 ScreenOperation
= UiHotKey
;
3239 case CfScreenOperation
:
3240 if ((ScreenOperation
!= UiReset
) && (ScreenOperation
!= UiHotKey
)) {
3242 // If the screen has no menu items, and the user didn't select UiReset or UiHotKey
3243 // ignore the selection and go back to reading keys.
3245 if (IsListEmpty (&gMenuOption
)) {
3246 ControlFlag
= CfReadKey
;
3252 Index
< sizeof (gScreenOperationToControlFlag
) / sizeof (gScreenOperationToControlFlag
[0]);
3255 if (ScreenOperation
== gScreenOperationToControlFlag
[Index
].ScreenOperation
) {
3256 ControlFlag
= gScreenOperationToControlFlag
[Index
].ControlFlag
;
3263 ControlFlag
= CfRepaint
;
3265 ASSERT(MenuOption
!= NULL
);
3266 Statement
= MenuOption
->ThisTag
;
3267 if (Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) {
3271 switch (Statement
->OpCode
->OpCode
) {
3272 case EFI_IFR_REF_OP
:
3273 case EFI_IFR_ACTION_OP
:
3274 case EFI_IFR_RESET_BUTTON_OP
:
3275 ControlFlag
= CfExit
;
3280 // Editable Questions: oneof, ordered list, checkbox, numeric, string, password
3282 RefreshKeyHelp (gFormData
, Statement
, TRUE
);
3283 Status
= ProcessOptions (MenuOption
, TRUE
, &OptionString
, TRUE
);
3285 if (OptionString
!= NULL
) {
3286 FreePool (OptionString
);
3289 if (EFI_ERROR (Status
)) {
3292 RefreshKeyHelp (gFormData
, Statement
, FALSE
);
3295 ControlFlag
= CfExit
;
3303 // We come here when someone press ESC
3304 // If the policy is not exit front page when user press ESC, process here.
3306 if (!FormExitPolicy()) {
3309 ControlFlag
= CfRepaint
;
3313 gUserInput
->Action
= BROWSER_ACTION_FORM_EXIT
;
3314 ControlFlag
= CfExit
;
3318 ControlFlag
= CfRepaint
;
3320 ASSERT (HotKey
!= NULL
);
3322 if (FxConfirmPopup(HotKey
->Action
)) {
3323 gUserInput
->Action
= HotKey
->Action
;
3324 if ((HotKey
->Action
& BROWSER_ACTION_DEFAULT
) == BROWSER_ACTION_DEFAULT
) {
3325 gUserInput
->DefaultId
= HotKey
->DefaultId
;
3327 ControlFlag
= CfExit
;
3331 ControlFlag
= CfRepaint
;
3337 ControlFlag
= CfRepaint
;
3338 ASSERT(MenuOption
!= NULL
);
3339 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_DATE_OP
) || (MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_TIME_OP
)) {
3340 if (MenuOption
->Sequence
!= 0) {
3342 // In the middle or tail of the Date/Time op-code set, go left.
3344 ASSERT(NewPos
!= NULL
);
3345 NewPos
= NewPos
->BackLink
;
3351 ControlFlag
= CfRepaint
;
3352 ASSERT(MenuOption
!= NULL
);
3353 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_DATE_OP
) || (MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_TIME_OP
)) {
3354 if (MenuOption
->Sequence
!= 2) {
3356 // In the middle or tail of the Date/Time op-code set, go left.
3358 ASSERT(NewPos
!= NULL
);
3359 NewPos
= NewPos
->ForwardLink
;
3365 ControlFlag
= CfRepaint
;
3368 SavedListEntry
= NewPos
;
3369 ASSERT(NewPos
!= NULL
);
3371 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
3372 ASSERT (MenuOption
!= NULL
);
3375 // Adjust Date/Time position before we advance forward.
3377 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3379 NewPos
= NewPos
->BackLink
;
3381 // Find next selectable menu or the first menu beyond current form.
3383 Difference
= MoveToNextStatement (TRUE
, &NewPos
, MenuOption
->Row
- TopRow
, FALSE
);
3384 if (Difference
< 0) {
3386 // We hit the begining MenuOption that can be focused
3387 // so we simply scroll to the top.
3390 if (TopOfScreen
!= gMenuOption
.ForwardLink
|| SkipValue
!= 0) {
3391 TopOfScreen
= gMenuOption
.ForwardLink
;
3392 NewPos
= SavedListEntry
;
3396 // Scroll up to the last page when we have arrived at top page.
3398 TopOfScreen
= FindTopOfScreenMenu (gMenuOption
.BackLink
, BottomRow
- TopRow
, &SkipValue
);
3399 NewPos
= gMenuOption
.BackLink
;
3400 MoveToNextStatement (TRUE
, &NewPos
, BottomRow
- TopRow
, TRUE
);
3403 NextMenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
3405 if (MenuOption
->Row
< TopRow
+ Difference
+ NextMenuOption
->Skip
) {
3407 // Previous focus MenuOption is above the TopOfScreen, so we need to scroll
3409 TopOfScreen
= NewPos
;
3415 // Check whether new highlight menu is selectable, if not, keep highlight on the old one.
3417 // BottomRow - TopRow + 1 means the total rows current forms supported.
3418 // Difference + NextMenuOption->Skip + 1 means the distance between last highlight menu
3419 // and new top menu. New top menu will all shows in next form, but last highlight menu
3420 // may only shows 1 line. + 1 at right part means at least need to keep 1 line for the
3421 // last highlight menu.
3423 if (!IsSelectable(NextMenuOption
) && IsSelectable(MenuOption
) &&
3424 (BottomRow
- TopRow
+ 1 >= Difference
+ NextMenuOption
->Skip
+ 1)) {
3425 NewPos
= SavedListEntry
;
3429 UpdateStatusBar (INPUT_ERROR
, FALSE
);
3432 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.
3434 AdjustDateAndTimePosition (TRUE
, &TopOfScreen
);
3435 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3437 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
3442 // SkipValue means lines is skipped when show the top menu option.
3444 ControlFlag
= CfRepaint
;
3450 // First minus the menu of the top screen, it's value is SkipValue.
3452 if (SkipValue
>= BottomRow
- TopRow
+ 1) {
3454 // SkipValue > (BottomRow - TopRow + 1) means current menu has more than one
3455 // form of options to be show, so just update the SkipValue to show the next
3456 // parts of options.
3458 SkipValue
-= BottomRow
- TopRow
+ 1;
3459 NewPos
= TopOfScreen
;
3462 Index
= (BottomRow
+ 1) - SkipValue
- TopRow
;
3465 TopOfScreen
= FindTopOfScreenMenu(TopOfScreen
, Index
, &SkipValue
);
3466 NewPos
= TopOfScreen
;
3467 MoveToNextStatement (FALSE
, &NewPos
, BottomRow
- TopRow
, FALSE
);
3469 UpdateStatusBar (INPUT_ERROR
, FALSE
);
3472 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.
3473 // Don't do this when we are already in the first page.
3475 AdjustDateAndTimePosition (TRUE
, &TopOfScreen
);
3476 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3478 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
3483 // SkipValue means lines is skipped when show the top menu option.
3485 ControlFlag
= CfRepaint
;
3490 NextMenuOption
= MENU_OPTION_FROM_LINK (Link
);
3491 Index
= TopRow
+ NextMenuOption
->Skip
- SkipValue
;
3493 // Count to the menu option which will show at the top of the next form.
3495 while ((Index
<= BottomRow
+ 1) && (Link
->ForwardLink
!= &gMenuOption
)) {
3496 Link
= Link
->ForwardLink
;
3497 NextMenuOption
= MENU_OPTION_FROM_LINK (Link
);
3498 Index
= Index
+ NextMenuOption
->Skip
;
3501 if ((Link
->ForwardLink
== &gMenuOption
) && (Index
<= BottomRow
+ 1)) {
3503 // Highlight on the last menu which can be highlight.
3506 MoveToNextStatement (TRUE
, &Link
, Index
- TopRow
, TRUE
);
3509 // Calculate the skip line for top of screen menu.
3511 if (Link
== TopOfScreen
) {
3513 // The top of screen menu option occupies the entire form.
3515 SkipValue
+= BottomRow
- TopRow
+ 1;
3517 SkipValue
= NextMenuOption
->Skip
- (Index
- (BottomRow
+ 1));
3522 // Move to the Next selectable menu.
3524 MoveToNextStatement (FALSE
, &Link
, BottomRow
- TopRow
, TRUE
);
3528 // Save the menu as the next highlight menu.
3532 UpdateStatusBar (INPUT_ERROR
, FALSE
);
3535 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.
3536 // Don't do this when we are already in the last page.
3538 AdjustDateAndTimePosition (TRUE
, &TopOfScreen
);
3539 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3541 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
3546 // SkipValue means lines is skipped when show the top menu option.
3547 // NewPos points to the menu which is highlighted now.
3549 ControlFlag
= CfRepaint
;
3552 if (NewPos
== TopOfScreen
) {
3558 SavedListEntry
= NewPos
;
3560 // Since the behavior of hitting the down arrow on a Date/Time op-code is intended
3561 // to be one that progresses to the next set of op-codes, we need to advance to the last
3562 // Date/Time op-code and leave the remaining logic in UiDown intact so the appropriate
3563 // checking can be done. The only other logic we need to introduce is that if a Date/Time
3564 // op-code is the last entry in the menu, we need to rewind back to the first op-code of
3565 // the Date/Time op-code.
3567 AdjustDateAndTimePosition (FALSE
, &NewPos
);
3569 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
3570 NewPos
= NewPos
->ForwardLink
;
3572 // Find the next selectable menu.
3574 if (MenuOption
->Row
+ MenuOption
->Skip
- Temp2
> BottomRow
+ 1) {
3575 if (gMenuOption
.ForwardLink
== NewPos
|| &gMenuOption
== NewPos
) {
3581 Difference
= MoveToNextStatement (FALSE
, &NewPos
, BottomRow
+ 1 - (MenuOption
->Row
+ MenuOption
->Skip
- Temp2
), FALSE
);
3583 if (Difference
< 0) {
3585 // Scroll to the first page.
3587 if (TopOfScreen
!= gMenuOption
.ForwardLink
|| SkipValue
!= 0) {
3588 TopOfScreen
= gMenuOption
.ForwardLink
;
3592 MenuOption
= MENU_OPTION_FROM_LINK (SavedListEntry
);
3594 NewPos
= gMenuOption
.ForwardLink
;
3595 MoveToNextStatement (FALSE
, &NewPos
, BottomRow
- TopRow
, TRUE
);
3599 // If we are at the end of the list and sitting on a Date/Time op, rewind to the head.
3601 AdjustDateAndTimePosition (TRUE
, &TopOfScreen
);
3602 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3604 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
3609 // Get next selected menu info.
3611 AdjustDateAndTimePosition (FALSE
, &NewPos
);
3612 NextMenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
3613 if (NextMenuOption
->Row
== 0) {
3614 UpdateOptionSkipLines (NextMenuOption
);
3618 // Calculate new highlight menu end row.
3620 Temp
= (MenuOption
->Row
+ MenuOption
->Skip
- Temp2
) + Difference
+ NextMenuOption
->Skip
- 1;
3621 if (Temp
> BottomRow
) {
3623 // Get the top screen menu info.
3625 AdjustDateAndTimePosition (FALSE
, &TopOfScreen
);
3626 SavedMenuOption
= MENU_OPTION_FROM_LINK (TopOfScreen
);
3629 // Current Top screen menu occupy (SavedMenuOption->Skip - SkipValue) rows.
3630 // Full shows the new selected menu need to skip (Temp - BottomRow - 1) rows.
3632 if ((Temp
- BottomRow
) >= (SavedMenuOption
->Skip
- SkipValue
)) {
3634 // Skip the top op-code
3636 TopOfScreen
= TopOfScreen
->ForwardLink
;
3637 DistanceValue
= (Temp
- BottomRow
) - (SavedMenuOption
->Skip
- SkipValue
);
3639 SavedMenuOption
= MENU_OPTION_FROM_LINK (TopOfScreen
);
3642 // If we have a remainder, skip that many more op-codes until we drain the remainder
3643 // Special case is the selected highlight menu has more than one form of menus.
3645 while (DistanceValue
>= SavedMenuOption
->Skip
&& TopOfScreen
!= NewPos
) {
3647 // Since the Difference is greater than or equal to this op-code's skip value, skip it
3649 DistanceValue
= DistanceValue
- (INTN
) SavedMenuOption
->Skip
;
3650 TopOfScreen
= TopOfScreen
->ForwardLink
;
3651 SavedMenuOption
= MENU_OPTION_FROM_LINK (TopOfScreen
);
3654 // Since we will act on this op-code in the next routine, and increment the
3655 // SkipValue, set the skips to one less than what is required.
3657 if (TopOfScreen
!= NewPos
) {
3658 SkipValue
= DistanceValue
;
3664 // Since we will act on this op-code in the next routine, and increment the
3665 // SkipValue, set the skips to one less than what is required.
3667 SkipValue
+= Temp
- BottomRow
;
3670 } else if (!IsSelectable (NextMenuOption
)) {
3672 // Continue to go down until scroll to next page or the selectable option is found.
3674 ScreenOperation
= UiDown
;
3675 ControlFlag
= CfScreenOperation
;
3679 MenuOption
= MENU_OPTION_FROM_LINK (SavedListEntry
);
3682 // Check whether new highlight menu is selectable, if not, keep highlight on the old one.
3684 // BottomRow - TopRow + 1 means the total rows current forms supported.
3685 // Difference + NextMenuOption->Skip + 1 means the distance between last highlight menu
3686 // and new top menu. New top menu will all shows in next form, but last highlight menu
3687 // may only shows 1 line. + 1 at right part means at least need to keep 1 line for the
3688 // last highlight menu.
3690 if (!IsSelectable (NextMenuOption
) && IsSelectable (MenuOption
) &&
3691 (BottomRow
- TopRow
+ 1 >= Difference
+ NextMenuOption
->Skip
+ 1)) {
3692 NewPos
= SavedListEntry
;
3695 UpdateStatusBar (INPUT_ERROR
, FALSE
);
3698 // If we are at the end of the list and sitting on a Date/Time op, rewind to the head.
3700 AdjustDateAndTimePosition (TRUE
, &TopOfScreen
);
3701 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3703 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
3706 case CfUiNoOperation
:
3707 ControlFlag
= CfRepaint
;
3711 gST
->ConOut
->SetAttribute (gST
->ConOut
, EFI_TEXT_ATTR (EFI_LIGHTGRAY
, EFI_BLACK
));
3712 if (HelpString
!= NULL
) {
3713 FreePool (HelpString
);
3715 if (HelpHeaderString
!= NULL
) {
3716 FreePool (HelpHeaderString
);
3718 if (HelpBottomString
!= NULL
) {
3719 FreePool (HelpBottomString
);
3731 Base on the browser status info to show an pop up message.
3735 BrowserStatusProcess (
3741 EFI_EVENT WaitList
[2];
3742 EFI_EVENT RefreshIntervalEvent
;
3743 EFI_EVENT TimeOutEvent
;
3747 WARNING_IF_CONTEXT EventContext
;
3748 EFI_IFR_OP_HEADER
*OpCodeBuf
;
3749 EFI_STRING_ID StringToken
;
3750 CHAR16 DiscardChange
;
3751 CHAR16 JumpToFormSet
;
3752 CHAR16
*PrintString
;
3754 if (gFormData
->BrowserStatus
== BROWSER_SUCCESS
) {
3759 TimeOutEvent
= NULL
;
3760 RefreshIntervalEvent
= NULL
;
3762 if (gFormData
->HighLightedStatement
!= NULL
) {
3763 OpCodeBuf
= gFormData
->HighLightedStatement
->OpCode
;
3766 if (gFormData
->BrowserStatus
== (BROWSER_WARNING_IF
)) {
3767 ASSERT (OpCodeBuf
!= NULL
&& OpCodeBuf
->OpCode
== EFI_IFR_WARNING_IF_OP
);
3769 TimeOut
= ((EFI_IFR_WARNING_IF
*) OpCodeBuf
)->TimeOut
;
3770 StringToken
= ((EFI_IFR_WARNING_IF
*) OpCodeBuf
)->Warning
;
3773 if ((gFormData
->BrowserStatus
== (BROWSER_NO_SUBMIT_IF
)) &&
3774 (OpCodeBuf
!= NULL
&& OpCodeBuf
->OpCode
== EFI_IFR_NO_SUBMIT_IF_OP
)) {
3775 StringToken
= ((EFI_IFR_NO_SUBMIT_IF
*) OpCodeBuf
)->Error
;
3776 } else if ((gFormData
->BrowserStatus
== (BROWSER_INCONSISTENT_IF
)) &&
3777 (OpCodeBuf
!= NULL
&& OpCodeBuf
->OpCode
== EFI_IFR_INCONSISTENT_IF_OP
)) {
3778 StringToken
= ((EFI_IFR_INCONSISTENT_IF
*) OpCodeBuf
)->Error
;
3782 if (StringToken
!= 0) {
3783 ErrorInfo
= GetToken (StringToken
, gFormData
->HiiHandle
);
3784 } else if (gFormData
->ErrorString
!= NULL
) {
3786 // Only used to compatible with old setup browser.
3787 // Not use this field in new browser core.
3789 ErrorInfo
= gFormData
->ErrorString
;
3791 switch (gFormData
->BrowserStatus
) {
3792 case BROWSER_SUBMIT_FAIL
:
3793 ErrorInfo
= gSaveFailed
;
3796 case BROWSER_FORM_NOT_FOUND
:
3797 ErrorInfo
= gFormNotFound
;
3800 case BROWSER_FORM_SUPPRESS
:
3801 ErrorInfo
= gFormSuppress
;
3804 case BROWSER_PROTOCOL_NOT_FOUND
:
3805 ErrorInfo
= gProtocolNotFound
;
3808 case BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF
:
3809 ErrorInfo
= gNoSubmitIfFailed
;
3812 case BROWSER_RECONNECT_FAIL
:
3813 ErrorInfo
= gReconnectFail
;
3816 case BROWSER_RECONNECT_SAVE_CHANGES
:
3817 ErrorInfo
= gReconnectConfirmChanges
;
3820 case BROWSER_RECONNECT_REQUIRED
:
3821 ErrorInfo
= gReconnectRequired
;
3825 ErrorInfo
= gBrowserError
;
3830 switch (gFormData
->BrowserStatus
) {
3831 case BROWSER_SUBMIT_FAIL
:
3832 case BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF
:
3833 case BROWSER_RECONNECT_SAVE_CHANGES
:
3834 ASSERT (gUserInput
!= NULL
);
3835 if (gFormData
->BrowserStatus
== (BROWSER_SUBMIT_FAIL
)) {
3836 PrintString
= gSaveProcess
;
3837 JumpToFormSet
= gJumpToFormSet
[0];
3838 DiscardChange
= gDiscardChange
[0];
3839 } else if (gFormData
->BrowserStatus
== (BROWSER_RECONNECT_SAVE_CHANGES
)){
3840 PrintString
= gChangesOpt
;
3841 JumpToFormSet
= gConfirmOptYes
[0];
3842 DiscardChange
= gConfirmOptNo
[0];
3844 PrintString
= gSaveNoSubmitProcess
;
3845 JumpToFormSet
= gCheckError
[0];
3846 DiscardChange
= gDiscardChange
[0];
3850 CreateDialog (&Key
, gEmptyString
, ErrorInfo
, PrintString
, gEmptyString
, NULL
);
3851 } while (((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (DiscardChange
| UPPER_LOWER_CASE_OFFSET
)) &&
3852 ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (JumpToFormSet
| UPPER_LOWER_CASE_OFFSET
)));
3854 if ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) == (DiscardChange
| UPPER_LOWER_CASE_OFFSET
)) {
3855 gUserInput
->Action
= BROWSER_ACTION_DISCARD
;
3857 gUserInput
->Action
= BROWSER_ACTION_GOTO
;
3864 CreateDialog (&Key
, gEmptyString
, ErrorInfo
, gPressEnter
, gEmptyString
, NULL
);
3865 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
3867 Status
= gBS
->CreateEvent (EVT_NOTIFY_WAIT
, TPL_CALLBACK
, EmptyEventProcess
, NULL
, &TimeOutEvent
);
3868 ASSERT_EFI_ERROR (Status
);
3870 EventContext
.SyncEvent
= TimeOutEvent
;
3871 EventContext
.TimeOut
= &TimeOut
;
3872 EventContext
.ErrorInfo
= ErrorInfo
;
3874 Status
= gBS
->CreateEvent (EVT_TIMER
| EVT_NOTIFY_SIGNAL
, TPL_CALLBACK
, RefreshTimeOutProcess
, &EventContext
, &RefreshIntervalEvent
);
3875 ASSERT_EFI_ERROR (Status
);
3878 // Show the dialog first to avoid long time not reaction.
3880 gBS
->SignalEvent (RefreshIntervalEvent
);
3882 Status
= gBS
->SetTimer (RefreshIntervalEvent
, TimerPeriodic
, ONE_SECOND
);
3883 ASSERT_EFI_ERROR (Status
);
3886 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3887 if (!EFI_ERROR (Status
) && Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3891 if (Status
!= EFI_NOT_READY
) {
3895 WaitList
[0] = TimeOutEvent
;
3896 WaitList
[1] = gST
->ConIn
->WaitForKey
;
3898 Status
= gBS
->WaitForEvent (2, WaitList
, &Index
);
3899 ASSERT_EFI_ERROR (Status
);
3903 // Timeout occur, close the hoot time out event.
3909 gBS
->CloseEvent (TimeOutEvent
);
3910 gBS
->CloseEvent (RefreshIntervalEvent
);
3915 if (StringToken
!= 0) {
3916 FreePool (ErrorInfo
);
3921 Display one form, and return user input.
3923 @param FormData Form Data to be shown.
3924 @param UserInputData User input data.
3926 @retval EFI_SUCCESS 1.Form Data is shown, and user input is got.
3927 2.Error info has show and return.
3928 @retval EFI_INVALID_PARAMETER The input screen dimension is not valid
3929 @retval EFI_NOT_FOUND New form data has some error.
3934 IN FORM_DISPLAY_ENGINE_FORM
*FormData
,
3935 OUT USER_INPUT
*UserInputData
3940 ASSERT (FormData
!= NULL
);
3941 if (FormData
== NULL
) {
3942 return EFI_INVALID_PARAMETER
;
3945 gUserInput
= UserInputData
;
3946 gFormData
= FormData
;
3949 // Process the status info first.
3951 BrowserStatusProcess();
3952 if (gFormData
->BrowserStatus
!= BROWSER_SUCCESS
) {
3954 // gFormData->BrowserStatus != BROWSER_SUCCESS, means only need to print the error info, return here.
3959 Status
= DisplayPageFrame (FormData
, &gStatementDimensions
);
3960 if (EFI_ERROR (Status
)) {
3965 // Global Widths should be initialized before any MenuOption creation
3966 // or the GetWidth() used in UiAddMenuOption() will return incorrect value.
3970 // |<-.->|<-.........->|<- .........->|<-...........->|
3971 // Skip Prompt Option Help
3973 gOptionBlockWidth
= (CHAR16
) ((gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
) / 3) + 1;
3974 gHelpBlockWidth
= (CHAR16
) (gOptionBlockWidth
- 1 - LEFT_SKIPPED_COLUMNS
);
3975 gPromptBlockWidth
= (CHAR16
) (gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
- 2 * (gOptionBlockWidth
- 1) - 1);
3977 ConvertStatementToMenu();
3980 // Check whether layout is changed.
3983 || (gOldFormEntry
.HiiHandle
!= FormData
->HiiHandle
)
3984 || (!CompareGuid (&gOldFormEntry
.FormSetGuid
, &FormData
->FormSetGuid
))
3985 || (gOldFormEntry
.FormId
!= FormData
->FormId
)) {
3986 mStatementLayoutIsChanged
= TRUE
;
3988 mStatementLayoutIsChanged
= FALSE
;
3991 Status
= UiDisplayMenu(FormData
);
3994 // Backup last form info.
3996 mIsFirstForm
= FALSE
;
3997 gOldFormEntry
.HiiHandle
= FormData
->HiiHandle
;
3998 CopyGuid (&gOldFormEntry
.FormSetGuid
, &FormData
->FormSetGuid
);
3999 gOldFormEntry
.FormId
= FormData
->FormId
;
4005 Clear Screen to the initial state.
4009 DriverClearDisplayPage (
4013 ClearDisplayPage ();
4014 mIsFirstForm
= TRUE
;
4018 Set Buffer to Value for Size bytes.
4020 @param Buffer Memory to set.
4021 @param Size Number of bytes to set
4022 @param Value Value of the set operation.
4035 while ((Size
--) != 0) {
4041 Initialize Setup Browser driver.
4043 @param ImageHandle The image handle.
4044 @param SystemTable The system table.
4046 @retval EFI_SUCCESS The Setup Browser module is initialized correctly..
4047 @return Other value if failed to initialize the Setup Browser module.
4052 InitializeDisplayEngine (
4053 IN EFI_HANDLE ImageHandle
,
4054 IN EFI_SYSTEM_TABLE
*SystemTable
4058 EFI_INPUT_KEY HotKey
;
4059 EFI_STRING NewString
;
4060 EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL
*FormBrowserEx2
;
4063 // Publish our HII data
4065 gHiiHandle
= HiiAddPackages (
4066 &gDisplayEngineGuid
,
4068 DisplayEngineStrings
,
4071 ASSERT (gHiiHandle
!= NULL
);
4074 // Install Form Display protocol
4076 Status
= gBS
->InstallProtocolInterface (
4077 &mPrivateData
.Handle
,
4078 &gEdkiiFormDisplayEngineProtocolGuid
,
4079 EFI_NATIVE_INTERFACE
,
4080 &mPrivateData
.FromDisplayProt
4082 ASSERT_EFI_ERROR (Status
);
4084 InitializeDisplayStrings();
4086 ZeroMem (&gHighligthMenuInfo
, sizeof (gHighligthMenuInfo
));
4087 ZeroMem (&gOldFormEntry
, sizeof (gOldFormEntry
));
4090 // Use BrowserEx2 protocol to register HotKey.
4092 Status
= gBS
->LocateProtocol (&gEdkiiFormBrowserEx2ProtocolGuid
, NULL
, (VOID
**) &FormBrowserEx2
);
4093 if (!EFI_ERROR (Status
)) {
4095 // Register the default HotKey F9 and F10 again.
4097 HotKey
.UnicodeChar
= CHAR_NULL
;
4098 HotKey
.ScanCode
= SCAN_F10
;
4099 NewString
= HiiGetString (gHiiHandle
, STRING_TOKEN (FUNCTION_TEN_STRING
), NULL
);
4100 ASSERT (NewString
!= NULL
);
4101 FormBrowserEx2
->RegisterHotKey (&HotKey
, BROWSER_ACTION_SUBMIT
, 0, NewString
);
4103 HotKey
.ScanCode
= SCAN_F9
;
4104 NewString
= HiiGetString (gHiiHandle
, STRING_TOKEN (FUNCTION_NINE_STRING
), NULL
);
4105 ASSERT (NewString
!= NULL
);
4106 FormBrowserEx2
->RegisterHotKey (&HotKey
, BROWSER_ACTION_DEFAULT
, EFI_HII_DEFAULT_CLASS_STANDARD
, NewString
);
4113 This is the default unload handle for display core drivers.
4115 @param[in] ImageHandle The drivers' driver image.
4117 @retval EFI_SUCCESS The image is unloaded.
4118 @retval Others Failed to unload the image.
4123 UnloadDisplayEngine (
4124 IN EFI_HANDLE ImageHandle
4127 HiiRemovePackages(gHiiHandle
);
4129 FreeDisplayStrings ();
4131 if (gHighligthMenuInfo
.HLTOpCode
!= NULL
) {
4132 FreePool (gHighligthMenuInfo
.HLTOpCode
);
4135 if (gHighligthMenuInfo
.TOSOpCode
!= NULL
) {
4136 FreePool (gHighligthMenuInfo
.TOSOpCode
);