[mirror_edk2.git] / Tools / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / platform / ui / FpdFileContents.java

/** @file\r
  Java class FpdFileContents is used to parse fpd xml file.\r
 \r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
**/\r
package org.tianocore.frameworkwizard.platform.ui;\r
\r
import java.io.File;\r
import java.io.IOException;\r
import java.math.BigInteger;\r
import java.util.ArrayList;\r
import java.util.HashMap;\r
import java.util.Iterator;\r
import java.util.LinkedHashMap;\r
import java.util.List;\r
import java.util.ListIterator;\r
import java.util.Map;\r
import java.util.Set;\r
\r
import javax.xml.namespace.QName;\r
\r
import org.apache.xmlbeans.XmlCursor;\r
import org.apache.xmlbeans.XmlObject;\r
import org.apache.xmlbeans.XmlOptions;\r
import org.tianocore.AntTaskDocument;\r
import org.tianocore.BuildOptionsDocument;\r
import org.tianocore.DynamicPcdBuildDefinitionsDocument;\r
import org.tianocore.FlashDefinitionFileDocument;\r
import org.tianocore.FlashDeviceDefinitionsDocument;\r
import org.tianocore.FlashDocument;\r
import org.tianocore.FrameworkModulesDocument;\r
import org.tianocore.FvRegionNameDocument;\r
import org.tianocore.LibrariesDocument;\r
import org.tianocore.ModuleSADocument;\r
import org.tianocore.ModuleSurfaceAreaDocument;\r
import org.tianocore.OptionDocument;\r
import org.tianocore.OptionsDocument;\r
import org.tianocore.PcdBuildDefinitionDocument;\r
import org.tianocore.PcdCodedDocument;\r
import org.tianocore.PcdDataTypes;\r
import org.tianocore.PcdDeclarationsDocument;\r
import org.tianocore.PcdItemTypes;\r
import org.tianocore.PlatformDefinitionsDocument;\r
import org.tianocore.PlatformSurfaceAreaDocument;\r
import org.tianocore.FvImageTypes;\r
import org.tianocore.FvImagesDocument;\r
import org.tianocore.LicenseDocument;\r
import org.tianocore.PlatformHeaderDocument;\r
import org.tianocore.SkuInfoDocument;\r
import org.tianocore.UserDefinedAntTasksDocument;\r
import org.tianocore.frameworkwizard.platform.ui.global.GlobalData;\r
import org.tianocore.frameworkwizard.platform.ui.global.SurfaceAreaQuery;\r
import org.tianocore.frameworkwizard.platform.ui.id.ModuleIdentification;\r
import org.tianocore.frameworkwizard.platform.ui.id.PackageIdentification;\r
\r
/**\r
 This class processes fpd file contents such as add remove xml elements. \r
 @since PackageEditor 1.0\r
**/\r
public class FpdFileContents {\r
\r
    static final String xmlNs = "http://www.TianoCore.org/2006/Edk2.0";\r
    \r
    private PlatformSurfaceAreaDocument fpdd = null;\r
    \r
    private PlatformSurfaceAreaDocument.PlatformSurfaceArea fpdRoot = null;\r
    \r
    private PlatformHeaderDocument.PlatformHeader fpdHdr = null;\r
    \r
    private PlatformDefinitionsDocument.PlatformDefinitions fpdPlatformDefs = null;\r
    \r
    private FlashDocument.Flash fpdFlash = null;\r
    \r
    private BuildOptionsDocument.BuildOptions fpdBuildOpts = null;\r
    \r
    private FrameworkModulesDocument.FrameworkModules fpdFrameworkModules = null;\r
    \r
    private DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions fpdDynPcdBuildDefs = null;\r
    \r
    public static HashMap<String, ArrayList<String>> dynPcdMap = null;\r
    \r
    /**\r
     * look through all pcd data in all ModuleSA, create pcd -> ModuleSA mappings.\r
     */\r
    public void initDynPcdMap() {\r
      if (dynPcdMap == null) {\r
          dynPcdMap = new HashMap<String, ArrayList<String>>();\r
          List<ModuleSADocument.ModuleSA> l = getfpdFrameworkModules().getModuleSAList();\r
          if (l == null) {\r
              return;\r
          }\r
          ListIterator<ModuleSADocument.ModuleSA> li = l.listIterator();\r
          while (li.hasNext()) {\r
              ModuleSADocument.ModuleSA msa = li.next();\r
              if (msa.getPcdBuildDefinition() == null || msa.getPcdBuildDefinition().getPcdDataList() == null) {\r
                  continue;\r
              }\r
              String ModuleInfo = msa.getModuleGuid() + " " + msa.getModuleVersion() +\r
               " " + msa.getPackageGuid() + " " + msa.getPackageVersion();\r
              List<PcdBuildDefinitionDocument.PcdBuildDefinition.PcdData> lp = msa.getPcdBuildDefinition().getPcdDataList();\r
              ListIterator<PcdBuildDefinitionDocument.PcdBuildDefinition.PcdData> lpi = lp.listIterator();\r
              while (lpi.hasNext()) {\r
                  PcdBuildDefinitionDocument.PcdBuildDefinition.PcdData pcdData = lpi.next();\r
                  String pcdKey = pcdData.getCName() + " " + pcdData.getTokenSpaceGuidCName();\r
                  if (dynPcdMap.get(pcdKey) == null) {\r
                      ArrayList<String> al = new ArrayList<String>();\r
                      al.add(ModuleInfo + " " + pcdData.getItemType().toString());\r
                      dynPcdMap.put(pcdKey, al);\r
                  }\r
                  else{\r
                      dynPcdMap.get(pcdKey).add(ModuleInfo + " " + pcdData.getItemType().toString());\r
                  }\r
              }\r
          }\r
      }\r
    }\r
    /**\r
     Constructor to create a new spd file\r
     **/\r
    public FpdFileContents() {\r
\r
        fpdd = PlatformSurfaceAreaDocument.Factory.newInstance();\r
        fpdRoot = fpdd.addNewPlatformSurfaceArea();\r
\r
    }\r
\r
    /**\r
     Constructor for existing document object\r
     @param psa\r
     **/\r
    public FpdFileContents(PlatformSurfaceAreaDocument.PlatformSurfaceArea fpd) {\r
        fpdRoot = fpd;\r
        fpdHdr = fpdRoot.getPlatformHeader();\r
        fpdPlatformDefs = fpdRoot.getPlatformDefinitions();\r
        fpdBuildOpts = fpdRoot.getBuildOptions();\r
        fpdFrameworkModules = fpdRoot.getFrameworkModules();\r
        fpdDynPcdBuildDefs = fpdRoot.getDynamicPcdBuildDefinitions();\r
        fpdFlash = fpdRoot.getFlash();\r
    }\r
\r
    /**\r
     Constructor based on an existing spd file\r
     \r
     @param f Existing spd file\r
     **/\r
    public FpdFileContents(File f) {\r
        try {\r
            fpdd = PlatformSurfaceAreaDocument.Factory.parse(f);\r
            fpdRoot = fpdd.getPlatformSurfaceArea();\r
        } catch (Exception e) {\r
            System.out.println(e.toString());\r
        }\r
    }\r
    \r
    public DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions getfpdDynPcdBuildDefs() {\r
        if (fpdDynPcdBuildDefs == null){\r
            fpdDynPcdBuildDefs = fpdRoot.addNewDynamicPcdBuildDefinitions();\r
        }\r
        return fpdDynPcdBuildDefs;\r
    }\r
   \r
    public FrameworkModulesDocument.FrameworkModules getfpdFrameworkModules() {\r
        if (fpdFrameworkModules == null){\r
            fpdFrameworkModules = fpdRoot.addNewFrameworkModules();\r
        }\r
        return fpdFrameworkModules;\r
    }\r
    \r
    public int getPlatformDefsSkuInfoCount(){\r
        if (getfpdPlatformDefs().getSkuInfo() == null || getfpdPlatformDefs().getSkuInfo().getUiSkuNameList() == null) {\r
            return 0;\r
        }\r
        return getfpdPlatformDefs().getSkuInfo().getUiSkuNameList().size();\r
    }\r
    \r
    public void getPlatformDefsSkuInfos(String[][] saa){\r
        if (getfpdPlatformDefs().getSkuInfo() == null || getfpdPlatformDefs().getSkuInfo().getUiSkuNameList() == null) {\r
            return ;\r
        }\r
        \r
        List<SkuInfoDocument.SkuInfo.UiSkuName> l = getfpdPlatformDefs().getSkuInfo().getUiSkuNameList();\r
        ListIterator<SkuInfoDocument.SkuInfo.UiSkuName> li = l.listIterator();\r
        int i = 0;\r
        while(li.hasNext()) {\r
            SkuInfoDocument.SkuInfo.UiSkuName sku = li.next();\r
            saa[i][0] = sku.getSkuID()+"";\r
            saa[i][1] = sku.getStringValue();\r
            ++i;\r
        }\r
    }\r
    \r
    public int getFrameworkModulesCount() {\r
        if (getfpdFrameworkModules().getModuleSAList() == null){\r
            return 0;\r
        }\r
        return getfpdFrameworkModules().getModuleSAList().size();\r
    }\r
    \r
    public void getFrameworkModulesInfo(String[][] saa) {\r
        if (getFrameworkModulesCount() == 0){\r
            return;\r
        }\r
        \r
        ListIterator li = getfpdFrameworkModules().getModuleSAList().listIterator();\r
        int i = 0;\r
        while(li.hasNext()) {\r
            ModuleSADocument.ModuleSA msa = (ModuleSADocument.ModuleSA)li.next();\r
            saa[i][1] = msa.getModuleGuid();\r
            saa[i][2] = msa.getModuleVersion();\r
            \r
            saa[i][3] = msa.getPackageGuid();\r
            saa[i][4] = msa.getPackageVersion();\r
//            saa[i][4] = listToString(msa.getSupArchList());\r
            ++i;\r
        }\r
    }\r
    \r
    public ModuleSADocument.ModuleSA getModuleSA(String key) {\r
        String[] s = key.split(" ");\r
        if (getfpdFrameworkModules().getModuleSAList() == null) {\r
            return null;\r
        }\r
        ListIterator li = getfpdFrameworkModules().getModuleSAList().listIterator();\r
        while(li.hasNext()) {\r
            ModuleSADocument.ModuleSA msa = (ModuleSADocument.ModuleSA)li.next();\r
            if (msa.getModuleGuid().equals(s[0]) && msa.getModuleVersion().equals(s[1])\r
                            && msa.getPackageGuid().equals(s[2]) && msa.getPackageVersion().equals(s[3])) {\r
                \r
                return msa;\r
            }\r
        }\r
        return null;\r
    }\r
    public void removeModuleSA(int i) {\r
        XmlObject o = getfpdFrameworkModules();\r
        if (o == null) {\r
            return;\r
        }\r
        \r
        XmlCursor cursor = o.newCursor();\r
        if (cursor.toFirstChild()) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling();\r
            }\r
            //\r
            // remove pcd from dynPcdMap, if DynamicPcdBuildData exists, remove them too.\r
            //\r
            ModuleSADocument.ModuleSA moduleSa = (ModuleSADocument.ModuleSA)cursor.getObject();\r
            String moduleInfo = moduleSa.getModuleGuid() + " " + moduleSa.getModuleVersion() + " " +\r
            moduleSa.getPackageGuid()+ " " + moduleSa.getPackageVersion();\r
            PcdBuildDefinitionDocument.PcdBuildDefinition pcdBuildDef = moduleSa.getPcdBuildDefinition();\r
            if (pcdBuildDef != null) {\r
                maintainDynPcdMap(pcdBuildDef, moduleInfo);\r
            }\r
            cursor.removeXml();\r
        }\r
        cursor.dispose();\r
    }\r
    \r
    private void maintainDynPcdMap(PcdBuildDefinitionDocument.PcdBuildDefinition o, String moduleInfo) {\r
        XmlCursor cursor = o.newCursor();\r
        boolean fromLibInstance = false;\r
        if (!cursor.toFirstChild()){\r
            return;\r
        }\r
        //\r
        // deal with first child, same process in the while loop below for siblings.\r
        //\r
        PcdBuildDefinitionDocument.PcdBuildDefinition.PcdData pcdData = (PcdBuildDefinitionDocument.PcdBuildDefinition.PcdData)cursor.getObject();\r
        String pcdKey = pcdData.getCName() + " " + pcdData.getTokenSpaceGuidCName();\r
        ArrayList<String> al = dynPcdMap.get(pcdKey);\r
        for(int i = 0; i < al.size(); ++i){\r
            if (al.get(i).startsWith(moduleInfo)){\r
                fromLibInstance = true;\r
                break;\r
            }\r
        }\r
        al.remove(moduleInfo + " " + pcdData.getItemType().toString());\r
        if (al.size() == 0) {\r
            dynPcdMap.remove(pcdKey);\r
        }\r
        \r
        if (pcdData.getItemType().toString().equals("DYNAMIC")) {\r
            if (dynPcdMap.get(pcdKey) == null) {\r
                removeDynamicPcdBuildData(pcdData.getCName(), pcdData.getTokenSpaceGuidCName());\r
            }\r
        }\r
        if (fromLibInstance){\r
            cursor.removeXml();\r
        }\r
        while(cursor.toNextSibling()) {\r
            fromLibInstance = false;\r
            pcdData = (PcdBuildDefinitionDocument.PcdBuildDefinition.PcdData)cursor.getObject();\r
            //\r
            // remove each pcd record from dynPcdMap\r
            //\r
            pcdKey = pcdData.getCName() + " " + pcdData.getTokenSpaceGuidCName();\r
            al = dynPcdMap.get(pcdKey);\r
            for(int i = 0; i < al.size(); ++i){\r
                if (al.get(i).startsWith(moduleInfo)){\r
                    fromLibInstance = true;\r
                    break;\r
                }\r
            }\r
            al.remove(moduleInfo + " " + pcdData.getItemType().toString());\r
            if (al.size() == 0) {\r
                dynPcdMap.remove(pcdKey);\r
            }\r
            \r
            if (pcdData.getItemType().toString().equals("DYNAMIC")) {\r
                //\r
                // First check whether this is the only consumer of this dyn pcd.\r
                //\r
                if (dynPcdMap.get(pcdKey) == null) {\r
                    //\r
                    // delete corresponding entry in DynamicPcdBuildData\r
                    //\r
                    removeDynamicPcdBuildData(pcdData.getCName(), pcdData.getTokenSpaceGuidCName());\r
                }\r
            }\r
            if (fromLibInstance){\r
                cursor.removeXml();\r
            }\r
        }\r
    }\r
    //\r
    // key for ModuleSA : "ModuleGuid ModuleVer PackageGuid PackageVer"\r
    //\r
    public int getPcdDataCount(String key){\r
        ModuleSADocument.ModuleSA msa = getModuleSA(key);\r
        if (msa == null || msa.getPcdBuildDefinition() == null || msa.getPcdBuildDefinition().getPcdDataList() == null){\r
            return 0;\r
        }\r
        return msa.getPcdBuildDefinition().getPcdDataList().size();\r
    }\r
    \r
    public void getPcdData(String key, String[][] saa) {\r
        ModuleSADocument.ModuleSA msa = getModuleSA(key);\r
        if (msa == null || msa.getPcdBuildDefinition() == null || msa.getPcdBuildDefinition().getPcdDataList() == null){\r
            return;\r
        }\r
        ListIterator<PcdBuildDefinitionDocument.PcdBuildDefinition.PcdData>li = msa.getPcdBuildDefinition().getPcdDataList().listIterator();\r
        for (int i = 0; i < saa.length; ++i) {\r
            PcdBuildDefinitionDocument.PcdBuildDefinition.PcdData pcdData = li.next();\r
            saa[i][0] = pcdData.getCName();\r
            saa[i][1] = pcdData.getTokenSpaceGuidCName();\r
            saa[i][2] = pcdData.getItemType().toString();\r
            saa[i][3] = pcdData.getToken().toString();\r
            saa[i][4] = pcdData.getDatumType().toString();\r
            saa[i][5] = pcdData.getValue();\r
            \r
        }\r
    }\r
    //\r
    // key for ModuleSA : "ModuleGuid ModuleVer PackageGuid PackageVer"\r
    //\r
    public int getLibraryInstancesCount(String key) {\r
        ModuleSADocument.ModuleSA msa = getModuleSA(key);\r
        if (msa == null || msa.getLibraries() == null || msa.getLibraries().getInstanceList() == null){\r
            return 0;\r
        }\r
        return msa.getLibraries().getInstanceList().size();\r
    }\r
    \r
    public void getLibraryInstances(String key, String[][] saa){\r
        ModuleSADocument.ModuleSA msa = getModuleSA(key);\r
        if (msa == null || msa.getLibraries() == null || msa.getLibraries().getInstanceList() == null){\r
            return ;\r
        }\r
        \r
        ListIterator<LibrariesDocument.Libraries.Instance> li = msa.getLibraries().getInstanceList().listIterator();\r
        for (int i = 0; i < saa.length; ++i) {\r
            LibrariesDocument.Libraries.Instance instance = li.next();\r
            saa[i][1] = instance.getModuleGuid();\r
            saa[i][2] = instance.getModuleVersion();\r
            saa[i][3] = instance.getPackageGuid();\r
            saa[i][4] = instance.getPackageVersion();\r
        }\r
    }\r
    \r
    public void removeLibraryInstances(String key) {\r
        ModuleSADocument.ModuleSA msa = getModuleSA(key);\r
        if (msa == null || msa.getLibraries() == null){\r
            return ;\r
        }\r
        \r
        XmlCursor cursor = msa.getLibraries().newCursor();\r
        cursor.removeXml();\r
        cursor.dispose();\r
    }\r
    \r
    public void genLibraryInstance(String mg, String mv, String pg, String pv, String key) {\r
        ModuleSADocument.ModuleSA msa = getModuleSA(key);\r
        if (msa == null){\r
            msa = getfpdFrameworkModules().addNewModuleSA();\r
        }\r
        LibrariesDocument.Libraries libs = msa.getLibraries();\r
        if(libs == null){\r
            libs = msa.addNewLibraries();\r
        }\r
        \r
        LibrariesDocument.Libraries.Instance instance = libs.addNewInstance();\r
        instance.setModuleGuid(mg);\r
        instance.setModuleVersion(mv);\r
        instance.setPackageGuid(pg);\r
        instance.setPackageVersion(pv);\r
        \r
    }\r
    /**add pcd information of module mi to a ModuleSA. \r
     * @param mi\r
     * @param moduleSa if null, generate a new ModuleSA.\r
     */\r
    public void addFrameworkModulesPcdBuildDefs(ModuleIdentification mi, ModuleSADocument.ModuleSA moduleSa){\r
        //ToDo add Arch filter\r
        \r
        try {\r
            ModuleSurfaceAreaDocument.ModuleSurfaceArea msa = (ModuleSurfaceAreaDocument.ModuleSurfaceArea)GlobalData.getModuleXmlObject(mi);\r
            if (msa.getPcdCoded() == null) {\r
                return;\r
            }\r
            if (moduleSa == null) {\r
                moduleSa = genModuleSA(mi);\r
            }\r
            Map<String, XmlObject> m = new HashMap<String, XmlObject>();\r
            m.put("ModuleSurfaceArea", msa);\r
            SurfaceAreaQuery.setDoc(m);\r
            PackageIdentification[] depPkgs = SurfaceAreaQuery.getDependencePkg(null);\r
            //\r
            // Implementing InitializePlatformPcdBuildDefinitions\r
            //\r
            List<PcdCodedDocument.PcdCoded.PcdEntry> l = msa.getPcdCoded().getPcdEntryList();\r
            ListIterator li = l.listIterator();\r
            while(li.hasNext()) {\r
                PcdCodedDocument.PcdCoded.PcdEntry msaPcd = (PcdCodedDocument.PcdCoded.PcdEntry)li.next();\r
                PcdDeclarationsDocument.PcdDeclarations.PcdEntry spdPcd = LookupPcdDeclaration(msaPcd, depPkgs);\r
                if (spdPcd == null) {\r
                    //\r
                    // ToDo Error \r
                    //\r
                    break;\r
                }\r
                //\r
                // AddItem to ModuleSA PcdBuildDefinitions\r
                //\r
                String defaultVal = msaPcd.getDefaultValue() == null ? spdPcd.getDefaultValue() : msaPcd.getDefaultValue();\r
                genPcdData(msaPcd.getCName(), spdPcd.getToken(), msaPcd.getTokenSpaceGuidCName(), msaPcd.getPcdItemType().toString(), spdPcd.getDatumType()+"", defaultVal, moduleSa);\r
            }\r
            \r
        }\r
        catch (Exception e){\r
            e.printStackTrace();\r
        }\r
        \r
    }\r
    \r
    private PcdDeclarationsDocument.PcdDeclarations.PcdEntry LookupPcdDeclaration (PcdCodedDocument.PcdCoded.PcdEntry msaPcd, PackageIdentification[] depPkgs) {\r
        \r
        Map<String, XmlObject> m = new HashMap<String, XmlObject>();\r
        PcdDeclarationsDocument.PcdDeclarations.PcdEntry spdPcd = null;\r
        for (int i = 0; i < depPkgs.length; ++i) {\r
            m.put("PackageSurfaceArea", GlobalData.getPackageXmlObject(depPkgs[i]));\r
            SurfaceAreaQuery.setDoc(m);\r
            XmlObject[] xo = SurfaceAreaQuery.getSpdPcdDeclarations();\r
            if (xo == null) {\r
                continue;\r
            }\r
            for (int j = 0; j < xo.length; ++j) {\r
                spdPcd = (PcdDeclarationsDocument.PcdDeclarations.PcdEntry)xo[j];\r
                if (msaPcd.getTokenSpaceGuidCName() == null) {\r
                    if (spdPcd.getCName().equals(msaPcd.getCName())) {\r
                        return spdPcd;\r
                    }\r
                }\r
                else{\r
                    if (spdPcd.getCName().equals(msaPcd.getCName()) && spdPcd.getTokenSpaceGuidCName().equals(msaPcd.getTokenSpaceGuidCName())) {\r
                        return spdPcd;\r
                    }\r
                }\r
                \r
            }\r
      \r
        }\r
        return null;\r
    }\r
    \r
    private ModuleSADocument.ModuleSA genModuleSA (ModuleIdentification mi) {\r
        PackageIdentification pi = GlobalData.getPackageForModule(mi);\r
        ModuleSADocument.ModuleSA msa = getfpdFrameworkModules().addNewModuleSA();\r
        msa.setModuleGuid(mi.getGuid());\r
        msa.setModuleVersion(mi.getVersion());\r
        msa.setPackageGuid(pi.getGuid());\r
        msa.setPackageVersion(pi.getVersion());\r
        \r
        return msa;\r
    }\r
    \r
    private void genPcdData (String cName, Object token, String tsGuid, String itemType, String dataType, String defaultVal, ModuleSADocument.ModuleSA moduleSa) {\r
        if (moduleSa.getPcdBuildDefinition() == null){\r
            moduleSa.addNewPcdBuildDefinition();\r
        }\r
        //\r
        // constructe pcd to modulesa mapping first.\r
        // Attention : for any error condition, remove from map this pcd.\r
        //\r
        ArrayList<String> pcdConsumer = LookupPlatformPcdData(cName + " " + tsGuid);\r
        if (pcdConsumer == null) {\r
            pcdConsumer = new ArrayList<String>();\r
        }\r
        String listValue = moduleSa.getModuleGuid() + " " + moduleSa.getModuleVersion() \r
        + " " + moduleSa.getPackageGuid() + " " + moduleSa.getPackageVersion() \r
        + " " + itemType;\r
        pcdConsumer.add(listValue);\r
        dynPcdMap.put(cName + " " + tsGuid, pcdConsumer);\r
        //\r
        // Special dynamic type, if this pcd already exists in other ModuleSA\r
        //\r
        if (itemType.equals("DYNAMIC")) {\r
            \r
            ListIterator li = pcdConsumer.listIterator();\r
            while(li.hasNext()) {\r
                String value = li.next().toString();\r
                String[] valuePart= value.split(" ");\r
                if (!valuePart[4].equals("DYNAMIC")) {\r
                    //ToDo error for same pcd, other type than dynamic\r
                    pcdConsumer.remove(listValue);\r
                    return;\r
                }\r
            }\r
        }\r
        else {\r
            ListIterator li = pcdConsumer.listIterator();\r
            while(li.hasNext()) {\r
                String value = li.next().toString();\r
                String[] valuePart= value.split(" ");\r
                if (valuePart[4].equals("DYNAMIC")) {\r
                    //ToDo error for same pcd, other type than non-dynamic\r
                    pcdConsumer.remove(listValue);\r
                    return;\r
                }\r
            }\r
        }\r
        \r
        PcdBuildDefinitionDocument.PcdBuildDefinition.PcdData fpdPcd = moduleSa.getPcdBuildDefinition().addNewPcdData();\r
        fpdPcd.setCName(cName);\r
        fpdPcd.setToken(token);\r
        fpdPcd.setTokenSpaceGuidCName(tsGuid);\r
        fpdPcd.setDatumType(PcdDataTypes.Enum.forString(dataType));\r
        fpdPcd.setItemType(PcdItemTypes.Enum.forString(itemType));\r
        \r
        if (itemType.equals("DYNAMIC") || itemType.equals("DYNAMIC_EX")) {\r
            ArrayList<String> al = LookupDynamicPcdBuildDefinition(cName + " " + tsGuid);\r
            //\r
            // if only one module mapped to this pcd, then the one is myself. so no other module mapped.\r
            // so need to add one dyn pcd.\r
            //\r
            if (al.size() == 1) {\r
                addDynamicPcdBuildData(cName, token, tsGuid, itemType, dataType, defaultVal);\r
            }\r
        }\r
        else {\r
            if (defaultVal != null){\r
                fpdPcd.setValue(defaultVal);\r
            }\r
            else {\r
                if (dataType.equals("UINT8") || dataType.equals("UINT16") || dataType.equals("UINT32") || dataType.equals("UINT64")) {\r
                    fpdPcd.setValue("0");\r
                }\r
                if (dataType.equals("BOOLEAN")){\r
                    fpdPcd.setValue("false");\r
                }\r
                if (dataType.equals("VOID*")) {\r
                    fpdPcd.setValue("");\r
                }\r
            }\r
            if (dataType.equals("UINT8")){\r
                fpdPcd.setMaxDatumSize(1);\r
            }\r
            if (dataType.equals("UINT16")) {\r
                fpdPcd.setMaxDatumSize(2);\r
            }\r
            if (dataType.equals("UINT32")) {\r
                fpdPcd.setMaxDatumSize(4);\r
            }\r
            if (dataType.equals("UINT64")){\r
                fpdPcd.setMaxDatumSize(8);\r
            }\r
            if (dataType.equals("BOOLEAN")){\r
                fpdPcd.setMaxDatumSize(1);\r
            }\r
            if (dataType.equals("VOID*")) {\r
                int maxSize = setMaxSizeForPointer(fpdPcd.getValue());\r
                fpdPcd.setMaxDatumSize(maxSize);\r
            }\r
        }\r
    }\r
    \r
    private int setMaxSizeForPointer(String datum) {\r
        if (datum == null) {\r
            return 0;\r
        }\r
        char    ch     = datum.charAt(0);\r
        int     start, end;\r
        String  strValue;\r
        //\r
        // For void* type PCD, only three datum is support:\r
        // 1) Unicode: string with start char is "L"\r
        // 2) Ansci: String  is ""\r
        // 3) byte array: String start char "{"\r
        // \r
        if (ch == 'L') {\r
            start       = datum.indexOf('\"');\r
            end         = datum.lastIndexOf('\"');\r
            if ((start > end)           || \r
                (end   > datum.length())||\r
                ((start == end) && (datum.length() > 0))) {\r
                //ToDo Error handling here\r
            }\r
\r
            strValue    = datum.substring(start + 1, end);\r
            return strValue.length() * 2;\r
        } else if (ch == '\"'){\r
            start       = datum.indexOf('\"');\r
            end         = datum.lastIndexOf('\"');\r
            if ((start > end)           || \r
                (end   > datum.length())||\r
                ((start == end) && (datum.length() > 0))) {\r
                \r
            }\r
            strValue    = datum.substring(start + 1, end);\r
            return strValue.length();\r
        } else if (ch =='{') {\r
            String[]  strValueArray;\r
\r
            start           = datum.indexOf('{');\r
            end             = datum.lastIndexOf('}');\r
            strValue        = datum.substring(start + 1, end);\r
            strValue        = strValue.trim();\r
            if (strValue.length() == 0) {\r
                return 0;\r
            }\r
            strValueArray   = strValue.split(",");\r
            for (int index = 0; index < strValueArray.length; index ++) {\r
                    Integer value = Integer.decode(strValueArray[index].trim());\r
                \r
                if (value > 0xFF) {\r
//                   "[FPD file error] The datum type of PCD %s in %s is VOID*, "+\r
//                   "it is byte array in fact. But the element of %s exceed the byte range",\r
                                                    \r
                }\r
            }\r
            return strValueArray.length;\r
\r
\r
        } else {\r
//            "[FPD file error] The datum type of PCD %s in %s is VOID*. For VOID* type, you have three format choise:\n "+\r
//            "1) UNICODE string: like L\"xxxx\";\r\n"+\r
//            "2) ANSIC string: like \"xxx\";\r\n"+\r
//            "3) Byte array: like {0x2, 0x45, 0x23}\r\n"+\r
//            "but the datum in seems does not following above format!",\r
              return -1;                             \r
            \r
        }\r
    }\r
    \r
    private ArrayList<String> LookupDynamicPcdBuildDefinition(String dynPcdKey) {\r
        ArrayList<String> al = dynPcdMap.get(dynPcdKey);\r
        \r
        return al;\r
    }\r
    \r
    private ArrayList<String> LookupPlatformPcdData(String pcdKey) {\r
        \r
        return dynPcdMap.get("pcdKey");\r
    }\r
    \r
    public int getDynamicPcdBuildDataCount() {\r
        if (getfpdDynPcdBuildDefs().getPcdBuildDataList() == null) {\r
            return 0;\r
        }\r
        return getfpdDynPcdBuildDefs().getPcdBuildDataList().size();\r
    }\r
    \r
    public void getDynamicPcdBuildData(String[][] saa) {\r
        if (getfpdDynPcdBuildDefs().getPcdBuildDataList() == null) {\r
            return ;\r
        }\r
        List<DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData> l = getfpdDynPcdBuildDefs().getPcdBuildDataList();\r
        ListIterator<DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData> li = l.listIterator();\r
        int i = 0;\r
        while(li.hasNext()) {\r
            DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData dynPcd = li.next();\r
            saa[i][0] = dynPcd.getCName();\r
            saa[i][1] = dynPcd.getToken().toString();\r
            saa[i][2] = dynPcd.getTokenSpaceGuidCName();\r
            saa[i][3] = dynPcd.getMaxDatumSize()+"";\r
            saa[i][4] = dynPcd.getDatumType().toString();\r
            \r
            ++i;\r
        }\r
    }\r
    \r
    private void addDynamicPcdBuildData(String cName, Object token, String tsGuid, String itemType, String dataType, String defaultVal) {\r
        DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData dynPcdData = getfpdDynPcdBuildDefs().addNewPcdBuildData();\r
        dynPcdData.setItemType(PcdItemTypes.Enum.forString(itemType));\r
        dynPcdData.setCName(cName);\r
        dynPcdData.setToken(token);\r
        dynPcdData.setTokenSpaceGuidCName(tsGuid);\r
        dynPcdData.setDatumType(PcdDataTypes.Enum.forString(dataType));\r
        \r
        BigInteger bigInt = new BigInteger("0");\r
        DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData.SkuInfo skuInfo = dynPcdData.addNewSkuInfo();\r
        skuInfo.setSkuId(bigInt);\r
        if (defaultVal != null){\r
            skuInfo.setValue(defaultVal);\r
        }\r
        else {\r
            if (dataType.equals("UINT8")){\r
                skuInfo.setValue("0");\r
            }\r
            if (dataType.equals("UINT16")) {\r
                skuInfo.setValue("0");\r
            }\r
            if (dataType.equals("UINT32")) {\r
                skuInfo.setValue("0");\r
            }\r
            if (dataType.equals("UINT64")){\r
                skuInfo.setValue("0");\r
            }\r
            if (dataType.equals("BOOLEAN")){\r
                skuInfo.setValue("false");\r
            }\r
            if (dataType.equals("VOID*")) {\r
                skuInfo.setValue("");\r
            }\r
        }\r
        if (dataType.equals("UINT8")){\r
            dynPcdData.setMaxDatumSize(1);\r
        }\r
        if (dataType.equals("UINT16")) {\r
            dynPcdData.setMaxDatumSize(2);\r
        }\r
        if (dataType.equals("UINT32")) {\r
            dynPcdData.setMaxDatumSize(4);\r
        }\r
        if (dataType.equals("UINT64")){\r
            dynPcdData.setMaxDatumSize(8);\r
        }\r
        if (dataType.equals("BOOLEAN")){\r
            dynPcdData.setMaxDatumSize(1);\r
        }\r
        if (dataType.equals("VOID*")) {\r
            int maxSize = setMaxSizeForPointer(defaultVal);\r
            dynPcdData.setMaxDatumSize(maxSize);\r
        }\r
    }\r
    \r
    private void removeDynamicPcdBuildData(String cName, String tsGuid) {\r
        XmlObject o = getfpdDynPcdBuildDefs();\r
        \r
        XmlCursor cursor = o.newCursor();\r
        if (cursor.toFirstChild()) {\r
            DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData pcdBuildData = \r
                (DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData)cursor.getObject();\r
            while (!(pcdBuildData.getCName().equals(cName) && pcdBuildData.getTokenSpaceGuidCName().equals(tsGuid))) {\r
                cursor.toNextSibling();\r
                pcdBuildData = (DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData)cursor.getObject();\r
            }\r
            \r
            cursor.removeXml();\r
        }\r
        cursor.dispose();\r
    }\r
    //\r
    // Get the Sku Info count of ith dyn pcd element.\r
    //\r
    public int getDynamicPcdSkuInfoCount(int i){\r
        if (getfpdDynPcdBuildDefs().getPcdBuildDataList() == null || getfpdDynPcdBuildDefs().getPcdBuildDataList().size() == 0) {\r
            return 0;\r
        }\r
        \r
        int skuInfoCount = 0;\r
        XmlCursor cursor = getfpdDynPcdBuildDefs().newCursor();\r
        if (cursor.toFirstChild()) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling();\r
            }\r
            DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData pcdData = (DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData)cursor.getObject();\r
            if (pcdData.getSkuInfoList() == null) {\r
                skuInfoCount = 0;\r
            }\r
            else {\r
                skuInfoCount = pcdData.getSkuInfoList().size();\r
            }\r
        }\r
        cursor.dispose();\r
        return skuInfoCount;\r
    }\r
    \r
    public void getDynamicPcdSkuInfos(int i, String[][] saa){\r
        if (getfpdDynPcdBuildDefs().getPcdBuildDataList() == null || getfpdDynPcdBuildDefs().getPcdBuildDataList().size() == 0) {\r
            return;\r
        }\r
        \r
        XmlCursor cursor = getfpdDynPcdBuildDefs().newCursor();\r
        if (cursor.toFirstChild()) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling();\r
            }\r
            DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData pcdData = (DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData)cursor.getObject();\r
            if (pcdData.getSkuInfoList() == null) {\r
                cursor.dispose();\r
                return;\r
            }\r
            else {\r
                ListIterator<DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData.SkuInfo> li = pcdData.getSkuInfoList().listIterator();\r
                int k = 0;\r
                while (li.hasNext()) {\r
                    DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData.SkuInfo skuInfo = li.next();\r
                    saa[k][0] = skuInfo.getSkuId()+"";\r
                    saa[k][1] = skuInfo.getVariableName();\r
                    saa[k][2] = skuInfo.getVariableGuid();\r
                    saa[k][3] = skuInfo.getVariableOffset();\r
                    saa[k][4] = skuInfo.getHiiDefaultValue();\r
                    saa[k][5] = skuInfo.getVpdOffset();\r
                    saa[k][6] = skuInfo.getValue();\r
                    ++k;\r
                }\r
                \r
            }\r
        }\r
        cursor.dispose();\r
       \r
    }\r
    \r
    public String getDynamicPcdBuildDataValue(int i){\r
        String value = null;\r
        if (getfpdDynPcdBuildDefs().getPcdBuildDataList() == null || getfpdDynPcdBuildDefs().getPcdBuildDataList().size() == 0) {\r
            return value;\r
        }\r
        \r
        XmlCursor cursor = getfpdDynPcdBuildDefs().newCursor();\r
        if (cursor.toFirstChild()) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling();\r
            }\r
            DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData pcdData = (DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData)cursor.getObject();\r
            if (pcdData.getSkuInfoList() == null) {\r
                value = null;\r
            }\r
            else {\r
                value = pcdData.getSkuInfoArray(0).getValue();\r
            }\r
        }\r
        cursor.dispose();\r
        return value;\r
    }\r
    \r
    public String getDynamicPcdBuildDataVpdOffset(int i){\r
        String vpdOffset = null;\r
        if (getfpdDynPcdBuildDefs().getPcdBuildDataList() == null || getfpdDynPcdBuildDefs().getPcdBuildDataList().size() == 0) {\r
            return vpdOffset;\r
        }\r
        \r
        XmlCursor cursor = getfpdDynPcdBuildDefs().newCursor();\r
        if (cursor.toFirstChild()) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling();\r
            }\r
            DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData pcdData = (DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData)cursor.getObject();\r
            if (pcdData.getSkuInfoList() == null) {\r
                vpdOffset = null;\r
            }\r
            else {\r
                vpdOffset = pcdData.getSkuInfoArray(0).getVpdOffset();\r
            }\r
        }\r
        cursor.dispose();\r
        return vpdOffset;\r
    }\r
    \r
    public void removeDynamicPcdBuildDataSkuInfo(int i) {\r
        if (getfpdDynPcdBuildDefs().getPcdBuildDataList() == null || getfpdDynPcdBuildDefs().getPcdBuildDataList().size() == 0) {\r
            return;\r
        }\r
        \r
        XmlCursor cursor = getfpdDynPcdBuildDefs().newCursor();\r
        if (cursor.toFirstChild()) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling();\r
            }\r
            DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData pcdData = (DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData)cursor.getObject();\r
            if (pcdData.getSkuInfoList() == null) {\r
                cursor.dispose();\r
                return;\r
            }\r
            else {\r
                QName qSkuInfo = new QName(xmlNs, "SkuInfo");\r
                cursor.toChild(qSkuInfo);\r
                cursor.removeXml();\r
            }\r
        }\r
        cursor.dispose();\r
    }\r
    //\r
    // generate sku info for ith dyn pcd build data.\r
    //\r
    public void genDynamicPcdBuildDataSkuInfo(String id, String varName, String varGuid, String varOffset, \r
                                              String hiiDefault, String vpdOffset, String value, int i) {\r
        if (getfpdDynPcdBuildDefs().getPcdBuildDataList() == null || getfpdDynPcdBuildDefs().getPcdBuildDataList().size() == 0) {\r
            return;\r
        }\r
        \r
        XmlCursor cursor = getfpdDynPcdBuildDefs().newCursor();\r
        if (cursor.toFirstChild()) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling();\r
            }\r
            DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData pcdData = (DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData)cursor.getObject();\r
            DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData.SkuInfo skuInfo = pcdData.addNewSkuInfo();\r
            skuInfo.setSkuId(new BigInteger(id));\r
            if (varName != null){\r
                skuInfo.setVariableName(varName);\r
                skuInfo.setVariableGuid(varGuid);\r
                skuInfo.setVariableOffset(varOffset);\r
                skuInfo.setHiiDefaultValue(hiiDefault);\r
            }\r
            else if (vpdOffset != null){\r
                skuInfo.setVpdOffset(vpdOffset);\r
            }\r
            else{\r
                skuInfo.setValue(value);\r
            }\r
        }\r
    }\r
    \r
    public void updateDynamicPcdBuildDataSkuInfo(String id, String varName, String varGuid, String varOffset, \r
                                                 String hiiDefault, String vpdOffset, String value, int i){\r
        if (getfpdDynPcdBuildDefs().getPcdBuildDataList() == null || getfpdDynPcdBuildDefs().getPcdBuildDataList().size() == 0) {\r
            return;\r
        }\r
        \r
        XmlCursor cursor = getfpdDynPcdBuildDefs().newCursor();\r
        if (cursor.toFirstChild()) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling();\r
            }\r
            DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData pcdData = (DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData)cursor.getObject();\r
            ListIterator<DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData.SkuInfo> li = pcdData.getSkuInfoList().listIterator();\r
            while (li.hasNext()) {\r
                DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData.SkuInfo skuInfo = li.next();\r
                if (skuInfo.getSkuId().toString().equals(id)){\r
                    if (varName != null){\r
                        skuInfo.setVariableName(varName);\r
                        skuInfo.setVariableGuid(varGuid);\r
                        skuInfo.setVariableOffset(varOffset);\r
                        skuInfo.setHiiDefaultValue(hiiDefault);\r
                    }\r
                    else if (vpdOffset != null){\r
                        skuInfo.setVpdOffset(vpdOffset);\r
                    }\r
                    else{\r
                        skuInfo.setValue(value);\r
                    }\r
                    break;\r
                }\r
            }\r
        }\r
    }\r
    \r
    public void removePcdDataFromLibraryInstance(String moduleKey, String libInstanceKey){\r
        ModuleSADocument.ModuleSA moduleSa = getModuleSA(moduleKey);\r
        //\r
        //  should better maintain pcd from lib instance only, but maintain all is acceptable now. \r
        //\r
        maintainDynPcdMap(moduleSa.getPcdBuildDefinition(), libInstanceKey);\r
        \r
    }\r
    \r
    public BuildOptionsDocument.BuildOptions getfpdBuildOpts() {\r
        if (fpdBuildOpts == null) {\r
            fpdBuildOpts = fpdRoot.addNewBuildOptions();\r
        }\r
        return fpdBuildOpts;\r
    }\r
    \r
    public void genBuildOptionsUserDefAntTask (String id, String fileName, String execOrder) {\r
        UserDefinedAntTasksDocument.UserDefinedAntTasks udats = getfpdBuildOpts().getUserDefinedAntTasks();\r
        if (udats == null) {\r
            udats = getfpdBuildOpts().addNewUserDefinedAntTasks();\r
        }\r
        \r
        AntTaskDocument.AntTask at = udats.addNewAntTask();\r
        setBuildOptionsUserDefAntTask(id, fileName, execOrder, at);\r
    }\r
    \r
    private void setBuildOptionsUserDefAntTask(String id, String fileName, String execOrder, AntTaskDocument.AntTask at) {\r
        at.setId(new Integer(id));\r
        if (fileName != null){\r
            at.setFilename(fileName);\r
        }\r
        else {\r
            at.setAntCmdOptions(execOrder);\r
        }\r
    }\r
    \r
    public void removeBuildOptionsUserDefAntTask(int i) {\r
        XmlObject o = getfpdBuildOpts().getUserDefinedAntTasks();\r
        if (o == null) {\r
            return;\r
        }\r
        XmlCursor cursor = o.newCursor();\r
        if (cursor.toFirstChild()) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling();\r
            }\r
            cursor.removeXml();\r
        }\r
        cursor.dispose();\r
    }\r
    \r
    public void updateBuildOptionsUserDefAntTask(int i, String id, String fileName, String execOrder){\r
        XmlObject o = getfpdBuildOpts().getUserDefinedAntTasks();\r
        if (o == null) {\r
            return;\r
        }\r
        XmlCursor cursor = o.newCursor();\r
        if (cursor.toFirstChild()) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling();\r
            }\r
            AntTaskDocument.AntTask at = (AntTaskDocument.AntTask)cursor.getObject();\r
            setBuildOptionsUserDefAntTask(id, fileName, execOrder, at);\r
        }\r
        cursor.dispose();\r
    }\r
    \r
    public int getBuildOptionsUserDefAntTaskCount() {\r
        UserDefinedAntTasksDocument.UserDefinedAntTasks udats = getfpdBuildOpts().getUserDefinedAntTasks();\r
        if (udats == null || udats.getAntTaskList() == null) {\r
            return 0;\r
        }\r
        \r
        return udats.getAntTaskList().size();\r
    }\r
    \r
    public void getBuildOptionsUserDefAntTasks(String[][] saa) {\r
        UserDefinedAntTasksDocument.UserDefinedAntTasks udats = getfpdBuildOpts().getUserDefinedAntTasks();\r
        if (udats == null || udats.getAntTaskList() == null) {\r
            return ;\r
        }\r
        \r
        List<AntTaskDocument.AntTask> l = udats.getAntTaskList();\r
        ListIterator li = l.listIterator();\r
        int i = 0;\r
        while (li.hasNext()) {\r
            AntTaskDocument.AntTask at = (AntTaskDocument.AntTask)li.next();\r
            saa[i][0] = at.getId() + "";\r
            saa[i][1] = saa[i][2] = "";\r
            if (at.getFilename() != null){\r
                saa[i][1] = at.getFilename();\r
            }\r
            if (at.getAntCmdOptions() != null) {\r
                saa[i][2] = at.getAntCmdOptions();\r
            }\r
            ++i;\r
        }\r
    }\r
    public void genBuildOptionsOpt(String buildTargets, String toolChain, String tagName, String toolCmd, String archList, String contents) {\r
        OptionsDocument.Options opts = getfpdBuildOpts().getOptions();\r
        if (opts == null) {\r
            opts = getfpdBuildOpts().addNewOptions();\r
        }\r
        OptionDocument.Option opt = opts.addNewOption();\r
        setBuildOptionsOpt(buildTargets, toolChain, tagName, toolCmd, archList, contents, opt);\r
    }\r
    \r
    private void setBuildOptionsOpt(String buildTargets, String toolChain, String tagName, String toolCmd, String archList, String contents, OptionDocument.Option opt){\r
        opt.setStringValue(contents);\r
//        opt.setBuildTargets(buildTargets);\r
        opt.setToolChainFamily(toolChain);\r
        opt.setTagName(tagName);\r
        opt.setToolCode(toolCmd);\r
        String[] s = archList.split(" ");\r
        ArrayList<String> al = new ArrayList<String>();\r
        for (int i = 0; i < s.length; ++i) {\r
            al.add(s[i]);\r
        }\r
        opt.setSupArchList(al);\r
    }\r
    \r
    public void removeBuildOptionsOpt(int i){\r
    \r
        XmlObject o = getfpdBuildOpts().getOptions();\r
        if (o == null) {\r
            return;\r
        }\r
        \r
        XmlCursor cursor = o.newCursor();\r
        if (cursor.toFirstChild()) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling();\r
            }\r
            cursor.removeXml();\r
        }\r
        cursor.dispose();\r
    }\r
    \r
    public void updateBuildOptionsOpt(int i, String buildTargets, String toolChain, String tagName, String toolCmd, String archList, String contents) {\r
        XmlObject o = getfpdBuildOpts().getOptions();\r
        if (o == null) {\r
            return;\r
        }\r
        \r
        XmlCursor cursor = o.newCursor();\r
        if (cursor.toFirstChild()) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling();\r
            }\r
            OptionDocument.Option opt = (OptionDocument.Option)cursor.getObject();\r
            setBuildOptionsOpt(buildTargets, toolChain, tagName, toolCmd, archList, contents, opt);\r
        }\r
        cursor.dispose();\r
    }\r
    \r
    public int getBuildOptionsOptCount(){\r
        if (getfpdBuildOpts().getOptions() == null || getfpdBuildOpts().getOptions().getOptionList() == null) {\r
            return 0;\r
        }\r
        return getfpdBuildOpts().getOptions().getOptionList().size();\r
    }\r
    \r
    public void getBuildOptionsOpts(String[][] saa) {\r
        if (getfpdBuildOpts().getOptions() == null || getfpdBuildOpts().getOptions().getOptionList() == null) {\r
            return ;\r
        }\r
        \r
        List<OptionDocument.Option> lOpt = getfpdBuildOpts().getOptions().getOptionList();\r
        ListIterator li = lOpt.listIterator();\r
        int i = 0;\r
        while(li.hasNext()) {\r
            OptionDocument.Option opt = (OptionDocument.Option)li.next();\r
//            saa[i][0] = opt.getBuildTargets();\r
            saa[i][1] = opt.getToolChainFamily();\r
            if (opt.getSupArchList() != null){\r
                Object[] archs = opt.getSupArchList().toArray();\r
                saa[i][2] = " ";\r
                for (int j = 0; j < archs.length; ++j){\r
                    saa[i][2] += archs[j];\r
                    saa[i][2] += " ";\r
                }\r
                saa[i][2] = saa[i][2].trim();\r
            }\r
            saa[i][3] = opt.getToolCode();\r
            saa[i][4] = opt.getTagName();\r
            saa[i][5] = opt.getStringValue();\r
             \r
            ++i;\r
        }\r
    }\r
    \r
    public PlatformDefinitionsDocument.PlatformDefinitions getfpdPlatformDefs(){\r
        if (fpdPlatformDefs == null){\r
            fpdPlatformDefs = fpdRoot.addNewPlatformDefinitions();\r
        }\r
        return fpdPlatformDefs;\r
    }\r
    \r
    public FlashDocument.Flash getfpdFlash() {\r
        if (fpdFlash == null) {\r
            fpdFlash = fpdRoot.addNewFlash();\r
        }\r
        return fpdFlash;\r
    }\r
    \r
    public void genFlashDefinitionFile(String file) {\r
        FlashDefinitionFileDocument.FlashDefinitionFile fdf = getfpdFlash().getFlashDefinitionFile();\r
        if (fdf == null) {\r
            fdf = getfpdFlash().addNewFlashDefinitionFile();\r
        }\r
        \r
        fdf.setStringValue(file);\r
    }\r
    \r
    public String getFlashDefinitionFile() {\r
        FlashDefinitionFileDocument.FlashDefinitionFile fdf = getfpdFlash().getFlashDefinitionFile();\r
        if (fdf == null) {\r
            return "";\r
        }\r
        \r
        return fdf.getStringValue();\r
    }\r
    \r
    \r
    \r
    public void genFvImagesNameValue(String name, String value) {\r
      \r
        FvImagesDocument.FvImages fi = getfpdFlash().getFvImages();\r
        if (fi == null) {\r
            fi = getfpdFlash().addNewFvImages();\r
        }\r
        \r
        FvImagesDocument.FvImages.NameValue nv = fi.addNewNameValue();\r
        nv.setName(name);\r
        nv.setValue(value);\r
    }\r
    \r
    public void removeFvImagesNameValue(int i){\r
     \r
        XmlObject o = getfpdFlash().getFvImages();\r
        if (o == null) {\r
            return;\r
        }\r
        \r
        QName qNameValue = new QName(xmlNs, "NameValue");\r
        XmlCursor cursor = o.newCursor();\r
        if (cursor.toChild(qNameValue)) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling(qNameValue);\r
            }\r
            cursor.removeXml();\r
        }\r
        cursor.dispose();\r
    }\r
    \r
    public void updateFvImagesNameValue(int i, String name, String value){\r
        \r
        XmlObject o = getfpdFlash().getFvImages();\r
        if (o == null) {\r
            return;\r
        }\r
        \r
        QName qNameValue = new QName(xmlNs, "NameValue");\r
        XmlCursor cursor = o.newCursor();\r
        if (cursor.toChild(qNameValue)) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling(qNameValue);\r
            }\r
            FvImagesDocument.FvImages.NameValue nv = (FvImagesDocument.FvImages.NameValue)cursor.getObject();\r
            nv.setName(name);\r
            nv.setValue(value);\r
        }\r
        cursor.dispose();\r
    }\r
    \r
    public int getFvImagesNameValueCount() {\r
           \r
        FvImagesDocument.FvImages fi = null;\r
        if ((fi = getfpdFlash().getFvImages()) == null || fi.getNameValueList() == null) {\r
            return 0;\r
        }\r
        return fi.getNameValueList().size();\r
    }\r
    \r
    public void getFvImagesNameValues(String[][] nv) {\r
     \r
        FvImagesDocument.FvImages fi = getfpdFlash().getFvImages();\r
        if (fi == null){\r
            return;\r
        }\r
        List<FvImagesDocument.FvImages.NameValue> l = fi.getNameValueList();\r
        int i = 0;\r
        ListIterator li = l.listIterator();\r
        while (li.hasNext()) {\r
            FvImagesDocument.FvImages.NameValue e = (FvImagesDocument.FvImages.NameValue) li\r
                                                                                                                    .next();\r
            nv[i][0] = e.getName();\r
            nv[i][1] = e.getValue();\r
            \r
            i++;\r
        }\r
    }\r
    \r
    public void genFvImagesFvImage(String[] names, String types, Map<String, String> options) {\r
      \r
        FvImagesDocument.FvImages fis = null;\r
        if ((fis = getfpdFlash().getFvImages()) == null) {\r
            fis = getfpdFlash().addNewFvImages();\r
        }\r
        \r
        //\r
        //gen FvImage with FvImageNames array\r
        //\r
        FvImagesDocument.FvImages.FvImage fi = fis.addNewFvImage();\r
        for (int i = 0; i < names.length; ++i) {\r
            fi.addFvImageNames(names[i]);\r
        }\r
        fi.setType(FvImageTypes.Enum.forString(types));\r
        if (options != null){\r
            setFvImagesFvImageFvImageOptions(options, fi);\r
        }\r
    }\r
    \r
    private void setFvImagesFvImageFvImageOptions(Map<String, String> options, FvImagesDocument.FvImages.FvImage fi){\r
        FvImagesDocument.FvImages.FvImage.FvImageOptions fio = fi.getFvImageOptions();\r
        if (fio == null){\r
            fio = fi.addNewFvImageOptions();\r
        }\r
        \r
        Set<String> key = options.keySet();\r
        Iterator<String> i = key.iterator();\r
        while (i.hasNext()) {\r
            FvImagesDocument.FvImages.FvImage.FvImageOptions.NameValue nv = fio.addNewNameValue();\r
            String k = (String)i.next();\r
            nv.setName(k);\r
            nv.setValue((String)options.get(k));\r
            \r
        }\r
        \r
    }\r
    \r
    public void removeFvImagesFvImage(int i) {\r
      \r
        XmlObject o = getfpdFlash().getFvImages();\r
        if (o == null) {\r
            return;\r
        }\r
        \r
        QName qFvImage = new QName(xmlNs, "FvImage");\r
        XmlCursor cursor = o.newCursor();\r
        if (cursor.toChild(qFvImage)) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling(qFvImage);\r
            }\r
            cursor.removeXml();\r
        }\r
        cursor.dispose();\r
    }\r
    \r
    public void updateFvImagesFvImage(int i, String[] names, String types, Map<String, String> options){\r
           \r
        XmlObject o = getfpdFlash().getFvImages();\r
        if (o == null) {\r
            return;\r
        }\r
        XmlCursor cursor = o.newCursor();\r
        QName qFvImage = new QName(xmlNs, "FvImage");\r
        if (cursor.toChild(qFvImage)) {\r
            for (int j = 0; j < i; ++j) {\r
                cursor.toNextSibling(qFvImage);\r
            }\r
            FvImagesDocument.FvImages.FvImage fi = (FvImagesDocument.FvImages.FvImage)cursor.getObject();\r
            fi.setType(FvImageTypes.Enum.forString(types));\r
            \r
            //\r
            // remove old FvImageNames before adding new ones\r
            //\r
            QName qFvImageNames = new QName(xmlNs, "FvImageNames"); \r
            cursor.toChild(qFvImageNames);\r
            cursor.removeXml();\r
            while (cursor.toNextSibling(qFvImageNames)) {\r
                cursor.removeXml();\r
            }\r
            \r
            for (int k = 0; k < names.length; ++k) {\r
                fi.addFvImageNames(names[k]);\r
            }\r
            //\r
            // remove old FvImageOptions before adding new options\r
            //\r
            QName qFvImageOptions = new QName(xmlNs, "FvImageOptions");\r
            cursor.toNextSibling(qFvImageOptions);\r
            cursor.removeXml();\r
            \r
            setFvImagesFvImageFvImageOptions(options, fi);\r
        }\r
        cursor.dispose();\r
    }\r
    \r
    public int getFvImagesFvImageCount() {\r
        \r
        if (getfpdFlash().getFvImages() == null || getfpdFlash().getFvImages().getFvImageList() == null) {\r
            return 0;\r
        }\r
        return getfpdFlash().getFvImages().getFvImageList().size();\r
    }\r
    \r
    public void getFvImagesFvImages(String[][] saa, ArrayList<LinkedHashMap<String, String>> options) {\r
    \r
        if (getfpdFlash().getFvImages() == null) {\r
            return;\r
        }\r
        List<FvImagesDocument.FvImages.FvImage> l = getfpdFlash().getFvImages().getFvImageList();\r
        if (l == null) {\r
            return;\r
        }\r
        ListIterator li = l.listIterator();\r
        int i = 0;\r
        while(li.hasNext()) {\r
            FvImagesDocument.FvImages.FvImage fi = (FvImagesDocument.FvImages.FvImage)li.next();\r
            //\r
            // get FvImageNames array, space separated\r
            //\r
            List<String> lfn = fi.getFvImageNamesList();\r
            ListIterator lfni = lfn.listIterator();\r
            saa[i][0] = " ";\r
            while (lfni.hasNext()) {\r
                saa[i][0] += (String)lfni.next();\r
                saa[i][0] += " ";\r
            }\r
            saa[i][0] = saa[i][0].trim();\r
            \r
            saa[i][1] = fi.getType()+"";\r
            \r
            //\r
            // get FvImageOptions into Map[i]\r
            //\r
            FvImagesDocument.FvImages.FvImage.FvImageOptions fo = fi.getFvImageOptions();\r
            if (fo == null) {\r
                ++i;\r
                continue;\r
            }\r
            List<FvImagesDocument.FvImages.FvImage.FvImageOptions.NameValue> lnv = fo.getNameValueList();\r
            if (lnv == null || lnv.isEmpty()) {\r
                ++i;\r
                continue;\r
            }\r
            ListIterator lnvi = lnv.listIterator();\r
            while (lnvi.hasNext()) {\r
                FvImagesDocument.FvImages.FvImage.FvImageOptions.NameValue nv = (FvImagesDocument.FvImages.FvImage.FvImageOptions.NameValue)lnvi.next();\r
                Map<String, String> m = options.get(i);\r
                m.put(nv.getName(), nv.getValue());\r
            }\r
            \r
            ++i;\r
        }\r
    }\r
    \r
    /**\r
     Get platform header element\r
     @return PlatformHeaderDocument.PlatformHeader\r
    **/\r
    public PlatformHeaderDocument.PlatformHeader getFpdHdr() {\r
        if (fpdHdr == null) {\r
            fpdHdr = fpdRoot.addNewPlatformHeader();\r
        }\r
        genPlatformDefsSkuInfo("0", "DEFAULT");\r
        return fpdHdr;\r
    }\r
    \r
    public void genPlatformDefsSkuInfo(String id, String name) {\r
        SkuInfoDocument.SkuInfo skuInfo = null;\r
        if (getfpdPlatformDefs().getSkuInfo() == null) {\r
            skuInfo = getfpdPlatformDefs().addNewSkuInfo();\r
        }\r
        skuInfo = getfpdPlatformDefs().getSkuInfo();\r
        if (skuInfo.getUiSkuNameList() == null || skuInfo.getUiSkuNameList().size() == 0) {\r
            SkuInfoDocument.SkuInfo.UiSkuName skuName = skuInfo.addNewUiSkuName();\r
            skuName.setSkuID(new BigInteger("0"));\r
            skuName.setStringValue("DEFAULT");\r
        }\r
        if (id.equals("0")) {\r
            return;\r
        }\r
        SkuInfoDocument.SkuInfo.UiSkuName skuName = skuInfo.addNewUiSkuName();\r
        skuName.setSkuID(new BigInteger(id));\r
        skuName.setStringValue(name);\r
            \r
        \r
    }\r
    public String getFpdHdrPlatformName() {\r
        return getFpdHdr().getPlatformName();\r
    }\r
    \r
    public String getFpdHdrGuidValue() {\r
        return getFpdHdr().getGuidValue();\r
    }\r
    \r
    public String getFpdHdrVer() {\r
        return getFpdHdr().getVersion();\r
    }\r
    \r
    public String getFpdHdrAbs() {\r
        return getFpdHdr().getAbstract();\r
    }\r
    \r
    public String getFpdHdrDescription() {\r
        return getFpdHdr().getDescription();\r
    }\r
    \r
    public String getFpdHdrCopyright() {\r
        return getFpdHdr().getCopyright();\r
    }\r
    \r
    public String getFpdHdrLicense() {\r
        LicenseDocument.License l = getFpdHdr().getLicense();\r
        if (l == null) {\r
            return null;\r
        }\r
        return l.getStringValue();\r
    }\r
    \r
    public String getFpdHdrUrl() {\r
        LicenseDocument.License l = getFpdHdr().getLicense();\r
        if (l == null) {\r
            return null;\r
        }\r
        return l.getURL();\r
    }\r
    \r
    public String getFpdHdrSpec() {\r
\r
        return "FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052";\r
//        return getFpdHdr().getSpecification();\r
    }\r
    \r
    public void setFpdHdrPlatformName(String name){\r
        getFpdHdr().setPlatformName(name);\r
    }\r
    \r
    public void setFpdHdrGuidValue(String guid){\r
        getFpdHdr().setGuidValue(guid);\r
    }\r
    \r
    public void setFpdHdrVer(String v){\r
        getFpdHdr().setVersion(v);\r
    }\r
    \r
    public void setFpdHdrAbs(String abs) {\r
        getFpdHdr().setAbstract(abs);\r
    }\r
    \r
    public void setFpdHdrDescription(String desc){\r
        getFpdHdr().setDescription(desc);\r
    }\r
    \r
    public void setFpdHdrCopyright(String cr) {\r
        getFpdHdr().setCopyright(cr);\r
    }\r
    \r
    public void setFpdHdrLicense(String license){\r
        LicenseDocument.License l = getFpdHdr().getLicense();\r
        if (l == null) {\r
            getFpdHdr().addNewLicense().setStringValue(license);\r
        }\r
        else {\r
            l.setStringValue(license);\r
        }\r
    }\r
\r
    public void setFpdHdrUrl(String url){\r
        LicenseDocument.License l = getFpdHdr().getLicense();\r
        \r
        l.setURL(url);\r
        \r
    }\r
    \r
    public void setFpdHdrSpec(String s){\r
        s = "FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052";\r
        getFpdHdr().setSpecification(s);\r
    }\r
    /**\r
    Save the processed xml contents to file\r
    \r
    @param fpdFile The file to save xml contents\r
    @throws IOException Exceptions during file operation\r
    **/\r
    public void saveAs(File fpdFile) throws IOException {\r
\r
       XmlOptions options = new XmlOptions();\r
\r
       options.setCharacterEncoding("UTF-8");\r
       options.setSavePrettyPrint();\r
       options.setSavePrettyPrintIndent(2);\r
       try {\r
           fpdd.save(fpdFile, options);\r
       } catch (IOException e) {\r
           e.printStackTrace();\r
       }\r
\r
    }\r
    \r
    private String listToString(List<String> l) {\r
        if (l == null) {\r
            return null;\r
        }\r
        String s = " ";\r
        ListIterator li = l.listIterator();\r
        while(li.hasNext()) {\r
            s += li.next();\r
            s += " ";\r
        }\r
        return s.trim();\r
    }\r
}\r