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

   1 /** @file
   2  GenAcpiTable class.
   3
   4  GenAcpiTable is used to call GenAcpiTable.exe to generate ACPI Table image .
   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   GenAcpiTable class.
  32
  33   GenAcpiTable is used to call GenAcpiTable.exe to generate ACPI Table image .
  34 **/
  35 public class GenAcpiTableTask extends Task implements EfiDefine {
  36     // /
  37     // / input file
  38     // /
  39     private String inputFile = "";
  40
  41     // /
  42     // / output file
  43     // /
  44     private String outputFile = "";
  45
  46     // /
  47     // / output directory, this variable is added by jave wrap
  48     // /
  49     private String outputDir = "";
  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, "genacpitable");
  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 = "GenAcpiTable";
  76         } else {
  77             command = path + File.separatorChar + "GenAcpiTable";
  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             revl = runner.execute();
 111
 112             if (EFI_SUCCESS == revl) {
 113                 //
 114                 // command execution success
 115                 //
 116                 EdkLog.log(EdkLog.EDK_VERBOSE, "GenAcpiTable succeeded!");
 117             } else {
 118                 //
 119                 // command execution fail
 120                 //
 121                 EdkLog.log(EdkLog.EDK_INFO, "ERROR = " + Integer.toHexString(revl));
 122                 throw new BuildException("GenAcpiTable failed!");
 123             }
 124         } catch (Exception e) {
 125             throw new BuildException(e.getMessage());
 126         }
 127     }
 128
 129     /**
 130      * getInputFile
 131      *
 132      * This function is to get class member "inputFile".
 133      *
 134      * @return string of input file name.
 135      */
 136     public String getInputFile() {
 137         return inputFile;
 138     }
 139
 140     /**
 141      * setComponentType
 142      *
 143      * This function is to set class member "inputFile".
 144      *
 145      * @param inputFile
 146      *            string of input file name.
 147      */
 148     public void setInputFile(String inputFile) {
 149         this.inputFile = inputFile;
 150     }
 151
 152     /**
 153      * getOutputFile
 154      *
 155      * This function is to get class member "outputFile"
 156      *
 157      * @return outputFile string of output file name.
 158      */
 159     public String getOutputFile() {
 160         return outputFile;
 161     }
 162
 163     /**
 164      * setOutputFile
 165      *
 166      * This function is to set class member "outputFile"
 167      *
 168      * @param outputFile
 169      *            string of output file name.
 170      */
 171     public void setOutputFile(String outputFile) {
 172         this.outputFile = outputFile;
 173     }
 174
 175     /**
 176      * getOutputDir
 177      *
 178      * This function is to get class member "outputDir"
 179      *
 180      * @return outputDir string of output directory.
 181      */
 182     public String getOutputDir() {
 183         return outputDir;
 184     }
 185
 186     /**
 187      * setOutputDir
 188      *
 189      * This function is to set class member "outputDir"
 190      *
 191      * @param outputDir
 192      *            string of output directory.
 193      */
 194     public void setOutputDir(String outputDir) {
 195         this.outputDir = outputDir;
 196     }
 197 }