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

   1 /** @file
   2  SplitfileTask class.
   3
   4  SplitfileTask is used to call splitfile.exe to split input file to 2 output
   5  file.
   6
   7
   8  Copyright (c) 2006, Intel Corporation
   9  All rights reserved. This program and the accompanying materials
  10  are licensed and made available under the terms and conditions of the BSD License
  11  which accompanies this distribution.  The full text of the license may be found at
  12  http://opensource.org/licenses/bsd-license.php
  13
  14  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  15  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  16
  17  **/
  18 package org.tianocore.framework.tasks;
  19
  20 import java.io.File;
  21
  22 import org.apache.tools.ant.Task;
  23 import org.apache.tools.ant.Project;
  24 import org.apache.tools.ant.BuildException;
  25 import org.apache.tools.ant.taskdefs.Execute;
  26 import org.apache.tools.ant.taskdefs.LogStreamHandler;
  27 import org.apache.tools.ant.types.Commandline;
  28 import org.tianocore.logger.EdkLog;
  29
  30 /**
  31   SplitfileTask class.
  32
  33   SplitfileTask is used to call splitfile.exe to split input file to 2 output
  34   file.
  35 **/
  36 public class SplitfileTask extends Task implements EfiDefine {
  37     ///
  38     /// input file
  39     ///
  40     private String inputFile = "";
  41
  42     ///
  43     /// offset value
  44     ///
  45     private String offset = "";
  46
  47
  48     /**
  49      * execute
  50      *
  51      * SplitfleTask execute function is to assemble tool command line & execute
  52      * tool command line
  53      *
  54      * @throws BuidException
  55      */
  56     public void execute() throws BuildException {
  57
  58         Project project = this.getOwningTarget().getProject();
  59
  60         //
  61         // set Logger
  62         //
  63         FrameworkLogger logger = new FrameworkLogger(project, "splitfile");
  64         EdkLog.setLogLevel(project.getProperty("env.LOGLEVEL"));
  65         EdkLog.setLogger(logger);
  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 = "SplitFile";
  75         } else {
  76             command = path + File.separatorChar + "SplitFile";
  77         }
  78
  79         //
  80         // argument of tools
  81         //
  82         argument = inputFile + " " + offset;
  83
  84         //
  85         // return value of fwimage execution
  86         //
  87         int revl = -1;
  88
  89         try {
  90             Commandline cmdline = new Commandline();
  91             cmdline.setExecutable(command);
  92             cmdline.createArgument().setLine(argument);
  93
  94             LogStreamHandler streamHandler = new LogStreamHandler(this,
  95                     Project.MSG_INFO, Project.MSG_WARN);
  96             Execute runner = new Execute(streamHandler, null);
  97
  98             runner.setAntRun(project);
  99             runner.setCommandline(cmdline.getCommandline());
 100
 101             EdkLog.log(EdkLog.EDK_INFO, Commandline.toString(cmdline.getCommandline()));
 102             revl = runner.execute();
 103             if (EFI_SUCCESS == revl) {
 104                 //
 105                 // command execution success
 106                 //
 107                 EdkLog.log(EdkLog.EDK_INFO, "splitfile succeeded!");
 108             } else {
 109                 //
 110                 // command execution fail
 111                 //
 112                 EdkLog.log(EdkLog.EDK_ERROR, "splitfile failed. (error="
 113                         + Integer.toHexString(revl) + ")");
 114                 throw new BuildException("splitfile failed. (error="
 115                         + Integer.toHexString(revl) + ")");
 116
 117             }
 118         } catch (Exception e) {
 119             throw new BuildException(e.getMessage());
 120         }
 121     }
 122
 123     /**
 124      * getInputFile
 125      *
 126      * This function is to get class member "inputFile".
 127      *
 128      * @return string of input file name.
 129      */
 130     public String getInputFile() {
 131         return inputFile;
 132     }
 133
 134     /**
 135      * setComponentType
 136      *
 137      * This function is to set class member "inputFile".
 138      *
 139      * @param inputFile
 140      *            string of input file name.
 141      */
 142     public void setInputFile(String inputFile) {
 143         this.inputFile = inputFile;
 144     }
 145
 146     /**
 147       getOffset
 148
 149       This function is to get class member "offset"
 150
 151       @return offset value of string.
 152     **/
 153     public String getOffset() {
 154         return offset;
 155     }
 156
 157     /**
 158       setOffset
 159
 160       This function is to set class member "offset"
 161
 162       @param offset
 163                  string of offset value.
 164     **/
 165     public void setOffset(String offset) {
 166         this.offset = offset;
 167     }
 168
 169 }