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
  29 import org.tianocore.common.logger.EdkLog;
  30
  31 /**
  32   SplitfileTask class.
  33
  34   SplitfileTask is used to call splitfile.exe to split input file to 2 output
  35   file.
  36 **/
  37 public class SplitfileTask extends Task implements EfiDefine {
  38     ///
  39     /// input file
  40     ///
  41     private String inputFile = "";
  42
  43     ///
  44     /// offset value
  45     ///
  46     private String offset = "";
  47
  48
  49     /**
  50      * execute
  51      *
  52      * SplitfleTask execute function is to assemble tool command line & execute
  53      * tool command line
  54      *
  55      * @throws BuidException
  56      */
  57     public void execute() throws BuildException {
  58
  59         Project project = this.getOwningTarget().getProject();
  60
  61         //
  62         // absolute path of efi tools
  63         //
  64         String path = project.getProperty("env.FRAMEWORK_TOOLS_PATH");
  65         String command;
  66         String argument;
  67         if (path == null) {
  68             command = "SplitFile";
  69         } else {
  70             command = path + File.separatorChar + "SplitFile";
  71         }
  72
  73         //
  74         // argument of tools
  75         //
  76         argument = inputFile + " " + offset;
  77
  78         //
  79         // return value of fwimage execution
  80         //
  81         int revl = -1;
  82
  83         try {
  84             Commandline cmdline = new Commandline();
  85             cmdline.setExecutable(command);
  86             cmdline.createArgument().setLine(argument);
  87
  88             LogStreamHandler streamHandler = new LogStreamHandler(this,
  89                     Project.MSG_INFO, Project.MSG_WARN);
  90             Execute runner = new Execute(streamHandler, null);
  91
  92             runner.setAntRun(project);
  93             runner.setCommandline(cmdline.getCommandline());
  94
  95             EdkLog.log(this, EdkLog.EDK_VERBOSE, Commandline.toString(cmdline.getCommandline()));
  96             EdkLog.log(this, EdkLog.EDK_INFO, (new File(this.inputFile)).getName());
  97             revl = runner.execute();
  98             if (EFI_SUCCESS == revl) {
  99                 //
 100                 // command execution success
 101                 //
 102                 EdkLog.log(this, EdkLog.EDK_VERBOSE, "SplitFile succeeded!");
 103             } else {
 104                 //
 105                 // command execution fail
 106                 //
 107                 EdkLog.log(this, EdkLog.EDK_INFO, "ERROR = " + Integer.toHexString(revl));
 108                 throw new BuildException("SplitFile failed!");
 109             }
 110         } catch (Exception e) {
 111             throw new BuildException(e.getMessage());
 112         }
 113     }
 114
 115     /**
 116      * getInputFile
 117      *
 118      * This function is to get class member "inputFile".
 119      *
 120      * @return string of input file name.
 121      */
 122     public String getInputFile() {
 123         return inputFile;
 124     }
 125
 126     /**
 127      * setComponentType
 128      *
 129      * This function is to set class member "inputFile".
 130      *
 131      * @param inputFile
 132      *            string of input file name.
 133      */
 134     public void setInputFile(String inputFile) {
 135         this.inputFile = inputFile;
 136     }
 137
 138     /**
 139       getOffset
 140
 141       This function is to get class member "offset"
 142
 143       @return offset value of string.
 144     **/
 145     public String getOffset() {
 146         return offset;
 147     }
 148
 149     /**
 150       setOffset
 151
 152       This function is to set class member "offset"
 153
 154       @param offset
 155                  string of offset value.
 156     **/
 157     public void setOffset(String offset) {
 158         this.offset = offset;
 159     }
 160
 161 }