ShellPkg/Include/Library/ShellLib.h

   1 /** @file
   2   Provides interface to shell functionality for shell commands and applications.
   3
   4   Copyright (c) 2006 - 2014, 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 /** Retrieve first entry from a directory.
 370
 371   This function takes an open directory handle and gets information from the
 372   first entry in the directory.  A buffer is allocated to contain
 373   the information and a pointer to the buffer is returned in *Buffer.  The
 374   caller can use ShellFindNextFile() to get subsequent directory entries.
 375
 376   The buffer will be freed by ShellFindNextFile() when the last directory
 377   entry is read.  Otherwise, the caller must free the buffer, using FreePool,
 378   when finished with it.
 379
 380   @param[in]  DirHandle         The file handle of the directory to search.
 381   @param[out] Buffer            The pointer to the buffer for the file's information.
 382
 383   @retval EFI_SUCCESS           Found the first file.
 384   @retval EFI_NOT_FOUND         Cannot find the directory.
 385   @retval EFI_NO_MEDIA          The device has no media.
 386   @retval EFI_DEVICE_ERROR      The device reported an error.
 387   @retval EFI_VOLUME_CORRUPTED  The file system structures are corrupted.
 388   @return Others                Status of ShellGetFileInfo, ShellSetFilePosition,
 389                                 or ShellReadFile.
 390
 391   @sa ShellReadFile
 392 **/
 393 EFI_STATUS
 394 EFIAPI
 395 ShellFindFirstFile (
 396   IN      SHELL_FILE_HANDLE       DirHandle,
 397      OUT  EFI_FILE_INFO         **Buffer
 398   );
 399
 400 /** Retrieve next entries from a directory.
 401
 402   To use this function, the caller must first call the ShellFindFirstFile()
 403   function to get the first directory entry.  Subsequent directory entries are
 404   retrieved by using the ShellFindNextFile() function.  This function can
 405   be called several times to get each entry from the directory.  If the call of
 406   ShellFindNextFile() retrieved the last directory entry, the next call of
 407   this function will set *NoFile to TRUE and free the buffer.
 408
 409   @param[in]  DirHandle         The file handle of the directory.
 410   @param[in, out] Buffer        The pointer to buffer for file's information.
 411   @param[in, out] NoFile        The pointer to boolean when last file is found.
 412
 413   @retval EFI_SUCCESS           Found the next file.
 414   @retval EFI_NO_MEDIA          The device has no media.
 415   @retval EFI_DEVICE_ERROR      The device reported an error.
 416   @retval EFI_VOLUME_CORRUPTED  The file system structures are corrupted.
 417
 418   @sa ShellReadFile
 419 **/
 420 EFI_STATUS
 421 EFIAPI
 422 ShellFindNextFile(
 423   IN      SHELL_FILE_HANDLE       DirHandle,
 424   IN OUT  EFI_FILE_INFO          *Buffer,
 425   IN OUT  BOOLEAN                *NoFile
 426   );
 427
 428 /**
 429   Retrieve the size of a file.
 430
 431   This function extracts the file size info from the FileHandle's EFI_FILE_INFO
 432   data.
 433
 434   @param[in] FileHandle         The file handle from which size is retrieved.
 435   @param[out] Size              The pointer to size.
 436
 437   @retval EFI_SUCCESS           The operation was completed sucessfully.
 438   @retval EFI_DEVICE_ERROR      Cannot access the file.
 439 **/
 440 EFI_STATUS
 441 EFIAPI
 442 ShellGetFileSize (
 443   IN SHELL_FILE_HANDLE          FileHandle,
 444   OUT UINT64                    *Size
 445   );
 446
 447 /**
 448   Retrieves the status of the break execution flag
 449
 450   This function is useful to check whether the application is being asked to halt by the shell.
 451
 452   @retval TRUE                  The execution break is enabled.
 453   @retval FALSE                 The execution break is not enabled.
 454 **/
 455 BOOLEAN
 456 EFIAPI
 457 ShellGetExecutionBreakFlag(
 458   VOID
 459   );
 460
 461 /**
 462   Return the value of an environment variable.
 463
 464   This function gets the value of the environment variable set by the
 465   ShellSetEnvironmentVariable function.
 466
 467   @param[in] EnvKey             The key name of the environment variable.
 468
 469   @retval NULL                  The named environment variable does not exist.
 470   @return != NULL               The pointer to the value of the environment variable.
 471 **/
 472 CONST CHAR16*
 473 EFIAPI
 474 ShellGetEnvironmentVariable (
 475   IN CONST CHAR16                *EnvKey
 476   );
 477
 478 /**
 479   Set the value of an environment variable.
 480
 481   This function changes the current value of the specified environment variable. If the
 482   environment variable exists and the Value is an empty string, then the environment
 483   variable is deleted. If the environment variable exists and the Value is not an empty
 484   string, then the value of the environment variable is changed. If the environment
 485   variable does not exist and the Value is an empty string, there is no action. If the
 486   environment variable does not exist and the Value is a non-empty string, then the
 487   environment variable is created and assigned the specified value.
 488
 489   This is not supported pre-UEFI Shell 2.0.
 490
 491   @param[in] EnvKey             The key name of the environment variable.
 492   @param[in] EnvVal             The Value of the environment variable
 493   @param[in] Volatile           Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
 494
 495   @retval EFI_SUCCESS           The operation completed sucessfully
 496   @retval EFI_UNSUPPORTED       This operation is not allowed in pre-UEFI 2.0 Shell environments.
 497 **/
 498 EFI_STATUS
 499 EFIAPI
 500 ShellSetEnvironmentVariable (
 501   IN CONST CHAR16               *EnvKey,
 502   IN CONST CHAR16               *EnvVal,
 503   IN BOOLEAN                    Volatile
 504   );
 505
 506 /**
 507   Cause the shell to parse and execute a command line.
 508
 509   This function creates a nested instance of the shell and executes the specified
 510   command (CommandLine) with the specified environment (Environment). Upon return,
 511   the status code returned by the specified command is placed in StatusCode.
 512   If Environment is NULL, then the current environment is used and all changes made
 513   by the commands executed will be reflected in the current environment. If the
 514   Environment is non-NULL, then the changes made will be discarded.
 515   The CommandLine is executed from the current working directory on the current
 516   device.
 517
 518   The EnvironmentVariables and Status parameters are ignored in a pre-UEFI Shell 2.0
 519   environment.  The values pointed to by the parameters will be unchanged by the
 520   ShellExecute() function.  The Output parameter has no effect in a
 521   UEFI Shell 2.0 environment.
 522
 523   @param[in] ParentHandle         The parent image starting the operation.
 524   @param[in] CommandLine          The pointer to a NULL terminated command line.
 525   @param[in] Output               True to display debug output.  False to hide it.
 526   @param[in] EnvironmentVariables Optional pointer to array of environment variables
 527                                   in the form "x=y".  If NULL, the current set is used.
 528   @param[out] Status              The status of the run command line.
 529
 530   @retval EFI_SUCCESS             The operation completed sucessfully.  Status
 531                                   contains the status code returned.
 532   @retval EFI_INVALID_PARAMETER   A parameter contains an invalid value.
 533   @retval EFI_OUT_OF_RESOURCES    Out of resources.
 534   @retval EFI_UNSUPPORTED         The operation is not allowed.
 535 **/
 536 EFI_STATUS
 537 EFIAPI
 538 ShellExecute (
 539   IN EFI_HANDLE                 *ParentHandle,
 540   IN CHAR16                     *CommandLine,
 541   IN BOOLEAN                    Output,
 542   IN CHAR16                     **EnvironmentVariables,
 543   OUT EFI_STATUS                *Status
 544   );
 545
 546 /**
 547   Retreives the current directory path.
 548
 549   If the DeviceName is NULL, it returns the current device's current directory
 550   name. If the DeviceName is not NULL, it returns the current directory name
 551   on specified drive.
 552
 553   @param[in] DeviceName         The name of the file system to get directory on.
 554
 555   @retval NULL                  The directory does not exist.
 556   @retval != NULL               The directory.
 557 **/
 558 CONST CHAR16*
 559 EFIAPI
 560 ShellGetCurrentDir (
 561   IN CHAR16                     * CONST DeviceName OPTIONAL
 562   );
 563
 564 /**
 565   Sets (enabled or disabled) the page break mode.
 566
 567   When page break mode is enabled the screen will stop scrolling
 568   and wait for operator input before scrolling a subsequent screen.
 569
 570   @param[in] CurrentState       TRUE to enable and FALSE to disable.
 571 **/
 572 VOID
 573 EFIAPI
 574 ShellSetPageBreakMode (
 575   IN BOOLEAN                    CurrentState
 576   );
 577
 578 /**
 579   Opens a group of files based on a path.
 580
 581   This function uses the Arg to open all the matching files. Each matched
 582   file has a SHELL_FILE_ARG structure to record the file information. These
 583   structures are placed on the list ListHead. Users can get the SHELL_FILE_ARG
 584   structures from ListHead to access each file. This function supports wildcards
 585   and will process '?' and '*' as such.  The list must be freed with a call to
 586   ShellCloseFileMetaArg().
 587
 588   If you are NOT appending to an existing list *ListHead must be NULL.  If
 589   *ListHead is NULL then it must be callee freed.
 590
 591   @param[in] Arg                 The pointer to path string.
 592   @param[in] OpenMode            Mode to open files with.
 593   @param[in, out] ListHead       Head of linked list of results.
 594
 595   @retval EFI_SUCCESS           The operation was sucessful and the list head
 596                                 contains the list of opened files.
 597   @retval != EFI_SUCCESS        The operation failed.
 598
 599   @sa InternalShellConvertFileListType
 600 **/
 601 EFI_STATUS
 602 EFIAPI
 603 ShellOpenFileMetaArg (
 604   IN CHAR16                     *Arg,
 605   IN UINT64                     OpenMode,
 606   IN OUT EFI_SHELL_FILE_INFO    **ListHead
 607   );
 608
 609 /**
 610   Free the linked list returned from ShellOpenFileMetaArg.
 611
 612   @param[in, out] ListHead       The pointer to free.
 613
 614   @retval EFI_SUCCESS           The operation was sucessful.
 615   @retval EFI_INVALID_PARAMETER A parameter was invalid.
 616 **/
 617 EFI_STATUS
 618 EFIAPI
 619 ShellCloseFileMetaArg (
 620   IN OUT EFI_SHELL_FILE_INFO    **ListHead
 621   );
 622
 623 /**
 624   Find a file by searching the CWD and then the path.
 625
 626   If FileName is NULL, then ASSERT.
 627
 628   If the return value is not NULL then the memory must be caller freed.
 629
 630   @param[in] FileName           Filename string.
 631
 632   @retval NULL                  The file was not found.
 633   @retval !NULL                 The path to the file.
 634 **/
 635 CHAR16 *
 636 EFIAPI
 637 ShellFindFilePath (
 638   IN CONST CHAR16 *FileName
 639   );
 640
 641 /**
 642   Find a file by searching the CWD and then the path with a variable set of file
 643   extensions.  If the file is not found it will append each extension in the list
 644   in the order provided and return the first one that is successful.
 645
 646   If FileName is NULL, then ASSERT.
 647   If FileExtension is NULL, then the behavior is identical to ShellFindFilePath.
 648
 649   If the return value is not NULL then the memory must be caller freed.
 650
 651   @param[in] FileName           The filename string.
 652   @param[in] FileExtension      Semicolon delimited list of possible extensions.
 653
 654   @retval NULL                  The file was not found.
 655   @retval !NULL                 The path to the file.
 656 **/
 657 CHAR16 *
 658 EFIAPI
 659 ShellFindFilePathEx (
 660   IN CONST CHAR16 *FileName,
 661   IN CONST CHAR16 *FileExtension
 662   );
 663
 664 typedef enum {
 665   TypeFlag  = 0,    ///< A flag that is present or not present only (IE "-a").
 666   TypeValue,        ///< A flag that has some data following it with a space (IE "-a 1").
 667   TypePosition,     ///< Some data that did not follow a parameter (IE "filename.txt").
 668   TypeStart,        ///< A flag that has variable value appended to the end (IE "-ad", "-afd", "-adf", etc...).
 669   TypeDoubleValue,  ///< A flag that has 2 space seperated value data following it (IE "-a 1 2").
 670   TypeMaxValue,     ///< A flag followed by all the command line data before the next flag.
 671   TypeTimeValue,    ///< A flag that has a time value following it (IE "-a -5:00").
 672   TypeMax,
 673 } SHELL_PARAM_TYPE;
 674
 675 typedef struct {
 676   CHAR16             *Name;
 677   SHELL_PARAM_TYPE   Type;
 678 } SHELL_PARAM_ITEM;
 679
 680
 681 /// Helper structure for no parameters (besides -? and -b)
 682 extern SHELL_PARAM_ITEM EmptyParamList[];
 683
 684 /// Helper structure for -sfo only (besides -? and -b)
 685 extern SHELL_PARAM_ITEM SfoParamList[];
 686
 687 /**
 688   Checks the command line arguments passed against the list of valid ones.
 689   Optionally removes NULL values first.
 690
 691   If no initialization is required, then return RETURN_SUCCESS.
 692
 693   @param[in] CheckList          The pointer to list of parameters to check.
 694   @param[out] CheckPackage      The package of checked values.
 695   @param[out] ProblemParam      Optional pointer to pointer to unicode string for
 696                                 the paramater that caused failure.
 697   @param[in] AutoPageBreak      Will automatically set PageBreakEnabled.
 698   @param[in] AlwaysAllowNumbers Will never fail for number based flags.
 699
 700   @retval EFI_SUCCESS           The operation completed sucessfully.
 701   @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.
 702   @retval EFI_INVALID_PARAMETER A parameter was invalid.
 703   @retval EFI_VOLUME_CORRUPTED  The command line was corrupt.
 704   @retval EFI_DEVICE_ERROR      The commands contained 2 opposing arguments.  One
 705                                 of the command line arguments was returned in
 706                                 ProblemParam if provided.
 707   @retval EFI_NOT_FOUND         A argument required a value that was missing.
 708                                 The invalid command line argument was returned in
 709                                 ProblemParam if provided.
 710 **/
 711 EFI_STATUS
 712 EFIAPI
 713 ShellCommandLineParseEx (
 714   IN CONST SHELL_PARAM_ITEM     *CheckList,
 715   OUT LIST_ENTRY                **CheckPackage,
 716   OUT CHAR16                    **ProblemParam OPTIONAL,
 717   IN BOOLEAN                    AutoPageBreak,
 718   IN BOOLEAN                    AlwaysAllowNumbers
 719   );
 720
 721 /// Make it easy to upgrade from older versions of the shell library.
 722 #define ShellCommandLineParse(CheckList,CheckPackage,ProblemParam,AutoPageBreak) ShellCommandLineParseEx(CheckList,CheckPackage,ProblemParam,AutoPageBreak,FALSE)
 723
 724 /**
 725   Frees shell variable list that was returned from ShellCommandLineParse.
 726
 727   This function will free all the memory that was used for the CheckPackage
 728   list of postprocessed shell arguments.
 729
 730   If CheckPackage is NULL, then return.
 731
 732   @param[in] CheckPackage       The list to de-allocate.
 733   **/
 734 VOID
 735 EFIAPI
 736 ShellCommandLineFreeVarList (
 737   IN LIST_ENTRY                 *CheckPackage
 738   );
 739
 740 /**
 741   Checks for presence of a flag parameter.
 742
 743   Flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key.
 744
 745   If CheckPackage is NULL then return FALSE.
 746   If KeyString is NULL then ASSERT().
 747
 748   @param[in] CheckPackage       The package of parsed command line arguments.
 749   @param[in] KeyString          The Key of the command line argument to check for.
 750
 751   @retval TRUE                  The flag is on the command line.
 752   @retval FALSE                 The flag is not on the command line.
 753 **/
 754 BOOLEAN
 755 EFIAPI
 756 ShellCommandLineGetFlag (
 757   IN CONST LIST_ENTRY         * CONST CheckPackage,
 758   IN CONST CHAR16             * CONST KeyString
 759   );
 760
 761 /**
 762   Returns value from command line argument.
 763
 764   Value parameters are in the form of "-<Key> value" or "/<Key> value".
 765
 766   If CheckPackage is NULL, then return NULL.
 767
 768   @param[in] CheckPackage       The package of parsed command line arguments.
 769   @param[in] KeyString          The Key of the command line argument to check for.
 770
 771   @retval NULL                  The flag is not on the command line.
 772   @retval !=NULL                The pointer to unicode string of the value.
 773 **/
 774 CONST CHAR16*
 775 EFIAPI
 776 ShellCommandLineGetValue (
 777   IN CONST LIST_ENTRY              *CheckPackage,
 778   IN CHAR16                        *KeyString
 779   );
 780
 781 /**
 782   Returns raw value from command line argument.
 783
 784   Raw value parameters are in the form of "value" in a specific position in the list.
 785
 786   If CheckPackage is NULL, then return NULL.
 787
 788   @param[in] CheckPackage       The package of parsed command line arguments.
 789   @param[in] Position           The position of the value.
 790
 791   @retval NULL                  The flag is not on the command line.
 792   @retval !=NULL                The pointer to unicode string of the value.
 793 **/
 794 CONST CHAR16*
 795 EFIAPI
 796 ShellCommandLineGetRawValue (
 797   IN CONST LIST_ENTRY              * CONST CheckPackage,
 798   IN UINTN                         Position
 799   );
 800
 801 /**
 802   Returns the number of command line value parameters that were parsed.
 803
 804   This will not include flags.
 805
 806   @param[in] CheckPackage       The package of parsed command line arguments.
 807
 808   @retval (UINTN)-1             No parsing has occurred.
 809   @retval other                 The number of value parameters found.
 810 **/
 811 UINTN
 812 EFIAPI
 813 ShellCommandLineGetCount(
 814   IN CONST LIST_ENTRY              *CheckPackage
 815   );
 816
 817 /**
 818   Determines if a parameter is duplicated.
 819
 820   If Param is not NULL, then it will point to a callee-allocated string buffer
 821   with the parameter value, if a duplicate is found.
 822
 823   If CheckPackage is NULL, then ASSERT.
 824
 825   @param[in] CheckPackage       The package of parsed command line arguments.
 826   @param[out] Param             Upon finding one, a pointer to the duplicated parameter.
 827
 828   @retval EFI_SUCCESS           No parameters were duplicated.
 829   @retval EFI_DEVICE_ERROR      A duplicate was found.
 830   **/
 831 EFI_STATUS
 832 EFIAPI
 833 ShellCommandLineCheckDuplicate (
 834   IN CONST LIST_ENTRY              *CheckPackage,
 835   OUT CHAR16                       **Param
 836   );
 837
 838 /**
 839   This function causes the shell library to initialize itself.  If the shell library
 840   is already initialized it will de-initialize all the current protocol pointers and
 841   re-populate them again.
 842
 843   When the library is used with PcdShellLibAutoInitialize set to true this function
 844   will return EFI_SUCCESS and perform no actions.
 845
 846   This function is intended for internal access for shell commands only.
 847
 848   @retval EFI_SUCCESS   The initialization was complete sucessfully.
 849
 850 **/
 851 EFI_STATUS
 852 EFIAPI
 853 ShellInitialize (
 854   VOID
 855   );
 856
 857 /**
 858   Print at a specific location on the screen.
 859
 860   This function will move the cursor to a given screen location and print the specified string.
 861
 862   If -1 is specified for either the Row or Col the current screen location for BOTH
 863   will be used.
 864
 865   If either Row or Col is out of range for the current console, then ASSERT.
 866   If Format is NULL, then ASSERT.
 867
 868   In addition to the standard %-based flags as supported by UefiLib Print() this supports
 869   the following additional flags:
 870     %N       -   Set output attribute to normal
 871     %H       -   Set output attribute to highlight
 872     %E       -   Set output attribute to error
 873     %B       -   Set output attribute to blue color
 874     %V       -   Set output attribute to green color
 875
 876   Note: The background color is controlled by the shell command cls.
 877
 878   @param[in] Col        The column to print at.
 879   @param[in] Row        The row to print at.
 880   @param[in] Format     The format string.
 881   @param[in] ...        The variable argument list.
 882
 883   @return EFI_SUCCESS           The printing was successful.
 884   @return EFI_DEVICE_ERROR      The console device reported an error.
 885 **/
 886 EFI_STATUS
 887 EFIAPI
 888 ShellPrintEx(
 889   IN INT32                Col OPTIONAL,
 890   IN INT32                Row OPTIONAL,
 891   IN CONST CHAR16         *Format,
 892   ...
 893   );
 894
 895 /**
 896   Print at a specific location on the screen.
 897
 898   This function will move the cursor to a given screen location and print the specified string.
 899
 900   If -1 is specified for either the Row or Col the current screen location for BOTH
 901   will be used.
 902
 903   If either Row or Col is out of range for the current console, then ASSERT.
 904   If Format is NULL, then ASSERT.
 905
 906   In addition to the standard %-based flags as supported by UefiLib Print() this supports
 907   the following additional flags:
 908     %N       -   Set output attribute to normal.
 909     %H       -   Set output attribute to highlight.
 910     %E       -   Set output attribute to error.
 911     %B       -   Set output attribute to blue color.
 912     %V       -   Set output attribute to green color.
 913
 914   Note: The background color is controlled by the shell command cls.
 915
 916   @param[in] Col                The column to print at.
 917   @param[in] Row                The row to print at.
 918   @param[in] Language           The language of the string to retrieve.  If this parameter
 919                                 is NULL, then the current platform language is used.
 920   @param[in] HiiFormatStringId  The format string Id for getting from Hii.
 921   @param[in] HiiFormatHandle    The format string Handle for getting from Hii.
 922   @param[in] ...                The variable argument list.
 923
 924   @return EFI_SUCCESS           The printing was successful.
 925   @return EFI_DEVICE_ERROR      The console device reported an error.
 926 **/
 927 EFI_STATUS
 928 EFIAPI
 929 ShellPrintHiiEx(
 930   IN INT32                Col OPTIONAL,
 931   IN INT32                Row OPTIONAL,
 932   IN CONST CHAR8          *Language OPTIONAL,
 933   IN CONST EFI_STRING_ID  HiiFormatStringId,
 934   IN CONST EFI_HANDLE     HiiFormatHandle,
 935   ...
 936   );
 937
 938 /**
 939   Function to determine if a given filename represents a directory.
 940
 941   If DirName is NULL, then ASSERT.
 942
 943   @param[in] DirName      Path to directory to test.
 944
 945   @retval EFI_SUCCESS     The Path represents a directory.
 946   @retval EFI_NOT_FOUND   The Path does not represent a directory.
 947   @retval other           The path failed to open.
 948 **/
 949 EFI_STATUS
 950 EFIAPI
 951 ShellIsDirectory(
 952   IN CONST CHAR16 *DirName
 953   );
 954
 955 /**
 956   Function to determine if a given filename represents a file.
 957
 958   This will search the CWD only.
 959
 960   If Name is NULL, then ASSERT.
 961
 962   @param[in] Name         Path to file to test.
 963
 964   @retval EFI_SUCCESS     The Path represents a file.
 965   @retval EFI_NOT_FOUND   The Path does not represent a file.
 966   @retval other           The path failed to open.
 967 **/
 968 EFI_STATUS
 969 EFIAPI
 970 ShellIsFile(
 971   IN CONST CHAR16 *Name
 972   );
 973
 974 /**
 975   Function to determine if a given filename represents a file.
 976
 977   This will search the CWD and then the Path.
 978
 979   If Name is NULL, then ASSERT.
 980
 981   @param[in] Name         Path to file to test.
 982
 983   @retval EFI_SUCCESS     The Path represents a file.
 984   @retval EFI_NOT_FOUND   The Path does not represent a file.
 985   @retval other           The path failed to open.
 986 **/
 987 EFI_STATUS
 988 EFIAPI
 989 ShellIsFileInPath(
 990   IN CONST CHAR16 *Name
 991   );
 992
 993 /**
 994   Function to determine whether a string is decimal or hex representation of a number
 995   and return the number converted from the string.
 996
 997   Note: this function cannot be used when (UINTN)(-1), (0xFFFFFFFF) may be a valid
 998   result.  Use ShellConvertStringToUint64 instead.
 999
1000   @param[in] String   String representation of a number.
1001
1002   @return             The unsigned integer result of the conversion.
1003   @retval (UINTN)(-1) An error occured.
1004 **/
1005 UINTN
1006 EFIAPI
1007 ShellStrToUintn(
1008   IN CONST CHAR16 *String
1009   );
1010
1011 /**
1012   Function return the number converted from a hex representation of a number.
1013
1014   Note: this function cannot be used when (UINTN)(-1), (0xFFFFFFFF) may be a valid
1015   result.  Use ShellConvertStringToUint64 instead.
1016
1017   @param[in] String   String representation of a number.
1018
1019   @return             The unsigned integer result of the conversion.
1020   @retval (UINTN)(-1) An error occured.
1021 **/
1022 UINTN
1023 EFIAPI
1024 ShellHexStrToUintn(
1025   IN CONST CHAR16 *String
1026   );
1027
1028 /**
1029   Safely append with automatic string resizing given length of Destination and
1030   desired length of copy from Source.
1031
1032   Append the first D characters of Source to the end of Destination, where D is
1033   the lesser of Count and the StrLen() of Source. If appending those D characters
1034   will fit within Destination (whose Size is given as CurrentSize) and
1035   still leave room for a NULL terminator, then those characters are appended,
1036   starting at the original terminating NULL of Destination, and a new terminating
1037   NULL is appended.
1038
1039   If appending D characters onto Destination will result in a overflow of the size
1040   given in CurrentSize the string will be grown such that the copy can be performed
1041   and CurrentSize will be updated to the new size.
1042
1043   If Source is NULL, there is nothing to append, so return the current buffer in
1044   Destination.
1045
1046   If Destination is NULL, then ASSERT().
1047   If Destination's current length (including NULL terminator) is already more than
1048   CurrentSize, then ASSERT().
1049
1050   @param[in, out] Destination    The String to append onto.
1051   @param[in, out] CurrentSize    On call, the number of bytes in Destination.  On
1052                                  return, possibly the new size (still in bytes).  If NULL,
1053                                  then allocate whatever is needed.
1054   @param[in]      Source         The String to append from.
1055   @param[in]      Count          The maximum number of characters to append.  If 0, then
1056                                  all are appended.
1057
1058   @return                       The Destination after appending the Source.
1059 **/
1060 CHAR16*
1061 EFIAPI
1062 StrnCatGrow (
1063   IN OUT CHAR16           **Destination,
1064   IN OUT UINTN            *CurrentSize,
1065   IN     CONST CHAR16     *Source,
1066   IN     UINTN            Count
1067   );
1068
1069 /**
1070   This is a find and replace function.  Upon successful return the NewString is a copy of
1071   SourceString with each instance of FindTarget replaced with ReplaceWith.
1072
1073   If SourceString and NewString overlap the behavior is undefined.
1074
1075   If the string would grow bigger than NewSize it will halt and return error.
1076
1077   @param[in] SourceString              The string with source buffer.
1078   @param[in, out] NewString            The string with resultant buffer.
1079   @param[in] NewSize                   The size in bytes of NewString.
1080   @param[in] FindTarget                The string to look for.
1081   @param[in] ReplaceWith               The string to replace FindTarget with.
1082   @param[in] SkipPreCarrot             If TRUE will skip a FindTarget that has a '^'
1083                                        immediately before it.
1084   @param[in] ParameterReplacing        If TRUE will add "" around items with spaces.
1085
1086   @retval EFI_INVALID_PARAMETER       SourceString was NULL.
1087   @retval EFI_INVALID_PARAMETER       NewString was NULL.
1088   @retval EFI_INVALID_PARAMETER       FindTarget was NULL.
1089   @retval EFI_INVALID_PARAMETER       ReplaceWith was NULL.
1090   @retval EFI_INVALID_PARAMETER       FindTarget had length < 1.
1091   @retval EFI_INVALID_PARAMETER       SourceString had length < 1.
1092   @retval EFI_BUFFER_TOO_SMALL        NewSize was less than the minimum size to hold
1093                                       the new string (truncation occurred).
1094   @retval EFI_SUCCESS                 The string was successfully copied with replacement.
1095 **/
1096 EFI_STATUS
1097 EFIAPI
1098 ShellCopySearchAndReplace(
1099   IN CHAR16 CONST                     *SourceString,
1100   IN OUT CHAR16                       *NewString,
1101   IN UINTN                            NewSize,
1102   IN CONST CHAR16                     *FindTarget,
1103   IN CONST CHAR16                     *ReplaceWith,
1104   IN CONST BOOLEAN                    SkipPreCarrot,
1105   IN CONST BOOLEAN                    ParameterReplacing
1106   );
1107
1108 /**
1109   Check if a Unicode character is a hexadecimal character.
1110
1111   This internal function checks if a Unicode character is a
1112   numeric character.  The valid hexadecimal characters are
1113   L'0' to L'9', L'a' to L'f', or L'A' to L'F'.
1114
1115
1116   @param  Char  The character to check against.
1117
1118   @retval TRUE  The Char is a hexadecmial character.
1119   @retval FALSE The Char is not a hexadecmial character.
1120
1121 **/
1122 BOOLEAN
1123 EFIAPI
1124 ShellIsHexaDecimalDigitCharacter (
1125   IN      CHAR16                    Char
1126   );
1127
1128 /**
1129   Check if a Unicode character is a decimal character.
1130
1131   This internal function checks if a Unicode character is a
1132   decimal character.  The valid characters are
1133   L'0' to L'9'.
1134
1135
1136   @param  Char  The character to check against.
1137
1138   @retval TRUE  The Char is a hexadecmial character.
1139   @retval FALSE The Char is not a hexadecmial character.
1140
1141 **/
1142 BOOLEAN
1143 EFIAPI
1144 ShellIsDecimalDigitCharacter (
1145   IN      CHAR16                    Char
1146   );
1147
1148 ///
1149 /// What type of answer is requested.
1150 ///
1151 typedef enum {
1152   ShellPromptResponseTypeYesNo,
1153   ShellPromptResponseTypeYesNoCancel,
1154   ShellPromptResponseTypeFreeform,
1155   ShellPromptResponseTypeQuitContinue,
1156   ShellPromptResponseTypeYesNoAllCancel,
1157   ShellPromptResponseTypeEnterContinue,
1158   ShellPromptResponseTypeAnyKeyContinue,
1159   ShellPromptResponseTypeMax
1160 } SHELL_PROMPT_REQUEST_TYPE;
1161
1162 ///
1163 /// What answer was given.
1164 ///
1165 typedef enum {
1166   ShellPromptResponseYes,
1167   ShellPromptResponseNo,
1168   ShellPromptResponseCancel,
1169   ShellPromptResponseQuit,
1170   ShellPromptResponseContinue,
1171   ShellPromptResponseAll,
1172   ShellPromptResponseMax
1173 } SHELL_PROMPT_RESPONSE;
1174
1175 /**
1176   Prompt the user and return the resultant answer to the requestor.
1177
1178   This function will display the requested question on the shell prompt and then
1179   wait for an apropriate answer to be input from the console.
1180
1181   If the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue
1182   or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.
1183
1184   If the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type
1185   CHAR16*.
1186
1187   In either case *Response must be callee freed if Response was not NULL;
1188
1189   @param Type                     What type of question is asked.  This is used to filter the input
1190                                   to prevent invalid answers to question.
1191   @param Prompt                   The pointer to a string prompt used to request input.
1192   @param Response                 The pointer to Response, which will be populated upon return.
1193
1194   @retval EFI_SUCCESS             The operation was successful.
1195   @retval EFI_UNSUPPORTED         The operation is not supported as requested.
1196   @retval EFI_INVALID_PARAMETER   A parameter was invalid.
1197   @return other                   The operation failed.
1198 **/
1199 EFI_STATUS
1200 EFIAPI
1201 ShellPromptForResponse (
1202   IN SHELL_PROMPT_REQUEST_TYPE   Type,
1203   IN CHAR16         *Prompt OPTIONAL,
1204   IN OUT VOID       **Response OPTIONAL
1205   );
1206
1207 /**
1208   Prompt the user and return the resultant answer to the requestor.
1209
1210   This function is the same as ShellPromptForResponse, except that the prompt is
1211   automatically pulled from HII.
1212
1213   @param[in] Type What type of question is asked.  This is used to filter the input
1214                   to prevent invalid answers to question.
1215   @param[in] HiiFormatStringId   The format string Id for getting from Hii.
1216   @param[in] HiiFormatHandle     The format string Handle for getting from Hii.
1217   @param[in, out] Response       The pointer to Response, which will be populated upon return.
1218
1219   @retval EFI_SUCCESS The operation was sucessful.
1220   @return other       The operation failed.
1221
1222   @sa ShellPromptForResponse
1223 **/
1224 EFI_STATUS
1225 EFIAPI
1226 ShellPromptForResponseHii (
1227   IN SHELL_PROMPT_REQUEST_TYPE         Type,
1228   IN CONST EFI_STRING_ID  HiiFormatStringId,
1229   IN CONST EFI_HANDLE     HiiFormatHandle,
1230   IN OUT VOID             **Response
1231   );
1232
1233 /**
1234   Function to determin if an entire string is a valid number.
1235
1236   If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.
1237
1238   @param[in] String       The string to evaluate.
1239   @param[in] ForceHex     TRUE - always assume hex.
1240   @param[in] StopAtSpace  TRUE to halt upon finding a space, FALSE to keep going.
1241
1242   @retval TRUE        It is all numeric (dec/hex) characters.
1243   @retval FALSE       There is a non-numeric character.
1244 **/
1245 BOOLEAN
1246 EFIAPI
1247 ShellIsHexOrDecimalNumber (
1248   IN CONST CHAR16   *String,
1249   IN CONST BOOLEAN  ForceHex,
1250   IN CONST BOOLEAN  StopAtSpace
1251   );
1252
1253 /**
1254   Function to verify and convert a string to its numerical 64 bit representation.
1255
1256   If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.
1257
1258   @param[in] String       The string to evaluate.
1259   @param[out] Value       Upon a successful return the value of the conversion.
1260   @param[in] ForceHex     TRUE - always assume hex.
1261   @param[in] StopAtSpace  TRUE to halt upon finding a space, FALSE to
1262                           process the entire String.
1263
1264   @retval EFI_SUCCESS             The conversion was successful.
1265   @retval EFI_INVALID_PARAMETER   String contained an invalid character.
1266   @retval EFI_NOT_FOUND           String was a number, but Value was NULL.
1267 **/
1268 EFI_STATUS
1269 EFIAPI
1270 ShellConvertStringToUint64(
1271   IN CONST CHAR16   *String,
1272      OUT   UINT64   *Value,
1273   IN CONST BOOLEAN  ForceHex,
1274   IN CONST BOOLEAN  StopAtSpace
1275   );
1276
1277 /**
1278   Function to determine if a given filename exists.
1279
1280   @param[in] Name         Path to test.
1281
1282   @retval EFI_SUCCESS     The Path represents a file.
1283   @retval EFI_NOT_FOUND   The Path does not represent a file.
1284   @retval other           The path failed to open.
1285 **/
1286 EFI_STATUS
1287 EFIAPI
1288 ShellFileExists(
1289   IN CONST CHAR16 *Name
1290   );
1291
1292 /**
1293   Function to read a single line from a SHELL_FILE_HANDLE. The \n is not included in the returned
1294   buffer.  The returned buffer must be callee freed.
1295
1296   If the position upon start is 0, then the Ascii Boolean will be set.  This should be
1297   maintained and not changed for all operations with the same file.
1298
1299   @param[in]       Handle        SHELL_FILE_HANDLE to read from.
1300   @param[in, out]  Ascii         Boolean value for indicating whether the file is
1301                                  Ascii (TRUE) or UCS2 (FALSE).
1302
1303   @return                        The line of text from the file.
1304
1305   @sa ShellFileHandleReadLine
1306 **/
1307 CHAR16*
1308 EFIAPI
1309 ShellFileHandleReturnLine(
1310   IN SHELL_FILE_HANDLE            Handle,
1311   IN OUT BOOLEAN                *Ascii
1312   );
1313
1314 /**
1315   Function to read a single line (up to but not including the \n) from a SHELL_FILE_HANDLE.
1316
1317   If the position upon start is 0, then the Ascii Boolean will be set.  This should be
1318   maintained and not changed for all operations with the same file.
1319
1320   @param[in]       Handle        SHELL_FILE_HANDLE to read from.
1321   @param[in, out]  Buffer        The pointer to buffer to read into.
1322   @param[in, out]  Size          The pointer to number of bytes in Buffer.
1323   @param[in]       Truncate      If the buffer is large enough, this has no effect.
1324                                  If the buffer is is too small and Truncate is TRUE,
1325                                  the line will be truncated.
1326                                  If the buffer is is too small and Truncate is FALSE,
1327                                  then no read will occur.
1328
1329   @param[in, out]  Ascii         Boolean value for indicating whether the file is
1330                                  Ascii (TRUE) or UCS2 (FALSE).
1331
1332   @retval EFI_SUCCESS           The operation was successful.  The line is stored in
1333                                 Buffer.
1334   @retval EFI_INVALID_PARAMETER Handle was NULL.
1335   @retval EFI_INVALID_PARAMETER Size was NULL.
1336   @retval EFI_BUFFER_TOO_SMALL  Size was not large enough to store the line.
1337                                 Size was updated to the minimum space required.
1338 **/
1339 EFI_STATUS
1340 EFIAPI
1341 ShellFileHandleReadLine(
1342   IN SHELL_FILE_HANDLE          Handle,
1343   IN OUT CHAR16                 *Buffer,
1344   IN OUT UINTN                  *Size,
1345   IN BOOLEAN                    Truncate,
1346   IN OUT BOOLEAN                *Ascii
1347   );
1348
1349 /**
1350   Function to delete a file by name
1351
1352   @param[in]       FileName       Pointer to file name to delete.
1353
1354   @retval EFI_SUCCESS             the file was deleted sucessfully
1355   @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not
1356                                   deleted
1357   @retval EFI_INVALID_PARAMETER   One of the parameters has an invalid value.
1358   @retval EFI_NOT_FOUND           The specified file could not be found on the
1359                                   device or the file system could not be found
1360                                   on the device.
1361   @retval EFI_NO_MEDIA            The device has no medium.
1362   @retval EFI_MEDIA_CHANGED       The device has a different medium in it or the
1363                                   medium is no longer supported.
1364   @retval EFI_DEVICE_ERROR        The device reported an error.
1365   @retval EFI_VOLUME_CORRUPTED    The file system structures are corrupted.
1366   @retval EFI_WRITE_PROTECTED     The file or medium is write protected.
1367   @retval EFI_ACCESS_DENIED       The file was opened read only.
1368   @retval EFI_OUT_OF_RESOURCES    Not enough resources were available to open the
1369                                   file.
1370   @retval other                   The file failed to open
1371 **/
1372 EFI_STATUS
1373 EFIAPI
1374 ShellDeleteFileByName(
1375   IN CONST CHAR16               *FileName
1376   );
1377
1378 /**
1379   Function to print help file / man page content in the spec from the UEFI Shell protocol GetHelpText function.
1380
1381   @param[in] CommandToGetHelpOn  Pointer to a string containing the command name of help file to be printed.
1382   @param[in] SectionToGetHelpOn  Pointer to the section specifier(s).
1383   @param[in] PrintCommandText    If TRUE, prints the command followed by the help content, otherwise prints
1384                                  the help content only.
1385   @retval EFI_DEVICE_ERROR       The help data format was incorrect.
1386   @retval EFI_NOT_FOUND          The help data could not be found.
1387   @retval EFI_SUCCESS            The operation was successful.
1388 **/
1389 EFI_STATUS
1390 EFIAPI
1391 ShellPrintHelp (
1392   IN CONST CHAR16     *CommandToGetHelpOn,
1393   IN CONST CHAR16     *SectionToGetHelpOn,
1394   IN BOOLEAN          PrintCommandText
1395   );
1396
1397 #endif // __SHELL_LIB__