[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / Edit / MainTextEditor.c

/** @file\r
  Implements editor 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 "TextEditor.h"\r
#include "EditStatusBar.h"\r
#include "EditInputBar.h"\r
#include "EditMenuBar.h"\r
\r
//\r
// the first time editor launch\r
//\r
BOOLEAN                       EditorFirst;\r
\r
//\r
// it's time editor should exit\r
//\r
BOOLEAN                       EditorExit;\r
\r
BOOLEAN                       EditorMouseAction;\r
\r
extern EFI_EDITOR_FILE_BUFFER FileBuffer;\r
\r
extern BOOLEAN                FileBufferNeedRefresh;\r
\r
extern BOOLEAN                FileBufferOnlyLineNeedRefresh;\r
\r
extern BOOLEAN                FileBufferMouseNeedRefresh;\r
\r
extern EFI_EDITOR_FILE_BUFFER FileBufferBackupVar;\r
\r
EFI_EDITOR_GLOBAL_EDITOR      MainEditor;\r
\r
\r
/**\r
  Load a file from disk to editor\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_LOAD_ERROR          A load error occurred.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
**/\r
EFI_STATUS\r
MainCommandOpenFile (\r
  VOID\r
  );\r
\r
/**\r
  Switch a file from ASCII to UNICODE or vise-versa.\r
\r
  @retval EFI_SUCCESS           The switch was ok or a warning was presented.\r
**/\r
EFI_STATUS\r
MainCommandSwitchFileType (\r
  VOID\r
  );\r
\r
/**\r
  move cursor to specified lines\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
**/\r
EFI_STATUS\r
MainCommandGotoLine (\r
  VOID\r
  );\r
\r
/**\r
  Save current file to disk, you can save to current file name or\r
  save to another file name.\r
\r
  @retval EFI_SUCCESS           The file was saved correctly.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
  @retval EFI_LOAD_ERROR          A file access error occurred.\r
**/\r
EFI_STATUS\r
MainCommandSaveFile (\r
  VOID\r
  );\r
\r
/**\r
  Show help information for the editor.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
**/\r
EFI_STATUS\r
MainCommandDisplayHelp (\r
  VOID\r
  );\r
\r
/**\r
  exit editor\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
  @retval EFI_LOAD_ERROR          A load error occurred.\r
**/\r
EFI_STATUS\r
MainCommandExit (\r
  VOID\r
  );\r
\r
/**\r
  search string in file buffer\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
  @retval EFI_LOAD_ERROR          A load error occurred.\r
**/\r
EFI_STATUS\r
MainCommandSearch (\r
  VOID\r
  );\r
\r
/**\r
  search string in file buffer, and replace it with another str\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
  @retval EFI_LOAD_ERROR          A load error occurred.\r
**/\r
EFI_STATUS\r
MainCommandSearchReplace (\r
  VOID\r
  );\r
\r
/**\r
  cut current line to clipboard\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
  @retval EFI_LOAD_ERROR          A load error occurred.\r
**/\r
EFI_STATUS\r
MainCommandCutLine (\r
  VOID\r
  );\r
\r
/**\r
  paste line to file buffer.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
  @retval EFI_LOAD_ERROR          A load error occurred.\r
**/\r
EFI_STATUS\r
MainCommandPasteLine (\r
  VOID\r
  );\r
\r
/**\r
  Help info that will be displayed.\r
**/\r
EFI_STRING_ID  MainMenuHelpInfo[] = {\r
  STRING_TOKEN(STR_EDIT_HELP_TITLE),\r
  STRING_TOKEN(STR_EDIT_HELP_BLANK),\r
  STRING_TOKEN(STR_EDIT_HELP_LIST_TITLE),\r
  STRING_TOKEN(STR_EDIT_HELP_DIV),\r
  STRING_TOKEN(STR_EDIT_HELP_GO_TO_LINE),\r
  STRING_TOKEN(STR_EDIT_HELP_SAVE_FILE),\r
  STRING_TOKEN(STR_EDIT_HELP_EXIT),\r
  STRING_TOKEN(STR_EDIT_HELP_SEARCH),\r
  STRING_TOKEN(STR_EDIT_HELP_SEARCH_REPLACE),\r
  STRING_TOKEN(STR_EDIT_HELP_CUT_LINE),\r
  STRING_TOKEN(STR_EDIT_HELP_PASTE_LINE),\r
  STRING_TOKEN(STR_EDIT_HELP_OPEN_FILE),\r
  STRING_TOKEN(STR_EDIT_HELP_FILE_TYPE),\r
  STRING_TOKEN(STR_EDIT_HELP_BLANK),\r
  STRING_TOKEN(STR_EDIT_HELP_EXIT_HELP),\r
  STRING_TOKEN(STR_EDIT_HELP_BLANK),\r
  STRING_TOKEN(STR_EDIT_HELP_BLANK),\r
  STRING_TOKEN(STR_EDIT_HELP_BLANK),\r
  STRING_TOKEN(STR_EDIT_HELP_BLANK),\r
  STRING_TOKEN(STR_EDIT_HELP_BLANK),\r
  STRING_TOKEN(STR_EDIT_HELP_BLANK),\r
  STRING_TOKEN(STR_EDIT_HELP_BLANK),\r
  STRING_TOKEN(STR_EDIT_HELP_DIV),\r
0\r
};\r
\r
MENU_ITEM_FUNCTION MainControlBasedMenuFunctions[] = {\r
  NULL,\r
  NULL,                      /* Ctrl - A */\r
  NULL,                      /* Ctrl - B */\r
  NULL,                      /* Ctrl - C */\r
  NULL,                      /* Ctrl - D */\r
  MainCommandDisplayHelp,    /* Ctrl - E */\r
  MainCommandSearch,         /* Ctrl - F */\r
  MainCommandGotoLine,       /* Ctrl - G */\r
  NULL,                      /* Ctrl - H */\r
  NULL,                      /* Ctrl - I */\r
  NULL,                      /* Ctrl - J */\r
  MainCommandCutLine,        /* Ctrl - K */\r
  NULL,                      /* Ctrl - L */\r
  NULL,                      /* Ctrl - M */\r
  NULL,                      /* Ctrl - N */\r
  MainCommandOpenFile,       /* Ctrl - O */\r
  NULL,                      /* Ctrl - P */\r
  MainCommandExit,           /* Ctrl - Q */\r
  MainCommandSearchReplace,  /* Ctrl - R */\r
  MainCommandSaveFile,       /* Ctrl - S */\r
  MainCommandSwitchFileType, /* Ctrl - T */\r
  MainCommandPasteLine,      /* Ctrl - U */\r
  NULL,                      /* Ctrl - V */\r
  NULL,                      /* Ctrl - W */\r
  NULL,                      /* Ctrl - X */\r
  NULL,                      /* Ctrl - Y */\r
  NULL,                      /* Ctrl - Z */\r
};\r
\r
EDITOR_MENU_ITEM  MainMenuItems[] = {\r
  {\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_GO_TO_LINE),\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_F1),\r
    MainCommandGotoLine\r
  },\r
  {\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_SAVE_FILE),\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_F2),\r
    MainCommandSaveFile\r
  },\r
  {\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_EXIT),\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_F3),\r
    MainCommandExit\r
  },\r
\r
  {\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_SEARCH),\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_F4),\r
    MainCommandSearch\r
  },\r
  {\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_SEARCH_REPLACE),\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_F5),\r
    MainCommandSearchReplace\r
  },\r
  {\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_CUT_LINE),\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_F6),\r
    MainCommandCutLine\r
  },\r
  {\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_PASTE_LINE),\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_F7),\r
    MainCommandPasteLine\r
  },\r
\r
  {\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_OPEN_FILE),\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_F8),\r
    MainCommandOpenFile\r
  },\r
  {\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_FILE_TYPE),\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_F9),\r
    MainCommandSwitchFileType\r
  },\r
  {\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_FILE_TYPE),\r
    STRING_TOKEN(STR_EDIT_LIBMENUBAR_F11),\r
    MainCommandSwitchFileType\r
  },\r
\r
  {\r
    0,\r
    0,\r
    NULL\r
  }\r
};\r
\r
\r
/**\r
  Load a file from disk to editor\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_LOAD_ERROR          A load error occurred.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
**/\r
EFI_STATUS\r
MainCommandOpenFile (\r
  VOID\r
  )\r
{\r
  BOOLEAN     Done;\r
  EFI_STATUS  Status;\r
\r
  //\r
  //  This command will open a file from current working directory.\r
  //   Read-only file can also be opened. But it can not be modified.\r
  // Below is the scenario of Open File command:\r
  // 1.IF currently opened file has not been modIFied, directly go to step .\r
  //   IF currently opened file has been modified,\r
  //     an Input Bar will be prompted as :\r
  //       "File Modified. Save ( Yes/No/Cancel) ?"\r
  //           IF user press 'y' or 'Y', currently opened file will be saved.\r
  //           IF user press 'n' or 'N', currently opened file will\r
  //              not be saved.\r
  //           IF user press 'c' or 'C' or ESC, Open File command ends and\r
  //              currently opened file is still opened.\r
  //\r
  // 2.  An Input Bar will be prompted as :  "File Name to Open: "\r
  //       IF user press ESC, Open File command ends and\r
  //          currently opened file is still opened.\r
  //       Any other inputs with a Return will\r
  //          cause currently opened file close.\r
  //\r
  // 3.  IF user input file name is an existing file , this file will be read\r
  //        and opened.\r
  //    IF user input file name is a new file, this file will be created\r
  //        and opened. This file's type ( UNICODE or ASCII ) is the same\r
  //        with the old file.\r
  // if current file is modified, so you need to choose\r
  // whether to save it first.\r
  //\r
  if (MainEditor.FileBuffer->FileModified) {\r
\r
    Status = InputBarSetPrompt (L"File modified. Save (Yes/No/Cancel) ? ");\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
    //\r
    // the answer is just one character\r
    //\r
    Status = InputBarSetStringSize (1);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
    //\r
    // loop for user's answer\r
    // valid answer is just 'y' 'Y', 'n' 'N', 'c' 'C'\r
    //\r
    Done = FALSE;\r
    while (!Done) {\r
      Status = InputBarRefresh (MainEditor.ScreenSize.Row, MainEditor.ScreenSize.Column);\r
      StatusBarSetRefresh();\r
\r
      //\r
      // ESC pressed\r
      //\r
      if (Status == EFI_NOT_READY) {\r
        return EFI_SUCCESS;\r
      }\r
\r
      switch (InputBarGetString()[0]) {\r
      case L'y':\r
      case L'Y':\r
        //\r
        // want to save this file first\r
        //\r
        Status = FileBufferSave (MainEditor.FileBuffer->FileName);\r
        if (EFI_ERROR (Status)) {\r
          return Status;\r
        }\r
\r
        MainTitleBarRefresh (MainEditor.FileBuffer->FileName, MainEditor.FileBuffer->FileType, MainEditor.FileBuffer->ReadOnly, MainEditor.FileBuffer->FileModified, MainEditor.ScreenSize.Column, MainEditor.ScreenSize.Row, 0, 0);\r
        FileBufferRestorePosition ();\r
        Done = TRUE;\r
        break;\r
\r
      case L'n':\r
      case L'N':\r
        //\r
        // the file won't be saved\r
        //\r
        Done = TRUE;\r
        break;\r
\r
      case L'c':\r
      case L'C':\r
        return EFI_SUCCESS;\r
      }\r
    }\r
  }\r
  //\r
  // TO get the open file name\r
  //\r
  Status = InputBarSetPrompt (L"File Name to Open: ");\r
  if (EFI_ERROR (Status)) {\r
    FileBufferRead (MainEditor.FileBuffer->FileName, TRUE);\r
    return Status;\r
  }\r
\r
  Status = InputBarSetStringSize (100);\r
  if (EFI_ERROR (Status)) {\r
    FileBufferRead (MainEditor.FileBuffer->FileName, TRUE);\r
    return Status;\r
  }\r
\r
  while (1) {\r
    Status = InputBarRefresh (MainEditor.ScreenSize.Row, MainEditor.ScreenSize.Column);\r
    StatusBarSetRefresh();\r
\r
    //\r
    // ESC pressed\r
    //\r
    if (Status == EFI_NOT_READY) {\r
      return EFI_SUCCESS;\r
    }\r
    //\r
    // The input string length should > 0\r
    //\r
    if (StrLen (InputBarGetString()) > 0) {\r
      //\r
      // CHECK if filename is valid\r
      //\r
      if (!IsValidFileName (InputBarGetString())) {\r
        FileBufferRead (MainEditor.FileBuffer->FileName, TRUE);\r
        StatusBarSetStatusString (L"Invalid File Name");\r
        return EFI_SUCCESS;\r
      }\r
\r
      break;\r
    }\r
  }\r
  //\r
  // read from disk\r
  //\r
  Status = FileBufferRead (InputBarGetString(), FALSE);\r
\r
  if (EFI_ERROR (Status)) {\r
    FileBufferRead (MainEditor.FileBuffer->FileName, TRUE);\r
    return EFI_LOAD_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Switch a file from ASCII to UNICODE or vise-versa.\r
\r
  @retval EFI_SUCCESS           The switch was ok or a warning was presented.\r
**/\r
EFI_STATUS\r
MainCommandSwitchFileType (\r
  VOID\r
  )\r
{\r
  //\r
  // Below is the scenario of File Type command:\r
  // After File Type is executed, file type will be changed to another type\r
  // if file is read-only, can not be modified\r
  //\r
  if (MainEditor.FileBuffer->ReadOnly) {\r
    StatusBarSetStatusString (L"Read Only File Can Not Be Modified");\r
    return EFI_SUCCESS;\r
  }\r
\r
  if (MainEditor.FileBuffer->FileType == FileTypeUnicode) {\r
    MainEditor.FileBuffer->FileType = FileTypeAscii;\r
  } else {\r
    MainEditor.FileBuffer->FileType = FileTypeUnicode;\r
  }\r
\r
  MainEditor.FileBuffer->FileModified = TRUE;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  cut current line to clipboard\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
  @retval EFI_LOAD_ERROR          A load error occurred.\r
**/\r
EFI_STATUS\r
MainCommandCutLine (\r
  VOID\r
  )\r
{\r
  EFI_STATUS      Status;\r
  EFI_EDITOR_LINE *Line;\r
\r
  //\r
  // This command will cut current line ( where cursor is on ) to clip board.\r
  //      And cursor will move to the beginning of next line.\r
  // Below is the scenario of Cut Line command:\r
  // 1.  IF cursor is on valid line, current line will be cut to clip board.\r
  //     IF cursor is not on valid line, an Status String will be prompted :\r
  //        "Nothing to Cut".\r
  //\r
  Line = NULL;\r
  Status = FileBufferCutLine (&Line);\r
  if (Status == EFI_NOT_FOUND) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  MainEditor.CutLine = Line;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  paste line to file buffer.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
  @retval EFI_LOAD_ERROR          A load error occurred.\r
**/\r
EFI_STATUS\r
MainCommandPasteLine (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Below is the scenario of Paste Line command:\r
  // 1.  IF nothing is on clipboard, a Status String will be prompted :\r
  //        "No Line to Paste" and Paste Line command ends.\r
  //     IF something is on clipboard, insert it above current line.\r
  // nothing on clipboard\r
  //\r
  if (MainEditor.CutLine == NULL) {\r
    StatusBarSetStatusString (L"No Line to Paste");\r
    return EFI_SUCCESS;\r
  }\r
\r
  Status = FileBufferPasteLine ();\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  search string in file buffer\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
  @retval EFI_LOAD_ERROR          A load error occurred.\r
**/\r
EFI_STATUS\r
MainCommandSearch (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
  CHAR16      *Buffer;\r
  BOOLEAN     Done;\r
  UINTN       Offset;\r
\r
  //\r
  // Below is the scenario of Search command:\r
  // 1.  An Input Bar will be prompted : "Enter Search String:".\r
  //       IF user press ESC, Search command ends.\r
  //       IF user just press Enter, Search command ends.\r
  //       IF user inputs the search string,  do Step 2.\r
  //\r
  // 2.  IF input search string is found, cursor will move to the first\r
  //        occurrence and do Step 3.\r
  //     IF input search string is not found, a Status String\r
  //        "Search String Not Found" will be prompted and Search command ends.\r
  //\r
  // 3.  An Input Bar will be prompted: "Find Next (Yes/No/Cancel ) ?".\r
  //      IF user press ESC, Search command ends.\r
  //       IF user press 'y' or 'Y', do Step 2.\r
  //       IF user press 'n' or 'N', Search command ends.\r
  //       IF user press 'c' or 'C', Search command ends.\r
  //\r
  Status = InputBarSetPrompt (L"Enter Search String: ");\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = InputBarSetStringSize (40);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = InputBarRefresh (MainEditor.ScreenSize.Row, MainEditor.ScreenSize.Column);\r
  StatusBarSetRefresh();\r
\r
  //\r
  // ESC\r
  //\r
  if (Status == EFI_NOT_READY) {\r
    return EFI_SUCCESS;\r
  }\r
  //\r
  // just enter pressed\r
  //\r
  if (StrLen (InputBarGetString()) == 0) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  Buffer = CatSPrint (NULL, L"%s", InputBarGetString());\r
  if (Buffer == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  //\r
  // the first time , search from current position\r
  //\r
  Offset = 0;\r
  do {\r
    //\r
    // since search may be continued to search multiple times\r
    // so we need to backup editor each time\r
    //\r
    MainEditorBackup ();\r
\r
    Status = FileBufferSearch (Buffer, Offset);\r
\r
    if (Status == EFI_NOT_FOUND) {\r
      break;\r
    }\r
    //\r
    // Find next\r
    //\r
    Status = InputBarSetPrompt (L"Find Next (Yes/No) ?");\r
    if (EFI_ERROR (Status)) {\r
      FreePool (Buffer);\r
      return Status;\r
    }\r
\r
    Status = InputBarSetStringSize (1);\r
    if (EFI_ERROR (Status)) {\r
      FreePool (Buffer);\r
      return Status;\r
    }\r
\r
    Done = FALSE;\r
    while (!Done) {\r
      Status = InputBarRefresh (MainEditor.ScreenSize.Row, MainEditor.ScreenSize.Column);\r
      StatusBarSetRefresh();\r
\r
      //\r
      // ESC pressed\r
      //\r
      if (Status == EFI_NOT_READY) {\r
        FreePool (Buffer);\r
        return EFI_SUCCESS;\r
      }\r
\r
      switch (InputBarGetString()[0]) {\r
      case L'y':\r
      case L'Y':\r
        Done = TRUE;\r
        break;\r
\r
      case L'n':\r
      case L'N':\r
        FreePool (Buffer);\r
        return EFI_SUCCESS;\r
\r
      }\r
      //\r
      // end of which\r
      //\r
    }\r
    //\r
    // end of while !Done\r
    // for search second, third time, search from current position + strlen\r
    //\r
    Offset = StrLen (Buffer);\r
\r
  } while (1);\r
  //\r
  // end of do\r
  //\r
  FreePool (Buffer);\r
  StatusBarSetStatusString (L"Search String Not Found");\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Search string in file buffer, and replace it with another str.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
  @retval EFI_LOAD_ERROR          A load error occurred.\r
**/\r
EFI_STATUS\r
MainCommandSearchReplace (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
  CHAR16      *Search;\r
  CHAR16      *Replace;\r
  BOOLEAN     Done;\r
  BOOLEAN     First;\r
  BOOLEAN     ReplaceOption;\r
  UINTN       SearchLen;\r
  UINTN       ReplaceLen;\r
  BOOLEAN     ReplaceAll;\r
\r
  ReplaceOption = FALSE;\r
\r
  //\r
  // Below is the scenario of Search/Replace command:\r
  // 1.  An Input Bar is prompted : "Enter Search String:".\r
  //       IF user press ESC, Search/Replace command ends.\r
  //       IF user just press Enter, Search/Replace command ends.\r
  //       IF user inputs the search string S, do Step 2.\r
  //\r
  // 2.  An Input Bar is prompted: "Replace With:".\r
  //       IF user press ESC, Search/Replace command ends.\r
  //      IF user inputs the replace string R, do Step 3.\r
  //\r
  // 3.  IF input search string is not found, an Status String\r
  //        "Search String Not Found" will be prompted\r
  //        and Search/Replace command ends\r
  //     IF input search string is found, do Step 4.\r
  //\r
  // 4.  An Input Bar will be prompted: "Replace ( Yes/No/All/Cancel )?"\r
  //       IF user press 'y' or 'Y', S will be replaced with R and do Step 5\r
  //       IF user press 'n' or 'N', S will not be replaced and do Step 5.\r
  //       IF user press 'a' or 'A', all the S from file current position on\r
  //          will be replaced with R and Search/Replace command ends.\r
  //       IF user press 'c' or 'C' or ESC, Search/Replace command ends.\r
  //\r
  // 5.  An Input Bar will be prompted: "Find Next (Yes/No/Cancel) ?".\r
  //       IF user press ESC, Search/Replace command ends.\r
  //       IF user press 'y' or 'Y', do Step 3.\r
  //       IF user press 'n' or 'N', Search/Replace command ends.\r
  //       IF user press 'c' or 'C', Search/Replace command ends.\r
  // input search string\r
  //\r
  Status = InputBarSetPrompt (L"Enter Search String: ");\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = InputBarSetStringSize (40);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = InputBarRefresh (MainEditor.ScreenSize.Row, MainEditor.ScreenSize.Column);\r
  StatusBarSetRefresh();\r
\r
  //\r
  // ESC\r
  //\r
  if (Status == EFI_NOT_READY) {\r
    return EFI_SUCCESS;\r
  }\r
  //\r
  // if just pressed enter\r
  //\r
  if (StrLen (InputBarGetString()) == 0) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  Search = CatSPrint (NULL, L"%s", InputBarGetString());\r
  if (Search == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  SearchLen = StrLen (Search);\r
\r
  //\r
  // input replace string\r
  //\r
  Status = InputBarSetPrompt (L"Replace With: ");\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = InputBarSetStringSize (40);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = InputBarRefresh (MainEditor.ScreenSize.Row, MainEditor.ScreenSize.Column);\r
  StatusBarSetRefresh();\r
\r
  //\r
  // ESC\r
  //\r
  if (Status == EFI_NOT_READY) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  Replace = CatSPrint (NULL, L"%s", InputBarGetString());\r
  if (Replace == NULL) {\r
    FreePool (Search);\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  ReplaceLen  = StrLen (Replace);\r
\r
  First       = TRUE;\r
  ReplaceAll  = FALSE;\r
  do {\r
    //\r
    // since search may be continued to search multiple times\r
    // so we need to backup editor each time\r
    //\r
    MainEditorBackup ();\r
\r
    if (First) {\r
      Status = FileBufferSearch (Search, 0);\r
    } else {\r
      //\r
      // if just replace, so skip this replace string\r
      // if replace string is an empty string, so skip to next character\r
      //\r
      if (ReplaceOption) {\r
        Status = FileBufferSearch (Search, (ReplaceLen == 0) ? 1 : ReplaceLen);\r
      } else {\r
        Status = FileBufferSearch (Search, SearchLen);\r
      }\r
    }\r
\r
    if (Status == EFI_NOT_FOUND) {\r
      break;\r
    }\r
    //\r
    // replace or not?\r
    //\r
    Status = InputBarSetPrompt (L"Replace (Yes/No/All/Cancel) ?");\r
\r
    if (EFI_ERROR (Status)) {\r
      FreePool (Search);\r
      FreePool (Replace);\r
      return Status;\r
    }\r
\r
    Status = InputBarSetStringSize (1);\r
    if (EFI_ERROR (Status)) {\r
      FreePool (Search);\r
      FreePool (Replace);\r
      return Status;\r
    }\r
\r
    Done = FALSE;\r
    while (!Done) {\r
      Status = InputBarRefresh (MainEditor.ScreenSize.Row, MainEditor.ScreenSize.Column);\r
      StatusBarSetRefresh();\r
\r
      //\r
      // ESC pressed\r
      //\r
      if (Status == EFI_NOT_READY) {\r
        FreePool (Search);\r
        FreePool (Replace);\r
        return EFI_SUCCESS;\r
      }\r
\r
      switch (InputBarGetString()[0]) {\r
      case L'y':\r
      case L'Y':\r
        Done          = TRUE;\r
        ReplaceOption = TRUE;\r
        break;\r
\r
      case L'n':\r
      case L'N':\r
        Done          = TRUE;\r
        ReplaceOption = FALSE;\r
        break;\r
\r
      case L'a':\r
      case L'A':\r
        Done          = TRUE;\r
        ReplaceOption = TRUE;\r
        ReplaceAll    = TRUE;\r
        break;\r
\r
      case L'c':\r
      case L'C':\r
        FreePool (Search);\r
        FreePool (Replace);\r
        return EFI_SUCCESS;\r
\r
      }\r
      //\r
      // end of which\r
      //\r
    }\r
    //\r
    // end of while !Done\r
    // Decide to Replace\r
    //\r
    if (ReplaceOption) {\r
      //\r
      // file is read-only\r
      //\r
      if (MainEditor.FileBuffer->ReadOnly) {\r
        StatusBarSetStatusString (L"Read Only File Can Not Be Modified");\r
        return EFI_SUCCESS;\r
      }\r
      //\r
      // replace all\r
      //\r
      if (ReplaceAll) {\r
        Status = FileBufferReplaceAll (Search, Replace, 0);\r
        FreePool (Search);\r
        FreePool (Replace);\r
        return Status;\r
      }\r
      //\r
      // replace\r
      //\r
      Status = FileBufferReplace (Replace, SearchLen);\r
      if (EFI_ERROR (Status)) {\r
        FreePool (Search);\r
        FreePool (Replace);\r
        return Status;\r
      }\r
    }\r
    //\r
    // Find next\r
    //\r
    Status = InputBarSetPrompt (L"Find Next (Yes/No) ?");\r
    if (EFI_ERROR (Status)) {\r
      FreePool (Search);\r
      FreePool (Replace);\r
      return Status;\r
    }\r
\r
    Status = InputBarSetStringSize (1);\r
    if (EFI_ERROR (Status)) {\r
      FreePool (Search);\r
      FreePool (Replace);\r
      return Status;\r
    }\r
\r
    Done = FALSE;\r
    while (!Done) {\r
      Status = InputBarRefresh (MainEditor.ScreenSize.Row, MainEditor.ScreenSize.Column);\r
      StatusBarSetRefresh();\r
\r
      //\r
      // ESC pressed\r
      //\r
      if (Status == EFI_NOT_READY) {\r
        FreePool (Search);\r
        FreePool (Replace);\r
        return EFI_SUCCESS;\r
      }\r
\r
      switch (InputBarGetString()[0]) {\r
      case L'y':\r
      case L'Y':\r
        Done = TRUE;\r
        break;\r
\r
      case L'n':\r
      case L'N':\r
        FreePool (Search);\r
        FreePool (Replace);\r
        return EFI_SUCCESS;\r
\r
      }\r
      //\r
      // end of which\r
      //\r
    }\r
    //\r
    // end of while !Done\r
    //\r
    First = FALSE;\r
\r
  } while (1);\r
  //\r
  // end of do\r
  //\r
  FreePool (Search);\r
  FreePool (Replace);\r
\r
  StatusBarSetStatusString (L"Search String Not Found");\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  exit editor\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
  @retval EFI_LOAD_ERROR          A load error occurred.\r
**/\r
EFI_STATUS\r
MainCommandExit (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Below is the scenario of Exit command:\r
  // 1.  IF currently opened file is not modified, exit the editor and\r
  //        Exit command ends.\r
  //     IF currently opened file is modified, do Step 2\r
  //\r
  // 2.  An Input Bar will be prompted:\r
  //        "File modified. Save ( Yes/No/Cancel )?"\r
  //       IF user press 'y' or 'Y', currently opened file will be saved\r
  //          and Editor exits\r
  //       IF user press 'n' or 'N', currently opened file will not be saved\r
  //          and Editor exits.\r
  //       IF user press 'c' or 'C' or ESC, Exit command ends.\r
  // if file has been modified, so will prompt user whether to save the changes\r
  //\r
  if (MainEditor.FileBuffer->FileModified) {\r
\r
    Status = InputBarSetPrompt (L"File modified. Save (Yes/No/Cancel) ? ");\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    Status = InputBarSetStringSize (1);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    while (1) {\r
      Status = InputBarRefresh (MainEditor.ScreenSize.Row, MainEditor.ScreenSize.Column);\r
      StatusBarSetRefresh();\r
\r
      //\r
      // ESC pressed\r
      //\r
      if (Status == EFI_NOT_READY) {\r
        return EFI_SUCCESS;\r
      }\r
\r
      switch (InputBarGetString()[0]) {\r
      case L'y':\r
      case L'Y':\r
        //\r
        // write file back to disk\r
        //\r
        Status = FileBufferSave (MainEditor.FileBuffer->FileName);\r
        if (!EFI_ERROR (Status)) {\r
          EditorExit = TRUE;\r
        }\r
\r
        return Status;\r
\r
      case L'n':\r
      case L'N':\r
        EditorExit = TRUE;\r
        return EFI_SUCCESS;\r
\r
      case L'c':\r
      case L'C':\r
        return EFI_SUCCESS;\r
\r
      }\r
    }\r
  }\r
\r
  EditorExit = TRUE;\r
  return EFI_SUCCESS;\r
\r
}\r
\r
/**\r
  move cursor to specified lines\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
**/\r
EFI_STATUS\r
MainCommandGotoLine (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       Row;\r
\r
  //\r
  // Below is the scenario of Go To Line command:\r
  // 1.  An Input Bar will be prompted : "Go To Line:".\r
  //       IF user press ESC, Go To Line command ends.\r
  //       IF user just press Enter, cursor remains unchanged.\r
  //       IF user inputs line number, do Step 2.\r
  //\r
  // 2.  IF input line number is valid, move cursor to the beginning\r
  //        of specified line and Go To Line command ends.\r
  //    IF input line number is invalid, a Status String will be prompted:\r
  //        "No Such Line" and Go To Line command ends.\r
  //\r
  Status = InputBarSetPrompt (L"Go To Line: ");\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  //\r
  // line number's digit <= 6\r
  //\r
  Status = InputBarSetStringSize (6);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = InputBarRefresh (MainEditor.ScreenSize.Row, MainEditor.ScreenSize.Column);\r
  StatusBarSetRefresh();\r
\r
  //\r
  // press ESC\r
  //\r
  if (Status == EFI_NOT_READY) {\r
    return EFI_SUCCESS;\r
  }\r
  //\r
  // if JUST press enter\r
  //\r
  if (StrLen (InputBarGetString()) == 0) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  Row = ShellStrToUintn (InputBarGetString());\r
\r
  //\r
  // invalid line number\r
  //\r
  if (Row > MainEditor.FileBuffer->NumLines || Row <= 0) {\r
    StatusBarSetStatusString (L"No Such Line");\r
    return EFI_SUCCESS;\r
  }\r
  //\r
  // move cursor to that line's start\r
  //\r
  FileBufferMovePosition (Row, 1);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Save current file to disk, you can save to current file name or\r
  save to another file name.\r
\r
  @retval EFI_SUCCESS           The file was saved correctly.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
  @retval EFI_LOAD_ERROR          A file access error occurred.\r
**/\r
EFI_STATUS\r
MainCommandSaveFile (\r
  VOID\r
  )\r
{\r
  EFI_STATUS        Status;\r
  CHAR16            *FileName;\r
  BOOLEAN           OldFile;\r
  CHAR16            *Str;\r
  SHELL_FILE_HANDLE FileHandle;\r
  EFI_FILE_INFO     *Info;\r
\r
  //\r
  // This command will save currently opened file to disk.\r
  // You can choose save to another file name or just save to\r
  //    current file name.\r
  // Below is the scenario of Save File command:\r
  //    ( Suppose the old file name is A )\r
  // 1.  An Input Bar will be prompted:    "File To Save: [ old file name]"\r
  //     IF user press ESC, Save File command ends .\r
  //     IF user press Enter, input file name will be A.\r
  //     IF user inputs a new file name B,  input file name will be B.\r
  //\r
  // 2.  IF input file name is A, go to do Step 3.\r
  //     IF input file name is B, go to do Step 4.\r
  //\r
  // 3.  IF A is read only, Status Bar will show "Access Denied" and\r
  //       Save File commands ends.\r
  //     IF A is not read only, save file buffer to disk and remove modified\r
  //       flag in Title Bar , then Save File command ends.\r
  //\r
  // 4.  IF B does not exist, create this file and save file buffer to it.\r
  //       Go to do Step 7.\r
  //     IF B exits, do Step 5.\r
  //\r
  // 5.An Input Bar will be prompted:\r
  //      "File Exists. Overwrite ( Yes/No/Cancel )?"\r
  //       IF user press 'y' or 'Y', do Step 6.\r
  //       IF user press 'n' or 'N', Save File commands ends.\r
  //       IF user press 'c' or 'C' or ESC, Save File commands ends.\r
  //\r
  // 6. IF B is a read-only file, Status Bar will show "Access Denied" and\r
  //       Save File commands ends.\r
  //    IF B can be read and write, save file buffer to B.\r
  //\r
  // 7.  Update File Name field in Title Bar to B and remove the modified\r
  //       flag in Title Bar.\r
  //\r
  Str = CatSPrint (NULL, L"File to Save: [%s]", MainEditor.FileBuffer->FileName);\r
  if (Str == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  if (StrLen (Str) >= 50) {\r
    //\r
    // replace the long file name with "..."\r
    //\r
    Str[46] = L'.';\r
    Str[47] = L'.';\r
    Str[48] = L'.';\r
    Str[49] = L']';\r
    Str[50] = CHAR_NULL;\r
  }\r
\r
  Status = InputBarSetPrompt (Str);\r
  FreePool(Str);\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
\r
  Status = InputBarSetStringSize (100);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  //\r
  // get new file name\r
  //\r
  Status = InputBarRefresh (MainEditor.ScreenSize.Row, MainEditor.ScreenSize.Column);\r
  StatusBarSetRefresh();\r
\r
  //\r
  // if user pressed ESC\r
  //\r
  if (Status == EFI_NOT_READY) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // if just enter pressed, so think save to current file name\r
  //\r
  if (StrLen (InputBarGetString()) == 0) {\r
    FileName = CatSPrint (NULL, L"%s", MainEditor.FileBuffer->FileName);\r
  } else {\r
    FileName = CatSPrint (NULL, L"%s", InputBarGetString());\r
  }\r
\r
  if (FileName == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  if (!IsValidFileName (FileName)) {\r
    StatusBarSetStatusString (L"Invalid File Name");\r
    FreePool (FileName);\r
    return EFI_SUCCESS;\r
  }\r
\r
  OldFile = FALSE;\r
\r
  //\r
  // save to the old file\r
  //\r
  if (StringNoCaseCompare (&FileName, &MainEditor.FileBuffer->FileName) == 0) {\r
    OldFile = TRUE;\r
  }\r
\r
  if (OldFile) {\r
    //\r
    // if the file is read only, so can not write back to it.\r
    //\r
    if (MainEditor.FileBuffer->ReadOnly == TRUE) {\r
      StatusBarSetStatusString (L"Access Denied");\r
      FreePool (FileName);\r
      return EFI_SUCCESS;\r
    }\r
  } else {\r
    //\r
    // if the file exists\r
    //\r
    if (ShellFileExists(FileName) != EFI_NOT_FOUND) {\r
      //\r
      // check for read only\r
      //\r
      Status = ShellOpenFileByName(FileName, &FileHandle, EFI_FILE_MODE_READ, 0);\r
      if (EFI_ERROR(Status)) {\r
        StatusBarSetStatusString (L"Open Failed");\r
        FreePool (FileName);\r
        return EFI_SUCCESS;\r
      }\r
\r
      Info = ShellGetFileInfo(FileHandle);\r
      if (Info == NULL) {\r
        StatusBarSetStatusString (L"Access Denied");\r
        FreePool (FileName);\r
        return (EFI_SUCCESS);\r
      }\r
\r
      if (Info->Attribute & EFI_FILE_READ_ONLY) {\r
        StatusBarSetStatusString (L"Access Denied - Read Only");\r
        FreePool (Info);\r
        FreePool (FileName);\r
        return (EFI_SUCCESS);\r
      }\r
      FreePool (Info);\r
\r
      //\r
      // ask user whether to overwrite this file\r
      //\r
      Status = InputBarSetPrompt (L"File exists. Overwrite (Yes/No/Cancel) ? ");\r
      if (EFI_ERROR (Status)) {\r
        SHELL_FREE_NON_NULL (FileName);\r
        return Status;\r
      }\r
\r
      Status = InputBarSetStringSize (1);\r
      if (EFI_ERROR (Status)) {\r
        SHELL_FREE_NON_NULL (FileName);\r
        return Status;\r
      }\r
\r
      while (TRUE) {\r
        Status = InputBarRefresh (MainEditor.ScreenSize.Row, MainEditor.ScreenSize.Column);\r
        StatusBarSetRefresh();\r
\r
        //\r
        // ESC pressed\r
        //\r
        if (Status == EFI_NOT_READY) {\r
          SHELL_FREE_NON_NULL (FileName);\r
          return EFI_SUCCESS;\r
        }\r
\r
        switch (InputBarGetString()[0]) {\r
        case L'y':\r
        case L'Y':\r
          break;\r
\r
        case L'n':\r
        case L'N':\r
        case L'c':\r
        case L'C':\r
          SHELL_FREE_NON_NULL (FileName);\r
          return EFI_SUCCESS;\r
        } // end switch\r
      } // while (!done)\r
    } // file does exist\r
  } // if old file name same\r
\r
  //\r
  // save file to disk with specified name\r
  //\r
  FileBufferSetModified();\r
  Status = FileBufferSave (FileName);\r
  SHELL_FREE_NON_NULL (FileName);\r
\r
  return Status;\r
}\r
\r
/**\r
  Show help information for the editor.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
**/\r
EFI_STATUS\r
MainCommandDisplayHelp (\r
  VOID\r
  )\r
{\r
  INT32           CurrentLine;\r
  CHAR16          *InfoString;\r
  EFI_KEY_DATA    KeyData;\r
  EFI_STATUS      Status;\r
  UINTN           EventIndex;\r
\r
  //\r
  // print helpInfo\r
  //\r
  for (CurrentLine = 0; 0 != MainMenuHelpInfo[CurrentLine]; CurrentLine++) {\r
    InfoString = HiiGetString(gShellDebug1HiiHandle, MainMenuHelpInfo[CurrentLine], NULL);\r
    ShellPrintEx (0, CurrentLine+1, L"%E%s%N", InfoString);\r
  }\r
\r
  //\r
  // scan for ctrl+w\r
  //\r
  while (TRUE) {\r
    Status = gBS->WaitForEvent (1, &MainEditor.TextInputEx->WaitForKeyEx, &EventIndex);\r
    if (EFI_ERROR (Status) || (EventIndex != 0)) {\r
      continue;\r
    }\r
    Status = MainEditor.TextInputEx->ReadKeyStrokeEx (MainEditor.TextInputEx, &KeyData);\r
    if (EFI_ERROR (Status)) {\r
      continue;\r
    }\r
\r
    if (((KeyData.KeyState.KeyShiftState & EFI_SHIFT_STATE_VALID) == 0) ||\r
        (KeyData.KeyState.KeyShiftState == EFI_SHIFT_STATE_VALID)) {\r
      //\r
      // For consoles that don't support/report shift state,\r
      // CTRL+W is translated to L'W' - L'A' + 1.\r
      //\r
      if (KeyData.Key.UnicodeChar == L'W' - L'A' + 1) {\r
        break;\r
      }\r
    } else if (((KeyData.KeyState.KeyShiftState & EFI_SHIFT_STATE_VALID) != 0) &&\r
               ((KeyData.KeyState.KeyShiftState & (EFI_LEFT_CONTROL_PRESSED | EFI_RIGHT_CONTROL_PRESSED)) != 0) &&\r
               ((KeyData.KeyState.KeyShiftState & ~(EFI_SHIFT_STATE_VALID | EFI_LEFT_CONTROL_PRESSED | EFI_RIGHT_CONTROL_PRESSED)) == 0)) {\r
      //\r
      // For consoles that supports/reports shift state,\r
      // make sure that only CONTROL shift key is pressed.\r
      //\r
      if ((KeyData.Key.UnicodeChar == 'w') || (KeyData.Key.UnicodeChar == 'W')) {\r
        break;\r
      }\r
    }\r
  }\r
  //\r
  // update screen with file buffer's info\r
  //\r
  FileBufferRestorePosition ();\r
  FileBufferNeedRefresh = TRUE;\r
  FileBufferOnlyLineNeedRefresh = FALSE;\r
  FileBufferRefresh ();\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_EDITOR_COLOR_ATTRIBUTES   OriginalColors;\r
INTN                          OriginalMode;\r
\r
\r
//\r
// basic initialization for MainEditor\r
//\r
EFI_EDITOR_GLOBAL_EDITOR      MainEditorConst = {\r
  &FileBuffer,\r
  {\r
    {0, 0}\r
  },\r
  {\r
    0,\r
    0\r
  },\r
  NULL,\r
  NULL,\r
  FALSE,\r
  NULL\r
};\r
\r
/**\r
  The initialization function for MainEditor.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_LOAD_ERROR          A load error occurred.\r
**/\r
EFI_STATUS\r
MainEditorInit (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
  EFI_HANDLE  *HandleBuffer;\r
  UINTN       HandleCount;\r
  UINTN       Index;\r
\r
  //\r
  // basic initialization\r
  //\r
  CopyMem (&MainEditor, &MainEditorConst, sizeof (MainEditor));\r
\r
  //\r
  // set screen attributes\r
  //\r
  MainEditor.ColorAttributes.Colors.Foreground  = gST->ConOut->Mode->Attribute & 0x000000ff;\r
\r
  MainEditor.ColorAttributes.Colors.Background  = (UINT8) (gST->ConOut->Mode->Attribute >> 4);\r
  OriginalColors = MainEditor.ColorAttributes.Colors;\r
\r
  OriginalMode = gST->ConOut->Mode->Mode;\r
\r
  //\r
  // query screen size\r
  //\r
  gST->ConOut->QueryMode (\r
        gST->ConOut,\r
        gST->ConOut->Mode->Mode,\r
        &(MainEditor.ScreenSize.Column),\r
        &(MainEditor.ScreenSize.Row)\r
        );\r
\r
  //\r
  // Find TextInEx in System Table ConsoleInHandle\r
  // Per UEFI Spec, TextInEx is required for a console capable platform.\r
  //\r
  Status = gBS->HandleProtocol (\r
              gST->ConsoleInHandle,\r
              &gEfiSimpleTextInputExProtocolGuid,\r
              (VOID**)&MainEditor.TextInputEx\r
              );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Find mouse in System Table ConsoleInHandle\r
  //\r
  Status = gBS->HandleProtocol (\r
                gST->ConsoleInHandle,\r
                &gEfiSimplePointerProtocolGuid,\r
                (VOID**)&MainEditor.MouseInterface\r
                );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // If there is no Simple Pointer Protocol on System Table\r
    //\r
    HandleBuffer = NULL;\r
    MainEditor.MouseInterface = NULL;\r
    Status = gBS->LocateHandleBuffer (\r
                  ByProtocol,\r
                  &gEfiSimplePointerProtocolGuid,\r
                  NULL,\r
                  &HandleCount,\r
                  &HandleBuffer\r
                  );\r
    if (!EFI_ERROR (Status) && HandleCount > 0) {\r
      //\r
      // Try to find the first available mouse device\r
      //\r
      for (Index = 0; Index < HandleCount; Index++) {\r
        Status = gBS->HandleProtocol (\r
                      HandleBuffer[Index],\r
                      &gEfiSimplePointerProtocolGuid,\r
                      (VOID**)&MainEditor.MouseInterface\r
                      );\r
        if (!EFI_ERROR (Status)) {\r
          break;\r
        }\r
      }\r
    }\r
    if (HandleBuffer != NULL) {\r
      FreePool (HandleBuffer);\r
    }\r
  }\r
\r
  if (!EFI_ERROR (Status) && MainEditor.MouseInterface != NULL) {\r
    MainEditor.MouseAccumulatorX  = 0;\r
    MainEditor.MouseAccumulatorY  = 0;\r
    MainEditor.MouseSupported     = TRUE;\r
  }\r
\r
  //\r
  // below will call the five components' init function\r
  //\r
  Status = MainTitleBarInit (L"UEFI EDIT");\r
  if (EFI_ERROR (Status)) {\r
    ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_EDIT_LIBEDITOR_TITLEBAR), gShellDebug1HiiHandle);\r
    return EFI_LOAD_ERROR;\r
  }\r
\r
  Status = ControlHotKeyInit (MainControlBasedMenuFunctions);\r
  Status = MenuBarInit (MainMenuItems);\r
  if (EFI_ERROR (Status)) {\r
    ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_EDIT_LIBEDITOR_MAINMENU), gShellDebug1HiiHandle);\r
    return EFI_LOAD_ERROR;\r
  }\r
\r
  Status = StatusBarInit ();\r
  if (EFI_ERROR (Status)) {\r
    ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_EDIT_LIBEDITOR_STATUSBAR), gShellDebug1HiiHandle);\r
    return EFI_LOAD_ERROR;\r
  }\r
\r
  InputBarInit (MainEditor.TextInputEx);\r
\r
  Status = FileBufferInit ();\r
  if (EFI_ERROR (Status)) {\r
    ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_EDIT_LIBEDITOR_FILEBUFFER), gShellDebug1HiiHandle);\r
    return EFI_LOAD_ERROR;\r
  }\r
  //\r
  // clear whole screen and enable cursor\r
  //\r
  gST->ConOut->ClearScreen (gST->ConOut);\r
  gST->ConOut->EnableCursor (gST->ConOut, TRUE);\r
\r
  //\r
  // initialize EditorFirst and EditorExit\r
  //\r
  EditorFirst       = TRUE;\r
  EditorExit        = FALSE;\r
  EditorMouseAction = FALSE;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  The cleanup function for MainEditor.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_LOAD_ERROR          A load error occurred.\r
**/\r
EFI_STATUS\r
MainEditorCleanup (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // call the five components' cleanup function\r
  // if error, do not exit\r
  // just print some warning\r
  //\r
  MainTitleBarCleanup();\r
  StatusBarCleanup();\r
  InputBarCleanup();\r
  MenuBarCleanup ();\r
\r
  Status = FileBufferCleanup ();\r
  if (EFI_ERROR (Status)) {\r
    ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_EDIT_LIBEDITOR_FILEBUFFER_CLEANUP), gShellDebug1HiiHandle);\r
  }\r
  //\r
  // restore old mode\r
  //\r
  if (OriginalMode != gST->ConOut->Mode->Mode) {\r
    gST->ConOut->SetMode (gST->ConOut, OriginalMode);\r
  }\r
  //\r
  // restore old screen color\r
  //\r
  gST->ConOut->SetAttribute (\r
        gST->ConOut,\r
        EFI_TEXT_ATTR (OriginalColors.Foreground, OriginalColors.Background)\r
        );\r
\r
  gST->ConOut->ClearScreen (gST->ConOut);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Refresh the main editor component.\r
**/\r
VOID\r
MainEditorRefresh (\r
  VOID\r
  )\r
{\r
  //\r
  // The Stall value is from experience. NOT from spec.  avoids 'flicker'\r
  //\r
  gBS->Stall (50);\r
\r
  //\r
  // call the components refresh function\r
  //\r
  if (EditorFirst\r
    || StrCmp (FileBufferBackupVar.FileName, FileBuffer.FileName) != 0\r
    || FileBufferBackupVar.FileType != FileBuffer.FileType\r
    || FileBufferBackupVar.FileModified != FileBuffer.FileModified\r
    || FileBufferBackupVar.ReadOnly != FileBuffer.ReadOnly) {\r
\r
    MainTitleBarRefresh (MainEditor.FileBuffer->FileName, MainEditor.FileBuffer->FileType, MainEditor.FileBuffer->ReadOnly, MainEditor.FileBuffer->FileModified, MainEditor.ScreenSize.Column, MainEditor.ScreenSize.Row, 0, 0);\r
    FileBufferRestorePosition ();\r
  }\r
\r
  if (EditorFirst\r
    || FileBufferBackupVar.FilePosition.Row != FileBuffer.FilePosition.Row\r
    || FileBufferBackupVar.FilePosition.Column != FileBuffer.FilePosition.Column\r
    || FileBufferBackupVar.ModeInsert != FileBuffer.ModeInsert\r
    || StatusBarGetRefresh()) {\r
\r
    StatusBarRefresh (EditorFirst, MainEditor.ScreenSize.Row, MainEditor.ScreenSize.Column, MainEditor.FileBuffer->FilePosition.Row, MainEditor.FileBuffer->FilePosition.Column, MainEditor.FileBuffer->ModeInsert);\r
    FileBufferRestorePosition ();\r
  }\r
\r
  if (EditorFirst) {\r
    FileBufferRestorePosition ();\r
  }\r
\r
  FileBufferRefresh ();\r
\r
  //\r
  // EditorFirst is now set to FALSE\r
  //\r
  EditorFirst = FALSE;\r
}\r
\r
/**\r
  Get's the resultant location of the cursor based on the relative movement of the Mouse.\r
\r
  @param[in] GuidX    The relative mouse movement.\r
\r
  @return The X location of the mouse.\r
**/\r
INT32\r
GetTextX (\r
  IN INT32 GuidX\r
  )\r
{\r
  INT32 Gap;\r
\r
  MainEditor.MouseAccumulatorX += GuidX;\r
  Gap = (MainEditor.MouseAccumulatorX * (INT32) MainEditor.ScreenSize.Column) / (INT32) (50 * (INT32) MainEditor.MouseInterface->Mode->ResolutionX);\r
  MainEditor.MouseAccumulatorX = (MainEditor.MouseAccumulatorX * (INT32) MainEditor.ScreenSize.Column) % (INT32) (50 * (INT32) MainEditor.MouseInterface->Mode->ResolutionX);\r
  MainEditor.MouseAccumulatorX = MainEditor.MouseAccumulatorX / (INT32) MainEditor.ScreenSize.Column;\r
  return Gap;\r
}\r
\r
/**\r
  Get's the resultant location of the cursor based on the relative movement of the Mouse.\r
\r
  @param[in] GuidY    The relative mouse movement.\r
\r
  @return The Y location of the mouse.\r
**/\r
INT32\r
GetTextY (\r
  IN INT32 GuidY\r
  )\r
{\r
  INT32 Gap;\r
\r
  MainEditor.MouseAccumulatorY += GuidY;\r
  Gap = (MainEditor.MouseAccumulatorY * (INT32) MainEditor.ScreenSize.Row) / (INT32) (50 * (INT32) MainEditor.MouseInterface->Mode->ResolutionY);\r
  MainEditor.MouseAccumulatorY = (MainEditor.MouseAccumulatorY * (INT32) MainEditor.ScreenSize.Row) % (INT32) (50 * (INT32) MainEditor.MouseInterface->Mode->ResolutionY);\r
  MainEditor.MouseAccumulatorY = MainEditor.MouseAccumulatorY / (INT32) MainEditor.ScreenSize.Row;\r
\r
  return Gap;\r
}\r
\r
/**\r
  Support mouse movement.  Move the cursor.\r
\r
  @param[in] MouseState     The current mouse state.\r
\r
  @retval EFI_SUCCESS       The operation was successful.\r
  @retval EFI_NOT_FOUND     There was no mouse support found.\r
**/\r
EFI_STATUS\r
MainEditorHandleMouseInput (\r
  IN EFI_SIMPLE_POINTER_STATE       MouseState\r
  )\r
{\r
\r
  INT32           TextX;\r
  INT32           TextY;\r
  UINTN           FRow;\r
  UINTN           FCol;\r
\r
  LIST_ENTRY  *Link;\r
  EFI_EDITOR_LINE *Line;\r
\r
  UINTN           Index;\r
  BOOLEAN         Action;\r
\r
  //\r
  // mouse action means:\r
  //    mouse movement\r
  //    mouse left button\r
  //\r
  Action = FALSE;\r
\r
  //\r
  // have mouse movement\r
  //\r
  if (MouseState.RelativeMovementX || MouseState.RelativeMovementY) {\r
    //\r
    // handle\r
    //\r
    TextX = GetTextX (MouseState.RelativeMovementX);\r
    TextY = GetTextY (MouseState.RelativeMovementY);\r
\r
    FileBufferAdjustMousePosition (TextX, TextY);\r
\r
    Action = TRUE;\r
\r
  }\r
\r
  //\r
  // if left button pushed down\r
  //\r
  if (MouseState.LeftButton) {\r
\r
    FCol = MainEditor.FileBuffer->MousePosition.Column - 1 + 1;\r
\r
    FRow = MainEditor.FileBuffer->FilePosition.Row +\r
      MainEditor.FileBuffer->MousePosition.Row -\r
      MainEditor.FileBuffer->DisplayPosition.Row;\r
\r
    //\r
    // beyond the file line length\r
    //\r
    if (MainEditor.FileBuffer->NumLines < FRow) {\r
      FRow = MainEditor.FileBuffer->NumLines;\r
    }\r
\r
    Link = MainEditor.FileBuffer->ListHead->ForwardLink;\r
    for (Index = 0; Index < FRow - 1; Index++) {\r
      Link = Link->ForwardLink;\r
    }\r
\r
    Line = CR (Link, EFI_EDITOR_LINE, Link, LINE_LIST_SIGNATURE);\r
\r
    //\r
    // beyond the line's column length\r
    //\r
    if (FCol > Line->Size + 1) {\r
      FCol = Line->Size + 1;\r
    }\r
\r
    FileBufferMovePosition (FRow, FCol);\r
\r
    MainEditor.FileBuffer->MousePosition.Row    = MainEditor.FileBuffer->DisplayPosition.Row;\r
\r
    MainEditor.FileBuffer->MousePosition.Column = MainEditor.FileBuffer->DisplayPosition.Column;\r
\r
    Action = TRUE;\r
  }\r
  //\r
  // mouse has action\r
  //\r
  if (Action) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // no mouse action\r
  //\r
  return EFI_NOT_FOUND;\r
}\r
\r
/**\r
  Handle user key input. This routes to other functions for the actions.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_LOAD_ERROR          A load error occurred.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
**/\r
EFI_STATUS\r
MainEditorKeyInput (\r
  VOID\r
  )\r
{\r
  EFI_KEY_DATA              KeyData;\r
  EFI_STATUS                Status;\r
  EFI_SIMPLE_POINTER_STATE  MouseState;\r
  BOOLEAN                   NoShiftState;\r
\r
  do {\r
\r
    Status            = EFI_SUCCESS;\r
    EditorMouseAction = FALSE;\r
\r
    //\r
    // backup some key elements, so that can aVOID some refresh work\r
    //\r
    MainEditorBackup ();\r
\r
    //\r
    // change priority of checking mouse/keyboard activity dynamically\r
    // so prevent starvation of keyboard.\r
    // if last time, mouse moves then this time check keyboard\r
    //\r
    if (MainEditor.MouseSupported) {\r
      Status = MainEditor.MouseInterface->GetState (\r
                                            MainEditor.MouseInterface,\r
                                            &MouseState\r
                                            );\r
      if (!EFI_ERROR (Status)) {\r
\r
        Status = MainEditorHandleMouseInput (MouseState);\r
\r
        if (!EFI_ERROR (Status)) {\r
          EditorMouseAction           = TRUE;\r
          FileBufferMouseNeedRefresh  = TRUE;\r
        } else if (Status == EFI_LOAD_ERROR) {\r
          StatusBarSetStatusString (L"Invalid Mouse Movement ");\r
        }\r
      }\r
    }\r
\r
    //\r
    // CheckEvent() returns Success when non-partial key is pressed.\r
    //\r
    Status = gBS->CheckEvent (MainEditor.TextInputEx->WaitForKeyEx);\r
    if (!EFI_ERROR (Status)) {\r
      Status = MainEditor.TextInputEx->ReadKeyStrokeEx (MainEditor.TextInputEx, &KeyData);\r
      if (!EFI_ERROR (Status)) {\r
        //\r
        // dispatch to different components' key handling function\r
        // so not everywhere has to set this variable\r
        //\r
        FileBufferMouseNeedRefresh = TRUE;\r
        //\r
        // clear previous status string\r
        //\r
        StatusBarSetRefresh();\r
        //\r
        // NoShiftState: TRUE when no shift key is pressed.\r
        //\r
        NoShiftState = ((KeyData.KeyState.KeyShiftState & EFI_SHIFT_STATE_VALID) == 0) || (KeyData.KeyState.KeyShiftState == EFI_SHIFT_STATE_VALID);\r
        //\r
        // dispatch to different components' key handling function\r
        //\r
        if (EFI_NOT_FOUND != MenuBarDispatchControlHotKey(&KeyData)) {\r
          Status = EFI_SUCCESS;\r
        } else if (NoShiftState && ((KeyData.Key.ScanCode == SCAN_NULL) || ((KeyData.Key.ScanCode >= SCAN_UP) && (KeyData.Key.ScanCode <= SCAN_PAGE_DOWN)))) {\r
          Status = FileBufferHandleInput (&KeyData.Key);\r
        } else if (NoShiftState && (KeyData.Key.ScanCode >= SCAN_F1) && (KeyData.Key.ScanCode <= SCAN_F12)) {\r
          Status = MenuBarDispatchFunctionKey (&KeyData.Key);\r
        } else {\r
          StatusBarSetStatusString (L"Unknown Command");\r
          FileBufferMouseNeedRefresh = FALSE;\r
        }\r
\r
        if (Status != EFI_SUCCESS && Status != EFI_OUT_OF_RESOURCES) {\r
          //\r
          // not already has some error status\r
          //\r
          if (StatusBarGetString() != NULL && StrCmp (L"", StatusBarGetString()) == 0) {\r
            StatusBarSetStatusString (L"Disk Error. Try Again");\r
          }\r
        }\r
\r
      }\r
    }\r
    //\r
    // after handling, refresh editor\r
    //\r
    MainEditorRefresh ();\r
\r
  } while (Status != EFI_OUT_OF_RESOURCES && !EditorExit);\r
\r
  return Status;\r
}\r
\r
/**\r
  Set clipboard\r
\r
  @param[in] Line   A pointer to the line to be set to clipboard\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r
**/\r
EFI_STATUS\r
MainEditorSetCutLine (\r
  EFI_EDITOR_LINE *Line\r
  )\r
{\r
  if (Line == NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  if (MainEditor.CutLine != NULL) {\r
    //\r
    // free the old clipboard\r
    //\r
    LineFree (MainEditor.CutLine);\r
  }\r
  //\r
  // duplicate the line to clipboard\r
  //\r
  MainEditor.CutLine = LineDup (Line);\r
  if (MainEditor.CutLine == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Backup function for MainEditor\r
\r
  @retval EFI_SUCCESS The operation was successful.\r
**/\r
EFI_STATUS\r
MainEditorBackup (\r
  VOID\r
  )\r
{\r
  FileBufferBackup ();\r
\r
  return EFI_SUCCESS;\r
}\r