]>
Commit | Line | Data |
---|---|---|
a405b86d | 1 | /** @file\r |
2 | Main file for NULL named library for level 1 shell command functions.\r | |
3 | \r | |
c011b6c9 | 4 | (C) Copyright 2013 Hewlett-Packard Development Company, L.P.<BR>\r |
77dcec12 | 5 | Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r |
a405b86d | 6 | This program and the accompanying materials\r |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | **/\r | |
15 | \r | |
16 | #include "UefiShellLevel1CommandsLib.h"\r | |
17 | \r | |
18 | STATIC CONST CHAR16 mFileName[] = L"ShellCommands";\r | |
19 | EFI_HANDLE gShellLevel1HiiHandle = NULL;\r | |
a405b86d | 20 | \r |
77dcec12 | 21 | /**\r |
22 | Return the help text filename. Only used if no HII information found.\r | |
23 | \r | |
24 | @retval the filename.\r | |
25 | **/\r | |
a405b86d | 26 | CONST CHAR16*\r |
27 | EFIAPI\r | |
28 | ShellCommandGetManFileNameLevel1 (\r | |
29 | VOID\r | |
30 | )\r | |
31 | {\r | |
32 | return (mFileName);\r | |
33 | }\r | |
34 | \r | |
35 | /**\r | |
36 | Constructor for the Shell Level 1 Commands library.\r | |
37 | \r | |
38 | Install the handlers for level 1 UEFI Shell 2.0 commands.\r | |
39 | \r | |
40 | @param ImageHandle the image handle of the process\r | |
41 | @param SystemTable the EFI System Table pointer\r | |
42 | \r | |
43 | @retval EFI_SUCCESS the shell command handlers were installed sucessfully\r | |
44 | @retval EFI_UNSUPPORTED the shell level required was not found.\r | |
45 | **/\r | |
46 | EFI_STATUS\r | |
47 | EFIAPI\r | |
48 | ShellLevel1CommandsLibConstructor (\r | |
49 | IN EFI_HANDLE ImageHandle,\r | |
50 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
51 | )\r | |
52 | {\r | |
53 | //\r | |
54 | // if shell level is less than 2 do nothing\r | |
55 | //\r | |
56 | if (PcdGet8(PcdShellSupportLevel) < 1) {\r | |
82571fb5 | 57 | return (EFI_SUCCESS);\r |
a405b86d | 58 | }\r |
59 | \r | |
60 | gShellLevel1HiiHandle = HiiAddPackages (&gShellLevel1HiiGuid, gImageHandle, UefiShellLevel1CommandsLibStrings, NULL);\r | |
61 | if (gShellLevel1HiiHandle == NULL) {\r | |
62 | return (EFI_DEVICE_ERROR);\r | |
63 | }\r | |
64 | \r | |
65 | //\r | |
66 | // install our shell command handlers that are always installed\r | |
67 | //\r | |
77dcec12 | 68 | ShellCommandRegisterCommandName(L"stall", ShellCommandRunStall , ShellCommandGetManFileNameLevel1, 1, L"", FALSE, gShellLevel1HiiHandle, (EFI_STRING_ID)(PcdGet8(PcdShellSupportLevel) < 3 ? 0 : STRING_TOKEN(STR_GET_HELP_STALL) ));\r |
a405b86d | 69 | ShellCommandRegisterCommandName(L"for", ShellCommandRunFor , ShellCommandGetManFileNameLevel1, 1, L"", FALSE, gShellLevel1HiiHandle, (EFI_STRING_ID)(PcdGet8(PcdShellSupportLevel) < 3 ? 0 : STRING_TOKEN(STR_GET_HELP_FOR) ));\r |
70 | ShellCommandRegisterCommandName(L"goto", ShellCommandRunGoto , ShellCommandGetManFileNameLevel1, 1, L"", FALSE, gShellLevel1HiiHandle, (EFI_STRING_ID)(PcdGet8(PcdShellSupportLevel) < 3 ? 0 : STRING_TOKEN(STR_GET_HELP_GOTO) ));\r | |
71 | ShellCommandRegisterCommandName(L"if", ShellCommandRunIf , ShellCommandGetManFileNameLevel1, 1, L"", FALSE, gShellLevel1HiiHandle, (EFI_STRING_ID)(PcdGet8(PcdShellSupportLevel) < 3 ? 0 : STRING_TOKEN(STR_GET_HELP_IF) ));\r | |
72 | ShellCommandRegisterCommandName(L"shift", ShellCommandRunShift , ShellCommandGetManFileNameLevel1, 1, L"", FALSE, gShellLevel1HiiHandle, (EFI_STRING_ID)(PcdGet8(PcdShellSupportLevel) < 3 ? 0 : STRING_TOKEN(STR_GET_HELP_SHIFT) ));\r | |
73 | ShellCommandRegisterCommandName(L"exit", ShellCommandRunExit , ShellCommandGetManFileNameLevel1, 1, L"", TRUE , gShellLevel1HiiHandle, (EFI_STRING_ID)(PcdGet8(PcdShellSupportLevel) < 3 ? 0 : STRING_TOKEN(STR_GET_HELP_EXIT) ));\r | |
74 | ShellCommandRegisterCommandName(L"else", ShellCommandRunElse , ShellCommandGetManFileNameLevel1, 1, L"", FALSE, gShellLevel1HiiHandle, (EFI_STRING_ID)(PcdGet8(PcdShellSupportLevel) < 3 ? 0 : STRING_TOKEN(STR_GET_HELP_ELSE) ));\r | |
75 | ShellCommandRegisterCommandName(L"endif", ShellCommandRunEndIf , ShellCommandGetManFileNameLevel1, 1, L"", FALSE, gShellLevel1HiiHandle, (EFI_STRING_ID)(PcdGet8(PcdShellSupportLevel) < 3 ? 0 : STRING_TOKEN(STR_GET_HELP_ENDIF) ));\r | |
76 | ShellCommandRegisterCommandName(L"endfor", ShellCommandRunEndFor , ShellCommandGetManFileNameLevel1, 1, L"", FALSE, gShellLevel1HiiHandle, (EFI_STRING_ID)(PcdGet8(PcdShellSupportLevel) < 3 ? 0 : STRING_TOKEN(STR_GET_HELP_ENDFOR)));\r | |
77 | \r | |
78 | return (EFI_SUCCESS);\r | |
79 | }\r | |
80 | \r | |
81 | /**\r | |
82 | Destructor for the library. free any resources.\r | |
77dcec12 | 83 | \r |
84 | @param ImageHandle The image handle of the process.\r | |
85 | @param SystemTable The EFI System Table pointer.\r | |
a405b86d | 86 | **/\r |
87 | EFI_STATUS\r | |
88 | EFIAPI\r | |
89 | ShellLevel1CommandsLibDestructor (\r | |
90 | IN EFI_HANDLE ImageHandle,\r | |
91 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
92 | )\r | |
93 | {\r | |
94 | if (gShellLevel1HiiHandle != NULL) {\r | |
95 | HiiRemovePackages(gShellLevel1HiiHandle);\r | |
96 | }\r | |
97 | return (EFI_SUCCESS);\r | |
98 | }\r | |
99 | \r | |
77dcec12 | 100 | /**\r |
101 | Test a node to see if meets the criterion.\r | |
102 | \r | |
103 | It functions so that count starts at 1 and it increases or decreases when it\r | |
104 | hits the specified tags. when it hits zero the location has been found.\r | |
105 | \r | |
106 | DecrementerTag and IncrementerTag are used to get around for/endfor and \r | |
107 | similar paired types where the entire middle should be ignored.\r | |
108 | \r | |
109 | If label is used it will be used instead of the count.\r | |
110 | \r | |
4ff7e37b ED |
111 | @param[in] Function The function to use to enumerate through the \r |
112 | list. Normally GetNextNode or GetPreviousNode.\r | |
113 | @param[in] DecrementerTag The tag to decrement the count at.\r | |
114 | @param[in] IncrementerTag The tag to increment the count at.\r | |
115 | @param[in] Label A label to look for.\r | |
116 | @param[in, out] ScriptFile The pointer to the current script file structure.\r | |
117 | @param[in] MovePast TRUE makes function return 1 past the found \r | |
118 | location.\r | |
119 | @param[in] FindOnly TRUE to not change the ScriptFile.\r | |
120 | @param[in] CommandNode The pointer to the Node to test.\r | |
121 | @param[in, out] TargetCount The pointer to the current count.\r | |
77dcec12 | 122 | **/\r |
a405b86d | 123 | BOOLEAN\r |
124 | EFIAPI\r | |
125 | TestNodeForMove (\r | |
126 | IN CONST LIST_MANIP_FUNC Function,\r | |
127 | IN CONST CHAR16 *DecrementerTag,\r | |
128 | IN CONST CHAR16 *IncrementerTag,\r | |
129 | IN CONST CHAR16 *Label OPTIONAL,\r | |
77dcec12 | 130 | IN OUT SCRIPT_FILE *ScriptFile,\r |
a405b86d | 131 | IN CONST BOOLEAN MovePast,\r |
132 | IN CONST BOOLEAN FindOnly,\r | |
133 | IN CONST SCRIPT_COMMAND_LIST *CommandNode,\r | |
77dcec12 | 134 | IN OUT UINTN *TargetCount\r |
a405b86d | 135 | )\r |
136 | {\r | |
137 | BOOLEAN Found;\r | |
138 | CHAR16 *CommandName;\r | |
139 | CHAR16 *CommandNameWalker;\r | |
140 | CHAR16 *TempLocation;\r | |
141 | \r | |
142 | Found = FALSE;\r | |
143 | \r | |
144 | //\r | |
145 | // get just the first part of the command line...\r | |
146 | //\r | |
147 | CommandName = NULL;\r | |
148 | CommandName = StrnCatGrow(&CommandName, NULL, CommandNode->Cl, 0);\r | |
532691c8 | 149 | if (CommandName == NULL) {\r |
150 | return (FALSE);\r | |
151 | }\r | |
152 | \r | |
a405b86d | 153 | CommandNameWalker = CommandName;\r |
13acebbd CP |
154 | \r |
155 | //\r | |
156 | // Skip leading spaces and tabs.\r | |
157 | //\r | |
158 | while ((CommandNameWalker[0] == L' ') || (CommandNameWalker[0] == L'\t')) {\r | |
a405b86d | 159 | CommandNameWalker++;\r |
160 | }\r | |
161 | TempLocation = StrStr(CommandNameWalker, L" ");\r | |
162 | \r | |
163 | if (TempLocation != NULL) {\r | |
164 | *TempLocation = CHAR_NULL;\r | |
165 | }\r | |
166 | \r | |
167 | //\r | |
168 | // did we find a nested item ?\r | |
169 | //\r | |
170 | if (gUnicodeCollation->StriColl(\r | |
171 | gUnicodeCollation,\r | |
172 | (CHAR16*)CommandNameWalker,\r | |
173 | (CHAR16*)IncrementerTag) == 0) {\r | |
174 | (*TargetCount)++;\r | |
175 | } else if (gUnicodeCollation->StriColl(\r | |
176 | gUnicodeCollation,\r | |
177 | (CHAR16*)CommandNameWalker,\r | |
178 | (CHAR16*)DecrementerTag) == 0) {\r | |
179 | if (*TargetCount > 0) {\r | |
180 | (*TargetCount)--;\r | |
181 | }\r | |
182 | }\r | |
183 | \r | |
184 | //\r | |
185 | // did we find the matching one...\r | |
186 | //\r | |
187 | if (Label == NULL) {\r | |
188 | if (*TargetCount == 0) {\r | |
189 | Found = TRUE;\r | |
190 | if (!FindOnly) {\r | |
191 | if (MovePast) {\r | |
192 | ScriptFile->CurrentCommand = (SCRIPT_COMMAND_LIST *)(*Function)(&ScriptFile->CommandList, &CommandNode->Link);\r | |
193 | } else {\r | |
194 | ScriptFile->CurrentCommand = (SCRIPT_COMMAND_LIST *)CommandNode;\r | |
195 | }\r | |
196 | }\r | |
197 | }\r | |
198 | } else {\r | |
199 | if (gUnicodeCollation->StriColl(\r | |
200 | gUnicodeCollation,\r | |
201 | (CHAR16*)CommandNameWalker,\r | |
202 | (CHAR16*)Label) == 0\r | |
203 | && (*TargetCount) == 0) {\r | |
204 | Found = TRUE;\r | |
205 | if (!FindOnly) {\r | |
206 | //\r | |
207 | // we found the target label without loops\r | |
208 | //\r | |
209 | if (MovePast) {\r | |
210 | ScriptFile->CurrentCommand = (SCRIPT_COMMAND_LIST *)(*Function)(&ScriptFile->CommandList, &CommandNode->Link);\r | |
211 | } else {\r | |
212 | ScriptFile->CurrentCommand = (SCRIPT_COMMAND_LIST *)CommandNode;\r | |
213 | }\r | |
214 | }\r | |
215 | }\r | |
216 | }\r | |
217 | \r | |
218 | //\r | |
219 | // Free the memory for this loop...\r | |
220 | //\r | |
221 | FreePool(CommandName);\r | |
222 | return (Found);\r | |
223 | }\r | |
224 | \r | |
77dcec12 | 225 | /**\r |
226 | Move the script pointer from 1 tag (line) to another.\r | |
227 | \r | |
228 | It functions so that count starts at 1 and it increases or decreases when it\r | |
229 | hits the specified tags. when it hits zero the location has been found.\r | |
230 | \r | |
231 | DecrementerTag and IncrementerTag are used to get around for/endfor and \r | |
232 | similar paired types where the entire middle should be ignored.\r | |
233 | \r | |
234 | If label is used it will be used instead of the count.\r | |
235 | \r | |
4ff7e37b ED |
236 | @param[in] Function The function to use to enumerate through the \r |
237 | list. Normally GetNextNode or GetPreviousNode.\r | |
238 | @param[in] DecrementerTag The tag to decrement the count at.\r | |
239 | @param[in] IncrementerTag The tag to increment the count at.\r | |
240 | @param[in] Label A label to look for.\r | |
241 | @param[in, out] ScriptFile The pointer to the current script file structure.\r | |
242 | @param[in] MovePast TRUE makes function return 1 past the found \r | |
243 | location.\r | |
244 | @param[in] FindOnly TRUE to not change the ScriptFile.\r | |
245 | @param[in] WrapAroundScript TRUE to wrap end-to-begining or vise versa in \r | |
246 | searching.\r | |
77dcec12 | 247 | **/\r |
a405b86d | 248 | BOOLEAN\r |
249 | EFIAPI\r | |
250 | MoveToTag (\r | |
251 | IN CONST LIST_MANIP_FUNC Function,\r | |
252 | IN CONST CHAR16 *DecrementerTag,\r | |
253 | IN CONST CHAR16 *IncrementerTag,\r | |
254 | IN CONST CHAR16 *Label OPTIONAL,\r | |
77dcec12 | 255 | IN OUT SCRIPT_FILE *ScriptFile,\r |
a405b86d | 256 | IN CONST BOOLEAN MovePast,\r |
257 | IN CONST BOOLEAN FindOnly,\r | |
258 | IN CONST BOOLEAN WrapAroundScript\r | |
259 | )\r | |
260 | {\r | |
261 | SCRIPT_COMMAND_LIST *CommandNode;\r | |
262 | BOOLEAN Found;\r | |
263 | UINTN TargetCount;\r | |
264 | \r | |
265 | if (Label == NULL) {\r | |
266 | TargetCount = 1;\r | |
267 | } else {\r | |
268 | TargetCount = 0;\r | |
269 | }\r | |
270 | \r | |
271 | if (ScriptFile == NULL) {\r | |
272 | return FALSE;\r | |
273 | }\r | |
274 | \r | |
275 | for (CommandNode = (SCRIPT_COMMAND_LIST *)(*Function)(&ScriptFile->CommandList, &ScriptFile->CurrentCommand->Link), Found = FALSE\r | |
276 | ; !IsNull(&ScriptFile->CommandList, &CommandNode->Link)&& !Found\r | |
277 | ; CommandNode = (SCRIPT_COMMAND_LIST *)(*Function)(&ScriptFile->CommandList, &CommandNode->Link)\r | |
278 | ){\r | |
279 | Found = TestNodeForMove(\r | |
280 | Function,\r | |
281 | DecrementerTag,\r | |
282 | IncrementerTag,\r | |
283 | Label,\r | |
284 | ScriptFile,\r | |
285 | MovePast,\r | |
286 | FindOnly,\r | |
287 | CommandNode,\r | |
288 | &TargetCount);\r | |
289 | }\r | |
290 | \r | |
291 | if (WrapAroundScript && !Found) {\r | |
292 | for (CommandNode = (SCRIPT_COMMAND_LIST *)GetFirstNode(&ScriptFile->CommandList), Found = FALSE\r | |
293 | ; CommandNode != ScriptFile->CurrentCommand && !Found\r | |
294 | ; CommandNode = (SCRIPT_COMMAND_LIST *)(*Function)(&ScriptFile->CommandList, &CommandNode->Link)\r | |
295 | ){\r | |
296 | Found = TestNodeForMove(\r | |
297 | Function,\r | |
298 | DecrementerTag,\r | |
299 | IncrementerTag,\r | |
300 | Label,\r | |
301 | ScriptFile,\r | |
302 | MovePast,\r | |
303 | FindOnly,\r | |
304 | CommandNode,\r | |
305 | &TargetCount);\r | |
306 | }\r | |
307 | }\r | |
308 | return (Found);\r | |
309 | }\r | |
310 | \r |