/** @file\r
Private structure, MACRO and function definitions for User Interface related functionalities.\r
\r
-Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2004 - 2013, 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
\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
CfUiPageUp,\r
CfUiPageDown,\r
CfUiDown,\r
- CfUiSave,\r
CfUiDefault,\r
CfUiNoOperation,\r
CfExit,\r
+ CfUiHotKey,\r
CfMaxControlFlag\r
} UI_CONTROL_FLAG;\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
UINTN Signature;\r
LIST_ENTRY Link;\r
\r
+ EFI_HII_HANDLE HiiHandle;\r
EFI_GUID FormSetGuid;\r
UINT16 FormId;\r
UINT16 QuestionId;\r
+ UINTN Sequence; // used for time/date only.\r
\r
UI_MENU_LIST *Parent;\r
LIST_ENTRY ChildListHead;\r
UINTN CurrentColumn;\r
UINTN CurrentRow;\r
UINTN CurrentAttribute;\r
+ EFI_EVENT Event;\r
};\r
\r
typedef struct {\r
\r
\r
extern LIST_ENTRY gMenuOption;\r
+extern LIST_ENTRY gMenuList;\r
extern MENU_REFRESH_ENTRY *gMenuRefreshHead;\r
extern UI_MENU_SELECTION *gCurrentSelection;\r
extern BOOLEAN mHiiPackageListUpdated;\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
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
- Search Menu with given FormId in the parent menu and all its child menus.\r
+ Search Menu with given FormId, FormSetGuid and Handle in all cached menu list.\r
\r
@param Parent The parent of menu to search.\r
+ @param Handle Hii handle related to this formset.\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
UI_MENU_LIST *\r
UiFindChildMenuList (\r
IN UI_MENU_LIST *Parent,\r
+ IN EFI_HII_HANDLE Handle,\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
+ Search Menu with given Handle, FormSetGuid and FormId in all cached menu list.\r
\r
+ @param Handle Hii handle related to this formset.\r
@param FormSetGuid The Formset GUID of the menu to search.\r
@param FormId The Form ID of menu to search.\r
\r
**/\r
UI_MENU_LIST *\r
UiFindMenuList (\r
+ IN EFI_HII_HANDLE Handle,\r
IN EFI_GUID *FormSetGuid,\r
IN UINT16 FormId\r
);\r
\r
+/**\r
+ Free Menu list linked list.\r
+\r
+ @param MenuListHead One Menu list point in the menu list.\r
+\r
+**/\r
+VOID\r
+UiFreeMenuList (\r
+ LIST_ENTRY *MenuListHead\r
+ );\r
+\r
/**\r
Free Menu option linked list.\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
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
\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
IN UINT64 Value\r
);\r
\r
+/**\r
+ Check whether this value already in the array, if yes, return the index.\r
+\r
+ @param Array The data array.\r
+ @param Type Type of the data in this array.\r
+ @param Value The value to be find.\r
+ @param Index The index in the array which has same value with Value.\r
+ \r
+ @retval TRUE Found the value in the array.\r
+ @retval FALSE Not found the value.\r
+\r
+**/\r
+BOOLEAN \r
+FindArrayData (\r
+ IN VOID *Array,\r
+ IN UINT8 Type,\r
+ IN UINT64 Value,\r
+ OUT UINTN *Index OPTIONAL\r
+ );\r
+\r
/**\r
Process a Question's Option (whether selected or un-selected).\r
\r
\r
@param StringPtr The entire help string.\r
@param FormattedString The oupput formatted string.\r
+ @param EachLineWidth The string length of each line in the formatted string.\r
@param RowCount TRUE: if Question is selected.\r
\r
**/\r
-VOID\r
+UINTN\r
ProcessHelpString (\r
- IN CHAR16 *StringPtr,\r
- OUT CHAR16 **FormattedString,\r
- IN UINTN RowCount\r
+ IN CHAR16 *StringPtr,\r
+ OUT CHAR16 **FormattedString,\r
+ OUT UINT16 *EachLineWidth,\r
+ IN UINTN RowCount\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
+ In the code, it deals \r,\n,\r\n same as \n\r, also it not process the \r or \g.\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 GlyphWidth The glyph width of the beging char in the string.\r
@param Index Where in InputString to start the copy process\r
@param OutputString Buffer to copy the string into\r
\r
GetLineByWidth (\r
IN CHAR16 *InputString,\r
IN UINT16 LineWidth,\r
+ IN OUT UINT16 *GlyphWidth,\r
IN OUT UINTN *Index,\r
OUT CHAR16 **OutputString\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
\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
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