add Edit and HexEdit commands.

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / HexEdit / HexEditorTypes.h

/** @file\r
  data types that are used by editor\r
  \r
  Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved. <BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _HEDITOR_TYPE_H_\r
#define _HEDITOR_TYPE_H_\r
\r
#include "UefiShellDebug1CommandsLib.h"\r
#include "EditTitleBar.h"\r
\r
#define EFI_EDITOR_LINE_LIST  'eell'\r
\r
#define ASCII_POSITION        ((0x10 * 3) + 12)\r
\r
\r
typedef struct {\r
  UINTN Row;\r
  UINTN Column;\r
} HEFI_EDITOR_POSITION;\r
\r
typedef\r
EFI_STATUS\r
(*HEFI_MENU_ITEM_FUNCTION) (\r
  VOID\r
  );\r
\r
typedef struct {\r
  CHAR16                  Name[50];\r
  CHAR16                  Key[3];\r
  HEFI_MENU_ITEM_FUNCTION Function;\r
} HMENU_ITEMS;\r
\r
typedef struct _HEFI_EDITOR_LINE {\r
  UINTN           Signature;\r
  UINT8           Buffer[0x10];\r
  UINTN           Size;                             // unit is Unicode\r
  LIST_ENTRY  Link;\r
} HEFI_EDITOR_LINE;\r
\r
typedef struct _HEFI_EDITOR_MENU_ITEM {\r
  CHAR16                  NameToken;\r
  CHAR16                  FunctionKeyToken;\r
  HEFI_MENU_ITEM_FUNCTION Function;\r
} HEFI_EDITOR_MENU_ITEM;\r
\r
typedef struct {\r
  UINT32  Foreground : 4;\r
  UINT32  Background : 4;\r
} HEFI_EDITOR_COLOR_ATTRIBUTES;\r
\r
typedef union {\r
  HEFI_EDITOR_COLOR_ATTRIBUTES  Colors;\r
  UINT8                         Data;\r
} HEFI_EDITOR_COLOR_UNION;\r
\r
typedef struct {\r
  UINTN Columns;\r
  UINTN Rows;\r
} HEFI_EDITOR_TEXT_MODE;\r
\r
\r
typedef struct {\r
  CHAR16  *Name;\r
\r
  UINTN   BlockSize;\r
  UINTN   Size;\r
  UINTN   Offset;\r
} HEFI_EDITOR_DISK_IMAGE;\r
\r
typedef struct {\r
  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *IoFncs;\r
\r
  UINTN                           Offset;\r
  UINTN                           Size;\r
} HEFI_EDITOR_MEM_IMAGE;\r
\r
typedef struct {\r
  CHAR16  *FileName;\r
  UINTN   Size;                                     // file size\r
  BOOLEAN ReadOnly;                                 // file is read-only or not\r
} HEFI_EDITOR_FILE_IMAGE;\r
\r
typedef struct {\r
  LIST_ENTRY                      *ListHead;        // list head of lines\r
  HEFI_EDITOR_LINE                *Lines;           // lines of current file\r
  UINTN                           NumLines;         // number of lines\r
  HEFI_EDITOR_LINE                *CurrentLine;     // current line cursor is at\r
  HEFI_EDITOR_POSITION            DisplayPosition;  // cursor position in screen\r
  HEFI_EDITOR_POSITION            MousePosition;    // mouse position in screen\r
  HEFI_EDITOR_POSITION            BufferPosition;   // cursor position in buffer\r
  UINTN                           LowVisibleRow;    // the lowest visible row of file position\r
  BOOLEAN                         HighBits;         // cursor is at the high4 bits or low4 bits\r
  BOOLEAN                         Modified;         // BUFFER is modified or not\r
  EDIT_FILE_TYPE                  BufferType;\r
\r
  HEFI_EDITOR_FILE_IMAGE          *FileImage;\r
  HEFI_EDITOR_DISK_IMAGE          *DiskImage;\r
  HEFI_EDITOR_MEM_IMAGE           *MemImage;\r
\r
} HEFI_EDITOR_BUFFER_IMAGE;\r
\r
typedef struct {\r
  UINT8 *Buffer;\r
  UINTN Size;\r
} HEFI_EDITOR_CLIPBOARD;\r
\r
typedef struct {\r
  HEFI_EDITOR_BUFFER_IMAGE    *BufferImage;\r
  HEFI_EDITOR_CLIPBOARD       *Clipboard;\r
\r
  HEFI_EDITOR_COLOR_UNION     ColorAttributes;\r
  HEFI_EDITOR_POSITION        ScreenSize;           // row number and column number\r
  BOOLEAN                     MouseSupported;\r
  EFI_SIMPLE_POINTER_PROTOCOL *MouseInterface;\r
  INT32                       MouseAccumulatorX;\r
  INT32                       MouseAccumulatorY;\r
\r
  UINTN                       SelectStart;          // starting from 1\r
  UINTN                       SelectEnd;            // starting from 1\r
} HEFI_EDITOR_GLOBAL_EDITOR;\r
\r
#endif\r