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

/** @file\r
 This file is ANT task FpdParserTask. \r
 \r
 FpdParserTask is used to parse FPD (Framework Platform Description) and generate\r
 build.out.xml. It is for Package or Platform build use. \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.fpd;\r
\r
import java.io.BufferedWriter;\r
import java.io.File;\r
import java.io.FileWriter;\r
import java.util.HashMap;\r
import java.util.Iterator;\r
import java.util.LinkedHashMap;\r
import java.util.LinkedHashSet;\r
import java.util.Map;\r
import java.util.Set;\r
import java.util.Vector;\r
import java.util.TreeMap;\r
\r
import org.apache.tools.ant.BuildException;\r
import org.apache.tools.ant.Task;\r
import org.apache.tools.ant.taskdefs.Ant;\r
import org.apache.tools.ant.taskdefs.Property;\r
import org.apache.xmlbeans.XmlObject;\r
\r
import org.tianocore.build.exception.EdkException;\r
import org.tianocore.build.global.GlobalData;\r
import org.tianocore.build.global.OutputManager;\r
import org.tianocore.build.global.SurfaceAreaQuery;\r
import org.tianocore.build.id.FpdModuleIdentification;\r
import org.tianocore.build.id.ModuleIdentification;\r
import org.tianocore.build.id.PlatformIdentification;\r
import org.tianocore.build.toolchain.ToolChainAttribute;\r
import org.tianocore.build.toolchain.ToolChainElement;\r
import org.tianocore.build.toolchain.ToolChainMap;\r
\r
/**\r
  <code>FpdParserTask</code> is an ANT task. The main function is parsing Framework\r
  Platform Descritpion (FPD) XML file and generating its ANT build script for \r
  corresponding platform.  \r
\r
  <p>The task sets global properties PLATFORM, PLATFORM_DIR, PLATFORM_RELATIVE_DIR\r
  and BUILD_DIR. </p>\r
  \r
  <p>The task generates ${PLATFORM}_build.xml file which will be called by top level\r
  build.xml. The task also generate Fv.inf files (File is for Tool GenFvImage) \r
  and flash definition file (File is for Tool FlashMap) if necessary. </p>\r
  \r
  <p>FpdParserTask task stores all FPD information to GlobalData. And parse\r
  tools definition file to set up compiler options for different Target and\r
  different ToolChainTag. </p>\r
  \r
  <p>The method parseFpdFile is also prepared for single module build. </p>\r
  \r
  <p>The usage is (take NT32 Platform for example):</p>\r
\r
  <pre>\r
  &lt;FPDParser platformName="Nt32" /&gt;\r
  </pre>\r
\r
  <p>The task will initialize all information through parsing Framework Database, \r
  SPD, Tool chain configuration files. </p>\r
\r
  @since GenBuild 1.0\r
**/\r
public class FpdParserTask extends Task {\r
    \r
    private String platformName;\r
\r
    private File fpdFile = null;\r
    \r
    private PlatformIdentification platformId;\r
    \r
    ///\r
    /// \r
    ///\r
    private String type;\r
    \r
    ///\r
    /// Mapping from modules identification to out put file name\r
    ///\r
    private Map<FpdModuleIdentification, String> outfiles = new LinkedHashMap<FpdModuleIdentification, String>();\r
\r
    ///\r
    /// Mapping from FV name to its modules\r
    ///\r
    private Map<String, Set<FpdModuleIdentification>> fvs = new HashMap<String, Set<FpdModuleIdentification>>();\r
\r
    ///\r
    /// Mapping from sequence number to FV names\r
    ///\r
    private Map<String, Set<String>> sequences = new TreeMap<String, Set<String>>();\r
\r
    ///\r
    /// FpdParserTask can specify some ANT properties. \r
    ///\r
    private Vector<Property> properties = new Vector<Property>();\r
    \r
    private boolean isUnified = true;\r
\r
\r
    /**\r
      Public construct method. It is necessary for ANT task.\r
    **/\r
    public FpdParserTask() {\r
    }\r
\r
    /**\r
     ANT task's entry method. The main steps is described as following: \r
     \r
     <ul>\r
     <li>Initialize global information (Framework DB, SPD files and all MSA files \r
     listed in SPD). This step will execute only once in whole build process;</li>\r
     <li>Parse specified FPD file; </li>\r
     <li>Generate FV.inf files; </li>\r
     <li>Generate PlatformName_build.xml file for Flatform build; </li>\r
     <li>Collect PCD information. </li>\r
     </ul>\r
     \r
     @throws BuildException\r
     Surface area is not valid. \r
    **/\r
    public void execute() throws BuildException {\r
        // Remove !!\r
        if ( fpdFile == null) {\r
            if (platformName == null) {\r
                throw new BuildException("FpdParserTask parameter error. Please specify platform name or FPD file. ");\r
            }\r
            platformId = GlobalData.getPlatform(platformName);\r
            fpdFile = platformId.getFpdFile();\r
        }\r
        \r
        //\r
        // Parse FPD file\r
        //\r
        parseFpdFile();\r
        \r
        //\r
        // Prepare BUILD_DIR\r
        //\r
        isUnified = OutputManager.getInstance().prepareBuildDir(getProject());\r
        \r
        //\r
        // Generate FDF (Flash Definition File) file\r
        //\r
\r
        //\r
        // For every Target and ToolChain\r
        //\r
        String[] targetList = GlobalData.getToolChainInfo().getTargets();\r
        for (int i = 0; i < targetList.length; i++){\r
            String[] toolchainList = GlobalData.getToolChainInfo().getTagnames();\r
            for(int j = 0; j < toolchainList.length; j++){\r
                //\r
                // Prepare FV_DIR\r
                //\r
                String ffsCommonDir = getProject().getProperty("BUILD_DIR") + File.separatorChar \r
                                + targetList[i] + File.separatorChar \r
                                + toolchainList[j];\r
                File fvDir = new File(ffsCommonDir + File.separatorChar + "FV");\r
                fvDir.mkdirs();\r
                getProject().setProperty("FV_DIR", fvDir.getPath().replaceAll("(\\\\)", "/"));\r
                \r
                //\r
                // Gen Fv.inf files\r
                //\r
                genFvInfFiles(ffsCommonDir);\r
            }\r
        }\r
\r
        //\r
        // Gen build.xml\r
        //\r
        PlatformBuildFileGenerator fileGenerator = new PlatformBuildFileGenerator(getProject(), outfiles, fvs, sequences, isUnified);\r
        fileGenerator.genBuildFile();\r
        \r
        //\r
        // Ant call ${PLATFORM}_build.xml\r
        //\r
        Ant ant = new Ant();\r
        ant.setProject(getProject());\r
        ant.setAntfile(platformId.getFpdFile().getParent() + File.separatorChar + platformId.getName() + "_build.xml");\r
        ant.setTarget(type);\r
        ant.setInheritAll(true);\r
        ant.init();\r
        ant.execute();\r
        \r
//        GlobalData.log.info("Fpd build end. ");\r
    }\r
\r
    /**\r
      Generate Fv.inf files. The Fv.inf file is composed with four \r
      parts: Options, Attributes, Components and Files. The Fv.inf files \r
      will be under FV_DIR.\r
     \r
      @throws BuildException\r
                  File write FV.inf files error. \r
    **/\r
    private void genFvInfFiles(String ffsCommonDir) throws BuildException {\r
        String[] validFv = SurfaceAreaQuery.getFpdValidImageNames();\r
        for (int i = 0; i < validFv.length; i++) {\r
            //\r
            // Get all global variables from FPD and set them to properties\r
            //\r
            String[][] globalVariables = SurfaceAreaQuery.getFpdGlobalVariable();\r
            for (int j = 0; j < globalVariables.length; j++) {\r
                getProject().setProperty(globalVariables[j][0], globalVariables[j][1]);\r
            }\r
\r
            getProject().setProperty("FV_FILENAME", validFv[i].toUpperCase());\r
            \r
            File fvFile = new File(getProject().replaceProperties( getProject().getProperty("FV_DIR") + File.separatorChar + validFv[i].toUpperCase() + ".inf"));\r
            fvFile.getParentFile().mkdirs();\r
\r
            try {\r
                FileWriter fw = new FileWriter(fvFile);\r
                BufferedWriter bw = new BufferedWriter(fw);\r
                \r
                //\r
                // Options\r
                //\r
                String[][] options = SurfaceAreaQuery.getFpdOptions(validFv[i]);\r
                if (options.length > 0) {\r
                    bw.write("[options]");\r
                    bw.newLine();\r
                    for (int j = 0; j < options.length; j++) {\r
                        StringBuffer str = new StringBuffer(100);\r
                        str.append(options[j][0]);\r
                        while (str.length() < 40) {\r
                            str.append(' ');\r
                        }\r
                        str.append("=  ");\r
                        str.append(options[j][1]);\r
                        bw.write(getProject().replaceProperties(str.toString()));\r
                        bw.newLine();\r
                    }\r
                    bw.newLine();\r
                }\r
                \r
                //\r
                // Attributes;\r
                //\r
                String[][] attributes = SurfaceAreaQuery.getFpdAttributes(validFv[i]);\r
                if (attributes.length > 0) {\r
                    bw.write("[attributes]");\r
                    bw.newLine();\r
                    for (int j = 0; j < attributes.length; j++) {\r
                        StringBuffer str = new StringBuffer(100);\r
                        str.append(attributes[j][0]);\r
                        while (str.length() < 40) {\r
                            str.append(' ');\r
                        }\r
                        str.append("=  ");\r
                        str.append(attributes[j][1]);\r
                        bw.write(getProject().replaceProperties(str.toString()));\r
                        bw.newLine();\r
                    }\r
                    bw.newLine();\r
                }\r
                \r
                //\r
                // Components\r
                //\r
                String[][] components = SurfaceAreaQuery.getFpdComponents(validFv[i]);\r
                if (components.length > 0) {\r
                    bw.write("[components]");\r
                    bw.newLine();\r
                    for (int j = 0; j < components.length; j++) {\r
                        StringBuffer str = new StringBuffer(100);\r
                        str.append(components[j][0]);\r
                        while (str.length() < 40) {\r
                            str.append(' ');\r
                        }\r
                        str.append("=  ");\r
                        str.append(components[j][1]);\r
                        bw.write(getProject().replaceProperties(str.toString()));\r
                        bw.newLine();\r
                    }\r
                    bw.newLine();\r
                }\r
                \r
                //\r
                // Files\r
                //\r
                Set<FpdModuleIdentification> filesSet = fvs.get(validFv[i].toUpperCase());\r
                if (filesSet != null) {\r
                    FpdModuleIdentification[] files = filesSet.toArray(new FpdModuleIdentification[filesSet.size()]);\r
                    bw.write("[files]");\r
                    bw.newLine();\r
                    for (int j = 0; j < files.length; j++) {\r
                        String str = ffsCommonDir + File.separatorChar + outfiles.get(files[j]);\r
                        bw.write(getProject().replaceProperties("EFI_FILE_NAME = " + str));\r
                        bw.newLine();\r
                    }\r
                }\r
                bw.flush();\r
                bw.close();\r
                fw.close();\r
            } catch (Exception e) {\r
                e.printStackTrace();\r
                throw new BuildException("Generate FV file [" + fvFile.getPath() + "] failed. \n" + e.getMessage());\r
            }\r
        }\r
    }\r
    /**\r
      This method is used for Single Module Build.\r
      \r
      \r
      @throws BuildException\r
                  FPD file is not valid. \r
    **/\r
    public void parseFpdFile(File fpdFile) throws BuildException {\r
        this.fpdFile = fpdFile;\r
        parseFpdFile();\r
    }\r
\r
    /**\r
      Parse FPD file. \r
     \r
      @throws BuildException\r
                  FPD file is not valid. \r
     **/\r
    private void parseFpdFile() throws BuildException {\r
        try {\r
            XmlObject doc = XmlObject.Factory.parse(fpdFile);\r
            \r
            if (!doc.validate()) {\r
                throw new BuildException("Platform Surface Area file [" + fpdFile.getPath() + "] is invalid.");\r
            }\r
            \r
            Map<String, XmlObject> map = new HashMap<String, XmlObject>();\r
            map.put("PlatformSurfaceArea", doc);\r
            SurfaceAreaQuery.setDoc(map);\r
            \r
            //\r
            // Initialize\r
            //\r
            platformId = SurfaceAreaQuery.getFpdHeader();\r
            platformId.setFpdFile(fpdFile);\r
            getProject().setProperty("PLATFORM", platformId.getName());\r
            getProject().setProperty("PLATFORM_DIR", platformId.getFpdFile().getParent().replaceAll("(\\\\)", "/"));\r
            getProject().setProperty("PLATFORM_RELATIVE_DIR", platformId.getPlatformRelativeDir().replaceAll("(\\\\)", "/"));\r
\r
            //\r
            // Build mode. User-defined output dir. \r
            //\r
            String buildMode = SurfaceAreaQuery.getFpdIntermediateDirectories();\r
            String userDefinedOutputDir = SurfaceAreaQuery.getFpdOutputDirectory();\r
\r
            OutputManager.getInstance().setup(userDefinedOutputDir, buildMode);\r
\r
            //\r
            // TBD. Deal PCD and BuildOption related Info\r
            //\r
            GlobalData.setFpdBuildOptions(SurfaceAreaQuery.getFpdBuildOptions());\r
            \r
            GlobalData.setToolChainPlatformInfo(SurfaceAreaQuery.getFpdToolChainInfo());\r
            \r
            //\r
            // Parse all list modules SA\r
            //\r
            parseModuleSAFiles();\r
\r
            //\r
            // TBD. Deal PCD and BuildOption related Info\r
            //\r
            parseToolChainFamilyOptions();\r
            parseToolChainOptions();\r
\r
            SurfaceAreaQuery.setDoc(map);\r
        } catch (Exception e) {\r
            e.printStackTrace();\r
            throw new BuildException("Load FPD file [" + fpdFile.getPath() + "] error. \n" + e.getMessage());\r
        }\r
    }\r
\r
\r
    \r
    /**\r
      Parse all modules listed in FPD file. \r
    **/\r
    private void parseModuleSAFiles() throws EdkException{\r
        Map<FpdModuleIdentification, Map<String, XmlObject>> moduleSAs = SurfaceAreaQuery.getFpdModules();\r
        System.out.println("Nubmer: ##" + moduleSAs.size());\r
        //\r
        // For every Module lists in FPD file.\r
        //\r
        Set<FpdModuleIdentification> keys = moduleSAs.keySet();\r
        Iterator iter = keys.iterator();\r
        while (iter.hasNext()) {\r
            FpdModuleIdentification fpdModuleId = (FpdModuleIdentification) iter.next();\r
            \r
            //\r
            // Judge if Module is existed? \r
            // TBD\r
            \r
            GlobalData.registerFpdModuleSA(fpdModuleId, moduleSAs.get(fpdModuleId));\r
\r
            //\r
            // Put fpdModuleId to the corresponding FV\r
            //\r
            SurfaceAreaQuery.push(GlobalData.getDoc(fpdModuleId));\r
            String fvBinding = SurfaceAreaQuery.getModuleFvBindingKeyword();\r
            SurfaceAreaQuery.pop();\r
\r
            fpdModuleId.setFvBinding(fvBinding);\r
            String fvSequence = fpdModuleId.getSequence();\r
            updateFvs(fvSequence, fvBinding, fpdModuleId);\r
            \r
            //\r
            // Prepare for out put file name\r
            //\r
            ModuleIdentification moduleId = fpdModuleId.getModule();\r
            SurfaceAreaQuery.push(GlobalData.getDoc(fpdModuleId));\r
            String baseName = SurfaceAreaQuery.getModuleOutputFileBasename();\r
            SurfaceAreaQuery.pop();\r
            if (baseName == null) {\r
                baseName = moduleId.getName();\r
            }\r
            outfiles.put(fpdModuleId, fpdModuleId.getArch() + File.separatorChar \r
                         + moduleId.getGuid() + "-" + baseName \r
                         + getSuffix(moduleId.getModuleType()));\r
\r
            //\r
            // parse module build options, if any\r
            // \r
            SurfaceAreaQuery.push(GlobalData.getDoc(fpdModuleId));\r
            GlobalData.addModuleToolChainOption(fpdModuleId, parseModuleBuildOptions(false));\r
            GlobalData.addModuleToolChainFamilyOption(fpdModuleId, parseModuleBuildOptions(true));\r
            SurfaceAreaQuery.pop();\r
        }\r
    }\r
\r
    private ToolChainMap parseModuleBuildOptions(boolean toolChainFamilyFlag) throws EdkException {\r
        String[][] options = SurfaceAreaQuery.getModuleBuildOptions(toolChainFamilyFlag);\r
        if (options == null || options.length == 0) {\r
            return null;\r
        }\r
        return parseOptions(options);\r
    }\r
    \r
    private ToolChainMap parsePlatformBuildOptions(boolean toolChainFamilyFlag) throws EdkException {\r
        String[][] options = SurfaceAreaQuery.getPlatformBuildOptions(toolChainFamilyFlag);\r
        if (options == null || options.length == 0) {\r
            return null;\r
        }\r
        return parseOptions(options);\r
    }\r
\r
    private ToolChainMap parseOptions(String[][] options) throws EdkException {\r
        ToolChainMap map = new ToolChainMap();\r
        int flagIndex = ToolChainElement.ATTRIBUTE.value;\r
\r
        for (int i = 0; i < options.length; ++i) {\r
            String flagString = options[i][flagIndex];\r
            if (flagString == null) {\r
                flagString = "";\r
            }\r
            options[i][flagIndex] = ToolChainAttribute.FLAGS + "";\r
            map.put(options[i], flagString.trim());\r
        }\r
\r
        return map;\r
    }\r
    \r
    private void parseToolChainFamilyOptions() throws EdkException {\r
        GlobalData.setPlatformToolChainFamilyOption(parsePlatformBuildOptions(true));\r
    }\r
\r
    private void parseToolChainOptions() throws EdkException {\r
        GlobalData.setPlatformToolChainOption(parsePlatformBuildOptions(false));\r
    }\r
\r
    /**\r
      Add the current module to corresponding FV. \r
     \r
      @param fvName current FV name\r
      @param moduleName current module identification\r
    **/\r
    private void updateFvs(String fvSequence, String fvName, FpdModuleIdentification fpdModuleId) {\r
        String upcaseFvName = fvName.toUpperCase();\r
        String[] fvNameArray = upcaseFvName.split("[, \t]+");\r
        for (int i = 0; i < fvNameArray.length; i++) {\r
            //\r
            // Put module to corresponding fvName\r
            //\r
            if (fvs.containsKey(fvNameArray[i])) {\r
                Set<FpdModuleIdentification> set = fvs.get(fvNameArray[i]);\r
                set.add(fpdModuleId);\r
            }\r
            else {\r
                Set<FpdModuleIdentification> set = new LinkedHashSet<FpdModuleIdentification>();\r
                set.add(fpdModuleId);\r
                fvs.put(fvNameArray[i], set);\r
            }\r
            \r
            //\r
            // Put fvName to corresponding fvSequence\r
            //\r
            if (sequences.containsKey(fvSequence)) {\r
                Set<String> set = sequences.get(fvSequence);\r
                set.add(fvNameArray[i]);\r
            }\r
            else {\r
                Set<String> set = new LinkedHashSet<String>();\r
                set.add(fvNameArray[i]);\r
                sequences.put(fvSequence, set);\r
            }\r
        }\r
    }\r
\r
    /**\r
      Get the suffix based on module type. Current relationship are listed:  \r
      \r
      <pre>\r
      <b>ModuleType</b>     <b>Suffix</b>\r
      BASE                 .FFS\r
      SEC                  .SEC\r
      PEI_CORE             .PEI\r
      PEIM                 .PEI\r
      DXE_CORE             .DXE\r
      DXE_DRIVER           .DXE\r
      DXE_RUNTIME_DRIVER   .DXE\r
      DXE_SAL_DRIVER       .DXE\r
      DXE_SMM_DRIVER       .DXE\r
      TOOL                 .FFS\r
      UEFI_DRIVER          .DXE\r
      UEFI_APPLICATION     .APP\r
      USER_DEFINED         .FFS\r
      </pre>\r
     \r
      @param moduleType module type\r
      @return\r
      @throws BuildException\r
      If module type is null\r
    **/\r
    public static String getSuffix(String moduleType) throws BuildException {\r
        if (moduleType == null) {\r
            throw new BuildException("Module type is not specified.");\r
        }\r
\r
        String[][] suffix = { { "BASE", ".FFS"},\r
                              { "SEC", ".SEC" }, { "PEI_CORE", ".PEI" }, \r
                              { "PEIM", ".PEI" }, { "DXE_CORE", ".DXE" },\r
                              { "DXE_DRIVER", ".DXE" }, { "DXE_RUNTIME_DRIVER", ".DXE" }, \r
                              { "DXE_SAL_DRIVER", ".DXE" }, { "DXE_SMM_DRIVER", ".DXE" }, \r
                              { "TOOL", ".FFS" }, { "UEFI_DRIVER", ".DXE" },\r
                              { "UEFI_APPLICATION", ".APP" }, { "USER_DEFINED", ".FFS" } };\r
        \r
        for (int i = 0; i < suffix.length; i++) {\r
            if (suffix[i][0].equalsIgnoreCase(moduleType)) {\r
                return suffix[i][1];\r
            }\r
        }\r
        //\r
        // Default is '.FFS'\r
        //\r
        return ".FFS";\r
    }\r
    /**\r
     Add a property. \r
     \r
     @param p property\r
     **/\r
    public void addProperty(Property p) {\r
        properties.addElement(p);\r
    }\r
\r
    public void setPlatformName(String platformName) {\r
        this.platformName = platformName;\r
    }\r
\r
    public void setFpdFile(File fpdFile) {\r
        this.fpdFile = fpdFile;\r
    }\r
\r
    public void setType(String type) {\r
        this.type = type;\r
    }\r
    \r
\r
}\r
Commit	Line	Data
878ddf1f	1	/** @file\r
a29c47e0	2	This file is ANT task FpdParserTask. \r
878ddf1f	3	\r
a29c47e0	4	FpdParserTask is used to parse FPD (Framework Platform Description) and generate\r
a29c47e0	5	build.out.xml. It is for Package or Platform build use. \r
878ddf1f	6	\r
a29c47e0	7	Copyright (c) 2006, Intel Corporation\r
	8	All rights reserved. This program and the accompanying materials\r
	9	are licensed and made available under the terms and conditions of the BSD License\r
	10	which accompanies this distribution. The full text of the license may be found at\r
	11	http://opensource.org/licenses/bsd-license.php\r
	12	\r
	13	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	14	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	15	**/\r
878ddf1f	16	package org.tianocore.build.fpd;\r
	17	\r
	18	import java.io.BufferedWriter;\r
	19	import java.io.File;\r
	20	import java.io.FileWriter;\r
	21	import java.util.HashMap;\r
	22	import java.util.Iterator;\r
	23	import java.util.LinkedHashMap;\r
	24	import java.util.LinkedHashSet;\r
	25	import java.util.Map;\r
	26	import java.util.Set;\r
	27	import java.util.Vector;\r
a29c47e0	28	import java.util.TreeMap;\r
878ddf1f	29	\r
	30	import org.apache.tools.ant.BuildException;\r
	31	import org.apache.tools.ant.Task;\r
a29c47e0	32	import org.apache.tools.ant.taskdefs.Ant;\r
878ddf1f	33	import org.apache.tools.ant.taskdefs.Property;\r
878ddf1f	34	import org.apache.xmlbeans.XmlObject;\r
878ddf1f	35	\r
a29c47e0	36	import org.tianocore.build.exception.EdkException;\r
878ddf1f	37	import org.tianocore.build.global.GlobalData;\r
878ddf1f	38	import org.tianocore.build.global.OutputManager;\r
878ddf1f	39	import org.tianocore.build.global.SurfaceAreaQuery;\r
a29c47e0	40	import org.tianocore.build.id.FpdModuleIdentification;\r
	41	import org.tianocore.build.id.ModuleIdentification;\r
	42	import org.tianocore.build.id.PlatformIdentification;\r
	43	import org.tianocore.build.toolchain.ToolChainAttribute;\r
	44	import org.tianocore.build.toolchain.ToolChainElement;\r
	45	import org.tianocore.build.toolchain.ToolChainMap;\r
878ddf1f	46	\r
878ddf1f	47	/**\r
a29c47e0	48	<code>FpdParserTask</code> is an ANT task. The main function is parsing Framework\r
	49	Platform Descritpion (FPD) XML file and generating its ANT build script for \r
	50	corresponding platform. \r
	51	\r
	52	<p>The task sets global properties PLATFORM, PLATFORM_DIR, PLATFORM_RELATIVE_DIR\r
	53	and BUILD_DIR. </p>\r
878ddf1f	54	\r
a29c47e0	55	<p>The task generates ${PLATFORM}_build.xml file which will be called by top level\r
	56	build.xml. The task also generate Fv.inf files (File is for Tool GenFvImage) \r
	57	and flash definition file (File is for Tool FlashMap) if necessary. </p>\r
	58	\r
	59	<p>FpdParserTask task stores all FPD information to GlobalData. And parse\r
	60	tools definition file to set up compiler options for different Target and\r
	61	different ToolChainTag. </p>\r
	62	\r
	63	<p>The method parseFpdFile is also prepared for single module build. </p>\r
878ddf1f	64	\r
a29c47e0	65	<p>The usage is (take NT32 Platform for example):</p>\r
a29c47e0	66	\r
878ddf1f	67	<pre>\r
a29c47e0	68	<FPDParser platformName="Nt32" />\r
878ddf1f	69	</pre>\r
a29c47e0	70	\r
878ddf1f	71	<p>The task will initialize all information through parsing Framework Database, \r
878ddf1f	72	SPD, Tool chain configuration files. </p>\r
a29c47e0	73	\r
878ddf1f	74	@since GenBuild 1.0\r
	75	**/\r
	76	public class FpdParserTask extends Task {\r
a29c47e0	77	\r
a29c47e0	78	private String platformName;\r
878ddf1f	79	\r
a29c47e0	80	private File fpdFile = null;\r
	81	\r
	82	private PlatformIdentification platformId;\r
	83	\r
878ddf1f	84	///\r
a29c47e0	85	/// \r
878ddf1f	86	///\r
a29c47e0	87	private String type;\r
a29c47e0	88	\r
878ddf1f	89	///\r
	90	/// Mapping from modules identification to out put file name\r
	91	///\r
	92	private Map<FpdModuleIdentification, String> outfiles = new LinkedHashMap<FpdModuleIdentification, String>();\r
	93	\r
	94	///\r
	95	/// Mapping from FV name to its modules\r
	96	///\r
a29c47e0	97	private Map<String, Set<FpdModuleIdentification>> fvs = new HashMap<String, Set<FpdModuleIdentification>>();\r
878ddf1f	98	\r
878ddf1f	99	///\r
a29c47e0	100	/// Mapping from sequence number to FV names\r
878ddf1f	101	///\r
a29c47e0	102	private Map<String, Set<String>> sequences = new TreeMap<String, Set<String>>();\r
878ddf1f	103	\r
	104	///\r
	105	/// FpdParserTask can specify some ANT properties. \r
	106	///\r
	107	private Vector<Property> properties = new Vector<Property>();\r
a29c47e0	108	\r
a29c47e0	109	private boolean isUnified = true;\r
878ddf1f	110	\r
878ddf1f	111	\r
	112	/**\r
	113	Public construct method. It is necessary for ANT task.\r
	114	**/\r
a29c47e0	115	public FpdParserTask() {\r
878ddf1f	116	}\r
	117	\r
	118	/**\r
a29c47e0	119	ANT task's entry method. The main steps is described as following: \r
	120	\r
	121	<ul>\r
	122	<li>Initialize global information (Framework DB, SPD files and all MSA files \r
	123	listed in SPD). This step will execute only once in whole build process;</li>\r
	124	<li>Parse specified FPD file; </li>\r
	125	<li>Generate FV.inf files; </li>\r
	126	<li>Generate PlatformName_build.xml file for Flatform build; </li>\r
	127	<li>Collect PCD information. </li>\r
	128	</ul>\r
	129	\r
	130	@throws BuildException\r
	131	Surface area is not valid. \r
878ddf1f	132	**/\r
878ddf1f	133	public void execute() throws BuildException {\r
a29c47e0	134	// Remove !!\r
	135	if ( fpdFile == null) {\r
	136	if (platformName == null) {\r
	137	throw new BuildException("FpdParserTask parameter error. Please specify platform name or FPD file. ");\r
	138	}\r
	139	platformId = GlobalData.getPlatform(platformName);\r
	140	fpdFile = platformId.getFpdFile();\r
	141	}\r
	142	\r
878ddf1f	143	//\r
	144	// Parse FPD file\r
	145	//\r
	146	parseFpdFile();\r
a29c47e0	147	\r
	148	//\r
	149	// Prepare BUILD_DIR\r
878ddf1f	150	//\r
a29c47e0	151	isUnified = OutputManager.getInstance().prepareBuildDir(getProject());\r
a29c47e0	152	\r
878ddf1f	153	//\r
a29c47e0	154	// Generate FDF (Flash Definition File) file\r
	155	//\r
	156	\r
	157	//\r
	158	// For every Target and ToolChain\r
	159	//\r
	160	String[] targetList = GlobalData.getToolChainInfo().getTargets();\r
	161	for (int i = 0; i < targetList.length; i++){\r
	162	String[] toolchainList = GlobalData.getToolChainInfo().getTagnames();\r
	163	for(int j = 0; j < toolchainList.length; j++){\r
	164	//\r
	165	// Prepare FV_DIR\r
	166	//\r
	167	String ffsCommonDir = getProject().getProperty("BUILD_DIR") + File.separatorChar \r
	168	+ targetList[i] + File.separatorChar \r
	169	+ toolchainList[j];\r
	170	File fvDir = new File(ffsCommonDir + File.separatorChar + "FV");\r
	171	fvDir.mkdirs();\r
	172	getProject().setProperty("FV_DIR", fvDir.getPath().replaceAll("(\\\\)", "/"));\r
	173	\r
	174	//\r
	175	// Gen Fv.inf files\r
	176	//\r
	177	genFvInfFiles(ffsCommonDir);\r
	178	}\r
	179	}\r
	180	\r
878ddf1f	181	//\r
	182	// Gen build.xml\r
	183	//\r
a29c47e0	184	PlatformBuildFileGenerator fileGenerator = new PlatformBuildFileGenerator(getProject(), outfiles, fvs, sequences, isUnified);\r
	185	fileGenerator.genBuildFile();\r
	186	\r
	187	//\r
	188	// Ant call ${PLATFORM}_build.xml\r
878ddf1f	189	//\r
a29c47e0	190	Ant ant = new Ant();\r
	191	ant.setProject(getProject());\r
	192	ant.setAntfile(platformId.getFpdFile().getParent() + File.separatorChar + platformId.getName() + "_build.xml");\r
	193	ant.setTarget(type);\r
	194	ant.setInheritAll(true);\r
	195	ant.init();\r
	196	ant.execute();\r
	197	\r
	198	// GlobalData.log.info("Fpd build end. ");\r
878ddf1f	199	}\r
a29c47e0	200	\r
878ddf1f	201	/**\r
	202	Generate Fv.inf files. The Fv.inf file is composed with four \r
	203	parts: Options, Attributes, Components and Files. The Fv.inf files \r
a29c47e0	204	will be under FV_DIR.\r
a29c47e0	205	\r
878ddf1f	206	@throws BuildException\r
a29c47e0	207	File write FV.inf files error. \r
878ddf1f	208	**/\r
a29c47e0	209	private void genFvInfFiles(String ffsCommonDir) throws BuildException {\r
878ddf1f	210	String[] validFv = SurfaceAreaQuery.getFpdValidImageNames();\r
878ddf1f	211	for (int i = 0; i < validFv.length; i++) {\r
878ddf1f	212	//\r
	213	// Get all global variables from FPD and set them to properties\r
	214	//\r
a29c47e0	215	String[][] globalVariables = SurfaceAreaQuery.getFpdGlobalVariable();\r
878ddf1f	216	for (int j = 0; j < globalVariables.length; j++) {\r
a29c47e0	217	getProject().setProperty(globalVariables[j][0], globalVariables[j][1]);\r
878ddf1f	218	}\r
878ddf1f	219	\r
a29c47e0	220	getProject().setProperty("FV_FILENAME", validFv[i].toUpperCase());\r
	221	\r
	222	File fvFile = new File(getProject().replaceProperties( getProject().getProperty("FV_DIR") + File.separatorChar + validFv[i].toUpperCase() + ".inf"));\r
878ddf1f	223	fvFile.getParentFile().mkdirs();\r
	224	\r
	225	try {\r
	226	FileWriter fw = new FileWriter(fvFile);\r
	227	BufferedWriter bw = new BufferedWriter(fw);\r
a29c47e0	228	\r
878ddf1f	229	//\r
	230	// Options\r
	231	//\r
	232	String[][] options = SurfaceAreaQuery.getFpdOptions(validFv[i]);\r
	233	if (options.length > 0) {\r
	234	bw.write("[options]");\r
	235	bw.newLine();\r
	236	for (int j = 0; j < options.length; j++) {\r
	237	StringBuffer str = new StringBuffer(100);\r
	238	str.append(options[j][0]);\r
	239	while (str.length() < 40) {\r
	240	str.append(' ');\r
	241	}\r
	242	str.append("= ");\r
	243	str.append(options[j][1]);\r
	244	bw.write(getProject().replaceProperties(str.toString()));\r
	245	bw.newLine();\r
	246	}\r
	247	bw.newLine();\r
	248	}\r
a29c47e0	249	\r
878ddf1f	250	//\r
	251	// Attributes;\r
	252	//\r
a29c47e0	253	String[][] attributes = SurfaceAreaQuery.getFpdAttributes(validFv[i]);\r
878ddf1f	254	if (attributes.length > 0) {\r
	255	bw.write("[attributes]");\r
	256	bw.newLine();\r
	257	for (int j = 0; j < attributes.length; j++) {\r
	258	StringBuffer str = new StringBuffer(100);\r
	259	str.append(attributes[j][0]);\r
	260	while (str.length() < 40) {\r
	261	str.append(' ');\r
	262	}\r
	263	str.append("= ");\r
	264	str.append(attributes[j][1]);\r
a29c47e0	265	bw.write(getProject().replaceProperties(str.toString()));\r
878ddf1f	266	bw.newLine();\r
	267	}\r
	268	bw.newLine();\r
	269	}\r
a29c47e0	270	\r
878ddf1f	271	//\r
	272	// Components\r
	273	//\r
a29c47e0	274	String[][] components = SurfaceAreaQuery.getFpdComponents(validFv[i]);\r
878ddf1f	275	if (components.length > 0) {\r
	276	bw.write("[components]");\r
	277	bw.newLine();\r
	278	for (int j = 0; j < components.length; j++) {\r
	279	StringBuffer str = new StringBuffer(100);\r
	280	str.append(components[j][0]);\r
	281	while (str.length() < 40) {\r
	282	str.append(' ');\r
	283	}\r
	284	str.append("= ");\r
	285	str.append(components[j][1]);\r
a29c47e0	286	bw.write(getProject().replaceProperties(str.toString()));\r
878ddf1f	287	bw.newLine();\r
	288	}\r
	289	bw.newLine();\r
	290	}\r
a29c47e0	291	\r
878ddf1f	292	//\r
	293	// Files\r
	294	//\r
	295	Set<FpdModuleIdentification> filesSet = fvs.get(validFv[i].toUpperCase());\r
	296	if (filesSet != null) {\r
a29c47e0	297	FpdModuleIdentification[] files = filesSet.toArray(new FpdModuleIdentification[filesSet.size()]);\r
878ddf1f	298	bw.write("[files]");\r
	299	bw.newLine();\r
	300	for (int j = 0; j < files.length; j++) {\r
a29c47e0	301	String str = ffsCommonDir + File.separatorChar + outfiles.get(files[j]);\r
a29c47e0	302	bw.write(getProject().replaceProperties("EFI_FILE_NAME = " + str));\r
878ddf1f	303	bw.newLine();\r
	304	}\r
	305	}\r
	306	bw.flush();\r
	307	bw.close();\r
	308	fw.close();\r
	309	} catch (Exception e) {\r
a29c47e0	310	e.printStackTrace();\r
a29c47e0	311	throw new BuildException("Generate FV file [" + fvFile.getPath() + "] failed. \n" + e.getMessage());\r
878ddf1f	312	}\r
	313	}\r
	314	}\r
a29c47e0	315	/**\r
	316	This method is used for Single Module Build.\r
	317	\r
	318	\r
	319	@throws BuildException\r
	320	FPD file is not valid. \r
	321	**/\r
	322	public void parseFpdFile(File fpdFile) throws BuildException {\r
	323	this.fpdFile = fpdFile;\r
	324	parseFpdFile();\r
	325	}\r
878ddf1f	326	\r
	327	/**\r
	328	Parse FPD file. \r
a29c47e0	329	\r
878ddf1f	330	@throws BuildException\r
a29c47e0	331	FPD file is not valid. \r
a29c47e0	332	**/\r
878ddf1f	333	private void parseFpdFile() throws BuildException {\r
878ddf1f	334	try {\r
a29c47e0	335	XmlObject doc = XmlObject.Factory.parse(fpdFile);\r
	336	\r
	337	if (!doc.validate()) {\r
	338	throw new BuildException("Platform Surface Area file [" + fpdFile.getPath() + "] is invalid.");\r
878ddf1f	339	}\r
a29c47e0	340	\r
	341	Map<String, XmlObject> map = new HashMap<String, XmlObject>();\r
	342	map.put("PlatformSurfaceArea", doc);\r
878ddf1f	343	SurfaceAreaQuery.setDoc(map);\r
a29c47e0	344	\r
	345	//\r
	346	// Initialize\r
	347	//\r
	348	platformId = SurfaceAreaQuery.getFpdHeader();\r
	349	platformId.setFpdFile(fpdFile);\r
	350	getProject().setProperty("PLATFORM", platformId.getName());\r
	351	getProject().setProperty("PLATFORM_DIR", platformId.getFpdFile().getParent().replaceAll("(\\\\)", "/"));\r
	352	getProject().setProperty("PLATFORM_RELATIVE_DIR", platformId.getPlatformRelativeDir().replaceAll("(\\\\)", "/"));\r
	353	\r
	354	//\r
	355	// Build mode. User-defined output dir. \r
	356	//\r
	357	String buildMode = SurfaceAreaQuery.getFpdIntermediateDirectories();\r
	358	String userDefinedOutputDir = SurfaceAreaQuery.getFpdOutputDirectory();\r
	359	\r
	360	OutputManager.getInstance().setup(userDefinedOutputDir, buildMode);\r
	361	\r
	362	//\r
	363	// TBD. Deal PCD and BuildOption related Info\r
	364	//\r
	365	GlobalData.setFpdBuildOptions(SurfaceAreaQuery.getFpdBuildOptions());\r
	366	\r
	367	GlobalData.setToolChainPlatformInfo(SurfaceAreaQuery.getFpdToolChainInfo());\r
	368	\r
878ddf1f	369	//\r
	370	// Parse all list modules SA\r
	371	//\r
	372	parseModuleSAFiles();\r
a29c47e0	373	\r
	374	//\r
	375	// TBD. Deal PCD and BuildOption related Info\r
	376	//\r
	377	parseToolChainFamilyOptions();\r
	378	parseToolChainOptions();\r
	379	\r
878ddf1f	380	SurfaceAreaQuery.setDoc(map);\r
878ddf1f	381	} catch (Exception e) {\r
a29c47e0	382	e.printStackTrace();\r
a29c47e0	383	throw new BuildException("Load FPD file [" + fpdFile.getPath() + "] error. \n" + e.getMessage());\r
878ddf1f	384	}\r
	385	}\r
	386	\r
a29c47e0	387	\r
a29c47e0	388	\r
878ddf1f	389	/**\r
	390	Parse all modules listed in FPD file. \r
	391	**/\r
a29c47e0	392	private void parseModuleSAFiles() throws EdkException{\r
	393	Map<FpdModuleIdentification, Map<String, XmlObject>> moduleSAs = SurfaceAreaQuery.getFpdModules();\r
	394	System.out.println("Nubmer: ##" + moduleSAs.size());\r
878ddf1f	395	//\r
	396	// For every Module lists in FPD file.\r
	397	//\r
a29c47e0	398	Set<FpdModuleIdentification> keys = moduleSAs.keySet();\r
	399	Iterator iter = keys.iterator();\r
	400	while (iter.hasNext()) {\r
	401	FpdModuleIdentification fpdModuleId = (FpdModuleIdentification) iter.next();\r
	402	\r
878ddf1f	403	//\r
a29c47e0	404	// Judge if Module is existed? \r
	405	// TBD\r
	406	\r
	407	GlobalData.registerFpdModuleSA(fpdModuleId, moduleSAs.get(fpdModuleId));\r
	408	\r
878ddf1f	409	//\r
a29c47e0	410	// Put fpdModuleId to the corresponding FV\r
878ddf1f	411	//\r
a29c47e0	412	SurfaceAreaQuery.push(GlobalData.getDoc(fpdModuleId));\r
	413	String fvBinding = SurfaceAreaQuery.getModuleFvBindingKeyword();\r
	414	SurfaceAreaQuery.pop();\r
	415	\r
	416	fpdModuleId.setFvBinding(fvBinding);\r
	417	String fvSequence = fpdModuleId.getSequence();\r
	418	updateFvs(fvSequence, fvBinding, fpdModuleId);\r
	419	\r
878ddf1f	420	//\r
a29c47e0	421	// Prepare for out put file name\r
878ddf1f	422	//\r
a29c47e0	423	ModuleIdentification moduleId = fpdModuleId.getModule();\r
	424	SurfaceAreaQuery.push(GlobalData.getDoc(fpdModuleId));\r
	425	String baseName = SurfaceAreaQuery.getModuleOutputFileBasename();\r
	426	SurfaceAreaQuery.pop();\r
	427	if (baseName == null) {\r
	428	baseName = moduleId.getName();\r
878ddf1f	429	}\r
a29c47e0	430	outfiles.put(fpdModuleId, fpdModuleId.getArch() + File.separatorChar \r
	431	+ moduleId.getGuid() + "-" + baseName \r
	432	+ getSuffix(moduleId.getModuleType()));\r
	433	\r
	434	//\r
	435	// parse module build options, if any\r
	436	// \r
	437	SurfaceAreaQuery.push(GlobalData.getDoc(fpdModuleId));\r
	438	GlobalData.addModuleToolChainOption(fpdModuleId, parseModuleBuildOptions(false));\r
	439	GlobalData.addModuleToolChainFamilyOption(fpdModuleId, parseModuleBuildOptions(true));\r
	440	SurfaceAreaQuery.pop();\r
878ddf1f	441	}\r
	442	}\r
	443	\r
a29c47e0	444	private ToolChainMap parseModuleBuildOptions(boolean toolChainFamilyFlag) throws EdkException {\r
	445	String[][] options = SurfaceAreaQuery.getModuleBuildOptions(toolChainFamilyFlag);\r
	446	if (options == null \|\| options.length == 0) {\r
	447	return null;\r
878ddf1f	448	}\r
a29c47e0	449	return parseOptions(options);\r
878ddf1f	450	}\r
878ddf1f	451	\r
a29c47e0	452	private ToolChainMap parsePlatformBuildOptions(boolean toolChainFamilyFlag) throws EdkException {\r
	453	String[][] options = SurfaceAreaQuery.getPlatformBuildOptions(toolChainFamilyFlag);\r
	454	if (options == null \|\| options.length == 0) {\r
	455	return null;\r
878ddf1f	456	}\r
a29c47e0	457	return parseOptions(options);\r
878ddf1f	458	}\r
878ddf1f	459	\r
a29c47e0	460	private ToolChainMap parseOptions(String[][] options) throws EdkException {\r
	461	ToolChainMap map = new ToolChainMap();\r
	462	int flagIndex = ToolChainElement.ATTRIBUTE.value;\r
	463	\r
	464	for (int i = 0; i < options.length; ++i) {\r
	465	String flagString = options[i][flagIndex];\r
	466	if (flagString == null) {\r
	467	flagString = "";\r
	468	}\r
	469	options[i][flagIndex] = ToolChainAttribute.FLAGS + "";\r
	470	map.put(options[i], flagString.trim());\r
	471	}\r
	472	\r
878ddf1f	473	return map;\r
878ddf1f	474	}\r
a29c47e0	475	\r
	476	private void parseToolChainFamilyOptions() throws EdkException {\r
	477	GlobalData.setPlatformToolChainFamilyOption(parsePlatformBuildOptions(true));\r
	478	}\r
	479	\r
	480	private void parseToolChainOptions() throws EdkException {\r
	481	GlobalData.setPlatformToolChainOption(parsePlatformBuildOptions(false));\r
	482	}\r
878ddf1f	483	\r
878ddf1f	484	/**\r
a29c47e0	485	Add the current module to corresponding FV. \r
	486	\r
	487	@param fvName current FV name\r
	488	@param moduleName current module identification\r
878ddf1f	489	**/\r
a29c47e0	490	private void updateFvs(String fvSequence, String fvName, FpdModuleIdentification fpdModuleId) {\r
	491	String upcaseFvName = fvName.toUpperCase();\r
	492	String[] fvNameArray = upcaseFvName.split("[, \t]+");\r
	493	for (int i = 0; i < fvNameArray.length; i++) {\r
878ddf1f	494	//\r
a29c47e0	495	// Put module to corresponding fvName\r
878ddf1f	496	//\r
a29c47e0	497	if (fvs.containsKey(fvNameArray[i])) {\r
	498	Set<FpdModuleIdentification> set = fvs.get(fvNameArray[i]);\r
	499	set.add(fpdModuleId);\r
878ddf1f	500	}\r
878ddf1f	501	else {\r
a29c47e0	502	Set<FpdModuleIdentification> set = new LinkedHashSet<FpdModuleIdentification>();\r
	503	set.add(fpdModuleId);\r
	504	fvs.put(fvNameArray[i], set);\r
878ddf1f	505	}\r
a29c47e0	506	\r
878ddf1f	507	//\r
a29c47e0	508	// Put fvName to corresponding fvSequence\r
878ddf1f	509	//\r
a29c47e0	510	if (sequences.containsKey(fvSequence)) {\r
	511	Set<String> set = sequences.get(fvSequence);\r
	512	set.add(fvNameArray[i]);\r
878ddf1f	513	}\r
878ddf1f	514	else {\r
a29c47e0	515	Set<String> set = new LinkedHashSet<String>();\r
	516	set.add(fvNameArray[i]);\r
	517	sequences.put(fvSequence, set);\r
878ddf1f	518	}\r
878ddf1f	519	}\r
	520	}\r
	521	\r
	522	/**\r
a29c47e0	523	Get the suffix based on module type. Current relationship are listed: \r
878ddf1f	524	\r
a29c47e0	525	<pre>\r
	526	<b>ModuleType</b> <b>Suffix</b>\r
	527	BASE .FFS\r
	528	SEC .SEC\r
	529	PEI_CORE .PEI\r
	530	PEIM .PEI\r
	531	DXE_CORE .DXE\r
	532	DXE_DRIVER .DXE\r
	533	DXE_RUNTIME_DRIVER .DXE\r
	534	DXE_SAL_DRIVER .DXE\r
	535	DXE_SMM_DRIVER .DXE\r
	536	TOOL .FFS\r
	537	UEFI_DRIVER .DXE\r
	538	UEFI_APPLICATION .APP\r
	539	USER_DEFINED .FFS\r
	540	</pre>\r
	541	\r
	542	@param moduleType module type\r
	543	@return\r
	544	@throws BuildException\r
	545	If module type is null\r
878ddf1f	546	**/\r
a29c47e0	547	public static String getSuffix(String moduleType) throws BuildException {\r
	548	if (moduleType == null) {\r
	549	throw new BuildException("Module type is not specified.");\r
	550	}\r
878ddf1f	551	\r
a29c47e0	552	String[][] suffix = { { "BASE", ".FFS"},\r
	553	{ "SEC", ".SEC" }, { "PEI_CORE", ".PEI" }, \r
	554	{ "PEIM", ".PEI" }, { "DXE_CORE", ".DXE" },\r
	555	{ "DXE_DRIVER", ".DXE" }, { "DXE_RUNTIME_DRIVER", ".DXE" }, \r
	556	{ "DXE_SAL_DRIVER", ".DXE" }, { "DXE_SMM_DRIVER", ".DXE" }, \r
	557	{ "TOOL", ".FFS" }, { "UEFI_DRIVER", ".DXE" },\r
	558	{ "UEFI_APPLICATION", ".APP" }, { "USER_DEFINED", ".FFS" } };\r
	559	\r
	560	for (int i = 0; i < suffix.length; i++) {\r
	561	if (suffix[i][0].equalsIgnoreCase(moduleType)) {\r
	562	return suffix[i][1];\r
	563	}\r
	564	}\r
	565	//\r
	566	// Default is '.FFS'\r
	567	//\r
	568	return ".FFS";\r
878ddf1f	569	}\r
878ddf1f	570	/**\r
a29c47e0	571	Add a property. \r
	572	\r
	573	@param p property\r
	574	**/\r
	575	public void addProperty(Property p) {\r
	576	properties.addElement(p);\r
878ddf1f	577	}\r
878ddf1f	578	\r
a29c47e0	579	public void setPlatformName(String platformName) {\r
a29c47e0	580	this.platformName = platformName;\r
878ddf1f	581	}\r
878ddf1f	582	\r
a29c47e0	583	public void setFpdFile(File fpdFile) {\r
a29c47e0	584	this.fpdFile = fpdFile;\r
878ddf1f	585	}\r
878ddf1f	586	\r
a29c47e0	587	public void setType(String type) {\r
a29c47e0	588	this.type = type;\r
878ddf1f	589	}\r
a29c47e0	590	\r
a29c47e0	591	\r
878ddf1f	592	}\r