Add EntryPointLib class once ImageEntryPoint is found in inf file.
[mirror_edk2.git] / Tools / Source / MigrationTools / org / tianocore / migration / ModuleReader.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.*;\r
446e26ee 18\r
0dc8c589 19import org.tianocore.*;\r
20\r
39e5e412 21public final class ModuleReader implements Common.ForDoAll {\r
22 private static final ModuleReader modulereader = new ModuleReader();\r
23 private ModuleInfo mi;\r
24 private final CommentLaplace commentlaplace = new CommentLaplace();\r
27e0221a 25 \r
26 private static final Pattern ptninfequation = Pattern.compile("([^\\s]*)\\s*=\\s*([^\\s]*)");\r
27 private static final Pattern ptnsection = Pattern.compile("\\[([^\\[\\]]*)\\]([^\\[\\]]*)\\n", Pattern.MULTILINE);\r
28 private static final Pattern ptnfilename = Pattern.compile("[^\\s]+");\r
29 \r
39e5e412 30 public final void ModuleScan() throws Exception {\r
27e0221a 31 Common.toDoAll(mi.modulepath, ModuleInfo.class.getMethod("enroll", String.class), mi, null, Common.FILE);\r
cfdfbaca 32\r
39e5e412 33 // inf&msa\r
27e0221a 34 String filename = null;\r
35 if (mi.msaorinf.isEmpty()) {\r
36 MigrationTool.ui.println("No INF nor MSA file found!");\r
37 System.exit(0);\r
38 } else {\r
39 if (mi.msaorinf.size() == 1) {\r
40 filename = (String)mi.msaorinf.toArray()[0];\r
41 } else {\r
42 filename = MigrationTool.ui.choose("Found .inf or .msa file for module\n" + mi.modulepath + "\nChoose one Please", mi.msaorinf.toArray());\r
43 }\r
44 }\r
5f4eb6b6 45\r
27e0221a 46 if (filename.contains(".inf")) {\r
47 readInf(filename);\r
48 } else if (filename.contains(".msa")) {\r
49 readMsa(filename);\r
50 }\r
39e5e412 51 // inf&msa\r
cfdfbaca 52\r
39e5e412 53 preProcessModule();\r
27e0221a 54 }\r
55 \r
39e5e412 56 private final void readMsa(String name) throws Exception {\r
27e0221a 57 ModuleSurfaceAreaDocument msadoc = ModuleSurfaceAreaDocument.Factory.parse(new File(mi.modulepath + File.separator + name));\r
58 ModuleSurfaceAreaDocument.ModuleSurfaceArea msa = msadoc.getModuleSurfaceArea();\r
59 MsaHeaderDocument.MsaHeader msaheader = msa.getMsaHeader();\r
7bcb8d17 60\r
27e0221a 61 mi.modulename = msaheader.getModuleName();\r
62 mi.guidvalue = msaheader.getGuidValue();\r
63 mi.moduletype = msaheader.getModuleType().toString(); // ???\r
7bcb8d17 64\r
27e0221a 65 SourceFilesDocument.SourceFiles sourcefiles = msa.getSourceFiles();\r
66 \r
67 String temp;\r
68 Iterator<FilenameDocument.Filename> li = sourcefiles.getFilenameList().iterator();\r
69 while (li.hasNext()) {\r
70 if (!mi.localmodulesources.contains(temp = li.next().toString())) {\r
71 System.out.println("Source File Missing! : " + temp);\r
72 }\r
73 }\r
74 }\r
75 \r
39e5e412 76 private final void readInf(String name) throws Exception {\r
27e0221a 77 System.out.println("\nParsing INF file: " + name);\r
78 String wholeline;\r
79 Matcher mtrinfequation;\r
80 Matcher mtrsection;\r
81 Matcher mtrfilename;\r
0dc8c589 82\r
27e0221a 83 wholeline = Common.file2string(mi.modulepath + File.separator + name);\r
84 mtrsection = ptnsection.matcher(wholeline);\r
85 while (mtrsection.find()) {\r
86 if (mtrsection.group(1).matches("defines")) {\r
87 mtrinfequation = ptninfequation.matcher(mtrsection.group(2));\r
88 while (mtrinfequation.find()) {\r
89 if (mtrinfequation.group(1).matches("BASE_NAME")) {\r
90 mi.modulename = mtrinfequation.group(2);\r
91 }\r
92 if (mtrinfequation.group(1).matches("FILE_GUID")) {\r
93 mi.guidvalue = mtrinfequation.group(2);\r
94 }\r
95 if (mtrinfequation.group(1).matches("COMPONENT_TYPE")) {\r
96 mi.moduletype = mtrinfequation.group(2);\r
97 }\r
98 }\r
99 }\r
77dd49a7 100 if (mtrsection.group(1).contains("nmake.")) {\r
27e0221a 101 mtrinfequation = ptninfequation.matcher(mtrsection.group(2));\r
102 while (mtrinfequation.find()) {\r
103 if (mtrinfequation.group(1).matches("IMAGE_ENTRY_POINT")) {\r
104 mi.entrypoint = mtrinfequation.group(2);\r
0e9d14c4 105 mi.hashrequiredr9libs.add("EntryPointLib");\r
27e0221a 106 }\r
107 if (mtrinfequation.group(1).matches("DPX_SOURCE")) {\r
108 if (!mi.localmodulesources.contains(mtrinfequation.group(2))) {\r
109 MigrationTool.ui.println("DPX File Missing! : " + mtrinfequation.group(2));\r
110 }\r
111 }\r
112 }\r
113 }\r
114 if (mtrsection.group(1).contains("sources.")) {\r
115 mtrfilename = ptnfilename.matcher(mtrsection.group(2));\r
116 while (mtrfilename.find()) {\r
39e5e412 117 mi.infsources.add(mtrfilename.group());\r
27e0221a 118 if (!mi.localmodulesources.contains(mtrfilename.group())) {\r
39e5e412 119 MigrationTool.ui.println("Warn: Source File Missing! : " + mtrfilename.group());\r
27e0221a 120 }\r
121 }\r
122 }\r
0e9d14c4 123 if (mtrsection.group(1).matches("includes.")) {\r
39e5e412 124 mtrfilename = ptnfilename.matcher(mtrsection.group(2));\r
125 while (mtrfilename.find()) {\r
126 mi.infincludes.add(mtrfilename.group());\r
127 }\r
128 }\r
27e0221a 129 }\r
130 }\r
131 \r
39e5e412 132 private final void preProcessModule() throws Exception {\r
133 // according to .inf file, add extraordinary includes and sourcefiles\r
77dd49a7 134 Common.dirCopy(mi.modulepath, mi.modulepath + File.separator + "temp"); // collect all Laplace.namechange to here???\r
39e5e412 135 \r
136 if (!mi.infincludes.isEmpty()) {\r
137 Iterator<String> it = mi.infincludes.iterator();\r
138 String tempincludename = null;\r
139 while (it.hasNext()) {\r
140 tempincludename = it.next();\r
141 if (tempincludename.contains("..")) {\r
142 Matcher mtr = Common.PTNSEPARATER.matcher(tempincludename);\r
143 if (mtr.find() && !mtr.group(2).matches(".")) {\r
144 Common.oneLevelDirCopy(mi.modulepath.replaceAll(Common.STRSEPARATER, "$1") + File.separator + mtr.group(2), mi.modulepath + File.separator + "temp", ".h");\r
145 } else {\r
146 Common.oneLevelDirCopy(mi.modulepath.replaceAll(Common.STRSEPARATER, "$1"), mi.modulepath + File.separator + "temp", ".h");\r
147 }\r
148 }\r
149 }\r
150 }\r
151 if (!mi.infsources.isEmpty()) {\r
152 Iterator<String> it = mi.infsources.iterator();\r
153 String tempsourcename = null;\r
154 while (it.hasNext()) {\r
155 tempsourcename = it.next();\r
156 if (tempsourcename.contains("..")) {\r
157 Common.ensureDir(mi.modulepath + File.separator + "temp" + File.separator + "MT_Parent_Sources");\r
158 Matcher mtr = Common.PTNSEPARATER.matcher(tempsourcename);\r
159 if (mtr.find()) {\r
160 Common.fileCopy(mi.modulepath.replaceAll(Common.STRSEPARATER, "$1") + File.separator + mtr.group(2), mi.modulepath + File.separator + "temp" + File.separator + "MT_Parent_Sources" + File.separator + mtr.group(2));\r
161 }\r
162 }\r
163 }\r
164 }\r
446e26ee 165\r
39e5e412 166 //CommentOutNonLocalHFile();\r
167 Common.toDoAll(mi.modulepath + File.separator + "temp", this, Common.FILE);\r
168 \r
169 parsePreProcessedSourceCode();\r
446e26ee 170\r
27e0221a 171 }\r
446e26ee 172\r
39e5e412 173 private final void parsePreProcessedSourceCode() throws Exception {\r
27e0221a 174 //Cl cl = new Cl(modulepath);\r
175 //cl.execute("Fat.c");\r
176 //cl.generateAll(preprocessedccodes);\r
177 //\r
178 //System.out.println("Note!!!! The CL is not implemented now , pls do it manually!!! RUN :");\r
179 //System.out.println("cl " + modulepath + "\\temp\\*.c" + " -P");\r
180 //String[] list = new File(modulepath + File.separator + "temp").list(); // without CL , add\r
181 BufferedReader rd = null;\r
182 String ifile = null;\r
183 String line = null;\r
184 String temp = null;\r
185 \r
186 Iterator<String> ii = mi.localmodulesources.iterator();\r
187 while (ii.hasNext()) {\r
188 temp = ii.next();\r
189 if (temp.contains(".c")) {\r
190 mi.preprocessedccodes.add(temp);\r
191 }\r
192 }\r
193 \r
194 ii = mi.preprocessedccodes.iterator();\r
195 \r
196 Pattern patefifuncc = Pattern.compile("g?(BS|RT)\\s*->\\s*([a-zA-Z_]\\w*)",Pattern.MULTILINE);\r
197 Pattern patentrypoint = Pattern.compile("EFI_([A-Z]*)_ENTRY_POINT\\s*\\(([^\\(\\)]*)\\)",Pattern.MULTILINE);\r
198 Matcher matguid;\r
199 Matcher matfuncc;\r
200 Matcher matfuncd;\r
201 Matcher matenclosereplace;\r
202 Matcher matefifuncc;\r
203 Matcher matentrypoint;\r
204 Matcher matmacro;\r
205 \r
206 while (ii.hasNext()) {\r
207 StringBuffer wholefile = new StringBuffer();\r
208 ifile = ii.next();\r
209 rd = new BufferedReader(new FileReader(mi.modulepath + File.separator + "temp" + File.separator + ifile));\r
210 while ((line = rd.readLine()) != null) {\r
211 wholefile.append(line + '\n');\r
212 }\r
213 line = wholefile.toString();\r
214 \r
215 // if this is a Pei phase module , add these library class to .msa\r
216 matentrypoint = patentrypoint.matcher(line);\r
217 if (matentrypoint.find()) {\r
218 mi.entrypoint = matentrypoint.group(2);\r
219 if (matentrypoint.group(1).matches("PEIM")) {\r
220 mi.hashrequiredr9libs.add("PeimEntryPoint");\r
221 } else {\r
222 mi.hashrequiredr9libs.add("UefiDriverEntryPoint");\r
223 }\r
224 }\r
225 \r
226 // find guid\r
227 matguid = Guid.ptnguid.matcher(line); // several ways to implement this , which one is faster ? :\r
228 while (matguid.find()) { // 1.currently , find once , then call to identify which is it\r
229 if ((temp = Guid.register(matguid, mi, MigrationTool.db)) != null) { // 2.use 3 different matchers , search 3 times to find each\r
230 //matguid.appendReplacement(result, MigrationTool.db.getR9Guidname(temp)); // search the database for all 3 kinds of guids , high cost\r
231 }\r
232 }\r
233 //matguid.appendTail(result);\r
234 //line = result.toString();\r
446e26ee 235\r
27e0221a 236 // find EFI call in form of '->' , many 'gUnicodeCollationInterface->' like things are not changed\r
237 // This item is not simply replaced , special operation is required.\r
238 matefifuncc = patefifuncc.matcher(line);\r
239 while (matefifuncc.find()) {\r
240 mi.hashEFIcall.add(matefifuncc.group(2));\r
241 }\r
446e26ee 242\r
27e0221a 243 // find function call\r
244 matfuncc = Func.ptnfuncc.matcher(line);\r
245 while (matfuncc.find()) {\r
246 if ((temp = Func.register(matfuncc, mi, MigrationTool.db)) != null) {\r
247 //MigrationTool.ui.println(ifile + " dofunc " + temp);\r
248 //matfuncc.appendReplacement(result, MigrationTool.db.getR9Func(temp));\r
249 }\r
250 }\r
251 //matfuncc.appendTail(result);\r
252 //line = result.toString();\r
446e26ee 253\r
27e0221a 254 // find macro\r
255 matmacro = Macro.ptntmacro.matcher(line);\r
256 while (matmacro.find()) {\r
257 if ((temp = Macro.register(matmacro, mi, MigrationTool.db)) != null) {\r
258 }\r
259 }\r
260 \r
261 // find function definition\r
262 // replace all {} to @\r
263 while ((matenclosereplace = Func.ptnbrace.matcher(line)).find()) {\r
264 line = matenclosereplace.replaceAll("@");\r
265 }\r
446e26ee 266\r
27e0221a 267 matfuncd = Func.ptnfuncd.matcher(line);\r
268 while (matfuncd.find()) {\r
269 if ((temp = Func.register(matfuncd, mi, MigrationTool.db)) != null) {\r
270 }\r
271 }\r
272 }\r
273 \r
274 // op on hash\r
275 Iterator<String> funcci = mi.hashfuncc.iterator();\r
276 while (funcci.hasNext()) {\r
277 if (!mi.hashfuncd.contains(temp = funcci.next()) && !mi.hashEFIcall.contains(temp)) {\r
278 mi.hashnonlocalfunc.add(temp); // this set contains both changed and not changed items\r
279 }\r
280 }\r
281 }\r
39e5e412 282 \r
283 public class CommentLaplace extends Common.Laplace {\r
284 public String operation(String wholeline) {\r
285 StringBuffer wholebuffer = new StringBuffer();\r
286 String templine = null;\r
287 Pattern ptnincludefile = Pattern.compile("[\"<](.*[.]h)[\">]");\r
288 Pattern ptninclude = Pattern.compile("#include\\s*(.*)");\r
289 Matcher mtrinclude = ptninclude.matcher(wholeline);\r
290 Matcher mtrincludefile = null;\r
291 while (mtrinclude.find()) {\r
292 mtrincludefile = ptnincludefile.matcher(mtrinclude.group(1));\r
293 if (mtrincludefile.find() && mi.localmodulesources.contains(mtrincludefile.group(1))) {\r
294 templine = mtrinclude.group();\r
295 } else {\r
296 templine = MigrationTool.MIGRATIONCOMMENT + mtrinclude.group();\r
297 }\r
298 mtrinclude.appendReplacement(wholebuffer, templine);\r
299 }\r
300 mtrinclude.appendTail(wholebuffer);\r
301 return wholebuffer.toString();\r
302 }\r
303 \r
304 public boolean recognize(String filename) {\r
305 return filename.contains(".c") || filename.contains(".h");\r
306 }\r
307 \r
308 public String namechange(String oldname) {\r
309 return oldname;\r
310 }\r
311 }\r
312\r
313 //-----------------------------------ForDoAll-----------------------------------//\r
314 public void run(String filepath) throws Exception {\r
315 String name = mi.modulepath + File.separator + "temp" + File.separator + filepath.replace(mi.modulepath + File.separator + "temp" + File.separator, "");\r
316 commentlaplace.transform(name, name);\r
317 }\r
318\r
319 public boolean filter(File dir) {\r
320 return true;\r
321 }\r
322 //-----------------------------------ForDoAll-----------------------------------//\r
323 \r
324 public final void setModuleInfo(ModuleInfo m) {\r
325 mi = m;\r
326 }\r
327 \r
328 public static final void aimAt(ModuleInfo mi) throws Exception {\r
329 modulereader.setModuleInfo(mi);\r
330 modulereader.ModuleScan();\r
331 }\r
719cebfe 332}\r