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

[mirror_edk2.git] / ShellPkg / Library / UefiShellLib / UefiShellLib.h

/** @file\r
  Provides interface to shell functionality for shell commands and applications.\r
\r
  (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _UEFI_SHELL_LIB_INTERNAL_H_\r
#define _UEFI_SHELL_LIB_INTERNAL_H_\r
\r
#include <Uefi.h>\r
\r
#include <Guid/FileInfo.h>\r
\r
#include <Protocol/SimpleFileSystem.h>\r
#include <Protocol/LoadedImage.h>\r
#include <Protocol/EfiShellInterface.h>\r
#include <Protocol/EfiShellEnvironment2.h>\r
#include <Protocol/Shell.h>\r
#include <Protocol/ShellParameters.h>\r
#include <Protocol/UnicodeCollation.h>\r
\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/FileHandleLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/ShellLib.h>\r
\r
typedef struct  {\r
  EFI_SHELL_GET_FILE_INFO        GetFileInfo;\r
  EFI_SHELL_SET_FILE_INFO        SetFileInfo;\r
  EFI_SHELL_READ_FILE            ReadFile;\r
  EFI_SHELL_WRITE_FILE           WriteFile;\r
  EFI_SHELL_CLOSE_FILE           CloseFile;\r
  EFI_SHELL_DELETE_FILE          DeleteFile;\r
  EFI_SHELL_GET_FILE_POSITION    GetFilePosition;\r
  EFI_SHELL_SET_FILE_POSITION    SetFilePosition;\r
  EFI_SHELL_FLUSH_FILE           FlushFile;\r
  EFI_SHELL_GET_FILE_SIZE        GetFileSize;\r
} FILE_HANDLE_FUNCTION_MAP;\r
\r
/**\r
  Function to determin if an entire string is a valid number.\r
\r
  If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.\r
\r
  @param[in] String       The string to evaluate.\r
  @param[in] ForceHex     TRUE - always assume hex.\r
  @param[in] StopAtSpace  TRUE to halt upon finding a space, FALSE to keep going.\r
  @param[in] TimeNumbers  TRUE to allow numbers with ":", FALSE otherwise.\r
\r
  @retval TRUE        It is all numeric (dec/hex) characters.\r
  @retval FALSE       There is a non-numeric character.\r
**/\r
BOOLEAN\r
InternalShellIsHexOrDecimalNumber (\r
  IN CONST CHAR16   *String,\r
  IN CONST BOOLEAN  ForceHex,\r
  IN CONST BOOLEAN  StopAtSpace,\r
  IN CONST BOOLEAN  TimeNumbers\r
  );\r
\r
/**\r
  Cleans off all the quotes in the string.\r
\r
  @param[in]     OriginalString   pointer to the string to be cleaned.\r
  @param[out]   CleanString      The new string with all quotes removed.\r
                                                  Memory allocated in the function and free\r
                                                  by caller.\r
\r
  @retval EFI_SUCCESS   The operation was successful.\r
**/\r
EFI_STATUS\r
InternalShellStripQuotes (\r
  IN  CONST CHAR16  *OriginalString,\r
  OUT CHAR16        **CleanString\r
  );\r
\r
#endif\r