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

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