ShellPkg/Application/Shell/ShellParametersProtocol.h

   1 /** @file
   2   Member functions of EFI_SHELL_PARAMETERS_PROTOCOL and functions for creation,
   3   manipulation, and initialization of EFI_SHELL_PARAMETERS_PROTOCOL.
   4
   5   Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef _SHELL_PARAMETERS_PROTOCOL_PROVIDER_HEADER_
  11 #define _SHELL_PARAMETERS_PROTOCOL_PROVIDER_HEADER_
  12
  13 #include "Shell.h"
  14
  15 typedef enum {
  16   Internal_Command,
  17   Script_File_Name,
  18   Efi_Application,
  19   File_Sys_Change,
  20   Unknown_Invalid
  21 } SHELL_OPERATION_TYPES;
  22
  23 /**
  24   creates a new EFI_SHELL_PARAMETERS_PROTOCOL instance and populates it and then
  25   installs it on our handle and if there is an existing version of the protocol
  26   that one is cached for removal later.
  27
  28   @param[in, out] NewShellParameters on a successful return, a pointer to pointer
  29                                      to the newly installed interface.
  30   @param[in, out] RootShellInstance  on a successful return, pointer to boolean.
  31                                      TRUE if this is the root shell instance.
  32
  33   @retval EFI_SUCCESS               the operation completed successfully.
  34   @return other                     the operation failed.
  35   @sa ReinstallProtocolInterface
  36   @sa InstallProtocolInterface
  37   @sa ParseCommandLineToArgs
  38 **/
  39 EFI_STATUS
  40 CreatePopulateInstallShellParametersProtocol (
  41   IN OUT EFI_SHELL_PARAMETERS_PROTOCOL  **NewShellParameters,
  42   IN OUT BOOLEAN                        *RootShellInstance
  43   );
  44
  45 /**
  46   frees all memory used by createion and installation of shell parameters protocol
  47   and if there was an old version installed it will restore that one.
  48
  49   @param NewShellParameters the interface of EFI_SHELL_PARAMETERS_PROTOCOL that is
  50   being cleaned up.
  51
  52   @retval EFI_SUCCESS     the cleanup was successful
  53   @return other           the cleanup failed
  54   @sa ReinstallProtocolInterface
  55   @sa UninstallProtocolInterface
  56 **/
  57 EFI_STATUS
  58 CleanUpShellParametersProtocol (
  59   IN OUT EFI_SHELL_PARAMETERS_PROTOCOL  *NewShellParameters
  60   );
  61
  62 /**
  63   Funcion will replace the current Argc and Argv in the ShellParameters protocol
  64   structure by parsing NewCommandLine.  The current values are returned to the
  65   user.
  66
  67   @param[in, out] ShellParameters       pointer to parameter structure to modify
  68   @param[in] NewCommandLine             the new command line to parse and use
  69   @param[in] Type                       the type of operation.
  70   @param[out] OldArgv                   pointer to old list of parameters
  71   @param[out] OldArgc                   pointer to old number of items in Argv list
  72
  73   @retval   EFI_SUCCESS                 operation was sucessful, Argv and Argc are valid
  74   @retval   EFI_OUT_OF_RESOURCES        a memory allocation failed.
  75 **/
  76 EFI_STATUS
  77 UpdateArgcArgv(
  78   IN OUT EFI_SHELL_PARAMETERS_PROTOCOL  *ShellParameters,
  79   IN CONST CHAR16                       *NewCommandLine,
  80   IN SHELL_OPERATION_TYPES              Type,
  81   OUT CHAR16                            ***OldArgv,
  82   OUT UINTN                             *OldArgc
  83   );
  84
  85 /**
  86   Funcion will replace the current Argc and Argv in the ShellParameters protocol
  87   structure with Argv and Argc.  The current values are de-allocated and the
  88   OldArgv must not be deallocated by the caller.
  89
  90   @param[in, out] ShellParameters       pointer to parameter structure to modify
  91   @param[in] OldArgv                    pointer to old list of parameters
  92   @param[in] OldArgc                    pointer to old number of items in Argv list
  93 **/
  94 VOID
  95 RestoreArgcArgv(
  96   IN OUT EFI_SHELL_PARAMETERS_PROTOCOL  *ShellParameters,
  97   IN CHAR16                             ***OldArgv,
  98   IN UINTN                              *OldArgc
  99   );
 100
 101 typedef struct {
 102   EFI_SIMPLE_TEXT_INPUT_PROTOCOL        *ConIn;
 103   EFI_HANDLE                            ConInHandle;
 104   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL       *ConOut;
 105   EFI_HANDLE                            ConOutHandle;
 106   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL       *ErrOut;
 107   EFI_HANDLE                            ErrOutHandle;
 108 } SYSTEM_TABLE_INFO;
 109
 110 /**
 111   Funcion will replace the current StdIn and StdOut in the ShellParameters protocol
 112   structure by parsing NewCommandLine.  The current values are returned to the
 113   user.
 114
 115   This will also update the system table.
 116
 117   @param[in, out] ShellParameters        Pointer to parameter structure to modify.
 118   @param[in] NewCommandLine              The new command line to parse and use.
 119   @param[out] OldStdIn                   Pointer to old StdIn.
 120   @param[out] OldStdOut                  Pointer to old StdOut.
 121   @param[out] OldStdErr                  Pointer to old StdErr.
 122   @param[out] SystemTableInfo            Pointer to old system table information.
 123
 124   @retval   EFI_SUCCESS                 Operation was sucessful, Argv and Argc are valid.
 125   @retval   EFI_OUT_OF_RESOURCES        A memory allocation failed.
 126 **/
 127 EFI_STATUS
 128 UpdateStdInStdOutStdErr(
 129   IN OUT EFI_SHELL_PARAMETERS_PROTOCOL  *ShellParameters,
 130   IN CHAR16                             *NewCommandLine,
 131   OUT SHELL_FILE_HANDLE                 *OldStdIn,
 132   OUT SHELL_FILE_HANDLE                 *OldStdOut,
 133   OUT SHELL_FILE_HANDLE                 *OldStdErr,
 134   OUT SYSTEM_TABLE_INFO                 *SystemTableInfo
 135   );
 136
 137 /**
 138   Funcion will replace the current StdIn and StdOut in the ShellParameters protocol
 139   structure with StdIn and StdOut.  The current values are de-allocated.
 140
 141   @param[in, out] ShellParameters      Pointer to parameter structure to modify.
 142   @param[in] OldStdIn                  Pointer to old StdIn.
 143   @param[in] OldStdOut                 Pointer to old StdOut.
 144   @param[in] OldStdErr                 Pointer to old StdErr.
 145   @param[in] SystemTableInfo           Pointer to old system table information.
 146 **/
 147 EFI_STATUS
 148 RestoreStdInStdOutStdErr (
 149   IN OUT EFI_SHELL_PARAMETERS_PROTOCOL  *ShellParameters,
 150   IN  SHELL_FILE_HANDLE                 *OldStdIn,
 151   IN  SHELL_FILE_HANDLE                 *OldStdOut,
 152   IN  SHELL_FILE_HANDLE                 *OldStdErr,
 153   IN  SYSTEM_TABLE_INFO                 *SystemTableInfo
 154   );
 155
 156 /**
 157   function to populate Argc and Argv.
 158
 159   This function parses the CommandLine and divides it into standard C style Argc/Argv
 160   parameters for inclusion in EFI_SHELL_PARAMETERS_PROTOCOL.  this supports space
 161   delimited and quote surrounded parameter definition.
 162
 163   @param[in] CommandLine          String of command line to parse
 164   @param[in] StripQuotation       if TRUE then strip the quotation marks surrounding
 165                                   the parameters.
 166   @param[in, out] Argv            pointer to array of strings; one for each parameter
 167   @param[in, out] Argc            pointer to number of strings in Argv array
 168
 169   @return EFI_SUCCESS           the operation was sucessful
 170   @return EFI_OUT_OF_RESOURCES  a memory allocation failed.
 171 **/
 172 EFI_STATUS
 173 ParseCommandLineToArgs(
 174   IN CONST CHAR16 *CommandLine,
 175   IN BOOLEAN      StripQuotation,
 176   IN OUT CHAR16   ***Argv,
 177   IN OUT UINTN    *Argc
 178   );
 179
 180 /**
 181   return the next parameter from a command line string;
 182
 183   This function moves the next parameter from Walker into TempParameter and moves
 184   Walker up past that parameter for recursive calling.  When the final parameter
 185   is moved *Walker will be set to NULL;
 186
 187   Temp Parameter must be large enough to hold the parameter before calling this
 188   function.
 189
 190   @param[in, out] Walker          pointer to string of command line.  Adjusted to
 191                                   reminaing command line on return
 192   @param[in, out] TempParameter   pointer to string of command line item extracted.
 193   @param[in]      Length          Length of (*TempParameter) in bytes
 194   @param[in]      StripQuotation  if TRUE then strip the quotation marks surrounding
 195                                   the parameters.
 196
 197   @return   EFI_INALID_PARAMETER  A required parameter was NULL or pointed to a NULL or empty string.
 198   @return   EFI_NOT_FOUND         A closing " could not be found on the specified string
 199 **/
 200 EFI_STATUS
 201 GetNextParameter(
 202   IN OUT CHAR16   **Walker,
 203   IN OUT CHAR16   **TempParameter,
 204   IN CONST UINTN  Length,
 205   IN BOOLEAN      StripQuotation
 206   );
 207
 208 #endif //_SHELL_PARAMETERS_PROTOCOL_PROVIDER_HEADER_
 209