ShellPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / ShellPkg / Application / Shell / FileHandleInternal.h

/** @file\r
  internal worker functions for FileHandleWrappers to use\r
\r
  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _FILE_HANDLE_INTERNAL_HEADER_\r
#define _FILE_HANDLE_INTERNAL_HEADER_\r
\r
/**\r
  Move the cursor position one character backward.\r
\r
  @param[in] LineLength       Length of a line. Get it by calling QueryMode\r
  @param[in, out] Column      Current column of the cursor position\r
  @param[in, out] Row         Current row of the cursor position\r
**/\r
VOID\r
MoveCursorBackward (\r
  IN     UINTN                   LineLength,\r
  IN OUT UINTN                   *Column,\r
  IN OUT UINTN                   *Row\r
  );\r
\r
/**\r
  Move the cursor position one character forward.\r
\r
  @param[in] LineLength       Length of a line.\r
  @param[in] TotalRow         Total row of a screen\r
  @param[in, out] Column      Current column of the cursor position\r
  @param[in, out] Row         Current row of the cursor position\r
**/\r
VOID\r
MoveCursorForward (\r
  IN     UINTN                   LineLength,\r
  IN     UINTN                   TotalRow,\r
  IN OUT UINTN                   *Column,\r
  IN OUT UINTN                   *Row\r
  );\r
\r
/**\r
  Prints out each previously typed command in the command list history log.\r
\r
  When each screen is full it will pause for a key before continuing.\r
\r
  @param[in] TotalCols    How many columns are on the screen\r
  @param[in] TotalRows    How many rows are on the screen\r
  @param[in] StartColumn  which column to start at\r
**/\r
VOID\r
PrintCommandHistory (\r
  IN CONST UINTN TotalCols,\r
  IN CONST UINTN TotalRows,\r
  IN CONST UINTN StartColumn\r
  );\r
\r
#endif //_FILE_HANDLE_INTERNAL_HEADER_\r
\r