ShellPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / Edit / FileBuffer.h

/** @file\r
  Declares filebuffer 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
#ifndef _LIB_FILE_BUFFER_H_\r
#define _LIB_FILE_BUFFER_H_\r
\r
#include "TextEditorTypes.h"\r
\r
/**\r
  Initialization function for FileBuffer.\r
\r
  @param EFI_SUCCESS            The initialization was successful.\r
  @param EFI_LOAD_ERROR         A default name could not be created.\r
  @param EFI_OUT_OF_RESOURCES   A memory allocation failed.\r
**/\r
EFI_STATUS\r
FileBufferInit (\r
  VOID\r
  );\r
\r
/**\r
  Cleanup function for FileBuffer.\r
\r
  @retval EFI_SUCCESS   The cleanup was successful.\r
**/\r
EFI_STATUS\r
FileBufferCleanup (\r
  VOID\r
  );\r
\r
/**\r
  Refresh the screen with whats in the buffer.\r
\r
  @retval EFI_SUCCESS     The refresh was successful.\r
  @retval EFI_LOAD_ERROR  There was an error finding what to write.\r
**/\r
EFI_STATUS\r
FileBufferRefresh (\r
  VOID\r
  );\r
\r
/**\r
  Dispatch input to different handler\r
  @param[in] Key                The input key.  One of:\r
                                    ASCII KEY\r
                                    Backspace/Delete\r
                                    Return\r
                                    Direction key: up/down/left/right/pgup/pgdn\r
                                    Home/End\r
                                    INS\r
\r
  @retval EFI_SUCCESS           The dispatch was done successfully.\r
  @retval EFI_LOAD_ERROR        The dispatch was not successful.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
**/\r
EFI_STATUS\r
FileBufferHandleInput (\r
  IN CONST EFI_INPUT_KEY * Key\r
  );\r
\r
/**\r
  Backup function for FileBuffer.  Only backup the following items:\r
      Mouse/Cursor position\r
      File Name, Type, ReadOnly, Modified\r
      Insert Mode\r
\r
  This is for making the file buffer refresh as few as possible.\r
\r
  @retval EFI_SUCCESS           The backup operation was successful.\r
**/\r
EFI_STATUS\r
FileBufferBackup (\r
  VOID\r
  );\r
\r
/**\r
  Set the cursor position according to FileBuffer.DisplayPosition.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
**/\r
EFI_STATUS\r
FileBufferRestorePosition (\r
  VOID\r
  );\r
\r
/**\r
  Set FileName field in FileBuffer.\r
\r
  @param Str                    The file name to set.\r
\r
  @retval EFI_SUCCESS           The filename was successfully set.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
  @retval EFI_INVALID_PARAMETER Str is not a valid filename.\r
**/\r
EFI_STATUS\r
FileBufferSetFileName (\r
  IN CONST CHAR16 *Str\r
  );\r
\r
/**\r
  Read a file from disk into the FileBuffer.\r
\r
  @param[in] FileName           The filename to read.\r
  @param[in] Recover            TRUE if is for recover mode, no information printouts.\r
\r
  @retval EFI_SUCCESS            The load was successful.\r
  @retval EFI_LOAD_ERROR         The load failed.\r
  @retval EFI_OUT_OF_RESOURCES   A memory allocation failed.\r
  @retval EFI_INVALID_PARAMETER  FileName is a directory.\r
**/\r
EFI_STATUS\r
FileBufferRead (\r
  IN CONST CHAR16  *FileName,\r
  IN CONST BOOLEAN Recover\r
  );\r
\r
/**\r
  Save lines in FileBuffer to disk\r
\r
  @param[in] FileName           The file name for writing.\r
\r
  @retval EFI_SUCCESS           Data was written.\r
  @retval EFI_LOAD_ERROR\r
  @retval EFI_OUT_OF_RESOURCES  There were not enough resources to write the file.\r
**/\r
EFI_STATUS\r
FileBufferSave (\r
  CONST CHAR16 *FileName\r
  );\r
\r
/**\r
  According to cursor's file position, adjust screen display\r
\r
  @param[in] NewFilePosRow    The row of file position ( start from 1 ).\r
  @param[in] NewFilePosCol    The column of file position ( start from 1 ).\r
**/\r
VOID\r
FileBufferMovePosition (\r
  IN CONST UINTN NewFilePosRow,\r
  IN CONST UINTN NewFilePosCol\r
  );\r
\r
/**\r
  Cut current line out and return a pointer to it.\r
\r
  @param[out] CutLine    Upon a successful return pointer to the pointer to\r
                        the allocated cut line.\r
\r
  @retval EFI_SUCCESS             The cut was successful.\r
  @retval EFI_NOT_FOUND           There was no selection to cut.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
**/\r
EFI_STATUS\r
FileBufferCutLine (\r
  OUT EFI_EDITOR_LINE **CutLine\r
  );\r
\r
/**\r
  Paste a line into line list.\r
\r
  @retval EFI_SUCCESS             The paste was successful.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
**/\r
EFI_STATUS\r
FileBufferPasteLine (\r
  VOID\r
  );\r
\r
/**\r
  Search string from current position on in file\r
\r
  @param[in] Str    The search string.\r
  @param[in] Offset The offset from current position.\r
\r
  @retval EFI_SUCCESS       The operation was successful.\r
  @retval EFI_NOT_FOUND     The string Str was not found.\r
**/\r
EFI_STATUS\r
FileBufferSearch (\r
  IN CONST CHAR16  *Str,\r
  IN CONST UINTN Offset\r
  );\r
\r
/**\r
  Replace SearchLen characters from current position on with Replace.\r
\r
  This will modify the current buffer at the current position.\r
\r
  @param[in] Replace    The string to replace.\r
  @param[in] SearchLen  Search string's length.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
**/\r
EFI_STATUS\r
FileBufferReplace (\r
  IN CONST CHAR16   *Replace,\r
  IN CONST UINTN    SearchLen\r
  );\r
\r
/**\r
  Search and replace operation.\r
\r
  @param[in] SearchStr    The string to search for.\r
  @param[in] ReplaceStr   The string to replace with.\r
  @param[in] Offset       The column to start at.\r
**/\r
EFI_STATUS\r
FileBufferReplaceAll (\r
  IN CHAR16 *SearchStr,\r
  IN CHAR16 *ReplaceStr,\r
  IN UINTN  Offset\r
  );\r
\r
/**\r
  Move the mouse cursor position.\r
\r
  @param[in] TextX      The new x-coordinate.\r
  @param[in] TextY      The new y-coordinate.\r
**/\r
VOID\r
FileBufferAdjustMousePosition (\r
  IN CONST INT32 TextX,\r
  IN CONST INT32 TextY\r
  );\r
\r
/**\r
  Set the modified state to TRUE.\r
**/\r
VOID\r
FileBufferSetModified (\r
  VOID\r
  );\r
\r
#endif\r