/** @file\r
Private structure, MACRO and function definitions for User Interface related functionalities.\r
\r
-Copyright (c) 2004 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>\r
+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
#ifndef _UI_H_\r
#define _UI_H_\r
\r
-#include "Setup.h"\r
-\r
//\r
// Globals\r
//\r
\r
#define SUBTITLE_INDENT 2\r
\r
+\r
+//\r
+// It take 23 characters including the NULL to print a 64 bits number with "[" and "]".\r
+// pow(2, 64) = [18446744073709551616]\r
+//\r
+#define MAX_NUMERIC_INPUT_WIDTH 23\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
+ UiHotKey,\r
UiMaxOperation\r
} UI_SCREEN_OPERATION;\r
\r
CfPrepareToReadKey,\r
CfReadKey,\r
CfScreenOperation,\r
- CfUiPrevious,\r
CfUiSelect,\r
CfUiReset,\r
CfUiLeft,\r
CfUiPageUp,\r
CfUiPageDown,\r
CfUiDown,\r
- CfUiSave,\r
CfUiDefault,\r
CfUiNoOperation,\r
CfExit,\r
+ CfUiHotKey,\r
CfMaxControlFlag\r
} UI_CONTROL_FLAG;\r
\r
#define UI_ACTION_REFRESH_FORMSET 2\r
#define UI_ACTION_EXIT 3\r
\r
+typedef struct _UI_MENU_LIST UI_MENU_LIST;\r
+\r
typedef struct {\r
EFI_HII_HANDLE Handle;\r
\r
EFI_GUID FormSetGuid;\r
UINT16 FormId;\r
UINT16 QuestionId;\r
+ UINTN Sequence; // used for time/date only.\r
\r
UINTN TopRow;\r
UINTN BottomRow;\r
FORM_BROWSER_FORMSET *FormSet;\r
FORM_BROWSER_FORM *Form;\r
FORM_BROWSER_STATEMENT *Statement;\r
+\r
+ //\r
+ // Whether the Form is editable\r
+ //\r
+ BOOLEAN FormEditable;\r
+\r
+ UI_MENU_LIST *CurrentMenu;\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
+#define UI_MENU_OPTION_SIGNATURE SIGNATURE_32 ('u', 'i', 'm', 'm')\r
+#define UI_MENU_LIST_SIGNATURE SIGNATURE_32 ('u', 'i', 'm', 'l')\r
\r
typedef struct {\r
UINTN Signature;\r
\r
BOOLEAN GrayOut;\r
BOOLEAN ReadOnly;\r
+\r
+ //\r
+ // Whether user could change value of this item\r
+ //\r
+ BOOLEAN IsQuestion;\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
+struct _UI_MENU_LIST {\r
UINTN Signature;\r
- LIST_ENTRY MenuLink;\r
+ LIST_ENTRY Link;\r
\r
+ EFI_HII_HANDLE HiiHandle;\r
+ EFI_GUID FormSetGuid;\r
UINT16 FormId;\r
UINT16 QuestionId;\r
-} UI_MENU_LIST;\r
+ UINTN Sequence; // used for time/date only.\r
+\r
+ UI_MENU_LIST *Parent;\r
+ LIST_ENTRY ChildListHead;\r
+};\r
\r
-typedef struct _MENU_REFRESH_ENTRY {\r
- struct _MENU_REFRESH_ENTRY *Next;\r
+#define UI_MENU_LIST_FROM_LINK(a) CR (a, UI_MENU_LIST, Link, UI_MENU_LIST_SIGNATURE)\r
+\r
+typedef struct _MENU_REFRESH_ENTRY MENU_REFRESH_ENTRY;\r
+struct _MENU_REFRESH_ENTRY {\r
+ 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
+ EFI_EVENT Event;\r
+};\r
\r
typedef struct {\r
UINT16 ScanCode;\r
} SCREEN_OPERATION_T0_CONTROL_FLAG;\r
\r
\r
-extern LIST_ENTRY gMenuList;\r
+extern LIST_ENTRY gMenuOption;\r
extern MENU_REFRESH_ENTRY *gMenuRefreshHead;\r
extern UI_MENU_SELECTION *gCurrentSelection;\r
extern BOOLEAN mHiiPackageListUpdated;\r
);\r
\r
/**\r
- Remove a Menu in list, and return FormId/QuestionId for previous Menu.\r
-\r
- @param Selection Menu selection.\r
+ Free Menu option linked list.\r
\r
**/\r
VOID\r
-UiRemoveMenuListEntry (\r
- OUT UI_MENU_SELECTION *Selection\r
+UiFreeMenu (\r
+ VOID\r
);\r
\r
/**\r
- Free Menu option linked list.\r
+ Create a menu with specified formset GUID and form ID, and add it as a child\r
+ of the given parent menu.\r
+\r
+ @param Parent The parent of menu to be added.\r
+ @param HiiHandle Hii handle related to this formset.\r
+ @param FormSetGuid The Formset Guid of menu to be added.\r
+ @param FormId The Form ID of menu to be added.\r
+\r
+ @return A pointer to the newly added menu or NULL if memory is insufficient.\r
\r
**/\r
-VOID\r
-UiFreeMenuList (\r
- VOID\r
+UI_MENU_LIST *\r
+UiAddMenuList (\r
+ IN OUT UI_MENU_LIST *Parent,\r
+ IN EFI_HII_HANDLE HiiHandle,\r
+ IN EFI_GUID *FormSetGuid,\r
+ IN UINT16 FormId\r
);\r
\r
/**\r
- Add one menu entry to the linked lst\r
+ Search Menu with given FormId in the parent menu and all its child menus.\r
\r
- @param Selection Menu selection.\r
+ @param Parent The parent of menu to search.\r
+ @param FormSetGuid The Formset GUID of the menu to search. \r
+ @param FormId The Form ID of menu to search.\r
+\r
+ @return A pointer to menu found or NULL if not found.\r
\r
**/\r
-VOID\r
-UiAddMenuListEntry (\r
- IN UI_MENU_SELECTION *Selection\r
+UI_MENU_LIST *\r
+UiFindChildMenuList (\r
+ IN UI_MENU_LIST *Parent,\r
+ IN EFI_GUID *FormSetGuid, \r
+ IN UINT16 FormId\r
+ );\r
+\r
+/**\r
+ Search Menu with given FormSetGuid and FormId in all cached menu list.\r
+\r
+ @param FormSetGuid The Formset GUID of the menu to search.\r
+ @param FormId The Form ID of menu to search.\r
+\r
+ @return A pointer to menu found or NULL if not found.\r
+\r
+**/\r
+UI_MENU_LIST *\r
+UiFindMenuList (\r
+ IN EFI_GUID *FormSetGuid,\r
+ IN UINT16 FormId\r
);\r
\r
/**\r
\r
**/\r
VOID\r
-UiFreeMenu (\r
+UiFreeRefreshList (\r
VOID\r
);\r
\r
\r
@param String String description for this option.\r
@param Handle Hii handle for the package list.\r
+ @param Form The form this statement belong to.\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
+ @retval Pointer Pointer to the added Menu Option.\r
+\r
**/\r
-VOID\r
+UI_MENU_OPTION *\r
UiAddMenuOption (\r
IN CHAR16 *String,\r
IN EFI_HII_HANDLE Handle,\r
+ IN FORM_BROWSER_FORM *Form,\r
IN FORM_BROWSER_STATEMENT *Statement,\r
IN UINT16 NumberOfLines,\r
IN UINT16 MenuItemCount\r
VOID\r
);\r
\r
+/**\r
+ Process the goto op code, update the info in the selection structure.\r
+\r
+ @param Statement The statement belong to goto op code.\r
+ @param Selection The selection info.\r
+ @param Repaint Whether need to repaint the menu.\r
+ @param NewLine Whether need to create new line.\r
+\r
+ @retval EFI_SUCCESS The menu process successfully.\r
+ @return Other value if the process failed.\r
+**/\r
+EFI_STATUS\r
+ProcessGotoOpCode (\r
+ IN OUT FORM_BROWSER_STATEMENT *Statement,\r
+ IN OUT UI_MENU_SELECTION *Selection,\r
+ OUT BOOLEAN *Repaint,\r
+ OUT BOOLEAN *NewLine\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
IN OUT UI_MENU_SELECTION *Selection\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
Set Buffer to Value for Size bytes.\r
\r
\r
**/\r
VOID\r
-CreatePopUp (\r
+EFIAPI\r
+CreateMultiStringPopUp (\r
IN UINTN ScreenWidth,\r
IN UINTN NumberOfLines,\r
...\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
+ @param StringPtr Old user input and 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
EFI_STATUS\r
ReadString (\r
- IN UI_MENU_OPTION *MenuOption,\r
- IN CHAR16 *Prompt,\r
- OUT CHAR16 *StringPtr\r
+ IN UI_MENU_OPTION *MenuOption,\r
+ IN CHAR16 *Prompt,\r
+ IN OUT CHAR16 *StringPtr\r
);\r
\r
/**\r
/**\r
Update status bar on the bottom of menu.\r
\r
+ @param Selection Current selection info.\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
VOID\r
UpdateStatusBar (\r
+ IN UI_MENU_SELECTION *Selection,\r
IN UINTN MessageType,\r
IN UINT8 Flags,\r
IN BOOLEAN State\r
IN EFI_HII_VALUE *OptionValue\r
);\r
\r
+/**\r
+ Return data element in an Array by its Index.\r
+\r
+ @param Array The data array.\r
+ @param Type Type of the data in this array.\r
+ @param Index Zero based index for data in this array.\r
+\r
+ @retval Value The data to be returned\r
+\r
+**/\r
+UINT64\r
+GetArrayData (\r
+ IN VOID *Array,\r
+ IN UINT8 Type,\r
+ IN UINTN Index\r
+ );\r
+\r
+/**\r
+ Set value of a data element in an Array by its Index.\r
+\r
+ @param Array The data array.\r
+ @param Type Type of the data in this array.\r
+ @param Index Zero based index for data in this array.\r
+ @param Value The value to be set.\r
+\r
+**/\r
+VOID\r
+SetArrayData (\r
+ IN VOID *Array,\r
+ IN UINT8 Type,\r
+ IN UINTN Index,\r
+ IN UINT64 Value\r
+ );\r
+\r
/**\r
Process a Question's Option (whether selected or un-selected).\r
\r
/**\r
Update key's help imformation.\r
\r
+ @param Selection Tell setup browser the information about the Selection\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_SELECTION *Selection,\r
IN UI_MENU_OPTION *MenuOption,\r
IN BOOLEAN Selected\r
);\r
**/\r
VOID\r
ClearLines (\r
- UINTN LeftColumn,\r
- UINTN RightColumn,\r
- UINTN TopRow,\r
- UINTN BottomRow,\r
- UINTN TextAttribute\r
+ IN UINTN LeftColumn,\r
+ IN UINTN RightColumn,\r
+ IN UINTN TopRow,\r
+ IN UINTN BottomRow,\r
+ IN UINTN TextAttribute\r
);\r
\r
/**\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
+ 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
+ If String is NULL, then ASSERT ().\r
+\r
@param String The input string to be counted.\r
\r
@return Storage space for the input string.\r
**/\r
UINTN\r
GetStringWidth (\r
- CHAR16 *String\r
+ IN CHAR16 *String\r
);\r
\r
/**\r
**/\r
VOID\r
NewStrCat (\r
- CHAR16 *Destination,\r
- CHAR16 *Source\r
+ IN OUT CHAR16 *Destination,\r
+ IN CHAR16 *Source\r
);\r
\r
/**\r
VOID\r
);\r
\r
+/**\r
+ Push the expression options onto the Stack.\r
+\r
+ @param Pointer Pointer to the current expression.\r
+ @param Level Which type this expression belong to. Form, \r
+ statement or option?\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 stack.\r
+\r
+**/\r
+EFI_STATUS\r
+PushConditionalExpression (\r
+ IN FORM_EXPRESSION *Pointer,\r
+ IN EXPRESS_LEVEL Level\r
+ );\r
+\r
+/**\r
+ Pop the expression options from the Stack\r
+\r
+ @param Level Which type this expression belong to. Form, \r
+ statement or option?\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 stack.\r
+\r
+**/\r
+EFI_STATUS\r
+PopConditionalExpression (\r
+ IN EXPRESS_LEVEL Level\r
+ );\r
+ \r
+/**\r
+ Get the expression Buffer pointer.\r
+ \r
+ @param Level Which type this expression belong to. Form, \r
+ statement or option?\r
+\r
+ @retval The start pointer of the expression buffer or NULL.\r
+\r
+**/\r
+FORM_EXPRESSION **\r
+GetConditionalExpressionList (\r
+ IN EXPRESS_LEVEL Level\r
+ );\r
+\r
+/**\r
+ Get the expression list count.\r
+ \r
+ @param Level Which type this expression belong to. Form, \r
+ statement or option?\r
+\r
+ @retval >=0 The expression count\r
+ @retval -1 Input parameter error.\r
+\r
+**/\r
+INTN \r
+GetConditionalExpressionCount (\r
+ IN EXPRESS_LEVEL Level\r
+ );\r
+\r
/**\r
Push an Operand onto the Stack\r
\r
OUT UINT8 *Operand\r
);\r
\r
+/**\r
+ Reset stack pointer to begin of the stack.\r
+\r
+**/\r
+VOID\r
+ResetCurrentExpressionStack (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Push current expression onto the Stack\r
+\r
+ @param Pointer Pointer to current expression.\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 stack.\r
+\r
+**/\r
+EFI_STATUS\r
+PushCurrentExpression (\r
+ IN VOID *Pointer\r
+ );\r
+\r
+/**\r
+ Pop current expression from the Stack\r
+\r
+ @param Pointer Pointer to current expression to be 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 stack.\r
+\r
+**/\r
+EFI_STATUS\r
+PopCurrentExpression (\r
+ OUT VOID **Pointer\r
+ );\r
+\r
+/**\r
+ Reset stack pointer to begin of the stack.\r
+\r
+**/\r
+VOID\r
+ResetMapExpressionListStack (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Push the list of map expression onto the Stack\r
+\r
+ @param Pointer Pointer to the list of map expression to be pushed.\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 stack.\r
+\r
+**/\r
+EFI_STATUS\r
+PushMapExpressionList (\r
+ IN VOID *Pointer\r
+ );\r
+\r
+/**\r
+ Pop the list of map expression from the Stack\r
+\r
+ @param Pointer Pointer to the list of map expression to be 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 stack.\r
+\r
+**/\r
+EFI_STATUS\r
+PopMapExpressionList (\r
+ OUT VOID **Pointer\r
+ );\r
+\r
/**\r
Get Form given its FormId.\r
\r
\r
@param Value1 Expression value to compare on left-hand.\r
@param Value2 Expression value to compare on right-hand.\r
+ @param Result Return value after compare.\r
+ retval 0 Two operators equal.\r
+ return Positive value if Value1 is greater than Value2.\r
+ retval Negative value if Value1 is less than Value2.\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
+ @retval other Could not perform compare on two values.\r
+ @retval EFI_SUCCESS Compare the value success.\r
\r
**/\r
-INTN\r
+EFI_STATUS\r
CompareHiiValue (\r
IN EFI_HII_VALUE *Value1,\r
IN EFI_HII_VALUE *Value2,\r
+ OUT INTN *Result,\r
IN EFI_HII_HANDLE HiiHandle OPTIONAL\r
);\r
\r
/**\r
Evaluate the result of a HII expression\r
\r
+ If Expression is NULL, then ASSERT.\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
IN OUT FORM_EXPRESSION *Expression\r
);\r
\r
+/**\r
+ Return the result of the expression list. Check the expression list and \r
+ return the highest priority express result. \r
+ Priority: DisableIf > SuppressIf > GrayOutIf > FALSE\r
+\r
+ @param ExpList The input expression list.\r
+ @param Evaluate Whether need to evaluate the expression first.\r
+ @param FormSet FormSet associated with this expression. Only \r
+ needed when Evaluate is TRUE\r
+ @param Form Form associated with this expression. Only \r
+ needed when Evaluate is TRUE \r
+\r
+ @retval EXPRESS_RESULT Return the higher priority express result. \r
+ DisableIf > SuppressIf > GrayOutIf > FALSE\r
+\r
+**/\r
+EXPRESS_RESULT \r
+EvaluateExpressionList (\r
+ IN FORM_EXPRESSION_LIST *ExpList,\r
+ IN BOOLEAN Evaluate,\r
+ IN FORM_BROWSER_FORMSET *FormSet, OPTIONAL\r
+ IN FORM_BROWSER_FORM *Form OPTIONAL\r
+ );\r
+\r
#endif // _UI_H\r
projects / mirror_edk2.git / blobdiff