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