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

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

/** @file\r
  Declares menubar 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_MENU_BAR_H_\r
#define _LIB_MENU_BAR_H_\r
\r
#define SCAN_CONTROL_E  5\r
#define SCAN_CONTROL_F  6\r
#define SCAN_CONTROL_G  7\r
#define SCAN_CONTROL_K  11\r
#define SCAN_CONTROL_O  15\r
#define SCAN_CONTROL_Q  17\r
#define SCAN_CONTROL_R  18\r
#define SCAN_CONTROL_S  19\r
#define SCAN_CONTROL_T  20\r
#define SCAN_CONTROL_U  21\r
#define SCAN_CONTROL_W  23\r
#define SCAN_CONTROL_Z  26\r
\r
typedef\r
EFI_STATUS\r
(*MENU_ITEM_FUNCTION) (\r
  VOID\r
  );\r
\r
typedef struct _EDITOR_MENU_ITEM {\r
  EFI_STRING_ID         NameToken;\r
  CHAR16                FunctionKeyToken;\r
  MENU_ITEM_FUNCTION    Function;\r
} EDITOR_MENU_ITEM;\r
\r
/**\r
  Initializa the menu bar with the specified items.\r
\r
  @param[in] Items              The items to display and their functions.\r
\r
  @retval EFI_SUCCESS           The initialization was correct.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
**/\r
EFI_STATUS\r
MenuBarInit (\r
  IN CONST EDITOR_MENU_ITEM  *Items\r
  );\r
\r
/**\r
  Initialize the control hot-key with the specified items.\r
\r
  @param[in] Items              The hot-key functions.\r
\r
  @retval EFI_SUCCESS           The initialization was correct.\r
**/\r
EFI_STATUS\r
ControlHotKeyInit (\r
  IN MENU_ITEM_FUNCTION  *Items\r
  );\r
\r
/**\r
  Cleanup function for a menu bar.  frees all allocated memory.\r
**/\r
VOID\r
MenuBarCleanup (\r
  VOID\r
  );\r
\r
/**\r
  Refresh function for the menu bar.\r
\r
  @param[in] LastRow            The last printable row.\r
  @param[in] LastCol            The last printable column.\r
\r
  @retval EFI_SUCCESS           The refresh was successful.\r
**/\r
EFI_STATUS\r
MenuBarRefresh (\r
  IN CONST UINTN  LastRow,\r
  IN CONST UINTN  LastCol\r
  );\r
\r
/**\r
  Function to dispatch the correct function based on a function key (F1...)\r
\r
  @param[in] Key                The pressed key.\r
\r
  @retval EFI_NOT_FOUND         The key was not a valid function key\r
                                (an error was sent to the status bar).\r
  @return The return value from the called dispatch function.\r
**/\r
EFI_STATUS\r
MenuBarDispatchFunctionKey (\r
  IN CONST EFI_INPUT_KEY  *Key\r
  );\r
\r
/**\r
  Function to dispatch the correct function based on a control-based key (ctrl+o...)\r
\r
  @param[in] KeyData                The pressed key.\r
\r
  @retval EFI_NOT_FOUND         The key was not a valid control-based key\r
                                (an error was sent to the status bar).\r
  @return EFI_SUCCESS.\r
**/\r
EFI_STATUS\r
MenuBarDispatchControlHotKey (\r
  IN CONST EFI_KEY_DATA  *KeyData\r
  );\r
\r
#endif\r