[mirror_edk2.git] / MdeModulePkg / Universal / SetupBrowserDxe / Presentation.c

/** @file\r
Utility functions for UI presentation.\r
\r
Copyright (c) 2004 - 2009, 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
#include "Setup.h"\r
#include "Ui.h"\r
\r
BOOLEAN            mHiiPackageListUpdated;\r
UI_MENU_SELECTION  *gCurrentSelection;\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
  CHAR16  *Buffer;\r
  UINTN   Row;\r
\r
  //\r
  // For now, allocate an arbitrarily long buffer\r
  //\r
  Buffer = AllocateZeroPool (0x10000);\r
  ASSERT (Buffer != NULL);\r
\r
  //\r
  // Set foreground and background as defined\r
  //\r
  gST->ConOut->SetAttribute (gST->ConOut, TextAttribute);\r
\r
  //\r
  // Much faster to buffer the long string instead of print it a character at a time\r
  //\r
  SetUnicodeMem (Buffer, RightColumn - LeftColumn, L' ');\r
\r
  //\r
  // Clear the desired area with the appropriate foreground/background\r
  //\r
  for (Row = TopRow; Row <= BottomRow; Row++) {\r
    PrintStringAt (LeftColumn, Row, Buffer);\r
  }\r
\r
  gST->ConOut->SetCursorPosition (gST->ConOut, LeftColumn, TopRow);\r
\r
  FreePool (Buffer);\r
  return ;\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
  UINTN Length;\r
\r
  for (Length = 0; Destination[Length] != 0; Length++)\r
    ;\r
\r
  //\r
  // We now have the length of the original string\r
  // We can safely assume for now that we are concatenating a narrow value to this string.\r
  // For instance, the string is "XYZ" and cat'ing ">"\r
  // If this assumption changes, we need to make this routine a bit more complex\r
  //\r
  Destination[Length] = NARROW_CHAR;\r
  Length++;\r
\r
  StrCpy (Destination + Length, Source);\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
  UINTN Index;\r
  UINTN Count;\r
  UINTN IncrementValue;\r
\r
  Index           = 0;\r
  Count           = 0;\r
  IncrementValue  = 1;\r
\r
  do {\r
    //\r
    // Advance to the null-terminator or to the first width directive\r
    //\r
    for (;\r
         (String[Index] != NARROW_CHAR) && (String[Index] != WIDE_CHAR) && (String[Index] != 0);\r
         Index++, Count = Count + IncrementValue\r
        )\r
      ;\r
\r
    //\r
    // We hit the null-terminator, we now have a count\r
    //\r
    if (String[Index] == 0) {\r
      break;\r
    }\r
    //\r
    // We encountered a narrow directive - strip it from the size calculation since it doesn't get printed\r
    // and also set the flag that determines what we increment by.(if narrow, increment by 1, if wide increment by 2)\r
    //\r
    if (String[Index] == NARROW_CHAR) {\r
      //\r
      // Skip to the next character\r
      //\r
      Index++;\r
      IncrementValue = 1;\r
    } else {\r
      //\r
      // Skip to the next character\r
      //\r
      Index++;\r
      IncrementValue = 2;\r
    }\r
  } while (String[Index] != 0);\r
\r
  //\r
  // Increment by one to include the null-terminator in the size\r
  //\r
  Count++;\r
\r
  return Count * sizeof (CHAR16);\r
}\r
\r
/**\r
  This function displays the page frame.\r
\r
**/\r
VOID\r
DisplayPageFrame (\r
  VOID\r
  )\r
{\r
  UINTN                  Index;\r
  UINT8                  Line;\r
  UINT8                  Alignment;\r
  CHAR16                 Character;\r
  CHAR16                 *Buffer;\r
  CHAR16                 *StrFrontPageBanner;\r
  UINTN                  Row;\r
  EFI_SCREEN_DESCRIPTOR  LocalScreen;\r
  UINT8                  RowIdx;\r
  UINT8                  ColumnIdx;\r
\r
  ZeroMem (&LocalScreen, sizeof (EFI_SCREEN_DESCRIPTOR));\r
  gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &LocalScreen.RightColumn, &LocalScreen.BottomRow);\r
  ClearLines (0, LocalScreen.RightColumn, 0, LocalScreen.BottomRow, KEYHELP_BACKGROUND);\r
\r
  CopyMem (&LocalScreen, &gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));\r
\r
  //\r
  // For now, allocate an arbitrarily long buffer\r
  //\r
  Buffer = AllocateZeroPool (0x10000);\r
  ASSERT (Buffer != NULL);\r
\r
  Character = BOXDRAW_HORIZONTAL;\r
\r
  for (Index = 0; Index + 2 < (LocalScreen.RightColumn - LocalScreen.LeftColumn); Index++) {\r
    Buffer[Index] = Character;\r
  }\r
\r
  if (gClassOfVfr == EFI_FRONT_PAGE_SUBCLASS) {\r
    //\r
    //    ClearLines(0, LocalScreen.RightColumn, 0, BANNER_HEIGHT-1, BANNER_TEXT | BANNER_BACKGROUND);\r
    //\r
    ClearLines (\r
      LocalScreen.LeftColumn,\r
      LocalScreen.RightColumn,\r
      LocalScreen.TopRow,\r
      FRONT_PAGE_HEADER_HEIGHT - 1 + LocalScreen.TopRow,\r
      BANNER_TEXT | BANNER_BACKGROUND\r
      );\r
    //\r
    //    for (Line = 0; Line < BANNER_HEIGHT; Line++) {\r
    //\r
    for (Line = (UINT8) LocalScreen.TopRow; Line < BANNER_HEIGHT + (UINT8) LocalScreen.TopRow; Line++) {\r
      //\r
      //      for (Alignment = 0; Alignment < BANNER_COLUMNS; Alignment++) {\r
      //\r
      for (Alignment = (UINT8) LocalScreen.LeftColumn;\r
           Alignment < BANNER_COLUMNS + (UINT8) LocalScreen.LeftColumn;\r
           Alignment++\r
          ) {\r
        RowIdx = (UINT8) (Line - (UINT8) LocalScreen.TopRow);\r
        ColumnIdx = (UINT8) (Alignment - (UINT8) LocalScreen.LeftColumn);\r
\r
        ASSERT (RowIdx < BANNER_HEIGHT);\r
        ASSERT (ColumnIdx < BANNER_COLUMNS);\r
        \r
        if (BannerData->Banner[RowIdx][ColumnIdx] != 0x0000) {\r
          StrFrontPageBanner = GetToken (\r
                                BannerData->Banner[RowIdx][ColumnIdx],\r
                                FrontPageHandle\r
                                );\r
        } else {\r
          continue;\r
        }\r
\r
        switch (Alignment - LocalScreen.LeftColumn) {\r
        case 0:\r
          //\r
          // Handle left column\r
          //\r
          PrintStringAt (LocalScreen.LeftColumn, Line, StrFrontPageBanner);\r
          break;\r
\r
        case 1:\r
          //\r
          // Handle center column\r
          //\r
          PrintStringAt (\r
            LocalScreen.LeftColumn + (LocalScreen.RightColumn - LocalScreen.LeftColumn) / 3,\r
            Line,\r
            StrFrontPageBanner\r
            );\r
          break;\r
\r
        case 2:\r
          //\r
          // Handle right column\r
          //\r
          PrintStringAt (\r
            LocalScreen.LeftColumn + (LocalScreen.RightColumn - LocalScreen.LeftColumn) * 2 / 3,\r
            Line,\r
            StrFrontPageBanner\r
            );\r
          break;\r
        }\r
\r
        FreePool (StrFrontPageBanner);\r
      }\r
    }\r
  }\r
\r
  ClearLines (\r
    LocalScreen.LeftColumn,\r
    LocalScreen.RightColumn,\r
    LocalScreen.BottomRow - STATUS_BAR_HEIGHT - FOOTER_HEIGHT,\r
    LocalScreen.BottomRow - STATUS_BAR_HEIGHT - 1,\r
    KEYHELP_TEXT | KEYHELP_BACKGROUND\r
    );\r
\r
  if (gClassOfVfr != EFI_FRONT_PAGE_SUBCLASS) {\r
    ClearLines (\r
      LocalScreen.LeftColumn,\r
      LocalScreen.RightColumn,\r
      LocalScreen.TopRow,\r
      LocalScreen.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT - 1,\r
      TITLE_TEXT | TITLE_BACKGROUND\r
      );\r
    //\r
    // Print Top border line\r
    // +------------------------------------------------------------------------------+\r
    // ?                                                                             ?\r
    // +------------------------------------------------------------------------------+\r
    //\r
    Character = BOXDRAW_DOWN_RIGHT;\r
\r
    PrintChar (Character);\r
    PrintString (Buffer);\r
\r
    Character = BOXDRAW_DOWN_LEFT;\r
    PrintChar (Character);\r
\r
    Character = BOXDRAW_VERTICAL;\r
    for (Row = LocalScreen.TopRow + 1; Row <= LocalScreen.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT - 2; Row++) {\r
      PrintCharAt (LocalScreen.LeftColumn, Row, Character);\r
      PrintCharAt (LocalScreen.RightColumn - 1, Row, Character);\r
    }\r
\r
    Character = BOXDRAW_UP_RIGHT;\r
    PrintCharAt (LocalScreen.LeftColumn, LocalScreen.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT - 1, Character);\r
    PrintString (Buffer);\r
\r
    Character = BOXDRAW_UP_LEFT;\r
    PrintChar (Character);\r
\r
    if (gClassOfVfr == EFI_SETUP_APPLICATION_SUBCLASS) {\r
      //\r
      // Print Bottom border line\r
      // +------------------------------------------------------------------------------+\r
      // ?                                                                             ?\r
      // +------------------------------------------------------------------------------+\r
      //\r
      Character = BOXDRAW_DOWN_RIGHT;\r
      PrintCharAt (LocalScreen.LeftColumn, LocalScreen.BottomRow - STATUS_BAR_HEIGHT - FOOTER_HEIGHT, Character);\r
\r
      PrintString (Buffer);\r
\r
      Character = BOXDRAW_DOWN_LEFT;\r
      PrintChar (Character);\r
      Character = BOXDRAW_VERTICAL;\r
      for (Row = LocalScreen.BottomRow - STATUS_BAR_HEIGHT - FOOTER_HEIGHT + 1;\r
           Row <= LocalScreen.BottomRow - STATUS_BAR_HEIGHT - 2;\r
           Row++\r
          ) {\r
        PrintCharAt (LocalScreen.LeftColumn, Row, Character);\r
        PrintCharAt (LocalScreen.RightColumn - 1, Row, Character);\r
      }\r
\r
      Character = BOXDRAW_UP_RIGHT;\r
      PrintCharAt (LocalScreen.LeftColumn, LocalScreen.BottomRow - STATUS_BAR_HEIGHT - 1, Character);\r
\r
      PrintString (Buffer);\r
\r
      Character = BOXDRAW_UP_LEFT;\r
      PrintChar (Character);\r
    }\r
  }\r
\r
  FreePool (Buffer);\r
\r
}\r
\r
\r
/**\r
  Evaluate all expressions in a Form.\r
\r
  @param  FormSet        FormSet this Form belongs to.\r
  @param  Form           The Form.\r
\r
  @retval EFI_SUCCESS    The expression evaluated successfuly\r
\r
**/\r
EFI_STATUS\r
EvaluateFormExpressions (\r
  IN FORM_BROWSER_FORMSET  *FormSet,\r
  IN FORM_BROWSER_FORM     *Form\r
  )\r
{\r
  EFI_STATUS       Status;\r
  LIST_ENTRY       *Link;\r
  FORM_EXPRESSION  *Expression;\r
\r
  Link = GetFirstNode (&Form->ExpressionListHead);\r
  while (!IsNull (&Form->ExpressionListHead, Link)) {\r
    Expression = FORM_EXPRESSION_FROM_LINK (Link);\r
    Link = GetNextNode (&Form->ExpressionListHead, Link);\r
\r
    if (Expression->Type == EFI_HII_EXPRESSION_INCONSISTENT_IF ||\r
        Expression->Type == EFI_HII_EXPRESSION_NO_SUBMIT_IF) {\r
      //\r
      // Postpone Form validation to Question editing or Form submiting\r
      //\r
      continue;\r
    }\r
\r
    Status = EvaluateExpression (FormSet, Form, Expression);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/*\r
+------------------------------------------------------------------------------+\r
?F2=Previous Page                 Setup Page                                  ?\r
+------------------------------------------------------------------------------+\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
+------------------------------------------------------------------------------+\r
?F1=Scroll Help                 F9=Reset to Defaults        F10=Save and Exit ?\r
| ^"=Move Highlight          <Spacebar> Toggles Checkbox   Esc=Discard Changes |\r
+------------------------------------------------------------------------------+\r
*/\r
\r
/**\r
\r
  \r
  Display form and wait for user to select one menu option, then return it.\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
  @retval EFI_SUCESSS            This function always return successfully for now.\r
\r
**/\r
EFI_STATUS\r
DisplayForm (\r
  IN OUT UI_MENU_SELECTION           *Selection\r
  )\r
{\r
  CHAR16                 *StringPtr;\r
  UINT16                 MenuItemCount;\r
  EFI_HII_HANDLE         Handle;\r
  BOOLEAN                Suppress;\r
  EFI_SCREEN_DESCRIPTOR  LocalScreen;\r
  UINT16                 Width;\r
  UINTN                  ArrayEntry;\r
  CHAR16                 *OutputString;\r
  LIST_ENTRY             *Link;\r
  FORM_BROWSER_STATEMENT *Statement;\r
  UINT16                 NumberOfLines;\r
  EFI_STATUS             Status;\r
\r
  Handle        = Selection->Handle;\r
  MenuItemCount = 0;\r
  ArrayEntry    = 0;\r
  OutputString  = NULL;\r
\r
  UiInitMenu ();\r
\r
  CopyMem (&LocalScreen, &gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));\r
\r
  StringPtr = GetToken (Selection->Form->FormTitle, Handle);\r
\r
  if (gClassOfVfr != EFI_FRONT_PAGE_SUBCLASS) {\r
    gST->ConOut->SetAttribute (gST->ConOut, TITLE_TEXT | TITLE_BACKGROUND);\r
    PrintStringAt (\r
      (LocalScreen.RightColumn + LocalScreen.LeftColumn - GetStringWidth (StringPtr) / 2) / 2,\r
      LocalScreen.TopRow + 1,\r
      StringPtr\r
      );\r
  }\r
\r
  if (gClassOfVfr == EFI_SETUP_APPLICATION_SUBCLASS) {\r
    gST->ConOut->SetAttribute (gST->ConOut, KEYHELP_TEXT | KEYHELP_BACKGROUND);\r
\r
    //\r
    // Display the infrastructure strings\r
    //\r
    if (!IsListEmpty (&gMenuList)) {\r
      PrintStringAt (LocalScreen.LeftColumn + 2, LocalScreen.TopRow + 1, gFunctionTwoString);\r
    }\r
  }\r
  //\r
  // Remove Buffer allocated for StringPtr after it has been used.\r
  //\r
  FreePool (StringPtr);\r
\r
  //\r
  // Evaluate all the Expressions in this Form\r
  //\r
  Status = EvaluateFormExpressions (Selection->FormSet, Selection->Form);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Link = GetFirstNode (&Selection->Form->StatementListHead);\r
  while (!IsNull (&Selection->Form->StatementListHead, Link)) {\r
    Statement = FORM_BROWSER_STATEMENT_FROM_LINK (Link);\r
\r
    if (Statement->SuppressExpression != NULL) {\r
      Suppress = Statement->SuppressExpression->Result.Value.b;\r
    } else {\r
      Suppress = FALSE;\r
    }\r
\r
    if (!Suppress) {\r
      StringPtr = GetToken (Statement->Prompt, Handle);\r
\r
      Width     = GetWidth (Statement, Handle);\r
\r
      NumberOfLines = 1;\r
      ArrayEntry = 0;\r
      for (; GetLineByWidth (StringPtr, Width, &ArrayEntry, &OutputString) != 0x0000;) {\r
        //\r
        // If there is more string to process print on the next row and increment the Skip value\r
        //\r
        if (StrLen (&StringPtr[ArrayEntry]) != 0) {\r
          NumberOfLines++;\r
        }\r
\r
        FreePool (OutputString);\r
      }\r
\r
      //\r
      // We are NOT!! removing this StringPtr buffer via FreePool since it is being used in the menuoptions, we will do\r
      // it in UiFreeMenu.\r
      //\r
      UiAddMenuOption (StringPtr, Selection->Handle, Statement, NumberOfLines, MenuItemCount);\r
      MenuItemCount++;\r
    }\r
\r
    Link = GetNextNode (&Selection->Form->StatementListHead, Link);\r
  }\r
\r
  Status = UiDisplayMenu (Selection);\r
\r
  UiFreeMenu ();\r
\r
  return Status;\r
}\r
\r
/**\r
  Initialize the HII String Token to the correct values.\r
\r
**/\r
VOID\r
InitializeBrowserStrings (\r
  VOID\r
  )\r
{\r
  gFunctionOneString    = GetToken (STRING_TOKEN (FUNCTION_ONE_STRING), gHiiHandle);\r
  gFunctionTwoString    = GetToken (STRING_TOKEN (FUNCTION_TWO_STRING), gHiiHandle);\r
  gFunctionNineString   = GetToken (STRING_TOKEN (FUNCTION_NINE_STRING), gHiiHandle);\r
  gFunctionTenString    = GetToken (STRING_TOKEN (FUNCTION_TEN_STRING), gHiiHandle);\r
  gEnterString          = GetToken (STRING_TOKEN (ENTER_STRING), gHiiHandle);\r
  gEnterCommitString    = GetToken (STRING_TOKEN (ENTER_COMMIT_STRING), gHiiHandle);\r
  gEnterEscapeString    = GetToken (STRING_TOKEN (ENTER_ESCAPE_STRING), gHiiHandle);\r
  gEscapeString         = GetToken (STRING_TOKEN (ESCAPE_STRING), gHiiHandle);\r
  gSaveFailed           = GetToken (STRING_TOKEN (SAVE_FAILED), gHiiHandle);\r
  gMoveHighlight        = GetToken (STRING_TOKEN (MOVE_HIGHLIGHT), gHiiHandle);\r
  gMakeSelection        = GetToken (STRING_TOKEN (MAKE_SELECTION), gHiiHandle);\r
  gDecNumericInput      = GetToken (STRING_TOKEN (DEC_NUMERIC_INPUT), gHiiHandle);\r
  gHexNumericInput      = GetToken (STRING_TOKEN (HEX_NUMERIC_INPUT), gHiiHandle);\r
  gToggleCheckBox       = GetToken (STRING_TOKEN (TOGGLE_CHECK_BOX), gHiiHandle);\r
  gPromptForData        = GetToken (STRING_TOKEN (PROMPT_FOR_DATA), gHiiHandle);\r
  gPromptForPassword    = GetToken (STRING_TOKEN (PROMPT_FOR_PASSWORD), gHiiHandle);\r
  gPromptForNewPassword = GetToken (STRING_TOKEN (PROMPT_FOR_NEW_PASSWORD), gHiiHandle);\r
  gConfirmPassword      = GetToken (STRING_TOKEN (CONFIRM_PASSWORD), gHiiHandle);\r
  gConfirmError         = GetToken (STRING_TOKEN (CONFIRM_ERROR), gHiiHandle);\r
  gPassowordInvalid     = GetToken (STRING_TOKEN (PASSWORD_INVALID), gHiiHandle);\r
  gPressEnter           = GetToken (STRING_TOKEN (PRESS_ENTER), gHiiHandle);\r
  gEmptyString          = GetToken (STRING_TOKEN (EMPTY_STRING), gHiiHandle);\r
  gAreYouSure           = GetToken (STRING_TOKEN (ARE_YOU_SURE), gHiiHandle);\r
  gYesResponse          = GetToken (STRING_TOKEN (ARE_YOU_SURE_YES), gHiiHandle);\r
  gNoResponse           = GetToken (STRING_TOKEN (ARE_YOU_SURE_NO), gHiiHandle);\r
  gMiniString           = GetToken (STRING_TOKEN (MINI_STRING), gHiiHandle);\r
  gPlusString           = GetToken (STRING_TOKEN (PLUS_STRING), gHiiHandle);\r
  gMinusString          = GetToken (STRING_TOKEN (MINUS_STRING), gHiiHandle);\r
  gAdjustNumber         = GetToken (STRING_TOKEN (ADJUST_NUMBER), gHiiHandle);\r
  gSaveChanges          = GetToken (STRING_TOKEN (SAVE_CHANGES), gHiiHandle);\r
  gOptionMismatch       = GetToken (STRING_TOKEN (OPTION_MISMATCH), gHiiHandle);\r
  return ;\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
  FreePool (gFunctionOneString);\r
  FreePool (gFunctionTwoString);\r
  FreePool (gFunctionNineString);\r
  FreePool (gFunctionTenString);\r
  FreePool (gEnterString);\r
  FreePool (gEnterCommitString);\r
  FreePool (gEnterEscapeString);\r
  FreePool (gEscapeString);\r
  FreePool (gMoveHighlight);\r
  FreePool (gMakeSelection);\r
  FreePool (gDecNumericInput);\r
  FreePool (gHexNumericInput);\r
  FreePool (gToggleCheckBox);\r
  FreePool (gPromptForData);\r
  FreePool (gPromptForPassword);\r
  FreePool (gPromptForNewPassword);\r
  FreePool (gConfirmPassword);\r
  FreePool (gPassowordInvalid);\r
  FreePool (gConfirmError);\r
  FreePool (gPressEnter);\r
  FreePool (gEmptyString);\r
  FreePool (gAreYouSure);\r
  FreePool (gYesResponse);\r
  FreePool (gNoResponse);\r
  FreePool (gMiniString);\r
  FreePool (gPlusString);\r
  FreePool (gMinusString);\r
  FreePool (gAdjustNumber);\r
  FreePool (gSaveChanges);\r
  FreePool (gOptionMismatch);\r
  return ;\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
  UINTN                  SecCol;\r
  UINTN                  ThdCol;\r
  UINTN                  LeftColumnOfHelp;\r
  UINTN                  RightColumnOfHelp;\r
  UINTN                  TopRowOfHelp;\r
  UINTN                  BottomRowOfHelp;\r
  UINTN                  StartColumnOfHelp;\r
  EFI_SCREEN_DESCRIPTOR  LocalScreen;\r
  FORM_BROWSER_STATEMENT *Statement;\r
\r
  CopyMem (&LocalScreen, &gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));\r
\r
  SecCol            = LocalScreen.LeftColumn + (LocalScreen.RightColumn - LocalScreen.LeftColumn) / 3;\r
  ThdCol            = LocalScreen.LeftColumn + (LocalScreen.RightColumn - LocalScreen.LeftColumn) * 2 / 3;\r
\r
  StartColumnOfHelp = LocalScreen.LeftColumn + 2;\r
  LeftColumnOfHelp  = LocalScreen.LeftColumn + 1;\r
  RightColumnOfHelp = LocalScreen.RightColumn - 2;\r
  TopRowOfHelp      = LocalScreen.BottomRow - 4;\r
  BottomRowOfHelp   = LocalScreen.BottomRow - 3;\r
\r
  if (gClassOfVfr == EFI_GENERAL_APPLICATION_SUBCLASS) {\r
    return ;\r
  }\r
\r
  gST->ConOut->SetAttribute (gST->ConOut, KEYHELP_TEXT | KEYHELP_BACKGROUND);\r
\r
  Statement = MenuOption->ThisTag;\r
  switch (Statement->Operand) {\r
  case EFI_IFR_ORDERED_LIST_OP:\r
  case EFI_IFR_ONE_OF_OP:\r
  case EFI_IFR_NUMERIC_OP:\r
  case EFI_IFR_TIME_OP:\r
  case EFI_IFR_DATE_OP:\r
    ClearLines (LeftColumnOfHelp, RightColumnOfHelp, TopRowOfHelp, BottomRowOfHelp, KEYHELP_TEXT | KEYHELP_BACKGROUND);\r
\r
    if (!Selected) {\r
      if (gClassOfVfr == EFI_SETUP_APPLICATION_SUBCLASS) {\r
        PrintStringAt (StartColumnOfHelp, TopRowOfHelp, gFunctionOneString);\r
        PrintStringAt (SecCol, TopRowOfHelp, gFunctionNineString);\r
        PrintStringAt (ThdCol, TopRowOfHelp, gFunctionTenString);\r
        PrintStringAt (ThdCol, BottomRowOfHelp, gEscapeString);\r
      }\r
\r
      if ((Statement->Operand == EFI_IFR_DATE_OP) ||\r
          (Statement->Operand == EFI_IFR_TIME_OP)) {\r
        PrintAt (\r
          StartColumnOfHelp,\r
          BottomRowOfHelp,\r
          L"%c%c%c%c%s",\r
          ARROW_UP,\r
          ARROW_DOWN,\r
          ARROW_RIGHT,\r
          ARROW_LEFT,\r
          gMoveHighlight\r
          );\r
        PrintStringAt (SecCol, BottomRowOfHelp, gAdjustNumber);\r
      } else {\r
        PrintAt (StartColumnOfHelp, BottomRowOfHelp, L"%c%c%s", ARROW_UP, ARROW_DOWN, gMoveHighlight);\r
        if (Statement->Operand == EFI_IFR_NUMERIC_OP && Statement->Step != 0) {\r
          PrintStringAt (SecCol, BottomRowOfHelp, gAdjustNumber);\r
        } else {\r
          PrintStringAt (SecCol, BottomRowOfHelp, gEnterString);\r
        }\r
      }\r
    } else {\r
      PrintStringAt (SecCol, BottomRowOfHelp, gEnterCommitString);\r
\r
      //\r
      // If it is a selected numeric with manual input, display different message\r
      //\r
      if ((Statement->Operand == EFI_IFR_NUMERIC_OP) && (Statement->Step == 0)) {\r
        PrintStringAt (\r
          SecCol,\r
          TopRowOfHelp,\r
          ((Statement->Flags & EFI_IFR_DISPLAY_UINT_HEX) == EFI_IFR_DISPLAY_UINT_HEX) ? gHexNumericInput : gDecNumericInput\r
          );\r
      } else if (Statement->Operand != EFI_IFR_ORDERED_LIST_OP) {\r
        PrintAt (StartColumnOfHelp, BottomRowOfHelp, L"%c%c%s", ARROW_UP, ARROW_DOWN, gMoveHighlight);\r
      }\r
\r
      if (Statement->Operand == EFI_IFR_ORDERED_LIST_OP) {\r
        PrintStringAt (StartColumnOfHelp, TopRowOfHelp, gPlusString);\r
        PrintStringAt (ThdCol, TopRowOfHelp, gMinusString);\r
      }\r
\r
      PrintStringAt (ThdCol, BottomRowOfHelp, gEnterEscapeString);\r
    }\r
    break;\r
\r
  case EFI_IFR_CHECKBOX_OP:\r
    ClearLines (LeftColumnOfHelp, RightColumnOfHelp, TopRowOfHelp, BottomRowOfHelp, KEYHELP_TEXT | KEYHELP_BACKGROUND);\r
\r
    if (gClassOfVfr == EFI_SETUP_APPLICATION_SUBCLASS) {\r
      PrintStringAt (StartColumnOfHelp, TopRowOfHelp, gFunctionOneString);\r
      PrintStringAt (SecCol, TopRowOfHelp, gFunctionNineString);\r
      PrintStringAt (ThdCol, TopRowOfHelp, gFunctionTenString);\r
      PrintStringAt (ThdCol, BottomRowOfHelp, gEscapeString);\r
    }\r
\r
    PrintAt (StartColumnOfHelp, BottomRowOfHelp, L"%c%c%s", ARROW_UP, ARROW_DOWN, gMoveHighlight);\r
    PrintStringAt (SecCol, BottomRowOfHelp, gToggleCheckBox);\r
    break;\r
\r
  case EFI_IFR_REF_OP:\r
  case EFI_IFR_PASSWORD_OP:\r
  case EFI_IFR_STRING_OP:\r
  case EFI_IFR_TEXT_OP:\r
  case EFI_IFR_ACTION_OP:\r
  case EFI_IFR_RESET_BUTTON_OP:\r
    ClearLines (LeftColumnOfHelp, RightColumnOfHelp, TopRowOfHelp, BottomRowOfHelp, KEYHELP_TEXT | KEYHELP_BACKGROUND);\r
\r
    if (!Selected) {\r
      if (gClassOfVfr == EFI_SETUP_APPLICATION_SUBCLASS) {\r
        PrintStringAt (StartColumnOfHelp, TopRowOfHelp, gFunctionOneString);\r
        PrintStringAt (SecCol, TopRowOfHelp, gFunctionNineString);\r
        PrintStringAt (ThdCol, TopRowOfHelp, gFunctionTenString);\r
        PrintStringAt (ThdCol, BottomRowOfHelp, gEscapeString);\r
      }\r
\r
      PrintAt (StartColumnOfHelp, BottomRowOfHelp, L"%c%c%s", ARROW_UP, ARROW_DOWN, gMoveHighlight);\r
      if (Statement->Operand != EFI_IFR_TEXT_OP) {\r
        PrintStringAt (SecCol, BottomRowOfHelp, gEnterString);\r
      }\r
    } else {\r
      if (Statement->Operand != EFI_IFR_REF_OP) {\r
        PrintStringAt (\r
          (LocalScreen.RightColumn - GetStringWidth (gEnterCommitString) / 2) / 2,\r
          BottomRowOfHelp,\r
          gEnterCommitString\r
          );\r
        PrintStringAt (ThdCol, BottomRowOfHelp, gEnterEscapeString);\r
      }\r
    }\r
    break;\r
\r
  default:\r
    break;\r
  }\r
}\r
\r
/**\r
  Functions which are registered to receive notification of\r
  database events have this prototype. The actual event is encoded\r
  in NotifyType. The following table describes how PackageType,\r
  PackageGuid, Handle, and Package are used for each of the\r
  notification types.\r
\r
  @param PackageType  Package type of the notification.\r
\r
  @param PackageGuid  If PackageType is\r
                      EFI_HII_PACKAGE_TYPE_GUID, then this is\r
                      the pointer to the GUID from the Guid\r
                      field of EFI_HII_PACKAGE_GUID_HEADER.\r
                      Otherwise, it must be NULL.\r
\r
  @param Package  Points to the package referred to by the\r
                  notification Handle The handle of the package\r
                  list which contains the specified package.\r
\r
  @param Handle       The HII handle.\r
\r
  @param NotifyType   The type of change concerning the\r
                      database. See\r
                      EFI_HII_DATABASE_NOTIFY_TYPE.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FormUpdateNotify (\r
  IN UINT8                              PackageType,\r
  IN CONST EFI_GUID                     *PackageGuid,\r
  IN CONST EFI_HII_PACKAGE_HEADER       *Package,\r
  IN EFI_HII_HANDLE                     Handle,\r
  IN EFI_HII_DATABASE_NOTIFY_TYPE       NotifyType\r
  )\r
{\r
  mHiiPackageListUpdated = TRUE;\r
\r
  return EFI_SUCCESS;\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
  EFI_STATUS                      Status;\r
  LIST_ENTRY                      *Link;\r
  EFI_BROWSER_ACTION_REQUEST      ActionRequest;\r
  EFI_HANDLE                      NotifyHandle;\r
  EFI_HII_VALUE                   *HiiValue;\r
  FORM_BROWSER_STATEMENT          *Statement;\r
  EFI_HII_CONFIG_ACCESS_PROTOCOL  *ConfigAccess;\r
  EFI_INPUT_KEY                   Key;\r
  CHAR16                          YesResponse;\r
  CHAR16                          NoResponse;\r
\r
  gMenuRefreshHead = NULL;\r
  gResetRequired = FALSE;\r
  gNvUpdateRequired = FALSE;\r
\r
  UiInitMenuList ();\r
\r
  //\r
  // Register notify for Form package update\r
  //\r
  Status = mHiiDatabase->RegisterPackageNotify (\r
                           mHiiDatabase,\r
                           EFI_HII_PACKAGE_FORMS,\r
                           NULL,\r
                           FormUpdateNotify,\r
                           EFI_HII_DATABASE_NOTIFY_REMOVE_PACK,\r
                           &NotifyHandle\r
                           );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  do {\r
    //\r
    // Displays the Header and Footer borders\r
    //\r
    DisplayPageFrame ();\r
\r
    //\r
    // Initialize Selection->Form\r
    //\r
    if (Selection->FormId == 0) {\r
      //\r
      // Zero FormId indicates display the first Form in a FormSet\r
      //\r
      Link = GetFirstNode (&Selection->FormSet->FormListHead);\r
\r
      Selection->Form = FORM_BROWSER_FORM_FROM_LINK (Link);\r
      Selection->FormId = Selection->Form->FormId;\r
    } else {\r
      Selection->Form = IdToForm (Selection->FormSet, Selection->FormId);\r
    }\r
\r
    //\r
    // Load Questions' Value for display\r
    //\r
    Status = LoadFormConfig (Selection->FormSet, Selection->Form);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    //\r
    // Display form\r
    //\r
    Status = DisplayForm (Selection);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    //\r
    // Check Selected Statement (if press ESC, Selection->Statement will be NULL)\r
    //\r
    Statement = Selection->Statement;\r
    if (Statement != NULL) {\r
      if ((Statement->QuestionFlags & EFI_IFR_FLAG_RESET_REQUIRED) == EFI_IFR_FLAG_RESET_REQUIRED) {\r
        gResetRequired = TRUE;\r
      }\r
\r
      //\r
      // Reset FormPackage update flag\r
      //\r
      mHiiPackageListUpdated = FALSE;\r
\r
      if (((Statement->QuestionFlags & EFI_IFR_FLAG_CALLBACK) == EFI_IFR_FLAG_CALLBACK) && (Statement->Operand != EFI_IFR_PASSWORD_OP)) {\r
        ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r
\r
        HiiValue = &Statement->HiiValue;\r
        if (HiiValue->Type == EFI_IFR_TYPE_STRING) {\r
          //\r
          // Create String in HII database for Configuration Driver to retrieve\r
          //\r
          HiiValue->Value.string = NewString ((CHAR16 *) Statement->BufferValue, Selection->FormSet->HiiHandle);\r
        }\r
\r
        ConfigAccess = Selection->FormSet->ConfigAccess;\r
        if (ConfigAccess == NULL) {\r
          return EFI_UNSUPPORTED;\r
        }\r
        Status = ConfigAccess->Callback (\r
                                 ConfigAccess,\r
                                 EFI_BROWSER_ACTION_CHANGING,\r
                                 Statement->QuestionId,\r
                                 HiiValue->Type,\r
                                 &HiiValue->Value,\r
                                 &ActionRequest\r
                                 );\r
\r
        if (HiiValue->Type == EFI_IFR_TYPE_STRING) {\r
          //\r
          // Clean the String in HII Database\r
          //\r
          DeleteString (HiiValue->Value.string, Selection->FormSet->HiiHandle);\r
        }\r
\r
        if (!EFI_ERROR (Status)) {\r
          switch (ActionRequest) {\r
          case EFI_BROWSER_ACTION_REQUEST_RESET:\r
            gResetRequired = TRUE;\r
            break;\r
\r
          case EFI_BROWSER_ACTION_REQUEST_SUBMIT:\r
            SubmitForm (Selection->FormSet, Selection->Form);\r
            break;\r
\r
          case EFI_BROWSER_ACTION_REQUEST_EXIT:\r
            Selection->Action = UI_ACTION_EXIT;\r
            gNvUpdateRequired = FALSE;\r
            break;\r
\r
          default:\r
            break;\r
          }\r
        }\r
      }\r
\r
      //\r
      // Check whether Form Package has been updated during Callback\r
      //\r
      if (mHiiPackageListUpdated && (Selection->Action == UI_ACTION_REFRESH_FORM)) {\r
        //\r
        // Force to reparse IFR binary of target Formset\r
        //\r
        Selection->Action = UI_ACTION_REFRESH_FORMSET;\r
\r
        //\r
        // Uncommitted data will be lost after IFR binary re-pasing, so confirm on whether to save\r
        //\r
        if (gNvUpdateRequired) {\r
          Status      = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
\r
          YesResponse = gYesResponse[0];\r
          NoResponse  = gNoResponse[0];\r
\r
          do {\r
            CreateDialog (3, TRUE, 0, NULL, &Key, gEmptyString, gSaveChanges, gEmptyString);\r
          } while\r
          (\r
            (Key.ScanCode != SCAN_ESC) &&\r
            ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (NoResponse | UPPER_LOWER_CASE_OFFSET)) &&\r
            ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (YesResponse | UPPER_LOWER_CASE_OFFSET))\r
          );\r
\r
          if ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) == (YesResponse | UPPER_LOWER_CASE_OFFSET)) {\r
            //\r
            // If the user hits the YesResponse key\r
            //\r
            SubmitForm (Selection->FormSet, Selection->Form);\r
          }\r
        }\r
      }\r
    }\r
  } while (Selection->Action == UI_ACTION_REFRESH_FORM);\r
\r
  //\r
  // Unregister notify for Form package update\r
  //\r
  Status = mHiiDatabase->UnregisterPackageNotify (\r
                           mHiiDatabase,\r
                           NotifyHandle\r
                           );\r
  return Status;\r
}\r