ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/BufferImage.h

   1 /** @file
   2     Defines BufferImage - the view of the file that is visible at any point,
   3     as well as the event handlers for editing the file
   4
   5   Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved. <BR>
   6   This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _LIB_BUFFER_IMAGE_H_
  17 #define _LIB_BUFFER_IMAGE_H_
  18
  19 #include "HexEditor.h"
  20
  21 EFI_STATUS
  22 HBufferImageInit (
  23   VOID
  24   );
  25 EFI_STATUS
  26 HBufferImageCleanup (
  27   VOID
  28   );
  29 EFI_STATUS
  30 HBufferImageRefresh (
  31   VOID
  32   );
  33 EFI_STATUS
  34 HBufferImageHide (
  35   VOID
  36   );
  37 EFI_STATUS
  38 HBufferImageHandleInput (
  39   EFI_INPUT_KEY *
  40   );
  41 EFI_STATUS
  42 HBufferImageBackup (
  43   VOID
  44   );
  45
  46 EFI_STATUS
  47 HBufferImageRead (
  48   IN CONST CHAR16   *,
  49   IN CONST CHAR16   *,
  50   IN          UINTN,
  51   IN          UINTN,
  52   IN          UINTN,
  53   IN          UINTN,
  54   IN          EDIT_FILE_TYPE,
  55   IN          BOOLEAN
  56   );
  57
  58 EFI_STATUS
  59 HBufferImageSave (
  60   IN CHAR16   *,
  61   IN CHAR16   *,
  62   IN          UINTN,
  63   IN          UINTN,
  64   IN          UINTN,
  65   IN          UINTN,
  66   IN          EDIT_FILE_TYPE
  67   );
  68
  69 INTN
  70 HBufferImageCharToHex (
  71   IN CHAR16
  72   );
  73
  74 EFI_STATUS
  75 HBufferImageRestoreMousePosition (
  76   VOID
  77   );
  78 EFI_STATUS
  79 HBufferImageRestorePosition (
  80   VOID
  81   );
  82
  83 VOID
  84 HBufferImageMovePosition (
  85   IN UINTN,
  86   IN UINTN,
  87   IN BOOLEAN
  88   );
  89
  90 EFI_STATUS
  91 HBufferImageHandleInput (
  92   EFI_INPUT_KEY *
  93   );
  94
  95 HEFI_EDITOR_LINE  *
  96 HBufferImageCreateLine (
  97   VOID
  98   );
  99
 100 EFI_STATUS
 101 HBufferImageDoCharInput (
 102   CHAR16
 103   );
 104 EFI_STATUS
 105 HBufferImageAddChar (
 106   CHAR16
 107   );
 108
 109 BOOLEAN
 110 HInCurrentScreen (
 111   UINTN
 112   );
 113 BOOLEAN
 114 HAboveCurrentScreen (
 115   UINTN
 116   );
 117 BOOLEAN
 118 HUnderCurrentScreen (
 119   UINTN
 120   );
 121
 122 EFI_STATUS
 123 HBufferImageScrollRight (
 124   VOID
 125   );
 126 EFI_STATUS
 127 HBufferImageScrollLeft (
 128   VOID
 129   );
 130 EFI_STATUS
 131 HBufferImageScrollDown (
 132   VOID
 133   );
 134 EFI_STATUS
 135 HBufferImageScrollUp (
 136   VOID
 137   );
 138 EFI_STATUS
 139 HBufferImagePageUp (
 140   VOID
 141   );
 142 EFI_STATUS
 143 HBufferImagePageDown (
 144   VOID
 145   );
 146 EFI_STATUS
 147 HBufferImageHome (
 148   VOID
 149   );
 150 EFI_STATUS
 151 HBufferImageEnd (
 152   VOID
 153   );
 154
 155 EFI_STATUS
 156 HBufferImageDoBackspace (
 157   VOID
 158   );
 159 EFI_STATUS
 160 HBufferImageDoDelete (
 161   VOID
 162   );
 163
 164 EFI_STATUS
 165 HBufferImageCutLine (
 166   HEFI_EDITOR_LINE **
 167   );
 168 EFI_STATUS
 169 HBufferImagePasteLine (
 170   VOID
 171   );
 172
 173 EFI_STATUS
 174 HBufferImageGetFileInfo (
 175   EFI_FILE_HANDLE,
 176   CHAR16          *,
 177   EFI_FILE_INFO   **
 178   );
 179
 180 EFI_STATUS
 181 HBufferImageSearch (
 182   CHAR16  *,
 183   UINTN
 184   );
 185 EFI_STATUS
 186 HBufferImageReplace (
 187   CHAR16  *,
 188   UINTN
 189   );
 190
 191 /**
 192   Free the current image.
 193
 194   @retval EFI_SUCCESS   The operation was successful.
 195 **/
 196 EFI_STATUS
 197 HBufferImageFree (
 198   VOID
 199   );
 200
 201 EFI_STATUS
 202 HBufferImageDeleteCharacterFromBuffer (
 203   IN      UINTN,
 204   IN      UINTN,
 205   UINT8   *
 206   );
 207
 208 EFI_STATUS
 209 HBufferImageAddCharacterToBuffer (
 210   IN      UINTN,
 211   IN      UINTN,
 212   UINT8   *
 213   );
 214
 215 EFI_STATUS
 216 HBufferImageBufferToList (
 217   IN VOID   *,
 218   IN        UINTN
 219   );
 220
 221 EFI_STATUS
 222 HBufferImageListToBuffer (
 223   IN VOID   *,
 224   IN        UINTN
 225   );
 226
 227 VOID
 228 HBufferImageAdjustMousePosition (
 229   INT32,
 230   INT32
 231   );
 232
 233 BOOLEAN
 234 HBufferImageIsAtHighBits (
 235   UINTN,
 236   UINTN *
 237   ) ;
 238
 239 EFI_STATUS
 240 HBufferImageCutLine (
 241   HEFI_EDITOR_LINE **
 242   );
 243
 244 UINTN
 245 HBufferImageGetTotalSize (
 246   VOID
 247   );
 248
 249 BOOLEAN
 250 HBufferImageIsInSelectedArea (
 251   UINTN,
 252   UINTN
 253   );
 254
 255 #endif