3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 package org
.tianocore
.migration
;
17 import java
.util
.regex
.*;
19 import org
.tianocore
.*;
21 public final class ModuleReader
{
22 private static ModuleInfo mi
;
24 private static final Pattern ptninfequation
= Pattern
.compile("([^\\s]*)\\s*=\\s*([^\\s]*)");
25 private static final Pattern ptnsection
= Pattern
.compile("\\[([^\\[\\]]*)\\]([^\\[\\]]*)\\n", Pattern
.MULTILINE
);
26 private static final Pattern ptnfilename
= Pattern
.compile("[^\\s]+");
28 public static final void ModuleScan(ModuleInfo m
) throws Exception
{
31 Common
.toDoAll(mi
.modulepath
, ModuleInfo
.class.getMethod("enroll", String
.class), mi
, null, Common
.FILE
);
33 String filename
= null;
34 if (mi
.msaorinf
.isEmpty()) {
35 MigrationTool
.ui
.println("No INF nor MSA file found!");
38 if (mi
.msaorinf
.size() == 1) {
39 filename
= (String
)mi
.msaorinf
.toArray()[0];
41 filename
= MigrationTool
.ui
.choose("Found .inf or .msa file for module\n" + mi
.modulepath
+ "\nChoose one Please", mi
.msaorinf
.toArray());
45 if (filename
.contains(".inf")) {
47 } else if (filename
.contains(".msa")) {
51 CommentOutNonLocalHFile();
52 parsePreProcessedSourceCode();
56 private static final void readMsa(String name
) throws Exception
{
57 ModuleSurfaceAreaDocument msadoc
= ModuleSurfaceAreaDocument
.Factory
.parse(new File(mi
.modulepath
+ File
.separator
+ name
));
58 ModuleSurfaceAreaDocument
.ModuleSurfaceArea msa
= msadoc
.getModuleSurfaceArea();
59 MsaHeaderDocument
.MsaHeader msaheader
= msa
.getMsaHeader();
61 mi
.modulename
= msaheader
.getModuleName();
62 mi
.guidvalue
= msaheader
.getGuidValue();
63 mi
.moduletype
= msaheader
.getModuleType().toString(); // ???
65 SourceFilesDocument
.SourceFiles sourcefiles
= msa
.getSourceFiles();
68 Iterator
<FilenameDocument
.Filename
> li
= sourcefiles
.getFilenameList().iterator();
69 while (li
.hasNext()) {
70 if (!mi
.localmodulesources
.contains(temp
= li
.next().toString())) {
71 System
.out
.println("Source File Missing! : " + temp
);
76 private static final void readInf(String name
) throws Exception
{
77 System
.out
.println("\nParsing INF file: " + name
);
79 Matcher mtrinfequation
;
83 wholeline
= Common
.file2string(mi
.modulepath
+ File
.separator
+ name
);
84 mtrsection
= ptnsection
.matcher(wholeline
);
85 while (mtrsection
.find()) {
86 if (mtrsection
.group(1).matches("defines")) {
87 mtrinfequation
= ptninfequation
.matcher(mtrsection
.group(2));
88 while (mtrinfequation
.find()) {
89 if (mtrinfequation
.group(1).matches("BASE_NAME")) {
90 mi
.modulename
= mtrinfequation
.group(2);
92 if (mtrinfequation
.group(1).matches("FILE_GUID")) {
93 mi
.guidvalue
= mtrinfequation
.group(2);
95 if (mtrinfequation
.group(1).matches("COMPONENT_TYPE")) {
96 mi
.moduletype
= mtrinfequation
.group(2);
100 if (mtrsection
.group(1).matches("nmake.common")) {
101 mtrinfequation
= ptninfequation
.matcher(mtrsection
.group(2));
102 while (mtrinfequation
.find()) {
103 if (mtrinfequation
.group(1).matches("IMAGE_ENTRY_POINT")) {
104 mi
.entrypoint
= mtrinfequation
.group(2);
106 if (mtrinfequation
.group(1).matches("DPX_SOURCE")) {
107 if (!mi
.localmodulesources
.contains(mtrinfequation
.group(2))) {
108 MigrationTool
.ui
.println("DPX File Missing! : " + mtrinfequation
.group(2));
113 if (mtrsection
.group(1).contains("sources.")) {
114 mtrfilename
= ptnfilename
.matcher(mtrsection
.group(2));
115 while (mtrfilename
.find()) {
116 if (!mi
.localmodulesources
.contains(mtrfilename
.group())) {
117 MigrationTool
.ui
.println("Source File Missing! : " + mtrfilename
.group());
124 // add '//' to all non-local include lines
125 private static final void CommentOutNonLocalHFile() throws IOException
{
131 Pattern ptninclude
= Pattern
.compile("[\"<](.*[.]h)[\">]");
134 Iterator
<String
> ii
= mi
.localmodulesources
.iterator();
135 while ( ii
.hasNext() ) {
137 rd
= new BufferedReader(new FileReader(mi
.modulepath
+ File
.separator
+ curFile
));
138 Common
.ensureDir(mi
.modulepath
+ File
.separator
+ "temp" + File
.separator
+ curFile
);
139 outfile
= new PrintWriter(new BufferedWriter(new FileWriter(mi
.modulepath
+ File
.separator
+ "temp" + File
.separator
+ curFile
)));
141 while ((line
= rd
.readLine()) != null) {
142 if (line
.contains("#include")) {
143 mtrinclude
= ptninclude
.matcher(line
);
144 if (mtrinclude
.find() && mi
.localmodulesources
.contains(mtrinclude
.group(1))) {
146 line
= MigrationTool
.MIGRATIONCOMMENT
+ line
;
149 outfile
.append(line
+ '\n');
157 private static final void parsePreProcessedSourceCode() throws Exception
{
158 //Cl cl = new Cl(modulepath);
159 //cl.execute("Fat.c");
160 //cl.generateAll(preprocessedccodes);
162 //System.out.println("Note!!!! The CL is not implemented now , pls do it manually!!! RUN :");
163 //System.out.println("cl " + modulepath + "\\temp\\*.c" + " -P");
164 //String[] list = new File(modulepath + File.separator + "temp").list(); // without CL , add
165 BufferedReader rd
= null;
170 Iterator
<String
> ii
= mi
.localmodulesources
.iterator();
171 while (ii
.hasNext()) {
173 if (temp
.contains(".c")) {
174 mi
.preprocessedccodes
.add(temp
);
178 ii
= mi
.preprocessedccodes
.iterator();
180 Pattern patefifuncc
= Pattern
.compile("g?(BS|RT)\\s*->\\s*([a-zA-Z_]\\w*)",Pattern
.MULTILINE
);
181 Pattern patentrypoint
= Pattern
.compile("EFI_([A-Z]*)_ENTRY_POINT\\s*\\(([^\\(\\)]*)\\)",Pattern
.MULTILINE
);
185 Matcher matenclosereplace
;
187 Matcher matentrypoint
;
190 while (ii
.hasNext()) {
191 StringBuffer wholefile
= new StringBuffer();
193 rd
= new BufferedReader(new FileReader(mi
.modulepath
+ File
.separator
+ "temp" + File
.separator
+ ifile
));
194 while ((line
= rd
.readLine()) != null) {
195 wholefile
.append(line
+ '\n');
197 line
= wholefile
.toString();
199 // if this is a Pei phase module , add these library class to .msa
200 matentrypoint
= patentrypoint
.matcher(line
);
201 if (matentrypoint
.find()) {
202 mi
.entrypoint
= matentrypoint
.group(2);
203 if (matentrypoint
.group(1).matches("PEIM")) {
204 mi
.hashrequiredr9libs
.add("PeimEntryPoint");
206 mi
.hashrequiredr9libs
.add("UefiDriverEntryPoint");
211 matguid
= Guid
.ptnguid
.matcher(line
); // several ways to implement this , which one is faster ? :
212 while (matguid
.find()) { // 1.currently , find once , then call to identify which is it
213 if ((temp
= Guid
.register(matguid
, mi
, MigrationTool
.db
)) != null) { // 2.use 3 different matchers , search 3 times to find each
214 //matguid.appendReplacement(result, MigrationTool.db.getR9Guidname(temp)); // search the database for all 3 kinds of guids , high cost
217 //matguid.appendTail(result);
218 //line = result.toString();
220 // find EFI call in form of '->' , many 'gUnicodeCollationInterface->' like things are not changed
221 // This item is not simply replaced , special operation is required.
222 matefifuncc
= patefifuncc
.matcher(line
);
223 while (matefifuncc
.find()) {
224 mi
.hashEFIcall
.add(matefifuncc
.group(2));
227 // find function call
228 matfuncc
= Func
.ptnfuncc
.matcher(line
);
229 while (matfuncc
.find()) {
230 if ((temp
= Func
.register(matfuncc
, mi
, MigrationTool
.db
)) != null) {
231 //MigrationTool.ui.println(ifile + " dofunc " + temp);
232 //matfuncc.appendReplacement(result, MigrationTool.db.getR9Func(temp));
235 //matfuncc.appendTail(result);
236 //line = result.toString();
239 matmacro
= Macro
.ptntmacro
.matcher(line
);
240 while (matmacro
.find()) {
241 if ((temp
= Macro
.register(matmacro
, mi
, MigrationTool
.db
)) != null) {
245 // find function definition
246 // replace all {} to @
247 while ((matenclosereplace
= Func
.ptnbrace
.matcher(line
)).find()) {
248 line
= matenclosereplace
.replaceAll("@");
251 matfuncd
= Func
.ptnfuncd
.matcher(line
);
252 while (matfuncd
.find()) {
253 if ((temp
= Func
.register(matfuncd
, mi
, MigrationTool
.db
)) != null) {
259 Iterator
<String
> funcci
= mi
.hashfuncc
.iterator();
260 while (funcci
.hasNext()) {
261 if (!mi
.hashfuncd
.contains(temp
= funcci
.next()) && !mi
.hashEFIcall
.contains(temp
)) {
262 mi
.hashnonlocalfunc
.add(temp
); // this set contains both changed and not changed items