- Fixed EDKT146; The override warning message has been reduced to almost none.

[mirror_edk2.git] / Tools / Source / FrameworkTasks / org / tianocore / framework / tasks / VfrCompilerTask.java

/** @file\r
This file is to define an ANT task which wraps VfrCompile.exe tool\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.framework.tasks;\r
\r
import java.io.File;\r
import java.io.IOException;\r
import java.util.ArrayList;\r
import java.util.List;\r
\r
import org.apache.tools.ant.BuildException;\r
import org.apache.tools.ant.Project;\r
import org.apache.tools.ant.Task;\r
import org.apache.tools.ant.taskdefs.Execute;\r
import org.apache.tools.ant.taskdefs.LogStreamHandler;\r
import org.apache.tools.ant.types.Commandline;\r
\r
/**\r
 VfrcompilerTask Task Class\r
  class member \r
      -createListFile  : create an output IFR listing file.\r
      -outPutDir       : deposit all output files to directory OutputDir (default=cwd)\r
      -createIfrBinFile: create an IFR HII pack file\r
      -vfrFile         : name of the input VFR script file\r
      -processArg      : c processer argument\r
      -includepathList : add IncPath to the search path for VFR included files\r
 **/\r
public class VfrCompilerTask extends Task implements EfiDefine {\r
    private String createListFile = "";\r
    private String outPutDir = "";\r
    private File outPutFile;\r
    private String createIfrBinFile = "";\r
    private String processerArg ="";\r
    private String vfrFile = "";\r
    private String vfrFileName = "";\r
\r
    private List<Object> includepathList = new ArrayList<Object>();\r
\r
    /**\r
     get class member of createList file\r
\r
     @returns file name of createList\r
     **/\r
    public String getCreateListFile() {\r
        return createListFile;\r
    }\r
\r
    /**\r
     set class member of createList file\r
\r
     @param     createListFile  if createList string equal "on" set '-l' flag\r
     **/\r
    public void setCreateListFile(String createListFile) {\r
        if (createListFile.equals("ON")||createListFile.equals("on"))\r
            this.createListFile = " -l";\r
    }\r
\r
    /**\r
     get output dir \r
\r
     @returns name of output dir\r
     **/\r
    public String getOutPutDir() {\r
        return outPutDir;\r
    }\r
\r
    /**\r
     set class member of outPutDir\r
\r
     @param     outPutDir   The directory name for ouput file\r
     **/\r
    public void setOutPutDir(String outPutDir) {\r
        if (outPutDir != null) {\r
            outPutFile = new File(outPutDir);\r
        }\r
        this.outPutDir = " -od " + outPutDir;\r
    }\r
\r
\r
    /**\r
     get class member of ifrBinFile\r
\r
     @return file name of ifrBinFile\r
     **/\r
    public String getCreateIfrBinFile() {\r
        return createIfrBinFile;\r
    }\r
\r
    /**\r
     set class member of ifrBinFile \r
\r
     @param     createIfrBinFile    The flag to specify if the IFR binary file should\r
                                    be generated or not\r
     */\r
    public void setCreateIfrBinFile(String createIfrBinFile) {\r
        if (createIfrBinFile.equals("ON") || createIfrBinFile.equals("on"));\r
        this.createIfrBinFile = " -ibin";\r
    }\r
\r
    /**\r
     get class member of vfrFile\r
\r
     @returns name of vfrFile\r
     **/\r
    public String getVfrFile() {\r
        return vfrFile;\r
    }\r
\r
    /**\r
     set class member of vfrFile \r
\r
     @param     vfrFile The name of VFR file\r
     **/\r
    public void setVfrFile(String vfrFile) {\r
        this.vfrFileName = (new File(vfrFile)).getName();\r
        this.vfrFile = " " + vfrFile;\r
    }\r
\r
    /**\r
     add includePath in includepath List \r
\r
     @param     includepath The IncludePath object which represents include path\r
     **/\r
    public void addIncludepath(IncludePath includepath){\r
        includepathList.add(includepath);\r
    }\r
\r
\r
    /**\r
     get class member of processerArg\r
\r
     @returns processer argument\r
     **/\r
    public String getProcesserArg() {\r
        return processerArg;\r
    }\r
\r
\r
    /**\r
     set class member of processerArg\r
\r
     @param     processerArg    The processor argument\r
     */\r
    public void setProcesserArg(String processerArg) {\r
        this.processerArg = " -ppflag " + processerArg;\r
    }\r
\r
    /**\r
     The standard execute method of ANT task.\r
     **/\r
    public void execute() throws BuildException {\r
        Project project = this.getProject();\r
        String  toolPath= project.getProperty("env.FRAMEWORK_TOOLS_PATH");\r
        String  command;\r
        if (toolPath == null) {\r
            command = "VfrCompile";\r
        } else {\r
            command = toolPath + "/" + "VfrCompile";\r
        }\r
        List<Object> includePath = new ArrayList<Object>();     \r
        String incPath = "";        \r
\r
        int  count = includepathList.size();    \r
        IncludePath path;\r
        for (int i = 0; i < count; i++) {\r
            path = (IncludePath) includepathList.get(i);\r
            if (path.getFile() != null) {\r
                FileParser.loadFile( project,includePath,path.getFile(), "-I");             \r
            }\r
        }\r
        for (int i = 0; i < count; i++) {\r
            incPath = incPath + " " + includepathList.get(i);\r
        }\r
        count =  includePath.size();\r
        for (int i = 0; i < count; i++) {\r
            incPath = incPath + " " + includePath.get(i);\r
        }\r
        String argument = this.createIfrBinFile +\r
                          this.processerArg + \r
                          incPath +\r
                          this.outPutDir + \r
                          this.createListFile +\r
                          this.vfrFile ;\r
        try {\r
            ///\r
            /// constructs the command-line\r
            ///\r
            Commandline commandLine = new Commandline();\r
            commandLine.setExecutable(command);\r
            commandLine.createArgument().setLine(argument);\r
\r
            ///\r
            /// configures the Execute object\r
            ///\r
            LogStreamHandler streamHandler = new LogStreamHandler(this,\r
                                                                  Project.MSG_INFO,\r
                                                                  Project.MSG_WARN);\r
\r
            Execute runner = new Execute(streamHandler,null);\r
            runner.setAntRun(project);\r
            \r
            runner.setCommandline(commandLine.getCommandline());\r
            \r
            if (outPutFile != null && outPutFile.exists()) {\r
                runner.setWorkingDirectory(outPutFile); \r
            }\r
\r
            log(Commandline.toString(commandLine.getCommandline()), Project.MSG_VERBOSE);\r
            log(vfrFileName);\r
            int returnVal = runner.execute();\r
            if (EFI_SUCCESS == returnVal) {\r
                log("VfrCompile succeeded!", Project.MSG_VERBOSE);\r
            } else {\r
                log("ERROR = " + Integer.toHexString(returnVal));\r
                throw new BuildException("VfrCompile failed!");\r
            }\r
        } catch (IOException e) {\r
            throw new BuildException(e.getMessage());\r
        }\r
    }\r
}\r