2 Private structure, MACRO and function definitions for User Interface related functionalities.
4 Copyright (c) 2004 - 2009, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
23 #define REGULAR_NUMERIC 0
24 #define TIME_NUMERIC 1
25 #define DATE_NUMERIC 2
27 #define SUBTITLE_INDENT 2
31 // It take 23 characters including the NULL to print a 64 bits number with "[" and "]".
32 // pow(2, 64) = [18446744073709551616]
34 #define MAX_NUMERIC_INPUT_WIDTH 23
50 } UI_SCREEN_OPERATION
;
76 #define UI_ACTION_NONE 0
77 #define UI_ACTION_REFRESH_FORM 1
78 #define UI_ACTION_REFRESH_FORMSET 2
79 #define UI_ACTION_EXIT 3
82 EFI_HII_HANDLE Handle
;
85 // Target formset/form/Question information
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
;
118 #define UI_MENU_OPTION_SIGNATURE SIGNATURE_32 ('u', 'i', 'm', 'm')
119 #define UI_MENU_LIST_SIGNATURE SIGNATURE_32 ('u', 'i', 'm', 'l')
125 EFI_HII_HANDLE Handle
;
126 FORM_BROWSER_STATEMENT
*ThisTag
;
133 UINTN Skip
; // Number of lines
136 // Display item sequence for date/time
137 // Date: Month/Day/Year
140 // Time: Hour : Minute : Second
150 // Whether user could change value of this item
155 #define MENU_OPTION_FROM_LINK(a) CR (a, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE)
157 typedef struct _UI_MENU_LIST UI_MENU_LIST
;
159 struct _UI_MENU_LIST
{
163 EFI_GUID FormSetGuid
;
167 UI_MENU_LIST
*Parent
;
168 LIST_ENTRY ChildListHead
;
171 #define UI_MENU_LIST_FROM_LINK(a) CR (a, UI_MENU_LIST, Link, UI_MENU_LIST_SIGNATURE)
173 typedef struct _MENU_REFRESH_ENTRY
{
174 struct _MENU_REFRESH_ENTRY
*Next
;
175 UI_MENU_OPTION
*MenuOption
; // Describes the entry needing an update
176 UI_MENU_SELECTION
*Selection
;
179 UINTN CurrentAttribute
;
180 } MENU_REFRESH_ENTRY
;
184 UI_SCREEN_OPERATION ScreenOperation
;
185 } SCAN_CODE_TO_SCREEN_OPERATION
;
188 UI_SCREEN_OPERATION ScreenOperation
;
189 UI_CONTROL_FLAG ControlFlag
;
190 } SCREEN_OPERATION_T0_CONTROL_FLAG
;
193 extern LIST_ENTRY gMenuOption
;
194 extern MENU_REFRESH_ENTRY
*gMenuRefreshHead
;
195 extern UI_MENU_SELECTION
*gCurrentSelection
;
196 extern BOOLEAN mHiiPackageListUpdated
;
202 Initialize Menu option list.
211 Initialize Menu option list.
220 Free Menu option linked list.
229 Create a menu with specified formset GUID and form ID, and add it as a child
230 of the given parent menu.
232 @param Parent The parent of menu to be added.
233 @param FormSetGuid The Formset Guid of menu to be added.
234 @param FormId The Form ID of menu to be added.
236 @return A pointer to the newly added menu or NULL if memory is insufficient.
241 IN OUT UI_MENU_LIST
*Parent
,
242 IN EFI_GUID
*FormSetGuid
,
247 Search Menu with given FormId in the parent menu and all its child menus.
249 @param Parent The parent of menu to search.
250 @param FormId The Form ID of menu to search.
252 @return A pointer to menu found or NULL if not found.
256 UiFindChildMenuList (
257 IN UI_MENU_LIST
*Parent
,
262 Search Menu with given FormSetGuid and FormId in all cached menu list.
264 @param FormSetGuid The Formset GUID of the menu to search.
265 @param FormId The Form ID of menu to search.
267 @return A pointer to menu found or NULL if not found.
272 IN EFI_GUID
*FormSetGuid
,
277 Free Menu option linked list.
286 Add one menu option by specified description and context.
288 @param String String description for this option.
289 @param Handle Hii handle for the package list.
290 @param Statement Statement of this Menu Option.
291 @param NumberOfLines Display lines for this Menu Option.
292 @param MenuItemCount The index for this Option in the Menu.
294 @retval Pointer Pointer to the added Menu Option.
300 IN EFI_HII_HANDLE Handle
,
301 IN FORM_BROWSER_STATEMENT
*Statement
,
302 IN UINT16 NumberOfLines
,
303 IN UINT16 MenuItemCount
307 Display menu and wait for user to select one menu option, then return it.
308 If AutoBoot is enabled, then if user doesn't select any option,
309 after period of time, it will automatically return the first menu option.
311 @param Selection Menu selection.
313 @return Return the pointer of the menu which selected,
314 @return otherwise return NULL.
319 IN OUT UI_MENU_SELECTION
*Selection
323 Free up the resource allocated for all strings required
333 The worker function that send the displays to the screen. On output,
334 the selection made by user is returned.
336 @param Selection On input, Selection tell setup browser the information
337 about the Selection, form and formset to be displayed.
338 On output, Selection return the screen item that is selected
341 @retval EFI_SUCCESS The page is displayed successfully.
342 @return Other value if the page failed to be diplayed.
347 IN OUT UI_MENU_SELECTION
*Selection
351 VSPrint worker function that prints a Value as a decimal number in Buffer.
353 @param Buffer Location to place ascii decimal number string of Value.
354 @param Flags Flags to use in printing decimal string, see file header for
356 @param Value Decimal value to convert to a string in Buffer.
358 @return Number of characters printed.
369 Set Buffer to Value for Size bytes.
371 @param Buffer Memory to set.
372 @param Size Number of bytes to set
373 @param Value Value of the set operation.
384 Wait for a given event to fire, or for an optional timeout to expire.
386 @param Event The event to wait for
387 @param Timeout An optional timeout value in 100 ns units.
388 @param RefreshInterval Menu refresh interval (in seconds).
390 @retval EFI_SUCCESS Event fired before Timeout expired.
391 @retval EFI_TIME_OUT Timout expired before Event fired.
395 UiWaitForSingleEvent (
397 IN UINT64 Timeout
, OPTIONAL
398 IN UINT8 RefreshInterval OPTIONAL
402 Draw a pop up windows based on the dimension, number of lines and
405 @param ScreenWidth The width of the pop-up.
406 @param NumberOfLines The number of lines.
407 @param ... A series of text strings that displayed in the pop-up.
411 CreateMultiStringPopUp (
412 IN UINTN ScreenWidth
,
413 IN UINTN NumberOfLines
,
418 Get string or password input from user.
420 @param MenuOption Pointer to the current input menu.
421 @param Prompt The prompt string shown on popup window.
422 @param StringPtr Destination for use input string.
424 @retval EFI_SUCCESS If string input is read successfully
425 @retval EFI_DEVICE_ERROR If operation fails
430 IN UI_MENU_OPTION
*MenuOption
,
432 OUT CHAR16
*StringPtr
436 Get selection for OneOf and OrderedList (Left/Right will be ignored).
438 @param Selection Pointer to current selection.
439 @param MenuOption Pointer to the current input menu.
441 @retval EFI_SUCCESS If Option input is processed successfully
442 @retval EFI_DEVICE_ERROR If operation fails
446 GetSelectionInputPopUp (
447 IN UI_MENU_SELECTION
*Selection
,
448 IN UI_MENU_OPTION
*MenuOption
452 This routine reads a numeric value from the user input.
454 @param Selection Pointer to current selection.
455 @param MenuOption Pointer to the current input menu.
457 @retval EFI_SUCCESS If numerical input is read successfully
458 @retval EFI_DEVICE_ERROR If operation fails
463 IN UI_MENU_SELECTION
*Selection
,
464 IN UI_MENU_OPTION
*MenuOption
468 Update status bar on the bottom of menu.
470 @param MessageType The type of message to be shown.
471 @param Flags The flags in Question header.
472 @param State Set or clear.
477 IN UINTN MessageType
,
483 Process Question Config.
485 @param Selection The UI menu selection.
486 @param Question The Question to be peocessed.
488 @retval EFI_SUCCESS Question Config process success.
489 @retval Other Question Config process fail.
493 ProcessQuestionConfig (
494 IN UI_MENU_SELECTION
*Selection
,
495 IN FORM_BROWSER_STATEMENT
*Question
499 Print Question Value according to it's storage width and display attributes.
501 @param Question The Question to be printed.
502 @param FormattedNumber Buffer for output string.
503 @param BufferSize The FormattedNumber buffer size in bytes.
505 @retval EFI_SUCCESS Print success.
506 @retval EFI_BUFFER_TOO_SMALL Buffer size is not enough for formatted number.
510 PrintFormattedNumber (
511 IN FORM_BROWSER_STATEMENT
*Question
,
512 IN OUT CHAR16
*FormattedNumber
,
517 Search an Option of a Question by its value.
519 @param Question The Question
520 @param OptionValue Value for Option to be searched.
522 @retval Pointer Pointer to the found Option.
523 @retval NULL Option not found.
528 IN FORM_BROWSER_STATEMENT
*Question
,
529 IN EFI_HII_VALUE
*OptionValue
533 Return data element in an Array by its Index.
535 @param Array The data array.
536 @param Type Type of the data in this array.
537 @param Index Zero based index for data in this array.
539 @retval Value The data to be returned
550 Set value of a data element in an Array by its Index.
552 @param Array The data array.
553 @param Type Type of the data in this array.
554 @param Index Zero based index for data in this array.
555 @param Value The value to be set.
567 Process a Question's Option (whether selected or un-selected).
569 @param Selection Pointer to UI_MENU_SELECTION.
570 @param MenuOption The MenuOption for this Question.
571 @param Selected TRUE: if Question is selected.
572 @param OptionString Pointer of the Option String to be displayed.
574 @retval EFI_SUCCESS Question Option process success.
575 @retval Other Question Option process fail.
580 IN UI_MENU_SELECTION
*Selection
,
581 IN UI_MENU_OPTION
*MenuOption
,
583 OUT CHAR16
**OptionString
587 Process the help string: Split StringPtr to several lines of strings stored in
588 FormattedString and the glyph width of each line cannot exceed gHelpBlockWidth.
590 @param StringPtr The entire help string.
591 @param FormattedString The oupput formatted string.
592 @param RowCount TRUE: if Question is selected.
597 IN CHAR16
*StringPtr
,
598 OUT CHAR16
**FormattedString
,
603 Update key's help imformation.
605 @param Selection Tell setup browser the information about the Selection
606 @param MenuOption The Menu option
607 @param Selected Whether or not a tag be selected
612 IN UI_MENU_SELECTION
*Selection
,
613 IN UI_MENU_OPTION
*MenuOption
,
618 Clear retangle with specified text attribute.
620 @param LeftColumn Left column of retangle.
621 @param RightColumn Right column of retangle.
622 @param TopRow Start row of retangle.
623 @param BottomRow End row of retangle.
624 @param TextAttribute The character foreground and background.
630 IN UINTN RightColumn
,
633 IN UINTN TextAttribute
637 Count the storage space of a Unicode string.
639 This function handles the Unicode string with NARROW_CHAR
640 and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR
641 does not count in the resultant output. If a WIDE_CHAR is
642 hit, then 2 Unicode character will consume an output storage
643 space with size of CHAR16 till a NARROW_CHAR is hit.
645 @param String The input string to be counted.
647 @return Storage space for the input string.
656 Will copy LineWidth amount of a string in the OutputString buffer and return the
657 number of CHAR16 characters that were copied into the OutputString buffer.
659 @param InputString String description for this option.
660 @param LineWidth Width of the desired string to extract in CHAR16
662 @param Index Where in InputString to start the copy process
663 @param OutputString Buffer to copy the string into
665 @return Returns the number of CHAR16 characters that were copied into the OutputString buffer.
670 IN CHAR16
*InputString
,
673 OUT CHAR16
**OutputString
677 Get the supported width for a particular op-code
679 @param Statement The FORM_BROWSER_STATEMENT structure passed in.
680 @param Handle The handle in the HII database being used
682 @return Returns the number of CHAR16 characters that is support.
687 IN FORM_BROWSER_STATEMENT
*Statement
,
688 IN EFI_HII_HANDLE Handle
692 Concatenate a narrow string to another string.
694 @param Destination The destination string.
695 @param Source The source string. The string to be concatenated.
696 to the end of Destination.
701 IN OUT CHAR16
*Destination
,
706 Wait for a key to be pressed by user.
708 @param Key The key which is pressed by user.
710 @retval EFI_SUCCESS The function always completed successfully.
715 OUT EFI_INPUT_KEY
*Key
719 Reset stack pointer to begin of the stack.
728 Push an Operand onto the Stack
730 @param Operand Operand to push.
732 @retval EFI_SUCCESS The value was pushed onto the stack.
733 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
743 Pop an Operand from the Stack
745 @param Operand Operand to pop.
747 @retval EFI_SUCCESS The value was pushed onto the stack.
748 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
758 Get Form given its FormId.
760 @param FormSet The formset which contains this form.
761 @param FormId Id of this form.
763 @retval Pointer The form.
764 @retval NULL Specified Form is not found in the formset.
769 IN FORM_BROWSER_FORMSET
*FormSet
,
774 Search a Question in Formset scope using its QuestionId.
776 @param FormSet The formset which contains this form.
777 @param Form The form which contains this Question.
778 @param QuestionId Id of this Question.
780 @retval Pointer The Question.
781 @retval NULL Specified Question not found in the form.
784 FORM_BROWSER_STATEMENT
*
786 IN FORM_BROWSER_FORMSET
*FormSet
,
787 IN FORM_BROWSER_FORM
*Form
,
792 Zero extend integer/boolean/date/time to UINT64 for comparing.
794 @param Value HII Value to be converted.
799 IN EFI_HII_VALUE
*Value
803 Compare two Hii value.
805 @param Value1 Expression value to compare on left-hand.
806 @param Value2 Expression value to compare on right-hand.
807 @param HiiHandle Only required for string compare.
809 @retval EFI_INVALID_PARAMETER Could not perform comparation on two values.
810 @retval 0 Two operators equeal.
811 @return Positive value if Value1 is greater than Value2.
812 @retval Negative value if Value1 is less than Value2.
817 IN EFI_HII_VALUE
*Value1
,
818 IN EFI_HII_VALUE
*Value2
,
819 IN EFI_HII_HANDLE HiiHandle OPTIONAL
823 Evaluate the result of a HII expression
825 If Expression is NULL, then ASSERT.
827 @param FormSet FormSet associated with this expression.
828 @param Form Form associated with this expression.
829 @param Expression Expression to be evaluated.
831 @retval EFI_SUCCESS The expression evaluated successfuly
832 @retval EFI_NOT_FOUND The Question which referenced by a QuestionId
834 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
836 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
837 @retval EFI_INVALID_PARAMETER Syntax error with the Expression
842 IN FORM_BROWSER_FORMSET
*FormSet
,
843 IN FORM_BROWSER_FORM
*Form
,
844 IN OUT FORM_EXPRESSION
*Expression