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

/** @file\r
  File is FfsProcess class which is used to get the corresponding FFS layout\r
  information for driver module. \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.Vector;\r
\r
import javax.xml.namespace.QName;\r
\r
import org.apache.tools.ant.BuildException;\r
import org.apache.tools.ant.Project;\r
import org.apache.xmlbeans.XmlCursor;\r
import org.apache.xmlbeans.XmlObject;\r
import org.tianocore.BuildOptionsDocument;\r
import org.tianocore.build.global.GlobalData;\r
import org.tianocore.build.global.SurfaceAreaQuery;\r
import org.tianocore.build.id.FpdModuleIdentification;\r
import org.w3c.dom.Document;\r
import org.w3c.dom.Element;\r
import org.w3c.dom.Node;\r
\r
/** \r
  <p><code>FfsProcess</code> is a class to find the corresponding FFS layout. </p>\r
  \r
  <p>Property <code>COMMON_FILE</code> specified which file to search. The element\r
  in <code>COMMON_FILE</code> is like following: </p>\r
  \r
  <pre>\r
    &lt;Ffs type="APPLICATION"&gt;\r
      &lt;Attribute Name="FFS_FILETYPE" Value="EFI_FV_FILETYPE_APPLICATION" /&gt;\r
      &lt;Attribute Name="FFS_ATTRIB_CHECKSUM" Value="TRUE" /&gt;\r
      &lt;Sections EncapsulationType="Compress"&gt;\r
        &lt;Sections EncapsulationType="Guid-Defined"&gt;\r
          &lt;Section SectionType="EFI_SECTION_PE32" /&gt; \r
          &lt;Section SectionType="EFI_SECTION_USER_INTERFACE" /&gt;\r
          &lt;Section SectionType="EFI_SECTION_VERSION" /&gt; \r
        &lt;/Sections&gt;\r
      &lt;/Sections&gt;\r
    &lt;/Ffs&gt;\r
  </pre>\r
 \r
  @since GenBuild 1.0\r
**/\r
public class FfsProcess {\r
\r
    ///\r
    /// Xml Document Node for corresponding FFS layout\r
    ///\r
    private Node ffs;\r
    \r
    private BuildOptionsDocument.BuildOptions.Ffs ffsXmlObject;\r
\r
    ///\r
    /// ANT script to call GenFfs\r
    ///\r
    private Element ffsNode = null;\r
\r
    ///\r
    /// Module base name\r
    ///\r
    private String basename;\r
\r
    ///\r
    /// Sections type: normal\r
    ///\r
    private static int MODE_NONE = 0;\r
\r
    ///\r
    /// Sections type: compress\r
    ///\r
    private static int MODE_COMPRESS = 1;\r
\r
    ///\r
    /// Sections type: guid-define\r
    ///\r
    private static int MODE_GUID_DEFINED = 2;\r
\r
    ///\r
    /// mapping from section type to section output file extension\r
    ///\r
    public static final String[][] sectionExt = { { "EFI_SECTION_FREEFORM_SUBTYPE_GUID", ".sec" },\r
                                                 { "EFI_SECTION_VERSION", ".ver" },\r
                                                 { "EFI_SECTION_USER_INTERFACE", ".ui" },\r
                                                 { "EFI_SECTION_DXE_DEPEX", ".dpx" },\r
                                                 { "EFI_SECTION_PEI_DEPEX", ".dpx" }, \r
                                                 { "EFI_SECTION_PE32", ".pe32" },\r
                                                 { "EFI_SECTION_PIC", ".pic" }, \r
                                                 { "EFI_SECTION_TE", ".tes" },\r
                                                 { "EFI_SECTION_RAW", ".sec" }, \r
                                                 { "EFI_SECTION_COMPRESSION", ".sec" },\r
                                                 { "EFI_SECTION_GUID_DEFINED", ".sec" },\r
                                                 { "EFI_SECTION_COMPATIBILITY16", ".sec" },\r
                                                 { "EFI_SECTION_FIRMWARE_VOLUME_IMAGE", ".sec" } };\r
\r
    /**\r
      search in the type, if componentType is listed in type, return true; \r
      otherwise return false.\r
      \r
      @param type a list supported component type separated by comma\r
      @param componentType current module component type\r
      @return whether componentType is one of type \r
    **/\r
    private boolean isMatch(String type, String componentType) {\r
        String[] items = type.split("[ \t]*,[ \t]*");\r
        for (int i = 0; i < items.length; i++) {\r
            if (items[i].equalsIgnoreCase(componentType)) {\r
                return true;\r
            }\r
        }\r
        return false;\r
    }\r
\r
    /**\r
      Find the corresponding FFS layout in <code>COMMON_FILE</code> if it\r
      does not specify in module's surface area. \r
      \r
      @param buildType Current module's component type\r
      @param project Ant project\r
      @return whether find the corresponding FFS layout\r
      @throws BuildException\r
              If specified COMMON_FILE XML file is not valide.\r
    **/\r
    public boolean initSections(String buildType, Project project, FpdModuleIdentification fpdModuleId) throws BuildException {\r
        //\r
        // Firstly, try to find in ModuleSA\r
        //\r
//        BuildOptionsDocument.BuildOptions.Ffs[] ffsArray = SurfaceAreaQuery.getModuleFfs();\r
//        for (int i = 0; i < ffsArray.length; i++) {\r
//            if (isMatch(ffsArray[i].getFfsKey(), buildType)) {\r
//                ffsXmlObject = ffsArray[i];\r
//                return true;\r
//            }\r
//        }\r
        \r
        //\r
        // secondly, try to sections defined in PLATFORM level\r
        //\r
        SurfaceAreaQuery.push(GlobalData.getFpdBuildOptions());\r
        BuildOptionsDocument.BuildOptions.Ffs[] ffsArray = SurfaceAreaQuery.getFpdFfs();\r
        SurfaceAreaQuery.pop();\r
        for (int i = 0; i < ffsArray.length; i++) {\r
            if (isMatch(ffsArray[i].getFfsKey(), buildType)) {\r
                ffsXmlObject = ffsArray[i];\r
                return true;\r
            }\r
        }\r
        \r
        //\r
        // If FfsFormatKey is not null, report exception and fail build\r
        // Otherwise report warning message\r
        //\r
        if (buildType == null) {\r
            System.out.println("Warning: this module doesn't specify a FfsFormatKey. ");\r
            }\r
        else {\r
            throw new BuildException("Can't find the FfsFormatKey [" + buildType + "] attribute in the FPD file!");            \r
        }\r
\r
        if (ffs == null) {\r
            return false;\r
        } else {\r
            return true;\r
        }\r
    }\r
    \r
    /**\r
      Recursive parse the FFS layout. Find out all section type here used. \r
      \r
      @param document BaseName_build.xml Xml document\r
      @param basename Module's base name\r
      @param guid Module's GUID\r
      @param targetFilename Module's final file name (GUID-BaseName.APP)\r
      @return List of section type\r
    **/\r
    public String[] getGenSectionElements(Document document, String basename, String guid, String targetFilename) {\r
        this.basename = basename;\r
        if (ffs == null && ffsXmlObject == null) {\r
            return new String[0];\r
        }\r
        Vector<String> sectionList = new Vector<String>();\r
        XmlCursor cursor = null;\r
        try {\r
            if (ffsXmlObject == null) {\r
                cursor = XmlObject.Factory.parse(ffs).newCursor();\r
            }\r
            else {\r
                cursor = ffsXmlObject.newCursor();\r
            }\r
        } catch (Exception e) {\r
            return null;\r
        }\r
        int mode = MODE_NONE;\r
        Element root = document.createElement("genffsfile");\r
        root.setAttribute("outputDir", "${BIN_DIR}");\r
        root.setAttribute("moduleType", "${MODULE_TYPE}");\r
        root.setAttribute("BaseName", basename);\r
        root.setAttribute("fileGuid", guid);\r
        if (ffsXmlObject == null) {\r
            cursor.toFirstChild();\r
        }\r
        if (cursor.toFirstChild()) {\r
            do {\r
                if (cursor.getName().getLocalPart().equalsIgnoreCase("Attribute")) {\r
                    String name = cursor.getAttributeText(new QName("Name"));\r
                    String value = cursor.getAttributeText(new QName("Value"));\r
                    root.setAttribute(changeAttributeName(name), value);\r
                } else if (cursor.getName().getLocalPart().equalsIgnoreCase("Section")) {\r
                    cursor.push();\r
                    dealSection(mode, document, root, cursor, sectionList);\r
                    cursor.pop();\r
                } else if (cursor.getName().getLocalPart().equalsIgnoreCase("Sections")) {\r
                    cursor.push();\r
                    dealSections(mode, document, root, cursor, sectionList);\r
                    cursor.pop();\r
                }\r
            } while (cursor.toNextSibling());\r
        }\r
        //\r
        // Check dependency \r
        //\r
        Element outofdateEle = document.createElement("OnDependency");\r
        Element sourceEle = document.createElement("sourcefiles");\r
        String[] result = new String[sectionList.size()];\r
        for (int i = 0; i < sectionList.size(); i++) {\r
            result[i] = (String) sectionList.get(i);\r
            Element pathEle = document.createElement("file");\r
            pathEle.setAttribute("name", "${DEST_DIR_OUTPUT}" + File.separatorChar + basename\r
                                         + getSectionExt(result[i]));\r
            sourceEle.appendChild(pathEle);\r
        }\r
        outofdateEle.appendChild(sourceEle);\r
        Element targetEle = document.createElement("targetfiles");\r
        Element fileEle = document.createElement("file");\r
        fileEle.setAttribute("name", "${BIN_DIR}" + File.separatorChar + targetFilename);\r
        targetEle.appendChild(fileEle);\r
        outofdateEle.appendChild(targetEle);\r
        Element sequentialEle = document.createElement("sequential");\r
        sequentialEle.appendChild(root);\r
        outofdateEle.appendChild(sequentialEle);\r
        ffsNode = outofdateEle;\r
        return result;\r
    }\r
\r
    /**\r
      Change the attribute name. For example: \r
      \r
      <pre>\r
          Before change: FFS_ATTRIB_CHECKSUM \r
          After  change: ffsATTRIBCHECKSUM\r
      </pre>\r
      \r
      @param name Original attribute name\r
      @return Changed attribute name\r
    **/\r
    private String changeAttributeName(String name) {\r
        String[] strs = name.split("_");\r
        String str = strs[0].toLowerCase();\r
        for (int j = 1; j < strs.length; j++) {\r
            str += strs[j];\r
        }\r
        return str;\r
    }\r
\r
    /**\r
      Recursively deal with Sections. If sections does not specify a type, then omit it.\r
      \r
      @param mode Current node mode (MODE_NONE | MODE_COMPREE | MODE_GUID_DEFINED)\r
      @param doc Xml Document\r
      @param root Root Node\r
      @param cursor Current FFS layout cursor\r
      @param list List of section type here used\r
    **/\r
    private void dealSections(int mode, Document doc, Element root, XmlCursor cursor, Vector<String> list) {\r
        String type = cursor.getAttributeText(new QName("EncapsulationType"));\r
        if (type == null) {\r
            if (cursor.toFirstChild()) {\r
                do {\r
                    if (cursor.getName().getLocalPart().equalsIgnoreCase("Section")) {\r
                        cursor.push();\r
                        dealSection(mode, doc, root, cursor, list);\r
                        cursor.pop();\r
                    } else if (cursor.getName().getLocalPart().equalsIgnoreCase("Sections")) {\r
                        cursor.push();\r
                        dealSections(mode, doc, root, cursor, list);\r
                        cursor.pop();\r
                    }\r
                } while (cursor.toNextSibling());\r
            }\r
            return;\r
        }\r
        Element ele;\r
        if (type.equalsIgnoreCase("COMPRESS")) {\r
            mode = MODE_COMPRESS;\r
            //\r
            // <compress compressName = "dummy">\r
            //\r
            ele = doc.createElement("compress");\r
            ele.setAttribute("compressName", "dummy");\r
        } else {\r
            mode = MODE_GUID_DEFINED;\r
            //\r
            // <tool toolName="${OEMTOOLPATH}\toolname"\r
            // outputPath = "${DEST_DIR_OUTPUT}">\r
            //\r
            ele = doc.createElement("tool");\r
            ele.setAttribute("toolName", "${WORKSPACE_DIR}" + File.separatorChar + "Tools" + File.separatorChar + "bin"\r
                                         + File.separatorChar + "GenCRC32Section");\r
            ele.setAttribute("outputPath", "${DEST_DIR_OUTPUT}");\r
        }\r
        if (cursor.toFirstChild()) {\r
            do {\r
                if (cursor.getName().getLocalPart().equalsIgnoreCase("Section")) {\r
                    cursor.push();\r
                    dealSection(mode, doc, ele, cursor, list);\r
                    cursor.pop();\r
                } else if (cursor.getName().getLocalPart().equalsIgnoreCase("Sections")) {\r
                    cursor.push();\r
                    dealSections(mode, doc, ele, cursor, list);\r
                    cursor.pop();\r
                }\r
            } while (cursor.toNextSibling());\r
        }\r
        root.appendChild(ele);\r
    }\r
    \r
    /**\r
      Recursively deal with section.\r
      \r
      @param mode Current node mode (MODE_NONE | MODE_COMPREE | MODE_GUID_DEFINED)\r
      @param doc Xml Document\r
      @param root Root Node\r
      @param cursor Current FFS layout cursor\r
      @param list List of section type here used\r
    **/\r
    private void dealSection(int mode, Document doc, Element root, XmlCursor cursor, Vector<String> list) {\r
        String type = cursor.getAttributeText(new QName("SectionType"));\r
        \r
        //\r
        // Judge if file is specified? Yes, just use the file, else call Build Macro\r
        // If fileName is null, means without FileNames specify in FPD file\r
        //\r
        String fileName = null;\r
        cursor.push();\r
        if (cursor.toFirstChild()) {\r
            do {\r
                if (cursor.getName().getLocalPart().equalsIgnoreCase("Filenames")) {\r
                    cursor.push();\r
                    if (cursor.toFirstChild()) {\r
                        do {\r
                            if (cursor.getName().getLocalPart().equalsIgnoreCase("Filename")) {\r
                                fileName = cursor.getTextValue();\r
                            }\r
                        } while (cursor.toNextSibling());\r
                    }\r
                    cursor.pop();\r
                }\r
            } while (cursor.toNextSibling());\r
        }\r
\r
        cursor.pop();\r
        \r
        if (fileName == null) {\r
            list.addElement(type);\r
        }\r
        if (mode == MODE_GUID_DEFINED) {\r
            //\r
            // <input file="${DEST_DIR_OUTPUT}\Bds.pe32"/>\r
            //\r
            Element ele = doc.createElement("input");\r
            if (fileName == null) {\r
                ele.setAttribute("file", "${DEST_DIR_OUTPUT}" + File.separatorChar + basename + getSectionExt(type));\r
            } else {\r
                ele.setAttribute("file", "${PLATFORM_DIR}" + File.separatorChar + fileName);\r
            }\r
            root.appendChild(ele);\r
        } else {\r
            //\r
            // <sectFile fileName= "..."/>\r
            //\r
            Element ele = doc.createElement("sectFile");\r
            if (fileName == null) {\r
                ele.setAttribute("fileName", "${DEST_DIR_OUTPUT}" + File.separatorChar + basename + getSectionExt(type));\r
            } else {\r
                ele.setAttribute("fileName", "${PLATFORM_DIR}" + File.separatorChar + fileName);\r
            }\r
            root.appendChild(ele);\r
        }\r
    }\r
\r
    /**\r
      Get the corresponding section file suffix.\r
       \r
      @param type Section type\r
      @return Corresponding section file extension\r
    **/\r
    private String getSectionExt(String type) {\r
        for (int i = 0; i < sectionExt.length; i++) {\r
            if (sectionExt[i][0].equalsIgnoreCase(type)) {\r
                return sectionExt[i][1];\r
            }\r
        }\r
        return ".sec";\r
    }\r
\r
    /**\r
      Return the ANT script to call GenFfs Tool.\r
      \r
      @return ANT script to call GenFfs Tool\r
    **/\r
    public Element getFfsNode() {\r
        return ffsNode;\r
    }\r
}\r
Commit	Line	Data
878ddf1f	1	/** @file\r
	2	File is FfsProcess class which is used to get the corresponding FFS layout\r
	3	information for driver module. \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	import java.util.Vector;\r
	18	\r
	19	import javax.xml.namespace.QName;\r
878ddf1f	20	\r
	21	import org.apache.tools.ant.BuildException;\r
	22	import org.apache.tools.ant.Project;\r
	23	import org.apache.xmlbeans.XmlCursor;\r
	24	import org.apache.xmlbeans.XmlObject;\r
a29c47e0	25	import org.tianocore.BuildOptionsDocument;\r
	26	import org.tianocore.build.global.GlobalData;\r
	27	import org.tianocore.build.global.SurfaceAreaQuery;\r
	28	import org.tianocore.build.id.FpdModuleIdentification;\r
878ddf1f	29	import org.w3c.dom.Document;\r
878ddf1f	30	import org.w3c.dom.Element;\r
878ddf1f	31	import org.w3c.dom.Node;\r
878ddf1f	32	\r
	33	/** \r
	34	<p><code>FfsProcess</code> is a class to find the corresponding FFS layout. </p>\r
	35	\r
	36	<p>Property <code>COMMON_FILE</code> specified which file to search. The element\r
	37	in <code>COMMON_FILE</code> is like following: </p>\r
	38	\r
	39	<pre>\r
	40	<Ffs type="APPLICATION">\r
	41	<Attribute Name="FFS_FILETYPE" Value="EFI_FV_FILETYPE_APPLICATION" />\r
	42	<Attribute Name="FFS_ATTRIB_CHECKSUM" Value="TRUE" />\r
	43	<Sections EncapsulationType="Compress">\r
	44	<Sections EncapsulationType="Guid-Defined">\r
	45	<Section SectionType="EFI_SECTION_PE32" /> \r
	46	<Section SectionType="EFI_SECTION_USER_INTERFACE" />\r
	47	<Section SectionType="EFI_SECTION_VERSION" /> \r
	48	</Sections>\r
	49	</Sections>\r
	50	</Ffs>\r
	51	</pre>\r
	52	\r
	53	@since GenBuild 1.0\r
	54	**/\r
	55	public class FfsProcess {\r
	56	\r
	57	///\r
	58	/// Xml Document Node for corresponding FFS layout\r
	59	///\r
	60	private Node ffs;\r
a29c47e0	61	\r
a29c47e0	62	private BuildOptionsDocument.BuildOptions.Ffs ffsXmlObject;\r
878ddf1f	63	\r
	64	///\r
	65	/// ANT script to call GenFfs\r
	66	///\r
	67	private Element ffsNode = null;\r
	68	\r
	69	///\r
	70	/// Module base name\r
	71	///\r
	72	private String basename;\r
	73	\r
	74	///\r
	75	/// Sections type: normal\r
	76	///\r
	77	private static int MODE_NONE = 0;\r
	78	\r
	79	///\r
	80	/// Sections type: compress\r
	81	///\r
	82	private static int MODE_COMPRESS = 1;\r
	83	\r
	84	///\r
	85	/// Sections type: guid-define\r
	86	///\r
	87	private static int MODE_GUID_DEFINED = 2;\r
	88	\r
	89	///\r
	90	/// mapping from section type to section output file extension\r
	91	///\r
	92	public static final String[][] sectionExt = { { "EFI_SECTION_FREEFORM_SUBTYPE_GUID", ".sec" },\r
	93	{ "EFI_SECTION_VERSION", ".ver" },\r
	94	{ "EFI_SECTION_USER_INTERFACE", ".ui" },\r
	95	{ "EFI_SECTION_DXE_DEPEX", ".dpx" },\r
	96	{ "EFI_SECTION_PEI_DEPEX", ".dpx" }, \r
	97	{ "EFI_SECTION_PE32", ".pe32" },\r
	98	{ "EFI_SECTION_PIC", ".pic" }, \r
	99	{ "EFI_SECTION_TE", ".tes" },\r
	100	{ "EFI_SECTION_RAW", ".sec" }, \r
	101	{ "EFI_SECTION_COMPRESSION", ".sec" },\r
	102	{ "EFI_SECTION_GUID_DEFINED", ".sec" },\r
	103	{ "EFI_SECTION_COMPATIBILITY16", ".sec" },\r
	104	{ "EFI_SECTION_FIRMWARE_VOLUME_IMAGE", ".sec" } };\r
	105	\r
	106	/**\r
	107	search in the type, if componentType is listed in type, return true; \r
	108	otherwise return false.\r
	109	\r
	110	@param type a list supported component type separated by comma\r
	111	@param componentType current module component type\r
	112	@return whether componentType is one of type \r
	113	**/\r
	114	private boolean isMatch(String type, String componentType) {\r
	115	String[] items = type.split("[ \t],[ \t]");\r
	116	for (int i = 0; i < items.length; i++) {\r
	117	if (items[i].equalsIgnoreCase(componentType)) {\r
	118	return true;\r
	119	}\r
	120	}\r
	121	return false;\r
	122	}\r
	123	\r
	124	/**\r
	125	Find the corresponding FFS layout in <code>COMMON_FILE</code> if it\r
	126	does not specify in module's surface area. \r
127	\r
128	@param buildType Current module's component type\r
129	@param project Ant project\r
130	@return whether find the corresponding FFS layout\r
131	@throws BuildException\r
132	If specified COMMON_FILE XML file is not valide.\r
133	**/\r
a29c47e0	134	public boolean initSections(String buildType, Project project, FpdModuleIdentification fpdModuleId) throws BuildException {\r
878ddf1f	135	//\r
a29c47e0	136	// Firstly, try to find in ModuleSA\r
878ddf1f	137	//\r
a29c47e0	138	// BuildOptionsDocument.BuildOptions.Ffs[] ffsArray = SurfaceAreaQuery.getModuleFfs();\r
	139	// for (int i = 0; i < ffsArray.length; i++) {\r
	140	// if (isMatch(ffsArray[i].getFfsKey(), buildType)) {\r
	141	// ffsXmlObject = ffsArray[i];\r
	142	// return true;\r
	143	// }\r
	144	// }\r
	145	\r
	146	//\r
	147	// secondly, try to sections defined in PLATFORM level\r
	148	//\r
	149	SurfaceAreaQuery.push(GlobalData.getFpdBuildOptions());\r
	150	BuildOptionsDocument.BuildOptions.Ffs[] ffsArray = SurfaceAreaQuery.getFpdFfs();\r
	151	SurfaceAreaQuery.pop();\r
	152	for (int i = 0; i < ffsArray.length; i++) {\r
	153	if (isMatch(ffsArray[i].getFfsKey(), buildType)) {\r
	154	ffsXmlObject = ffsArray[i];\r
	155	return true;\r
	156	}\r
	157	}\r
	158	\r
878ddf1f	159	//\r
e64c74dd	160	// If FfsFormatKey is not null, report exception and fail build\r
e64c74dd	161	// Otherwise report warning message\r
878ddf1f	162	//\r
e64c74dd	163	if (buildType == null) {\r
e64c74dd	164	System.out.println("Warning: this module doesn't specify a FfsFormatKey. ");\r
878ddf1f	165	}\r
e64c74dd	166	else {\r
391dbbb1	167	throw new BuildException("Can't find the FfsFormatKey [" + buildType + "] attribute in the FPD file!"); \r
878ddf1f	168	}\r
e64c74dd	169	\r
878ddf1f	170	if (ffs == null) {\r
	171	return false;\r
	172	} else {\r
	173	return true;\r
	174	}\r
	175	}\r
	176	\r
	177	/**\r
	178	Recursive parse the FFS layout. Find out all section type here used. \r
	179	\r
	180	@param document BaseName_build.xml Xml document\r
	181	@param basename Module's base name\r
	182	@param guid Module's GUID\r
	183	@param targetFilename Module's final file name (GUID-BaseName.APP)\r
	184	@return List of section type\r
	185	**/\r
	186	public String[] getGenSectionElements(Document document, String basename, String guid, String targetFilename) {\r
	187	this.basename = basename;\r
a29c47e0	188	if (ffs == null && ffsXmlObject == null) {\r
878ddf1f	189	return new String[0];\r
	190	}\r
	191	Vector<String> sectionList = new Vector<String>();\r
	192	XmlCursor cursor = null;\r
	193	try {\r
a29c47e0	194	if (ffsXmlObject == null) {\r
	195	cursor = XmlObject.Factory.parse(ffs).newCursor();\r
	196	}\r
	197	else {\r
	198	cursor = ffsXmlObject.newCursor();\r
	199	}\r
878ddf1f	200	} catch (Exception e) {\r
	201	return null;\r
	202	}\r
	203	int mode = MODE_NONE;\r
	204	Element root = document.createElement("genffsfile");\r
	205	root.setAttribute("outputDir", "${BIN_DIR}");\r
a29c47e0	206	root.setAttribute("moduleType", "${MODULE_TYPE}");\r
878ddf1f	207	root.setAttribute("BaseName", basename);\r
878ddf1f	208	root.setAttribute("fileGuid", guid);\r
a29c47e0	209	if (ffsXmlObject == null) {\r
	210	cursor.toFirstChild();\r
	211	}\r
878ddf1f	212	if (cursor.toFirstChild()) {\r
	213	do {\r
	214	if (cursor.getName().getLocalPart().equalsIgnoreCase("Attribute")) {\r
	215	String name = cursor.getAttributeText(new QName("Name"));\r
	216	String value = cursor.getAttributeText(new QName("Value"));\r
	217	root.setAttribute(changeAttributeName(name), value);\r
	218	} else if (cursor.getName().getLocalPart().equalsIgnoreCase("Section")) {\r
	219	cursor.push();\r
	220	dealSection(mode, document, root, cursor, sectionList);\r
	221	cursor.pop();\r
	222	} else if (cursor.getName().getLocalPart().equalsIgnoreCase("Sections")) {\r
	223	cursor.push();\r
	224	dealSections(mode, document, root, cursor, sectionList);\r
	225	cursor.pop();\r
	226	}\r
	227	} while (cursor.toNextSibling());\r
	228	}\r
	229	//\r
	230	// Check dependency \r
	231	//\r
	232	Element outofdateEle = document.createElement("OnDependency");\r
	233	Element sourceEle = document.createElement("sourcefiles");\r
	234	String[] result = new String[sectionList.size()];\r
	235	for (int i = 0; i < sectionList.size(); i++) {\r
	236	result[i] = (String) sectionList.get(i);\r
	237	Element pathEle = document.createElement("file");\r
	238	pathEle.setAttribute("name", "${DEST_DIR_OUTPUT}" + File.separatorChar + basename\r
	239	+ getSectionExt(result[i]));\r
	240	sourceEle.appendChild(pathEle);\r
	241	}\r
	242	outofdateEle.appendChild(sourceEle);\r
	243	Element targetEle = document.createElement("targetfiles");\r
	244	Element fileEle = document.createElement("file");\r
52cbbdbc	245	fileEle.setAttribute("name", "${BIN_DIR}" + File.separatorChar + targetFilename);\r
878ddf1f	246	targetEle.appendChild(fileEle);\r
	247	outofdateEle.appendChild(targetEle);\r
	248	Element sequentialEle = document.createElement("sequential");\r
	249	sequentialEle.appendChild(root);\r
	250	outofdateEle.appendChild(sequentialEle);\r
	251	ffsNode = outofdateEle;\r
	252	return result;\r
	253	}\r
	254	\r
	255	/**\r
	256	Change the attribute name. For example: \r
	257	\r
	258	<pre>\r
	259	Before change: FFS_ATTRIB_CHECKSUM \r
	260	After change: ffsATTRIBCHECKSUM\r
	261	</pre>\r
	262	\r
	263	@param name Original attribute name\r
	264	@return Changed attribute name\r
	265	**/\r
	266	private String changeAttributeName(String name) {\r
	267	String[] strs = name.split("_");\r
	268	String str = strs[0].toLowerCase();\r
	269	for (int j = 1; j < strs.length; j++) {\r
	270	str += strs[j];\r
	271	}\r
	272	return str;\r
	273	}\r
	274	\r
	275	/**\r
	276	Recursively deal with Sections. If sections does not specify a type, then omit it.\r
	277	\r
	278	@param mode Current node mode (MODE_NONE \| MODE_COMPREE \| MODE_GUID_DEFINED)\r
	279	@param doc Xml Document\r
	280	@param root Root Node\r
	281	@param cursor Current FFS layout cursor\r
	282	@param list List of section type here used\r
	283	**/\r
	284	private void dealSections(int mode, Document doc, Element root, XmlCursor cursor, Vector<String> list) {\r
	285	String type = cursor.getAttributeText(new QName("EncapsulationType"));\r
	286	if (type == null) {\r
	287	if (cursor.toFirstChild()) {\r
	288	do {\r
	289	if (cursor.getName().getLocalPart().equalsIgnoreCase("Section")) {\r
	290	cursor.push();\r
	291	dealSection(mode, doc, root, cursor, list);\r
	292	cursor.pop();\r
	293	} else if (cursor.getName().getLocalPart().equalsIgnoreCase("Sections")) {\r
	294	cursor.push();\r
	295	dealSections(mode, doc, root, cursor, list);\r
	296	cursor.pop();\r
	297	}\r
	298	} while (cursor.toNextSibling());\r
	299	}\r
	300	return;\r
	301	}\r
	302	Element ele;\r
	303	if (type.equalsIgnoreCase("COMPRESS")) {\r
	304	mode = MODE_COMPRESS;\r
	305	//\r
	306	// <compress compressName = "dummy">\r
	307	//\r
	308	ele = doc.createElement("compress");\r
	309	ele.setAttribute("compressName", "dummy");\r
310	} else {\r
311	mode = MODE_GUID_DEFINED;\r
312	//\r
313	// <tool toolName="${OEMTOOLPATH}\toolname"\r
314	// outputPath = "${DEST_DIR_OUTPUT}">\r
315	//\r
316	ele = doc.createElement("tool");\r
a33f3dd1	317	ele.setAttribute("toolName", "${WORKSPACE_DIR}" + File.separatorChar + "Tools" + File.separatorChar + "bin"\r
878ddf1f	318	+ File.separatorChar + "GenCRC32Section");\r
	319	ele.setAttribute("outputPath", "${DEST_DIR_OUTPUT}");\r
	320	}\r
	321	if (cursor.toFirstChild()) {\r
	322	do {\r
	323	if (cursor.getName().getLocalPart().equalsIgnoreCase("Section")) {\r
	324	cursor.push();\r
	325	dealSection(mode, doc, ele, cursor, list);\r
	326	cursor.pop();\r
	327	} else if (cursor.getName().getLocalPart().equalsIgnoreCase("Sections")) {\r
	328	cursor.push();\r
	329	dealSections(mode, doc, ele, cursor, list);\r
	330	cursor.pop();\r
	331	}\r
	332	} while (cursor.toNextSibling());\r
	333	}\r
	334	root.appendChild(ele);\r
	335	}\r
	336	\r
	337	/**\r
	338	Recursively deal with section.\r
	339	\r
	340	@param mode Current node mode (MODE_NONE \| MODE_COMPREE \| MODE_GUID_DEFINED)\r
	341	@param doc Xml Document\r
	342	@param root Root Node\r
	343	@param cursor Current FFS layout cursor\r
	344	@param list List of section type here used\r
	345	**/\r
	346	private void dealSection(int mode, Document doc, Element root, XmlCursor cursor, Vector<String> list) {\r
	347	String type = cursor.getAttributeText(new QName("SectionType"));\r
8a9783c1	348	\r
	349	//\r
	350	// Judge if file is specified? Yes, just use the file, else call Build Macro\r
	351	// If fileName is null, means without FileNames specify in FPD file\r
	352	//\r
	353	String fileName = null;\r
	354	cursor.push();\r
	355	if (cursor.toFirstChild()) {\r
	356	do {\r
	357	if (cursor.getName().getLocalPart().equalsIgnoreCase("Filenames")) {\r
	358	cursor.push();\r
	359	if (cursor.toFirstChild()) {\r
	360	do {\r
	361	if (cursor.getName().getLocalPart().equalsIgnoreCase("Filename")) {\r
	362	fileName = cursor.getTextValue();\r
	363	}\r
	364	} while (cursor.toNextSibling());\r
	365	}\r
	366	cursor.pop();\r
	367	}\r
	368	} while (cursor.toNextSibling());\r
	369	}\r
	370	\r
	371	cursor.pop();\r
	372	\r
	373	if (fileName == null) {\r
	374	list.addElement(type);\r
	375	}\r
878ddf1f	376	if (mode == MODE_GUID_DEFINED) {\r
	377	//\r
	378	// <input file="${DEST_DIR_OUTPUT}\Bds.pe32"/>\r
	379	//\r
	380	Element ele = doc.createElement("input");\r
8a9783c1	381	if (fileName == null) {\r
	382	ele.setAttribute("file", "${DEST_DIR_OUTPUT}" + File.separatorChar + basename + getSectionExt(type));\r
	383	} else {\r
	384	ele.setAttribute("file", "${PLATFORM_DIR}" + File.separatorChar + fileName);\r
	385	}\r
878ddf1f	386	root.appendChild(ele);\r
	387	} else {\r
	388	//\r
	389	// <sectFile fileName= "..."/>\r
	390	//\r
	391	Element ele = doc.createElement("sectFile");\r
8a9783c1	392	if (fileName == null) {\r
	393	ele.setAttribute("fileName", "${DEST_DIR_OUTPUT}" + File.separatorChar + basename + getSectionExt(type));\r
	394	} else {\r
	395	ele.setAttribute("fileName", "${PLATFORM_DIR}" + File.separatorChar + fileName);\r
	396	}\r
878ddf1f	397	root.appendChild(ele);\r
	398	}\r
	399	}\r
	400	\r
	401	/**\r
a29c47e0	402	Get the corresponding section file suffix.\r
878ddf1f	403	\r
	404	@param type Section type\r
	405	@return Corresponding section file extension\r
	406	**/\r
	407	private String getSectionExt(String type) {\r
	408	for (int i = 0; i < sectionExt.length; i++) {\r
	409	if (sectionExt[i][0].equalsIgnoreCase(type)) {\r
	410	return sectionExt[i][1];\r
	411	}\r
	412	}\r
	413	return ".sec";\r
	414	}\r
	415	\r
	416	/**\r
	417	Return the ANT script to call GenFfs Tool.\r
	418	\r
	419	@return ANT script to call GenFfs Tool\r
	420	**/\r
	421	public Element getFfsNode() {\r
	422	return ffsNode;\r
	423	}\r
	424	}\r