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.
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
48 } UI_SCREEN_OPERATION
;
74 #define UI_ACTION_NONE 0
75 #define UI_ACTION_REFRESH_FORM 1
76 #define UI_ACTION_REFRESH_FORMSET 2
77 #define UI_ACTION_EXIT 3
80 EFI_HII_HANDLE Handle
;
83 // Target formset/form/Question information
96 // Ation for Browser to taken:
97 // UI_ACTION_NONE - navigation inside a form
98 // UI_ACTION_REFRESH_FORM - re-evaluate expressions and repaint form
99 // UI_ACTION_REFRESH_FORMSET - re-parse formset IFR binary
104 // Current selected fomset/form/Question
106 FORM_BROWSER_FORMSET
*FormSet
;
107 FORM_BROWSER_FORM
*Form
;
108 FORM_BROWSER_STATEMENT
*Statement
;
111 // Whether the Form is editable
113 BOOLEAN FormEditable
;
116 #define UI_MENU_OPTION_SIGNATURE SIGNATURE_32 ('u', 'i', 'm', 'm')
117 #define UI_MENU_LIST_SIGNATURE SIGNATURE_32 ('u', 'i', 'm', 'l')
123 EFI_HII_HANDLE Handle
;
124 FORM_BROWSER_STATEMENT
*ThisTag
;
131 UINTN Skip
; // Number of lines
134 // Display item sequence for date/time
135 // Date: Month/Day/Year
138 // Time: Hour : Minute : Second
148 // Whether user could change value of this item
153 #define MENU_OPTION_FROM_LINK(a) CR (a, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE)
155 typedef struct _UI_MENU_LIST UI_MENU_LIST
;
157 struct _UI_MENU_LIST
{
161 EFI_GUID FormSetGuid
;
165 UI_MENU_LIST
*Parent
;
166 LIST_ENTRY ChildListHead
;
169 #define UI_MENU_LIST_FROM_LINK(a) CR (a, UI_MENU_LIST, Link, UI_MENU_LIST_SIGNATURE)
171 typedef struct _MENU_REFRESH_ENTRY
{
172 struct _MENU_REFRESH_ENTRY
*Next
;
173 UI_MENU_OPTION
*MenuOption
; // Describes the entry needing an update
174 UI_MENU_SELECTION
*Selection
;
177 UINTN CurrentAttribute
;
178 } MENU_REFRESH_ENTRY
;
182 UI_SCREEN_OPERATION ScreenOperation
;
183 } SCAN_CODE_TO_SCREEN_OPERATION
;
186 UI_SCREEN_OPERATION ScreenOperation
;
187 UI_CONTROL_FLAG ControlFlag
;
188 } SCREEN_OPERATION_T0_CONTROL_FLAG
;
191 extern LIST_ENTRY gMenuOption
;
192 extern MENU_REFRESH_ENTRY
*gMenuRefreshHead
;
193 extern UI_MENU_SELECTION
*gCurrentSelection
;
194 extern BOOLEAN mHiiPackageListUpdated
;
200 Initialize Menu option list.
209 Initialize Menu option list.
218 Free Menu option linked list.
227 Create a menu with specified formset GUID and form ID, and add it as a child
228 of the given parent menu.
230 @param Parent The parent of menu to be added.
231 @param FormSetGuid The Formset Guid of menu to be added.
232 @param FormId The Form ID of menu to be added.
234 @return A pointer to the newly added menu or NULL if memory is insufficient.
239 IN OUT UI_MENU_LIST
*Parent
,
240 IN EFI_GUID
*FormSetGuid
,
245 Search Menu with given FormId in the parent menu and all its child menus.
247 @param Parent The parent of menu to search.
248 @param FormId The Form ID of menu to search.
250 @return A pointer to menu found or NULL if not found.
254 UiFindChildMenuList (
255 IN UI_MENU_LIST
*Parent
,
260 Search Menu with given FormSetGuid and FormId in all cached menu list.
262 @param FormSetGuid The Formset GUID of the menu to search.
263 @param FormId The Form ID of menu to search.
265 @return A pointer to menu found or NULL if not found.
270 IN EFI_GUID
*FormSetGuid
,
275 Free Menu option linked list.
284 Add one menu option by specified description and context.
286 @param String String description for this option.
287 @param Handle Hii handle for the package list.
288 @param Statement Statement of this Menu Option.
289 @param NumberOfLines Display lines for this Menu Option.
290 @param MenuItemCount The index for this Option in the Menu.
292 @retval Pointer Pointer to the added Menu Option.
298 IN EFI_HII_HANDLE Handle
,
299 IN FORM_BROWSER_STATEMENT
*Statement
,
300 IN UINT16 NumberOfLines
,
301 IN UINT16 MenuItemCount
305 Display menu and wait for user to select one menu option, then return it.
306 If AutoBoot is enabled, then if user doesn't select any option,
307 after period of time, it will automatically return the first menu option.
309 @param Selection Menu selection.
311 @return Return the pointer of the menu which selected,
312 @return otherwise return NULL.
317 IN OUT UI_MENU_SELECTION
*Selection
321 Free up the resource allocated for all strings required
331 The worker function that send the displays to the screen. On output,
332 the selection made by user is returned.
334 @param Selection On input, Selection tell setup browser the information
335 about the Selection, form and formset to be displayed.
336 On output, Selection return the screen item that is selected
339 @retval EFI_SUCCESS The page is displayed successfully.
340 @return Other value if the page failed to be diplayed.
345 IN OUT UI_MENU_SELECTION
*Selection
349 Set Buffer to Value for Size bytes.
351 @param Buffer Memory to set.
352 @param Size Number of bytes to set
353 @param Value Value of the set operation.
364 Wait for a given event to fire, or for an optional timeout to expire.
366 @param Event The event to wait for
367 @param Timeout An optional timeout value in 100 ns units.
368 @param RefreshInterval Menu refresh interval (in seconds).
370 @retval EFI_SUCCESS Event fired before Timeout expired.
371 @retval EFI_TIME_OUT Timout expired before Event fired.
375 UiWaitForSingleEvent (
377 IN UINT64 Timeout
, OPTIONAL
378 IN UINT8 RefreshInterval OPTIONAL
382 Draw a pop up windows based on the dimension, number of lines and
385 @param ScreenWidth The width of the pop-up.
386 @param NumberOfLines The number of lines.
387 @param ... A series of text strings that displayed in the pop-up.
391 CreateMultiStringPopUp (
392 IN UINTN ScreenWidth
,
393 IN UINTN NumberOfLines
,
398 Get string or password input from user.
400 @param MenuOption Pointer to the current input menu.
401 @param Prompt The prompt string shown on popup window.
402 @param StringPtr Destination for use input string.
404 @retval EFI_SUCCESS If string input is read successfully
405 @retval EFI_DEVICE_ERROR If operation fails
410 IN UI_MENU_OPTION
*MenuOption
,
412 OUT CHAR16
*StringPtr
416 Get selection for OneOf and OrderedList (Left/Right will be ignored).
418 @param Selection Pointer to current selection.
419 @param MenuOption Pointer to the current input menu.
421 @retval EFI_SUCCESS If Option input is processed successfully
422 @retval EFI_DEVICE_ERROR If operation fails
426 GetSelectionInputPopUp (
427 IN UI_MENU_SELECTION
*Selection
,
428 IN UI_MENU_OPTION
*MenuOption
432 This routine reads a numeric value from the user input.
434 @param Selection Pointer to current selection.
435 @param MenuOption Pointer to the current input menu.
437 @retval EFI_SUCCESS If numerical input is read successfully
438 @retval EFI_DEVICE_ERROR If operation fails
443 IN UI_MENU_SELECTION
*Selection
,
444 IN UI_MENU_OPTION
*MenuOption
448 Update status bar on the bottom of menu.
450 @param MessageType The type of message to be shown.
451 @param Flags The flags in Question header.
452 @param State Set or clear.
457 IN UINTN MessageType
,
463 Process Question Config.
465 @param Selection The UI menu selection.
466 @param Question The Question to be peocessed.
468 @retval EFI_SUCCESS Question Config process success.
469 @retval Other Question Config process fail.
473 ProcessQuestionConfig (
474 IN UI_MENU_SELECTION
*Selection
,
475 IN FORM_BROWSER_STATEMENT
*Question
479 Print Question Value according to it's storage width and display attributes.
481 @param Question The Question to be printed.
482 @param FormattedNumber Buffer for output string.
483 @param BufferSize The FormattedNumber buffer size in bytes.
485 @retval EFI_SUCCESS Print success.
486 @retval EFI_BUFFER_TOO_SMALL Buffer size is not enough for formatted number.
490 PrintFormattedNumber (
491 IN FORM_BROWSER_STATEMENT
*Question
,
492 IN OUT CHAR16
*FormattedNumber
,
497 Search an Option of a Question by its value.
499 @param Question The Question
500 @param OptionValue Value for Option to be searched.
502 @retval Pointer Pointer to the found Option.
503 @retval NULL Option not found.
508 IN FORM_BROWSER_STATEMENT
*Question
,
509 IN EFI_HII_VALUE
*OptionValue
513 Return data element in an Array by its Index.
515 @param Array The data array.
516 @param Type Type of the data in this array.
517 @param Index Zero based index for data in this array.
519 @retval Value The data to be returned
530 Set value of a data element in an Array by its Index.
532 @param Array The data array.
533 @param Type Type of the data in this array.
534 @param Index Zero based index for data in this array.
535 @param Value The value to be set.
547 Process a Question's Option (whether selected or un-selected).
549 @param Selection Pointer to UI_MENU_SELECTION.
550 @param MenuOption The MenuOption for this Question.
551 @param Selected TRUE: if Question is selected.
552 @param OptionString Pointer of the Option String to be displayed.
554 @retval EFI_SUCCESS Question Option process success.
555 @retval Other Question Option process fail.
560 IN UI_MENU_SELECTION
*Selection
,
561 IN UI_MENU_OPTION
*MenuOption
,
563 OUT CHAR16
**OptionString
567 Process the help string: Split StringPtr to several lines of strings stored in
568 FormattedString and the glyph width of each line cannot exceed gHelpBlockWidth.
570 @param StringPtr The entire help string.
571 @param FormattedString The oupput formatted string.
572 @param RowCount TRUE: if Question is selected.
577 IN CHAR16
*StringPtr
,
578 OUT CHAR16
**FormattedString
,
583 Update key's help imformation.
585 @param Selection Tell setup browser the information about the Selection
586 @param MenuOption The Menu option
587 @param Selected Whether or not a tag be selected
592 IN UI_MENU_SELECTION
*Selection
,
593 IN UI_MENU_OPTION
*MenuOption
,
598 Clear retangle with specified text attribute.
600 @param LeftColumn Left column of retangle.
601 @param RightColumn Right column of retangle.
602 @param TopRow Start row of retangle.
603 @param BottomRow End row of retangle.
604 @param TextAttribute The character foreground and background.
610 IN UINTN RightColumn
,
613 IN UINTN TextAttribute
617 Count the storage space of a Unicode string.
619 This function handles the Unicode string with NARROW_CHAR
620 and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR
621 does not count in the resultant output. If a WIDE_CHAR is
622 hit, then 2 Unicode character will consume an output storage
623 space with size of CHAR16 till a NARROW_CHAR is hit.
625 @param String The input string to be counted.
627 @return Storage space for the input string.
636 Will copy LineWidth amount of a string in the OutputString buffer and return the
637 number of CHAR16 characters that were copied into the OutputString buffer.
639 @param InputString String description for this option.
640 @param LineWidth Width of the desired string to extract in CHAR16
642 @param Index Where in InputString to start the copy process
643 @param OutputString Buffer to copy the string into
645 @return Returns the number of CHAR16 characters that were copied into the OutputString buffer.
650 IN CHAR16
*InputString
,
653 OUT CHAR16
**OutputString
657 Get the supported width for a particular op-code
659 @param Statement The FORM_BROWSER_STATEMENT structure passed in.
660 @param Handle The handle in the HII database being used
662 @return Returns the number of CHAR16 characters that is support.
667 IN FORM_BROWSER_STATEMENT
*Statement
,
668 IN EFI_HII_HANDLE Handle
672 Concatenate a narrow string to another string.
674 @param Destination The destination string.
675 @param Source The source string. The string to be concatenated.
676 to the end of Destination.
681 IN OUT CHAR16
*Destination
,
686 Wait for a key to be pressed by user.
688 @param Key The key which is pressed by user.
690 @retval EFI_SUCCESS The function always completed successfully.
695 OUT EFI_INPUT_KEY
*Key
699 Reset stack pointer to begin of the stack.
708 Push an Operand onto the Stack
710 @param Operand Operand to push.
712 @retval EFI_SUCCESS The value was pushed onto the stack.
713 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
723 Pop an Operand from the Stack
725 @param Operand Operand to pop.
727 @retval EFI_SUCCESS The value was pushed onto the stack.
728 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
738 Get Form given its FormId.
740 @param FormSet The formset which contains this form.
741 @param FormId Id of this form.
743 @retval Pointer The form.
744 @retval NULL Specified Form is not found in the formset.
749 IN FORM_BROWSER_FORMSET
*FormSet
,
754 Search a Question in Formset scope using its QuestionId.
756 @param FormSet The formset which contains this form.
757 @param Form The form which contains this Question.
758 @param QuestionId Id of this Question.
760 @retval Pointer The Question.
761 @retval NULL Specified Question not found in the form.
764 FORM_BROWSER_STATEMENT
*
766 IN FORM_BROWSER_FORMSET
*FormSet
,
767 IN FORM_BROWSER_FORM
*Form
,
772 Zero extend integer/boolean/date/time to UINT64 for comparing.
774 @param Value HII Value to be converted.
779 IN EFI_HII_VALUE
*Value
783 Compare two Hii value.
785 @param Value1 Expression value to compare on left-hand.
786 @param Value2 Expression value to compare on right-hand.
787 @param HiiHandle Only required for string compare.
789 @retval EFI_INVALID_PARAMETER Could not perform comparation on two values.
790 @retval 0 Two operators equeal.
791 @return Positive value if Value1 is greater than Value2.
792 @retval Negative value if Value1 is less than Value2.
797 IN EFI_HII_VALUE
*Value1
,
798 IN EFI_HII_VALUE
*Value2
,
799 IN EFI_HII_HANDLE HiiHandle OPTIONAL
803 Evaluate the result of a HII expression
805 If Expression is NULL, then ASSERT.
807 @param FormSet FormSet associated with this expression.
808 @param Form Form associated with this expression.
809 @param Expression Expression to be evaluated.
811 @retval EFI_SUCCESS The expression evaluated successfuly
812 @retval EFI_NOT_FOUND The Question which referenced by a QuestionId
814 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
816 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
817 @retval EFI_INVALID_PARAMETER Syntax error with the Expression
822 IN FORM_BROWSER_FORMSET
*FormSet
,
823 IN FORM_BROWSER_FORM
*Form
,
824 IN OUT FORM_EXPRESSION
*Expression