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