UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / EditStatusBar.h

/** @file\r
  Declares statusbar interface functions.\r
\r
  Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _LIB_STATUS_BAR_H_\r
#define _LIB_STATUS_BAR_H_\r
\r
/**\r
  Initialization function for Status Bar.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
  @sa StatusBarSetStatusString\r
**/\r
EFI_STATUS\r
StatusBarInit (\r
  VOID\r
  );\r
\r
/**\r
  Cleanup function for the status bar.\r
**/\r
VOID\r
StatusBarCleanup (\r
  VOID\r
  );\r
\r
/**\r
  Cause the status bar to refresh it's printing on the screen.\r
\r
  @param[in] EditorFirst      TRUE to indicate the first launch of the editor.\r
                              FALSE otherwise.\r
  @param[in] LastRow          LastPrintable row.\r
  @param[in] LastCol          Last printable column.\r
  @param[in] FileRow          Row in the file.\r
  @param[in] FileCol          Column in the file.\r
  @param[in] InsertMode       TRUE to indicate InsertMode.  FALSE otherwise.\r
\r
  @retval EFI_SUCCESS         The operation was successful.\r
**/\r
EFI_STATUS\r
StatusBarRefresh (\r
  IN BOOLEAN  EditorFirst,\r
  IN UINTN    LastRow,\r
  IN UINTN    LastCol,\r
  IN UINTN    FileRow,\r
  IN UINTN    FileCol,\r
  IN BOOLEAN  InsertMode\r
  );\r
\r
/**\r
  Set the status string text part.\r
\r
  @param[in] Str                The string to use.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
**/\r
EFI_STATUS\r
StatusBarSetStatusString (\r
  IN CHAR16  *Str\r
  );\r
\r
/**\r
  Function to retrieve the current status string.\r
\r
  @return The string that is used.\r
**/\r
CONST CHAR16 *\r
StatusBarGetString (\r
  VOID\r
  );\r
\r
/**\r
  Function to set the need refresh boolean to TRUE.\r
**/\r
VOID\r
StatusBarSetRefresh (\r
  VOID\r
  );\r
\r
/**\r
  Function to get the need refresh boolean to TRUE.\r
\r
  @retval TRUE    The status bar needs to be refreshed.\r
**/\r
BOOLEAN\r
StatusBarGetRefresh (\r
  VOID\r
  );\r
\r
#endif\r