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

/** @file\r
  function definitions for internal to shell functions.\r
\r
  (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>\r
  Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _SHELL_INTERNAL_HEADER_\r
#define _SHELL_INTERNAL_HEADER_\r
\r
#include <Uefi.h>\r
#include <ShellBase.h>\r
\r
#include <Guid/ShellVariableGuid.h>\r
#include <Guid/ShellAliasGuid.h>\r
\r
#include <Protocol/LoadedImage.h>\r
#include <Protocol/SimpleTextOut.h>\r
#include <Protocol/EfiShell.h>\r
#include <Protocol/EfiShellInterface.h>\r
#include <Protocol/EfiShellEnvironment2.h>\r
#include <Protocol/EfiShellParameters.h>\r
#include <Protocol/BlockIo.h>\r
#include <Protocol/HiiPackageList.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/UefiApplicationEntryPoint.h>\r
#include <Library/UefiLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/ShellCommandLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/ShellLib.h>\r
#include <Library/SortLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/HandleParsingLib.h>\r
#include <Library/FileHandleLib.h>\r
#include <Library/UefiHiiServicesLib.h>\r
\r
#include "ShellParametersProtocol.h"\r
#include "ShellProtocol.h"\r
#include "ShellEnvVar.h"\r
#include "ConsoleLogger.h"\r
#include "ShellManParser.h"\r
#include "ConsoleWrappers.h"\r
#include "FileHandleWrappers.h"\r
\r
extern CONST CHAR16 mNoNestingEnvVarName[];\r
extern CONST CHAR16 mNoNestingTrue[];\r
extern CONST CHAR16 mNoNestingFalse[];\r
\r
typedef struct {\r
  LIST_ENTRY        Link;           ///< Standard linked list handler.\r
  SHELL_FILE_HANDLE *SplitStdOut;   ///< ConsoleOut for use in the split.\r
  SHELL_FILE_HANDLE *SplitStdIn;    ///< ConsoleIn for use in the split.\r
} SPLIT_LIST;\r
\r
typedef struct {\r
  UINT32  Startup:1;      ///< Was "-startup"       found on command line.\r
  UINT32  NoStartup:1;    ///< Was "-nostartup"     found on command line.\r
  UINT32  NoConsoleOut:1; ///< Was "-noconsoleout"  found on command line.\r
  UINT32  NoConsoleIn:1;  ///< Was "-noconsolein"   found on command line.\r
  UINT32  NoInterrupt:1;  ///< Was "-nointerrupt"   found on command line.\r
  UINT32  NoMap:1;        ///< Was "-nomap"         found on command line.\r
  UINT32  NoVersion:1;    ///< Was "-noversion"     found on command line.\r
  UINT32  Delay:1;        ///< Was "-delay[:n]      found on command line\r
  UINT32  Exit:1;         ///< Was "-_exit"         found on command line\r
  UINT32  NoNest:1;       ///< Was "-nonest"        found on command line\r
  UINT32  Reserved:7;     ///< Extra bits\r
} SHELL_BITS;\r
\r
typedef union {\r
  SHELL_BITS  Bits;\r
  UINT16      AllBits;\r
} SHELL_BIT_UNION;\r
\r
typedef struct {\r
  SHELL_BIT_UNION BitUnion;\r
  UINTN           Delay;          ///< Seconds of delay default:5.\r
  CHAR16          *FileName;      ///< Filename to run upon successful initialization.\r
  CHAR16          *FileOptions;   ///< Options to pass to FileName.\r
} SHELL_INIT_SETTINGS;\r
\r
typedef struct {\r
  BUFFER_LIST                 CommandHistory;\r
  UINTN                       VisibleRowNumber;\r
  UINTN                       OriginalVisibleRowNumber;\r
  BOOLEAN                     InsertMode;           ///< Is the current typing mode insert (FALSE = overwrite).\r
} SHELL_VIEWING_SETTINGS;\r
\r
typedef struct {\r
  EFI_SHELL_PARAMETERS_PROTOCOL *NewShellParametersProtocol;\r
  EFI_SHELL_PROTOCOL            *NewEfiShellProtocol;\r
  BOOLEAN                       PageBreakEnabled;\r
  BOOLEAN                       RootShellInstance;\r
  SHELL_INIT_SETTINGS           ShellInitSettings;\r
  BUFFER_LIST                   BufferToFreeList;     ///< List of buffers that were returned to the user to free.\r
  SHELL_VIEWING_SETTINGS        ViewingSettings;\r
  EFI_HII_HANDLE                HiiHandle;            ///< Handle from HiiLib.\r
  UINTN                         LogScreenCount;       ///< How many screens of log information to save.\r
  EFI_EVENT                     UserBreakTimer;       ///< Timer event for polling for CTRL-C.\r
  EFI_DEVICE_PATH_PROTOCOL      *ImageDevPath;        ///< DevicePath for ourselves.\r
  EFI_DEVICE_PATH_PROTOCOL      *FileDevPath;         ///< DevicePath for ourselves.\r
  CONSOLE_LOGGER_PRIVATE_DATA   *ConsoleInfo;         ///< Pointer for ConsoleInformation.\r
  EFI_SHELL_PARAMETERS_PROTOCOL *OldShellParameters;  ///< old shell parameters to reinstall upon exiting.\r
  SHELL_PROTOCOL_HANDLE_LIST    OldShellList;         ///< List of other instances to reinstall when closing.\r
  SPLIT_LIST                    SplitList;            ///< List of Splits in FILO stack.\r
  VOID                          *CtrlCNotifyHandle1;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
  VOID                          *CtrlCNotifyHandle2;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
  VOID                          *CtrlCNotifyHandle3;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
  VOID                          *CtrlCNotifyHandle4;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
  VOID                          *CtrlSNotifyHandle1;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
  VOID                          *CtrlSNotifyHandle2;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
  VOID                          *CtrlSNotifyHandle3;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
  VOID                          *CtrlSNotifyHandle4;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
  BOOLEAN                       HaltOutput;           ///< TRUE to start a CTRL-S halt.\r
} SHELL_INFO;\r
\r
#pragma pack(1)\r
///\r
/// HII specific Vendor Device Path definition.\r
///\r
typedef struct {\r
  VENDOR_DEVICE_PATH             VendorDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL       End;\r
} SHELL_MAN_HII_VENDOR_DEVICE_PATH;\r
#pragma pack()\r
\r
extern SHELL_INFO ShellInfoObject;\r
\r
/**\r
  Converts the command line to it's post-processed form.  this replaces variables and alias' per UEFI Shell spec.\r
\r
  @param[in,out] CmdLine        pointer to the command line to update\r
\r
  @retval EFI_SUCCESS           The operation was successful\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
  @return                       some other error occurred\r
**/\r
EFI_STATUS\r
ProcessCommandLineToFinal(\r
  IN OUT CHAR16 **CmdLine\r
  );\r
\r
/**\r
  Function to update the shell variable "lasterror".\r
\r
  @param[in] ErrorCode      the error code to put into lasterror\r
**/\r
EFI_STATUS\r
SetLastError(\r
  IN CONST SHELL_STATUS   ErrorCode\r
  );\r
\r
/**\r
  Sets all the alias' that were registered with the ShellCommandLib library.\r
\r
  @retval EFI_SUCCESS           all init commands were run successfully.\r
**/\r
EFI_STATUS\r
SetBuiltInAlias(\r
  VOID\r
  );\r
\r
/**\r
  This function will populate the 2 device path protocol parameters based on the\r
  global gImageHandle.  the DevPath will point to the device path for the handle that has\r
  loaded image protocol installed on it.  the FilePath will point to the device path\r
  for the file that was loaded.\r
\r
  @param[in, out] DevPath       on a successful return the device path to the loaded image\r
  @param[in, out] FilePath      on a successful return the device path to the file\r
\r
  @retval EFI_SUCCESS           the 2 device paths were successfully returned.\r
  @return other                 a error from gBS->HandleProtocol\r
\r
  @sa HandleProtocol\r
**/\r
EFI_STATUS\r
GetDevicePathsForImageAndFile (\r
  IN OUT EFI_DEVICE_PATH_PROTOCOL **DevPath,\r
  IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath\r
  );\r
\r
/**\r
  Process all Uefi Shell 2.0 command line options.\r
\r
  see Uefi Shell 2.0 section 3.2 for full details.\r
\r
  the command line should resemble the following:\r
\r
  shell.efi [ShellOpt-options] [options] [file-name [file-name-options]]\r
\r
  ShellOpt options  Options which control the initialization behavior of the shell.\r
                    These options are read from the EFI global variable "ShellOpt"\r
                    and are processed before options or file-name.\r
\r
  options           Options which control the initialization behavior of the shell.\r
\r
  file-name         The name of a UEFI shell application or script to be executed\r
                    after initialization is complete. By default, if file-name is\r
                    specified, then -nostartup is implied. Scripts are not supported\r
                    by level 0.\r
\r
  file-nameoptions  The command-line options that are passed to file-name when it\r
                    is invoked.\r
\r
  This will initialize the ShellInitSettings global variable.\r
\r
  @retval EFI_SUCCESS           the variable is initialized.\r
**/\r
EFI_STATUS\r
ProcessCommandLine(\r
  VOID\r
  );\r
\r
/**\r
  Handles all interaction with the default startup script.\r
\r
  this will check that the correct command line parameters were passed, handle the delay, and then start running the script.\r
\r
  @param[in] ImagePath          The path to the image for shell.  The first place to look for the startup script.\r
  @param[in] FilePath           The path to the file for shell.  The second place to look for the startup script.\r
\r
  @retval EFI_SUCCESS           The variable is initialized.\r
**/\r
EFI_STATUS\r
DoStartupScript(\r
  IN EFI_DEVICE_PATH_PROTOCOL *ImagePath,\r
  IN EFI_DEVICE_PATH_PROTOCOL *FilePath\r
  );\r
\r
/**\r
  Function to perform the shell prompt looping.  It will do a single prompt,\r
  dispatch the result, and then return.  It is expected that the caller will\r
  call this function in a loop many times.\r
\r
  @retval EFI_SUCCESS\r
  @retval RETURN_ABORTED\r
**/\r
EFI_STATUS\r
DoShellPrompt (\r
  VOID\r
  );\r
\r
/**\r
  Add a buffer to the Buffer To Free List for safely returning buffers to other\r
  places without risking letting them modify internal shell information.\r
\r
  @param Buffer   Something to pass to FreePool when the shell is exiting.\r
**/\r
VOID*\r
AddBufferToFreeList(\r
  VOID *Buffer\r
  );\r
\r
/**\r
  Add a buffer to the Command History List.\r
\r
  @param Buffer[in]     The line buffer to add.\r
**/\r
VOID\r
AddLineToCommandHistory(\r
  IN CONST CHAR16 *Buffer\r
  );\r
\r
/**\r
  Function will process and run a command line.\r
\r
  This will determine if the command line represents an internal shell command or dispatch an external application.\r
\r
  @param[in] CmdLine  the command line to parse\r
\r
  @retval EFI_SUCCESS     the command was completed\r
  @retval EFI_ABORTED     the command's operation was aborted\r
**/\r
EFI_STATUS\r
RunCommand(\r
  IN CONST CHAR16   *CmdLine\r
  );\r
\r
/**\r
  Function will process and run a command line.\r
\r
  This will determine if the command line represents an internal shell \r
  command or dispatch an external application.\r
\r
  @param[in] CmdLine      The command line to parse.\r
  @param[out] CommandStatus   The status from the command line.\r
\r
  @retval EFI_SUCCESS     The command was completed.\r
  @retval EFI_ABORTED     The command's operation was aborted.\r
**/\r
EFI_STATUS\r
RunShellCommand(\r
  IN CONST CHAR16   *CmdLine,\r
  OUT EFI_STATUS    *CommandStatus\r
  );\r
\r
/**\r
  Function determines if the CommandName COULD be a valid command.  It does not determine whether\r
  this is a valid command.  It only checks for invalid characters.\r
\r
  @param[in] CommandName    The name to check\r
\r
  @retval TRUE              CommandName could be a command name\r
  @retval FALSE             CommandName could not be a valid command name\r
**/\r
BOOLEAN\r
IsValidCommandName(\r
  IN CONST CHAR16     *CommandName\r
  );\r
\r
/**\r
  Function to process a NSH script file via SHELL_FILE_HANDLE.\r
\r
  @param[in] Handle             The handle to the already opened file.\r
  @param[in] Name               The name of the script file.\r
\r
  @retval EFI_SUCCESS           the script completed successfully\r
**/\r
EFI_STATUS\r
RunScriptFileHandle (\r
  IN SHELL_FILE_HANDLE  Handle,\r
  IN CONST CHAR16       *Name\r
  );\r
\r
/**\r
  Function to process a NSH script file.\r
\r
  @param[in] ScriptPath         Pointer to the script file name (including file system path).\r
  @param[in] Handle             the handle of the script file already opened.\r
  @param[in] CmdLine            the command line to run.\r
  @param[in] ParamProtocol      the shell parameters protocol pointer\r
\r
  @retval EFI_SUCCESS           the script completed successfully\r
**/\r
EFI_STATUS\r
RunScriptFile (\r
  IN CONST CHAR16                   *ScriptPath,\r
  IN SHELL_FILE_HANDLE              Handle OPTIONAL,\r
  IN CONST CHAR16                   *CmdLine,\r
  IN EFI_SHELL_PARAMETERS_PROTOCOL  *ParamProtocol\r
  );\r
\r
/**\r
  Return the pointer to the first occurrence of any character from a list of characters.\r
\r
  @param[in] String           the string to parse\r
  @param[in] CharacterList    the list of character to look for\r
  @param[in] EscapeCharacter  An escape character to skip\r
\r
  @return the location of the first character in the string\r
  @retval CHAR_NULL no instance of any character in CharacterList was found in String\r
**/\r
CONST CHAR16*\r
FindFirstCharacter(\r
  IN CONST CHAR16 *String,\r
  IN CONST CHAR16 *CharacterList,\r
  IN CONST CHAR16 EscapeCharacter\r
  );\r
\r
/**\r
  Cleans off leading and trailing spaces and tabs.\r
\r
  @param[in] String pointer to the string to trim them off.\r
**/\r
EFI_STATUS\r
TrimSpaces(\r
  IN CHAR16 **String\r
  );\r
\r
/**\r
  \r
  Create a new buffer list and stores the old one to OldBufferList  \r
\r
  @param OldBufferList   The temporary list head used to store the nodes in BufferToFreeList.\r
**/\r
VOID\r
SaveBufferList (\r
  OUT LIST_ENTRY     *OldBufferList\r
  );\r
\r
/**\r
  Restore previous nodes into BufferToFreeList .\r
\r
  @param OldBufferList   The temporary list head used to store the nodes in BufferToFreeList.\r
**/\r
VOID\r
RestoreBufferList (\r
  IN OUT LIST_ENTRY     *OldBufferList\r
  );\r
\r
\r
\r
#endif //_SHELL_INTERNAL_HEADER_\r
\r
Commit	Line	Data
a405b86d	1	/** @file\r
	2	function definitions for internal to shell functions.\r
	3	\r
c011b6c9	4	(C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>\r
8d4eec6d	5	Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
a405b86d	6	This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	#ifndef _SHELL_INTERNAL_HEADER_\r
	17	#define _SHELL_INTERNAL_HEADER_\r
	18	\r
	19	#include <Uefi.h>\r
	20	#include <ShellBase.h>\r
	21	\r
	22	#include <Guid/ShellVariableGuid.h>\r
0406a571	23	#include <Guid/ShellAliasGuid.h>\r
a405b86d	24	\r
	25	#include <Protocol/LoadedImage.h>\r
	26	#include <Protocol/SimpleTextOut.h>\r
	27	#include <Protocol/EfiShell.h>\r
	28	#include <Protocol/EfiShellInterface.h>\r
	29	#include <Protocol/EfiShellEnvironment2.h>\r
	30	#include <Protocol/EfiShellParameters.h>\r
	31	#include <Protocol/BlockIo.h>\r
8d4eec6d	32	#include <Protocol/HiiPackageList.h>\r
a405b86d	33	\r
	34	#include <Library/BaseLib.h>\r
	35	#include <Library/UefiApplicationEntryPoint.h>\r
	36	#include <Library/UefiLib.h>\r
	37	#include <Library/DebugLib.h>\r
	38	#include <Library/MemoryAllocationLib.h>\r
	39	#include <Library/ShellCommandLib.h>\r
	40	#include <Library/UefiRuntimeServicesTableLib.h>\r
	41	#include <Library/UefiBootServicesTableLib.h>\r
	42	#include <Library/DevicePathLib.h>\r
	43	#include <Library/BaseMemoryLib.h>\r
	44	#include <Library/PcdLib.h>\r
	45	#include <Library/ShellLib.h>\r
	46	#include <Library/SortLib.h>\r
	47	#include <Library/HiiLib.h>\r
	48	#include <Library/PrintLib.h>\r
	49	#include <Library/HandleParsingLib.h>\r
0406a571	50	#include <Library/FileHandleLib.h>\r
8d4eec6d	51	#include <Library/UefiHiiServicesLib.h>\r
a405b86d	52	\r
	53	#include "ShellParametersProtocol.h"\r
	54	#include "ShellProtocol.h"\r
	55	#include "ShellEnvVar.h"\r
	56	#include "ConsoleLogger.h"\r
	57	#include "ShellManParser.h"\r
a49f6a2f	58	#include "ConsoleWrappers.h"\r
0406a571	59	#include "FileHandleWrappers.h"\r
a405b86d	60	\r
dcbdb8bf QS	61	extern CONST CHAR16 mNoNestingEnvVarName[];\r
	62	extern CONST CHAR16 mNoNestingTrue[];\r
	63	extern CONST CHAR16 mNoNestingFalse[];\r
	64	\r
a405b86d	65	typedef struct {\r
	66	LIST_ENTRY Link; ///< Standard linked list handler.\r
	67	SHELL_FILE_HANDLE *SplitStdOut; ///< ConsoleOut for use in the split.\r
	68	SHELL_FILE_HANDLE *SplitStdIn; ///< ConsoleIn for use in the split.\r
	69	} SPLIT_LIST;\r
	70	\r
	71	typedef struct {\r
	72	UINT32 Startup:1; ///< Was "-startup" found on command line.\r
	73	UINT32 NoStartup:1; ///< Was "-nostartup" found on command line.\r
	74	UINT32 NoConsoleOut:1; ///< Was "-noconsoleout" found on command line.\r
	75	UINT32 NoConsoleIn:1; ///< Was "-noconsolein" found on command line.\r
	76	UINT32 NoInterrupt:1; ///< Was "-nointerrupt" found on command line.\r
	77	UINT32 NoMap:1; ///< Was "-nomap" found on command line.\r
	78	UINT32 NoVersion:1; ///< Was "-noversion" found on command line.\r
	79	UINT32 Delay:1; ///< Was "-delay[:n] found on command line\r
dcbdb8bf QS	80	UINT32 Exit:1; ///< Was "-_exit" found on command line\r
dcbdb8bf QS	81	UINT32 NoNest:1; ///< Was "-nonest" found on command line\r
ca79c798	82	UINT32 Reserved:7; ///< Extra bits\r
a405b86d	83	} SHELL_BITS;\r
	84	\r
	85	typedef union {\r
	86	SHELL_BITS Bits;\r
	87	UINT16 AllBits;\r
	88	} SHELL_BIT_UNION;\r
	89	\r
	90	typedef struct {\r
	91	SHELL_BIT_UNION BitUnion;\r
	92	UINTN Delay; ///< Seconds of delay default:5.\r
	93	CHAR16 *FileName; ///< Filename to run upon successful initialization.\r
	94	CHAR16 *FileOptions; ///< Options to pass to FileName.\r
	95	} SHELL_INIT_SETTINGS;\r
	96	\r
	97	typedef struct {\r
	98	BUFFER_LIST CommandHistory;\r
	99	UINTN VisibleRowNumber;\r
	100	UINTN OriginalVisibleRowNumber;\r
	101	BOOLEAN InsertMode; ///< Is the current typing mode insert (FALSE = overwrite).\r
	102	} SHELL_VIEWING_SETTINGS;\r
	103	\r
	104	typedef struct {\r
	105	EFI_SHELL_PARAMETERS_PROTOCOL *NewShellParametersProtocol;\r
838b31a6	106	EFI_SHELL_PROTOCOL *NewEfiShellProtocol;\r
a405b86d	107	BOOLEAN PageBreakEnabled;\r
	108	BOOLEAN RootShellInstance;\r
	109	SHELL_INIT_SETTINGS ShellInitSettings;\r
	110	BUFFER_LIST BufferToFreeList; ///< List of buffers that were returned to the user to free.\r
	111	SHELL_VIEWING_SETTINGS ViewingSettings;\r
	112	EFI_HII_HANDLE HiiHandle; ///< Handle from HiiLib.\r
	113	UINTN LogScreenCount; ///< How many screens of log information to save.\r
	114	EFI_EVENT UserBreakTimer; ///< Timer event for polling for CTRL-C.\r
	115	EFI_DEVICE_PATH_PROTOCOL *ImageDevPath; ///< DevicePath for ourselves.\r
	116	EFI_DEVICE_PATH_PROTOCOL *FileDevPath; ///< DevicePath for ourselves.\r
	117	CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo; ///< Pointer for ConsoleInformation.\r
	118	EFI_SHELL_PARAMETERS_PROTOCOL *OldShellParameters; ///< old shell parameters to reinstall upon exiting.\r
	119	SHELL_PROTOCOL_HANDLE_LIST OldShellList; ///< List of other instances to reinstall when closing.\r
	120	SPLIT_LIST SplitList; ///< List of Splits in FILO stack.\r
402e4a9d RN	121	VOID *CtrlCNotifyHandle1; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
	122	VOID *CtrlCNotifyHandle2; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
	123	VOID *CtrlCNotifyHandle3; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
	124	VOID *CtrlCNotifyHandle4; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
	125	VOID *CtrlSNotifyHandle1; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
	126	VOID *CtrlSNotifyHandle2; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
	127	VOID *CtrlSNotifyHandle3; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
	128	VOID *CtrlSNotifyHandle4; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
a49f6a2f	129	BOOLEAN HaltOutput; ///< TRUE to start a CTRL-S halt.\r
a405b86d	130	} SHELL_INFO;\r
a405b86d	131	\r
8d4eec6d QS	132	#pragma pack(1)\r
	133	///\r
	134	/// HII specific Vendor Device Path definition.\r
	135	///\r
	136	typedef struct {\r
	137	VENDOR_DEVICE_PATH VendorDevicePath;\r
	138	EFI_DEVICE_PATH_PROTOCOL End;\r
	139	} SHELL_MAN_HII_VENDOR_DEVICE_PATH;\r
	140	#pragma pack()\r
	141	\r
a405b86d	142	extern SHELL_INFO ShellInfoObject;\r
a405b86d	143	\r
6bd64463 JC	144	/**\r
	145	Converts the command line to it's post-processed form. this replaces variables and alias' per UEFI Shell spec.\r
	146	\r
	147	@param[in,out] CmdLine pointer to the command line to update\r
	148	\r
	149	@retval EFI_SUCCESS The operation was successful\r
	150	@retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r
d08a5464	151	@return some other error occurred\r
6bd64463 JC	152	**/\r
6bd64463 JC	153	EFI_STATUS\r
6bd64463 JC	154	ProcessCommandLineToFinal(\r
	155	IN OUT CHAR16 **CmdLine\r
	156	);\r
	157	\r
	158	/**\r
51429264	159	Function to update the shell variable "lasterror".\r
6bd64463 JC	160	\r
	161	@param[in] ErrorCode the error code to put into lasterror\r
	162	**/\r
	163	EFI_STATUS\r
6bd64463 JC	164	SetLastError(\r
	165	IN CONST SHELL_STATUS ErrorCode\r
	166	);\r
	167	\r
a405b86d	168	/**\r
	169	Sets all the alias' that were registered with the ShellCommandLib library.\r
	170	\r
d08a5464	171	@retval EFI_SUCCESS all init commands were run successfully.\r
a405b86d	172	**/\r
a405b86d	173	EFI_STATUS\r
a405b86d	174	SetBuiltInAlias(\r
	175	VOID\r
	176	);\r
	177	\r
	178	/**\r
	179	This function will populate the 2 device path protocol parameters based on the\r
	180	global gImageHandle. the DevPath will point to the device path for the handle that has\r
	181	loaded image protocol installed on it. the FilePath will point to the device path\r
	182	for the file that was loaded.\r
	183	\r
d08a5464 JP	184	@param[in, out] DevPath on a successful return the device path to the loaded image\r
d08a5464 JP	185	@param[in, out] FilePath on a successful return the device path to the file\r
a405b86d	186	\r
d08a5464	187	@retval EFI_SUCCESS the 2 device paths were successfully returned.\r
a405b86d	188	@return other a error from gBS->HandleProtocol\r
	189	\r
	190	@sa HandleProtocol\r
	191	**/\r
	192	EFI_STATUS\r
a405b86d	193	GetDevicePathsForImageAndFile (\r
	194	IN OUT EFI_DEVICE_PATH_PROTOCOL **DevPath,\r
	195	IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath\r
	196	);\r
	197	\r
	198	/**\r
	199	Process all Uefi Shell 2.0 command line options.\r
	200	\r
	201	see Uefi Shell 2.0 section 3.2 for full details.\r
	202	\r
	203	the command line should resemble the following:\r
	204	\r
	205	shell.efi [ShellOpt-options] [options] [file-name [file-name-options]]\r
	206	\r
	207	ShellOpt options Options which control the initialization behavior of the shell.\r
	208	These options are read from the EFI global variable "ShellOpt"\r
	209	and are processed before options or file-name.\r
	210	\r
	211	options Options which control the initialization behavior of the shell.\r
	212	\r
	213	file-name The name of a UEFI shell application or script to be executed\r
	214	after initialization is complete. By default, if file-name is\r
	215	specified, then -nostartup is implied. Scripts are not supported\r
	216	by level 0.\r
	217	\r
	218	file-nameoptions The command-line options that are passed to file-name when it\r
	219	is invoked.\r
	220	\r
	221	This will initialize the ShellInitSettings global variable.\r
	222	\r
	223	@retval EFI_SUCCESS the variable is initialized.\r
	224	**/\r
	225	EFI_STATUS\r
a405b86d	226	ProcessCommandLine(\r
	227	VOID\r
	228	);\r
	229	\r
	230	/**\r
	231	Handles all interaction with the default startup script.\r
	232	\r
	233	this will check that the correct command line parameters were passed, handle the delay, and then start running the script.\r
	234	\r
	235	@param[in] ImagePath The path to the image for shell. The first place to look for the startup script.\r
	236	@param[in] FilePath The path to the file for shell. The second place to look for the startup script.\r
	237	\r
	238	@retval EFI_SUCCESS The variable is initialized.\r
	239	**/\r
	240	EFI_STATUS\r
a405b86d	241	DoStartupScript(\r
a308e058 RN	242	IN EFI_DEVICE_PATH_PROTOCOL *ImagePath,\r
a308e058 RN	243	IN EFI_DEVICE_PATH_PROTOCOL *FilePath\r
a405b86d	244	);\r
	245	\r
	246	/**\r
	247	Function to perform the shell prompt looping. It will do a single prompt,\r
	248	dispatch the result, and then return. It is expected that the caller will\r
	249	call this function in a loop many times.\r
	250	\r
	251	@retval EFI_SUCCESS\r
	252	@retval RETURN_ABORTED\r
	253	**/\r
	254	EFI_STATUS\r
a405b86d	255	DoShellPrompt (\r
	256	VOID\r
	257	);\r
	258	\r
	259	/**\r
	260	Add a buffer to the Buffer To Free List for safely returning buffers to other\r
	261	places without risking letting them modify internal shell information.\r
	262	\r
	263	@param Buffer Something to pass to FreePool when the shell is exiting.\r
	264	**/\r
	265	VOID*\r
a405b86d	266	AddBufferToFreeList(\r
	267	VOID *Buffer\r
	268	);\r
	269	\r
	270	/**\r
	271	Add a buffer to the Command History List.\r
	272	\r
	273	@param Buffer[in] The line buffer to add.\r
	274	**/\r
	275	VOID\r
a405b86d	276	AddLineToCommandHistory(\r
	277	IN CONST CHAR16 *Buffer\r
	278	);\r
	279	\r
	280	/**\r
	281	Function will process and run a command line.\r
	282	\r
	283	This will determine if the command line represents an internal shell command or dispatch an external application.\r
	284	\r
a308e058	285	@param[in] CmdLine the command line to parse\r
a405b86d	286	\r
	287	@retval EFI_SUCCESS the command was completed\r
	288	@retval EFI_ABORTED the command's operation was aborted\r
	289	**/\r
	290	EFI_STATUS\r
a405b86d	291	RunCommand(\r
a308e058	292	IN CONST CHAR16 *CmdLine\r
a405b86d	293	);\r
a405b86d	294	\r
490ce43d QS	295	/**\r
	296	Function will process and run a command line.\r
	297	\r
	298	This will determine if the command line represents an internal shell \r
	299	command or dispatch an external application.\r
	300	\r
	301	@param[in] CmdLine The command line to parse.\r
	302	@param[out] CommandStatus The status from the command line.\r
	303	\r
	304	@retval EFI_SUCCESS The command was completed.\r
	305	@retval EFI_ABORTED The command's operation was aborted.\r
	306	**/\r
	307	EFI_STATUS\r
490ce43d QS	308	RunShellCommand(\r
	309	IN CONST CHAR16 *CmdLine,\r
	310	OUT EFI_STATUS *CommandStatus\r
	311	);\r
	312	\r
a405b86d	313	/**\r
d08a5464	314	Function determines if the CommandName COULD be a valid command. It does not determine whether\r
a405b86d	315	this is a valid command. It only checks for invalid characters.\r
	316	\r
	317	@param[in] CommandName The name to check\r
	318	\r
	319	@retval TRUE CommandName could be a command name\r
	320	@retval FALSE CommandName could not be a valid command name\r
	321	**/\r
	322	BOOLEAN\r
a405b86d	323	IsValidCommandName(\r
	324	IN CONST CHAR16 *CommandName\r
	325	);\r
	326	\r
	327	/**\r
	328	Function to process a NSH script file via SHELL_FILE_HANDLE.\r
	329	\r
	330	@param[in] Handle The handle to the already opened file.\r
	331	@param[in] Name The name of the script file.\r
	332	\r
d08a5464	333	@retval EFI_SUCCESS the script completed successfully\r
a405b86d	334	**/\r
a405b86d	335	EFI_STATUS\r
a405b86d	336	RunScriptFileHandle (\r
a308e058 RN	337	IN SHELL_FILE_HANDLE Handle,\r
a308e058 RN	338	IN CONST CHAR16 *Name\r
a405b86d	339	);\r
	340	\r
	341	/**\r
	342	Function to process a NSH script file.\r
	343	\r
	344	@param[in] ScriptPath Pointer to the script file name (including file system path).\r
e958b946 JC	345	@param[in] Handle the handle of the script file already opened.\r
	346	@param[in] CmdLine the command line to run.\r
	347	@param[in] ParamProtocol the shell parameters protocol pointer\r
a405b86d	348	\r
d08a5464	349	@retval EFI_SUCCESS the script completed successfully\r
a405b86d	350	**/\r
a405b86d	351	EFI_STATUS\r
a405b86d	352	RunScriptFile (\r
a308e058 RN	353	IN CONST CHAR16 *ScriptPath,\r
	354	IN SHELL_FILE_HANDLE Handle OPTIONAL,\r
	355	IN CONST CHAR16 *CmdLine,\r
	356	IN EFI_SHELL_PARAMETERS_PROTOCOL *ParamProtocol\r
a405b86d	357	);\r
a405b86d	358	\r
1219c85d RN	359	/**\r
	360	Return the pointer to the first occurrence of any character from a list of characters.\r
	361	\r
	362	@param[in] String the string to parse\r
	363	@param[in] CharacterList the list of character to look for\r
	364	@param[in] EscapeCharacter An escape character to skip\r
	365	\r
	366	@return the location of the first character in the string\r
	367	@retval CHAR_NULL no instance of any character in CharacterList was found in String\r
	368	**/\r
	369	CONST CHAR16*\r
1219c85d RN	370	FindFirstCharacter(\r
	371	IN CONST CHAR16 *String,\r
	372	IN CONST CHAR16 *CharacterList,\r
	373	IN CONST CHAR16 EscapeCharacter\r
	374	);\r
	375	\r
389824ff QS	376	/**\r
	377	Cleans off leading and trailing spaces and tabs.\r
	378	\r
	379	@param[in] String pointer to the string to trim them off.\r
	380	**/\r
	381	EFI_STATUS\r
389824ff QS	382	TrimSpaces(\r
	383	IN CHAR16 **String\r
	384	);\r
	385	\r
14810d6b QS	386	/**\r
	387	\r
	388	Create a new buffer list and stores the old one to OldBufferList \r
	389	\r
	390	@param OldBufferList The temporary list head used to store the nodes in BufferToFreeList.\r
	391	**/\r
	392	VOID\r
	393	SaveBufferList (\r
	394	OUT LIST_ENTRY *OldBufferList\r
	395	);\r
	396	\r
	397	/**\r
	398	Restore previous nodes into BufferToFreeList .\r
	399	\r
	400	@param OldBufferList The temporary list head used to store the nodes in BufferToFreeList.\r
	401	**/\r
	402	VOID\r
	403	RestoreBufferList (\r
	404	IN OUT LIST_ENTRY *OldBufferList\r
	405	);\r
	406	\r
	407	\r
	408	\r
a405b86d	409	#endif //_SHELL_INTERNAL_HEADER_\r
a405b86d	410	\r