2 Entry and initialization module for the browser.
4 Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>
5 Copyright (c) 2014, Hewlett-Packard Development Company, L.P.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "FormDisplay.h"
19 // Search table for UiDisplayMenu()
21 SCAN_CODE_TO_SCREEN_OPERATION gScanCodeToOperation
[] = {
52 UINTN mScanCodeNumber
= sizeof (gScanCodeToOperation
) / sizeof (gScanCodeToOperation
[0]);
54 SCREEN_OPERATION_T0_CONTROL_FLAG gScreenOperationToControlFlag
[] = {
97 EFI_GUID gDisplayEngineGuid
= {
98 0xE38C1029, 0xE38F, 0x45b9, {0x8F, 0x0D, 0xE2, 0xE6, 0x0B, 0xC9, 0xB2, 0x62}
102 EFI_SCREEN_DESCRIPTOR gStatementDimensions
;
103 BOOLEAN mStatementLayoutIsChanged
= TRUE
;
104 USER_INPUT
*gUserInput
;
105 FORM_DISPLAY_ENGINE_FORM
*gFormData
;
106 EFI_HII_HANDLE gHiiHandle
;
108 LIST_ENTRY gMenuOption
;
109 DISPLAY_HIGHLIGHT_MENU_INFO gHighligthMenuInfo
= {0};
110 BOOLEAN mIsFirstForm
= TRUE
;
111 FORM_ENTRY_INFO gOldFormEntry
= {0};
114 // Browser Global Strings
116 CHAR16
*gReconnectConfirmChanges
;
117 CHAR16
*gReconnectFail
;
118 CHAR16
*gReconnectRequired
;
120 CHAR16
*gFormNotFound
;
122 CHAR16
*gBrowserError
;
124 CHAR16
*gNoSubmitIfFailed
;
125 CHAR16
*gSaveProcess
;
126 CHAR16
*gSaveNoSubmitProcess
;
127 CHAR16
*gDiscardChange
;
128 CHAR16
*gJumpToFormSet
;
130 CHAR16
*gPromptForData
;
131 CHAR16
*gPromptForPassword
;
132 CHAR16
*gPromptForNewPassword
;
133 CHAR16
*gConfirmPassword
;
134 CHAR16
*gConfirmError
;
135 CHAR16
*gPassowordInvalid
;
137 CHAR16
*gEmptyString
;
139 CHAR16
*gOptionMismatch
;
140 CHAR16
*gFormSuppress
;
141 CHAR16
*gProtocolNotFound
;
142 CHAR16
*gConfirmDefaultMsg
;
143 CHAR16
*gConfirmSubmitMsg
;
144 CHAR16
*gConfirmDiscardMsg
;
145 CHAR16
*gConfirmResetMsg
;
146 CHAR16
*gConfirmExitMsg
;
147 CHAR16
*gConfirmSubmitMsg2nd
;
148 CHAR16
*gConfirmDefaultMsg2nd
;
149 CHAR16
*gConfirmResetMsg2nd
;
150 CHAR16
*gConfirmExitMsg2nd
;
152 CHAR16
*gConfirmOptYes
;
153 CHAR16
*gConfirmOptNo
;
154 CHAR16
*gConfirmMsgConnect
;
155 CHAR16
*gConfirmMsgEnd
;
156 CHAR16 gModalSkipColumn
;
157 CHAR16 gPromptBlockWidth
;
158 CHAR16 gOptionBlockWidth
;
159 CHAR16 gHelpBlockWidth
;
160 CHAR16
*mUnknownString
;
162 FORM_DISPLAY_DRIVER_PRIVATE_DATA mPrivateData
= {
163 FORM_DISPLAY_DRIVER_SIGNATURE
,
167 DriverClearDisplayPage
,
174 Get the string based on the StringId and HII Package List Handle.
176 @param Token The String's ID.
177 @param HiiHandle The package list in the HII database to search for
178 the specified string.
180 @return The output string.
185 IN EFI_STRING_ID Token
,
186 IN EFI_HII_HANDLE HiiHandle
191 String
= HiiGetString (HiiHandle
, Token
, NULL
);
192 if (String
== NULL
) {
193 String
= AllocateCopyPool (StrSize (mUnknownString
), mUnknownString
);
194 ASSERT (String
!= NULL
);
197 return (CHAR16
*) String
;
202 Initialize the HII String Token to the correct values.
206 InitializeDisplayStrings (
210 gReconnectConfirmChanges
= GetToken (STRING_TOKEN (RECONNECT_CONFIRM_CHANGES
), gHiiHandle
);
211 mUnknownString
= GetToken (STRING_TOKEN (UNKNOWN_STRING
), gHiiHandle
);
212 gSaveFailed
= GetToken (STRING_TOKEN (SAVE_FAILED
), gHiiHandle
);
213 gNoSubmitIfFailed
= GetToken (STRING_TOKEN (NO_SUBMIT_IF_CHECK_FAILED
), gHiiHandle
);
214 gReconnectFail
= GetToken (STRING_TOKEN (RECONNECT_FAILED
), gHiiHandle
);
215 gReconnectRequired
= GetToken (STRING_TOKEN (RECONNECT_REQUIRED
), gHiiHandle
);
216 gChangesOpt
= GetToken (STRING_TOKEN (RECONNECT_CHANGES_OPTIONS
), gHiiHandle
);
217 gSaveProcess
= GetToken (STRING_TOKEN (DISCARD_OR_JUMP
), gHiiHandle
);
218 gSaveNoSubmitProcess
= GetToken (STRING_TOKEN (DISCARD_OR_CHECK
), gHiiHandle
);
219 gDiscardChange
= GetToken (STRING_TOKEN (DISCARD_OR_JUMP_DISCARD
), gHiiHandle
);
220 gJumpToFormSet
= GetToken (STRING_TOKEN (DISCARD_OR_JUMP_JUMP
), gHiiHandle
);
221 gCheckError
= GetToken (STRING_TOKEN (DISCARD_OR_CHECK_CHECK
), gHiiHandle
);
222 gPromptForData
= GetToken (STRING_TOKEN (PROMPT_FOR_DATA
), gHiiHandle
);
223 gPromptForPassword
= GetToken (STRING_TOKEN (PROMPT_FOR_PASSWORD
), gHiiHandle
);
224 gPromptForNewPassword
= GetToken (STRING_TOKEN (PROMPT_FOR_NEW_PASSWORD
), gHiiHandle
);
225 gConfirmPassword
= GetToken (STRING_TOKEN (CONFIRM_PASSWORD
), gHiiHandle
);
226 gConfirmError
= GetToken (STRING_TOKEN (CONFIRM_ERROR
), gHiiHandle
);
227 gPassowordInvalid
= GetToken (STRING_TOKEN (PASSWORD_INVALID
), gHiiHandle
);
228 gPressEnter
= GetToken (STRING_TOKEN (PRESS_ENTER
), gHiiHandle
);
229 gEmptyString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
230 gMiniString
= GetToken (STRING_TOKEN (MINI_STRING
), gHiiHandle
);
231 gOptionMismatch
= GetToken (STRING_TOKEN (OPTION_MISMATCH
), gHiiHandle
);
232 gFormSuppress
= GetToken (STRING_TOKEN (FORM_SUPPRESSED
), gHiiHandle
);
233 gProtocolNotFound
= GetToken (STRING_TOKEN (PROTOCOL_NOT_FOUND
), gHiiHandle
);
234 gFormNotFound
= GetToken (STRING_TOKEN (STATUS_BROWSER_FORM_NOT_FOUND
), gHiiHandle
);
235 gNoSubmitIf
= GetToken (STRING_TOKEN (STATUS_BROWSER_NO_SUBMIT_IF
), gHiiHandle
);
236 gBrowserError
= GetToken (STRING_TOKEN (STATUS_BROWSER_ERROR
), gHiiHandle
);
237 gConfirmDefaultMsg
= GetToken (STRING_TOKEN (CONFIRM_DEFAULT_MESSAGE
), gHiiHandle
);
238 gConfirmDiscardMsg
= GetToken (STRING_TOKEN (CONFIRM_DISCARD_MESSAGE
), gHiiHandle
);
239 gConfirmSubmitMsg
= GetToken (STRING_TOKEN (CONFIRM_SUBMIT_MESSAGE
), gHiiHandle
);
240 gConfirmResetMsg
= GetToken (STRING_TOKEN (CONFIRM_RESET_MESSAGE
), gHiiHandle
);
241 gConfirmExitMsg
= GetToken (STRING_TOKEN (CONFIRM_EXIT_MESSAGE
), gHiiHandle
);
242 gConfirmDefaultMsg2nd
= GetToken (STRING_TOKEN (CONFIRM_DEFAULT_MESSAGE_2ND
), gHiiHandle
);
243 gConfirmSubmitMsg2nd
= GetToken (STRING_TOKEN (CONFIRM_SUBMIT_MESSAGE_2ND
), gHiiHandle
);
244 gConfirmResetMsg2nd
= GetToken (STRING_TOKEN (CONFIRM_RESET_MESSAGE_2ND
), gHiiHandle
);
245 gConfirmExitMsg2nd
= GetToken (STRING_TOKEN (CONFIRM_EXIT_MESSAGE_2ND
), gHiiHandle
);
246 gConfirmOpt
= GetToken (STRING_TOKEN (CONFIRM_OPTION
), gHiiHandle
);
247 gConfirmOptYes
= GetToken (STRING_TOKEN (CONFIRM_OPTION_YES
), gHiiHandle
);
248 gConfirmOptNo
= GetToken (STRING_TOKEN (CONFIRM_OPTION_NO
), gHiiHandle
);
249 gConfirmMsgConnect
= GetToken (STRING_TOKEN (CONFIRM_OPTION_CONNECT
), gHiiHandle
);
250 gConfirmMsgEnd
= GetToken (STRING_TOKEN (CONFIRM_OPTION_END
), gHiiHandle
);
254 Free up the resource allocated for all strings required
263 FreePool (mUnknownString
);
264 FreePool (gEmptyString
);
265 FreePool (gSaveFailed
);
266 FreePool (gNoSubmitIfFailed
);
267 FreePool (gReconnectFail
);
268 FreePool (gReconnectRequired
);
269 FreePool (gChangesOpt
);
270 FreePool (gReconnectConfirmChanges
);
271 FreePool (gSaveProcess
);
272 FreePool (gSaveNoSubmitProcess
);
273 FreePool (gDiscardChange
);
274 FreePool (gJumpToFormSet
);
275 FreePool (gCheckError
);
276 FreePool (gPromptForData
);
277 FreePool (gPromptForPassword
);
278 FreePool (gPromptForNewPassword
);
279 FreePool (gConfirmPassword
);
280 FreePool (gConfirmError
);
281 FreePool (gPassowordInvalid
);
282 FreePool (gPressEnter
);
283 FreePool (gMiniString
);
284 FreePool (gOptionMismatch
);
285 FreePool (gFormSuppress
);
286 FreePool (gProtocolNotFound
);
287 FreePool (gBrowserError
);
288 FreePool (gNoSubmitIf
);
289 FreePool (gFormNotFound
);
290 FreePool (gConfirmDefaultMsg
);
291 FreePool (gConfirmSubmitMsg
);
292 FreePool (gConfirmDiscardMsg
);
293 FreePool (gConfirmResetMsg
);
294 FreePool (gConfirmExitMsg
);
295 FreePool (gConfirmDefaultMsg2nd
);
296 FreePool (gConfirmSubmitMsg2nd
);
297 FreePool (gConfirmResetMsg2nd
);
298 FreePool (gConfirmExitMsg2nd
);
299 FreePool (gConfirmOpt
);
300 FreePool (gConfirmOptYes
);
301 FreePool (gConfirmOptNo
);
302 FreePool (gConfirmMsgConnect
);
303 FreePool (gConfirmMsgEnd
);
307 Get prompt string id from the opcode data buffer.
309 @param OpCode The input opcode buffer.
311 @return The prompt string id.
316 IN EFI_IFR_OP_HEADER
*OpCode
319 EFI_IFR_STATEMENT_HEADER
*Header
;
321 if (OpCode
->Length
<= sizeof (EFI_IFR_OP_HEADER
)) {
325 Header
= (EFI_IFR_STATEMENT_HEADER
*) (OpCode
+ 1);
327 return Header
->Prompt
;
331 Get the supported width for a particular op-code
333 @param MenuOption The menu option.
334 @param AdjustWidth The width which is saved for the space.
336 @return Returns the number of CHAR16 characters that is support.
341 IN UI_MENU_OPTION
*MenuOption
,
342 OUT UINT16
*AdjustWidth
347 EFI_IFR_TEXT
*TestOp
;
349 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
351 Statement
= MenuOption
->ThisTag
;
354 // For modal form, clean the entire row.
356 if ((gFormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
357 if (AdjustWidth
!= NULL
) {
358 *AdjustWidth
= LEFT_SKIPPED_COLUMNS
;
360 return (UINT16
)(gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
- 2 * (gModalSkipColumn
+ LEFT_SKIPPED_COLUMNS
));
366 // See if the second text parameter is really NULL
368 if (Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) {
369 TestOp
= (EFI_IFR_TEXT
*) Statement
->OpCode
;
370 if (TestOp
->TextTwo
!= 0) {
371 String
= GetToken (TestOp
->TextTwo
, gFormData
->HiiHandle
);
372 Size
= StrLen (String
);
377 if ((Statement
->OpCode
->OpCode
== EFI_IFR_SUBTITLE_OP
) ||
378 (Statement
->OpCode
->OpCode
== EFI_IFR_REF_OP
) ||
379 (Statement
->OpCode
->OpCode
== EFI_IFR_PASSWORD_OP
) ||
380 (Statement
->OpCode
->OpCode
== EFI_IFR_ACTION_OP
) ||
381 (Statement
->OpCode
->OpCode
== EFI_IFR_RESET_BUTTON_OP
) ||
383 // Allow a wide display if text op-code and no secondary text op-code
385 ((Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) && (Size
== 0))
389 // Return the space width.
391 if (AdjustWidth
!= NULL
) {
395 // Keep consistent with current behavior.
397 ReturnWidth
= (UINT16
) (gPromptBlockWidth
+ gOptionBlockWidth
- 2);
399 if (AdjustWidth
!= NULL
) {
403 ReturnWidth
= (UINT16
) (gPromptBlockWidth
- 1);
407 // For nest in statement, should the subtitle indent.
409 if (MenuOption
->NestInStatement
) {
410 ReturnWidth
-= SUBTITLE_INDENT
;
417 Will copy LineWidth amount of a string in the OutputString buffer and return the
418 number of CHAR16 characters that were copied into the OutputString buffer.
419 The output string format is:
420 Glyph Info + String info + '\0'.
422 In the code, it deals \r,\n,\r\n same as \n\r, also it not process the \r or \g.
424 @param InputString String description for this option.
425 @param LineWidth Width of the desired string to extract in CHAR16
427 @param GlyphWidth The glyph width of the begin of the char in the string.
428 @param Index Where in InputString to start the copy process
429 @param OutputString Buffer to copy the string into
431 @return Returns the number of CHAR16 characters that were copied into the OutputString
432 buffer, include extra glyph info and '\0' info.
437 IN CHAR16
*InputString
,
439 IN OUT UINT16
*GlyphWidth
,
441 OUT CHAR16
**OutputString
446 UINT16 OriginalGlyphWidth
;
448 UINT16 LastSpaceOffset
;
449 UINT16 LastGlyphWidth
;
451 if (InputString
== NULL
|| Index
== NULL
|| OutputString
== NULL
) {
455 if (LineWidth
== 0 || *GlyphWidth
== 0) {
460 // Save original glyph width.
462 OriginalGlyphWidth
= *GlyphWidth
;
463 LastGlyphWidth
= OriginalGlyphWidth
;
468 // NARROW_CHAR can not be printed in screen, so if a line only contain the two CHARs: 'NARROW_CHAR + CHAR_CARRIAGE_RETURN' , it is a empty line in Screen.
469 // To avoid displaying this empty line in screen, just skip the two CHARs here.
471 if ((InputString
[*Index
] == NARROW_CHAR
) && (InputString
[*Index
+ 1] == CHAR_CARRIAGE_RETURN
)) {
476 // Fast-forward the string and see if there is a carriage-return in the string
478 for (StrOffset
= 0, GlyphOffset
= 0; GlyphOffset
<= LineWidth
; StrOffset
++) {
479 switch (InputString
[*Index
+ StrOffset
]) {
488 case CHAR_CARRIAGE_RETURN
:
495 GlyphOffset
= GlyphOffset
+ *GlyphWidth
;
498 // Record the last space info in this line. Will be used in rewind.
500 if ((InputString
[*Index
+ StrOffset
] == CHAR_SPACE
) && (GlyphOffset
<= LineWidth
)) {
501 LastSpaceOffset
= StrOffset
;
502 LastGlyphWidth
= *GlyphWidth
;
513 // Rewind the string from the maximum size until we see a space to break the line
515 if (GlyphOffset
> LineWidth
) {
517 // Rewind the string to last space char in this line.
519 if (LastSpaceOffset
!= 0) {
520 StrOffset
= LastSpaceOffset
;
521 *GlyphWidth
= LastGlyphWidth
;
524 // Roll back to last char in the line width.
531 // The CHAR_NULL has process last time, this time just return 0 to stand for the end.
533 if (StrOffset
== 0 && (InputString
[*Index
+ StrOffset
] == CHAR_NULL
)) {
538 // Need extra glyph info and '\0' info, so +2.
540 *OutputString
= AllocateZeroPool (((UINTN
) (StrOffset
+ 2) * sizeof(CHAR16
)));
541 if (*OutputString
== NULL
) {
546 // Save the glyph info at the begin of the string, will used by Print function.
548 if (OriginalGlyphWidth
== 1) {
549 *(*OutputString
) = NARROW_CHAR
;
551 *(*OutputString
) = WIDE_CHAR
;
554 CopyMem ((*OutputString
) + 1, &InputString
[*Index
], StrOffset
* sizeof(CHAR16
));
556 if (InputString
[*Index
+ StrOffset
] == CHAR_SPACE
) {
558 // Skip the space info at the begin of next line.
560 *Index
= (UINT16
) (*Index
+ StrOffset
+ 1);
561 } else if (InputString
[*Index
+ StrOffset
] == CHAR_LINEFEED
) {
563 // Skip the /n or /n/r info.
565 if (InputString
[*Index
+ StrOffset
+ 1] == CHAR_CARRIAGE_RETURN
) {
566 *Index
= (UINT16
) (*Index
+ StrOffset
+ 2);
568 *Index
= (UINT16
) (*Index
+ StrOffset
+ 1);
570 } else if (InputString
[*Index
+ StrOffset
] == CHAR_CARRIAGE_RETURN
) {
572 // Skip the /r or /r/n info.
574 if (InputString
[*Index
+ StrOffset
+ 1] == CHAR_LINEFEED
) {
575 *Index
= (UINT16
) (*Index
+ StrOffset
+ 2);
577 *Index
= (UINT16
) (*Index
+ StrOffset
+ 1);
580 *Index
= (UINT16
) (*Index
+ StrOffset
);
584 // Include extra glyph info and '\0' info, so +2.
586 return StrOffset
+ 2;
590 Add one menu option by specified description and context.
592 @param Statement Statement of this Menu Option.
593 @param MenuItemCount The index for this Option in the Menu.
594 @param NestIn Whether this statement is nest in another statement.
599 IN FORM_DISPLAY_ENGINE_STATEMENT
*Statement
,
600 IN UINT16
*MenuItemCount
,
604 UI_MENU_OPTION
*MenuOption
;
608 UINT16 NumberOfLines
;
612 CHAR16
*OutputString
;
613 EFI_STRING_ID PromptId
;
621 PromptId
= GetPrompt (Statement
->OpCode
);
622 ASSERT (PromptId
!= 0);
624 String
= GetToken (PromptId
, gFormData
->HiiHandle
);
625 ASSERT (String
!= NULL
);
627 if (Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
|| Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
) {
631 for (Index
= 0; Index
< Count
; Index
++) {
632 MenuOption
= AllocateZeroPool (sizeof (UI_MENU_OPTION
));
635 MenuOption
->Signature
= UI_MENU_OPTION_SIGNATURE
;
636 MenuOption
->Description
= String
;
637 MenuOption
->Handle
= gFormData
->HiiHandle
;
638 MenuOption
->ThisTag
= Statement
;
639 MenuOption
->NestInStatement
= NestIn
;
640 MenuOption
->EntryNumber
= *MenuItemCount
;
642 MenuOption
->Sequence
= Index
;
644 if ((Statement
->Attribute
& HII_DISPLAY_GRAYOUT
) != 0) {
645 MenuOption
->GrayOut
= TRUE
;
647 MenuOption
->GrayOut
= FALSE
;
650 if ((Statement
->Attribute
& HII_DISPLAY_LOCK
) != 0 || (gFormData
->Attribute
& HII_DISPLAY_LOCK
) != 0) {
651 MenuOption
->GrayOut
= TRUE
;
655 // If the form or the question has the lock attribute, deal same as grayout.
657 if ((gFormData
->Attribute
& HII_DISPLAY_LOCK
) != 0 || (Statement
->Attribute
& HII_DISPLAY_LOCK
) != 0) {
658 MenuOption
->GrayOut
= TRUE
;
661 switch (Statement
->OpCode
->OpCode
) {
662 case EFI_IFR_ORDERED_LIST_OP
:
663 case EFI_IFR_ONE_OF_OP
:
664 case EFI_IFR_NUMERIC_OP
:
665 case EFI_IFR_TIME_OP
:
666 case EFI_IFR_DATE_OP
:
667 case EFI_IFR_CHECKBOX_OP
:
668 case EFI_IFR_PASSWORD_OP
:
669 case EFI_IFR_STRING_OP
:
671 // User could change the value of these items
673 MenuOption
->IsQuestion
= TRUE
;
675 case EFI_IFR_TEXT_OP
:
676 if (FeaturePcdGet (PcdBrowserGrayOutTextStatement
)) {
678 // Initializing GrayOut option as TRUE for Text setup options
679 // so that those options will be Gray in colour and un selectable.
681 MenuOption
->GrayOut
= TRUE
;
685 MenuOption
->IsQuestion
= FALSE
;
689 if ((Statement
->Attribute
& HII_DISPLAY_READONLY
) != 0) {
690 MenuOption
->ReadOnly
= TRUE
;
691 if (FeaturePcdGet (PcdBrowerGrayOutReadOnlyMenu
)) {
692 MenuOption
->GrayOut
= TRUE
;
697 (Statement
->OpCode
->OpCode
!= EFI_IFR_DATE_OP
) &&
698 (Statement
->OpCode
->OpCode
!= EFI_IFR_TIME_OP
)) {
699 Width
= GetWidth (MenuOption
, NULL
);
700 for (; GetLineByWidth (String
, Width
, &GlyphWidth
,&ArrayEntry
, &OutputString
) != 0x0000;) {
702 // If there is more string to process print on the next row and increment the Skip value
704 if (StrLen (&String
[ArrayEntry
]) != 0) {
707 FreePool (OutputString
);
711 // Add three MenuOptions for Date/Time
712 // Data format : [01/02/2004] [11:22:33]
713 // Line number : 0 0 1 0 0 1
720 // Override LineNumber for the MenuOption in Date/Time sequence
722 MenuOption
->Skip
= 1;
724 MenuOption
->Skip
= NumberOfLines
;
727 InsertTailList (&gMenuOption
, &MenuOption
->Link
);
734 Create the menu list base on the form data info.
738 ConvertStatementToMenu (
742 UINT16 MenuItemCount
;
744 LIST_ENTRY
*NestLink
;
745 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
746 FORM_DISPLAY_ENGINE_STATEMENT
*NestStatement
;
749 InitializeListHead (&gMenuOption
);
751 Link
= GetFirstNode (&gFormData
->StatementListHead
);
752 while (!IsNull (&gFormData
->StatementListHead
, Link
)) {
753 Statement
= FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK (Link
);
754 Link
= GetNextNode (&gFormData
->StatementListHead
, Link
);
757 // Skip the opcode not recognized by Display core.
759 if (Statement
->OpCode
->OpCode
== EFI_IFR_GUID_OP
) {
763 UiAddMenuOption (Statement
, &MenuItemCount
, FALSE
);
766 // Check the statement nest in this host statement.
768 NestLink
= GetFirstNode (&Statement
->NestStatementList
);
769 while (!IsNull (&Statement
->NestStatementList
, NestLink
)) {
770 NestStatement
= FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK (NestLink
);
771 NestLink
= GetNextNode (&Statement
->NestStatementList
, NestLink
);
774 // Skip the opcode not recognized by Display core.
776 if (NestStatement
->OpCode
->OpCode
== EFI_IFR_GUID_OP
) {
780 UiAddMenuOption (NestStatement
, &MenuItemCount
, TRUE
);
786 Count the storage space of a Unicode string.
788 This function handles the Unicode string with NARROW_CHAR
789 and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR
790 does not count in the resultant output. If a WIDE_CHAR is
791 hit, then 2 Unicode character will consume an output storage
792 space with size of CHAR16 till a NARROW_CHAR is hit.
794 If String is NULL, then ASSERT ().
796 @param String The input string to be counted.
798 @return Storage space for the input string.
808 UINTN IncrementValue
;
810 ASSERT (String
!= NULL
);
811 if (String
== NULL
) {
821 // Advance to the null-terminator or to the first width directive
824 (String
[Index
] != NARROW_CHAR
) && (String
[Index
] != WIDE_CHAR
) && (String
[Index
] != 0);
825 Index
++, Count
= Count
+ IncrementValue
830 // We hit the null-terminator, we now have a count
832 if (String
[Index
] == 0) {
836 // We encountered a narrow directive - strip it from the size calculation since it doesn't get printed
837 // and also set the flag that determines what we increment by.(if narrow, increment by 1, if wide increment by 2)
839 if (String
[Index
] == NARROW_CHAR
) {
841 // Skip to the next character
847 // Skip to the next character
852 } while (String
[Index
] != 0);
855 // Increment by one to include the null-terminator in the size
859 return Count
* sizeof (CHAR16
);
863 Base on the input option string to update the skip value for a menu option.
865 @param MenuOption The MenuOption to be checked.
866 @param OptionString The input option string.
870 UpdateSkipInfoForMenu (
871 IN UI_MENU_OPTION
*MenuOption
,
872 IN CHAR16
*OptionString
878 CHAR16
*OutputString
;
881 Width
= (UINT16
) gOptionBlockWidth
;
885 for (Index
= 0; GetLineByWidth (OptionString
, Width
, &GlyphWidth
, &Index
, &OutputString
) != 0x0000;) {
886 if (StrLen (&OptionString
[Index
]) != 0) {
890 FreePool (OutputString
);
893 if ((Row
> MenuOption
->Skip
) &&
894 (MenuOption
->ThisTag
->OpCode
->OpCode
!= EFI_IFR_DATE_OP
) &&
895 (MenuOption
->ThisTag
->OpCode
->OpCode
!= EFI_IFR_TIME_OP
)) {
896 MenuOption
->Skip
= Row
;
901 Update display lines for a Menu Option.
903 @param MenuOption The MenuOption to be checked.
907 UpdateOptionSkipLines (
908 IN UI_MENU_OPTION
*MenuOption
911 CHAR16
*OptionString
;
915 ProcessOptions (MenuOption
, FALSE
, &OptionString
, TRUE
);
916 if (OptionString
!= NULL
) {
917 UpdateSkipInfoForMenu (MenuOption
, OptionString
);
919 FreePool (OptionString
);
922 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) && (((EFI_IFR_TEXT
*)MenuOption
->ThisTag
->OpCode
)->TextTwo
!= 0)) {
923 OptionString
= GetToken (((EFI_IFR_TEXT
*)MenuOption
->ThisTag
->OpCode
)->TextTwo
, gFormData
->HiiHandle
);
925 if (OptionString
!= NULL
) {
926 UpdateSkipInfoForMenu (MenuOption
, OptionString
);
928 FreePool (OptionString
);
934 Check whether this Menu Option could be print.
936 Check Prompt string, option string or text two string not NULL.
938 This is an internal function.
940 @param MenuOption The MenuOption to be checked.
942 @retval TRUE This Menu Option is printable.
943 @retval FALSE This Menu Option could not be printable.
948 UI_MENU_OPTION
*MenuOption
952 EFI_STRING OptionString
;
956 if (MenuOption
->Description
[0] != '\0') {
960 Status
= ProcessOptions (MenuOption
, FALSE
, &OptionString
, FALSE
);
961 if (EFI_ERROR (Status
)) {
964 if (OptionString
!= NULL
&& OptionString
[0] != '\0') {
965 FreePool (OptionString
);
969 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) && (((EFI_IFR_TEXT
*)MenuOption
->ThisTag
->OpCode
)->TextTwo
!= 0)) {
970 OptionString
= GetToken (((EFI_IFR_TEXT
*)MenuOption
->ThisTag
->OpCode
)->TextTwo
, gFormData
->HiiHandle
);
971 ASSERT (OptionString
!= NULL
);
972 if (OptionString
[0] != '\0'){
973 FreePool (OptionString
);
982 Check whether this Menu Option could be highlighted.
984 This is an internal function.
986 @param MenuOption The MenuOption to be checked.
988 @retval TRUE This Menu Option is selectable.
989 @retval FALSE This Menu Option could not be selected.
994 UI_MENU_OPTION
*MenuOption
997 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_SUBTITLE_OP
) ||
998 MenuOption
->GrayOut
|| MenuOption
->ReadOnly
|| !PrintableMenu (MenuOption
)) {
1006 Move to next selectable statement.
1008 This is an internal function.
1010 @param GoUp The navigation direction. TRUE: up, FALSE: down.
1011 @param CurrentPosition Current position.
1012 @param GapToTop Gap position to top or bottom.
1013 @param FindInForm Whether find menu in current form or beyond.
1015 @return The row distance from current MenuOption to next selectable MenuOption.
1017 @retval -1 Reach the begin of the menu, still can't find the selectable menu.
1018 @retval Value Find the selectable menu, maybe the truly selectable, maybe the
1019 first menu showing beyond current form or last menu showing in
1021 The value is the line number between the new selected menu and the
1022 current select menu, not include the new selected menu.
1026 MoveToNextStatement (
1028 IN OUT LIST_ENTRY
**CurrentPosition
,
1030 IN BOOLEAN FindInForm
1035 UI_MENU_OPTION
*NextMenuOption
;
1036 UI_MENU_OPTION
*PreMenuOption
;
1039 Pos
= *CurrentPosition
;
1041 if (Pos
== &gMenuOption
) {
1045 PreMenuOption
= MENU_OPTION_FROM_LINK (Pos
);
1048 NextMenuOption
= MENU_OPTION_FROM_LINK (Pos
);
1050 // NextMenuOption->Row == 0 means this menu has not calculate
1051 // the NextMenuOption->Skip value yet, just calculate here.
1053 if (NextMenuOption
->Row
== 0) {
1054 UpdateOptionSkipLines (NextMenuOption
);
1057 if (IsSelectable (NextMenuOption
)) {
1062 // In this case, still can't find the selectable menu,
1063 // return the first one beyond the showing form.
1065 if ((UINTN
) Distance
+ NextMenuOption
->Skip
> GapToTop
) {
1067 NextMenuOption
= PreMenuOption
;
1072 Distance
+= NextMenuOption
->Skip
;
1075 // Arrive at begin of the menu list.
1077 if ((GoUp
? Pos
->BackLink
: Pos
->ForwardLink
) == &gMenuOption
) {
1082 Pos
= (GoUp
? Pos
->BackLink
: Pos
->ForwardLink
);
1083 PreMenuOption
= NextMenuOption
;
1086 *CurrentPosition
= &NextMenuOption
->Link
;
1092 Process option string for date/time opcode.
1094 @param MenuOption Menu option point to date/time.
1095 @param OptionString Option string input for process.
1096 @param AddOptCol Whether need to update MenuOption->OptCol.
1100 ProcessStringForDateTime (
1101 UI_MENU_OPTION
*MenuOption
,
1102 CHAR16
*OptionString
,
1108 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
1112 ASSERT (MenuOption
!= NULL
&& OptionString
!= NULL
);
1114 Statement
= MenuOption
->ThisTag
;
1117 if (Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
) {
1118 Date
= (EFI_IFR_DATE
*) Statement
->OpCode
;
1119 } else if (Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
) {
1120 Time
= (EFI_IFR_TIME
*) Statement
->OpCode
;
1124 // If leading spaces on OptionString - remove the spaces
1126 for (Index
= 0; OptionString
[Index
] == L
' '; Index
++) {
1128 // Base on the blockspace to get the option column info.
1131 MenuOption
->OptCol
++;
1135 for (Count
= 0; OptionString
[Index
] != CHAR_NULL
; Index
++) {
1136 OptionString
[Count
] = OptionString
[Index
];
1139 OptionString
[Count
] = CHAR_NULL
;
1142 // Enable to suppress field in the opcode base on the flag.
1144 if (Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
) {
1146 // OptionString format is: <**: **: ****>
1150 if ((Date
->Flags
& EFI_QF_DATE_MONTH_SUPPRESS
) && (MenuOption
->Sequence
== 0)) {
1152 // At this point, only "<**:" in the optionstring.
1153 // Clean the day's ** field, after clean, the format is "< :"
1155 SetUnicodeMem (&OptionString
[1], 2, L
' ');
1156 } else if ((Date
->Flags
& EFI_QF_DATE_DAY_SUPPRESS
) && (MenuOption
->Sequence
== 1)) {
1158 // At this point, only "**:" in the optionstring.
1159 // Clean the month's "**" field, after clean, the format is " :"
1161 SetUnicodeMem (&OptionString
[0], 2, L
' ');
1162 } else if ((Date
->Flags
& EFI_QF_DATE_YEAR_SUPPRESS
) && (MenuOption
->Sequence
== 2)) {
1164 // At this point, only "****>" in the optionstring.
1165 // Clean the year's "****" field, after clean, the format is " >"
1167 SetUnicodeMem (&OptionString
[0], 4, L
' ');
1169 } else if (Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
) {
1171 // OptionString format is: <**: **: **>
1172 // |hour|minute|second|
1175 if ((Time
->Flags
& QF_TIME_HOUR_SUPPRESS
) && (MenuOption
->Sequence
== 0)) {
1177 // At this point, only "<**:" in the optionstring.
1178 // Clean the hour's ** field, after clean, the format is "< :"
1180 SetUnicodeMem (&OptionString
[1], 2, L
' ');
1181 } else if ((Time
->Flags
& QF_TIME_MINUTE_SUPPRESS
) && (MenuOption
->Sequence
== 1)) {
1183 // At this point, only "**:" in the optionstring.
1184 // Clean the minute's "**" field, after clean, the format is " :"
1186 SetUnicodeMem (&OptionString
[0], 2, L
' ');
1187 } else if ((Time
->Flags
& QF_TIME_SECOND_SUPPRESS
) && (MenuOption
->Sequence
== 2)) {
1189 // At this point, only "**>" in the optionstring.
1190 // Clean the second's "**" field, after clean, the format is " >"
1192 SetUnicodeMem (&OptionString
[0], 2, L
' ');
1199 Adjust Data and Time position accordingly.
1200 Data format : [01/02/2004] [11:22:33]
1201 Line number : 0 0 1 0 0 1
1203 This is an internal function.
1205 @param DirectionUp the up or down direction. False is down. True is
1207 @param CurrentPosition Current position. On return: Point to the last
1208 Option (Year or Second) if up; Point to the first
1209 Option (Month or Hour) if down.
1211 @return Return line number to pad. It is possible that we stand on a zero-advance
1212 @return data or time opcode, so pad one line when we judge if we are going to scroll outside.
1216 AdjustDateAndTimePosition (
1217 IN BOOLEAN DirectionUp
,
1218 IN OUT LIST_ENTRY
**CurrentPosition
1222 LIST_ENTRY
*NewPosition
;
1223 UI_MENU_OPTION
*MenuOption
;
1224 UINTN PadLineNumber
;
1227 NewPosition
= *CurrentPosition
;
1228 MenuOption
= MENU_OPTION_FROM_LINK (NewPosition
);
1230 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_DATE_OP
) ||
1231 (MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_TIME_OP
)) {
1233 // Calculate the distance from current position to the last Date/Time MenuOption
1236 while (MenuOption
->Skip
== 0) {
1238 NewPosition
= NewPosition
->ForwardLink
;
1239 MenuOption
= MENU_OPTION_FROM_LINK (NewPosition
);
1243 NewPosition
= *CurrentPosition
;
1246 // Since the behavior of hitting the up arrow on a Date/Time MenuOption is intended
1247 // to be one that back to the previous set of MenuOptions, we need to advance to the first
1248 // Date/Time MenuOption and leave the remaining logic in CfUiUp intact so the appropriate
1249 // checking can be done.
1251 while (Count
++ < 2) {
1252 NewPosition
= NewPosition
->BackLink
;
1256 // Since the behavior of hitting the down arrow on a Date/Time MenuOption is intended
1257 // to be one that progresses to the next set of MenuOptions, we need to advance to the last
1258 // Date/Time MenuOption and leave the remaining logic in CfUiDown intact so the appropriate
1259 // checking can be done.
1261 while (Count
-- > 0) {
1262 NewPosition
= NewPosition
->ForwardLink
;
1266 *CurrentPosition
= NewPosition
;
1269 return PadLineNumber
;
1273 Get step info from numeric opcode.
1275 @param[in] OpCode The input numeric op code.
1277 @return step info for this opcode.
1281 IN EFI_IFR_OP_HEADER
*OpCode
1284 EFI_IFR_NUMERIC
*NumericOp
;
1287 NumericOp
= (EFI_IFR_NUMERIC
*) OpCode
;
1289 switch (NumericOp
->Flags
& EFI_IFR_NUMERIC_SIZE
) {
1290 case EFI_IFR_NUMERIC_SIZE_1
:
1291 Step
= NumericOp
->data
.u8
.Step
;
1294 case EFI_IFR_NUMERIC_SIZE_2
:
1295 Step
= NumericOp
->data
.u16
.Step
;
1298 case EFI_IFR_NUMERIC_SIZE_4
:
1299 Step
= NumericOp
->data
.u32
.Step
;
1302 case EFI_IFR_NUMERIC_SIZE_8
:
1303 Step
= NumericOp
->data
.u64
.Step
;
1315 Find the registered HotKey based on KeyData.
1317 @param[in] KeyData A pointer to a buffer that describes the keystroke
1318 information for the hot key.
1320 @return The registered HotKey context. If no found, NULL will return.
1323 GetHotKeyFromRegisterList (
1324 IN EFI_INPUT_KEY
*KeyData
1328 BROWSER_HOT_KEY
*HotKey
;
1330 Link
= GetFirstNode (&gFormData
->HotKeyListHead
);
1331 while (!IsNull (&gFormData
->HotKeyListHead
, Link
)) {
1332 HotKey
= BROWSER_HOT_KEY_FROM_LINK (Link
);
1334 if (HotKey
->KeyData
->ScanCode
== KeyData
->ScanCode
) {
1338 Link
= GetNextNode (&gFormData
->HotKeyListHead
, Link
);
1346 Determine if the menu is the last menu that can be selected.
1348 This is an internal function.
1350 @param Direction The scroll direction. False is down. True is up.
1351 @param CurrentPos The current focus.
1353 @return FALSE -- the menu isn't the last menu that can be selected.
1354 @return TRUE -- the menu is the last menu that can be selected.
1359 IN BOOLEAN Direction
,
1360 IN LIST_ENTRY
*CurrentPos
1365 Temp
= Direction
? CurrentPos
->BackLink
: CurrentPos
->ForwardLink
;
1367 if (Temp
== &gMenuOption
) {
1375 Wait for a given event to fire, or for an optional timeout to expire.
1377 @param Event The event to wait for
1379 @retval UI_EVENT_TYPE The type of the event which is trigged.
1391 EFI_EVENT TimerEvent
;
1392 EFI_EVENT WaitList
[3];
1393 UI_EVENT_TYPE EventType
;
1396 Timeout
= FormExitTimeout(gFormData
);
1399 Status
= gBS
->CreateEvent (EVT_TIMER
, 0, NULL
, NULL
, &TimerEvent
);
1402 // Set the timer event
1411 WaitList
[0] = Event
;
1413 if (gFormData
->FormRefreshEvent
!= NULL
) {
1414 WaitList
[EventNum
] = gFormData
->FormRefreshEvent
;
1419 WaitList
[EventNum
] = TimerEvent
;
1423 Status
= gBS
->WaitForEvent (EventNum
, WaitList
, &Index
);
1424 ASSERT_EFI_ERROR (Status
);
1428 EventType
= UIEventKey
;
1432 if (gFormData
->FormRefreshEvent
!= NULL
) {
1433 EventType
= UIEventDriver
;
1435 ASSERT (Timeout
!= 0 && EventNum
== 2);
1436 EventType
= UIEventTimeOut
;
1441 ASSERT (Index
== 2 && EventNum
== 3);
1442 EventType
= UIEventTimeOut
;
1447 gBS
->CloseEvent (TimerEvent
);
1454 Get question id info from the input opcode header.
1456 @param OpCode The input opcode header pointer.
1458 @retval The question id for this opcode.
1463 IN EFI_IFR_OP_HEADER
*OpCode
1466 EFI_IFR_QUESTION_HEADER
*QuestionHeader
;
1468 if (OpCode
->Length
< sizeof (EFI_IFR_OP_HEADER
) + sizeof (EFI_IFR_QUESTION_HEADER
)) {
1472 QuestionHeader
= (EFI_IFR_QUESTION_HEADER
*)((UINT8
*) OpCode
+ sizeof(EFI_IFR_OP_HEADER
));
1474 return QuestionHeader
->QuestionId
;
1479 Find the top of screen menu base on the current menu.
1481 @param CurPos Current input menu.
1482 @param Rows Totol screen rows.
1483 @param SkipValue SkipValue for this new form.
1485 @retval TopOfScreen Top of screen menu for the new form.
1489 FindTopOfScreenMenu (
1490 IN LIST_ENTRY
*CurPos
,
1492 OUT UINTN
*SkipValue
1496 LIST_ENTRY
*TopOfScreen
;
1497 UI_MENU_OPTION
*PreviousMenuOption
;
1500 PreviousMenuOption
= NULL
;
1502 while (Link
->BackLink
!= &gMenuOption
) {
1503 Link
= Link
->BackLink
;
1504 PreviousMenuOption
= MENU_OPTION_FROM_LINK (Link
);
1505 if (PreviousMenuOption
->Row
== 0) {
1506 UpdateOptionSkipLines (PreviousMenuOption
);
1508 if (Rows
<= PreviousMenuOption
->Skip
) {
1511 Rows
= Rows
- PreviousMenuOption
->Skip
;
1514 if (Link
->BackLink
== &gMenuOption
) {
1515 TopOfScreen
= gMenuOption
.ForwardLink
;
1516 if (PreviousMenuOption
!= NULL
&& Rows
< PreviousMenuOption
->Skip
) {
1517 *SkipValue
= PreviousMenuOption
->Skip
- Rows
;
1523 *SkipValue
= PreviousMenuOption
->Skip
- Rows
;
1530 Get the index info for this opcode.
1532 @param OpCode The input opcode for the statement.
1534 @retval The index of this statement.
1538 GetIndexInfoForOpcode (
1539 IN EFI_IFR_OP_HEADER
*OpCode
1543 UI_MENU_OPTION
*MenuOption
;
1546 NewPos
= gMenuOption
.ForwardLink
;
1549 for (NewPos
= gMenuOption
.ForwardLink
; NewPos
!= &gMenuOption
; NewPos
= NewPos
->ForwardLink
){
1550 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1552 if (CompareMem (MenuOption
->ThisTag
->OpCode
, OpCode
, OpCode
->Length
) == 0) {
1553 if (MenuOption
->ThisTag
->OpCode
== OpCode
) {
1565 Is this the saved highlight statement.
1567 @param HighLightedStatement The input highlight statement.
1569 @retval TRUE This is the highlight statement.
1570 @retval FALSE This is not the highlight statement.
1574 IsSavedHighlightStatement (
1575 IN FORM_DISPLAY_ENGINE_STATEMENT
*HighLightedStatement
1578 if ((gFormData
->HiiHandle
== gHighligthMenuInfo
.HiiHandle
) &&
1579 (gFormData
->FormId
== gHighligthMenuInfo
.FormId
)) {
1580 if (gHighligthMenuInfo
.HLTQuestionId
!= 0) {
1581 return (BOOLEAN
) (gHighligthMenuInfo
.HLTQuestionId
== GetQuestionIdInfo (HighLightedStatement
->OpCode
));
1583 if (CompareMem (gHighligthMenuInfo
.HLTOpCode
, HighLightedStatement
->OpCode
, gHighligthMenuInfo
.HLTOpCode
->Length
) == 0) {
1584 if (gHighligthMenuInfo
.HLTIndex
== 0 || gHighligthMenuInfo
.HLTIndex
== GetIndexInfoForOpcode(HighLightedStatement
->OpCode
)) {
1597 Is this the highlight menu.
1599 @param MenuOption The input Menu option.
1601 @retval TRUE This is the highlight menu option.
1602 @retval FALSE This is not the highlight menu option.
1606 IsHighLightMenuOption (
1607 IN UI_MENU_OPTION
*MenuOption
1610 if (gHighligthMenuInfo
.HLTQuestionId
!= 0) {
1611 if (GetQuestionIdInfo(MenuOption
->ThisTag
->OpCode
) == gHighligthMenuInfo
.HLTQuestionId
) {
1612 return (BOOLEAN
) (MenuOption
->Sequence
== gHighligthMenuInfo
.HLTSequence
);
1615 if(CompareMem (gHighligthMenuInfo
.HLTOpCode
, MenuOption
->ThisTag
->OpCode
, gHighligthMenuInfo
.HLTOpCode
->Length
) == 0) {
1616 if (gHighligthMenuInfo
.HLTIndex
== 0 || gHighligthMenuInfo
.HLTIndex
== GetIndexInfoForOpcode(MenuOption
->ThisTag
->OpCode
)) {
1617 return (BOOLEAN
) (MenuOption
->Sequence
== gHighligthMenuInfo
.HLTSequence
);
1628 Find the highlight menu.
1630 If the input is NULL, base on the record highlight info in
1631 gHighligthMenuInfo to find the last highlight menu.
1633 @param HighLightedStatement The input highlight statement.
1635 @retval The highlight menu index.
1639 FindHighLightMenuOption (
1640 IN FORM_DISPLAY_ENGINE_STATEMENT
*HighLightedStatement
1644 UI_MENU_OPTION
*MenuOption
;
1646 NewPos
= gMenuOption
.ForwardLink
;
1647 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1649 if (HighLightedStatement
!= NULL
) {
1650 while (MenuOption
->ThisTag
!= HighLightedStatement
) {
1651 NewPos
= NewPos
->ForwardLink
;
1652 if (NewPos
== &gMenuOption
) {
1654 // Not Found it, break
1658 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1662 // Must find the highlight statement.
1664 ASSERT (NewPos
!= &gMenuOption
);
1667 while (!IsHighLightMenuOption (MenuOption
)) {
1668 NewPos
= NewPos
->ForwardLink
;
1669 if (NewPos
== &gMenuOption
) {
1671 // Not Found it, break
1675 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1679 // Highlight statement has disappear (suppressed/disableed)
1681 if (NewPos
== &gMenuOption
) {
1690 Is this the Top of screen menu.
1692 @param MenuOption The input Menu option.
1694 @retval TRUE This is the Top of screen menu option.
1695 @retval FALSE This is not the Top of screen menu option.
1699 IsTopOfScreeMenuOption (
1700 IN UI_MENU_OPTION
*MenuOption
1703 if (gHighligthMenuInfo
.TOSQuestionId
!= 0) {
1704 return (BOOLEAN
) (GetQuestionIdInfo(MenuOption
->ThisTag
->OpCode
) == gHighligthMenuInfo
.TOSQuestionId
);
1707 if(CompareMem (gHighligthMenuInfo
.TOSOpCode
, MenuOption
->ThisTag
->OpCode
, gHighligthMenuInfo
.TOSOpCode
->Length
) == 0) {
1708 if (gHighligthMenuInfo
.TOSIndex
== 0 || gHighligthMenuInfo
.TOSIndex
== GetIndexInfoForOpcode(MenuOption
->ThisTag
->OpCode
)) {
1719 Find the Top of screen menu.
1721 If the input is NULL, base on the record highlight info in
1722 gHighligthMenuInfo to find the last highlight menu.
1724 @param HighLightedStatement The input highlight statement.
1726 @retval The highlight menu index.
1730 FindTopOfScreenMenuOption (
1735 UI_MENU_OPTION
*MenuOption
;
1737 NewPos
= gMenuOption
.ForwardLink
;
1738 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1740 while (!IsTopOfScreeMenuOption(MenuOption
)) {
1741 NewPos
= NewPos
->ForwardLink
;
1742 if (NewPos
== &gMenuOption
) {
1744 // Not Found it, break
1748 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
1752 // Last time top of screen menu has disappeared.
1754 if (NewPos
== &gMenuOption
) {
1762 Find the first menu which will be show at the top.
1764 @param FormData The data info for this form.
1765 @param TopOfScreen The link_entry pointer to top menu.
1766 @param HighlightMenu The menu which will be highlight.
1767 @param SkipValue The skip value for the top menu.
1772 IN FORM_DISPLAY_ENGINE_FORM
*FormData
,
1773 OUT LIST_ENTRY
**TopOfScreen
,
1774 OUT LIST_ENTRY
**HighlightMenu
,
1775 OUT UINTN
*SkipValue
1780 UI_MENU_OPTION
*MenuOption
;
1783 TopRow
= gStatementDimensions
.TopRow
+ SCROLL_ARROW_HEIGHT
;
1784 BottomRow
= gStatementDimensions
.BottomRow
- SCROLL_ARROW_HEIGHT
;
1788 // Reenter caused by option mismatch or auto exit caused by refresh form(refresh interval/guid),
1789 // base on the record highlight info to find the highlight menu.
1791 ASSERT (gFormData
->HiiHandle
== gHighligthMenuInfo
.HiiHandle
&&
1792 gFormData
->FormId
== gHighligthMenuInfo
.FormId
);
1794 *HighlightMenu
= FindHighLightMenuOption(NULL
);
1795 if (*HighlightMenu
!= NULL
) {
1797 // Update skip info for this highlight menu.
1799 MenuOption
= MENU_OPTION_FROM_LINK (*HighlightMenu
);
1800 UpdateOptionSkipLines (MenuOption
);
1803 // Found the last time highlight menu.
1805 *TopOfScreen
= FindTopOfScreenMenuOption();
1806 if (*TopOfScreen
!= NULL
) {
1808 // Found the last time selectable top of screen menu.
1810 AdjustDateAndTimePosition(TRUE
, TopOfScreen
);
1811 MenuOption
= MENU_OPTION_FROM_LINK (*TopOfScreen
);
1812 UpdateOptionSkipLines (MenuOption
);
1814 *SkipValue
= gHighligthMenuInfo
.SkipValue
;
1817 // Not found last time top of screen menu, so base on current highlight menu
1818 // to find the new top of screen menu.
1819 // Make the current highlight menu at the bottom of the form to calculate the
1820 // top of screen menu.
1822 if (MenuOption
->Skip
>= BottomRow
- TopRow
) {
1823 *TopOfScreen
= *HighlightMenu
;
1826 *TopOfScreen
= FindTopOfScreenMenu(*HighlightMenu
, BottomRow
- TopRow
- MenuOption
->Skip
, &TmpValue
);
1829 *SkipValue
= TmpValue
;
1833 // Last time highlight menu has disappear, find the first highlightable menu as the defalut one.
1835 *HighlightMenu
= gMenuOption
.ForwardLink
;
1836 if (!IsListEmpty (&gMenuOption
)) {
1837 MoveToNextStatement (FALSE
, HighlightMenu
, BottomRow
- TopRow
, TRUE
);
1839 *TopOfScreen
= gMenuOption
.ForwardLink
;
1844 } else if (FormData
->HighLightedStatement
!= NULL
) {
1845 if (IsSavedHighlightStatement (FormData
->HighLightedStatement
)) {
1847 // Input highlight menu is same as last time highlight menu.
1848 // Base on last time highlight menu to set the top of screen menu and highlight menu.
1850 *HighlightMenu
= FindHighLightMenuOption(NULL
);
1851 ASSERT (*HighlightMenu
!= NULL
);
1854 // Update skip info for this highlight menu.
1856 MenuOption
= MENU_OPTION_FROM_LINK (*HighlightMenu
);
1857 UpdateOptionSkipLines (MenuOption
);
1859 *TopOfScreen
= FindTopOfScreenMenuOption();
1860 if (*TopOfScreen
== NULL
) {
1862 // Not found last time top of screen menu, so base on current highlight menu
1863 // to find the new top of screen menu.
1864 // Make the current highlight menu at the bottom of the form to calculate the
1865 // top of screen menu.
1867 if (MenuOption
->Skip
>= BottomRow
- TopRow
) {
1868 *TopOfScreen
= *HighlightMenu
;
1871 *TopOfScreen
= FindTopOfScreenMenu(*HighlightMenu
, BottomRow
- TopRow
- MenuOption
->Skip
, &TmpValue
);
1874 *SkipValue
= TmpValue
;
1876 AdjustDateAndTimePosition(TRUE
, TopOfScreen
);
1877 MenuOption
= MENU_OPTION_FROM_LINK (*TopOfScreen
);
1878 UpdateOptionSkipLines (MenuOption
);
1880 *SkipValue
= gHighligthMenuInfo
.SkipValue
;
1882 AdjustDateAndTimePosition(TRUE
, TopOfScreen
);
1885 // Input highlight menu is not save as last time highlight menu.
1887 *HighlightMenu
= FindHighLightMenuOption(FormData
->HighLightedStatement
);
1888 MenuOption
= MENU_OPTION_FROM_LINK (*HighlightMenu
);
1889 UpdateOptionSkipLines (MenuOption
);
1892 // Make the current highlight menu at the bottom of the form to calculate the
1893 // top of screen menu.
1895 if (MenuOption
->Skip
>= BottomRow
- TopRow
) {
1896 *TopOfScreen
= *HighlightMenu
;
1899 *TopOfScreen
= FindTopOfScreenMenu(*HighlightMenu
, BottomRow
- TopRow
- MenuOption
->Skip
, &TmpValue
);
1902 *SkipValue
= TmpValue
;
1904 AdjustDateAndTimePosition(TRUE
, TopOfScreen
);
1907 // If not has input highlight statement, just return the first one in this form.
1909 *TopOfScreen
= gMenuOption
.ForwardLink
;
1910 *HighlightMenu
= gMenuOption
.ForwardLink
;
1911 if (!IsListEmpty (&gMenuOption
)) {
1912 MoveToNextStatement (FALSE
, HighlightMenu
, BottomRow
- TopRow
, TRUE
);
1918 // First enter to show the menu, update highlight info.
1920 UpdateHighlightMenuInfo (*HighlightMenu
, *TopOfScreen
, *SkipValue
);
1924 Record the highlight menu and top of screen menu info.
1926 @param Highlight The menu opton which is highlight.
1927 @param TopOfScreen The menu opton which is at the top of the form.
1928 @param SkipValue The skip line info for the top of screen menu.
1932 UpdateHighlightMenuInfo (
1933 IN LIST_ENTRY
*Highlight
,
1934 IN LIST_ENTRY
*TopOfScreen
,
1938 UI_MENU_OPTION
*MenuOption
;
1939 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
1941 gHighligthMenuInfo
.HiiHandle
= gFormData
->HiiHandle
;
1942 gHighligthMenuInfo
.FormId
= gFormData
->FormId
;
1943 gHighligthMenuInfo
.SkipValue
= (UINT16
)SkipValue
;
1945 if (!IsListEmpty (&gMenuOption
)) {
1946 MenuOption
= MENU_OPTION_FROM_LINK (Highlight
);
1947 Statement
= MenuOption
->ThisTag
;
1949 gUserInput
->SelectedStatement
= Statement
;
1951 gHighligthMenuInfo
.HLTSequence
= MenuOption
->Sequence
;
1952 gHighligthMenuInfo
.HLTQuestionId
= GetQuestionIdInfo(Statement
->OpCode
);
1953 if (gHighligthMenuInfo
.HLTQuestionId
== 0) {
1955 // if question id == 0, save the opcode buffer..
1957 if (gHighligthMenuInfo
.HLTOpCode
!= NULL
) {
1958 FreePool (gHighligthMenuInfo
.HLTOpCode
);
1960 gHighligthMenuInfo
.HLTOpCode
= AllocateCopyPool (Statement
->OpCode
->Length
, Statement
->OpCode
);
1961 ASSERT (gHighligthMenuInfo
.HLTOpCode
!= NULL
);
1963 gHighligthMenuInfo
.HLTIndex
= GetIndexInfoForOpcode(Statement
->OpCode
);
1966 MenuOption
= MENU_OPTION_FROM_LINK (TopOfScreen
);
1967 Statement
= MenuOption
->ThisTag
;
1969 gHighligthMenuInfo
.TOSQuestionId
= GetQuestionIdInfo(Statement
->OpCode
);
1970 if (gHighligthMenuInfo
.TOSQuestionId
== 0) {
1972 // if question id == 0, save the opcode buffer..
1974 if (gHighligthMenuInfo
.TOSOpCode
!= NULL
) {
1975 FreePool (gHighligthMenuInfo
.TOSOpCode
);
1977 gHighligthMenuInfo
.TOSOpCode
= AllocateCopyPool (Statement
->OpCode
->Length
, Statement
->OpCode
);
1978 ASSERT (gHighligthMenuInfo
.TOSOpCode
!= NULL
);
1980 gHighligthMenuInfo
.TOSIndex
= GetIndexInfoForOpcode(Statement
->OpCode
);
1983 gUserInput
->SelectedStatement
= NULL
;
1985 gHighligthMenuInfo
.HLTSequence
= 0;
1986 gHighligthMenuInfo
.HLTQuestionId
= 0;
1987 if (gHighligthMenuInfo
.HLTOpCode
!= NULL
) {
1988 FreePool (gHighligthMenuInfo
.HLTOpCode
);
1990 gHighligthMenuInfo
.HLTOpCode
= NULL
;
1991 gHighligthMenuInfo
.HLTIndex
= 0;
1993 gHighligthMenuInfo
.TOSQuestionId
= 0;
1994 if (gHighligthMenuInfo
.TOSOpCode
!= NULL
) {
1995 FreePool (gHighligthMenuInfo
.TOSOpCode
);
1997 gHighligthMenuInfo
.TOSOpCode
= NULL
;
1998 gHighligthMenuInfo
.TOSIndex
= 0;
2003 Update attribut for this menu.
2005 @param MenuOption The menu opton which this attribut used to.
2006 @param Highlight Whether this menu will be highlight.
2010 SetDisplayAttribute (
2011 IN UI_MENU_OPTION
*MenuOption
,
2012 IN BOOLEAN Highlight
2015 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
2017 Statement
= MenuOption
->ThisTag
;
2020 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetHighlightTextColor ());
2024 if (MenuOption
->GrayOut
) {
2025 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetGrayedTextColor ());
2027 if (Statement
->OpCode
->OpCode
== EFI_IFR_SUBTITLE_OP
) {
2028 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetSubTitleTextColor ());
2030 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetFieldTextColor ());
2036 Print string for this menu option.
2038 @param MenuOption The menu opton which this attribut used to.
2039 @param Col The column that this string will be print at.
2040 @param Row The row that this string will be print at.
2041 @param String The string which need to print.
2042 @param Width The width need to print, if string is less than the
2043 width, the block space will be used.
2044 @param Highlight Whether this menu will be highlight.
2049 IN UI_MENU_OPTION
*MenuOption
,
2054 IN BOOLEAN Highlight
2060 // Print string with normal color.
2063 PrintStringAtWithWidth (Col
, Row
, String
, Width
);
2068 // Print the highlight menu string.
2069 // First print the highlight string.
2071 SetDisplayAttribute(MenuOption
, TRUE
);
2072 Length
= PrintStringAt (Col
, Row
, String
);
2075 // Second, clean the empty after the string.
2077 SetDisplayAttribute(MenuOption
, FALSE
);
2078 PrintStringAtWithWidth (Col
+ Length
, Row
, L
"", Width
- Length
);
2082 Check whether this menu can has option string.
2084 @param MenuOption The menu opton which this attribut used to.
2086 @retval TRUE This menu option can have option string.
2087 @retval FALSE This menu option can't have option string.
2092 IN UI_MENU_OPTION
*MenuOption
2095 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
2098 EFI_IFR_TEXT
*TestOp
;
2101 Statement
= MenuOption
->ThisTag
;
2104 // See if the second text parameter is really NULL
2106 if (Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) {
2107 TestOp
= (EFI_IFR_TEXT
*) Statement
->OpCode
;
2108 if (TestOp
->TextTwo
!= 0) {
2109 String
= GetToken (TestOp
->TextTwo
, gFormData
->HiiHandle
);
2110 Size
= StrLen (String
);
2115 if ((Statement
->OpCode
->OpCode
== EFI_IFR_SUBTITLE_OP
) ||
2116 (Statement
->OpCode
->OpCode
== EFI_IFR_REF_OP
) ||
2117 (Statement
->OpCode
->OpCode
== EFI_IFR_PASSWORD_OP
) ||
2118 (Statement
->OpCode
->OpCode
== EFI_IFR_ACTION_OP
) ||
2119 (Statement
->OpCode
->OpCode
== EFI_IFR_RESET_BUTTON_OP
) ||
2121 // Allow a wide display if text op-code and no secondary text op-code
2123 ((Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) && (Size
== 0))
2133 Double confirm with user about the action.
2135 @param Action The user input action.
2137 @retval TRUE User confirm with the input or not need user confirm.
2138 @retval FALSE User want ignore this input.
2154 CatLen
= StrLen (gConfirmMsgConnect
);
2157 // Below action need extra popup dialog to confirm.
2159 CheckFlags
= BROWSER_ACTION_DISCARD
|
2160 BROWSER_ACTION_DEFAULT
|
2161 BROWSER_ACTION_SUBMIT
|
2162 BROWSER_ACTION_RESET
|
2163 BROWSER_ACTION_EXIT
;
2166 // Not need to confirm with user, just return TRUE.
2168 if ((Action
& CheckFlags
) == 0) {
2172 if ((Action
& BROWSER_ACTION_DISCARD
) == BROWSER_ACTION_DISCARD
) {
2173 CfmStrLen
+= StrLen (gConfirmDiscardMsg
);
2176 if ((Action
& BROWSER_ACTION_DEFAULT
) == BROWSER_ACTION_DEFAULT
) {
2177 if (CfmStrLen
!= 0) {
2178 CfmStrLen
+= CatLen
;
2181 CfmStrLen
+= StrLen (gConfirmDefaultMsg
);
2184 if ((Action
& BROWSER_ACTION_SUBMIT
) == BROWSER_ACTION_SUBMIT
) {
2185 if (CfmStrLen
!= 0) {
2186 CfmStrLen
+= CatLen
;
2189 CfmStrLen
+= StrLen (gConfirmSubmitMsg
);
2192 if ((Action
& BROWSER_ACTION_RESET
) == BROWSER_ACTION_RESET
) {
2193 if (CfmStrLen
!= 0) {
2194 CfmStrLen
+= CatLen
;
2197 CfmStrLen
+= StrLen (gConfirmResetMsg
);
2200 if ((Action
& BROWSER_ACTION_EXIT
) == BROWSER_ACTION_EXIT
) {
2201 if (CfmStrLen
!= 0) {
2202 CfmStrLen
+= CatLen
;
2205 CfmStrLen
+= StrLen (gConfirmExitMsg
);
2209 // Allocate buffer to save the string.
2210 // String + "?" + "\0"
2212 CfmStr
= AllocateZeroPool ((CfmStrLen
+ 1 + 1) * sizeof (CHAR16
));
2213 ASSERT (CfmStr
!= NULL
);
2215 if ((Action
& BROWSER_ACTION_DISCARD
) == BROWSER_ACTION_DISCARD
) {
2216 StrCpy (CfmStr
, gConfirmDiscardMsg
);
2219 if ((Action
& BROWSER_ACTION_DEFAULT
) == BROWSER_ACTION_DEFAULT
) {
2220 if (CfmStr
[0] != 0) {
2221 StrCat (CfmStr
, gConfirmMsgConnect
);
2222 StrCat (CfmStr
, gConfirmDefaultMsg2nd
);
2224 StrCpy (CfmStr
, gConfirmDefaultMsg
);
2228 if ((Action
& BROWSER_ACTION_SUBMIT
) == BROWSER_ACTION_SUBMIT
) {
2229 if (CfmStr
[0] != 0) {
2230 StrCat (CfmStr
, gConfirmMsgConnect
);
2231 StrCat (CfmStr
, gConfirmSubmitMsg2nd
);
2233 StrCpy (CfmStr
, gConfirmSubmitMsg
);
2237 if ((Action
& BROWSER_ACTION_RESET
) == BROWSER_ACTION_RESET
) {
2238 if (CfmStr
[0] != 0) {
2239 StrCat (CfmStr
, gConfirmMsgConnect
);
2240 StrCat (CfmStr
, gConfirmResetMsg2nd
);
2242 StrCpy (CfmStr
, gConfirmResetMsg
);
2246 if ((Action
& BROWSER_ACTION_EXIT
) == BROWSER_ACTION_EXIT
) {
2247 if (CfmStr
[0] != 0) {
2248 StrCat (CfmStr
, gConfirmMsgConnect
);
2249 StrCat (CfmStr
, gConfirmExitMsg2nd
);
2251 StrCpy (CfmStr
, gConfirmExitMsg
);
2255 StrCat (CfmStr
, gConfirmMsgEnd
);
2258 CreateDialog (&Key
, gEmptyString
, CfmStr
, gConfirmOpt
, gEmptyString
, NULL
);
2259 } while (((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (gConfirmOptYes
[0] | UPPER_LOWER_CASE_OFFSET
)) &&
2260 ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (gConfirmOptNo
[0] | UPPER_LOWER_CASE_OFFSET
)));
2262 if ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) == (gConfirmOptYes
[0] | UPPER_LOWER_CASE_OFFSET
)) {
2274 Print string for this menu option.
2276 @param MenuOption The menu opton which this attribut used to.
2277 @param SkipWidth The skip width between the left to the start of the prompt.
2278 @param BeginCol The begin column for one menu.
2279 @param SkipLine The skip line for this menu.
2280 @param BottomRow The bottom row for this form.
2281 @param Highlight Whether this menu will be highlight.
2282 @param UpdateCol Whether need to update the column info for Date/Time.
2284 @retval EFI_SUCESSS Process the user selection success.
2289 IN UI_MENU_OPTION
*MenuOption
,
2294 IN BOOLEAN Highlight
,
2295 IN BOOLEAN UpdateCol
2298 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
2303 CHAR16
*OptionString
;
2304 CHAR16
*OutputString
;
2311 BOOLEAN IsProcessingFirstRow
;
2313 UINTN PromptLineNum
;
2314 UINTN OptionLineNum
;
2318 Statement
= MenuOption
->ThisTag
;
2326 IsProcessingFirstRow
= TRUE
;
2329 // Set default color.
2331 SetDisplayAttribute (MenuOption
, FALSE
);
2334 // 1. Paint the option string.
2336 Status
= ProcessOptions (MenuOption
, FALSE
, &OptionString
, FALSE
);
2337 if (EFI_ERROR (Status
)) {
2341 if (OptionString
!= NULL
) {
2342 if (Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
|| Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
) {
2344 // Adjust option string for date/time opcode.
2346 ProcessStringForDateTime(MenuOption
, OptionString
, UpdateCol
);
2349 Width
= (UINT16
) gOptionBlockWidth
- 1;
2350 Row
= MenuOption
->Row
;
2354 for (Index
= 0; GetLineByWidth (OptionString
, Width
, &GlyphWidth
, &Index
, &OutputString
) != 0x0000;) {
2355 if (((Temp2
== 0)) && (Row
<= BottomRow
)) {
2356 if (Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
|| Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
) {
2358 // For date/time question, it has three menu options for this qustion.
2359 // The first/second menu options with the skip value is 0. the last one
2360 // with skip value is 1.
2362 if (MenuOption
->Skip
!= 0) {
2364 // For date/ time, print the last past (year for date and second for time)
2365 // - 7 means skip [##/##/ for date and [##:##: for time.
2367 DisplayMenuString (MenuOption
,MenuOption
->OptCol
, Row
, OutputString
, Width
+ 1 - 7, Highlight
);
2370 // For date/ time, print the first and second past (year for date and second for time)
2371 // The OutputString has a NARROW_CHAR or WIDE_CHAR at the begin of the string,
2372 // so need to - 1 to remove it, otherwise, it will clean 1 extr char follow it.
2373 DisplayMenuString (MenuOption
, MenuOption
->OptCol
, Row
, OutputString
, StrLen (OutputString
) - 1, Highlight
);
2376 DisplayMenuString (MenuOption
, MenuOption
->OptCol
, Row
, OutputString
, Width
+ 1, Highlight
);
2382 // If there is more string to process print on the next row and increment the Skip value
2384 if (StrLen (&OptionString
[Index
]) != 0) {
2388 // Since the Number of lines for this menu entry may or may not be reflected accurately
2389 // since the prompt might be 1 lines and option might be many, and vice versa, we need to do
2390 // some testing to ensure we are keeping this in-sync.
2392 // If the difference in rows is greater than or equal to the skip value, increase the skip value
2394 if ((Row
- MenuOption
->Row
) >= MenuOption
->Skip
) {
2400 FreePool (OutputString
);
2408 FreePool (OptionString
);
2412 // 2. Paint the description.
2414 PromptWidth
= GetWidth (MenuOption
, &AdjustValue
);
2415 Row
= MenuOption
->Row
;
2419 if (MenuOption
->Description
== NULL
|| MenuOption
->Description
[0] == '\0') {
2420 PrintStringAtWithWidth (BeginCol
, Row
, L
"", PromptWidth
+ AdjustValue
+ SkipWidth
);
2423 for (Index
= 0; GetLineByWidth (MenuOption
->Description
, PromptWidth
, &GlyphWidth
, &Index
, &OutputString
) != 0x0000;) {
2424 if ((Temp
== 0) && (Row
<= BottomRow
)) {
2426 // 1.Clean the start LEFT_SKIPPED_COLUMNS
2428 PrintStringAtWithWidth (BeginCol
, Row
, L
"", SkipWidth
);
2430 if (Statement
->OpCode
->OpCode
== EFI_IFR_REF_OP
&& MenuOption
->Col
>= 2 && IsProcessingFirstRow
) {
2432 // Print Arrow for Goto button.
2435 MenuOption
->Col
- 2,
2437 GEOMETRICSHAPE_RIGHT_TRIANGLE
2439 IsProcessingFirstRow
= FALSE
;
2441 DisplayMenuString (MenuOption
, MenuOption
->Col
, Row
, OutputString
, PromptWidth
+ AdjustValue
, Highlight
);
2445 // If there is more string to process print on the next row and increment the Skip value
2447 if (StrLen (&MenuOption
->Description
[Index
]) != 0) {
2453 FreePool (OutputString
);
2464 // 3. If this is a text op with secondary text information
2466 if ((Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) && (((EFI_IFR_TEXT
*)Statement
->OpCode
)->TextTwo
!= 0)) {
2467 StringPtr
= GetToken (((EFI_IFR_TEXT
*)Statement
->OpCode
)->TextTwo
, gFormData
->HiiHandle
);
2469 Width
= (UINT16
) gOptionBlockWidth
- 1;
2470 Row
= MenuOption
->Row
;
2474 for (Index
= 0; GetLineByWidth (StringPtr
, Width
, &GlyphWidth
, &Index
, &OutputString
) != 0x0000;) {
2475 if ((Temp3
== 0) && (Row
<= BottomRow
)) {
2476 DisplayMenuString (MenuOption
, MenuOption
->OptCol
, Row
, OutputString
, Width
+ 1, Highlight
);
2480 // If there is more string to process print on the next row and increment the Skip value
2482 if (StrLen (&StringPtr
[Index
]) != 0) {
2486 // If the rows for text two is greater than or equal to the skip value, increase the skip value
2488 if ((Row
- MenuOption
->Row
) >= MenuOption
->Skip
) {
2494 FreePool (OutputString
);
2500 FreePool (StringPtr
);
2504 // 4.Line number for Option string and prompt string are not equal.
2505 // Clean the column whose line number is less.
2507 if (HasOptionString(MenuOption
) && (OptionLineNum
!= PromptLineNum
)) {
2508 Col
= OptionLineNum
< PromptLineNum
? MenuOption
->OptCol
: BeginCol
;
2509 Row
= (OptionLineNum
< PromptLineNum
? OptionLineNum
: PromptLineNum
) + MenuOption
->Row
;
2510 Width
= (UINT16
) (OptionLineNum
< PromptLineNum
? gOptionBlockWidth
: PromptWidth
+ AdjustValue
+ SkipWidth
);
2511 MaxRow
= (OptionLineNum
< PromptLineNum
? PromptLineNum
: OptionLineNum
) + MenuOption
->Row
- 1;
2513 while (Row
<= MaxRow
) {
2514 DisplayMenuString (MenuOption
, Col
, Row
++, L
"", Width
, FALSE
);
2522 Display menu and wait for user to select one menu option, then return it.
2523 If AutoBoot is enabled, then if user doesn't select any option,
2524 after period of time, it will automatically return the first menu option.
2526 @param FormData The current form data info.
2528 @retval EFI_SUCESSS Process the user selection success.
2529 @retval EFI_NOT_FOUND Process option string for orderedlist/Oneof fail.
2534 IN FORM_DISPLAY_ENGINE_FORM
*FormData
2539 UINTN DistanceValue
;
2548 CHAR16
*StringRightPtr
;
2549 CHAR16
*StringErrorPtr
;
2550 CHAR16
*OptionString
;
2552 CHAR16
*HelpHeaderString
;
2553 CHAR16
*HelpBottomString
;
2562 LIST_ENTRY
*TopOfScreen
;
2563 LIST_ENTRY
*SavedListEntry
;
2564 UI_MENU_OPTION
*MenuOption
;
2565 UI_MENU_OPTION
*NextMenuOption
;
2566 UI_MENU_OPTION
*SavedMenuOption
;
2567 UI_CONTROL_FLAG ControlFlag
;
2568 UI_SCREEN_OPERATION ScreenOperation
;
2569 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
2570 BROWSER_HOT_KEY
*HotKey
;
2571 UINTN HelpPageIndex
;
2572 UINTN HelpPageCount
;
2575 UINTN HelpHeaderLine
;
2576 UINTN HelpBottomLine
;
2577 BOOLEAN MultiHelpPage
;
2578 UINT16 EachLineWidth
;
2579 UINT16 HeaderLineWidth
;
2580 UINT16 BottomLineWidth
;
2581 EFI_STRING_ID HelpInfo
;
2582 UI_EVENT_TYPE EventType
;
2583 BOOLEAN SkipHighLight
;
2584 EFI_HII_VALUE
*StatementValue
;
2586 EventType
= UIEventNone
;
2587 Status
= EFI_SUCCESS
;
2589 HelpHeaderString
= NULL
;
2590 HelpBottomString
= NULL
;
2591 OptionString
= NULL
;
2592 ScreenOperation
= UiNoOperation
;
2600 MultiHelpPage
= FALSE
;
2602 HeaderLineWidth
= 0;
2603 BottomLineWidth
= 0;
2607 SkipHighLight
= FALSE
;
2609 NextMenuOption
= NULL
;
2610 SavedMenuOption
= NULL
;
2614 gModalSkipColumn
= (CHAR16
) (gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
) / 6;
2616 ZeroMem (&Key
, sizeof (EFI_INPUT_KEY
));
2618 TopRow
= gStatementDimensions
.TopRow
+ SCROLL_ARROW_HEIGHT
;
2619 BottomRow
= gStatementDimensions
.BottomRow
- SCROLL_ARROW_HEIGHT
- 1;
2622 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2623 Col
= gStatementDimensions
.LeftColumn
+ LEFT_SKIPPED_COLUMNS
+ gModalSkipColumn
;
2625 Col
= gStatementDimensions
.LeftColumn
+ LEFT_SKIPPED_COLUMNS
;
2628 FindTopMenu(FormData
, &TopOfScreen
, &NewPos
, &SkipValue
);
2629 if (!IsListEmpty (&gMenuOption
)) {
2630 NextMenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
2631 gUserInput
->SelectedStatement
= NextMenuOption
->ThisTag
;
2634 gST
->ConOut
->EnableCursor (gST
->ConOut
, FALSE
);
2636 ControlFlag
= CfInitialization
;
2638 switch (ControlFlag
) {
2639 case CfInitialization
:
2640 if ((gOldFormEntry
.HiiHandle
!= FormData
->HiiHandle
) ||
2641 (!CompareGuid (&gOldFormEntry
.FormSetGuid
, &FormData
->FormSetGuid
))) {
2643 // Clear Statement range if different formset is painted.
2646 gStatementDimensions
.LeftColumn
,
2647 gStatementDimensions
.RightColumn
,
2648 TopRow
- SCROLL_ARROW_HEIGHT
,
2649 BottomRow
+ SCROLL_ARROW_HEIGHT
,
2650 GetFieldTextColor ()
2654 ControlFlag
= CfRepaint
;
2658 ControlFlag
= CfRefreshHighLight
;
2668 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetFieldTextColor ());
2671 // 1. Check whether need to print the arrow up.
2673 if (!ValueIsScroll (TRUE
, TopOfScreen
)) {
2677 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2678 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
+ gModalSkipColumn
, TopRow
- 1, L
"", gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
- 2 * gModalSkipColumn
);
2680 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
, TopRow
- 1, L
"", gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
);
2683 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetArrowColor ());
2685 gStatementDimensions
.LeftColumn
+ gPromptBlockWidth
+ gOptionBlockWidth
+ 1,
2686 TopRow
- SCROLL_ARROW_HEIGHT
,
2689 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetFieldTextColor ());
2693 // 2.Paint the menu.
2695 for (Link
= TopOfScreen
; Link
!= &gMenuOption
; Link
= Link
->ForwardLink
) {
2696 MenuOption
= MENU_OPTION_FROM_LINK (Link
);
2697 MenuOption
->Row
= Row
;
2698 MenuOption
->Col
= Col
;
2699 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2700 MenuOption
->OptCol
= gStatementDimensions
.LeftColumn
+ LEFT_SKIPPED_COLUMNS
+ gPromptBlockWidth
+ gModalSkipColumn
;
2702 MenuOption
->OptCol
= gStatementDimensions
.LeftColumn
+ LEFT_SKIPPED_COLUMNS
+ gPromptBlockWidth
;
2705 if (MenuOption
->NestInStatement
) {
2706 MenuOption
->Col
+= SUBTITLE_INDENT
;
2710 // Save the highlight menu, will be used in CfRefreshHighLight case.
2712 if (Link
== NewPos
) {
2713 SavedMenuOption
= MenuOption
;
2714 SkipHighLight
= TRUE
;
2717 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2718 Status
= DisplayOneMenu (MenuOption
,
2719 MenuOption
->Col
- gStatementDimensions
.LeftColumn
,
2720 gStatementDimensions
.LeftColumn
+ gModalSkipColumn
,
2721 Link
== TopOfScreen
? SkipValue
: 0,
2723 (BOOLEAN
) ((Link
== NewPos
) && IsSelectable(MenuOption
)),
2727 Status
= DisplayOneMenu (MenuOption
,
2728 MenuOption
->Col
- gStatementDimensions
.LeftColumn
,
2729 gStatementDimensions
.LeftColumn
,
2730 Link
== TopOfScreen
? SkipValue
: 0,
2732 (BOOLEAN
) ((Link
== NewPos
) && IsSelectable(MenuOption
)),
2737 if (EFI_ERROR (Status
)) {
2745 // 3. Update the row info which will be used by next menu.
2747 if (Link
== TopOfScreen
) {
2748 Row
+= MenuOption
->Skip
- SkipValue
;
2750 Row
+= MenuOption
->Skip
;
2753 if (Row
> BottomRow
) {
2754 if (!ValueIsScroll (FALSE
, Link
)) {
2758 Row
= BottomRow
+ 1;
2764 // 3. Menus in this form may not cover all form, clean the remain field.
2766 while (Row
<= BottomRow
) {
2767 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2768 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
+ gModalSkipColumn
, Row
++, L
"", gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
- 2 * gModalSkipColumn
);
2770 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
, Row
++, L
"", gStatementDimensions
.RightColumn
- gHelpBlockWidth
- gStatementDimensions
.LeftColumn
);
2775 // 4. Print the down arrow row.
2777 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2778 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
+ gModalSkipColumn
, BottomRow
+ 1, L
"", gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
- 2 * + gModalSkipColumn
);
2780 PrintStringAtWithWidth(gStatementDimensions
.LeftColumn
, BottomRow
+ 1, L
"", gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
);
2783 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetArrowColor ());
2785 gStatementDimensions
.LeftColumn
+ gPromptBlockWidth
+ gOptionBlockWidth
+ 1,
2786 BottomRow
+ SCROLL_ARROW_HEIGHT
,
2789 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetFieldTextColor ());
2796 case CfRefreshHighLight
:
2799 // MenuOption: Last menu option that need to remove hilight
2800 // MenuOption is set to NULL in Repaint
2801 // NewPos: Current menu option that need to hilight
2803 ControlFlag
= CfUpdateHelpString
;
2805 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
2807 if (SkipHighLight
) {
2808 SkipHighLight
= FALSE
;
2809 MenuOption
= SavedMenuOption
;
2810 RefreshKeyHelp(gFormData
, SavedMenuOption
->ThisTag
, FALSE
);
2814 if (IsListEmpty (&gMenuOption
)) {
2816 // No menu option, just update the hotkey filed.
2818 RefreshKeyHelp(gFormData
, NULL
, FALSE
);
2822 if (MenuOption
!= NULL
&& TopOfScreen
== &MenuOption
->Link
) {
2827 if (NewPos
== TopOfScreen
) {
2833 if (NewPos
!= NULL
&& (MenuOption
== NULL
|| NewPos
!= &MenuOption
->Link
)) {
2834 if (MenuOption
!= NULL
) {
2836 // Remove the old highlight menu.
2838 Status
= DisplayOneMenu (MenuOption
,
2839 MenuOption
->Col
- gStatementDimensions
.LeftColumn
,
2840 gStatementDimensions
.LeftColumn
,
2849 // This is the current selected statement
2851 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
2852 RefreshKeyHelp(gFormData
, MenuOption
->ThisTag
, FALSE
);
2854 if (!IsSelectable (MenuOption
)) {
2858 Status
= DisplayOneMenu (MenuOption
,
2859 MenuOption
->Col
- gStatementDimensions
.LeftColumn
,
2860 gStatementDimensions
.LeftColumn
,
2869 case CfUpdateHelpString
:
2870 ControlFlag
= CfPrepareToReadKey
;
2871 if ((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) {
2876 // NewLine means only update highlight menu (remove old highlight and highlith
2877 // the new one), not need to full repain the form.
2879 if (Repaint
|| NewLine
) {
2880 if (IsListEmpty (&gMenuOption
)) {
2882 // Don't print anything if no mwnu option.
2884 StringPtr
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2887 // Don't print anything if it is a NULL help token
2889 ASSERT(MenuOption
!= NULL
);
2890 HelpInfo
= ((EFI_IFR_STATEMENT_HEADER
*) ((CHAR8
*)MenuOption
->ThisTag
->OpCode
+ sizeof (EFI_IFR_OP_HEADER
)))->Help
;
2891 Statement
= MenuOption
->ThisTag
;
2892 StatementValue
= &Statement
->CurrentValue
;
2893 if (HelpInfo
== 0 || !IsSelectable (MenuOption
)) {
2894 if ((Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
&& StatementValue
->Value
.date
.Month
== 0xff)||(Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
&& StatementValue
->Value
.time
.Hour
== 0xff)){
2895 StringPtr
= GetToken (STRING_TOKEN (GET_TIME_FAIL
), gHiiHandle
);
2897 StringPtr
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2900 if ((Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
&& StatementValue
->Value
.date
.Month
== 0xff)||(Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
&& StatementValue
->Value
.time
.Hour
== 0xff)){
2901 StringRightPtr
= GetToken (HelpInfo
, gFormData
->HiiHandle
);
2902 StringErrorPtr
= GetToken (STRING_TOKEN (GET_TIME_FAIL
), gHiiHandle
);
2903 StringPtr
= AllocateZeroPool ((StrLen (StringRightPtr
) + StrLen (StringErrorPtr
)+ 1 ) * sizeof (CHAR16
));
2904 StrCpyS (StringPtr
, StrLen (StringRightPtr
) + StrLen (StringErrorPtr
) + 1, StringRightPtr
);
2905 StrCatS (StringPtr
, StrLen (StringRightPtr
) + StrLen (StringErrorPtr
) + 1, StringErrorPtr
);
2906 FreePool (StringRightPtr
);
2907 FreePool (StringErrorPtr
);
2909 StringPtr
= GetToken (HelpInfo
, gFormData
->HiiHandle
);
2914 RowCount
= BottomRow
- TopRow
+ 1;
2917 // 1.Calculate how many line the help string need to print.
2919 if (HelpString
!= NULL
) {
2920 FreePool (HelpString
);
2923 HelpLine
= ProcessHelpString (StringPtr
, &HelpString
, &EachLineWidth
, RowCount
);
2924 FreePool (StringPtr
);
2926 if (HelpLine
> RowCount
) {
2927 MultiHelpPage
= TRUE
;
2928 StringPtr
= GetToken (STRING_TOKEN(ADJUST_HELP_PAGE_UP
), gHiiHandle
);
2929 if (HelpHeaderString
!= NULL
) {
2930 FreePool (HelpHeaderString
);
2931 HelpHeaderString
= NULL
;
2933 HelpHeaderLine
= ProcessHelpString (StringPtr
, &HelpHeaderString
, &HeaderLineWidth
, 0);
2934 FreePool (StringPtr
);
2935 StringPtr
= GetToken (STRING_TOKEN(ADJUST_HELP_PAGE_DOWN
), gHiiHandle
);
2936 if (HelpBottomString
!= NULL
) {
2937 FreePool (HelpBottomString
);
2938 HelpBottomString
= NULL
;
2940 HelpBottomLine
= ProcessHelpString (StringPtr
, &HelpBottomString
, &BottomLineWidth
, 0);
2941 FreePool (StringPtr
);
2943 // Calculate the help page count.
2945 if (HelpLine
> 2 * RowCount
- 2) {
2946 HelpPageCount
= (HelpLine
- RowCount
+ 1) / (RowCount
- 2) + 1;
2947 if ((HelpLine
- RowCount
+ 1) % (RowCount
- 2) > 1) {
2954 MultiHelpPage
= FALSE
;
2959 // Check whether need to show the 'More(U/u)' at the begin.
2960 // Base on current direct info, here shows aligned to the right side of the column.
2961 // If the direction is multi line and aligned to right side may have problem, so
2962 // add ASSERT code here.
2964 if (HelpPageIndex
> 0) {
2965 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetInfoTextColor ());
2966 for (Index
= 0; Index
< HelpHeaderLine
; Index
++) {
2967 ASSERT (HelpHeaderLine
== 1);
2968 ASSERT (GetStringWidth (HelpHeaderString
) / 2 < (UINTN
) (gHelpBlockWidth
- 1));
2969 PrintStringAtWithWidth (
2970 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
2976 gStatementDimensions
.RightColumn
- GetStringWidth (HelpHeaderString
) / 2 - 1,
2978 &HelpHeaderString
[Index
* HeaderLineWidth
]
2983 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetHelpTextColor ());
2985 // Print the help string info.
2987 if (!MultiHelpPage
) {
2988 for (Index
= 0; Index
< HelpLine
; Index
++) {
2989 PrintStringAtWithWidth (
2990 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
2992 &HelpString
[Index
* EachLineWidth
],
2996 for (; Index
< RowCount
; Index
++) {
2997 PrintStringAtWithWidth (
2998 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
3004 gST
->ConOut
->SetCursorPosition(gST
->ConOut
, gStatementDimensions
.RightColumn
-1, BottomRow
);
3006 if (HelpPageIndex
== 0) {
3007 for (Index
= 0; Index
< RowCount
- HelpBottomLine
; Index
++) {
3008 PrintStringAtWithWidth (
3009 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
3011 &HelpString
[Index
* EachLineWidth
],
3016 for (Index
= 0; (Index
< RowCount
- HelpBottomLine
- HelpHeaderLine
) &&
3017 (Index
+ HelpPageIndex
* (RowCount
- 2) + 1 < HelpLine
); Index
++) {
3018 PrintStringAtWithWidth (
3019 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
3020 Index
+ TopRow
+ HelpHeaderLine
,
3021 &HelpString
[(Index
+ HelpPageIndex
* (RowCount
- 2) + 1)* EachLineWidth
],
3025 if (HelpPageIndex
== HelpPageCount
- 1) {
3026 for (; Index
< RowCount
- HelpHeaderLine
; Index
++) {
3027 PrintStringAtWithWidth (
3028 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
3029 Index
+ TopRow
+ HelpHeaderLine
,
3034 gST
->ConOut
->SetCursorPosition(gST
->ConOut
, gStatementDimensions
.RightColumn
-1, BottomRow
);
3040 // Check whether need to print the 'More(D/d)' at the bottom.
3041 // Base on current direct info, here shows aligned to the right side of the column.
3042 // If the direction is multi line and aligned to right side may have problem, so
3043 // add ASSERT code here.
3045 if (HelpPageIndex
< HelpPageCount
- 1 && MultiHelpPage
) {
3046 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetInfoTextColor ());
3047 for (Index
= 0; Index
< HelpBottomLine
; Index
++) {
3048 ASSERT (HelpBottomLine
== 1);
3049 ASSERT (GetStringWidth (HelpBottomString
) / 2 < (UINTN
) (gHelpBlockWidth
- 1));
3050 PrintStringAtWithWidth (
3051 gStatementDimensions
.RightColumn
- gHelpBlockWidth
,
3052 BottomRow
+ Index
- HelpBottomLine
+ 1,
3057 gStatementDimensions
.RightColumn
- GetStringWidth (HelpBottomString
) / 2 - 1,
3058 BottomRow
+ Index
- HelpBottomLine
+ 1,
3059 &HelpBottomString
[Index
* BottomLineWidth
]
3064 // Reset this flag every time we finish using it.
3070 case CfPrepareToReadKey
:
3071 ControlFlag
= CfReadKey
;
3072 ScreenOperation
= UiNoOperation
;
3076 ControlFlag
= CfScreenOperation
;
3079 // Wait for user's selection
3082 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3083 if (!EFI_ERROR (Status
)) {
3084 EventType
= UIEventKey
;
3089 // If we encounter error, continue to read another key in.
3091 if (Status
!= EFI_NOT_READY
) {
3095 EventType
= UiWaitForEvent(gST
->ConIn
->WaitForKey
);
3096 if (EventType
== UIEventKey
) {
3097 gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3102 if (EventType
== UIEventDriver
) {
3104 gUserInput
->Action
= BROWSER_ACTION_NONE
;
3105 ControlFlag
= CfExit
;
3109 if (EventType
== UIEventTimeOut
) {
3110 gUserInput
->Action
= BROWSER_ACTION_FORM_EXIT
;
3111 ControlFlag
= CfExit
;
3115 switch (Key
.UnicodeChar
) {
3116 case CHAR_CARRIAGE_RETURN
:
3117 if(MenuOption
== NULL
|| MenuOption
->GrayOut
|| MenuOption
->ReadOnly
) {
3118 ControlFlag
= CfReadKey
;
3122 ScreenOperation
= UiSelect
;
3127 // We will push the adjustment of these numeric values directly to the input handler
3128 // NOTE: we won't handle manual input numeric
3133 // If the screen has no menu items, and the user didn't select UiReset
3134 // ignore the selection and go back to reading keys.
3136 ASSERT(MenuOption
!= NULL
);
3137 if(IsListEmpty (&gMenuOption
) || MenuOption
->GrayOut
|| MenuOption
->ReadOnly
) {
3138 ControlFlag
= CfReadKey
;
3142 Statement
= MenuOption
->ThisTag
;
3143 if ((Statement
->OpCode
->OpCode
== EFI_IFR_DATE_OP
)
3144 || (Statement
->OpCode
->OpCode
== EFI_IFR_TIME_OP
)
3145 || ((Statement
->OpCode
->OpCode
== EFI_IFR_NUMERIC_OP
) && (GetFieldFromNum(Statement
->OpCode
) != 0))
3147 if (Key
.UnicodeChar
== '+') {
3148 gDirection
= SCAN_RIGHT
;
3150 gDirection
= SCAN_LEFT
;
3153 Status
= ProcessOptions (MenuOption
, TRUE
, &OptionString
, TRUE
);
3154 if (OptionString
!= NULL
) {
3155 FreePool (OptionString
);
3157 if (EFI_ERROR (Status
)) {
3159 // Repaint to clear possible error prompt pop-up
3164 ControlFlag
= CfExit
;
3170 ScreenOperation
= UiUp
;
3175 ScreenOperation
= UiDown
;
3179 if(IsListEmpty (&gMenuOption
)) {
3180 ControlFlag
= CfReadKey
;
3184 ASSERT(MenuOption
!= NULL
);
3185 if (MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_CHECKBOX_OP
&& !MenuOption
->GrayOut
&& !MenuOption
->ReadOnly
) {
3186 ScreenOperation
= UiSelect
;
3192 if (!MultiHelpPage
) {
3193 ControlFlag
= CfReadKey
;
3196 ControlFlag
= CfUpdateHelpString
;
3197 HelpPageIndex
= HelpPageIndex
< HelpPageCount
- 1 ? HelpPageIndex
+ 1 : HelpPageCount
- 1;
3202 if (!MultiHelpPage
) {
3203 ControlFlag
= CfReadKey
;
3206 ControlFlag
= CfUpdateHelpString
;
3207 HelpPageIndex
= HelpPageIndex
> 0 ? HelpPageIndex
- 1 : 0;
3211 for (Index
= 0; Index
< mScanCodeNumber
; Index
++) {
3212 if (Key
.ScanCode
== gScanCodeToOperation
[Index
].ScanCode
) {
3213 ScreenOperation
= gScanCodeToOperation
[Index
].ScreenOperation
;
3218 if (((FormData
->Attribute
& HII_DISPLAY_MODAL
) != 0) && (Key
.ScanCode
== SCAN_ESC
|| Index
== mScanCodeNumber
)) {
3220 // ModalForm has no ESC key and Hot Key.
3222 ControlFlag
= CfReadKey
;
3223 } else if (Index
== mScanCodeNumber
) {
3225 // Check whether Key matches the registered hot key.
3228 HotKey
= GetHotKeyFromRegisterList (&Key
);
3229 if (HotKey
!= NULL
) {
3230 ScreenOperation
= UiHotKey
;
3237 case CfScreenOperation
:
3238 if ((ScreenOperation
!= UiReset
) && (ScreenOperation
!= UiHotKey
)) {
3240 // If the screen has no menu items, and the user didn't select UiReset or UiHotKey
3241 // ignore the selection and go back to reading keys.
3243 if (IsListEmpty (&gMenuOption
)) {
3244 ControlFlag
= CfReadKey
;
3250 Index
< sizeof (gScreenOperationToControlFlag
) / sizeof (gScreenOperationToControlFlag
[0]);
3253 if (ScreenOperation
== gScreenOperationToControlFlag
[Index
].ScreenOperation
) {
3254 ControlFlag
= gScreenOperationToControlFlag
[Index
].ControlFlag
;
3261 ControlFlag
= CfRepaint
;
3263 ASSERT(MenuOption
!= NULL
);
3264 Statement
= MenuOption
->ThisTag
;
3265 if (Statement
->OpCode
->OpCode
== EFI_IFR_TEXT_OP
) {
3269 switch (Statement
->OpCode
->OpCode
) {
3270 case EFI_IFR_REF_OP
:
3271 case EFI_IFR_ACTION_OP
:
3272 case EFI_IFR_RESET_BUTTON_OP
:
3273 ControlFlag
= CfExit
;
3278 // Editable Questions: oneof, ordered list, checkbox, numeric, string, password
3280 RefreshKeyHelp (gFormData
, Statement
, TRUE
);
3281 Status
= ProcessOptions (MenuOption
, TRUE
, &OptionString
, TRUE
);
3283 if (OptionString
!= NULL
) {
3284 FreePool (OptionString
);
3287 if (EFI_ERROR (Status
)) {
3290 RefreshKeyHelp (gFormData
, Statement
, FALSE
);
3293 ControlFlag
= CfExit
;
3301 // We come here when someone press ESC
3302 // If the policy is not exit front page when user press ESC, process here.
3304 if (!FormExitPolicy()) {
3307 ControlFlag
= CfRepaint
;
3311 gUserInput
->Action
= BROWSER_ACTION_FORM_EXIT
;
3312 ControlFlag
= CfExit
;
3316 ControlFlag
= CfRepaint
;
3318 ASSERT (HotKey
!= NULL
);
3320 if (FxConfirmPopup(HotKey
->Action
)) {
3321 gUserInput
->Action
= HotKey
->Action
;
3322 if ((HotKey
->Action
& BROWSER_ACTION_DEFAULT
) == BROWSER_ACTION_DEFAULT
) {
3323 gUserInput
->DefaultId
= HotKey
->DefaultId
;
3325 ControlFlag
= CfExit
;
3329 ControlFlag
= CfRepaint
;
3335 ControlFlag
= CfRepaint
;
3336 ASSERT(MenuOption
!= NULL
);
3337 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_DATE_OP
) || (MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_TIME_OP
)) {
3338 if (MenuOption
->Sequence
!= 0) {
3340 // In the middle or tail of the Date/Time op-code set, go left.
3342 ASSERT(NewPos
!= NULL
);
3343 NewPos
= NewPos
->BackLink
;
3349 ControlFlag
= CfRepaint
;
3350 ASSERT(MenuOption
!= NULL
);
3351 if ((MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_DATE_OP
) || (MenuOption
->ThisTag
->OpCode
->OpCode
== EFI_IFR_TIME_OP
)) {
3352 if (MenuOption
->Sequence
!= 2) {
3354 // In the middle or tail of the Date/Time op-code set, go left.
3356 ASSERT(NewPos
!= NULL
);
3357 NewPos
= NewPos
->ForwardLink
;
3363 ControlFlag
= CfRepaint
;
3366 SavedListEntry
= NewPos
;
3367 ASSERT(NewPos
!= NULL
);
3369 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
3370 ASSERT (MenuOption
!= NULL
);
3373 // Adjust Date/Time position before we advance forward.
3375 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3377 NewPos
= NewPos
->BackLink
;
3379 // Find next selectable menu or the first menu beyond current form.
3381 Difference
= MoveToNextStatement (TRUE
, &NewPos
, MenuOption
->Row
- TopRow
, FALSE
);
3382 if (Difference
< 0) {
3384 // We hit the begining MenuOption that can be focused
3385 // so we simply scroll to the top.
3388 if (TopOfScreen
!= gMenuOption
.ForwardLink
|| SkipValue
!= 0) {
3389 TopOfScreen
= gMenuOption
.ForwardLink
;
3390 NewPos
= SavedListEntry
;
3394 // Scroll up to the last page when we have arrived at top page.
3396 TopOfScreen
= FindTopOfScreenMenu (gMenuOption
.BackLink
, BottomRow
- TopRow
, &SkipValue
);
3397 NewPos
= gMenuOption
.BackLink
;
3398 MoveToNextStatement (TRUE
, &NewPos
, BottomRow
- TopRow
, TRUE
);
3401 NextMenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
3403 if (MenuOption
->Row
< TopRow
+ Difference
+ NextMenuOption
->Skip
) {
3405 // Previous focus MenuOption is above the TopOfScreen, so we need to scroll
3407 TopOfScreen
= NewPos
;
3413 // Check whether new highlight menu is selectable, if not, keep highlight on the old one.
3415 // BottomRow - TopRow + 1 means the total rows current forms supported.
3416 // Difference + NextMenuOption->Skip + 1 means the distance between last highlight menu
3417 // and new top menu. New top menu will all shows in next form, but last highlight menu
3418 // may only shows 1 line. + 1 at right part means at least need to keep 1 line for the
3419 // last highlight menu.
3421 if (!IsSelectable(NextMenuOption
) && IsSelectable(MenuOption
) &&
3422 (BottomRow
- TopRow
+ 1 >= Difference
+ NextMenuOption
->Skip
+ 1)) {
3423 NewPos
= SavedListEntry
;
3427 UpdateStatusBar (INPUT_ERROR
, FALSE
);
3430 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.
3432 AdjustDateAndTimePosition (TRUE
, &TopOfScreen
);
3433 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3435 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
3440 // SkipValue means lines is skipped when show the top menu option.
3442 ControlFlag
= CfRepaint
;
3448 // First minus the menu of the top screen, it's value is SkipValue.
3450 if (SkipValue
>= BottomRow
- TopRow
+ 1) {
3452 // SkipValue > (BottomRow - TopRow + 1) means current menu has more than one
3453 // form of options to be show, so just update the SkipValue to show the next
3454 // parts of options.
3456 SkipValue
-= BottomRow
- TopRow
+ 1;
3457 NewPos
= TopOfScreen
;
3460 Index
= (BottomRow
+ 1) - SkipValue
- TopRow
;
3463 TopOfScreen
= FindTopOfScreenMenu(TopOfScreen
, Index
, &SkipValue
);
3464 NewPos
= TopOfScreen
;
3465 MoveToNextStatement (FALSE
, &NewPos
, BottomRow
- TopRow
, FALSE
);
3467 UpdateStatusBar (INPUT_ERROR
, FALSE
);
3470 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.
3471 // Don't do this when we are already in the first page.
3473 AdjustDateAndTimePosition (TRUE
, &TopOfScreen
);
3474 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3476 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
3481 // SkipValue means lines is skipped when show the top menu option.
3483 ControlFlag
= CfRepaint
;
3488 NextMenuOption
= MENU_OPTION_FROM_LINK (Link
);
3489 Index
= TopRow
+ NextMenuOption
->Skip
- SkipValue
;
3491 // Count to the menu option which will show at the top of the next form.
3493 while ((Index
<= BottomRow
+ 1) && (Link
->ForwardLink
!= &gMenuOption
)) {
3494 Link
= Link
->ForwardLink
;
3495 NextMenuOption
= MENU_OPTION_FROM_LINK (Link
);
3496 Index
= Index
+ NextMenuOption
->Skip
;
3499 if ((Link
->ForwardLink
== &gMenuOption
) && (Index
<= BottomRow
+ 1)) {
3501 // Highlight on the last menu which can be highlight.
3504 MoveToNextStatement (TRUE
, &Link
, Index
- TopRow
, TRUE
);
3507 // Calculate the skip line for top of screen menu.
3509 if (Link
== TopOfScreen
) {
3511 // The top of screen menu option occupies the entire form.
3513 SkipValue
+= BottomRow
- TopRow
+ 1;
3515 SkipValue
= NextMenuOption
->Skip
- (Index
- (BottomRow
+ 1));
3520 // Move to the Next selectable menu.
3522 MoveToNextStatement (FALSE
, &Link
, BottomRow
- TopRow
, TRUE
);
3526 // Save the menu as the next highlight menu.
3530 UpdateStatusBar (INPUT_ERROR
, FALSE
);
3533 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.
3534 // Don't do this when we are already in the last page.
3536 AdjustDateAndTimePosition (TRUE
, &TopOfScreen
);
3537 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3539 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
3544 // SkipValue means lines is skipped when show the top menu option.
3545 // NewPos points to the menu which is highlighted now.
3547 ControlFlag
= CfRepaint
;
3550 if (NewPos
== TopOfScreen
) {
3556 SavedListEntry
= NewPos
;
3558 // Since the behavior of hitting the down arrow on a Date/Time op-code is intended
3559 // to be one that progresses to the next set of op-codes, we need to advance to the last
3560 // Date/Time op-code and leave the remaining logic in UiDown intact so the appropriate
3561 // checking can be done. The only other logic we need to introduce is that if a Date/Time
3562 // op-code is the last entry in the menu, we need to rewind back to the first op-code of
3563 // the Date/Time op-code.
3565 AdjustDateAndTimePosition (FALSE
, &NewPos
);
3567 MenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
3568 NewPos
= NewPos
->ForwardLink
;
3570 // Find the next selectable menu.
3572 if (MenuOption
->Row
+ MenuOption
->Skip
- Temp2
> BottomRow
+ 1) {
3573 if (gMenuOption
.ForwardLink
== NewPos
|| &gMenuOption
== NewPos
) {
3579 Difference
= MoveToNextStatement (FALSE
, &NewPos
, BottomRow
+ 1 - (MenuOption
->Row
+ MenuOption
->Skip
- Temp2
), FALSE
);
3581 if (Difference
< 0) {
3583 // Scroll to the first page.
3585 if (TopOfScreen
!= gMenuOption
.ForwardLink
|| SkipValue
!= 0) {
3586 TopOfScreen
= gMenuOption
.ForwardLink
;
3590 MenuOption
= MENU_OPTION_FROM_LINK (SavedListEntry
);
3592 NewPos
= gMenuOption
.ForwardLink
;
3593 MoveToNextStatement (FALSE
, &NewPos
, BottomRow
- TopRow
, TRUE
);
3597 // If we are at the end of the list and sitting on a Date/Time op, rewind to the head.
3599 AdjustDateAndTimePosition (TRUE
, &TopOfScreen
);
3600 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3602 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
3607 // Get next selected menu info.
3609 AdjustDateAndTimePosition (FALSE
, &NewPos
);
3610 NextMenuOption
= MENU_OPTION_FROM_LINK (NewPos
);
3611 if (NextMenuOption
->Row
== 0) {
3612 UpdateOptionSkipLines (NextMenuOption
);
3616 // Calculate new highlight menu end row.
3618 Temp
= (MenuOption
->Row
+ MenuOption
->Skip
- Temp2
) + Difference
+ NextMenuOption
->Skip
- 1;
3619 if (Temp
> BottomRow
) {
3621 // Get the top screen menu info.
3623 AdjustDateAndTimePosition (FALSE
, &TopOfScreen
);
3624 SavedMenuOption
= MENU_OPTION_FROM_LINK (TopOfScreen
);
3627 // Current Top screen menu occupy (SavedMenuOption->Skip - SkipValue) rows.
3628 // Full shows the new selected menu need to skip (Temp - BottomRow - 1) rows.
3630 if ((Temp
- BottomRow
) >= (SavedMenuOption
->Skip
- SkipValue
)) {
3632 // Skip the top op-code
3634 TopOfScreen
= TopOfScreen
->ForwardLink
;
3635 DistanceValue
= (Temp
- BottomRow
) - (SavedMenuOption
->Skip
- SkipValue
);
3637 SavedMenuOption
= MENU_OPTION_FROM_LINK (TopOfScreen
);
3640 // If we have a remainder, skip that many more op-codes until we drain the remainder
3641 // Special case is the selected highlight menu has more than one form of menus.
3643 while (DistanceValue
>= SavedMenuOption
->Skip
&& TopOfScreen
!= NewPos
) {
3645 // Since the Difference is greater than or equal to this op-code's skip value, skip it
3647 DistanceValue
= DistanceValue
- (INTN
) SavedMenuOption
->Skip
;
3648 TopOfScreen
= TopOfScreen
->ForwardLink
;
3649 SavedMenuOption
= MENU_OPTION_FROM_LINK (TopOfScreen
);
3652 // Since we will act on this op-code in the next routine, and increment the
3653 // SkipValue, set the skips to one less than what is required.
3655 if (TopOfScreen
!= NewPos
) {
3656 SkipValue
= DistanceValue
;
3662 // Since we will act on this op-code in the next routine, and increment the
3663 // SkipValue, set the skips to one less than what is required.
3665 SkipValue
+= Temp
- BottomRow
;
3668 } else if (!IsSelectable (NextMenuOption
)) {
3670 // Continue to go down until scroll to next page or the selectable option is found.
3672 ScreenOperation
= UiDown
;
3673 ControlFlag
= CfScreenOperation
;
3677 MenuOption
= MENU_OPTION_FROM_LINK (SavedListEntry
);
3680 // Check whether new highlight menu is selectable, if not, keep highlight on the old one.
3682 // BottomRow - TopRow + 1 means the total rows current forms supported.
3683 // Difference + NextMenuOption->Skip + 1 means the distance between last highlight menu
3684 // and new top menu. New top menu will all shows in next form, but last highlight menu
3685 // may only shows 1 line. + 1 at right part means at least need to keep 1 line for the
3686 // last highlight menu.
3688 if (!IsSelectable (NextMenuOption
) && IsSelectable (MenuOption
) &&
3689 (BottomRow
- TopRow
+ 1 >= Difference
+ NextMenuOption
->Skip
+ 1)) {
3690 NewPos
= SavedListEntry
;
3693 UpdateStatusBar (INPUT_ERROR
, FALSE
);
3696 // If we are at the end of the list and sitting on a Date/Time op, rewind to the head.
3698 AdjustDateAndTimePosition (TRUE
, &TopOfScreen
);
3699 AdjustDateAndTimePosition (TRUE
, &NewPos
);
3701 UpdateHighlightMenuInfo(NewPos
, TopOfScreen
, SkipValue
);
3704 case CfUiNoOperation
:
3705 ControlFlag
= CfRepaint
;
3709 gST
->ConOut
->SetAttribute (gST
->ConOut
, EFI_TEXT_ATTR (EFI_LIGHTGRAY
, EFI_BLACK
));
3710 if (HelpString
!= NULL
) {
3711 FreePool (HelpString
);
3713 if (HelpHeaderString
!= NULL
) {
3714 FreePool (HelpHeaderString
);
3716 if (HelpBottomString
!= NULL
) {
3717 FreePool (HelpBottomString
);
3729 Base on the browser status info to show an pop up message.
3733 BrowserStatusProcess (
3739 EFI_EVENT WaitList
[2];
3740 EFI_EVENT RefreshIntervalEvent
;
3741 EFI_EVENT TimeOutEvent
;
3745 WARNING_IF_CONTEXT EventContext
;
3746 EFI_IFR_OP_HEADER
*OpCodeBuf
;
3747 EFI_STRING_ID StringToken
;
3748 CHAR16 DiscardChange
;
3749 CHAR16 JumpToFormSet
;
3750 CHAR16
*PrintString
;
3752 if (gFormData
->BrowserStatus
== BROWSER_SUCCESS
) {
3757 TimeOutEvent
= NULL
;
3758 RefreshIntervalEvent
= NULL
;
3760 if (gFormData
->HighLightedStatement
!= NULL
) {
3761 OpCodeBuf
= gFormData
->HighLightedStatement
->OpCode
;
3764 if (gFormData
->BrowserStatus
== (BROWSER_WARNING_IF
)) {
3765 ASSERT (OpCodeBuf
!= NULL
&& OpCodeBuf
->OpCode
== EFI_IFR_WARNING_IF_OP
);
3767 TimeOut
= ((EFI_IFR_WARNING_IF
*) OpCodeBuf
)->TimeOut
;
3768 StringToken
= ((EFI_IFR_WARNING_IF
*) OpCodeBuf
)->Warning
;
3771 if ((gFormData
->BrowserStatus
== (BROWSER_NO_SUBMIT_IF
)) &&
3772 (OpCodeBuf
!= NULL
&& OpCodeBuf
->OpCode
== EFI_IFR_NO_SUBMIT_IF_OP
)) {
3773 StringToken
= ((EFI_IFR_NO_SUBMIT_IF
*) OpCodeBuf
)->Error
;
3774 } else if ((gFormData
->BrowserStatus
== (BROWSER_INCONSISTENT_IF
)) &&
3775 (OpCodeBuf
!= NULL
&& OpCodeBuf
->OpCode
== EFI_IFR_INCONSISTENT_IF_OP
)) {
3776 StringToken
= ((EFI_IFR_INCONSISTENT_IF
*) OpCodeBuf
)->Error
;
3780 if (StringToken
!= 0) {
3781 ErrorInfo
= GetToken (StringToken
, gFormData
->HiiHandle
);
3782 } else if (gFormData
->ErrorString
!= NULL
) {
3784 // Only used to compatible with old setup browser.
3785 // Not use this field in new browser core.
3787 ErrorInfo
= gFormData
->ErrorString
;
3789 switch (gFormData
->BrowserStatus
) {
3790 case BROWSER_SUBMIT_FAIL
:
3791 ErrorInfo
= gSaveFailed
;
3794 case BROWSER_FORM_NOT_FOUND
:
3795 ErrorInfo
= gFormNotFound
;
3798 case BROWSER_FORM_SUPPRESS
:
3799 ErrorInfo
= gFormSuppress
;
3802 case BROWSER_PROTOCOL_NOT_FOUND
:
3803 ErrorInfo
= gProtocolNotFound
;
3806 case BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF
:
3807 ErrorInfo
= gNoSubmitIfFailed
;
3810 case BROWSER_RECONNECT_FAIL
:
3811 ErrorInfo
= gReconnectFail
;
3814 case BROWSER_RECONNECT_SAVE_CHANGES
:
3815 ErrorInfo
= gReconnectConfirmChanges
;
3818 case BROWSER_RECONNECT_REQUIRED
:
3819 ErrorInfo
= gReconnectRequired
;
3823 ErrorInfo
= gBrowserError
;
3828 switch (gFormData
->BrowserStatus
) {
3829 case BROWSER_SUBMIT_FAIL
:
3830 case BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF
:
3831 case BROWSER_RECONNECT_SAVE_CHANGES
:
3832 ASSERT (gUserInput
!= NULL
);
3833 if (gFormData
->BrowserStatus
== (BROWSER_SUBMIT_FAIL
)) {
3834 PrintString
= gSaveProcess
;
3835 JumpToFormSet
= gJumpToFormSet
[0];
3836 DiscardChange
= gDiscardChange
[0];
3837 } else if (gFormData
->BrowserStatus
== (BROWSER_RECONNECT_SAVE_CHANGES
)){
3838 PrintString
= gChangesOpt
;
3839 JumpToFormSet
= gConfirmOptYes
[0];
3840 DiscardChange
= gConfirmOptNo
[0];
3842 PrintString
= gSaveNoSubmitProcess
;
3843 JumpToFormSet
= gCheckError
[0];
3844 DiscardChange
= gDiscardChange
[0];
3848 CreateDialog (&Key
, gEmptyString
, ErrorInfo
, PrintString
, gEmptyString
, NULL
);
3849 } while (((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (DiscardChange
| UPPER_LOWER_CASE_OFFSET
)) &&
3850 ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) != (JumpToFormSet
| UPPER_LOWER_CASE_OFFSET
)));
3852 if ((Key
.UnicodeChar
| UPPER_LOWER_CASE_OFFSET
) == (DiscardChange
| UPPER_LOWER_CASE_OFFSET
)) {
3853 gUserInput
->Action
= BROWSER_ACTION_DISCARD
;
3855 gUserInput
->Action
= BROWSER_ACTION_GOTO
;
3862 CreateDialog (&Key
, gEmptyString
, ErrorInfo
, gPressEnter
, gEmptyString
, NULL
);
3863 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
3865 Status
= gBS
->CreateEvent (EVT_NOTIFY_WAIT
, TPL_CALLBACK
, EmptyEventProcess
, NULL
, &TimeOutEvent
);
3866 ASSERT_EFI_ERROR (Status
);
3868 EventContext
.SyncEvent
= TimeOutEvent
;
3869 EventContext
.TimeOut
= &TimeOut
;
3870 EventContext
.ErrorInfo
= ErrorInfo
;
3872 Status
= gBS
->CreateEvent (EVT_TIMER
| EVT_NOTIFY_SIGNAL
, TPL_CALLBACK
, RefreshTimeOutProcess
, &EventContext
, &RefreshIntervalEvent
);
3873 ASSERT_EFI_ERROR (Status
);
3876 // Show the dialog first to avoid long time not reaction.
3878 gBS
->SignalEvent (RefreshIntervalEvent
);
3880 Status
= gBS
->SetTimer (RefreshIntervalEvent
, TimerPeriodic
, ONE_SECOND
);
3881 ASSERT_EFI_ERROR (Status
);
3884 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3885 if (!EFI_ERROR (Status
) && Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3889 if (Status
!= EFI_NOT_READY
) {
3893 WaitList
[0] = TimeOutEvent
;
3894 WaitList
[1] = gST
->ConIn
->WaitForKey
;
3896 Status
= gBS
->WaitForEvent (2, WaitList
, &Index
);
3897 ASSERT_EFI_ERROR (Status
);
3901 // Timeout occur, close the hoot time out event.
3907 gBS
->CloseEvent (TimeOutEvent
);
3908 gBS
->CloseEvent (RefreshIntervalEvent
);
3913 if (StringToken
!= 0) {
3914 FreePool (ErrorInfo
);
3919 Display one form, and return user input.
3921 @param FormData Form Data to be shown.
3922 @param UserInputData User input data.
3924 @retval EFI_SUCCESS 1.Form Data is shown, and user input is got.
3925 2.Error info has show and return.
3926 @retval EFI_INVALID_PARAMETER The input screen dimension is not valid
3927 @retval EFI_NOT_FOUND New form data has some error.
3932 IN FORM_DISPLAY_ENGINE_FORM
*FormData
,
3933 OUT USER_INPUT
*UserInputData
3938 ASSERT (FormData
!= NULL
);
3939 if (FormData
== NULL
) {
3940 return EFI_INVALID_PARAMETER
;
3943 gUserInput
= UserInputData
;
3944 gFormData
= FormData
;
3947 // Process the status info first.
3949 BrowserStatusProcess();
3950 if (gFormData
->BrowserStatus
!= BROWSER_SUCCESS
) {
3952 // gFormData->BrowserStatus != BROWSER_SUCCESS, means only need to print the error info, return here.
3957 Status
= DisplayPageFrame (FormData
, &gStatementDimensions
);
3958 if (EFI_ERROR (Status
)) {
3963 // Global Widths should be initialized before any MenuOption creation
3964 // or the GetWidth() used in UiAddMenuOption() will return incorrect value.
3968 // |<-.->|<-.........->|<- .........->|<-...........->|
3969 // Skip Prompt Option Help
3971 gOptionBlockWidth
= (CHAR16
) ((gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
) / 3) + 1;
3972 gHelpBlockWidth
= (CHAR16
) (gOptionBlockWidth
- 1 - LEFT_SKIPPED_COLUMNS
);
3973 gPromptBlockWidth
= (CHAR16
) (gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
- 2 * (gOptionBlockWidth
- 1) - 1);
3975 ConvertStatementToMenu();
3978 // Check whether layout is changed.
3981 || (gOldFormEntry
.HiiHandle
!= FormData
->HiiHandle
)
3982 || (!CompareGuid (&gOldFormEntry
.FormSetGuid
, &FormData
->FormSetGuid
))
3983 || (gOldFormEntry
.FormId
!= FormData
->FormId
)) {
3984 mStatementLayoutIsChanged
= TRUE
;
3986 mStatementLayoutIsChanged
= FALSE
;
3989 Status
= UiDisplayMenu(FormData
);
3992 // Backup last form info.
3994 mIsFirstForm
= FALSE
;
3995 gOldFormEntry
.HiiHandle
= FormData
->HiiHandle
;
3996 CopyGuid (&gOldFormEntry
.FormSetGuid
, &FormData
->FormSetGuid
);
3997 gOldFormEntry
.FormId
= FormData
->FormId
;
4003 Clear Screen to the initial state.
4007 DriverClearDisplayPage (
4011 ClearDisplayPage ();
4012 mIsFirstForm
= TRUE
;
4016 Set Buffer to Value for Size bytes.
4018 @param Buffer Memory to set.
4019 @param Size Number of bytes to set
4020 @param Value Value of the set operation.
4033 while ((Size
--) != 0) {
4039 Initialize Setup Browser driver.
4041 @param ImageHandle The image handle.
4042 @param SystemTable The system table.
4044 @retval EFI_SUCCESS The Setup Browser module is initialized correctly..
4045 @return Other value if failed to initialize the Setup Browser module.
4050 InitializeDisplayEngine (
4051 IN EFI_HANDLE ImageHandle
,
4052 IN EFI_SYSTEM_TABLE
*SystemTable
4056 EFI_INPUT_KEY HotKey
;
4057 EFI_STRING NewString
;
4058 EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL
*FormBrowserEx2
;
4061 // Publish our HII data
4063 gHiiHandle
= HiiAddPackages (
4064 &gDisplayEngineGuid
,
4066 DisplayEngineStrings
,
4069 ASSERT (gHiiHandle
!= NULL
);
4072 // Install Form Display protocol
4074 Status
= gBS
->InstallProtocolInterface (
4075 &mPrivateData
.Handle
,
4076 &gEdkiiFormDisplayEngineProtocolGuid
,
4077 EFI_NATIVE_INTERFACE
,
4078 &mPrivateData
.FromDisplayProt
4080 ASSERT_EFI_ERROR (Status
);
4082 InitializeDisplayStrings();
4084 ZeroMem (&gHighligthMenuInfo
, sizeof (gHighligthMenuInfo
));
4085 ZeroMem (&gOldFormEntry
, sizeof (gOldFormEntry
));
4088 // Use BrowserEx2 protocol to register HotKey.
4090 Status
= gBS
->LocateProtocol (&gEdkiiFormBrowserEx2ProtocolGuid
, NULL
, (VOID
**) &FormBrowserEx2
);
4091 if (!EFI_ERROR (Status
)) {
4093 // Register the default HotKey F9 and F10 again.
4095 HotKey
.UnicodeChar
= CHAR_NULL
;
4096 HotKey
.ScanCode
= SCAN_F10
;
4097 NewString
= HiiGetString (gHiiHandle
, STRING_TOKEN (FUNCTION_TEN_STRING
), NULL
);
4098 ASSERT (NewString
!= NULL
);
4099 FormBrowserEx2
->RegisterHotKey (&HotKey
, BROWSER_ACTION_SUBMIT
, 0, NewString
);
4101 HotKey
.ScanCode
= SCAN_F9
;
4102 NewString
= HiiGetString (gHiiHandle
, STRING_TOKEN (FUNCTION_NINE_STRING
), NULL
);
4103 ASSERT (NewString
!= NULL
);
4104 FormBrowserEx2
->RegisterHotKey (&HotKey
, BROWSER_ACTION_DEFAULT
, EFI_HII_DEFAULT_CLASS_STANDARD
, NewString
);
4111 This is the default unload handle for display core drivers.
4113 @param[in] ImageHandle The drivers' driver image.
4115 @retval EFI_SUCCESS The image is unloaded.
4116 @retval Others Failed to unload the image.
4121 UnloadDisplayEngine (
4122 IN EFI_HANDLE ImageHandle
4125 HiiRemovePackages(gHiiHandle
);
4127 FreeDisplayStrings ();
4129 if (gHighligthMenuInfo
.HLTOpCode
!= NULL
) {
4130 FreePool (gHighligthMenuInfo
.HLTOpCode
);
4133 if (gHighligthMenuInfo
.TOSOpCode
!= NULL
) {
4134 FreePool (gHighligthMenuInfo
.TOSOpCode
);