[mirror_edk2.git] / MdeModulePkg / Universal / SetupBrowserDxe / Ui.h

/** @file\r
Private structure, MACRO and function definitions for User Interface related functionalities.\r
\r
Copyright (c) 2004 - 2007, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _UI_H_\r
#define _UI_H_\r
\r
#include "Setup.h"\r
\r
//\r
// Globals\r
//\r
#define REGULAR_NUMERIC 0\r
#define TIME_NUMERIC    1\r
#define DATE_NUMERIC    2\r
\r
#define SUBTITLE_INDENT  2\r
\r
typedef enum {\r
  UiNoOperation,\r
  UiDefault,\r
  UiSelect,\r
  UiUp,\r
  UiDown,\r
  UiLeft,\r
  UiRight,\r
  UiReset,\r
  UiSave,\r
  UiPrevious,\r
  UiPageUp,\r
  UiPageDown,\r
  UiMaxOperation\r
} UI_SCREEN_OPERATION;\r
\r
typedef enum {\r
  CfInitialization,\r
  CfCheckSelection,\r
  CfRepaint,\r
  CfRefreshHighLight,\r
  CfUpdateHelpString,\r
  CfPrepareToReadKey,\r
  CfReadKey,\r
  CfScreenOperation,\r
  CfUiPrevious,\r
  CfUiSelect,\r
  CfUiReset,\r
  CfUiLeft,\r
  CfUiRight,\r
  CfUiUp,\r
  CfUiPageUp,\r
  CfUiPageDown,\r
  CfUiDown,\r
  CfUiSave,\r
  CfUiDefault,\r
  CfUiNoOperation,\r
  CfExit,\r
  CfMaxControlFlag\r
} UI_CONTROL_FLAG;\r
\r
#define UI_ACTION_NONE               0\r
#define UI_ACTION_REFRESH_FORM       1\r
#define UI_ACTION_REFRESH_FORMSET    2\r
#define UI_ACTION_EXIT               3\r
\r
typedef struct {\r
  EFI_HII_HANDLE  Handle;\r
\r
  //\r
  // Target formset/form/Question information\r
  //\r
  EFI_GUID        FormSetGuid;\r
  UINT16          FormId;\r
  UINT16          QuestionId;\r
\r
  UINTN           TopRow;\r
  UINTN           BottomRow;\r
  UINTN           PromptCol;\r
  UINTN           OptionCol;\r
  UINTN           CurrentRow;\r
\r
  //\r
  // Ation for Browser to taken:\r
  //   UI_ACTION_NONE            - navigation inside a form\r
  //   UI_ACTION_REFRESH_FORM    - re-evaluate expressions and repaint form\r
  //   UI_ACTION_REFRESH_FORMSET - re-parse formset IFR binary\r
  //\r
  UINTN           Action;\r
\r
  //\r
  // Current selected fomset/form/Question\r
  //\r
  FORM_BROWSER_FORMSET    *FormSet;\r
  FORM_BROWSER_FORM       *Form;\r
  FORM_BROWSER_STATEMENT  *Statement;\r
} UI_MENU_SELECTION;\r
\r
#define UI_MENU_OPTION_SIGNATURE  EFI_SIGNATURE_32 ('u', 'i', 'm', 'm')\r
#define UI_MENU_LIST_SIGNATURE    EFI_SIGNATURE_32 ('u', 'i', 'm', 'l')\r
\r
typedef struct {\r
  UINTN                   Signature;\r
  LIST_ENTRY              Link;\r
\r
  EFI_HII_HANDLE          Handle;\r
  FORM_BROWSER_STATEMENT  *ThisTag;\r
  UINT16                  EntryNumber;\r
\r
  UINTN                   Row;\r
  UINTN                   Col;\r
  UINTN                   OptCol;\r
  CHAR16                  *Description;\r
  UINTN                   Skip;           // Number of lines\r
\r
  //\r
  // Display item sequence for date/time\r
  //  Date:      Month/Day/Year\r
  //  Sequence:  0     1   2\r
  //\r
  //  Time:      Hour : Minute : Second\r
  //  Sequence:  0      1        2\r
  //\r
  //\r
  UINTN                   Sequence;\r
\r
  BOOLEAN                 GrayOut;\r
  BOOLEAN                 ReadOnly;\r
} UI_MENU_OPTION;\r
\r
#define MENU_OPTION_FROM_LINK(a)  CR (a, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE)\r
\r
typedef struct {\r
  UINTN           Signature;\r
  LIST_ENTRY      MenuLink;\r
\r
  UINT16          FormId;\r
  UINT16          QuestionId;\r
} UI_MENU_LIST;\r
\r
typedef struct _MENU_REFRESH_ENTRY {\r
  struct _MENU_REFRESH_ENTRY  *Next;\r
  UI_MENU_OPTION              *MenuOption;  // Describes the entry needing an update\r
  UI_MENU_SELECTION           *Selection;\r
  UINTN                       CurrentColumn;\r
  UINTN                       CurrentRow;\r
  UINTN                       CurrentAttribute;\r
} MENU_REFRESH_ENTRY;\r
\r
typedef struct {\r
  UINT16              ScanCode;\r
  UI_SCREEN_OPERATION ScreenOperation;\r
} SCAN_CODE_TO_SCREEN_OPERATION;\r
\r
typedef struct {\r
  UI_SCREEN_OPERATION ScreenOperation;\r
  UI_CONTROL_FLAG     ControlFlag;\r
} SCREEN_OPERATION_T0_CONTROL_FLAG;\r
\r
\r
extern LIST_ENTRY          gMenuList;\r
extern MENU_REFRESH_ENTRY  *gMenuRefreshHead;\r
extern UI_MENU_SELECTION   *gCurrentSelection;\r
\r
//\r
// Global Functions\r
//\r
/**\r
  Initialize Menu option list.\r
\r
**/\r
VOID\r
UiInitMenu (\r
  VOID\r
  )\r
;\r
\r
/**\r
  Initialize Menu option list.\r
\r
**/\r
VOID\r
UiInitMenuList (\r
  VOID\r
  )\r
;\r
\r
/**\r
  Remove a Menu in list, and return FormId/QuestionId for previous Menu.\r
\r
  @param  Selection              Menu selection.\r
\r
**/\r
VOID\r
UiRemoveMenuListEntry (\r
  OUT UI_MENU_SELECTION  *Selection\r
  )\r
;\r
\r
/**\r
  Free Menu option linked list.\r
\r
**/\r
VOID\r
UiFreeMenuList (\r
  VOID\r
  )\r
;\r
\r
/**\r
  Add one menu entry to the linked lst\r
\r
  @param  Selection              Menu selection.\r
\r
**/\r
VOID\r
UiAddMenuListEntry (\r
  IN UI_MENU_SELECTION            *Selection\r
  )\r
;\r
\r
/**\r
  Free Menu option linked list.\r
\r
**/\r
VOID\r
UiFreeMenu (\r
  VOID\r
  )\r
;\r
\r
/**\r
  Add one menu option by specified description and context.\r
\r
  @param  String                 String description for this option.\r
  @param  Handle                 Hii handle for the package list.\r
  @param  Statement              Statement of this Menu Option.\r
  @param  NumberOfLines          Display lines for this Menu Option.\r
  @param  MenuItemCount          The index for this Option in the Menu.\r
\r
**/\r
VOID\r
UiAddMenuOption (\r
  IN CHAR16                  *String,\r
  IN EFI_HII_HANDLE          Handle,\r
  IN FORM_BROWSER_STATEMENT  *Statement,\r
  IN UINT16                  NumberOfLines,\r
  IN UINT16                  MenuItemCount\r
  )\r
;\r
\r
/**\r
  Display menu and wait for user to select one menu option, then return it.\r
  If AutoBoot is enabled, then if user doesn't select any option,\r
  after period of time, it will automatically return the first menu option.\r
\r
  @param  Selection              Menu selection.\r
\r
  @return Return the pointer of the menu which selected,\r
  @return otherwise return NULL.\r
\r
**/\r
EFI_STATUS\r
UiDisplayMenu (\r
  IN OUT UI_MENU_SELECTION           *Selection\r
  )\r
;\r
\r
/**\r
  Free up the resource allocated for all strings required\r
  by Setup Browser.\r
\r
**/\r
VOID\r
FreeBrowserStrings (\r
  VOID\r
  )\r
;\r
\r
/**\r
  The worker function that send the displays to the screen. On output,\r
  the selection made by user is returned.\r
\r
  @param Selection       On input, Selection tell setup browser the information\r
                         about the Selection, form and formset to be displayed.\r
                         On output, Selection return the screen item that is selected\r
                         by user.\r
\r
  @retval EFI_SUCCESS    The page is displayed successfully.\r
  @return Other value if the page failed to be diplayed.\r
\r
**/\r
EFI_STATUS\r
SetupBrowser (\r
  IN OUT UI_MENU_SELECTION    *Selection\r
  )\r
;\r
\r
/**\r
  VSPrint worker function that prints a Value as a decimal number in Buffer.\r
\r
  @param  Buffer     Location to place ascii decimal number string of Value.\r
  @param  Flags      Flags to use in printing decimal string, see file header for\r
                     details.\r
  @param  Value      Decimal value to convert to a string in Buffer.\r
\r
  @return Number of characters printed.\r
\r
**/\r
VOID\r
ValueToString (\r
  IN CHAR16   *Buffer,\r
  IN BOOLEAN  Flags,\r
  IN INT64    Value\r
  )\r
;\r
\r
/**\r
  Set Buffer to Value for Size bytes.\r
\r
  @param  Buffer                 Memory to set.\r
  @param  Size                   Number of bytes to set\r
  @param  Value                  Value of the set operation.\r
\r
**/\r
VOID\r
SetUnicodeMem (\r
  IN VOID   *Buffer,\r
  IN UINTN  Size,\r
  IN CHAR16 Value\r
  )\r
;\r
\r
/**\r
  Wait for a given event to fire, or for an optional timeout to expire.\r
\r
  @param  Event                  The event to wait for\r
  @param  Timeout                An optional timeout value in 100 ns units.\r
  @param  RefreshInterval        Menu refresh interval (in seconds).\r
\r
  @retval EFI_SUCCESS            Event fired before Timeout expired.\r
  @retval EFI_TIME_OUT           Timout expired before Event fired.\r
\r
**/\r
EFI_STATUS\r
UiWaitForSingleEvent (\r
  IN EFI_EVENT                Event,\r
  IN UINT64                   Timeout, OPTIONAL\r
  IN UINT8                    RefreshInterval OPTIONAL\r
  )\r
;\r
\r
/**\r
  Draw a pop up windows based on the dimension, number of lines and\r
  strings specified.\r
\r
  @param RequestedWidth  The width of the pop-up.\r
  @param NumberOfLines   The number of lines.\r
  @param ...             A series of text strings that displayed in the pop-up.\r
\r
**/\r
VOID\r
CreatePopUp (\r
  IN  UINTN                       ScreenWidth,\r
  IN  UINTN                       NumberOfLines,\r
  ...\r
  )\r
;\r
\r
/**\r
  Get string or password input from user.\r
\r
  @param  MenuOption        Pointer to the current input menu.\r
  @param  Prompt            The prompt string shown on popup window.\r
  @param  StringPtr         Destination for use input string.\r
\r
  @retval EFI_SUCCESS       If string input is read successfully\r
  @retval EFI_DEVICE_ERROR  If operation fails\r
\r
**/\r
EFI_STATUS\r
ReadString (\r
  IN  UI_MENU_OPTION              *MenuOption,\r
  IN  CHAR16                      *Prompt,\r
  OUT CHAR16                      *StringPtr\r
  )\r
;\r
\r
/**\r
  Get selection for OneOf and OrderedList (Left/Right will be ignored).\r
\r
  @param  Selection         Pointer to current selection.\r
  @param  MenuOption        Pointer to the current input menu.\r
\r
  @retval EFI_SUCCESS       If Option input is processed successfully\r
  @retval EFI_DEVICE_ERROR  If operation fails\r
\r
**/\r
EFI_STATUS\r
GetSelectionInputPopUp (\r
  IN  UI_MENU_SELECTION           *Selection,\r
  IN  UI_MENU_OPTION              *MenuOption\r
  )\r
;\r
\r
/**\r
  This routine reads a numeric value from the user input.\r
\r
  @param  Selection         Pointer to current selection.\r
  @param  MenuOption        Pointer to the current input menu.\r
\r
  @retval EFI_SUCCESS       If numerical input is read successfully\r
  @retval EFI_DEVICE_ERROR  If operation fails\r
\r
**/\r
EFI_STATUS\r
GetNumericInput (\r
  IN  UI_MENU_SELECTION           *Selection,\r
  IN  UI_MENU_OPTION              *MenuOption\r
  )\r
;\r
\r
/**\r
  Update status bar on the bottom of menu.\r
\r
  @param  MessageType            The type of message to be shown.\r
  @param  Flags                  The flags in Question header.\r
  @param  State                  Set or clear.\r
\r
**/\r
VOID\r
UpdateStatusBar (\r
  IN  UINTN                       MessageType,\r
  IN  UINT8                       Flags,\r
  IN  BOOLEAN                     State\r
  )\r
;\r
\r
/**\r
  Process Question Config.\r
\r
  @param  Selection              The UI menu selection.\r
  @param  Question               The Question to be peocessed.\r
\r
  @retval EFI_SUCCESS            Question Config process success.\r
  @retval Other                  Question Config process fail.\r
\r
**/\r
EFI_STATUS\r
ProcessQuestionConfig (\r
  IN  UI_MENU_SELECTION       *Selection,\r
  IN  FORM_BROWSER_STATEMENT  *Question\r
  )\r
;\r
\r
/**\r
  Print Question Value according to it's storage width and display attributes.\r
\r
  @param  Question               The Question to be printed.\r
  @param  FormattedNumber        Buffer for output string.\r
  @param  BufferSize             The FormattedNumber buffer size in bytes.\r
\r
  @retval EFI_SUCCESS            Print success.\r
  @retval EFI_BUFFER_TOO_SMALL   Buffer size is not enough for formatted number.\r
\r
**/\r
EFI_STATUS\r
PrintFormattedNumber (\r
  IN FORM_BROWSER_STATEMENT   *Question,\r
  IN OUT CHAR16               *FormattedNumber,\r
  IN UINTN                    BufferSize\r
  )\r
;\r
\r
/**\r
  Search an Option of a Question by its value.\r
\r
  @param  Question               The Question\r
  @param  OptionValue            Value for Option to be searched.\r
\r
  @retval Pointer                Pointer to the found Option.\r
  @retval NULL                   Option not found.\r
\r
**/\r
QUESTION_OPTION *\r
ValueToOption (\r
  IN FORM_BROWSER_STATEMENT   *Question,\r
  IN EFI_HII_VALUE            *OptionValue\r
  )\r
;\r
\r
/**\r
  Process a Question's Option (whether selected or un-selected).\r
\r
  @param  Selection              Pointer to UI_MENU_SELECTION.\r
  @param  MenuOption             The MenuOption for this Question.\r
  @param  Selected               TRUE: if Question is selected.\r
  @param  OptionString           Pointer of the Option String to be displayed.\r
\r
  @retval EFI_SUCCESS            Question Option process success.\r
  @retval Other                  Question Option process fail.\r
\r
**/\r
EFI_STATUS\r
ProcessOptions (\r
  IN  UI_MENU_SELECTION           *Selection,\r
  IN  UI_MENU_OPTION              *MenuOption,\r
  IN  BOOLEAN                     Selected,\r
  OUT CHAR16                      **OptionString\r
  )\r
;\r
\r
/**\r
  Process the help string: Split StringPtr to several lines of strings stored in\r
  FormattedString and the glyph width of each line cannot exceed gHelpBlockWidth.\r
\r
  @param  StringPtr              The entire help string.\r
  @param  FormattedString        The oupput formatted string.\r
  @param  RowCount               TRUE: if Question is selected.\r
\r
**/\r
VOID\r
ProcessHelpString (\r
  IN  CHAR16                      *StringPtr,\r
  OUT CHAR16                      **FormattedString,\r
  IN  UINTN                       RowCount\r
  )\r
;\r
\r
/**\r
  Update key's help imformation.\r
\r
  @param  MenuOption     The Menu option\r
  @param  Selected       Whether or not a tag be selected\r
\r
**/\r
VOID\r
UpdateKeyHelp (\r
  IN  UI_MENU_OPTION              *MenuOption,\r
  IN  BOOLEAN                     Selected\r
  )\r
;\r
\r
/**\r
  Clear retangle with specified text attribute.\r
\r
  @param  LeftColumn     Left column of retangle.\r
  @param  RightColumn    Right column of retangle.\r
  @param  TopRow         Start row of retangle.\r
  @param  BottomRow      End row of retangle.\r
  @param  TextAttribute  The character foreground and background.\r
\r
**/\r
VOID\r
ClearLines (\r
  UINTN                                       LeftColumn,\r
  UINTN                                       RightColumn,\r
  UINTN                                       TopRow,\r
  UINTN                                       BottomRow,\r
  UINTN                                       TextAttribute\r
  )\r
;\r
\r
/**\r
  Count the storage space of a Unicode string.\r
\r
  This function handles the Unicode string with NARROW_CHAR\r
  and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR\r
  does not count in the resultant output. If a WIDE_CHAR is \r
  hit, then 2 Unicode character will consume an output storage\r
  space with size of CHAR16 till a NARROW_CHAR is hit.\r
\r
  @param String          The input string to be counted.\r
\r
  @return Storage space for the input string.\r
\r
**/\r
UINTN\r
GetStringWidth (\r
  CHAR16                                      *String\r
  )\r
;\r
\r
/**\r
  Will copy LineWidth amount of a string in the OutputString buffer and return the\r
  number of CHAR16 characters that were copied into the OutputString buffer.\r
\r
  @param  InputString            String description for this option.\r
  @param  LineWidth              Width of the desired string to extract in CHAR16\r
                                 characters\r
  @param  Index                  Where in InputString to start the copy process\r
  @param  OutputString           Buffer to copy the string into\r
\r
  @return Returns the number of CHAR16 characters that were copied into the OutputString buffer.\r
\r
**/\r
UINT16\r
GetLineByWidth (\r
  IN      CHAR16                      *InputString,\r
  IN      UINT16                      LineWidth,\r
  IN OUT  UINTN                       *Index,\r
  OUT     CHAR16                      **OutputString\r
  )\r
;\r
\r
/**\r
  Get the supported width for a particular op-code\r
\r
  @param  Statement              The FORM_BROWSER_STATEMENT structure passed in.\r
  @param  Handle                 The handle in the HII database being used\r
\r
  @return Returns the number of CHAR16 characters that is support.\r
\r
**/\r
UINT16\r
GetWidth (\r
  IN FORM_BROWSER_STATEMENT        *Statement,\r
  IN EFI_HII_HANDLE                 Handle\r
  )\r
;\r
\r
/**\r
  Concatenate a narrow string to another string.\r
\r
  @param Destination The destination string.\r
  @param Source      The source string. The string to be concatenated.\r
                     to the end of Destination.\r
\r
**/\r
VOID\r
NewStrCat (\r
  CHAR16                                      *Destination,\r
  CHAR16                                      *Source\r
  )\r
;\r
\r
/**\r
  Wait for a key to be pressed by user.\r
\r
  @param Key         The key which is pressed by user.\r
\r
  @retval EFI_SUCCESS The function always completed successfully.\r
\r
**/\r
EFI_STATUS\r
WaitForKeyStroke (\r
  OUT  EFI_INPUT_KEY           *Key\r
  )\r
;\r
\r
/**\r
  Reset stack pointer to begin of the stack.\r
\r
**/\r
VOID\r
ResetScopeStack (\r
  VOID\r
  )\r
;\r
\r
/**\r
  Push an Operand onto the Stack\r
\r
  @param  Operand                Operand to push.\r
\r
  @retval EFI_SUCCESS            The value was pushed onto the stack.\r
  @retval EFI_OUT_OF_RESOURCES   There is not enough system memory to grow the\r
                                 stack.\r
\r
**/\r
EFI_STATUS\r
PushScope (\r
  IN UINT8   Operand\r
  )\r
;\r
\r
/**\r
  Pop an Operand from the Stack\r
\r
  @param  Operand                Operand to pop.\r
\r
  @retval EFI_SUCCESS            The value was pushed onto the stack.\r
  @retval EFI_OUT_OF_RESOURCES   There is not enough system memory to grow the\r
                                 stack.\r
\r
**/\r
EFI_STATUS\r
PopScope (\r
  OUT UINT8     *Operand\r
  )\r
;\r
\r
/**\r
  Get Form given its FormId.\r
\r
  @param  FormSet                The formset which contains this form.\r
  @param  FormId                 Id of this form.\r
\r
  @retval Pointer                The form.\r
  @retval NULL                   Specified Form is not found in the formset.\r
\r
**/\r
FORM_BROWSER_FORM *\r
IdToForm (\r
  IN FORM_BROWSER_FORMSET  *FormSet,\r
  IN UINT16                FormId\r
  )\r
;\r
\r
/**\r
  Search a Question in Formset scope using its QuestionId.\r
\r
  @param  FormSet                The formset which contains this form.\r
  @param  Form                   The form which contains this Question.\r
  @param  QuestionId             Id of this Question.\r
\r
  @retval Pointer                The Question.\r
  @retval NULL                   Specified Question not found in the form.\r
\r
**/\r
FORM_BROWSER_STATEMENT *\r
IdToQuestion (\r
  IN FORM_BROWSER_FORMSET  *FormSet,\r
  IN FORM_BROWSER_FORM     *Form,\r
  IN UINT16                QuestionId\r
  )\r
;\r
\r
/**\r
  Zero extend integer/boolean/date/time to UINT64 for comparing.\r
\r
  @param  Value                  HII Value to be converted.\r
\r
**/\r
VOID\r
ExtendValueToU64 (\r
  IN  EFI_HII_VALUE   *Value\r
  )\r
;\r
\r
/**\r
  Compare two Hii value.\r
\r
  @param  Value1                 Expression value to compare on left-hand.\r
  @param  Value2                 Expression value to compare on right-hand.\r
  @param  HiiHandle              Only required for string compare.\r
\r
  @retval EFI_INVALID_PARAMETER  Could not perform comparation on two values.\r
  @retval 0                      Two operators equeal.\r
  @return Positive value if Value1 is greater than Value2.\r
  @retval Negative value if Value1 is less than Value2.\r
\r
**/\r
INTN\r
CompareHiiValue (\r
  IN  EFI_HII_VALUE   *Value1,\r
  IN  EFI_HII_VALUE   *Value2,\r
  IN  EFI_HII_HANDLE  HiiHandle OPTIONAL\r
  )\r
;\r
\r
/**\r
  Evaluate the result of a HII expression\r
\r
  @param  FormSet                FormSet associated with this expression.\r
  @param  Form                   Form associated with this expression.\r
  @param  Expression             Expression to be evaluated.\r
\r
  @retval EFI_SUCCESS            The expression evaluated successfuly\r
  @retval EFI_NOT_FOUND          The Question which referenced by a QuestionId\r
                                 could not be found.\r
  @retval EFI_OUT_OF_RESOURCES   There is not enough system memory to grow the\r
                                 stack.\r
  @retval EFI_ACCESS_DENIED      The pop operation underflowed the stack\r
  @retval EFI_INVALID_PARAMETER  Syntax error with the Expression\r
\r
**/\r
EFI_STATUS\r
EvaluateExpression (\r
  IN FORM_BROWSER_FORMSET  *FormSet,\r
  IN FORM_BROWSER_FORM     *Form,\r
  IN OUT FORM_EXPRESSION   *Expression\r
  )\r
;\r
\r
#endif // _UI_H\r
Commit	Line	Data
7936fb6a	1	/** @file\r
	2	Private structure, MACRO and function definitions for User Interface related functionalities.\r
	3	\r
	4	Copyright (c) 2004 - 2007, Intel Corporation\r
	5	All rights reserved. This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	**/\r
	14	\r
	15	#ifndef _UI_H_\r
	16	#define _UI_H_\r
	17	\r
	18	#include "Setup.h"\r
	19	\r
	20	//\r
	21	// Globals\r
	22	//\r
	23	#define REGULAR_NUMERIC 0\r
	24	#define TIME_NUMERIC 1\r
	25	#define DATE_NUMERIC 2\r
	26	\r
	27	#define SUBTITLE_INDENT 2\r
	28	\r
	29	typedef enum {\r
	30	UiNoOperation,\r
	31	UiDefault,\r
	32	UiSelect,\r
	33	UiUp,\r
	34	UiDown,\r
	35	UiLeft,\r
	36	UiRight,\r
	37	UiReset,\r
	38	UiSave,\r
	39	UiPrevious,\r
	40	UiPageUp,\r
	41	UiPageDown,\r
	42	UiMaxOperation\r
	43	} UI_SCREEN_OPERATION;\r
	44	\r
	45	typedef enum {\r
	46	CfInitialization,\r
	47	CfCheckSelection,\r
	48	CfRepaint,\r
	49	CfRefreshHighLight,\r
	50	CfUpdateHelpString,\r
	51	CfPrepareToReadKey,\r
	52	CfReadKey,\r
	53	CfScreenOperation,\r
	54	CfUiPrevious,\r
	55	CfUiSelect,\r
	56	CfUiReset,\r
	57	CfUiLeft,\r
	58	CfUiRight,\r
	59	CfUiUp,\r
	60	CfUiPageUp,\r
	61	CfUiPageDown,\r
	62	CfUiDown,\r
	63	CfUiSave,\r
	64	CfUiDefault,\r
65	CfUiNoOperation,\r
66	CfExit,\r
67	CfMaxControlFlag\r
68	} UI_CONTROL_FLAG;\r
69	\r
70	#define UI_ACTION_NONE 0\r
71	#define UI_ACTION_REFRESH_FORM 1\r
72	#define UI_ACTION_REFRESH_FORMSET 2\r
73	#define UI_ACTION_EXIT 3\r
74	\r
75	typedef struct {\r
76	EFI_HII_HANDLE Handle;\r
77	\r
78	//\r
79	// Target formset/form/Question information\r
80	//\r
81	EFI_GUID FormSetGuid;\r
82	UINT16 FormId;\r
83	UINT16 QuestionId;\r
84	\r
85	UINTN TopRow;\r
86	UINTN BottomRow;\r
87	UINTN PromptCol;\r
88	UINTN OptionCol;\r
89	UINTN CurrentRow;\r
90	\r
91	//\r
92	// Ation for Browser to taken:\r
93	// UI_ACTION_NONE - navigation inside a form\r
94	// UI_ACTION_REFRESH_FORM - re-evaluate expressions and repaint form\r
95	// UI_ACTION_REFRESH_FORMSET - re-parse formset IFR binary\r
96	//\r
97	UINTN Action;\r
98	\r
99	//\r
100	// Current selected fomset/form/Question\r
101	//\r
102	FORM_BROWSER_FORMSET *FormSet;\r
103	FORM_BROWSER_FORM *Form;\r
104	FORM_BROWSER_STATEMENT *Statement;\r
105	} UI_MENU_SELECTION;\r
106	\r
107	#define UI_MENU_OPTION_SIGNATURE EFI_SIGNATURE_32 ('u', 'i', 'm', 'm')\r
108	#define UI_MENU_LIST_SIGNATURE EFI_SIGNATURE_32 ('u', 'i', 'm', 'l')\r
109	\r
110	typedef struct {\r
111	UINTN Signature;\r
112	LIST_ENTRY Link;\r
113	\r
114	EFI_HII_HANDLE Handle;\r
115	FORM_BROWSER_STATEMENT *ThisTag;\r
116	UINT16 EntryNumber;\r
117	\r
118	UINTN Row;\r
119	UINTN Col;\r
120	UINTN OptCol;\r
121	CHAR16 *Description;\r
122	UINTN Skip; // Number of lines\r
123	\r
124	//\r
125	// Display item sequence for date/time\r
126	// Date: Month/Day/Year\r
127	// Sequence: 0 1 2\r
128	//\r
129	// Time: Hour : Minute : Second\r
130	// Sequence: 0 1 2\r
131	//\r
132	//\r
133	UINTN Sequence;\r
134	\r
135	BOOLEAN GrayOut;\r
136	BOOLEAN ReadOnly;\r
137	} UI_MENU_OPTION;\r
138	\r
139	#define MENU_OPTION_FROM_LINK(a) CR (a, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE)\r
140	\r
141	typedef struct {\r
142	UINTN Signature;\r
143	LIST_ENTRY MenuLink;\r
144	\r
145	UINT16 FormId;\r
146	UINT16 QuestionId;\r
147	} UI_MENU_LIST;\r
148	\r
149	typedef struct _MENU_REFRESH_ENTRY {\r
150	struct _MENU_REFRESH_ENTRY *Next;\r
151	UI_MENU_OPTION *MenuOption; // Describes the entry needing an update\r
152	UI_MENU_SELECTION *Selection;\r
153	UINTN CurrentColumn;\r
154	UINTN CurrentRow;\r
155	UINTN CurrentAttribute;\r
156	} MENU_REFRESH_ENTRY;\r
157	\r
158	typedef struct {\r
159	UINT16 ScanCode;\r
160	UI_SCREEN_OPERATION ScreenOperation;\r
161	} SCAN_CODE_TO_SCREEN_OPERATION;\r
162	\r
163	typedef struct {\r
164	UI_SCREEN_OPERATION ScreenOperation;\r
165	UI_CONTROL_FLAG ControlFlag;\r
166	} SCREEN_OPERATION_T0_CONTROL_FLAG;\r
167	\r
168	\r
169	extern LIST_ENTRY gMenuList;\r
170	extern MENU_REFRESH_ENTRY *gMenuRefreshHead;\r
171	extern UI_MENU_SELECTION *gCurrentSelection;\r
172	\r
173	//\r
174	// Global Functions\r
175	//\r
176	/**\r
177	Initialize Menu option list.\r
178	\r
179	**/\r
180	VOID\r
181	UiInitMenu (\r
182	VOID\r
183	)\r
184	;\r
185	\r
186	/**\r
187	Initialize Menu option list.\r
188	\r
189	**/\r
190	VOID\r
191	UiInitMenuList (\r
192	VOID\r
193	)\r
194	;\r
195	\r
196	/**\r
197	Remove a Menu in list, and return FormId/QuestionId for previous Menu.\r
198	\r
199	@param Selection Menu selection.\r
200	\r
201	**/\r
202	VOID\r
203	UiRemoveMenuListEntry (\r
204	OUT UI_MENU_SELECTION *Selection\r
205	)\r
206	;\r
207	\r
208	/**\r
209	Free Menu option linked list.\r
210	\r
211	**/\r
212	VOID\r
213	UiFreeMenuList (\r
214	VOID\r
215	)\r
216	;\r
217	\r
218	/**\r
219	Add one menu entry to the linked lst\r
220	\r
221	@param Selection Menu selection.\r
222	\r
223	**/\r
224	VOID\r
225	UiAddMenuListEntry (\r
226	IN UI_MENU_SELECTION *Selection\r
227	)\r
228	;\r
229	\r
230	/**\r
231	Free Menu option linked list.\r
232	\r
233	**/\r
234	VOID\r
235	UiFreeMenu (\r
236	VOID\r
237	)\r
238	;\r
239	\r
240	/**\r
241	Add one menu option by specified description and context.\r
242	\r
243	@param String String description for this option.\r
244	@param Handle Hii handle for the package list.\r
245	@param Statement Statement of this Menu Option.\r
246	@param NumberOfLines Display lines for this Menu Option.\r
247	@param MenuItemCount The index for this Option in the Menu.\r
248	\r
249	**/\r
250	VOID\r
251	UiAddMenuOption (\r
252	IN CHAR16 *String,\r
253	IN EFI_HII_HANDLE Handle,\r
254	IN FORM_BROWSER_STATEMENT *Statement,\r
255	IN UINT16 NumberOfLines,\r
256	IN UINT16 MenuItemCount\r
257	)\r
258	;\r
259	\r
260	/**\r
261	Display menu and wait for user to select one menu option, then return it.\r
262	If AutoBoot is enabled, then if user doesn't select any option,\r
263	after period of time, it will automatically return the first menu option.\r
264	\r
265	@param Selection Menu selection.\r
266	\r
267	@return Return the pointer of the menu which selected,\r
268	@return otherwise return NULL.\r
269	\r
270	**/\r
271	EFI_STATUS\r
272	UiDisplayMenu (\r
273	IN OUT UI_MENU_SELECTION *Selection\r
274	)\r
275	;\r
276	\r
277	/**\r
278	Free up the resource allocated for all strings required\r
279	by Setup Browser.\r
280	\r
281	**/\r
282	VOID\r
283	FreeBrowserStrings (\r
284	VOID\r
285	)\r
286	;\r
287	\r
288	/**\r
289	The worker function that send the displays to the screen. On output,\r
290	the selection made by user is returned.\r
291	\r
292	@param Selection On input, Selection tell setup browser the information\r
293	about the Selection, form and formset to be displayed.\r
294	On output, Selection return the screen item that is selected\r
295	by user.\r
296	\r
297	@retval EFI_SUCCESS The page is displayed successfully.\r
298	@return Other value if the page failed to be diplayed.\r
299	\r
300	**/\r
301	EFI_STATUS\r
302	SetupBrowser (\r
303	IN OUT UI_MENU_SELECTION *Selection\r
304	)\r
305	;\r
306	\r
307	/**\r
308	VSPrint worker function that prints a Value as a decimal number in Buffer.\r
309	\r
310	@param Buffer Location to place ascii decimal number string of Value.\r
311	@param Flags Flags to use in printing decimal string, see file header for\r
312	details.\r
313	@param Value Decimal value to convert to a string in Buffer.\r
314	\r
315	@return Number of characters printed.\r
316	\r
317	**/\r
318	VOID\r
319	ValueToString (\r
320	IN CHAR16 *Buffer,\r
321	IN BOOLEAN Flags,\r
322	IN INT64 Value\r
323	)\r
324	;\r
325	\r
326	/**\r
327	Set Buffer to Value for Size bytes.\r
328	\r
329	@param Buffer Memory to set.\r
330	@param Size Number of bytes to set\r
331	@param Value Value of the set operation.\r
332	\r
333	**/\r
334	VOID\r
335	SetUnicodeMem (\r
336	IN VOID *Buffer,\r
337	IN UINTN Size,\r
338	IN CHAR16 Value\r
339	)\r
340	;\r
341	\r
342	/**\r
343	Wait for a given event to fire, or for an optional timeout to expire.\r
344	\r
345	@param Event The event to wait for\r
346	@param Timeout An optional timeout value in 100 ns units.\r
347	@param RefreshInterval Menu refresh interval (in seconds).\r
348	\r
349	@retval EFI_SUCCESS Event fired before Timeout expired.\r
350	@retval EFI_TIME_OUT Timout expired before Event fired.\r
351	\r
352	**/\r
353	EFI_STATUS\r
354	UiWaitForSingleEvent (\r
355	IN EFI_EVENT Event,\r
356	IN UINT64 Timeout, OPTIONAL\r
357	IN UINT8 RefreshInterval OPTIONAL\r
358	)\r
359	;\r
360	\r
361	/**\r
362	Draw a pop up windows based on the dimension, number of lines and\r
363	strings specified.\r
364	\r
365	@param RequestedWidth The width of the pop-up.\r
366	@param NumberOfLines The number of lines.\r
7936fb6a	367	@param ... A series of text strings that displayed in the pop-up.\r
	368	\r
	369	**/\r
	370	VOID\r
	371	CreatePopUp (\r
	372	IN UINTN ScreenWidth,\r
	373	IN UINTN NumberOfLines,\r
7936fb6a	374	...\r
	375	)\r
	376	;\r
	377	\r
	378	/**\r
	379	Get string or password input from user.\r
	380	\r
	381	@param MenuOption Pointer to the current input menu.\r
	382	@param Prompt The prompt string shown on popup window.\r
	383	@param StringPtr Destination for use input string.\r
	384	\r
	385	@retval EFI_SUCCESS If string input is read successfully\r
	386	@retval EFI_DEVICE_ERROR If operation fails\r
	387	\r
	388	**/\r
	389	EFI_STATUS\r
	390	ReadString (\r
	391	IN UI_MENU_OPTION *MenuOption,\r
	392	IN CHAR16 *Prompt,\r
	393	OUT CHAR16 *StringPtr\r
	394	)\r
	395	;\r
	396	\r
	397	/**\r
	398	Get selection for OneOf and OrderedList (Left/Right will be ignored).\r
	399	\r
	400	@param Selection Pointer to current selection.\r
	401	@param MenuOption Pointer to the current input menu.\r
	402	\r
	403	@retval EFI_SUCCESS If Option input is processed successfully\r
	404	@retval EFI_DEVICE_ERROR If operation fails\r
	405	\r
	406	**/\r
	407	EFI_STATUS\r
	408	GetSelectionInputPopUp (\r
	409	IN UI_MENU_SELECTION *Selection,\r
	410	IN UI_MENU_OPTION *MenuOption\r
	411	)\r
	412	;\r
	413	\r
	414	/**\r
	415	This routine reads a numeric value from the user input.\r
	416	\r
	417	@param Selection Pointer to current selection.\r
	418	@param MenuOption Pointer to the current input menu.\r
	419	\r
	420	@retval EFI_SUCCESS If numerical input is read successfully\r
	421	@retval EFI_DEVICE_ERROR If operation fails\r
	422	\r
	423	**/\r
	424	EFI_STATUS\r
	425	GetNumericInput (\r
	426	IN UI_MENU_SELECTION *Selection,\r
	427	IN UI_MENU_OPTION *MenuOption\r
	428	)\r
	429	;\r
	430	\r
	431	/**\r
	432	Update status bar on the bottom of menu.\r
	433	\r
	434	@param MessageType The type of message to be shown.\r
	435	@param Flags The flags in Question header.\r
	436	@param State Set or clear.\r
	437	\r
438	**/\r
439	VOID\r
440	UpdateStatusBar (\r
441	IN UINTN MessageType,\r
442	IN UINT8 Flags,\r
443	IN BOOLEAN State\r
444	)\r
445	;\r
446	\r
447	/**\r
448	Process Question Config.\r
449	\r
450	@param Selection The UI menu selection.\r
451	@param Question The Question to be peocessed.\r
452	\r
453	@retval EFI_SUCCESS Question Config process success.\r
454	@retval Other Question Config process fail.\r
455	\r
456	**/\r
457	EFI_STATUS\r
458	ProcessQuestionConfig (\r
459	IN UI_MENU_SELECTION *Selection,\r
460	IN FORM_BROWSER_STATEMENT *Question\r
461	)\r
462	;\r
463	\r
464	/**\r
465	Print Question Value according to it's storage width and display attributes.\r
466	\r
467	@param Question The Question to be printed.\r
468	@param FormattedNumber Buffer for output string.\r
469	@param BufferSize The FormattedNumber buffer size in bytes.\r
470	\r
471	@retval EFI_SUCCESS Print success.\r
472	@retval EFI_BUFFER_TOO_SMALL Buffer size is not enough for formatted number.\r
473	\r
474	**/\r
475	EFI_STATUS\r
476	PrintFormattedNumber (\r
477	IN FORM_BROWSER_STATEMENT *Question,\r
478	IN OUT CHAR16 *FormattedNumber,\r
479	IN UINTN BufferSize\r
480	)\r
481	;\r
482	\r
483	/**\r
484	Search an Option of a Question by its value.\r
485	\r
486	@param Question The Question\r
487	@param OptionValue Value for Option to be searched.\r
488	\r
489	@retval Pointer Pointer to the found Option.\r
490	@retval NULL Option not found.\r
491	\r
492	**/\r
493	QUESTION_OPTION *\r
494	ValueToOption (\r
495	IN FORM_BROWSER_STATEMENT *Question,\r
496	IN EFI_HII_VALUE *OptionValue\r
497	)\r
498	;\r
499	\r
500	/**\r
501	Process a Question's Option (whether selected or un-selected).\r
502	\r
503	@param Selection Pointer to UI_MENU_SELECTION.\r
504	@param MenuOption The MenuOption for this Question.\r
505	@param Selected TRUE: if Question is selected.\r
506	@param OptionString Pointer of the Option String to be displayed.\r
507	\r
508	@retval EFI_SUCCESS Question Option process success.\r
509	@retval Other Question Option process fail.\r
510	\r
511	**/\r
512	EFI_STATUS\r
513	ProcessOptions (\r
514	IN UI_MENU_SELECTION *Selection,\r
515	IN UI_MENU_OPTION *MenuOption,\r
516	IN BOOLEAN Selected,\r
517	OUT CHAR16 **OptionString\r
518	)\r
519	;\r
520	\r
521	/**\r
522	Process the help string: Split StringPtr to several lines of strings stored in\r
523	FormattedString and the glyph width of each line cannot exceed gHelpBlockWidth.\r
524	\r
525	@param StringPtr The entire help string.\r
526	@param FormattedString The oupput formatted string.\r
527	@param RowCount TRUE: if Question is selected.\r
528	\r
529	**/\r
530	VOID\r
531	ProcessHelpString (\r
532	IN CHAR16 *StringPtr,\r
533	OUT CHAR16 **FormattedString,\r
534	IN UINTN RowCount\r
535	)\r
536	;\r
537	\r
538	/**\r
539	Update key's help imformation.\r
540	\r
541	@param MenuOption The Menu option\r
542	@param Selected Whether or not a tag be selected\r
543	\r
544	**/\r
545	VOID\r
546	UpdateKeyHelp (\r
547	IN UI_MENU_OPTION *MenuOption,\r
548	IN BOOLEAN Selected\r
549	)\r
550	;\r
551	\r
552	/**\r
553	Clear retangle with specified text attribute.\r
554	\r
555	@param LeftColumn Left column of retangle.\r
556	@param RightColumn Right column of retangle.\r
557	@param TopRow Start row of retangle.\r
558	@param BottomRow End row of retangle.\r
559	@param TextAttribute The character foreground and background.\r
560	\r
561	**/\r
562	VOID\r
563	ClearLines (\r
564	UINTN LeftColumn,\r
565	UINTN RightColumn,\r
566	UINTN TopRow,\r
567	UINTN BottomRow,\r
568	UINTN TextAttribute\r
569	)\r
570	;\r
571	\r
572	/**\r
573	Count the storage space of a Unicode string.\r
574	\r
575	This function handles the Unicode string with NARROW_CHAR\r
576	and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR\r
577	does not count in the resultant output. If a WIDE_CHAR is \r
578	hit, then 2 Unicode character will consume an output storage\r
579	space with size of CHAR16 till a NARROW_CHAR is hit.\r
580	\r
581	@param String The input string to be counted.\r
582	\r
583	@return Storage space for the input string.\r
584	\r
585	**/\r
586	UINTN\r
587	GetStringWidth (\r
588	CHAR16 *String\r
589	)\r
590	;\r
591	\r
592	/**\r
593	Will copy LineWidth amount of a string in the OutputString buffer and return the\r
594	number of CHAR16 characters that were copied into the OutputString buffer.\r
595	\r
596	@param InputString String description for this option.\r
597	@param LineWidth Width of the desired string to extract in CHAR16\r
598	characters\r
599	@param Index Where in InputString to start the copy process\r
600	@param OutputString Buffer to copy the string into\r
601	\r
602	@return Returns the number of CHAR16 characters that were copied into the OutputString buffer.\r
603	\r
604	**/\r
605	UINT16\r
606	GetLineByWidth (\r
607	IN CHAR16 *InputString,\r
608	IN UINT16 LineWidth,\r
609	IN OUT UINTN *Index,\r
610	OUT CHAR16 **OutputString\r
611	)\r
612	;\r
613	\r
614	/**\r
615	Get the supported width for a particular op-code\r
616	\r
617	@param Statement The FORM_BROWSER_STATEMENT structure passed in.\r
618	@param Handle The handle in the HII database being used\r
619	\r
620	@return Returns the number of CHAR16 characters that is support.\r
621	\r
622	**/\r
623	UINT16\r
624	GetWidth (\r
625	IN FORM_BROWSER_STATEMENT *Statement,\r
626	IN EFI_HII_HANDLE Handle\r
627	)\r
628	;\r
629	\r
630	/**\r
631	Concatenate a narrow string to another string.\r
632	\r
633	@param Destination The destination string.\r
634	@param Source The source string. The string to be concatenated.\r
635	to the end of Destination.\r
636	\r
637	**/\r
638	VOID\r
639	NewStrCat (\r
640	CHAR16 *Destination,\r
641	CHAR16 *Source\r
642	)\r
643	;\r
644	\r
645	/**\r
646	Wait for a key to be pressed by user.\r
647	\r
648	@param Key The key which is pressed by user.\r
649	\r
650	@retval EFI_SUCCESS The function always completed successfully.\r
651	\r
652	**/\r
653	EFI_STATUS\r
654	WaitForKeyStroke (\r
655	OUT EFI_INPUT_KEY *Key\r
656	)\r
657	;\r
658	\r
659	/**\r
660	Reset stack pointer to begin of the stack.\r
661	\r
662	**/\r
663	VOID\r
664	ResetScopeStack (\r
665	VOID\r
666	)\r
667	;\r
668	\r
669	/**\r
670	Push an Operand onto the Stack\r
671	\r
672	@param Operand Operand to push.\r
673	\r
674	@retval EFI_SUCCESS The value was pushed onto the stack.\r
675	@retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the\r
676	stack.\r
677	\r
678	**/\r
679	EFI_STATUS\r
680	PushScope (\r
681	IN UINT8 Operand\r
682	)\r
683	;\r
684	\r
685	/**\r
686	Pop an Operand from the Stack\r
687	\r
688	@param Operand Operand to pop.\r
689	\r
690	@retval EFI_SUCCESS The value was pushed onto the stack.\r
691	@retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the\r
692	stack.\r
693	\r
694	**/\r
695	EFI_STATUS\r
696	PopScope (\r
697	OUT UINT8 *Operand\r
698	)\r
699	;\r
700	\r
701	/**\r
702	Get Form given its FormId.\r
703	\r
704	@param FormSet The formset which contains this form.\r
705	@param FormId Id of this form.\r
706	\r
707	@retval Pointer The form.\r
708	@retval NULL Specified Form is not found in the formset.\r
709	\r
710	**/\r
711	FORM_BROWSER_FORM *\r
712	IdToForm (\r
713	IN FORM_BROWSER_FORMSET *FormSet,\r
714	IN UINT16 FormId\r
715	)\r
716	;\r
717	\r
718	/**\r
719	Search a Question in Formset scope using its QuestionId.\r
720	\r
721	@param FormSet The formset which contains this form.\r
722	@param Form The form which contains this Question.\r
723	@param QuestionId Id of this Question.\r
724	\r
725	@retval Pointer The Question.\r
726	@retval NULL Specified Question not found in the form.\r
727	\r
728	**/\r
729	FORM_BROWSER_STATEMENT *\r
730	IdToQuestion (\r
731	IN FORM_BROWSER_FORMSET *FormSet,\r
732	IN FORM_BROWSER_FORM *Form,\r
733	IN UINT16 QuestionId\r
734	)\r
735	;\r
736	\r
737	/**\r
738	Zero extend integer/boolean/date/time to UINT64 for comparing.\r
739	\r
740	@param Value HII Value to be converted.\r
741	\r
742	**/\r
743	VOID\r
744	ExtendValueToU64 (\r
745	IN EFI_HII_VALUE *Value\r
746	)\r
747	;\r
748	\r
749	/**\r
750	Compare two Hii value.\r
751	\r
752	@param Value1 Expression value to compare on left-hand.\r
753	@param Value2 Expression value to compare on right-hand.\r
754	@param HiiHandle Only required for string compare.\r
755	\r
756	@retval EFI_INVALID_PARAMETER Could not perform comparation on two values.\r
757	@retval 0 Two operators equeal.\r
758	@return Positive value if Value1 is greater than Value2.\r
759	@retval Negative value if Value1 is less than Value2.\r
760	\r
761	**/\r
762	INTN\r
763	CompareHiiValue (\r
764	IN EFI_HII_VALUE *Value1,\r
765	IN EFI_HII_VALUE *Value2,\r
766	IN EFI_HII_HANDLE HiiHandle OPTIONAL\r
767	)\r
768	;\r
769	\r
770	/**\r
771	Evaluate the result of a HII expression\r
772	\r
773	@param FormSet FormSet associated with this expression.\r
774	@param Form Form associated with this expression.\r
775	@param Expression Expression to be evaluated.\r
776	\r
777	@retval EFI_SUCCESS The expression evaluated successfuly\r
778	@retval EFI_NOT_FOUND The Question which referenced by a QuestionId\r
779	could not be found.\r
780	@retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the\r
781	stack.\r
782	@retval EFI_ACCESS_DENIED The pop operation underflowed the stack\r
783	@retval EFI_INVALID_PARAMETER Syntax error with the Expression\r
784	\r
785	**/\r
786	EFI_STATUS\r
787	EvaluateExpression (\r
788	IN FORM_BROWSER_FORMSET *FormSet,\r
789	IN FORM_BROWSER_FORM *Form,\r
790	IN OUT FORM_EXPRESSION *Expression\r
791	)\r
792	;\r
793	\r
794	#endif // _UI_H\r