]>
Commit | Line | Data |
---|---|---|
94b17fa1 | 1 | /** @file\r |
2 | Provides interface to shell functionality for shell commands and applications.\r | |
3 | \r | |
75a5e2ef | 4 | Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r |
1e6e84c7 | 5 | This program and the accompanying materials\r |
b3011f40 | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
94b17fa1 | 9 | \r |
b3011f40 | 10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
94b17fa1 | 12 | \r |
13 | **/\r | |
14 | \r | |
b1f95a06 | 15 | #include "UefiShellLib.h"\r |
a405b86d | 16 | #include <ShellBase.h>\r |
252d9457 | 17 | #include <Library/SortLib.h>\r |
d2b4564b | 18 | \r |
94b17fa1 | 19 | #define FIND_XXXXX_FILE_BUFFER_SIZE (SIZE_OF_EFI_FILE_INFO + MAX_FILE_NAME_LEN)\r |
20 | \r | |
d2b4564b | 21 | //\r |
a405b86d | 22 | // globals...\r |
d2b4564b | 23 | //\r |
24 | SHELL_PARAM_ITEM EmptyParamList[] = {\r | |
25 | {NULL, TypeMax}\r | |
26 | };\r | |
a405b86d | 27 | SHELL_PARAM_ITEM SfoParamList[] = {\r |
28 | {L"-sfo", TypeFlag},\r | |
29 | {NULL, TypeMax}\r | |
30 | };\r | |
31 | EFI_SHELL_ENVIRONMENT2 *mEfiShellEnvironment2;\r | |
32 | EFI_SHELL_INTERFACE *mEfiShellInterface;\r | |
366f81a0 | 33 | EFI_SHELL_PROTOCOL *gEfiShellProtocol;\r |
34 | EFI_SHELL_PARAMETERS_PROTOCOL *gEfiShellParametersProtocol;\r | |
a405b86d | 35 | EFI_HANDLE mEfiShellEnvironment2Handle;\r |
36 | FILE_HANDLE_FUNCTION_MAP FileFunctionMap;\r | |
b3011f40 | 37 | \r |
2247dde4 | 38 | /**\r |
39 | Check if a Unicode character is a hexadecimal character.\r | |
40 | \r | |
1e6e84c7 | 41 | This internal function checks if a Unicode character is a\r |
a405b86d | 42 | numeric character. The valid hexadecimal characters are\r |
2247dde4 | 43 | L'0' to L'9', L'a' to L'f', or L'A' to L'F'.\r |
44 | \r | |
2247dde4 | 45 | @param Char The character to check against.\r |
46 | \r | |
47 | @retval TRUE If the Char is a hexadecmial character.\r | |
48 | @retval FALSE If the Char is not a hexadecmial character.\r | |
49 | \r | |
50 | **/\r | |
51 | BOOLEAN\r | |
52 | EFIAPI\r | |
969c783b | 53 | ShellIsHexaDecimalDigitCharacter (\r |
2247dde4 | 54 | IN CHAR16 Char\r |
a405b86d | 55 | )\r |
56 | {\r | |
2247dde4 | 57 | return (BOOLEAN) ((Char >= L'0' && Char <= L'9') || (Char >= L'A' && Char <= L'F') || (Char >= L'a' && Char <= L'f'));\r |
58 | }\r | |
94b17fa1 | 59 | \r |
60 | /**\r | |
a405b86d | 61 | Check if a Unicode character is a decimal character.\r |
62 | \r | |
63 | This internal function checks if a Unicode character is a\r | |
64 | decimal character. The valid characters are\r | |
65 | L'0' to L'9'.\r | |
66 | \r | |
67 | \r | |
68 | @param Char The character to check against.\r | |
69 | \r | |
70 | @retval TRUE If the Char is a hexadecmial character.\r | |
71 | @retval FALSE If the Char is not a hexadecmial character.\r | |
72 | \r | |
73 | **/\r | |
74 | BOOLEAN\r | |
75 | EFIAPI\r | |
76 | ShellIsDecimalDigitCharacter (\r | |
77 | IN CHAR16 Char\r | |
78 | )\r | |
79 | {\r | |
80 | return (BOOLEAN) (Char >= L'0' && Char <= L'9');\r | |
81 | }\r | |
82 | \r | |
83 | /**\r | |
84 | Helper function to find ShellEnvironment2 for constructor.\r | |
85 | \r | |
86 | @param[in] ImageHandle A copy of the calling image's handle.\r | |
beab0fc5 | 87 | \r |
88 | @retval EFI_OUT_OF_RESOURCES Memory allocation failed.\r | |
94b17fa1 | 89 | **/\r |
90 | EFI_STATUS\r | |
91 | EFIAPI\r | |
92 | ShellFindSE2 (\r | |
93 | IN EFI_HANDLE ImageHandle\r | |
a405b86d | 94 | )\r |
95 | {\r | |
94b17fa1 | 96 | EFI_STATUS Status;\r |
97 | EFI_HANDLE *Buffer;\r | |
98 | UINTN BufferSize;\r | |
99 | UINTN HandleIndex;\r | |
100 | \r | |
101 | BufferSize = 0;\r | |
102 | Buffer = NULL;\r | |
1e6e84c7 | 103 | Status = gBS->OpenProtocol(ImageHandle,\r |
94b17fa1 | 104 | &gEfiShellEnvironment2Guid,\r |
105 | (VOID **)&mEfiShellEnvironment2,\r | |
106 | ImageHandle,\r | |
107 | NULL,\r | |
108 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
a405b86d | 109 | );\r |
94b17fa1 | 110 | //\r |
111 | // look for the mEfiShellEnvironment2 protocol at a higher level\r | |
112 | //\r | |
a405b86d | 113 | if (EFI_ERROR (Status) || !(CompareGuid (&mEfiShellEnvironment2->SESGuid, &gEfiShellEnvironment2ExtGuid))){\r |
94b17fa1 | 114 | //\r |
115 | // figure out how big of a buffer we need.\r | |
116 | //\r | |
117 | Status = gBS->LocateHandle (ByProtocol,\r | |
118 | &gEfiShellEnvironment2Guid,\r | |
119 | NULL, // ignored for ByProtocol\r | |
120 | &BufferSize,\r | |
121 | Buffer\r | |
a405b86d | 122 | );\r |
2247dde4 | 123 | //\r |
124 | // maybe it's not there???\r | |
125 | //\r | |
126 | if (Status == EFI_BUFFER_TOO_SMALL) {\r | |
252d9457 | 127 | Buffer = (EFI_HANDLE*)AllocateZeroPool(BufferSize);\r |
beab0fc5 | 128 | if (Buffer == NULL) {\r |
129 | return (EFI_OUT_OF_RESOURCES);\r | |
130 | }\r | |
2247dde4 | 131 | Status = gBS->LocateHandle (ByProtocol,\r |
132 | &gEfiShellEnvironment2Guid,\r | |
133 | NULL, // ignored for ByProtocol\r | |
134 | &BufferSize,\r | |
135 | Buffer\r | |
a405b86d | 136 | );\r |
2247dde4 | 137 | }\r |
1cd45e78 | 138 | if (!EFI_ERROR (Status) && Buffer != NULL) {\r |
94b17fa1 | 139 | //\r |
140 | // now parse the list of returned handles\r | |
141 | //\r | |
142 | Status = EFI_NOT_FOUND;\r | |
143 | for (HandleIndex = 0; HandleIndex < (BufferSize/sizeof(Buffer[0])); HandleIndex++) {\r | |
1e6e84c7 | 144 | Status = gBS->OpenProtocol(Buffer[HandleIndex],\r |
94b17fa1 | 145 | &gEfiShellEnvironment2Guid,\r |
146 | (VOID **)&mEfiShellEnvironment2,\r | |
147 | ImageHandle,\r | |
148 | NULL,\r | |
149 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
a405b86d | 150 | );\r |
151 | if (CompareGuid (&mEfiShellEnvironment2->SESGuid, &gEfiShellEnvironment2ExtGuid)) {\r | |
94b17fa1 | 152 | mEfiShellEnvironment2Handle = Buffer[HandleIndex];\r |
153 | Status = EFI_SUCCESS;\r | |
154 | break;\r | |
155 | }\r | |
156 | }\r | |
157 | }\r | |
158 | }\r | |
159 | if (Buffer != NULL) {\r | |
160 | FreePool (Buffer);\r | |
161 | }\r | |
162 | return (Status);\r | |
163 | }\r | |
164 | \r | |
252d9457 | 165 | /**\r |
b0934ac4 | 166 | Function to do most of the work of the constructor. Allows for calling\r |
a405b86d | 167 | multiple times without complete re-initialization.\r |
168 | \r | |
169 | @param[in] ImageHandle A copy of the ImageHandle.\r | |
170 | @param[in] SystemTable A pointer to the SystemTable for the application.\r | |
252d9457 | 171 | \r |
172 | @retval EFI_SUCCESS The operationw as successful.\r | |
a405b86d | 173 | **/\r |
94b17fa1 | 174 | EFI_STATUS\r |
175 | EFIAPI\r | |
d2b4564b | 176 | ShellLibConstructorWorker (\r |
94b17fa1 | 177 | IN EFI_HANDLE ImageHandle,\r |
178 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
a405b86d | 179 | )\r |
180 | {\r | |
181 | EFI_STATUS Status;\r | |
ecd3d59f | 182 | \r |
94b17fa1 | 183 | //\r |
184 | // UEFI 2.0 shell interfaces (used preferentially)\r | |
185 | //\r | |
a405b86d | 186 | Status = gBS->OpenProtocol(\r |
187 | ImageHandle,\r | |
188 | &gEfiShellProtocolGuid,\r | |
366f81a0 | 189 | (VOID **)&gEfiShellProtocol,\r |
a405b86d | 190 | ImageHandle,\r |
191 | NULL,\r | |
192 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
193 | );\r | |
94b17fa1 | 194 | if (EFI_ERROR(Status)) {\r |
a405b86d | 195 | //\r |
196 | // Search for the shell protocol\r | |
197 | //\r | |
198 | Status = gBS->LocateProtocol(\r | |
199 | &gEfiShellProtocolGuid,\r | |
200 | NULL,\r | |
366f81a0 | 201 | (VOID **)&gEfiShellProtocol\r |
a405b86d | 202 | );\r |
203 | if (EFI_ERROR(Status)) {\r | |
366f81a0 | 204 | gEfiShellProtocol = NULL;\r |
a405b86d | 205 | }\r |
94b17fa1 | 206 | }\r |
a405b86d | 207 | Status = gBS->OpenProtocol(\r |
208 | ImageHandle,\r | |
209 | &gEfiShellParametersProtocolGuid,\r | |
366f81a0 | 210 | (VOID **)&gEfiShellParametersProtocol,\r |
a405b86d | 211 | ImageHandle,\r |
212 | NULL,\r | |
213 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
214 | );\r | |
94b17fa1 | 215 | if (EFI_ERROR(Status)) {\r |
366f81a0 | 216 | gEfiShellParametersProtocol = NULL;\r |
94b17fa1 | 217 | }\r |
218 | \r | |
366f81a0 | 219 | if (gEfiShellParametersProtocol == NULL || gEfiShellProtocol == NULL) {\r |
94b17fa1 | 220 | //\r |
221 | // Moved to seperate function due to complexity\r | |
222 | //\r | |
223 | Status = ShellFindSE2(ImageHandle);\r | |
224 | \r | |
225 | if (EFI_ERROR(Status)) {\r | |
226 | DEBUG((DEBUG_ERROR, "Status: 0x%08x\r\n", Status));\r | |
227 | mEfiShellEnvironment2 = NULL;\r | |
228 | }\r | |
1e6e84c7 | 229 | Status = gBS->OpenProtocol(ImageHandle,\r |
94b17fa1 | 230 | &gEfiShellInterfaceGuid,\r |
231 | (VOID **)&mEfiShellInterface,\r | |
232 | ImageHandle,\r | |
233 | NULL,\r | |
234 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
a405b86d | 235 | );\r |
94b17fa1 | 236 | if (EFI_ERROR(Status)) {\r |
237 | mEfiShellInterface = NULL;\r | |
238 | }\r | |
239 | }\r | |
c9d92df0 | 240 | \r |
94b17fa1 | 241 | //\r |
242 | // only success getting 2 of either the old or new, but no 1/2 and 1/2\r | |
243 | //\r | |
1e6e84c7 | 244 | if ((mEfiShellEnvironment2 != NULL && mEfiShellInterface != NULL) ||\r |
366f81a0 | 245 | (gEfiShellProtocol != NULL && gEfiShellParametersProtocol != NULL) ) {\r |
246 | if (gEfiShellProtocol != NULL) {\r | |
247 | FileFunctionMap.GetFileInfo = gEfiShellProtocol->GetFileInfo;\r | |
248 | FileFunctionMap.SetFileInfo = gEfiShellProtocol->SetFileInfo;\r | |
249 | FileFunctionMap.ReadFile = gEfiShellProtocol->ReadFile;\r | |
250 | FileFunctionMap.WriteFile = gEfiShellProtocol->WriteFile;\r | |
251 | FileFunctionMap.CloseFile = gEfiShellProtocol->CloseFile;\r | |
252 | FileFunctionMap.DeleteFile = gEfiShellProtocol->DeleteFile;\r | |
253 | FileFunctionMap.GetFilePosition = gEfiShellProtocol->GetFilePosition;\r | |
254 | FileFunctionMap.SetFilePosition = gEfiShellProtocol->SetFilePosition;\r | |
255 | FileFunctionMap.FlushFile = gEfiShellProtocol->FlushFile;\r | |
256 | FileFunctionMap.GetFileSize = gEfiShellProtocol->GetFileSize;\r | |
d2b4564b | 257 | } else {\r |
a405b86d | 258 | FileFunctionMap.GetFileInfo = (EFI_SHELL_GET_FILE_INFO)FileHandleGetInfo;\r |
259 | FileFunctionMap.SetFileInfo = (EFI_SHELL_SET_FILE_INFO)FileHandleSetInfo;\r | |
260 | FileFunctionMap.ReadFile = (EFI_SHELL_READ_FILE)FileHandleRead;\r | |
261 | FileFunctionMap.WriteFile = (EFI_SHELL_WRITE_FILE)FileHandleWrite;\r | |
262 | FileFunctionMap.CloseFile = (EFI_SHELL_CLOSE_FILE)FileHandleClose;\r | |
263 | FileFunctionMap.DeleteFile = (EFI_SHELL_DELETE_FILE)FileHandleDelete;\r | |
264 | FileFunctionMap.GetFilePosition = (EFI_SHELL_GET_FILE_POSITION)FileHandleGetPosition;\r | |
265 | FileFunctionMap.SetFilePosition = (EFI_SHELL_SET_FILE_POSITION)FileHandleSetPosition;\r | |
266 | FileFunctionMap.FlushFile = (EFI_SHELL_FLUSH_FILE)FileHandleFlush;\r | |
267 | FileFunctionMap.GetFileSize = (EFI_SHELL_GET_FILE_SIZE)FileHandleGetSize;\r | |
d2b4564b | 268 | }\r |
94b17fa1 | 269 | return (EFI_SUCCESS);\r |
270 | }\r | |
271 | return (EFI_NOT_FOUND);\r | |
272 | }\r | |
d2b4564b | 273 | /**\r |
274 | Constructor for the Shell library.\r | |
275 | \r | |
276 | Initialize the library and determine if the underlying is a UEFI Shell 2.0 or an EFI shell.\r | |
277 | \r | |
278 | @param ImageHandle the image handle of the process\r | |
279 | @param SystemTable the EFI System Table pointer\r | |
280 | \r | |
281 | @retval EFI_SUCCESS the initialization was complete sucessfully\r | |
282 | @return others an error ocurred during initialization\r | |
283 | **/\r | |
284 | EFI_STATUS\r | |
285 | EFIAPI\r | |
286 | ShellLibConstructor (\r | |
287 | IN EFI_HANDLE ImageHandle,\r | |
288 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
a405b86d | 289 | )\r |
290 | {\r | |
d2b4564b | 291 | mEfiShellEnvironment2 = NULL;\r |
366f81a0 | 292 | gEfiShellProtocol = NULL;\r |
293 | gEfiShellParametersProtocol = NULL;\r | |
d2b4564b | 294 | mEfiShellInterface = NULL;\r |
295 | mEfiShellEnvironment2Handle = NULL;\r | |
296 | \r | |
d2b4564b | 297 | //\r |
298 | // verify that auto initialize is not set false\r | |
1e6e84c7 | 299 | //\r |
d2b4564b | 300 | if (PcdGetBool(PcdShellLibAutoInitialize) == 0) {\r |
301 | return (EFI_SUCCESS);\r | |
302 | }\r | |
1e6e84c7 | 303 | \r |
d2b4564b | 304 | return (ShellLibConstructorWorker(ImageHandle, SystemTable));\r |
305 | }\r | |
94b17fa1 | 306 | \r |
307 | /**\r | |
a405b86d | 308 | Destructor for the library. free any resources.\r |
309 | \r | |
310 | @param[in] ImageHandle A copy of the ImageHandle.\r | |
311 | @param[in] SystemTable A pointer to the SystemTable for the application.\r | |
312 | \r | |
313 | @retval EFI_SUCCESS The operation was successful.\r | |
314 | @return An error from the CloseProtocol function.\r | |
94b17fa1 | 315 | **/\r |
316 | EFI_STATUS\r | |
317 | EFIAPI\r | |
318 | ShellLibDestructor (\r | |
319 | IN EFI_HANDLE ImageHandle,\r | |
320 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
a405b86d | 321 | )\r |
322 | {\r | |
94b17fa1 | 323 | if (mEfiShellEnvironment2 != NULL) {\r |
324 | gBS->CloseProtocol(mEfiShellEnvironment2Handle==NULL?ImageHandle:mEfiShellEnvironment2Handle,\r | |
325 | &gEfiShellEnvironment2Guid,\r | |
326 | ImageHandle,\r | |
327 | NULL);\r | |
d2b4564b | 328 | mEfiShellEnvironment2 = NULL;\r |
94b17fa1 | 329 | }\r |
330 | if (mEfiShellInterface != NULL) {\r | |
331 | gBS->CloseProtocol(ImageHandle,\r | |
332 | &gEfiShellInterfaceGuid,\r | |
333 | ImageHandle,\r | |
1e6e84c7 | 334 | NULL);\r |
d2b4564b | 335 | mEfiShellInterface = NULL;\r |
94b17fa1 | 336 | }\r |
366f81a0 | 337 | if (gEfiShellProtocol != NULL) {\r |
94b17fa1 | 338 | gBS->CloseProtocol(ImageHandle,\r |
339 | &gEfiShellProtocolGuid,\r | |
340 | ImageHandle,\r | |
1e6e84c7 | 341 | NULL);\r |
366f81a0 | 342 | gEfiShellProtocol = NULL;\r |
94b17fa1 | 343 | }\r |
366f81a0 | 344 | if (gEfiShellParametersProtocol != NULL) {\r |
94b17fa1 | 345 | gBS->CloseProtocol(ImageHandle,\r |
346 | &gEfiShellParametersProtocolGuid,\r | |
347 | ImageHandle,\r | |
1e6e84c7 | 348 | NULL);\r |
366f81a0 | 349 | gEfiShellParametersProtocol = NULL;\r |
94b17fa1 | 350 | }\r |
d2b4564b | 351 | mEfiShellEnvironment2Handle = NULL;\r |
ecd3d59f | 352 | \r |
94b17fa1 | 353 | return (EFI_SUCCESS);\r |
354 | }\r | |
d2b4564b | 355 | \r |
356 | /**\r | |
357 | This function causes the shell library to initialize itself. If the shell library\r | |
358 | is already initialized it will de-initialize all the current protocol poitners and\r | |
359 | re-populate them again.\r | |
360 | \r | |
361 | When the library is used with PcdShellLibAutoInitialize set to true this function\r | |
362 | will return EFI_SUCCESS and perform no actions.\r | |
363 | \r | |
364 | This function is intended for internal access for shell commands only.\r | |
365 | \r | |
366 | @retval EFI_SUCCESS the initialization was complete sucessfully\r | |
367 | \r | |
368 | **/\r | |
369 | EFI_STATUS\r | |
370 | EFIAPI\r | |
371 | ShellInitialize (\r | |
a405b86d | 372 | )\r |
373 | {\r | |
d2b4564b | 374 | //\r |
375 | // if auto initialize is not false then skip\r | |
376 | //\r | |
377 | if (PcdGetBool(PcdShellLibAutoInitialize) != 0) {\r | |
378 | return (EFI_SUCCESS);\r | |
379 | }\r | |
380 | \r | |
381 | //\r | |
382 | // deinit the current stuff\r | |
383 | //\r | |
384 | ASSERT_EFI_ERROR(ShellLibDestructor(gImageHandle, gST));\r | |
385 | \r | |
386 | //\r | |
387 | // init the new stuff\r | |
388 | //\r | |
389 | return (ShellLibConstructorWorker(gImageHandle, gST));\r | |
390 | }\r | |
391 | \r | |
94b17fa1 | 392 | /**\r |
1e6e84c7 | 393 | This function will retrieve the information about the file for the handle\r |
94b17fa1 | 394 | specified and store it in allocated pool memory.\r |
395 | \r | |
1e6e84c7 | 396 | This function allocates a buffer to store the file's information. It is the\r |
69817bf8 | 397 | caller's responsibility to free the buffer\r |
94b17fa1 | 398 | \r |
1e6e84c7 | 399 | @param FileHandle The file handle of the file for which information is\r |
94b17fa1 | 400 | being requested.\r |
401 | \r | |
402 | @retval NULL information could not be retrieved.\r | |
403 | \r | |
404 | @return the information about the file\r | |
405 | **/\r | |
406 | EFI_FILE_INFO*\r | |
407 | EFIAPI\r | |
408 | ShellGetFileInfo (\r | |
a405b86d | 409 | IN SHELL_FILE_HANDLE FileHandle\r |
410 | )\r | |
411 | {\r | |
d2b4564b | 412 | return (FileFunctionMap.GetFileInfo(FileHandle));\r |
94b17fa1 | 413 | }\r |
414 | \r | |
415 | /**\r | |
a405b86d | 416 | This function sets the information about the file for the opened handle\r |
94b17fa1 | 417 | specified.\r |
418 | \r | |
a405b86d | 419 | @param[in] FileHandle The file handle of the file for which information\r |
420 | is being set.\r | |
94b17fa1 | 421 | \r |
a405b86d | 422 | @param[in] FileInfo The information to set.\r |
94b17fa1 | 423 | \r |
b0934ac4 | 424 | @retval EFI_SUCCESS The information was set.\r |
a405b86d | 425 | @retval EFI_INVALID_PARAMETER A parameter was out of range or invalid.\r |
426 | @retval EFI_UNSUPPORTED The FileHandle does not support FileInfo.\r | |
b0934ac4 | 427 | @retval EFI_NO_MEDIA The device has no medium.\r |
428 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
429 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
430 | @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r | |
a405b86d | 431 | @retval EFI_ACCESS_DENIED The file was opened read only.\r |
432 | @retval EFI_VOLUME_FULL The volume is full.\r | |
94b17fa1 | 433 | **/\r |
434 | EFI_STATUS\r | |
435 | EFIAPI\r | |
436 | ShellSetFileInfo (\r | |
b0934ac4 | 437 | IN SHELL_FILE_HANDLE FileHandle,\r |
94b17fa1 | 438 | IN EFI_FILE_INFO *FileInfo\r |
a405b86d | 439 | )\r |
440 | {\r | |
d2b4564b | 441 | return (FileFunctionMap.SetFileInfo(FileHandle, FileInfo));\r |
1e6e84c7 | 442 | }\r |
443 | \r | |
94b17fa1 | 444 | /**\r |
445 | This function will open a file or directory referenced by DevicePath.\r | |
446 | \r | |
1e6e84c7 | 447 | This function opens a file with the open mode according to the file path. The\r |
94b17fa1 | 448 | Attributes is valid only for EFI_FILE_MODE_CREATE.\r |
449 | \r | |
b0934ac4 | 450 | @param FilePath on input the device path to the file. On output\r |
94b17fa1 | 451 | the remaining device path.\r |
b0934ac4 | 452 | @param DeviceHandle pointer to the system device handle.\r |
453 | @param FileHandle pointer to the file handle.\r | |
454 | @param OpenMode the mode to open the file with.\r | |
455 | @param Attributes the file's file attributes.\r | |
456 | \r | |
457 | @retval EFI_SUCCESS The information was set.\r | |
458 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r | |
459 | @retval EFI_UNSUPPORTED Could not open the file path.\r | |
460 | @retval EFI_NOT_FOUND The specified file could not be found on the\r | |
1e6e84c7 | 461 | device or the file system could not be found on\r |
94b17fa1 | 462 | the device.\r |
b0934ac4 | 463 | @retval EFI_NO_MEDIA The device has no medium.\r |
464 | @retval EFI_MEDIA_CHANGED The device has a different medium in it or the\r | |
94b17fa1 | 465 | medium is no longer supported.\r |
b0934ac4 | 466 | @retval EFI_DEVICE_ERROR The device reported an error.\r |
467 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
468 | @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r | |
469 | @retval EFI_ACCESS_DENIED The file was opened read only.\r | |
470 | @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the\r | |
94b17fa1 | 471 | file.\r |
b0934ac4 | 472 | @retval EFI_VOLUME_FULL The volume is full.\r |
94b17fa1 | 473 | **/\r |
474 | EFI_STATUS\r | |
475 | EFIAPI\r | |
476 | ShellOpenFileByDevicePath(\r | |
b0934ac4 | 477 | IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath,\r |
478 | OUT EFI_HANDLE *DeviceHandle,\r | |
a405b86d | 479 | OUT SHELL_FILE_HANDLE *FileHandle,\r |
b0934ac4 | 480 | IN UINT64 OpenMode,\r |
481 | IN UINT64 Attributes\r | |
a405b86d | 482 | )\r |
483 | {\r | |
484 | CHAR16 *FileName;\r | |
485 | EFI_STATUS Status;\r | |
94b17fa1 | 486 | EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *EfiSimpleFileSystemProtocol;\r |
a405b86d | 487 | EFI_FILE_PROTOCOL *Handle1;\r |
488 | EFI_FILE_PROTOCOL *Handle2;\r | |
0b6cb335 ED |
489 | CHAR16 *FnafPathName;\r |
490 | UINTN PathLen;\r | |
94b17fa1 | 491 | \r |
92a5447e | 492 | if (FilePath == NULL || FileHandle == NULL || DeviceHandle == NULL) {\r |
493 | return (EFI_INVALID_PARAMETER);\r | |
494 | }\r | |
495 | \r | |
1e6e84c7 | 496 | //\r |
94b17fa1 | 497 | // which shell interface should we use\r |
498 | //\r | |
366f81a0 | 499 | if (gEfiShellProtocol != NULL) {\r |
94b17fa1 | 500 | //\r |
501 | // use UEFI Shell 2.0 method.\r | |
502 | //\r | |
366f81a0 | 503 | FileName = gEfiShellProtocol->GetFilePathFromDevicePath(*FilePath);\r |
94b17fa1 | 504 | if (FileName == NULL) {\r |
505 | return (EFI_INVALID_PARAMETER);\r | |
506 | }\r | |
507 | Status = ShellOpenFileByName(FileName, FileHandle, OpenMode, Attributes);\r | |
508 | FreePool(FileName);\r | |
509 | return (Status);\r | |
1e6e84c7 | 510 | }\r |
d2b4564b | 511 | \r |
512 | \r | |
513 | //\r | |
514 | // use old shell method.\r | |
515 | //\r | |
1e6e84c7 | 516 | Status = gBS->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid,\r |
517 | FilePath,\r | |
d2b4564b | 518 | DeviceHandle);\r |
519 | if (EFI_ERROR (Status)) {\r | |
520 | return Status;\r | |
521 | }\r | |
522 | Status = gBS->OpenProtocol(*DeviceHandle,\r | |
523 | &gEfiSimpleFileSystemProtocolGuid,\r | |
b1f95a06 | 524 | (VOID**)&EfiSimpleFileSystemProtocol,\r |
d2b4564b | 525 | gImageHandle,\r |
526 | NULL,\r | |
527 | EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r | |
528 | if (EFI_ERROR (Status)) {\r | |
529 | return Status;\r | |
530 | }\r | |
a405b86d | 531 | Status = EfiSimpleFileSystemProtocol->OpenVolume(EfiSimpleFileSystemProtocol, &Handle1);\r |
d2b4564b | 532 | if (EFI_ERROR (Status)) {\r |
533 | FileHandle = NULL;\r | |
534 | return Status;\r | |
535 | }\r | |
536 | \r | |
537 | //\r | |
538 | // go down directories one node at a time.\r | |
539 | //\r | |
540 | while (!IsDevicePathEnd (*FilePath)) {\r | |
94b17fa1 | 541 | //\r |
d2b4564b | 542 | // For file system access each node should be a file path component\r |
94b17fa1 | 543 | //\r |
d2b4564b | 544 | if (DevicePathType (*FilePath) != MEDIA_DEVICE_PATH ||\r |
545 | DevicePathSubType (*FilePath) != MEDIA_FILEPATH_DP\r | |
a405b86d | 546 | ) {\r |
94b17fa1 | 547 | FileHandle = NULL;\r |
d2b4564b | 548 | return (EFI_INVALID_PARAMETER);\r |
94b17fa1 | 549 | }\r |
d2b4564b | 550 | //\r |
551 | // Open this file path node\r | |
552 | //\r | |
a405b86d | 553 | Handle2 = Handle1;\r |
554 | Handle1 = NULL;\r | |
94b17fa1 | 555 | \r |
0b6cb335 ED |
556 | //\r |
557 | // File Name Alignment Fix (FNAF)\r | |
558 | // Handle2->Open may be incapable of handling a unaligned CHAR16 data.\r | |
559 | // The structure pointed to by FilePath may be not CHAR16 aligned.\r | |
560 | // This code copies the potentially unaligned PathName data from the\r | |
561 | // FilePath structure to the aligned FnafPathName for use in the\r | |
562 | // calls to Handl2->Open.\r | |
563 | //\r | |
564 | \r | |
565 | //\r | |
566 | // Determine length of PathName, in bytes.\r | |
567 | //\r | |
568 | PathLen = DevicePathNodeLength (*FilePath) - SIZE_OF_FILEPATH_DEVICE_PATH;\r | |
569 | \r | |
570 | //\r | |
571 | // Allocate memory for the aligned copy of the string Extra allocation is to allow for forced alignment\r | |
572 | // Copy bytes from possibly unaligned location to aligned location\r | |
573 | //\r | |
574 | FnafPathName = AllocateCopyPool(PathLen, (UINT8 *)((FILEPATH_DEVICE_PATH*)*FilePath)->PathName);\r | |
575 | if (FnafPathName == NULL) {\r | |
576 | return EFI_OUT_OF_RESOURCES;\r | |
577 | }\r | |
578 | \r | |
94b17fa1 | 579 | //\r |
d2b4564b | 580 | // Try to test opening an existing file\r |
94b17fa1 | 581 | //\r |
a405b86d | 582 | Status = Handle2->Open (\r |
583 | Handle2,\r | |
584 | &Handle1,\r | |
0b6cb335 | 585 | FnafPathName,\r |
d2b4564b | 586 | OpenMode &~EFI_FILE_MODE_CREATE,\r |
587 | 0\r | |
a405b86d | 588 | );\r |
94b17fa1 | 589 | \r |
d2b4564b | 590 | //\r |
591 | // see if the error was that it needs to be created\r | |
592 | //\r | |
593 | if ((EFI_ERROR (Status)) && (OpenMode != (OpenMode &~EFI_FILE_MODE_CREATE))) {\r | |
a405b86d | 594 | Status = Handle2->Open (\r |
595 | Handle2,\r | |
596 | &Handle1,\r | |
0b6cb335 | 597 | FnafPathName,\r |
d2b4564b | 598 | OpenMode,\r |
599 | Attributes\r | |
a405b86d | 600 | );\r |
d2b4564b | 601 | }\r |
0b6cb335 ED |
602 | \r |
603 | //\r | |
604 | // Free the alignment buffer\r | |
605 | //\r | |
606 | FreePool(FnafPathName);\r | |
607 | \r | |
d2b4564b | 608 | //\r |
609 | // Close the last node\r | |
610 | //\r | |
a405b86d | 611 | Handle2->Close (Handle2);\r |
94b17fa1 | 612 | \r |
d2b4564b | 613 | if (EFI_ERROR(Status)) {\r |
614 | return (Status);\r | |
94b17fa1 | 615 | }\r |
d2b4564b | 616 | \r |
617 | //\r | |
618 | // Get the next node\r | |
619 | //\r | |
620 | *FilePath = NextDevicePathNode (*FilePath);\r | |
94b17fa1 | 621 | }\r |
a405b86d | 622 | \r |
623 | //\r | |
624 | // This is a weak spot since if the undefined SHELL_FILE_HANDLE format changes this must change also!\r | |
625 | //\r | |
626 | *FileHandle = (VOID*)Handle1;\r | |
d2b4564b | 627 | return (EFI_SUCCESS);\r |
94b17fa1 | 628 | }\r |
629 | \r | |
630 | /**\r | |
631 | This function will open a file or directory referenced by filename.\r | |
632 | \r | |
1e6e84c7 | 633 | If return is EFI_SUCCESS, the Filehandle is the opened file's handle;\r |
634 | otherwise, the Filehandle is NULL. The Attributes is valid only for\r | |
94b17fa1 | 635 | EFI_FILE_MODE_CREATE.\r |
636 | \r | |
92a5447e | 637 | if FileName is NULL then ASSERT()\r |
94b17fa1 | 638 | \r |
b0934ac4 | 639 | @param FileName pointer to file name\r |
640 | @param FileHandle pointer to the file handle.\r | |
641 | @param OpenMode the mode to open the file with.\r | |
642 | @param Attributes the file's file attributes.\r | |
94b17fa1 | 643 | \r |
b0934ac4 | 644 | @retval EFI_SUCCESS The information was set.\r |
645 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r | |
646 | @retval EFI_UNSUPPORTED Could not open the file path.\r | |
647 | @retval EFI_NOT_FOUND The specified file could not be found on the\r | |
1e6e84c7 | 648 | device or the file system could not be found\r |
94b17fa1 | 649 | on the device.\r |
b0934ac4 | 650 | @retval EFI_NO_MEDIA The device has no medium.\r |
651 | @retval EFI_MEDIA_CHANGED The device has a different medium in it or the\r | |
94b17fa1 | 652 | medium is no longer supported.\r |
b0934ac4 | 653 | @retval EFI_DEVICE_ERROR The device reported an error.\r |
654 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
655 | @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r | |
656 | @retval EFI_ACCESS_DENIED The file was opened read only.\r | |
657 | @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the\r | |
94b17fa1 | 658 | file.\r |
b0934ac4 | 659 | @retval EFI_VOLUME_FULL The volume is full.\r |
94b17fa1 | 660 | **/\r |
661 | EFI_STATUS\r | |
662 | EFIAPI\r | |
663 | ShellOpenFileByName(\r | |
b0934ac4 | 664 | IN CONST CHAR16 *FileName,\r |
a405b86d | 665 | OUT SHELL_FILE_HANDLE *FileHandle,\r |
94b17fa1 | 666 | IN UINT64 OpenMode,\r |
b0934ac4 | 667 | IN UINT64 Attributes\r |
a405b86d | 668 | )\r |
669 | {\r | |
94b17fa1 | 670 | EFI_HANDLE DeviceHandle;\r |
671 | EFI_DEVICE_PATH_PROTOCOL *FilePath;\r | |
b1f95a06 | 672 | EFI_STATUS Status;\r |
673 | EFI_FILE_INFO *FileInfo;\r | |
94b17fa1 | 674 | \r |
675 | //\r | |
676 | // ASSERT if FileName is NULL\r | |
677 | //\r | |
678 | ASSERT(FileName != NULL);\r | |
679 | \r | |
a405b86d | 680 | if (FileName == NULL) {\r |
681 | return (EFI_INVALID_PARAMETER);\r | |
682 | }\r | |
683 | \r | |
366f81a0 | 684 | if (gEfiShellProtocol != NULL) {\r |
a405b86d | 685 | if ((OpenMode & EFI_FILE_MODE_CREATE) == EFI_FILE_MODE_CREATE && (Attributes & EFI_FILE_DIRECTORY) == EFI_FILE_DIRECTORY) {\r |
686 | return ShellCreateDirectory(FileName, FileHandle);\r | |
687 | }\r | |
94b17fa1 | 688 | //\r |
689 | // Use UEFI Shell 2.0 method\r | |
690 | //\r | |
366f81a0 | 691 | Status = gEfiShellProtocol->OpenFileByName(FileName,\r |
b1f95a06 | 692 | FileHandle,\r |
693 | OpenMode);\r | |
a405b86d | 694 | if (StrCmp(FileName, L"NUL") != 0 && !EFI_ERROR(Status) && ((OpenMode & EFI_FILE_MODE_CREATE) != 0)){\r |
2247dde4 | 695 | FileInfo = FileFunctionMap.GetFileInfo(*FileHandle);\r |
b1f95a06 | 696 | ASSERT(FileInfo != NULL);\r |
697 | FileInfo->Attribute = Attributes;\r | |
2247dde4 | 698 | Status = FileFunctionMap.SetFileInfo(*FileHandle, FileInfo);\r |
699 | FreePool(FileInfo);\r | |
b1f95a06 | 700 | }\r |
701 | return (Status);\r | |
1e6e84c7 | 702 | }\r |
94b17fa1 | 703 | //\r |
704 | // Using EFI Shell version\r | |
705 | // this means convert name to path and call that function\r | |
706 | // since this will use EFI method again that will open it.\r | |
707 | //\r | |
708 | ASSERT(mEfiShellEnvironment2 != NULL);\r | |
b82bfcc1 | 709 | FilePath = mEfiShellEnvironment2->NameToPath ((CHAR16*)FileName);\r |
90bfa227 | 710 | if (FilePath != NULL) {\r |
94b17fa1 | 711 | return (ShellOpenFileByDevicePath(&FilePath,\r |
712 | &DeviceHandle,\r | |
713 | FileHandle,\r | |
714 | OpenMode,\r | |
a405b86d | 715 | Attributes));\r |
94b17fa1 | 716 | }\r |
717 | return (EFI_DEVICE_ERROR);\r | |
718 | }\r | |
719 | /**\r | |
720 | This function create a directory\r | |
721 | \r | |
1e6e84c7 | 722 | If return is EFI_SUCCESS, the Filehandle is the opened directory's handle;\r |
723 | otherwise, the Filehandle is NULL. If the directory already existed, this\r | |
94b17fa1 | 724 | function opens the existing directory.\r |
725 | \r | |
b0934ac4 | 726 | @param DirectoryName pointer to directory name\r |
727 | @param FileHandle pointer to the file handle.\r | |
94b17fa1 | 728 | \r |
b0934ac4 | 729 | @retval EFI_SUCCESS The information was set.\r |
730 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r | |
731 | @retval EFI_UNSUPPORTED Could not open the file path.\r | |
732 | @retval EFI_NOT_FOUND The specified file could not be found on the\r | |
1e6e84c7 | 733 | device or the file system could not be found\r |
94b17fa1 | 734 | on the device.\r |
b0934ac4 | 735 | @retval EFI_NO_MEDIA The device has no medium.\r |
736 | @retval EFI_MEDIA_CHANGED The device has a different medium in it or the\r | |
94b17fa1 | 737 | medium is no longer supported.\r |
b0934ac4 | 738 | @retval EFI_DEVICE_ERROR The device reported an error.\r |
739 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
740 | @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r | |
741 | @retval EFI_ACCESS_DENIED The file was opened read only.\r | |
742 | @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the\r | |
94b17fa1 | 743 | file.\r |
b0934ac4 | 744 | @retval EFI_VOLUME_FULL The volume is full.\r |
94b17fa1 | 745 | @sa ShellOpenFileByName\r |
746 | **/\r | |
747 | EFI_STATUS\r | |
748 | EFIAPI\r | |
749 | ShellCreateDirectory(\r | |
b82bfcc1 | 750 | IN CONST CHAR16 *DirectoryName,\r |
a405b86d | 751 | OUT SHELL_FILE_HANDLE *FileHandle\r |
752 | )\r | |
753 | {\r | |
366f81a0 | 754 | if (gEfiShellProtocol != NULL) {\r |
2247dde4 | 755 | //\r |
756 | // Use UEFI Shell 2.0 method\r | |
757 | //\r | |
366f81a0 | 758 | return (gEfiShellProtocol->CreateFile(DirectoryName,\r |
2247dde4 | 759 | EFI_FILE_DIRECTORY,\r |
760 | FileHandle\r | |
a405b86d | 761 | ));\r |
2247dde4 | 762 | } else {\r |
763 | return (ShellOpenFileByName(DirectoryName,\r | |
764 | FileHandle,\r | |
765 | EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE | EFI_FILE_MODE_CREATE,\r | |
766 | EFI_FILE_DIRECTORY\r | |
a405b86d | 767 | ));\r |
2247dde4 | 768 | }\r |
94b17fa1 | 769 | }\r |
770 | \r | |
771 | /**\r | |
772 | This function reads information from an opened file.\r | |
773 | \r | |
1e6e84c7 | 774 | If FileHandle is not a directory, the function reads the requested number of\r |
775 | bytes from the file at the file's current position and returns them in Buffer.\r | |
94b17fa1 | 776 | If the read goes beyond the end of the file, the read length is truncated to the\r |
1e6e84c7 | 777 | end of the file. The file's current position is increased by the number of bytes\r |
778 | returned. If FileHandle is a directory, the function reads the directory entry\r | |
779 | at the file's current position and returns the entry in Buffer. If the Buffer\r | |
780 | is not large enough to hold the current directory entry, then\r | |
781 | EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated.\r | |
782 | BufferSize is set to be the size of the buffer needed to read the entry. On\r | |
783 | success, the current position is updated to the next directory entry. If there\r | |
784 | are no more directory entries, the read returns a zero-length buffer.\r | |
94b17fa1 | 785 | EFI_FILE_INFO is the structure returned as the directory entry.\r |
786 | \r | |
787 | @param FileHandle the opened file handle\r | |
1e6e84c7 | 788 | @param BufferSize on input the size of buffer in bytes. on return\r |
94b17fa1 | 789 | the number of bytes written.\r |
790 | @param Buffer the buffer to put read data into.\r | |
791 | \r | |
b0934ac4 | 792 | @retval EFI_SUCCESS Data was read.\r |
793 | @retval EFI_NO_MEDIA The device has no media.\r | |
794 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
795 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
796 | @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required\r | |
94b17fa1 | 797 | size.\r |
798 | \r | |
799 | **/\r | |
800 | EFI_STATUS\r | |
801 | EFIAPI\r | |
802 | ShellReadFile(\r | |
a405b86d | 803 | IN SHELL_FILE_HANDLE FileHandle,\r |
94b17fa1 | 804 | IN OUT UINTN *BufferSize,\r |
805 | OUT VOID *Buffer\r | |
a405b86d | 806 | )\r |
807 | {\r | |
d2b4564b | 808 | return (FileFunctionMap.ReadFile(FileHandle, BufferSize, Buffer));\r |
94b17fa1 | 809 | }\r |
810 | \r | |
811 | \r | |
812 | /**\r | |
813 | Write data to a file.\r | |
814 | \r | |
1e6e84c7 | 815 | This function writes the specified number of bytes to the file at the current\r |
816 | file position. The current file position is advanced the actual number of bytes\r | |
817 | written, which is returned in BufferSize. Partial writes only occur when there\r | |
818 | has been a data error during the write attempt (such as "volume space full").\r | |
819 | The file is automatically grown to hold the data if required. Direct writes to\r | |
94b17fa1 | 820 | opened directories are not supported.\r |
821 | \r | |
822 | @param FileHandle The opened file for writing\r | |
823 | @param BufferSize on input the number of bytes in Buffer. On output\r | |
824 | the number of bytes written.\r | |
825 | @param Buffer the buffer containing data to write is stored.\r | |
826 | \r | |
b0934ac4 | 827 | @retval EFI_SUCCESS Data was written.\r |
828 | @retval EFI_UNSUPPORTED Writes to an open directory are not supported.\r | |
829 | @retval EFI_NO_MEDIA The device has no media.\r | |
830 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
831 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
832 | @retval EFI_WRITE_PROTECTED The device is write-protected.\r | |
833 | @retval EFI_ACCESS_DENIED The file was open for read only.\r | |
834 | @retval EFI_VOLUME_FULL The volume is full.\r | |
94b17fa1 | 835 | **/\r |
836 | EFI_STATUS\r | |
837 | EFIAPI\r | |
838 | ShellWriteFile(\r | |
252d9457 | 839 | IN SHELL_FILE_HANDLE FileHandle,\r |
94b17fa1 | 840 | IN OUT UINTN *BufferSize,\r |
841 | IN VOID *Buffer\r | |
a405b86d | 842 | )\r |
843 | {\r | |
d2b4564b | 844 | return (FileFunctionMap.WriteFile(FileHandle, BufferSize, Buffer));\r |
94b17fa1 | 845 | }\r |
846 | \r | |
1e6e84c7 | 847 | /**\r |
94b17fa1 | 848 | Close an open file handle.\r |
849 | \r | |
1e6e84c7 | 850 | This function closes a specified file handle. All "dirty" cached file data is\r |
851 | flushed to the device, and the file is closed. In all cases the handle is\r | |
94b17fa1 | 852 | closed.\r |
853 | \r | |
854 | @param FileHandle the file handle to close.\r | |
855 | \r | |
856 | @retval EFI_SUCCESS the file handle was closed sucessfully.\r | |
857 | **/\r | |
858 | EFI_STATUS\r | |
859 | EFIAPI\r | |
860 | ShellCloseFile (\r | |
a405b86d | 861 | IN SHELL_FILE_HANDLE *FileHandle\r |
862 | )\r | |
863 | {\r | |
d2b4564b | 864 | return (FileFunctionMap.CloseFile(*FileHandle));\r |
94b17fa1 | 865 | }\r |
866 | \r | |
867 | /**\r | |
868 | Delete a file and close the handle\r | |
869 | \r | |
870 | This function closes and deletes a file. In all cases the file handle is closed.\r | |
1e6e84c7 | 871 | If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is\r |
94b17fa1 | 872 | returned, but the handle is still closed.\r |
873 | \r | |
874 | @param FileHandle the file handle to delete\r | |
875 | \r | |
876 | @retval EFI_SUCCESS the file was closed sucessfully\r | |
1e6e84c7 | 877 | @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not\r |
94b17fa1 | 878 | deleted\r |
b0934ac4 | 879 | @retval INVALID_PARAMETER One of the parameters has an invalid value.\r |
94b17fa1 | 880 | **/\r |
881 | EFI_STATUS\r | |
882 | EFIAPI\r | |
883 | ShellDeleteFile (\r | |
b0934ac4 | 884 | IN SHELL_FILE_HANDLE *FileHandle\r |
a405b86d | 885 | )\r |
886 | {\r | |
d2b4564b | 887 | return (FileFunctionMap.DeleteFile(*FileHandle));\r |
94b17fa1 | 888 | }\r |
889 | \r | |
890 | /**\r | |
891 | Set the current position in a file.\r | |
892 | \r | |
1e6e84c7 | 893 | This function sets the current file position for the handle to the position\r |
94b17fa1 | 894 | supplied. With the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only\r |
1e6e84c7 | 895 | absolute positioning is supported, and seeking past the end of the file is\r |
896 | allowed (a subsequent write would grow the file). Seeking to position\r | |
94b17fa1 | 897 | 0xFFFFFFFFFFFFFFFF causes the current position to be set to the end of the file.\r |
1e6e84c7 | 898 | If FileHandle is a directory, the only position that may be set is zero. This\r |
94b17fa1 | 899 | has the effect of starting the read process of the directory entries over.\r |
900 | \r | |
901 | @param FileHandle The file handle on which the position is being set\r | |
902 | @param Position Byte position from begining of file\r | |
903 | \r | |
904 | @retval EFI_SUCCESS Operation completed sucessfully.\r | |
1e6e84c7 | 905 | @retval EFI_UNSUPPORTED the seek request for non-zero is not valid on\r |
94b17fa1 | 906 | directories.\r |
907 | @retval INVALID_PARAMETER One of the parameters has an invalid value.\r | |
908 | **/\r | |
909 | EFI_STATUS\r | |
910 | EFIAPI\r | |
911 | ShellSetFilePosition (\r | |
b0934ac4 | 912 | IN SHELL_FILE_HANDLE FileHandle,\r |
913 | IN UINT64 Position\r | |
a405b86d | 914 | )\r |
915 | {\r | |
d2b4564b | 916 | return (FileFunctionMap.SetFilePosition(FileHandle, Position));\r |
94b17fa1 | 917 | }\r |
918 | \r | |
1e6e84c7 | 919 | /**\r |
94b17fa1 | 920 | Gets a file's current position\r |
921 | \r | |
1e6e84c7 | 922 | This function retrieves the current file position for the file handle. For\r |
923 | directories, the current file position has no meaning outside of the file\r | |
94b17fa1 | 924 | system driver and as such the operation is not supported. An error is returned\r |
925 | if FileHandle is a directory.\r | |
926 | \r | |
927 | @param FileHandle The open file handle on which to get the position.\r | |
928 | @param Position Byte position from begining of file.\r | |
929 | \r | |
930 | @retval EFI_SUCCESS the operation completed sucessfully.\r | |
931 | @retval INVALID_PARAMETER One of the parameters has an invalid value.\r | |
932 | @retval EFI_UNSUPPORTED the request is not valid on directories.\r | |
933 | **/\r | |
934 | EFI_STATUS\r | |
935 | EFIAPI\r | |
936 | ShellGetFilePosition (\r | |
a405b86d | 937 | IN SHELL_FILE_HANDLE FileHandle,\r |
94b17fa1 | 938 | OUT UINT64 *Position\r |
a405b86d | 939 | )\r |
940 | {\r | |
d2b4564b | 941 | return (FileFunctionMap.GetFilePosition(FileHandle, Position));\r |
94b17fa1 | 942 | }\r |
943 | /**\r | |
944 | Flushes data on a file\r | |
1e6e84c7 | 945 | \r |
94b17fa1 | 946 | This function flushes all modified data associated with a file to a device.\r |
947 | \r | |
948 | @param FileHandle The file handle on which to flush data\r | |
949 | \r | |
950 | @retval EFI_SUCCESS The data was flushed.\r | |
951 | @retval EFI_NO_MEDIA The device has no media.\r | |
952 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
953 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
954 | @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r | |
955 | @retval EFI_ACCESS_DENIED The file was opened for read only.\r | |
956 | **/\r | |
957 | EFI_STATUS\r | |
958 | EFIAPI\r | |
959 | ShellFlushFile (\r | |
a405b86d | 960 | IN SHELL_FILE_HANDLE FileHandle\r |
961 | )\r | |
962 | {\r | |
d2b4564b | 963 | return (FileFunctionMap.FlushFile(FileHandle));\r |
94b17fa1 | 964 | }\r |
965 | \r | |
b0934ac4 | 966 | /** Retrieve first entry from a directory.\r |
94b17fa1 | 967 | \r |
b0934ac4 | 968 | This function takes an open directory handle and gets information from the\r |
969 | first entry in the directory. A buffer is allocated to contain\r | |
970 | the information and a pointer to the buffer is returned in *Buffer. The\r | |
971 | caller can use ShellFindNextFile() to get subsequent directory entries.\r | |
94b17fa1 | 972 | \r |
b0934ac4 | 973 | The buffer will be freed by ShellFindNextFile() when the last directory\r |
974 | entry is read. Otherwise, the caller must free the buffer, using FreePool,\r | |
975 | when finished with it.\r | |
976 | \r | |
977 | @param[in] DirHandle The file handle of the directory to search.\r | |
978 | @param[out] Buffer The pointer to the buffer for the file's information.\r | |
94b17fa1 | 979 | \r |
980 | @retval EFI_SUCCESS Found the first file.\r | |
981 | @retval EFI_NOT_FOUND Cannot find the directory.\r | |
982 | @retval EFI_NO_MEDIA The device has no media.\r | |
983 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
984 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
985 | @return Others status of ShellGetFileInfo, ShellSetFilePosition,\r | |
986 | or ShellReadFile\r | |
987 | **/\r | |
988 | EFI_STATUS\r | |
989 | EFIAPI\r | |
990 | ShellFindFirstFile (\r | |
a405b86d | 991 | IN SHELL_FILE_HANDLE DirHandle,\r |
d2b4564b | 992 | OUT EFI_FILE_INFO **Buffer\r |
a405b86d | 993 | )\r |
994 | {\r | |
94b17fa1 | 995 | //\r |
d2b4564b | 996 | // pass to file handle lib\r |
94b17fa1 | 997 | //\r |
d2b4564b | 998 | return (FileHandleFindFirstFile(DirHandle, Buffer));\r |
94b17fa1 | 999 | }\r |
b0934ac4 | 1000 | /** Retrieve next entries from a directory.\r |
94b17fa1 | 1001 | \r |
b0934ac4 | 1002 | To use this function, the caller must first call the ShellFindFirstFile()\r |
1003 | function to get the first directory entry. Subsequent directory entries are\r | |
1004 | retrieved by using the ShellFindNextFile() function. This function can\r | |
1005 | be called several times to get each entry from the directory. If the call of\r | |
1006 | ShellFindNextFile() retrieved the last directory entry, the next call of\r | |
1007 | this function will set *NoFile to TRUE and free the buffer.\r | |
94b17fa1 | 1008 | \r |
b0934ac4 | 1009 | @param[in] DirHandle The file handle of the directory.\r |
1010 | @param[out] Buffer The pointer to buffer for file's information.\r | |
1011 | @param[out] NoFile The pointer to boolean when last file is found.\r | |
94b17fa1 | 1012 | \r |
1013 | @retval EFI_SUCCESS Found the next file, or reached last file\r | |
1014 | @retval EFI_NO_MEDIA The device has no media.\r | |
1015 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
1016 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
1017 | **/\r | |
1018 | EFI_STATUS\r | |
1019 | EFIAPI\r | |
1020 | ShellFindNextFile(\r | |
a405b86d | 1021 | IN SHELL_FILE_HANDLE DirHandle,\r |
94b17fa1 | 1022 | OUT EFI_FILE_INFO *Buffer,\r |
1023 | OUT BOOLEAN *NoFile\r | |
a405b86d | 1024 | )\r |
1025 | {\r | |
94b17fa1 | 1026 | //\r |
d2b4564b | 1027 | // pass to file handle lib\r |
94b17fa1 | 1028 | //\r |
d2b4564b | 1029 | return (FileHandleFindNextFile(DirHandle, Buffer, NoFile));\r |
94b17fa1 | 1030 | }\r |
1031 | /**\r | |
1032 | Retrieve the size of a file.\r | |
1033 | \r | |
1034 | if FileHandle is NULL then ASSERT()\r | |
1035 | if Size is NULL then ASSERT()\r | |
1036 | \r | |
1e6e84c7 | 1037 | This function extracts the file size info from the FileHandle's EFI_FILE_INFO\r |
94b17fa1 | 1038 | data.\r |
1039 | \r | |
1040 | @param FileHandle file handle from which size is retrieved\r | |
1041 | @param Size pointer to size\r | |
1042 | \r | |
1043 | @retval EFI_SUCCESS operation was completed sucessfully\r | |
1044 | @retval EFI_DEVICE_ERROR cannot access the file\r | |
1045 | **/\r | |
1046 | EFI_STATUS\r | |
1047 | EFIAPI\r | |
1048 | ShellGetFileSize (\r | |
a405b86d | 1049 | IN SHELL_FILE_HANDLE FileHandle,\r |
94b17fa1 | 1050 | OUT UINT64 *Size\r |
a405b86d | 1051 | )\r |
1052 | {\r | |
d2b4564b | 1053 | return (FileFunctionMap.GetFileSize(FileHandle, Size));\r |
94b17fa1 | 1054 | }\r |
1055 | /**\r | |
1056 | Retrieves the status of the break execution flag\r | |
1057 | \r | |
1058 | this function is useful to check whether the application is being asked to halt by the shell.\r | |
1059 | \r | |
1060 | @retval TRUE the execution break is enabled\r | |
1061 | @retval FALSE the execution break is not enabled\r | |
1062 | **/\r | |
1063 | BOOLEAN\r | |
1064 | EFIAPI\r | |
1065 | ShellGetExecutionBreakFlag(\r | |
1066 | VOID\r | |
1067 | )\r | |
1068 | {\r | |
1e6e84c7 | 1069 | //\r |
94b17fa1 | 1070 | // Check for UEFI Shell 2.0 protocols\r |
1071 | //\r | |
366f81a0 | 1072 | if (gEfiShellProtocol != NULL) {\r |
94b17fa1 | 1073 | \r |
1074 | //\r | |
1075 | // We are using UEFI Shell 2.0; see if the event has been triggered\r | |
1076 | //\r | |
366f81a0 | 1077 | if (gBS->CheckEvent(gEfiShellProtocol->ExecutionBreak) != EFI_SUCCESS) {\r |
94b17fa1 | 1078 | return (FALSE);\r |
1079 | }\r | |
1080 | return (TRUE);\r | |
1e6e84c7 | 1081 | }\r |
94b17fa1 | 1082 | \r |
1083 | //\r | |
1084 | // using EFI Shell; call the function to check\r | |
1085 | //\r | |
92a5447e | 1086 | if (mEfiShellEnvironment2 != NULL) {\r |
1087 | return (mEfiShellEnvironment2->GetExecutionBreak());\r | |
1088 | }\r | |
1089 | \r | |
1090 | return (FALSE);\r | |
94b17fa1 | 1091 | }\r |
1092 | /**\r | |
1093 | return the value of an environment variable\r | |
1094 | \r | |
1e6e84c7 | 1095 | this function gets the value of the environment variable set by the\r |
94b17fa1 | 1096 | ShellSetEnvironmentVariable function\r |
1097 | \r | |
1098 | @param EnvKey The key name of the environment variable.\r | |
1099 | \r | |
1100 | @retval NULL the named environment variable does not exist.\r | |
1101 | @return != NULL pointer to the value of the environment variable\r | |
1102 | **/\r | |
1103 | CONST CHAR16*\r | |
1104 | EFIAPI\r | |
1105 | ShellGetEnvironmentVariable (\r | |
9b3bf083 | 1106 | IN CONST CHAR16 *EnvKey\r |
94b17fa1 | 1107 | )\r |
1108 | {\r | |
1e6e84c7 | 1109 | //\r |
94b17fa1 | 1110 | // Check for UEFI Shell 2.0 protocols\r |
1111 | //\r | |
366f81a0 | 1112 | if (gEfiShellProtocol != NULL) {\r |
1113 | return (gEfiShellProtocol->GetEnv(EnvKey));\r | |
94b17fa1 | 1114 | }\r |
1115 | \r | |
1116 | //\r | |
92a5447e | 1117 | // Check for EFI shell\r |
94b17fa1 | 1118 | //\r |
92a5447e | 1119 | if (mEfiShellEnvironment2 != NULL) {\r |
1120 | return (mEfiShellEnvironment2->GetEnv((CHAR16*)EnvKey));\r | |
1121 | }\r | |
94b17fa1 | 1122 | \r |
92a5447e | 1123 | return NULL;\r |
94b17fa1 | 1124 | }\r |
1125 | /**\r | |
1126 | set the value of an environment variable\r | |
1127 | \r | |
1128 | This function changes the current value of the specified environment variable. If the\r | |
1129 | environment variable exists and the Value is an empty string, then the environment\r | |
1130 | variable is deleted. If the environment variable exists and the Value is not an empty\r | |
1131 | string, then the value of the environment variable is changed. If the environment\r | |
1132 | variable does not exist and the Value is an empty string, there is no action. If the\r | |
1133 | environment variable does not exist and the Value is a non-empty string, then the\r | |
1134 | environment variable is created and assigned the specified value.\r | |
1135 | \r | |
1136 | This is not supported pre-UEFI Shell 2.0.\r | |
1137 | \r | |
1138 | @param EnvKey The key name of the environment variable.\r | |
1139 | @param EnvVal The Value of the environment variable\r | |
1140 | @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).\r | |
1141 | \r | |
1142 | @retval EFI_SUCCESS the operation was completed sucessfully\r | |
1143 | @retval EFI_UNSUPPORTED This operation is not allowed in pre UEFI 2.0 Shell environments\r | |
1144 | **/\r | |
1145 | EFI_STATUS\r | |
1146 | EFIAPI\r | |
1147 | ShellSetEnvironmentVariable (\r | |
1148 | IN CONST CHAR16 *EnvKey,\r | |
1149 | IN CONST CHAR16 *EnvVal,\r | |
1150 | IN BOOLEAN Volatile\r | |
1151 | )\r | |
1152 | {\r | |
1e6e84c7 | 1153 | //\r |
94b17fa1 | 1154 | // Check for UEFI Shell 2.0 protocols\r |
1155 | //\r | |
366f81a0 | 1156 | if (gEfiShellProtocol != NULL) {\r |
1157 | return (gEfiShellProtocol->SetEnv(EnvKey, EnvVal, Volatile));\r | |
1e6e84c7 | 1158 | }\r |
94b17fa1 | 1159 | \r |
1160 | //\r | |
1161 | // This feature does not exist under EFI shell\r | |
1162 | //\r | |
1163 | return (EFI_UNSUPPORTED);\r | |
1164 | }\r | |
a405b86d | 1165 | \r |
94b17fa1 | 1166 | /**\r |
a405b86d | 1167 | Cause the shell to parse and execute a command line.\r |
94b17fa1 | 1168 | \r |
1169 | This function creates a nested instance of the shell and executes the specified\r | |
a405b86d | 1170 | command (CommandLine) with the specified environment (Environment). Upon return,\r |
1171 | the status code returned by the specified command is placed in StatusCode.\r | |
1172 | If Environment is NULL, then the current environment is used and all changes made\r | |
1173 | by the commands executed will be reflected in the current environment. If the\r | |
1174 | Environment is non-NULL, then the changes made will be discarded.\r | |
1175 | The CommandLine is executed from the current working directory on the current\r | |
1176 | device.\r | |
1177 | \r | |
3877d0f5 | 1178 | The EnvironmentVariables pararemeter is ignored in a pre-UEFI Shell 2.0\r |
a405b86d | 1179 | environment. The values pointed to by the parameters will be unchanged by the\r |
1180 | ShellExecute() function. The Output parameter has no effect in a\r | |
1181 | UEFI Shell 2.0 environment.\r | |
1182 | \r | |
1183 | @param[in] ParentHandle The parent image starting the operation.\r | |
1184 | @param[in] CommandLine The pointer to a NULL terminated command line.\r | |
1185 | @param[in] Output True to display debug output. False to hide it.\r | |
1186 | @param[in] EnvironmentVariables Optional pointer to array of environment variables\r | |
1187 | in the form "x=y". If NULL, the current set is used.\r | |
1188 | @param[out] Status The status of the run command line.\r | |
1189 | \r | |
1190 | @retval EFI_SUCCESS The operation completed sucessfully. Status\r | |
1191 | contains the status code returned.\r | |
1192 | @retval EFI_INVALID_PARAMETER A parameter contains an invalid value.\r | |
1193 | @retval EFI_OUT_OF_RESOURCES Out of resources.\r | |
1194 | @retval EFI_UNSUPPORTED The operation is not allowed.\r | |
94b17fa1 | 1195 | **/\r |
1196 | EFI_STATUS\r | |
1197 | EFIAPI\r | |
1198 | ShellExecute (\r | |
1199 | IN EFI_HANDLE *ParentHandle,\r | |
1200 | IN CHAR16 *CommandLine OPTIONAL,\r | |
1201 | IN BOOLEAN Output OPTIONAL,\r | |
1202 | IN CHAR16 **EnvironmentVariables OPTIONAL,\r | |
1203 | OUT EFI_STATUS *Status OPTIONAL\r | |
1204 | )\r | |
1205 | {\r | |
3877d0f5 | 1206 | EFI_STATUS CmdStatus;\r |
1e6e84c7 | 1207 | //\r |
94b17fa1 | 1208 | // Check for UEFI Shell 2.0 protocols\r |
1209 | //\r | |
366f81a0 | 1210 | if (gEfiShellProtocol != NULL) {\r |
94b17fa1 | 1211 | //\r |
1212 | // Call UEFI Shell 2.0 version (not using Output parameter)\r | |
1213 | //\r | |
366f81a0 | 1214 | return (gEfiShellProtocol->Execute(ParentHandle,\r |
94b17fa1 | 1215 | CommandLine,\r |
1216 | EnvironmentVariables,\r | |
1217 | Status));\r | |
1e6e84c7 | 1218 | }\r |
92a5447e | 1219 | \r |
94b17fa1 | 1220 | //\r |
92a5447e | 1221 | // Check for EFI shell\r |
94b17fa1 | 1222 | //\r |
92a5447e | 1223 | if (mEfiShellEnvironment2 != NULL) {\r |
1224 | //\r | |
3877d0f5 | 1225 | // Call EFI Shell version.\r |
92a5447e | 1226 | // Due to oddity in the EFI shell we want to dereference the ParentHandle here\r |
1227 | //\r | |
3877d0f5 | 1228 | CmdStatus = (mEfiShellEnvironment2->Execute(*ParentHandle,\r |
92a5447e | 1229 | CommandLine,\r |
1230 | Output));\r | |
3877d0f5 BJ |
1231 | //\r |
1232 | // No Status output parameter so just use the returned status\r | |
1233 | //\r | |
1234 | if (Status != NULL) {\r | |
1235 | *Status = CmdStatus;\r | |
1236 | }\r | |
1237 | //\r | |
1238 | // If there was an error, we can't tell if it was from the command or from\r | |
1239 | // the Execute() function, so we'll just assume the shell ran successfully\r | |
1240 | // and the error came from the command.\r | |
1241 | //\r | |
1242 | return EFI_SUCCESS;\r | |
92a5447e | 1243 | }\r |
1244 | \r | |
1245 | return (EFI_UNSUPPORTED);\r | |
94b17fa1 | 1246 | }\r |
3877d0f5 | 1247 | \r |
94b17fa1 | 1248 | /**\r |
1249 | Retreives the current directory path\r | |
1250 | \r | |
1e6e84c7 | 1251 | If the DeviceName is NULL, it returns the current device's current directory\r |
1252 | name. If the DeviceName is not NULL, it returns the current directory name\r | |
94b17fa1 | 1253 | on specified drive.\r |
1254 | \r | |
1255 | @param DeviceName the name of the drive to get directory on\r | |
1256 | \r | |
1257 | @retval NULL the directory does not exist\r | |
1258 | @return != NULL the directory\r | |
1259 | **/\r | |
1260 | CONST CHAR16*\r | |
1261 | EFIAPI\r | |
1262 | ShellGetCurrentDir (\r | |
a405b86d | 1263 | IN CHAR16 * CONST DeviceName OPTIONAL\r |
94b17fa1 | 1264 | )\r |
1265 | {\r | |
1e6e84c7 | 1266 | //\r |
94b17fa1 | 1267 | // Check for UEFI Shell 2.0 protocols\r |
1268 | //\r | |
366f81a0 | 1269 | if (gEfiShellProtocol != NULL) {\r |
1270 | return (gEfiShellProtocol->GetCurDir(DeviceName));\r | |
1e6e84c7 | 1271 | }\r |
92a5447e | 1272 | \r |
94b17fa1 | 1273 | //\r |
8bd282be | 1274 | // Check for EFI shell\r |
94b17fa1 | 1275 | //\r |
8bd282be | 1276 | if (mEfiShellEnvironment2 != NULL) {\r |
1277 | return (mEfiShellEnvironment2->CurDir(DeviceName));\r | |
1278 | }\r | |
1279 | \r | |
1280 | return (NULL);\r | |
94b17fa1 | 1281 | }\r |
1282 | /**\r | |
1283 | sets (enabled or disabled) the page break mode\r | |
1284 | \r | |
1e6e84c7 | 1285 | when page break mode is enabled the screen will stop scrolling\r |
94b17fa1 | 1286 | and wait for operator input before scrolling a subsequent screen.\r |
1287 | \r | |
1288 | @param CurrentState TRUE to enable and FALSE to disable\r | |
1289 | **/\r | |
1e6e84c7 | 1290 | VOID\r |
94b17fa1 | 1291 | EFIAPI\r |
1292 | ShellSetPageBreakMode (\r | |
1293 | IN BOOLEAN CurrentState\r | |
1294 | )\r | |
1295 | {\r | |
1296 | //\r | |
1297 | // check for enabling\r | |
1298 | //\r | |
1299 | if (CurrentState != 0x00) {\r | |
1e6e84c7 | 1300 | //\r |
94b17fa1 | 1301 | // check for UEFI Shell 2.0\r |
1302 | //\r | |
366f81a0 | 1303 | if (gEfiShellProtocol != NULL) {\r |
94b17fa1 | 1304 | //\r |
1305 | // Enable with UEFI 2.0 Shell\r | |
1306 | //\r | |
366f81a0 | 1307 | gEfiShellProtocol->EnablePageBreak();\r |
94b17fa1 | 1308 | return;\r |
1309 | } else {\r | |
1e6e84c7 | 1310 | //\r |
92a5447e | 1311 | // Check for EFI shell\r |
94b17fa1 | 1312 | //\r |
92a5447e | 1313 | if (mEfiShellEnvironment2 != NULL) {\r |
1314 | //\r | |
1315 | // Enable with EFI Shell\r | |
1316 | //\r | |
1317 | mEfiShellEnvironment2->EnablePageBreak (DEFAULT_INIT_ROW, DEFAULT_AUTO_LF);\r | |
1318 | return;\r | |
1319 | }\r | |
94b17fa1 | 1320 | }\r |
1321 | } else {\r | |
1e6e84c7 | 1322 | //\r |
94b17fa1 | 1323 | // check for UEFI Shell 2.0\r |
1324 | //\r | |
366f81a0 | 1325 | if (gEfiShellProtocol != NULL) {\r |
94b17fa1 | 1326 | //\r |
1327 | // Disable with UEFI 2.0 Shell\r | |
1328 | //\r | |
366f81a0 | 1329 | gEfiShellProtocol->DisablePageBreak();\r |
94b17fa1 | 1330 | return;\r |
1331 | } else {\r | |
1e6e84c7 | 1332 | //\r |
92a5447e | 1333 | // Check for EFI shell\r |
94b17fa1 | 1334 | //\r |
92a5447e | 1335 | if (mEfiShellEnvironment2 != NULL) {\r |
1336 | //\r | |
1337 | // Disable with EFI Shell\r | |
1338 | //\r | |
1339 | mEfiShellEnvironment2->DisablePageBreak ();\r | |
1340 | return;\r | |
1341 | }\r | |
94b17fa1 | 1342 | }\r |
1343 | }\r | |
1344 | }\r | |
1345 | \r | |
1346 | ///\r | |
1347 | /// version of EFI_SHELL_FILE_INFO struct, except has no CONST pointers.\r | |
1348 | /// This allows for the struct to be populated.\r | |
1349 | ///\r | |
1350 | typedef struct {\r | |
d2b4564b | 1351 | LIST_ENTRY Link;\r |
94b17fa1 | 1352 | EFI_STATUS Status;\r |
1353 | CHAR16 *FullName;\r | |
1354 | CHAR16 *FileName;\r | |
a405b86d | 1355 | SHELL_FILE_HANDLE Handle;\r |
94b17fa1 | 1356 | EFI_FILE_INFO *Info;\r |
1357 | } EFI_SHELL_FILE_INFO_NO_CONST;\r | |
1358 | \r | |
1359 | /**\r | |
1360 | Converts a EFI shell list of structures to the coresponding UEFI Shell 2.0 type of list.\r | |
1361 | \r | |
1362 | if OldStyleFileList is NULL then ASSERT()\r | |
1363 | \r | |
1e6e84c7 | 1364 | this function will convert a SHELL_FILE_ARG based list into a callee allocated\r |
94b17fa1 | 1365 | EFI_SHELL_FILE_INFO based list. it is up to the caller to free the memory via\r |
1366 | the ShellCloseFileMetaArg function.\r | |
1367 | \r | |
4ff7e37b ED |
1368 | @param[in] FileList the EFI shell list type\r |
1369 | @param[in, out] ListHead the list to add to\r | |
94b17fa1 | 1370 | \r |
1371 | @retval the resultant head of the double linked new format list;\r | |
1372 | **/\r | |
1373 | LIST_ENTRY*\r | |
1374 | EFIAPI\r | |
1375 | InternalShellConvertFileListType (\r | |
9b3bf083 | 1376 | IN LIST_ENTRY *FileList,\r |
1377 | IN OUT LIST_ENTRY *ListHead\r | |
125c2cf4 | 1378 | )\r |
1379 | {\r | |
94b17fa1 | 1380 | SHELL_FILE_ARG *OldInfo;\r |
9b3bf083 | 1381 | LIST_ENTRY *Link;\r |
94b17fa1 | 1382 | EFI_SHELL_FILE_INFO_NO_CONST *NewInfo;\r |
1383 | \r | |
1384 | //\r | |
9b3bf083 | 1385 | // ASSERTs\r |
94b17fa1 | 1386 | //\r |
9b3bf083 | 1387 | ASSERT(FileList != NULL);\r |
1388 | ASSERT(ListHead != NULL);\r | |
94b17fa1 | 1389 | \r |
1390 | //\r | |
1391 | // enumerate through each member of the old list and copy\r | |
1392 | //\r | |
d2b4564b | 1393 | for (Link = FileList->ForwardLink; Link != FileList; Link = Link->ForwardLink) {\r |
94b17fa1 | 1394 | OldInfo = CR (Link, SHELL_FILE_ARG, Link, SHELL_FILE_ARG_SIGNATURE);\r |
a405b86d | 1395 | ASSERT(OldInfo != NULL);\r |
1396 | \r | |
1397 | //\r | |
1398 | // Skip ones that failed to open...\r | |
1399 | //\r | |
1400 | if (OldInfo->Status != EFI_SUCCESS) {\r | |
1401 | continue;\r | |
1402 | }\r | |
94b17fa1 | 1403 | \r |
1404 | //\r | |
1405 | // make sure the old list was valid\r | |
1406 | //\r | |
94b17fa1 | 1407 | ASSERT(OldInfo->Info != NULL);\r |
1408 | ASSERT(OldInfo->FullName != NULL);\r | |
1409 | ASSERT(OldInfo->FileName != NULL);\r | |
1410 | \r | |
1411 | //\r | |
1412 | // allocate a new EFI_SHELL_FILE_INFO object\r | |
1413 | //\r | |
1414 | NewInfo = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));\r | |
c9d92df0 | 1415 | if (NewInfo == NULL) {\r |
7a95efda | 1416 | ShellCloseFileMetaArg((EFI_SHELL_FILE_INFO**)(&ListHead));\r |
beab0fc5 | 1417 | ListHead = NULL;\r |
c9d92df0 | 1418 | break;\r |
1419 | }\r | |
1e6e84c7 | 1420 | \r |
1421 | //\r | |
94b17fa1 | 1422 | // copy the simple items\r |
1423 | //\r | |
1424 | NewInfo->Handle = OldInfo->Handle;\r | |
1425 | NewInfo->Status = OldInfo->Status;\r | |
1426 | \r | |
d2b4564b | 1427 | // old shell checks for 0 not NULL\r |
1428 | OldInfo->Handle = 0;\r | |
1429 | \r | |
94b17fa1 | 1430 | //\r |
1431 | // allocate new space to copy strings and structure\r | |
1432 | //\r | |
1433 | NewInfo->FullName = AllocateZeroPool(StrSize(OldInfo->FullName));\r | |
1434 | NewInfo->FileName = AllocateZeroPool(StrSize(OldInfo->FileName));\r | |
1435 | NewInfo->Info = AllocateZeroPool((UINTN)OldInfo->Info->Size);\r | |
1e6e84c7 | 1436 | \r |
94b17fa1 | 1437 | //\r |
1438 | // make sure all the memory allocations were sucessful\r | |
1439 | //\r | |
beab0fc5 | 1440 | if (NULL == NewInfo->FullName || NewInfo->FileName == NULL || NewInfo->Info == NULL) {\r |
7a95efda | 1441 | ShellCloseFileMetaArg((EFI_SHELL_FILE_INFO**)(&ListHead));\r |
beab0fc5 | 1442 | ListHead = NULL;\r |
1443 | break;\r | |
1444 | }\r | |
94b17fa1 | 1445 | \r |
1446 | //\r | |
1447 | // Copt the strings and structure\r | |
1448 | //\r | |
1449 | StrCpy(NewInfo->FullName, OldInfo->FullName);\r | |
1450 | StrCpy(NewInfo->FileName, OldInfo->FileName);\r | |
1451 | gBS->CopyMem (NewInfo->Info, OldInfo->Info, (UINTN)OldInfo->Info->Size);\r | |
1452 | \r | |
1453 | //\r | |
1454 | // add that to the list\r | |
1455 | //\r | |
9b3bf083 | 1456 | InsertTailList(ListHead, &NewInfo->Link);\r |
94b17fa1 | 1457 | }\r |
1458 | return (ListHead);\r | |
1459 | }\r | |
1460 | /**\r | |
1461 | Opens a group of files based on a path.\r | |
1462 | \r | |
1e6e84c7 | 1463 | This function uses the Arg to open all the matching files. Each matched\r |
70879314 BJ |
1464 | file has a SHELL_FILE_INFO structure to record the file information. These\r |
1465 | structures are placed on the list ListHead. Users can get the SHELL_FILE_INFO\r | |
94b17fa1 | 1466 | structures from ListHead to access each file. This function supports wildcards\r |
1e6e84c7 | 1467 | and will process '?' and '*' as such. the list must be freed with a call to\r |
94b17fa1 | 1468 | ShellCloseFileMetaArg().\r |
1469 | \r | |
1e6e84c7 | 1470 | If you are NOT appending to an existing list *ListHead must be NULL. If\r |
5f7431d0 | 1471 | *ListHead is NULL then it must be callee freed.\r |
94b17fa1 | 1472 | \r |
1473 | @param Arg pointer to path string\r | |
1474 | @param OpenMode mode to open files with\r | |
1475 | @param ListHead head of linked list of results\r | |
1476 | \r | |
1e6e84c7 | 1477 | @retval EFI_SUCCESS the operation was sucessful and the list head\r |
94b17fa1 | 1478 | contains the list of opened files\r |
94b17fa1 | 1479 | @return != EFI_SUCCESS the operation failed\r |
1480 | \r | |
1481 | @sa InternalShellConvertFileListType\r | |
1482 | **/\r | |
1483 | EFI_STATUS\r | |
1484 | EFIAPI\r | |
1485 | ShellOpenFileMetaArg (\r | |
1486 | IN CHAR16 *Arg,\r | |
1487 | IN UINT64 OpenMode,\r | |
1488 | IN OUT EFI_SHELL_FILE_INFO **ListHead\r | |
1489 | )\r | |
1490 | {\r | |
1491 | EFI_STATUS Status;\r | |
9b3bf083 | 1492 | LIST_ENTRY mOldStyleFileList;\r |
1e6e84c7 | 1493 | \r |
94b17fa1 | 1494 | //\r |
1495 | // ASSERT that Arg and ListHead are not NULL\r | |
1496 | //\r | |
1497 | ASSERT(Arg != NULL);\r | |
1498 | ASSERT(ListHead != NULL);\r | |
1499 | \r | |
1e6e84c7 | 1500 | //\r |
94b17fa1 | 1501 | // Check for UEFI Shell 2.0 protocols\r |
1502 | //\r | |
366f81a0 | 1503 | if (gEfiShellProtocol != NULL) {\r |
5f7431d0 | 1504 | if (*ListHead == NULL) {\r |
1505 | *ListHead = (EFI_SHELL_FILE_INFO*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));\r | |
1506 | if (*ListHead == NULL) {\r | |
1507 | return (EFI_OUT_OF_RESOURCES);\r | |
1508 | }\r | |
1509 | InitializeListHead(&((*ListHead)->Link));\r | |
1e6e84c7 | 1510 | }\r |
366f81a0 | 1511 | Status = gEfiShellProtocol->OpenFileList(Arg,\r |
1e6e84c7 | 1512 | OpenMode,\r |
2247dde4 | 1513 | ListHead);\r |
1514 | if (EFI_ERROR(Status)) {\r | |
366f81a0 | 1515 | gEfiShellProtocol->RemoveDupInFileList(ListHead);\r |
2247dde4 | 1516 | } else {\r |
366f81a0 | 1517 | Status = gEfiShellProtocol->RemoveDupInFileList(ListHead);\r |
2247dde4 | 1518 | }\r |
a405b86d | 1519 | if (*ListHead != NULL && IsListEmpty(&(*ListHead)->Link)) {\r |
1520 | FreePool(*ListHead);\r | |
1521 | *ListHead = NULL;\r | |
1522 | return (EFI_NOT_FOUND);\r | |
1523 | }\r | |
2247dde4 | 1524 | return (Status);\r |
1e6e84c7 | 1525 | }\r |
94b17fa1 | 1526 | \r |
1527 | //\r | |
92a5447e | 1528 | // Check for EFI shell\r |
94b17fa1 | 1529 | //\r |
92a5447e | 1530 | if (mEfiShellEnvironment2 != NULL) {\r |
1531 | //\r | |
1532 | // make sure the list head is initialized\r | |
1533 | //\r | |
1534 | InitializeListHead(&mOldStyleFileList);\r | |
94b17fa1 | 1535 | \r |
92a5447e | 1536 | //\r |
1537 | // Get the EFI Shell list of files\r | |
1538 | //\r | |
1539 | Status = mEfiShellEnvironment2->FileMetaArg(Arg, &mOldStyleFileList);\r | |
1540 | if (EFI_ERROR(Status)) {\r | |
1541 | *ListHead = NULL;\r | |
1542 | return (Status);\r | |
1543 | }\r | |
94b17fa1 | 1544 | \r |
9b3bf083 | 1545 | if (*ListHead == NULL) {\r |
92a5447e | 1546 | *ListHead = (EFI_SHELL_FILE_INFO *)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));\r |
1547 | if (*ListHead == NULL) {\r | |
1548 | return (EFI_OUT_OF_RESOURCES);\r | |
1549 | }\r | |
1550 | InitializeListHead(&((*ListHead)->Link));\r | |
9b3bf083 | 1551 | }\r |
9b3bf083 | 1552 | \r |
92a5447e | 1553 | //\r |
1554 | // Convert that to equivalent of UEFI Shell 2.0 structure\r | |
1555 | //\r | |
1556 | InternalShellConvertFileListType(&mOldStyleFileList, &(*ListHead)->Link);\r | |
94b17fa1 | 1557 | \r |
92a5447e | 1558 | //\r |
1559 | // Free the EFI Shell version that was converted.\r | |
1560 | //\r | |
1561 | mEfiShellEnvironment2->FreeFileList(&mOldStyleFileList);\r | |
94b17fa1 | 1562 | \r |
92a5447e | 1563 | if ((*ListHead)->Link.ForwardLink == (*ListHead)->Link.BackLink && (*ListHead)->Link.BackLink == &((*ListHead)->Link)) {\r |
1564 | FreePool(*ListHead);\r | |
1565 | *ListHead = NULL;\r | |
1566 | Status = EFI_NOT_FOUND;\r | |
1567 | }\r | |
1568 | return (Status);\r | |
a405b86d | 1569 | }\r |
1570 | \r | |
92a5447e | 1571 | return (EFI_UNSUPPORTED);\r |
94b17fa1 | 1572 | }\r |
1573 | /**\r | |
a405b86d | 1574 | Free the linked list returned from ShellOpenFileMetaArg.\r |
94b17fa1 | 1575 | \r |
a405b86d | 1576 | if ListHead is NULL then ASSERT().\r |
94b17fa1 | 1577 | \r |
a405b86d | 1578 | @param ListHead the pointer to free.\r |
94b17fa1 | 1579 | \r |
a405b86d | 1580 | @retval EFI_SUCCESS the operation was sucessful.\r |
94b17fa1 | 1581 | **/\r |
1582 | EFI_STATUS\r | |
1583 | EFIAPI\r | |
1584 | ShellCloseFileMetaArg (\r | |
1585 | IN OUT EFI_SHELL_FILE_INFO **ListHead\r | |
1586 | )\r | |
1587 | {\r | |
1588 | LIST_ENTRY *Node;\r | |
1589 | \r | |
1590 | //\r | |
1591 | // ASSERT that ListHead is not NULL\r | |
1592 | //\r | |
1593 | ASSERT(ListHead != NULL);\r | |
1594 | \r | |
1e6e84c7 | 1595 | //\r |
94b17fa1 | 1596 | // Check for UEFI Shell 2.0 protocols\r |
1597 | //\r | |
366f81a0 | 1598 | if (gEfiShellProtocol != NULL) {\r |
1599 | return (gEfiShellProtocol->FreeFileList(ListHead));\r | |
92a5447e | 1600 | } else if (mEfiShellEnvironment2 != NULL) {\r |
94b17fa1 | 1601 | //\r |
1e6e84c7 | 1602 | // Since this is EFI Shell version we need to free our internally made copy\r |
94b17fa1 | 1603 | // of the list\r |
1604 | //\r | |
1e6e84c7 | 1605 | for ( Node = GetFirstNode(&(*ListHead)->Link)\r |
a405b86d | 1606 | ; *ListHead != NULL && !IsListEmpty(&(*ListHead)->Link)\r |
9b3bf083 | 1607 | ; Node = GetFirstNode(&(*ListHead)->Link)) {\r |
94b17fa1 | 1608 | RemoveEntryList(Node);\r |
a405b86d | 1609 | ((EFI_FILE_PROTOCOL*)((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->Handle)->Close(((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->Handle);\r |
94b17fa1 | 1610 | FreePool(((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->FullName);\r |
1611 | FreePool(((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->FileName);\r | |
1612 | FreePool(((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->Info);\r | |
1613 | FreePool((EFI_SHELL_FILE_INFO_NO_CONST*)Node);\r | |
1614 | }\r | |
75a5e2ef | 1615 | SHELL_FREE_NON_NULL(*ListHead);\r |
94b17fa1 | 1616 | return EFI_SUCCESS;\r |
1617 | }\r | |
92a5447e | 1618 | \r |
1619 | return (EFI_UNSUPPORTED);\r | |
94b17fa1 | 1620 | }\r |
1621 | \r | |
125c2cf4 | 1622 | /**\r |
1623 | Find a file by searching the CWD and then the path.\r | |
1624 | \r | |
b3011f40 | 1625 | If FileName is NULL then ASSERT.\r |
125c2cf4 | 1626 | \r |
b3011f40 | 1627 | If the return value is not NULL then the memory must be caller freed.\r |
125c2cf4 | 1628 | \r |
1629 | @param FileName Filename string.\r | |
1630 | \r | |
1631 | @retval NULL the file was not found\r | |
1632 | @return !NULL the full path to the file.\r | |
1633 | **/\r | |
1634 | CHAR16 *\r | |
1635 | EFIAPI\r | |
1636 | ShellFindFilePath (\r | |
1637 | IN CONST CHAR16 *FileName\r | |
1638 | )\r | |
1639 | {\r | |
1640 | CONST CHAR16 *Path;\r | |
a405b86d | 1641 | SHELL_FILE_HANDLE Handle;\r |
125c2cf4 | 1642 | EFI_STATUS Status;\r |
1643 | CHAR16 *RetVal;\r | |
1644 | CHAR16 *TestPath;\r | |
1645 | CONST CHAR16 *Walker;\r | |
36a9d672 | 1646 | UINTN Size;\r |
1cd45e78 | 1647 | CHAR16 *TempChar;\r |
125c2cf4 | 1648 | \r |
1649 | RetVal = NULL;\r | |
1650 | \r | |
a405b86d | 1651 | //\r |
1652 | // First make sure its not an absolute path.\r | |
1653 | //\r | |
1654 | Status = ShellOpenFileByName(FileName, &Handle, EFI_FILE_MODE_READ, 0);\r | |
1655 | if (!EFI_ERROR(Status)){\r | |
1656 | if (FileHandleIsDirectory(Handle) != EFI_SUCCESS) {\r | |
1657 | ASSERT(RetVal == NULL);\r | |
1658 | RetVal = StrnCatGrow(&RetVal, NULL, FileName, 0);\r | |
1659 | ShellCloseFile(&Handle);\r | |
1660 | return (RetVal);\r | |
1661 | } else {\r | |
1662 | ShellCloseFile(&Handle);\r | |
1663 | }\r | |
1664 | }\r | |
1665 | \r | |
125c2cf4 | 1666 | Path = ShellGetEnvironmentVariable(L"cwd");\r |
1667 | if (Path != NULL) {\r | |
36a9d672 | 1668 | Size = StrSize(Path);\r |
1669 | Size += StrSize(FileName);\r | |
1670 | TestPath = AllocateZeroPool(Size);\r | |
c9d92df0 | 1671 | if (TestPath == NULL) {\r |
1672 | return (NULL);\r | |
1673 | }\r | |
125c2cf4 | 1674 | StrCpy(TestPath, Path);\r |
1675 | StrCat(TestPath, FileName);\r | |
1676 | Status = ShellOpenFileByName(TestPath, &Handle, EFI_FILE_MODE_READ, 0);\r | |
1677 | if (!EFI_ERROR(Status)){\r | |
a405b86d | 1678 | if (FileHandleIsDirectory(Handle) != EFI_SUCCESS) {\r |
1679 | ASSERT(RetVal == NULL);\r | |
1680 | RetVal = StrnCatGrow(&RetVal, NULL, TestPath, 0);\r | |
1681 | ShellCloseFile(&Handle);\r | |
1682 | FreePool(TestPath);\r | |
1683 | return (RetVal);\r | |
1684 | } else {\r | |
1685 | ShellCloseFile(&Handle);\r | |
1686 | }\r | |
125c2cf4 | 1687 | }\r |
1688 | FreePool(TestPath);\r | |
1689 | }\r | |
1690 | Path = ShellGetEnvironmentVariable(L"path");\r | |
1691 | if (Path != NULL) {\r | |
a405b86d | 1692 | Size = StrSize(Path)+sizeof(CHAR16);\r |
36a9d672 | 1693 | Size += StrSize(FileName);\r |
1694 | TestPath = AllocateZeroPool(Size);\r | |
3e082d58 | 1695 | if (TestPath == NULL) {\r |
1696 | return (NULL);\r | |
1697 | }\r | |
1e6e84c7 | 1698 | Walker = (CHAR16*)Path;\r |
125c2cf4 | 1699 | do {\r |
1700 | CopyMem(TestPath, Walker, StrSize(Walker));\r | |
3e082d58 | 1701 | if (TestPath != NULL) {\r |
1702 | TempChar = StrStr(TestPath, L";");\r | |
1703 | if (TempChar != NULL) {\r | |
1704 | *TempChar = CHAR_NULL;\r | |
1705 | }\r | |
1706 | if (TestPath[StrLen(TestPath)-1] != L'\\') {\r | |
1707 | StrCat(TestPath, L"\\");\r | |
1708 | }\r | |
89e8537a | 1709 | if (FileName[0] == L'\\') {\r |
1710 | FileName++;\r | |
1711 | }\r | |
3e082d58 | 1712 | StrCat(TestPath, FileName);\r |
1713 | if (StrStr(Walker, L";") != NULL) {\r | |
1714 | Walker = StrStr(Walker, L";") + 1;\r | |
a405b86d | 1715 | } else {\r |
3e082d58 | 1716 | Walker = NULL;\r |
1717 | }\r | |
1718 | Status = ShellOpenFileByName(TestPath, &Handle, EFI_FILE_MODE_READ, 0);\r | |
1719 | if (!EFI_ERROR(Status)){\r | |
1720 | if (FileHandleIsDirectory(Handle) != EFI_SUCCESS) {\r | |
1721 | ASSERT(RetVal == NULL);\r | |
1722 | RetVal = StrnCatGrow(&RetVal, NULL, TestPath, 0);\r | |
1723 | ShellCloseFile(&Handle);\r | |
1724 | break;\r | |
1725 | } else {\r | |
1726 | ShellCloseFile(&Handle);\r | |
1727 | }\r | |
a405b86d | 1728 | }\r |
125c2cf4 | 1729 | }\r |
1730 | } while (Walker != NULL && Walker[0] != CHAR_NULL);\r | |
1731 | FreePool(TestPath);\r | |
1732 | }\r | |
1733 | return (RetVal);\r | |
1734 | }\r | |
1735 | \r | |
b3011f40 | 1736 | /**\r |
1e6e84c7 | 1737 | Find a file by searching the CWD and then the path with a variable set of file\r |
1738 | extensions. If the file is not found it will append each extension in the list\r | |
b3011f40 | 1739 | in the order provided and return the first one that is successful.\r |
1740 | \r | |
1741 | If FileName is NULL, then ASSERT.\r | |
1742 | If FileExtension is NULL, then behavior is identical to ShellFindFilePath.\r | |
1743 | \r | |
1744 | If the return value is not NULL then the memory must be caller freed.\r | |
1745 | \r | |
1746 | @param[in] FileName Filename string.\r | |
1747 | @param[in] FileExtension Semi-colon delimeted list of possible extensions.\r | |
1748 | \r | |
1749 | @retval NULL The file was not found.\r | |
1750 | @retval !NULL The path to the file.\r | |
1751 | **/\r | |
1752 | CHAR16 *\r | |
1753 | EFIAPI\r | |
1754 | ShellFindFilePathEx (\r | |
1755 | IN CONST CHAR16 *FileName,\r | |
1756 | IN CONST CHAR16 *FileExtension\r | |
1757 | )\r | |
1758 | {\r | |
1759 | CHAR16 *TestPath;\r | |
1760 | CHAR16 *RetVal;\r | |
1761 | CONST CHAR16 *ExtensionWalker;\r | |
9e926b69 | 1762 | UINTN Size;\r |
1cd45e78 | 1763 | CHAR16 *TempChar;\r |
c9d92df0 | 1764 | CHAR16 *TempChar2;\r |
1cd45e78 | 1765 | \r |
b3011f40 | 1766 | ASSERT(FileName != NULL);\r |
1767 | if (FileExtension == NULL) {\r | |
1768 | return (ShellFindFilePath(FileName));\r | |
1769 | }\r | |
1770 | RetVal = ShellFindFilePath(FileName);\r | |
1771 | if (RetVal != NULL) {\r | |
1772 | return (RetVal);\r | |
1773 | }\r | |
9e926b69 | 1774 | Size = StrSize(FileName);\r |
1775 | Size += StrSize(FileExtension);\r | |
1776 | TestPath = AllocateZeroPool(Size);\r | |
c9d92df0 | 1777 | if (TestPath == NULL) {\r |
1778 | return (NULL);\r | |
1779 | }\r | |
a405b86d | 1780 | for (ExtensionWalker = FileExtension, TempChar2 = (CHAR16*)FileExtension; TempChar2 != NULL ; ExtensionWalker = TempChar2 + 1){\r |
b3011f40 | 1781 | StrCpy(TestPath, FileName);\r |
a405b86d | 1782 | if (ExtensionWalker != NULL) {\r |
1783 | StrCat(TestPath, ExtensionWalker);\r | |
1784 | }\r | |
1cd45e78 | 1785 | TempChar = StrStr(TestPath, L";");\r |
1786 | if (TempChar != NULL) {\r | |
1787 | *TempChar = CHAR_NULL;\r | |
b3011f40 | 1788 | }\r |
1789 | RetVal = ShellFindFilePath(TestPath);\r | |
1790 | if (RetVal != NULL) {\r | |
1791 | break;\r | |
1792 | }\r | |
a405b86d | 1793 | ASSERT(ExtensionWalker != NULL);\r |
c9d92df0 | 1794 | TempChar2 = StrStr(ExtensionWalker, L";");\r |
b3011f40 | 1795 | }\r |
1796 | FreePool(TestPath);\r | |
1797 | return (RetVal);\r | |
1798 | }\r | |
1799 | \r | |
94b17fa1 | 1800 | typedef struct {\r |
9b3bf083 | 1801 | LIST_ENTRY Link;\r |
94b17fa1 | 1802 | CHAR16 *Name;\r |
a405b86d | 1803 | SHELL_PARAM_TYPE Type;\r |
94b17fa1 | 1804 | CHAR16 *Value;\r |
1805 | UINTN OriginalPosition;\r | |
1806 | } SHELL_PARAM_PACKAGE;\r | |
1807 | \r | |
1808 | /**\r | |
1e6e84c7 | 1809 | Checks the list of valid arguments and returns TRUE if the item was found. If the\r |
94b17fa1 | 1810 | return value is TRUE then the type parameter is set also.\r |
1e6e84c7 | 1811 | \r |
94b17fa1 | 1812 | if CheckList is NULL then ASSERT();\r |
1813 | if Name is NULL then ASSERT();\r | |
1814 | if Type is NULL then ASSERT();\r | |
1815 | \r | |
94b17fa1 | 1816 | @param Name pointer to Name of parameter found\r |
1817 | @param CheckList List to check against\r | |
a405b86d | 1818 | @param Type pointer to type of parameter if it was found\r |
94b17fa1 | 1819 | \r |
1820 | @retval TRUE the Parameter was found. Type is valid.\r | |
1821 | @retval FALSE the Parameter was not found. Type is not valid.\r | |
1822 | **/\r | |
1823 | BOOLEAN\r | |
1824 | EFIAPI\r | |
d2b4564b | 1825 | InternalIsOnCheckList (\r |
94b17fa1 | 1826 | IN CONST CHAR16 *Name,\r |
1827 | IN CONST SHELL_PARAM_ITEM *CheckList,\r | |
252d9457 | 1828 | OUT SHELL_PARAM_TYPE *Type\r |
a405b86d | 1829 | )\r |
1830 | {\r | |
94b17fa1 | 1831 | SHELL_PARAM_ITEM *TempListItem;\r |
252d9457 | 1832 | CHAR16 *TempString;\r |
94b17fa1 | 1833 | \r |
1834 | //\r | |
1835 | // ASSERT that all 3 pointer parameters aren't NULL\r | |
1836 | //\r | |
1837 | ASSERT(CheckList != NULL);\r | |
1838 | ASSERT(Type != NULL);\r | |
1839 | ASSERT(Name != NULL);\r | |
1840 | \r | |
d2b4564b | 1841 | //\r |
1842 | // question mark and page break mode are always supported\r | |
1843 | //\r | |
1844 | if ((StrCmp(Name, L"-?") == 0) ||\r | |
1845 | (StrCmp(Name, L"-b") == 0)\r | |
a405b86d | 1846 | ) {\r |
252d9457 | 1847 | *Type = TypeFlag;\r |
d2b4564b | 1848 | return (TRUE);\r |
1849 | }\r | |
1850 | \r | |
94b17fa1 | 1851 | //\r |
1852 | // Enumerate through the list\r | |
1853 | //\r | |
1854 | for (TempListItem = (SHELL_PARAM_ITEM*)CheckList ; TempListItem->Name != NULL ; TempListItem++) {\r | |
1855 | //\r | |
9eb53ac3 | 1856 | // If the Type is TypeStart only check the first characters of the passed in param\r |
1857 | // If it matches set the type and return TRUE\r | |
94b17fa1 | 1858 | //\r |
b0934ac4 | 1859 | if (TempListItem->Type == TypeStart) {\r |
252d9457 | 1860 | if (StrnCmp(Name, TempListItem->Name, StrLen(TempListItem->Name)) == 0) {\r |
1861 | *Type = TempListItem->Type;\r | |
1862 | return (TRUE);\r | |
1863 | }\r | |
1864 | TempString = NULL;\r | |
1865 | TempString = StrnCatGrow(&TempString, NULL, Name, StrLen(TempListItem->Name));\r | |
1866 | if (TempString != NULL) {\r | |
1867 | if (StringNoCaseCompare(&TempString, &TempListItem->Name) == 0) {\r | |
1868 | *Type = TempListItem->Type;\r | |
1869 | FreePool(TempString);\r | |
1870 | return (TRUE);\r | |
1871 | }\r | |
1872 | FreePool(TempString);\r | |
1873 | }\r | |
1874 | } else if (StringNoCaseCompare(&Name, &TempListItem->Name) == 0) {\r | |
94b17fa1 | 1875 | *Type = TempListItem->Type;\r |
1876 | return (TRUE);\r | |
1877 | }\r | |
1878 | }\r | |
2247dde4 | 1879 | \r |
94b17fa1 | 1880 | return (FALSE);\r |
1881 | }\r | |
1882 | /**\r | |
d2b4564b | 1883 | Checks the string for indicators of "flag" status. this is a leading '/', '-', or '+'\r |
94b17fa1 | 1884 | \r |
a405b86d | 1885 | @param[in] Name pointer to Name of parameter found\r |
1886 | @param[in] AlwaysAllowNumbers TRUE to allow numbers, FALSE to not.\r | |
94b17fa1 | 1887 | \r |
1888 | @retval TRUE the Parameter is a flag.\r | |
a405b86d | 1889 | @retval FALSE the Parameter not a flag.\r |
94b17fa1 | 1890 | **/\r |
1891 | BOOLEAN\r | |
1892 | EFIAPI\r | |
d2b4564b | 1893 | InternalIsFlag (\r |
2247dde4 | 1894 | IN CONST CHAR16 *Name,\r |
1895 | IN BOOLEAN AlwaysAllowNumbers\r | |
94b17fa1 | 1896 | )\r |
1897 | {\r | |
1898 | //\r | |
1899 | // ASSERT that Name isn't NULL\r | |
1900 | //\r | |
1901 | ASSERT(Name != NULL);\r | |
1902 | \r | |
2247dde4 | 1903 | //\r |
1904 | // If we accept numbers then dont return TRUE. (they will be values)\r | |
1905 | //\r | |
a405b86d | 1906 | if (((Name[0] == L'-' || Name[0] == L'+') && ShellIsHexaDecimalDigitCharacter(Name[1])) && AlwaysAllowNumbers) {\r |
2247dde4 | 1907 | return (FALSE);\r |
1908 | }\r | |
1909 | \r | |
94b17fa1 | 1910 | //\r |
a405b86d | 1911 | // If the Name has a /, +, or - as the first character return TRUE\r |
94b17fa1 | 1912 | //\r |
1e6e84c7 | 1913 | if ((Name[0] == L'/') ||\r |
d2b4564b | 1914 | (Name[0] == L'-') ||\r |
1915 | (Name[0] == L'+')\r | |
a405b86d | 1916 | ) {\r |
94b17fa1 | 1917 | return (TRUE);\r |
1918 | }\r | |
1919 | return (FALSE);\r | |
1920 | }\r | |
1921 | \r | |
1922 | /**\r | |
1e6e84c7 | 1923 | Checks the command line arguments passed against the list of valid ones.\r |
94b17fa1 | 1924 | \r |
1925 | If no initialization is required, then return RETURN_SUCCESS.\r | |
1e6e84c7 | 1926 | \r |
a405b86d | 1927 | @param[in] CheckList pointer to list of parameters to check\r |
1928 | @param[out] CheckPackage pointer to pointer to list checked values\r | |
1929 | @param[out] ProblemParam optional pointer to pointer to unicode string for\r | |
d2b4564b | 1930 | the paramater that caused failure. If used then the\r |
1931 | caller is responsible for freeing the memory.\r | |
a405b86d | 1932 | @param[in] AutoPageBreak will automatically set PageBreakEnabled for "b" parameter\r |
1933 | @param[in] Argv pointer to array of parameters\r | |
1934 | @param[in] Argc Count of parameters in Argv\r | |
1935 | @param[in] AlwaysAllowNumbers TRUE to allow numbers always, FALSE otherwise.\r | |
94b17fa1 | 1936 | \r |
1937 | @retval EFI_SUCCESS The operation completed sucessfully.\r | |
1938 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed\r | |
1939 | @retval EFI_INVALID_PARAMETER A parameter was invalid\r | |
1e6e84c7 | 1940 | @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was\r |
1941 | duplicated. the duplicated command line argument\r | |
94b17fa1 | 1942 | was returned in ProblemParam if provided.\r |
1e6e84c7 | 1943 | @retval EFI_NOT_FOUND a argument required a value that was missing.\r |
94b17fa1 | 1944 | the invalid command line argument was returned in\r |
1945 | ProblemParam if provided.\r | |
1946 | **/\r | |
1947 | EFI_STATUS\r | |
1948 | EFIAPI\r | |
1949 | InternalCommandLineParse (\r | |
1950 | IN CONST SHELL_PARAM_ITEM *CheckList,\r | |
1951 | OUT LIST_ENTRY **CheckPackage,\r | |
1952 | OUT CHAR16 **ProblemParam OPTIONAL,\r | |
1953 | IN BOOLEAN AutoPageBreak,\r | |
1954 | IN CONST CHAR16 **Argv,\r | |
2247dde4 | 1955 | IN UINTN Argc,\r |
1956 | IN BOOLEAN AlwaysAllowNumbers\r | |
a405b86d | 1957 | )\r |
1958 | {\r | |
94b17fa1 | 1959 | UINTN LoopCounter;\r |
252d9457 | 1960 | SHELL_PARAM_TYPE CurrentItemType;\r |
94b17fa1 | 1961 | SHELL_PARAM_PACKAGE *CurrentItemPackage;\r |
125c2cf4 | 1962 | UINTN GetItemValue;\r |
1963 | UINTN ValueSize;\r | |
a405b86d | 1964 | UINTN Count;\r |
252d9457 | 1965 | CONST CHAR16 *TempPointer;\r |
94b17fa1 | 1966 | \r |
1967 | CurrentItemPackage = NULL;\r | |
125c2cf4 | 1968 | GetItemValue = 0;\r |
1969 | ValueSize = 0;\r | |
a405b86d | 1970 | Count = 0;\r |
94b17fa1 | 1971 | \r |
1972 | //\r | |
1973 | // If there is only 1 item we dont need to do anything\r | |
1974 | //\r | |
a405b86d | 1975 | if (Argc < 1) {\r |
94b17fa1 | 1976 | *CheckPackage = NULL;\r |
1977 | return (EFI_SUCCESS);\r | |
1978 | }\r | |
1979 | \r | |
2247dde4 | 1980 | //\r |
1981 | // ASSERTs\r | |
1982 | //\r | |
1983 | ASSERT(CheckList != NULL);\r | |
1984 | ASSERT(Argv != NULL);\r | |
1985 | \r | |
94b17fa1 | 1986 | //\r |
1987 | // initialize the linked list\r | |
1988 | //\r | |
1989 | *CheckPackage = (LIST_ENTRY*)AllocateZeroPool(sizeof(LIST_ENTRY));\r | |
02a758cb | 1990 | if (*CheckPackage == NULL) {\r |
beab0fc5 | 1991 | return (EFI_OUT_OF_RESOURCES);\r |
02a758cb | 1992 | }\r |
beab0fc5 | 1993 | \r |
94b17fa1 | 1994 | InitializeListHead(*CheckPackage);\r |
1995 | \r | |
1996 | //\r | |
1997 | // loop through each of the arguments\r | |
1998 | //\r | |
1999 | for (LoopCounter = 0 ; LoopCounter < Argc ; ++LoopCounter) {\r | |
2000 | if (Argv[LoopCounter] == NULL) {\r | |
2001 | //\r | |
2002 | // do nothing for NULL argv\r | |
2003 | //\r | |
a405b86d | 2004 | } else if (InternalIsOnCheckList(Argv[LoopCounter], CheckList, &CurrentItemType)) {\r |
2247dde4 | 2005 | //\r |
2006 | // We might have leftover if last parameter didnt have optional value\r | |
2007 | //\r | |
125c2cf4 | 2008 | if (GetItemValue != 0) {\r |
2009 | GetItemValue = 0;\r | |
2247dde4 | 2010 | InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r |
2011 | }\r | |
94b17fa1 | 2012 | //\r |
2013 | // this is a flag\r | |
2014 | //\r | |
252d9457 | 2015 | CurrentItemPackage = AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE));\r |
beab0fc5 | 2016 | if (CurrentItemPackage == NULL) {\r |
2017 | ShellCommandLineFreeVarList(*CheckPackage);\r | |
2018 | *CheckPackage = NULL;\r | |
2019 | return (EFI_OUT_OF_RESOURCES);\r | |
2020 | }\r | |
252d9457 | 2021 | CurrentItemPackage->Name = AllocateZeroPool(StrSize(Argv[LoopCounter]));\r |
beab0fc5 | 2022 | if (CurrentItemPackage->Name == NULL) {\r |
2023 | ShellCommandLineFreeVarList(*CheckPackage);\r | |
2024 | *CheckPackage = NULL;\r | |
2025 | return (EFI_OUT_OF_RESOURCES);\r | |
2026 | }\r | |
94b17fa1 | 2027 | StrCpy(CurrentItemPackage->Name, Argv[LoopCounter]);\r |
2028 | CurrentItemPackage->Type = CurrentItemType;\r | |
2029 | CurrentItemPackage->OriginalPosition = (UINTN)(-1);\r | |
b1f95a06 | 2030 | CurrentItemPackage->Value = NULL;\r |
94b17fa1 | 2031 | \r |
2032 | //\r | |
2033 | // Does this flag require a value\r | |
2034 | //\r | |
125c2cf4 | 2035 | switch (CurrentItemPackage->Type) {\r |
94b17fa1 | 2036 | //\r |
125c2cf4 | 2037 | // possibly trigger the next loop(s) to populate the value of this item\r |
1e6e84c7 | 2038 | //\r |
125c2cf4 | 2039 | case TypeValue:\r |
1e6e84c7 | 2040 | GetItemValue = 1;\r |
125c2cf4 | 2041 | ValueSize = 0;\r |
2042 | break;\r | |
2043 | case TypeDoubleValue:\r | |
2044 | GetItemValue = 2;\r | |
2045 | ValueSize = 0;\r | |
2046 | break;\r | |
2047 | case TypeMaxValue:\r | |
2048 | GetItemValue = (UINTN)(-1);\r | |
2049 | ValueSize = 0;\r | |
2050 | break;\r | |
2051 | default:\r | |
2052 | //\r | |
2053 | // this item has no value expected; we are done\r | |
2054 | //\r | |
2055 | InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r | |
2056 | ASSERT(GetItemValue == 0);\r | |
2057 | break;\r | |
94b17fa1 | 2058 | }\r |
a405b86d | 2059 | } else if (GetItemValue != 0 && !InternalIsFlag(Argv[LoopCounter], AlwaysAllowNumbers)) {\r |
b1f95a06 | 2060 | ASSERT(CurrentItemPackage != NULL);\r |
2061 | //\r | |
125c2cf4 | 2062 | // get the item VALUE for a previous flag\r |
b1f95a06 | 2063 | //\r |
49bd498d | 2064 | if (StrStr(Argv[LoopCounter], L" ") == NULL) {\r |
2065 | CurrentItemPackage->Value = ReallocatePool(ValueSize, ValueSize + StrSize(Argv[LoopCounter]) + sizeof(CHAR16), CurrentItemPackage->Value);\r | |
2066 | ASSERT(CurrentItemPackage->Value != NULL);\r | |
2067 | if (ValueSize == 0) {\r | |
2068 | StrCpy(CurrentItemPackage->Value, Argv[LoopCounter]);\r | |
2069 | } else {\r | |
2070 | StrCat(CurrentItemPackage->Value, L" ");\r | |
2071 | StrCat(CurrentItemPackage->Value, Argv[LoopCounter]);\r | |
2072 | }\r | |
2073 | ValueSize += StrSize(Argv[LoopCounter]) + sizeof(CHAR16);\r | |
125c2cf4 | 2074 | } else {\r |
49bd498d | 2075 | //\r |
2076 | // the parameter has spaces. must be quoted.\r | |
2077 | //\r | |
2078 | CurrentItemPackage->Value = ReallocatePool(ValueSize, ValueSize + StrSize(Argv[LoopCounter]) + sizeof(CHAR16) + sizeof(CHAR16) + sizeof(CHAR16), CurrentItemPackage->Value);\r | |
2079 | ASSERT(CurrentItemPackage->Value != NULL);\r | |
2080 | if (ValueSize == 0) {\r | |
2081 | StrCpy(CurrentItemPackage->Value, L"\"");\r | |
2082 | StrCat(CurrentItemPackage->Value, Argv[LoopCounter]);\r | |
2083 | StrCat(CurrentItemPackage->Value, L"\"");\r | |
2084 | } else {\r | |
2085 | StrCat(CurrentItemPackage->Value, L" ");\r | |
2086 | StrCat(CurrentItemPackage->Value, L"\"");\r | |
2087 | StrCat(CurrentItemPackage->Value, Argv[LoopCounter]);\r | |
2088 | StrCat(CurrentItemPackage->Value, L"\"");\r | |
2089 | }\r | |
2090 | ValueSize += StrSize(Argv[LoopCounter]) + sizeof(CHAR16);\r | |
125c2cf4 | 2091 | }\r |
125c2cf4 | 2092 | GetItemValue--;\r |
2093 | if (GetItemValue == 0) {\r | |
2094 | InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r | |
2095 | }\r | |
a405b86d | 2096 | } else if (!InternalIsFlag(Argv[LoopCounter], AlwaysAllowNumbers) ){ //|| ProblemParam == NULL) {\r |
b1f95a06 | 2097 | //\r |
2098 | // add this one as a non-flag\r | |
2099 | //\r | |
252d9457 | 2100 | \r |
2101 | TempPointer = Argv[LoopCounter];\r | |
b0934ac4 | 2102 | if ((*TempPointer == L'^' && *(TempPointer+1) == L'-')\r |
252d9457 | 2103 | || (*TempPointer == L'^' && *(TempPointer+1) == L'/')\r |
2104 | || (*TempPointer == L'^' && *(TempPointer+1) == L'+')\r | |
2105 | ){\r | |
2106 | TempPointer++;\r | |
2107 | }\r | |
2108 | CurrentItemPackage = AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE));\r | |
beab0fc5 | 2109 | if (CurrentItemPackage == NULL) {\r |
2110 | ShellCommandLineFreeVarList(*CheckPackage);\r | |
2111 | *CheckPackage = NULL;\r | |
2112 | return (EFI_OUT_OF_RESOURCES);\r | |
2113 | }\r | |
b1f95a06 | 2114 | CurrentItemPackage->Name = NULL;\r |
2115 | CurrentItemPackage->Type = TypePosition;\r | |
252d9457 | 2116 | CurrentItemPackage->Value = AllocateZeroPool(StrSize(TempPointer));\r |
beab0fc5 | 2117 | if (CurrentItemPackage->Value == NULL) {\r |
2118 | ShellCommandLineFreeVarList(*CheckPackage);\r | |
2119 | *CheckPackage = NULL;\r | |
2120 | return (EFI_OUT_OF_RESOURCES);\r | |
2121 | }\r | |
252d9457 | 2122 | StrCpy(CurrentItemPackage->Value, TempPointer);\r |
a405b86d | 2123 | CurrentItemPackage->OriginalPosition = Count++;\r |
9b3bf083 | 2124 | InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r |
252d9457 | 2125 | } else {\r |
94b17fa1 | 2126 | //\r |
2127 | // this was a non-recognised flag... error!\r | |
2128 | //\r | |
252d9457 | 2129 | if (ProblemParam != NULL) {\r |
2130 | *ProblemParam = AllocateZeroPool(StrSize(Argv[LoopCounter]));\r | |
beab0fc5 | 2131 | if (*ProblemParam != NULL) {\r |
b0934ac4 | 2132 | StrCpy(*ProblemParam, Argv[LoopCounter]);\r |
beab0fc5 | 2133 | }\r |
252d9457 | 2134 | }\r |
94b17fa1 | 2135 | ShellCommandLineFreeVarList(*CheckPackage);\r |
2136 | *CheckPackage = NULL;\r | |
2137 | return (EFI_VOLUME_CORRUPTED);\r | |
94b17fa1 | 2138 | }\r |
2139 | }\r | |
125c2cf4 | 2140 | if (GetItemValue != 0) {\r |
2141 | GetItemValue = 0;\r | |
2142 | InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r | |
2143 | }\r | |
94b17fa1 | 2144 | //\r |
2145 | // support for AutoPageBreak\r | |
2146 | //\r | |
2147 | if (AutoPageBreak && ShellCommandLineGetFlag(*CheckPackage, L"-b")) {\r | |
2148 | ShellSetPageBreakMode(TRUE);\r | |
2149 | }\r | |
2150 | return (EFI_SUCCESS);\r | |
2151 | }\r | |
2152 | \r | |
2153 | /**\r | |
1e6e84c7 | 2154 | Checks the command line arguments passed against the list of valid ones.\r |
94b17fa1 | 2155 | Optionally removes NULL values first.\r |
1e6e84c7 | 2156 | \r |
94b17fa1 | 2157 | If no initialization is required, then return RETURN_SUCCESS.\r |
1e6e84c7 | 2158 | \r |
a405b86d | 2159 | @param[in] CheckList The pointer to list of parameters to check.\r |
2160 | @param[out] CheckPackage The package of checked values.\r | |
2161 | @param[out] ProblemParam Optional pointer to pointer to unicode string for\r | |
94b17fa1 | 2162 | the paramater that caused failure.\r |
a405b86d | 2163 | @param[in] AutoPageBreak Will automatically set PageBreakEnabled.\r |
2164 | @param[in] AlwaysAllowNumbers Will never fail for number based flags.\r | |
94b17fa1 | 2165 | \r |
2166 | @retval EFI_SUCCESS The operation completed sucessfully.\r | |
a405b86d | 2167 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r |
2168 | @retval EFI_INVALID_PARAMETER A parameter was invalid.\r | |
2169 | @retval EFI_VOLUME_CORRUPTED The command line was corrupt.\r | |
2170 | @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One\r | |
1e6e84c7 | 2171 | of the command line arguments was returned in\r |
94b17fa1 | 2172 | ProblemParam if provided.\r |
a405b86d | 2173 | @retval EFI_NOT_FOUND A argument required a value that was missing.\r |
2174 | The invalid command line argument was returned in\r | |
94b17fa1 | 2175 | ProblemParam if provided.\r |
2176 | **/\r | |
2177 | EFI_STATUS\r | |
2178 | EFIAPI\r | |
2247dde4 | 2179 | ShellCommandLineParseEx (\r |
94b17fa1 | 2180 | IN CONST SHELL_PARAM_ITEM *CheckList,\r |
2181 | OUT LIST_ENTRY **CheckPackage,\r | |
2182 | OUT CHAR16 **ProblemParam OPTIONAL,\r | |
2247dde4 | 2183 | IN BOOLEAN AutoPageBreak,\r |
2184 | IN BOOLEAN AlwaysAllowNumbers\r | |
a405b86d | 2185 | )\r |
2186 | {\r | |
1e6e84c7 | 2187 | //\r |
94b17fa1 | 2188 | // ASSERT that CheckList and CheckPackage aren't NULL\r |
2189 | //\r | |
2190 | ASSERT(CheckList != NULL);\r | |
2191 | ASSERT(CheckPackage != NULL);\r | |
2192 | \r | |
1e6e84c7 | 2193 | //\r |
94b17fa1 | 2194 | // Check for UEFI Shell 2.0 protocols\r |
2195 | //\r | |
366f81a0 | 2196 | if (gEfiShellParametersProtocol != NULL) {\r |
1e6e84c7 | 2197 | return (InternalCommandLineParse(CheckList,\r |
2198 | CheckPackage,\r | |
2199 | ProblemParam,\r | |
2200 | AutoPageBreak,\r | |
366f81a0 | 2201 | (CONST CHAR16**) gEfiShellParametersProtocol->Argv,\r |
2202 | gEfiShellParametersProtocol->Argc,\r | |
2247dde4 | 2203 | AlwaysAllowNumbers));\r |
94b17fa1 | 2204 | }\r |
2205 | \r | |
1e6e84c7 | 2206 | //\r |
94b17fa1 | 2207 | // ASSERT That EFI Shell is not required\r |
2208 | //\r | |
2209 | ASSERT (mEfiShellInterface != NULL);\r | |
1e6e84c7 | 2210 | return (InternalCommandLineParse(CheckList,\r |
2211 | CheckPackage,\r | |
2212 | ProblemParam,\r | |
2213 | AutoPageBreak,\r | |
08d7f8e8 | 2214 | (CONST CHAR16**) mEfiShellInterface->Argv,\r |
2247dde4 | 2215 | mEfiShellInterface->Argc,\r |
2216 | AlwaysAllowNumbers));\r | |
94b17fa1 | 2217 | }\r |
2218 | \r | |
2219 | /**\r | |
2220 | Frees shell variable list that was returned from ShellCommandLineParse.\r | |
2221 | \r | |
2222 | This function will free all the memory that was used for the CheckPackage\r | |
2223 | list of postprocessed shell arguments.\r | |
2224 | \r | |
2225 | this function has no return value.\r | |
2226 | \r | |
2227 | if CheckPackage is NULL, then return\r | |
2228 | \r | |
2229 | @param CheckPackage the list to de-allocate\r | |
2230 | **/\r | |
2231 | VOID\r | |
2232 | EFIAPI\r | |
2233 | ShellCommandLineFreeVarList (\r | |
2234 | IN LIST_ENTRY *CheckPackage\r | |
a405b86d | 2235 | )\r |
2236 | {\r | |
94b17fa1 | 2237 | LIST_ENTRY *Node;\r |
2238 | \r | |
2239 | //\r | |
2240 | // check for CheckPackage == NULL\r | |
2241 | //\r | |
2242 | if (CheckPackage == NULL) {\r | |
2243 | return;\r | |
2244 | }\r | |
2245 | \r | |
2246 | //\r | |
2247 | // for each node in the list\r | |
2248 | //\r | |
9eb53ac3 | 2249 | for ( Node = GetFirstNode(CheckPackage)\r |
a405b86d | 2250 | ; !IsListEmpty(CheckPackage)\r |
9eb53ac3 | 2251 | ; Node = GetFirstNode(CheckPackage)\r |
a405b86d | 2252 | ){\r |
94b17fa1 | 2253 | //\r |
2254 | // Remove it from the list\r | |
2255 | //\r | |
2256 | RemoveEntryList(Node);\r | |
2257 | \r | |
2258 | //\r | |
2259 | // if it has a name free the name\r | |
2260 | //\r | |
2261 | if (((SHELL_PARAM_PACKAGE*)Node)->Name != NULL) {\r | |
2262 | FreePool(((SHELL_PARAM_PACKAGE*)Node)->Name);\r | |
2263 | }\r | |
2264 | \r | |
2265 | //\r | |
2266 | // if it has a value free the value\r | |
2267 | //\r | |
2268 | if (((SHELL_PARAM_PACKAGE*)Node)->Value != NULL) {\r | |
2269 | FreePool(((SHELL_PARAM_PACKAGE*)Node)->Value);\r | |
2270 | }\r | |
1e6e84c7 | 2271 | \r |
94b17fa1 | 2272 | //\r |
2273 | // free the node structure\r | |
2274 | //\r | |
2275 | FreePool((SHELL_PARAM_PACKAGE*)Node);\r | |
2276 | }\r | |
2277 | //\r | |
2278 | // free the list head node\r | |
2279 | //\r | |
2280 | FreePool(CheckPackage);\r | |
2281 | }\r | |
2282 | /**\r | |
2283 | Checks for presence of a flag parameter\r | |
2284 | \r | |
2285 | flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key\r | |
2286 | \r | |
2287 | if CheckPackage is NULL then return FALSE.\r | |
2288 | if KeyString is NULL then ASSERT()\r | |
1e6e84c7 | 2289 | \r |
94b17fa1 | 2290 | @param CheckPackage The package of parsed command line arguments\r |
2291 | @param KeyString the Key of the command line argument to check for\r | |
2292 | \r | |
2293 | @retval TRUE the flag is on the command line\r | |
2294 | @retval FALSE the flag is not on the command line\r | |
2295 | **/\r | |
2296 | BOOLEAN\r | |
2297 | EFIAPI\r | |
2298 | ShellCommandLineGetFlag (\r | |
a405b86d | 2299 | IN CONST LIST_ENTRY * CONST CheckPackage,\r |
2300 | IN CONST CHAR16 * CONST KeyString\r | |
2301 | )\r | |
2302 | {\r | |
94b17fa1 | 2303 | LIST_ENTRY *Node;\r |
252d9457 | 2304 | CHAR16 *TempString;\r |
94b17fa1 | 2305 | \r |
2306 | //\r | |
0c1950ba | 2307 | // return FALSE for no package or KeyString is NULL\r |
94b17fa1 | 2308 | //\r |
0c1950ba | 2309 | if (CheckPackage == NULL || KeyString == NULL) {\r |
94b17fa1 | 2310 | return (FALSE);\r |
2311 | }\r | |
2312 | \r | |
2313 | //\r | |
2314 | // enumerate through the list of parametrs\r | |
2315 | //\r | |
1e6e84c7 | 2316 | for ( Node = GetFirstNode(CheckPackage)\r |
2317 | ; !IsNull (CheckPackage, Node)\r | |
2318 | ; Node = GetNextNode(CheckPackage, Node)\r | |
252d9457 | 2319 | ){\r |
94b17fa1 | 2320 | //\r |
2321 | // If the Name matches, return TRUE (and there may be NULL name)\r | |
2322 | //\r | |
2323 | if (((SHELL_PARAM_PACKAGE*)Node)->Name != NULL) {\r | |
9eb53ac3 | 2324 | //\r |
2325 | // If Type is TypeStart then only compare the begining of the strings\r | |
2326 | //\r | |
252d9457 | 2327 | if (((SHELL_PARAM_PACKAGE*)Node)->Type == TypeStart) {\r |
2328 | if (StrnCmp(KeyString, ((SHELL_PARAM_PACKAGE*)Node)->Name, StrLen(KeyString)) == 0) {\r | |
2329 | return (TRUE);\r | |
2330 | }\r | |
2331 | TempString = NULL;\r | |
2332 | TempString = StrnCatGrow(&TempString, NULL, KeyString, StrLen(((SHELL_PARAM_PACKAGE*)Node)->Name));\r | |
2333 | if (TempString != NULL) {\r | |
2334 | if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r | |
2335 | FreePool(TempString);\r | |
2336 | return (TRUE);\r | |
2337 | }\r | |
2338 | FreePool(TempString);\r | |
2339 | }\r | |
2340 | } else if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r | |
94b17fa1 | 2341 | return (TRUE);\r |
2342 | }\r | |
2343 | }\r | |
2344 | }\r | |
2345 | return (FALSE);\r | |
2346 | }\r | |
2347 | /**\r | |
a405b86d | 2348 | Returns value from command line argument.\r |
94b17fa1 | 2349 | \r |
a405b86d | 2350 | Value parameters are in the form of "-<Key> value" or "/<Key> value".\r |
1e6e84c7 | 2351 | \r |
a405b86d | 2352 | If CheckPackage is NULL, then return NULL.\r |
94b17fa1 | 2353 | \r |
a405b86d | 2354 | @param[in] CheckPackage The package of parsed command line arguments.\r |
2355 | @param[in] KeyString The Key of the command line argument to check for.\r | |
94b17fa1 | 2356 | \r |
a405b86d | 2357 | @retval NULL The flag is not on the command line.\r |
2358 | @retval !=NULL The pointer to unicode string of the value.\r | |
2359 | **/\r | |
94b17fa1 | 2360 | CONST CHAR16*\r |
2361 | EFIAPI\r | |
2362 | ShellCommandLineGetValue (\r | |
2363 | IN CONST LIST_ENTRY *CheckPackage,\r | |
2364 | IN CHAR16 *KeyString\r | |
a405b86d | 2365 | )\r |
2366 | {\r | |
94b17fa1 | 2367 | LIST_ENTRY *Node;\r |
252d9457 | 2368 | CHAR16 *TempString;\r |
94b17fa1 | 2369 | \r |
2370 | //\r | |
0c1950ba | 2371 | // return NULL for no package or KeyString is NULL\r |
94b17fa1 | 2372 | //\r |
0c1950ba | 2373 | if (CheckPackage == NULL || KeyString == NULL) {\r |
94b17fa1 | 2374 | return (NULL);\r |
2375 | }\r | |
2376 | \r | |
2377 | //\r | |
2378 | // enumerate through the list of parametrs\r | |
2379 | //\r | |
1e6e84c7 | 2380 | for ( Node = GetFirstNode(CheckPackage)\r |
2381 | ; !IsNull (CheckPackage, Node)\r | |
2382 | ; Node = GetNextNode(CheckPackage, Node)\r | |
252d9457 | 2383 | ){\r |
94b17fa1 | 2384 | //\r |
252d9457 | 2385 | // If the Name matches, return TRUE (and there may be NULL name)\r |
94b17fa1 | 2386 | //\r |
2387 | if (((SHELL_PARAM_PACKAGE*)Node)->Name != NULL) {\r | |
9eb53ac3 | 2388 | //\r |
2389 | // If Type is TypeStart then only compare the begining of the strings\r | |
2390 | //\r | |
252d9457 | 2391 | if (((SHELL_PARAM_PACKAGE*)Node)->Type == TypeStart) {\r |
2392 | if (StrnCmp(KeyString, ((SHELL_PARAM_PACKAGE*)Node)->Name, StrLen(KeyString)) == 0) {\r | |
2393 | return (((SHELL_PARAM_PACKAGE*)Node)->Name + StrLen(KeyString));\r | |
2394 | }\r | |
2395 | TempString = NULL;\r | |
2396 | TempString = StrnCatGrow(&TempString, NULL, KeyString, StrLen(((SHELL_PARAM_PACKAGE*)Node)->Name));\r | |
2397 | if (TempString != NULL) {\r | |
2398 | if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r | |
2399 | FreePool(TempString);\r | |
2400 | return (((SHELL_PARAM_PACKAGE*)Node)->Name + StrLen(KeyString));\r | |
2401 | }\r | |
2402 | FreePool(TempString);\r | |
2403 | }\r | |
2404 | } else if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r | |
94b17fa1 | 2405 | return (((SHELL_PARAM_PACKAGE*)Node)->Value);\r |
2406 | }\r | |
2407 | }\r | |
2408 | }\r | |
2409 | return (NULL);\r | |
2410 | }\r | |
a405b86d | 2411 | \r |
94b17fa1 | 2412 | /**\r |
a405b86d | 2413 | Returns raw value from command line argument.\r |
94b17fa1 | 2414 | \r |
a405b86d | 2415 | Raw value parameters are in the form of "value" in a specific position in the list.\r |
1e6e84c7 | 2416 | \r |
a405b86d | 2417 | If CheckPackage is NULL, then return NULL.\r |
94b17fa1 | 2418 | \r |
a405b86d | 2419 | @param[in] CheckPackage The package of parsed command line arguments.\r |
2420 | @param[in] Position The position of the value.\r | |
94b17fa1 | 2421 | \r |
a405b86d | 2422 | @retval NULL The flag is not on the command line.\r |
2423 | @retval !=NULL The pointer to unicode string of the value.\r | |
94b17fa1 | 2424 | **/\r |
2425 | CONST CHAR16*\r | |
2426 | EFIAPI\r | |
2427 | ShellCommandLineGetRawValue (\r | |
a405b86d | 2428 | IN CONST LIST_ENTRY * CONST CheckPackage,\r |
2429 | IN UINTN Position\r | |
2430 | )\r | |
2431 | {\r | |
94b17fa1 | 2432 | LIST_ENTRY *Node;\r |
2433 | \r | |
2434 | //\r | |
2435 | // check for CheckPackage == NULL\r | |
2436 | //\r | |
2437 | if (CheckPackage == NULL) {\r | |
2438 | return (NULL);\r | |
2439 | }\r | |
2440 | \r | |
2441 | //\r | |
2442 | // enumerate through the list of parametrs\r | |
2443 | //\r | |
1e6e84c7 | 2444 | for ( Node = GetFirstNode(CheckPackage)\r |
2445 | ; !IsNull (CheckPackage, Node)\r | |
2446 | ; Node = GetNextNode(CheckPackage, Node)\r | |
a405b86d | 2447 | ){\r |
94b17fa1 | 2448 | //\r |
2449 | // If the position matches, return the value\r | |
2450 | //\r | |
2451 | if (((SHELL_PARAM_PACKAGE*)Node)->OriginalPosition == Position) {\r | |
2452 | return (((SHELL_PARAM_PACKAGE*)Node)->Value);\r | |
2453 | }\r | |
2454 | }\r | |
2455 | return (NULL);\r | |
b1f95a06 | 2456 | }\r |
2247dde4 | 2457 | \r |
2458 | /**\r | |
1e6e84c7 | 2459 | returns the number of command line value parameters that were parsed.\r |
2460 | \r | |
2247dde4 | 2461 | this will not include flags.\r |
2462 | \r | |
a405b86d | 2463 | @param[in] CheckPackage The package of parsed command line arguments.\r |
2464 | \r | |
2247dde4 | 2465 | @retval (UINTN)-1 No parsing has ocurred\r |
2466 | @return other The number of value parameters found\r | |
2467 | **/\r | |
2468 | UINTN\r | |
2469 | EFIAPI\r | |
2470 | ShellCommandLineGetCount(\r | |
a405b86d | 2471 | IN CONST LIST_ENTRY *CheckPackage\r |
125c2cf4 | 2472 | )\r |
2473 | {\r | |
a405b86d | 2474 | LIST_ENTRY *Node1;\r |
2475 | UINTN Count;\r | |
2476 | \r | |
2477 | if (CheckPackage == NULL) {\r | |
2478 | return (0);\r | |
2479 | }\r | |
2480 | for ( Node1 = GetFirstNode(CheckPackage), Count = 0\r | |
2481 | ; !IsNull (CheckPackage, Node1)\r | |
2482 | ; Node1 = GetNextNode(CheckPackage, Node1)\r | |
2483 | ){\r | |
2484 | if (((SHELL_PARAM_PACKAGE*)Node1)->Name == NULL) {\r | |
2485 | Count++;\r | |
2486 | }\r | |
2487 | }\r | |
2488 | return (Count);\r | |
2247dde4 | 2489 | }\r |
2490 | \r | |
36a9d672 | 2491 | /**\r |
2492 | Determins if a parameter is duplicated.\r | |
2493 | \r | |
1e6e84c7 | 2494 | If Param is not NULL then it will point to a callee allocated string buffer\r |
36a9d672 | 2495 | with the parameter value if a duplicate is found.\r |
2496 | \r | |
2497 | If CheckPackage is NULL, then ASSERT.\r | |
2498 | \r | |
2499 | @param[in] CheckPackage The package of parsed command line arguments.\r | |
2500 | @param[out] Param Upon finding one, a pointer to the duplicated parameter.\r | |
2501 | \r | |
2502 | @retval EFI_SUCCESS No parameters were duplicated.\r | |
2503 | @retval EFI_DEVICE_ERROR A duplicate was found.\r | |
2504 | **/\r | |
2505 | EFI_STATUS\r | |
2506 | EFIAPI\r | |
2507 | ShellCommandLineCheckDuplicate (\r | |
2508 | IN CONST LIST_ENTRY *CheckPackage,\r | |
2509 | OUT CHAR16 **Param\r | |
2510 | )\r | |
2511 | {\r | |
2512 | LIST_ENTRY *Node1;\r | |
2513 | LIST_ENTRY *Node2;\r | |
1e6e84c7 | 2514 | \r |
36a9d672 | 2515 | ASSERT(CheckPackage != NULL);\r |
2516 | \r | |
1e6e84c7 | 2517 | for ( Node1 = GetFirstNode(CheckPackage)\r |
2518 | ; !IsNull (CheckPackage, Node1)\r | |
2519 | ; Node1 = GetNextNode(CheckPackage, Node1)\r | |
a405b86d | 2520 | ){\r |
1e6e84c7 | 2521 | for ( Node2 = GetNextNode(CheckPackage, Node1)\r |
2522 | ; !IsNull (CheckPackage, Node2)\r | |
2523 | ; Node2 = GetNextNode(CheckPackage, Node2)\r | |
a405b86d | 2524 | ){\r |
2525 | if ((((SHELL_PARAM_PACKAGE*)Node1)->Name != NULL) && (((SHELL_PARAM_PACKAGE*)Node2)->Name != NULL) && StrCmp(((SHELL_PARAM_PACKAGE*)Node1)->Name, ((SHELL_PARAM_PACKAGE*)Node2)->Name) == 0) {\r | |
36a9d672 | 2526 | if (Param != NULL) {\r |
2527 | *Param = NULL;\r | |
2528 | *Param = StrnCatGrow(Param, NULL, ((SHELL_PARAM_PACKAGE*)Node1)->Name, 0);\r | |
2529 | }\r | |
2530 | return (EFI_DEVICE_ERROR);\r | |
2531 | }\r | |
2532 | }\r | |
2533 | }\r | |
2534 | return (EFI_SUCCESS);\r | |
2535 | }\r | |
2536 | \r | |
975136ab | 2537 | /**\r |
1e6e84c7 | 2538 | This is a find and replace function. Upon successful return the NewString is a copy of\r |
975136ab | 2539 | SourceString with each instance of FindTarget replaced with ReplaceWith.\r |
2540 | \r | |
b3011f40 | 2541 | If SourceString and NewString overlap the behavior is undefined.\r |
2542 | \r | |
975136ab | 2543 | If the string would grow bigger than NewSize it will halt and return error.\r |
2544 | \r | |
4ff7e37b ED |
2545 | @param[in] SourceString The string with source buffer.\r |
2546 | @param[in, out] NewString The string with resultant buffer.\r | |
2547 | @param[in] NewSize The size in bytes of NewString.\r | |
2548 | @param[in] FindTarget The string to look for.\r | |
2549 | @param[in] ReplaceWith The string to replace FindTarget with.\r | |
2550 | @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'\r | |
2551 | immediately before it.\r | |
2552 | @param[in] ParameterReplacing If TRUE will add "" around items with spaces.\r | |
969c783b | 2553 | \r |
2554 | @retval EFI_INVALID_PARAMETER SourceString was NULL.\r | |
2555 | @retval EFI_INVALID_PARAMETER NewString was NULL.\r | |
2556 | @retval EFI_INVALID_PARAMETER FindTarget was NULL.\r | |
2557 | @retval EFI_INVALID_PARAMETER ReplaceWith was NULL.\r | |
2558 | @retval EFI_INVALID_PARAMETER FindTarget had length < 1.\r | |
2559 | @retval EFI_INVALID_PARAMETER SourceString had length < 1.\r | |
1e6e84c7 | 2560 | @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold\r |
969c783b | 2561 | the new string (truncation occurred).\r |
a405b86d | 2562 | @retval EFI_SUCCESS The string was successfully copied with replacement.\r |
975136ab | 2563 | **/\r |
975136ab | 2564 | EFI_STATUS\r |
2565 | EFIAPI\r | |
a405b86d | 2566 | ShellCopySearchAndReplace(\r |
975136ab | 2567 | IN CHAR16 CONST *SourceString,\r |
a405b86d | 2568 | IN OUT CHAR16 *NewString,\r |
975136ab | 2569 | IN UINTN NewSize,\r |
2570 | IN CONST CHAR16 *FindTarget,\r | |
969c783b | 2571 | IN CONST CHAR16 *ReplaceWith,\r |
a405b86d | 2572 | IN CONST BOOLEAN SkipPreCarrot,\r |
2573 | IN CONST BOOLEAN ParameterReplacing\r | |
1e6e84c7 | 2574 | )\r |
2247dde4 | 2575 | {\r |
0158294b | 2576 | UINTN Size;\r |
a405b86d | 2577 | CHAR16 *Replace;\r |
2578 | \r | |
975136ab | 2579 | if ( (SourceString == NULL)\r |
2580 | || (NewString == NULL)\r | |
2581 | || (FindTarget == NULL)\r | |
2582 | || (ReplaceWith == NULL)\r | |
2583 | || (StrLen(FindTarget) < 1)\r | |
2584 | || (StrLen(SourceString) < 1)\r | |
a405b86d | 2585 | ){\r |
975136ab | 2586 | return (EFI_INVALID_PARAMETER);\r |
2587 | }\r | |
a405b86d | 2588 | Replace = NULL;\r |
2589 | if (StrStr(ReplaceWith, L" ") == NULL || !ParameterReplacing) {\r | |
2590 | Replace = StrnCatGrow(&Replace, NULL, ReplaceWith, 0);\r | |
2591 | } else {\r | |
2592 | Replace = AllocateZeroPool(StrSize(ReplaceWith) + 2*sizeof(CHAR16));\r | |
beab0fc5 | 2593 | if (Replace != NULL) {\r |
2594 | UnicodeSPrint(Replace, StrSize(ReplaceWith) + 2*sizeof(CHAR16), L"\"%s\"", ReplaceWith);\r | |
2595 | }\r | |
a405b86d | 2596 | }\r |
3e082d58 | 2597 | if (Replace == NULL) {\r |
2598 | return (EFI_OUT_OF_RESOURCES);\r | |
2599 | }\r | |
2247dde4 | 2600 | NewString = SetMem16(NewString, NewSize, CHAR_NULL);\r |
2601 | while (*SourceString != CHAR_NULL) {\r | |
969c783b | 2602 | //\r |
a405b86d | 2603 | // if we find the FindTarget and either Skip == FALSE or Skip and we\r |
969c783b | 2604 | // dont have a carrot do a replace...\r |
2605 | //\r | |
1e6e84c7 | 2606 | if (StrnCmp(SourceString, FindTarget, StrLen(FindTarget)) == 0\r |
a405b86d | 2607 | && ((SkipPreCarrot && *(SourceString-1) != L'^') || !SkipPreCarrot)\r |
2608 | ){\r | |
975136ab | 2609 | SourceString += StrLen(FindTarget);\r |
0158294b | 2610 | Size = StrSize(NewString);\r |
a405b86d | 2611 | if ((Size + (StrLen(Replace)*sizeof(CHAR16))) > NewSize) {\r |
2612 | FreePool(Replace);\r | |
975136ab | 2613 | return (EFI_BUFFER_TOO_SMALL);\r |
2614 | }\r | |
a405b86d | 2615 | StrCat(NewString, Replace);\r |
975136ab | 2616 | } else {\r |
0158294b | 2617 | Size = StrSize(NewString);\r |
2618 | if (Size + sizeof(CHAR16) > NewSize) {\r | |
a405b86d | 2619 | FreePool(Replace);\r |
975136ab | 2620 | return (EFI_BUFFER_TOO_SMALL);\r |
2621 | }\r | |
2622 | StrnCat(NewString, SourceString, 1);\r | |
2623 | SourceString++;\r | |
2624 | }\r | |
2625 | }\r | |
a405b86d | 2626 | FreePool(Replace);\r |
975136ab | 2627 | return (EFI_SUCCESS);\r |
2628 | }\r | |
b1f95a06 | 2629 | \r |
e2f8297f | 2630 | /**\r |
2631 | Internal worker function to output a string.\r | |
2632 | \r | |
2633 | This function will output a string to the correct StdOut.\r | |
2634 | \r | |
2635 | @param[in] String The string to print out.\r | |
2636 | \r | |
2637 | @retval EFI_SUCCESS The operation was sucessful.\r | |
2638 | @retval !EFI_SUCCESS The operation failed.\r | |
2639 | **/\r | |
2640 | EFI_STATUS\r | |
2641 | EFIAPI\r | |
2642 | InternalPrintTo (\r | |
2643 | IN CONST CHAR16 *String\r | |
2644 | )\r | |
2645 | {\r | |
2646 | UINTN Size;\r | |
2647 | Size = StrSize(String) - sizeof(CHAR16);\r | |
a405b86d | 2648 | if (Size == 0) {\r |
2649 | return (EFI_SUCCESS);\r | |
2650 | }\r | |
366f81a0 | 2651 | if (gEfiShellParametersProtocol != NULL) {\r |
2652 | return (gEfiShellProtocol->WriteFile(gEfiShellParametersProtocol->StdOut, &Size, (VOID*)String));\r | |
e2f8297f | 2653 | }\r |
2654 | if (mEfiShellInterface != NULL) {\r | |
06c355b4 | 2655 | if (mEfiShellInterface->RedirArgc == 0) { \r |
49bd498d | 2656 | //\r |
2657 | // Divide in half for old shell. Must be string length not size.\r | |
06c355b4 | 2658 | // \r |
2659 | Size /=2; // Divide in half only when no redirection.\r | |
2660 | }\r | |
a405b86d | 2661 | return (mEfiShellInterface->StdOut->Write(mEfiShellInterface->StdOut, &Size, (VOID*)String));\r |
e2f8297f | 2662 | }\r |
2663 | ASSERT(FALSE);\r | |
2664 | return (EFI_UNSUPPORTED);\r | |
2665 | }\r | |
2666 | \r | |
b1f95a06 | 2667 | /**\r |
2668 | Print at a specific location on the screen.\r | |
2669 | \r | |
f1b87e7a | 2670 | This function will move the cursor to a given screen location and print the specified string\r |
1e6e84c7 | 2671 | \r |
2672 | If -1 is specified for either the Row or Col the current screen location for BOTH\r | |
f1b87e7a | 2673 | will be used.\r |
b1f95a06 | 2674 | \r |
2675 | if either Row or Col is out of range for the current console, then ASSERT\r | |
2676 | if Format is NULL, then ASSERT\r | |
2677 | \r | |
1e6e84c7 | 2678 | In addition to the standard %-based flags as supported by UefiLib Print() this supports\r |
b1f95a06 | 2679 | the following additional flags:\r |
2680 | %N - Set output attribute to normal\r | |
2681 | %H - Set output attribute to highlight\r | |
2682 | %E - Set output attribute to error\r | |
2683 | %B - Set output attribute to blue color\r | |
2684 | %V - Set output attribute to green color\r | |
2685 | \r | |
2686 | Note: The background color is controlled by the shell command cls.\r | |
2687 | \r | |
b1f95a06 | 2688 | @param[in] Col the column to print at\r |
252d9457 | 2689 | @param[in] Row the row to print at\r |
b1f95a06 | 2690 | @param[in] Format the format string\r |
2247dde4 | 2691 | @param[in] Marker the marker for the variable argument list\r |
b1f95a06 | 2692 | \r |
a405b86d | 2693 | @return EFI_SUCCESS The operation was successful.\r |
2694 | @return EFI_DEVICE_ERROR The console device reported an error.\r | |
b1f95a06 | 2695 | **/\r |
a405b86d | 2696 | EFI_STATUS\r |
b1f95a06 | 2697 | EFIAPI\r |
2247dde4 | 2698 | InternalShellPrintWorker(\r |
b1f95a06 | 2699 | IN INT32 Col OPTIONAL,\r |
2700 | IN INT32 Row OPTIONAL,\r | |
2701 | IN CONST CHAR16 *Format,\r | |
252d9457 | 2702 | IN VA_LIST Marker\r |
1e6e84c7 | 2703 | )\r |
2247dde4 | 2704 | {\r |
b1f95a06 | 2705 | EFI_STATUS Status;\r |
975136ab | 2706 | CHAR16 *ResumeLocation;\r |
2707 | CHAR16 *FormatWalker;\r | |
a405b86d | 2708 | UINTN OriginalAttribute;\r |
89e8537a | 2709 | CHAR16 *mPostReplaceFormat;\r |
2710 | CHAR16 *mPostReplaceFormat2;\r | |
2711 | \r | |
2712 | mPostReplaceFormat = AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize));\r | |
2713 | mPostReplaceFormat2 = AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize));\r | |
a405b86d | 2714 | \r |
f8d3e689 | 2715 | if (mPostReplaceFormat == NULL || mPostReplaceFormat2 == NULL) {\r |
2716 | SHELL_FREE_NON_NULL(mPostReplaceFormat);\r | |
2717 | SHELL_FREE_NON_NULL(mPostReplaceFormat2);\r | |
2718 | return (EFI_OUT_OF_RESOURCES);\r | |
2719 | }\r | |
2720 | \r | |
a405b86d | 2721 | Status = EFI_SUCCESS;\r |
2722 | OriginalAttribute = gST->ConOut->Mode->Attribute;\r | |
1e6e84c7 | 2723 | \r |
975136ab | 2724 | //\r |
2725 | // Back and forth each time fixing up 1 of our flags...\r | |
2726 | //\r | |
a405b86d | 2727 | Status = ShellCopySearchAndReplace(Format, mPostReplaceFormat, PcdGet16 (PcdShellPrintBufferSize), L"%N", L"%%N", FALSE, FALSE);\r |
975136ab | 2728 | ASSERT_EFI_ERROR(Status);\r |
a405b86d | 2729 | Status = ShellCopySearchAndReplace(mPostReplaceFormat, mPostReplaceFormat2, PcdGet16 (PcdShellPrintBufferSize), L"%E", L"%%E", FALSE, FALSE);\r |
975136ab | 2730 | ASSERT_EFI_ERROR(Status);\r |
a405b86d | 2731 | Status = ShellCopySearchAndReplace(mPostReplaceFormat2, mPostReplaceFormat, PcdGet16 (PcdShellPrintBufferSize), L"%H", L"%%H", FALSE, FALSE);\r |
975136ab | 2732 | ASSERT_EFI_ERROR(Status);\r |
a405b86d | 2733 | Status = ShellCopySearchAndReplace(mPostReplaceFormat, mPostReplaceFormat2, PcdGet16 (PcdShellPrintBufferSize), L"%B", L"%%B", FALSE, FALSE);\r |
975136ab | 2734 | ASSERT_EFI_ERROR(Status);\r |
a405b86d | 2735 | Status = ShellCopySearchAndReplace(mPostReplaceFormat2, mPostReplaceFormat, PcdGet16 (PcdShellPrintBufferSize), L"%V", L"%%V", FALSE, FALSE);\r |
975136ab | 2736 | ASSERT_EFI_ERROR(Status);\r |
2737 | \r | |
2738 | //\r | |
2739 | // Use the last buffer from replacing to print from...\r | |
2740 | //\r | |
a405b86d | 2741 | UnicodeVSPrint (mPostReplaceFormat2, PcdGet16 (PcdShellPrintBufferSize), mPostReplaceFormat, Marker);\r |
b1f95a06 | 2742 | \r |
2743 | if (Col != -1 && Row != -1) {\r | |
b1f95a06 | 2744 | Status = gST->ConOut->SetCursorPosition(gST->ConOut, Col, Row);\r |
975136ab | 2745 | }\r |
2746 | \r | |
ecd3d59f | 2747 | FormatWalker = mPostReplaceFormat2;\r |
2247dde4 | 2748 | while (*FormatWalker != CHAR_NULL) {\r |
975136ab | 2749 | //\r |
2750 | // Find the next attribute change request\r | |
2751 | //\r | |
2752 | ResumeLocation = StrStr(FormatWalker, L"%");\r | |
2753 | if (ResumeLocation != NULL) {\r | |
2247dde4 | 2754 | *ResumeLocation = CHAR_NULL;\r |
975136ab | 2755 | }\r |
2756 | //\r | |
2757 | // print the current FormatWalker string\r | |
2758 | //\r | |
a405b86d | 2759 | if (StrLen(FormatWalker)>0) {\r |
2760 | Status = InternalPrintTo(FormatWalker);\r | |
2761 | if (EFI_ERROR(Status)) {\r | |
2762 | break;\r | |
2763 | }\r | |
2764 | }\r | |
2765 | \r | |
975136ab | 2766 | //\r |
2767 | // update the attribute\r | |
2768 | //\r | |
2769 | if (ResumeLocation != NULL) {\r | |
5d46f17b | 2770 | if (*(ResumeLocation-1) == L'^') {\r |
8bb7441e | 2771 | //\r |
2772 | // Move cursor back 1 position to overwrite the ^\r | |
2773 | //\r | |
2774 | gST->ConOut->SetCursorPosition(gST->ConOut, gST->ConOut->Mode->CursorColumn - 1, gST->ConOut->Mode->CursorRow);\r | |
2775 | \r | |
5d46f17b | 2776 | //\r |
2777 | // Print a simple '%' symbol\r | |
2778 | //\r | |
2779 | Status = InternalPrintTo(L"%");\r | |
2780 | ResumeLocation = ResumeLocation - 1;\r | |
2781 | } else {\r | |
2782 | switch (*(ResumeLocation+1)) {\r | |
2783 | case (L'N'):\r | |
2784 | gST->ConOut->SetAttribute(gST->ConOut, OriginalAttribute);\r | |
a405b86d | 2785 | break;\r |
5d46f17b | 2786 | case (L'E'):\r |
2787 | gST->ConOut->SetAttribute(gST->ConOut, EFI_TEXT_ATTR(EFI_YELLOW, ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)));\r | |
2788 | break;\r | |
2789 | case (L'H'):\r | |
2790 | gST->ConOut->SetAttribute(gST->ConOut, EFI_TEXT_ATTR(EFI_WHITE, ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)));\r | |
2791 | break;\r | |
2792 | case (L'B'):\r | |
2793 | gST->ConOut->SetAttribute(gST->ConOut, EFI_TEXT_ATTR(EFI_BLUE, ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)));\r | |
2794 | break;\r | |
2795 | case (L'V'):\r | |
2796 | gST->ConOut->SetAttribute(gST->ConOut, EFI_TEXT_ATTR(EFI_GREEN, ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)));\r | |
2797 | break;\r | |
2798 | default:\r | |
2799 | //\r | |
2800 | // Print a simple '%' symbol\r | |
2801 | //\r | |
2802 | Status = InternalPrintTo(L"%");\r | |
2803 | if (EFI_ERROR(Status)) {\r | |
2804 | break;\r | |
2805 | }\r | |
2806 | ResumeLocation = ResumeLocation - 1;\r | |
2807 | break;\r | |
2808 | }\r | |
975136ab | 2809 | }\r |
2810 | } else {\r | |
2811 | //\r | |
2812 | // reset to normal now...\r | |
2813 | //\r | |
975136ab | 2814 | break;\r |
2815 | }\r | |
2816 | \r | |
2817 | //\r | |
2818 | // update FormatWalker to Resume + 2 (skip the % and the indicator)\r | |
2819 | //\r | |
2820 | FormatWalker = ResumeLocation + 2;\r | |
2821 | }\r | |
b1f95a06 | 2822 | \r |
a405b86d | 2823 | gST->ConOut->SetAttribute(gST->ConOut, OriginalAttribute);\r |
89e8537a | 2824 | \r |
2825 | SHELL_FREE_NON_NULL(mPostReplaceFormat);\r | |
2826 | SHELL_FREE_NON_NULL(mPostReplaceFormat2);\r | |
a405b86d | 2827 | return (Status);\r |
5f7431d0 | 2828 | }\r |
2247dde4 | 2829 | \r |
2830 | /**\r | |
2831 | Print at a specific location on the screen.\r | |
2832 | \r | |
e2f8297f | 2833 | This function will move the cursor to a given screen location and print the specified string.\r |
1e6e84c7 | 2834 | \r |
2835 | If -1 is specified for either the Row or Col the current screen location for BOTH\r | |
2247dde4 | 2836 | will be used.\r |
2837 | \r | |
e2f8297f | 2838 | If either Row or Col is out of range for the current console, then ASSERT.\r |
2839 | If Format is NULL, then ASSERT.\r | |
2247dde4 | 2840 | \r |
1e6e84c7 | 2841 | In addition to the standard %-based flags as supported by UefiLib Print() this supports\r |
2247dde4 | 2842 | the following additional flags:\r |
2843 | %N - Set output attribute to normal\r | |
2844 | %H - Set output attribute to highlight\r | |
2845 | %E - Set output attribute to error\r | |
2846 | %B - Set output attribute to blue color\r | |
2847 | %V - Set output attribute to green color\r | |
2848 | \r | |
2849 | Note: The background color is controlled by the shell command cls.\r | |
2850 | \r | |
2247dde4 | 2851 | @param[in] Col the column to print at\r |
a405b86d | 2852 | @param[in] Row the row to print at\r |
2247dde4 | 2853 | @param[in] Format the format string\r |
a405b86d | 2854 | @param[in] ... The variable argument list.\r |
2247dde4 | 2855 | \r |
a405b86d | 2856 | @return EFI_SUCCESS The printing was successful.\r |
2857 | @return EFI_DEVICE_ERROR The console device reported an error.\r | |
2247dde4 | 2858 | **/\r |
a405b86d | 2859 | EFI_STATUS\r |
2247dde4 | 2860 | EFIAPI\r |
2861 | ShellPrintEx(\r | |
2862 | IN INT32 Col OPTIONAL,\r | |
2863 | IN INT32 Row OPTIONAL,\r | |
2864 | IN CONST CHAR16 *Format,\r | |
2865 | ...\r | |
1e6e84c7 | 2866 | )\r |
2247dde4 | 2867 | {\r |
2868 | VA_LIST Marker;\r | |
a405b86d | 2869 | EFI_STATUS RetVal;\r |
3e082d58 | 2870 | if (Format == NULL) {\r |
2871 | return (EFI_INVALID_PARAMETER);\r | |
2872 | }\r | |
2247dde4 | 2873 | VA_START (Marker, Format);\r |
a405b86d | 2874 | RetVal = InternalShellPrintWorker(Col, Row, Format, Marker);\r |
e2f8297f | 2875 | VA_END(Marker);\r |
a405b86d | 2876 | return(RetVal);\r |
2247dde4 | 2877 | }\r |
2878 | \r | |
2879 | /**\r | |
2880 | Print at a specific location on the screen.\r | |
2881 | \r | |
e2f8297f | 2882 | This function will move the cursor to a given screen location and print the specified string.\r |
1e6e84c7 | 2883 | \r |
2884 | If -1 is specified for either the Row or Col the current screen location for BOTH\r | |
e2f8297f | 2885 | will be used.\r |
2247dde4 | 2886 | \r |
e2f8297f | 2887 | If either Row or Col is out of range for the current console, then ASSERT.\r |
2888 | If Format is NULL, then ASSERT.\r | |
2247dde4 | 2889 | \r |
1e6e84c7 | 2890 | In addition to the standard %-based flags as supported by UefiLib Print() this supports\r |
2247dde4 | 2891 | the following additional flags:\r |
1e6e84c7 | 2892 | %N - Set output attribute to normal.\r |
2893 | %H - Set output attribute to highlight.\r | |
2894 | %E - Set output attribute to error.\r | |
2895 | %B - Set output attribute to blue color.\r | |
2896 | %V - Set output attribute to green color.\r | |
2247dde4 | 2897 | \r |
2898 | Note: The background color is controlled by the shell command cls.\r | |
2899 | \r | |
1e6e84c7 | 2900 | @param[in] Col The column to print at.\r |
a405b86d | 2901 | @param[in] Row The row to print at.\r |
1e6e84c7 | 2902 | @param[in] Language The language of the string to retrieve. If this parameter\r |
2903 | is NULL, then the current platform language is used.\r | |
2904 | @param[in] HiiFormatStringId The format string Id for getting from Hii.\r | |
2905 | @param[in] HiiFormatHandle The format string Handle for getting from Hii.\r | |
a405b86d | 2906 | @param[in] ... The variable argument list.\r |
2247dde4 | 2907 | \r |
a405b86d | 2908 | @return EFI_SUCCESS The printing was successful.\r |
2909 | @return EFI_DEVICE_ERROR The console device reported an error.\r | |
2247dde4 | 2910 | **/\r |
a405b86d | 2911 | EFI_STATUS\r |
2247dde4 | 2912 | EFIAPI\r |
2913 | ShellPrintHiiEx(\r | |
2914 | IN INT32 Col OPTIONAL,\r | |
2915 | IN INT32 Row OPTIONAL,\r | |
1e6e84c7 | 2916 | IN CONST CHAR8 *Language OPTIONAL,\r |
2247dde4 | 2917 | IN CONST EFI_STRING_ID HiiFormatStringId,\r |
2918 | IN CONST EFI_HANDLE HiiFormatHandle,\r | |
2919 | ...\r | |
2920 | )\r | |
2921 | {\r | |
2922 | VA_LIST Marker;\r | |
2923 | CHAR16 *HiiFormatString;\r | |
a405b86d | 2924 | EFI_STATUS RetVal;\r |
2247dde4 | 2925 | \r |
2926 | VA_START (Marker, HiiFormatHandle);\r | |
1e6e84c7 | 2927 | HiiFormatString = HiiGetString(HiiFormatHandle, HiiFormatStringId, Language);\r |
2247dde4 | 2928 | ASSERT(HiiFormatString != NULL);\r |
2929 | \r | |
2930 | RetVal = InternalShellPrintWorker(Col, Row, HiiFormatString, Marker);\r | |
2931 | \r | |
a405b86d | 2932 | SHELL_FREE_NON_NULL(HiiFormatString);\r |
e2f8297f | 2933 | VA_END(Marker);\r |
2247dde4 | 2934 | \r |
2935 | return (RetVal);\r | |
2936 | }\r | |
2937 | \r | |
2938 | /**\r | |
2939 | Function to determine if a given filename represents a file or a directory.\r | |
2940 | \r | |
2941 | @param[in] DirName Path to directory to test.\r | |
2942 | \r | |
c8c22591 | 2943 | @retval EFI_SUCCESS The Path represents a directory\r |
2944 | @retval EFI_NOT_FOUND The Path does not represent a directory\r | |
2945 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r | |
2946 | @return The path failed to open\r | |
2247dde4 | 2947 | **/\r |
2948 | EFI_STATUS\r | |
2949 | EFIAPI\r | |
2950 | ShellIsDirectory(\r | |
2951 | IN CONST CHAR16 *DirName\r | |
2952 | )\r | |
2953 | {\r | |
2954 | EFI_STATUS Status;\r | |
a405b86d | 2955 | SHELL_FILE_HANDLE Handle;\r |
3e082d58 | 2956 | CHAR16 *TempLocation;\r |
2957 | CHAR16 *TempLocation2;\r | |
2247dde4 | 2958 | \r |
ecd3d59f | 2959 | ASSERT(DirName != NULL);\r |
2960 | \r | |
a405b86d | 2961 | Handle = NULL;\r |
2962 | TempLocation = NULL;\r | |
2247dde4 | 2963 | \r |
2964 | Status = ShellOpenFileByName(DirName, &Handle, EFI_FILE_MODE_READ, 0);\r | |
2965 | if (EFI_ERROR(Status)) {\r | |
a405b86d | 2966 | //\r |
2967 | // try good logic first.\r | |
2968 | //\r | |
366f81a0 | 2969 | if (gEfiShellProtocol != NULL) {\r |
3e082d58 | 2970 | TempLocation = StrnCatGrow(&TempLocation, NULL, DirName, 0);\r |
c8c22591 | 2971 | if (TempLocation == NULL) {\r |
2972 | ShellCloseFile(&Handle);\r | |
2973 | return (EFI_OUT_OF_RESOURCES);\r | |
2974 | }\r | |
3e082d58 | 2975 | TempLocation2 = StrStr(TempLocation, L":");\r |
2976 | if (TempLocation2 != NULL && StrLen(StrStr(TempLocation, L":")) == 2) {\r | |
2977 | *(TempLocation2+1) = CHAR_NULL;\r | |
a405b86d | 2978 | }\r |
366f81a0 | 2979 | if (gEfiShellProtocol->GetDevicePathFromMap(TempLocation) != NULL) {\r |
a405b86d | 2980 | FreePool(TempLocation);\r |
2981 | return (EFI_SUCCESS);\r | |
2982 | }\r | |
2983 | FreePool(TempLocation);\r | |
2984 | } else {\r | |
2985 | //\r | |
2986 | // probably a map name?!?!!?\r | |
2987 | //\r | |
2988 | TempLocation = StrStr(DirName, L"\\");\r | |
2989 | if (TempLocation != NULL && *(TempLocation+1) == CHAR_NULL) {\r | |
2990 | return (EFI_SUCCESS);\r | |
2991 | }\r | |
2992 | }\r | |
2247dde4 | 2993 | return (Status);\r |
2994 | }\r | |
2995 | \r | |
2996 | if (FileHandleIsDirectory(Handle) == EFI_SUCCESS) {\r | |
2997 | ShellCloseFile(&Handle);\r | |
2998 | return (EFI_SUCCESS);\r | |
2999 | }\r | |
3000 | ShellCloseFile(&Handle);\r | |
3001 | return (EFI_NOT_FOUND);\r | |
3002 | }\r | |
3003 | \r | |
36a9d672 | 3004 | /**\r |
3005 | Function to determine if a given filename represents a file.\r | |
3006 | \r | |
3007 | @param[in] Name Path to file to test.\r | |
3008 | \r | |
3009 | @retval EFI_SUCCESS The Path represents a file.\r | |
3010 | @retval EFI_NOT_FOUND The Path does not represent a file.\r | |
3011 | @retval other The path failed to open.\r | |
3012 | **/\r | |
3013 | EFI_STATUS\r | |
3014 | EFIAPI\r | |
3015 | ShellIsFile(\r | |
3016 | IN CONST CHAR16 *Name\r | |
3017 | )\r | |
3018 | {\r | |
3019 | EFI_STATUS Status;\r | |
a405b86d | 3020 | SHELL_FILE_HANDLE Handle;\r |
36a9d672 | 3021 | \r |
ecd3d59f | 3022 | ASSERT(Name != NULL);\r |
3023 | \r | |
36a9d672 | 3024 | Handle = NULL;\r |
3025 | \r | |
3026 | Status = ShellOpenFileByName(Name, &Handle, EFI_FILE_MODE_READ, 0);\r | |
3027 | if (EFI_ERROR(Status)) {\r | |
3028 | return (Status);\r | |
3029 | }\r | |
3030 | \r | |
3031 | if (FileHandleIsDirectory(Handle) != EFI_SUCCESS) {\r | |
3032 | ShellCloseFile(&Handle);\r | |
3033 | return (EFI_SUCCESS);\r | |
3034 | }\r | |
3035 | ShellCloseFile(&Handle);\r | |
3036 | return (EFI_NOT_FOUND);\r | |
3037 | }\r | |
3038 | \r | |
b3011f40 | 3039 | /**\r |
3040 | Function to determine if a given filename represents a file.\r | |
3041 | \r | |
3042 | This will search the CWD and then the Path.\r | |
3043 | \r | |
3044 | If Name is NULL, then ASSERT.\r | |
3045 | \r | |
3046 | @param[in] Name Path to file to test.\r | |
3047 | \r | |
3048 | @retval EFI_SUCCESS The Path represents a file.\r | |
3049 | @retval EFI_NOT_FOUND The Path does not represent a file.\r | |
3050 | @retval other The path failed to open.\r | |
3051 | **/\r | |
3052 | EFI_STATUS\r | |
3053 | EFIAPI\r | |
3054 | ShellIsFileInPath(\r | |
3055 | IN CONST CHAR16 *Name\r | |
a405b86d | 3056 | )\r |
3057 | {\r | |
b3011f40 | 3058 | CHAR16 *NewName;\r |
3059 | EFI_STATUS Status;\r | |
3060 | \r | |
3061 | if (!EFI_ERROR(ShellIsFile(Name))) {\r | |
a405b86d | 3062 | return (EFI_SUCCESS);\r |
b3011f40 | 3063 | }\r |
3064 | \r | |
3065 | NewName = ShellFindFilePath(Name);\r | |
3066 | if (NewName == NULL) {\r | |
3067 | return (EFI_NOT_FOUND);\r | |
3068 | }\r | |
3069 | Status = ShellIsFile(NewName);\r | |
3070 | FreePool(NewName);\r | |
3071 | return (Status);\r | |
3072 | }\r | |
252d9457 | 3073 | \r |
74b0fb8c JC |
3074 | /**\r |
3075 | Function return the number converted from a hex representation of a number.\r | |
3076 | \r | |
3077 | Note: this function cannot be used when (UINTN)(-1), (0xFFFFFFFF) may be a valid\r | |
3078 | result. Use ShellConvertStringToUint64 instead.\r | |
3079 | \r | |
3080 | @param[in] String String representation of a number.\r | |
3081 | \r | |
3082 | @return The unsigned integer result of the conversion.\r | |
3083 | @retval (UINTN)(-1) An error occured.\r | |
3084 | **/\r | |
3085 | UINTN\r | |
3086 | EFIAPI\r | |
3087 | ShellHexStrToUintn(\r | |
3088 | IN CONST CHAR16 *String\r | |
3089 | )\r | |
3090 | {\r | |
3091 | UINT64 RetVal;\r | |
3092 | \r | |
3093 | if (!EFI_ERROR(ShellConvertStringToUint64(String, &RetVal, TRUE, TRUE))) {\r | |
3094 | return ((UINTN)RetVal);\r | |
3095 | }\r | |
3096 | \r | |
3097 | return ((UINTN)(-1));\r | |
3098 | }\r | |
3099 | \r | |
125c2cf4 | 3100 | /**\r |
1e6e84c7 | 3101 | Function to determine whether a string is decimal or hex representation of a number\r |
d59fc244 | 3102 | and return the number converted from the string. Spaces are always skipped.\r |
125c2cf4 | 3103 | \r |
3104 | @param[in] String String representation of a number\r | |
3105 | \r | |
252d9457 | 3106 | @return the number\r |
3107 | @retval (UINTN)(-1) An error ocurred.\r | |
125c2cf4 | 3108 | **/\r |
3109 | UINTN\r | |
3110 | EFIAPI\r | |
3111 | ShellStrToUintn(\r | |
3112 | IN CONST CHAR16 *String\r | |
3113 | )\r | |
3114 | {\r | |
252d9457 | 3115 | UINT64 RetVal;\r |
3116 | BOOLEAN Hex;\r | |
3117 | \r | |
3118 | Hex = FALSE;\r | |
3119 | \r | |
3120 | if (!InternalShellIsHexOrDecimalNumber(String, Hex, TRUE)) {\r | |
3121 | Hex = TRUE;\r | |
125c2cf4 | 3122 | }\r |
252d9457 | 3123 | \r |
3124 | if (!EFI_ERROR(ShellConvertStringToUint64(String, &RetVal, Hex, TRUE))) {\r | |
3125 | return ((UINTN)RetVal);\r | |
3126 | }\r | |
3127 | return ((UINTN)(-1));\r | |
125c2cf4 | 3128 | }\r |
3129 | \r | |
3130 | /**\r | |
3131 | Safely append with automatic string resizing given length of Destination and\r | |
3132 | desired length of copy from Source.\r | |
3133 | \r | |
3134 | append the first D characters of Source to the end of Destination, where D is\r | |
3135 | the lesser of Count and the StrLen() of Source. If appending those D characters\r | |
3136 | will fit within Destination (whose Size is given as CurrentSize) and\r | |
1e6e84c7 | 3137 | still leave room for a NULL terminator, then those characters are appended,\r |
3138 | starting at the original terminating NULL of Destination, and a new terminating\r | |
3139 | NULL is appended.\r | |
125c2cf4 | 3140 | \r |
3141 | If appending D characters onto Destination will result in a overflow of the size\r | |
3142 | given in CurrentSize the string will be grown such that the copy can be performed\r | |
3143 | and CurrentSize will be updated to the new size.\r | |
3144 | \r | |
3145 | If Source is NULL, there is nothing to append, just return the current buffer in\r | |
3146 | Destination.\r | |
3147 | \r | |
3148 | if Destination is NULL, then ASSERT()\r | |
3149 | if Destination's current length (including NULL terminator) is already more then\r | |
3150 | CurrentSize, then ASSERT()\r | |
3151 | \r | |
4ff7e37b ED |
3152 | @param[in, out] Destination The String to append onto\r |
3153 | @param[in, out] CurrentSize on call the number of bytes in Destination. On\r | |
125c2cf4 | 3154 | return possibly the new size (still in bytes). if NULL\r |
3155 | then allocate whatever is needed.\r | |
3156 | @param[in] Source The String to append from\r | |
3157 | @param[in] Count Maximum number of characters to append. if 0 then\r | |
3158 | all are appended.\r | |
3159 | \r | |
3160 | @return Destination return the resultant string.\r | |
3161 | **/\r | |
3162 | CHAR16*\r | |
3163 | EFIAPI\r | |
3164 | StrnCatGrow (\r | |
3165 | IN OUT CHAR16 **Destination,\r | |
3166 | IN OUT UINTN *CurrentSize,\r | |
3167 | IN CONST CHAR16 *Source,\r | |
3168 | IN UINTN Count\r | |
3169 | )\r | |
3170 | {\r | |
3171 | UINTN DestinationStartSize;\r | |
3172 | UINTN NewSize;\r | |
3173 | \r | |
3174 | //\r | |
3175 | // ASSERTs\r | |
3176 | //\r | |
3177 | ASSERT(Destination != NULL);\r | |
3178 | \r | |
3179 | //\r | |
3180 | // If there's nothing to do then just return Destination\r | |
3181 | //\r | |
3182 | if (Source == NULL) {\r | |
3183 | return (*Destination);\r | |
3184 | }\r | |
3185 | \r | |
3186 | //\r | |
3187 | // allow for un-initialized pointers, based on size being 0\r | |
3188 | //\r | |
3189 | if (CurrentSize != NULL && *CurrentSize == 0) {\r | |
3190 | *Destination = NULL;\r | |
3191 | }\r | |
3192 | \r | |
3193 | //\r | |
3194 | // allow for NULL pointers address as Destination\r | |
3195 | //\r | |
3196 | if (*Destination != NULL) {\r | |
3197 | ASSERT(CurrentSize != 0);\r | |
3198 | DestinationStartSize = StrSize(*Destination);\r | |
3199 | ASSERT(DestinationStartSize <= *CurrentSize);\r | |
3200 | } else {\r | |
3201 | DestinationStartSize = 0;\r | |
3202 | // ASSERT(*CurrentSize == 0);\r | |
3203 | }\r | |
3204 | \r | |
3205 | //\r | |
3206 | // Append all of Source?\r | |
3207 | //\r | |
3208 | if (Count == 0) {\r | |
3209 | Count = StrLen(Source);\r | |
3210 | }\r | |
3211 | \r | |
3212 | //\r | |
3213 | // Test and grow if required\r | |
3214 | //\r | |
3215 | if (CurrentSize != NULL) {\r | |
3216 | NewSize = *CurrentSize;\r | |
f480fdc0 ED |
3217 | if (NewSize < DestinationStartSize + (Count * sizeof(CHAR16))) {\r |
3218 | while (NewSize < (DestinationStartSize + (Count*sizeof(CHAR16)))) {\r | |
3219 | NewSize += 2 * Count * sizeof(CHAR16);\r | |
3220 | }\r | |
3221 | *Destination = ReallocatePool(*CurrentSize, NewSize, *Destination);\r | |
3222 | *CurrentSize = NewSize;\r | |
125c2cf4 | 3223 | }\r |
125c2cf4 | 3224 | } else {\r |
3225 | *Destination = AllocateZeroPool((Count+1)*sizeof(CHAR16));\r | |
3226 | }\r | |
3227 | \r | |
3228 | //\r | |
3229 | // Now use standard StrnCat on a big enough buffer\r | |
3230 | //\r | |
c9d92df0 | 3231 | if (*Destination == NULL) {\r |
3232 | return (NULL);\r | |
3233 | }\r | |
125c2cf4 | 3234 | return StrnCat(*Destination, Source, Count);\r |
3235 | }\r | |
c9d92df0 | 3236 | \r |
3237 | /**\r | |
3238 | Prompt the user and return the resultant answer to the requestor.\r | |
3239 | \r | |
3240 | This function will display the requested question on the shell prompt and then\r | |
3241 | wait for an apropriate answer to be input from the console.\r | |
3242 | \r | |
a405b86d | 3243 | if the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue\r |
c9d92df0 | 3244 | or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.\r |
3245 | \r | |
a405b86d | 3246 | if the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type\r |
c9d92df0 | 3247 | CHAR16*.\r |
3248 | \r | |
3249 | In either case *Response must be callee freed if Response was not NULL;\r | |
3250 | \r | |
3251 | @param Type What type of question is asked. This is used to filter the input\r | |
3252 | to prevent invalid answers to question.\r | |
3253 | @param Prompt Pointer to string prompt to use to request input.\r | |
3254 | @param Response Pointer to Response which will be populated upon return.\r | |
3255 | \r | |
3256 | @retval EFI_SUCCESS The operation was sucessful.\r | |
3257 | @retval EFI_UNSUPPORTED The operation is not supported as requested.\r | |
3258 | @retval EFI_INVALID_PARAMETER A parameter was invalid.\r | |
3259 | @return other The operation failed.\r | |
3260 | **/\r | |
3261 | EFI_STATUS\r | |
3262 | EFIAPI\r | |
3263 | ShellPromptForResponse (\r | |
3264 | IN SHELL_PROMPT_REQUEST_TYPE Type,\r | |
3265 | IN CHAR16 *Prompt OPTIONAL,\r | |
3266 | IN OUT VOID **Response OPTIONAL\r | |
3267 | )\r | |
3268 | {\r | |
3269 | EFI_STATUS Status;\r | |
3270 | EFI_INPUT_KEY Key;\r | |
3271 | UINTN EventIndex;\r | |
3272 | SHELL_PROMPT_RESPONSE *Resp;\r | |
a405b86d | 3273 | UINTN Size;\r |
3274 | CHAR16 *Buffer;\r | |
c9d92df0 | 3275 | \r |
a405b86d | 3276 | Status = EFI_UNSUPPORTED;\r |
3277 | Resp = NULL;\r | |
3278 | Buffer = NULL;\r | |
3279 | Size = 0;\r | |
3280 | if (Type != ShellPromptResponseTypeFreeform) {\r | |
252d9457 | 3281 | Resp = (SHELL_PROMPT_RESPONSE*)AllocateZeroPool(sizeof(SHELL_PROMPT_RESPONSE));\r |
3e082d58 | 3282 | if (Resp == NULL) {\r |
3283 | return (EFI_OUT_OF_RESOURCES);\r | |
3284 | }\r | |
90bfa227 | 3285 | }\r |
c9d92df0 | 3286 | \r |
3287 | switch(Type) {\r | |
a405b86d | 3288 | case ShellPromptResponseTypeQuitContinue:\r |
c9d92df0 | 3289 | if (Prompt != NULL) {\r |
3290 | ShellPrintEx(-1, -1, L"%s", Prompt);\r | |
3291 | }\r | |
3292 | //\r | |
3293 | // wait for valid response\r | |
3294 | //\r | |
3295 | gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r | |
3296 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r | |
31b018a6 JC |
3297 | if (EFI_ERROR(Status)) {\r |
3298 | break;\r | |
3299 | }\r | |
c9d92df0 | 3300 | ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r |
3301 | if (Key.UnicodeChar == L'Q' || Key.UnicodeChar ==L'q') {\r | |
a405b86d | 3302 | *Resp = ShellPromptResponseQuit;\r |
c9d92df0 | 3303 | } else {\r |
a405b86d | 3304 | *Resp = ShellPromptResponseContinue;\r |
c9d92df0 | 3305 | }\r |
3306 | break;\r | |
a405b86d | 3307 | case ShellPromptResponseTypeYesNoCancel:\r |
c9d92df0 | 3308 | if (Prompt != NULL) {\r |
3309 | ShellPrintEx(-1, -1, L"%s", Prompt);\r | |
3310 | }\r | |
3311 | //\r | |
3312 | // wait for valid response\r | |
3313 | //\r | |
a405b86d | 3314 | *Resp = ShellPromptResponseMax;\r |
3315 | while (*Resp == ShellPromptResponseMax) {\r | |
194ae48d JC |
3316 | if (ShellGetExecutionBreakFlag()) {\r |
3317 | Status = EFI_ABORTED;\r | |
3318 | break;\r | |
3319 | }\r | |
c9d92df0 | 3320 | gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r |
3321 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r | |
31b018a6 JC |
3322 | if (EFI_ERROR(Status)) {\r |
3323 | break;\r | |
3324 | }\r | |
c9d92df0 | 3325 | ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r |
3326 | switch (Key.UnicodeChar) {\r | |
3327 | case L'Y':\r | |
3328 | case L'y':\r | |
a405b86d | 3329 | *Resp = ShellPromptResponseYes;\r |
c9d92df0 | 3330 | break;\r |
3331 | case L'N':\r | |
3332 | case L'n':\r | |
a405b86d | 3333 | *Resp = ShellPromptResponseNo;\r |
3334 | break;\r | |
3335 | case L'C':\r | |
3336 | case L'c':\r | |
3337 | *Resp = ShellPromptResponseCancel;\r | |
3338 | break;\r | |
3339 | }\r | |
3340 | }\r | |
3341 | break; case ShellPromptResponseTypeYesNoAllCancel:\r | |
3342 | if (Prompt != NULL) {\r | |
3343 | ShellPrintEx(-1, -1, L"%s", Prompt);\r | |
3344 | }\r | |
3345 | //\r | |
3346 | // wait for valid response\r | |
3347 | //\r | |
3348 | *Resp = ShellPromptResponseMax;\r | |
3349 | while (*Resp == ShellPromptResponseMax) {\r | |
194ae48d JC |
3350 | if (ShellGetExecutionBreakFlag()) {\r |
3351 | Status = EFI_ABORTED;\r | |
3352 | break;\r | |
3353 | }\r | |
a405b86d | 3354 | gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r |
3355 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r | |
31b018a6 JC |
3356 | if (EFI_ERROR(Status)) {\r |
3357 | break;\r | |
3358 | }\r | |
a405b86d | 3359 | ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r |
3360 | switch (Key.UnicodeChar) {\r | |
3361 | case L'Y':\r | |
3362 | case L'y':\r | |
3363 | *Resp = ShellPromptResponseYes;\r | |
3364 | break;\r | |
3365 | case L'N':\r | |
3366 | case L'n':\r | |
3367 | *Resp = ShellPromptResponseNo;\r | |
c9d92df0 | 3368 | break;\r |
3369 | case L'A':\r | |
3370 | case L'a':\r | |
a405b86d | 3371 | *Resp = ShellPromptResponseAll;\r |
c9d92df0 | 3372 | break;\r |
3373 | case L'C':\r | |
3374 | case L'c':\r | |
a405b86d | 3375 | *Resp = ShellPromptResponseCancel;\r |
c9d92df0 | 3376 | break;\r |
3377 | }\r | |
3378 | }\r | |
3379 | break;\r | |
a405b86d | 3380 | case ShellPromptResponseTypeEnterContinue:\r |
3381 | case ShellPromptResponseTypeAnyKeyContinue:\r | |
c9d92df0 | 3382 | if (Prompt != NULL) {\r |
3383 | ShellPrintEx(-1, -1, L"%s", Prompt);\r | |
3384 | }\r | |
3385 | //\r | |
3386 | // wait for valid response\r | |
3387 | //\r | |
a405b86d | 3388 | *Resp = ShellPromptResponseMax;\r |
3389 | while (*Resp == ShellPromptResponseMax) {\r | |
194ae48d JC |
3390 | if (ShellGetExecutionBreakFlag()) {\r |
3391 | Status = EFI_ABORTED;\r | |
3392 | break;\r | |
3393 | }\r | |
c9d92df0 | 3394 | gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r |
a405b86d | 3395 | if (Type == ShellPromptResponseTypeEnterContinue) {\r |
c9d92df0 | 3396 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r |
31b018a6 JC |
3397 | if (EFI_ERROR(Status)) {\r |
3398 | break;\r | |
3399 | }\r | |
c9d92df0 | 3400 | ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r |
3401 | if (Key.UnicodeChar == CHAR_CARRIAGE_RETURN) {\r | |
a405b86d | 3402 | *Resp = ShellPromptResponseContinue;\r |
c9d92df0 | 3403 | break;\r |
3404 | }\r | |
3405 | }\r | |
a405b86d | 3406 | if (Type == ShellPromptResponseTypeAnyKeyContinue) {\r |
3407 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r | |
3408 | ASSERT_EFI_ERROR(Status);\r | |
3409 | *Resp = ShellPromptResponseContinue;\r | |
3410 | break;\r | |
3411 | }\r | |
3412 | }\r | |
3413 | break;\r | |
3414 | case ShellPromptResponseTypeYesNo:\r | |
3415 | if (Prompt != NULL) {\r | |
3416 | ShellPrintEx(-1, -1, L"%s", Prompt);\r | |
3417 | }\r | |
3418 | //\r | |
3419 | // wait for valid response\r | |
3420 | //\r | |
3421 | *Resp = ShellPromptResponseMax;\r | |
3422 | while (*Resp == ShellPromptResponseMax) {\r | |
194ae48d JC |
3423 | if (ShellGetExecutionBreakFlag()) {\r |
3424 | Status = EFI_ABORTED;\r | |
3425 | break;\r | |
3426 | }\r | |
a405b86d | 3427 | gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r |
3428 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r | |
31b018a6 JC |
3429 | if (EFI_ERROR(Status)) {\r |
3430 | break;\r | |
3431 | }\r | |
a405b86d | 3432 | ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r |
3433 | switch (Key.UnicodeChar) {\r | |
3434 | case L'Y':\r | |
3435 | case L'y':\r | |
3436 | *Resp = ShellPromptResponseYes;\r | |
3437 | break;\r | |
3438 | case L'N':\r | |
3439 | case L'n':\r | |
3440 | *Resp = ShellPromptResponseNo;\r | |
3441 | break;\r | |
3442 | }\r | |
3443 | }\r | |
3444 | break;\r | |
3445 | case ShellPromptResponseTypeFreeform:\r | |
3446 | if (Prompt != NULL) {\r | |
3447 | ShellPrintEx(-1, -1, L"%s", Prompt);\r | |
3448 | }\r | |
3449 | while(1) {\r | |
194ae48d JC |
3450 | if (ShellGetExecutionBreakFlag()) {\r |
3451 | Status = EFI_ABORTED;\r | |
3452 | break;\r | |
3453 | }\r | |
a405b86d | 3454 | gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r |
3455 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r | |
31b018a6 JC |
3456 | if (EFI_ERROR(Status)) {\r |
3457 | break;\r | |
3458 | }\r | |
a405b86d | 3459 | ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r |
3460 | if (Key.UnicodeChar == CHAR_CARRIAGE_RETURN) {\r | |
c9d92df0 | 3461 | break;\r |
3462 | }\r | |
a405b86d | 3463 | ASSERT((Buffer == NULL && Size == 0) || (Buffer != NULL));\r |
3464 | StrnCatGrow(&Buffer, &Size, &Key.UnicodeChar, 1);\r | |
c9d92df0 | 3465 | }\r |
3466 | break;\r | |
a405b86d | 3467 | //\r |
3468 | // This is the location to add new prompt types.\r | |
194ae48d | 3469 | // If your new type loops remember to add ExecutionBreak support.\r |
a405b86d | 3470 | //\r |
c9d92df0 | 3471 | default:\r |
a405b86d | 3472 | ASSERT(FALSE);\r |
c9d92df0 | 3473 | }\r |
3474 | \r | |
3475 | if (Response != NULL) {\r | |
a405b86d | 3476 | if (Resp != NULL) {\r |
3477 | *Response = Resp;\r | |
3478 | } else if (Buffer != NULL) {\r | |
3479 | *Response = Buffer;\r | |
3480 | }\r | |
c9d92df0 | 3481 | } else {\r |
a405b86d | 3482 | if (Resp != NULL) {\r |
3483 | FreePool(Resp);\r | |
3484 | }\r | |
3485 | if (Buffer != NULL) {\r | |
3486 | FreePool(Buffer);\r | |
3487 | }\r | |
c9d92df0 | 3488 | }\r |
3489 | \r | |
a405b86d | 3490 | ShellPrintEx(-1, -1, L"\r\n");\r |
c9d92df0 | 3491 | return (Status);\r |
3492 | }\r | |
3493 | \r | |
3494 | /**\r | |
3495 | Prompt the user and return the resultant answer to the requestor.\r | |
3496 | \r | |
3497 | This function is the same as ShellPromptForResponse, except that the prompt is\r | |
3498 | automatically pulled from HII.\r | |
3499 | \r | |
3500 | @param Type What type of question is asked. This is used to filter the input\r | |
3501 | to prevent invalid answers to question.\r | |
a405b86d | 3502 | @param[in] HiiFormatStringId The format string Id for getting from Hii.\r |
3503 | @param[in] HiiFormatHandle The format string Handle for getting from Hii.\r | |
3504 | @param Response Pointer to Response which will be populated upon return.\r | |
c9d92df0 | 3505 | \r |
3506 | @retval EFI_SUCCESS the operation was sucessful.\r | |
3507 | @return other the operation failed.\r | |
3508 | \r | |
3509 | @sa ShellPromptForResponse\r | |
3510 | **/\r | |
3511 | EFI_STATUS\r | |
3512 | EFIAPI\r | |
3513 | ShellPromptForResponseHii (\r | |
3514 | IN SHELL_PROMPT_REQUEST_TYPE Type,\r | |
3515 | IN CONST EFI_STRING_ID HiiFormatStringId,\r | |
3516 | IN CONST EFI_HANDLE HiiFormatHandle,\r | |
3517 | IN OUT VOID **Response\r | |
3518 | )\r | |
3519 | {\r | |
3520 | CHAR16 *Prompt;\r | |
3521 | EFI_STATUS Status;\r | |
3522 | \r | |
3523 | Prompt = HiiGetString(HiiFormatHandle, HiiFormatStringId, NULL);\r | |
3524 | Status = ShellPromptForResponse(Type, Prompt, Response);\r | |
3525 | FreePool(Prompt);\r | |
3526 | return (Status);\r | |
3527 | }\r | |
3528 | \r | |
a405b86d | 3529 | /**\r |
3530 | Function to determin if an entire string is a valid number.\r | |
3531 | \r | |
3532 | If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.\r | |
c9d92df0 | 3533 | \r |
a405b86d | 3534 | @param[in] String The string to evaluate.\r |
3535 | @param[in] ForceHex TRUE - always assume hex.\r | |
3536 | @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.\r | |
3537 | \r | |
3538 | @retval TRUE It is all numeric (dec/hex) characters.\r | |
3539 | @retval FALSE There is a non-numeric character.\r | |
3540 | **/\r | |
3541 | BOOLEAN\r | |
3542 | EFIAPI\r | |
252d9457 | 3543 | InternalShellIsHexOrDecimalNumber (\r |
a405b86d | 3544 | IN CONST CHAR16 *String,\r |
3545 | IN CONST BOOLEAN ForceHex,\r | |
3546 | IN CONST BOOLEAN StopAtSpace\r | |
3547 | )\r | |
3548 | {\r | |
3549 | BOOLEAN Hex;\r | |
3550 | \r | |
3551 | //\r | |
3552 | // chop off a single negative sign\r | |
3553 | //\r | |
3554 | if (String != NULL && *String == L'-') {\r | |
3555 | String++;\r | |
3556 | }\r | |
b0934ac4 | 3557 | \r |
a405b86d | 3558 | if (String == NULL) {\r |
3559 | return (FALSE);\r | |
3560 | }\r | |
3561 | \r | |
3562 | //\r | |
3563 | // chop leading zeroes\r | |
3564 | //\r | |
3565 | while(String != NULL && *String == L'0'){\r | |
3566 | String++;\r | |
3567 | }\r | |
3568 | //\r | |
3569 | // allow '0x' or '0X', but not 'x' or 'X'\r | |
3570 | //\r | |
3571 | if (String != NULL && (*String == L'x' || *String == L'X')) {\r | |
3572 | if (*(String-1) != L'0') {\r | |
3573 | //\r | |
3574 | // we got an x without a preceeding 0\r | |
3575 | //\r | |
3576 | return (FALSE);\r | |
3577 | }\r | |
3578 | String++;\r | |
3579 | Hex = TRUE;\r | |
3580 | } else if (ForceHex) {\r | |
3581 | Hex = TRUE;\r | |
3582 | } else {\r | |
3583 | Hex = FALSE;\r | |
3584 | }\r | |
3585 | \r | |
3586 | //\r | |
3587 | // loop through the remaining characters and use the lib function\r | |
3588 | //\r | |
3589 | for ( ; String != NULL && *String != CHAR_NULL && !(StopAtSpace && *String == L' ') ; String++){\r | |
3590 | if (Hex) {\r | |
3591 | if (!ShellIsHexaDecimalDigitCharacter(*String)) {\r | |
3592 | return (FALSE);\r | |
3593 | }\r | |
3594 | } else {\r | |
3595 | if (!ShellIsDecimalDigitCharacter(*String)) {\r | |
3596 | return (FALSE);\r | |
3597 | }\r | |
3598 | }\r | |
3599 | }\r | |
252d9457 | 3600 | \r |
a405b86d | 3601 | return (TRUE);\r |
3602 | }\r | |
3603 | \r | |
3604 | /**\r | |
3605 | Function to determine if a given filename exists.\r | |
3606 | \r | |
3607 | @param[in] Name Path to test.\r | |
3608 | \r | |
3609 | @retval EFI_SUCCESS The Path represents a file.\r | |
3610 | @retval EFI_NOT_FOUND The Path does not represent a file.\r | |
3611 | @retval other The path failed to open.\r | |
3612 | **/\r | |
3613 | EFI_STATUS\r | |
3614 | EFIAPI\r | |
3615 | ShellFileExists(\r | |
3616 | IN CONST CHAR16 *Name\r | |
3617 | )\r | |
3618 | {\r | |
3619 | EFI_STATUS Status;\r | |
3620 | EFI_SHELL_FILE_INFO *List;\r | |
3621 | \r | |
3622 | ASSERT(Name != NULL);\r | |
3623 | \r | |
3624 | List = NULL;\r | |
3625 | Status = ShellOpenFileMetaArg((CHAR16*)Name, EFI_FILE_MODE_READ, &List);\r | |
3626 | if (EFI_ERROR(Status)) {\r | |
3627 | return (Status);\r | |
3628 | }\r | |
3629 | \r | |
3630 | ShellCloseFileMetaArg(&List);\r | |
3631 | \r | |
3632 | return (EFI_SUCCESS);\r | |
3633 | }\r | |
252d9457 | 3634 | \r |
3635 | /**\r | |
b0934ac4 | 3636 | Convert a Unicode character to upper case only if\r |
252d9457 | 3637 | it maps to a valid small-case ASCII character.\r |
3638 | \r | |
3639 | This internal function only deal with Unicode character\r | |
3640 | which maps to a valid small-case ASCII character, i.e.\r | |
3641 | L'a' to L'z'. For other Unicode character, the input character\r | |
3642 | is returned directly.\r | |
3643 | \r | |
3644 | @param Char The character to convert.\r | |
3645 | \r | |
3646 | @retval LowerCharacter If the Char is with range L'a' to L'z'.\r | |
3647 | @retval Unchanged Otherwise.\r | |
3648 | \r | |
3649 | **/\r | |
3650 | CHAR16\r | |
3651 | EFIAPI\r | |
3652 | InternalShellCharToUpper (\r | |
3653 | IN CHAR16 Char\r | |
3654 | )\r | |
3655 | {\r | |
3656 | if (Char >= L'a' && Char <= L'z') {\r | |
3657 | return (CHAR16) (Char - (L'a' - L'A'));\r | |
3658 | }\r | |
3659 | \r | |
3660 | return Char;\r | |
3661 | }\r | |
3662 | \r | |
3663 | /**\r | |
3664 | Convert a Unicode character to numerical value.\r | |
3665 | \r | |
3666 | This internal function only deal with Unicode character\r | |
3667 | which maps to a valid hexadecimal ASII character, i.e.\r | |
b0934ac4 | 3668 | L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other\r |
252d9457 | 3669 | Unicode character, the value returned does not make sense.\r |
3670 | \r | |
3671 | @param Char The character to convert.\r | |
3672 | \r | |
3673 | @return The numerical value converted.\r | |
3674 | \r | |
3675 | **/\r | |
3676 | UINTN\r | |
3677 | EFIAPI\r | |
3678 | InternalShellHexCharToUintn (\r | |
3679 | IN CHAR16 Char\r | |
3680 | )\r | |
3681 | {\r | |
3682 | if (ShellIsDecimalDigitCharacter (Char)) {\r | |
3683 | return Char - L'0';\r | |
3684 | }\r | |
3685 | \r | |
3686 | return (UINTN) (10 + InternalShellCharToUpper (Char) - L'A');\r | |
3687 | }\r | |
3688 | \r | |
3689 | /**\r | |
3690 | Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.\r | |
3691 | \r | |
3692 | This function returns a value of type UINTN by interpreting the contents\r | |
3693 | of the Unicode string specified by String as a hexadecimal number.\r | |
3694 | The format of the input Unicode string String is:\r | |
3695 | \r | |
3696 | [spaces][zeros][x][hexadecimal digits].\r | |
3697 | \r | |
3698 | The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].\r | |
3699 | The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.\r | |
3700 | If "x" appears in the input string, it must be prefixed with at least one 0.\r | |
3701 | The function will ignore the pad space, which includes spaces or tab characters,\r | |
3702 | before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or\r | |
3703 | [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the\r | |
3704 | first valid hexadecimal digit. Then, the function stops at the first character that is\r | |
3705 | a not a valid hexadecimal character or NULL, whichever one comes first.\r | |
3706 | \r | |
3707 | If String has only pad spaces, then zero is returned.\r | |
3708 | If String has no leading pad spaces, leading zeros or valid hexadecimal digits,\r | |
3709 | then zero is returned.\r | |
3710 | \r | |
3711 | @param[in] String A pointer to a Null-terminated Unicode string.\r | |
3712 | @param[out] Value Upon a successful return the value of the conversion.\r | |
3713 | @param[in] StopAtSpace FALSE to skip spaces.\r | |
3714 | \r | |
3715 | @retval EFI_SUCCESS The conversion was successful.\r | |
3716 | @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.\r | |
3717 | @retval EFI_DEVICE_ERROR An overflow occured.\r | |
3718 | **/\r | |
3719 | EFI_STATUS\r | |
3720 | EFIAPI\r | |
3721 | InternalShellStrHexToUint64 (\r | |
3722 | IN CONST CHAR16 *String,\r | |
3723 | OUT UINT64 *Value,\r | |
3724 | IN CONST BOOLEAN StopAtSpace\r | |
3725 | )\r | |
3726 | {\r | |
3727 | UINT64 Result;\r | |
3728 | \r | |
3729 | if (String == NULL || StrSize(String) == 0 || Value == NULL) {\r | |
3730 | return (EFI_INVALID_PARAMETER);\r | |
3731 | }\r | |
b0934ac4 | 3732 | \r |
252d9457 | 3733 | //\r |
b0934ac4 | 3734 | // Ignore the pad spaces (space or tab)\r |
252d9457 | 3735 | //\r |
3736 | while ((*String == L' ') || (*String == L'\t')) {\r | |
3737 | String++;\r | |
3738 | }\r | |
3739 | \r | |
3740 | //\r | |
3741 | // Ignore leading Zeros after the spaces\r | |
3742 | //\r | |
3743 | while (*String == L'0') {\r | |
3744 | String++;\r | |
3745 | }\r | |
3746 | \r | |
3747 | if (InternalShellCharToUpper (*String) == L'X') {\r | |
3748 | if (*(String - 1) != L'0') {\r | |
3749 | return 0;\r | |
3750 | }\r | |
3751 | //\r | |
3752 | // Skip the 'X'\r | |
3753 | //\r | |
3754 | String++;\r | |
3755 | }\r | |
3756 | \r | |
3757 | Result = 0;\r | |
b0934ac4 | 3758 | \r |
252d9457 | 3759 | //\r |
12ea4694 | 3760 | // Skip spaces if requested\r |
252d9457 | 3761 | //\r |
12ea4694 ED |
3762 | while (StopAtSpace && *String == L' ') {\r |
3763 | String++;\r | |
252d9457 | 3764 | }\r |
b0934ac4 | 3765 | \r |
252d9457 | 3766 | while (ShellIsHexaDecimalDigitCharacter (*String)) {\r |
3767 | //\r | |
b0934ac4 | 3768 | // If the Hex Number represented by String overflows according\r |
252d9457 | 3769 | // to the range defined by UINTN, then ASSERT().\r |
3770 | //\r | |
3771 | if (!(Result <= (RShiftU64((((UINT64) ~0) - InternalShellHexCharToUintn (*String)), 4)))) {\r | |
3772 | // if (!(Result <= ((((UINT64) ~0) - InternalShellHexCharToUintn (*String)) >> 4))) {\r | |
3773 | return (EFI_DEVICE_ERROR);\r | |
3774 | }\r | |
3775 | \r | |
3776 | Result = (LShiftU64(Result, 4));\r | |
3777 | Result += InternalShellHexCharToUintn (*String);\r | |
3778 | String++;\r | |
3779 | \r | |
3780 | //\r | |
49bd498d | 3781 | // stop at spaces if requested\r |
252d9457 | 3782 | //\r |
49bd498d | 3783 | if (StopAtSpace && *String == L' ') {\r |
3784 | break;\r | |
252d9457 | 3785 | }\r |
3786 | }\r | |
3787 | \r | |
3788 | *Value = Result;\r | |
3789 | return (EFI_SUCCESS);\r | |
3790 | }\r | |
3791 | \r | |
3792 | /**\r | |
3793 | Convert a Null-terminated Unicode decimal string to a value of\r | |
3794 | type UINT64.\r | |
3795 | \r | |
3796 | This function returns a value of type UINT64 by interpreting the contents\r | |
3797 | of the Unicode string specified by String as a decimal number. The format\r | |
3798 | of the input Unicode string String is:\r | |
3799 | \r | |
3800 | [spaces] [decimal digits].\r | |
3801 | \r | |
3802 | The valid decimal digit character is in the range [0-9]. The\r | |
3803 | function will ignore the pad space, which includes spaces or\r | |
3804 | tab characters, before [decimal digits]. The running zero in the\r | |
3805 | beginning of [decimal digits] will be ignored. Then, the function\r | |
3806 | stops at the first character that is a not a valid decimal character\r | |
3807 | or a Null-terminator, whichever one comes first.\r | |
3808 | \r | |
3809 | If String has only pad spaces, then 0 is returned.\r | |
3810 | If String has no pad spaces or valid decimal digits,\r | |
3811 | then 0 is returned.\r | |
3812 | \r | |
3813 | @param[in] String A pointer to a Null-terminated Unicode string.\r | |
3814 | @param[out] Value Upon a successful return the value of the conversion.\r | |
3815 | @param[in] StopAtSpace FALSE to skip spaces.\r | |
3816 | \r | |
3817 | @retval EFI_SUCCESS The conversion was successful.\r | |
3818 | @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.\r | |
3819 | @retval EFI_DEVICE_ERROR An overflow occured.\r | |
3820 | **/\r | |
3821 | EFI_STATUS\r | |
3822 | EFIAPI\r | |
3823 | InternalShellStrDecimalToUint64 (\r | |
3824 | IN CONST CHAR16 *String,\r | |
3825 | OUT UINT64 *Value,\r | |
3826 | IN CONST BOOLEAN StopAtSpace\r | |
3827 | )\r | |
3828 | {\r | |
3829 | UINT64 Result;\r | |
3830 | \r | |
3831 | if (String == NULL || StrSize (String) == 0 || Value == NULL) {\r | |
3832 | return (EFI_INVALID_PARAMETER);\r | |
3833 | }\r | |
3834 | \r | |
3835 | //\r | |
3836 | // Ignore the pad spaces (space or tab)\r | |
3837 | //\r | |
3838 | while ((*String == L' ') || (*String == L'\t')) {\r | |
3839 | String++;\r | |
3840 | }\r | |
3841 | \r | |
3842 | //\r | |
3843 | // Ignore leading Zeros after the spaces\r | |
3844 | //\r | |
3845 | while (*String == L'0') {\r | |
3846 | String++;\r | |
3847 | }\r | |
3848 | \r | |
3849 | Result = 0;\r | |
3850 | \r | |
3851 | //\r | |
3852 | // Skip spaces if requested\r | |
3853 | //\r | |
3854 | while (StopAtSpace && *String == L' ') {\r | |
3855 | String++;\r | |
3856 | }\r | |
3857 | while (ShellIsDecimalDigitCharacter (*String)) {\r | |
3858 | //\r | |
b0934ac4 | 3859 | // If the number represented by String overflows according\r |
252d9457 | 3860 | // to the range defined by UINT64, then ASSERT().\r |
3861 | //\r | |
b0934ac4 | 3862 | \r |
252d9457 | 3863 | if (!(Result <= (DivU64x32((((UINT64) ~0) - (*String - L'0')),10)))) {\r |
3864 | return (EFI_DEVICE_ERROR);\r | |
3865 | }\r | |
3866 | \r | |
3867 | Result = MultU64x32(Result, 10) + (*String - L'0');\r | |
3868 | String++;\r | |
3869 | \r | |
3870 | //\r | |
3871 | // Stop at spaces if requested\r | |
3872 | //\r | |
3873 | if (StopAtSpace && *String == L' ') {\r | |
3874 | break;\r | |
3875 | }\r | |
3876 | }\r | |
3877 | \r | |
3878 | *Value = Result;\r | |
b0934ac4 | 3879 | \r |
252d9457 | 3880 | return (EFI_SUCCESS);\r |
3881 | }\r | |
3882 | \r | |
3883 | /**\r | |
3884 | Function to verify and convert a string to its numerical value.\r | |
3885 | \r | |
3886 | If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.\r | |
3887 | \r | |
3888 | @param[in] String The string to evaluate.\r | |
3889 | @param[out] Value Upon a successful return the value of the conversion.\r | |
3890 | @param[in] ForceHex TRUE - always assume hex.\r | |
3891 | @param[in] StopAtSpace FALSE to skip spaces.\r | |
b0934ac4 | 3892 | \r |
252d9457 | 3893 | @retval EFI_SUCCESS The conversion was successful.\r |
3894 | @retval EFI_INVALID_PARAMETER String contained an invalid character.\r | |
3895 | @retval EFI_NOT_FOUND String was a number, but Value was NULL.\r | |
3896 | **/\r | |
3897 | EFI_STATUS\r | |
3898 | EFIAPI\r | |
3899 | ShellConvertStringToUint64(\r | |
3900 | IN CONST CHAR16 *String,\r | |
3901 | OUT UINT64 *Value,\r | |
3902 | IN CONST BOOLEAN ForceHex,\r | |
3903 | IN CONST BOOLEAN StopAtSpace\r | |
3904 | )\r | |
3905 | {\r | |
3906 | UINT64 RetVal;\r | |
3907 | CONST CHAR16 *Walker;\r | |
3908 | EFI_STATUS Status;\r | |
3909 | BOOLEAN Hex;\r | |
3910 | \r | |
3911 | Hex = ForceHex;\r | |
3912 | \r | |
3913 | if (!InternalShellIsHexOrDecimalNumber(String, Hex, StopAtSpace)) {\r | |
3914 | if (!Hex) {\r | |
3915 | Hex = TRUE;\r | |
3916 | if (!InternalShellIsHexOrDecimalNumber(String, Hex, StopAtSpace)) {\r | |
3917 | return (EFI_INVALID_PARAMETER);\r | |
3918 | }\r | |
3919 | } else {\r | |
3920 | return (EFI_INVALID_PARAMETER);\r | |
3921 | }\r | |
3922 | }\r | |
3923 | \r | |
3924 | //\r | |
3925 | // Chop off leading spaces\r | |
3926 | //\r | |
3927 | for (Walker = String; Walker != NULL && *Walker != CHAR_NULL && *Walker == L' '; Walker++);\r | |
3928 | \r | |
3929 | //\r | |
3930 | // make sure we have something left that is numeric.\r | |
3931 | //\r | |
3932 | if (Walker == NULL || *Walker == CHAR_NULL || !InternalShellIsHexOrDecimalNumber(Walker, Hex, StopAtSpace)) {\r | |
3933 | return (EFI_INVALID_PARAMETER);\r | |
b0934ac4 | 3934 | }\r |
252d9457 | 3935 | \r |
3936 | //\r | |
3937 | // do the conversion.\r | |
3938 | //\r | |
3939 | if (Hex || StrnCmp(Walker, L"0x", 2) == 0 || StrnCmp(Walker, L"0X", 2) == 0){\r | |
3940 | Status = InternalShellStrHexToUint64(Walker, &RetVal, StopAtSpace);\r | |
3941 | } else {\r | |
3942 | Status = InternalShellStrDecimalToUint64(Walker, &RetVal, StopAtSpace);\r | |
3943 | }\r | |
3944 | \r | |
3945 | if (Value == NULL && !EFI_ERROR(Status)) {\r | |
3946 | return (EFI_NOT_FOUND);\r | |
3947 | }\r | |
3948 | \r | |
3949 | if (Value != NULL) {\r | |
3950 | *Value = RetVal;\r | |
3951 | }\r | |
3952 | \r | |
3953 | return (Status);\r | |
3954 | }\r | |
3955 | \r | |
3956 | /**\r | |
3957 | Function to determin if an entire string is a valid number.\r | |
3958 | \r | |
3959 | If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.\r | |
3960 | \r | |
3961 | @param[in] String The string to evaluate.\r | |
3962 | @param[in] ForceHex TRUE - always assume hex.\r | |
3963 | @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.\r | |
3964 | \r | |
3965 | @retval TRUE It is all numeric (dec/hex) characters.\r | |
3966 | @retval FALSE There is a non-numeric character.\r | |
3967 | **/\r | |
3968 | BOOLEAN\r | |
3969 | EFIAPI\r | |
3970 | ShellIsHexOrDecimalNumber (\r | |
3971 | IN CONST CHAR16 *String,\r | |
3972 | IN CONST BOOLEAN ForceHex,\r | |
3973 | IN CONST BOOLEAN StopAtSpace\r | |
3974 | )\r | |
3975 | {\r | |
3976 | if (ShellConvertStringToUint64(String, NULL, ForceHex, StopAtSpace) == EFI_NOT_FOUND) {\r | |
3977 | return (TRUE);\r | |
3978 | }\r | |
3979 | return (FALSE);\r | |
3980 | }\r | |
4d0a4fce | 3981 | \r |
3982 | /**\r | |
3983 | Function to read a single line from a SHELL_FILE_HANDLE. The \n is not included in the returned\r | |
3984 | buffer. The returned buffer must be callee freed.\r | |
3985 | \r | |
3986 | If the position upon start is 0, then the Ascii Boolean will be set. This should be\r | |
3987 | maintained and not changed for all operations with the same file.\r | |
3988 | \r | |
4ff7e37b ED |
3989 | @param[in] Handle SHELL_FILE_HANDLE to read from.\r |
3990 | @param[in, out] Ascii Boolean value for indicating whether the file is\r | |
3991 | Ascii (TRUE) or UCS2 (FALSE).\r | |
4d0a4fce | 3992 | \r |
beab0fc5 | 3993 | @return The line of text from the file.\r |
3994 | @retval NULL There was not enough memory available.\r | |
4d0a4fce | 3995 | \r |
3996 | @sa ShellFileHandleReadLine\r | |
3997 | **/\r | |
3998 | CHAR16*\r | |
3999 | EFIAPI\r | |
4000 | ShellFileHandleReturnLine(\r | |
4001 | IN SHELL_FILE_HANDLE Handle,\r | |
4002 | IN OUT BOOLEAN *Ascii\r | |
4003 | )\r | |
4004 | {\r | |
4005 | CHAR16 *RetVal;\r | |
4006 | UINTN Size;\r | |
4007 | EFI_STATUS Status;\r | |
4008 | \r | |
4009 | Size = 0;\r | |
4010 | RetVal = NULL;\r | |
4011 | \r | |
4012 | Status = ShellFileHandleReadLine(Handle, RetVal, &Size, FALSE, Ascii);\r | |
4013 | if (Status == EFI_BUFFER_TOO_SMALL) {\r | |
4014 | RetVal = AllocateZeroPool(Size);\r | |
beab0fc5 | 4015 | if (RetVal == NULL) {\r |
4016 | return (NULL);\r | |
4017 | }\r | |
4d0a4fce | 4018 | Status = ShellFileHandleReadLine(Handle, RetVal, &Size, FALSE, Ascii);\r |
b0934ac4 | 4019 | \r |
4d0a4fce | 4020 | }\r |
4d0a4fce | 4021 | if (EFI_ERROR(Status) && (RetVal != NULL)) {\r |
4022 | FreePool(RetVal);\r | |
4023 | RetVal = NULL;\r | |
4024 | }\r | |
4025 | return (RetVal);\r | |
4026 | }\r | |
4027 | \r | |
4028 | /**\r | |
4029 | Function to read a single line (up to but not including the \n) from a SHELL_FILE_HANDLE.\r | |
4030 | \r | |
4031 | If the position upon start is 0, then the Ascii Boolean will be set. This should be\r | |
4032 | maintained and not changed for all operations with the same file.\r | |
4033 | \r | |
4ff7e37b ED |
4034 | @param[in] Handle SHELL_FILE_HANDLE to read from.\r |
4035 | @param[in, out] Buffer The pointer to buffer to read into.\r | |
4036 | @param[in, out] Size The pointer to number of bytes in Buffer.\r | |
4037 | @param[in] Truncate If the buffer is large enough, this has no effect.\r | |
4038 | If the buffer is is too small and Truncate is TRUE,\r | |
4039 | the line will be truncated.\r | |
4040 | If the buffer is is too small and Truncate is FALSE,\r | |
4041 | then no read will occur.\r | |
4042 | \r | |
4043 | @param[in, out] Ascii Boolean value for indicating whether the file is\r | |
4044 | Ascii (TRUE) or UCS2 (FALSE).\r | |
4d0a4fce | 4045 | \r |
4046 | @retval EFI_SUCCESS The operation was successful. The line is stored in\r | |
4047 | Buffer.\r | |
4048 | @retval EFI_INVALID_PARAMETER Handle was NULL.\r | |
4049 | @retval EFI_INVALID_PARAMETER Size was NULL.\r | |
4050 | @retval EFI_BUFFER_TOO_SMALL Size was not large enough to store the line.\r | |
4051 | Size was updated to the minimum space required.\r | |
4052 | **/\r | |
4053 | EFI_STATUS\r | |
4054 | EFIAPI\r | |
4055 | ShellFileHandleReadLine(\r | |
4056 | IN SHELL_FILE_HANDLE Handle,\r | |
4057 | IN OUT CHAR16 *Buffer,\r | |
4058 | IN OUT UINTN *Size,\r | |
4059 | IN BOOLEAN Truncate,\r | |
4060 | IN OUT BOOLEAN *Ascii\r | |
4061 | )\r | |
4062 | {\r | |
4063 | EFI_STATUS Status;\r | |
4064 | CHAR16 CharBuffer;\r | |
4065 | UINTN CharSize;\r | |
4066 | UINTN CountSoFar;\r | |
4067 | UINT64 OriginalFilePosition;\r | |
4068 | \r | |
4069 | \r | |
4070 | if (Handle == NULL\r | |
4071 | ||Size == NULL\r | |
4072 | ){\r | |
4073 | return (EFI_INVALID_PARAMETER);\r | |
4074 | }\r | |
4075 | if (Buffer == NULL) {\r | |
4076 | ASSERT(*Size == 0);\r | |
4077 | } else {\r | |
4078 | *Buffer = CHAR_NULL;\r | |
4079 | }\r | |
4080 | gEfiShellProtocol->GetFilePosition(Handle, &OriginalFilePosition);\r | |
4081 | if (OriginalFilePosition == 0) {\r | |
4082 | CharSize = sizeof(CHAR16);\r | |
4083 | Status = gEfiShellProtocol->ReadFile(Handle, &CharSize, &CharBuffer);\r | |
4084 | ASSERT_EFI_ERROR(Status);\r | |
4085 | if (CharBuffer == gUnicodeFileTag) {\r | |
4086 | *Ascii = FALSE;\r | |
4087 | } else {\r | |
4088 | *Ascii = TRUE;\r | |
4089 | gEfiShellProtocol->SetFilePosition(Handle, OriginalFilePosition);\r | |
4090 | }\r | |
4091 | }\r | |
4092 | \r | |
4093 | for (CountSoFar = 0;;CountSoFar++){\r | |
4094 | CharBuffer = 0;\r | |
4095 | if (*Ascii) {\r | |
4096 | CharSize = sizeof(CHAR8);\r | |
4097 | } else {\r | |
4098 | CharSize = sizeof(CHAR16);\r | |
4099 | }\r | |
4100 | Status = gEfiShellProtocol->ReadFile(Handle, &CharSize, &CharBuffer);\r | |
4101 | if ( EFI_ERROR(Status)\r | |
4102 | || CharSize == 0\r | |
4103 | || (CharBuffer == L'\n' && !(*Ascii))\r | |
4104 | || (CharBuffer == '\n' && *Ascii)\r | |
4105 | ){\r | |
4106 | break;\r | |
4107 | }\r | |
4108 | //\r | |
4109 | // if we have space save it...\r | |
4110 | //\r | |
4111 | if ((CountSoFar+1)*sizeof(CHAR16) < *Size){\r | |
4112 | ASSERT(Buffer != NULL);\r | |
4113 | ((CHAR16*)Buffer)[CountSoFar] = CharBuffer;\r | |
4114 | ((CHAR16*)Buffer)[CountSoFar+1] = CHAR_NULL;\r | |
4115 | }\r | |
4116 | }\r | |
4117 | \r | |
4118 | //\r | |
4119 | // if we ran out of space tell when...\r | |
4120 | //\r | |
4121 | if ((CountSoFar+1)*sizeof(CHAR16) > *Size){\r | |
4122 | *Size = (CountSoFar+1)*sizeof(CHAR16);\r | |
4123 | if (!Truncate) {\r | |
4124 | gEfiShellProtocol->SetFilePosition(Handle, OriginalFilePosition);\r | |
4125 | } else {\r | |
4126 | DEBUG((DEBUG_WARN, "The line was truncated in ShellFileHandleReadLine"));\r | |
4127 | }\r | |
4128 | return (EFI_BUFFER_TOO_SMALL);\r | |
4129 | }\r | |
4130 | while(Buffer[StrLen(Buffer)-1] == L'\r') {\r | |
4131 | Buffer[StrLen(Buffer)-1] = CHAR_NULL;\r | |
4132 | }\r | |
4133 | \r | |
4134 | return (Status);\r | |
4135 | }\r | |
fb5278ef | 4136 | \r |
365aa98a | 4137 | /**\r |
4138 | Function to print help file / man page content in the spec from the UEFI Shell protocol GetHelpText function.\r | |
4139 | \r | |
4140 | @param[in] CommandToGetHelpOn Pointer to a string containing the command name of help file to be printed.\r | |
4141 | @param[in] SectionToGetHelpOn Pointer to the section specifier(s).\r | |
4142 | @param[in] PrintCommandText If TRUE, prints the command followed by the help content, otherwise prints \r | |
4143 | the help content only.\r | |
4144 | @retval EFI_DEVICE_ERROR The help data format was incorrect.\r | |
4145 | @retval EFI_NOT_FOUND The help data could not be found.\r | |
4146 | @retval EFI_SUCCESS The operation was successful.\r | |
4147 | **/\r | |
4148 | EFI_STATUS\r | |
4149 | EFIAPI\r | |
4150 | ShellPrintHelp (\r | |
4151 | IN CONST CHAR16 *CommandToGetHelpOn,\r | |
4152 | IN CONST CHAR16 *SectionToGetHelpOn,\r | |
4153 | IN BOOLEAN PrintCommandText\r | |
4154 | )\r | |
4155 | {\r | |
4156 | EFI_STATUS Status;\r | |
4157 | CHAR16 *OutText;\r | |
4158 | \r | |
4159 | OutText = NULL;\r | |
4160 | \r | |
4161 | //\r | |
4162 | // Get the string to print based\r | |
4163 | //\r | |
4164 | Status = gEfiShellProtocol->GetHelpText (CommandToGetHelpOn, SectionToGetHelpOn, &OutText);\r | |
4165 | \r | |
4166 | //\r | |
4167 | // make sure we got a valid string\r | |
4168 | //\r | |
4169 | if (EFI_ERROR(Status)){\r | |
4170 | return Status;\r | |
4171 | } \r | |
4172 | if (OutText == NULL || StrLen(OutText) == 0) {\r | |
4173 | return EFI_NOT_FOUND; \r | |
4174 | }\r | |
4175 | \r | |
4176 | //\r | |
4177 | // Chop off trailing stuff we dont need\r | |
4178 | //\r | |
4179 | while (OutText[StrLen(OutText)-1] == L'\r' || OutText[StrLen(OutText)-1] == L'\n' || OutText[StrLen(OutText)-1] == L' ') {\r | |
4180 | OutText[StrLen(OutText)-1] = CHAR_NULL;\r | |
4181 | }\r | |
4182 | \r | |
4183 | //\r | |
4184 | // Print this out to the console\r | |
4185 | //\r | |
4186 | if (PrintCommandText) {\r | |
4187 | ShellPrintEx(-1, -1, L"%H%-14s%N- %s\r\n", CommandToGetHelpOn, OutText);\r | |
4188 | } else {\r | |
4189 | ShellPrintEx(-1, -1, L"%N%s\r\n", OutText);\r | |
4190 | }\r | |
4191 | \r | |
4192 | SHELL_FREE_NON_NULL(OutText);\r | |
4193 | \r | |
4194 | return EFI_SUCCESS;\r | |
4195 | }\r | |
4196 | \r | |
fb5278ef | 4197 | /**\r |
4198 | Function to delete a file by name\r | |
4199 | \r | |
4200 | @param[in] FileName Pointer to file name to delete.\r | |
4201 | \r | |
4202 | @retval EFI_SUCCESS the file was deleted sucessfully\r | |
4203 | @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not\r | |
4204 | deleted\r | |
4205 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r | |
4206 | @retval EFI_NOT_FOUND The specified file could not be found on the\r | |
4207 | device or the file system could not be found\r | |
4208 | on the device.\r | |
4209 | @retval EFI_NO_MEDIA The device has no medium.\r | |
4210 | @retval EFI_MEDIA_CHANGED The device has a different medium in it or the\r | |
4211 | medium is no longer supported.\r | |
4212 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
4213 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
4214 | @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r | |
4215 | @retval EFI_ACCESS_DENIED The file was opened read only.\r | |
4216 | @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the\r | |
4217 | file.\r | |
4218 | @retval other The file failed to open\r | |
4219 | **/\r | |
4220 | EFI_STATUS\r | |
4221 | EFIAPI\r | |
4222 | ShellDeleteFileByName(\r | |
4223 | IN CONST CHAR16 *FileName\r | |
4224 | )\r | |
4225 | {\r | |
4226 | EFI_STATUS Status;\r | |
4227 | SHELL_FILE_HANDLE FileHandle;\r | |
4228 | \r | |
4229 | Status = ShellFileExists(FileName);\r | |
4230 | \r | |
4231 | if (Status == EFI_SUCCESS){\r | |
4232 | Status = ShellOpenFileByName(FileName, &FileHandle, EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE | EFI_FILE_MODE_CREATE, 0x0);\r | |
4233 | if (Status == EFI_SUCCESS){\r | |
4234 | Status = ShellDeleteFile(&FileHandle);\r | |
4235 | }\r | |
4236 | } \r | |
4237 | \r | |
4238 | return(Status);\r | |
4239 | \r | |
4240 | }\r |