ShellPkg: Apply uncrustify changes

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / HexEdit / FileImage.c

/** @file\r
  Functions to deal with file buffer.\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 "HexEditor.h"\r
\r
extern EFI_HANDLE                HImageHandleBackup;\r
extern HEFI_EDITOR_BUFFER_IMAGE  HBufferImage;\r
\r
extern BOOLEAN  HBufferImageNeedRefresh;\r
extern BOOLEAN  HBufferImageOnlyLineNeedRefresh;\r
extern BOOLEAN  HBufferImageMouseNeedRefresh;\r
\r
extern HEFI_EDITOR_GLOBAL_EDITOR  HMainEditor;\r
\r
HEFI_EDITOR_FILE_IMAGE  HFileImage;\r
HEFI_EDITOR_FILE_IMAGE  HFileImageBackupVar;\r
\r
//\r
// for basic initialization of HFileImage\r
//\r
HEFI_EDITOR_BUFFER_IMAGE  HFileImageConst = {\r
  NULL,\r
  0,\r
  FALSE\r
};\r
\r
/**\r
  Initialization function for HFileImage\r
\r
  @retval EFI_SUCCESS     The operation was successful.\r
**/\r
EFI_STATUS\r
HFileImageInit (\r
  VOID\r
  )\r
{\r
  //\r
  // basically initialize the HFileImage\r
  //\r
  CopyMem (&HFileImage, &HFileImageConst, sizeof (HFileImage));\r
\r
  CopyMem (\r
    &HFileImageBackupVar,\r
    &HFileImageConst,\r
    sizeof (HFileImageBackupVar)\r
    );\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Backup function for HFileImage. Only a few fields need to be backup.\r
  This is for making the file buffer refresh as few as possible.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
**/\r
EFI_STATUS\r
HFileImageBackup (\r
  VOID\r
  )\r
{\r
  SHELL_FREE_NON_NULL (HFileImageBackupVar.FileName);\r
  HFileImageBackupVar.FileName = CatSPrint (NULL, L"%s", HFileImage.FileName);\r
  if (HFileImageBackupVar.FileName == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Cleanup function for HFileImage.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
**/\r
EFI_STATUS\r
HFileImageCleanup (\r
  VOID\r
  )\r
{\r
  SHELL_FREE_NON_NULL (HFileImage.FileName);\r
  SHELL_FREE_NON_NULL (HFileImageBackupVar.FileName);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Set FileName field in HFileImage\r
\r
  @param[in] Str  File name to set.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
**/\r
EFI_STATUS\r
HFileImageSetFileName (\r
  IN CONST CHAR16  *Str\r
  )\r
{\r
  if (Str == HFileImage.FileName) {\r
    //\r
    // This function might be called using HFileImage.FileName as Str.\r
    // Directly return without updating HFileImage.FileName.\r
    //\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // free the old file name\r
  //\r
  SHELL_FREE_NON_NULL (HFileImage.FileName);\r
  HFileImage.FileName = AllocateCopyPool (StrSize (Str), Str);\r
  if (HFileImage.FileName == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Read a file from disk into HBufferImage.\r
\r
  @param[in] FileName     filename to read.\r
  @param[in] Recover      if is for recover, no information print.\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
HFileImageRead (\r
  IN CONST CHAR16  *FileName,\r
  IN BOOLEAN       Recover\r
  )\r
{\r
  HEFI_EDITOR_LINE  *Line;\r
  UINT8             *Buffer;\r
  CHAR16            *UnicodeBuffer;\r
  EFI_STATUS        Status;\r
\r
  //\r
  // variable initialization\r
  //\r
  Line = NULL;\r
\r
  //\r
  // in this function, when you return error ( except EFI_OUT_OF_RESOURCES )\r
  // you should set status string\r
  // since this function maybe called before the editorhandleinput loop\r
  // so any error will cause editor return\r
  // so if you want to print the error status\r
  // you should set the status string\r
  //\r
  Status = ReadFileIntoBuffer (FileName, (VOID **)&Buffer, &HFileImage.Size, &HFileImage.ReadOnly);\r
  //\r
  // NULL pointer is only also a failure for a non-zero file size.\r
  //\r
  if ((EFI_ERROR (Status)) || ((Buffer == NULL) && (HFileImage.Size != 0))) {\r
    UnicodeBuffer = CatSPrint (NULL, L"Read error on file %s: %r", FileName, Status);\r
    if (UnicodeBuffer == NULL) {\r
      SHELL_FREE_NON_NULL (Buffer);\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    StatusBarSetStatusString (UnicodeBuffer);\r
    FreePool (UnicodeBuffer);\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  HFileImageSetFileName (FileName);\r
\r
  //\r
  // free the old lines\r
  //\r
  HBufferImageFree ();\r
\r
  Status = HBufferImageBufferToList (Buffer, HFileImage.Size);\r
  SHELL_FREE_NON_NULL (Buffer);\r
  if (EFI_ERROR (Status)) {\r
    StatusBarSetStatusString (L"Error parsing file.");\r
    return Status;\r
  }\r
\r
  HBufferImage.DisplayPosition.Row    = 2;\r
  HBufferImage.DisplayPosition.Column = 10;\r
  HBufferImage.MousePosition.Row      = 2;\r
  HBufferImage.MousePosition.Column   = 10;\r
  HBufferImage.LowVisibleRow          = 1;\r
  HBufferImage.HighBits               = TRUE;\r
  HBufferImage.BufferPosition.Row     = 1;\r
  HBufferImage.BufferPosition.Column  = 1;\r
  HBufferImage.BufferType             = FileTypeFileBuffer;\r
\r
  if (!Recover) {\r
    UnicodeBuffer = CatSPrint (NULL, L"%d Lines Read", HBufferImage.NumLines);\r
    if (UnicodeBuffer == NULL) {\r
      SHELL_FREE_NON_NULL (Buffer);\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    StatusBarSetStatusString (UnicodeBuffer);\r
    FreePool (UnicodeBuffer);\r
\r
    HMainEditor.SelectStart = 0;\r
    HMainEditor.SelectEnd   = 0;\r
  }\r
\r
  //\r
  // has line\r
  //\r
  if (HBufferImage.Lines != 0) {\r
    HBufferImage.CurrentLine = CR (HBufferImage.ListHead->ForwardLink, HEFI_EDITOR_LINE, Link, EFI_EDITOR_LINE_LIST);\r
  } else {\r
    //\r
    // create a dummy line\r
    //\r
    Line = HBufferImageCreateLine ();\r
    if (Line == NULL) {\r
      SHELL_FREE_NON_NULL (Buffer);\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    HBufferImage.CurrentLine = Line;\r
  }\r
\r
  HBufferImage.Modified           = FALSE;\r
  HBufferImageNeedRefresh         = TRUE;\r
  HBufferImageOnlyLineNeedRefresh = FALSE;\r
  HBufferImageMouseNeedRefresh    = TRUE;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Save lines in HBufferImage to disk.\r
\r
  @param[in] FileName     The file name.\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
HFileImageSave (\r
  IN CHAR16  *FileName\r
  )\r
{\r
  LIST_ENTRY         *Link;\r
  HEFI_EDITOR_LINE   *Line;\r
  CHAR16             *Str;\r
  EFI_STATUS         Status;\r
  UINTN              NumLines;\r
  SHELL_FILE_HANDLE  FileHandle;\r
  UINTN              TotalSize;\r
  UINT8              *Buffer;\r
  UINT8              *Ptr;\r
  EDIT_FILE_TYPE     BufferTypeBackup;\r
\r
  BufferTypeBackup        = HBufferImage.BufferType;\r
  HBufferImage.BufferType = FileTypeFileBuffer;\r
\r
  //\r
  // if is the old file\r
  //\r
  if ((HFileImage.FileName != NULL) && (FileName != NULL) && (StrCmp (FileName, HFileImage.FileName) == 0)) {\r
    //\r
    // check whether file exists on disk\r
    //\r
    if (ShellIsFile (FileName) == EFI_SUCCESS) {\r
      //\r
      // current file exists on disk\r
      // so if not modified, then not save\r
      //\r
      if (HBufferImage.Modified == FALSE) {\r
        return EFI_SUCCESS;\r
      }\r
\r
      //\r
      // if file is read-only, set error\r
      //\r
      if (HFileImage.ReadOnly == TRUE) {\r
        StatusBarSetStatusString (L"Read Only File Can Not Be Saved");\r
        return EFI_SUCCESS;\r
      }\r
    }\r
  }\r
\r
  if (ShellIsDirectory (FileName) == EFI_SUCCESS) {\r
    StatusBarSetStatusString (L"Directory Can Not Be Saved");\r
    return EFI_LOAD_ERROR;\r
  }\r
\r
  Status = ShellOpenFileByName (FileName, &FileHandle, EFI_FILE_MODE_READ|EFI_FILE_MODE_WRITE, 0);\r
\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // the file exits, delete it\r
    //\r
    Status = ShellDeleteFile (&FileHandle);\r
    if (EFI_ERROR (Status) || (Status == EFI_WARN_DELETE_FAILURE)) {\r
      StatusBarSetStatusString (L"Write File Failed");\r
      return EFI_LOAD_ERROR;\r
    }\r
  }\r
\r
  //\r
  // write all the lines back to disk\r
  //\r
  NumLines  = 0;\r
  TotalSize = 0;\r
  for (Link = HBufferImage.ListHead->ForwardLink; Link != HBufferImage.ListHead; Link = Link->ForwardLink) {\r
    Line = CR (Link, HEFI_EDITOR_LINE, Link, EFI_EDITOR_LINE_LIST);\r
\r
    if (Line->Size != 0) {\r
      TotalSize += Line->Size;\r
    }\r
\r
    //\r
    // end of if Line -> Size != 0\r
    //\r
    NumLines++;\r
  }\r
\r
  //\r
  // end of for Link\r
  //\r
  Buffer = AllocateZeroPool (TotalSize);\r
  if (Buffer == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Ptr = Buffer;\r
  for (Link = HBufferImage.ListHead->ForwardLink; Link != HBufferImage.ListHead; Link = Link->ForwardLink) {\r
    Line = CR (Link, HEFI_EDITOR_LINE, Link, EFI_EDITOR_LINE_LIST);\r
\r
    if (Line->Size != 0) {\r
      CopyMem (Ptr, Line->Buffer, Line->Size);\r
      Ptr += Line->Size;\r
    }\r
\r
    //\r
    // end of if Line -> Size != 0\r
    //\r
  }\r
\r
  Status = ShellOpenFileByName (FileName, &FileHandle, EFI_FILE_MODE_READ|EFI_FILE_MODE_WRITE|EFI_FILE_MODE_CREATE, 0);\r
\r
  if (EFI_ERROR (Status)) {\r
    StatusBarSetStatusString (L"Create File Failed");\r
    return EFI_LOAD_ERROR;\r
  }\r
\r
  Status = ShellWriteFile (FileHandle, &TotalSize, Buffer);\r
  FreePool (Buffer);\r
  if (EFI_ERROR (Status)) {\r
    ShellDeleteFile (&FileHandle);\r
    return EFI_LOAD_ERROR;\r
  }\r
\r
  ShellCloseFile (&FileHandle);\r
\r
  HBufferImage.Modified = FALSE;\r
\r
  //\r
  // set status string\r
  //\r
  Str = CatSPrint (NULL, L"%d Lines Written", NumLines);\r
  StatusBarSetStatusString (Str);\r
  FreePool (Str);\r
\r
  //\r
  // now everything is ready , you can set the new file name to filebuffer\r
  //\r
  if (((BufferTypeBackup != FileTypeFileBuffer) && (FileName != NULL)) ||\r
      ((FileName != NULL) && (HFileImage.FileName != NULL) && (StringNoCaseCompare (&FileName, &HFileImage.FileName) != 0)))\r
  {\r
    //\r
    // not the same\r
    //\r
    HFileImageSetFileName (FileName);\r
    if (HFileImage.FileName == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
  }\r
\r
  HFileImage.ReadOnly = FALSE;\r
\r
  return EFI_SUCCESS;\r
}\r