--- /dev/null
+/** @file\r
+ GenCapsuleHdrTask class.\r
+\r
+ GenCapsuleHdrTask is used to call GenCapsuleHdr.exe to generate capsule.\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.Task;\r
+import org.apache.tools.ant.Project;\r
+import org.apache.tools.ant.BuildException;\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
+ GenCapsuleHdrTask class.\r
+\r
+ GenCapsuleHdrTask is used to call GenCapsuleHdr.exe to generate capsule.\r
+**/\r
+public class GenCapsuleHdrTask extends Task implements EfiDefine {\r
+ //\r
+ // tool name\r
+ //\r
+ private String toolName = "GenCapsuleHdr";\r
+\r
+ //\r
+ // script file\r
+ //\r
+ private FileArg scriptFile = new FileArg();\r
+\r
+ //\r
+ // output file\r
+ //\r
+ private FileArg outputFile = new FileArg();\r
+\r
+ //\r
+ // output directory, this variable is added by jave wrap\r
+ //\r
+ private String outputDir = ".";\r
+\r
+ //\r
+ // Verbose flag\r
+ //\r
+ private ToolArg verbose = new ToolArg();\r
+\r
+ //\r
+ // Dump flag\r
+ //\r
+ private ToolArg dump = new ToolArg();\r
+\r
+ //\r
+ // Split size\r
+ //\r
+ private ToolArg size = new ToolArg();\r
+\r
+ //\r
+ // capsule into one image flag\r
+ //\r
+ private ToolArg joinFlag = new ToolArg();\r
+\r
+ //\r
+ // capsule file\r
+ //\r
+ private FileArg capsuleFile = new FileArg();\r
+\r
+\r
+ /**\r
+ execute\r
+ \r
+ GenCapsuleHdrTask 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
+ String argument;\r
+ if (path == null) {\r
+ command = toolName;\r
+ } else {\r
+ command = path + File.separator + toolName;\r
+ }\r
+ //\r
+ // argument of tools\r
+ //\r
+ argument = "" + this.verbose + this.dump + this.outputFile\r
+ + this.scriptFile + this.size + this.joinFlag + this.capsuleFile;\r
+\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
+ runner.setWorkingDirectory(new File(outputDir));\r
+\r
+ //\r
+ // Set debug log information.\r
+ //\r
+ EdkLog.log(this, EdkLog.EDK_VERBOSE, Commandline.toString(cmdline.getCommandline()));\r
+ EdkLog.log(this, EdkLog.EDK_INFO, scriptFile.toFileList() + " => " +\r
+ outputFile.toFileList() + capsuleFile.toFileList());\r
+\r
+ revl = runner.execute();\r
+ if (EFI_SUCCESS == revl) {\r
+ //\r
+ // command execution success\r
+ //\r
+ EdkLog.log(this, EdkLog.EDK_VERBOSE, toolName + " succeeded!");\r
+ } else {\r
+ //\r
+ // command execution fail\r
+ //\r
+ EdkLog.log(this, EdkLog.EDK_ERROR, "ERROR = " + Integer.toHexString(revl));\r
+ throw new BuildException(toolName + " failed!");\r
+ }\r
+ } catch (Exception e) {\r
+ throw new BuildException(e.getMessage());\r
+ }\r
+ }\r
+\r
+ /**\r
+ getInputFile\r
+ \r
+ This function is to get class member "scriptFile".\r
+ \r
+ @return string of input file name.\r
+ **/\r
+ public String getScriptFile() {\r
+ return this.scriptFile.getValue();\r
+ }\r
+\r
+ /**\r
+ setComponentType\r
+ \r
+ This function is to set class member "inputFile".\r
+ \r
+ @param inputFile\r
+ string of input file name.\r
+ **/\r
+ public void setScriptFile(String scriptFile) {\r
+ this.scriptFile.setArg(" -script ", scriptFile);\r
+ }\r
+\r
+ /**\r
+ getOutputFile\r
+ \r
+ This function is to get class member "outputFile"\r
+ \r
+ @return outputFile string of output file name.\r
+ **/\r
+ public String getOutputFile() {\r
+ return outputFile.getValue();\r
+ }\r
+\r
+ /**\r
+ setOutputFile\r
+ \r
+ This function is to set class member "outputFile"\r
+ \r
+ @param outputFile\r
+ string of output file name.\r
+ **/\r
+ public void setOutputFile(String outputFile) {\r
+ this.outputFile.setArg(" -o ", outputFile);\r
+ }\r
+\r
+ /**\r
+ getOutputDir\r
+ \r
+ This function is to get class member "outputDir"\r
+ \r
+ @return outputDir string of output directory.\r
+ **/\r
+ public String getOutputDir() {\r
+ return outputDir;\r
+ }\r
+\r
+ /**\r
+ setOutputDir\r
+ \r
+ This function is to set class member "outputDir"\r
+ \r
+ @param outputDir\r
+ string of output directory.\r
+ **/\r
+ public void setOutputDir(String outputDir) {\r
+ this.outputDir = outputDir;\r
+ }\r
+\r
+ /**\r
+ getVerbose\r
+ \r
+ This function is to get class member "verbose"\r
+ \r
+ @return verbose the flag of verbose.\r
+ **/\r
+ public String getVerbose() {\r
+ return this.verbose.getValue();\r
+ }\r
+\r
+ /**\r
+ setVerbose\r
+ \r
+ This function is to set class member "verbose"\r
+ \r
+ @param verbose\r
+ True or False.\r
+ **/\r
+ public void setVerbose(boolean verbose) {\r
+ if (verbose) {\r
+ this.verbose.setArg(" -", "v");\r
+ }\r
+ }\r
+\r
+ /**\r
+ getDump\r
+ \r
+ This function is to get class member "dump"\r
+ \r
+ @return verbose the flag of dump.\r
+ **/\r
+ public String getDump() {\r
+ return dump.getValue();\r
+ }\r
+\r
+ /**\r
+ setDump\r
+ \r
+ This function is to set class member "dump".\r
+ \r
+ @param dump\r
+ True or False.\r
+ **/\r
+ public void setDump(boolean dump) {\r
+ if (dump) {\r
+ this.dump.setArg(" -", "dump");\r
+ }\r
+ }\r
+\r
+ /**\r
+ getSize\r
+ \r
+ This function is to set class member "size".\r
+ \r
+ @return size string of size value\r
+ **/\r
+ public String getSize() {\r
+ return size.getValue();\r
+ }\r
+\r
+ /**\r
+ setSize\r
+ \r
+ This function is to set class member "size".\r
+ \r
+ @param size string of size value.\r
+ **/\r
+ public void setSize(String size) {\r
+ this.size.setArg(" -split ", size);\r
+ }\r
+\r
+ /**\r
+ getCapsuleFile\r
+ \r
+ This function is to get class member "capsuleFile"\r
+ \r
+ @return capsuleFile capsule file name\r
+ **/\r
+ public String getCapsuleFile() {\r
+ return capsuleFile.getValue();\r
+ }\r
+\r
+ /**\r
+ setCapsuleFile\r
+ \r
+ This function is to set class member "capsuleFile"\r
+ \r
+ @param capsuleFile capsule file name\r
+ **/\r
+ public void setCapsuleFile(String capsuleFile) {\r
+ this.capsuleFile.setArg(" ", capsuleFile);\r
+ }\r
+\r
+ /**\r
+ isJoinFlag\r
+ \r
+ This function is to get class member "joinFlag"\r
+ \r
+ @return joinFlag flag of if need to join split capsule images into\r
+ a single image.\r
+ **/\r
+ public String getJoinFlag() {\r
+ return joinFlag.getValue();\r
+ }\r
+\r
+ /**\r
+ setJoinFlag\r
+ \r
+ This function is to set class member "joinFlag"\r
+ \r
+ @param joinFlag flag of if need to join split capsule images into\r
+ a single image.\r
+ **/\r
+ public void setJoinFlag(boolean joinFlag) {\r
+ if (joinFlag){\r
+ this.joinFlag.setArg(" -", "j");\r
+ }\r
+ }\r
+}\r
projects / mirror_edk2.git / blobdiff