ShellPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / EditInputBar.c

/** @file\r
  Implements inputbar interface functions.\r
\r
  Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "EditInputBar.h"\r
#include "UefiShellDebug1CommandsLib.h"\r
\r
CHAR16  *mPrompt;        // Input bar mPrompt string.\r
CHAR16  *mReturnString;  // The returned string.\r
UINTN   StringSize;      // Size of mReturnString space size.\r
EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *mTextInEx;\r
\r
/**\r
  Initialize the input bar.\r
\r
  @param[in] TextInEx  Pointer to SimpleTextInEx instance in System Table.\r
**/\r
VOID\r
InputBarInit (\r
  IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *TextInEx\r
  )\r
{\r
  mPrompt       = NULL;\r
  mReturnString = NULL;\r
  StringSize    = 0;\r
  mTextInEx     = TextInEx;\r
}\r
\r
/**\r
  Cleanup function for input bar.\r
**/\r
VOID\r
InputBarCleanup (\r
  VOID\r
  )\r
{\r
  //\r
  // free input bar's prompt and input string\r
  //\r
  SHELL_FREE_NON_NULL (mPrompt);\r
  SHELL_FREE_NON_NULL (mReturnString);\r
  mPrompt       = NULL;\r
  mReturnString = NULL;\r
}\r
\r
/**\r
  Display the prompt.\r
  Do the requesting of input.\r
\r
  @param[in]  LastColumn   The last printable column.\r
  @param[in]  LastRow      The last printable row.\r
**/\r
VOID\r
InputBarPrintInput (\r
  IN UINTN LastColumn,\r
  IN UINTN LastRow\r
  )\r
{\r
  UINTN   Limit;\r
  UINTN   Size;\r
  CHAR16  *Buffer;\r
  UINTN   Index;\r
  UINTN   mPromptLen;\r
\r
  mPromptLen = StrLen (mPrompt);\r
  Limit     = LastColumn - mPromptLen - 1;\r
  Size      = StrLen (mReturnString);\r
\r
  //\r
  // check whether the mPrompt length and input length will\r
  // exceed limit\r
  //\r
  if (Size <= Limit) {\r
    Buffer = mReturnString;\r
  } else {\r
    Buffer = mReturnString + Size - Limit;\r
  }\r
\r
  gST->ConOut->EnableCursor (gST->ConOut, FALSE);\r
\r
  ShellPrintEx (((INT32)mPromptLen), ((INT32)LastRow) - 1, L"%s", Buffer);\r
  Size = StrLen (Buffer);\r
\r
  //\r
  // print " " after mPrompt\r
  //\r
  for (Index = Size; Index < Limit; Index++) {\r
    ShellPrintEx ((INT32)(mPromptLen + Size), ((INT32)LastRow) - 1, L" ");\r
  }\r
\r
  gST->ConOut->EnableCursor (gST->ConOut, TRUE);\r
  gST->ConOut->SetCursorPosition (gST->ConOut, Size + mPromptLen, LastRow - 1);\r
}\r
\r
typedef struct {\r
  UINT32  Foreground : 4;\r
  UINT32  Background : 3;\r
} INPUT_BAR_COLOR_ATTRIBUTES;\r
\r
typedef union {\r
  INPUT_BAR_COLOR_ATTRIBUTES  Colors;\r
  UINTN                       Data;\r
} INPUT_BAR_COLOR_UNION;\r
\r
\r
/**\r
  The refresh function for InputBar, it will wait for user input\r
\r
  @param[in] LastRow            The last printable row.\r
  @param[in] LastColumn         The last printable column.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
**/\r
EFI_STATUS\r
InputBarRefresh (\r
  UINTN LastRow,\r
  UINTN LastColumn\r
  )\r
{\r
  INPUT_BAR_COLOR_UNION   Orig;\r
  INPUT_BAR_COLOR_UNION   New;\r
  EFI_KEY_DATA            KeyData;\r
  UINTN                   Size;\r
  EFI_STATUS              Status;\r
  BOOLEAN                 NoDisplay;\r
  UINTN                   EventIndex;\r
  UINTN                   CursorRow;\r
  UINTN                   CursorCol;\r
\r
  //\r
  // variable initialization\r
  //\r
  Size    = 0;\r
  Status  = EFI_SUCCESS;\r
\r
  //\r
  // back up the old screen attributes\r
  //\r
  CursorCol             = gST->ConOut->Mode->CursorColumn;\r
  CursorRow             = gST->ConOut->Mode->CursorRow;\r
  Orig.Data             = gST->ConOut->Mode->Attribute;\r
  New.Data              = 0;\r
  New.Colors.Foreground = Orig.Colors.Background & 0xF;\r
  New.Colors.Background = Orig.Colors.Foreground & 0x7;\r
\r
  gST->ConOut->SetAttribute (gST->ConOut, New.Data & 0x7F);\r
\r
  //\r
  // clear input bar\r
  //\r
  EditorClearLine (LastRow , LastColumn, LastRow);\r
\r
  gST->ConOut->SetCursorPosition (gST->ConOut, 0, LastRow - 1);\r
  ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_EDIT_LIBINPUTBAR_MAININPUTBAR), gShellDebug1HiiHandle, mPrompt);\r
\r
  //\r
  // this is a selection mPrompt, cursor will stay in edit area\r
  // actually this is for search , search/replace\r
  //\r
  if (StrStr (mPrompt, L"Yes/No")) {\r
    NoDisplay = TRUE;\r
    gST->ConOut->SetCursorPosition (gST->ConOut, CursorCol, CursorRow);\r
    gST->ConOut->SetAttribute (gST->ConOut, Orig.Data);\r
  } else {\r
    NoDisplay = FALSE;\r
  }\r
  //\r
  // wait for user input\r
  //\r
  for (;;) {\r
    Status = gBS->WaitForEvent (1, &mTextInEx->WaitForKeyEx, &EventIndex);\r
    if (EFI_ERROR (Status) || (EventIndex != 0)) {\r
      continue;\r
    }\r
    Status = mTextInEx->ReadKeyStrokeEx (mTextInEx, &KeyData);\r
    if (EFI_ERROR (Status)) {\r
      continue;\r
    }\r
    if (((KeyData.KeyState.KeyShiftState & EFI_SHIFT_STATE_VALID) != 0) &&\r
        (KeyData.KeyState.KeyShiftState != EFI_SHIFT_STATE_VALID)) {\r
      //\r
      // Shift key pressed.\r
      //\r
      continue;\r
    }\r
    //\r
    // pressed ESC\r
    //\r
    if (KeyData.Key.ScanCode == SCAN_ESC) {\r
      Size    = 0;\r
      Status  = EFI_NOT_READY;\r
      break;\r
    }\r
    //\r
    // return pressed\r
    //\r
    if (KeyData.Key.UnicodeChar == CHAR_LINEFEED || KeyData.Key.UnicodeChar == CHAR_CARRIAGE_RETURN) {\r
      break;\r
    } else if (KeyData.Key.UnicodeChar == CHAR_BACKSPACE) {\r
      //\r
      // backspace\r
      //\r
      if (Size > 0) {\r
        Size--;\r
        mReturnString[Size] = CHAR_NULL;\r
        if (!NoDisplay) {\r
\r
          InputBarPrintInput (LastColumn, LastRow);\r
\r
        }\r
      }\r
    } else if (KeyData.Key.UnicodeChar <= 127 && KeyData.Key.UnicodeChar >= 32) {\r
      //\r
      // VALID ASCII char pressed\r
      //\r
      mReturnString[Size] = KeyData.Key.UnicodeChar;\r
\r
      //\r
      // should be less than specified length\r
      //\r
      if (Size >= StringSize) {\r
        continue;\r
      }\r
\r
      Size++;\r
\r
      mReturnString[Size] = CHAR_NULL;\r
\r
      if (!NoDisplay) {\r
\r
        InputBarPrintInput (LastColumn, LastRow);\r
\r
      } else {\r
        //\r
        // if just choose yes/no\r
        //\r
        break;\r
      }\r
\r
    }\r
  }\r
\r
  mReturnString[Size] = CHAR_NULL;\r
\r
\r
  //\r
  // restore screen attributes\r
  //\r
  gST->ConOut->SetCursorPosition (gST->ConOut, CursorCol, CursorRow);\r
  gST->ConOut->SetAttribute (gST->ConOut, Orig.Data);\r
\r
  return Status;\r
}\r
\r
/**\r
  SetPrompt and wait for input.\r
\r
  @param[in] Str                The prompt string.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
**/\r
EFI_STATUS\r
InputBarSetPrompt (\r
  IN CONST CHAR16 *Str\r
  )\r
{\r
  //\r
  // FREE the old mPrompt string\r
  //\r
  SHELL_FREE_NON_NULL (mPrompt);\r
\r
  mPrompt = CatSPrint (NULL, L"%s ", Str);\r
  if (mPrompt == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Set the size of the string in characters.\r
\r
  @param[in] Size               The max number of characters to accept.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
**/\r
EFI_STATUS\r
InputBarSetStringSize (\r
  UINTN   Size\r
  )\r
{\r
  //\r
  // free the old ReturnStirng\r
  //\r
  SHELL_FREE_NON_NULL (mReturnString);\r
\r
  StringSize = Size;\r
  mReturnString = AllocateZeroPool ((StringSize + 1) * sizeof(mReturnString[0]));\r
  if (mReturnString == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Function to retrieve the input from the user.\r
\r
  @retval NULL                  No input has been received.\r
  @return The string that was input.\r
**/\r
CONST CHAR16*\r
InputBarGetString (\r
  VOID\r
  )\r
{\r
  return (mReturnString);\r
}\r