ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Misc.h

   1 /** @file
   2     Definitions for various line and string routines
   3
   4   Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef _LIB_MISC_H_
  10 #define _LIB_MISC_H_
  11
  12 #include "HexEditor.h"
  13
  14 /**
  15   Advance/Retreat lines.
  16
  17   @param[in] Count      The line number to advance/retreat.
  18                             >0 : advance
  19                             <0: retreat
  20
  21   @retval NULL An error occurred.
  22   @return A pointer to the line after move.
  23 **/
  24 HEFI_EDITOR_LINE *
  25 HMoveLine (
  26   IN  INTN  Count
  27   );
  28
  29 /**
  30   Advance/Retreat lines and set CurrentLine in BufferImage to it.
  31
  32   @param[in] Count    The line number to advance/retreat.
  33                           >0 : advance
  34                           <0: retreat
  35
  36   @retval NULL An error occurred.
  37   @return A pointer to the line after move.
  38 **/
  39 HEFI_EDITOR_LINE *
  40 HMoveCurrentLine (
  41   IN  INTN  Count
  42   );
  43
  44 /**
  45   Free all the lines in HBufferImage.
  46     Fields affected:
  47     Lines
  48     CurrentLine
  49     NumLines
  50     ListHead
  51
  52   @param[in] ListHead     The list head.
  53   @param[in] Lines        The lines.
  54
  55   @retval EFI_SUCCESS     The operation was successful.
  56 **/
  57 EFI_STATUS
  58 HFreeLines (
  59   IN LIST_ENTRY        *ListHead,
  60   IN HEFI_EDITOR_LINE  *Lines
  61   );
  62
  63 /**
  64   Get the X information for the mouse.
  65
  66   @param[in] GuidX      The change.
  67
  68   @return the new information.
  69 **/
  70 INT32
  71 HGetTextX (
  72   IN INT32  GuidX
  73   );
  74
  75 /**
  76   Get the Y information for the mouse.
  77
  78   @param[in] GuidY      The change.
  79
  80   @return the new information.
  81 **/
  82 INT32
  83 HGetTextY (
  84   IN INT32  GuidY
  85   );
  86
  87 #endif