[mirror_edk2.git] / MdeModulePkg / Library / CustomizedDisplayLib / CustomizedDisplayLibInternal.c

/** @file\r
\r
  This library class defines a set of interfaces to customize Display module\r
\r
Copyright (c) 2013-2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
#include "CustomizedDisplayLibInternal.h"\r
\r
EFI_SCREEN_DESCRIPTOR         gScreenDimensions;\r
CHAR16                        *mLibUnknownString;\r
extern EFI_HII_HANDLE         mCDLStringPackHandle;\r
CHAR16                        *mSpaceBuffer;\r
#define SPACE_BUFFER_SIZE      1000\r
\r
//\r
// Browser Global Strings\r
//\r
CHAR16            *gEnterString;\r
CHAR16            *gEnterCommitString;\r
CHAR16            *gEnterEscapeString;\r
CHAR16            *gEscapeString;\r
CHAR16            *gMoveHighlight;\r
CHAR16            *gDecNumericInput;\r
CHAR16            *gHexNumericInput;\r
CHAR16            *gToggleCheckBox;\r
CHAR16            *gLibEmptyString;\r
CHAR16            *gAreYouSure;\r
CHAR16            *gYesResponse;\r
CHAR16            *gNoResponse;\r
CHAR16            *gPlusString;\r
CHAR16            *gMinusString;\r
CHAR16            *gAdjustNumber;\r
CHAR16            *gSaveChanges;\r
CHAR16            *gNvUpdateMessage;\r
CHAR16            *gInputErrorMessage;\r
\r
/**\r
\r
  Print banner info for front page.\r
\r
  @param[in]  FormData             Form Data to be shown in Page\r
\r
**/\r
VOID\r
PrintBannerInfo (\r
  IN FORM_DISPLAY_ENGINE_FORM       *FormData\r
  )\r
{\r
  UINT8                  Line;\r
  UINT8                  Alignment;\r
  CHAR16                 *StrFrontPageBanner;\r
  UINT8                  RowIdx;\r
  UINT8                  ColumnIdx;\r
\r
  //\r
  //    ClearLines(0, LocalScreen.RightColumn, 0, BANNER_HEIGHT-1, BANNER_TEXT | BANNER_BACKGROUND);\r
  //\r
  ClearLines (\r
    gScreenDimensions.LeftColumn,\r
    gScreenDimensions.RightColumn,\r
    gScreenDimensions.TopRow,\r
    FRONT_PAGE_HEADER_HEIGHT - 1 + gScreenDimensions.TopRow,\r
    BANNER_TEXT | BANNER_BACKGROUND\r
    );\r
\r
  //\r
  //    for (Line = 0; Line < BANNER_HEIGHT; Line++) {\r
  //\r
  for (Line = (UINT8) gScreenDimensions.TopRow; Line < BANNER_HEIGHT + (UINT8) gScreenDimensions.TopRow; Line++) {\r
    //\r
    //      for (Alignment = 0; Alignment < BANNER_COLUMNS; Alignment++) {\r
    //\r
    for (Alignment = (UINT8) gScreenDimensions.LeftColumn;\r
         Alignment < BANNER_COLUMNS + (UINT8) gScreenDimensions.LeftColumn;\r
         Alignment++\r
        ) {\r
      RowIdx    = (UINT8) (Line - (UINT8) gScreenDimensions.TopRow);\r
      ColumnIdx = (UINT8) (Alignment - (UINT8) gScreenDimensions.LeftColumn);\r
\r
      ASSERT (RowIdx < BANNER_HEIGHT && ColumnIdx < BANNER_COLUMNS);\r
\r
      if (gBannerData!= NULL && gBannerData->Banner[RowIdx][ColumnIdx] != 0x0000) {\r
        StrFrontPageBanner = LibGetToken (gBannerData->Banner[RowIdx][ColumnIdx], FormData->HiiHandle);\r
      } else {\r
        continue;\r
      }\r
\r
      switch (Alignment - gScreenDimensions.LeftColumn) {\r
      case 0:\r
        //\r
        // Handle left column\r
        //\r
        PrintStringAt (gScreenDimensions.LeftColumn + BANNER_LEFT_COLUMN_INDENT, Line, StrFrontPageBanner);\r
        break;\r
\r
      case 1:\r
        //\r
        // Handle center column\r
        //\r
        PrintStringAt (\r
          gScreenDimensions.LeftColumn + (gScreenDimensions.RightColumn - gScreenDimensions.LeftColumn) / 3,\r
          Line,\r
          StrFrontPageBanner\r
          );\r
        break;\r
\r
      case 2:\r
        //\r
        // Handle right column\r
        //\r
        PrintStringAt (\r
          gScreenDimensions.LeftColumn + (gScreenDimensions.RightColumn - gScreenDimensions.LeftColumn) * 2 / 3,\r
          Line,\r
          StrFrontPageBanner\r
          );\r
        break;\r
      }\r
\r
      FreePool (StrFrontPageBanner);\r
    }\r
  }\r
}\r
\r
/**\r
  Print framework and form title for a page.\r
\r
  @param[in]  FormData             Form Data to be shown in Page\r
**/\r
VOID\r
PrintFramework (\r
  IN FORM_DISPLAY_ENGINE_FORM       *FormData\r
  )\r
{\r
  UINTN                  Index;\r
  CHAR16                 Character;\r
  CHAR16                 *Buffer;\r
  UINTN                  Row;\r
  CHAR16                 *TitleStr;\r
  UINTN                  TitleColumn;\r
\r
  if (gClassOfVfr != FORMSET_CLASS_PLATFORM_SETUP) {\r
    //\r
    // Only Setup page needs Framework\r
    //\r
    ClearLines (\r
      gScreenDimensions.LeftColumn,\r
      gScreenDimensions.RightColumn,\r
      gScreenDimensions.BottomRow - STATUS_BAR_HEIGHT - gFooterHeight,\r
      gScreenDimensions.BottomRow - STATUS_BAR_HEIGHT - 1,\r
      KEYHELP_TEXT | KEYHELP_BACKGROUND\r
      );\r
    return;\r
  }\r
\r
  Buffer = AllocateZeroPool (0x10000);\r
  ASSERT (Buffer != NULL);\r
  Character = BOXDRAW_HORIZONTAL;\r
  for (Index = 0; Index + 2 < (gScreenDimensions.RightColumn - gScreenDimensions.LeftColumn); Index++) {\r
    Buffer[Index] = Character;\r
  }\r
\r
  //\r
  // Print Top border line\r
  // +------------------------------------------------------------------------------+\r
  // ?                                                                             ?\r
  // +------------------------------------------------------------------------------+\r
  //\r
  gST->ConOut->SetAttribute (gST->ConOut, TITLE_TEXT | TITLE_BACKGROUND);\r
  Character = BOXDRAW_DOWN_RIGHT;\r
\r
  PrintCharAt (gScreenDimensions.LeftColumn, gScreenDimensions.TopRow, Character);\r
  PrintStringAt ((UINTN) -1, (UINTN) -1, Buffer);\r
\r
  Character = BOXDRAW_DOWN_LEFT;\r
  PrintCharAt ((UINTN) -1, (UINTN) -1, Character);\r
\r
  Character = BOXDRAW_VERTICAL;\r
  for (Row = gScreenDimensions.TopRow + 1; Row <= gScreenDimensions.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT - 2; Row++) {\r
    PrintCharAt (gScreenDimensions.LeftColumn, Row, Character);\r
    PrintCharAt (gScreenDimensions.RightColumn - 1, Row, Character);\r
  }\r
\r
  //\r
  // Print Form Title\r
  //\r
  TitleStr = LibGetToken (FormData->FormTitle, FormData->HiiHandle);\r
  ASSERT (TitleStr != NULL);\r
  TitleColumn = (gScreenDimensions.RightColumn + gScreenDimensions.LeftColumn - LibGetStringWidth (TitleStr) / 2) / 2;\r
  PrintStringAtWithWidth (gScreenDimensions.LeftColumn + 1, gScreenDimensions.TopRow + 1, gLibEmptyString, TitleColumn - gScreenDimensions.LeftColumn - 1);\r
  PrintStringAtWithWidth (\r
    TitleColumn,\r
    gScreenDimensions.TopRow + 1,\r
    TitleStr,\r
    gScreenDimensions.RightColumn - 1 - TitleColumn\r
    );\r
  FreePool (TitleStr);\r
\r
  Character = BOXDRAW_UP_RIGHT;\r
  PrintCharAt (gScreenDimensions.LeftColumn, gScreenDimensions.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT - 1, Character);\r
  PrintStringAt ((UINTN) -1, (UINTN) -1, Buffer);\r
\r
  Character = BOXDRAW_UP_LEFT;\r
  PrintCharAt ((UINTN) -1, (UINTN) -1, Character);\r
\r
  //\r
  // Print Bottom border line\r
  // +------------------------------------------------------------------------------+\r
  // ?                                                                             ?\r
  // +------------------------------------------------------------------------------+\r
  //\r
  Character = BOXDRAW_DOWN_RIGHT;\r
  PrintCharAt (gScreenDimensions.LeftColumn, gScreenDimensions.BottomRow - STATUS_BAR_HEIGHT - gFooterHeight, Character);\r
\r
  PrintStringAt ((UINTN) -1, (UINTN) -1, Buffer);\r
\r
  Character = BOXDRAW_DOWN_LEFT;\r
  PrintCharAt ((UINTN) -1, (UINTN) -1, Character);\r
  Character = BOXDRAW_VERTICAL;\r
  for (Row = gScreenDimensions.BottomRow - STATUS_BAR_HEIGHT - gFooterHeight + 1;\r
       Row <= gScreenDimensions.BottomRow - STATUS_BAR_HEIGHT - 2;\r
       Row++\r
      ) {\r
    PrintCharAt (gScreenDimensions.LeftColumn, Row, Character);\r
    PrintCharAt (gScreenDimensions.RightColumn - 1, Row, Character);\r
  }\r
\r
  Character = BOXDRAW_UP_RIGHT;\r
  PrintCharAt (gScreenDimensions.LeftColumn, gScreenDimensions.BottomRow - STATUS_BAR_HEIGHT - 1, Character);\r
\r
  PrintStringAt ((UINTN) -1, (UINTN) -1, Buffer);\r
\r
  Character = BOXDRAW_UP_LEFT;\r
  PrintCharAt ((UINTN) -1, (UINTN) -1, Character);\r
\r
  FreePool (Buffer);\r
}\r
\r
/**\r
  Process some op code which is not recognized by browser core.\r
\r
  @param OpCodeData                  The pointer to the op code buffer.\r
\r
  @return EFI_SUCCESS            Pass the statement success.\r
\r
**/\r
VOID\r
ProcessUserOpcode(\r
  IN  EFI_IFR_OP_HEADER         *OpCodeData\r
  )\r
{\r
  EFI_GUID *   ClassGuid;\r
  UINT8        ClassGuidNum;\r
\r
  ClassGuid    = NULL;\r
  ClassGuidNum = 0;\r
\r
  switch (OpCodeData->OpCode) {\r
    case EFI_IFR_FORM_SET_OP:\r
      //\r
      // process the statement outside of form,if it is formset op, get its formsetguid or classguid and compared with gFrontPageFormSetGuid\r
      //\r
      if (CompareMem (PcdGetPtr (PcdFrontPageFormSetGuid), &((EFI_IFR_FORM_SET *) OpCodeData)->Guid, sizeof (EFI_GUID)) == 0){\r
        gClassOfVfr = FORMSET_CLASS_FRONT_PAGE;\r
      } else{\r
        ClassGuidNum = (UINT8)(((EFI_IFR_FORM_SET *)OpCodeData)->Flags & 0x3);\r
        ClassGuid    = (EFI_GUID *)(VOID *)((UINT8 *)OpCodeData + sizeof (EFI_IFR_FORM_SET));\r
        while (ClassGuidNum-- > 0){\r
          if (CompareGuid((EFI_GUID*)PcdGetPtr (PcdFrontPageFormSetGuid),ClassGuid)){\r
            gClassOfVfr = FORMSET_CLASS_FRONT_PAGE;\r
            break;\r
          }\r
          ClassGuid ++;\r
        }\r
      }\r
      break;\r
\r
    case EFI_IFR_GUID_OP:\r
      if (CompareGuid (&gEfiIfrTianoGuid, (EFI_GUID *)((CHAR8*) OpCodeData + sizeof (EFI_IFR_OP_HEADER)))) {\r
        //\r
        // Tiano specific GUIDed opcodes\r
        //\r
        switch (((EFI_IFR_GUID_LABEL *) OpCodeData)->ExtendOpCode) {\r
        case EFI_IFR_EXTEND_OP_LABEL:\r
          //\r
          // just ignore label\r
          //\r
          break;\r
\r
        case EFI_IFR_EXTEND_OP_BANNER:\r
          //\r
          // Only in front page form set, we care about the banner data.\r
          //\r
          if (gClassOfVfr == FORMSET_CLASS_FRONT_PAGE) {\r
            //\r
            // Initialize Driver private data\r
            //\r
            if (gBannerData == NULL) {\r
              gBannerData = AllocateZeroPool (sizeof (BANNER_DATA));\r
              ASSERT (gBannerData != NULL);\r
            }\r
\r
            CopyMem (\r
              &gBannerData->Banner[((EFI_IFR_GUID_BANNER *) OpCodeData)->LineNumber][\r
              ((EFI_IFR_GUID_BANNER *) OpCodeData)->Alignment],\r
              &((EFI_IFR_GUID_BANNER *) OpCodeData)->Title,\r
              sizeof (EFI_STRING_ID)\r
              );\r
          }\r
          break;\r
\r
        case EFI_IFR_EXTEND_OP_SUBCLASS:\r
          if (((EFI_IFR_GUID_SUBCLASS *) OpCodeData)->SubClass == EFI_FRONT_PAGE_SUBCLASS) {\r
            gClassOfVfr = FORMSET_CLASS_FRONT_PAGE;\r
          }\r
          break;\r
\r
        default:\r
          break;\r
        }\r
      }\r
      break;\r
\r
    default:\r
      break;\r
  }\r
}\r
\r
/**\r
  Process some op codes which is out side of current form.\r
\r
  @param FormData                Pointer to the form data.\r
\r
  @return EFI_SUCCESS            Pass the statement success.\r
\r
**/\r
VOID\r
ProcessExternedOpcode (\r
  IN FORM_DISPLAY_ENGINE_FORM       *FormData\r
  )\r
{\r
  LIST_ENTRY                    *Link;\r
  LIST_ENTRY                    *NestLink;\r
  FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
  FORM_DISPLAY_ENGINE_STATEMENT *NestStatement;\r
\r
  Link = GetFirstNode (&FormData->StatementListOSF);\r
  while (!IsNull (&FormData->StatementListOSF, Link)) {\r
    Statement = FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK (Link);\r
    Link = GetNextNode (&FormData->StatementListOSF, Link);\r
\r
    ProcessUserOpcode(Statement->OpCode);\r
  }\r
\r
  Link = GetFirstNode (&FormData->StatementListHead);\r
  while (!IsNull (&FormData->StatementListHead, Link)) {\r
    Statement = FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK (Link);\r
    Link = GetNextNode (&FormData->StatementListHead, Link);\r
\r
    ProcessUserOpcode(Statement->OpCode);\r
\r
    NestLink = GetFirstNode (&Statement->NestStatementList);\r
    while (!IsNull (&Statement->NestStatementList, NestLink)) {\r
      NestStatement = FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK (NestLink);\r
      NestLink = GetNextNode (&Statement->NestStatementList, NestLink);\r
\r
      ProcessUserOpcode(NestStatement->OpCode);\r
    }\r
\r
  }\r
}\r
\r
/**\r
  Validate the input screen diemenstion info.\r
\r
  @param  FormData               The input form data info.\r
\r
  @return EFI_SUCCESS            The input screen info is acceptable.\r
  @return EFI_INVALID_PARAMETER  The input screen info is not acceptable.\r
\r
**/\r
EFI_STATUS\r
ScreenDiemensionInfoValidate (\r
  IN FORM_DISPLAY_ENGINE_FORM       *FormData\r
  )\r
{\r
  LIST_ENTRY           *Link;\r
  UINTN                Index;\r
\r
  //\r
  // Calculate total number of Register HotKeys.\r
  //\r
  Index = 0;\r
  if (!IsListEmpty (&FormData->HotKeyListHead)){\r
    Link  = GetFirstNode (&FormData->HotKeyListHead);\r
    while (!IsNull (&FormData->HotKeyListHead, Link)) {\r
      Link = GetNextNode (&FormData->HotKeyListHead, Link);\r
      Index ++;\r
    }\r
  }\r
\r
  //\r
  // Show three HotKeys help information on one row.\r
  //\r
  gFooterHeight = FOOTER_HEIGHT + (Index / 3);\r
\r
\r
  ZeroMem (&gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));\r
  gST->ConOut->QueryMode (\r
                 gST->ConOut,\r
                 gST->ConOut->Mode->Mode,\r
                 &gScreenDimensions.RightColumn,\r
                 &gScreenDimensions.BottomRow\r
                 );\r
\r
  //\r
  // Check local dimension vs. global dimension.\r
  //\r
  if (FormData->ScreenDimensions != NULL) {\r
    if ((gScreenDimensions.RightColumn < FormData->ScreenDimensions->RightColumn) ||\r
        (gScreenDimensions.BottomRow < FormData->ScreenDimensions->BottomRow)\r
        ) {\r
      return EFI_INVALID_PARAMETER;\r
    } else {\r
      //\r
      // Local dimension validation.\r
      //\r
      if ((FormData->ScreenDimensions->RightColumn > FormData->ScreenDimensions->LeftColumn) &&\r
          (FormData->ScreenDimensions->BottomRow > FormData->ScreenDimensions->TopRow) &&\r
          ((FormData->ScreenDimensions->RightColumn - FormData->ScreenDimensions->LeftColumn) > 2) &&\r
          ((FormData->ScreenDimensions->BottomRow - FormData->ScreenDimensions->TopRow) > STATUS_BAR_HEIGHT +\r
            FRONT_PAGE_HEADER_HEIGHT + gFooterHeight + 3)) {\r
        CopyMem (&gScreenDimensions, (VOID *) FormData->ScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));\r
      } else {\r
        return EFI_INVALID_PARAMETER;\r
      }\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Get the string based on the StringId and HII Package List Handle.\r
\r
  @param  Token                  The String's ID.\r
  @param  HiiHandle              The package list in the HII database to search for\r
                                 the specified string.\r
\r
  @return The output string.\r
\r
**/\r
CHAR16 *\r
LibGetToken (\r
  IN  EFI_STRING_ID                Token,\r
  IN  EFI_HII_HANDLE               HiiHandle\r
  )\r
{\r
  EFI_STRING  String;\r
\r
  String = HiiGetString (HiiHandle, Token, NULL);\r
  if (String == NULL) {\r
    String = AllocateCopyPool (StrSize (mLibUnknownString), mLibUnknownString);\r
    ASSERT (String != NULL);\r
  }\r
\r
  return (CHAR16 *) String;\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
  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
**/\r
UINTN\r
LibGetStringWidth (\r
  IN CHAR16               *String\r
  )\r
{\r
  UINTN Index;\r
  UINTN Count;\r
  UINTN IncrementValue;\r
\r
  ASSERT (String != NULL);\r
  if (String == NULL) {\r
    return 0;\r
  }\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
  Show all registered HotKey help strings on bottom Rows.\r
\r
  @param FormData          The curent input form data info.\r
  @param SetState          Set HotKey or Clear HotKey\r
\r
**/\r
VOID\r
PrintHotKeyHelpString (\r
  IN FORM_DISPLAY_ENGINE_FORM      *FormData,\r
  IN BOOLEAN                       SetState\r
  )\r
{\r
  UINTN                  CurrentCol;\r
  UINTN                  CurrentRow;\r
  UINTN                  BottomRowOfHotKeyHelp;\r
  UINTN                  ColumnIndexWidth;\r
  UINTN                  ColumnWidth;\r
  UINTN                  ColumnIndex;\r
  UINTN                  Index;\r
  EFI_SCREEN_DESCRIPTOR  LocalScreen;\r
  LIST_ENTRY             *Link;\r
  BROWSER_HOT_KEY        *HotKey;\r
  CHAR16                 BakChar;\r
  CHAR16                 *ColumnStr;\r
\r
  CopyMem (&LocalScreen, &gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));\r
  ColumnWidth            = (LocalScreen.RightColumn - LocalScreen.LeftColumn) / 3;\r
  BottomRowOfHotKeyHelp  = LocalScreen.BottomRow - STATUS_BAR_HEIGHT - 3;\r
  ColumnStr              = gLibEmptyString;\r
\r
  //\r
  // Calculate total number of Register HotKeys.\r
  //\r
  Index = 0;\r
  Link  = GetFirstNode (&FormData->HotKeyListHead);\r
  while (!IsNull (&FormData->HotKeyListHead, Link)) {\r
    HotKey = BROWSER_HOT_KEY_FROM_LINK (Link);\r
    //\r
    // Calculate help information Column and Row.\r
    //\r
    ColumnIndex = Index % 3;\r
    if (ColumnIndex == 0) {\r
      CurrentCol       = LocalScreen.LeftColumn + 2 * ColumnWidth;\r
      ColumnIndexWidth = ColumnWidth - 1;\r
    } else if (ColumnIndex == 1) {\r
      CurrentCol       = LocalScreen.LeftColumn + ColumnWidth;\r
      ColumnIndexWidth = ColumnWidth;\r
    } else {\r
      CurrentCol       = LocalScreen.LeftColumn + 2;\r
      ColumnIndexWidth = ColumnWidth - 2;\r
    }\r
    CurrentRow = BottomRowOfHotKeyHelp - Index / 3;\r
\r
    //\r
    // Help string can't exceed ColumnWidth. One Row will show three Help information.\r
    //\r
    BakChar = L'\0';\r
    if (StrLen (HotKey->HelpString) > ColumnIndexWidth) {\r
      BakChar = HotKey->HelpString[ColumnIndexWidth];\r
      HotKey->HelpString[ColumnIndexWidth] = L'\0';\r
    }\r
\r
    //\r
    // Print HotKey help string on bottom Row.\r
    //\r
    if (SetState) {\r
      ColumnStr = HotKey->HelpString;\r
    }\r
    PrintStringAtWithWidth (CurrentCol, CurrentRow, ColumnStr, ColumnIndexWidth);\r
\r
    if (BakChar != L'\0') {\r
      HotKey->HelpString[ColumnIndexWidth] = BakChar;\r
    }\r
    //\r
    // Get Next Hot Key.\r
    //\r
    Link = GetNextNode (&FormData->HotKeyListHead, Link);\r
    Index ++;\r
  }\r
\r
  if (SetState) {\r
    //\r
    // Clear KeyHelp\r
    //\r
    CurrentRow  = BottomRowOfHotKeyHelp - Index / 3;\r
    ColumnIndex = Index % 3;\r
    if (ColumnIndex == 0) {\r
      CurrentCol       = LocalScreen.LeftColumn + 2 * ColumnWidth;\r
      ColumnIndexWidth = ColumnWidth - 1;\r
      ColumnIndex ++;\r
      PrintStringAtWithWidth (CurrentCol, CurrentRow, gLibEmptyString, ColumnIndexWidth);\r
    }\r
    if (ColumnIndex == 1) {\r
      CurrentCol       = LocalScreen.LeftColumn + ColumnWidth;\r
      ColumnIndexWidth = ColumnWidth;\r
      PrintStringAtWithWidth (CurrentCol, CurrentRow, gLibEmptyString, ColumnIndexWidth);\r
    }\r
  }\r
\r
  return;\r
}\r
\r
/**\r
  Get step info from numeric opcode.\r
\r
  @param[in] OpCode     The input numeric op code.\r
\r
  @return step info for this opcode.\r
**/\r
UINT64\r
LibGetFieldFromNum (\r
  IN  EFI_IFR_OP_HEADER     *OpCode\r
  )\r
{\r
  EFI_IFR_NUMERIC       *NumericOp;\r
  UINT64                Step;\r
\r
  NumericOp = (EFI_IFR_NUMERIC *) OpCode;\r
\r
  switch (NumericOp->Flags & EFI_IFR_NUMERIC_SIZE) {\r
  case EFI_IFR_NUMERIC_SIZE_1:\r
    Step    = NumericOp->data.u8.Step;\r
    break;\r
\r
  case EFI_IFR_NUMERIC_SIZE_2:\r
    Step    = NumericOp->data.u16.Step;\r
    break;\r
\r
  case EFI_IFR_NUMERIC_SIZE_4:\r
    Step    = NumericOp->data.u32.Step;\r
    break;\r
\r
  case EFI_IFR_NUMERIC_SIZE_8:\r
    Step    = NumericOp->data.u64.Step;\r
    break;\r
\r
  default:\r
    Step = 0;\r
    break;\r
  }\r
\r
  return Step;\r
}\r
\r
/**\r
  Initialize the HII String Token to the correct values.\r
\r
**/\r
VOID\r
InitializeLibStrings (\r
  VOID\r
  )\r
{\r
  mLibUnknownString        = L"!";\r
\r
  gEnterString          = LibGetToken (STRING_TOKEN (ENTER_STRING), mCDLStringPackHandle);\r
  gEnterCommitString    = LibGetToken (STRING_TOKEN (ENTER_COMMIT_STRING), mCDLStringPackHandle);\r
  gEnterEscapeString    = LibGetToken (STRING_TOKEN (ENTER_ESCAPE_STRING), mCDLStringPackHandle);\r
  gEscapeString         = LibGetToken (STRING_TOKEN (ESCAPE_STRING), mCDLStringPackHandle);\r
  gMoveHighlight        = LibGetToken (STRING_TOKEN (MOVE_HIGHLIGHT), mCDLStringPackHandle);\r
  gDecNumericInput      = LibGetToken (STRING_TOKEN (DEC_NUMERIC_INPUT), mCDLStringPackHandle);\r
  gHexNumericInput      = LibGetToken (STRING_TOKEN (HEX_NUMERIC_INPUT), mCDLStringPackHandle);\r
  gToggleCheckBox       = LibGetToken (STRING_TOKEN (TOGGLE_CHECK_BOX), mCDLStringPackHandle);\r
\r
  gAreYouSure           = LibGetToken (STRING_TOKEN (ARE_YOU_SURE), mCDLStringPackHandle);\r
  gYesResponse          = LibGetToken (STRING_TOKEN (ARE_YOU_SURE_YES), mCDLStringPackHandle);\r
  gNoResponse           = LibGetToken (STRING_TOKEN (ARE_YOU_SURE_NO), mCDLStringPackHandle);\r
  gPlusString           = LibGetToken (STRING_TOKEN (PLUS_STRING), mCDLStringPackHandle);\r
  gMinusString          = LibGetToken (STRING_TOKEN (MINUS_STRING), mCDLStringPackHandle);\r
  gAdjustNumber         = LibGetToken (STRING_TOKEN (ADJUST_NUMBER), mCDLStringPackHandle);\r
  gSaveChanges          = LibGetToken (STRING_TOKEN (SAVE_CHANGES), mCDLStringPackHandle);\r
\r
  gLibEmptyString       = LibGetToken (STRING_TOKEN (EMPTY_STRING), mCDLStringPackHandle);\r
\r
  gNvUpdateMessage      = LibGetToken (STRING_TOKEN (NV_UPDATE_MESSAGE), mCDLStringPackHandle);\r
  gInputErrorMessage    = LibGetToken (STRING_TOKEN (INPUT_ERROR_MESSAGE), mCDLStringPackHandle);\r
\r
  //\r
  // SpaceBuffer;\r
  //\r
  mSpaceBuffer = AllocatePool ((SPACE_BUFFER_SIZE + 1) * sizeof (CHAR16));\r
  ASSERT (mSpaceBuffer != NULL);\r
  LibSetUnicodeMem (mSpaceBuffer, SPACE_BUFFER_SIZE, L' ');\r
  mSpaceBuffer[SPACE_BUFFER_SIZE] = L'\0';\r
}\r
\r
\r
/**\r
  Free the HII String.\r
\r
**/\r
VOID\r
FreeLibStrings (\r
  VOID\r
  )\r
{\r
  FreePool (gEnterString);\r
  FreePool (gEnterCommitString);\r
  FreePool (gEnterEscapeString);\r
  FreePool (gEscapeString);\r
  FreePool (gMoveHighlight);\r
  FreePool (gDecNumericInput);\r
  FreePool (gHexNumericInput);\r
  FreePool (gToggleCheckBox);\r
\r
  FreePool (gAreYouSure);\r
  FreePool (gYesResponse);\r
  FreePool (gNoResponse);\r
  FreePool (gPlusString);\r
  FreePool (gMinusString);\r
  FreePool (gAdjustNumber);\r
  FreePool (gSaveChanges);\r
\r
  FreePool (gLibEmptyString);\r
\r
  FreePool (gNvUpdateMessage);\r
  FreePool (gInputErrorMessage);\r
\r
  FreePool (mSpaceBuffer);\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
  EFI_STATUS  Status;\r
  UINTN       Index;\r
\r
  while (TRUE) {\r
    Status = gST->ConIn->ReadKeyStroke (gST->ConIn, Key);\r
    if (!EFI_ERROR (Status)) {\r
      break;\r
    }\r
\r
    if (Status != EFI_NOT_READY) {\r
      continue;\r
    }\r
\r
    gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &Index);\r
  }\r
  return Status;\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
LibSetUnicodeMem (\r
  IN VOID   *Buffer,\r
  IN UINTN  Size,\r
  IN CHAR16 Value\r
  )\r
{\r
  CHAR16  *Ptr;\r
\r
  Ptr = Buffer;\r
  while ((Size--)  != 0) {\r
    *(Ptr++) = Value;\r
  }\r
}\r
\r
/**\r
  The internal function prints to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL\r
  protocol instance.\r
\r
  @param Width           Width of string to be print.\r
  @param Column          The position of the output string.\r
  @param Row             The position of the output string.\r
  @param Out             The EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL instance.\r
  @param Fmt             The format string.\r
  @param Args            The additional argument for the variables in the format string.\r
\r
  @return Number of Unicode character printed.\r
\r
**/\r
UINTN\r
PrintInternal (\r
  IN UINTN                            Width,\r
  IN UINTN                            Column,\r
  IN UINTN                            Row,\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *Out,\r
  IN CHAR16                           *Fmt,\r
  IN VA_LIST                          Args\r
  )\r
{\r
  CHAR16  *Buffer;\r
  CHAR16  *BackupBuffer;\r
  UINTN   Index;\r
  UINTN   PreviousIndex;\r
  UINTN   Count;\r
  UINTN   TotalCount;\r
  UINTN   PrintWidth;\r
  UINTN   CharWidth;\r
\r
  //\r
  // For now, allocate an arbitrarily long buffer\r
  //\r
  Buffer        = AllocateZeroPool (0x10000);\r
  BackupBuffer  = AllocateZeroPool (0x10000);\r
  ASSERT (Buffer);\r
  ASSERT (BackupBuffer);\r
\r
  if (Column != (UINTN) -1) {\r
    Out->SetCursorPosition (Out, Column, Row);\r
  }\r
\r
  UnicodeVSPrint (Buffer, 0x10000, Fmt, Args);\r
\r
  Out->Mode->Attribute = Out->Mode->Attribute & 0x7f;\r
\r
  Out->SetAttribute (Out, Out->Mode->Attribute);\r
\r
  Index         = 0;\r
  PreviousIndex = 0;\r
  Count         = 0;\r
  TotalCount    = 0;\r
  PrintWidth    = 0;\r
  CharWidth     = 1;\r
\r
  do {\r
    for (; (Buffer[Index] != NARROW_CHAR) && (Buffer[Index] != WIDE_CHAR) && (Buffer[Index] != 0); Index++) {\r
      BackupBuffer[Index] = Buffer[Index];\r
    }\r
\r
    if (Buffer[Index] == 0) {\r
      break;\r
    }\r
\r
    //\r
    // Print this out, we are about to switch widths\r
    //\r
    Out->OutputString (Out, &BackupBuffer[PreviousIndex]);\r
    Count = StrLen (&BackupBuffer[PreviousIndex]);\r
    PrintWidth += Count * CharWidth;\r
    TotalCount += Count;\r
\r
    //\r
    // Preserve the current index + 1, since this is where we will start printing from next\r
    //\r
    PreviousIndex = Index + 1;\r
\r
    //\r
    // We are at a narrow or wide character directive.  Set attributes and strip it and print it\r
    //\r
    if (Buffer[Index] == NARROW_CHAR) {\r
      //\r
      // Preserve bits 0 - 6 and zero out the rest\r
      //\r
      Out->Mode->Attribute = Out->Mode->Attribute & 0x7f;\r
      Out->SetAttribute (Out, Out->Mode->Attribute);\r
      CharWidth = 1;\r
    } else {\r
      //\r
      // Must be wide, set bit 7 ON\r
      //\r
      Out->Mode->Attribute = Out->Mode->Attribute | EFI_WIDE_ATTRIBUTE;\r
      Out->SetAttribute (Out, Out->Mode->Attribute);\r
      CharWidth = 2;\r
    }\r
\r
    Index++;\r
\r
  } while (Buffer[Index] != 0);\r
\r
  //\r
  // We hit the end of the string - print it\r
  //\r
  Out->OutputString (Out, &BackupBuffer[PreviousIndex]);\r
  Count = StrLen (&BackupBuffer[PreviousIndex]);\r
  PrintWidth += Count * CharWidth;\r
  TotalCount += Count;\r
  if (PrintWidth < Width) {\r
    Out->Mode->Attribute = Out->Mode->Attribute & 0x7f;\r
    Out->SetAttribute (Out, Out->Mode->Attribute);\r
    Out->OutputString (Out, &mSpaceBuffer[SPACE_BUFFER_SIZE - Width + PrintWidth]);\r
  }\r
\r
  FreePool (Buffer);\r
  FreePool (BackupBuffer);\r
  return TotalCount;\r
}\r
\r
/**\r
  Prints a formatted unicode string to the default console, at\r
  the supplied cursor position.\r
\r
  @param  Width      Width of String to be printed.\r
  @param  Column     The cursor position to print the string at.\r
  @param  Row        The cursor position to print the string at.\r
  @param  Fmt        Format string.\r
  @param  ...        Variable argument list for format string.\r
\r
  @return Length of string printed to the console\r
\r
**/\r
UINTN\r
EFIAPI\r
PrintAt (\r
  IN UINTN     Width,\r
  IN UINTN     Column,\r
  IN UINTN     Row,\r
  IN CHAR16    *Fmt,\r
  ...\r
  )\r
{\r
  VA_LIST Args;\r
  UINTN   LengthOfPrinted;\r
\r
  VA_START (Args, Fmt);\r
  LengthOfPrinted = PrintInternal (Width, Column, Row, gST->ConOut, Fmt, Args);\r
  VA_END (Args);\r
  return LengthOfPrinted;\r
}\r
\r