ShellPkg/Application/Shell/FileHandleInternal.h

   1 /** @file
   2   internal worker functions for FileHandleWrappers to use
   3
   4   Copyright (c) 2009 - 2010, 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 _FILE_HANDLE_INTERNAL_HEADER_
  16 #define _FILE_HANDLE_INTERNAL_HEADER_
  17
  18 /**
  19   Move the cursor position one character backward.
  20
  21   @param[in] LineLength       Length of a line. Get it by calling QueryMode
  22   @param[in,out] Column      Current column of the cursor position
  23   @param[in,out] Row         Current row of the cursor position
  24 **/
  25 VOID
  26 EFIAPI
  27 MoveCursorBackward (
  28   IN     UINTN                   LineLength,
  29   IN OUT UINTN                   *Column,
  30   IN OUT UINTN                   *Row
  31   );
  32
  33 /**
  34   Move the cursor position one character forward.
  35
  36   @param[in] LineLength       Length of a line.
  37   @param[in] TotalRow         Total row of a screen
  38   @param[in,out] Column      Current column of the cursor position
  39   @param[in,out] Row         Current row of the cursor position
  40 **/
  41 VOID
  42 EFIAPI
  43 MoveCursorForward (
  44   IN     UINTN                   LineLength,
  45   IN     UINTN                   TotalRow,
  46   IN OUT UINTN                   *Column,
  47   IN OUT UINTN                   *Row
  48   );
  49
  50 /**
  51   Prints out each previously typed command in the command list history log.
  52
  53   When each screen is full it will pause for a key before continuing.
  54
  55   @param[in] TotalCols    How many columns are on the screen
  56   @param[in] TotalRows    How many rows are on the screen
  57   @param[in] StartColumn  which column to start at
  58 **/
  59 VOID
  60 EFIAPI
  61 PrintCommandHistory (
  62   IN CONST UINTN TotalCols,
  63   IN CONST UINTN TotalRows,
  64   IN CONST UINTN StartColumn
  65   );
  66
  67 #endif //_FILE_HANDLE_INTERNAL_HEADER_
  68