2 Private structure, MACRO and function definitions for User Interface related functionalities.
4 Copyright (c) 2004 - 2007, 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
43 } UI_SCREEN_OPERATION
;
70 #define UI_ACTION_NONE 0
71 #define UI_ACTION_REFRESH_FORM 1
72 #define UI_ACTION_REFRESH_FORMSET 2
73 #define UI_ACTION_EXIT 3
76 EFI_HII_HANDLE Handle
;
79 // Target formset/form/Question information
92 // Ation for Browser to taken:
93 // UI_ACTION_NONE - navigation inside a form
94 // UI_ACTION_REFRESH_FORM - re-evaluate expressions and repaint form
95 // UI_ACTION_REFRESH_FORMSET - re-parse formset IFR binary
100 // Current selected fomset/form/Question
102 FORM_BROWSER_FORMSET
*FormSet
;
103 FORM_BROWSER_FORM
*Form
;
104 FORM_BROWSER_STATEMENT
*Statement
;
107 #define UI_MENU_OPTION_SIGNATURE EFI_SIGNATURE_32 ('u', 'i', 'm', 'm')
108 #define UI_MENU_LIST_SIGNATURE EFI_SIGNATURE_32 ('u', 'i', 'm', 'l')
114 EFI_HII_HANDLE Handle
;
115 FORM_BROWSER_STATEMENT
*ThisTag
;
122 UINTN Skip
; // Number of lines
125 // Display item sequence for date/time
126 // Date: Month/Day/Year
129 // Time: Hour : Minute : Second
139 #define MENU_OPTION_FROM_LINK(a) CR (a, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE)
149 typedef struct _MENU_REFRESH_ENTRY
{
150 struct _MENU_REFRESH_ENTRY
*Next
;
151 UI_MENU_OPTION
*MenuOption
; // Describes the entry needing an update
152 UI_MENU_SELECTION
*Selection
;
155 UINTN CurrentAttribute
;
156 } MENU_REFRESH_ENTRY
;
160 UI_SCREEN_OPERATION ScreenOperation
;
161 } SCAN_CODE_TO_SCREEN_OPERATION
;
164 UI_SCREEN_OPERATION ScreenOperation
;
165 UI_CONTROL_FLAG ControlFlag
;
166 } SCREEN_OPERATION_T0_CONTROL_FLAG
;
169 extern LIST_ENTRY gMenuList
;
170 extern MENU_REFRESH_ENTRY
*gMenuRefreshHead
;
171 extern UI_MENU_SELECTION
*gCurrentSelection
;
177 Initialize Menu option list.
187 Initialize Menu option list.
197 Remove a Menu in list, and return FormId/QuestionId for previous Menu.
199 @param Selection Menu selection.
203 UiRemoveMenuListEntry (
204 OUT UI_MENU_SELECTION
*Selection
209 Free Menu option linked list.
219 Add one menu entry to the linked lst
221 @param Selection Menu selection.
226 IN UI_MENU_SELECTION
*Selection
231 Free Menu option linked list.
241 Add one menu option by specified description and context.
243 @param String String description for this option.
244 @param Handle Hii handle for the package list.
245 @param Statement Statement of this Menu Option.
246 @param NumberOfLines Display lines for this Menu Option.
247 @param MenuItemCount The index for this Option in the Menu.
253 IN EFI_HII_HANDLE Handle
,
254 IN FORM_BROWSER_STATEMENT
*Statement
,
255 IN UINT16 NumberOfLines
,
256 IN UINT16 MenuItemCount
261 Display menu and wait for user to select one menu option, then return it.
262 If AutoBoot is enabled, then if user doesn't select any option,
263 after period of time, it will automatically return the first menu option.
265 @param Selection Menu selection.
267 @return Return the pointer of the menu which selected,
268 @return otherwise return NULL.
273 IN OUT UI_MENU_SELECTION
*Selection
278 Free up the resource allocated for all strings required
289 The worker function that send the displays to the screen. On output,
290 the selection made by user is returned.
292 @param Selection On input, Selection tell setup browser the information
293 about the Selection, form and formset to be displayed.
294 On output, Selection return the screen item that is selected
297 @retval EFI_SUCCESS The page is displayed successfully.
298 @return Other value if the page failed to be diplayed.
303 IN OUT UI_MENU_SELECTION
*Selection
308 VSPrint worker function that prints a Value as a decimal number in Buffer.
310 @param Buffer Location to place ascii decimal number string of Value.
311 @param Flags Flags to use in printing decimal string, see file header for
313 @param Value Decimal value to convert to a string in Buffer.
315 @return Number of characters printed.
327 Set Buffer to Value for Size bytes.
329 @param Buffer Memory to set.
330 @param Size Number of bytes to set
331 @param Value Value of the set operation.
343 Wait for a given event to fire, or for an optional timeout to expire.
345 @param Event The event to wait for
346 @param Timeout An optional timeout value in 100 ns units.
347 @param RefreshInterval Menu refresh interval (in seconds).
349 @retval EFI_SUCCESS Event fired before Timeout expired.
350 @retval EFI_TIME_OUT Timout expired before Event fired.
354 UiWaitForSingleEvent (
356 IN UINT64 Timeout
, OPTIONAL
357 IN UINT8 RefreshInterval OPTIONAL
362 Draw a pop up windows based on the dimension, number of lines and
365 @param RequestedWidth The width of the pop-up.
366 @param NumberOfLines The number of lines.
367 @param ... A series of text strings that displayed in the pop-up.
372 IN UINTN ScreenWidth
,
373 IN UINTN NumberOfLines
,
379 Get string or password input from user.
381 @param MenuOption Pointer to the current input menu.
382 @param Prompt The prompt string shown on popup window.
383 @param StringPtr Destination for use input string.
385 @retval EFI_SUCCESS If string input is read successfully
386 @retval EFI_DEVICE_ERROR If operation fails
391 IN UI_MENU_OPTION
*MenuOption
,
393 OUT CHAR16
*StringPtr
398 Get selection for OneOf and OrderedList (Left/Right will be ignored).
400 @param Selection Pointer to current selection.
401 @param MenuOption Pointer to the current input menu.
403 @retval EFI_SUCCESS If Option input is processed successfully
404 @retval EFI_DEVICE_ERROR If operation fails
408 GetSelectionInputPopUp (
409 IN UI_MENU_SELECTION
*Selection
,
410 IN UI_MENU_OPTION
*MenuOption
415 This routine reads a numeric value from the user input.
417 @param Selection Pointer to current selection.
418 @param MenuOption Pointer to the current input menu.
420 @retval EFI_SUCCESS If numerical input is read successfully
421 @retval EFI_DEVICE_ERROR If operation fails
426 IN UI_MENU_SELECTION
*Selection
,
427 IN UI_MENU_OPTION
*MenuOption
432 Update status bar on the bottom of menu.
434 @param MessageType The type of message to be shown.
435 @param Flags The flags in Question header.
436 @param State Set or clear.
441 IN UINTN MessageType
,
448 Process Question Config.
450 @param Selection The UI menu selection.
451 @param Question The Question to be peocessed.
453 @retval EFI_SUCCESS Question Config process success.
454 @retval Other Question Config process fail.
458 ProcessQuestionConfig (
459 IN UI_MENU_SELECTION
*Selection
,
460 IN FORM_BROWSER_STATEMENT
*Question
465 Print Question Value according to it's storage width and display attributes.
467 @param Question The Question to be printed.
468 @param FormattedNumber Buffer for output string.
469 @param BufferSize The FormattedNumber buffer size in bytes.
471 @retval EFI_SUCCESS Print success.
472 @retval EFI_BUFFER_TOO_SMALL Buffer size is not enough for formatted number.
476 PrintFormattedNumber (
477 IN FORM_BROWSER_STATEMENT
*Question
,
478 IN OUT CHAR16
*FormattedNumber
,
484 Search an Option of a Question by its value.
486 @param Question The Question
487 @param OptionValue Value for Option to be searched.
489 @retval Pointer Pointer to the found Option.
490 @retval NULL Option not found.
495 IN FORM_BROWSER_STATEMENT
*Question
,
496 IN EFI_HII_VALUE
*OptionValue
501 Process a Question's Option (whether selected or un-selected).
503 @param Selection Pointer to UI_MENU_SELECTION.
504 @param MenuOption The MenuOption for this Question.
505 @param Selected TRUE: if Question is selected.
506 @param OptionString Pointer of the Option String to be displayed.
508 @retval EFI_SUCCESS Question Option process success.
509 @retval Other Question Option process fail.
514 IN UI_MENU_SELECTION
*Selection
,
515 IN UI_MENU_OPTION
*MenuOption
,
517 OUT CHAR16
**OptionString
522 Process the help string: Split StringPtr to several lines of strings stored in
523 FormattedString and the glyph width of each line cannot exceed gHelpBlockWidth.
525 @param StringPtr The entire help string.
526 @param FormattedString The oupput formatted string.
527 @param RowCount TRUE: if Question is selected.
532 IN CHAR16
*StringPtr
,
533 OUT CHAR16
**FormattedString
,
539 Update key's help imformation.
541 @param MenuOption The Menu option
542 @param Selected Whether or not a tag be selected
547 IN UI_MENU_OPTION
*MenuOption
,
553 Clear retangle with specified text attribute.
555 @param LeftColumn Left column of retangle.
556 @param RightColumn Right column of retangle.
557 @param TopRow Start row of retangle.
558 @param BottomRow End row of retangle.
559 @param TextAttribute The character foreground and background.
573 Count the storage space of a Unicode string.
575 This function handles the Unicode string with NARROW_CHAR
576 and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR
577 does not count in the resultant output. If a WIDE_CHAR is
578 hit, then 2 Unicode character will consume an output storage
579 space with size of CHAR16 till a NARROW_CHAR is hit.
581 @param String The input string to be counted.
583 @return Storage space for the input string.
593 Will copy LineWidth amount of a string in the OutputString buffer and return the
594 number of CHAR16 characters that were copied into the OutputString buffer.
596 @param InputString String description for this option.
597 @param LineWidth Width of the desired string to extract in CHAR16
599 @param Index Where in InputString to start the copy process
600 @param OutputString Buffer to copy the string into
602 @return Returns the number of CHAR16 characters that were copied into the OutputString buffer.
607 IN CHAR16
*InputString
,
610 OUT CHAR16
**OutputString
615 Get the supported width for a particular op-code
617 @param Statement The FORM_BROWSER_STATEMENT structure passed in.
618 @param Handle The handle in the HII database being used
620 @return Returns the number of CHAR16 characters that is support.
625 IN FORM_BROWSER_STATEMENT
*Statement
,
626 IN EFI_HII_HANDLE Handle
631 Concatenate a narrow string to another string.
633 @param Destination The destination string.
634 @param Source The source string. The string to be concatenated.
635 to the end of Destination.
646 Wait for a key to be pressed by user.
648 @param Key The key which is pressed by user.
650 @retval EFI_SUCCESS The function always completed successfully.
655 OUT EFI_INPUT_KEY
*Key
660 Reset stack pointer to begin of the stack.
670 Push an Operand onto the Stack
672 @param Operand Operand to push.
674 @retval EFI_SUCCESS The value was pushed onto the stack.
675 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
686 Pop an Operand from the Stack
688 @param Operand Operand to pop.
690 @retval EFI_SUCCESS The value was pushed onto the stack.
691 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
702 Get Form given its FormId.
704 @param FormSet The formset which contains this form.
705 @param FormId Id of this form.
707 @retval Pointer The form.
708 @retval NULL Specified Form is not found in the formset.
713 IN FORM_BROWSER_FORMSET
*FormSet
,
719 Search a Question in Formset scope using its QuestionId.
721 @param FormSet The formset which contains this form.
722 @param Form The form which contains this Question.
723 @param QuestionId Id of this Question.
725 @retval Pointer The Question.
726 @retval NULL Specified Question not found in the form.
729 FORM_BROWSER_STATEMENT
*
731 IN FORM_BROWSER_FORMSET
*FormSet
,
732 IN FORM_BROWSER_FORM
*Form
,
738 Zero extend integer/boolean/date/time to UINT64 for comparing.
740 @param Value HII Value to be converted.
745 IN EFI_HII_VALUE
*Value
750 Compare two Hii value.
752 @param Value1 Expression value to compare on left-hand.
753 @param Value2 Expression value to compare on right-hand.
754 @param HiiHandle Only required for string compare.
756 @retval EFI_INVALID_PARAMETER Could not perform comparation on two values.
757 @retval 0 Two operators equeal.
758 @return Positive value if Value1 is greater than Value2.
759 @retval Negative value if Value1 is less than Value2.
764 IN EFI_HII_VALUE
*Value1
,
765 IN EFI_HII_VALUE
*Value2
,
766 IN EFI_HII_HANDLE HiiHandle OPTIONAL
771 Evaluate the result of a HII expression
773 @param FormSet FormSet associated with this expression.
774 @param Form Form associated with this expression.
775 @param Expression Expression to be evaluated.
777 @retval EFI_SUCCESS The expression evaluated successfuly
778 @retval EFI_NOT_FOUND The Question which referenced by a QuestionId
780 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
782 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
783 @retval EFI_INVALID_PARAMETER Syntax error with the Expression
788 IN FORM_BROWSER_FORMSET
*FormSet
,
789 IN FORM_BROWSER_FORM
*Form
,
790 IN OUT FORM_EXPRESSION
*Expression