ShellPkg: Clean up source files

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

/** @file\r
    Definitions for various line and string routines\r
\r
  Copyright (c) 2005 - 2018, 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 _LIB_MISC_H_\r
#define _LIB_MISC_H_\r
\r
#include "HexEditor.h"\r
\r
/**\r
  Advance/Retreat lines.\r
\r
  @param[in] Count      The line number to advance/retreat.\r
                            >0 : advance\r
                            <0: retreat\r
\r
  @retval NULL An error occured.\r
  @return A pointer to the line after move.\r
**/\r
HEFI_EDITOR_LINE *\r
HMoveLine (\r
  IN  INTN Count\r
  );\r
\r
/**\r
  Advance/Retreat lines and set CurrentLine in BufferImage to it.\r
\r
  @param[in] Count    The line number to advance/retreat.\r
                          >0 : advance\r
                          <0: retreat\r
\r
  @retval NULL An error occured.\r
  @return A pointer to the line after move.\r
**/\r
HEFI_EDITOR_LINE *\r
HMoveCurrentLine (\r
  IN  INTN Count\r
  );\r
\r
/**\r
  Free all the lines in HBufferImage.\r
    Fields affected:\r
    Lines\r
    CurrentLine\r
    NumLines\r
    ListHead\r
\r
  @param[in] ListHead     The list head.\r
  @param[in] Lines        The lines.\r
\r
  @retval EFI_SUCCESS     The operation was successful.\r
**/\r
EFI_STATUS\r
HFreeLines (\r
  IN LIST_ENTRY   *ListHead,\r
  IN HEFI_EDITOR_LINE *Lines\r
  );\r
\r
/**\r
  Get the X information for the mouse.\r
\r
  @param[in] GuidX      The change.\r
\r
  @return the new information.\r
**/\r
INT32\r
HGetTextX (\r
  IN INT32 GuidX\r
  );\r
\r
/**\r
  Get the Y information for the mouse.\r
\r
  @param[in] GuidY      The change.\r
\r
  @return the new information.\r
**/\r
INT32\r
HGetTextY (\r
  IN INT32 GuidY\r
  );\r
\r
#endif\r