Fix capitalization

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

/** @file\r
  SurfaceAreaParser class.\r
  \r
  SurfaceAreaParser class is used to parse module surface area include both \r
  driver and library. \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.global;\r
\r
import java.io.File;\r
import java.util.HashMap;\r
import java.util.Map;\r
\r
import org.apache.tools.ant.BuildException;\r
import org.apache.xmlbeans.XmlObject;\r
import org.tianocore.LibraryModuleBuildDescriptionDocument;\r
import org.tianocore.LibraryModuleSurfaceAreaDocument;\r
import org.tianocore.ModuleBuildDescriptionDocument;\r
import org.tianocore.ModuleSurfaceAreaDocument;\r
\r
/**\r
  This class is used to parse module surface area (MSA & MBD) include both \r
  driver and library. \r
\r
  @since GenBuild 1.0\r
**/\r
public class SurfaceAreaParser {\r
\r
    /**\r
      Using XmlBeans to parse and valid surface area file. \r
    \r
      @param surfaceAreaFile the surface area file to parse\r
      @return top level elements and its value mapping information\r
      @throws BuildException\r
              If surface area is not well-formed or invalid\r
    **/\r
    public Map<String, XmlObject> parseFile(File surfaceAreaFile) throws BuildException {\r
        Map<String, XmlObject> map = new HashMap<String, XmlObject>();\r
        try {\r
            XmlObject sadoc = XmlObject.Factory.parse(surfaceAreaFile);\r
            // Validate File if they obey XML Schema\r
            \r
            if ( ! sadoc.validate()){\r
                throw new BuildException("Surface Area file [" + surfaceAreaFile.getPath() + "] is invalid.");\r
            }\r
            if (sadoc instanceof ModuleSurfaceAreaDocument){\r
                parseFile((ModuleSurfaceAreaDocument) sadoc, map);\r
            }\r
            else if(sadoc instanceof ModuleBuildDescriptionDocument){\r
                parseFile((ModuleBuildDescriptionDocument) sadoc, map);\r
            }\r
            else if(sadoc instanceof LibraryModuleSurfaceAreaDocument){\r
                parseFile((LibraryModuleSurfaceAreaDocument) sadoc, map);\r
            }\r
            else if(sadoc instanceof LibraryModuleBuildDescriptionDocument){\r
                parseFile((LibraryModuleBuildDescriptionDocument) sadoc, map);\r
            }\r
        }\r
        catch (Exception ex){\r
            throw new BuildException(ex.getMessage());\r
        }\r
        return map;\r
    }\r
    \r
    \r
    /**\r
      Parse MSA.\r
    \r
      @param doc top level surface area XML document\r
      @param msaMap the map to store the result\r
    **/\r
    private void parseFile(ModuleSurfaceAreaDocument doc, Map<String, XmlObject> msaMap) {\r
        msaMap.put("MsaHeader", doc.getModuleSurfaceArea().getMsaHeader());\r
        msaMap.put("LibraryClassDefinitions", doc.getModuleSurfaceArea()\r
                        .getLibraryClassDefinitions());\r
        msaMap.put("SourceFiles", doc.getModuleSurfaceArea().getSourceFiles());\r
        msaMap.put("Includes", doc.getModuleSurfaceArea().getIncludes());\r
        msaMap.put("Protocols", doc.getModuleSurfaceArea().getProtocols());\r
\r
        msaMap.put("Events", doc.getModuleSurfaceArea().getEvents());\r
        msaMap.put("Hobs", doc.getModuleSurfaceArea().getHobs());\r
        msaMap.put("PPIs", doc.getModuleSurfaceArea().getPPIs());\r
        msaMap.put("Variables", doc.getModuleSurfaceArea().getVariables());\r
        msaMap.put("BootModes", doc.getModuleSurfaceArea().getBootModes());\r
\r
        msaMap\r
                        .put("SystemTables", doc.getModuleSurfaceArea()\r
                                        .getSystemTables());\r
        msaMap.put("DataHubs", doc.getModuleSurfaceArea().getDataHubs());\r
        msaMap.put("Formsets", doc.getModuleSurfaceArea().getFormsets());\r
        msaMap.put("Guids", doc.getModuleSurfaceArea().getGuids());\r
        msaMap.put("Externs", doc.getModuleSurfaceArea().getExterns());\r
\r
        msaMap.put("PCDs", doc.getModuleSurfaceArea().getPCDs());\r
        msaMap\r
                        .put("BuildOptions", doc.getModuleSurfaceArea()\r
                                        .getBuildOptions());\r
    }\r
\r
    /**\r
      Parse MBD.\r
  \r
      @param doc top level surface area XML document\r
      @param msaMap the map to store the result\r
    **/\r
    private void parseFile(ModuleBuildDescriptionDocument doc, Map<String, XmlObject> mbdMap) {\r
        mbdMap.put("MbdHeader", doc.getModuleBuildDescription().getMbdHeader());\r
        mbdMap.put("Libraries", doc.getModuleBuildDescription().getLibraries());\r
        mbdMap.put("SourceFiles", doc.getModuleBuildDescription()\r
                        .getSourceFiles());\r
        mbdMap.put("Includes", doc.getModuleBuildDescription().getIncludes());\r
        mbdMap.put("Protocols", doc.getModuleBuildDescription().getProtocols());\r
\r
        mbdMap.put("Events", doc.getModuleBuildDescription().getEvents());\r
        mbdMap.put("Hobs", doc.getModuleBuildDescription().getHobs());\r
        mbdMap.put("PPIs", doc.getModuleBuildDescription().getPPIs());\r
        mbdMap.put("Variables", doc.getModuleBuildDescription().getVariables());\r
        mbdMap.put("BootModes", doc.getModuleBuildDescription().getBootModes());\r
\r
        mbdMap.put("SystemTables", doc.getModuleBuildDescription()\r
                        .getSystemTables());\r
        mbdMap.put("DataHubs", doc.getModuleBuildDescription().getDataHubs());\r
        mbdMap.put("Formsets", doc.getModuleBuildDescription().getFormsets());\r
        mbdMap.put("Guids", doc.getModuleBuildDescription().getGuids());\r
        mbdMap.put("Externs", doc.getModuleBuildDescription().getExterns());\r
\r
        mbdMap.put("PCDs", doc.getModuleBuildDescription().getPCDs());\r
        mbdMap.put("BuildOptions", doc.getModuleBuildDescription()\r
                        .getBuildOptions());\r
    }\r
    /**\r
      Parse Library MSA.\r
\r
      @param doc top level surface area XML document\r
      @param msaMap the map to store the result\r
    **/\r
    private void parseFile(LibraryModuleSurfaceAreaDocument doc, Map<String, XmlObject> msaMap) {\r
        msaMap.put("MsaLibHeader", doc.getLibraryModuleSurfaceArea()\r
                        .getMsaLibHeader());\r
        msaMap.put("LibraryClassDefinitions", doc.getLibraryModuleSurfaceArea()\r
                        .getLibraryClassDefinitions());\r
        msaMap.put("SourceFiles", doc.getLibraryModuleSurfaceArea()\r
                        .getSourceFiles());\r
        msaMap.put("Includes", doc.getLibraryModuleSurfaceArea().getIncludes());\r
        msaMap.put("Protocols", doc.getLibraryModuleSurfaceArea()\r
                        .getProtocols());\r
\r
        msaMap.put("Events", doc.getLibraryModuleSurfaceArea().getEvents());\r
        msaMap.put("Hobs", doc.getLibraryModuleSurfaceArea().getHobs());\r
        msaMap.put("PPIs", doc.getLibraryModuleSurfaceArea().getPPIs());\r
        msaMap.put("Variables", doc.getLibraryModuleSurfaceArea()\r
                        .getVariables());\r
        msaMap.put("BootModes", doc.getLibraryModuleSurfaceArea()\r
                        .getBootModes());\r
\r
        msaMap.put("SystemTables", doc.getLibraryModuleSurfaceArea()\r
                        .getSystemTables());\r
        msaMap.put("DataHubs", doc.getLibraryModuleSurfaceArea().getDataHubs());\r
        msaMap.put("Formsets", doc.getLibraryModuleSurfaceArea().getFormsets());\r
        msaMap.put("Guids", doc.getLibraryModuleSurfaceArea().getGuids());\r
        msaMap.put("Externs", doc.getLibraryModuleSurfaceArea().getExterns());\r
\r
        msaMap.put("PCDs", doc.getLibraryModuleSurfaceArea().getPCDs());\r
        msaMap.put("BuildOptions", doc.getLibraryModuleSurfaceArea()\r
                        .getBuildOptions());\r
    }\r
\r
    /**\r
      Parse Library MBD.\r
\r
      @param doc top level surface area XML document\r
      @param msaMap the map to store the result\r
    **/\r
    private void parseFile(LibraryModuleBuildDescriptionDocument doc, Map<String, XmlObject> mbdMap) {\r
        mbdMap.put("MbdLibHeader", doc.getLibraryModuleBuildDescription()\r
                        .getMbdLibHeader());\r
        mbdMap.put("Libraries", doc.getLibraryModuleBuildDescription()\r
                        .getLibraries());\r
        mbdMap.put("SourceFiles", doc.getLibraryModuleBuildDescription()\r
                        .getSourceFiles());\r
        mbdMap.put("Includes", doc.getLibraryModuleBuildDescription()\r
                        .getIncludes());\r
        mbdMap.put("Protocols", doc.getLibraryModuleBuildDescription()\r
                        .getProtocols());\r
\r
        mbdMap\r
                        .put("Events", doc.getLibraryModuleBuildDescription()\r
                                        .getEvents());\r
        mbdMap.put("Hobs", doc.getLibraryModuleBuildDescription().getHobs());\r
        mbdMap.put("PPIs", doc.getLibraryModuleBuildDescription().getPPIs());\r
        mbdMap.put("Variables", doc.getLibraryModuleBuildDescription()\r
                        .getVariables());\r
        mbdMap.put("BootModes", doc.getLibraryModuleBuildDescription()\r
                        .getBootModes());\r
\r
        mbdMap.put("SystemTables", doc.getLibraryModuleBuildDescription()\r
                        .getSystemTables());\r
        mbdMap.put("DataHubs", doc.getLibraryModuleBuildDescription()\r
                        .getDataHubs());\r
        mbdMap.put("Formsets", doc.getLibraryModuleBuildDescription()\r
                        .getFormsets());\r
        mbdMap.put("Guids", doc.getLibraryModuleBuildDescription().getGuids());\r
        mbdMap.put("Externs", doc.getLibraryModuleBuildDescription()\r
                        .getExterns());\r
\r
        mbdMap.put("PCDs", doc.getLibraryModuleBuildDescription().getPCDs());\r
        mbdMap.put("BuildOptions", doc.getLibraryModuleBuildDescription()\r
                        .getBuildOptions());\r
    }\r
}\r