]>
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 | |
98c16be5 JC |
1433 | NewInfo->FullName = AllocateCopyPool(StrSize(OldInfo->FullName), OldInfo->FullName);\r |
1434 | NewInfo->FileName = AllocateCopyPool(StrSize(OldInfo->FileName), OldInfo->FileName);\r | |
1435 | NewInfo->Info = AllocateCopyPool((UINTN)OldInfo->Info->Size, OldInfo->Info);\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 |
98c16be5 JC |
1441 | //\r |
1442 | // Free the partially allocated new node\r | |
1443 | //\r | |
1444 | SHELL_FREE_NON_NULL(NewInfo->FullName);\r | |
1445 | SHELL_FREE_NON_NULL(NewInfo->FileName);\r | |
1446 | SHELL_FREE_NON_NULL(NewInfo->Info);\r | |
1447 | SHELL_FREE_NON_NULL(NewInfo);\r | |
1448 | \r | |
1449 | //\r | |
1450 | // Free the previously converted stuff\r | |
1451 | //\r | |
7a95efda | 1452 | ShellCloseFileMetaArg((EFI_SHELL_FILE_INFO**)(&ListHead));\r |
beab0fc5 | 1453 | ListHead = NULL;\r |
1454 | break;\r | |
1455 | }\r | |
94b17fa1 | 1456 | \r |
94b17fa1 | 1457 | //\r |
1458 | // add that to the list\r | |
1459 | //\r | |
9b3bf083 | 1460 | InsertTailList(ListHead, &NewInfo->Link);\r |
94b17fa1 | 1461 | }\r |
1462 | return (ListHead);\r | |
1463 | }\r | |
1464 | /**\r | |
1465 | Opens a group of files based on a path.\r | |
1466 | \r | |
1e6e84c7 | 1467 | This function uses the Arg to open all the matching files. Each matched\r |
70879314 BJ |
1468 | file has a SHELL_FILE_INFO structure to record the file information. These\r |
1469 | structures are placed on the list ListHead. Users can get the SHELL_FILE_INFO\r | |
94b17fa1 | 1470 | structures from ListHead to access each file. This function supports wildcards\r |
1e6e84c7 | 1471 | and will process '?' and '*' as such. the list must be freed with a call to\r |
94b17fa1 | 1472 | ShellCloseFileMetaArg().\r |
1473 | \r | |
1e6e84c7 | 1474 | If you are NOT appending to an existing list *ListHead must be NULL. If\r |
5f7431d0 | 1475 | *ListHead is NULL then it must be callee freed.\r |
94b17fa1 | 1476 | \r |
1477 | @param Arg pointer to path string\r | |
1478 | @param OpenMode mode to open files with\r | |
1479 | @param ListHead head of linked list of results\r | |
1480 | \r | |
1e6e84c7 | 1481 | @retval EFI_SUCCESS the operation was sucessful and the list head\r |
94b17fa1 | 1482 | contains the list of opened files\r |
94b17fa1 | 1483 | @return != EFI_SUCCESS the operation failed\r |
1484 | \r | |
1485 | @sa InternalShellConvertFileListType\r | |
1486 | **/\r | |
1487 | EFI_STATUS\r | |
1488 | EFIAPI\r | |
1489 | ShellOpenFileMetaArg (\r | |
1490 | IN CHAR16 *Arg,\r | |
1491 | IN UINT64 OpenMode,\r | |
1492 | IN OUT EFI_SHELL_FILE_INFO **ListHead\r | |
1493 | )\r | |
1494 | {\r | |
1495 | EFI_STATUS Status;\r | |
9b3bf083 | 1496 | LIST_ENTRY mOldStyleFileList;\r |
0960ba17 | 1497 | CHAR16 *CleanFilePathStr;\r |
1e6e84c7 | 1498 | \r |
94b17fa1 | 1499 | //\r |
1500 | // ASSERT that Arg and ListHead are not NULL\r | |
1501 | //\r | |
1502 | ASSERT(Arg != NULL);\r | |
1503 | ASSERT(ListHead != NULL);\r | |
1504 | \r | |
0960ba17 QS |
1505 | Status = InternalShellStripQuotes (Arg, &CleanFilePathStr);\r |
1506 | if (EFI_ERROR (Status)) {\r | |
1507 | return Status;\r | |
1508 | }\r | |
1509 | \r | |
1e6e84c7 | 1510 | //\r |
94b17fa1 | 1511 | // Check for UEFI Shell 2.0 protocols\r |
1512 | //\r | |
366f81a0 | 1513 | if (gEfiShellProtocol != NULL) {\r |
5f7431d0 | 1514 | if (*ListHead == NULL) {\r |
1515 | *ListHead = (EFI_SHELL_FILE_INFO*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));\r | |
1516 | if (*ListHead == NULL) {\r | |
0960ba17 | 1517 | FreePool(CleanFilePathStr);\r |
5f7431d0 | 1518 | return (EFI_OUT_OF_RESOURCES);\r |
1519 | }\r | |
1520 | InitializeListHead(&((*ListHead)->Link));\r | |
1e6e84c7 | 1521 | }\r |
0960ba17 | 1522 | Status = gEfiShellProtocol->OpenFileList(CleanFilePathStr,\r |
1e6e84c7 | 1523 | OpenMode,\r |
2247dde4 | 1524 | ListHead);\r |
1525 | if (EFI_ERROR(Status)) {\r | |
366f81a0 | 1526 | gEfiShellProtocol->RemoveDupInFileList(ListHead);\r |
2247dde4 | 1527 | } else {\r |
366f81a0 | 1528 | Status = gEfiShellProtocol->RemoveDupInFileList(ListHead);\r |
2247dde4 | 1529 | }\r |
a405b86d | 1530 | if (*ListHead != NULL && IsListEmpty(&(*ListHead)->Link)) {\r |
1531 | FreePool(*ListHead);\r | |
0960ba17 | 1532 | FreePool(CleanFilePathStr);\r |
a405b86d | 1533 | *ListHead = NULL;\r |
1534 | return (EFI_NOT_FOUND);\r | |
1535 | }\r | |
0960ba17 | 1536 | FreePool(CleanFilePathStr);\r |
2247dde4 | 1537 | return (Status);\r |
1e6e84c7 | 1538 | }\r |
94b17fa1 | 1539 | \r |
1540 | //\r | |
92a5447e | 1541 | // Check for EFI shell\r |
94b17fa1 | 1542 | //\r |
92a5447e | 1543 | if (mEfiShellEnvironment2 != NULL) {\r |
1544 | //\r | |
1545 | // make sure the list head is initialized\r | |
1546 | //\r | |
1547 | InitializeListHead(&mOldStyleFileList);\r | |
94b17fa1 | 1548 | \r |
92a5447e | 1549 | //\r |
1550 | // Get the EFI Shell list of files\r | |
1551 | //\r | |
0960ba17 | 1552 | Status = mEfiShellEnvironment2->FileMetaArg(CleanFilePathStr, &mOldStyleFileList);\r |
92a5447e | 1553 | if (EFI_ERROR(Status)) {\r |
1554 | *ListHead = NULL;\r | |
0960ba17 | 1555 | FreePool(CleanFilePathStr);\r |
92a5447e | 1556 | return (Status);\r |
1557 | }\r | |
94b17fa1 | 1558 | \r |
9b3bf083 | 1559 | if (*ListHead == NULL) {\r |
92a5447e | 1560 | *ListHead = (EFI_SHELL_FILE_INFO *)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));\r |
1561 | if (*ListHead == NULL) {\r | |
0960ba17 | 1562 | FreePool(CleanFilePathStr);\r |
92a5447e | 1563 | return (EFI_OUT_OF_RESOURCES);\r |
1564 | }\r | |
1565 | InitializeListHead(&((*ListHead)->Link));\r | |
9b3bf083 | 1566 | }\r |
9b3bf083 | 1567 | \r |
92a5447e | 1568 | //\r |
1569 | // Convert that to equivalent of UEFI Shell 2.0 structure\r | |
1570 | //\r | |
1571 | InternalShellConvertFileListType(&mOldStyleFileList, &(*ListHead)->Link);\r | |
94b17fa1 | 1572 | \r |
92a5447e | 1573 | //\r |
1574 | // Free the EFI Shell version that was converted.\r | |
1575 | //\r | |
1576 | mEfiShellEnvironment2->FreeFileList(&mOldStyleFileList);\r | |
94b17fa1 | 1577 | \r |
92a5447e | 1578 | if ((*ListHead)->Link.ForwardLink == (*ListHead)->Link.BackLink && (*ListHead)->Link.BackLink == &((*ListHead)->Link)) {\r |
1579 | FreePool(*ListHead);\r | |
1580 | *ListHead = NULL;\r | |
1581 | Status = EFI_NOT_FOUND;\r | |
1582 | }\r | |
0960ba17 | 1583 | FreePool(CleanFilePathStr);\r |
92a5447e | 1584 | return (Status);\r |
a405b86d | 1585 | }\r |
1586 | \r | |
0960ba17 | 1587 | FreePool(CleanFilePathStr);\r |
92a5447e | 1588 | return (EFI_UNSUPPORTED);\r |
94b17fa1 | 1589 | }\r |
1590 | /**\r | |
a405b86d | 1591 | Free the linked list returned from ShellOpenFileMetaArg.\r |
94b17fa1 | 1592 | \r |
a405b86d | 1593 | if ListHead is NULL then ASSERT().\r |
94b17fa1 | 1594 | \r |
a405b86d | 1595 | @param ListHead the pointer to free.\r |
94b17fa1 | 1596 | \r |
a405b86d | 1597 | @retval EFI_SUCCESS the operation was sucessful.\r |
94b17fa1 | 1598 | **/\r |
1599 | EFI_STATUS\r | |
1600 | EFIAPI\r | |
1601 | ShellCloseFileMetaArg (\r | |
1602 | IN OUT EFI_SHELL_FILE_INFO **ListHead\r | |
1603 | )\r | |
1604 | {\r | |
1605 | LIST_ENTRY *Node;\r | |
1606 | \r | |
1607 | //\r | |
1608 | // ASSERT that ListHead is not NULL\r | |
1609 | //\r | |
1610 | ASSERT(ListHead != NULL);\r | |
1611 | \r | |
1e6e84c7 | 1612 | //\r |
94b17fa1 | 1613 | // Check for UEFI Shell 2.0 protocols\r |
1614 | //\r | |
366f81a0 | 1615 | if (gEfiShellProtocol != NULL) {\r |
1616 | return (gEfiShellProtocol->FreeFileList(ListHead));\r | |
92a5447e | 1617 | } else if (mEfiShellEnvironment2 != NULL) {\r |
94b17fa1 | 1618 | //\r |
1e6e84c7 | 1619 | // Since this is EFI Shell version we need to free our internally made copy\r |
94b17fa1 | 1620 | // of the list\r |
1621 | //\r | |
1e6e84c7 | 1622 | for ( Node = GetFirstNode(&(*ListHead)->Link)\r |
a405b86d | 1623 | ; *ListHead != NULL && !IsListEmpty(&(*ListHead)->Link)\r |
9b3bf083 | 1624 | ; Node = GetFirstNode(&(*ListHead)->Link)) {\r |
94b17fa1 | 1625 | RemoveEntryList(Node);\r |
a405b86d | 1626 | ((EFI_FILE_PROTOCOL*)((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->Handle)->Close(((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->Handle);\r |
94b17fa1 | 1627 | FreePool(((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->FullName);\r |
1628 | FreePool(((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->FileName);\r | |
1629 | FreePool(((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->Info);\r | |
1630 | FreePool((EFI_SHELL_FILE_INFO_NO_CONST*)Node);\r | |
1631 | }\r | |
75a5e2ef | 1632 | SHELL_FREE_NON_NULL(*ListHead);\r |
94b17fa1 | 1633 | return EFI_SUCCESS;\r |
1634 | }\r | |
92a5447e | 1635 | \r |
1636 | return (EFI_UNSUPPORTED);\r | |
94b17fa1 | 1637 | }\r |
1638 | \r | |
125c2cf4 | 1639 | /**\r |
1640 | Find a file by searching the CWD and then the path.\r | |
1641 | \r | |
b3011f40 | 1642 | If FileName is NULL then ASSERT.\r |
125c2cf4 | 1643 | \r |
b3011f40 | 1644 | If the return value is not NULL then the memory must be caller freed.\r |
125c2cf4 | 1645 | \r |
1646 | @param FileName Filename string.\r | |
1647 | \r | |
1648 | @retval NULL the file was not found\r | |
1649 | @return !NULL the full path to the file.\r | |
1650 | **/\r | |
1651 | CHAR16 *\r | |
1652 | EFIAPI\r | |
1653 | ShellFindFilePath (\r | |
1654 | IN CONST CHAR16 *FileName\r | |
1655 | )\r | |
1656 | {\r | |
1657 | CONST CHAR16 *Path;\r | |
a405b86d | 1658 | SHELL_FILE_HANDLE Handle;\r |
125c2cf4 | 1659 | EFI_STATUS Status;\r |
1660 | CHAR16 *RetVal;\r | |
1661 | CHAR16 *TestPath;\r | |
1662 | CONST CHAR16 *Walker;\r | |
36a9d672 | 1663 | UINTN Size;\r |
1cd45e78 | 1664 | CHAR16 *TempChar;\r |
125c2cf4 | 1665 | \r |
1666 | RetVal = NULL;\r | |
1667 | \r | |
a405b86d | 1668 | //\r |
1669 | // First make sure its not an absolute path.\r | |
1670 | //\r | |
1671 | Status = ShellOpenFileByName(FileName, &Handle, EFI_FILE_MODE_READ, 0);\r | |
1672 | if (!EFI_ERROR(Status)){\r | |
1673 | if (FileHandleIsDirectory(Handle) != EFI_SUCCESS) {\r | |
1674 | ASSERT(RetVal == NULL);\r | |
1675 | RetVal = StrnCatGrow(&RetVal, NULL, FileName, 0);\r | |
1676 | ShellCloseFile(&Handle);\r | |
1677 | return (RetVal);\r | |
1678 | } else {\r | |
1679 | ShellCloseFile(&Handle);\r | |
1680 | }\r | |
1681 | }\r | |
1682 | \r | |
125c2cf4 | 1683 | Path = ShellGetEnvironmentVariable(L"cwd");\r |
1684 | if (Path != NULL) {\r | |
36a9d672 | 1685 | Size = StrSize(Path);\r |
1686 | Size += StrSize(FileName);\r | |
1687 | TestPath = AllocateZeroPool(Size);\r | |
c9d92df0 | 1688 | if (TestPath == NULL) {\r |
1689 | return (NULL);\r | |
1690 | }\r | |
98c16be5 JC |
1691 | StrnCpy(TestPath, Path, Size/sizeof(CHAR16) - 1);\r |
1692 | StrnCat(TestPath, FileName, Size/sizeof(CHAR16) - 1 - StrLen(TestPath));\r | |
125c2cf4 | 1693 | Status = ShellOpenFileByName(TestPath, &Handle, EFI_FILE_MODE_READ, 0);\r |
1694 | if (!EFI_ERROR(Status)){\r | |
a405b86d | 1695 | if (FileHandleIsDirectory(Handle) != EFI_SUCCESS) {\r |
1696 | ASSERT(RetVal == NULL);\r | |
1697 | RetVal = StrnCatGrow(&RetVal, NULL, TestPath, 0);\r | |
1698 | ShellCloseFile(&Handle);\r | |
1699 | FreePool(TestPath);\r | |
1700 | return (RetVal);\r | |
1701 | } else {\r | |
1702 | ShellCloseFile(&Handle);\r | |
1703 | }\r | |
125c2cf4 | 1704 | }\r |
1705 | FreePool(TestPath);\r | |
1706 | }\r | |
1707 | Path = ShellGetEnvironmentVariable(L"path");\r | |
1708 | if (Path != NULL) {\r | |
a405b86d | 1709 | Size = StrSize(Path)+sizeof(CHAR16);\r |
36a9d672 | 1710 | Size += StrSize(FileName);\r |
1711 | TestPath = AllocateZeroPool(Size);\r | |
3e082d58 | 1712 | if (TestPath == NULL) {\r |
1713 | return (NULL);\r | |
1714 | }\r | |
1e6e84c7 | 1715 | Walker = (CHAR16*)Path;\r |
125c2cf4 | 1716 | do {\r |
1717 | CopyMem(TestPath, Walker, StrSize(Walker));\r | |
3e082d58 | 1718 | if (TestPath != NULL) {\r |
1719 | TempChar = StrStr(TestPath, L";");\r | |
1720 | if (TempChar != NULL) {\r | |
1721 | *TempChar = CHAR_NULL;\r | |
1722 | }\r | |
1723 | if (TestPath[StrLen(TestPath)-1] != L'\\') {\r | |
98c16be5 | 1724 | StrnCat(TestPath, L"\\", Size/sizeof(CHAR16) - 1 - StrLen(TestPath));\r |
3e082d58 | 1725 | }\r |
89e8537a | 1726 | if (FileName[0] == L'\\') {\r |
1727 | FileName++;\r | |
1728 | }\r | |
98c16be5 | 1729 | StrnCat(TestPath, FileName, Size/sizeof(CHAR16) - 1 - StrLen(TestPath));\r |
3e082d58 | 1730 | if (StrStr(Walker, L";") != NULL) {\r |
1731 | Walker = StrStr(Walker, L";") + 1;\r | |
a405b86d | 1732 | } else {\r |
3e082d58 | 1733 | Walker = NULL;\r |
1734 | }\r | |
1735 | Status = ShellOpenFileByName(TestPath, &Handle, EFI_FILE_MODE_READ, 0);\r | |
1736 | if (!EFI_ERROR(Status)){\r | |
1737 | if (FileHandleIsDirectory(Handle) != EFI_SUCCESS) {\r | |
1738 | ASSERT(RetVal == NULL);\r | |
1739 | RetVal = StrnCatGrow(&RetVal, NULL, TestPath, 0);\r | |
1740 | ShellCloseFile(&Handle);\r | |
1741 | break;\r | |
1742 | } else {\r | |
1743 | ShellCloseFile(&Handle);\r | |
1744 | }\r | |
a405b86d | 1745 | }\r |
125c2cf4 | 1746 | }\r |
1747 | } while (Walker != NULL && Walker[0] != CHAR_NULL);\r | |
1748 | FreePool(TestPath);\r | |
1749 | }\r | |
1750 | return (RetVal);\r | |
1751 | }\r | |
1752 | \r | |
b3011f40 | 1753 | /**\r |
1e6e84c7 | 1754 | Find a file by searching the CWD and then the path with a variable set of file\r |
1755 | extensions. If the file is not found it will append each extension in the list\r | |
b3011f40 | 1756 | in the order provided and return the first one that is successful.\r |
1757 | \r | |
1758 | If FileName is NULL, then ASSERT.\r | |
1759 | If FileExtension is NULL, then behavior is identical to ShellFindFilePath.\r | |
1760 | \r | |
1761 | If the return value is not NULL then the memory must be caller freed.\r | |
1762 | \r | |
1763 | @param[in] FileName Filename string.\r | |
1764 | @param[in] FileExtension Semi-colon delimeted list of possible extensions.\r | |
1765 | \r | |
1766 | @retval NULL The file was not found.\r | |
1767 | @retval !NULL The path to the file.\r | |
1768 | **/\r | |
1769 | CHAR16 *\r | |
1770 | EFIAPI\r | |
1771 | ShellFindFilePathEx (\r | |
1772 | IN CONST CHAR16 *FileName,\r | |
1773 | IN CONST CHAR16 *FileExtension\r | |
1774 | )\r | |
1775 | {\r | |
1776 | CHAR16 *TestPath;\r | |
1777 | CHAR16 *RetVal;\r | |
1778 | CONST CHAR16 *ExtensionWalker;\r | |
9e926b69 | 1779 | UINTN Size;\r |
1cd45e78 | 1780 | CHAR16 *TempChar;\r |
c9d92df0 | 1781 | CHAR16 *TempChar2;\r |
1cd45e78 | 1782 | \r |
b3011f40 | 1783 | ASSERT(FileName != NULL);\r |
1784 | if (FileExtension == NULL) {\r | |
1785 | return (ShellFindFilePath(FileName));\r | |
1786 | }\r | |
1787 | RetVal = ShellFindFilePath(FileName);\r | |
1788 | if (RetVal != NULL) {\r | |
1789 | return (RetVal);\r | |
1790 | }\r | |
9e926b69 | 1791 | Size = StrSize(FileName);\r |
1792 | Size += StrSize(FileExtension);\r | |
1793 | TestPath = AllocateZeroPool(Size);\r | |
c9d92df0 | 1794 | if (TestPath == NULL) {\r |
1795 | return (NULL);\r | |
1796 | }\r | |
a405b86d | 1797 | for (ExtensionWalker = FileExtension, TempChar2 = (CHAR16*)FileExtension; TempChar2 != NULL ; ExtensionWalker = TempChar2 + 1){\r |
98c16be5 | 1798 | StrnCpy(TestPath, FileName, Size/sizeof(CHAR16) - 1);\r |
a405b86d | 1799 | if (ExtensionWalker != NULL) {\r |
98c16be5 | 1800 | StrnCat(TestPath, ExtensionWalker, Size/sizeof(CHAR16) - 1 - StrLen(TestPath));\r |
a405b86d | 1801 | }\r |
1cd45e78 | 1802 | TempChar = StrStr(TestPath, L";");\r |
1803 | if (TempChar != NULL) {\r | |
1804 | *TempChar = CHAR_NULL;\r | |
b3011f40 | 1805 | }\r |
1806 | RetVal = ShellFindFilePath(TestPath);\r | |
1807 | if (RetVal != NULL) {\r | |
1808 | break;\r | |
1809 | }\r | |
a405b86d | 1810 | ASSERT(ExtensionWalker != NULL);\r |
c9d92df0 | 1811 | TempChar2 = StrStr(ExtensionWalker, L";");\r |
b3011f40 | 1812 | }\r |
1813 | FreePool(TestPath);\r | |
1814 | return (RetVal);\r | |
1815 | }\r | |
1816 | \r | |
94b17fa1 | 1817 | typedef struct {\r |
9b3bf083 | 1818 | LIST_ENTRY Link;\r |
94b17fa1 | 1819 | CHAR16 *Name;\r |
a405b86d | 1820 | SHELL_PARAM_TYPE Type;\r |
94b17fa1 | 1821 | CHAR16 *Value;\r |
1822 | UINTN OriginalPosition;\r | |
1823 | } SHELL_PARAM_PACKAGE;\r | |
1824 | \r | |
1825 | /**\r | |
1e6e84c7 | 1826 | Checks the list of valid arguments and returns TRUE if the item was found. If the\r |
94b17fa1 | 1827 | return value is TRUE then the type parameter is set also.\r |
1e6e84c7 | 1828 | \r |
94b17fa1 | 1829 | if CheckList is NULL then ASSERT();\r |
1830 | if Name is NULL then ASSERT();\r | |
1831 | if Type is NULL then ASSERT();\r | |
1832 | \r | |
94b17fa1 | 1833 | @param Name pointer to Name of parameter found\r |
1834 | @param CheckList List to check against\r | |
a405b86d | 1835 | @param Type pointer to type of parameter if it was found\r |
94b17fa1 | 1836 | \r |
1837 | @retval TRUE the Parameter was found. Type is valid.\r | |
1838 | @retval FALSE the Parameter was not found. Type is not valid.\r | |
1839 | **/\r | |
1840 | BOOLEAN\r | |
1841 | EFIAPI\r | |
d2b4564b | 1842 | InternalIsOnCheckList (\r |
94b17fa1 | 1843 | IN CONST CHAR16 *Name,\r |
1844 | IN CONST SHELL_PARAM_ITEM *CheckList,\r | |
252d9457 | 1845 | OUT SHELL_PARAM_TYPE *Type\r |
a405b86d | 1846 | )\r |
1847 | {\r | |
94b17fa1 | 1848 | SHELL_PARAM_ITEM *TempListItem;\r |
252d9457 | 1849 | CHAR16 *TempString;\r |
94b17fa1 | 1850 | \r |
1851 | //\r | |
1852 | // ASSERT that all 3 pointer parameters aren't NULL\r | |
1853 | //\r | |
1854 | ASSERT(CheckList != NULL);\r | |
1855 | ASSERT(Type != NULL);\r | |
1856 | ASSERT(Name != NULL);\r | |
1857 | \r | |
d2b4564b | 1858 | //\r |
1859 | // question mark and page break mode are always supported\r | |
1860 | //\r | |
1861 | if ((StrCmp(Name, L"-?") == 0) ||\r | |
1862 | (StrCmp(Name, L"-b") == 0)\r | |
a405b86d | 1863 | ) {\r |
252d9457 | 1864 | *Type = TypeFlag;\r |
d2b4564b | 1865 | return (TRUE);\r |
1866 | }\r | |
1867 | \r | |
94b17fa1 | 1868 | //\r |
1869 | // Enumerate through the list\r | |
1870 | //\r | |
1871 | for (TempListItem = (SHELL_PARAM_ITEM*)CheckList ; TempListItem->Name != NULL ; TempListItem++) {\r | |
1872 | //\r | |
9eb53ac3 | 1873 | // If the Type is TypeStart only check the first characters of the passed in param\r |
1874 | // If it matches set the type and return TRUE\r | |
94b17fa1 | 1875 | //\r |
b0934ac4 | 1876 | if (TempListItem->Type == TypeStart) {\r |
252d9457 | 1877 | if (StrnCmp(Name, TempListItem->Name, StrLen(TempListItem->Name)) == 0) {\r |
1878 | *Type = TempListItem->Type;\r | |
1879 | return (TRUE);\r | |
1880 | }\r | |
1881 | TempString = NULL;\r | |
1882 | TempString = StrnCatGrow(&TempString, NULL, Name, StrLen(TempListItem->Name));\r | |
1883 | if (TempString != NULL) {\r | |
1884 | if (StringNoCaseCompare(&TempString, &TempListItem->Name) == 0) {\r | |
1885 | *Type = TempListItem->Type;\r | |
1886 | FreePool(TempString);\r | |
1887 | return (TRUE);\r | |
1888 | }\r | |
1889 | FreePool(TempString);\r | |
1890 | }\r | |
1891 | } else if (StringNoCaseCompare(&Name, &TempListItem->Name) == 0) {\r | |
94b17fa1 | 1892 | *Type = TempListItem->Type;\r |
1893 | return (TRUE);\r | |
1894 | }\r | |
1895 | }\r | |
2247dde4 | 1896 | \r |
94b17fa1 | 1897 | return (FALSE);\r |
1898 | }\r | |
1899 | /**\r | |
d2b4564b | 1900 | Checks the string for indicators of "flag" status. this is a leading '/', '-', or '+'\r |
94b17fa1 | 1901 | \r |
a405b86d | 1902 | @param[in] Name pointer to Name of parameter found\r |
1903 | @param[in] AlwaysAllowNumbers TRUE to allow numbers, FALSE to not.\r | |
94b17fa1 | 1904 | \r |
1905 | @retval TRUE the Parameter is a flag.\r | |
a405b86d | 1906 | @retval FALSE the Parameter not a flag.\r |
94b17fa1 | 1907 | **/\r |
1908 | BOOLEAN\r | |
1909 | EFIAPI\r | |
d2b4564b | 1910 | InternalIsFlag (\r |
2247dde4 | 1911 | IN CONST CHAR16 *Name,\r |
1912 | IN BOOLEAN AlwaysAllowNumbers\r | |
94b17fa1 | 1913 | )\r |
1914 | {\r | |
1915 | //\r | |
1916 | // ASSERT that Name isn't NULL\r | |
1917 | //\r | |
1918 | ASSERT(Name != NULL);\r | |
1919 | \r | |
2247dde4 | 1920 | //\r |
1921 | // If we accept numbers then dont return TRUE. (they will be values)\r | |
1922 | //\r | |
8af89dae | 1923 | if (((Name[0] == L'-' || Name[0] == L'+') && InternalShellIsHexOrDecimalNumber(Name+1, FALSE, FALSE)) && AlwaysAllowNumbers) {\r |
2247dde4 | 1924 | return (FALSE);\r |
1925 | }\r | |
1926 | \r | |
94b17fa1 | 1927 | //\r |
a405b86d | 1928 | // If the Name has a /, +, or - as the first character return TRUE\r |
94b17fa1 | 1929 | //\r |
1e6e84c7 | 1930 | if ((Name[0] == L'/') ||\r |
d2b4564b | 1931 | (Name[0] == L'-') ||\r |
1932 | (Name[0] == L'+')\r | |
a405b86d | 1933 | ) {\r |
94b17fa1 | 1934 | return (TRUE);\r |
1935 | }\r | |
1936 | return (FALSE);\r | |
1937 | }\r | |
1938 | \r | |
1939 | /**\r | |
1e6e84c7 | 1940 | Checks the command line arguments passed against the list of valid ones.\r |
94b17fa1 | 1941 | \r |
1942 | If no initialization is required, then return RETURN_SUCCESS.\r | |
1e6e84c7 | 1943 | \r |
a405b86d | 1944 | @param[in] CheckList pointer to list of parameters to check\r |
1945 | @param[out] CheckPackage pointer to pointer to list checked values\r | |
1946 | @param[out] ProblemParam optional pointer to pointer to unicode string for\r | |
d2b4564b | 1947 | the paramater that caused failure. If used then the\r |
1948 | caller is responsible for freeing the memory.\r | |
a405b86d | 1949 | @param[in] AutoPageBreak will automatically set PageBreakEnabled for "b" parameter\r |
1950 | @param[in] Argv pointer to array of parameters\r | |
1951 | @param[in] Argc Count of parameters in Argv\r | |
1952 | @param[in] AlwaysAllowNumbers TRUE to allow numbers always, FALSE otherwise.\r | |
94b17fa1 | 1953 | \r |
1954 | @retval EFI_SUCCESS The operation completed sucessfully.\r | |
1955 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed\r | |
1956 | @retval EFI_INVALID_PARAMETER A parameter was invalid\r | |
1e6e84c7 | 1957 | @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was\r |
1958 | duplicated. the duplicated command line argument\r | |
94b17fa1 | 1959 | was returned in ProblemParam if provided.\r |
1e6e84c7 | 1960 | @retval EFI_NOT_FOUND a argument required a value that was missing.\r |
94b17fa1 | 1961 | the invalid command line argument was returned in\r |
1962 | ProblemParam if provided.\r | |
1963 | **/\r | |
1964 | EFI_STATUS\r | |
1965 | EFIAPI\r | |
1966 | InternalCommandLineParse (\r | |
1967 | IN CONST SHELL_PARAM_ITEM *CheckList,\r | |
1968 | OUT LIST_ENTRY **CheckPackage,\r | |
1969 | OUT CHAR16 **ProblemParam OPTIONAL,\r | |
1970 | IN BOOLEAN AutoPageBreak,\r | |
1971 | IN CONST CHAR16 **Argv,\r | |
2247dde4 | 1972 | IN UINTN Argc,\r |
1973 | IN BOOLEAN AlwaysAllowNumbers\r | |
a405b86d | 1974 | )\r |
1975 | {\r | |
94b17fa1 | 1976 | UINTN LoopCounter;\r |
252d9457 | 1977 | SHELL_PARAM_TYPE CurrentItemType;\r |
94b17fa1 | 1978 | SHELL_PARAM_PACKAGE *CurrentItemPackage;\r |
125c2cf4 | 1979 | UINTN GetItemValue;\r |
1980 | UINTN ValueSize;\r | |
a405b86d | 1981 | UINTN Count;\r |
252d9457 | 1982 | CONST CHAR16 *TempPointer;\r |
98c16be5 | 1983 | UINTN CurrentValueSize;\r |
94b17fa1 | 1984 | \r |
1985 | CurrentItemPackage = NULL;\r | |
125c2cf4 | 1986 | GetItemValue = 0;\r |
1987 | ValueSize = 0;\r | |
a405b86d | 1988 | Count = 0;\r |
94b17fa1 | 1989 | \r |
1990 | //\r | |
1991 | // If there is only 1 item we dont need to do anything\r | |
1992 | //\r | |
a405b86d | 1993 | if (Argc < 1) {\r |
94b17fa1 | 1994 | *CheckPackage = NULL;\r |
1995 | return (EFI_SUCCESS);\r | |
1996 | }\r | |
1997 | \r | |
2247dde4 | 1998 | //\r |
1999 | // ASSERTs\r | |
2000 | //\r | |
2001 | ASSERT(CheckList != NULL);\r | |
2002 | ASSERT(Argv != NULL);\r | |
2003 | \r | |
94b17fa1 | 2004 | //\r |
2005 | // initialize the linked list\r | |
2006 | //\r | |
2007 | *CheckPackage = (LIST_ENTRY*)AllocateZeroPool(sizeof(LIST_ENTRY));\r | |
02a758cb | 2008 | if (*CheckPackage == NULL) {\r |
beab0fc5 | 2009 | return (EFI_OUT_OF_RESOURCES);\r |
02a758cb | 2010 | }\r |
beab0fc5 | 2011 | \r |
94b17fa1 | 2012 | InitializeListHead(*CheckPackage);\r |
2013 | \r | |
2014 | //\r | |
2015 | // loop through each of the arguments\r | |
2016 | //\r | |
2017 | for (LoopCounter = 0 ; LoopCounter < Argc ; ++LoopCounter) {\r | |
2018 | if (Argv[LoopCounter] == NULL) {\r | |
2019 | //\r | |
2020 | // do nothing for NULL argv\r | |
2021 | //\r | |
a405b86d | 2022 | } else if (InternalIsOnCheckList(Argv[LoopCounter], CheckList, &CurrentItemType)) {\r |
2247dde4 | 2023 | //\r |
2024 | // We might have leftover if last parameter didnt have optional value\r | |
2025 | //\r | |
125c2cf4 | 2026 | if (GetItemValue != 0) {\r |
2027 | GetItemValue = 0;\r | |
2247dde4 | 2028 | InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r |
2029 | }\r | |
94b17fa1 | 2030 | //\r |
2031 | // this is a flag\r | |
2032 | //\r | |
252d9457 | 2033 | CurrentItemPackage = AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE));\r |
beab0fc5 | 2034 | if (CurrentItemPackage == NULL) {\r |
2035 | ShellCommandLineFreeVarList(*CheckPackage);\r | |
2036 | *CheckPackage = NULL;\r | |
2037 | return (EFI_OUT_OF_RESOURCES);\r | |
2038 | }\r | |
98c16be5 | 2039 | CurrentItemPackage->Name = AllocateCopyPool(StrSize(Argv[LoopCounter]), Argv[LoopCounter]);\r |
beab0fc5 | 2040 | if (CurrentItemPackage->Name == NULL) {\r |
2041 | ShellCommandLineFreeVarList(*CheckPackage);\r | |
2042 | *CheckPackage = NULL;\r | |
2043 | return (EFI_OUT_OF_RESOURCES);\r | |
2044 | }\r | |
94b17fa1 | 2045 | CurrentItemPackage->Type = CurrentItemType;\r |
2046 | CurrentItemPackage->OriginalPosition = (UINTN)(-1);\r | |
b1f95a06 | 2047 | CurrentItemPackage->Value = NULL;\r |
94b17fa1 | 2048 | \r |
2049 | //\r | |
2050 | // Does this flag require a value\r | |
2051 | //\r | |
125c2cf4 | 2052 | switch (CurrentItemPackage->Type) {\r |
94b17fa1 | 2053 | //\r |
125c2cf4 | 2054 | // possibly trigger the next loop(s) to populate the value of this item\r |
1e6e84c7 | 2055 | //\r |
125c2cf4 | 2056 | case TypeValue:\r |
1e6e84c7 | 2057 | GetItemValue = 1;\r |
125c2cf4 | 2058 | ValueSize = 0;\r |
2059 | break;\r | |
2060 | case TypeDoubleValue:\r | |
2061 | GetItemValue = 2;\r | |
2062 | ValueSize = 0;\r | |
2063 | break;\r | |
2064 | case TypeMaxValue:\r | |
2065 | GetItemValue = (UINTN)(-1);\r | |
2066 | ValueSize = 0;\r | |
2067 | break;\r | |
2068 | default:\r | |
2069 | //\r | |
2070 | // this item has no value expected; we are done\r | |
2071 | //\r | |
2072 | InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r | |
2073 | ASSERT(GetItemValue == 0);\r | |
2074 | break;\r | |
94b17fa1 | 2075 | }\r |
a405b86d | 2076 | } else if (GetItemValue != 0 && !InternalIsFlag(Argv[LoopCounter], AlwaysAllowNumbers)) {\r |
b1f95a06 | 2077 | ASSERT(CurrentItemPackage != NULL);\r |
2078 | //\r | |
125c2cf4 | 2079 | // get the item VALUE for a previous flag\r |
b1f95a06 | 2080 | //\r |
49bd498d | 2081 | if (StrStr(Argv[LoopCounter], L" ") == NULL) {\r |
98c16be5 JC |
2082 | CurrentValueSize = ValueSize + StrSize(Argv[LoopCounter]) + sizeof(CHAR16);\r |
2083 | CurrentItemPackage->Value = ReallocatePool(ValueSize, CurrentValueSize, CurrentItemPackage->Value);\r | |
49bd498d | 2084 | ASSERT(CurrentItemPackage->Value != NULL);\r |
2085 | if (ValueSize == 0) {\r | |
98c16be5 | 2086 | StrnCpy(CurrentItemPackage->Value, Argv[LoopCounter], CurrentValueSize/sizeof(CHAR16) - 1);\r |
49bd498d | 2087 | } else {\r |
98c16be5 JC |
2088 | StrnCat(CurrentItemPackage->Value, L" ", CurrentValueSize/sizeof(CHAR16) - 1 - StrLen(CurrentItemPackage->Value));\r |
2089 | StrnCat(CurrentItemPackage->Value, Argv[LoopCounter], CurrentValueSize/sizeof(CHAR16) - 1 - StrLen(CurrentItemPackage->Value));\r | |
49bd498d | 2090 | }\r |
2091 | ValueSize += StrSize(Argv[LoopCounter]) + sizeof(CHAR16);\r | |
125c2cf4 | 2092 | } else {\r |
49bd498d | 2093 | //\r |
2094 | // the parameter has spaces. must be quoted.\r | |
2095 | //\r | |
98c16be5 JC |
2096 | CurrentValueSize = ValueSize + StrSize(Argv[LoopCounter]) + sizeof(CHAR16) + sizeof(CHAR16) + sizeof(CHAR16);\r |
2097 | CurrentItemPackage->Value = ReallocatePool(ValueSize, CurrentValueSize, CurrentItemPackage->Value);\r | |
49bd498d | 2098 | ASSERT(CurrentItemPackage->Value != NULL);\r |
2099 | if (ValueSize == 0) {\r | |
98c16be5 JC |
2100 | StrnCpy(CurrentItemPackage->Value, L"\"", CurrentValueSize/sizeof(CHAR16) - 1);\r |
2101 | StrnCat(CurrentItemPackage->Value, Argv[LoopCounter], CurrentValueSize/sizeof(CHAR16) - 1 - StrLen(CurrentItemPackage->Value));\r | |
2102 | StrnCat(CurrentItemPackage->Value, L"\"", CurrentValueSize/sizeof(CHAR16) - 1 - StrLen(CurrentItemPackage->Value));\r | |
49bd498d | 2103 | } else {\r |
98c16be5 JC |
2104 | StrnCat(CurrentItemPackage->Value, L" ", CurrentValueSize/sizeof(CHAR16) - 1 - StrLen(CurrentItemPackage->Value));\r |
2105 | StrnCat(CurrentItemPackage->Value, L"\"", CurrentValueSize/sizeof(CHAR16) - 1 - StrLen(CurrentItemPackage->Value));\r | |
2106 | StrnCat(CurrentItemPackage->Value, Argv[LoopCounter], CurrentValueSize/sizeof(CHAR16) - 1 - StrLen(CurrentItemPackage->Value));\r | |
2107 | StrnCat(CurrentItemPackage->Value, L"\"", CurrentValueSize/sizeof(CHAR16) - 1 - StrLen(CurrentItemPackage->Value));\r | |
49bd498d | 2108 | }\r |
2109 | ValueSize += StrSize(Argv[LoopCounter]) + sizeof(CHAR16);\r | |
125c2cf4 | 2110 | }\r |
125c2cf4 | 2111 | GetItemValue--;\r |
2112 | if (GetItemValue == 0) {\r | |
2113 | InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r | |
2114 | }\r | |
a405b86d | 2115 | } else if (!InternalIsFlag(Argv[LoopCounter], AlwaysAllowNumbers) ){ //|| ProblemParam == NULL) {\r |
b1f95a06 | 2116 | //\r |
2117 | // add this one as a non-flag\r | |
2118 | //\r | |
252d9457 | 2119 | \r |
2120 | TempPointer = Argv[LoopCounter];\r | |
b0934ac4 | 2121 | if ((*TempPointer == L'^' && *(TempPointer+1) == L'-')\r |
252d9457 | 2122 | || (*TempPointer == L'^' && *(TempPointer+1) == L'/')\r |
2123 | || (*TempPointer == L'^' && *(TempPointer+1) == L'+')\r | |
2124 | ){\r | |
2125 | TempPointer++;\r | |
2126 | }\r | |
2127 | CurrentItemPackage = AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE));\r | |
beab0fc5 | 2128 | if (CurrentItemPackage == NULL) {\r |
2129 | ShellCommandLineFreeVarList(*CheckPackage);\r | |
2130 | *CheckPackage = NULL;\r | |
2131 | return (EFI_OUT_OF_RESOURCES);\r | |
2132 | }\r | |
b1f95a06 | 2133 | CurrentItemPackage->Name = NULL;\r |
2134 | CurrentItemPackage->Type = TypePosition;\r | |
98c16be5 | 2135 | CurrentItemPackage->Value = AllocateCopyPool(StrSize(TempPointer), TempPointer);\r |
beab0fc5 | 2136 | if (CurrentItemPackage->Value == NULL) {\r |
2137 | ShellCommandLineFreeVarList(*CheckPackage);\r | |
2138 | *CheckPackage = NULL;\r | |
2139 | return (EFI_OUT_OF_RESOURCES);\r | |
2140 | }\r | |
a405b86d | 2141 | CurrentItemPackage->OriginalPosition = Count++;\r |
9b3bf083 | 2142 | InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r |
252d9457 | 2143 | } else {\r |
94b17fa1 | 2144 | //\r |
2145 | // this was a non-recognised flag... error!\r | |
2146 | //\r | |
252d9457 | 2147 | if (ProblemParam != NULL) {\r |
98c16be5 | 2148 | *ProblemParam = AllocateCopyPool(StrSize(Argv[LoopCounter]), Argv[LoopCounter]);\r |
252d9457 | 2149 | }\r |
94b17fa1 | 2150 | ShellCommandLineFreeVarList(*CheckPackage);\r |
2151 | *CheckPackage = NULL;\r | |
2152 | return (EFI_VOLUME_CORRUPTED);\r | |
94b17fa1 | 2153 | }\r |
2154 | }\r | |
125c2cf4 | 2155 | if (GetItemValue != 0) {\r |
2156 | GetItemValue = 0;\r | |
2157 | InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r | |
2158 | }\r | |
94b17fa1 | 2159 | //\r |
2160 | // support for AutoPageBreak\r | |
2161 | //\r | |
2162 | if (AutoPageBreak && ShellCommandLineGetFlag(*CheckPackage, L"-b")) {\r | |
2163 | ShellSetPageBreakMode(TRUE);\r | |
2164 | }\r | |
2165 | return (EFI_SUCCESS);\r | |
2166 | }\r | |
2167 | \r | |
2168 | /**\r | |
1e6e84c7 | 2169 | Checks the command line arguments passed against the list of valid ones.\r |
94b17fa1 | 2170 | Optionally removes NULL values first.\r |
1e6e84c7 | 2171 | \r |
94b17fa1 | 2172 | If no initialization is required, then return RETURN_SUCCESS.\r |
1e6e84c7 | 2173 | \r |
a405b86d | 2174 | @param[in] CheckList The pointer to list of parameters to check.\r |
2175 | @param[out] CheckPackage The package of checked values.\r | |
2176 | @param[out] ProblemParam Optional pointer to pointer to unicode string for\r | |
94b17fa1 | 2177 | the paramater that caused failure.\r |
a405b86d | 2178 | @param[in] AutoPageBreak Will automatically set PageBreakEnabled.\r |
2179 | @param[in] AlwaysAllowNumbers Will never fail for number based flags.\r | |
94b17fa1 | 2180 | \r |
2181 | @retval EFI_SUCCESS The operation completed sucessfully.\r | |
a405b86d | 2182 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r |
2183 | @retval EFI_INVALID_PARAMETER A parameter was invalid.\r | |
2184 | @retval EFI_VOLUME_CORRUPTED The command line was corrupt.\r | |
2185 | @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One\r | |
1e6e84c7 | 2186 | of the command line arguments was returned in\r |
94b17fa1 | 2187 | ProblemParam if provided.\r |
a405b86d | 2188 | @retval EFI_NOT_FOUND A argument required a value that was missing.\r |
2189 | The invalid command line argument was returned in\r | |
94b17fa1 | 2190 | ProblemParam if provided.\r |
2191 | **/\r | |
2192 | EFI_STATUS\r | |
2193 | EFIAPI\r | |
2247dde4 | 2194 | ShellCommandLineParseEx (\r |
94b17fa1 | 2195 | IN CONST SHELL_PARAM_ITEM *CheckList,\r |
2196 | OUT LIST_ENTRY **CheckPackage,\r | |
2197 | OUT CHAR16 **ProblemParam OPTIONAL,\r | |
2247dde4 | 2198 | IN BOOLEAN AutoPageBreak,\r |
2199 | IN BOOLEAN AlwaysAllowNumbers\r | |
a405b86d | 2200 | )\r |
2201 | {\r | |
1e6e84c7 | 2202 | //\r |
94b17fa1 | 2203 | // ASSERT that CheckList and CheckPackage aren't NULL\r |
2204 | //\r | |
2205 | ASSERT(CheckList != NULL);\r | |
2206 | ASSERT(CheckPackage != NULL);\r | |
2207 | \r | |
1e6e84c7 | 2208 | //\r |
94b17fa1 | 2209 | // Check for UEFI Shell 2.0 protocols\r |
2210 | //\r | |
366f81a0 | 2211 | if (gEfiShellParametersProtocol != NULL) {\r |
1e6e84c7 | 2212 | return (InternalCommandLineParse(CheckList,\r |
2213 | CheckPackage,\r | |
2214 | ProblemParam,\r | |
2215 | AutoPageBreak,\r | |
366f81a0 | 2216 | (CONST CHAR16**) gEfiShellParametersProtocol->Argv,\r |
2217 | gEfiShellParametersProtocol->Argc,\r | |
2247dde4 | 2218 | AlwaysAllowNumbers));\r |
94b17fa1 | 2219 | }\r |
2220 | \r | |
1e6e84c7 | 2221 | //\r |
94b17fa1 | 2222 | // ASSERT That EFI Shell is not required\r |
2223 | //\r | |
2224 | ASSERT (mEfiShellInterface != NULL);\r | |
1e6e84c7 | 2225 | return (InternalCommandLineParse(CheckList,\r |
2226 | CheckPackage,\r | |
2227 | ProblemParam,\r | |
2228 | AutoPageBreak,\r | |
08d7f8e8 | 2229 | (CONST CHAR16**) mEfiShellInterface->Argv,\r |
2247dde4 | 2230 | mEfiShellInterface->Argc,\r |
2231 | AlwaysAllowNumbers));\r | |
94b17fa1 | 2232 | }\r |
2233 | \r | |
2234 | /**\r | |
2235 | Frees shell variable list that was returned from ShellCommandLineParse.\r | |
2236 | \r | |
2237 | This function will free all the memory that was used for the CheckPackage\r | |
2238 | list of postprocessed shell arguments.\r | |
2239 | \r | |
2240 | this function has no return value.\r | |
2241 | \r | |
2242 | if CheckPackage is NULL, then return\r | |
2243 | \r | |
2244 | @param CheckPackage the list to de-allocate\r | |
2245 | **/\r | |
2246 | VOID\r | |
2247 | EFIAPI\r | |
2248 | ShellCommandLineFreeVarList (\r | |
2249 | IN LIST_ENTRY *CheckPackage\r | |
a405b86d | 2250 | )\r |
2251 | {\r | |
94b17fa1 | 2252 | LIST_ENTRY *Node;\r |
2253 | \r | |
2254 | //\r | |
2255 | // check for CheckPackage == NULL\r | |
2256 | //\r | |
2257 | if (CheckPackage == NULL) {\r | |
2258 | return;\r | |
2259 | }\r | |
2260 | \r | |
2261 | //\r | |
2262 | // for each node in the list\r | |
2263 | //\r | |
9eb53ac3 | 2264 | for ( Node = GetFirstNode(CheckPackage)\r |
a405b86d | 2265 | ; !IsListEmpty(CheckPackage)\r |
9eb53ac3 | 2266 | ; Node = GetFirstNode(CheckPackage)\r |
a405b86d | 2267 | ){\r |
94b17fa1 | 2268 | //\r |
2269 | // Remove it from the list\r | |
2270 | //\r | |
2271 | RemoveEntryList(Node);\r | |
2272 | \r | |
2273 | //\r | |
2274 | // if it has a name free the name\r | |
2275 | //\r | |
2276 | if (((SHELL_PARAM_PACKAGE*)Node)->Name != NULL) {\r | |
2277 | FreePool(((SHELL_PARAM_PACKAGE*)Node)->Name);\r | |
2278 | }\r | |
2279 | \r | |
2280 | //\r | |
2281 | // if it has a value free the value\r | |
2282 | //\r | |
2283 | if (((SHELL_PARAM_PACKAGE*)Node)->Value != NULL) {\r | |
2284 | FreePool(((SHELL_PARAM_PACKAGE*)Node)->Value);\r | |
2285 | }\r | |
1e6e84c7 | 2286 | \r |
94b17fa1 | 2287 | //\r |
2288 | // free the node structure\r | |
2289 | //\r | |
2290 | FreePool((SHELL_PARAM_PACKAGE*)Node);\r | |
2291 | }\r | |
2292 | //\r | |
2293 | // free the list head node\r | |
2294 | //\r | |
2295 | FreePool(CheckPackage);\r | |
2296 | }\r | |
2297 | /**\r | |
2298 | Checks for presence of a flag parameter\r | |
2299 | \r | |
2300 | flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key\r | |
2301 | \r | |
2302 | if CheckPackage is NULL then return FALSE.\r | |
2303 | if KeyString is NULL then ASSERT()\r | |
1e6e84c7 | 2304 | \r |
94b17fa1 | 2305 | @param CheckPackage The package of parsed command line arguments\r |
2306 | @param KeyString the Key of the command line argument to check for\r | |
2307 | \r | |
2308 | @retval TRUE the flag is on the command line\r | |
2309 | @retval FALSE the flag is not on the command line\r | |
2310 | **/\r | |
2311 | BOOLEAN\r | |
2312 | EFIAPI\r | |
2313 | ShellCommandLineGetFlag (\r | |
a405b86d | 2314 | IN CONST LIST_ENTRY * CONST CheckPackage,\r |
2315 | IN CONST CHAR16 * CONST KeyString\r | |
2316 | )\r | |
2317 | {\r | |
94b17fa1 | 2318 | LIST_ENTRY *Node;\r |
252d9457 | 2319 | CHAR16 *TempString;\r |
94b17fa1 | 2320 | \r |
2321 | //\r | |
0c1950ba | 2322 | // return FALSE for no package or KeyString is NULL\r |
94b17fa1 | 2323 | //\r |
0c1950ba | 2324 | if (CheckPackage == NULL || KeyString == NULL) {\r |
94b17fa1 | 2325 | return (FALSE);\r |
2326 | }\r | |
2327 | \r | |
2328 | //\r | |
2329 | // enumerate through the list of parametrs\r | |
2330 | //\r | |
1e6e84c7 | 2331 | for ( Node = GetFirstNode(CheckPackage)\r |
2332 | ; !IsNull (CheckPackage, Node)\r | |
2333 | ; Node = GetNextNode(CheckPackage, Node)\r | |
252d9457 | 2334 | ){\r |
94b17fa1 | 2335 | //\r |
2336 | // If the Name matches, return TRUE (and there may be NULL name)\r | |
2337 | //\r | |
2338 | if (((SHELL_PARAM_PACKAGE*)Node)->Name != NULL) {\r | |
9eb53ac3 | 2339 | //\r |
2340 | // If Type is TypeStart then only compare the begining of the strings\r | |
2341 | //\r | |
252d9457 | 2342 | if (((SHELL_PARAM_PACKAGE*)Node)->Type == TypeStart) {\r |
2343 | if (StrnCmp(KeyString, ((SHELL_PARAM_PACKAGE*)Node)->Name, StrLen(KeyString)) == 0) {\r | |
2344 | return (TRUE);\r | |
2345 | }\r | |
2346 | TempString = NULL;\r | |
2347 | TempString = StrnCatGrow(&TempString, NULL, KeyString, StrLen(((SHELL_PARAM_PACKAGE*)Node)->Name));\r | |
2348 | if (TempString != NULL) {\r | |
2349 | if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r | |
2350 | FreePool(TempString);\r | |
2351 | return (TRUE);\r | |
2352 | }\r | |
2353 | FreePool(TempString);\r | |
2354 | }\r | |
2355 | } else if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r | |
94b17fa1 | 2356 | return (TRUE);\r |
2357 | }\r | |
2358 | }\r | |
2359 | }\r | |
2360 | return (FALSE);\r | |
2361 | }\r | |
2362 | /**\r | |
a405b86d | 2363 | Returns value from command line argument.\r |
94b17fa1 | 2364 | \r |
a405b86d | 2365 | Value parameters are in the form of "-<Key> value" or "/<Key> value".\r |
1e6e84c7 | 2366 | \r |
a405b86d | 2367 | If CheckPackage is NULL, then return NULL.\r |
94b17fa1 | 2368 | \r |
a405b86d | 2369 | @param[in] CheckPackage The package of parsed command line arguments.\r |
2370 | @param[in] KeyString The Key of the command line argument to check for.\r | |
94b17fa1 | 2371 | \r |
a405b86d | 2372 | @retval NULL The flag is not on the command line.\r |
2373 | @retval !=NULL The pointer to unicode string of the value.\r | |
2374 | **/\r | |
94b17fa1 | 2375 | CONST CHAR16*\r |
2376 | EFIAPI\r | |
2377 | ShellCommandLineGetValue (\r | |
2378 | IN CONST LIST_ENTRY *CheckPackage,\r | |
2379 | IN CHAR16 *KeyString\r | |
a405b86d | 2380 | )\r |
2381 | {\r | |
94b17fa1 | 2382 | LIST_ENTRY *Node;\r |
252d9457 | 2383 | CHAR16 *TempString;\r |
94b17fa1 | 2384 | \r |
2385 | //\r | |
0c1950ba | 2386 | // return NULL for no package or KeyString is NULL\r |
94b17fa1 | 2387 | //\r |
0c1950ba | 2388 | if (CheckPackage == NULL || KeyString == NULL) {\r |
94b17fa1 | 2389 | return (NULL);\r |
2390 | }\r | |
2391 | \r | |
2392 | //\r | |
2393 | // enumerate through the list of parametrs\r | |
2394 | //\r | |
1e6e84c7 | 2395 | for ( Node = GetFirstNode(CheckPackage)\r |
2396 | ; !IsNull (CheckPackage, Node)\r | |
2397 | ; Node = GetNextNode(CheckPackage, Node)\r | |
252d9457 | 2398 | ){\r |
94b17fa1 | 2399 | //\r |
252d9457 | 2400 | // If the Name matches, return TRUE (and there may be NULL name)\r |
94b17fa1 | 2401 | //\r |
2402 | if (((SHELL_PARAM_PACKAGE*)Node)->Name != NULL) {\r | |
9eb53ac3 | 2403 | //\r |
2404 | // If Type is TypeStart then only compare the begining of the strings\r | |
2405 | //\r | |
252d9457 | 2406 | if (((SHELL_PARAM_PACKAGE*)Node)->Type == TypeStart) {\r |
2407 | if (StrnCmp(KeyString, ((SHELL_PARAM_PACKAGE*)Node)->Name, StrLen(KeyString)) == 0) {\r | |
2408 | return (((SHELL_PARAM_PACKAGE*)Node)->Name + StrLen(KeyString));\r | |
2409 | }\r | |
2410 | TempString = NULL;\r | |
2411 | TempString = StrnCatGrow(&TempString, NULL, KeyString, StrLen(((SHELL_PARAM_PACKAGE*)Node)->Name));\r | |
2412 | if (TempString != NULL) {\r | |
2413 | if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r | |
2414 | FreePool(TempString);\r | |
2415 | return (((SHELL_PARAM_PACKAGE*)Node)->Name + StrLen(KeyString));\r | |
2416 | }\r | |
2417 | FreePool(TempString);\r | |
2418 | }\r | |
2419 | } else if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r | |
94b17fa1 | 2420 | return (((SHELL_PARAM_PACKAGE*)Node)->Value);\r |
2421 | }\r | |
2422 | }\r | |
2423 | }\r | |
2424 | return (NULL);\r | |
2425 | }\r | |
a405b86d | 2426 | \r |
94b17fa1 | 2427 | /**\r |
a405b86d | 2428 | Returns raw value from command line argument.\r |
94b17fa1 | 2429 | \r |
a405b86d | 2430 | Raw value parameters are in the form of "value" in a specific position in the list.\r |
1e6e84c7 | 2431 | \r |
a405b86d | 2432 | If CheckPackage is NULL, then return NULL.\r |
94b17fa1 | 2433 | \r |
a405b86d | 2434 | @param[in] CheckPackage The package of parsed command line arguments.\r |
2435 | @param[in] Position The position of the value.\r | |
94b17fa1 | 2436 | \r |
a405b86d | 2437 | @retval NULL The flag is not on the command line.\r |
2438 | @retval !=NULL The pointer to unicode string of the value.\r | |
94b17fa1 | 2439 | **/\r |
2440 | CONST CHAR16*\r | |
2441 | EFIAPI\r | |
2442 | ShellCommandLineGetRawValue (\r | |
a405b86d | 2443 | IN CONST LIST_ENTRY * CONST CheckPackage,\r |
2444 | IN UINTN Position\r | |
2445 | )\r | |
2446 | {\r | |
94b17fa1 | 2447 | LIST_ENTRY *Node;\r |
2448 | \r | |
2449 | //\r | |
2450 | // check for CheckPackage == NULL\r | |
2451 | //\r | |
2452 | if (CheckPackage == NULL) {\r | |
2453 | return (NULL);\r | |
2454 | }\r | |
2455 | \r | |
2456 | //\r | |
2457 | // enumerate through the list of parametrs\r | |
2458 | //\r | |
1e6e84c7 | 2459 | for ( Node = GetFirstNode(CheckPackage)\r |
2460 | ; !IsNull (CheckPackage, Node)\r | |
2461 | ; Node = GetNextNode(CheckPackage, Node)\r | |
a405b86d | 2462 | ){\r |
94b17fa1 | 2463 | //\r |
2464 | // If the position matches, return the value\r | |
2465 | //\r | |
2466 | if (((SHELL_PARAM_PACKAGE*)Node)->OriginalPosition == Position) {\r | |
2467 | return (((SHELL_PARAM_PACKAGE*)Node)->Value);\r | |
2468 | }\r | |
2469 | }\r | |
2470 | return (NULL);\r | |
b1f95a06 | 2471 | }\r |
2247dde4 | 2472 | \r |
2473 | /**\r | |
1e6e84c7 | 2474 | returns the number of command line value parameters that were parsed.\r |
2475 | \r | |
2247dde4 | 2476 | this will not include flags.\r |
2477 | \r | |
a405b86d | 2478 | @param[in] CheckPackage The package of parsed command line arguments.\r |
2479 | \r | |
2247dde4 | 2480 | @retval (UINTN)-1 No parsing has ocurred\r |
2481 | @return other The number of value parameters found\r | |
2482 | **/\r | |
2483 | UINTN\r | |
2484 | EFIAPI\r | |
2485 | ShellCommandLineGetCount(\r | |
a405b86d | 2486 | IN CONST LIST_ENTRY *CheckPackage\r |
125c2cf4 | 2487 | )\r |
2488 | {\r | |
a405b86d | 2489 | LIST_ENTRY *Node1;\r |
2490 | UINTN Count;\r | |
2491 | \r | |
2492 | if (CheckPackage == NULL) {\r | |
2493 | return (0);\r | |
2494 | }\r | |
2495 | for ( Node1 = GetFirstNode(CheckPackage), Count = 0\r | |
2496 | ; !IsNull (CheckPackage, Node1)\r | |
2497 | ; Node1 = GetNextNode(CheckPackage, Node1)\r | |
2498 | ){\r | |
2499 | if (((SHELL_PARAM_PACKAGE*)Node1)->Name == NULL) {\r | |
2500 | Count++;\r | |
2501 | }\r | |
2502 | }\r | |
2503 | return (Count);\r | |
2247dde4 | 2504 | }\r |
2505 | \r | |
36a9d672 | 2506 | /**\r |
2507 | Determins if a parameter is duplicated.\r | |
2508 | \r | |
1e6e84c7 | 2509 | If Param is not NULL then it will point to a callee allocated string buffer\r |
36a9d672 | 2510 | with the parameter value if a duplicate is found.\r |
2511 | \r | |
2512 | If CheckPackage is NULL, then ASSERT.\r | |
2513 | \r | |
2514 | @param[in] CheckPackage The package of parsed command line arguments.\r | |
2515 | @param[out] Param Upon finding one, a pointer to the duplicated parameter.\r | |
2516 | \r | |
2517 | @retval EFI_SUCCESS No parameters were duplicated.\r | |
2518 | @retval EFI_DEVICE_ERROR A duplicate was found.\r | |
2519 | **/\r | |
2520 | EFI_STATUS\r | |
2521 | EFIAPI\r | |
2522 | ShellCommandLineCheckDuplicate (\r | |
2523 | IN CONST LIST_ENTRY *CheckPackage,\r | |
2524 | OUT CHAR16 **Param\r | |
2525 | )\r | |
2526 | {\r | |
2527 | LIST_ENTRY *Node1;\r | |
2528 | LIST_ENTRY *Node2;\r | |
1e6e84c7 | 2529 | \r |
36a9d672 | 2530 | ASSERT(CheckPackage != NULL);\r |
2531 | \r | |
1e6e84c7 | 2532 | for ( Node1 = GetFirstNode(CheckPackage)\r |
2533 | ; !IsNull (CheckPackage, Node1)\r | |
2534 | ; Node1 = GetNextNode(CheckPackage, Node1)\r | |
a405b86d | 2535 | ){\r |
1e6e84c7 | 2536 | for ( Node2 = GetNextNode(CheckPackage, Node1)\r |
2537 | ; !IsNull (CheckPackage, Node2)\r | |
2538 | ; Node2 = GetNextNode(CheckPackage, Node2)\r | |
a405b86d | 2539 | ){\r |
2540 | 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 | 2541 | if (Param != NULL) {\r |
2542 | *Param = NULL;\r | |
2543 | *Param = StrnCatGrow(Param, NULL, ((SHELL_PARAM_PACKAGE*)Node1)->Name, 0);\r | |
2544 | }\r | |
2545 | return (EFI_DEVICE_ERROR);\r | |
2546 | }\r | |
2547 | }\r | |
2548 | }\r | |
2549 | return (EFI_SUCCESS);\r | |
2550 | }\r | |
2551 | \r | |
975136ab | 2552 | /**\r |
1e6e84c7 | 2553 | This is a find and replace function. Upon successful return the NewString is a copy of\r |
975136ab | 2554 | SourceString with each instance of FindTarget replaced with ReplaceWith.\r |
2555 | \r | |
b3011f40 | 2556 | If SourceString and NewString overlap the behavior is undefined.\r |
2557 | \r | |
975136ab | 2558 | If the string would grow bigger than NewSize it will halt and return error.\r |
2559 | \r | |
4ff7e37b ED |
2560 | @param[in] SourceString The string with source buffer.\r |
2561 | @param[in, out] NewString The string with resultant buffer.\r | |
2562 | @param[in] NewSize The size in bytes of NewString.\r | |
2563 | @param[in] FindTarget The string to look for.\r | |
2564 | @param[in] ReplaceWith The string to replace FindTarget with.\r | |
2565 | @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'\r | |
2566 | immediately before it.\r | |
2567 | @param[in] ParameterReplacing If TRUE will add "" around items with spaces.\r | |
969c783b | 2568 | \r |
2569 | @retval EFI_INVALID_PARAMETER SourceString was NULL.\r | |
2570 | @retval EFI_INVALID_PARAMETER NewString was NULL.\r | |
2571 | @retval EFI_INVALID_PARAMETER FindTarget was NULL.\r | |
2572 | @retval EFI_INVALID_PARAMETER ReplaceWith was NULL.\r | |
2573 | @retval EFI_INVALID_PARAMETER FindTarget had length < 1.\r | |
2574 | @retval EFI_INVALID_PARAMETER SourceString had length < 1.\r | |
1e6e84c7 | 2575 | @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold\r |
969c783b | 2576 | the new string (truncation occurred).\r |
a405b86d | 2577 | @retval EFI_SUCCESS The string was successfully copied with replacement.\r |
975136ab | 2578 | **/\r |
975136ab | 2579 | EFI_STATUS\r |
2580 | EFIAPI\r | |
a405b86d | 2581 | ShellCopySearchAndReplace(\r |
975136ab | 2582 | IN CHAR16 CONST *SourceString,\r |
a405b86d | 2583 | IN OUT CHAR16 *NewString,\r |
975136ab | 2584 | IN UINTN NewSize,\r |
2585 | IN CONST CHAR16 *FindTarget,\r | |
969c783b | 2586 | IN CONST CHAR16 *ReplaceWith,\r |
a405b86d | 2587 | IN CONST BOOLEAN SkipPreCarrot,\r |
2588 | IN CONST BOOLEAN ParameterReplacing\r | |
1e6e84c7 | 2589 | )\r |
2247dde4 | 2590 | {\r |
0158294b | 2591 | UINTN Size;\r |
a405b86d | 2592 | CHAR16 *Replace;\r |
2593 | \r | |
975136ab | 2594 | if ( (SourceString == NULL)\r |
2595 | || (NewString == NULL)\r | |
2596 | || (FindTarget == NULL)\r | |
2597 | || (ReplaceWith == NULL)\r | |
2598 | || (StrLen(FindTarget) < 1)\r | |
2599 | || (StrLen(SourceString) < 1)\r | |
a405b86d | 2600 | ){\r |
975136ab | 2601 | return (EFI_INVALID_PARAMETER);\r |
2602 | }\r | |
a405b86d | 2603 | Replace = NULL;\r |
2604 | if (StrStr(ReplaceWith, L" ") == NULL || !ParameterReplacing) {\r | |
2605 | Replace = StrnCatGrow(&Replace, NULL, ReplaceWith, 0);\r | |
2606 | } else {\r | |
2607 | Replace = AllocateZeroPool(StrSize(ReplaceWith) + 2*sizeof(CHAR16));\r | |
beab0fc5 | 2608 | if (Replace != NULL) {\r |
2609 | UnicodeSPrint(Replace, StrSize(ReplaceWith) + 2*sizeof(CHAR16), L"\"%s\"", ReplaceWith);\r | |
2610 | }\r | |
a405b86d | 2611 | }\r |
3e082d58 | 2612 | if (Replace == NULL) {\r |
2613 | return (EFI_OUT_OF_RESOURCES);\r | |
2614 | }\r | |
98c16be5 | 2615 | NewString = ZeroMem(NewString, NewSize);\r |
2247dde4 | 2616 | while (*SourceString != CHAR_NULL) {\r |
969c783b | 2617 | //\r |
a405b86d | 2618 | // if we find the FindTarget and either Skip == FALSE or Skip and we\r |
969c783b | 2619 | // dont have a carrot do a replace...\r |
2620 | //\r | |
1e6e84c7 | 2621 | if (StrnCmp(SourceString, FindTarget, StrLen(FindTarget)) == 0\r |
a405b86d | 2622 | && ((SkipPreCarrot && *(SourceString-1) != L'^') || !SkipPreCarrot)\r |
2623 | ){\r | |
975136ab | 2624 | SourceString += StrLen(FindTarget);\r |
0158294b | 2625 | Size = StrSize(NewString);\r |
a405b86d | 2626 | if ((Size + (StrLen(Replace)*sizeof(CHAR16))) > NewSize) {\r |
2627 | FreePool(Replace);\r | |
975136ab | 2628 | return (EFI_BUFFER_TOO_SMALL);\r |
2629 | }\r | |
98c16be5 | 2630 | StrnCat(NewString, Replace, NewSize/sizeof(CHAR16) - 1 - StrLen(NewString));\r |
975136ab | 2631 | } else {\r |
0158294b | 2632 | Size = StrSize(NewString);\r |
2633 | if (Size + sizeof(CHAR16) > NewSize) {\r | |
a405b86d | 2634 | FreePool(Replace);\r |
975136ab | 2635 | return (EFI_BUFFER_TOO_SMALL);\r |
2636 | }\r | |
2637 | StrnCat(NewString, SourceString, 1);\r | |
2638 | SourceString++;\r | |
2639 | }\r | |
2640 | }\r | |
a405b86d | 2641 | FreePool(Replace);\r |
975136ab | 2642 | return (EFI_SUCCESS);\r |
2643 | }\r | |
b1f95a06 | 2644 | \r |
e2f8297f | 2645 | /**\r |
2646 | Internal worker function to output a string.\r | |
2647 | \r | |
2648 | This function will output a string to the correct StdOut.\r | |
2649 | \r | |
2650 | @param[in] String The string to print out.\r | |
2651 | \r | |
2652 | @retval EFI_SUCCESS The operation was sucessful.\r | |
2653 | @retval !EFI_SUCCESS The operation failed.\r | |
2654 | **/\r | |
2655 | EFI_STATUS\r | |
2656 | EFIAPI\r | |
2657 | InternalPrintTo (\r | |
2658 | IN CONST CHAR16 *String\r | |
2659 | )\r | |
2660 | {\r | |
2661 | UINTN Size;\r | |
2662 | Size = StrSize(String) - sizeof(CHAR16);\r | |
a405b86d | 2663 | if (Size == 0) {\r |
2664 | return (EFI_SUCCESS);\r | |
2665 | }\r | |
366f81a0 | 2666 | if (gEfiShellParametersProtocol != NULL) {\r |
2667 | return (gEfiShellProtocol->WriteFile(gEfiShellParametersProtocol->StdOut, &Size, (VOID*)String));\r | |
e2f8297f | 2668 | }\r |
2669 | if (mEfiShellInterface != NULL) {\r | |
06c355b4 | 2670 | if (mEfiShellInterface->RedirArgc == 0) { \r |
49bd498d | 2671 | //\r |
2672 | // Divide in half for old shell. Must be string length not size.\r | |
06c355b4 | 2673 | // \r |
2674 | Size /=2; // Divide in half only when no redirection.\r | |
2675 | }\r | |
a405b86d | 2676 | return (mEfiShellInterface->StdOut->Write(mEfiShellInterface->StdOut, &Size, (VOID*)String));\r |
e2f8297f | 2677 | }\r |
2678 | ASSERT(FALSE);\r | |
2679 | return (EFI_UNSUPPORTED);\r | |
2680 | }\r | |
2681 | \r | |
b1f95a06 | 2682 | /**\r |
2683 | Print at a specific location on the screen.\r | |
2684 | \r | |
f1b87e7a | 2685 | This function will move the cursor to a given screen location and print the specified string\r |
1e6e84c7 | 2686 | \r |
2687 | If -1 is specified for either the Row or Col the current screen location for BOTH\r | |
f1b87e7a | 2688 | will be used.\r |
b1f95a06 | 2689 | \r |
2690 | if either Row or Col is out of range for the current console, then ASSERT\r | |
2691 | if Format is NULL, then ASSERT\r | |
2692 | \r | |
1e6e84c7 | 2693 | In addition to the standard %-based flags as supported by UefiLib Print() this supports\r |
b1f95a06 | 2694 | the following additional flags:\r |
2695 | %N - Set output attribute to normal\r | |
2696 | %H - Set output attribute to highlight\r | |
2697 | %E - Set output attribute to error\r | |
2698 | %B - Set output attribute to blue color\r | |
2699 | %V - Set output attribute to green color\r | |
2700 | \r | |
2701 | Note: The background color is controlled by the shell command cls.\r | |
2702 | \r | |
b1f95a06 | 2703 | @param[in] Col the column to print at\r |
252d9457 | 2704 | @param[in] Row the row to print at\r |
b1f95a06 | 2705 | @param[in] Format the format string\r |
2247dde4 | 2706 | @param[in] Marker the marker for the variable argument list\r |
b1f95a06 | 2707 | \r |
a405b86d | 2708 | @return EFI_SUCCESS The operation was successful.\r |
2709 | @return EFI_DEVICE_ERROR The console device reported an error.\r | |
b1f95a06 | 2710 | **/\r |
a405b86d | 2711 | EFI_STATUS\r |
b1f95a06 | 2712 | EFIAPI\r |
2247dde4 | 2713 | InternalShellPrintWorker(\r |
b1f95a06 | 2714 | IN INT32 Col OPTIONAL,\r |
2715 | IN INT32 Row OPTIONAL,\r | |
2716 | IN CONST CHAR16 *Format,\r | |
252d9457 | 2717 | IN VA_LIST Marker\r |
1e6e84c7 | 2718 | )\r |
2247dde4 | 2719 | {\r |
b1f95a06 | 2720 | EFI_STATUS Status;\r |
975136ab | 2721 | CHAR16 *ResumeLocation;\r |
2722 | CHAR16 *FormatWalker;\r | |
a405b86d | 2723 | UINTN OriginalAttribute;\r |
89e8537a | 2724 | CHAR16 *mPostReplaceFormat;\r |
2725 | CHAR16 *mPostReplaceFormat2;\r | |
2726 | \r | |
2727 | mPostReplaceFormat = AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize));\r | |
2728 | mPostReplaceFormat2 = AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize));\r | |
a405b86d | 2729 | \r |
f8d3e689 | 2730 | if (mPostReplaceFormat == NULL || mPostReplaceFormat2 == NULL) {\r |
2731 | SHELL_FREE_NON_NULL(mPostReplaceFormat);\r | |
2732 | SHELL_FREE_NON_NULL(mPostReplaceFormat2);\r | |
2733 | return (EFI_OUT_OF_RESOURCES);\r | |
2734 | }\r | |
2735 | \r | |
a405b86d | 2736 | Status = EFI_SUCCESS;\r |
2737 | OriginalAttribute = gST->ConOut->Mode->Attribute;\r | |
1e6e84c7 | 2738 | \r |
975136ab | 2739 | //\r |
2740 | // Back and forth each time fixing up 1 of our flags...\r | |
2741 | //\r | |
a405b86d | 2742 | Status = ShellCopySearchAndReplace(Format, mPostReplaceFormat, PcdGet16 (PcdShellPrintBufferSize), L"%N", L"%%N", FALSE, FALSE);\r |
975136ab | 2743 | ASSERT_EFI_ERROR(Status);\r |
a405b86d | 2744 | Status = ShellCopySearchAndReplace(mPostReplaceFormat, mPostReplaceFormat2, PcdGet16 (PcdShellPrintBufferSize), L"%E", L"%%E", FALSE, FALSE);\r |
975136ab | 2745 | ASSERT_EFI_ERROR(Status);\r |
a405b86d | 2746 | Status = ShellCopySearchAndReplace(mPostReplaceFormat2, mPostReplaceFormat, PcdGet16 (PcdShellPrintBufferSize), L"%H", L"%%H", FALSE, FALSE);\r |
975136ab | 2747 | ASSERT_EFI_ERROR(Status);\r |
a405b86d | 2748 | Status = ShellCopySearchAndReplace(mPostReplaceFormat, mPostReplaceFormat2, PcdGet16 (PcdShellPrintBufferSize), L"%B", L"%%B", FALSE, FALSE);\r |
975136ab | 2749 | ASSERT_EFI_ERROR(Status);\r |
a405b86d | 2750 | Status = ShellCopySearchAndReplace(mPostReplaceFormat2, mPostReplaceFormat, PcdGet16 (PcdShellPrintBufferSize), L"%V", L"%%V", FALSE, FALSE);\r |
975136ab | 2751 | ASSERT_EFI_ERROR(Status);\r |
2752 | \r | |
2753 | //\r | |
2754 | // Use the last buffer from replacing to print from...\r | |
2755 | //\r | |
a405b86d | 2756 | UnicodeVSPrint (mPostReplaceFormat2, PcdGet16 (PcdShellPrintBufferSize), mPostReplaceFormat, Marker);\r |
b1f95a06 | 2757 | \r |
2758 | if (Col != -1 && Row != -1) {\r | |
b1f95a06 | 2759 | Status = gST->ConOut->SetCursorPosition(gST->ConOut, Col, Row);\r |
975136ab | 2760 | }\r |
2761 | \r | |
ecd3d59f | 2762 | FormatWalker = mPostReplaceFormat2;\r |
2247dde4 | 2763 | while (*FormatWalker != CHAR_NULL) {\r |
975136ab | 2764 | //\r |
2765 | // Find the next attribute change request\r | |
2766 | //\r | |
2767 | ResumeLocation = StrStr(FormatWalker, L"%");\r | |
2768 | if (ResumeLocation != NULL) {\r | |
2247dde4 | 2769 | *ResumeLocation = CHAR_NULL;\r |
975136ab | 2770 | }\r |
2771 | //\r | |
2772 | // print the current FormatWalker string\r | |
2773 | //\r | |
a405b86d | 2774 | if (StrLen(FormatWalker)>0) {\r |
2775 | Status = InternalPrintTo(FormatWalker);\r | |
2776 | if (EFI_ERROR(Status)) {\r | |
2777 | break;\r | |
2778 | }\r | |
2779 | }\r | |
2780 | \r | |
975136ab | 2781 | //\r |
2782 | // update the attribute\r | |
2783 | //\r | |
2784 | if (ResumeLocation != NULL) {\r | |
5d46f17b | 2785 | if (*(ResumeLocation-1) == L'^') {\r |
8bb7441e | 2786 | //\r |
2787 | // Move cursor back 1 position to overwrite the ^\r | |
2788 | //\r | |
2789 | gST->ConOut->SetCursorPosition(gST->ConOut, gST->ConOut->Mode->CursorColumn - 1, gST->ConOut->Mode->CursorRow);\r | |
2790 | \r | |
5d46f17b | 2791 | //\r |
2792 | // Print a simple '%' symbol\r | |
2793 | //\r | |
2794 | Status = InternalPrintTo(L"%");\r | |
2795 | ResumeLocation = ResumeLocation - 1;\r | |
2796 | } else {\r | |
2797 | switch (*(ResumeLocation+1)) {\r | |
2798 | case (L'N'):\r | |
2799 | gST->ConOut->SetAttribute(gST->ConOut, OriginalAttribute);\r | |
a405b86d | 2800 | break;\r |
5d46f17b | 2801 | case (L'E'):\r |
2802 | gST->ConOut->SetAttribute(gST->ConOut, EFI_TEXT_ATTR(EFI_YELLOW, ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)));\r | |
2803 | break;\r | |
2804 | case (L'H'):\r | |
2805 | gST->ConOut->SetAttribute(gST->ConOut, EFI_TEXT_ATTR(EFI_WHITE, ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)));\r | |
2806 | break;\r | |
2807 | case (L'B'):\r | |
2808 | gST->ConOut->SetAttribute(gST->ConOut, EFI_TEXT_ATTR(EFI_BLUE, ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)));\r | |
2809 | break;\r | |
2810 | case (L'V'):\r | |
2811 | gST->ConOut->SetAttribute(gST->ConOut, EFI_TEXT_ATTR(EFI_GREEN, ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)));\r | |
2812 | break;\r | |
2813 | default:\r | |
2814 | //\r | |
2815 | // Print a simple '%' symbol\r | |
2816 | //\r | |
2817 | Status = InternalPrintTo(L"%");\r | |
2818 | if (EFI_ERROR(Status)) {\r | |
2819 | break;\r | |
2820 | }\r | |
2821 | ResumeLocation = ResumeLocation - 1;\r | |
2822 | break;\r | |
2823 | }\r | |
975136ab | 2824 | }\r |
2825 | } else {\r | |
2826 | //\r | |
2827 | // reset to normal now...\r | |
2828 | //\r | |
975136ab | 2829 | break;\r |
2830 | }\r | |
2831 | \r | |
2832 | //\r | |
2833 | // update FormatWalker to Resume + 2 (skip the % and the indicator)\r | |
2834 | //\r | |
2835 | FormatWalker = ResumeLocation + 2;\r | |
2836 | }\r | |
b1f95a06 | 2837 | \r |
a405b86d | 2838 | gST->ConOut->SetAttribute(gST->ConOut, OriginalAttribute);\r |
89e8537a | 2839 | \r |
2840 | SHELL_FREE_NON_NULL(mPostReplaceFormat);\r | |
2841 | SHELL_FREE_NON_NULL(mPostReplaceFormat2);\r | |
a405b86d | 2842 | return (Status);\r |
5f7431d0 | 2843 | }\r |
2247dde4 | 2844 | \r |
2845 | /**\r | |
2846 | Print at a specific location on the screen.\r | |
2847 | \r | |
e2f8297f | 2848 | This function will move the cursor to a given screen location and print the specified string.\r |
1e6e84c7 | 2849 | \r |
2850 | If -1 is specified for either the Row or Col the current screen location for BOTH\r | |
2247dde4 | 2851 | will be used.\r |
2852 | \r | |
e2f8297f | 2853 | If either Row or Col is out of range for the current console, then ASSERT.\r |
2854 | If Format is NULL, then ASSERT.\r | |
2247dde4 | 2855 | \r |
1e6e84c7 | 2856 | In addition to the standard %-based flags as supported by UefiLib Print() this supports\r |
2247dde4 | 2857 | the following additional flags:\r |
2858 | %N - Set output attribute to normal\r | |
2859 | %H - Set output attribute to highlight\r | |
2860 | %E - Set output attribute to error\r | |
2861 | %B - Set output attribute to blue color\r | |
2862 | %V - Set output attribute to green color\r | |
2863 | \r | |
2864 | Note: The background color is controlled by the shell command cls.\r | |
2865 | \r | |
2247dde4 | 2866 | @param[in] Col the column to print at\r |
a405b86d | 2867 | @param[in] Row the row to print at\r |
2247dde4 | 2868 | @param[in] Format the format string\r |
a405b86d | 2869 | @param[in] ... The variable argument list.\r |
2247dde4 | 2870 | \r |
a405b86d | 2871 | @return EFI_SUCCESS The printing was successful.\r |
2872 | @return EFI_DEVICE_ERROR The console device reported an error.\r | |
2247dde4 | 2873 | **/\r |
a405b86d | 2874 | EFI_STATUS\r |
2247dde4 | 2875 | EFIAPI\r |
2876 | ShellPrintEx(\r | |
2877 | IN INT32 Col OPTIONAL,\r | |
2878 | IN INT32 Row OPTIONAL,\r | |
2879 | IN CONST CHAR16 *Format,\r | |
2880 | ...\r | |
1e6e84c7 | 2881 | )\r |
2247dde4 | 2882 | {\r |
2883 | VA_LIST Marker;\r | |
a405b86d | 2884 | EFI_STATUS RetVal;\r |
3e082d58 | 2885 | if (Format == NULL) {\r |
2886 | return (EFI_INVALID_PARAMETER);\r | |
2887 | }\r | |
2247dde4 | 2888 | VA_START (Marker, Format);\r |
a405b86d | 2889 | RetVal = InternalShellPrintWorker(Col, Row, Format, Marker);\r |
e2f8297f | 2890 | VA_END(Marker);\r |
a405b86d | 2891 | return(RetVal);\r |
2247dde4 | 2892 | }\r |
2893 | \r | |
2894 | /**\r | |
2895 | Print at a specific location on the screen.\r | |
2896 | \r | |
e2f8297f | 2897 | This function will move the cursor to a given screen location and print the specified string.\r |
1e6e84c7 | 2898 | \r |
2899 | If -1 is specified for either the Row or Col the current screen location for BOTH\r | |
e2f8297f | 2900 | will be used.\r |
2247dde4 | 2901 | \r |
e2f8297f | 2902 | If either Row or Col is out of range for the current console, then ASSERT.\r |
2903 | If Format is NULL, then ASSERT.\r | |
2247dde4 | 2904 | \r |
1e6e84c7 | 2905 | In addition to the standard %-based flags as supported by UefiLib Print() this supports\r |
2247dde4 | 2906 | the following additional flags:\r |
1e6e84c7 | 2907 | %N - Set output attribute to normal.\r |
2908 | %H - Set output attribute to highlight.\r | |
2909 | %E - Set output attribute to error.\r | |
2910 | %B - Set output attribute to blue color.\r | |
2911 | %V - Set output attribute to green color.\r | |
2247dde4 | 2912 | \r |
2913 | Note: The background color is controlled by the shell command cls.\r | |
2914 | \r | |
1e6e84c7 | 2915 | @param[in] Col The column to print at.\r |
a405b86d | 2916 | @param[in] Row The row to print at.\r |
1e6e84c7 | 2917 | @param[in] Language The language of the string to retrieve. If this parameter\r |
2918 | is NULL, then the current platform language is used.\r | |
2919 | @param[in] HiiFormatStringId The format string Id for getting from Hii.\r | |
2920 | @param[in] HiiFormatHandle The format string Handle for getting from Hii.\r | |
a405b86d | 2921 | @param[in] ... The variable argument list.\r |
2247dde4 | 2922 | \r |
a405b86d | 2923 | @return EFI_SUCCESS The printing was successful.\r |
2924 | @return EFI_DEVICE_ERROR The console device reported an error.\r | |
2247dde4 | 2925 | **/\r |
a405b86d | 2926 | EFI_STATUS\r |
2247dde4 | 2927 | EFIAPI\r |
2928 | ShellPrintHiiEx(\r | |
2929 | IN INT32 Col OPTIONAL,\r | |
2930 | IN INT32 Row OPTIONAL,\r | |
1e6e84c7 | 2931 | IN CONST CHAR8 *Language OPTIONAL,\r |
2247dde4 | 2932 | IN CONST EFI_STRING_ID HiiFormatStringId,\r |
2933 | IN CONST EFI_HANDLE HiiFormatHandle,\r | |
2934 | ...\r | |
2935 | )\r | |
2936 | {\r | |
2937 | VA_LIST Marker;\r | |
2938 | CHAR16 *HiiFormatString;\r | |
a405b86d | 2939 | EFI_STATUS RetVal;\r |
2247dde4 | 2940 | \r |
2941 | VA_START (Marker, HiiFormatHandle);\r | |
1e6e84c7 | 2942 | HiiFormatString = HiiGetString(HiiFormatHandle, HiiFormatStringId, Language);\r |
2247dde4 | 2943 | ASSERT(HiiFormatString != NULL);\r |
2944 | \r | |
2945 | RetVal = InternalShellPrintWorker(Col, Row, HiiFormatString, Marker);\r | |
2946 | \r | |
a405b86d | 2947 | SHELL_FREE_NON_NULL(HiiFormatString);\r |
e2f8297f | 2948 | VA_END(Marker);\r |
2247dde4 | 2949 | \r |
2950 | return (RetVal);\r | |
2951 | }\r | |
2952 | \r | |
2953 | /**\r | |
2954 | Function to determine if a given filename represents a file or a directory.\r | |
2955 | \r | |
2956 | @param[in] DirName Path to directory to test.\r | |
2957 | \r | |
c8c22591 | 2958 | @retval EFI_SUCCESS The Path represents a directory\r |
2959 | @retval EFI_NOT_FOUND The Path does not represent a directory\r | |
2960 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r | |
2961 | @return The path failed to open\r | |
2247dde4 | 2962 | **/\r |
2963 | EFI_STATUS\r | |
2964 | EFIAPI\r | |
2965 | ShellIsDirectory(\r | |
2966 | IN CONST CHAR16 *DirName\r | |
2967 | )\r | |
2968 | {\r | |
2969 | EFI_STATUS Status;\r | |
a405b86d | 2970 | SHELL_FILE_HANDLE Handle;\r |
3e082d58 | 2971 | CHAR16 *TempLocation;\r |
2972 | CHAR16 *TempLocation2;\r | |
2247dde4 | 2973 | \r |
ecd3d59f | 2974 | ASSERT(DirName != NULL);\r |
2975 | \r | |
a405b86d | 2976 | Handle = NULL;\r |
2977 | TempLocation = NULL;\r | |
2247dde4 | 2978 | \r |
2979 | Status = ShellOpenFileByName(DirName, &Handle, EFI_FILE_MODE_READ, 0);\r | |
2980 | if (EFI_ERROR(Status)) {\r | |
a405b86d | 2981 | //\r |
2982 | // try good logic first.\r | |
2983 | //\r | |
366f81a0 | 2984 | if (gEfiShellProtocol != NULL) {\r |
3e082d58 | 2985 | TempLocation = StrnCatGrow(&TempLocation, NULL, DirName, 0);\r |
c8c22591 | 2986 | if (TempLocation == NULL) {\r |
2987 | ShellCloseFile(&Handle);\r | |
2988 | return (EFI_OUT_OF_RESOURCES);\r | |
2989 | }\r | |
3e082d58 | 2990 | TempLocation2 = StrStr(TempLocation, L":");\r |
2991 | if (TempLocation2 != NULL && StrLen(StrStr(TempLocation, L":")) == 2) {\r | |
2992 | *(TempLocation2+1) = CHAR_NULL;\r | |
a405b86d | 2993 | }\r |
366f81a0 | 2994 | if (gEfiShellProtocol->GetDevicePathFromMap(TempLocation) != NULL) {\r |
a405b86d | 2995 | FreePool(TempLocation);\r |
2996 | return (EFI_SUCCESS);\r | |
2997 | }\r | |
2998 | FreePool(TempLocation);\r | |
2999 | } else {\r | |
3000 | //\r | |
3001 | // probably a map name?!?!!?\r | |
3002 | //\r | |
3003 | TempLocation = StrStr(DirName, L"\\");\r | |
3004 | if (TempLocation != NULL && *(TempLocation+1) == CHAR_NULL) {\r | |
3005 | return (EFI_SUCCESS);\r | |
3006 | }\r | |
3007 | }\r | |
2247dde4 | 3008 | return (Status);\r |
3009 | }\r | |
3010 | \r | |
3011 | if (FileHandleIsDirectory(Handle) == EFI_SUCCESS) {\r | |
3012 | ShellCloseFile(&Handle);\r | |
3013 | return (EFI_SUCCESS);\r | |
3014 | }\r | |
3015 | ShellCloseFile(&Handle);\r | |
3016 | return (EFI_NOT_FOUND);\r | |
3017 | }\r | |
3018 | \r | |
36a9d672 | 3019 | /**\r |
3020 | Function to determine if a given filename represents a file.\r | |
3021 | \r | |
3022 | @param[in] Name Path to file to test.\r | |
3023 | \r | |
3024 | @retval EFI_SUCCESS The Path represents a file.\r | |
3025 | @retval EFI_NOT_FOUND The Path does not represent a file.\r | |
3026 | @retval other The path failed to open.\r | |
3027 | **/\r | |
3028 | EFI_STATUS\r | |
3029 | EFIAPI\r | |
3030 | ShellIsFile(\r | |
3031 | IN CONST CHAR16 *Name\r | |
3032 | )\r | |
3033 | {\r | |
3034 | EFI_STATUS Status;\r | |
a405b86d | 3035 | SHELL_FILE_HANDLE Handle;\r |
36a9d672 | 3036 | \r |
ecd3d59f | 3037 | ASSERT(Name != NULL);\r |
3038 | \r | |
36a9d672 | 3039 | Handle = NULL;\r |
3040 | \r | |
3041 | Status = ShellOpenFileByName(Name, &Handle, EFI_FILE_MODE_READ, 0);\r | |
3042 | if (EFI_ERROR(Status)) {\r | |
3043 | return (Status);\r | |
3044 | }\r | |
3045 | \r | |
3046 | if (FileHandleIsDirectory(Handle) != EFI_SUCCESS) {\r | |
3047 | ShellCloseFile(&Handle);\r | |
3048 | return (EFI_SUCCESS);\r | |
3049 | }\r | |
3050 | ShellCloseFile(&Handle);\r | |
3051 | return (EFI_NOT_FOUND);\r | |
3052 | }\r | |
3053 | \r | |
b3011f40 | 3054 | /**\r |
3055 | Function to determine if a given filename represents a file.\r | |
3056 | \r | |
3057 | This will search the CWD and then the Path.\r | |
3058 | \r | |
3059 | If Name is NULL, then ASSERT.\r | |
3060 | \r | |
3061 | @param[in] Name Path to file to test.\r | |
3062 | \r | |
3063 | @retval EFI_SUCCESS The Path represents a file.\r | |
3064 | @retval EFI_NOT_FOUND The Path does not represent a file.\r | |
3065 | @retval other The path failed to open.\r | |
3066 | **/\r | |
3067 | EFI_STATUS\r | |
3068 | EFIAPI\r | |
3069 | ShellIsFileInPath(\r | |
3070 | IN CONST CHAR16 *Name\r | |
a405b86d | 3071 | )\r |
3072 | {\r | |
b3011f40 | 3073 | CHAR16 *NewName;\r |
3074 | EFI_STATUS Status;\r | |
3075 | \r | |
3076 | if (!EFI_ERROR(ShellIsFile(Name))) {\r | |
a405b86d | 3077 | return (EFI_SUCCESS);\r |
b3011f40 | 3078 | }\r |
3079 | \r | |
3080 | NewName = ShellFindFilePath(Name);\r | |
3081 | if (NewName == NULL) {\r | |
3082 | return (EFI_NOT_FOUND);\r | |
3083 | }\r | |
3084 | Status = ShellIsFile(NewName);\r | |
3085 | FreePool(NewName);\r | |
3086 | return (Status);\r | |
3087 | }\r | |
252d9457 | 3088 | \r |
74b0fb8c JC |
3089 | /**\r |
3090 | Function return the number converted from a hex representation of a number.\r | |
3091 | \r | |
3092 | Note: this function cannot be used when (UINTN)(-1), (0xFFFFFFFF) may be a valid\r | |
3093 | result. Use ShellConvertStringToUint64 instead.\r | |
3094 | \r | |
3095 | @param[in] String String representation of a number.\r | |
3096 | \r | |
3097 | @return The unsigned integer result of the conversion.\r | |
3098 | @retval (UINTN)(-1) An error occured.\r | |
3099 | **/\r | |
3100 | UINTN\r | |
3101 | EFIAPI\r | |
3102 | ShellHexStrToUintn(\r | |
3103 | IN CONST CHAR16 *String\r | |
3104 | )\r | |
3105 | {\r | |
3106 | UINT64 RetVal;\r | |
3107 | \r | |
3108 | if (!EFI_ERROR(ShellConvertStringToUint64(String, &RetVal, TRUE, TRUE))) {\r | |
3109 | return ((UINTN)RetVal);\r | |
3110 | }\r | |
3111 | \r | |
3112 | return ((UINTN)(-1));\r | |
3113 | }\r | |
3114 | \r | |
125c2cf4 | 3115 | /**\r |
1e6e84c7 | 3116 | Function to determine whether a string is decimal or hex representation of a number\r |
d59fc244 | 3117 | and return the number converted from the string. Spaces are always skipped.\r |
125c2cf4 | 3118 | \r |
3119 | @param[in] String String representation of a number\r | |
3120 | \r | |
252d9457 | 3121 | @return the number\r |
3122 | @retval (UINTN)(-1) An error ocurred.\r | |
125c2cf4 | 3123 | **/\r |
3124 | UINTN\r | |
3125 | EFIAPI\r | |
3126 | ShellStrToUintn(\r | |
3127 | IN CONST CHAR16 *String\r | |
3128 | )\r | |
3129 | {\r | |
252d9457 | 3130 | UINT64 RetVal;\r |
3131 | BOOLEAN Hex;\r | |
3132 | \r | |
3133 | Hex = FALSE;\r | |
3134 | \r | |
3135 | if (!InternalShellIsHexOrDecimalNumber(String, Hex, TRUE)) {\r | |
3136 | Hex = TRUE;\r | |
125c2cf4 | 3137 | }\r |
252d9457 | 3138 | \r |
3139 | if (!EFI_ERROR(ShellConvertStringToUint64(String, &RetVal, Hex, TRUE))) {\r | |
3140 | return ((UINTN)RetVal);\r | |
3141 | }\r | |
3142 | return ((UINTN)(-1));\r | |
125c2cf4 | 3143 | }\r |
3144 | \r | |
3145 | /**\r | |
3146 | Safely append with automatic string resizing given length of Destination and\r | |
3147 | desired length of copy from Source.\r | |
3148 | \r | |
3149 | append the first D characters of Source to the end of Destination, where D is\r | |
3150 | the lesser of Count and the StrLen() of Source. If appending those D characters\r | |
3151 | will fit within Destination (whose Size is given as CurrentSize) and\r | |
1e6e84c7 | 3152 | still leave room for a NULL terminator, then those characters are appended,\r |
3153 | starting at the original terminating NULL of Destination, and a new terminating\r | |
3154 | NULL is appended.\r | |
125c2cf4 | 3155 | \r |
3156 | If appending D characters onto Destination will result in a overflow of the size\r | |
3157 | given in CurrentSize the string will be grown such that the copy can be performed\r | |
3158 | and CurrentSize will be updated to the new size.\r | |
3159 | \r | |
3160 | If Source is NULL, there is nothing to append, just return the current buffer in\r | |
3161 | Destination.\r | |
3162 | \r | |
3163 | if Destination is NULL, then ASSERT()\r | |
3164 | if Destination's current length (including NULL terminator) is already more then\r | |
3165 | CurrentSize, then ASSERT()\r | |
3166 | \r | |
4ff7e37b ED |
3167 | @param[in, out] Destination The String to append onto\r |
3168 | @param[in, out] CurrentSize on call the number of bytes in Destination. On\r | |
125c2cf4 | 3169 | return possibly the new size (still in bytes). if NULL\r |
3170 | then allocate whatever is needed.\r | |
3171 | @param[in] Source The String to append from\r | |
3172 | @param[in] Count Maximum number of characters to append. if 0 then\r | |
3173 | all are appended.\r | |
3174 | \r | |
3175 | @return Destination return the resultant string.\r | |
3176 | **/\r | |
3177 | CHAR16*\r | |
3178 | EFIAPI\r | |
3179 | StrnCatGrow (\r | |
3180 | IN OUT CHAR16 **Destination,\r | |
3181 | IN OUT UINTN *CurrentSize,\r | |
3182 | IN CONST CHAR16 *Source,\r | |
3183 | IN UINTN Count\r | |
3184 | )\r | |
3185 | {\r | |
3186 | UINTN DestinationStartSize;\r | |
3187 | UINTN NewSize;\r | |
3188 | \r | |
3189 | //\r | |
3190 | // ASSERTs\r | |
3191 | //\r | |
3192 | ASSERT(Destination != NULL);\r | |
3193 | \r | |
3194 | //\r | |
3195 | // If there's nothing to do then just return Destination\r | |
3196 | //\r | |
3197 | if (Source == NULL) {\r | |
3198 | return (*Destination);\r | |
3199 | }\r | |
3200 | \r | |
3201 | //\r | |
3202 | // allow for un-initialized pointers, based on size being 0\r | |
3203 | //\r | |
3204 | if (CurrentSize != NULL && *CurrentSize == 0) {\r | |
3205 | *Destination = NULL;\r | |
3206 | }\r | |
3207 | \r | |
3208 | //\r | |
3209 | // allow for NULL pointers address as Destination\r | |
3210 | //\r | |
3211 | if (*Destination != NULL) {\r | |
3212 | ASSERT(CurrentSize != 0);\r | |
3213 | DestinationStartSize = StrSize(*Destination);\r | |
3214 | ASSERT(DestinationStartSize <= *CurrentSize);\r | |
3215 | } else {\r | |
3216 | DestinationStartSize = 0;\r | |
3217 | // ASSERT(*CurrentSize == 0);\r | |
3218 | }\r | |
3219 | \r | |
3220 | //\r | |
3221 | // Append all of Source?\r | |
3222 | //\r | |
3223 | if (Count == 0) {\r | |
3224 | Count = StrLen(Source);\r | |
3225 | }\r | |
3226 | \r | |
3227 | //\r | |
3228 | // Test and grow if required\r | |
3229 | //\r | |
3230 | if (CurrentSize != NULL) {\r | |
3231 | NewSize = *CurrentSize;\r | |
f480fdc0 ED |
3232 | if (NewSize < DestinationStartSize + (Count * sizeof(CHAR16))) {\r |
3233 | while (NewSize < (DestinationStartSize + (Count*sizeof(CHAR16)))) {\r | |
3234 | NewSize += 2 * Count * sizeof(CHAR16);\r | |
3235 | }\r | |
3236 | *Destination = ReallocatePool(*CurrentSize, NewSize, *Destination);\r | |
3237 | *CurrentSize = NewSize;\r | |
125c2cf4 | 3238 | }\r |
125c2cf4 | 3239 | } else {\r |
3240 | *Destination = AllocateZeroPool((Count+1)*sizeof(CHAR16));\r | |
3241 | }\r | |
3242 | \r | |
3243 | //\r | |
3244 | // Now use standard StrnCat on a big enough buffer\r | |
3245 | //\r | |
c9d92df0 | 3246 | if (*Destination == NULL) {\r |
3247 | return (NULL);\r | |
3248 | }\r | |
125c2cf4 | 3249 | return StrnCat(*Destination, Source, Count);\r |
3250 | }\r | |
c9d92df0 | 3251 | \r |
3252 | /**\r | |
3253 | Prompt the user and return the resultant answer to the requestor.\r | |
3254 | \r | |
3255 | This function will display the requested question on the shell prompt and then\r | |
3256 | wait for an apropriate answer to be input from the console.\r | |
3257 | \r | |
a405b86d | 3258 | if the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue\r |
c9d92df0 | 3259 | or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.\r |
3260 | \r | |
a405b86d | 3261 | if the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type\r |
c9d92df0 | 3262 | CHAR16*.\r |
3263 | \r | |
3264 | In either case *Response must be callee freed if Response was not NULL;\r | |
3265 | \r | |
3266 | @param Type What type of question is asked. This is used to filter the input\r | |
3267 | to prevent invalid answers to question.\r | |
3268 | @param Prompt Pointer to string prompt to use to request input.\r | |
3269 | @param Response Pointer to Response which will be populated upon return.\r | |
3270 | \r | |
3271 | @retval EFI_SUCCESS The operation was sucessful.\r | |
3272 | @retval EFI_UNSUPPORTED The operation is not supported as requested.\r | |
3273 | @retval EFI_INVALID_PARAMETER A parameter was invalid.\r | |
3274 | @return other The operation failed.\r | |
3275 | **/\r | |
3276 | EFI_STATUS\r | |
3277 | EFIAPI\r | |
3278 | ShellPromptForResponse (\r | |
3279 | IN SHELL_PROMPT_REQUEST_TYPE Type,\r | |
3280 | IN CHAR16 *Prompt OPTIONAL,\r | |
3281 | IN OUT VOID **Response OPTIONAL\r | |
3282 | )\r | |
3283 | {\r | |
3284 | EFI_STATUS Status;\r | |
3285 | EFI_INPUT_KEY Key;\r | |
3286 | UINTN EventIndex;\r | |
3287 | SHELL_PROMPT_RESPONSE *Resp;\r | |
a405b86d | 3288 | UINTN Size;\r |
3289 | CHAR16 *Buffer;\r | |
c9d92df0 | 3290 | \r |
a405b86d | 3291 | Status = EFI_UNSUPPORTED;\r |
3292 | Resp = NULL;\r | |
3293 | Buffer = NULL;\r | |
3294 | Size = 0;\r | |
3295 | if (Type != ShellPromptResponseTypeFreeform) {\r | |
252d9457 | 3296 | Resp = (SHELL_PROMPT_RESPONSE*)AllocateZeroPool(sizeof(SHELL_PROMPT_RESPONSE));\r |
3e082d58 | 3297 | if (Resp == NULL) {\r |
3298 | return (EFI_OUT_OF_RESOURCES);\r | |
3299 | }\r | |
90bfa227 | 3300 | }\r |
c9d92df0 | 3301 | \r |
3302 | switch(Type) {\r | |
a405b86d | 3303 | case ShellPromptResponseTypeQuitContinue:\r |
c9d92df0 | 3304 | if (Prompt != NULL) {\r |
3305 | ShellPrintEx(-1, -1, L"%s", Prompt);\r | |
3306 | }\r | |
3307 | //\r | |
3308 | // wait for valid response\r | |
3309 | //\r | |
3310 | gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r | |
3311 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r | |
31b018a6 JC |
3312 | if (EFI_ERROR(Status)) {\r |
3313 | break;\r | |
3314 | }\r | |
c9d92df0 | 3315 | ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r |
3316 | if (Key.UnicodeChar == L'Q' || Key.UnicodeChar ==L'q') {\r | |
a405b86d | 3317 | *Resp = ShellPromptResponseQuit;\r |
c9d92df0 | 3318 | } else {\r |
a405b86d | 3319 | *Resp = ShellPromptResponseContinue;\r |
c9d92df0 | 3320 | }\r |
3321 | break;\r | |
a405b86d | 3322 | case ShellPromptResponseTypeYesNoCancel:\r |
c9d92df0 | 3323 | if (Prompt != NULL) {\r |
3324 | ShellPrintEx(-1, -1, L"%s", Prompt);\r | |
3325 | }\r | |
3326 | //\r | |
3327 | // wait for valid response\r | |
3328 | //\r | |
a405b86d | 3329 | *Resp = ShellPromptResponseMax;\r |
3330 | while (*Resp == ShellPromptResponseMax) {\r | |
194ae48d JC |
3331 | if (ShellGetExecutionBreakFlag()) {\r |
3332 | Status = EFI_ABORTED;\r | |
3333 | break;\r | |
3334 | }\r | |
c9d92df0 | 3335 | gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r |
3336 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r | |
31b018a6 JC |
3337 | if (EFI_ERROR(Status)) {\r |
3338 | break;\r | |
3339 | }\r | |
c9d92df0 | 3340 | ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r |
3341 | switch (Key.UnicodeChar) {\r | |
3342 | case L'Y':\r | |
3343 | case L'y':\r | |
a405b86d | 3344 | *Resp = ShellPromptResponseYes;\r |
c9d92df0 | 3345 | break;\r |
3346 | case L'N':\r | |
3347 | case L'n':\r | |
a405b86d | 3348 | *Resp = ShellPromptResponseNo;\r |
3349 | break;\r | |
3350 | case L'C':\r | |
3351 | case L'c':\r | |
3352 | *Resp = ShellPromptResponseCancel;\r | |
3353 | break;\r | |
3354 | }\r | |
3355 | }\r | |
3356 | break; case ShellPromptResponseTypeYesNoAllCancel:\r | |
3357 | if (Prompt != NULL) {\r | |
3358 | ShellPrintEx(-1, -1, L"%s", Prompt);\r | |
3359 | }\r | |
3360 | //\r | |
3361 | // wait for valid response\r | |
3362 | //\r | |
3363 | *Resp = ShellPromptResponseMax;\r | |
3364 | while (*Resp == ShellPromptResponseMax) {\r | |
194ae48d JC |
3365 | if (ShellGetExecutionBreakFlag()) {\r |
3366 | Status = EFI_ABORTED;\r | |
3367 | break;\r | |
3368 | }\r | |
a405b86d | 3369 | gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r |
3370 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r | |
31b018a6 JC |
3371 | if (EFI_ERROR(Status)) {\r |
3372 | break;\r | |
3373 | }\r | |
a405b86d | 3374 | ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r |
3375 | switch (Key.UnicodeChar) {\r | |
3376 | case L'Y':\r | |
3377 | case L'y':\r | |
3378 | *Resp = ShellPromptResponseYes;\r | |
3379 | break;\r | |
3380 | case L'N':\r | |
3381 | case L'n':\r | |
3382 | *Resp = ShellPromptResponseNo;\r | |
c9d92df0 | 3383 | break;\r |
3384 | case L'A':\r | |
3385 | case L'a':\r | |
a405b86d | 3386 | *Resp = ShellPromptResponseAll;\r |
c9d92df0 | 3387 | break;\r |
3388 | case L'C':\r | |
3389 | case L'c':\r | |
a405b86d | 3390 | *Resp = ShellPromptResponseCancel;\r |
c9d92df0 | 3391 | break;\r |
3392 | }\r | |
3393 | }\r | |
3394 | break;\r | |
a405b86d | 3395 | case ShellPromptResponseTypeEnterContinue:\r |
3396 | case ShellPromptResponseTypeAnyKeyContinue:\r | |
c9d92df0 | 3397 | if (Prompt != NULL) {\r |
3398 | ShellPrintEx(-1, -1, L"%s", Prompt);\r | |
3399 | }\r | |
3400 | //\r | |
3401 | // wait for valid response\r | |
3402 | //\r | |
a405b86d | 3403 | *Resp = ShellPromptResponseMax;\r |
3404 | while (*Resp == ShellPromptResponseMax) {\r | |
194ae48d JC |
3405 | if (ShellGetExecutionBreakFlag()) {\r |
3406 | Status = EFI_ABORTED;\r | |
3407 | break;\r | |
3408 | }\r | |
c9d92df0 | 3409 | gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r |
a405b86d | 3410 | if (Type == ShellPromptResponseTypeEnterContinue) {\r |
c9d92df0 | 3411 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r |
31b018a6 JC |
3412 | if (EFI_ERROR(Status)) {\r |
3413 | break;\r | |
3414 | }\r | |
c9d92df0 | 3415 | ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r |
3416 | if (Key.UnicodeChar == CHAR_CARRIAGE_RETURN) {\r | |
a405b86d | 3417 | *Resp = ShellPromptResponseContinue;\r |
c9d92df0 | 3418 | break;\r |
3419 | }\r | |
3420 | }\r | |
a405b86d | 3421 | if (Type == ShellPromptResponseTypeAnyKeyContinue) {\r |
3422 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r | |
3423 | ASSERT_EFI_ERROR(Status);\r | |
3424 | *Resp = ShellPromptResponseContinue;\r | |
3425 | break;\r | |
3426 | }\r | |
3427 | }\r | |
3428 | break;\r | |
3429 | case ShellPromptResponseTypeYesNo:\r | |
3430 | if (Prompt != NULL) {\r | |
3431 | ShellPrintEx(-1, -1, L"%s", Prompt);\r | |
3432 | }\r | |
3433 | //\r | |
3434 | // wait for valid response\r | |
3435 | //\r | |
3436 | *Resp = ShellPromptResponseMax;\r | |
3437 | while (*Resp == ShellPromptResponseMax) {\r | |
194ae48d JC |
3438 | if (ShellGetExecutionBreakFlag()) {\r |
3439 | Status = EFI_ABORTED;\r | |
3440 | break;\r | |
3441 | }\r | |
a405b86d | 3442 | gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r |
3443 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r | |
31b018a6 JC |
3444 | if (EFI_ERROR(Status)) {\r |
3445 | break;\r | |
3446 | }\r | |
a405b86d | 3447 | ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r |
3448 | switch (Key.UnicodeChar) {\r | |
3449 | case L'Y':\r | |
3450 | case L'y':\r | |
3451 | *Resp = ShellPromptResponseYes;\r | |
3452 | break;\r | |
3453 | case L'N':\r | |
3454 | case L'n':\r | |
3455 | *Resp = ShellPromptResponseNo;\r | |
3456 | break;\r | |
3457 | }\r | |
3458 | }\r | |
3459 | break;\r | |
3460 | case ShellPromptResponseTypeFreeform:\r | |
3461 | if (Prompt != NULL) {\r | |
3462 | ShellPrintEx(-1, -1, L"%s", Prompt);\r | |
3463 | }\r | |
3464 | while(1) {\r | |
194ae48d JC |
3465 | if (ShellGetExecutionBreakFlag()) {\r |
3466 | Status = EFI_ABORTED;\r | |
3467 | break;\r | |
3468 | }\r | |
a405b86d | 3469 | gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r |
3470 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r | |
31b018a6 JC |
3471 | if (EFI_ERROR(Status)) {\r |
3472 | break;\r | |
3473 | }\r | |
a405b86d | 3474 | ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r |
3475 | if (Key.UnicodeChar == CHAR_CARRIAGE_RETURN) {\r | |
c9d92df0 | 3476 | break;\r |
3477 | }\r | |
a405b86d | 3478 | ASSERT((Buffer == NULL && Size == 0) || (Buffer != NULL));\r |
3479 | StrnCatGrow(&Buffer, &Size, &Key.UnicodeChar, 1);\r | |
c9d92df0 | 3480 | }\r |
3481 | break;\r | |
a405b86d | 3482 | //\r |
3483 | // This is the location to add new prompt types.\r | |
194ae48d | 3484 | // If your new type loops remember to add ExecutionBreak support.\r |
a405b86d | 3485 | //\r |
c9d92df0 | 3486 | default:\r |
a405b86d | 3487 | ASSERT(FALSE);\r |
c9d92df0 | 3488 | }\r |
3489 | \r | |
3490 | if (Response != NULL) {\r | |
a405b86d | 3491 | if (Resp != NULL) {\r |
3492 | *Response = Resp;\r | |
3493 | } else if (Buffer != NULL) {\r | |
3494 | *Response = Buffer;\r | |
3495 | }\r | |
c9d92df0 | 3496 | } else {\r |
a405b86d | 3497 | if (Resp != NULL) {\r |
3498 | FreePool(Resp);\r | |
3499 | }\r | |
3500 | if (Buffer != NULL) {\r | |
3501 | FreePool(Buffer);\r | |
3502 | }\r | |
c9d92df0 | 3503 | }\r |
3504 | \r | |
a405b86d | 3505 | ShellPrintEx(-1, -1, L"\r\n");\r |
c9d92df0 | 3506 | return (Status);\r |
3507 | }\r | |
3508 | \r | |
3509 | /**\r | |
3510 | Prompt the user and return the resultant answer to the requestor.\r | |
3511 | \r | |
3512 | This function is the same as ShellPromptForResponse, except that the prompt is\r | |
3513 | automatically pulled from HII.\r | |
3514 | \r | |
3515 | @param Type What type of question is asked. This is used to filter the input\r | |
3516 | to prevent invalid answers to question.\r | |
a405b86d | 3517 | @param[in] HiiFormatStringId The format string Id for getting from Hii.\r |
3518 | @param[in] HiiFormatHandle The format string Handle for getting from Hii.\r | |
3519 | @param Response Pointer to Response which will be populated upon return.\r | |
c9d92df0 | 3520 | \r |
3521 | @retval EFI_SUCCESS the operation was sucessful.\r | |
3522 | @return other the operation failed.\r | |
3523 | \r | |
3524 | @sa ShellPromptForResponse\r | |
3525 | **/\r | |
3526 | EFI_STATUS\r | |
3527 | EFIAPI\r | |
3528 | ShellPromptForResponseHii (\r | |
3529 | IN SHELL_PROMPT_REQUEST_TYPE Type,\r | |
3530 | IN CONST EFI_STRING_ID HiiFormatStringId,\r | |
3531 | IN CONST EFI_HANDLE HiiFormatHandle,\r | |
3532 | IN OUT VOID **Response\r | |
3533 | )\r | |
3534 | {\r | |
3535 | CHAR16 *Prompt;\r | |
3536 | EFI_STATUS Status;\r | |
3537 | \r | |
3538 | Prompt = HiiGetString(HiiFormatHandle, HiiFormatStringId, NULL);\r | |
3539 | Status = ShellPromptForResponse(Type, Prompt, Response);\r | |
3540 | FreePool(Prompt);\r | |
3541 | return (Status);\r | |
3542 | }\r | |
3543 | \r | |
a405b86d | 3544 | /**\r |
3545 | Function to determin if an entire string is a valid number.\r | |
3546 | \r | |
3547 | If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.\r | |
c9d92df0 | 3548 | \r |
a405b86d | 3549 | @param[in] String The string to evaluate.\r |
3550 | @param[in] ForceHex TRUE - always assume hex.\r | |
3551 | @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.\r | |
3552 | \r | |
3553 | @retval TRUE It is all numeric (dec/hex) characters.\r | |
3554 | @retval FALSE There is a non-numeric character.\r | |
3555 | **/\r | |
3556 | BOOLEAN\r | |
3557 | EFIAPI\r | |
252d9457 | 3558 | InternalShellIsHexOrDecimalNumber (\r |
a405b86d | 3559 | IN CONST CHAR16 *String,\r |
3560 | IN CONST BOOLEAN ForceHex,\r | |
3561 | IN CONST BOOLEAN StopAtSpace\r | |
3562 | )\r | |
3563 | {\r | |
3564 | BOOLEAN Hex;\r | |
3565 | \r | |
3566 | //\r | |
3567 | // chop off a single negative sign\r | |
3568 | //\r | |
3569 | if (String != NULL && *String == L'-') {\r | |
3570 | String++;\r | |
3571 | }\r | |
b0934ac4 | 3572 | \r |
a405b86d | 3573 | if (String == NULL) {\r |
3574 | return (FALSE);\r | |
3575 | }\r | |
3576 | \r | |
3577 | //\r | |
3578 | // chop leading zeroes\r | |
3579 | //\r | |
3580 | while(String != NULL && *String == L'0'){\r | |
3581 | String++;\r | |
3582 | }\r | |
3583 | //\r | |
3584 | // allow '0x' or '0X', but not 'x' or 'X'\r | |
3585 | //\r | |
3586 | if (String != NULL && (*String == L'x' || *String == L'X')) {\r | |
3587 | if (*(String-1) != L'0') {\r | |
3588 | //\r | |
3589 | // we got an x without a preceeding 0\r | |
3590 | //\r | |
3591 | return (FALSE);\r | |
3592 | }\r | |
3593 | String++;\r | |
3594 | Hex = TRUE;\r | |
3595 | } else if (ForceHex) {\r | |
3596 | Hex = TRUE;\r | |
3597 | } else {\r | |
3598 | Hex = FALSE;\r | |
3599 | }\r | |
3600 | \r | |
3601 | //\r | |
3602 | // loop through the remaining characters and use the lib function\r | |
3603 | //\r | |
3604 | for ( ; String != NULL && *String != CHAR_NULL && !(StopAtSpace && *String == L' ') ; String++){\r | |
3605 | if (Hex) {\r | |
3606 | if (!ShellIsHexaDecimalDigitCharacter(*String)) {\r | |
3607 | return (FALSE);\r | |
3608 | }\r | |
3609 | } else {\r | |
3610 | if (!ShellIsDecimalDigitCharacter(*String)) {\r | |
3611 | return (FALSE);\r | |
3612 | }\r | |
3613 | }\r | |
3614 | }\r | |
252d9457 | 3615 | \r |
a405b86d | 3616 | return (TRUE);\r |
3617 | }\r | |
3618 | \r | |
3619 | /**\r | |
3620 | Function to determine if a given filename exists.\r | |
3621 | \r | |
3622 | @param[in] Name Path to test.\r | |
3623 | \r | |
3624 | @retval EFI_SUCCESS The Path represents a file.\r | |
3625 | @retval EFI_NOT_FOUND The Path does not represent a file.\r | |
3626 | @retval other The path failed to open.\r | |
3627 | **/\r | |
3628 | EFI_STATUS\r | |
3629 | EFIAPI\r | |
3630 | ShellFileExists(\r | |
3631 | IN CONST CHAR16 *Name\r | |
3632 | )\r | |
3633 | {\r | |
3634 | EFI_STATUS Status;\r | |
3635 | EFI_SHELL_FILE_INFO *List;\r | |
3636 | \r | |
3637 | ASSERT(Name != NULL);\r | |
3638 | \r | |
3639 | List = NULL;\r | |
3640 | Status = ShellOpenFileMetaArg((CHAR16*)Name, EFI_FILE_MODE_READ, &List);\r | |
3641 | if (EFI_ERROR(Status)) {\r | |
3642 | return (Status);\r | |
3643 | }\r | |
3644 | \r | |
3645 | ShellCloseFileMetaArg(&List);\r | |
3646 | \r | |
3647 | return (EFI_SUCCESS);\r | |
3648 | }\r | |
252d9457 | 3649 | \r |
3650 | /**\r | |
b0934ac4 | 3651 | Convert a Unicode character to upper case only if\r |
252d9457 | 3652 | it maps to a valid small-case ASCII character.\r |
3653 | \r | |
3654 | This internal function only deal with Unicode character\r | |
3655 | which maps to a valid small-case ASCII character, i.e.\r | |
3656 | L'a' to L'z'. For other Unicode character, the input character\r | |
3657 | is returned directly.\r | |
3658 | \r | |
3659 | @param Char The character to convert.\r | |
3660 | \r | |
3661 | @retval LowerCharacter If the Char is with range L'a' to L'z'.\r | |
3662 | @retval Unchanged Otherwise.\r | |
3663 | \r | |
3664 | **/\r | |
3665 | CHAR16\r | |
3666 | EFIAPI\r | |
3667 | InternalShellCharToUpper (\r | |
3668 | IN CHAR16 Char\r | |
3669 | )\r | |
3670 | {\r | |
3671 | if (Char >= L'a' && Char <= L'z') {\r | |
3672 | return (CHAR16) (Char - (L'a' - L'A'));\r | |
3673 | }\r | |
3674 | \r | |
3675 | return Char;\r | |
3676 | }\r | |
3677 | \r | |
3678 | /**\r | |
3679 | Convert a Unicode character to numerical value.\r | |
3680 | \r | |
3681 | This internal function only deal with Unicode character\r | |
3682 | which maps to a valid hexadecimal ASII character, i.e.\r | |
b0934ac4 | 3683 | L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other\r |
252d9457 | 3684 | Unicode character, the value returned does not make sense.\r |
3685 | \r | |
3686 | @param Char The character to convert.\r | |
3687 | \r | |
3688 | @return The numerical value converted.\r | |
3689 | \r | |
3690 | **/\r | |
3691 | UINTN\r | |
3692 | EFIAPI\r | |
3693 | InternalShellHexCharToUintn (\r | |
3694 | IN CHAR16 Char\r | |
3695 | )\r | |
3696 | {\r | |
3697 | if (ShellIsDecimalDigitCharacter (Char)) {\r | |
3698 | return Char - L'0';\r | |
3699 | }\r | |
3700 | \r | |
3701 | return (UINTN) (10 + InternalShellCharToUpper (Char) - L'A');\r | |
3702 | }\r | |
3703 | \r | |
3704 | /**\r | |
3705 | Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.\r | |
3706 | \r | |
3707 | This function returns a value of type UINTN by interpreting the contents\r | |
3708 | of the Unicode string specified by String as a hexadecimal number.\r | |
3709 | The format of the input Unicode string String is:\r | |
3710 | \r | |
3711 | [spaces][zeros][x][hexadecimal digits].\r | |
3712 | \r | |
3713 | The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].\r | |
3714 | The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.\r | |
3715 | If "x" appears in the input string, it must be prefixed with at least one 0.\r | |
3716 | The function will ignore the pad space, which includes spaces or tab characters,\r | |
3717 | before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or\r | |
3718 | [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the\r | |
3719 | first valid hexadecimal digit. Then, the function stops at the first character that is\r | |
3720 | a not a valid hexadecimal character or NULL, whichever one comes first.\r | |
3721 | \r | |
3722 | If String has only pad spaces, then zero is returned.\r | |
3723 | If String has no leading pad spaces, leading zeros or valid hexadecimal digits,\r | |
3724 | then zero is returned.\r | |
3725 | \r | |
3726 | @param[in] String A pointer to a Null-terminated Unicode string.\r | |
3727 | @param[out] Value Upon a successful return the value of the conversion.\r | |
3728 | @param[in] StopAtSpace FALSE to skip spaces.\r | |
3729 | \r | |
3730 | @retval EFI_SUCCESS The conversion was successful.\r | |
3731 | @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.\r | |
3732 | @retval EFI_DEVICE_ERROR An overflow occured.\r | |
3733 | **/\r | |
3734 | EFI_STATUS\r | |
3735 | EFIAPI\r | |
3736 | InternalShellStrHexToUint64 (\r | |
3737 | IN CONST CHAR16 *String,\r | |
3738 | OUT UINT64 *Value,\r | |
3739 | IN CONST BOOLEAN StopAtSpace\r | |
3740 | )\r | |
3741 | {\r | |
3742 | UINT64 Result;\r | |
3743 | \r | |
3744 | if (String == NULL || StrSize(String) == 0 || Value == NULL) {\r | |
3745 | return (EFI_INVALID_PARAMETER);\r | |
3746 | }\r | |
b0934ac4 | 3747 | \r |
252d9457 | 3748 | //\r |
b0934ac4 | 3749 | // Ignore the pad spaces (space or tab)\r |
252d9457 | 3750 | //\r |
3751 | while ((*String == L' ') || (*String == L'\t')) {\r | |
3752 | String++;\r | |
3753 | }\r | |
3754 | \r | |
3755 | //\r | |
3756 | // Ignore leading Zeros after the spaces\r | |
3757 | //\r | |
3758 | while (*String == L'0') {\r | |
3759 | String++;\r | |
3760 | }\r | |
3761 | \r | |
3762 | if (InternalShellCharToUpper (*String) == L'X') {\r | |
3763 | if (*(String - 1) != L'0') {\r | |
3764 | return 0;\r | |
3765 | }\r | |
3766 | //\r | |
3767 | // Skip the 'X'\r | |
3768 | //\r | |
3769 | String++;\r | |
3770 | }\r | |
3771 | \r | |
3772 | Result = 0;\r | |
b0934ac4 | 3773 | \r |
252d9457 | 3774 | //\r |
12ea4694 | 3775 | // Skip spaces if requested\r |
252d9457 | 3776 | //\r |
12ea4694 ED |
3777 | while (StopAtSpace && *String == L' ') {\r |
3778 | String++;\r | |
252d9457 | 3779 | }\r |
b0934ac4 | 3780 | \r |
252d9457 | 3781 | while (ShellIsHexaDecimalDigitCharacter (*String)) {\r |
3782 | //\r | |
b0934ac4 | 3783 | // If the Hex Number represented by String overflows according\r |
252d9457 | 3784 | // to the range defined by UINTN, then ASSERT().\r |
3785 | //\r | |
3786 | if (!(Result <= (RShiftU64((((UINT64) ~0) - InternalShellHexCharToUintn (*String)), 4)))) {\r | |
3787 | // if (!(Result <= ((((UINT64) ~0) - InternalShellHexCharToUintn (*String)) >> 4))) {\r | |
3788 | return (EFI_DEVICE_ERROR);\r | |
3789 | }\r | |
3790 | \r | |
3791 | Result = (LShiftU64(Result, 4));\r | |
3792 | Result += InternalShellHexCharToUintn (*String);\r | |
3793 | String++;\r | |
3794 | \r | |
3795 | //\r | |
49bd498d | 3796 | // stop at spaces if requested\r |
252d9457 | 3797 | //\r |
49bd498d | 3798 | if (StopAtSpace && *String == L' ') {\r |
3799 | break;\r | |
252d9457 | 3800 | }\r |
3801 | }\r | |
3802 | \r | |
3803 | *Value = Result;\r | |
3804 | return (EFI_SUCCESS);\r | |
3805 | }\r | |
3806 | \r | |
3807 | /**\r | |
3808 | Convert a Null-terminated Unicode decimal string to a value of\r | |
3809 | type UINT64.\r | |
3810 | \r | |
3811 | This function returns a value of type UINT64 by interpreting the contents\r | |
3812 | of the Unicode string specified by String as a decimal number. The format\r | |
3813 | of the input Unicode string String is:\r | |
3814 | \r | |
3815 | [spaces] [decimal digits].\r | |
3816 | \r | |
3817 | The valid decimal digit character is in the range [0-9]. The\r | |
3818 | function will ignore the pad space, which includes spaces or\r | |
3819 | tab characters, before [decimal digits]. The running zero in the\r | |
3820 | beginning of [decimal digits] will be ignored. Then, the function\r | |
3821 | stops at the first character that is a not a valid decimal character\r | |
3822 | or a Null-terminator, whichever one comes first.\r | |
3823 | \r | |
3824 | If String has only pad spaces, then 0 is returned.\r | |
3825 | If String has no pad spaces or valid decimal digits,\r | |
3826 | then 0 is returned.\r | |
3827 | \r | |
3828 | @param[in] String A pointer to a Null-terminated Unicode string.\r | |
3829 | @param[out] Value Upon a successful return the value of the conversion.\r | |
3830 | @param[in] StopAtSpace FALSE to skip spaces.\r | |
3831 | \r | |
3832 | @retval EFI_SUCCESS The conversion was successful.\r | |
3833 | @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.\r | |
3834 | @retval EFI_DEVICE_ERROR An overflow occured.\r | |
3835 | **/\r | |
3836 | EFI_STATUS\r | |
3837 | EFIAPI\r | |
3838 | InternalShellStrDecimalToUint64 (\r | |
3839 | IN CONST CHAR16 *String,\r | |
3840 | OUT UINT64 *Value,\r | |
3841 | IN CONST BOOLEAN StopAtSpace\r | |
3842 | )\r | |
3843 | {\r | |
3844 | UINT64 Result;\r | |
3845 | \r | |
3846 | if (String == NULL || StrSize (String) == 0 || Value == NULL) {\r | |
3847 | return (EFI_INVALID_PARAMETER);\r | |
3848 | }\r | |
3849 | \r | |
3850 | //\r | |
3851 | // Ignore the pad spaces (space or tab)\r | |
3852 | //\r | |
3853 | while ((*String == L' ') || (*String == L'\t')) {\r | |
3854 | String++;\r | |
3855 | }\r | |
3856 | \r | |
3857 | //\r | |
3858 | // Ignore leading Zeros after the spaces\r | |
3859 | //\r | |
3860 | while (*String == L'0') {\r | |
3861 | String++;\r | |
3862 | }\r | |
3863 | \r | |
3864 | Result = 0;\r | |
3865 | \r | |
3866 | //\r | |
3867 | // Skip spaces if requested\r | |
3868 | //\r | |
3869 | while (StopAtSpace && *String == L' ') {\r | |
3870 | String++;\r | |
3871 | }\r | |
3872 | while (ShellIsDecimalDigitCharacter (*String)) {\r | |
3873 | //\r | |
b0934ac4 | 3874 | // If the number represented by String overflows according\r |
252d9457 | 3875 | // to the range defined by UINT64, then ASSERT().\r |
3876 | //\r | |
b0934ac4 | 3877 | \r |
252d9457 | 3878 | if (!(Result <= (DivU64x32((((UINT64) ~0) - (*String - L'0')),10)))) {\r |
3879 | return (EFI_DEVICE_ERROR);\r | |
3880 | }\r | |
3881 | \r | |
3882 | Result = MultU64x32(Result, 10) + (*String - L'0');\r | |
3883 | String++;\r | |
3884 | \r | |
3885 | //\r | |
3886 | // Stop at spaces if requested\r | |
3887 | //\r | |
3888 | if (StopAtSpace && *String == L' ') {\r | |
3889 | break;\r | |
3890 | }\r | |
3891 | }\r | |
3892 | \r | |
3893 | *Value = Result;\r | |
b0934ac4 | 3894 | \r |
252d9457 | 3895 | return (EFI_SUCCESS);\r |
3896 | }\r | |
3897 | \r | |
3898 | /**\r | |
3899 | Function to verify and convert a string to its numerical value.\r | |
3900 | \r | |
3901 | If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.\r | |
3902 | \r | |
3903 | @param[in] String The string to evaluate.\r | |
3904 | @param[out] Value Upon a successful return the value of the conversion.\r | |
3905 | @param[in] ForceHex TRUE - always assume hex.\r | |
3906 | @param[in] StopAtSpace FALSE to skip spaces.\r | |
b0934ac4 | 3907 | \r |
252d9457 | 3908 | @retval EFI_SUCCESS The conversion was successful.\r |
3909 | @retval EFI_INVALID_PARAMETER String contained an invalid character.\r | |
3910 | @retval EFI_NOT_FOUND String was a number, but Value was NULL.\r | |
3911 | **/\r | |
3912 | EFI_STATUS\r | |
3913 | EFIAPI\r | |
3914 | ShellConvertStringToUint64(\r | |
3915 | IN CONST CHAR16 *String,\r | |
3916 | OUT UINT64 *Value,\r | |
3917 | IN CONST BOOLEAN ForceHex,\r | |
3918 | IN CONST BOOLEAN StopAtSpace\r | |
3919 | )\r | |
3920 | {\r | |
3921 | UINT64 RetVal;\r | |
3922 | CONST CHAR16 *Walker;\r | |
3923 | EFI_STATUS Status;\r | |
3924 | BOOLEAN Hex;\r | |
3925 | \r | |
3926 | Hex = ForceHex;\r | |
3927 | \r | |
3928 | if (!InternalShellIsHexOrDecimalNumber(String, Hex, StopAtSpace)) {\r | |
3929 | if (!Hex) {\r | |
3930 | Hex = TRUE;\r | |
3931 | if (!InternalShellIsHexOrDecimalNumber(String, Hex, StopAtSpace)) {\r | |
3932 | return (EFI_INVALID_PARAMETER);\r | |
3933 | }\r | |
3934 | } else {\r | |
3935 | return (EFI_INVALID_PARAMETER);\r | |
3936 | }\r | |
3937 | }\r | |
3938 | \r | |
3939 | //\r | |
3940 | // Chop off leading spaces\r | |
3941 | //\r | |
3942 | for (Walker = String; Walker != NULL && *Walker != CHAR_NULL && *Walker == L' '; Walker++);\r | |
3943 | \r | |
3944 | //\r | |
3945 | // make sure we have something left that is numeric.\r | |
3946 | //\r | |
3947 | if (Walker == NULL || *Walker == CHAR_NULL || !InternalShellIsHexOrDecimalNumber(Walker, Hex, StopAtSpace)) {\r | |
3948 | return (EFI_INVALID_PARAMETER);\r | |
b0934ac4 | 3949 | }\r |
252d9457 | 3950 | \r |
3951 | //\r | |
3952 | // do the conversion.\r | |
3953 | //\r | |
3954 | if (Hex || StrnCmp(Walker, L"0x", 2) == 0 || StrnCmp(Walker, L"0X", 2) == 0){\r | |
3955 | Status = InternalShellStrHexToUint64(Walker, &RetVal, StopAtSpace);\r | |
3956 | } else {\r | |
3957 | Status = InternalShellStrDecimalToUint64(Walker, &RetVal, StopAtSpace);\r | |
3958 | }\r | |
3959 | \r | |
3960 | if (Value == NULL && !EFI_ERROR(Status)) {\r | |
3961 | return (EFI_NOT_FOUND);\r | |
3962 | }\r | |
3963 | \r | |
3964 | if (Value != NULL) {\r | |
3965 | *Value = RetVal;\r | |
3966 | }\r | |
3967 | \r | |
3968 | return (Status);\r | |
3969 | }\r | |
3970 | \r | |
3971 | /**\r | |
3972 | Function to determin if an entire string is a valid number.\r | |
3973 | \r | |
3974 | If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.\r | |
3975 | \r | |
3976 | @param[in] String The string to evaluate.\r | |
3977 | @param[in] ForceHex TRUE - always assume hex.\r | |
3978 | @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.\r | |
3979 | \r | |
3980 | @retval TRUE It is all numeric (dec/hex) characters.\r | |
3981 | @retval FALSE There is a non-numeric character.\r | |
3982 | **/\r | |
3983 | BOOLEAN\r | |
3984 | EFIAPI\r | |
3985 | ShellIsHexOrDecimalNumber (\r | |
3986 | IN CONST CHAR16 *String,\r | |
3987 | IN CONST BOOLEAN ForceHex,\r | |
3988 | IN CONST BOOLEAN StopAtSpace\r | |
3989 | )\r | |
3990 | {\r | |
3991 | if (ShellConvertStringToUint64(String, NULL, ForceHex, StopAtSpace) == EFI_NOT_FOUND) {\r | |
3992 | return (TRUE);\r | |
3993 | }\r | |
3994 | return (FALSE);\r | |
3995 | }\r | |
4d0a4fce | 3996 | \r |
3997 | /**\r | |
3998 | Function to read a single line from a SHELL_FILE_HANDLE. The \n is not included in the returned\r | |
3999 | buffer. The returned buffer must be callee freed.\r | |
4000 | \r | |
4001 | If the position upon start is 0, then the Ascii Boolean will be set. This should be\r | |
4002 | maintained and not changed for all operations with the same file.\r | |
4003 | \r | |
4ff7e37b ED |
4004 | @param[in] Handle SHELL_FILE_HANDLE to read from.\r |
4005 | @param[in, out] Ascii Boolean value for indicating whether the file is\r | |
4006 | Ascii (TRUE) or UCS2 (FALSE).\r | |
4d0a4fce | 4007 | \r |
beab0fc5 | 4008 | @return The line of text from the file.\r |
4009 | @retval NULL There was not enough memory available.\r | |
4d0a4fce | 4010 | \r |
4011 | @sa ShellFileHandleReadLine\r | |
4012 | **/\r | |
4013 | CHAR16*\r | |
4014 | EFIAPI\r | |
4015 | ShellFileHandleReturnLine(\r | |
4016 | IN SHELL_FILE_HANDLE Handle,\r | |
4017 | IN OUT BOOLEAN *Ascii\r | |
4018 | )\r | |
4019 | {\r | |
4020 | CHAR16 *RetVal;\r | |
4021 | UINTN Size;\r | |
4022 | EFI_STATUS Status;\r | |
4023 | \r | |
4024 | Size = 0;\r | |
4025 | RetVal = NULL;\r | |
4026 | \r | |
4027 | Status = ShellFileHandleReadLine(Handle, RetVal, &Size, FALSE, Ascii);\r | |
4028 | if (Status == EFI_BUFFER_TOO_SMALL) {\r | |
4029 | RetVal = AllocateZeroPool(Size);\r | |
beab0fc5 | 4030 | if (RetVal == NULL) {\r |
4031 | return (NULL);\r | |
4032 | }\r | |
4d0a4fce | 4033 | Status = ShellFileHandleReadLine(Handle, RetVal, &Size, FALSE, Ascii);\r |
b0934ac4 | 4034 | \r |
4d0a4fce | 4035 | }\r |
4d0a4fce | 4036 | if (EFI_ERROR(Status) && (RetVal != NULL)) {\r |
4037 | FreePool(RetVal);\r | |
4038 | RetVal = NULL;\r | |
4039 | }\r | |
4040 | return (RetVal);\r | |
4041 | }\r | |
4042 | \r | |
4043 | /**\r | |
4044 | Function to read a single line (up to but not including the \n) from a SHELL_FILE_HANDLE.\r | |
4045 | \r | |
4046 | If the position upon start is 0, then the Ascii Boolean will be set. This should be\r | |
4047 | maintained and not changed for all operations with the same file.\r | |
4048 | \r | |
4ff7e37b ED |
4049 | @param[in] Handle SHELL_FILE_HANDLE to read from.\r |
4050 | @param[in, out] Buffer The pointer to buffer to read into.\r | |
4051 | @param[in, out] Size The pointer to number of bytes in Buffer.\r | |
4052 | @param[in] Truncate If the buffer is large enough, this has no effect.\r | |
4053 | If the buffer is is too small and Truncate is TRUE,\r | |
4054 | the line will be truncated.\r | |
4055 | If the buffer is is too small and Truncate is FALSE,\r | |
4056 | then no read will occur.\r | |
4057 | \r | |
4058 | @param[in, out] Ascii Boolean value for indicating whether the file is\r | |
4059 | Ascii (TRUE) or UCS2 (FALSE).\r | |
4d0a4fce | 4060 | \r |
4061 | @retval EFI_SUCCESS The operation was successful. The line is stored in\r | |
4062 | Buffer.\r | |
4063 | @retval EFI_INVALID_PARAMETER Handle was NULL.\r | |
4064 | @retval EFI_INVALID_PARAMETER Size was NULL.\r | |
4065 | @retval EFI_BUFFER_TOO_SMALL Size was not large enough to store the line.\r | |
4066 | Size was updated to the minimum space required.\r | |
4067 | **/\r | |
4068 | EFI_STATUS\r | |
4069 | EFIAPI\r | |
4070 | ShellFileHandleReadLine(\r | |
4071 | IN SHELL_FILE_HANDLE Handle,\r | |
4072 | IN OUT CHAR16 *Buffer,\r | |
4073 | IN OUT UINTN *Size,\r | |
4074 | IN BOOLEAN Truncate,\r | |
4075 | IN OUT BOOLEAN *Ascii\r | |
4076 | )\r | |
4077 | {\r | |
4078 | EFI_STATUS Status;\r | |
4079 | CHAR16 CharBuffer;\r | |
4080 | UINTN CharSize;\r | |
4081 | UINTN CountSoFar;\r | |
4082 | UINT64 OriginalFilePosition;\r | |
4083 | \r | |
4084 | \r | |
4085 | if (Handle == NULL\r | |
4086 | ||Size == NULL\r | |
4087 | ){\r | |
4088 | return (EFI_INVALID_PARAMETER);\r | |
4089 | }\r | |
4090 | if (Buffer == NULL) {\r | |
4091 | ASSERT(*Size == 0);\r | |
4092 | } else {\r | |
4093 | *Buffer = CHAR_NULL;\r | |
4094 | }\r | |
4095 | gEfiShellProtocol->GetFilePosition(Handle, &OriginalFilePosition);\r | |
4096 | if (OriginalFilePosition == 0) {\r | |
4097 | CharSize = sizeof(CHAR16);\r | |
4098 | Status = gEfiShellProtocol->ReadFile(Handle, &CharSize, &CharBuffer);\r | |
4099 | ASSERT_EFI_ERROR(Status);\r | |
4100 | if (CharBuffer == gUnicodeFileTag) {\r | |
4101 | *Ascii = FALSE;\r | |
4102 | } else {\r | |
4103 | *Ascii = TRUE;\r | |
4104 | gEfiShellProtocol->SetFilePosition(Handle, OriginalFilePosition);\r | |
4105 | }\r | |
4106 | }\r | |
4107 | \r | |
4108 | for (CountSoFar = 0;;CountSoFar++){\r | |
4109 | CharBuffer = 0;\r | |
4110 | if (*Ascii) {\r | |
4111 | CharSize = sizeof(CHAR8);\r | |
4112 | } else {\r | |
4113 | CharSize = sizeof(CHAR16);\r | |
4114 | }\r | |
4115 | Status = gEfiShellProtocol->ReadFile(Handle, &CharSize, &CharBuffer);\r | |
4116 | if ( EFI_ERROR(Status)\r | |
4117 | || CharSize == 0\r | |
4118 | || (CharBuffer == L'\n' && !(*Ascii))\r | |
4119 | || (CharBuffer == '\n' && *Ascii)\r | |
4120 | ){\r | |
4121 | break;\r | |
4122 | }\r | |
4123 | //\r | |
4124 | // if we have space save it...\r | |
4125 | //\r | |
4126 | if ((CountSoFar+1)*sizeof(CHAR16) < *Size){\r | |
4127 | ASSERT(Buffer != NULL);\r | |
4128 | ((CHAR16*)Buffer)[CountSoFar] = CharBuffer;\r | |
4129 | ((CHAR16*)Buffer)[CountSoFar+1] = CHAR_NULL;\r | |
4130 | }\r | |
4131 | }\r | |
4132 | \r | |
4133 | //\r | |
4134 | // if we ran out of space tell when...\r | |
4135 | //\r | |
4136 | if ((CountSoFar+1)*sizeof(CHAR16) > *Size){\r | |
4137 | *Size = (CountSoFar+1)*sizeof(CHAR16);\r | |
4138 | if (!Truncate) {\r | |
4139 | gEfiShellProtocol->SetFilePosition(Handle, OriginalFilePosition);\r | |
4140 | } else {\r | |
4141 | DEBUG((DEBUG_WARN, "The line was truncated in ShellFileHandleReadLine"));\r | |
4142 | }\r | |
4143 | return (EFI_BUFFER_TOO_SMALL);\r | |
4144 | }\r | |
4145 | while(Buffer[StrLen(Buffer)-1] == L'\r') {\r | |
4146 | Buffer[StrLen(Buffer)-1] = CHAR_NULL;\r | |
4147 | }\r | |
4148 | \r | |
4149 | return (Status);\r | |
4150 | }\r | |
fb5278ef | 4151 | \r |
365aa98a | 4152 | /**\r |
4153 | Function to print help file / man page content in the spec from the UEFI Shell protocol GetHelpText function.\r | |
4154 | \r | |
4155 | @param[in] CommandToGetHelpOn Pointer to a string containing the command name of help file to be printed.\r | |
4156 | @param[in] SectionToGetHelpOn Pointer to the section specifier(s).\r | |
4157 | @param[in] PrintCommandText If TRUE, prints the command followed by the help content, otherwise prints \r | |
4158 | the help content only.\r | |
4159 | @retval EFI_DEVICE_ERROR The help data format was incorrect.\r | |
4160 | @retval EFI_NOT_FOUND The help data could not be found.\r | |
4161 | @retval EFI_SUCCESS The operation was successful.\r | |
4162 | **/\r | |
4163 | EFI_STATUS\r | |
4164 | EFIAPI\r | |
4165 | ShellPrintHelp (\r | |
4166 | IN CONST CHAR16 *CommandToGetHelpOn,\r | |
4167 | IN CONST CHAR16 *SectionToGetHelpOn,\r | |
4168 | IN BOOLEAN PrintCommandText\r | |
4169 | )\r | |
4170 | {\r | |
4171 | EFI_STATUS Status;\r | |
4172 | CHAR16 *OutText;\r | |
4173 | \r | |
4174 | OutText = NULL;\r | |
4175 | \r | |
4176 | //\r | |
4177 | // Get the string to print based\r | |
4178 | //\r | |
4179 | Status = gEfiShellProtocol->GetHelpText (CommandToGetHelpOn, SectionToGetHelpOn, &OutText);\r | |
4180 | \r | |
4181 | //\r | |
4182 | // make sure we got a valid string\r | |
4183 | //\r | |
4184 | if (EFI_ERROR(Status)){\r | |
4185 | return Status;\r | |
4186 | } \r | |
4187 | if (OutText == NULL || StrLen(OutText) == 0) {\r | |
4188 | return EFI_NOT_FOUND; \r | |
4189 | }\r | |
4190 | \r | |
4191 | //\r | |
4192 | // Chop off trailing stuff we dont need\r | |
4193 | //\r | |
4194 | while (OutText[StrLen(OutText)-1] == L'\r' || OutText[StrLen(OutText)-1] == L'\n' || OutText[StrLen(OutText)-1] == L' ') {\r | |
4195 | OutText[StrLen(OutText)-1] = CHAR_NULL;\r | |
4196 | }\r | |
4197 | \r | |
4198 | //\r | |
4199 | // Print this out to the console\r | |
4200 | //\r | |
4201 | if (PrintCommandText) {\r | |
4202 | ShellPrintEx(-1, -1, L"%H%-14s%N- %s\r\n", CommandToGetHelpOn, OutText);\r | |
4203 | } else {\r | |
4204 | ShellPrintEx(-1, -1, L"%N%s\r\n", OutText);\r | |
4205 | }\r | |
4206 | \r | |
4207 | SHELL_FREE_NON_NULL(OutText);\r | |
4208 | \r | |
4209 | return EFI_SUCCESS;\r | |
4210 | }\r | |
4211 | \r | |
fb5278ef | 4212 | /**\r |
4213 | Function to delete a file by name\r | |
4214 | \r | |
4215 | @param[in] FileName Pointer to file name to delete.\r | |
4216 | \r | |
4217 | @retval EFI_SUCCESS the file was deleted sucessfully\r | |
4218 | @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not\r | |
4219 | deleted\r | |
4220 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r | |
4221 | @retval EFI_NOT_FOUND The specified file could not be found on the\r | |
4222 | device or the file system could not be found\r | |
4223 | on the device.\r | |
4224 | @retval EFI_NO_MEDIA The device has no medium.\r | |
4225 | @retval EFI_MEDIA_CHANGED The device has a different medium in it or the\r | |
4226 | medium is no longer supported.\r | |
4227 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
4228 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
4229 | @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r | |
4230 | @retval EFI_ACCESS_DENIED The file was opened read only.\r | |
4231 | @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the\r | |
4232 | file.\r | |
4233 | @retval other The file failed to open\r | |
4234 | **/\r | |
4235 | EFI_STATUS\r | |
4236 | EFIAPI\r | |
4237 | ShellDeleteFileByName(\r | |
4238 | IN CONST CHAR16 *FileName\r | |
4239 | )\r | |
4240 | {\r | |
4241 | EFI_STATUS Status;\r | |
4242 | SHELL_FILE_HANDLE FileHandle;\r | |
4243 | \r | |
4244 | Status = ShellFileExists(FileName);\r | |
4245 | \r | |
4246 | if (Status == EFI_SUCCESS){\r | |
4247 | Status = ShellOpenFileByName(FileName, &FileHandle, EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE | EFI_FILE_MODE_CREATE, 0x0);\r | |
4248 | if (Status == EFI_SUCCESS){\r | |
4249 | Status = ShellDeleteFile(&FileHandle);\r | |
4250 | }\r | |
4251 | } \r | |
4252 | \r | |
4253 | return(Status);\r | |
4254 | \r | |
4255 | }\r | |
0960ba17 QS |
4256 | \r |
4257 | /**\r | |
4258 | Cleans off all the quotes in the string.\r | |
4259 | \r | |
4260 | @param[in] OriginalString pointer to the string to be cleaned.\r | |
4261 | @param[out] CleanString The new string with all quotes removed. \r | |
4262 | Memory allocated in the function and free \r | |
4263 | by caller.\r | |
4264 | \r | |
4265 | @retval EFI_SUCCESS The operation was successful.\r | |
4266 | **/\r | |
4267 | EFI_STATUS\r | |
4268 | EFIAPI\r | |
4269 | InternalShellStripQuotes (\r | |
4270 | IN CONST CHAR16 *OriginalString,\r | |
4271 | OUT CHAR16 **CleanString\r | |
4272 | )\r | |
4273 | {\r | |
4274 | CHAR16 *Walker;\r | |
4275 | \r | |
4276 | if (OriginalString == NULL || CleanString == NULL) {\r | |
4277 | return EFI_INVALID_PARAMETER;\r | |
4278 | }\r | |
4279 | \r | |
4280 | *CleanString = AllocateCopyPool (StrSize (OriginalString), OriginalString);\r | |
4281 | if (*CleanString == NULL) {\r | |
4282 | return EFI_OUT_OF_RESOURCES;\r | |
4283 | }\r | |
4284 | \r | |
4285 | for (Walker = *CleanString; Walker != NULL && *Walker != CHAR_NULL ; Walker++) {\r | |
4286 | if (*Walker == L'\"') {\r | |
4287 | CopyMem(Walker, Walker+1, StrSize(Walker) - sizeof(Walker[0]));\r | |
4288 | }\r | |
4289 | }\r | |
4290 | \r | |
4291 | return EFI_SUCCESS;\r | |
4292 | }\r | |
4293 | \r |