ShellPkg: Document ParseCommandLineToArgs returns EFI_INVALID_PARAMETER

[mirror_edk2.git] / ShellPkg / Application / Shell / ShellParametersProtocol.h

/** @file\r
  Member functions of EFI_SHELL_PARAMETERS_PROTOCOL and functions for creation,\r
  manipulation, and initialization of EFI_SHELL_PARAMETERS_PROTOCOL.\r
\r
  Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _SHELL_PARAMETERS_PROTOCOL_PROVIDER_HEADER_\r
#define _SHELL_PARAMETERS_PROTOCOL_PROVIDER_HEADER_\r
\r
#include "Shell.h"\r
\r
typedef enum {\r
  Internal_Command,\r
  Script_File_Name,\r
  Efi_Application,\r
  File_Sys_Change,\r
  Unknown_Invalid\r
} SHELL_OPERATION_TYPES;\r
\r
/**\r
  creates a new EFI_SHELL_PARAMETERS_PROTOCOL instance and populates it and then\r
  installs it on our handle and if there is an existing version of the protocol\r
  that one is cached for removal later.\r
\r
  @param[in, out] NewShellParameters on a successful return, a pointer to pointer\r
                                     to the newly installed interface.\r
  @param[in, out] RootShellInstance  on a successful return, pointer to boolean.\r
                                     TRUE if this is the root shell instance.\r
\r
  @retval EFI_SUCCESS               the operation completed successfully.\r
  @return other                     the operation failed.\r
  @sa ReinstallProtocolInterface\r
  @sa InstallProtocolInterface\r
  @sa ParseCommandLineToArgs\r
**/\r
EFI_STATUS\r
CreatePopulateInstallShellParametersProtocol (\r
  IN OUT EFI_SHELL_PARAMETERS_PROTOCOL  **NewShellParameters,\r
  IN OUT BOOLEAN                        *RootShellInstance\r
  );\r
\r
/**\r
  frees all memory used by creation and installation of shell parameters protocol\r
  and if there was an old version installed it will restore that one.\r
\r
  @param NewShellParameters the interface of EFI_SHELL_PARAMETERS_PROTOCOL that is\r
  being cleaned up.\r
\r
  @retval EFI_SUCCESS     the cleanup was successful\r
  @return other           the cleanup failed\r
  @sa ReinstallProtocolInterface\r
  @sa UninstallProtocolInterface\r
**/\r
EFI_STATUS\r
CleanUpShellParametersProtocol (\r
  IN OUT EFI_SHELL_PARAMETERS_PROTOCOL  *NewShellParameters\r
  );\r
\r
/**\r
  Function will replace the current Argc and Argv in the ShellParameters protocol\r
  structure by parsing NewCommandLine.  The current values are returned to the\r
  user.\r
\r
  @param[in, out] ShellParameters       pointer to parameter structure to modify\r
  @param[in] NewCommandLine             the new command line to parse and use\r
  @param[in] Type                       the type of operation.\r
  @param[out] OldArgv                   pointer to old list of parameters\r
  @param[out] OldArgc                   pointer to old number of items in Argv list\r
\r
  @retval   EFI_SUCCESS                 operation was successful, Argv and Argc are valid\r
  @retval   EFI_OUT_OF_RESOURCES        a memory allocation failed.\r
**/\r
EFI_STATUS\r
UpdateArgcArgv(\r
  IN OUT EFI_SHELL_PARAMETERS_PROTOCOL  *ShellParameters,\r
  IN CONST CHAR16                       *NewCommandLine,\r
  IN SHELL_OPERATION_TYPES              Type,\r
  OUT CHAR16                            ***OldArgv,\r
  OUT UINTN                             *OldArgc\r
  );\r
\r
/**\r
  Function will replace the current Argc and Argv in the ShellParameters protocol\r
  structure with Argv and Argc.  The current values are de-allocated and the\r
  OldArgv must not be deallocated by the caller.\r
\r
  @param[in, out] ShellParameters       pointer to parameter structure to modify\r
  @param[in] OldArgv                    pointer to old list of parameters\r
  @param[in] OldArgc                    pointer to old number of items in Argv list\r
**/\r
VOID\r
RestoreArgcArgv(\r
  IN OUT EFI_SHELL_PARAMETERS_PROTOCOL  *ShellParameters,\r
  IN CHAR16                             ***OldArgv,\r
  IN UINTN                              *OldArgc\r
  );\r
\r
typedef struct {\r
  EFI_SIMPLE_TEXT_INPUT_PROTOCOL        *ConIn;\r
  EFI_HANDLE                            ConInHandle;\r
  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL       *ConOut;\r
  EFI_HANDLE                            ConOutHandle;\r
  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL       *ErrOut;\r
  EFI_HANDLE                            ErrOutHandle;\r
} SYSTEM_TABLE_INFO;\r
\r
/**\r
  Function will replace the current StdIn and StdOut in the ShellParameters protocol\r
  structure by parsing NewCommandLine.  The current values are returned to the\r
  user.\r
\r
  This will also update the system table.\r
\r
  @param[in, out] ShellParameters        Pointer to parameter structure to modify.\r
  @param[in] NewCommandLine              The new command line to parse and use.\r
  @param[out] OldStdIn                   Pointer to old StdIn.\r
  @param[out] OldStdOut                  Pointer to old StdOut.\r
  @param[out] OldStdErr                  Pointer to old StdErr.\r
  @param[out] SystemTableInfo            Pointer to old system table information.\r
\r
  @retval   EFI_SUCCESS                 Operation was successful, Argv and Argc are valid.\r
  @retval   EFI_OUT_OF_RESOURCES        A memory allocation failed.\r
**/\r
EFI_STATUS\r
UpdateStdInStdOutStdErr(\r
  IN OUT EFI_SHELL_PARAMETERS_PROTOCOL  *ShellParameters,\r
  IN CHAR16                             *NewCommandLine,\r
  OUT SHELL_FILE_HANDLE                 *OldStdIn,\r
  OUT SHELL_FILE_HANDLE                 *OldStdOut,\r
  OUT SHELL_FILE_HANDLE                 *OldStdErr,\r
  OUT SYSTEM_TABLE_INFO                 *SystemTableInfo\r
  );\r
\r
/**\r
  Function will replace the current StdIn and StdOut in the ShellParameters protocol\r
  structure with StdIn and StdOut.  The current values are de-allocated.\r
\r
  @param[in, out] ShellParameters      Pointer to parameter structure to modify.\r
  @param[in] OldStdIn                  Pointer to old StdIn.\r
  @param[in] OldStdOut                 Pointer to old StdOut.\r
  @param[in] OldStdErr                 Pointer to old StdErr.\r
  @param[in] SystemTableInfo           Pointer to old system table information.\r
**/\r
EFI_STATUS\r
RestoreStdInStdOutStdErr (\r
  IN OUT EFI_SHELL_PARAMETERS_PROTOCOL  *ShellParameters,\r
  IN  SHELL_FILE_HANDLE                 *OldStdIn,\r
  IN  SHELL_FILE_HANDLE                 *OldStdOut,\r
  IN  SHELL_FILE_HANDLE                 *OldStdErr,\r
  IN  SYSTEM_TABLE_INFO                 *SystemTableInfo\r
  );\r
\r
/**\r
  function to populate Argc and Argv.\r
\r
  This function parses the CommandLine and divides it into standard C style Argc/Argv\r
  parameters for inclusion in EFI_SHELL_PARAMETERS_PROTOCOL.  this supports space\r
  delimited and quote surrounded parameter definition.\r
\r
  @param[in] CommandLine          String of command line to parse\r
  @param[in] StripQuotation       if TRUE then strip the quotation marks surrounding\r
                                  the parameters.\r
  @param[in, out] Argv            pointer to array of strings; one for each parameter\r
  @param[in, out] Argc            pointer to number of strings in Argv array\r
\r
  @return EFI_SUCCESS           the operation was successful\r
  @return EFI_INVALID_PARAMETER some parameters are invalid\r
  @return EFI_OUT_OF_RESOURCES  a memory allocation failed.\r
**/\r
EFI_STATUS\r
ParseCommandLineToArgs(\r
  IN CONST CHAR16 *CommandLine,\r
  IN BOOLEAN      StripQuotation,\r
  IN OUT CHAR16   ***Argv,\r
  IN OUT UINTN    *Argc\r
  );\r
\r
/**\r
  return the next parameter from a command line string;\r
\r
  This function moves the next parameter from Walker into TempParameter and moves\r
  Walker up past that parameter for recursive calling.  When the final parameter\r
  is moved *Walker will be set to NULL;\r
\r
  Temp Parameter must be large enough to hold the parameter before calling this\r
  function.\r
\r
  @param[in, out] Walker          pointer to string of command line.  Adjusted to\r
                                  remaining command line on return\r
  @param[in, out] TempParameter   pointer to string of command line item extracted.\r
  @param[in]      Length          Length of (*TempParameter) in bytes\r
  @param[in]      StripQuotation  if TRUE then strip the quotation marks surrounding\r
                                  the parameters.\r
\r
  @return   EFI_INVALID_PARAMETER A required parameter was NULL or pointed to a NULL or empty string.\r
  @return   EFI_NOT_FOUND         A closing " could not be found on the specified string\r
**/\r
EFI_STATUS\r
GetNextParameter(\r
  IN OUT CHAR16   **Walker,\r
  IN OUT CHAR16   **TempParameter,\r
  IN CONST UINTN  Length,\r
  IN BOOLEAN      StripQuotation\r
  );\r
\r
#endif //_SHELL_PARAMETERS_PROTOCOL_PROVIDER_HEADER_\r
\r