ShellPkg/Include/Library/ShellLib.h

   1 /** @file
   2   Provides interface to shell functionality for shell commands and applications.
   3
   4   Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __SHELL_LIB__
  16 #define __SHELL_LIB__
  17
  18 #include <Uefi.h>
  19 #include <Guid/FileInfo.h>
  20 #include <Protocol/SimpleFileSystem.h>
  21 #include <Protocol/LoadedImage.h>
  22 #include <Protocol/EfiShellInterface.h>
  23 #include <Protocol/EfiShellEnvironment2.h>
  24 #include <Protocol/EfiShell.h>
  25 #include <Protocol/EfiShellParameters.h>
  26
  27 // (20 * (6+5+2))+1) unicode characters from EFI FAT spec (doubled for bytes)
  28 #define MAX_FILE_NAME_LEN 512
  29
  30 extern EFI_SHELL_PARAMETERS_PROTOCOL *gEfiShellParametersProtocol;
  31 extern EFI_SHELL_PROTOCOL            *gEfiShellProtocol;
  32
  33 /**
  34   This function will retrieve the information about the file for the handle
  35   specified and store it in allocated pool memory.
  36
  37   This function allocates a buffer to store the file's information. It is the
  38   caller's responsibility to free the buffer.
  39
  40   @param[in] FileHandle         The file handle of the file for which information is
  41                                 being requested.
  42
  43   @retval NULL                  Information could not be retrieved.
  44
  45   @return                       The information about the file.
  46 **/
  47 EFI_FILE_INFO*
  48 EFIAPI
  49 ShellGetFileInfo (
  50   IN SHELL_FILE_HANDLE          FileHandle
  51   );
  52
  53 /**
  54   This function sets the information about the file for the opened handle
  55   specified.
  56
  57   @param[in]  FileHandle        The file handle of the file for which information
  58                                 is being set.
  59
  60   @param[in]  FileInfo          The information to set.
  61
  62   @retval EFI_SUCCESS                   The information was set.
  63   @retval EFI_INVALID_PARAMETER A parameter was out of range or invalid.
  64   @retval EFI_UNSUPPORTED       The FileHandle does not support FileInfo.
  65   @retval EFI_NO_MEDIA                The device has no medium.
  66   @retval EFI_DEVICE_ERROR          The device reported an error.
  67   @retval EFI_VOLUME_CORRUPTED  The file system structures are corrupted.
  68   @retval EFI_WRITE_PROTECTED     The file or medium is write protected.
  69   @retval EFI_ACCESS_DENIED     The file was opened read only.
  70   @retval EFI_VOLUME_FULL       The volume is full.
  71 **/
  72 EFI_STATUS
  73 EFIAPI
  74 ShellSetFileInfo (
  75   IN SHELL_FILE_HANDLE          FileHandle,
  76   IN EFI_FILE_INFO              *FileInfo
  77   );
  78
  79 /**
  80   This function will open a file or directory referenced by DevicePath.
  81
  82   This function opens a file with the open mode according to the file path. The
  83   Attributes is valid only for EFI_FILE_MODE_CREATE.
  84
  85   @param[in,out]  FilePath      On input, the device path to the file.  On output,
  86                                 the remaining device path.
  87   @param[out]  DeviceHandle     Pointer to the system device handle.
  88   @param[out]  FileHandle       Pointer to the file handle.
  89   @param[in]  OpenMode          The mode to open the file with.
  90   @param[in]  Attributes        The file's file attributes.
  91
  92   @retval EFI_SUCCESS           The information was set.
  93   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
  94   @retval EFI_UNSUPPORTED       Could not open the file path.
  95   @retval EFI_NOT_FOUND         The specified file could not be found on the
  96                                 device or the file system could not be found on
  97                                 the device.
  98   @retval EFI_NO_MEDIA          The device has no medium.
  99   @retval EFI_MEDIA_CHANGED     The device has a different medium in it or the
 100                                 medium is no longer supported.
 101   @retval EFI_DEVICE_ERROR      The device reported an error.
 102   @retval EFI_VOLUME_CORRUPTED  The file system structures are corrupted.
 103   @retval EFI_WRITE_PROTECTED   The file or medium is write protected.
 104   @retval EFI_ACCESS_DENIED     The file was opened read only.
 105   @retval EFI_OUT_OF_RESOURCES  Not enough resources were available to open the
 106                                 file.
 107   @retval EFI_VOLUME_FULL       The volume is full.
 108 **/
 109 EFI_STATUS
 110 EFIAPI
 111 ShellOpenFileByDevicePath(
 112   IN OUT EFI_DEVICE_PATH_PROTOCOL         **FilePath,
 113   OUT EFI_HANDLE                        *DeviceHandle,
 114   OUT SHELL_FILE_HANDLE                 *FileHandle,
 115   IN UINT64                             OpenMode,
 116   IN UINT64                             Attributes
 117   );
 118
 119 /**
 120   This function will open a file or directory referenced by filename.
 121
 122   If return is EFI_SUCCESS, the Filehandle is the opened file's handle;
 123   otherwise, the Filehandle is NULL. Attributes is valid only for
 124   EFI_FILE_MODE_CREATE.
 125
 126   @param[in] FilePath           The pointer to file name.
 127   @param[out] FileHandle        The pointer to the file handle.
 128   @param[in] OpenMode           The mode to open the file with.
 129   @param[in] Attributes         The file's file attributes.
 130
 131   @retval EFI_SUCCESS           The information was set.
 132   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
 133   @retval EFI_UNSUPPORTED       Could not open the file path.
 134   @retval EFI_NOT_FOUND         The specified file could not be found on the
 135                                 device or the file system could not be found
 136                                 on the device.
 137   @retval EFI_NO_MEDIA          The device has no medium.
 138   @retval EFI_MEDIA_CHANGED     The device has a different medium in it or the
 139                                 medium is no longer supported.
 140   @retval EFI_DEVICE_ERROR      The device reported an error.
 141   @retval EFI_VOLUME_CORRUPTED  The file system structures are corrupted.
 142   @retval EFI_WRITE_PROTECTED   The file or medium is write protected.
 143   @retval EFI_ACCESS_DENIED     The file was opened read only.
 144   @retval EFI_OUT_OF_RESOURCES  Not enough resources were available to open the
 145                                 file.
 146   @retval EFI_VOLUME_FULL       The volume is full.
 147 **/
 148 EFI_STATUS
 149 EFIAPI
 150 ShellOpenFileByName(
 151   IN CONST CHAR16                           *FilePath,
 152   OUT SHELL_FILE_HANDLE         *FileHandle,
 153   IN UINT64                     OpenMode,
 154   IN UINT64                     Attributes
 155   );
 156
 157 /**
 158   This function creates a directory.
 159
 160   If return is EFI_SUCCESS, the Filehandle is the opened directory's handle;
 161   otherwise, the Filehandle is NULL. If the directory already existed, this
 162   function opens the existing directory.
 163
 164   @param[in]  DirectoryName     The pointer to Directory name.
 165   @param[out] FileHandle        The pointer to the file handle.
 166
 167   @retval EFI_SUCCESS           The information was set.
 168   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
 169   @retval EFI_UNSUPPORTED       Could not open the file path.
 170   @retval EFI_NOT_FOUND         The specified file could not be found on the
 171                                 device, or the file system could not be found
 172                                 on the device.
 173   @retval EFI_NO_MEDIA          The device has no medium.
 174   @retval EFI_MEDIA_CHANGED     The device has a different medium in it or the
 175                                 medium is no longer supported.
 176   @retval EFI_DEVICE_ERROR      The device reported an error.
 177   @retval EFI_VOLUME_CORRUPTED  The file system structures are corrupted.
 178   @retval EFI_WRITE_PROTECTED   The file or medium is write protected.
 179   @retval EFI_ACCESS_DENIED     The file was opened read only.
 180   @retval EFI_OUT_OF_RESOURCES  Not enough resources were available to open the
 181                                 file.
 182   @retval EFI_VOLUME_FULL       The volume is full.
 183 **/
 184 EFI_STATUS
 185 EFIAPI
 186 ShellCreateDirectory(
 187   IN CONST CHAR16             *DirectoryName,
 188   OUT SHELL_FILE_HANDLE       *FileHandle
 189   );
 190
 191 /**
 192   This function reads information from an opened file.
 193
 194   If FileHandle is not a directory, the function reads the requested number of
 195   bytes from the file at the file's current position and returns them in Buffer.
 196   If the read goes beyond the end of the file, the read length is truncated to the
 197   end of the file. The file's current position is increased by the number of bytes
 198   returned.  If FileHandle is a directory, the function reads the directory entry
 199   at the file's current position and returns the entry in Buffer. If the Buffer
 200   is not large enough to hold the current directory entry, then
 201   EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated.
 202   BufferSize is set to be the size of the buffer needed to read the entry. On
 203   success, the current position is updated to the next directory entry. If there
 204   are no more directory entries, the read returns a zero-length buffer.
 205   EFI_FILE_INFO is the structure returned as the directory entry.
 206
 207   @param[in] FileHandle         The opened file handle.
 208   @param[in,out] ReadSize       On input the size of buffer in bytes.  On return
 209                                 the number of bytes written.
 210   @param[out] Buffer            The buffer to put read data into.
 211
 212   @retval EFI_SUCCESS           Data was read.
 213   @retval EFI_NO_MEDIA          The device has no media.
 214   @retval EFI_DEVICE_ERROR      The device reported an error.
 215   @retval EFI_VOLUME_CORRUPTED  The file system structures are corrupted.
 216   @retval EFI_BUFFER_TO_SMALL   Buffer is too small. ReadSize contains required
 217                                 size.
 218
 219 **/
 220 EFI_STATUS
 221 EFIAPI
 222 ShellReadFile(
 223   IN SHELL_FILE_HANDLE          FileHandle,
 224   IN OUT UINTN                  *ReadSize,
 225   OUT VOID                      *Buffer
 226   );
 227
 228 /**
 229   Write data to a file.
 230
 231   This function writes the specified number of bytes to the file at the current
 232   file position. The current file position is advanced the actual number of bytes
 233   written, which is returned in BufferSize. Partial writes only occur when there
 234   has been a data error during the write attempt (such as "volume space full").
 235   The file is automatically grown to hold the data if required. Direct writes to
 236   opened directories are not supported.
 237
 238   @param[in] FileHandle         The opened file for writing.
 239
 240   @param[in,out] BufferSize     On input the number of bytes in Buffer.  On output
 241                                 the number of bytes written.
 242
 243   @param[in] Buffer             The buffer containing data to write is stored.
 244
 245   @retval EFI_SUCCESS           Data was written.
 246   @retval EFI_UNSUPPORTED       Writes to an open directory are not supported.
 247   @retval EFI_NO_MEDIA          The device has no media.
 248   @retval EFI_DEVICE_ERROR      The device reported an error.
 249   @retval EFI_VOLUME_CORRUPTED  The file system structures are corrupted.
 250   @retval EFI_WRITE_PROTECTED   The device is write-protected.
 251   @retval EFI_ACCESS_DENIED     The file was open for read only.
 252   @retval EFI_VOLUME_FULL       The volume is full.
 253 **/
 254 EFI_STATUS
 255 EFIAPI
 256 ShellWriteFile(
 257   IN SHELL_FILE_HANDLE          FileHandle,
 258   IN OUT UINTN                  *BufferSize,
 259   IN VOID                       *Buffer
 260   );
 261
 262 /**
 263   Close an open file handle.
 264
 265   This function closes a specified file handle. All "dirty" cached file data is
 266   flushed to the device, and the file is closed. In all cases the handle is
 267   closed.
 268
 269   @param[in] FileHandle           The file handle to close.
 270
 271   @retval EFI_SUCCESS             The file handle was closed sucessfully.
 272   @retval INVALID_PARAMETER       One of the parameters has an invalid value.
 273 **/
 274 EFI_STATUS
 275 EFIAPI
 276 ShellCloseFile (
 277   IN SHELL_FILE_HANDLE          *FileHandle
 278   );
 279
 280 /**
 281   Delete a file and close the handle
 282
 283   This function closes and deletes a file. In all cases the file handle is closed.
 284   If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is
 285   returned, but the handle is still closed.
 286
 287   @param[in] FileHandle             The file handle to delete.
 288
 289   @retval EFI_SUCCESS               The file was closed sucessfully.
 290   @retval EFI_WARN_DELETE_FAILURE   The handle was closed, but the file was not
 291                                     deleted.
 292   @retval INVALID_PARAMETER         One of the parameters has an invalid value.
 293 **/
 294 EFI_STATUS
 295 EFIAPI
 296 ShellDeleteFile (
 297   IN SHELL_FILE_HANDLE          *FileHandle
 298   );
 299
 300 /**
 301   Set the current position in a file.
 302
 303   This function sets the current file position for the handle to the position
 304   supplied. With the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only
 305   absolute positioning is supported, and moving past the end of the file is
 306   allowed (a subsequent write would grow the file). Moving to position
 307   0xFFFFFFFFFFFFFFFF causes the current position to be set to the end of the file.
 308   If FileHandle is a directory, the only position that may be set is zero. This
 309   has the effect of starting the read process of the directory entries over.
 310
 311   @param[in] FileHandle         The file handle on which the position is being set.
 312
 313   @param[in] Position           The byte position from the begining of the file.
 314
 315   @retval EFI_SUCCESS           Operation completed sucessfully.
 316   @retval EFI_UNSUPPORTED       The seek request for non-zero is not valid on
 317                                 directories.
 318   @retval INVALID_PARAMETER     One of the parameters has an invalid value.
 319 **/
 320 EFI_STATUS
 321 EFIAPI
 322 ShellSetFilePosition (
 323   IN SHELL_FILE_HANDLE  FileHandle,
 324   IN UINT64             Position
 325   );
 326
 327 /**
 328   Gets a file's current position
 329
 330   This function retrieves the current file position for the file handle. For
 331   directories, the current file position has no meaning outside of the file
 332   system driver and as such the operation is not supported. An error is returned
 333   if FileHandle is a directory.
 334
 335   @param[in] FileHandle         The open file handle on which to get the position.
 336   @param[out] Position          The byte position from the begining of the file.
 337
 338   @retval EFI_SUCCESS           The operation completed sucessfully.
 339   @retval INVALID_PARAMETER     One of the parameters has an invalid value.
 340   @retval EFI_UNSUPPORTED       The request is not valid on directories.
 341 **/
 342 EFI_STATUS
 343 EFIAPI
 344 ShellGetFilePosition (
 345   IN SHELL_FILE_HANDLE          FileHandle,
 346   OUT UINT64                    *Position
 347   );
 348
 349 /**
 350   Flushes data on a file
 351
 352   This function flushes all modified data associated with a file to a device.
 353
 354   @param[in] FileHandle         The file handle on which to flush data.
 355
 356   @retval EFI_SUCCESS           The data was flushed.
 357   @retval EFI_NO_MEDIA          The device has no media.
 358   @retval EFI_DEVICE_ERROR      The device reported an error.
 359   @retval EFI_VOLUME_CORRUPTED  The file system structures are corrupted.
 360   @retval EFI_WRITE_PROTECTED   The file or medium is write protected.
 361   @retval EFI_ACCESS_DENIED     The file was opened for read only.
 362 **/
 363 EFI_STATUS
 364 EFIAPI
 365 ShellFlushFile (
 366   IN SHELL_FILE_HANDLE          FileHandle
 367   );
 368
 369 /**
 370   Retrieves the first file from a directory
 371
 372   This function takes an open directory handle and gets the first file
 373   in the directory's info. Caller can use ShellFindNextFile() to get
 374   subsequent files.
 375
 376   Caller must use FreePool on *Buffer opon completion of all file searching.
 377
 378   @param[in] DirHandle          The file handle of the directory to search.
 379   @param[out] Buffer            The pointer to the buffer for the file's information.
 380
 381   @retval EFI_SUCCESS           Found the first file.
 382   @retval EFI_NOT_FOUND         Cannot find the directory.
 383   @retval EFI_NO_MEDIA          The device has no media.
 384   @retval EFI_DEVICE_ERROR      The device reported an error.
 385   @retval EFI_VOLUME_CORRUPTED  The file system structures are corrupted.
 386   @sa ShellReadFile
 387 **/
 388 EFI_STATUS
 389 EFIAPI
 390 ShellFindFirstFile (
 391   IN SHELL_FILE_HANDLE          DirHandle,
 392   OUT EFI_FILE_INFO             **Buffer
 393   );
 394
 395 /**
 396   Retrieves the next file in a directory.
 397
 398   To use this function, caller must call the ShellFindFirstFile() to get the
 399   first file, and then use this function get other files. This function can be
 400   called for several times to get each file's information in the directory. If
 401   the call of ShellFindNextFile() got the last file in the directory, the next
 402   call of this function has no file to get. *NoFile will be set to TRUE, and the
 403   data in Buffer is meaningless.
 404
 405   @param[in] DirHandle          The file handle of the directory.
 406   @param[in,out] Buffer         The pointer to buffer for file's information.
 407   @param[in,out] NoFile         The pointer to boolean when last file is found.
 408
 409   @retval EFI_SUCCESS           Found the next file.
 410   @retval EFI_NO_MEDIA          The device has no media.
 411   @retval EFI_DEVICE_ERROR      The device reported an error.
 412   @retval EFI_VOLUME_CORRUPTED  The file system structures are corrupted.
 413   @sa ShellReadFile
 414 **/
 415 EFI_STATUS
 416 EFIAPI
 417 ShellFindNextFile(
 418   IN SHELL_FILE_HANDLE           DirHandle,
 419   IN OUT EFI_FILE_INFO           *Buffer,
 420   IN OUT BOOLEAN                 *NoFile
 421   );
 422
 423 /**
 424   Retrieve the size of a file.
 425
 426   This function extracts the file size info from the FileHandle's EFI_FILE_INFO
 427   data.
 428
 429   @param[in] FileHandle         The file handle from which size is retrieved.
 430   @param[out] Size              The pointer to size.
 431
 432   @retval EFI_SUCCESS           The operation was completed sucessfully.
 433   @retval EFI_DEVICE_ERROR      Cannot access the file.
 434 **/
 435 EFI_STATUS
 436 EFIAPI
 437 ShellGetFileSize (
 438   IN SHELL_FILE_HANDLE          FileHandle,
 439   OUT UINT64                    *Size
 440   );
 441
 442 /**
 443   Retrieves the status of the break execution flag
 444
 445   This function is useful to check whether the application is being asked to halt by the shell.
 446
 447   @retval TRUE                  The execution break is enabled.
 448   @retval FALSE                 The execution break is not enabled.
 449 **/
 450 BOOLEAN
 451 EFIAPI
 452 ShellGetExecutionBreakFlag(
 453   VOID
 454   );
 455
 456 /**
 457   Return the value of an environment variable.
 458
 459   This function gets the value of the environment variable set by the
 460   ShellSetEnvironmentVariable function.
 461
 462   @param[in] EnvKey             The key name of the environment variable.
 463
 464   @retval NULL                  The named environment variable does not exist.
 465   @return != NULL               The pointer to the value of the environment variable.
 466 **/
 467 CONST CHAR16*
 468 EFIAPI
 469 ShellGetEnvironmentVariable (
 470   IN CONST CHAR16                *EnvKey
 471   );
 472
 473 /**
 474   Set the value of an environment variable.
 475
 476   This function changes the current value of the specified environment variable. If the
 477   environment variable exists and the Value is an empty string, then the environment
 478   variable is deleted. If the environment variable exists and the Value is not an empty
 479   string, then the value of the environment variable is changed. If the environment
 480   variable does not exist and the Value is an empty string, there is no action. If the
 481   environment variable does not exist and the Value is a non-empty string, then the
 482   environment variable is created and assigned the specified value.
 483
 484   This is not supported pre-UEFI Shell 2.0.
 485
 486   @param[in] EnvKey             The key name of the environment variable.
 487   @param[in] EnvVal             The Value of the environment variable
 488   @param[in] Volatile           Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
 489
 490   @retval EFI_SUCCESS           The operation completed sucessfully
 491   @retval EFI_UNSUPPORTED       This operation is not allowed in pre-UEFI 2.0 Shell environments.
 492 **/
 493 EFI_STATUS
 494 EFIAPI
 495 ShellSetEnvironmentVariable (
 496   IN CONST CHAR16               *EnvKey,
 497   IN CONST CHAR16               *EnvVal,
 498   IN BOOLEAN                    Volatile
 499   );
 500
 501 /**
 502   Cause the shell to parse and execute a command line.
 503
 504   This function creates a nested instance of the shell and executes the specified
 505   command (CommandLine) with the specified environment (Environment). Upon return,
 506   the status code returned by the specified command is placed in StatusCode.
 507   If Environment is NULL, then the current environment is used and all changes made
 508   by the commands executed will be reflected in the current environment. If the
 509   Environment is non-NULL, then the changes made will be discarded.
 510   The CommandLine is executed from the current working directory on the current
 511   device.
 512
 513   The EnvironmentVariables and Status parameters are ignored in a pre-UEFI Shell 2.0
 514   environment.  The values pointed to by the parameters will be unchanged by the
 515   ShellExecute() function.  The Output parameter has no effect in a
 516   UEFI Shell 2.0 environment.
 517
 518   @param[in] ParentHandle         The parent image starting the operation.
 519   @param[in] CommandLine          The pointer to a NULL terminated command line.
 520   @param[in] Output               True to display debug output.  False to hide it.
 521   @param[in] EnvironmentVariables Optional pointer to array of environment variables
 522                                   in the form "x=y".  If NULL, the current set is used.
 523   @param[out] Status              The status of the run command line.
 524
 525   @retval EFI_SUCCESS             The operation completed sucessfully.  Status
 526                                   contains the status code returned.
 527   @retval EFI_INVALID_PARAMETER   A parameter contains an invalid value.
 528   @retval EFI_OUT_OF_RESOURCES    Out of resources.
 529   @retval EFI_UNSUPPORTED         The operation is not allowed.
 530 **/
 531 EFI_STATUS
 532 EFIAPI
 533 ShellExecute (
 534   IN EFI_HANDLE                 *ParentHandle,
 535   IN CHAR16                     *CommandLine,
 536   IN BOOLEAN                    Output,
 537   IN CHAR16                     **EnvironmentVariables,
 538   OUT EFI_STATUS                *Status
 539   );
 540
 541 /**
 542   Retreives the current directory path.
 543
 544   If the DeviceName is NULL, it returns the current device's current directory
 545   name. If the DeviceName is not NULL, it returns the current directory name
 546   on specified drive.
 547
 548   @param[in] DeviceName         The name of the file system to get directory on.
 549
 550   @retval NULL                  The directory does not exist.
 551   @retval != NULL               The directory.
 552 **/
 553 CONST CHAR16*
 554 EFIAPI
 555 ShellGetCurrentDir (
 556   IN CHAR16                     * CONST DeviceName OPTIONAL
 557   );
 558
 559 /**
 560   Sets (enabled or disabled) the page break mode.
 561
 562   When page break mode is enabled the screen will stop scrolling
 563   and wait for operator input before scrolling a subsequent screen.
 564
 565   @param[in] CurrentState       TRUE to enable and FALSE to disable.
 566 **/
 567 VOID
 568 EFIAPI
 569 ShellSetPageBreakMode (
 570   IN BOOLEAN                    CurrentState
 571   );
 572
 573 /**
 574   Opens a group of files based on a path.
 575
 576   This function uses the Arg to open all the matching files. Each matched
 577   file has a SHELL_FILE_ARG structure to record the file information. These
 578   structures are placed on the list ListHead. Users can get the SHELL_FILE_ARG
 579   structures from ListHead to access each file. This function supports wildcards
 580   and will process '?' and '*' as such.  The list must be freed with a call to
 581   ShellCloseFileMetaArg().
 582
 583   If you are NOT appending to an existing list *ListHead must be NULL.  If
 584   *ListHead is NULL then it must be callee freed.
 585
 586   @param[in] Arg                The pointer to path string.
 587   @param[in] OpenMode           Mode to open files with.
 588   @param[in,out] ListHead       Head of linked list of results.
 589
 590   @retval EFI_SUCCESS           The operation was sucessful and the list head
 591                                 contains the list of opened files.
 592   @retval != EFI_SUCCESS        The operation failed.
 593
 594   @sa InternalShellConvertFileListType
 595 **/
 596 EFI_STATUS
 597 EFIAPI
 598 ShellOpenFileMetaArg (
 599   IN CHAR16                     *Arg,
 600   IN UINT64                     OpenMode,
 601   IN OUT EFI_SHELL_FILE_INFO    **ListHead
 602   );
 603
 604 /**
 605   Free the linked list returned from ShellOpenFileMetaArg.
 606
 607   @param[in,out] ListHead       The pointer to free.
 608
 609   @retval EFI_SUCCESS           The operation was sucessful.
 610   @retval EFI_INVALID_PARAMETER A parameter was invalid.
 611 **/
 612 EFI_STATUS
 613 EFIAPI
 614 ShellCloseFileMetaArg (
 615   IN OUT EFI_SHELL_FILE_INFO    **ListHead
 616   );
 617
 618 /**
 619   Find a file by searching the CWD and then the path.
 620
 621   If FileName is NULL, then ASSERT.
 622
 623   If the return value is not NULL then the memory must be caller freed.
 624
 625   @param[in] FileName           Filename string.
 626
 627   @retval NULL                  The file was not found.
 628   @retval !NULL                 The path to the file.
 629 **/
 630 CHAR16 *
 631 EFIAPI
 632 ShellFindFilePath (
 633   IN CONST CHAR16 *FileName
 634   );
 635
 636 /**
 637   Find a file by searching the CWD and then the path with a variable set of file
 638   extensions.  If the file is not found it will append each extension in the list
 639   in the order provided and return the first one that is successful.
 640
 641   If FileName is NULL, then ASSERT.
 642   If FileExtension is NULL, then the behavior is identical to ShellFindFilePath.
 643
 644   If the return value is not NULL then the memory must be caller freed.
 645
 646   @param[in] FileName           The filename string.
 647   @param[in] FileExtension      Semicolon delimited list of possible extensions.
 648
 649   @retval NULL                  The file was not found.
 650   @retval !NULL                 The path to the file.
 651 **/
 652 CHAR16 *
 653 EFIAPI
 654 ShellFindFilePathEx (
 655   IN CONST CHAR16 *FileName,
 656   IN CONST CHAR16 *FileExtension
 657   );
 658
 659 typedef enum {
 660   TypeFlag  = 0,    ///< A flag that is present or not present only (IE "-a").
 661   TypeValue,        ///< A flag that has some data following it with a space (IE "-a 1").
 662   TypePosition,     ///< Some data that did not follow a parameter (IE "filename.txt").
 663   TypeStart,        ///< A flag that has variable value appended to the end (IE "-ad", "-afd", "-adf", etc...).
 664   TypeDoubleValue,  ///< A flag that has 2 space seperated value data following it (IE "-a 1 2").
 665   TypeMaxValue,     ///< A flag followed by all the command line data before the next flag.
 666   TypeMax,
 667 } SHELL_PARAM_TYPE;
 668
 669 typedef struct {
 670   CHAR16             *Name;
 671   SHELL_PARAM_TYPE   Type;
 672 } SHELL_PARAM_ITEM;
 673
 674
 675 /// Helper structure for no parameters (besides -? and -b)
 676 extern SHELL_PARAM_ITEM EmptyParamList[];
 677
 678 /// Helper structure for -sfo only (besides -? and -b)
 679 extern SHELL_PARAM_ITEM SfoParamList[];
 680
 681 /**
 682   Checks the command line arguments passed against the list of valid ones.
 683   Optionally removes NULL values first.
 684
 685   If no initialization is required, then return RETURN_SUCCESS.
 686
 687   @param[in] CheckList          The pointer to list of parameters to check.
 688   @param[out] CheckPackage      The package of checked values.
 689   @param[out] ProblemParam      Optional pointer to pointer to unicode string for
 690                                 the paramater that caused failure.
 691   @param[in] AutoPageBreak      Will automatically set PageBreakEnabled.
 692   @param[in] AlwaysAllowNumbers Will never fail for number based flags.
 693
 694   @retval EFI_SUCCESS           The operation completed sucessfully.
 695   @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.
 696   @retval EFI_INVALID_PARAMETER A parameter was invalid.
 697   @retval EFI_VOLUME_CORRUPTED  The command line was corrupt.
 698   @retval EFI_DEVICE_ERROR      The commands contained 2 opposing arguments.  One
 699                                 of the command line arguments was returned in
 700                                 ProblemParam if provided.
 701   @retval EFI_NOT_FOUND         A argument required a value that was missing.
 702                                 The invalid command line argument was returned in
 703                                 ProblemParam if provided.
 704 **/
 705 EFI_STATUS
 706 EFIAPI
 707 ShellCommandLineParseEx (
 708   IN CONST SHELL_PARAM_ITEM     *CheckList,
 709   OUT LIST_ENTRY                **CheckPackage,
 710   OUT CHAR16                    **ProblemParam OPTIONAL,
 711   IN BOOLEAN                    AutoPageBreak,
 712   IN BOOLEAN                    AlwaysAllowNumbers
 713   );
 714
 715 /// Make it easy to upgrade from older versions of the shell library.
 716 #define ShellCommandLineParse(CheckList,CheckPackage,ProblemParam,AutoPageBreak) ShellCommandLineParseEx(CheckList,CheckPackage,ProblemParam,AutoPageBreak,FALSE)
 717
 718 /**
 719   Frees shell variable list that was returned from ShellCommandLineParse.
 720
 721   This function will free all the memory that was used for the CheckPackage
 722   list of postprocessed shell arguments.
 723
 724   If CheckPackage is NULL, then return.
 725
 726   @param[in] CheckPackage       The list to de-allocate.
 727   **/
 728 VOID
 729 EFIAPI
 730 ShellCommandLineFreeVarList (
 731   IN LIST_ENTRY                 *CheckPackage
 732   );
 733
 734 /**
 735   Checks for presence of a flag parameter.
 736
 737   Flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key.
 738
 739   If CheckPackage is NULL then return FALSE.
 740   If KeyString is NULL then ASSERT().
 741
 742   @param[in] CheckPackage       The package of parsed command line arguments.
 743   @param[in] KeyString          The Key of the command line argument to check for.
 744
 745   @retval TRUE                  The flag is on the command line.
 746   @retval FALSE                 The flag is not on the command line.
 747 **/
 748 BOOLEAN
 749 EFIAPI
 750 ShellCommandLineGetFlag (
 751   IN CONST LIST_ENTRY         * CONST CheckPackage,
 752   IN CONST CHAR16             * CONST KeyString
 753   );
 754
 755 /**
 756   Returns value from command line argument.
 757
 758   Value parameters are in the form of "-<Key> value" or "/<Key> value".
 759
 760   If CheckPackage is NULL, then return NULL.
 761
 762   @param[in] CheckPackage       The package of parsed command line arguments.
 763   @param[in] KeyString          The Key of the command line argument to check for.
 764
 765   @retval NULL                  The flag is not on the command line.
 766   @retval !=NULL                The pointer to unicode string of the value.
 767 **/
 768 CONST CHAR16*
 769 EFIAPI
 770 ShellCommandLineGetValue (
 771   IN CONST LIST_ENTRY              *CheckPackage,
 772   IN CHAR16                        *KeyString
 773   );
 774
 775 /**
 776   Returns raw value from command line argument.
 777
 778   Raw value parameters are in the form of "value" in a specific position in the list.
 779
 780   If CheckPackage is NULL, then return NULL.
 781
 782   @param[in] CheckPackage       The package of parsed command line arguments.
 783   @param[in] Position           The position of the value.
 784
 785   @retval NULL                  The flag is not on the command line.
 786   @retval !=NULL                The pointer to unicode string of the value.
 787 **/
 788 CONST CHAR16*
 789 EFIAPI
 790 ShellCommandLineGetRawValue (
 791   IN CONST LIST_ENTRY              * CONST CheckPackage,
 792   IN UINTN                         Position
 793   );
 794
 795 /**
 796   Returns the number of command line value parameters that were parsed.
 797
 798   This will not include flags.
 799
 800   @param[in] CheckPackage       The package of parsed command line arguments.
 801
 802   @retval (UINTN)-1             No parsing has occurred.
 803   @retval other                 The number of value parameters found.
 804 **/
 805 UINTN
 806 EFIAPI
 807 ShellCommandLineGetCount(
 808   IN CONST LIST_ENTRY              *CheckPackage
 809   );
 810
 811 /**
 812   Determines if a parameter is duplicated.
 813
 814   If Param is not NULL, then it will point to a callee-allocated string buffer
 815   with the parameter value, if a duplicate is found.
 816
 817   If CheckPackage is NULL, then ASSERT.
 818
 819   @param[in] CheckPackage       The package of parsed command line arguments.
 820   @param[out] Param             Upon finding one, a pointer to the duplicated parameter.
 821
 822   @retval EFI_SUCCESS           No parameters were duplicated.
 823   @retval EFI_DEVICE_ERROR      A duplicate was found.
 824   **/
 825 EFI_STATUS
 826 EFIAPI
 827 ShellCommandLineCheckDuplicate (
 828   IN CONST LIST_ENTRY              *CheckPackage,
 829   OUT CHAR16                       **Param
 830   );
 831
 832 /**
 833   This function causes the shell library to initialize itself.  If the shell library
 834   is already initialized it will de-initialize all the current protocol pointers and
 835   re-populate them again.
 836
 837   When the library is used with PcdShellLibAutoInitialize set to true this function
 838   will return EFI_SUCCESS and perform no actions.
 839
 840   This function is intended for internal access for shell commands only.
 841
 842   @retval EFI_SUCCESS   The initialization was complete sucessfully.
 843
 844 **/
 845 EFI_STATUS
 846 EFIAPI
 847 ShellInitialize (
 848   VOID
 849   );
 850
 851 /**
 852   Print at a specific location on the screen.
 853
 854   This function will move the cursor to a given screen location and print the specified string.
 855
 856   If -1 is specified for either the Row or Col the current screen location for BOTH
 857   will be used.
 858
 859   If either Row or Col is out of range for the current console, then ASSERT.
 860   If Format is NULL, then ASSERT.
 861
 862   In addition to the standard %-based flags as supported by UefiLib Print() this supports
 863   the following additional flags:
 864     %N       -   Set output attribute to normal
 865     %H       -   Set output attribute to highlight
 866     %E       -   Set output attribute to error
 867     %B       -   Set output attribute to blue color
 868     %V       -   Set output attribute to green color
 869
 870   Note: The background color is controlled by the shell command cls.
 871
 872   @param[in] Col        The column to print at.
 873   @param[in] Row        The row to print at.
 874   @param[in] Format     The format string.
 875   @param[in] ...        The variable argument list.
 876
 877   @return EFI_SUCCESS           The printing was successful.
 878   @return EFI_DEVICE_ERROR      The console device reported an error.
 879 **/
 880 EFI_STATUS
 881 EFIAPI
 882 ShellPrintEx(
 883   IN INT32                Col OPTIONAL,
 884   IN INT32                Row OPTIONAL,
 885   IN CONST CHAR16         *Format,
 886   ...
 887   );
 888
 889 /**
 890   Print at a specific location on the screen.
 891
 892   This function will move the cursor to a given screen location and print the specified string.
 893
 894   If -1 is specified for either the Row or Col the current screen location for BOTH
 895   will be used.
 896
 897   If either Row or Col is out of range for the current console, then ASSERT.
 898   If Format is NULL, then ASSERT.
 899
 900   In addition to the standard %-based flags as supported by UefiLib Print() this supports
 901   the following additional flags:
 902     %N       -   Set output attribute to normal.
 903     %H       -   Set output attribute to highlight.
 904     %E       -   Set output attribute to error.
 905     %B       -   Set output attribute to blue color.
 906     %V       -   Set output attribute to green color.
 907
 908   Note: The background color is controlled by the shell command cls.
 909
 910   @param[in] Col                The column to print at.
 911   @param[in] Row                The row to print at.
 912   @param[in] Language           The language of the string to retrieve.  If this parameter
 913                                 is NULL, then the current platform language is used.
 914   @param[in] HiiFormatStringId  The format string Id for getting from Hii.
 915   @param[in] HiiFormatHandle    The format string Handle for getting from Hii.
 916   @param[in] ...                The variable argument list.
 917
 918   @return EFI_SUCCESS           The printing was successful.
 919   @return EFI_DEVICE_ERROR      The console device reported an error.
 920 **/
 921 EFI_STATUS
 922 EFIAPI
 923 ShellPrintHiiEx(
 924   IN INT32                Col OPTIONAL,
 925   IN INT32                Row OPTIONAL,
 926   IN CONST CHAR8          *Language OPTIONAL,
 927   IN CONST EFI_STRING_ID  HiiFormatStringId,
 928   IN CONST EFI_HANDLE     HiiFormatHandle,
 929   ...
 930   );
 931
 932 /**
 933   Function to determine if a given filename represents a directory.
 934
 935   If DirName is NULL, then ASSERT.
 936
 937   @param[in] DirName      Path to directory to test.
 938
 939   @retval EFI_SUCCESS     The Path represents a directory.
 940   @retval EFI_NOT_FOUND   The Path does not represent a directory.
 941   @retval other           The path failed to open.
 942 **/
 943 EFI_STATUS
 944 EFIAPI
 945 ShellIsDirectory(
 946   IN CONST CHAR16 *DirName
 947   );
 948
 949 /**
 950   Function to determine if a given filename represents a file.
 951
 952   This will search the CWD only.
 953
 954   If Name is NULL, then ASSERT.
 955
 956   @param[in] Name         Path to file to test.
 957
 958   @retval EFI_SUCCESS     The Path represents a file.
 959   @retval EFI_NOT_FOUND   The Path does not represent a file.
 960   @retval other           The path failed to open.
 961 **/
 962 EFI_STATUS
 963 EFIAPI
 964 ShellIsFile(
 965   IN CONST CHAR16 *Name
 966   );
 967
 968 /**
 969   Function to determine if a given filename represents a file.
 970
 971   This will search the CWD and then the Path.
 972
 973   If Name is NULL, then ASSERT.
 974
 975   @param[in] Name         Path to file to test.
 976
 977   @retval EFI_SUCCESS     The Path represents a file.
 978   @retval EFI_NOT_FOUND   The Path does not represent a file.
 979   @retval other           The path failed to open.
 980 **/
 981 EFI_STATUS
 982 EFIAPI
 983 ShellIsFileInPath(
 984   IN CONST CHAR16 *Name
 985   );
 986
 987 /**
 988   Function to determine whether a string is decimal or hex representation of a number
 989   and return the number converted from the string.
 990
 991   Note: this function cannot be used when (UINTN)(-1), (0xFFFFFFFF) may be a valid
 992   result.  Use ShellConvertStringToUint64 instead.
 993
 994   @param[in] String   String representation of a number.
 995
 996   @return             The unsigned integer result of the conversion.
 997   @retval (UINTN)(-1) An error occured.
 998 **/
 999 UINTN
1000 EFIAPI
1001 ShellStrToUintn(
1002   IN CONST CHAR16 *String
1003   );
1004
1005 /**
1006   Safely append with automatic string resizing given length of Destination and
1007   desired length of copy from Source.
1008
1009   Append the first D characters of Source to the end of Destination, where D is
1010   the lesser of Count and the StrLen() of Source. If appending those D characters
1011   will fit within Destination (whose Size is given as CurrentSize) and
1012   still leave room for a NULL terminator, then those characters are appended,
1013   starting at the original terminating NULL of Destination, and a new terminating
1014   NULL is appended.
1015
1016   If appending D characters onto Destination will result in a overflow of the size
1017   given in CurrentSize the string will be grown such that the copy can be performed
1018   and CurrentSize will be updated to the new size.
1019
1020   If Source is NULL, there is nothing to append, so return the current buffer in
1021   Destination.
1022
1023   If Destination is NULL, then ASSERT().
1024   If Destination's current length (including NULL terminator) is already more than
1025   CurrentSize, then ASSERT().
1026
1027   @param[in,out] Destination    The String to append onto.
1028   @param[in,out] CurrentSize    On call, the number of bytes in Destination.  On
1029                                 return, possibly the new size (still in bytes).  If NULL,
1030                                 then allocate whatever is needed.
1031   @param[in]     Source         The String to append from.
1032   @param[in]     Count          The maximum number of characters to append.  If 0, then
1033                                 all are appended.
1034
1035   @return                       The Destination after appending the Source.
1036 **/
1037 CHAR16*
1038 EFIAPI
1039 StrnCatGrow (
1040   IN OUT CHAR16           **Destination,
1041   IN OUT UINTN            *CurrentSize,
1042   IN     CONST CHAR16     *Source,
1043   IN     UINTN            Count
1044   );
1045
1046 /**
1047   This is a find and replace function.  Upon successful return the NewString is a copy of
1048   SourceString with each instance of FindTarget replaced with ReplaceWith.
1049
1050   If SourceString and NewString overlap the behavior is undefined.
1051
1052   If the string would grow bigger than NewSize it will halt and return error.
1053
1054   @param[in] SourceString             The string with source buffer.
1055   @param[in,out] NewString            The string with resultant buffer.
1056   @param[in] NewSize                  The size in bytes of NewString.
1057   @param[in] FindTarget               The string to look for.
1058   @param[in] ReplaceWith              The string to replace FindTarget with.
1059   @param[in] SkipPreCarrot            If TRUE will skip a FindTarget that has a '^'
1060                                       immediately before it.
1061   @param[in] ParameterReplacing       If TRUE will add "" around items with spaces.
1062
1063   @retval EFI_INVALID_PARAMETER       SourceString was NULL.
1064   @retval EFI_INVALID_PARAMETER       NewString was NULL.
1065   @retval EFI_INVALID_PARAMETER       FindTarget was NULL.
1066   @retval EFI_INVALID_PARAMETER       ReplaceWith was NULL.
1067   @retval EFI_INVALID_PARAMETER       FindTarget had length < 1.
1068   @retval EFI_INVALID_PARAMETER       SourceString had length < 1.
1069   @retval EFI_BUFFER_TOO_SMALL        NewSize was less than the minimum size to hold
1070                                       the new string (truncation occurred).
1071   @retval EFI_SUCCESS                 The string was successfully copied with replacement.
1072 **/
1073 EFI_STATUS
1074 EFIAPI
1075 ShellCopySearchAndReplace(
1076   IN CHAR16 CONST                     *SourceString,
1077   IN OUT CHAR16                       *NewString,
1078   IN UINTN                            NewSize,
1079   IN CONST CHAR16                     *FindTarget,
1080   IN CONST CHAR16                     *ReplaceWith,
1081   IN CONST BOOLEAN                    SkipPreCarrot,
1082   IN CONST BOOLEAN                    ParameterReplacing
1083   );
1084
1085 /**
1086   Check if a Unicode character is a hexadecimal character.
1087
1088   This internal function checks if a Unicode character is a
1089   numeric character.  The valid hexadecimal characters are
1090   L'0' to L'9', L'a' to L'f', or L'A' to L'F'.
1091
1092
1093   @param  Char  The character to check against.
1094
1095   @retval TRUE  The Char is a hexadecmial character.
1096   @retval FALSE The Char is not a hexadecmial character.
1097
1098 **/
1099 BOOLEAN
1100 EFIAPI
1101 ShellIsHexaDecimalDigitCharacter (
1102   IN      CHAR16                    Char
1103   );
1104
1105 /**
1106   Check if a Unicode character is a decimal character.
1107
1108   This internal function checks if a Unicode character is a
1109   decimal character.  The valid characters are
1110   L'0' to L'9'.
1111
1112
1113   @param  Char  The character to check against.
1114
1115   @retval TRUE  The Char is a hexadecmial character.
1116   @retval FALSE The Char is not a hexadecmial character.
1117
1118 **/
1119 BOOLEAN
1120 EFIAPI
1121 ShellIsDecimalDigitCharacter (
1122   IN      CHAR16                    Char
1123   );
1124
1125 ///
1126 /// What type of answer is requested.
1127 ///
1128 typedef enum {
1129   ShellPromptResponseTypeYesNo,
1130   ShellPromptResponseTypeYesNoCancel,
1131   ShellPromptResponseTypeFreeform,
1132   ShellPromptResponseTypeQuitContinue,
1133   ShellPromptResponseTypeYesNoAllCancel,
1134   ShellPromptResponseTypeEnterContinue,
1135   ShellPromptResponseTypeAnyKeyContinue,
1136   ShellPromptResponseTypeMax
1137 } SHELL_PROMPT_REQUEST_TYPE;
1138
1139 ///
1140 /// What answer was given.
1141 ///
1142 typedef enum {
1143   ShellPromptResponseYes,
1144   ShellPromptResponseNo,
1145   ShellPromptResponseCancel,
1146   ShellPromptResponseQuit,
1147   ShellPromptResponseContinue,
1148   ShellPromptResponseAll,
1149   ShellPromptResponseMax
1150 } SHELL_PROMPT_RESPONSE;
1151
1152 /**
1153   Prompt the user and return the resultant answer to the requestor.
1154
1155   This function will display the requested question on the shell prompt and then
1156   wait for an apropriate answer to be input from the console.
1157
1158   If the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue
1159   or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.
1160
1161   If the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type
1162   CHAR16*.
1163
1164   In either case *Response must be callee freed if Response was not NULL;
1165
1166   @param Type                     What type of question is asked.  This is used to filter the input
1167                                   to prevent invalid answers to question.
1168   @param Prompt                   The pointer to a string prompt used to request input.
1169   @param Response                 The pointer to Response, which will be populated upon return.
1170
1171   @retval EFI_SUCCESS             The operation was successful.
1172   @retval EFI_UNSUPPORTED         The operation is not supported as requested.
1173   @retval EFI_INVALID_PARAMETER   A parameter was invalid.
1174   @return other                   The operation failed.
1175 **/
1176 EFI_STATUS
1177 EFIAPI
1178 ShellPromptForResponse (
1179   IN SHELL_PROMPT_REQUEST_TYPE   Type,
1180   IN CHAR16         *Prompt OPTIONAL,
1181   IN OUT VOID       **Response OPTIONAL
1182   );
1183
1184 /**
1185   Prompt the user and return the resultant answer to the requestor.
1186
1187   This function is the same as ShellPromptForResponse, except that the prompt is
1188   automatically pulled from HII.
1189
1190   @param[in] Type What type of question is asked.  This is used to filter the input
1191                   to prevent invalid answers to question.
1192   @param[in] HiiFormatStringId  The format string Id for getting from Hii.
1193   @param[in] HiiFormatHandle    The format string Handle for getting from Hii.
1194   @param[in,out] Response       The pointer to Response, which will be populated upon return.
1195
1196   @retval EFI_SUCCESS The operation was sucessful.
1197   @return other       The operation failed.
1198
1199   @sa ShellPromptForResponse
1200 **/
1201 EFI_STATUS
1202 EFIAPI
1203 ShellPromptForResponseHii (
1204   IN SHELL_PROMPT_REQUEST_TYPE         Type,
1205   IN CONST EFI_STRING_ID  HiiFormatStringId,
1206   IN CONST EFI_HANDLE     HiiFormatHandle,
1207   IN OUT VOID             **Response
1208   );
1209
1210 /**
1211   Function to determin if an entire string is a valid number.
1212
1213   If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.
1214
1215   @param[in] String       The string to evaluate.
1216   @param[in] ForceHex     TRUE - always assume hex.
1217   @param[in] StopAtSpace  TRUE to halt upon finding a space, FALSE to keep going.
1218
1219   @retval TRUE        It is all numeric (dec/hex) characters.
1220   @retval FALSE       There is a non-numeric character.
1221 **/
1222 BOOLEAN
1223 EFIAPI
1224 ShellIsHexOrDecimalNumber (
1225   IN CONST CHAR16   *String,
1226   IN CONST BOOLEAN  ForceHex,
1227   IN CONST BOOLEAN  StopAtSpace
1228   );
1229
1230 /**
1231   Function to verify and convert a string to its numerical 64 bit representation.
1232
1233   If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.
1234
1235   @param[in] String       The string to evaluate.
1236   @param[out] Value       Upon a successful return the value of the conversion.
1237   @param[in] ForceHex     TRUE - always assume hex.
1238   @param[in] StopAtSpace  TRUE to halt upon finding a space, FALSE to
1239                           process the entire String.
1240
1241   @retval EFI_SUCCESS             The conversion was successful.
1242   @retval EFI_INVALID_PARAMETER   String contained an invalid character.
1243   @retval EFI_NOT_FOUND           String was a number, but Value was NULL.
1244 **/
1245 EFI_STATUS
1246 EFIAPI
1247 ShellConvertStringToUint64(
1248   IN CONST CHAR16   *String,
1249      OUT   UINT64   *Value,
1250   IN CONST BOOLEAN  ForceHex,
1251   IN CONST BOOLEAN  StopAtSpace
1252   );
1253
1254 /**
1255   Function to determine if a given filename exists.
1256
1257   @param[in] Name         Path to test.
1258
1259   @retval EFI_SUCCESS     The Path represents a file.
1260   @retval EFI_NOT_FOUND   The Path does not represent a file.
1261   @retval other           The path failed to open.
1262 **/
1263 EFI_STATUS
1264 EFIAPI
1265 ShellFileExists(
1266   IN CONST CHAR16 *Name
1267   );
1268
1269 /**
1270   Function to read a single line from a SHELL_FILE_HANDLE. The \n is not included in the returned
1271   buffer.  The returned buffer must be callee freed.
1272
1273   If the position upon start is 0, then the Ascii Boolean will be set.  This should be
1274   maintained and not changed for all operations with the same file.
1275
1276   @param[in]      Handle        SHELL_FILE_HANDLE to read from.
1277   @param[in,out]  Ascii         Boolean value for indicating whether the file is
1278                                 Ascii (TRUE) or UCS2 (FALSE).
1279
1280   @return                       The line of text from the file.
1281
1282   @sa ShellFileHandleReadLine
1283 **/
1284 CHAR16*
1285 EFIAPI
1286 ShellFileHandleReturnLine(
1287   IN SHELL_FILE_HANDLE            Handle,
1288   IN OUT BOOLEAN                *Ascii
1289   );
1290
1291 /**
1292   Function to read a single line (up to but not including the \n) from a SHELL_FILE_HANDLE.
1293
1294   If the position upon start is 0, then the Ascii Boolean will be set.  This should be
1295   maintained and not changed for all operations with the same file.
1296
1297   @param[in]      Handle        SHELL_FILE_HANDLE to read from.
1298   @param[in,out]  Buffer        The pointer to buffer to read into.
1299   @param[in,out]  Size          The pointer to number of bytes in Buffer.
1300   @param[in]      Truncate      If the buffer is large enough, this has no effect.
1301                                 If the buffer is is too small and Truncate is TRUE,
1302                                 the line will be truncated.
1303                                 If the buffer is is too small and Truncate is FALSE,
1304                                 then no read will occur.
1305
1306   @param[in,out]  Ascii         Boolean value for indicating whether the file is
1307                                 Ascii (TRUE) or UCS2 (FALSE).
1308
1309   @retval EFI_SUCCESS           The operation was successful.  The line is stored in
1310                                 Buffer.
1311   @retval EFI_INVALID_PARAMETER Handle was NULL.
1312   @retval EFI_INVALID_PARAMETER Size was NULL.
1313   @retval EFI_BUFFER_TOO_SMALL  Size was not large enough to store the line.
1314                                 Size was updated to the minimum space required.
1315 **/
1316 EFI_STATUS
1317 EFIAPI
1318 ShellFileHandleReadLine(
1319   IN SHELL_FILE_HANDLE          Handle,
1320   IN OUT CHAR16                 *Buffer,
1321   IN OUT UINTN                  *Size,
1322   IN BOOLEAN                    Truncate,
1323   IN OUT BOOLEAN                *Ascii
1324   );
1325
1326 #endif // __SHELL_LIB__