]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Tools/Java/Source/FrameworkTasks/org/tianocore/framework/tasks/FwImageTask.java
Restructuring for better separation of Tool packages.
[mirror_edk2.git] / Tools / Java / Source / FrameworkTasks / org / tianocore / framework / tasks / FwImageTask.java
diff --git a/Tools/Java/Source/FrameworkTasks/org/tianocore/framework/tasks/FwImageTask.java b/Tools/Java/Source/FrameworkTasks/org/tianocore/framework/tasks/FwImageTask.java
new file mode 100644 (file)
index 0000000..78d9cbe
--- /dev/null
@@ -0,0 +1,198 @@
+/** @file\r
+ FwImageTask class.\r
+\r
+ FwImageTask is used to call FwImage.ext to generate the FwImage.\r
+\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
+\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 org.tianocore.common.logger.EdkLog;\r
+\r
+/**\r
+  FwImageTask class.\r
+\r
+  FwImageTask is used to call FwImage.ext to generate the FwImage.\r
+**/\r
+public class FwImageTask extends Task implements EfiDefine {\r
+    //\r
+    // fwimage tool name\r
+    // \r
+    private static String toolName = "FwImage";\r
+    //\r
+    // time&data\r
+    //\r
+    private ToolArg time = new ToolArg();\r
+    //\r
+    // input PE image\r
+    //\r
+    private FileArg peImage = new FileArg();\r
+    //\r
+    // output EFI image\r
+    //\r
+    private FileArg outImage = new FileArg();\r
+    //\r
+    // component type\r
+    //\r
+    private ToolArg componentType = new ToolArg();\r
+\r
+    /**\r
+      execute\r
+\r
+      FwimageTask execute function is to assemble tool command line & execute\r
+      tool command line\r
+\r
+      @throws BuidException\r
+    **/\r
+    public void execute() throws BuildException {\r
+\r
+        Project project = this.getOwningTarget().getProject();\r
+        //\r
+        // absolute path of efi tools\r
+        //\r
+        String path = project.getProperty("env.FRAMEWORK_TOOLS_PATH");\r
+        String command;\r
+        if (path == null) {\r
+            command = toolName;\r
+        } else {\r
+            command = path + File.separator + toolName;\r
+        }\r
+        //\r
+        // argument of tools\r
+        //\r
+        String argument = "" + time + componentType + peImage + outImage;\r
+        //\r
+        // return value of fwimage execution\r
+        //\r
+        int revl = -1;\r
+\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
+\r
+            EdkLog.log(this, EdkLog.EDK_VERBOSE, Commandline.toString(cmdline.getCommandline()));\r
+            EdkLog.log(this, peImage.toFileList() + " => " + outImage.toFileList());\r
+\r
+            revl = runner.execute();\r
+            if (EFI_SUCCESS == revl) {\r
+                EdkLog.log(this, EdkLog.EDK_VERBOSE, "FwImage succeeded!");\r
+            } else {\r
+                //\r
+                // command execution fail\r
+                //\r
+                EdkLog.log(this, "ERROR = " + Integer.toHexString(revl));\r
+                throw new BuildException("FwImage failed!");\r
+            }\r
+        } catch (Exception e) {\r
+            throw new BuildException(e.getMessage());\r
+        }\r
+    }\r
+\r
+    /**\r
+      setTime\r
+\r
+      This function is to set operation of class member "time".\r
+\r
+      @param time            string of time\r
+    **/\r
+    public void setTime(String time) {\r
+        this.time.setArg(" -t ", time);\r
+    }\r
+\r
+    /**\r
+      getTime\r
+\r
+      This function is to get class member "time"\r
+      @return time          string of time\r
+    **/\r
+    public String getTime() {\r
+        return this.time.getValue();\r
+    }\r
+\r
+    /**\r
+      getPeImage\r
+\r
+      This function is to get class member "peImage".\r
+      @return                name of PE image\r
+    **/\r
+    public String getPeImage() {\r
+        return this.peImage.getValue();\r
+    }\r
+\r
+    /**\r
+      setPeImage\r
+\r
+      This function is to set class member "peImage"\r
+      @param  peImage        name of PE image\r
+    **/\r
+    public void setPeImage(String peImage) {\r
+        this.peImage.setArg(" ", peImage);\r
+    }\r
+\r
+    /**\r
+      getOutImage\r
+\r
+      This function is to get class member "outImage".\r
+      @return                 name of output EFI image\r
+    **/\r
+    public String getOutImage() {\r
+        return this.outImage.getValue();\r
+    }\r
+\r
+    /**\r
+      setOutImage\r
+\r
+      This function is to set class member "outImage".\r
+      @param outImage         name of output EFI image\r
+    **/\r
+    public void setOutImage(String outImage) {\r
+        this.outImage.setArg(" ", outImage);\r
+    }\r
+\r
+    /**\r
+      getComponentType\r
+\r
+      This function is to get class member "componentType".\r
+\r
+      @return                 string of componentType\r
+    **/\r
+    public String getComponentType() {\r
+        return this.componentType.getValue();\r
+    }\r
+\r
+    /**\r
+      setComponentType\r
+\r
+      This function is to set class member "componentType".\r
+      @param  componentType   string of component type\r
+    **/\r
+    public void setComponentType(String componentType) {\r
+        this.componentType.setArg(" ", componentType);\r
+    }\r
+}\r