Presentation.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Utility functions for UI presentation.
Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "Setup.h"
EFI_GUID mCurrentFormSetGuid = {0, 0, 0, {0, 0, 0, 0, 0, 0, 0, 0}};
UINT16 mCurrentFormId = 0;
/**
Clear retangle with specified text attribute.
@param LeftColumn Left column of retangle.
@param RightColumn Right column of retangle.
@param TopRow Start row of retangle.
@param BottomRow End row of retangle.
@param TextAttribute The character foreground and background.
**/
)
{
//
// For now, allocate an arbitrarily long buffer
//
//
// Set foreground and background as defined
//
//
// Much faster to buffer the long string instead of print it a character at a time
//
//
// Clear the desired area with the appropriate foreground/background
//
}
return ;
}
/**
Concatenate a narrow string to another string.
@param Destination The destination string.
@param Source The source string. The string to be concatenated.
to the end of Destination.
**/
)
{
;
//
// We now have the length of the original string
// We can safely assume for now that we are concatenating a narrow value to this string.
// For instance, the string is "XYZ" and cat'ing ">"
// If this assumption changes, we need to make this routine a bit more complex
//
Length++;
}
/**
Count the storage space of a Unicode string.
This function handles the Unicode string with NARROW_CHAR
and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR
does not count in the resultant output. If a WIDE_CHAR is
hit, then 2 Unicode character will consume an output storage
space with size of CHAR16 till a NARROW_CHAR is hit.
If String is NULL, then ASSERT ().
@param String The input string to be counted.
@return Storage space for the input string.
**/
)
{
return 0;
}
Index = 0;
Count = 0;
IncrementValue = 1;
do {
//
// Advance to the null-terminator or to the first width directive
//
for (;
)
;
//
// We hit the null-terminator, we now have a count
//
break;
}
//
// We encountered a narrow directive - strip it from the size calculation since it doesn't get printed
// and also set the flag that determines what we increment by.(if narrow, increment by 1, if wide increment by 2)
//
//
// Skip to the next character
//
Index++;
IncrementValue = 1;
} else {
//
// Skip to the next character
//
Index++;
IncrementValue = 2;
}
//
// Increment by one to include the null-terminator in the size
//
Count++;
}
/**
This function displays the page frame.
@param Selection Selection contains the information about
the Selection, form and formset to be displayed.
Selection action may be updated in retrieve callback.
**/
)
{
gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &LocalScreen.RightColumn, &LocalScreen.BottomRow);
return;
}
//
// For now, allocate an arbitrarily long buffer
//
}
//
// ClearLines(0, LocalScreen.RightColumn, 0, BANNER_HEIGHT-1, BANNER_TEXT | BANNER_BACKGROUND);
//
);
//
// for (Line = 0; Line < BANNER_HEIGHT; Line++) {
//
for (Line = (UINT8) LocalScreen.TopRow; Line < BANNER_HEIGHT + (UINT8) LocalScreen.TopRow; Line++) {
//
// for (Alignment = 0; Alignment < BANNER_COLUMNS; Alignment++) {
//
) {
);
} else {
continue;
}
case 0:
//
// Handle left column
//
break;
case 1:
//
// Handle center column
//
Line,
);
break;
case 2:
//
// Handle right column
//
Line,
);
break;
}
}
}
}
);
);
//
// Print Top border line
// +------------------------------------------------------------------------------+
// ? ?
// +------------------------------------------------------------------------------+
//
for (Row = LocalScreen.TopRow + 1; Row <= LocalScreen.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT - 2; Row++) {
}
PrintCharAt (LocalScreen.LeftColumn, LocalScreen.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT - 1, Character);
//
// Print Bottom border line
// +------------------------------------------------------------------------------+
// ? ?
// +------------------------------------------------------------------------------+
//
PrintCharAt (LocalScreen.LeftColumn, LocalScreen.BottomRow - STATUS_BAR_HEIGHT - gFooterHeight, Character);
Row++
) {
}
}
}
}
/**
Evaluate all expressions in a Form.
@param FormSet FormSet this Form belongs to.
@param Form The Form.
@retval EFI_SUCCESS The expression evaluated successfuly
**/
)
{
//
// Postpone Form validation to Question editing or Form submitting or Question Write or Question Read for nonstandard form.
//
continue;
}
return Status;
}
}
return EFI_SUCCESS;
}
/*
+------------------------------------------------------------------------------+
? Setup Page ?
+------------------------------------------------------------------------------+
+------------------------------------------------------------------------------+
?F1=Scroll Help F9=Reset to Defaults F10=Save and Exit ?
| ^"=Move Highlight <Spacebar> Toggles Checkbox Esc=Discard Changes |
+------------------------------------------------------------------------------+
*/
/**
Display form and wait for user to select one menu option, then return it.
@param Selection On input, Selection tell setup browser the information
about the Selection, form and formset to be displayed.
On output, Selection return the screen item that is selected
by user.
@retval EFI_SUCESSS This function always return successfully for now.
**/
)
{
MenuItemCount = 0;
ArrayEntry = 0;
OutputString = NULL;
UiInitMenu ();
} else {
}
);
}
//
// Remove Buffer allocated for StringPtr after it has been used.
//
//
// Evaluate all the Expressions in this Form
//
return Status;
}
NumberOfLines = 1;
ArrayEntry = 0;
//
// If there is more string to process print on the next row and increment the Skip value
//
}
}
//
// We are NOT!! removing this StringPtr buffer via FreePool since it is being used in the menuoptions, we will do
// it in UiFreeMenu.
//
MenuOption = UiAddMenuOption (StringPtr, Selection->Handle, Selection->Form, Statement, NumberOfLines, MenuItemCount);
//
// At least one item is not readonly, this Form is considered as editable
//
}
}
}
UiFreeMenu ();
return Status;
}
/**
Initialize the HII String Token to the correct values.
**/
)
{
return ;
}
/**
Free up the resource allocated for all strings required
by Setup Browser.
**/
)
{
return ;
}
/**
Show all registered HotKey help strings on bottom Rows.
**/
)
{
//
// Calculate total number of Register HotKeys.
//
Index = 0;
//
// Help string can't exceed ColumnWidth. One Row will show three Help information.
//
}
//
// Calculate help information Column and Row.
//
} else {
}
//
// Print HotKey help string on bottom Row.
//
//
// Get Next Hot Key.
//
Index ++;
}
return;
}
/**
Update key's help imformation.
@param Selection Tell setup browser the information about the Selection
@param MenuOption The Menu option
@param Selected Whether or not a tag be selected
**/
)
{
return;
}
case EFI_IFR_ORDERED_LIST_OP:
case EFI_IFR_ONE_OF_OP:
case EFI_IFR_NUMERIC_OP:
case EFI_IFR_TIME_OP:
case EFI_IFR_DATE_OP:
ClearLines (LeftColumnOfHelp, RightColumnOfHelp, TopRowOfHelp, BottomRowOfHelp, KEYHELP_TEXT | KEYHELP_BACKGROUND);
if (!Selected) {
//
// On system setting, HotKey will show on every form.
//
if (gBrowserSettingScope == SystemLevel ||
}
}
PrintAt (
L"%c%c%c%c%s",
);
} else {
}
}
} else {
//
// If it is a selected numeric with manual input, display different message
//
((Statement->Flags & EFI_IFR_DISPLAY_UINT_HEX) == EFI_IFR_DISPLAY_UINT_HEX) ? gHexNumericInput : gDecNumericInput
);
}
}
}
break;
case EFI_IFR_CHECKBOX_OP:
ClearLines (LeftColumnOfHelp, RightColumnOfHelp, TopRowOfHelp, BottomRowOfHelp, KEYHELP_TEXT | KEYHELP_BACKGROUND);
//
// On system setting, HotKey will show on every form.
//
if (gBrowserSettingScope == SystemLevel ||
}
}
break;
case EFI_IFR_REF_OP:
case EFI_IFR_PASSWORD_OP:
case EFI_IFR_STRING_OP:
case EFI_IFR_TEXT_OP:
case EFI_IFR_ACTION_OP:
case EFI_IFR_RESET_BUTTON_OP:
case EFI_IFR_SUBTITLE_OP:
ClearLines (LeftColumnOfHelp, RightColumnOfHelp, TopRowOfHelp, BottomRowOfHelp, KEYHELP_TEXT | KEYHELP_BACKGROUND);
if (!Selected) {
//
// On system setting, HotKey will show on every form.
//
if (gBrowserSettingScope == SystemLevel ||
}
}
}
} else {
);
}
}
break;
default:
break;
}
}
/**
Functions which are registered to receive notification of
database events have this prototype. The actual event is encoded
in NotifyType. The following table describes how PackageType,
PackageGuid, Handle, and Package are used for each of the
notification types.
@param PackageType Package type of the notification.
@param PackageGuid If PackageType is
EFI_HII_PACKAGE_TYPE_GUID, then this is
the pointer to the GUID from the Guid
field of EFI_HII_PACKAGE_GUID_HEADER.
Otherwise, it must be NULL.
@param Package Points to the package referred to by the
notification Handle The handle of the package
list which contains the specified package.
@param Handle The HII handle.
@param NotifyType The type of change concerning the
database. See
EFI_HII_DATABASE_NOTIFY_TYPE.
**/
)
{
return EFI_SUCCESS;
}
/**
check whether the formset need to update the NV.
@param FormSet FormSet data structure.
@retval TRUE Need to update the NV.
@retval FALSE No need to update the NV.
**/
)
{
if (Form->NvUpdateRequired ) {
return TRUE;
}
}
return FALSE;
}
/**
check whether the formset need to update the NV.
@param FormSet FormSet data structure.
@param SetValue Whether set new value or clear old value.
**/
)
{
}
}
/**
Find menu which will show next time.
@param Selection On input, Selection tell setup browser the information
about the Selection, form and formset to be displayed.
On output, Selection return the screen item that is selected
by user.
@param Repaint Whether need to repaint the menu.
@param NewLine Whether need to show at new line.
@retval TRUE Need return.
@retval FALSE No need to return.
**/
)
{
//
// we have a parent, so go to the parent menu
//
//
// The parent menu and current menu are in the same formset
//
} else {
}
//
// Form Level Check whether the data is changed.
//
(gBrowserSettingScope == FormSetLevel && IsNvUpdateRequired(Selection->FormSet) && Scope == FormSetLevel)) {
YesResponse = gYesResponse[0];
NoResponse = gNoResponse[0];
//
// If NV flag is up, prompt user
//
do {
} while
(
);
//
// User hits the ESC key, Ingore.
//
}
}
return FALSE;
}
//
// If the user hits the YesResponse key
//
} else {
//
// If the user hits the NoResponse key
//
}
}
//
// Clear highlight record for this menu
//
CurrentMenu->QuestionId = 0;
return FALSE;
}
//
// We never exit FrontPage, so skip the ESC
//
return FALSE;
}
//
// We are going to leave current FormSet, so check uncommited data in this FormSet
//
YesResponse = gYesResponse[0];
NoResponse = gNoResponse[0];
//
// If NV flag is up, prompt user
//
do {
} while
(
);
//
// User hits the ESC key
//
}
}
return FALSE;
}
//
// If the user hits the YesResponse key
//
} else {
//
// If the user hits the NoResponse key
//
}
}
if (CurrentMenu != NULL) {
CurrentMenu->QuestionId = 0;
}
return TRUE;
}
/**
Call the call back function for the question and process the return action.
@param Selection On input, Selection tell setup browser the information
about the Selection, form and formset to be displayed.
On output, Selection return the screen item that is selected
by user.
@param Question The Question which need to call.
@param Action The action request.
@param SkipSaveOrDiscard Whether skip save or discard action.
@retval EFI_SUCCESS The call back function excutes successfully.
@return Other value if the call back function failed to excute.
**/
)
{
if (ConfigAccess == NULL) {
return EFI_SUCCESS;
}
//
// if Question != NULL, only process the question. Else, process all question in this form.
//
continue;
}
continue;
}
//
// Check whether Statement is disabled.
//
if (EvaluateExpressionList(Statement->Expression, TRUE, Selection->FormSet, Selection->Form) == ExpressDisable) {
continue;
}
}
//
// For OrderedList, passing in the value buffer to Callback()
//
}
);
//
// Only for EFI_BROWSER_ACTION_CHANGED need to handle this ActionRequest.
//
if (Action == EFI_BROWSER_ACTION_CHANGED) {
switch (ActionRequest) {
break;
break;
break;
break;
break;
break;
break;
default:
break;
}
}
//
// According the spec, return value from call back of "changing" and
// "retrieve" should update to the question's temp buffer.
//
}
} else {
//
// According the spec, return fail from call back of "changing" and
// "retrieve", should restore the question's value.
//
}
if (Status == EFI_UNSUPPORTED) {
//
// If return EFI_UNSUPPORTED, also consider Hii driver suceess deal with it.
//
}
}
}
if (SubmitFormIsRequired && !SkipSaveOrDiscard) {
}
if (DiscardFormIsRequired && !SkipSaveOrDiscard) {
}
if (NeedExit) {
}
return Status;
}
/**
The worker function that send the displays to the screen. On output,
the selection made by user is returned.
@param Selection On input, Selection tell setup browser the information
about the Selection, form and formset to be displayed.
On output, Selection return the screen item that is selected
by user.
@retval EFI_SUCCESS The page is displayed successfully.
@return Other value if the page failed to be diplayed.
**/
)
{
//
// Register notify for Form package update
//
NULL,
);
return Status;
}
//
// Initialize current settings of Questions in this FormSet
//
goto Done;
}
//
// Update gOldFormSet on maintain back up FormSet list.
// And, make gOldFormSet point to current FormSet.
//
if (gOldFormSet != NULL) {
}
do {
//
// Initialize Selection->Form
//
//
// Zero FormId indicates display the first Form in a FormSet
//
} else {
}
//
// No Form to display
//
goto Done;
}
//
// Check Form is suppressed.
//
if (EvaluateExpressionList(Selection->Form->SuppressExpression, TRUE, Selection->FormSet, Selection->Form) == ExpressSuppress) {
//
// Form is suppressed.
//
do {
goto Done;
}
}
//
// Reset FormPackage update flag
//
//
// Before display new form, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_OPEN
// for each question with callback flag.
// New form may be the first form, or the different form after another form close.
//
if ((ConfigAccess != NULL) &&
//
// Keep current form information
//
goto Done;
}
//
// EXIT requests to close form.
//
goto Done;
}
//
// IFR is updated during callback of open form, force to reparse the IFR binary
//
if (mHiiPackageListUpdated) {
break;
}
}
//
// Load Questions' Value for display
//
goto Done;
}
//
// EXIT requests to close form.
//
goto Done;
}
//
// IFR is updated during callback of read value, force to reparse the IFR binary
//
if (mHiiPackageListUpdated) {
break;
}
//
// Displays the Header and Footer borders
//
//
// Display form
//
goto Done;
}
//
// Check Selected Statement (if press ESC, Selection->Statement will be NULL)
//
}
//
// Reset FormPackage update flag
//
if ((ConfigAccess != NULL) &&
//
// Process dynamic update ref opcode.
//
}
//
// Callback return error status or status return from process goto opcode.
//
//
// Cross reference will not be taken
//
Selection->QuestionId = 0;
}
}
}
}
//
// Check whether Form Package has been updated during Callback
//
//
// Force to reparse IFR binary of target Formset
//
}
}
//
// Before exit the form, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_CLOSE
// for each question with callback flag.
//
if ((ConfigAccess != NULL) &&
goto Done;
}
}
Done:
//
// Reset current form information to the initial setting when error happens or form exit.
//
mCurrentFormId = 0;
}
//
// Unregister notify for Form package update
//
);
return Status;
}