Tools/Java/Source/FrameworkTasks/org/tianocore/framework/tasks/EfiCompressTask.java

   1 /** @file
   2  EfiCompressTask class.
   3
   4  EfiCompressTask is used to call EfiCompress.exe to strip input 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   EfiCompressTask class.
  32
  33   EfiCompressTask is used to call EfiCompress.exe to strip input file.
  34 **/
  35 public class EfiCompressTask extends Task implements EfiDefine {
  36     //
  37     //
  38     //
  39     private final static String toolName = "EfiCompress";
  40     //
  41     // input file
  42     //
  43     private FileArg inputFile = new FileArg();
  44
  45     //
  46     // output file
  47     //
  48     private FileArg outputFile = new FileArg();
  49
  50     //
  51     // output directory, this variable is added by jave wrap
  52     //
  53     private String outputDir = ".";
  54
  55     /**
  56       execute
  57
  58       EfiCompressTask 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.separator + toolName;
  77         }
  78         //
  79         // argument of tools
  80         //
  81         argument = "" + inputFile + outputFile;
  82         //
  83         // return value of fwimage execution
  84         //
  85         int revl = -1;
  86
  87         try {
  88             Commandline cmdline = new Commandline();
  89             cmdline.setExecutable(command);
  90             cmdline.createArgument().setLine(argument);
  91
  92             LogStreamHandler streamHandler = new LogStreamHandler(this,
  93                     Project.MSG_INFO, Project.MSG_WARN);
  94             Execute runner = new Execute(streamHandler, null);
  95
  96             runner.setAntRun(project);
  97             runner.setCommandline(cmdline.getCommandline());
  98             runner.setWorkingDirectory(new File(outputDir));
  99
 100             //
 101             // Set debug log information.
 102             //
 103             EdkLog.log(this, EdkLog.EDK_VERBOSE, Commandline.toString(cmdline.getCommandline()));
 104             EdkLog.log(this, EdkLog.EDK_INFO, this.inputFile.toFileList() + " => "
 105                                               + this.outputFile.toFileList());
 106
 107             revl = runner.execute();
 108             if (EFI_SUCCESS == revl) {
 109                 //
 110                 // command execution success
 111                 //
 112                 EdkLog.log(this, EdkLog.EDK_VERBOSE, toolName + " succeeded!");
 113             } else {
 114                 //
 115                 // command execution fail
 116                 //
 117                 EdkLog.log(this, EdkLog.EDK_ERROR, "ERROR = " + Integer.toHexString(revl));
 118                 throw new BuildException(toolName + " failed!");
 119
 120             }
 121         } catch (Exception e) {
 122             throw new BuildException(e.getMessage());
 123         }
 124     }
 125
 126     /**
 127       getInputFile
 128
 129       This function is to get class member "inputFile".
 130
 131       @return string of input file name.
 132      **/
 133     public String getInputFile() {
 134         return inputFile.getValue();
 135     }
 136
 137     /**
 138       setComponentType
 139
 140       This function is to set class member "inputFile".
 141
 142       @param inputFile
 143                  string of input file name.
 144      **/
 145     public void setInputFile(String inputFile) {
 146         this.inputFile.setArg(" ", inputFile);
 147     }
 148
 149     /**
 150       getOutputFile
 151
 152       This function is to get class member "outputFile"
 153
 154       @return outputFile string of output file name.
 155      **/
 156     public String getOutputFile() {
 157         return outputFile.getValue();
 158     }
 159
 160     /**
 161       setOutputFile
 162
 163       This function is to set class member "outputFile"
 164
 165       @param outputFile
 166                  string of output file name.
 167      **/
 168     public void setOutputFile(String outputFile) {
 169         this.outputFile.setArg(" ", outputFile);
 170     }
 171
 172     /**
 173       getOutputDir
 174
 175       This function is to get class member "outputDir"
 176
 177       @return outputDir string of output directory.
 178      **/
 179     public String getOutputDir() {
 180         return outputDir;
 181     }
 182
 183     /**
 184       setOutputDir
 185
 186       This function is to set class member "outputDir"
 187
 188       @param outputDir
 189                  string of output directory.
 190      **/
 191     public void setOutputDir(String outputDir) {
 192         this.outputDir = outputDir;
 193     }
 194 }