1) Changed ToolArg class to abstract generic arguments of a tool

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

/** @file\r
 GenFvImageTask class.\r
\r
 GenFvImageTask is to call GenFvImage.exe to generate FvImage.\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 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
import java.io.File;\r
import java.io.InputStreamReader;\r
import java.lang.ProcessBuilder;\r
import java.util.LinkedList;\r
\r
import org.tianocore.common.logger.EdkLog;\r
\r
/**\r
  GenFvImageTask\r
  \r
  GenFvImageTask is to call GenFvImage.exe to generate the FvImage.\r
  \r
**/\r
public class GenFvImageTask extends Task implements EfiDefine{\r
    //\r
    // tool name\r
    //\r
    static final private String toolName = "GenFvImage";\r
    //\r
    // The name of input inf file\r
    //\r
    private FileArg infFile = new FileArg();\r
    //\r
    // Output directory\r
    //\r
    private String outputDir = ".";\r
\r
    /**\r
      execute\r
      \r
      GenFvImageTask execute is to assemble tool command line & execute tool\r
      command line.\r
    **/\r
    public void execute() throws BuildException  {\r
        Project project = this.getOwningTarget().getProject();\r
        String path = project.getProperty("env.FRAMEWORK_TOOLS_PATH");\r
\r
        String command;\r
        if (path == null) {\r
            command = toolName;\r
        } else {\r
            command = path + File.separator + toolName;\r
        }\r
\r
        String argument = "" + infFile;\r
        //\r
        // lauch the program\r
        //\r
        int exitCode = 0;\r
        try {\r
            Commandline cmdline = new Commandline();\r
            cmdline.setExecutable(command);\r
            cmdline.createArgument().setLine(argument);\r
\r
            LogStreamHandler streamHandler = new LogStreamHandler(this,\r
                    Project.MSG_INFO, Project.MSG_WARN);\r
            Execute runner = new Execute(streamHandler, null);\r
\r
            runner.setAntRun(project);\r
            runner.setCommandline(cmdline.getCommandline());\r
            runner.setWorkingDirectory(new File(outputDir)); \r
            //\r
            // log command line string.\r
            //\r
            EdkLog.log(this, EdkLog.EDK_VERBOSE, Commandline.toString(cmdline.getCommandline()));\r
            EdkLog.log(this, infFile.toFileList());\r
\r
            exitCode = runner.execute();\r
            if (exitCode != 0) {\r
                EdkLog.log(this, "ERROR = " + Integer.toHexString(exitCode));\r
            } else {\r
                EdkLog.log(this, EdkLog.EDK_VERBOSE, "GenFvImage succeeded!");\r
            }\r
        } catch (Exception e) {\r
            throw new BuildException(e.getMessage());\r
        } finally {\r
            if (exitCode != 0) {\r
                throw new BuildException("GenFvImage: failed to generate FV file!");\r
            }\r
        }\r
    }\r
    /**\r
      getInfFile\r
      \r
      This function is to get class member of infFile\r
      @return String    name of infFile\r
    **/\r
    public String getInfFile() {\r
        return infFile.getValue();\r
    }\r
    \r
    /**\r
      setInfFile\r
      \r
      This function is to set class member of infFile.\r
      \r
      @param infFile  name of infFile\r
    **/\r
    public void setInfFile(String infFile) {\r
        this.infFile.setArg(" -I ", infFile);\r
    }\r
    \r
    /**\r
      getOutputDir\r
      \r
      This function is to get output directory.\r
      \r
      @return                Path of output directory.\r
    **/\r
    public String getOutputDir() {\r
        return outputDir;\r
    }\r
\r
    /**\r
      setOutputDir\r
      \r
      This function is to set output directory.\r
      \r
      @param outputDir        The output direcotry.\r
    **/\r
    public void setOutputDir(String outputDir) {\r
        this.outputDir = outputDir;\r
    }\r
}\r