[mirror_edk2.git] / Tools / Java / Source / GenBuild / org / tianocore / build / FileProcess.java

/** @file\r
  File is FileProcess class which is used to generate ANT script to build \r
  source files. \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
package org.tianocore.build;\r
\r
import java.io.File;\r
\r
import org.apache.tools.ant.BuildException;\r
import org.apache.tools.ant.Project;\r
import org.w3c.dom.Document;\r
import org.w3c.dom.Element;\r
import org.w3c.dom.Node;\r
\r
/**\r
  <p><code>FileProcess</code> is class to generate ANT script to build source\r
  files.</p>\r
  \r
  <p>If file does not specify file type, <code>FileProcess</code> will judge \r
  by its extension. Following is the current supported extensions. </p>\r
  \r
  <pre>   \r
 Source File Suffix     File Type       Description\r
    .h                   CHeader      C header file\r
    .c                   CCode        C source file\r
    .inc                 ASMHeader    Assembly header file\r
    .asm                 ASM          Assembly source file, usually for IA32 and X64 Arch and MSFT tool chain\r
    .S                   ASM          Assembly source file, usually for IPF Arch\r
    .s                   ASM          Assembly source file, usually for IA32 and X64 Arch and GCC tool chain\r
    .uni                 UNI          Unicode file\r
    .vfr                 VFR          Visual Forms Representation File\r
    .fv                  FV           Firmware Volume\r
    .SEC                 FFS          Firmware File System file\r
    .PEI                 FFS          Firmware File System file\r
    .DXE                 FFS          Firmware File System file\r
    .APP                 FFS          Firmware File System file\r
    .FVI                 FFS          Firmware File System file\r
    .FFS                 FFS          Firmware File System file\r
    .bmp                 BMP          Graphic File\r
    .i                   PPCode       IPF PreProcessor Code\r
  </pre>\r
  \r
  @since GenBuild 1.0\r
**/\r
public class FileProcess {\r
    ///\r
    ///  The mapping information about source suffix, tool code, file type.\r
    ///\r
    public final String[][] fileTypes = { {".h", "", "CHeader" }, \r
                                          {".c", "CC", "CCode" },\r
                                          {".inc", "", "ASMHeader" },\r
                                          {".asm", "ASM", "ASM" }, \r
                                          {".S", "ASM", "ASM" },\r
                                          {".s", "ASM", "ASM" },\r
                                          {".uni", "", "UNI" },\r
                                          {".vfr", "", "VFR" },\r
                                          {".Vfr", "", "VFR" },\r
                                          {".dxs", "", "DPX"},\r
                                          {".fv", "", "FV" },\r
                                          {".efi", "", "EFI" },\r
                                          {".SEC", "", "FFS" },\r
                                          {".PEI", "", "FFS" },\r
                                          {".DXE", "", "FFS" },\r
                                          {".APP", "", "FFS" },\r
                                          {".FYI", "", "FFS" },\r
                                          {".FFS", "", "FFS" },\r
                                          {".bmp", "", "BMP" },\r
                                          {".i", "PP", "PPCode"}};\r
    ///\r
    /// Current ANT context. \r
    ///\r
    private Project project;\r
\r
    ///\r
    /// Current module's include pathes\r
    ///\r
    private String[] includes;\r
    \r
    ///\r
    /// Xml Document.\r
    ///\r
    private Document document;\r
    \r
    ///\r
    /// The flag to ensure all unicode files build before others. \r
    ///\r
    private boolean unicodeFirst = true;\r
    \r
    ///\r
    /// The flag present whether current module contains Unicode files or not.\r
    ///\r
    private boolean unicodeExist = false;\r
\r
    /**\r
      Initialize the project, includes, sourceFiles, document members.\r
      \r
      @param project ANT project\r
      @param includes Module include pathes\r
      @param sourceFiles Modules source files\r
      @param document XML document\r
    **/\r
    public void init(Project project, String[] includes, Document document) {\r
        this.document = document;\r
        this.includes = includes;\r
        this.project = project;\r
    }\r
\r
    /**\r
      Parse file without file type. \r
      \r
      @param filename Source file name\r
      @param root Root node\r
      @param unicodeFirst whether build Unicode file firstly or not\r
    **/\r
    public synchronized void parseFile(String filename, String family, Node root, boolean unicodeFirst) {\r
        this.unicodeFirst = unicodeFirst;\r
        parseFile(filename, family, root);\r
    }\r
    \r
    /**\r
      Get whether current module contains Unicode files or not.\r
      \r
      @return Whether current module contains Unicode files or not\r
    **/\r
    public boolean isUnicodeExist() {\r
        return unicodeExist;\r
    }\r
\r
    /**\r
      Parse file.\r
      \r
      @param filename Source file name\r
      @param filetype Source file type\r
      @param root Root node\r
      @param unicodeFirst whether build Unicode file firstly or not\r
    **/\r
    public synchronized void parseFile(String filename, String filetype, String family, Node root, boolean unicodeFirst) {\r
        this.unicodeFirst = unicodeFirst;\r
        parseFile(filename, filetype, family, root);\r
    }\r
    \r
    /**\r
      Find out source file's type. \r
      \r
      @param filename Source file name\r
      @param root Root node\r
    **/\r
    public synchronized void parseFile(String filename, String family, Node root) throws BuildException {\r
        for (int i = 0; i < fileTypes.length; i++) {\r
            if (filename.endsWith(fileTypes[i][0])) {\r
                parseFile(filename, fileTypes[i][2], family, root);\r
                return ;\r
            }\r
        }\r
    }\r
\r
    /**\r
      Parse file. If flag <code>unicodeFirst</code> is true, then build all\r
      unicode files firstly. \r
      \r
      <p>Note that AutoGen.c is processed specially. It's output path is always\r
      <code>${DEST_DIR_OUTPUT}</code>, others are <code>${DEST_DIR_OUTPUT}</code>\r
      and relative to module path. </p>\r
      \r
      @param filename Source file name\r
      @param filetype Source file type\r
      @param root Root node\r
    **/\r
    public synchronized void parseFile(String filename, String filetype, String family, Node root) {\r
        //\r
        // Filter file with family. Only family is specified in source file and\r
        // not include current family will skip the file. \r
        //\r
        String toolCode = getToolCodeByFileType(filetype);\r
        if (family != null && !family.trim().equalsIgnoreCase("")) {\r
            String toolChainFamily = project.getProperty(toolCode + "_FAMILY");\r
            if (toolChainFamily != null) {\r
                if(!toolChainFamily.equalsIgnoreCase(family)) {\r
                    return ;\r
                }\r
            }\r
        }\r
        \r
        if (unicodeFirst) {\r
            if ( ! filetype.equalsIgnoreCase("UNI")){\r
                return ;\r
            }\r
            unicodeExist= true;\r
        } else {\r
            if (filetype.equalsIgnoreCase("UNI")){\r
                return ;\r
            }\r
        }\r
        \r
        //\r
        // If file is C or ASM header file, skip it\r
        //\r
        if (filetype.equalsIgnoreCase("CHeader") || filetype.equalsIgnoreCase("ASMHeader")) {\r
            return;\r
        }\r
        \r
        //\r
        // If file is pre-processor file, skip it\r
        // \r
        if (filetype.equalsIgnoreCase("PPCode")) {\r
            return;\r
        }\r
        \r
        //\r
        // If define CC_EXT in tools_def.txt file, the source file with \r
        // different suffix is skipped\r
        //\r
        String toolsDefExtName = project.getProperty(toolCode + "_EXT");\r
        if (toolsDefExtName != null) {\r
            String[] exts = toolsDefExtName.split(" ");\r
            for (int i = 0; i < exts.length; i++) {\r
                if ( ! filename.endsWith(exts[i])) {\r
                    return ;\r
                }\r
            }\r
        }\r
        \r
        String module_path = project.getProperty("MODULE_DIR");\r
        File moduleFile = new File(module_path);\r
        File sourceFile = new File(filename);\r
        \r
        //\r
        // If source file is AutoGen.c, then Filepath is .\r
        //\r
        String sourceFilepath = "";\r
        String sourceFilename = "";\r
        String sourceFileext = "";\r
        if (sourceFile.getPath().endsWith("AutoGen.c")) {\r
            sourceFilepath = ".";\r
            sourceFilename = "AutoGen";\r
            sourceFileext = ".c";\r
            filetype = "AUTOGEN";\r
        } else {\r
            // sourceFile.\r
            String str = sourceFile.getPath().substring(moduleFile.getPath().length() + 1);\r
            int index = str.lastIndexOf(File.separatorChar);\r
            sourceFilepath = ".";\r
            if (index > 0) {\r
                sourceFilepath = str.substring(0, index);\r
                str = str.substring(index + 1);\r
            }\r
            sourceFilename = str;\r
            index = str.lastIndexOf('.');\r
            if (index > 0) {\r
                sourceFilename = str.substring(0, index);\r
                sourceFileext = str.substring(index);\r
            }\r
        }\r
        // <Build_filetype FILEPATH="" FILENAME="" />\r
        Element ele = document.createElement("Build_" + filetype);\r
        ele.setAttribute("FILEPATH", sourceFilepath);\r
        ele.setAttribute("FILENAME", sourceFilename);\r
        ele.setAttribute("FILEEXT", sourceFileext.substring(1));\r
        Element includesEle = document.createElement("EXTRA.INC");\r
        for (int i = 0; i < includes.length; i++) {\r
            Element includeEle = document.createElement("includepath");\r
            includeEle.setAttribute("path", project.replaceProperties(includes[i]));\r
            includesEle.appendChild(includeEle);\r
        }\r
        ele.appendChild(includesEle);\r
        root.appendChild(ele);\r
    }\r
    \r
    private String getToolCodeByFileType(String fileType) {\r
        for (int i = 0; i < fileTypes.length; i++) {\r
            if (fileTypes[i][2].equalsIgnoreCase(fileType)) {\r
                return fileTypes[i][1];\r
            }\r
        }\r
        return null;\r
    }\r
}
Commit	Line	Data
878ddf1f	1	/** @file\r
	2	File is FileProcess class which is used to generate ANT script to build \r
	3	source files. \r
	4	\r
	5	Copyright (c) 2006, Intel Corporation\r
	6	All rights reserved. This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	**/\r
	14	package org.tianocore.build;\r
	15	\r
	16	import java.io.File;\r
878ddf1f	17	\r
a29c47e0	18	import org.apache.tools.ant.BuildException;\r
878ddf1f	19	import org.apache.tools.ant.Project;\r
	20	import org.w3c.dom.Document;\r
	21	import org.w3c.dom.Element;\r
	22	import org.w3c.dom.Node;\r
	23	\r
	24	/**\r
	25	<p><code>FileProcess</code> is class to generate ANT script to build source\r
	26	files.</p>\r
	27	\r
	28	<p>If file does not specify file type, <code>FileProcess</code> will judge \r
	29	by its extension. Following is the current supported extensions. </p>\r
	30	\r
	31	<pre> \r
a29c47e0	32	Source File Suffix File Type Description\r
	33	.h CHeader C header file\r
	34	.c CCode C source file\r
	35	.inc ASMHeader Assembly header file\r
	36	.asm ASM Assembly source file, usually for IA32 and X64 Arch and MSFT tool chain\r
	37	.S ASM Assembly source file, usually for IPF Arch\r
	38	.s ASM Assembly source file, usually for IA32 and X64 Arch and GCC tool chain\r
	39	.uni UNI Unicode file\r
	40	.vfr VFR Visual Forms Representation File\r
	41	.fv FV Firmware Volume\r
	42	.SEC FFS Firmware File System file\r
	43	.PEI FFS Firmware File System file\r
	44	.DXE FFS Firmware File System file\r
	45	.APP FFS Firmware File System file\r
	46	.FVI FFS Firmware File System file\r
	47	.FFS FFS Firmware File System file\r
	48	.bmp BMP Graphic File\r
	49	.i PPCode IPF PreProcessor Code\r
878ddf1f	50	</pre>\r
	51	\r
	52	@since GenBuild 1.0\r
	53	**/\r
	54	public class FileProcess {\r
	55	///\r
91a1f0d7	56	/// The mapping information about source suffix, tool code, file type.\r
878ddf1f	57	///\r
a29c47e0	58	public final String[][] fileTypes = { {".h", "", "CHeader" }, \r
91a1f0d7	59	{".c", "CC", "CCode" },\r
a29c47e0	60	{".inc", "", "ASMHeader" },\r
91a1f0d7	61	{".asm", "ASM", "ASM" }, \r
	62	{".S", "ASM", "ASM" },\r
	63	{".s", "ASM", "ASM" },\r
a29c47e0	64	{".uni", "", "UNI" },\r
a29c47e0	65	{".vfr", "", "VFR" },\r
136adffc	66	{".Vfr", "", "VFR" },\r
a29c47e0	67	{".dxs", "", "DPX"},\r
	68	{".fv", "", "FV" },\r
	69	{".efi", "", "EFI" },\r
	70	{".SEC", "", "FFS" },\r
	71	{".PEI", "", "FFS" },\r
	72	{".DXE", "", "FFS" },\r
	73	{".APP", "", "FFS" },\r
	74	{".FYI", "", "FFS" },\r
	75	{".FFS", "", "FFS" },\r
	76	{".bmp", "", "BMP" },\r
91a1f0d7	77	{".i", "PP", "PPCode"}};\r
878ddf1f	78	///\r
	79	/// Current ANT context. \r
	80	///\r
	81	private Project project;\r
	82	\r
	83	///\r
	84	/// Current module's include pathes\r
	85	///\r
bf3a7173	86	private String[] includes;\r
878ddf1f	87	\r
	88	///\r
	89	/// Xml Document.\r
	90	///\r
	91	private Document document;\r
	92	\r
	93	///\r
	94	/// The flag to ensure all unicode files build before others. \r
	95	///\r
	96	private boolean unicodeFirst = true;\r
	97	\r
	98	///\r
	99	/// The flag present whether current module contains Unicode files or not.\r
	100	///\r
	101	private boolean unicodeExist = false;\r
	102	\r
	103	/**\r
	104	Initialize the project, includes, sourceFiles, document members.\r
	105	\r
	106	@param project ANT project\r
	107	@param includes Module include pathes\r
	108	@param sourceFiles Modules source files\r
	109	@param document XML document\r
	110	**/\r
bf3a7173	111	public void init(Project project, String[] includes, Document document) {\r
878ddf1f	112	this.document = document;\r
	113	this.includes = includes;\r
	114	this.project = project;\r
878ddf1f	115	}\r
	116	\r
	117	/**\r
	118	Parse file without file type. \r
	119	\r
	120	@param filename Source file name\r
	121	@param root Root node\r
	122	@param unicodeFirst whether build Unicode file firstly or not\r
	123	**/\r
91a1f0d7	124	public synchronized void parseFile(String filename, String family, Node root, boolean unicodeFirst) {\r
878ddf1f	125	this.unicodeFirst = unicodeFirst;\r
91a1f0d7	126	parseFile(filename, family, root);\r
878ddf1f	127	}\r
	128	\r
	129	/**\r
	130	Get whether current module contains Unicode files or not.\r
	131	\r
	132	@return Whether current module contains Unicode files or not\r
	133	**/\r
	134	public boolean isUnicodeExist() {\r
	135	return unicodeExist;\r
	136	}\r
	137	\r
	138	/**\r
	139	Parse file.\r
	140	\r
	141	@param filename Source file name\r
	142	@param filetype Source file type\r
	143	@param root Root node\r
	144	@param unicodeFirst whether build Unicode file firstly or not\r
	145	**/\r
91a1f0d7	146	public synchronized void parseFile(String filename, String filetype, String family, Node root, boolean unicodeFirst) {\r
878ddf1f	147	this.unicodeFirst = unicodeFirst;\r
91a1f0d7	148	parseFile(filename, filetype, family, root);\r
878ddf1f	149	}\r
	150	\r
	151	/**\r
	152	Find out source file's type. \r
	153	\r
	154	@param filename Source file name\r
	155	@param root Root node\r
	156	**/\r
91a1f0d7	157	public synchronized void parseFile(String filename, String family, Node root) throws BuildException {\r
878ddf1f	158	for (int i = 0; i < fileTypes.length; i++) {\r
a29c47e0	159	if (filename.endsWith(fileTypes[i][0])) {\r
91a1f0d7	160	parseFile(filename, fileTypes[i][2], family, root);\r
82516887	161	return ;\r
878ddf1f	162	}\r
878ddf1f	163	}\r
878ddf1f	164	}\r
	165	\r
	166	/**\r
	167	Parse file. If flag <code>unicodeFirst</code> is true, then build all\r
	168	unicode files firstly. \r
	169	\r
	170	<p>Note that AutoGen.c is processed specially. It's output path is always\r
	171	<code>${DEST_DIR_OUTPUT}</code>, others are <code>${DEST_DIR_OUTPUT}</code>\r
	172	and relative to module path. </p>\r
	173	\r
	174	@param filename Source file name\r
	175	@param filetype Source file type\r
	176	@param root Root node\r
	177	**/\r
91a1f0d7	178	public synchronized void parseFile(String filename, String filetype, String family, Node root) {\r
	179	//\r
	180	// Filter file with family. Only family is specified in source file and\r
	181	// not include current family will skip the file. \r
	182	//\r
	183	String toolCode = getToolCodeByFileType(filetype);\r
	184	if (family != null && !family.trim().equalsIgnoreCase("")) {\r
	185	String toolChainFamily = project.getProperty(toolCode + "_FAMILY");\r
	186	if (toolChainFamily != null) {\r
	187	if(!toolChainFamily.equalsIgnoreCase(family)) {\r
	188	return ;\r
	189	}\r
	190	}\r
	191	}\r
	192	\r
878ddf1f	193	if (unicodeFirst) {\r
a29c47e0	194	if ( ! filetype.equalsIgnoreCase("UNI")){\r
878ddf1f	195	return ;\r
	196	}\r
	197	unicodeExist= true;\r
	198	} else {\r
a29c47e0	199	if (filetype.equalsIgnoreCase("UNI")){\r
878ddf1f	200	return ;\r
	201	}\r
	202	}\r
a29c47e0	203	\r
	204	//\r
	205	// If file is C or ASM header file, skip it\r
	206	//\r
	207	if (filetype.equalsIgnoreCase("CHeader") \|\| filetype.equalsIgnoreCase("ASMHeader")) {\r
878ddf1f	208	return;\r
878ddf1f	209	}\r
a29c47e0	210	\r
	211	//\r
	212	// If file is pre-processor file, skip it\r
	213	// \r
	214	if (filetype.equalsIgnoreCase("PPCode")) {\r
878ddf1f	215	return;\r
878ddf1f	216	}\r
a29c47e0	217	\r
	218	//\r
	219	// If define CC_EXT in tools_def.txt file, the source file with \r
	220	// different suffix is skipped\r
	221	//\r
91a1f0d7	222	String toolsDefExtName = project.getProperty(toolCode + "_EXT");\r
a29c47e0	223	if (toolsDefExtName != null) {\r
	224	String[] exts = toolsDefExtName.split(" ");\r
	225	for (int i = 0; i < exts.length; i++) {\r
	226	if ( ! filename.endsWith(exts[i])) {\r
	227	return ;\r
	228	}\r
	229	}\r
	230	}\r
	231	\r
878ddf1f	232	String module_path = project.getProperty("MODULE_DIR");\r
	233	File moduleFile = new File(module_path);\r
	234	File sourceFile = new File(filename);\r
a29c47e0	235	\r
a29c47e0	236	//\r
878ddf1f	237	// If source file is AutoGen.c, then Filepath is .\r
a29c47e0	238	//\r
	239	String sourceFilepath = "";\r
	240	String sourceFilename = "";\r
	241	String sourceFileext = "";\r
878ddf1f	242	if (sourceFile.getPath().endsWith("AutoGen.c")) {\r
	243	sourceFilepath = ".";\r
	244	sourceFilename = "AutoGen";\r
a29c47e0	245	sourceFileext = ".c";\r
878ddf1f	246	filetype = "AUTOGEN";\r
	247	} else {\r
	248	// sourceFile.\r
	249	String str = sourceFile.getPath().substring(moduleFile.getPath().length() + 1);\r
	250	int index = str.lastIndexOf(File.separatorChar);\r
	251	sourceFilepath = ".";\r
	252	if (index > 0) {\r
	253	sourceFilepath = str.substring(0, index);\r
	254	str = str.substring(index + 1);\r
	255	}\r
	256	sourceFilename = str;\r
	257	index = str.lastIndexOf('.');\r
	258	if (index > 0) {\r
	259	sourceFilename = str.substring(0, index);\r
a29c47e0	260	sourceFileext = str.substring(index);\r
878ddf1f	261	}\r
	262	}\r
	263	// <Build_filetype FILEPATH="" FILENAME="" />\r
	264	Element ele = document.createElement("Build_" + filetype);\r
	265	ele.setAttribute("FILEPATH", sourceFilepath);\r
	266	ele.setAttribute("FILENAME", sourceFilename);\r
a29c47e0	267	ele.setAttribute("FILEEXT", sourceFileext.substring(1));\r
878ddf1f	268	Element includesEle = document.createElement("EXTRA.INC");\r
bf3a7173	269	for (int i = 0; i < includes.length; i++) {\r
878ddf1f	270	Element includeEle = document.createElement("includepath");\r
bf3a7173	271	includeEle.setAttribute("path", project.replaceProperties(includes[i]));\r
878ddf1f	272	includesEle.appendChild(includeEle);\r
	273	}\r
	274	ele.appendChild(includesEle);\r
	275	root.appendChild(ele);\r
	276	}\r
91a1f0d7	277	\r
	278	private String getToolCodeByFileType(String fileType) {\r
	279	for (int i = 0; i < fileTypes.length; i++) {\r
	280	if (fileTypes[i][2].equalsIgnoreCase(fileType)) {\r
	281	return fileTypes[i][1];\r
	282	}\r
	283	}\r
	284	return null;\r
	285	}\r
878ddf1f	286	}