Change to new XML Schema.

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

/** @file\r
  This file is an ANT task.\r
  \r
  LibBuildFileGenerator task is used to generate module's build.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
**/\r
package org.tianocore.build.global;\r
\r
import java.io.File;\r
import java.util.HashMap;\r
import java.util.Iterator;\r
import java.util.Map;\r
import java.util.Set;\r
import java.util.Vector;\r
\r
import javax.xml.parsers.DocumentBuilder;\r
import javax.xml.parsers.DocumentBuilderFactory;\r
import javax.xml.transform.OutputKeys;\r
import javax.xml.transform.Result;\r
import javax.xml.transform.Source;\r
import javax.xml.transform.Transformer;\r
import javax.xml.transform.TransformerFactory;\r
import javax.xml.transform.dom.DOMSource;\r
import javax.xml.transform.stream.StreamResult;\r
\r
import org.apache.tools.ant.BuildException;\r
import org.apache.tools.ant.Task;\r
import org.apache.xmlbeans.XmlObject;\r
import org.tianocore.MsaHeaderDocument.MsaHeader;\r
import org.tianocore.MsaLibHeaderDocument.MsaLibHeader;\r
import org.w3c.dom.Document;\r
import org.w3c.dom.Element;\r
\r
/**\r
  This class <code>LibBuildFileGenerator</code> is an ANT task to generate \r
  build.xml for each module. Here are two usages. \r
  \r
  <ul>\r
    <li>\r
      For one module (<b>bf</b> is LibBuildFileGenerator task name):\r
      <pre>\r
        &lt;bf buildFile="Application\HelloWorld\HelloWorld.msa" /&gt;\r
      </pre>\r
    </li>\r
    <li>\r
      For one package:\r
      <pre>\r
        &lt;bf recursive="true" /&gt;\r
      </pre>\r
    </li>\r
  </ul>\r
  \r
  @since GenBuild 1.0\r
**/\r
public class LibBuildFileGenerator extends Task {\r
\r
    private File buildFile;\r
\r
    private boolean recursive = false;\r
    \r
    private String license = " Copyright (c) 2006, Intel Corporation \n"\r
                    + "All rights reserved. This program and the accompanying materials \n"\r
                    + "are licensed and made available under the terms and conditions of the BSD License \n"\r
                    + "which accompanies this distribution.  The full text of the license may be found at  \n"\r
                    + "http://opensource.org/licenses/bsd-license.php \n"\r
                    + "\n"\r
                    + "THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN \"AS IS\" BASIS, \n"\r
                    + "WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.";\r
\r
    private String base_name;\r
    \r
    private String module_relative_path;\r
    \r
    private File base_file = new File(".");\r
    \r
    /**\r
      Public construct method. It is necessary for ANT task.\r
    **/\r
    public LibBuildFileGenerator () {\r
    }\r
\r
    /**\r
      ANT task's entry point, will be called after init(). \r
      \r
      @throws BuildException\r
              buildFile do not specify while recursive set to false\r
    **/\r
    public void execute() throws BuildException {\r
        if(recursive){\r
            searchMsa(new File("."));\r
        }\r
        else {\r
            Map<String,File> map = new HashMap<String,File>();\r
            String basename = buildFile.getName();\r
            int k = basename.lastIndexOf('.');\r
            base_name = basename.substring(0, k);\r
            map.put(base_name, buildFile);\r
            genBuildFile(map);\r
        }\r
    }\r
    \r
    /**\r
      Recursivly find all MSA files and record all modules. \r
      \r
      @param path Package path\r
    **/\r
    private void searchMsa(File path){\r
        File[] files = path.listFiles();\r
        Vector<File> vec = new Vector<File>();\r
        for(int i=0; i < files.length; i ++){\r
            if (files[i].isFile()){\r
                if(files[i].getName().endsWith(".msa")){\r
                    System.out.println("#" + files[i].getPath());\r
                    vec.add(files[i]);\r
                }\r
            }\r
        }\r
        Map<String,File> mapBasename = new HashMap<String,File>();\r
        if (vec.size() > 0){\r
            base_name = null;\r
            for ( int j = 0 ; j < vec.size(); j++){\r
                if ( vec.size() > 1){\r
                  System.out.println("##" + vec.get(0));\r
                }\r
                File f = (File)vec.get(j);\r
                SurfaceAreaParser surfaceAreaParser = new SurfaceAreaParser();\r
                Map<String, XmlObject> map = surfaceAreaParser.parseFile(f);\r
                String baseName = "";\r
                XmlObject header = null;\r
                if ( (header = map.get("MsaHeader")) != null ){\r
                    baseName = ((MsaHeader)header).getBaseName().getStringValue();\r
                }\r
                else if ( (header = map.get("MsaLibHeader")) != null){\r
                    baseName = ((MsaLibHeader)header).getBaseName().getStringValue();\r
                } else {\r
                    continue ;\r
                }\r
                if ( base_name == null || base_name.length() > baseName.length()){\r
                    base_name = baseName;\r
                    buildFile = f;\r
                    try {\r
                    module_relative_path = buildFile.getParent().substring(base_file.getPath().length() + 1);\r
                    }\r
                    catch(Exception e){\r
                        module_relative_path = ".";\r
                    }\r
                }\r
                mapBasename.put(baseName, f);\r
            }\r
            genBuildFile(mapBasename);\r
        }\r
\r
        for(int i=0; i < files.length; i ++){\r
            if (files[i].isDirectory()){\r
                searchMsa(files[i]);\r
            }\r
        }\r
    }\r
    \r
    /**\r
      Generate build.xml.\r
      \r
      @param map All base name under one module directory\r
    **/\r
    private void genBuildFile(Map map) {\r
        DocumentBuilderFactory domfac = DocumentBuilderFactory.newInstance();\r
        try {\r
            DocumentBuilder dombuilder = domfac.newDocumentBuilder();\r
            Document document = dombuilder.newDocument();\r
            //\r
            // create root element and its attributes\r
            //\r
            document.appendChild(document.createComment(license));\r
            Element root = document.createElement("project");\r
            root.setAttribute("default", base_name);\r
            root.setAttribute("basedir", ".");\r
            //\r
            // element for External ANT tasks\r
            //\r
            root.appendChild(document.createComment("Apply external ANT tasks"));\r
            Element ele = document.createElement("taskdef");\r
            ele.setAttribute("resource", "GenBuild.tasks");\r
            root.appendChild(ele);\r
            //\r
            // <taskdef resource="net/sf/antcontrib/antlib.xml" />\r
            //\r
            ele = document.createElement("taskdef");\r
            ele.setAttribute("resource", "net/sf/antcontrib/antlib.xml");\r
            root.appendChild(ele);\r
            \r
            ele = document.createElement("property");\r
            ele.setAttribute("environment", "env");\r
            root.appendChild(ele);\r
\r
            ele = document.createElement("property");\r
            ele.setAttribute("name", "WORKSPACE_DIR");\r
            ele.setAttribute("value", "${env.WORKSPACE}");\r
            root.appendChild(ele);\r
            \r
            ele = document.createElement("import");\r
            ele.setAttribute("file", "${WORKSPACE_DIR}"+File.separatorChar+"Tools"+File.separatorChar+"Conf"+File.separatorChar+"BuildMacro.xml");\r
            root.appendChild(ele);\r
            \r
            root.appendChild(document.createComment("MODULE_RELATIVE PATH is relative to PACKAGE_DIR"));\r
            ele = document.createElement("property");\r
            ele.setAttribute("name", "MODULE_RELATIVE_PATH");\r
            ele.setAttribute("value", module_relative_path);\r
            root.appendChild(ele);\r
\r
            ele = document.createElement("property");\r
            ele.setAttribute("name", "MODULE_DIR");\r
            ele.setAttribute("value", "${PACKAGE_DIR}" + File.separatorChar + "${MODULE_RELATIVE_PATH}");\r
            root.appendChild(ele);\r
\r
            ele = document.createElement("property");\r
            ele.setAttribute("name", "COMMON_FILE");\r
            ele.setAttribute("value", "${WORKSPACE_DIR}" + File.separatorChar + "Tools"\r
                            + File.separatorChar + "Conf" + File.separatorChar + "Common.xml");\r
            root.appendChild(ele);\r
            \r
            //\r
            // generate the buildfmd target\r
            //\r
            Set set = map.keySet();\r
            Iterator iter = set.iterator();\r
            while (iter.hasNext()){\r
                String bName = (String)iter.next();\r
                File msaFile = (File)map.get(bName);\r
                String msaFilename = "${MODULE_DIR}" + File.separatorChar + msaFile.getName();\r
                String mbdFilename = msaFilename.substring(0 , msaFilename.length() - 4) + ".mbd";\r
                ele = document.createElement("target");\r
                ele.setAttribute("name", bName);\r
                Element target = document.createElement("GenBuild");\r
                target.setAttribute("msaFilename", msaFilename);\r
                target.setAttribute("mbdFilename", mbdFilename);\r
                target.setAttribute("baseName", bName);\r
                ele.appendChild(target);\r
                root.appendChild(ele);\r
            }\r
\r
            root.appendChild(ele);\r
            //\r
            // Default clean\r
            //\r
            ele = document.createElement("target");\r
            ele.setAttribute("name", "clean");\r
            ele.setAttribute("depends", base_name + "_clean");\r
            root.appendChild(ele);\r
            //\r
            // Default Clean ALl\r
            //\r
            ele = document.createElement("target");\r
            ele.setAttribute("name", "cleanall");\r
            ele.setAttribute("depends", base_name + "_cleanall");\r
            root.appendChild(ele);\r
            //\r
            // Every clean target for each BaseName\r
            //\r
            set = map.keySet();\r
            iter = set.iterator();\r
            while (iter.hasNext()){\r
                String bName = (String)iter.next();\r
                File msaFile = (File)map.get(bName);\r
                String msaFilename = "${MODULE_DIR}" + File.separatorChar + msaFile.getName();\r
                String mbdFilename = msaFilename.substring(0 , msaFilename.length() - 4) + ".mbd";\r
                \r
                ele = document.createElement("target");\r
                ele.setAttribute("name", bName + "_clean");\r
                //\r
                // Output Dir\r
                //\r
                Element target = document.createElement("OutputDirSetup");\r
                target.setAttribute("msaFilename", msaFilename);\r
                target.setAttribute("mbdFilename", mbdFilename);\r
                target.setAttribute("baseName", bName);\r
                ele.appendChild(target);\r
                //\r
                // Call BaseName_build.xml clean\r
                //\r
                Element ifEle = document.createElement("if");\r
                Element availableEle = document.createElement("available");\r
                availableEle.setAttribute("file", "${DEST_DIR_OUTPUT}" + File.separatorChar + bName + "_build.xml");\r
                ifEle.appendChild(availableEle);\r
                Element elseEle = document.createElement("then");\r
                \r
                Element moduleEle = document.createElement("ant");\r
                moduleEle.setAttribute("antfile", "${DEST_DIR_OUTPUT}" + File.separatorChar + bName + "_build.xml");\r
                moduleEle.setAttribute("target", "clean");\r
                \r
                elseEle.appendChild(moduleEle);\r
                ifEle.appendChild(elseEle);\r
                ele.appendChild(ifEle);\r
                //\r
                // just delete\r
                //\r
                Element clean = document.createElement("delete");\r
                clean.setAttribute("dir", "${DEST_DIR_OUTPUT}");\r
                clean.setAttribute("excludes", "*.xml");\r
                ele.appendChild(clean);\r
                \r
                root.appendChild(ele);\r
            }\r
            //\r
            // Every Clean ALl target for each BaseName\r
            //\r
            set = map.keySet();\r
            iter = set.iterator();\r
            while (iter.hasNext()){\r
                String bName = (String)iter.next();\r
                File msaFile = (File)map.get(bName);\r
                String msaFilename = "${MODULE_DIR}" + File.separatorChar + msaFile.getName();\r
                String mbdFilename = msaFilename.substring(0 , msaFilename.length() - 4) + ".mbd";\r
                \r
                ele = document.createElement("target");\r
                ele.setAttribute("name", bName + "_cleanall");\r
                //\r
                // Output Dir\r
                //\r
                Element target = document.createElement("OutputDirSetup");\r
                target.setAttribute("msaFilename", msaFilename);\r
                target.setAttribute("mbdFilename", mbdFilename);\r
                target.setAttribute("baseName", bName);\r
                ele.appendChild(target);\r
                //\r
                // Call BaseName_build.xml clean\r
                //\r
                Element ifEle = document.createElement("if");\r
                Element availableEle = document.createElement("available");\r
                availableEle.setAttribute("file", "${DEST_DIR_OUTPUT}" + File.separatorChar + bName + "_build.xml");\r
                ifEle.appendChild(availableEle);\r
                Element elseEle = document.createElement("then");\r
                \r
                Element moduleEle = document.createElement("ant");\r
                moduleEle.setAttribute("antfile", "${DEST_DIR_OUTPUT}" + File.separatorChar + bName + "_build.xml");\r
                moduleEle.setAttribute("target", "cleanall");\r
                \r
                elseEle.appendChild(moduleEle);\r
                ifEle.appendChild(elseEle);\r
                ele.appendChild(ifEle);\r
                //\r
                // just delete\r
                //\r
                Element clean = document.createElement("delete");\r
                clean.setAttribute("dir", "${DEST_DIR_OUTPUT}");\r
                ele.appendChild(clean);\r
                \r
                clean = document.createElement("delete");\r
                clean.setAttribute("dir", "${DEST_DIR_DEBUG}");\r
                ele.appendChild(clean);\r
                \r
                clean = document.createElement("delete");\r
                Element fileset = document.createElement("fileset");\r
                fileset.setAttribute("dir", "${BIN_DIR}");\r
                fileset.setAttribute("includes", "**" + bName + "*");\r
                clean.appendChild(fileset);\r
                ele.appendChild(clean);\r
                \r
                root.appendChild(ele);\r
            }\r
            document.appendChild(root);\r
            //\r
            // Prepare the DOM document for writing\r
            //\r
            Source source = new DOMSource(document);\r
            //\r
            // Prepare the output file\r
            //\r
            String filename = buildFile.getParent() + File.separatorChar + "build.xml";\r
            File file = new File(getProject().replaceProperties(filename));\r
            //\r
            // generate all directory path\r
            //\r
            Result result = new StreamResult(file);\r
            //\r
            // Write the DOM document to the file\r
            //\r
            Transformer xformer = TransformerFactory.newInstance()\r
                            .newTransformer();\r
            xformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");\r
            xformer.setOutputProperty(OutputKeys.INDENT, "yes");\r
            xformer.transform(source, result);\r
        } catch (Exception ex) {\r
            System.out.println("##" + ex);\r
        }\r
    }\r
    \r
    \r
    public File getBuildFile() {\r
        return buildFile;\r
    }\r
\r
    public void setBuildFile(File buildFile) {\r
        this.buildFile = buildFile;\r
    }\r
\r
    public boolean isRecursive() {\r
        return recursive;\r
    }\r
\r
    public void setRecursive(boolean recursive) {\r
        this.recursive = recursive;\r
    }\r
}\r