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
*gFormNotFound
;
118 CHAR16
*gBrwoserError
;
120 CHAR16
*gNoSubmitIfFailed
;
121 CHAR16
*gSaveProcess
;
122 CHAR16
*gSaveNoSubmitProcess
;
123 CHAR16
*gDiscardChange
;
124 CHAR16
*gJumpToFormSet
;
126 CHAR16
*gPromptForData
;
127 CHAR16
*gPromptForPassword
;
128 CHAR16
*gPromptForNewPassword
;
129 CHAR16
*gConfirmPassword
;
130 CHAR16
*gConfirmError
;
131 CHAR16
*gPassowordInvalid
;
133 CHAR16
*gEmptyString
;
135 CHAR16
*gOptionMismatch
;
136 CHAR16
*gFormSuppress
;
137 CHAR16
*gProtocolNotFound
;
138 CHAR16
*gConfirmDefaultMsg
;
139 CHAR16
*gConfirmSubmitMsg
;
140 CHAR16
*gConfirmDiscardMsg
;
141 CHAR16
*gConfirmResetMsg
;
142 CHAR16
*gConfirmExitMsg
;
143 CHAR16
*gConfirmSubmitMsg2nd
;
144 CHAR16
*gConfirmDefaultMsg2nd
;
145 CHAR16
*gConfirmResetMsg2nd
;
146 CHAR16
*gConfirmExitMsg2nd
;
148 CHAR16
*gConfirmOptYes
;
149 CHAR16
*gConfirmOptNo
;
150 CHAR16
*gConfirmMsgConnect
;
151 CHAR16
*gConfirmMsgEnd
;
152 CHAR16 gModalSkipColumn
;
153 CHAR16 gPromptBlockWidth
;
154 CHAR16 gOptionBlockWidth
;
155 CHAR16 gHelpBlockWidth
;
156 CHAR16
*mUnknownString
;
158 FORM_DISPLAY_DRIVER_PRIVATE_DATA mPrivateData
= {
159 FORM_DISPLAY_DRIVER_SIGNATURE
,
163 DriverClearDisplayPage
,
170 Get the string based on the StringId and HII Package List Handle.
172 @param Token The String's ID.
173 @param HiiHandle The package list in the HII database to search for
174 the specified string.
176 @return The output string.
181 IN EFI_STRING_ID Token
,
182 IN EFI_HII_HANDLE HiiHandle
187 String
= HiiGetString (HiiHandle
, Token
, NULL
);
188 if (String
== NULL
) {
189 String
= AllocateCopyPool (StrSize (mUnknownString
), mUnknownString
);
190 ASSERT (String
!= NULL
);
193 return (CHAR16
*) String
;
198 Initialize the HII String Token to the correct values.
202 InitializeDisplayStrings (
206 mUnknownString
= GetToken (STRING_TOKEN (UNKNOWN_STRING
), gHiiHandle
);
207 gSaveFailed
= GetToken (STRING_TOKEN (SAVE_FAILED
), gHiiHandle
);
208 gNoSubmitIfFailed
= GetToken (STRING_TOKEN (NO_SUBMIT_IF_CHECK_FAILED
), gHiiHandle
);
209 gSaveProcess
= GetToken (STRING_TOKEN (DISCARD_OR_JUMP
), gHiiHandle
);
210 gSaveNoSubmitProcess
= GetToken (STRING_TOKEN (DISCARD_OR_CHECK
), gHiiHandle
);
211 gDiscardChange
= GetToken (STRING_TOKEN (DISCARD_OR_JUMP_DISCARD
), gHiiHandle
);
212 gJumpToFormSet
= GetToken (STRING_TOKEN (DISCARD_OR_JUMP_JUMP
), gHiiHandle
);
213 gCheckError
= GetToken (STRING_TOKEN (DISCARD_OR_CHECK_CHECK
), gHiiHandle
);
214 gPromptForData
= GetToken (STRING_TOKEN (PROMPT_FOR_DATA
), gHiiHandle
);
215 gPromptForPassword
= GetToken (STRING_TOKEN (PROMPT_FOR_PASSWORD
), gHiiHandle
);
216 gPromptForNewPassword
= GetToken (STRING_TOKEN (PROMPT_FOR_NEW_PASSWORD
), gHiiHandle
);
217 gConfirmPassword
= GetToken (STRING_TOKEN (CONFIRM_PASSWORD
), gHiiHandle
);
218 gConfirmError
= GetToken (STRING_TOKEN (CONFIRM_ERROR
), gHiiHandle
);
219 gPassowordInvalid
= GetToken (STRING_TOKEN (PASSWORD_INVALID
), gHiiHandle
);
220 gPressEnter
= GetToken (STRING_TOKEN (PRESS_ENTER
), gHiiHandle
);
221 gEmptyString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
222 gMiniString
= GetToken (STRING_TOKEN (MINI_STRING
), gHiiHandle
);
223 gOptionMismatch
= GetToken (STRING_TOKEN (OPTION_MISMATCH
), gHiiHandle
);
224 gFormSuppress
= GetToken (STRING_TOKEN (FORM_SUPPRESSED
), gHiiHandle
);
225 gProtocolNotFound
= GetToken (STRING_TOKEN (PROTOCOL_NOT_FOUND
), gHiiHandle
);
226 gFormNotFound
= GetToken (STRING_TOKEN (STATUS_BROWSER_FORM_NOT_FOUND
), gHiiHandle
);
227 gNoSubmitIf
= GetToken (STRING_TOKEN (STATUS_BROWSER_NO_SUBMIT_IF
), gHiiHandle
);
228 gBrwoserError
= GetToken (STRING_TOKEN (STATUS_BROWSER_ERROR
), gHiiHandle
);
229 gConfirmDefaultMsg
= GetToken (STRING_TOKEN (CONFIRM_DEFAULT_MESSAGE
), gHiiHandle
);
230 gConfirmDiscardMsg
= GetToken (STRING_TOKEN (CONFIRM_DISCARD_MESSAGE
), gHiiHandle
);
231 gConfirmSubmitMsg
= GetToken (STRING_TOKEN (CONFIRM_SUBMIT_MESSAGE
), gHiiHandle
);
232 gConfirmResetMsg
= GetToken (STRING_TOKEN (CONFIRM_RESET_MESSAGE
), gHiiHandle
);
233 gConfirmExitMsg
= GetToken (STRING_TOKEN (CONFIRM_EXIT_MESSAGE
), gHiiHandle
);
234 gConfirmDefaultMsg2nd
= GetToken (STRING_TOKEN (CONFIRM_DEFAULT_MESSAGE_2ND
), gHiiHandle
);
235 gConfirmSubmitMsg2nd
= GetToken (STRING_TOKEN (CONFIRM_SUBMIT_MESSAGE_2ND
), gHiiHandle
);
236 gConfirmResetMsg2nd
= GetToken (STRING_TOKEN (CONFIRM_RESET_MESSAGE_2ND
), gHiiHandle
);
237 gConfirmExitMsg2nd
= GetToken (STRING_TOKEN (CONFIRM_EXIT_MESSAGE_2ND
), gHiiHandle
);
238 gConfirmOpt
= GetToken (STRING_TOKEN (CONFIRM_OPTION
), gHiiHandle
);
239 gConfirmOptYes
= GetToken (STRING_TOKEN (CONFIRM_OPTION_YES
), gHiiHandle
);
240 gConfirmOptNo
= GetToken (STRING_TOKEN (CONFIRM_OPTION_NO
), gHiiHandle
);
241 gConfirmMsgConnect
= GetToken (STRING_TOKEN (CONFIRM_OPTION_CONNECT
), gHiiHandle
);
242 gConfirmMsgEnd
= GetToken (STRING_TOKEN (CONFIRM_OPTION_END
), gHiiHandle
);
246 Free up the resource allocated for all strings required
255 FreePool (mUnknownString
);
256 FreePool (gEmptyString
);
257 FreePool (gSaveFailed
);
258 FreePool (gNoSubmitIfFailed
);
259 FreePool (gSaveProcess
);
260 FreePool (gSaveNoSubmitProcess
);
261 FreePool (gDiscardChange
);
262 FreePool (gJumpToFormSet
);
263 FreePool (gCheckError
);
264 FreePool (gPromptForData
);
265 FreePool (gPromptForPassword
);
266 FreePool (gPromptForNewPassword
);
267 FreePool (gConfirmPassword
);
268 FreePool (gConfirmError
);
269 FreePool (gPassowordInvalid
);
270 FreePool (gPressEnter
);
271 FreePool (gMiniString
);
272 FreePool (gOptionMismatch
);
273 FreePool (gFormSuppress
);
274 FreePool (gProtocolNotFound
);
275 FreePool (gBrwoserError
);
276 FreePool (gNoSubmitIf
);
277 FreePool (gFormNotFound
);
278 FreePool (gConfirmDefaultMsg
);
279 FreePool (gConfirmSubmitMsg
);
280 FreePool (gConfirmDiscardMsg
);
281 FreePool (gConfirmResetMsg
);
282 FreePool (gConfirmExitMsg
);
283 FreePool (gConfirmDefaultMsg2nd
);
284 FreePool (gConfirmSubmitMsg2nd
);
285 FreePool (gConfirmResetMsg2nd
);
286 FreePool (gConfirmExitMsg2nd
);
287 FreePool (gConfirmOpt
);
288 FreePool (gConfirmOptYes
);
289 FreePool (gConfirmOptNo
);
290 FreePool (gConfirmMsgConnect
);
291 FreePool (gConfirmMsgEnd
);
295 Get prompt string id from the opcode data buffer.
297 @param OpCode The input opcode buffer.
299 @return The prompt string id.
304 IN EFI_IFR_OP_HEADER
*OpCode
307 EFI_IFR_STATEMENT_HEADER
*Header
;
309 if (OpCode
->Length
<= sizeof (EFI_IFR_OP_HEADER
)) {
313 Header
= (EFI_IFR_STATEMENT_HEADER
*) (OpCode
+ 1);
315 return Header
->Prompt
;
319 Get the supported width for a particular op-code
321 @param MenuOption The menu option.
322 @param AdjustWidth The width which is saved for the space.
324 @return Returns the number of CHAR16 characters that is support.
329 IN UI_MENU_OPTION
*MenuOption
,
330 OUT UINT16
*AdjustWidth
335 EFI_IFR_TEXT
*TestOp
;
337 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
339 Statement
= MenuOption
->ThisTag
;
342 // For modal form, clean the entire row.
344 if ((gFormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
345 if (AdjustWidth
!= NULL
) {
346 *AdjustWidth
= LEFT_SKIPPED_COLUMNS
;
348 return (UINT16
)(gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
- 2 * (gModalSkipColumn
+ LEFT_SKIPPED_COLUMNS
));
354 // See if the second text parameter is really NULL
356 if (Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) {
357 TestOp
= (EFI_IFR_TEXT
*) Statement
->OpCode
;
358 if (TestOp
->TextTwo
!= 0) {
359 String
= GetToken (TestOp
->TextTwo
, gFormData
->HiiHandle
);
360 Size
= StrLen (String
);
365 if ((Statement
->OpCode
->OpCode
== EFI_IFR_SUBTITLE_OP
) ||
366 (Statement
->OpCode
->OpCode
== EFI_IFR_REF_OP
) ||
367 (Statement
->OpCode
->OpCode
== EFI_IFR_PASSWORD_OP
) ||
368 (Statement
->OpCode
->OpCode
== EFI_IFR_ACTION_OP
) ||
369 (Statement
->OpCode
->OpCode
== EFI_IFR_RESET_BUTTON_OP
) ||
371 // Allow a wide display if text op-code and no secondary text op-code
373 ((Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) && (Size
== 0))
377 // Return the space width.
379 if (AdjustWidth
!= NULL
) {
383 // Keep consistent with current behavior.
385 ReturnWidth
= (UINT16
) (gPromptBlockWidth
+ gOptionBlockWidth
- 2);
387 if (AdjustWidth
!= NULL
) {
391 ReturnWidth
= (UINT16
) (gPromptBlockWidth
- 1);
395 // For nest in statement, should the subtitle indent.
397 if (MenuOption
->NestInStatement
) {
398 ReturnWidth
-= SUBTITLE_INDENT
;
405 Will copy LineWidth amount of a string in the OutputString buffer and return the
406 number of CHAR16 characters that were copied into the OutputString buffer.
407 The output string format is:
408 Glyph Info + String info + '\0'.
410 In the code, it deals \r,\n,\r\n same as \n\r, also it not process the \r or \g.
412 @param InputString String description for this option.
413 @param LineWidth Width of the desired string to extract in CHAR16
415 @param GlyphWidth The glyph width of the begin of the char in the string.
416 @param Index Where in InputString to start the copy process
417 @param OutputString Buffer to copy the string into
419 @return Returns the number of CHAR16 characters that were copied into the OutputString
420 buffer, include extra glyph info and '\0' info.
425 IN CHAR16
*InputString
,
427 IN OUT UINT16
*GlyphWidth
,
429 OUT CHAR16
**OutputString
434 UINT16 OriginalGlyphWidth
;
436 UINT16 LastSpaceOffset
;
437 UINT16 LastGlyphWidth
;
439 if (InputString
== NULL
|| Index
== NULL
|| OutputString
== NULL
) {
443 if (LineWidth
== 0 || *GlyphWidth
== 0) {
448 // Save original glyph width.
450 OriginalGlyphWidth
= *GlyphWidth
;
451 LastGlyphWidth
= OriginalGlyphWidth
;
456 // 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.
457 // To avoid displaying this empty line in screen, just skip the two CHARs here.
459 if ((InputString
[*Index
] == NARROW_CHAR
) && (InputString
[*Index
+ 1] == CHAR_CARRIAGE_RETURN
)) {
464 // Fast-forward the string and see if there is a carriage-return in the string
466 for (StrOffset
= 0, GlyphOffset
= 0; GlyphOffset
<= LineWidth
; StrOffset
++) {
467 switch (InputString
[*Index
+ StrOffset
]) {
476 case CHAR_CARRIAGE_RETURN
:
483 GlyphOffset
= GlyphOffset
+ *GlyphWidth
;
486 // Record the last space info in this line. Will be used in rewind.
488 if ((InputString
[*Index
+ StrOffset
] == CHAR_SPACE
) && (GlyphOffset
<= LineWidth
)) {
489 LastSpaceOffset
= StrOffset
;
490 LastGlyphWidth
= *GlyphWidth
;
501 // Rewind the string from the maximum size until we see a space to break the line
503 if (GlyphOffset
> LineWidth
) {
505 // Rewind the string to last space char in this line.
507 if (LastSpaceOffset
!= 0) {
508 StrOffset
= LastSpaceOffset
;
509 *GlyphWidth
= LastGlyphWidth
;
512 // Roll back to last char in the line width.
519 // The CHAR_NULL has process last time, this time just return 0 to stand for the end.
521 if (StrOffset
== 0 && (InputString
[*Index
+ StrOffset
] == CHAR_NULL
)) {
526 // Need extra glyph info and '\0' info, so +2.
528 *OutputString
= AllocateZeroPool (((UINTN
) (StrOffset
+ 2) * sizeof(CHAR16
)));
529 if (*OutputString
== NULL
) {
534 // Save the glyph info at the begin of the string, will used by Print function.
536 if (OriginalGlyphWidth
== 1) {
537 *(*OutputString
) = NARROW_CHAR
;
539 *(*OutputString
) = WIDE_CHAR
;
542 CopyMem ((*OutputString
) + 1, &InputString
[*Index
], StrOffset
* sizeof(CHAR16
));
544 if (InputString
[*Index
+ StrOffset
] == CHAR_SPACE
) {
546 // Skip the space info at the begin of next line.
548 *Index
= (UINT16
) (*Index
+ StrOffset
+ 1);
549 } else if (InputString
[*Index
+ StrOffset
] == CHAR_LINEFEED
) {
551 // Skip the /n or /n/r info.
553 if (InputString
[*Index
+ StrOffset
+ 1] == CHAR_CARRIAGE_RETURN
) {
554 *Index
= (UINT16
) (*Index
+ StrOffset
+ 2);
556 *Index
= (UINT16
) (*Index
+ StrOffset
+ 1);
558 } else if (InputString
[*Index
+ StrOffset
] == CHAR_CARRIAGE_RETURN
) {
560 // Skip the /r or /r/n info.
562 if (InputString
[*Index
+ StrOffset
+ 1] == CHAR_LINEFEED
) {
563 *Index
= (UINT16
) (*Index
+ StrOffset
+ 2);
565 *Index
= (UINT16
) (*Index
+ StrOffset
+ 1);
568 *Index
= (UINT16
) (*Index
+ StrOffset
);
572 // Include extra glyph info and '\0' info, so +2.
574 return StrOffset
+ 2;
578 Add one menu option by specified description and context.
580 @param Statement Statement of this Menu Option.
581 @param MenuItemCount The index for this Option in the Menu.
582 @param NestIn Whether this statement is nest in another statement.
587 IN FORM_DISPLAY_ENGINE_STATEMENT
*Statement
,
588 IN UINT16
*MenuItemCount
,
592 UI_MENU_OPTION
*MenuOption
;
596 UINT16 NumberOfLines
;
600 CHAR16
*OutputString
;
601 EFI_STRING_ID PromptId
;
609 PromptId
= GetPrompt (Statement
->OpCode
);
610 ASSERT (PromptId
!= 0);
612 String
= GetToken (PromptId
, gFormData
->HiiHandle
);
613 ASSERT (String
!= NULL
);
615 if (Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
|| Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
) {
619 for (Index
= 0; Index
< Count
; Index
++) {
620 MenuOption
= AllocateZeroPool (sizeof (UI_MENU_OPTION
));
623 MenuOption
->Signature
= UI_MENU_OPTION_SIGNATURE
;
624 MenuOption
->Description
= String
;
625 MenuOption
->Handle
= gFormData
->HiiHandle
;
626 MenuOption
->ThisTag
= Statement
;
627 MenuOption
->NestInStatement
= NestIn
;
628 MenuOption
->EntryNumber
= *MenuItemCount
;
630 MenuOption
->Sequence
= Index
;
632 if ((Statement
->Attribute
& HII_DISPLAY_GRAYOUT
) != 0) {
633 MenuOption
->GrayOut
= TRUE
;
635 MenuOption
->GrayOut
= FALSE
;
638 if ((Statement
->Attribute
& HII_DISPLAY_LOCK
) != 0 || (gFormData
->Attribute
& HII_DISPLAY_LOCK
) != 0) {
639 MenuOption
->GrayOut
= TRUE
;
643 // If the form or the question has the lock attribute, deal same as grayout.
645 if ((gFormData
->Attribute
& HII_DISPLAY_LOCK
) != 0 || (Statement
->Attribute
& HII_DISPLAY_LOCK
) != 0) {
646 MenuOption
->GrayOut
= TRUE
;
649 switch (Statement
->OpCode
->OpCode
) {
650 case EFI_IFR_ORDERED_LIST_OP
:
651 case EFI_IFR_ONE_OF_OP
:
652 case EFI_IFR_NUMERIC_OP
:
653 case EFI_IFR_TIME_OP
:
654 case EFI_IFR_DATE_OP
:
655 case EFI_IFR_CHECKBOX_OP
:
656 case EFI_IFR_PASSWORD_OP
:
657 case EFI_IFR_STRING_OP
:
659 // User could change the value of these items
661 MenuOption
->IsQuestion
= TRUE
;
663 case EFI_IFR_TEXT_OP
:
664 if (FeaturePcdGet (PcdBrowserGrayOutTextStatement
)) {
666 // Initializing GrayOut option as TRUE for Text setup options
667 // so that those options will be Gray in colour and un selectable.
669 MenuOption
->GrayOut
= TRUE
;
673 MenuOption
->IsQuestion
= FALSE
;
677 if ((Statement
->Attribute
& HII_DISPLAY_READONLY
) != 0) {
678 MenuOption
->ReadOnly
= TRUE
;
679 if (FeaturePcdGet (PcdBrowerGrayOutReadOnlyMenu
)) {
680 MenuOption
->GrayOut
= TRUE
;
685 (Statement
->OpCode
->OpCode
!= EFI_IFR_DATE_OP
) &&
686 (Statement
->OpCode
->OpCode
!= EFI_IFR_TIME_OP
)) {
687 Width
= GetWidth (MenuOption
, NULL
);
688 for (; GetLineByWidth (String
, Width
, &GlyphWidth
,&ArrayEntry
, &OutputString
) != 0x0000;) {
690 // If there is more string to process print on the next row and increment the Skip value
692 if (StrLen (&String
[ArrayEntry
]) != 0) {
695 FreePool (OutputString
);
699 // Add three MenuOptions for Date/Time
700 // Data format : [01/02/2004] [11:22:33]
701 // Line number : 0 0 1 0 0 1
708 // Override LineNumber for the MenuOption in Date/Time sequence
710 MenuOption
->Skip
= 1;
712 MenuOption
->Skip
= NumberOfLines
;
715 InsertTailList (&gMenuOption
, &MenuOption
->Link
);
722 Create the menu list base on the form data info.
726 ConvertStatementToMenu (
730 UINT16 MenuItemCount
;
732 LIST_ENTRY
*NestLink
;
733 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
734 FORM_DISPLAY_ENGINE_STATEMENT
*NestStatement
;
737 InitializeListHead (&gMenuOption
);
739 Link
= GetFirstNode (&gFormData
->StatementListHead
);
740 while (!IsNull (&gFormData
->StatementListHead
, Link
)) {
741 Statement
= FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK (Link
);
742 Link
= GetNextNode (&gFormData
->StatementListHead
, Link
);
745 // Skip the opcode not recognized by Display core.
747 if (Statement
->OpCode
->OpCode
== EFI_IFR_GUID_OP
) {
751 UiAddMenuOption (Statement
, &MenuItemCount
, FALSE
);
754 // Check the statement nest in this host statement.
756 NestLink
= GetFirstNode (&Statement
->NestStatementList
);
757 while (!IsNull (&Statement
->NestStatementList
, NestLink
)) {
758 NestStatement
= FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK (NestLink
);
759 NestLink
= GetNextNode (&Statement
->NestStatementList
, NestLink
);
762 // Skip the opcode not recognized by Display core.
764 if (NestStatement
->OpCode
->OpCode
== EFI_IFR_GUID_OP
) {
768 UiAddMenuOption (NestStatement
, &MenuItemCount
, TRUE
);
774 Count the storage space of a Unicode string.
776 This function handles the Unicode string with NARROW_CHAR
777 and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR
778 does not count in the resultant output. If a WIDE_CHAR is
779 hit, then 2 Unicode character will consume an output storage
780 space with size of CHAR16 till a NARROW_CHAR is hit.
782 If String is NULL, then ASSERT ().
784 @param String The input string to be counted.
786 @return Storage space for the input string.
796 UINTN IncrementValue
;
798 ASSERT (String
!= NULL
);
799 if (String
== NULL
) {
809 // Advance to the null-terminator or to the first width directive
812 (String
[Index
] != NARROW_CHAR
) && (String
[Index
] != WIDE_CHAR
) && (String
[Index
] != 0);
813 Index
++, Count
= Count
+ IncrementValue
818 // We hit the null-terminator, we now have a count
820 if (String
[Index
] == 0) {
824 // We encountered a narrow directive - strip it from the size calculation since it doesn't get printed
825 // and also set the flag that determines what we increment by.(if narrow, increment by 1, if wide increment by 2)
827 if (String
[Index
] == NARROW_CHAR
) {
829 // Skip to the next character
835 // Skip to the next character
840 } while (String
[Index
] != 0);
843 // Increment by one to include the null-terminator in the size
847 return Count
* sizeof (CHAR16
);
851 Base on the input option string to update the skip value for a menu option.
853 @param MenuOption The MenuOption to be checked.
854 @param OptionString The input option string.
858 UpdateSkipInfoForMenu (
859 IN UI_MENU_OPTION
*MenuOption
,
860 IN CHAR16
*OptionString
866 CHAR16
*OutputString
;
869 Width
= (UINT16
) gOptionBlockWidth
;
873 for (Index
= 0; GetLineByWidth (OptionString
, Width
, &GlyphWidth
, &Index
, &OutputString
) != 0x0000;) {
874 if (StrLen (&OptionString
[Index
]) != 0) {
878 FreePool (OutputString
);
881 if ((Row
> MenuOption
->Skip
) &&
882 (MenuOption
->ThisTag
->OpCode
->OpCode
!= EFI_IFR_DATE_OP
) &&
883 (MenuOption
->ThisTag
->OpCode
->OpCode
!= EFI_IFR_TIME_OP
)) {
884 MenuOption
->Skip
= Row
;
889 Update display lines for a Menu Option.
891 @param MenuOption The MenuOption to be checked.
895 UpdateOptionSkipLines (
896 IN UI_MENU_OPTION
*MenuOption
899 CHAR16
*OptionString
;
903 ProcessOptions (MenuOption
, FALSE
, &OptionString
, TRUE
);
904 if (OptionString
!= NULL
) {
905 UpdateSkipInfoForMenu (MenuOption
, OptionString
);
907 FreePool (OptionString
);
910 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) && (((EFI_IFR_TEXT
*)MenuOption
->ThisTag
->OpCode
)->TextTwo
!= 0)) {
911 OptionString
= GetToken (((EFI_IFR_TEXT
*)MenuOption
->ThisTag
->OpCode
)->TextTwo
, gFormData
->HiiHandle
);
913 if (OptionString
!= NULL
) {
914 UpdateSkipInfoForMenu (MenuOption
, OptionString
);
916 FreePool (OptionString
);
922 Check whether this Menu Option could be print.
924 Check Prompt string, option string or text two string not NULL.
926 This is an internal function.
928 @param MenuOption The MenuOption to be checked.
930 @retval TRUE This Menu Option is printable.
931 @retval FALSE This Menu Option could not be printable.
936 UI_MENU_OPTION
*MenuOption
940 EFI_STRING OptionString
;
944 if (MenuOption
->Description
[0] != '\0') {
948 Status
= ProcessOptions (MenuOption
, FALSE
, &OptionString
, FALSE
);
949 if (EFI_ERROR (Status
)) {
952 if (OptionString
!= NULL
&& OptionString
[0] != '\0') {
953 FreePool (OptionString
);
957 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) && (((EFI_IFR_TEXT
*)MenuOption
->ThisTag
->OpCode
)->TextTwo
!= 0)) {
958 OptionString
= GetToken (((EFI_IFR_TEXT
*)MenuOption
->ThisTag
->OpCode
)->TextTwo
, gFormData
->HiiHandle
);
959 ASSERT (OptionString
!= NULL
);
960 if (OptionString
[0] != '\0'){
961 FreePool (OptionString
);
970 Check whether this Menu Option could be highlighted.
972 This is an internal function.
974 @param MenuOption The MenuOption to be checked.
976 @retval TRUE This Menu Option is selectable.
977 @retval FALSE This Menu Option could not be selected.
982 UI_MENU_OPTION
*MenuOption
985 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_SUBTITLE_OP
) ||
986 MenuOption
->GrayOut
|| MenuOption
->ReadOnly
|| !PrintableMenu (MenuOption
)) {
994 Move to next selectable statement.
996 This is an internal function.
998 @param GoUp The navigation direction. TRUE: up, FALSE: down.
999 @param CurrentPosition Current position.
1000 @param GapToTop Gap position to top or bottom.
1001 @param FindInForm Whether find menu in current form or beyond.
1003 @return The row distance from current MenuOption to next selectable MenuOption.
1005 @retval -1 Reach the begin of the menu, still can't find the selectable menu.
1006 @retval Value Find the selectable menu, maybe the truly selectable, maybe the
1007 first menu showing beyond current form or last menu showing in
1009 The value is the line number between the new selected menu and the
1010 current select menu, not include the new selected menu.
1014 MoveToNextStatement (
1016 IN OUT LIST_ENTRY
**CurrentPosition
,
1018 IN BOOLEAN FindInForm
1023 UI_MENU_OPTION
*NextMenuOption
;
1024 UI_MENU_OPTION
*PreMenuOption
;
1027 Pos
= *CurrentPosition
;
1029 if (Pos
== &gMenuOption
) {
1033 PreMenuOption
= MENU_OPTION_FROM_LINK (Pos
);
1036 NextMenuOption
= MENU_OPTION_FROM_LINK (Pos
);
1038 // NextMenuOption->Row == 0 means this menu has not calculate
1039 // the NextMenuOption->Skip value yet, just calculate here.
1041 if (NextMenuOption
->Row
== 0) {
1042 UpdateOptionSkipLines (NextMenuOption
);
1045 if (IsSelectable (NextMenuOption
)) {
1050 // In this case, still can't find the selectable menu,
1051 // return the first one beyond the showing form.
1053 if ((UINTN
) Distance
+ NextMenuOption
->Skip
> GapToTop
) {
1055 NextMenuOption
= PreMenuOption
;
1060 Distance
+= NextMenuOption
->Skip
;
1063 // Arrive at begin of the menu list.
1065 if ((GoUp
? Pos
->BackLink
: Pos
->ForwardLink
) == &gMenuOption
) {
1070 Pos
= (GoUp
? Pos
->BackLink
: Pos
->ForwardLink
);
1071 PreMenuOption
= NextMenuOption
;
1074 *CurrentPosition
= &NextMenuOption
->Link
;
1080 Process option string for date/time opcode.
1082 @param MenuOption Menu option point to date/time.
1083 @param OptionString Option string input for process.
1084 @param AddOptCol Whether need to update MenuOption->OptCol.
1088 ProcessStringForDateTime (
1089 UI_MENU_OPTION
*MenuOption
,
1090 CHAR16
*OptionString
,
1096 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
1100 ASSERT (MenuOption
!= NULL
&& OptionString
!= NULL
);
1102 Statement
= MenuOption
->ThisTag
;
1105 if (Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
) {
1106 Date
= (EFI_IFR_DATE
*) Statement
->OpCode
;
1107 } else if (Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
) {
1108 Time
= (EFI_IFR_TIME
*) Statement
->OpCode
;
1112 // If leading spaces on OptionString - remove the spaces
1114 for (Index
= 0; OptionString
[Index
] == L
' '; Index
++) {
1116 // Base on the blockspace to get the option column info.
1119 MenuOption
->OptCol
++;
1123 for (Count
= 0; OptionString
[Index
] != CHAR_NULL
; Index
++) {
1124 OptionString
[Count
] = OptionString
[Index
];
1127 OptionString
[Count
] = CHAR_NULL
;
1130 // Enable to suppress field in the opcode base on the flag.
1132 if (Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
) {
1134 // OptionString format is: <**: **: ****>
1138 if ((Date
->Flags
& EFI_QF_DATE_MONTH_SUPPRESS
) && (MenuOption
->Sequence
== 0)) {
1140 // At this point, only "<**:" in the optionstring.
1141 // Clean the day's ** field, after clean, the format is "< :"
1143 SetUnicodeMem (&OptionString
[1], 2, L
' ');
1144 } else if ((Date
->Flags
& EFI_QF_DATE_DAY_SUPPRESS
) && (MenuOption
->Sequence
== 1)) {
1146 // At this point, only "**:" in the optionstring.
1147 // Clean the month's "**" field, after clean, the format is " :"
1149 SetUnicodeMem (&OptionString
[0], 2, L
' ');
1150 } else if ((Date
->Flags
& EFI_QF_DATE_YEAR_SUPPRESS
) && (MenuOption
->Sequence
== 2)) {
1152 // At this point, only "****>" in the optionstring.
1153 // Clean the year's "****" field, after clean, the format is " >"
1155 SetUnicodeMem (&OptionString
[0], 4, L
' ');
1157 } else if (Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
) {
1159 // OptionString format is: <**: **: **>
1160 // |hour|minute|second|
1163 if ((Time
->Flags
& QF_TIME_HOUR_SUPPRESS
) && (MenuOption
->Sequence
== 0)) {
1165 // At this point, only "<**:" in the optionstring.
1166 // Clean the hour's ** field, after clean, the format is "< :"
1168 SetUnicodeMem (&OptionString
[1], 2, L
' ');
1169 } else if ((Time
->Flags
& QF_TIME_MINUTE_SUPPRESS
) && (MenuOption
->Sequence
== 1)) {
1171 // At this point, only "**:" in the optionstring.
1172 // Clean the minute's "**" field, after clean, the format is " :"
1174 SetUnicodeMem (&OptionString
[0], 2, L
' ');
1175 } else if ((Time
->Flags
& QF_TIME_SECOND_SUPPRESS
) && (MenuOption
->Sequence
== 2)) {
1177 // At this point, only "**>" in the optionstring.
1178 // Clean the second's "**" field, after clean, the format is " >"
1180 SetUnicodeMem (&OptionString
[0], 2, L
' ');
1187 Adjust Data and Time position accordingly.
1188 Data format : [01/02/2004] [11:22:33]
1189 Line number : 0 0 1 0 0 1
1191 This is an internal function.
1193 @param DirectionUp the up or down direction. False is down. True is
1195 @param CurrentPosition Current position. On return: Point to the last
1196 Option (Year or Second) if up; Point to the first
1197 Option (Month or Hour) if down.
1199 @return Return line number to pad. It is possible that we stand on a zero-advance
1200 @return data or time opcode, so pad one line when we judge if we are going to scroll outside.
1204 AdjustDateAndTimePosition (
1205 IN BOOLEAN DirectionUp
,
1206 IN OUT LIST_ENTRY
**CurrentPosition
1210 LIST_ENTRY
*NewPosition
;
1211 UI_MENU_OPTION
*MenuOption
;
1212 UINTN PadLineNumber
;
1215 NewPosition
= *CurrentPosition
;
1216 MenuOption
= MENU_OPTION_FROM_LINK (NewPosition
);
1218 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_DATE_OP
) ||
1219 (MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_TIME_OP
)) {
1221 // Calculate the distance from current position to the last Date/Time MenuOption
1224 while (MenuOption
->Skip
== 0) {
1226 NewPosition
= NewPosition
->ForwardLink
;
1227 MenuOption
= MENU_OPTION_FROM_LINK (NewPosition
);
1231 NewPosition
= *CurrentPosition
;
1234 // Since the behavior of hitting the up arrow on a Date/Time MenuOption is intended
1235 // to be one that back to the previous set of MenuOptions, we need to advance to the first
1236 // Date/Time MenuOption and leave the remaining logic in CfUiUp intact so the appropriate
1237 // checking can be done.
1239 while (Count
++ < 2) {
1240 NewPosition
= NewPosition
->BackLink
;
1244 // Since the behavior of hitting the down arrow on a Date/Time MenuOption is intended
1245 // to be one that progresses to the next set of MenuOptions, we need to advance to the last
1246 // Date/Time MenuOption and leave the remaining logic in CfUiDown intact so the appropriate
1247 // checking can be done.
1249 while (Count
-- > 0) {
1250 NewPosition
= NewPosition
->ForwardLink
;
1254 *CurrentPosition
= NewPosition
;
1257 return PadLineNumber
;
1261 Get step info from numeric opcode.
1263 @param[in] OpCode The input numeric op code.
1265 @return step info for this opcode.
1269 IN EFI_IFR_OP_HEADER
*OpCode
1272 EFI_IFR_NUMERIC
*NumericOp
;
1275 NumericOp
= (EFI_IFR_NUMERIC
*) OpCode
;
1277 switch (NumericOp
->Flags
& EFI_IFR_NUMERIC_SIZE
) {
1278 case EFI_IFR_NUMERIC_SIZE_1
:
1279 Step
= NumericOp
->data
.u8
.Step
;
1282 case EFI_IFR_NUMERIC_SIZE_2
:
1283 Step
= NumericOp
->data
.u16
.Step
;
1286 case EFI_IFR_NUMERIC_SIZE_4
:
1287 Step
= NumericOp
->data
.u32
.Step
;
1290 case EFI_IFR_NUMERIC_SIZE_8
:
1291 Step
= NumericOp
->data
.u64
.Step
;
1303 Find the registered HotKey based on KeyData.
1305 @param[in] KeyData A pointer to a buffer that describes the keystroke
1306 information for the hot key.
1308 @return The registered HotKey context. If no found, NULL will return.
1311 GetHotKeyFromRegisterList (
1312 IN EFI_INPUT_KEY
*KeyData
1316 BROWSER_HOT_KEY
*HotKey
;
1318 Link
= GetFirstNode (&gFormData
->HotKeyListHead
);
1319 while (!IsNull (&gFormData
->HotKeyListHead
, Link
)) {
1320 HotKey
= BROWSER_HOT_KEY_FROM_LINK (Link
);
1322 if (HotKey
->KeyData
->ScanCode
== KeyData
->ScanCode
) {
1326 Link
= GetNextNode (&gFormData
->HotKeyListHead
, Link
);
1334 Determine if the menu is the last menu that can be selected.
1336 This is an internal function.
1338 @param Direction The scroll direction. False is down. True is up.
1339 @param CurrentPos The current focus.
1341 @return FALSE -- the menu isn't the last menu that can be selected.
1342 @return TRUE -- the menu is the last menu that can be selected.
1347 IN BOOLEAN Direction
,
1348 IN LIST_ENTRY
*CurrentPos
1353 Temp
= Direction
? CurrentPos
->BackLink
: CurrentPos
->ForwardLink
;
1355 if (Temp
== &gMenuOption
) {
1363 Wait for a given event to fire, or for an optional timeout to expire.
1365 @param Event The event to wait for
1367 @retval UI_EVENT_TYPE The type of the event which is trigged.
1379 EFI_EVENT TimerEvent
;
1380 EFI_EVENT WaitList
[3];
1381 UI_EVENT_TYPE EventType
;
1384 Timeout
= FormExitTimeout(gFormData
);
1387 Status
= gBS
->CreateEvent (EVT_TIMER
, 0, NULL
, NULL
, &TimerEvent
);
1390 // Set the timer event
1399 WaitList
[0] = Event
;
1401 if (gFormData
->FormRefreshEvent
!= NULL
) {
1402 WaitList
[EventNum
] = gFormData
->FormRefreshEvent
;
1407 WaitList
[EventNum
] = TimerEvent
;
1411 Status
= gBS
->WaitForEvent (EventNum
, WaitList
, &Index
);
1412 ASSERT_EFI_ERROR (Status
);
1416 EventType
= UIEventKey
;
1420 if (gFormData
->FormRefreshEvent
!= NULL
) {
1421 EventType
= UIEventDriver
;
1423 ASSERT (Timeout
!= 0 && EventNum
== 2);
1424 EventType
= UIEventTimeOut
;
1429 ASSERT (Index
== 2 && EventNum
== 3);
1430 EventType
= UIEventTimeOut
;
1435 gBS
->CloseEvent (TimerEvent
);
1442 Get question id info from the input opcode header.
1444 @param OpCode The input opcode header pointer.
1446 @retval The question id for this opcode.
1451 IN EFI_IFR_OP_HEADER
*OpCode
1454 EFI_IFR_QUESTION_HEADER
*QuestionHeader
;
1456 if (OpCode
->Length
< sizeof (EFI_IFR_OP_HEADER
) + sizeof (EFI_IFR_QUESTION_HEADER
)) {
1460 QuestionHeader
= (EFI_IFR_QUESTION_HEADER
*)((UINT8
*) OpCode
+ sizeof(EFI_IFR_OP_HEADER
));
1462 return QuestionHeader
->QuestionId
;
1467 Find the top of screen menu base on the current menu.
1469 @param CurPos Current input menu.
1470 @param Rows Totol screen rows.
1471 @param SkipValue SkipValue for this new form.
1473 @retval TopOfScreen Top of screen menu for the new form.
1477 FindTopOfScreenMenu (
1478 IN LIST_ENTRY
*CurPos
,
1480 OUT UINTN
*SkipValue
1484 LIST_ENTRY
*TopOfScreen
;
1485 UI_MENU_OPTION
*PreviousMenuOption
;
1488 PreviousMenuOption
= NULL
;
1490 while (Link
->BackLink
!= &gMenuOption
) {
1491 Link
= Link
->BackLink
;
1492 PreviousMenuOption
= MENU_OPTION_FROM_LINK (Link
);
1493 if (PreviousMenuOption
->Row
== 0) {
1494 UpdateOptionSkipLines (PreviousMenuOption
);
1496 if (Rows
<= PreviousMenuOption
->Skip
) {
1499 Rows
= Rows
- PreviousMenuOption
->Skip
;
1502 if (Link
->BackLink
== &gMenuOption
) {
1503 TopOfScreen
= gMenuOption
.ForwardLink
;
1504 if (PreviousMenuOption
!= NULL
&& Rows
< PreviousMenuOption
->Skip
) {
1505 *SkipValue
= PreviousMenuOption
->Skip
- Rows
;
1511 *SkipValue
= PreviousMenuOption
->Skip
- Rows
;
1518 Get the index info for this opcode.
1520 @param OpCode The input opcode for the statement.
1522 @retval The index of this statement.
1526 GetIndexInfoForOpcode (
1527 IN EFI_IFR_OP_HEADER
*OpCode
1531 UI_MENU_OPTION
*MenuOption
;
1534 NewPos
= gMenuOption
.ForwardLink
;
1537 for (NewPos
= gMenuOption
.ForwardLink
; NewPos
!= &gMenuOption
; NewPos
= NewPos
->ForwardLink
){
1538 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1540 if (CompareMem (MenuOption
->ThisTag
->OpCode
, OpCode
, OpCode
->Length
) == 0) {
1541 if (MenuOption
->ThisTag
->OpCode
== OpCode
) {
1553 Is this the saved highlight statement.
1555 @param HighLightedStatement The input highlight statement.
1557 @retval TRUE This is the highlight statement.
1558 @retval FALSE This is not the highlight statement.
1562 IsSavedHighlightStatement (
1563 IN FORM_DISPLAY_ENGINE_STATEMENT
*HighLightedStatement
1566 if ((gFormData
->HiiHandle
== gHighligthMenuInfo
.HiiHandle
) &&
1567 (gFormData
->FormId
== gHighligthMenuInfo
.FormId
)) {
1568 if (gHighligthMenuInfo
.HLTQuestionId
!= 0) {
1569 return (BOOLEAN
) (gHighligthMenuInfo
.HLTQuestionId
== GetQuestionIdInfo (HighLightedStatement
->OpCode
));
1571 if (CompareMem (gHighligthMenuInfo
.HLTOpCode
, HighLightedStatement
->OpCode
, gHighligthMenuInfo
.HLTOpCode
->Length
) == 0) {
1572 if (gHighligthMenuInfo
.HLTIndex
== 0 || gHighligthMenuInfo
.HLTIndex
== GetIndexInfoForOpcode(HighLightedStatement
->OpCode
)) {
1585 Is this the highlight menu.
1587 @param MenuOption The input Menu option.
1589 @retval TRUE This is the highlight menu option.
1590 @retval FALSE This is not the highlight menu option.
1594 IsHighLightMenuOption (
1595 IN UI_MENU_OPTION
*MenuOption
1598 if (gHighligthMenuInfo
.HLTQuestionId
!= 0) {
1599 if (GetQuestionIdInfo(MenuOption
->ThisTag
->OpCode
) == gHighligthMenuInfo
.HLTQuestionId
) {
1600 return (BOOLEAN
) (MenuOption
->Sequence
== gHighligthMenuInfo
.HLTSequence
);
1603 if(CompareMem (gHighligthMenuInfo
.HLTOpCode
, MenuOption
->ThisTag
->OpCode
, gHighligthMenuInfo
.HLTOpCode
->Length
) == 0) {
1604 if (gHighligthMenuInfo
.HLTIndex
== 0 || gHighligthMenuInfo
.HLTIndex
== GetIndexInfoForOpcode(MenuOption
->ThisTag
->OpCode
)) {
1605 return (BOOLEAN
) (MenuOption
->Sequence
== gHighligthMenuInfo
.HLTSequence
);
1616 Find the highlight menu.
1618 If the input is NULL, base on the record highlight info in
1619 gHighligthMenuInfo to find the last highlight menu.
1621 @param HighLightedStatement The input highlight statement.
1623 @retval The highlight menu index.
1627 FindHighLightMenuOption (
1628 IN FORM_DISPLAY_ENGINE_STATEMENT
*HighLightedStatement
1632 UI_MENU_OPTION
*MenuOption
;
1634 NewPos
= gMenuOption
.ForwardLink
;
1635 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1637 if (HighLightedStatement
!= NULL
) {
1638 while (MenuOption
->ThisTag
!= HighLightedStatement
) {
1639 NewPos
= NewPos
->ForwardLink
;
1640 if (NewPos
== &gMenuOption
) {
1642 // Not Found it, break
1646 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1650 // Must find the highlight statement.
1652 ASSERT (NewPos
!= &gMenuOption
);
1655 while (!IsHighLightMenuOption (MenuOption
)) {
1656 NewPos
= NewPos
->ForwardLink
;
1657 if (NewPos
== &gMenuOption
) {
1659 // Not Found it, break
1663 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1667 // Highlight statement has disappear (suppressed/disableed)
1669 if (NewPos
== &gMenuOption
) {
1678 Is this the Top of screen menu.
1680 @param MenuOption The input Menu option.
1682 @retval TRUE This is the Top of screen menu option.
1683 @retval FALSE This is not the Top of screen menu option.
1687 IsTopOfScreeMenuOption (
1688 IN UI_MENU_OPTION
*MenuOption
1691 if (gHighligthMenuInfo
.TOSQuestionId
!= 0) {
1692 return (BOOLEAN
) (GetQuestionIdInfo(MenuOption
->ThisTag
->OpCode
) == gHighligthMenuInfo
.TOSQuestionId
);
1695 if(CompareMem (gHighligthMenuInfo
.TOSOpCode
, MenuOption
->ThisTag
->OpCode
, gHighligthMenuInfo
.TOSOpCode
->Length
) == 0) {
1696 if (gHighligthMenuInfo
.TOSIndex
== 0 || gHighligthMenuInfo
.TOSIndex
== GetIndexInfoForOpcode(MenuOption
->ThisTag
->OpCode
)) {
1707 Find the Top of screen menu.
1709 If the input is NULL, base on the record highlight info in
1710 gHighligthMenuInfo to find the last highlight menu.
1712 @param HighLightedStatement The input highlight statement.
1714 @retval The highlight menu index.
1718 FindTopOfScreenMenuOption (
1723 UI_MENU_OPTION
*MenuOption
;
1725 NewPos
= gMenuOption
.ForwardLink
;
1726 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1728 while (!IsTopOfScreeMenuOption(MenuOption
)) {
1729 NewPos
= NewPos
->ForwardLink
;
1730 if (NewPos
== &gMenuOption
) {
1732 // Not Found it, break
1736 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1740 // Last time top of screen menu has disappeared.
1742 if (NewPos
== &gMenuOption
) {
1750 Find the first menu which will be show at the top.
1752 @param FormData The data info for this form.
1753 @param TopOfScreen The link_entry pointer to top menu.
1754 @param HighlightMenu The menu which will be highlight.
1755 @param SkipValue The skip value for the top menu.
1760 IN FORM_DISPLAY_ENGINE_FORM
*FormData
,
1761 OUT LIST_ENTRY
**TopOfScreen
,
1762 OUT LIST_ENTRY
**HighlightMenu
,
1763 OUT UINTN
*SkipValue
1768 UI_MENU_OPTION
*MenuOption
;
1771 TopRow
= gStatementDimensions
.TopRow
+ SCROLL_ARROW_HEIGHT
;
1772 BottomRow
= gStatementDimensions
.BottomRow
- SCROLL_ARROW_HEIGHT
;
1776 // Reenter caused by option mismatch or auto exit caused by refresh form(refresh interval/guid),
1777 // base on the record highlight info to find the highlight menu.
1779 ASSERT (gFormData
->HiiHandle
== gHighligthMenuInfo
.HiiHandle
&&
1780 gFormData
->FormId
== gHighligthMenuInfo
.FormId
);
1782 *HighlightMenu
= FindHighLightMenuOption(NULL
);
1783 if (*HighlightMenu
!= NULL
) {
1785 // Update skip info for this highlight menu.
1787 MenuOption
= MENU_OPTION_FROM_LINK (*HighlightMenu
);
1788 UpdateOptionSkipLines (MenuOption
);
1791 // Found the last time highlight menu.
1793 *TopOfScreen
= FindTopOfScreenMenuOption();
1794 if (*TopOfScreen
!= NULL
) {
1796 // Found the last time selectable top of screen menu.
1798 AdjustDateAndTimePosition(TRUE
, TopOfScreen
);
1799 MenuOption
= MENU_OPTION_FROM_LINK (*TopOfScreen
);
1800 UpdateOptionSkipLines (MenuOption
);
1802 *SkipValue
= gHighligthMenuInfo
.SkipValue
;
1805 // Not found last time top of screen menu, so base on current highlight menu
1806 // to find the new top of screen menu.
1807 // Make the current highlight menu at the bottom of the form to calculate the
1808 // top of screen menu.
1810 if (MenuOption
->Skip
>= BottomRow
- TopRow
) {
1811 *TopOfScreen
= *HighlightMenu
;
1814 *TopOfScreen
= FindTopOfScreenMenu(*HighlightMenu
, BottomRow
- TopRow
- MenuOption
->Skip
, &TmpValue
);
1817 *SkipValue
= TmpValue
;
1821 // Last time highlight menu has disappear, find the first highlightable menu as the defalut one.
1823 *HighlightMenu
= gMenuOption
.ForwardLink
;
1824 if (!IsListEmpty (&gMenuOption
)) {
1825 MoveToNextStatement (FALSE
, HighlightMenu
, BottomRow
- TopRow
, TRUE
);
1827 *TopOfScreen
= gMenuOption
.ForwardLink
;
1832 } else if (FormData
->HighLightedStatement
!= NULL
) {
1833 if (IsSavedHighlightStatement (FormData
->HighLightedStatement
)) {
1835 // Input highlight menu is same as last time highlight menu.
1836 // Base on last time highlight menu to set the top of screen menu and highlight menu.
1838 *HighlightMenu
= FindHighLightMenuOption(NULL
);
1839 ASSERT (*HighlightMenu
!= NULL
);
1842 // Update skip info for this highlight menu.
1844 MenuOption
= MENU_OPTION_FROM_LINK (*HighlightMenu
);
1845 UpdateOptionSkipLines (MenuOption
);
1847 *TopOfScreen
= FindTopOfScreenMenuOption();
1848 if (*TopOfScreen
== NULL
) {
1850 // Not found last time top of screen menu, so base on current highlight menu
1851 // to find the new top of screen menu.
1852 // Make the current highlight menu at the bottom of the form to calculate the
1853 // top of screen menu.
1855 if (MenuOption
->Skip
>= BottomRow
- TopRow
) {
1856 *TopOfScreen
= *HighlightMenu
;
1859 *TopOfScreen
= FindTopOfScreenMenu(*HighlightMenu
, BottomRow
- TopRow
- MenuOption
->Skip
, &TmpValue
);
1862 *SkipValue
= TmpValue
;
1864 AdjustDateAndTimePosition(TRUE
, TopOfScreen
);
1865 MenuOption
= MENU_OPTION_FROM_LINK (*TopOfScreen
);
1866 UpdateOptionSkipLines (MenuOption
);
1868 *SkipValue
= gHighligthMenuInfo
.SkipValue
;
1870 AdjustDateAndTimePosition(TRUE
, TopOfScreen
);
1873 // Input highlight menu is not save as last time highlight menu.
1875 *HighlightMenu
= FindHighLightMenuOption(FormData
->HighLightedStatement
);
1876 MenuOption
= MENU_OPTION_FROM_LINK (*HighlightMenu
);
1877 UpdateOptionSkipLines (MenuOption
);
1880 // Make the current highlight menu at the bottom of the form to calculate the
1881 // top of screen menu.
1883 if (MenuOption
->Skip
>= BottomRow
- TopRow
) {
1884 *TopOfScreen
= *HighlightMenu
;
1887 *TopOfScreen
= FindTopOfScreenMenu(*HighlightMenu
, BottomRow
- TopRow
- MenuOption
->Skip
, &TmpValue
);
1890 *SkipValue
= TmpValue
;
1892 AdjustDateAndTimePosition(TRUE
, TopOfScreen
);
1895 // If not has input highlight statement, just return the first one in this form.
1897 *TopOfScreen
= gMenuOption
.ForwardLink
;
1898 *HighlightMenu
= gMenuOption
.ForwardLink
;
1899 if (!IsListEmpty (&gMenuOption
)) {
1900 MoveToNextStatement (FALSE
, HighlightMenu
, BottomRow
- TopRow
, TRUE
);
1906 // First enter to show the menu, update highlight info.
1908 UpdateHighlightMenuInfo (*HighlightMenu
, *TopOfScreen
, *SkipValue
);
1912 Record the highlight menu and top of screen menu info.
1914 @param Highlight The menu opton which is highlight.
1915 @param TopOfScreen The menu opton which is at the top of the form.
1916 @param SkipValue The skip line info for the top of screen menu.
1920 UpdateHighlightMenuInfo (
1921 IN LIST_ENTRY
*Highlight
,
1922 IN LIST_ENTRY
*TopOfScreen
,
1926 UI_MENU_OPTION
*MenuOption
;
1927 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
1929 gHighligthMenuInfo
.HiiHandle
= gFormData
->HiiHandle
;
1930 gHighligthMenuInfo
.FormId
= gFormData
->FormId
;
1931 gHighligthMenuInfo
.SkipValue
= (UINT16
)SkipValue
;
1933 if (!IsListEmpty (&gMenuOption
)) {
1934 MenuOption
= MENU_OPTION_FROM_LINK (Highlight
);
1935 Statement
= MenuOption
->ThisTag
;
1937 gUserInput
->SelectedStatement
= Statement
;
1939 gHighligthMenuInfo
.HLTSequence
= MenuOption
->Sequence
;
1940 gHighligthMenuInfo
.HLTQuestionId
= GetQuestionIdInfo(Statement
->OpCode
);
1941 if (gHighligthMenuInfo
.HLTQuestionId
== 0) {
1943 // if question id == 0, save the opcode buffer..
1945 if (gHighligthMenuInfo
.HLTOpCode
!= NULL
) {
1946 FreePool (gHighligthMenuInfo
.HLTOpCode
);
1948 gHighligthMenuInfo
.HLTOpCode
= AllocateCopyPool (Statement
->OpCode
->Length
, Statement
->OpCode
);
1949 ASSERT (gHighligthMenuInfo
.HLTOpCode
!= NULL
);
1951 gHighligthMenuInfo
.HLTIndex
= GetIndexInfoForOpcode(Statement
->OpCode
);
1954 MenuOption
= MENU_OPTION_FROM_LINK (TopOfScreen
);
1955 Statement
= MenuOption
->ThisTag
;
1957 gHighligthMenuInfo
.TOSQuestionId
= GetQuestionIdInfo(Statement
->OpCode
);
1958 if (gHighligthMenuInfo
.TOSQuestionId
== 0) {
1960 // if question id == 0, save the opcode buffer..
1962 if (gHighligthMenuInfo
.TOSOpCode
!= NULL
) {
1963 FreePool (gHighligthMenuInfo
.TOSOpCode
);
1965 gHighligthMenuInfo
.TOSOpCode
= AllocateCopyPool (Statement
->OpCode
->Length
, Statement
->OpCode
);
1966 ASSERT (gHighligthMenuInfo
.TOSOpCode
!= NULL
);
1968 gHighligthMenuInfo
.TOSIndex
= GetIndexInfoForOpcode(Statement
->OpCode
);
1971 gUserInput
->SelectedStatement
= NULL
;
1973 gHighligthMenuInfo
.HLTSequence
= 0;
1974 gHighligthMenuInfo
.HLTQuestionId
= 0;
1975 if (gHighligthMenuInfo
.HLTOpCode
!= NULL
) {
1976 FreePool (gHighligthMenuInfo
.HLTOpCode
);
1978 gHighligthMenuInfo
.HLTOpCode
= NULL
;
1979 gHighligthMenuInfo
.HLTIndex
= 0;
1981 gHighligthMenuInfo
.TOSQuestionId
= 0;
1982 if (gHighligthMenuInfo
.TOSOpCode
!= NULL
) {
1983 FreePool (gHighligthMenuInfo
.TOSOpCode
);
1985 gHighligthMenuInfo
.TOSOpCode
= NULL
;
1986 gHighligthMenuInfo
.TOSIndex
= 0;
1991 Update attribut for this menu.
1993 @param MenuOption The menu opton which this attribut used to.
1994 @param Highlight Whether this menu will be highlight.
1998 SetDisplayAttribute (
1999 IN UI_MENU_OPTION
*MenuOption
,
2000 IN BOOLEAN Highlight
2003 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
2005 Statement
= MenuOption
->ThisTag
;
2008 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetHighlightTextColor ());
2012 if (MenuOption
->GrayOut
) {
2013 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetGrayedTextColor ());
2015 if (Statement
->OpCode
->OpCode
== EFI_IFR_SUBTITLE_OP
) {
2016 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetSubTitleTextColor ());
2018 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetFieldTextColor ());
2024 Print string for this menu option.
2026 @param MenuOption The menu opton which this attribut used to.
2027 @param Col The column that this string will be print at.
2028 @param Row The row that this string will be print at.
2029 @param String The string which need to print.
2030 @param Width The width need to print, if string is less than the
2031 width, the block space will be used.
2032 @param Highlight Whether this menu will be highlight.
2037 IN UI_MENU_OPTION
*MenuOption
,
2042 IN BOOLEAN Highlight
2048 // Print string with normal color.
2051 PrintStringAtWithWidth (Col
, Row
, String
, Width
);
2056 // Print the highlight menu string.
2057 // First print the highlight string.
2059 SetDisplayAttribute(MenuOption
, TRUE
);
2060 Length
= PrintStringAt (Col
, Row
, String
);
2063 // Second, clean the empty after the string.
2065 SetDisplayAttribute(MenuOption
, FALSE
);
2066 PrintStringAtWithWidth (Col
+ Length
, Row
, L
"", Width
- Length
);
2070 Check whether this menu can has option string.
2072 @param MenuOption The menu opton which this attribut used to.
2074 @retval TRUE This menu option can have option string.
2075 @retval FALSE This menu option can't have option string.
2080 IN UI_MENU_OPTION
*MenuOption
2083 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
2086 EFI_IFR_TEXT
*TestOp
;
2089 Statement
= MenuOption
->ThisTag
;
2092 // See if the second text parameter is really NULL
2094 if (Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) {
2095 TestOp
= (EFI_IFR_TEXT
*) Statement
->OpCode
;
2096 if (TestOp
->TextTwo
!= 0) {
2097 String
= GetToken (TestOp
->TextTwo
, gFormData
->HiiHandle
);
2098 Size
= StrLen (String
);
2103 if ((Statement
->OpCode
->OpCode
== EFI_IFR_SUBTITLE_OP
) ||
2104 (Statement
->OpCode
->OpCode
== EFI_IFR_REF_OP
) ||
2105 (Statement
->OpCode
->OpCode
== EFI_IFR_PASSWORD_OP
) ||
2106 (Statement
->OpCode
->OpCode
== EFI_IFR_ACTION_OP
) ||
2107 (Statement
->OpCode
->OpCode
== EFI_IFR_RESET_BUTTON_OP
) ||
2109 // Allow a wide display if text op-code and no secondary text op-code
2111 ((Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) && (Size
== 0))
2121 Double confirm with user about the action.
2123 @param Action The user input action.
2125 @retval TRUE User confirm with the input or not need user confirm.
2126 @retval FALSE User want ignore this input.
2142 CatLen
= StrLen (gConfirmMsgConnect
);
2145 // Below action need extra popup dialog to confirm.
2147 CheckFlags
= BROWSER_ACTION_DISCARD
|
2148 BROWSER_ACTION_DEFAULT
|
2149 BROWSER_ACTION_SUBMIT
|
2150 BROWSER_ACTION_RESET
|
2151 BROWSER_ACTION_EXIT
;
2154 // Not need to confirm with user, just return TRUE.
2156 if ((Action
& CheckFlags
) == 0) {
2160 if ((Action
& BROWSER_ACTION_DISCARD
) == BROWSER_ACTION_DISCARD
) {
2161 CfmStrLen
+= StrLen (gConfirmDiscardMsg
);
2164 if ((Action
& BROWSER_ACTION_DEFAULT
) == BROWSER_ACTION_DEFAULT
) {
2165 if (CfmStrLen
!= 0) {
2166 CfmStrLen
+= CatLen
;
2169 CfmStrLen
+= StrLen (gConfirmDefaultMsg
);
2172 if ((Action
& BROWSER_ACTION_SUBMIT
) == BROWSER_ACTION_SUBMIT
) {
2173 if (CfmStrLen
!= 0) {
2174 CfmStrLen
+= CatLen
;
2177 CfmStrLen
+= StrLen (gConfirmSubmitMsg
);
2180 if ((Action
& BROWSER_ACTION_RESET
) == BROWSER_ACTION_RESET
) {
2181 if (CfmStrLen
!= 0) {
2182 CfmStrLen
+= CatLen
;
2185 CfmStrLen
+= StrLen (gConfirmResetMsg
);
2188 if ((Action
& BROWSER_ACTION_EXIT
) == BROWSER_ACTION_EXIT
) {
2189 if (CfmStrLen
!= 0) {
2190 CfmStrLen
+= CatLen
;
2193 CfmStrLen
+= StrLen (gConfirmExitMsg
);
2197 // Allocate buffer to save the string.
2198 // String + "?" + "\0"
2200 CfmStr
= AllocateZeroPool ((CfmStrLen
+ 1 + 1) * sizeof (CHAR16
));
2201 ASSERT (CfmStr
!= NULL
);
2203 if ((Action
& BROWSER_ACTION_DISCARD
) == BROWSER_ACTION_DISCARD
) {
2204 StrCpy (CfmStr
, gConfirmDiscardMsg
);
2207 if ((Action
& BROWSER_ACTION_DEFAULT
) == BROWSER_ACTION_DEFAULT
) {
2208 if (CfmStr
[0] != 0) {
2209 StrCat (CfmStr
, gConfirmMsgConnect
);
2210 StrCat (CfmStr
, gConfirmDefaultMsg2nd
);
2212 StrCpy (CfmStr
, gConfirmDefaultMsg
);
2216 if ((Action
& BROWSER_ACTION_SUBMIT
) == BROWSER_ACTION_SUBMIT
) {
2217 if (CfmStr
[0] != 0) {
2218 StrCat (CfmStr
, gConfirmMsgConnect
);
2219 StrCat (CfmStr
, gConfirmSubmitMsg2nd
);
2221 StrCpy (CfmStr
, gConfirmSubmitMsg
);
2225 if ((Action
& BROWSER_ACTION_RESET
) == BROWSER_ACTION_RESET
) {
2226 if (CfmStr
[0] != 0) {
2227 StrCat (CfmStr
, gConfirmMsgConnect
);
2228 StrCat (CfmStr
, gConfirmResetMsg2nd
);
2230 StrCpy (CfmStr
, gConfirmResetMsg
);
2234 if ((Action
& BROWSER_ACTION_EXIT
) == BROWSER_ACTION_EXIT
) {
2235 if (CfmStr
[0] != 0) {
2236 StrCat (CfmStr
, gConfirmMsgConnect
);
2237 StrCat (CfmStr
, gConfirmExitMsg2nd
);
2239 StrCpy (CfmStr
, gConfirmExitMsg
);
2243 StrCat (CfmStr
, gConfirmMsgEnd
);
2246 CreateDialog (&Key
, gEmptyString
, CfmStr
, gConfirmOpt
, gEmptyString
, NULL
);
2247 } while (((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (gConfirmOptYes
[0] | UPPER_LOWER_CASE_OFFSET
)) &&
2248 ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (gConfirmOptNo
[0] | UPPER_LOWER_CASE_OFFSET
)));
2250 if ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) == (gConfirmOptYes
[0] | UPPER_LOWER_CASE_OFFSET
)) {
2262 Print string for this menu option.
2264 @param MenuOption The menu opton which this attribut used to.
2265 @param SkipWidth The skip width between the left to the start of the prompt.
2266 @param BeginCol The begin column for one menu.
2267 @param SkipLine The skip line for this menu.
2268 @param BottomRow The bottom row for this form.
2269 @param Highlight Whether this menu will be highlight.
2270 @param UpdateCol Whether need to update the column info for Date/Time.
2272 @retval EFI_SUCESSS Process the user selection success.
2277 IN UI_MENU_OPTION
*MenuOption
,
2282 IN BOOLEAN Highlight
,
2283 IN BOOLEAN UpdateCol
2286 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
2291 CHAR16
*OptionString
;
2292 CHAR16
*OutputString
;
2299 BOOLEAN IsProcessingFirstRow
;
2301 UINTN PromptLineNum
;
2302 UINTN OptionLineNum
;
2306 Statement
= MenuOption
->ThisTag
;
2314 IsProcessingFirstRow
= TRUE
;
2317 // Set default color.
2319 SetDisplayAttribute (MenuOption
, FALSE
);
2322 // 1. Paint the option string.
2324 Status
= ProcessOptions (MenuOption
, FALSE
, &OptionString
, FALSE
);
2325 if (EFI_ERROR (Status
)) {
2329 if (OptionString
!= NULL
) {
2330 if (Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
|| Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
) {
2332 // Adjust option string for date/time opcode.
2334 ProcessStringForDateTime(MenuOption
, OptionString
, UpdateCol
);
2337 Width
= (UINT16
) gOptionBlockWidth
- 1;
2338 Row
= MenuOption
->Row
;
2342 for (Index
= 0; GetLineByWidth (OptionString
, Width
, &GlyphWidth
, &Index
, &OutputString
) != 0x0000;) {
2343 if (((Temp2
== 0)) && (Row
<= BottomRow
)) {
2344 if (Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
|| Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
) {
2346 // For date/time question, it has three menu options for this qustion.
2347 // The first/second menu options with the skip value is 0. the last one
2348 // with skip value is 1.
2350 if (MenuOption
->Skip
!= 0) {
2352 // For date/ time, print the last past (year for date and second for time)
2353 // - 7 means skip [##/##/ for date and [##:##: for time.
2355 DisplayMenuString (MenuOption
,MenuOption
->OptCol
, Row
, OutputString
, Width
+ 1 - 7, Highlight
);
2358 // For date/ time, print the first and second past (year for date and second for time)
2359 // The OutputString has a NARROW_CHAR or WIDE_CHAR at the begin of the string,
2360 // so need to - 1 to remove it, otherwise, it will clean 1 extr char follow it.
2361 DisplayMenuString (MenuOption
, MenuOption
->OptCol
, Row
, OutputString
, StrLen (OutputString
) - 1, Highlight
);
2364 DisplayMenuString (MenuOption
, MenuOption
->OptCol
, Row
, OutputString
, Width
+ 1, Highlight
);
2370 // If there is more string to process print on the next row and increment the Skip value
2372 if (StrLen (&OptionString
[Index
]) != 0) {
2376 // Since the Number of lines for this menu entry may or may not be reflected accurately
2377 // since the prompt might be 1 lines and option might be many, and vice versa, we need to do
2378 // some testing to ensure we are keeping this in-sync.
2380 // If the difference in rows is greater than or equal to the skip value, increase the skip value
2382 if ((Row
- MenuOption
->Row
) >= MenuOption
->Skip
) {
2388 FreePool (OutputString
);
2396 FreePool (OptionString
);
2400 // 2. Paint the description.
2402 PromptWidth
= GetWidth (MenuOption
, &AdjustValue
);
2403 Row
= MenuOption
->Row
;
2407 if (MenuOption
->Description
== NULL
|| MenuOption
->Description
[0] == '\0') {
2408 PrintStringAtWithWidth (BeginCol
, Row
, L
"", PromptWidth
+ AdjustValue
+ SkipWidth
);
2411 for (Index
= 0; GetLineByWidth (MenuOption
->Description
, PromptWidth
, &GlyphWidth
, &Index
, &OutputString
) != 0x0000;) {
2412 if ((Temp
== 0) && (Row
<= BottomRow
)) {
2414 // 1.Clean the start LEFT_SKIPPED_COLUMNS
2416 PrintStringAtWithWidth (BeginCol
, Row
, L
"", SkipWidth
);
2418 if (Statement
->OpCode
->OpCode
== EFI_IFR_REF_OP
&& MenuOption
->Col
>= 2 && IsProcessingFirstRow
) {
2420 // Print Arrow for Goto button.
2423 MenuOption
->Col
- 2,
2425 GEOMETRICSHAPE_RIGHT_TRIANGLE
2427 IsProcessingFirstRow
= FALSE
;
2429 DisplayMenuString (MenuOption
, MenuOption
->Col
, Row
, OutputString
, PromptWidth
+ AdjustValue
, Highlight
);
2433 // If there is more string to process print on the next row and increment the Skip value
2435 if (StrLen (&MenuOption
->Description
[Index
]) != 0) {
2441 FreePool (OutputString
);
2452 // 3. If this is a text op with secondary text information
2454 if ((Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) && (((EFI_IFR_TEXT
*)Statement
->OpCode
)->TextTwo
!= 0)) {
2455 StringPtr
= GetToken (((EFI_IFR_TEXT
*)Statement
->OpCode
)->TextTwo
, gFormData
->HiiHandle
);
2457 Width
= (UINT16
) gOptionBlockWidth
- 1;
2458 Row
= MenuOption
->Row
;
2462 for (Index
= 0; GetLineByWidth (StringPtr
, Width
, &GlyphWidth
, &Index
, &OutputString
) != 0x0000;) {
2463 if ((Temp3
== 0) && (Row
<= BottomRow
)) {
2464 DisplayMenuString (MenuOption
, MenuOption
->OptCol
, Row
, OutputString
, Width
+ 1, Highlight
);
2468 // If there is more string to process print on the next row and increment the Skip value
2470 if (StrLen (&StringPtr
[Index
]) != 0) {
2474 // If the rows for text two is greater than or equal to the skip value, increase the skip value
2476 if ((Row
- MenuOption
->Row
) >= MenuOption
->Skip
) {
2482 FreePool (OutputString
);
2488 FreePool (StringPtr
);
2492 // 4.Line number for Option string and prompt string are not equal.
2493 // Clean the column whose line number is less.
2495 if (HasOptionString(MenuOption
) && (OptionLineNum
!= PromptLineNum
)) {
2496 Col
= OptionLineNum
< PromptLineNum
? MenuOption
->OptCol
: BeginCol
;
2497 Row
= (OptionLineNum
< PromptLineNum
? OptionLineNum
: PromptLineNum
) + MenuOption
->Row
;
2498 Width
= (UINT16
) (OptionLineNum
< PromptLineNum
? gOptionBlockWidth
: PromptWidth
+ AdjustValue
+ SkipWidth
);
2499 MaxRow
= (OptionLineNum
< PromptLineNum
? PromptLineNum
: OptionLineNum
) + MenuOption
->Row
- 1;
2501 while (Row
<= MaxRow
) {
2502 DisplayMenuString (MenuOption
, Col
, Row
++, L
"", Width
, FALSE
);
2510 Display menu and wait for user to select one menu option, then return it.
2511 If AutoBoot is enabled, then if user doesn't select any option,
2512 after period of time, it will automatically return the first menu option.
2514 @param FormData The current form data info.
2516 @retval EFI_SUCESSS Process the user selection success.
2517 @retval EFI_NOT_FOUND Process option string for orderedlist/Oneof fail.
2522 IN FORM_DISPLAY_ENGINE_FORM
*FormData
2527 UINTN DistanceValue
;
2536 CHAR16
*OptionString
;
2538 CHAR16
*HelpHeaderString
;
2539 CHAR16
*HelpBottomString
;
2548 LIST_ENTRY
*TopOfScreen
;
2549 LIST_ENTRY
*SavedListEntry
;
2550 UI_MENU_OPTION
*MenuOption
;
2551 UI_MENU_OPTION
*NextMenuOption
;
2552 UI_MENU_OPTION
*SavedMenuOption
;
2553 UI_CONTROL_FLAG ControlFlag
;
2554 UI_SCREEN_OPERATION ScreenOperation
;
2555 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
2556 BROWSER_HOT_KEY
*HotKey
;
2557 UINTN HelpPageIndex
;
2558 UINTN HelpPageCount
;
2561 UINTN HelpHeaderLine
;
2562 UINTN HelpBottomLine
;
2563 BOOLEAN MultiHelpPage
;
2564 UINT16 EachLineWidth
;
2565 UINT16 HeaderLineWidth
;
2566 UINT16 BottomLineWidth
;
2567 EFI_STRING_ID HelpInfo
;
2568 UI_EVENT_TYPE EventType
;
2569 BOOLEAN SkipHighLight
;
2571 EventType
= UIEventNone
;
2572 Status
= EFI_SUCCESS
;
2574 HelpHeaderString
= NULL
;
2575 HelpBottomString
= NULL
;
2576 OptionString
= NULL
;
2577 ScreenOperation
= UiNoOperation
;
2585 MultiHelpPage
= FALSE
;
2587 HeaderLineWidth
= 0;
2588 BottomLineWidth
= 0;
2592 SkipHighLight
= FALSE
;
2594 NextMenuOption
= NULL
;
2595 SavedMenuOption
= NULL
;
2599 gModalSkipColumn
= (CHAR16
) (gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
) / 6;
2601 ZeroMem (&Key
, sizeof (EFI_INPUT_KEY
));
2603 TopRow
= gStatementDimensions
.TopRow
+ SCROLL_ARROW_HEIGHT
;
2604 BottomRow
= gStatementDimensions
.BottomRow
- SCROLL_ARROW_HEIGHT
- 1;
2607 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2608 Col
= gStatementDimensions
.LeftColumn
+ LEFT_SKIPPED_COLUMNS
+ gModalSkipColumn
;
2610 Col
= gStatementDimensions
.LeftColumn
+ LEFT_SKIPPED_COLUMNS
;
2613 FindTopMenu(FormData
, &TopOfScreen
, &NewPos
, &SkipValue
);
2614 if (!IsListEmpty (&gMenuOption
)) {
2615 NextMenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
2616 gUserInput
->SelectedStatement
= NextMenuOption
->ThisTag
;
2619 gST
->ConOut
->EnableCursor (gST
->ConOut
, FALSE
);
2621 ControlFlag
= CfInitialization
;
2623 switch (ControlFlag
) {
2624 case CfInitialization
:
2625 if ((gOldFormEntry
.HiiHandle
!= FormData
->HiiHandle
) ||
2626 (!CompareGuid (&gOldFormEntry
.FormSetGuid
, &FormData
->FormSetGuid
))) {
2628 // Clear Statement range if different formset is painted.
2631 gStatementDimensions
.LeftColumn
,
2632 gStatementDimensions
.RightColumn
,
2633 TopRow
- SCROLL_ARROW_HEIGHT
,
2634 BottomRow
+ SCROLL_ARROW_HEIGHT
,
2635 GetFieldTextColor ()
2639 ControlFlag
= CfRepaint
;
2643 ControlFlag
= CfRefreshHighLight
;
2653 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetFieldTextColor ());
2656 // 1. Check whether need to print the arrow up.
2658 if (!ValueIsScroll (TRUE
, TopOfScreen
)) {
2662 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2663 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
+ gModalSkipColumn
, TopRow
- 1, L
"", gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
- 2 * gModalSkipColumn
);
2665 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
, TopRow
- 1, L
"", gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
);
2668 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetArrowColor ());
2670 gStatementDimensions
.LeftColumn
+ gPromptBlockWidth
+ gOptionBlockWidth
+ 1,
2671 TopRow
- SCROLL_ARROW_HEIGHT
,
2674 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetFieldTextColor ());
2678 // 2.Paint the menu.
2680 for (Link
= TopOfScreen
; Link
!= &gMenuOption
; Link
= Link
->ForwardLink
) {
2681 MenuOption
= MENU_OPTION_FROM_LINK (Link
);
2682 MenuOption
->Row
= Row
;
2683 MenuOption
->Col
= Col
;
2684 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2685 MenuOption
->OptCol
= gStatementDimensions
.LeftColumn
+ LEFT_SKIPPED_COLUMNS
+ gPromptBlockWidth
+ gModalSkipColumn
;
2687 MenuOption
->OptCol
= gStatementDimensions
.LeftColumn
+ LEFT_SKIPPED_COLUMNS
+ gPromptBlockWidth
;
2690 if (MenuOption
->NestInStatement
) {
2691 MenuOption
->Col
+= SUBTITLE_INDENT
;
2695 // Save the highlight menu, will be used in CfRefreshHighLight case.
2697 if (Link
== NewPos
) {
2698 SavedMenuOption
= MenuOption
;
2699 SkipHighLight
= TRUE
;
2702 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2703 Status
= DisplayOneMenu (MenuOption
,
2704 MenuOption
->Col
- gStatementDimensions
.LeftColumn
,
2705 gStatementDimensions
.LeftColumn
+ gModalSkipColumn
,
2706 Link
== TopOfScreen
? SkipValue
: 0,
2708 (BOOLEAN
) ((Link
== NewPos
) && IsSelectable(MenuOption
)),
2712 Status
= DisplayOneMenu (MenuOption
,
2713 MenuOption
->Col
- gStatementDimensions
.LeftColumn
,
2714 gStatementDimensions
.LeftColumn
,
2715 Link
== TopOfScreen
? SkipValue
: 0,
2717 (BOOLEAN
) ((Link
== NewPos
) && IsSelectable(MenuOption
)),
2722 if (EFI_ERROR (Status
)) {
2730 // 3. Update the row info which will be used by next menu.
2732 if (Link
== TopOfScreen
) {
2733 Row
+= MenuOption
->Skip
- SkipValue
;
2735 Row
+= MenuOption
->Skip
;
2738 if (Row
> BottomRow
) {
2739 if (!ValueIsScroll (FALSE
, Link
)) {
2743 Row
= BottomRow
+ 1;
2749 // 3. Menus in this form may not cover all form, clean the remain field.
2751 while (Row
<= BottomRow
) {
2752 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2753 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
+ gModalSkipColumn
, Row
++, L
"", gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
- 2 * gModalSkipColumn
);
2755 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
, Row
++, L
"", gStatementDimensions
.RightColumn
- gHelpBlockWidth
- gStatementDimensions
.LeftColumn
);
2760 // 4. Print the down arrow row.
2762 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2763 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
+ gModalSkipColumn
, BottomRow
+ 1, L
"", gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
- 2 * + gModalSkipColumn
);
2765 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
, BottomRow
+ 1, L
"", gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
);
2768 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetArrowColor ());
2770 gStatementDimensions
.LeftColumn
+ gPromptBlockWidth
+ gOptionBlockWidth
+ 1,
2771 BottomRow
+ SCROLL_ARROW_HEIGHT
,
2774 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetFieldTextColor ());
2781 case CfRefreshHighLight
:
2784 // MenuOption: Last menu option that need to remove hilight
2785 // MenuOption is set to NULL in Repaint
2786 // NewPos: Current menu option that need to hilight
2788 ControlFlag
= CfUpdateHelpString
;
2790 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
2792 if (SkipHighLight
) {
2793 SkipHighLight
= FALSE
;
2794 MenuOption
= SavedMenuOption
;
2795 RefreshKeyHelp(gFormData
, SavedMenuOption
->ThisTag
, FALSE
);
2799 if (IsListEmpty (&gMenuOption
)) {
2801 // No menu option, just update the hotkey filed.
2803 RefreshKeyHelp(gFormData
, NULL
, FALSE
);
2807 if (MenuOption
!= NULL
&& TopOfScreen
== &MenuOption
->Link
) {
2812 if (NewPos
== TopOfScreen
) {
2818 if (NewPos
!= NULL
&& (MenuOption
== NULL
|| NewPos
!= &MenuOption
->Link
)) {
2819 if (MenuOption
!= NULL
) {
2821 // Remove the old highlight menu.
2823 Status
= DisplayOneMenu (MenuOption
,
2824 MenuOption
->Col
- gStatementDimensions
.LeftColumn
,
2825 gStatementDimensions
.LeftColumn
,
2834 // This is the current selected statement
2836 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
2837 RefreshKeyHelp(gFormData
, MenuOption
->ThisTag
, FALSE
);
2839 if (!IsSelectable (MenuOption
)) {
2843 Status
= DisplayOneMenu (MenuOption
,
2844 MenuOption
->Col
- gStatementDimensions
.LeftColumn
,
2845 gStatementDimensions
.LeftColumn
,
2854 case CfUpdateHelpString
:
2855 ControlFlag
= CfPrepareToReadKey
;
2856 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2861 // NewLine means only update highlight menu (remove old highlight and highlith
2862 // the new one), not need to full repain the form.
2864 if (Repaint
|| NewLine
) {
2865 if (IsListEmpty (&gMenuOption
)) {
2867 // Don't print anything if no mwnu option.
2869 StringPtr
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2872 // Don't print anything if it is a NULL help token
2874 ASSERT(MenuOption
!= NULL
);
2875 HelpInfo
= ((EFI_IFR_STATEMENT_HEADER
*) ((CHAR8
*)MenuOption
->ThisTag
->OpCode
+ sizeof (EFI_IFR_OP_HEADER
)))->Help
;
2876 if (HelpInfo
== 0 || !IsSelectable (MenuOption
)) {
2877 StringPtr
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2879 StringPtr
= GetToken (HelpInfo
, gFormData
->HiiHandle
);
2883 RowCount
= BottomRow
- TopRow
+ 1;
2886 // 1.Calculate how many line the help string need to print.
2888 if (HelpString
!= NULL
) {
2889 FreePool (HelpString
);
2892 HelpLine
= ProcessHelpString (StringPtr
, &HelpString
, &EachLineWidth
, RowCount
);
2893 FreePool (StringPtr
);
2895 if (HelpLine
> RowCount
) {
2896 MultiHelpPage
= TRUE
;
2897 StringPtr
= GetToken (STRING_TOKEN(ADJUST_HELP_PAGE_UP
), gHiiHandle
);
2898 if (HelpHeaderString
!= NULL
) {
2899 FreePool (HelpHeaderString
);
2900 HelpHeaderString
= NULL
;
2902 HelpHeaderLine
= ProcessHelpString (StringPtr
, &HelpHeaderString
, &HeaderLineWidth
, 0);
2903 FreePool (StringPtr
);
2904 StringPtr
= GetToken (STRING_TOKEN(ADJUST_HELP_PAGE_DOWN
), gHiiHandle
);
2905 if (HelpBottomString
!= NULL
) {
2906 FreePool (HelpBottomString
);
2907 HelpBottomString
= NULL
;
2909 HelpBottomLine
= ProcessHelpString (StringPtr
, &HelpBottomString
, &BottomLineWidth
, 0);
2910 FreePool (StringPtr
);
2912 // Calculate the help page count.
2914 if (HelpLine
> 2 * RowCount
- 2) {
2915 HelpPageCount
= (HelpLine
- RowCount
+ 1) / (RowCount
- 2) + 1;
2916 if ((HelpLine
- RowCount
+ 1) % (RowCount
- 2) > 1) {
2923 MultiHelpPage
= FALSE
;
2928 // Check whether need to show the 'More(U/u)' at the begin.
2929 // Base on current direct info, here shows aligned to the right side of the column.
2930 // If the direction is multi line and aligned to right side may have problem, so
2931 // add ASSERT code here.
2933 if (HelpPageIndex
> 0) {
2934 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetInfoTextColor ());
2935 for (Index
= 0; Index
< HelpHeaderLine
; Index
++) {
2936 ASSERT (HelpHeaderLine
== 1);
2937 ASSERT (GetStringWidth (HelpHeaderString
) / 2 < (UINTN
) (gHelpBlockWidth
- 1));
2938 PrintStringAtWithWidth (
2939 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
2945 gStatementDimensions
.RightColumn
- GetStringWidth (HelpHeaderString
) / 2 - 1,
2947 &HelpHeaderString
[Index
* HeaderLineWidth
]
2952 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetHelpTextColor ());
2954 // Print the help string info.
2956 if (!MultiHelpPage
) {
2957 for (Index
= 0; Index
< HelpLine
; Index
++) {
2958 PrintStringAtWithWidth (
2959 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
2961 &HelpString
[Index
* EachLineWidth
],
2965 for (; Index
< RowCount
; Index
++) {
2966 PrintStringAtWithWidth (
2967 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
2973 gST
->ConOut
->SetCursorPosition(gST
->ConOut
, gStatementDimensions
.RightColumn
-1, BottomRow
);
2975 if (HelpPageIndex
== 0) {
2976 for (Index
= 0; Index
< RowCount
- HelpBottomLine
; Index
++) {
2977 PrintStringAtWithWidth (
2978 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
2980 &HelpString
[Index
* EachLineWidth
],
2985 for (Index
= 0; (Index
< RowCount
- HelpBottomLine
- HelpHeaderLine
) &&
2986 (Index
+ HelpPageIndex
* (RowCount
- 2) + 1 < HelpLine
); Index
++) {
2987 PrintStringAtWithWidth (
2988 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
2989 Index
+ TopRow
+ HelpHeaderLine
,
2990 &HelpString
[(Index
+ HelpPageIndex
* (RowCount
- 2) + 1)* EachLineWidth
],
2994 if (HelpPageIndex
== HelpPageCount
- 1) {
2995 for (; Index
< RowCount
- HelpHeaderLine
; Index
++) {
2996 PrintStringAtWithWidth (
2997 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
2998 Index
+ TopRow
+ HelpHeaderLine
,
3003 gST
->ConOut
->SetCursorPosition(gST
->ConOut
, gStatementDimensions
.RightColumn
-1, BottomRow
);
3009 // Check whether need to print the 'More(D/d)' at the bottom.
3010 // Base on current direct info, here shows aligned to the right side of the column.
3011 // If the direction is multi line and aligned to right side may have problem, so
3012 // add ASSERT code here.
3014 if (HelpPageIndex
< HelpPageCount
- 1 && MultiHelpPage
) {
3015 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetInfoTextColor ());
3016 for (Index
= 0; Index
< HelpBottomLine
; Index
++) {
3017 ASSERT (HelpBottomLine
== 1);
3018 ASSERT (GetStringWidth (HelpBottomString
) / 2 < (UINTN
) (gHelpBlockWidth
- 1));
3019 PrintStringAtWithWidth (
3020 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
3021 BottomRow
+ Index
- HelpBottomLine
+ 1,
3026 gStatementDimensions
.RightColumn
- GetStringWidth (HelpBottomString
) / 2 - 1,
3027 BottomRow
+ Index
- HelpBottomLine
+ 1,
3028 &HelpBottomString
[Index
* BottomLineWidth
]
3033 // Reset this flag every time we finish using it.
3039 case CfPrepareToReadKey
:
3040 ControlFlag
= CfReadKey
;
3041 ScreenOperation
= UiNoOperation
;
3045 ControlFlag
= CfScreenOperation
;
3048 // Wait for user's selection
3051 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3052 if (!EFI_ERROR (Status
)) {
3053 EventType
= UIEventKey
;
3058 // If we encounter error, continue to read another key in.
3060 if (Status
!= EFI_NOT_READY
) {
3064 EventType
= UiWaitForEvent(gST
->ConIn
->WaitForKey
);
3065 if (EventType
== UIEventKey
) {
3066 gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3071 if (EventType
== UIEventDriver
) {
3073 gUserInput
->Action
= BROWSER_ACTION_NONE
;
3074 ControlFlag
= CfExit
;
3078 if (EventType
== UIEventTimeOut
) {
3079 gUserInput
->Action
= BROWSER_ACTION_FORM_EXIT
;
3080 ControlFlag
= CfExit
;
3084 switch (Key
.UnicodeChar
) {
3085 case CHAR_CARRIAGE_RETURN
:
3086 if(MenuOption
== NULL
|| MenuOption
->GrayOut
|| MenuOption
->ReadOnly
) {
3087 ControlFlag
= CfReadKey
;
3091 ScreenOperation
= UiSelect
;
3096 // We will push the adjustment of these numeric values directly to the input handler
3097 // NOTE: we won't handle manual input numeric
3102 // If the screen has no menu items, and the user didn't select UiReset
3103 // ignore the selection and go back to reading keys.
3105 ASSERT(MenuOption
!= NULL
);
3106 if(IsListEmpty (&gMenuOption
) || MenuOption
->GrayOut
|| MenuOption
->ReadOnly
) {
3107 ControlFlag
= CfReadKey
;
3111 Statement
= MenuOption
->ThisTag
;
3112 if ((Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
)
3113 || (Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
)
3114 || ((Statement
->OpCode
->OpCode
== EFI_IFR_NUMERIC_OP
) && (GetFieldFromNum(Statement
->OpCode
) != 0))
3116 if (Key
.UnicodeChar
== '+') {
3117 gDirection
= SCAN_RIGHT
;
3119 gDirection
= SCAN_LEFT
;
3122 Status
= ProcessOptions (MenuOption
, TRUE
, &OptionString
, TRUE
);
3123 if (OptionString
!= NULL
) {
3124 FreePool (OptionString
);
3126 if (EFI_ERROR (Status
)) {
3128 // Repaint to clear possible error prompt pop-up
3133 ControlFlag
= CfExit
;
3139 ScreenOperation
= UiUp
;
3144 ScreenOperation
= UiDown
;
3148 if(IsListEmpty (&gMenuOption
)) {
3149 ControlFlag
= CfReadKey
;
3153 ASSERT(MenuOption
!= NULL
);
3154 if (MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_CHECKBOX_OP
&& !MenuOption
->GrayOut
&& !MenuOption
->ReadOnly
) {
3155 ScreenOperation
= UiSelect
;
3161 if (!MultiHelpPage
) {
3162 ControlFlag
= CfReadKey
;
3165 ControlFlag
= CfUpdateHelpString
;
3166 HelpPageIndex
= HelpPageIndex
< HelpPageCount
- 1 ? HelpPageIndex
+ 1 : HelpPageCount
- 1;
3171 if (!MultiHelpPage
) {
3172 ControlFlag
= CfReadKey
;
3175 ControlFlag
= CfUpdateHelpString
;
3176 HelpPageIndex
= HelpPageIndex
> 0 ? HelpPageIndex
- 1 : 0;
3180 for (Index
= 0; Index
< mScanCodeNumber
; Index
++) {
3181 if (Key
.ScanCode
== gScanCodeToOperation
[Index
].ScanCode
) {
3182 ScreenOperation
= gScanCodeToOperation
[Index
].ScreenOperation
;
3187 if (((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) && (Key
.ScanCode
== SCAN_ESC
|| Index
== mScanCodeNumber
)) {
3189 // ModalForm has no ESC key and Hot Key.
3191 ControlFlag
= CfReadKey
;
3192 } else if (Index
== mScanCodeNumber
) {
3194 // Check whether Key matches the registered hot key.
3197 HotKey
= GetHotKeyFromRegisterList (&Key
);
3198 if (HotKey
!= NULL
) {
3199 ScreenOperation
= UiHotKey
;
3206 case CfScreenOperation
:
3207 if ((ScreenOperation
!= UiReset
) && (ScreenOperation
!= UiHotKey
)) {
3209 // If the screen has no menu items, and the user didn't select UiReset or UiHotKey
3210 // ignore the selection and go back to reading keys.
3212 if (IsListEmpty (&gMenuOption
)) {
3213 ControlFlag
= CfReadKey
;
3219 Index
< sizeof (gScreenOperationToControlFlag
) / sizeof (gScreenOperationToControlFlag
[0]);
3222 if (ScreenOperation
== gScreenOperationToControlFlag
[Index
].ScreenOperation
) {
3223 ControlFlag
= gScreenOperationToControlFlag
[Index
].ControlFlag
;
3230 ControlFlag
= CfRepaint
;
3232 ASSERT(MenuOption
!= NULL
);
3233 Statement
= MenuOption
->ThisTag
;
3234 if (Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) {
3238 switch (Statement
->OpCode
->OpCode
) {
3239 case EFI_IFR_REF_OP
:
3240 case EFI_IFR_ACTION_OP
:
3241 case EFI_IFR_RESET_BUTTON_OP
:
3242 ControlFlag
= CfExit
;
3247 // Editable Questions: oneof, ordered list, checkbox, numeric, string, password
3249 RefreshKeyHelp (gFormData
, Statement
, TRUE
);
3250 Status
= ProcessOptions (MenuOption
, TRUE
, &OptionString
, TRUE
);
3252 if (OptionString
!= NULL
) {
3253 FreePool (OptionString
);
3256 if (EFI_ERROR (Status
)) {
3259 RefreshKeyHelp (gFormData
, Statement
, FALSE
);
3262 ControlFlag
= CfExit
;
3270 // We come here when someone press ESC
3271 // If the policy is not exit front page when user press ESC, process here.
3273 if (!FormExitPolicy()) {
3276 ControlFlag
= CfRepaint
;
3280 gUserInput
->Action
= BROWSER_ACTION_FORM_EXIT
;
3281 ControlFlag
= CfExit
;
3285 ControlFlag
= CfRepaint
;
3287 ASSERT (HotKey
!= NULL
);
3289 if (FxConfirmPopup(HotKey
->Action
)) {
3290 gUserInput
->Action
= HotKey
->Action
;
3291 if ((HotKey
->Action
& BROWSER_ACTION_DEFAULT
) == BROWSER_ACTION_DEFAULT
) {
3292 gUserInput
->DefaultId
= HotKey
->DefaultId
;
3294 ControlFlag
= CfExit
;
3298 ControlFlag
= CfRepaint
;
3304 ControlFlag
= CfRepaint
;
3305 ASSERT(MenuOption
!= NULL
);
3306 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_DATE_OP
) || (MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_TIME_OP
)) {
3307 if (MenuOption
->Sequence
!= 0) {
3309 // In the middle or tail of the Date/Time op-code set, go left.
3311 ASSERT(NewPos
!= NULL
);
3312 NewPos
= NewPos
->BackLink
;
3318 ControlFlag
= CfRepaint
;
3319 ASSERT(MenuOption
!= NULL
);
3320 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_DATE_OP
) || (MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_TIME_OP
)) {
3321 if (MenuOption
->Sequence
!= 2) {
3323 // In the middle or tail of the Date/Time op-code set, go left.
3325 ASSERT(NewPos
!= NULL
);
3326 NewPos
= NewPos
->ForwardLink
;
3332 ControlFlag
= CfRepaint
;
3335 SavedListEntry
= NewPos
;
3336 ASSERT(NewPos
!= NULL
);
3338 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
3339 ASSERT (MenuOption
!= NULL
);
3342 // Adjust Date/Time position before we advance forward.
3344 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3346 NewPos
= NewPos
->BackLink
;
3348 // Find next selectable menu or the first menu beyond current form.
3350 Difference
= MoveToNextStatement (TRUE
, &NewPos
, MenuOption
->Row
- TopRow
, FALSE
);
3351 if (Difference
< 0) {
3353 // We hit the begining MenuOption that can be focused
3354 // so we simply scroll to the top.
3357 if (TopOfScreen
!= gMenuOption
.ForwardLink
|| SkipValue
!= 0) {
3358 TopOfScreen
= gMenuOption
.ForwardLink
;
3359 NewPos
= SavedListEntry
;
3363 // Scroll up to the last page when we have arrived at top page.
3365 TopOfScreen
= FindTopOfScreenMenu (gMenuOption
.BackLink
, BottomRow
- TopRow
, &SkipValue
);
3366 NewPos
= gMenuOption
.BackLink
;
3367 MoveToNextStatement (TRUE
, &NewPos
, BottomRow
- TopRow
, TRUE
);
3370 NextMenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
3372 if (MenuOption
->Row
< TopRow
+ Difference
+ NextMenuOption
->Skip
) {
3374 // Previous focus MenuOption is above the TopOfScreen, so we need to scroll
3376 TopOfScreen
= NewPos
;
3382 // Check whether new highlight menu is selectable, if not, keep highlight on the old one.
3384 // BottomRow - TopRow + 1 means the total rows current forms supported.
3385 // Difference + NextMenuOption->Skip + 1 means the distance between last highlight menu
3386 // and new top menu. New top menu will all shows in next form, but last highlight menu
3387 // may only shows 1 line. + 1 at right part means at least need to keep 1 line for the
3388 // last highlight menu.
3390 if (!IsSelectable(NextMenuOption
) && IsSelectable(MenuOption
) &&
3391 (BottomRow
- TopRow
+ 1 >= Difference
+ NextMenuOption
->Skip
+ 1)) {
3392 NewPos
= SavedListEntry
;
3396 UpdateStatusBar (INPUT_ERROR
, FALSE
);
3399 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.
3401 AdjustDateAndTimePosition (TRUE
, &TopOfScreen
);
3402 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3404 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
3409 // SkipValue means lines is skipped when show the top menu option.
3411 ControlFlag
= CfRepaint
;
3417 // First minus the menu of the top screen, it's value is SkipValue.
3419 if (SkipValue
>= BottomRow
- TopRow
+ 1) {
3421 // SkipValue > (BottomRow - TopRow + 1) means current menu has more than one
3422 // form of options to be show, so just update the SkipValue to show the next
3423 // parts of options.
3425 SkipValue
-= BottomRow
- TopRow
+ 1;
3426 NewPos
= TopOfScreen
;
3429 Index
= (BottomRow
+ 1) - SkipValue
- TopRow
;
3432 TopOfScreen
= FindTopOfScreenMenu(TopOfScreen
, Index
, &SkipValue
);
3433 NewPos
= TopOfScreen
;
3434 MoveToNextStatement (FALSE
, &NewPos
, BottomRow
- TopRow
, FALSE
);
3436 UpdateStatusBar (INPUT_ERROR
, FALSE
);
3439 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.
3440 // Don't do this when we are already in the first page.
3442 AdjustDateAndTimePosition (TRUE
, &TopOfScreen
);
3443 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3445 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
3450 // SkipValue means lines is skipped when show the top menu option.
3452 ControlFlag
= CfRepaint
;
3457 NextMenuOption
= MENU_OPTION_FROM_LINK (Link
);
3458 Index
= TopRow
+ NextMenuOption
->Skip
- SkipValue
;
3460 // Count to the menu option which will show at the top of the next form.
3462 while ((Index
<= BottomRow
+ 1) && (Link
->ForwardLink
!= &gMenuOption
)) {
3463 Link
= Link
->ForwardLink
;
3464 NextMenuOption
= MENU_OPTION_FROM_LINK (Link
);
3465 Index
= Index
+ NextMenuOption
->Skip
;
3468 if ((Link
->ForwardLink
== &gMenuOption
) && (Index
<= BottomRow
+ 1)) {
3470 // Highlight on the last menu which can be highlight.
3473 MoveToNextStatement (TRUE
, &Link
, Index
- TopRow
, TRUE
);
3476 // Calculate the skip line for top of screen menu.
3478 if (Link
== TopOfScreen
) {
3480 // The top of screen menu option occupies the entire form.
3482 SkipValue
+= BottomRow
- TopRow
+ 1;
3484 SkipValue
= NextMenuOption
->Skip
- (Index
- (BottomRow
+ 1));
3489 // Move to the Next selectable menu.
3491 MoveToNextStatement (FALSE
, &Link
, BottomRow
- TopRow
, TRUE
);
3495 // Save the menu as the next highlight menu.
3499 UpdateStatusBar (INPUT_ERROR
, FALSE
);
3502 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.
3503 // Don't do this when we are already in the last page.
3505 AdjustDateAndTimePosition (TRUE
, &TopOfScreen
);
3506 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3508 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
3513 // SkipValue means lines is skipped when show the top menu option.
3514 // NewPos points to the menu which is highlighted now.
3516 ControlFlag
= CfRepaint
;
3519 if (NewPos
== TopOfScreen
) {
3525 SavedListEntry
= NewPos
;
3527 // Since the behavior of hitting the down arrow on a Date/Time op-code is intended
3528 // to be one that progresses to the next set of op-codes, we need to advance to the last
3529 // Date/Time op-code and leave the remaining logic in UiDown intact so the appropriate
3530 // checking can be done. The only other logic we need to introduce is that if a Date/Time
3531 // op-code is the last entry in the menu, we need to rewind back to the first op-code of
3532 // the Date/Time op-code.
3534 AdjustDateAndTimePosition (FALSE
, &NewPos
);
3536 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
3537 NewPos
= NewPos
->ForwardLink
;
3539 // Find the next selectable menu.
3541 if (MenuOption
->Row
+ MenuOption
->Skip
- Temp2
> BottomRow
+ 1) {
3542 if (gMenuOption
.ForwardLink
== NewPos
|| &gMenuOption
== NewPos
) {
3548 Difference
= MoveToNextStatement (FALSE
, &NewPos
, BottomRow
+ 1 - (MenuOption
->Row
+ MenuOption
->Skip
- Temp2
), FALSE
);
3550 if (Difference
< 0) {
3552 // Scroll to the first page.
3554 if (TopOfScreen
!= gMenuOption
.ForwardLink
|| SkipValue
!= 0) {
3555 TopOfScreen
= gMenuOption
.ForwardLink
;
3559 MenuOption
= MENU_OPTION_FROM_LINK (SavedListEntry
);
3561 NewPos
= gMenuOption
.ForwardLink
;
3562 MoveToNextStatement (FALSE
, &NewPos
, BottomRow
- TopRow
, TRUE
);
3566 // If we are at the end of the list and sitting on a Date/Time op, rewind to the head.
3568 AdjustDateAndTimePosition (TRUE
, &TopOfScreen
);
3569 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3571 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
3576 // Get next selected menu info.
3578 AdjustDateAndTimePosition (FALSE
, &NewPos
);
3579 NextMenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
3580 if (NextMenuOption
->Row
== 0) {
3581 UpdateOptionSkipLines (NextMenuOption
);
3585 // Calculate new highlight menu end row.
3587 Temp
= (MenuOption
->Row
+ MenuOption
->Skip
- Temp2
) + Difference
+ NextMenuOption
->Skip
- 1;
3588 if (Temp
> BottomRow
) {
3590 // Get the top screen menu info.
3592 AdjustDateAndTimePosition (FALSE
, &TopOfScreen
);
3593 SavedMenuOption
= MENU_OPTION_FROM_LINK (TopOfScreen
);
3596 // Current Top screen menu occupy (SavedMenuOption->Skip - SkipValue) rows.
3597 // Full shows the new selected menu need to skip (Temp - BottomRow - 1) rows.
3599 if ((Temp
- BottomRow
) >= (SavedMenuOption
->Skip
- SkipValue
)) {
3601 // Skip the top op-code
3603 TopOfScreen
= TopOfScreen
->ForwardLink
;
3604 DistanceValue
= (Temp
- BottomRow
) - (SavedMenuOption
->Skip
- SkipValue
);
3606 SavedMenuOption
= MENU_OPTION_FROM_LINK (TopOfScreen
);
3609 // If we have a remainder, skip that many more op-codes until we drain the remainder
3610 // Special case is the selected highlight menu has more than one form of menus.
3612 while (DistanceValue
>= SavedMenuOption
->Skip
&& TopOfScreen
!= NewPos
) {
3614 // Since the Difference is greater than or equal to this op-code's skip value, skip it
3616 DistanceValue
= DistanceValue
- (INTN
) SavedMenuOption
->Skip
;
3617 TopOfScreen
= TopOfScreen
->ForwardLink
;
3618 SavedMenuOption
= MENU_OPTION_FROM_LINK (TopOfScreen
);
3621 // Since we will act on this op-code in the next routine, and increment the
3622 // SkipValue, set the skips to one less than what is required.
3624 if (TopOfScreen
!= NewPos
) {
3625 SkipValue
= DistanceValue
;
3631 // Since we will act on this op-code in the next routine, and increment the
3632 // SkipValue, set the skips to one less than what is required.
3634 SkipValue
+= Temp
- BottomRow
;
3637 } else if (!IsSelectable (NextMenuOption
)) {
3639 // Continue to go down until scroll to next page or the selectable option is found.
3641 ScreenOperation
= UiDown
;
3642 ControlFlag
= CfScreenOperation
;
3646 MenuOption
= MENU_OPTION_FROM_LINK (SavedListEntry
);
3649 // Check whether new highlight menu is selectable, if not, keep highlight on the old one.
3651 // BottomRow - TopRow + 1 means the total rows current forms supported.
3652 // Difference + NextMenuOption->Skip + 1 means the distance between last highlight menu
3653 // and new top menu. New top menu will all shows in next form, but last highlight menu
3654 // may only shows 1 line. + 1 at right part means at least need to keep 1 line for the
3655 // last highlight menu.
3657 if (!IsSelectable (NextMenuOption
) && IsSelectable (MenuOption
) &&
3658 (BottomRow
- TopRow
+ 1 >= Difference
+ NextMenuOption
->Skip
+ 1)) {
3659 NewPos
= SavedListEntry
;
3662 UpdateStatusBar (INPUT_ERROR
, FALSE
);
3665 // If we are at the end of the list and sitting on a Date/Time op, rewind to the head.
3667 AdjustDateAndTimePosition (TRUE
, &TopOfScreen
);
3668 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3670 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
3673 case CfUiNoOperation
:
3674 ControlFlag
= CfRepaint
;
3678 gST
->ConOut
->SetAttribute (gST
->ConOut
, EFI_TEXT_ATTR (EFI_LIGHTGRAY
, EFI_BLACK
));
3679 if (HelpString
!= NULL
) {
3680 FreePool (HelpString
);
3682 if (HelpHeaderString
!= NULL
) {
3683 FreePool (HelpHeaderString
);
3685 if (HelpBottomString
!= NULL
) {
3686 FreePool (HelpBottomString
);
3698 Base on the browser status info to show an pop up message.
3702 BrowserStatusProcess (
3708 EFI_EVENT WaitList
[2];
3709 EFI_EVENT RefreshIntervalEvent
;
3710 EFI_EVENT TimeOutEvent
;
3714 WARNING_IF_CONTEXT EventContext
;
3715 EFI_IFR_OP_HEADER
*OpCodeBuf
;
3716 EFI_STRING_ID StringToken
;
3717 CHAR16 DiscardChange
;
3718 CHAR16 JumpToFormSet
;
3719 CHAR16
*PrintString
;
3721 if (gFormData
->BrowserStatus
== BROWSER_SUCCESS
) {
3726 TimeOutEvent
= NULL
;
3727 RefreshIntervalEvent
= NULL
;
3729 if (gFormData
->HighLightedStatement
!= NULL
) {
3730 OpCodeBuf
= gFormData
->HighLightedStatement
->OpCode
;
3733 if (gFormData
->BrowserStatus
== (BROWSER_WARNING_IF
)) {
3734 ASSERT (OpCodeBuf
!= NULL
&& OpCodeBuf
->OpCode
== EFI_IFR_WARNING_IF_OP
);
3736 TimeOut
= ((EFI_IFR_WARNING_IF
*) OpCodeBuf
)->TimeOut
;
3737 StringToken
= ((EFI_IFR_WARNING_IF
*) OpCodeBuf
)->Warning
;
3740 if ((gFormData
->BrowserStatus
== (BROWSER_NO_SUBMIT_IF
)) &&
3741 (OpCodeBuf
!= NULL
&& OpCodeBuf
->OpCode
== EFI_IFR_NO_SUBMIT_IF_OP
)) {
3742 StringToken
= ((EFI_IFR_NO_SUBMIT_IF
*) OpCodeBuf
)->Error
;
3743 } else if ((gFormData
->BrowserStatus
== (BROWSER_INCONSISTENT_IF
)) &&
3744 (OpCodeBuf
!= NULL
&& OpCodeBuf
->OpCode
== EFI_IFR_INCONSISTENT_IF_OP
)) {
3745 StringToken
= ((EFI_IFR_INCONSISTENT_IF
*) OpCodeBuf
)->Error
;
3749 if (StringToken
!= 0) {
3750 ErrorInfo
= GetToken (StringToken
, gFormData
->HiiHandle
);
3751 } else if (gFormData
->ErrorString
!= NULL
) {
3753 // Only used to compatible with old setup browser.
3754 // Not use this field in new browser core.
3756 ErrorInfo
= gFormData
->ErrorString
;
3758 switch (gFormData
->BrowserStatus
) {
3759 case BROWSER_SUBMIT_FAIL
:
3760 ErrorInfo
= gSaveFailed
;
3763 case BROWSER_FORM_NOT_FOUND
:
3764 ErrorInfo
= gFormNotFound
;
3767 case BROWSER_FORM_SUPPRESS
:
3768 ErrorInfo
= gFormSuppress
;
3771 case BROWSER_PROTOCOL_NOT_FOUND
:
3772 ErrorInfo
= gProtocolNotFound
;
3775 case BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF
:
3776 ErrorInfo
= gNoSubmitIfFailed
;
3780 ErrorInfo
= gBrwoserError
;
3785 switch (gFormData
->BrowserStatus
) {
3786 case BROWSER_SUBMIT_FAIL
:
3787 case BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF
:
3788 ASSERT (gUserInput
!= NULL
);
3789 if (gFormData
->BrowserStatus
== (BROWSER_SUBMIT_FAIL
)) {
3790 PrintString
= gSaveProcess
;
3791 JumpToFormSet
= gJumpToFormSet
[0];
3793 PrintString
= gSaveNoSubmitProcess
;
3794 JumpToFormSet
= gCheckError
[0];
3796 DiscardChange
= gDiscardChange
[0];
3799 CreateDialog (&Key
, gEmptyString
, ErrorInfo
, PrintString
, gEmptyString
, NULL
);
3800 } while (((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (DiscardChange
| UPPER_LOWER_CASE_OFFSET
)) &&
3801 ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (JumpToFormSet
| UPPER_LOWER_CASE_OFFSET
)));
3803 if ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) == (DiscardChange
| UPPER_LOWER_CASE_OFFSET
)) {
3804 gUserInput
->Action
= BROWSER_ACTION_DISCARD
;
3806 gUserInput
->Action
= BROWSER_ACTION_GOTO
;
3813 CreateDialog (&Key
, gEmptyString
, ErrorInfo
, gPressEnter
, gEmptyString
, NULL
);
3814 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
3816 Status
= gBS
->CreateEvent (EVT_NOTIFY_WAIT
, TPL_CALLBACK
, EmptyEventProcess
, NULL
, &TimeOutEvent
);
3817 ASSERT_EFI_ERROR (Status
);
3819 EventContext
.SyncEvent
= TimeOutEvent
;
3820 EventContext
.TimeOut
= &TimeOut
;
3821 EventContext
.ErrorInfo
= ErrorInfo
;
3823 Status
= gBS
->CreateEvent (EVT_TIMER
| EVT_NOTIFY_SIGNAL
, TPL_CALLBACK
, RefreshTimeOutProcess
, &EventContext
, &RefreshIntervalEvent
);
3824 ASSERT_EFI_ERROR (Status
);
3827 // Show the dialog first to avoid long time not reaction.
3829 gBS
->SignalEvent (RefreshIntervalEvent
);
3831 Status
= gBS
->SetTimer (RefreshIntervalEvent
, TimerPeriodic
, ONE_SECOND
);
3832 ASSERT_EFI_ERROR (Status
);
3835 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3836 if (!EFI_ERROR (Status
) && Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3840 if (Status
!= EFI_NOT_READY
) {
3844 WaitList
[0] = TimeOutEvent
;
3845 WaitList
[1] = gST
->ConIn
->WaitForKey
;
3847 Status
= gBS
->WaitForEvent (2, WaitList
, &Index
);
3848 ASSERT_EFI_ERROR (Status
);
3852 // Timeout occur, close the hoot time out event.
3858 gBS
->CloseEvent (TimeOutEvent
);
3859 gBS
->CloseEvent (RefreshIntervalEvent
);
3864 if (StringToken
!= 0) {
3865 FreePool (ErrorInfo
);
3870 Display one form, and return user input.
3872 @param FormData Form Data to be shown.
3873 @param UserInputData User input data.
3875 @retval EFI_SUCCESS 1.Form Data is shown, and user input is got.
3876 2.Error info has show and return.
3877 @retval EFI_INVALID_PARAMETER The input screen dimension is not valid
3878 @retval EFI_NOT_FOUND New form data has some error.
3883 IN FORM_DISPLAY_ENGINE_FORM
*FormData
,
3884 OUT USER_INPUT
*UserInputData
3889 ASSERT (FormData
!= NULL
);
3890 if (FormData
== NULL
) {
3891 return EFI_INVALID_PARAMETER
;
3894 gUserInput
= UserInputData
;
3895 gFormData
= FormData
;
3898 // Process the status info first.
3900 BrowserStatusProcess();
3901 if (gFormData
->BrowserStatus
!= BROWSER_SUCCESS
) {
3903 // gFormData->BrowserStatus != BROWSER_SUCCESS, means only need to print the error info, return here.
3908 Status
= DisplayPageFrame (FormData
, &gStatementDimensions
);
3909 if (EFI_ERROR (Status
)) {
3914 // Global Widths should be initialized before any MenuOption creation
3915 // or the GetWidth() used in UiAddMenuOption() will return incorrect value.
3919 // |<-.->|<-.........->|<- .........->|<-...........->|
3920 // Skip Prompt Option Help
3922 gOptionBlockWidth
= (CHAR16
) ((gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
) / 3) + 1;
3923 gHelpBlockWidth
= (CHAR16
) (gOptionBlockWidth
- 1 - LEFT_SKIPPED_COLUMNS
);
3924 gPromptBlockWidth
= (CHAR16
) (gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
- 2 * (gOptionBlockWidth
- 1) - 1);
3926 ConvertStatementToMenu();
3929 // Check whether layout is changed.
3932 || (gOldFormEntry
.HiiHandle
!= FormData
->HiiHandle
)
3933 || (!CompareGuid (&gOldFormEntry
.FormSetGuid
, &FormData
->FormSetGuid
))
3934 || (gOldFormEntry
.FormId
!= FormData
->FormId
)) {
3935 mStatementLayoutIsChanged
= TRUE
;
3937 mStatementLayoutIsChanged
= FALSE
;
3940 Status
= UiDisplayMenu(FormData
);
3943 // Backup last form info.
3945 mIsFirstForm
= FALSE
;
3946 gOldFormEntry
.HiiHandle
= FormData
->HiiHandle
;
3947 CopyGuid (&gOldFormEntry
.FormSetGuid
, &FormData
->FormSetGuid
);
3948 gOldFormEntry
.FormId
= FormData
->FormId
;
3954 Clear Screen to the initial state.
3958 DriverClearDisplayPage (
3962 ClearDisplayPage ();
3963 mIsFirstForm
= TRUE
;
3967 Set Buffer to Value for Size bytes.
3969 @param Buffer Memory to set.
3970 @param Size Number of bytes to set
3971 @param Value Value of the set operation.
3984 while ((Size
--) != 0) {
3990 Initialize Setup Browser driver.
3992 @param ImageHandle The image handle.
3993 @param SystemTable The system table.
3995 @retval EFI_SUCCESS The Setup Browser module is initialized correctly..
3996 @return Other value if failed to initialize the Setup Browser module.
4001 InitializeDisplayEngine (
4002 IN EFI_HANDLE ImageHandle
,
4003 IN EFI_SYSTEM_TABLE
*SystemTable
4007 EFI_INPUT_KEY HotKey
;
4008 EFI_STRING NewString
;
4009 EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL
*FormBrowserEx2
;
4012 // Publish our HII data
4014 gHiiHandle
= HiiAddPackages (
4015 &gDisplayEngineGuid
,
4017 DisplayEngineStrings
,
4020 ASSERT (gHiiHandle
!= NULL
);
4023 // Install Form Display protocol
4025 Status
= gBS
->InstallProtocolInterface (
4026 &mPrivateData
.Handle
,
4027 &gEdkiiFormDisplayEngineProtocolGuid
,
4028 EFI_NATIVE_INTERFACE
,
4029 &mPrivateData
.FromDisplayProt
4031 ASSERT_EFI_ERROR (Status
);
4033 InitializeDisplayStrings();
4035 ZeroMem (&gHighligthMenuInfo
, sizeof (gHighligthMenuInfo
));
4036 ZeroMem (&gOldFormEntry
, sizeof (gOldFormEntry
));
4039 // Use BrowserEx2 protocol to register HotKey.
4041 Status
= gBS
->LocateProtocol (&gEdkiiFormBrowserEx2ProtocolGuid
, NULL
, (VOID
**) &FormBrowserEx2
);
4042 if (!EFI_ERROR (Status
)) {
4044 // Register the default HotKey F9 and F10 again.
4046 HotKey
.UnicodeChar
= CHAR_NULL
;
4047 HotKey
.ScanCode
= SCAN_F10
;
4048 NewString
= HiiGetString (gHiiHandle
, STRING_TOKEN (FUNCTION_TEN_STRING
), NULL
);
4049 ASSERT (NewString
!= NULL
);
4050 FormBrowserEx2
->RegisterHotKey (&HotKey
, BROWSER_ACTION_SUBMIT
, 0, NewString
);
4052 HotKey
.ScanCode
= SCAN_F9
;
4053 NewString
= HiiGetString (gHiiHandle
, STRING_TOKEN (FUNCTION_NINE_STRING
), NULL
);
4054 ASSERT (NewString
!= NULL
);
4055 FormBrowserEx2
->RegisterHotKey (&HotKey
, BROWSER_ACTION_DEFAULT
, EFI_HII_DEFAULT_CLASS_STANDARD
, NewString
);
4062 This is the default unload handle for display core drivers.
4064 @param[in] ImageHandle The drivers' driver image.
4066 @retval EFI_SUCCESS The image is unloaded.
4067 @retval Others Failed to unload the image.
4072 UnloadDisplayEngine (
4073 IN EFI_HANDLE ImageHandle
4076 HiiRemovePackages(gHiiHandle
);
4078 FreeDisplayStrings ();
4080 if (gHighligthMenuInfo
.HLTOpCode
!= NULL
) {
4081 FreePool (gHighligthMenuInfo
.HLTOpCode
);
4084 if (gHighligthMenuInfo
.TOSOpCode
!= NULL
) {
4085 FreePool (gHighligthMenuInfo
.TOSOpCode
);