Refine code to make it more safely.

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / Edit / MainTextEditor.h

/** @file\r
  Declares editor interface functions.\r
\r
  Copyright (c) 2005 - 2011, 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_EDITOR_H_\r
#define _LIB_EDITOR_H_\r
\r
#include "TextEditorTypes.h"\r
\r
/**\r
  The initialization function for MainEditor.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_LOAD_ERROR          A load error occured.\r
**/\r
EFI_STATUS\r
EFIAPI\r
MainEditorInit (\r
  VOID\r
  );\r
\r
/**\r
  The cleanup function for MainEditor.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_LOAD_ERROR          A load error occured.\r
**/\r
EFI_STATUS\r
EFIAPI\r
MainEditorCleanup (\r
  VOID\r
  );\r
\r
/**\r
  Refresh the main editor component.\r
**/\r
VOID\r
EFIAPI\r
MainEditorRefresh (\r
  VOID\r
  );\r
\r
/**\r
  Handle user key input. This routes to other functions for the actions.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_LOAD_ERROR          A load error occured.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.\r
**/\r
EFI_STATUS\r
EFIAPI\r
MainEditorKeyInput (\r
  VOID\r
  );\r
\r
/**\r
  Backup function for MainEditor\r
\r
  @retval EFI_SUCCESS The operation was successful.\r
**/\r
EFI_STATUS\r
EFIAPI\r
MainEditorBackup (\r
  VOID\r
  );\r
\r
#endif\r