Add Critic.java

[mirror_edk2.git] / Tools / Source / MigrationTools / org / tianocore / migration / ModuleInfo.java

/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
 \r
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
package org.tianocore.migration;\r
\r
import java.io.*;\r
import java.util.*;\r
import java.util.regex.*;\r
\r
/*\r
	Class ModuleInfo is built for scanning the source files, it contains all the needed\r
information and all the temporary data.\r
*/\r
public class ModuleInfo {\r
	ModuleInfo(String modulepath, UI ui, Database db) throws Exception {\r
		this.modulepath = modulepath;\r
		this.ui = ui;\r
		this.db = db;\r
		moduleScan();\r
	}\r
	\r
	private String modulepath = null;\r
	private Database db = null;\r
	private UI ui = null;\r
	\r
	public String modulename = null;\r
	public String guidvalue = null;\r
	public String moduletype = null;\r
	public String entrypoint = null;\r
	\r
	public Set<String> localmodulesources = new HashSet<String>();		//contains both .c and .h\r
	public Set<String> preprocessedccodes = new HashSet<String>();\r
	public Set<String> msaorinf = new HashSet<String>();				//only a little, hash may be too big for this\r
	\r
	public Set<String> hashfuncc = new HashSet<String>();\r
	public Set<String> hashfuncd = new HashSet<String>();\r
	public Set<String> hashnonlocalfunc = new HashSet<String>();\r
	public Set<String> hashnonlocalmacro = new HashSet<String>();\r
	public Set<String> hashEFIcall = new HashSet<String>();\r
	public Set<String> hashr8only = new HashSet<String>();\r
	\r
	public Set<String> hashrequiredr9libs = new HashSet<String>();	// hashrequiredr9libs is now all added in SourceFileReplacer \r
	public Set<String> guid = new HashSet<String>();\r
	public Set<String> protocol = new HashSet<String>();\r
	public Set<String> ppi = new HashSet<String>();\r
	\r
	private static String migrationcomment = "//%$//";\r
	\r
	private void dirScan(String subpath) throws Exception {\r
		String[] list = new File(modulepath + File.separator + subpath).list();			// if no sub , separator need?\r
		File test;\r
		\r
		for (int i = 0 ; i < list.length ; i++) {\r
			test = new File(modulepath + File.separator + subpath + list[i]);\r
			if (test.isDirectory()) {\r
				if (list[i].contains("result") || list[i].contains("temp")) {\r
				} else {\r
					dirScan(subpath + list[i] + File.separator);\r
				}\r
			} else {\r
				if (list[i].contains(".c") || list[i].contains(".C") || list[i].contains(".h") || \r
					list[i].contains(".H") || list[i].contains(".dxs") || list[i].contains(".uni")) {\r
					localmodulesources.add(subpath + list[i]);\r
				} else if (list[i].contains(".inf") || list[i].contains(".msa")) {\r
					msaorinf.add(subpath + list[i]);\r
				}\r
			}\r
		}\r
	}\r
	\r
	private void moduleScan() throws Exception {\r
		dirScan("");\r
		String filename = null;\r
		if (msaorinf.isEmpty()) {\r
			ui.println("No INF nor MSA file found!");\r
			System.exit(0);\r
		} else {\r
			filename = ui.choose("Found .inf or .msa file in the module\nChoose one Please", msaorinf.toArray());\r
		}\r
		ModuleReader mr = new ModuleReader(modulepath, this, db, ui);\r
		if (filename.contains(".inf")) {\r
			mr.readInf(filename);\r
		} else if (filename.contains(".msa")) {\r
			mr.readMsa(filename);\r
		}\r
		\r
		CommentOutNonLocalHFile();\r
		parsePreProcessedSourceCode();\r
		\r
		new SourceFileReplacer(modulepath, this, db, ui).flush();	// some adding library actions are taken here,so it must be put before "MsaWriter"\r
		\r
		// show result\r
		if (ui.yesOrNo("Parse of the Module Information has completed. View details?")) {\r
			ui.println("\nModule Information : ");\r
			ui.println("Entrypoint : " + entrypoint);\r
			show(protocol, "Protocol : ");\r
			show(ppi, "Ppi : ");\r
			show(guid, "Guid : ");\r
			show(hashfuncc, "call : ");\r
			show(hashfuncd, "def : ");\r
			show(hashEFIcall, "EFIcall : ");\r
			show(hashnonlocalmacro, "macro : ");\r
			show(hashnonlocalfunc, "nonlocal : ");\r
			show(hashr8only, "hashr8only : ");\r
		}\r
		\r
		new MsaWriter(modulepath, this, db, ui).flush();\r
		\r
		// remove temp directory\r
		//File tempdir = new File(modulepath + File.separator + "temp");\r
		//System.out.println("Deleting Dir");\r
		//if (tempdir.exists()) tempdir.d;\r
		\r
		ui.println("Errors Left : " + db.error);\r
		ui.println("Complete!");\r
		ui.println("Your R9 module was placed here: " + modulepath + File.separator + "result");\r
		ui.println("Your logfile was placed here: " + modulepath);\r
	}\r
	\r
	private void show(Set<String> hash, String show) {\r
		ui.println(show + hash.size());\r
		ui.println(hash);\r
	}\r
	\r
	// add '//' to all non-local include lines\r
	private void CommentOutNonLocalHFile() throws IOException {\r
		BufferedReader rd;\r
		String line;\r
		String curFile;\r
		PrintWriter outfile;\r
\r
		Pattern ptninclude = Pattern.compile("[\"<](.*[.]h)[\">]");\r
		Matcher mtrinclude;\r
		\r
		Iterator<String> ii = localmodulesources.iterator();\r
		while ( ii.hasNext() ) {\r
			curFile = ii.next();\r
			rd = new BufferedReader(new FileReader(modulepath + File.separator + curFile));\r
			Common.ensureDir(modulepath + File.separator + "temp" + File.separator + curFile);\r
			outfile = new PrintWriter(new BufferedWriter(new FileWriter(modulepath + File.separator + "temp" + File.separator + curFile)));\r
			while ((line = rd.readLine()) != null) {\r
				if (line.contains("#include")) {\r
					mtrinclude = ptninclude.matcher(line);\r
					if (mtrinclude.find() && localmodulesources.contains(mtrinclude.group(1))) {\r
					} else {\r
						line = migrationcomment + line;\r
					}\r
				}\r
				outfile.append(line + '\n');\r
			}\r
			outfile.flush();\r
			outfile.close();\r
		}\r
	}\r
\r
	private void parsePreProcessedSourceCode() throws Exception {\r
		//Cl cl = new Cl(modulepath);\r
		//cl.execute("Fat.c");\r
		//cl.generateAll(preprocessedccodes);\r
		//\r
		//System.out.println("Note!!!! The CL is not implemented now , pls do it manually!!! RUN :");\r
		//System.out.println("cl " + modulepath + "\\temp\\*.c" + " -P");\r
		//String[] list = new File(modulepath + File.separator + "temp").list();	// without CL , add\r
		BufferedReader rd = null;\r
		String ifile = null;\r
		String line = null;\r
		String temp = null;\r
		\r
		Iterator<String> ii = localmodulesources.iterator();\r
		while (ii.hasNext()) {\r
			temp = ii.next();\r
			if (temp.contains(".c")) {\r
				preprocessedccodes.add(temp);\r
			}\r
		}\r
		\r
		ii = preprocessedccodes.iterator();\r
		\r
		Pattern patefifuncc = Pattern.compile("g?(BS|RT)\\s*->\\s*([a-zA-Z_]\\w*)",Pattern.MULTILINE);\r
		Pattern patentrypoint = Pattern.compile("EFI_([A-Z]*)_ENTRY_POINT\\s*\\(([^\\(\\)]*)\\)",Pattern.MULTILINE);\r
		Matcher matguid;\r
		Matcher matfuncc;\r
		Matcher matfuncd;\r
		Matcher matenclosereplace;\r
		Matcher matefifuncc;\r
		Matcher matentrypoint;\r
		Matcher matmacro;\r
		\r
		while (ii.hasNext()) {\r
			StringBuffer wholefile = new StringBuffer();\r
			ifile = ii.next();\r
			rd = new BufferedReader(new FileReader(modulepath + File.separator + "temp" + File.separator + ifile));\r
			while ((line = rd.readLine()) != null) {\r
				wholefile.append(line + '\n');\r
			}\r
			line = wholefile.toString();\r
			\r
			// if this is a Pei phase module , add these library class to .msa\r
			matentrypoint = patentrypoint.matcher(line);\r
			if (matentrypoint.find()) {\r
				entrypoint = matentrypoint.group(2);\r
				if (matentrypoint.group(1).matches("PEIM")) {\r
					hashrequiredr9libs.add("PeimEntryPoint");\r
				} else {\r
					hashrequiredr9libs.add("UefiDriverEntryPoint");\r
				}\r
			}\r
			\r
			// find guid\r
			matguid = Guid.ptnguid.matcher(line);										// several ways to implement this , which one is faster ? :\r
			while (matguid.find()) {													// 1.currently , find once , then call to identify which is it\r
				if ((temp = Guid.register(matguid, this, db)) != null) {			// 2.use 3 different matchers , search 3 times to find each\r
					//matguid.appendReplacement(result, db.getR9Guidname(temp));		// search the database for all 3 kinds of guids , high cost\r
				}\r
			}\r
			//matguid.appendTail(result);\r
			//line = result.toString();\r
\r
			// find EFI call in form of '->' , many 'gUnicodeCollationInterface->' like things are not changed\r
			// This item is not simply replaced , special operation is required.\r
			matefifuncc = patefifuncc.matcher(line);\r
			while (matefifuncc.find()) {\r
				hashEFIcall.add(matefifuncc.group(2));\r
			}\r
\r
			// find function call\r
			matfuncc = Func.ptnfuncc.matcher(line);\r
			while (matfuncc.find()) {\r
				if ((temp = Func.register(matfuncc, this, db)) != null) {\r
					//ui.println(ifile + "  dofunc  " + temp);\r
					//matfuncc.appendReplacement(result, db.getR9Func(temp));\r
				}\r
			}\r
			//matfuncc.appendTail(result);\r
			//line = result.toString();\r
\r
			// find macro\r
			matmacro = Macro.ptntmacro.matcher(line);\r
			while (matmacro.find()) {\r
				if ((temp = Macro.register(matmacro, this, db)) != null) {\r
				}\r
			}\r
			\r
			// find function definition\r
			// replace all {} to @\r
			while ((matenclosereplace = Func.ptnbrace.matcher(line)).find()) {\r
				line = matenclosereplace.replaceAll("@");\r
			}\r
\r
			matfuncd = Func.ptnfuncd.matcher(line);\r
			while (matfuncd.find()) {\r
				if ((temp = Func.register(matfuncd, this, db)) != null) {\r
				}\r
			}\r
		}\r
		\r
		// op on hash\r
		Iterator<String> funcci = hashfuncc.iterator();\r
		while (funcci.hasNext()) {\r
			if (!hashfuncd.contains(temp = funcci.next()) && !hashEFIcall.contains(temp)) {\r
				hashnonlocalfunc.add(temp);					// this set contains both changed and not changed items\r
			}\r
		}\r
	}\r
	\r
	public static void main(String[] args) throws Exception {\r
		FirstPanel.init();\r
	}\r
}