2 Private structure, MACRO and function definitions for User Interface related functionalities.
4 Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21 #define REGULAR_NUMERIC 0
22 #define TIME_NUMERIC 1
23 #define DATE_NUMERIC 2
25 #define SUBTITLE_INDENT 2
29 // It take 23 characters including the NULL to print a 64 bits number with "[" and "]".
30 // pow(2, 64) = [18446744073709551616]
32 #define MAX_NUMERIC_INPUT_WIDTH 23
47 } UI_SCREEN_OPERATION
;
73 #define UI_ACTION_NONE 0
74 #define UI_ACTION_REFRESH_FORM 1
75 #define UI_ACTION_REFRESH_FORMSET 2
76 #define UI_ACTION_EXIT 3
78 typedef struct _UI_MENU_LIST UI_MENU_LIST
;
81 EFI_HII_HANDLE Handle
;
84 // Target formset/form/Question information
89 UINTN Sequence
; // used for time/date only.
98 // Ation for Browser to taken:
99 // UI_ACTION_NONE - navigation inside a form
100 // UI_ACTION_REFRESH_FORM - re-evaluate expressions and repaint form
101 // UI_ACTION_REFRESH_FORMSET - re-parse formset IFR binary
106 // Current selected fomset/form/Question
108 FORM_BROWSER_FORMSET
*FormSet
;
109 FORM_BROWSER_FORM
*Form
;
110 FORM_BROWSER_STATEMENT
*Statement
;
113 // Whether the Form is editable
115 BOOLEAN FormEditable
;
117 UI_MENU_LIST
*CurrentMenu
;
120 #define UI_MENU_OPTION_SIGNATURE SIGNATURE_32 ('u', 'i', 'm', 'm')
121 #define UI_MENU_LIST_SIGNATURE SIGNATURE_32 ('u', 'i', 'm', 'l')
127 EFI_HII_HANDLE Handle
;
128 FORM_BROWSER_STATEMENT
*ThisTag
;
135 UINTN Skip
; // Number of lines
138 // Display item sequence for date/time
139 // Date: Month/Day/Year
142 // Time: Hour : Minute : Second
152 // Whether user could change value of this item
157 #define MENU_OPTION_FROM_LINK(a) CR (a, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE)
159 struct _UI_MENU_LIST
{
163 EFI_HII_HANDLE HiiHandle
;
164 EFI_GUID FormSetGuid
;
167 UINTN Sequence
; // used for time/date only.
169 UI_MENU_LIST
*Parent
;
170 LIST_ENTRY ChildListHead
;
173 #define UI_MENU_LIST_FROM_LINK(a) CR (a, UI_MENU_LIST, Link, UI_MENU_LIST_SIGNATURE)
175 typedef struct _MENU_REFRESH_ENTRY MENU_REFRESH_ENTRY
;
176 struct _MENU_REFRESH_ENTRY
{
177 MENU_REFRESH_ENTRY
*Next
;
178 UI_MENU_OPTION
*MenuOption
; // Describes the entry needing an update
179 UI_MENU_SELECTION
*Selection
;
182 UINTN CurrentAttribute
;
188 UI_SCREEN_OPERATION ScreenOperation
;
189 } SCAN_CODE_TO_SCREEN_OPERATION
;
192 UI_SCREEN_OPERATION ScreenOperation
;
193 UI_CONTROL_FLAG ControlFlag
;
194 } SCREEN_OPERATION_T0_CONTROL_FLAG
;
197 extern LIST_ENTRY gMenuOption
;
198 extern MENU_REFRESH_ENTRY
*gMenuRefreshHead
;
199 extern UI_MENU_SELECTION
*gCurrentSelection
;
200 extern BOOLEAN mHiiPackageListUpdated
;
206 Initialize Menu option list.
215 Initialize Menu option list.
224 Free Menu option linked list.
233 Create a menu with specified formset GUID and form ID, and add it as a child
234 of the given parent menu.
236 @param Parent The parent of menu to be added.
237 @param HiiHandle Hii handle related to this formset.
238 @param FormSetGuid The Formset Guid of menu to be added.
239 @param FormId The Form ID of menu to be added.
241 @return A pointer to the newly added menu or NULL if memory is insufficient.
246 IN OUT UI_MENU_LIST
*Parent
,
247 IN EFI_HII_HANDLE HiiHandle
,
248 IN EFI_GUID
*FormSetGuid
,
253 Search Menu with given FormId in the parent menu and all its child menus.
255 @param Parent The parent of menu to search.
256 @param FormSetGuid The Formset GUID of the menu to search.
257 @param FormId The Form ID of menu to search.
259 @return A pointer to menu found or NULL if not found.
263 UiFindChildMenuList (
264 IN UI_MENU_LIST
*Parent
,
265 IN EFI_GUID
*FormSetGuid
,
270 Search Menu with given FormSetGuid and FormId in all cached menu list.
272 @param FormSetGuid The Formset GUID of the menu to search.
273 @param FormId The Form ID of menu to search.
275 @return A pointer to menu found or NULL if not found.
280 IN EFI_GUID
*FormSetGuid
,
285 Free Menu option linked list.
294 Add one menu option by specified description and context.
296 @param String String description for this option.
297 @param Handle Hii handle for the package list.
298 @param Form The form this statement belong to.
299 @param Statement Statement of this Menu Option.
300 @param NumberOfLines Display lines for this Menu Option.
301 @param MenuItemCount The index for this Option in the Menu.
303 @retval Pointer Pointer to the added Menu Option.
309 IN EFI_HII_HANDLE Handle
,
310 IN FORM_BROWSER_FORM
*Form
,
311 IN FORM_BROWSER_STATEMENT
*Statement
,
312 IN UINT16 NumberOfLines
,
313 IN UINT16 MenuItemCount
317 Display menu and wait for user to select one menu option, then return it.
318 If AutoBoot is enabled, then if user doesn't select any option,
319 after period of time, it will automatically return the first menu option.
321 @param Selection Menu selection.
323 @return Return the pointer of the menu which selected,
324 @return otherwise return NULL.
329 IN OUT UI_MENU_SELECTION
*Selection
333 Free up the resource allocated for all strings required
343 Process the goto op code, update the info in the selection structure.
345 @param Statement The statement belong to goto op code.
346 @param Selection The selection info.
347 @param Repaint Whether need to repaint the menu.
348 @param NewLine Whether need to create new line.
350 @retval EFI_SUCCESS The menu process successfully.
351 @return Other value if the process failed.
355 IN OUT FORM_BROWSER_STATEMENT
*Statement
,
356 IN OUT UI_MENU_SELECTION
*Selection
,
357 OUT BOOLEAN
*Repaint
,
363 The worker function that send the displays to the screen. On output,
364 the selection made by user is returned.
366 @param Selection On input, Selection tell setup browser the information
367 about the Selection, form and formset to be displayed.
368 On output, Selection return the screen item that is selected
371 @retval EFI_SUCCESS The page is displayed successfully.
372 @return Other value if the page failed to be diplayed.
377 IN OUT UI_MENU_SELECTION
*Selection
381 Set Buffer to Value for Size bytes.
383 @param Buffer Memory to set.
384 @param Size Number of bytes to set
385 @param Value Value of the set operation.
396 Wait for a given event to fire, or for an optional timeout to expire.
398 @param Event The event to wait for
399 @param Timeout An optional timeout value in 100 ns units.
400 @param RefreshInterval Menu refresh interval (in seconds).
402 @retval EFI_SUCCESS Event fired before Timeout expired.
403 @retval EFI_TIME_OUT Timout expired before Event fired.
407 UiWaitForSingleEvent (
409 IN UINT64 Timeout
, OPTIONAL
410 IN UINT8 RefreshInterval OPTIONAL
414 Draw a pop up windows based on the dimension, number of lines and
417 @param ScreenWidth The width of the pop-up.
418 @param NumberOfLines The number of lines.
419 @param ... A series of text strings that displayed in the pop-up.
424 CreateMultiStringPopUp (
425 IN UINTN ScreenWidth
,
426 IN UINTN NumberOfLines
,
431 Get string or password input from user.
433 @param MenuOption Pointer to the current input menu.
434 @param Prompt The prompt string shown on popup window.
435 @param StringPtr Old user input and destination for use input string.
437 @retval EFI_SUCCESS If string input is read successfully
438 @retval EFI_DEVICE_ERROR If operation fails
443 IN UI_MENU_OPTION
*MenuOption
,
445 IN OUT CHAR16
*StringPtr
449 Get selection for OneOf and OrderedList (Left/Right will be ignored).
451 @param Selection Pointer to current selection.
452 @param MenuOption Pointer to the current input menu.
454 @retval EFI_SUCCESS If Option input is processed successfully
455 @retval EFI_DEVICE_ERROR If operation fails
459 GetSelectionInputPopUp (
460 IN UI_MENU_SELECTION
*Selection
,
461 IN UI_MENU_OPTION
*MenuOption
465 This routine reads a numeric value from the user input.
467 @param Selection Pointer to current selection.
468 @param MenuOption Pointer to the current input menu.
470 @retval EFI_SUCCESS If numerical input is read successfully
471 @retval EFI_DEVICE_ERROR If operation fails
476 IN UI_MENU_SELECTION
*Selection
,
477 IN UI_MENU_OPTION
*MenuOption
481 Update status bar on the bottom of menu.
483 @param Selection Current selection info.
484 @param MessageType The type of message to be shown.
485 @param Flags The flags in Question header.
486 @param State Set or clear.
491 IN UI_MENU_SELECTION
*Selection
,
492 IN UINTN MessageType
,
498 Process Question Config.
500 @param Selection The UI menu selection.
501 @param Question The Question to be peocessed.
503 @retval EFI_SUCCESS Question Config process success.
504 @retval Other Question Config process fail.
508 ProcessQuestionConfig (
509 IN UI_MENU_SELECTION
*Selection
,
510 IN FORM_BROWSER_STATEMENT
*Question
514 Print Question Value according to it's storage width and display attributes.
516 @param Question The Question to be printed.
517 @param FormattedNumber Buffer for output string.
518 @param BufferSize The FormattedNumber buffer size in bytes.
520 @retval EFI_SUCCESS Print success.
521 @retval EFI_BUFFER_TOO_SMALL Buffer size is not enough for formatted number.
525 PrintFormattedNumber (
526 IN FORM_BROWSER_STATEMENT
*Question
,
527 IN OUT CHAR16
*FormattedNumber
,
532 Search an Option of a Question by its value.
534 @param Question The Question
535 @param OptionValue Value for Option to be searched.
537 @retval Pointer Pointer to the found Option.
538 @retval NULL Option not found.
543 IN FORM_BROWSER_STATEMENT
*Question
,
544 IN EFI_HII_VALUE
*OptionValue
548 Return data element in an Array by its Index.
550 @param Array The data array.
551 @param Type Type of the data in this array.
552 @param Index Zero based index for data in this array.
554 @retval Value The data to be returned
565 Set value of a data element in an Array by its Index.
567 @param Array The data array.
568 @param Type Type of the data in this array.
569 @param Index Zero based index for data in this array.
570 @param Value The value to be set.
582 Process a Question's Option (whether selected or un-selected).
584 @param Selection Pointer to UI_MENU_SELECTION.
585 @param MenuOption The MenuOption for this Question.
586 @param Selected TRUE: if Question is selected.
587 @param OptionString Pointer of the Option String to be displayed.
589 @retval EFI_SUCCESS Question Option process success.
590 @retval Other Question Option process fail.
595 IN UI_MENU_SELECTION
*Selection
,
596 IN UI_MENU_OPTION
*MenuOption
,
598 OUT CHAR16
**OptionString
602 Process the help string: Split StringPtr to several lines of strings stored in
603 FormattedString and the glyph width of each line cannot exceed gHelpBlockWidth.
605 @param StringPtr The entire help string.
606 @param FormattedString The oupput formatted string.
607 @param EachLineWidth The string length of each line in the formatted string.
608 @param RowCount TRUE: if Question is selected.
613 IN CHAR16
*StringPtr
,
614 OUT CHAR16
**FormattedString
,
615 OUT UINT16
*EachLineWidth
,
620 Update key's help imformation.
622 @param Selection Tell setup browser the information about the Selection
623 @param MenuOption The Menu option
624 @param Selected Whether or not a tag be selected
629 IN UI_MENU_SELECTION
*Selection
,
630 IN UI_MENU_OPTION
*MenuOption
,
635 Clear retangle with specified text attribute.
637 @param LeftColumn Left column of retangle.
638 @param RightColumn Right column of retangle.
639 @param TopRow Start row of retangle.
640 @param BottomRow End row of retangle.
641 @param TextAttribute The character foreground and background.
647 IN UINTN RightColumn
,
650 IN UINTN TextAttribute
654 Count the storage space of a Unicode string.
656 This function handles the Unicode string with NARROW_CHAR
657 and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR
658 does not count in the resultant output. If a WIDE_CHAR is
659 hit, then 2 Unicode character will consume an output storage
660 space with size of CHAR16 till a NARROW_CHAR is hit.
662 If String is NULL, then ASSERT ().
664 @param String The input string to be counted.
666 @return Storage space for the input string.
675 Will copy LineWidth amount of a string in the OutputString buffer and return the
676 number of CHAR16 characters that were copied into the OutputString buffer.
677 In the code, it deals \r,\n,\r\n same as \n\r, also it not process the \r or \g.
679 @param InputString String description for this option.
680 @param LineWidth Width of the desired string to extract in CHAR16
682 @param GlyphWidth The glyph width of the beging char in the string.
683 @param Index Where in InputString to start the copy process
684 @param OutputString Buffer to copy the string into
686 @return Returns the number of CHAR16 characters that were copied into the OutputString buffer.
691 IN CHAR16
*InputString
,
693 IN OUT UINT16
*GlyphWidth
,
695 OUT CHAR16
**OutputString
699 Get the supported width for a particular op-code
701 @param Statement The FORM_BROWSER_STATEMENT structure passed in.
702 @param Handle The handle in the HII database being used
704 @return Returns the number of CHAR16 characters that is support.
709 IN FORM_BROWSER_STATEMENT
*Statement
,
710 IN EFI_HII_HANDLE Handle
714 Concatenate a narrow string to another string.
716 @param Destination The destination string.
717 @param Source The source string. The string to be concatenated.
718 to the end of Destination.
723 IN OUT CHAR16
*Destination
,
728 Wait for a key to be pressed by user.
730 @param Key The key which is pressed by user.
732 @retval EFI_SUCCESS The function always completed successfully.
737 OUT EFI_INPUT_KEY
*Key
741 Reset stack pointer to begin of the stack.
750 Push the expression options onto the Stack.
752 @param Pointer Pointer to the current expression.
753 @param Level Which type this expression belong to. Form,
756 @retval EFI_SUCCESS The value was pushed onto the stack.
757 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
761 PushConditionalExpression (
762 IN FORM_EXPRESSION
*Pointer
,
763 IN EXPRESS_LEVEL Level
767 Pop the expression options from the Stack
769 @param Level Which type this expression belong to. Form,
772 @retval EFI_SUCCESS The value was pushed onto the stack.
773 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
777 PopConditionalExpression (
778 IN EXPRESS_LEVEL Level
782 Get the expression Buffer pointer.
784 @param Level Which type this expression belong to. Form,
787 @retval The start pointer of the expression buffer or NULL.
791 GetConditionalExpressionList (
792 IN EXPRESS_LEVEL Level
796 Get the expression list count.
798 @param Level Which type this expression belong to. Form,
801 @retval >=0 The expression count
802 @retval -1 Input parameter error.
806 GetConditionalExpressionCount (
807 IN EXPRESS_LEVEL Level
811 Push an Operand onto the Stack
813 @param Operand Operand to push.
815 @retval EFI_SUCCESS The value was pushed onto the stack.
816 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
826 Pop an Operand from the Stack
828 @param Operand Operand to pop.
830 @retval EFI_SUCCESS The value was pushed onto the stack.
831 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
841 Reset stack pointer to begin of the stack.
845 ResetCurrentExpressionStack (
850 Push current expression onto the Stack
852 @param Pointer Pointer to current expression.
854 @retval EFI_SUCCESS The value was pushed onto the stack.
855 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
859 PushCurrentExpression (
864 Pop current expression from the Stack
866 @param Pointer Pointer to current expression to be pop.
868 @retval EFI_SUCCESS The value was pushed onto the stack.
869 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
873 PopCurrentExpression (
878 Reset stack pointer to begin of the stack.
882 ResetMapExpressionListStack (
887 Push the list of map expression onto the Stack
889 @param Pointer Pointer to the list of map expression to be pushed.
891 @retval EFI_SUCCESS The value was pushed onto the stack.
892 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
896 PushMapExpressionList (
901 Pop the list of map expression from the Stack
903 @param Pointer Pointer to the list of map expression to be pop.
905 @retval EFI_SUCCESS The value was pushed onto the stack.
906 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
910 PopMapExpressionList (
915 Get Form given its FormId.
917 @param FormSet The formset which contains this form.
918 @param FormId Id of this form.
920 @retval Pointer The form.
921 @retval NULL Specified Form is not found in the formset.
926 IN FORM_BROWSER_FORMSET
*FormSet
,
931 Search a Question in Formset scope using its QuestionId.
933 @param FormSet The formset which contains this form.
934 @param Form The form which contains this Question.
935 @param QuestionId Id of this Question.
937 @retval Pointer The Question.
938 @retval NULL Specified Question not found in the form.
941 FORM_BROWSER_STATEMENT
*
943 IN FORM_BROWSER_FORMSET
*FormSet
,
944 IN FORM_BROWSER_FORM
*Form
,
949 Zero extend integer/boolean/date/time to UINT64 for comparing.
951 @param Value HII Value to be converted.
956 IN EFI_HII_VALUE
*Value
960 Compare two Hii value.
962 @param Value1 Expression value to compare on left-hand.
963 @param Value2 Expression value to compare on right-hand.
964 @param Result Return value after compare.
965 retval 0 Two operators equal.
966 return Positive value if Value1 is greater than Value2.
967 retval Negative value if Value1 is less than Value2.
968 @param HiiHandle Only required for string compare.
970 @retval other Could not perform compare on two values.
971 @retval EFI_SUCCESS Compare the value success.
976 IN EFI_HII_VALUE
*Value1
,
977 IN EFI_HII_VALUE
*Value2
,
979 IN EFI_HII_HANDLE HiiHandle OPTIONAL
983 Evaluate the result of a HII expression
985 If Expression is NULL, then ASSERT.
987 @param FormSet FormSet associated with this expression.
988 @param Form Form associated with this expression.
989 @param Expression Expression to be evaluated.
991 @retval EFI_SUCCESS The expression evaluated successfuly
992 @retval EFI_NOT_FOUND The Question which referenced by a QuestionId
994 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
996 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
997 @retval EFI_INVALID_PARAMETER Syntax error with the Expression
1001 EvaluateExpression (
1002 IN FORM_BROWSER_FORMSET
*FormSet
,
1003 IN FORM_BROWSER_FORM
*Form
,
1004 IN OUT FORM_EXPRESSION
*Expression
1008 Return the result of the expression list. Check the expression list and
1009 return the highest priority express result.
1010 Priority: DisableIf > SuppressIf > GrayOutIf > FALSE
1012 @param ExpList The input expression list.
1013 @param Evaluate Whether need to evaluate the expression first.
1014 @param FormSet FormSet associated with this expression. Only
1015 needed when Evaluate is TRUE
1016 @param Form Form associated with this expression. Only
1017 needed when Evaluate is TRUE
1019 @retval EXPRESS_RESULT Return the higher priority express result.
1020 DisableIf > SuppressIf > GrayOutIf > FALSE
1024 EvaluateExpressionList (
1025 IN FORM_EXPRESSION_LIST
*ExpList
,
1026 IN BOOLEAN Evaluate
,
1027 IN FORM_BROWSER_FORMSET
*FormSet
, OPTIONAL
1028 IN FORM_BROWSER_FORM
*Form OPTIONAL
1032 Transfer the device path string to binary format.
1034 @param StringPtr The device path string info.
1036 @retval Device path binary info.
1039 EFI_DEVICE_PATH_PROTOCOL
*
1040 ConvertDevicePathFromText (
1041 IN CHAR16
*StringPtr