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