Modify code according suggestion from code review meeting.

[mirror_edk2.git] / Tools / Source / FrameworkTasks / org / tianocore / framework / tasks / Tool.java

/** @file\r
This file is to define nested element which is meant for specifying a tool\r
\r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
package org.tianocore.framework.tasks;\r
\r
import java.io.DataInputStream;\r
import java.io.DataOutputStream;\r
import java.io.File;\r
import java.io.FileInputStream;\r
import java.util.ArrayList;\r
import java.util.Iterator;\r
import java.util.List;\r
\r
import org.apache.tools.ant.BuildException;\r
\r
/**\r
 Class Tool is to define an external tool to be used for genffsfile\r
 **/\r
public class Tool implements EfiDefine, Section {\r
\r
    String toolName     = "";\r
    List<Object>   toolArgList  = new ArrayList<Object>();\r
    String outputPath;\r
    String outPutFileName ;\r
    List<Input>    inputFiles = new ArrayList<Input>();\r
\r
    /**\r
     Call extern tool\r
\r
     @param     buffer  The buffer to put the result with alignment\r
     **/\r
    public void toBuffer (DataOutputStream buffer){\r
        File           OutputFile;\r
        byte           data;\r
\r
        ///\r
        /// call extern tool\r
        ///\r
        try {\r
            executeTool ();\r
        } catch (Exception e) {\r
            throw new BuildException("Call to executeTool failed!\n");\r
        }\r
\r
        ///\r
        /// check if file exist\r
        ///\r
        OutputFile = new File (this.outPutFileName);\r
        long fileLen = OutputFile.length();\r
        if (!OutputFile.exists()) {\r
            throw new BuildException("The file " + outPutFileName + " does not exist!\n");\r
        }\r
\r
        ///\r
        /// Read output file and write it's cotains to buffer\r
        ///\r
        try {\r
            FileInputStream fs  = new FileInputStream (this.outPutFileName);\r
            DataInputStream In  = new DataInputStream (fs);\r
\r
            int i = 0;\r
            while (i < fileLen) {\r
                data = In.readByte();\r
                buffer.writeByte(data);\r
                i ++;\r
            }\r
\r
            ///\r
            /// 4 byte alignment\r
            ///\r
            while ((fileLen & 0x03) != 0) {\r
                fileLen++;\r
                buffer.writeByte(0);\r
            }\r
            In.close();\r
\r
        } catch (Exception e) {\r
            System.out.print(e.getMessage());\r
            throw new BuildException("Tool call, toBuffer failed!\n");\r
        }\r
    }\r
\r
    ///\r
    /// execute external tool for genffsfile\r
    ///\r
    private void executeTool () {\r
        String command   = "";\r
        String argument  = "";\r
        command          = toolName;\r
        Iterator argIter = toolArgList.iterator();\r
        Iterator inputIter = inputFiles.iterator();\r
        ToolArg toolArg;\r
        Input file = null;\r
\r
        ///\r
        /// argument of tools\r
        ///\r
        while (argIter.hasNext()) {\r
            toolArg = (ToolArg)argIter.next();\r
            argument = argument + toolArg.getLine() + " ";\r
\r
        }\r
\r
        ///\r
        /// input files for tools\r
        ///\r
        argument = argument + "-i ";\r
        while (inputIter.hasNext()) {\r
            file = (Input)inputIter.next();\r
            argument = argument + file.getFile() + " ";\r
        }\r
\r
        outPutFileName = outputPath + File.separatorChar + (new File(file.getFile())).getName() + ".crc";\r
        argument       = argument + " -o " + outPutFileName; \r
\r
        try {\r
\r
            ///\r
            /// execute command line\r
            ///\r
            Process crcProcess = Runtime.getRuntime().exec(command + " " + argument);\r
            crcProcess.waitFor();\r
        } catch (Exception e) {\r
            System.out.print (e.getMessage());\r
            throw new BuildException("Execution of externalTool task failed!\n");\r
        }\r
    }\r
\r
    /**\r
     Add method of ANT task/datatype for nested ToolArg type of element\r
\r
     @param     toolArg     The ToolArg object containing arguments for the tool\r
     **/\r
    public void addToolArg (ToolArg toolArg) {\r
        toolArgList.add (toolArg);\r
    }\r
\r
    /**\r
     Get method of ANT task/datatype for attribute "OutputPath"\r
\r
     @returns   The name of output path\r
     **/\r
    public String getOutputPath() {\r
        return outputPath;\r
    }\r
\r
    /**\r
     Set method of ANT task/datatype for attribute "OutputPath"\r
\r
     @param     outputPath  The name of output path\r
     **/\r
    public void setOutputPath(String outPutPath) {\r
        this.outputPath = outPutPath;\r
    }\r
\r
    /**\r
     Get method of ANT task/datatype for attribute "ToolName"\r
\r
     @returns   The name of the tool.\r
     **/\r
    public String getToolName() {\r
        return toolName;\r
    }\r
\r
    /**\r
     Set method of ANT task/datatype for attribute "ToolName"\r
\r
     @param     toolName    The name of the tool\r
     **/\r
    public void setToolName(String toolName) {\r
        this.toolName = toolName;\r
    }\r
\r
    /**\r
     Add method of ANT task/datatype for nested Input type of element\r
\r
     @param     file    The Input objec which represents a file\r
     **/\r
    public void addInput(Input file) {\r
        inputFiles.add(file);\r
    }\r
}\r
\r
\r