ShellPkg: Series of patches to fix typos - apropriate to appropriate

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

/** @file\r
  Declares editor types.\r
\r
  Copyright (c) 2005 - 2016, 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 _EDITOR_TYPE_H_\r
#define _EDITOR_TYPE_H_\r
\r
#include "UefiShellDebug1CommandsLib.h"\r
#include "EditTitleBar.h"\r
#include "EditMenuBar.h"\r
\r
#define MIN_POOL_SIZE                 125\r
#define MAX_STRING_LENGTH             127\r
#define SHELL_EDIT_MAX_LINE_SIZE      0x50\r
\r
typedef struct {\r
  UINTN Row;\r
  UINTN Column;\r
} EFI_EDITOR_POSITION;\r
\r
typedef\r
EFI_STATUS\r
(*EFI_MENU_ITEM_FUNCTION) (\r
  VOID\r
  );\r
\r
typedef enum {\r
  NewLineTypeDefault,\r
  NewLineTypeLineFeed,\r
  NewLineTypeCarriageReturn,\r
  NewLineTypeCarriageReturnLineFeed,\r
  NewLineTypeLineFeedCarriageReturn,\r
  NewLineTypeUnknown\r
} EE_NEWLINE_TYPE;\r
\r
#define LINE_LIST_SIGNATURE  SIGNATURE_32 ('e', 'e', 'l', 'l')\r
typedef struct _EFI_EDITOR_LINE {\r
  UINTN           Signature;\r
  CHAR16          *Buffer;\r
  UINTN           Size;                   // unit is Unicode\r
  UINTN           TotalSize;              // unit is Unicode, exclude CHAR_NULL\r
  EE_NEWLINE_TYPE Type;\r
  LIST_ENTRY      Link;\r
} EFI_EDITOR_LINE;\r
\r
typedef struct {\r
  UINT32  Foreground : 4;\r
  UINT32  Background : 4;\r
} EFI_EDITOR_COLOR_ATTRIBUTES;\r
\r
typedef union {\r
  EFI_EDITOR_COLOR_ATTRIBUTES Colors;\r
  UINTN                       Data;\r
} EFI_EDITOR_COLOR_UNION;\r
\r
typedef struct {\r
  UINTN Columns;\r
  UINTN Rows;\r
} EFI_EDITOR_TEXT_MODE;\r
\r
typedef struct {\r
  CHAR16                *FileName;        // file name current edited in editor\r
  EDIT_FILE_TYPE        FileType;         // Unicode file or ASCII file\r
  LIST_ENTRY            *ListHead;        // list head of lines\r
  EFI_EDITOR_LINE       *Lines;           // lines of current file\r
  UINTN                 NumLines;         // total line numbers\r
  EFI_EDITOR_POSITION   DisplayPosition;  // cursor position in screen\r
  EFI_EDITOR_POSITION   FilePosition;     // cursor position in file\r
  EFI_EDITOR_POSITION   MousePosition;    // mouse position in screen\r
  // file position of first byte displayed on screen\r
  //\r
  EFI_EDITOR_POSITION   LowVisibleRange;\r
\r
  BOOLEAN               FileModified;     // file is modified or not\r
  BOOLEAN               ModeInsert;       // input mode INS or OVR\r
  BOOLEAN               ReadOnly;         // file is read-only or not\r
  EFI_EDITOR_LINE       *CurrentLine;     // current line cursor is at\r
} EFI_EDITOR_FILE_BUFFER;\r
\r
typedef struct {\r
  EFI_EDITOR_FILE_BUFFER      *FileBuffer;\r
\r
  EFI_EDITOR_COLOR_UNION      ColorAttributes;\r
  EFI_EDITOR_POSITION         ScreenSize; // row number and column number\r
  EFI_EDITOR_LINE             *CutLine;   // clip board\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
} EFI_EDITOR_GLOBAL_EDITOR;\r
\r
#endif\r