Tools/Source/FrameworkTasks/org/tianocore/framework/tasks/CreateMtFileTask.java

   1 /** @file
   2  CreateMtFileTask class.
   3
   4  CreateMtFileTask is used to call CreateMtFile.exe to create MT file.
   5
   6
   7  Copyright (c) 2006, Intel Corporation
   8  All rights reserved. This program and the accompanying materials
   9  are licensed and made available under the terms and conditions of the BSD License
  10  which accompanies this distribution.  The full text of the license may be found at
  11  http://opensource.org/licenses/bsd-license.php
  12
  13  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16  **/
  17 package org.tianocore.framework.tasks;
  18
  19 import java.io.File;
  20
  21 import org.apache.tools.ant.Task;
  22 import org.apache.tools.ant.Project;
  23 import org.apache.tools.ant.BuildException;
  24 import org.apache.tools.ant.taskdefs.Execute;
  25 import org.apache.tools.ant.taskdefs.LogStreamHandler;
  26 import org.apache.tools.ant.types.Commandline;
  27
  28 import org.tianocore.common.logger.EdkLog;
  29
  30 /**
  31   CreateMtFileTask class.
  32
  33   CreateMtFileTask is used to call CreateMtFile.exe to create MT file.
  34 **/
  35 public class CreateMtFileTask extends Task implements EfiDefine {
  36     ///
  37     /// Tool name
  38     ///
  39     private String toolName="CreateMtFile";
  40     ///
  41     /// file size
  42     ///
  43     private String fileSize = "";
  44
  45     ///
  46     /// output file
  47     ///
  48     private String outputFile = "";
  49
  50     ///
  51     /// output directory, this variable is added by jave wrap
  52     ///
  53     private String outputDir = "";
  54
  55     /**
  56      * execute
  57      *
  58      * StripTask execute function is to assemble tool command line & execute
  59      * tool command line
  60      *
  61      * @throws BuidException
  62      */
  63     public void execute() throws BuildException {
  64
  65         Project project = this.getOwningTarget().getProject();
  66
  67         //
  68         // absolute path of efi tools
  69         //
  70         String path = project.getProperty("env.FRAMEWORK_TOOLS_PATH");
  71         String command;
  72         String argument;
  73         if (path == null) {
  74             command = toolName;
  75         } else {
  76             command = path + File.separatorChar + toolName;
  77         }
  78         //
  79         // argument of tools
  80         //
  81         File file = new File(outputFile);
  82         if (!file.isAbsolute() && (!this.outputDir.equalsIgnoreCase(""))) {
  83             argument = outputDir + File.separatorChar +  outputFile + " " + this.fileSize;
  84
  85         } else {
  86             argument = outputFile  + " " + this.fileSize;
  87         }
  88         //
  89         // return value of fwimage execution
  90         //
  91         int revl = -1;
  92
  93         try {
  94             Commandline cmdline = new Commandline();
  95             cmdline.setExecutable(command);
  96             cmdline.createArgument().setLine(argument);
  97
  98             LogStreamHandler streamHandler = new LogStreamHandler(this,
  99                     Project.MSG_INFO, Project.MSG_WARN);
 100             Execute runner = new Execute(streamHandler, null);
 101
 102             runner.setAntRun(project);
 103             runner.setCommandline(cmdline.getCommandline());
 104             //
 105             // Set debug log information.
 106             //
 107             EdkLog.log(this, EdkLog.EDK_VERBOSE, Commandline.toString(cmdline.getCommandline()));
 108             EdkLog.log(this, EdkLog.EDK_INFO, (new File(this.outputFile)).getName());
 109             revl = runner.execute();
 110
 111             if (EFI_SUCCESS == revl) {
 112                 //
 113                 // command execution success
 114                 //
 115                 EdkLog.log(this, EdkLog.EDK_VERBOSE, "CreateMtFile succeeded!");
 116             } else {
 117                 //
 118                 // command execution fail
 119                 //
 120                 EdkLog.log(this, EdkLog.EDK_INFO, "ERROR = " + Integer.toHexString(revl));
 121                 throw new BuildException("CreateMtFile failed!");
 122             }
 123         } catch (Exception e) {
 124             throw new BuildException(e.getMessage());
 125         }
 126     }
 127
 128     /**
 129      * getFileSize
 130      *
 131      * This function is to get class member "fileSize".
 132      *
 133      * @return fileSize       string of file size.
 134      */
 135     public String getFileSize() {
 136         return this.fileSize;
 137     }
 138
 139     /**
 140      * setFileSize
 141      *
 142      * This function is to set class member "fileSize".
 143      *
 144      * @param fileSize
 145      *            string of file size value.
 146      */
 147     public void setFileSize(String fileSize) {
 148         this.fileSize = fileSize;
 149     }
 150
 151     /**
 152      * getOutputFile
 153      *
 154      * This function is to get class member "outputFile"
 155      *
 156      * @return outputFile string of output file name.
 157      */
 158     public String getOutputFile() {
 159         return outputFile;
 160     }
 161
 162     /**
 163      * setOutputFile
 164      *
 165      * This function is to set class member "outputFile"
 166      *
 167      * @param outputFile
 168      *            string of output file name.
 169      */
 170     public void setOutputFile(String outputFile) {
 171         this.outputFile = outputFile;
 172     }
 173
 174     /**
 175      * getOutputDir
 176      *
 177      * This function is to get class member "outputDir"
 178      *
 179      * @return outputDir string of output directory.
 180      */
 181     public String getOutputDir() {
 182         return outputDir;
 183     }
 184
 185     /**
 186      * setOutputDir
 187      *
 188      * This function is to set class member "outputDir"
 189      *
 190      * @param outputDir
 191      *            string of output directory.
 192      */
 193     public void setOutputDir(String outputDir) {
 194         this.outputDir = outputDir;
 195     }
 196 }