2 function definitions for internal to shell functions.
4 (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef _SHELL_INTERNAL_HEADER_
17 #define _SHELL_INTERNAL_HEADER_
20 #include <ShellBase.h>
22 #include <Guid/ShellVariableGuid.h>
23 #include <Guid/ShellAliasGuid.h>
25 #include <Protocol/LoadedImage.h>
26 #include <Protocol/SimpleTextOut.h>
27 #include <Protocol/EfiShell.h>
28 #include <Protocol/EfiShellInterface.h>
29 #include <Protocol/EfiShellEnvironment2.h>
30 #include <Protocol/EfiShellParameters.h>
31 #include <Protocol/BlockIo.h>
32 #include <Protocol/HiiPackageList.h>
34 #include <Library/BaseLib.h>
35 #include <Library/UefiApplicationEntryPoint.h>
36 #include <Library/UefiLib.h>
37 #include <Library/DebugLib.h>
38 #include <Library/MemoryAllocationLib.h>
39 #include <Library/ShellCommandLib.h>
40 #include <Library/UefiRuntimeServicesTableLib.h>
41 #include <Library/UefiBootServicesTableLib.h>
42 #include <Library/DevicePathLib.h>
43 #include <Library/BaseMemoryLib.h>
44 #include <Library/PcdLib.h>
45 #include <Library/ShellLib.h>
46 #include <Library/SortLib.h>
47 #include <Library/HiiLib.h>
48 #include <Library/PrintLib.h>
49 #include <Library/HandleParsingLib.h>
50 #include <Library/FileHandleLib.h>
51 #include <Library/UefiHiiServicesLib.h>
53 #include "ShellParametersProtocol.h"
54 #include "ShellProtocol.h"
55 #include "ShellEnvVar.h"
56 #include "ConsoleLogger.h"
57 #include "ShellManParser.h"
58 #include "ConsoleWrappers.h"
59 #include "FileHandleWrappers.h"
61 extern CONST CHAR16 mNoNestingEnvVarName
[];
62 extern CONST CHAR16 mNoNestingTrue
[];
63 extern CONST CHAR16 mNoNestingFalse
[];
66 LIST_ENTRY Link
; ///< Standard linked list handler.
67 SHELL_FILE_HANDLE
*SplitStdOut
; ///< ConsoleOut for use in the split.
68 SHELL_FILE_HANDLE
*SplitStdIn
; ///< ConsoleIn for use in the split.
72 UINT32 Startup
:1; ///< Was "-startup" found on command line.
73 UINT32 NoStartup
:1; ///< Was "-nostartup" found on command line.
74 UINT32 NoConsoleOut
:1; ///< Was "-noconsoleout" found on command line.
75 UINT32 NoConsoleIn
:1; ///< Was "-noconsolein" found on command line.
76 UINT32 NoInterrupt
:1; ///< Was "-nointerrupt" found on command line.
77 UINT32 NoMap
:1; ///< Was "-nomap" found on command line.
78 UINT32 NoVersion
:1; ///< Was "-noversion" found on command line.
79 UINT32 Delay
:1; ///< Was "-delay[:n] found on command line
80 UINT32 Exit
:1; ///< Was "-_exit" found on command line
81 UINT32 NoNest
:1; ///< Was "-nonest" found on command line
82 UINT32 Reserved
:7; ///< Extra bits
91 SHELL_BIT_UNION BitUnion
;
92 UINTN Delay
; ///< Seconds of delay default:5.
93 CHAR16
*FileName
; ///< Filename to run upon successful initialization.
94 CHAR16
*FileOptions
; ///< Options to pass to FileName.
95 } SHELL_INIT_SETTINGS
;
98 BUFFER_LIST CommandHistory
;
99 UINTN VisibleRowNumber
;
100 UINTN OriginalVisibleRowNumber
;
101 BOOLEAN InsertMode
; ///< Is the current typing mode insert (FALSE = overwrite).
102 } SHELL_VIEWING_SETTINGS
;
105 EFI_SHELL_PARAMETERS_PROTOCOL
*NewShellParametersProtocol
;
106 EFI_SHELL_PROTOCOL
*NewEfiShellProtocol
;
107 BOOLEAN PageBreakEnabled
;
108 BOOLEAN RootShellInstance
;
109 SHELL_INIT_SETTINGS ShellInitSettings
;
110 BUFFER_LIST BufferToFreeList
; ///< List of buffers that were returned to the user to free.
111 SHELL_VIEWING_SETTINGS ViewingSettings
;
112 EFI_HII_HANDLE HiiHandle
; ///< Handle from HiiLib.
113 UINTN LogScreenCount
; ///< How many screens of log information to save.
114 EFI_EVENT UserBreakTimer
; ///< Timer event for polling for CTRL-C.
115 EFI_DEVICE_PATH_PROTOCOL
*ImageDevPath
; ///< DevicePath for ourselves.
116 EFI_DEVICE_PATH_PROTOCOL
*FileDevPath
; ///< DevicePath for ourselves.
117 CONSOLE_LOGGER_PRIVATE_DATA
*ConsoleInfo
; ///< Pointer for ConsoleInformation.
118 EFI_SHELL_PARAMETERS_PROTOCOL
*OldShellParameters
; ///< old shell parameters to reinstall upon exiting.
119 SHELL_PROTOCOL_HANDLE_LIST OldShellList
; ///< List of other instances to reinstall when closing.
120 SPLIT_LIST SplitList
; ///< List of Splits in FILO stack.
121 VOID
*CtrlCNotifyHandle1
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
122 VOID
*CtrlCNotifyHandle2
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
123 VOID
*CtrlCNotifyHandle3
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
124 VOID
*CtrlCNotifyHandle4
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
125 VOID
*CtrlSNotifyHandle1
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
126 VOID
*CtrlSNotifyHandle2
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
127 VOID
*CtrlSNotifyHandle3
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
128 VOID
*CtrlSNotifyHandle4
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
129 BOOLEAN HaltOutput
; ///< TRUE to start a CTRL-S halt.
134 /// HII specific Vendor Device Path definition.
137 VENDOR_DEVICE_PATH VendorDevicePath
;
138 EFI_DEVICE_PATH_PROTOCOL End
;
139 } SHELL_MAN_HII_VENDOR_DEVICE_PATH
;
142 extern SHELL_INFO ShellInfoObject
;
145 Converts the command line to it's post-processed form. this replaces variables and alias' per UEFI Shell spec.
147 @param[in,out] CmdLine pointer to the command line to update
149 @retval EFI_SUCCESS The operation was successful
150 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
151 @return some other error occurred
155 ProcessCommandLineToFinal(
156 IN OUT CHAR16
**CmdLine
160 Function to update the shell variable "lasterror".
162 @param[in] ErrorCode the error code to put into lasterror
167 IN CONST SHELL_STATUS ErrorCode
171 Sets all the alias' that were registered with the ShellCommandLib library.
173 @retval EFI_SUCCESS all init commands were run successfully.
182 This function will populate the 2 device path protocol parameters based on the
183 global gImageHandle. the DevPath will point to the device path for the handle that has
184 loaded image protocol installed on it. the FilePath will point to the device path
185 for the file that was loaded.
187 @param[in, out] DevPath on a successful return the device path to the loaded image
188 @param[in, out] FilePath on a successful return the device path to the file
190 @retval EFI_SUCCESS the 2 device paths were successfully returned.
191 @return other a error from gBS->HandleProtocol
197 GetDevicePathsForImageAndFile (
198 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevPath
,
199 IN OUT EFI_DEVICE_PATH_PROTOCOL
**FilePath
203 Process all Uefi Shell 2.0 command line options.
205 see Uefi Shell 2.0 section 3.2 for full details.
207 the command line should resemble the following:
209 shell.efi [ShellOpt-options] [options] [file-name [file-name-options]]
211 ShellOpt options Options which control the initialization behavior of the shell.
212 These options are read from the EFI global variable "ShellOpt"
213 and are processed before options or file-name.
215 options Options which control the initialization behavior of the shell.
217 file-name The name of a UEFI shell application or script to be executed
218 after initialization is complete. By default, if file-name is
219 specified, then -nostartup is implied. Scripts are not supported
222 file-nameoptions The command-line options that are passed to file-name when it
225 This will initialize the ShellInitSettings global variable.
227 @retval EFI_SUCCESS the variable is initialized.
236 Handles all interaction with the default startup script.
238 this will check that the correct command line parameters were passed, handle the delay, and then start running the script.
240 @param[in] ImagePath The path to the image for shell. The first place to look for the startup script.
241 @param[in] FilePath The path to the file for shell. The second place to look for the startup script.
243 @retval EFI_SUCCESS The variable is initialized.
248 IN EFI_DEVICE_PATH_PROTOCOL
*ImagePath
,
249 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
253 Function to perform the shell prompt looping. It will do a single prompt,
254 dispatch the result, and then return. It is expected that the caller will
255 call this function in a loop many times.
258 @retval RETURN_ABORTED
267 Add a buffer to the Buffer To Free List for safely returning buffers to other
268 places without risking letting them modify internal shell information.
270 @param Buffer Something to pass to FreePool when the shell is exiting.
279 Add a buffer to the Command History List.
281 @param Buffer[in] The line buffer to add.
285 AddLineToCommandHistory(
286 IN CONST CHAR16
*Buffer
290 Function will process and run a command line.
292 This will determine if the command line represents an internal shell command or dispatch an external application.
294 @param[in] CmdLine the command line to parse
296 @retval EFI_SUCCESS the command was completed
297 @retval EFI_ABORTED the command's operation was aborted
302 IN CONST CHAR16
*CmdLine
306 Function will process and run a command line.
308 This will determine if the command line represents an internal shell
309 command or dispatch an external application.
311 @param[in] CmdLine The command line to parse.
312 @param[out] CommandStatus The status from the command line.
314 @retval EFI_SUCCESS The command was completed.
315 @retval EFI_ABORTED The command's operation was aborted.
320 IN CONST CHAR16
*CmdLine
,
321 OUT EFI_STATUS
*CommandStatus
325 Function determines if the CommandName COULD be a valid command. It does not determine whether
326 this is a valid command. It only checks for invalid characters.
328 @param[in] CommandName The name to check
330 @retval TRUE CommandName could be a command name
331 @retval FALSE CommandName could not be a valid command name
336 IN CONST CHAR16
*CommandName
340 Function to process a NSH script file via SHELL_FILE_HANDLE.
342 @param[in] Handle The handle to the already opened file.
343 @param[in] Name The name of the script file.
345 @retval EFI_SUCCESS the script completed successfully
349 RunScriptFileHandle (
350 IN SHELL_FILE_HANDLE Handle
,
351 IN CONST CHAR16
*Name
355 Function to process a NSH script file.
357 @param[in] ScriptPath Pointer to the script file name (including file system path).
358 @param[in] Handle the handle of the script file already opened.
359 @param[in] CmdLine the command line to run.
360 @param[in] ParamProtocol the shell parameters protocol pointer
362 @retval EFI_SUCCESS the script completed successfully
367 IN CONST CHAR16
*ScriptPath
,
368 IN SHELL_FILE_HANDLE Handle OPTIONAL
,
369 IN CONST CHAR16
*CmdLine
,
370 IN EFI_SHELL_PARAMETERS_PROTOCOL
*ParamProtocol
374 Return the pointer to the first occurrence of any character from a list of characters.
376 @param[in] String the string to parse
377 @param[in] CharacterList the list of character to look for
378 @param[in] EscapeCharacter An escape character to skip
380 @return the location of the first character in the string
381 @retval CHAR_NULL no instance of any character in CharacterList was found in String
386 IN CONST CHAR16
*String
,
387 IN CONST CHAR16
*CharacterList
,
388 IN CONST CHAR16 EscapeCharacter
392 Cleans off leading and trailing spaces and tabs.
394 @param[in] String pointer to the string to trim them off.
404 Create a new buffer list and stores the old one to OldBufferList
406 @param OldBufferList The temporary list head used to store the nodes in BufferToFreeList.
410 OUT LIST_ENTRY
*OldBufferList
414 Restore previous nodes into BufferToFreeList .
416 @param OldBufferList The temporary list head used to store the nodes in BufferToFreeList.
420 IN OUT LIST_ENTRY
*OldBufferList
425 #endif //_SHELL_INTERNAL_HEADER_