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

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