Fix capitalization

[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
import java.io.File;\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
  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
    /// The name of input inf file\r
    ///\r
    private String infFile="";\r
    ///\r
    /// The target architecture.\r
    ///\r
    private String arch="";\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
        String command = "";\r
        \r
        if (path == null){\r
            path = "";\r
        }else {\r
            path = path + File.separatorChar;\r
        }\r
        \r
        if (arch.equalsIgnoreCase("")){\r
            command = path + "GenFvImage";\r
        }\r
        if (arch.equalsIgnoreCase("ia32")){\r
            command = path + "GenFvImage_IA32";\r
        }   \r
        if (arch.equalsIgnoreCase("x64")){\r
            command = path + "GenFvImage_X64";\r
        }\r
        if (arch.equalsIgnoreCase("ipf")){\r
            command = path + "GenFvImage_IPF";\r
        }\r
        String argument = infFile;\r
        \r
        try {\r
            \r
            Commandline commandLine = new Commandline();\r
            commandLine.setExecutable(command);\r
            commandLine.createArgument().setLine(argument);\r
            \r
            LogStreamHandler streamHandler = new LogStreamHandler(this,\r
                                                   Project.MSG_INFO,\r
                                                   Project.MSG_WARN);\r
            //\r
            // create a execute object and set it's commandline\r
            //\r
            Execute runner = new Execute(streamHandler,null);\r
            runner.setAntRun(project);\r
            runner.setCommandline(commandLine.getCommandline());            \r
            System.out.println(Commandline.toString(commandLine.getCommandline()));\r
            \r
            int revl = -1;\r
            //\r
            //  user execute class call external programs - GenFvImage\r
            //\r
            revl = runner.execute();\r
            // \r
            // execute command line success!\r
            //\r
            if (EFI_SUCCESS == revl){\r
                System.out.println("GenFvImage succeeded!");\r
            } else {\r
                \r
            // \r
            // execute command line failed! \r
            //\r
                throw new BuildException("GenFvImage failed !(error =" + \r
                    Integer.toHexString(revl) + ")");\r
            }\r
            \r
        } catch (Exception e) {\r
            System.out.println(e.getMessage());\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;\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 = "-I " + infFile;\r
    }\r
    \r
    /**\r
      getArch\r
      \r
      This function is to get class member of arch.\r
      @return           The target architecture.\r
    **/\r
    public String getArch() {\r
        return arch;\r
    }\r
    \r
    /**\r
      setArch\r
      \r
      This function is to set class member of arch. \r
      \r
      @param arch       The target architecture.\r
    **/\r
    public void setArch(String arch) {\r
        this.arch = arch;\r
    }   \r
}