]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiShellLib/UefiShellLib.h
ShellPkg: clarify space limitation in comment.
[mirror_edk2.git] / ShellPkg / Library / UefiShellLib / UefiShellLib.h
CommitLineData
d2b4564b 1/** @file\r
2 Provides interface to shell functionality for shell commands and applications.\r
3\r
252d9457 4 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
1e6e84c7 5 This program and the accompanying materials\r
b3011f40 6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
d2b4564b 9\r
b3011f40 10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
d2b4564b 12\r
13**/\r
14\r
a1d4bfcc 15#ifndef _UEFI_SHELL_LIB_INTERNAL_H_\r
252d9457 16#define _UEFI_SHELL_LIB_INTERNAL_H_\r
17\r
b3011f40 18#include <Uefi.h>\r
19\r
20#include <Guid/FileInfo.h>\r
21\r
22#include <Protocol/SimpleFileSystem.h>\r
23#include <Protocol/LoadedImage.h>\r
24#include <Protocol/EfiShellInterface.h>\r
25#include <Protocol/EfiShellEnvironment2.h>\r
26#include <Protocol/EfiShell.h>\r
27#include <Protocol/EfiShellParameters.h>\r
28\r
29#include <Library/UefiBootServicesTableLib.h>\r
30#include <Library/BaseLib.h>\r
31#include <Library/BaseMemoryLib.h>\r
32#include <Library/DebugLib.h>\r
33#include <Library/MemoryAllocationLib.h>\r
34#include <Library/DevicePathLib.h>\r
35#include <Library/PcdLib.h>\r
36#include <Library/FileHandleLib.h>\r
37#include <Library/PrintLib.h>\r
38#include <Library/UefiLib.h>\r
39#include <Library/HiiLib.h>\r
40#include <Library/ShellLib.h>\r
41\r
d2b4564b 42typedef struct {\r
43 EFI_SHELL_GET_FILE_INFO GetFileInfo;\r
44 EFI_SHELL_SET_FILE_INFO SetFileInfo;\r
45 EFI_SHELL_READ_FILE ReadFile;\r
46 EFI_SHELL_WRITE_FILE WriteFile;\r
47 EFI_SHELL_CLOSE_FILE CloseFile;\r
48 EFI_SHELL_DELETE_FILE DeleteFile;\r
49 EFI_SHELL_GET_FILE_POSITION GetFilePosition;\r
50 EFI_SHELL_SET_FILE_POSITION SetFilePosition;\r
51 EFI_SHELL_FLUSH_FILE FlushFile;\r
52 EFI_SHELL_GET_FILE_SIZE GetFileSize;\r
53} FILE_HANDLE_FUNCTION_MAP;\r
252d9457 54\r
55/**\r
56 Function to determin if an entire string is a valid number.\r
57\r
58 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.\r
59\r
60 @param[in] String The string to evaluate.\r
61 @param[in] ForceHex TRUE - always assume hex.\r
62 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.\r
63\r
64 @retval TRUE It is all numeric (dec/hex) characters.\r
65 @retval FALSE There is a non-numeric character.\r
66**/\r
67BOOLEAN\r
68EFIAPI\r
69InternalShellIsHexOrDecimalNumber (\r
70 IN CONST CHAR16 *String,\r
71 IN CONST BOOLEAN ForceHex,\r
72 IN CONST BOOLEAN StopAtSpace\r
73 );\r
74\r
75#endif\r
76\r