ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Misc.h

   1 /** @file
   2     Definitions for various line and string routines
   3
   4   Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved. <BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _LIB_MISC_H_
  16 #define _LIB_MISC_H_
  17
  18 #include "HexEditor.h"
  19
  20 /**
  21   Advance/Retreat lines.
  22
  23   @param[in] Count      The line number to advance/retreat.
  24                             >0 : advance
  25                             <0: retreat
  26
  27   @retval NULL An error occured.
  28   @return A pointer to the line after move.
  29 **/
  30 HEFI_EDITOR_LINE *
  31 HMoveLine (
  32   IN  INTN Count
  33   );
  34
  35 /**
  36   Advance/Retreat lines and set CurrentLine in BufferImage to it.
  37
  38   @param[in] Count    The line number to advance/retreat.
  39                           >0 : advance
  40                           <0: retreat
  41
  42   @retval NULL An error occured.
  43   @return A pointer to the line after move.
  44 **/
  45 HEFI_EDITOR_LINE *
  46 HMoveCurrentLine (
  47   IN  INTN Count
  48   );
  49
  50 /**
  51   Free all the lines in HBufferImage.
  52     Fields affected:
  53     Lines
  54     CurrentLine
  55     NumLines
  56     ListHead
  57
  58   @param[in] ListHead     The list head.
  59   @param[in] Lines        The lines.
  60
  61   @retval EFI_SUCCESS     The operation was successful.
  62 **/
  63 EFI_STATUS
  64 HFreeLines (
  65   IN LIST_ENTRY   *ListHead,
  66   IN HEFI_EDITOR_LINE *Lines
  67   );
  68
  69 /**
  70   Get the X information for the mouse.
  71
  72   @param[in] GuidX      The change.
  73
  74   @return the new information.
  75 **/
  76 INT32
  77 HGetTextX (
  78   IN INT32 GuidX
  79   );
  80
  81 /**
  82   Get the Y information for the mouse.
  83
  84   @param[in] GuidY      The change.
  85
  86   @return the new information.
  87 **/
  88 INT32
  89 HGetTextY (
  90   IN INT32 GuidY
  91   );
  92
  93 #endif