]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Java/Source/MigrationTools/org/tianocore/migration/SourceFileReplacer.java
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Enhance MsaOwner.java
[mirror_edk2.git] / Tools / Java / Source / MigrationTools / org / tianocore / migration / SourceFileReplacer.java
CommitLineData
b0282412 1/** @file\r
2 \r
3 Copyright (c) 2006, Intel Corporation\r
4 All rights reserved. This program and the accompanying materials\r
5 are licensed and made available under the terms and conditions of the BSD License\r
6 which accompanies this distribution. The full text of the license may be found at\r
7 http://opensource.org/licenses/bsd-license.php\r
8 \r
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
11 \r
12 **/\r
0dc8c589 13package org.tianocore.migration;\r
14\r
15import java.io.*;\r
16import java.util.*;\r
17import java.util.regex.Matcher;\r
18import java.util.regex.Pattern;\r
19\r
8270b34d 20import org.tianocore.UsageTypes;\r
21\r
16b7eeef 22public final class SourceFileReplacer implements Common.ForDoAll {\r
27e0221a 23 private static final SourceFileReplacer SFReplacer = new SourceFileReplacer();\r
24 private ModuleInfo mi;\r
25 private static final Set<Common.Laplace> Laplaces = new HashSet<Common.Laplace>();\r
2887f99b 26\r
27e0221a 27 // these sets are used only for printing log of the changes in current file\r
28 private static final Set<r8tor9> filefunc = new HashSet<r8tor9>();\r
29 private static final Set<r8tor9> filemacro = new HashSet<r8tor9>();\r
30 private static final Set<r8tor9> fileguid = new HashSet<r8tor9>();\r
31 private static final Set<r8tor9> fileppi = new HashSet<r8tor9>();\r
32 private static final Set<r8tor9> fileprotocol = new HashSet<r8tor9>();\r
33 private static final Set<String> filer8only = new HashSet<String>();\r
34 \r
35 private static final String[] specialhoblibfunc = {\r
36 "BuildModuleHob",\r
37 "BuildResourceDescriptorHob",\r
38 "BuildFvHob",\r
39 "BuildCpuHob",\r
733d48fe 40 "BuildGuidDataHob",\r
27e0221a 41 "BuildStackHob",\r
42 "BuildBspStoreHob",\r
43 "BuildMemoryAllocationHob"\r
44 };\r
10e4f990 45 private static final String[] peiserviceslibfunc = {\r
46 "InstallPpi",\r
47 "ReInstallPpi",\r
48 "LocatePpi",\r
49 "NotifyPpi",\r
50 "GetBootMode",\r
51 "SetBootMode",\r
52 "GetHobList",\r
53 "CreateHob",\r
54 "FfsFindNextVolume",\r
55 "FfsFindNextFile",\r
56 "FfsFindSectionData",\r
57 "InstallPeiMemory",\r
58 "AllocatePages",\r
59 "AllocatePool",\r
60 "PeiResetSystem"\r
61 };\r
27e0221a 62 //---------------------------------------inner classes---------------------------------------//\r
63 private static class r8tor9 {\r
64 r8tor9(String r8, String r9) {\r
65 r8thing = r8;\r
66 r9thing = r9;\r
67 }\r
68 public String r8thing;\r
69 public String r9thing;\r
70 }\r
71 \r
72 private class IdleLaplace extends Common.Laplace {\r
73 public String operation(String wholeline) {\r
9f98dbb7 74 return replaceLibrary (wholeline, mi.hashmacro);\r
27e0221a 75 }\r
76 \r
77 public boolean recognize(String filename) {\r
78 return filename.contains(".h") || filename.contains(".H") || filename.contains(".uni");\r
79 }\r
2887f99b 80\r
27e0221a 81 public String namechange(String oldname) {\r
82 if (oldname.contains(".H")) {\r
83 return oldname.replaceFirst(".H", ".h");\r
84 } else {\r
85 return oldname;\r
86 }\r
87 }\r
88 }\r
89 private class DxsLaplace extends Common.Laplace {\r
90 public String operation(String wholeline) {\r
49324055 91 wholeline = replaceMacro(wholeline, mi.hashnonlocalmacro);\r
27e0221a 92 if (mi.getModuleType().equals("PEIM")) {\r
93 return addincludefile(wholeline, "\\<PeimDepex.h\\>");\r
94 } else {\r
95 return addincludefile(wholeline, "\\<DxeDepex.h\\>");\r
96 }\r
97 }\r
98 \r
99 public boolean recognize(String filename) {\r
100 return filename.contains(".dxs");\r
101 }\r
2887f99b 102\r
27e0221a 103 public String namechange(String oldname) {\r
104 return oldname;\r
105 }\r
106 }\r
107 \r
108 private class CLaplace extends Common.Laplace {\r
109 public String operation(String wholeline) {\r
27e0221a 110 // remove EFI_DRIVER_ENTRY_POINT\r
49324055 111 wholeline = wholeline.replaceAll("(EFI_[A-Z]+_ENTRY_POINT\\s*\\(\\s*\\w(\\w|\\d)*\\s*\\))", MigrationTool.MIGRATIONCOMMENT + " $1");\r
d47b9900 112 // redefine module entry point for some self-relocated modules\r
113 wholeline = wholeline.replaceAll (mi.entrypoint + "([^{]*?})", "_ModuleEntryPoint" + "$1");\r
06d1ff5b 114 // remove R8 library contractor\r
115 wholeline = wholeline.replaceAll ("(\\b(?:Efi|Dxe)InitializeDriverLib\\b)", MigrationTool.MIGRATIONCOMMENT + " $1");\r
116 // Add Library Class for potential reference of gBS, gRT & gDS.\r
117 if (Common.find (wholeline, "\\bg?BS\\b")) {\r
118 mi.hashrequiredr9libs.add("UefiBootServicesTableLib");\r
119 }\r
120 if (Common.find (wholeline, "\\bg?RT\\b")) {\r
121 mi.hashrequiredr9libs.add ("UefiRuntimeServicesTableLib");\r
122 }\r
123 if (Common.find (wholeline, "\\bgDS\\b")) {\r
124 mi.hashrequiredr9libs.add ("DxeServicesTableLib");\r
125 }\r
9f98dbb7 126\r
127 wholeline = replaceLibrary (wholeline, mi.hashnonlocalfunc);\r
128 wholeline = replaceLibrary (wholeline, mi.hashmacro);\r
27e0221a 129 // Converting macro\r
9f98dbb7 130 wholeline = replaceMacro (wholeline, mi.hashnonlocalmacro);\r
0dc8c589 131\r
27e0221a 132 // Converting guid\r
323e2ffc 133 replaceGuid(wholeline, mi.guids, "guid", fileguid);\r
134 replaceGuid(wholeline, mi.ppis, "ppi", fileppi);\r
135 replaceGuid(wholeline, mi.protocols, "protocol", fileprotocol);\r
2887f99b 136\r
27e0221a 137 // Converting Pei\r
27e0221a 138 if (mi.getModuleType().matches("PEIM")) {\r
10e4f990 139 //\r
140 // Try to remove PeiServicesTablePointer;\r
141 // \r
142 wholeline = dropPeiServicesPointer (wholeline);\r
143 //\r
144 // Drop the possible return Status of Hob building function.\r
145 // \r
146 wholeline = drophobLibReturnStatus (wholeline);\r
27e0221a 147 }\r
10e4f990 148 //\r
149 // Expand obsolete R8 macro.\r
150 // \r
151 wholeline = replaceObsoleteMacro (wholeline);\r
0dc8c589 152\r
27e0221a 153 show(filefunc, "function");\r
154 show(filemacro, "macro");\r
155 show(fileguid, "guid");\r
156 show(fileppi, "ppi");\r
157 show(fileprotocol, "protocol");\r
158 if (!filer8only.isEmpty()) {\r
159 MigrationTool.ui.println("Converting r8only : " + filer8only);\r
160 }\r
2887f99b 161\r
27e0221a 162 filefunc.clear();\r
163 filemacro.clear();\r
164 fileguid.clear();\r
165 fileppi.clear();\r
166 fileprotocol.clear();\r
167 filer8only.clear();\r
2887f99b 168\r
27e0221a 169 return wholeline;\r
170 }\r
171 \r
172 public boolean recognize(String filename) {\r
173 return filename.contains(".c") || filename.contains(".C");\r
174 }\r
0dc8c589 175\r
27e0221a 176 public String namechange(String oldname) {\r
177 if (oldname.contains(".C")) {\r
178 return oldname.replaceFirst(".C", ".c");\r
179 } else {\r
180 return oldname;\r
181 }\r
182 }\r
183 }\r
184 //---------------------------------------inner classes---------------------------------------//\r
99b0f0e6 185\r
27e0221a 186 //-------------------------------------process functions-------------------------------------//\r
187 private static final String addincludefile(String wholeline, String hfile) {\r
188 return wholeline.replaceFirst("(\\*/\\s)", "$1\n#include " + hfile + "\n");\r
189 }\r
190 \r
191 private static final void show(Set<r8tor9> hash, String sh) {\r
192 Iterator<r8tor9> it = hash.iterator();\r
193 r8tor9 temp;\r
194 if (!hash.isEmpty()) {\r
195 MigrationTool.ui.print("Converting " + sh + " : ");\r
196 while (it.hasNext()) {\r
197 temp = it.next();\r
198 MigrationTool.ui.print("[" + temp.r8thing + "->" + temp.r9thing + "] ");\r
199 }\r
200 MigrationTool.ui.println("");\r
201 }\r
202 }\r
71874f93 203\r
27e0221a 204 private static final void replaceGuid(String line, Set<String> hash, String kind, Set<r8tor9> filehash) {\r
205 Iterator<String> it;\r
206 String r8thing;\r
207 String r9thing;\r
208 it = hash.iterator();\r
209 while (it.hasNext()) {\r
210 r8thing = it.next();\r
211 if ((r9thing = MigrationTool.db.getR9Guidname(r8thing)) != null) {\r
212 if (!r8thing.equals(r9thing)) {\r
213 if (line.contains(r8thing)) {\r
214 line = line.replaceAll(r8thing, r9thing);\r
215 filehash.add(new r8tor9(r8thing, r9thing));\r
216 }\r
217 }\r
218 }\r
219 }\r
220 }\r
71874f93 221\r
10e4f990 222 private final String dropPeiServicesPointer (String wholeline) {\r
223 String peiServicesTablePointer;\r
224 String peiServicesTableCaller;\r
225 String regPeiServices;\r
226 Pattern ptnPei;\r
227 Matcher mtrPei;\r
228\r
229 peiServicesTablePointer = "\\w(?:\\w|[0-9]|->)*";\r
230 peiServicesTableCaller = "\\(\\*\\*?\\s*(" + peiServicesTablePointer + ")\\s*\\)[.-]>?\\s*";\r
231 for (int i = 0; i < peiserviceslibfunc.length; i++) {\r
232 regPeiServices = peiServicesTableCaller + peiserviceslibfunc[i] + "\\s*\\(\\s*\\1\\s*,(\\t| )*"; \r
233 ptnPei = Pattern.compile (regPeiServices);\r
234 mtrPei = ptnPei.matcher (wholeline);\r
235 if (mtrPei.find()) {\r
236 wholeline = mtrPei.replaceAll("PeiServices" + peiserviceslibfunc[i] + " (");\r
237 mi.hashrequiredr9libs.add("PeiServicesLib");\r
238 }\r
239 }\r
240 regPeiServices = peiServicesTableCaller + "(CopyMem|SetMem)" + "\\s*\\((\\t| )*";\r
241 ptnPei = Pattern.compile (regPeiServices);\r
242 mtrPei = ptnPei.matcher (wholeline);\r
243 if (mtrPei.find()) {\r
244 wholeline = mtrPei.replaceAll("$2 (");\r
245 mi.hashrequiredr9libs.add("BaseMemoryLib");\r
246 }\r
247\r
248 ptnPei = Pattern.compile("#%+(\\s*\\(+\\s*)" + peiServicesTablePointer + "\\s*,\\s*", Pattern.MULTILINE);\r
249 mtrPei = ptnPei.matcher(wholeline);\r
250 while (mtrPei.find()) {\r
251 wholeline = mtrPei.replaceAll("$1");\r
252 }\r
253\r
254 return wholeline;\r
255 }\r
256\r
257 private final String drophobLibReturnStatus (String wholeline) { // or use regex to find pattern "Status = ..."\r
27e0221a 258 Pattern ptnhobstatus;\r
259 Matcher mtrhobstatus;\r
260 String templine = wholeline;\r
261 for (int i = 0; i < specialhoblibfunc.length; i++) {\r
262 ptnhobstatus = Pattern.compile("(Status\\s*=\\s*)?" + specialhoblibfunc[i] + "(.*?\\)\\s*;)", Pattern.DOTALL);\r
263 mtrhobstatus = ptnhobstatus.matcher(templine);\r
264 if (mtrhobstatus.find()) {\r
10e4f990 265 templine = mtrhobstatus.replaceAll(specialhoblibfunc[i] + mtrhobstatus.group(2) + "\n " + \r
266 MigrationTool.MIGRATIONCOMMENT + "R9 Hob-building library functions will assert if build failure.\n Status = EFI_SUCCESS;");\r
27e0221a 267 }\r
268 }\r
269 return templine;\r
270 }\r
9f98dbb7 271\r
272 private final String replaceMacro (String wholeline, Set<String> symbolSet) {\r
273 String r8thing;\r
274 String r9thing;\r
275 Iterator<String> it;\r
276\r
277 it = symbolSet.iterator();\r
278 while (it.hasNext()) { //macros are all assumed MdePkg currently\r
279 r8thing = it.next();\r
9f98dbb7 280 //mi.hashrequiredr9libs.add(MigrationTool.db.getR9Lib(r8thing)); \r
281 if ((r9thing = MigrationTool.db.getR9Macro(r8thing)) != null) {\r
282 if (wholeline.contains(r8thing)) {\r
49324055 283 String findString = "(?<!(?:\\d|\\w))" + r8thing + "(?!(?:\\d|\\w))";\r
284 wholeline = wholeline.replaceAll(findString, r9thing);\r
9f98dbb7 285 filemacro.add(new r8tor9(r8thing, r9thing));\r
286 }\r
287 }\r
288 }\r
289 return wholeline;\r
290 }\r
291\r
292 private final String replaceLibrary (String wholeline, Set<String> symbolSet) {\r
293 boolean addr8 = false;\r
294 // start replacing names\r
295 String r8thing;\r
296 String r9thing;\r
297 Iterator<String> it;\r
298 // Converting non-locla function\r
299 it = symbolSet.iterator();\r
300 while (it.hasNext()) {\r
301 r8thing = it.next();\r
8270b34d 302 mi.addLibraryClass(MigrationTool.db.getR9Lib(r8thing), UsageTypes.ALWAYS_CONSUMED);\r
303 //mi.hashrequiredr9libs.add(MigrationTool.db.getR9Lib(r8thing)); // add a library here\r
9f98dbb7 304 \r
305 r8tor9 temp;\r
306 if ((r9thing = MigrationTool.db.getR9Func(r8thing)) != null) {\r
307 if (!r8thing.equals(r9thing)) {\r
308 if (wholeline.contains(r8thing)) {\r
309 wholeline = wholeline.replaceAll(r8thing, r9thing);\r
310 filefunc.add(new r8tor9(r8thing, r9thing));\r
311 Iterator<r8tor9> rt = filefunc.iterator();\r
312 while (rt.hasNext()) {\r
313 temp = rt.next();\r
314 if (MigrationTool.db.r8only.contains(temp.r8thing)) {\r
315 filer8only.add(r8thing);\r
316 mi.hashr8only.add(r8thing);\r
317 addr8 = true;\r
318 }\r
319 }\r
320 }\r
321 }\r
322 }\r
323 } //is any of the guids changed?\r
324 if (addr8 == true) {\r
325 wholeline = addincludefile(wholeline, "\"R8Lib.h\"");\r
326 }\r
327 return wholeline;\r
328 }\r
329\r
10e4f990 330 private final String replaceObsoleteMacro (String wholeline) {\r
331 Matcher mtrmac;\r
332 mtrmac = Pattern.compile("EFI_IDIV_ROUND\\((.*), (.*)\\)").matcher(wholeline);\r
333 if (mtrmac.find()) {\r
334 wholeline = mtrmac.replaceAll("\\($1 \\/ $2 \\+ \\(\\(\\(2 \\* \\($1 \\% $2\\)\\) \\< $2\\) \\? 0 \\: 1\\)\\)");\r
335 }\r
336 mtrmac = Pattern.compile("EFI_MIN\\((.*), (.*)\\)").matcher(wholeline);\r
337 if (mtrmac.find()) {\r
338 wholeline = mtrmac.replaceAll("\\(\\($1 \\< $2\\) \\? $1 \\: $2\\)");\r
339 }\r
340 mtrmac = Pattern.compile("EFI_MAX\\((.*), (.*)\\)").matcher(wholeline);\r
341 if (mtrmac.find()) {\r
342 wholeline = mtrmac.replaceAll("\\(\\($1 \\> $2\\) \\? $1 \\: $2\\)");\r
343 }\r
344 mtrmac = Pattern.compile("EFI_UINTN_ALIGNED\\((.*)\\)").matcher(wholeline);\r
345 if (mtrmac.find()) {\r
346 wholeline = mtrmac.replaceAll("\\(\\(\\(UINTN\\) $1\\) \\& \\(sizeof \\(UINTN\\) \\- 1\\)\\)");\r
347 }\r
348 if (wholeline.contains("EFI_UINTN_ALIGN_MASK")) {\r
349 wholeline = wholeline.replaceAll("EFI_UINTN_ALIGN_MASK", "(sizeof (UINTN) - 1)");\r
350 }\r
351 return wholeline;\r
352 }\r
353\r
27e0221a 354 private final void addr8only() throws Exception {\r
355 String paragraph = null;\r
356 String line = Common.file2string(MigrationTool.db.DatabasePath + File.separator + "R8Lib.c");\r
357 PrintWriter outfile1 = new PrintWriter(new BufferedWriter(new FileWriter(MigrationTool.ModuleInfoMap.get(mi) + File.separator + "Migration_" + mi.modulename + File.separator + "R8Lib.c")));\r
358 PrintWriter outfile2 = new PrintWriter(new BufferedWriter(new FileWriter(MigrationTool.ModuleInfoMap.get(mi) + File.separator + "Migration_" + mi.modulename + File.separator + "R8Lib.h")));\r
359 Pattern ptnr8only = Pattern.compile("////#?(\\w*)?(.*?R8_(\\w*).*?)////~", Pattern.DOTALL);\r
360 Matcher mtrr8only = ptnr8only.matcher(line);\r
361 Matcher mtrr8onlyhead;\r
362 \r
363 //add head comment\r
364 Matcher mtrr8onlyheadcomment = Critic.PTN_NEW_HEAD_COMMENT.matcher(line);\r
365 if (mtrr8onlyheadcomment.find()) {\r
366 outfile1.append(mtrr8onlyheadcomment.group() + "\n\n");\r
367 outfile2.append(mtrr8onlyheadcomment.group() + "\n\n");\r
368 }\r
369 \r
370 //add functions body\r
371 while (mtrr8only.find()) {\r
372 if (mi.hashr8only.contains(mtrr8only.group(3))) {\r
373 paragraph = mtrr8only.group(2);\r
374 outfile1.append(paragraph + "\n\n");\r
375 if (mtrr8only.group(1).length() != 0) {\r
376 mi.hashrequiredr9libs.add(mtrr8only.group(1));\r
377 }\r
378 //generate R8lib.h\r
379 while ((mtrr8onlyhead = Func.ptnbrace.matcher(paragraph)).find()) {\r
380 paragraph = mtrr8onlyhead.replaceAll(";");\r
381 }\r
382 outfile2.append(paragraph + "\n\n");\r
383 }\r
384 }\r
385 outfile1.flush();\r
386 outfile1.close();\r
387 outfile2.flush();\r
388 outfile2.close();\r
389 \r
390 mi.localmodulesources.add("R8Lib.h");\r
391 mi.localmodulesources.add("R8Lib.c");\r
392 }\r
393 //-------------------------------------process functions-------------------------------------//\r
394 \r
395 //-----------------------------------ForDoAll-----------------------------------//\r
396 public void run(String filepath) throws Exception {\r
df87de9b 397 String inname = filepath.replace(mi.temppath + File.separator, "");\r
398 String tempinpath = mi.temppath + File.separator;\r
27e0221a 399 String tempoutpath = MigrationTool.ModuleInfoMap.get(mi) + File.separator + "Migration_" + mi.modulename + File.separator;\r
16b7eeef 400\r
27e0221a 401 Iterator<Common.Laplace> itLaplace = Laplaces.iterator();\r
402 while (itLaplace.hasNext()) {\r
403 Common.Laplace lap = itLaplace.next();\r
404 if (lap.recognize(inname)) {\r
405 MigrationTool.ui.println("\nHandling file: " + inname);\r
406 lap.transform(tempinpath + inname, tempoutpath + lap.namechange(inname));\r
407 }\r
408 }\r
409 }\r
410 \r
411 public boolean filter(File dir) {\r
412 return true;\r
413 }\r
414 //-----------------------------------ForDoAll-----------------------------------//\r
415 \r
416 private final void setModuleInfo(ModuleInfo moduleinfo) {\r
417 mi = moduleinfo;\r
418 }\r
419 \r
420 private final void start() throws Exception {\r
421 Laplaces.add(new DxsLaplace());\r
422 Laplaces.add(new CLaplace());\r
423 Laplaces.add(new IdleLaplace());\r
424 \r
df87de9b 425 Common.toDoAll(mi.temppath, this, Common.FILE);\r
27e0221a 426 \r
427 if (!mi.hashr8only.isEmpty()) {\r
428 addr8only();\r
429 }\r
430 \r
431 Laplaces.clear();\r
432 }\r
433 \r
434 public static final void fireAt(ModuleInfo moduleinfo) throws Exception {\r
435 SFReplacer.setModuleInfo(moduleinfo);\r
436 SFReplacer.start();\r
437 }\r
0dc8c589 438}\r
EFI Development Kit II mirror for PVE