Add more comments in UefiDriverModelLib

[mirror_edk2.git] / Tools / Source / MigrationTools / org / tianocore / migration / MsaWriter.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
\r
import org.tianocore.*;\r
import org.tianocore.SupportedArchitectures.Enum;\r
import org.apache.xmlbeans.*;\r
\r
public class MsaWriter {\r
	MsaWriter(String path, ModuleInfo moduleinfo, Database database) {\r
		modulepath = path;\r
		mi = moduleinfo;\r
		db = database;\r
	}\r
\r
	private String modulepath;\r
	private ModuleInfo mi;\r
	private Database db;\r
	\r
	private ModuleSurfaceAreaDocument msadoc = ModuleSurfaceAreaDocument.Factory.newInstance();\r
	\r
	private ModuleSurfaceAreaDocument.ModuleSurfaceArea msa = msadoc.addNewModuleSurfaceArea();\r
	private MsaHeaderDocument.MsaHeader msaheader = msa.addNewMsaHeader();\r
	private ModuleDefinitionsDocument.ModuleDefinitions md = msa.addNewModuleDefinitions();\r
	private SourceFilesDocument.SourceFiles sourcefiles = msa.addNewSourceFiles();	//found local .h files are not written\r
	private GuidsDocument.Guids guids = msa.addNewGuids();\r
	private ProtocolsDocument.Protocols protocols = msa.addNewProtocols();\r
	private PPIsDocument.PPIs ppis = msa.addNewPPIs();\r
	private PackageDependenciesDocument.PackageDependencies pd = msa.addNewPackageDependencies();\r
	private LibraryClassDefinitionsDocument.LibraryClassDefinitions libclassdefs = msa.addNewLibraryClassDefinitions();\r
	private ExternsDocument.Externs externs = msa.addNewExterns();\r
	\r
	private String Query (String requirement) throws Exception {\r
		String answer;\r
		BufferedReader rd = new BufferedReader(new InputStreamReader(System.in));\r
		System.out.println(requirement);\r
		while ((answer = rd.readLine()).length() == 0) ;\r
		return answer;\r
	}\r
	\r
	private ModuleSurfaceAreaDocument fulfillMsadoc() throws Exception {\r
		Iterator<String> it;\r
		String temp;\r
		\r
		if (mi.modulename != null) {\r
			msaheader.setModuleName(mi.modulename);\r
		} else {\r
			msaheader.setModuleName(mi.modulename = Query("ModuleName Not Found . Please Input ModuleName"));\r
		}\r
		if (mi.guidvalue != null) {\r
			msaheader.setGuidValue(mi.guidvalue);\r
		} else {\r
			msaheader.setGuidValue(mi.guidvalue = Query("GuidValue Not Found . Please Input GuidValue"));\r
		}\r
		if (mi.moduletype != null) {\r
			if (mi.moduletype.contains("PEI")) {\r
				msaheader.setModuleType(ModuleTypeDef.Enum.forString("PEIM"));\r
			} else {\r
				msaheader.setModuleType(ModuleTypeDef.Enum.forString("DXE_DRIVER"));\r
			}\r
		} else {\r
			msaheader.setModuleType(ModuleTypeDef.Enum.forString(mi.moduletype = Query("GuidValue Not Found . Please Input GuidValue")));\r
		}\r
		msaheader.setCopyright("Copyright (c) 2006, Intel Corporation");\r
		msaheader.setVersion("1.0");\r
		msaheader.setAbstract("Component name for module " + mi.modulename);\r
		msaheader.setDescription("FIX ME!");							//???\r
		msaheader.addNewLicense().setStringValue("All rights reserved.\n" +\r
				"      This software and associated documentation (if any) is furnished\n" +\r
				"      under a license and may only be used or copied in accordance\n" +\r
				"      with the terms of the license. Except as permitted by such\n" +\r
				"      license, no part of this software or documentation may be\n" +\r
				"      reproduced, stored in a retrieval system, or transmitted in any\n" +\r
				"      form or by any means without the express written consent of\n" +\r
				"      Intel Corporation.");\r
		\r
		List<Enum> arch = new ArrayList<Enum>();\r
		arch.add(SupportedArchitectures.IA_32);\r
		arch.add(SupportedArchitectures.X_64);\r
		arch.add(SupportedArchitectures.IPF);\r
		arch.add(SupportedArchitectures.EBC);\r
		md.setSupportedArchitectures(arch);\r
		md.setBinaryModule(false);\r
		md.setOutputFileBasename(mi.modulename);\r
		\r
		pd.addNewPackage().setPackageGuid("5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec");\r
		externs.addNewSpecification().setStringValue("EFI_SPECIFICATION_VERSION 0x00020000");\r
		externs.addNewSpecification().setStringValue("EDK_RELEASE_VERSION 0x00020000");\r
		externs.addNewExtern().setModuleEntryPoint(mi.entrypoint);\r
		\r
		it = mi.localmodulesources.iterator();\r
		while (it.hasNext()) {\r
			sourcefiles.addNewFilename().setStringValue(it.next());\r
		}\r
		it = mi.protocol.iterator();\r
		while (it.hasNext()) {\r
			if ((temp = it.next()) != null) {\r
				ProtocolsDocument.Protocols.Protocol pr = protocols.addNewProtocol();\r
				pr.setProtocolCName(temp);\r
				pr.setUsage(UsageTypes.ALWAYS_CONSUMED);\r
			}\r
		}\r
		it = mi.ppi.iterator();\r
		while (it.hasNext()) {\r
			if ((temp = it.next()) != null) {\r
				PPIsDocument.PPIs.Ppi pp = ppis.addNewPpi();\r
				pp.setPpiCName(temp);\r
				pp.setUsage(UsageTypes.ALWAYS_CONSUMED);\r
			}\r
		}\r
		it = mi.guid.iterator();\r
		while (it.hasNext()) {\r
			if ((temp = it.next()) != null) {\r
				GuidsDocument.Guids.GuidCNames gcn = guids.addNewGuidCNames();\r
				gcn.setGuidCName(temp);\r
				gcn.setUsage(UsageTypes.ALWAYS_CONSUMED);\r
			}\r
		}\r
		it = mi.hashrequiredr9libs.iterator();\r
		while (it.hasNext()) {\r
			if ((temp = it.next()) != null && !temp.matches("%")) {\r
				LibraryClassDocument.LibraryClass lc = libclassdefs.addNewLibraryClass();\r
				lc.setKeyword(temp);\r
				lc.setUsage(UsageTypes.ALWAYS_CONSUMED);\r
			}\r
		}\r
		\r
		return msadoc;\r
	}\r
	\r
	public void flush() throws Exception {\r
        XmlOptions options = new XmlOptions();\r
\r
        options.setCharacterEncoding("UTF-8");\r
        options.setSavePrettyPrint();\r
        options.setSavePrettyPrintIndent(2);\r
        options.setUseDefaultNamespace();\r
        \r
		BufferedWriter bw = new BufferedWriter(new FileWriter(modulepath + File.separator + "result" + File.separator + mi.modulename + ".msa"));\r
		fulfillMsadoc().save(bw, options);\r
		bw.flush();\r
		bw.close();\r
	}\r
}\r