+++ /dev/null
-/** @file\r
-This file is to wrap MakeDeps.exe tool as ANT task, which is used to generate\r
-dependency files for source code.\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.File;\r
-import java.io.FileReader;\r
-import java.io.IOException;\r
-import java.io.LineNumberReader;\r
-import java.util.List;\r
-\r
-import org.apache.tools.ant.BuildException;\r
-import org.apache.tools.ant.Project;\r
-import org.apache.tools.ant.Task;\r
-import org.apache.tools.ant.taskdefs.Execute;\r
-import org.apache.tools.ant.taskdefs.LogStreamHandler;\r
-import org.apache.tools.ant.types.Commandline;\r
-\r
-import org.tianocore.common.logger.EdkLog;\r
-import org.tianocore.common.cache.FileTimeStamp;\r
-\r
-/**\r
- Class MakeDeps is used to wrap MakeDeps.exe as an ANT task.\r
- **/\r
-public class MakeDeps extends Task {\r
-\r
- //\r
- // private members, use set/get to access them\r
- //\r
- private static final String toolName = "MakeDeps";\r
- private FileArg depsFile = new FileArg();\r
- private ToolArg subDir = new ToolArg();\r
- private ToolArg quietMode = new ToolArg(" -", "q");\r
- private ToolArg ignoreError = new ToolArg(" -", "ignorenotfound");\r
- private IncludePath includePathList = new IncludePath();\r
- private Input inputFileList = new Input();\r
- private ToolArg target = new FileArg(" -target ", "dummy");\r
-\r
- public MakeDeps() {\r
-\r
- }\r
-\r
- /**\r
- The Standard execute method for ANT task. It will check if it's necessary\r
- to generate the dependency list file. If no file is found or the dependency\r
- is changed, it will compose the command line and call MakeDeps.exe to\r
- generate the dependency list file.\r
-\r
- @throws BuildException\r
- **/\r
- public void execute() throws BuildException {\r
- ///\r
- /// check if the dependency list file is uptodate or not\r
- ///\r
- if (isUptodate()) {\r
- return;\r
- }\r
-\r
- Project prj = this.getOwningTarget().getProject();\r
- String toolPath = prj.getProperty("env.FRAMEWORK_TOOLS_PATH");\r
-\r
- ///\r
- /// compose full tool path\r
- ///\r
- if (toolPath == null || toolPath.length() == 0) {\r
- toolPath = toolName;\r
- } else {\r
- if (toolPath.endsWith("/") || toolPath.endsWith("\\")) {\r
- toolPath = toolPath + toolName;\r
- } else {\r
- toolPath = toolPath + File.separator + toolName;\r
- }\r
- }\r
-\r
- ///\r
- /// compose tool arguments\r
- ///\r
- String argument = "" + inputFileList + includePathList + subDir\r
- + quietMode + ignoreError + target + depsFile;\r
-\r
- ///\r
- /// prepare to execute the tool\r
- ///\r
- Commandline cmd = new Commandline();\r
- cmd.setExecutable(toolPath);\r
- cmd.createArgument().setLine(argument);\r
-\r
- LogStreamHandler streamHandler = new LogStreamHandler(this, Project.MSG_INFO, Project.MSG_WARN);\r
- Execute runner = new Execute(streamHandler, null);\r
-\r
- runner.setAntRun(prj);\r
- runner.setCommandline(cmd.getCommandline());\r
-\r
- EdkLog.log(this, EdkLog.EDK_VERBOSE, Commandline.toString(cmd.getCommandline()));\r
-\r
- int result = 0;\r
- try {\r
- result = runner.execute();\r
- } catch (IOException e) {\r
- throw new BuildException(e.getMessage());\r
- }\r
-\r
- if (result != 0) {\r
- EdkLog.log(this, EdkLog.EDK_INFO, toolName + " failed!");\r
- throw new BuildException(toolName + ": failed to generate dependency file!");\r
- } else {\r
- EdkLog.log(this, EdkLog.EDK_VERBOSE, toolName + " succeeded!");\r
- }\r
- }\r
-\r
- /**\r
- Set method for "DepsFile" attribute\r
-\r
- @param name The name of dependency list file\r
- **/\r
- public void setDepsFile(String name) {\r
- depsFile.setArg(" -o ", name);\r
- }\r
-\r
- /**\r
- Get method for "DepsFile" attribute\r
-\r
- @returns The name of dependency list file\r
- **/\r
- public String getDepsFile() {\r
- return depsFile.getValue();\r
- }\r
-\r
- /**\r
- Set method for "IgnoreError" attribute\r
-\r
- @param ignore flag to control error handling (true/false)\r
- **/\r
- public void setIgnoreError(boolean ignore) {\r
- if (!ignore) {\r
- ignoreError.setArg(" ", " ");\r
- }\r
- }\r
-\r
- /**\r
- Get method for "IgnoreError" attribute\r
-\r
- @returns The value of current IgnoreError flag\r
- **/\r
- public boolean getIgnoreError() {\r
- return ignoreError.getValue().length() > 0;\r
- }\r
-\r
- /**\r
- Set method for "QuietMode" attribute\r
-\r
- @param quiet flag to control the output information (true/false)\r
- **/\r
- public void setQuietMode(boolean quiet) {\r
- if (!quiet) {\r
- quietMode.setArg(" ", " ");\r
- }\r
- }\r
-\r
- /**\r
- Get method for "QuietMode" attribute\r
-\r
- @returns value of current QuietMode flag\r
- **/\r
- public boolean getQuietMode() {\r
- return quietMode.getValue().length() > 0;\r
- }\r
-\r
- /**\r
- Set method for "SubDir" attribute\r
-\r
- @param dir The name of sub-directory in which source files will be scanned\r
- **/\r
- public void setSubDir(String dir) {\r
- subDir.setArg(" -s ", dir);\r
- }\r
-\r
- /**\r
- Get method for "SubDir" attribute\r
-\r
- @returns The name of sub-directory\r
- **/\r
- public String getSubDir() {\r
- return subDir.getValue();\r
- }\r
-\r
- /**\r
- Add method for "IncludePath" nested element\r
-\r
- @param path The IncludePath object from nested IncludePath type of element\r
- **/\r
- public void addConfiguredIncludepath(IncludePath path) {\r
- includePathList.insert(path);\r
- }\r
-\r
- /**\r
- Add method for "Input" nested element\r
-\r
- @param input The Input object from nested Input type of element\r
- **/\r
- public void addConfiguredInput(Input inputFile) {\r
- inputFileList.insert(inputFile);\r
- }\r
-\r
- /**\r
- Check if the dependency list file should be (re-)generated or not.\r
-\r
- @returns true The dependency list file is uptodate. No re-generation is needed.\r
- @returns false The dependency list file is outofdate. Re-generation is needed.\r
- **/\r
- private boolean isUptodate() {\r
- String dfName = depsFile.getValue();\r
- File df = new File(dfName);\r
- if (!df.exists()) {\r
- EdkLog.log(this, EdkLog.EDK_VERBOSE, dfName + " doesn't exist!");\r
- return false;\r
- }\r
-\r
- //\r
- // If the source file(s) is newer than dependency list file, we need to\r
- // re-generate the dependency list file\r
- //\r
- long depsFileTimeStamp = FileTimeStamp.get(dfName);\r
- List<String> fileList = inputFileList.getNameList();\r
- for (int i = 0, length = fileList.size(); i < length; ++i) {\r
- String sf = fileList.get(i);\r
- if (FileTimeStamp.get(sf) > depsFileTimeStamp) {\r
- EdkLog.log(this, EdkLog.EDK_VERBOSE, sf + " has been changed since last build!");\r
- return false;\r
- }\r
- }\r
-\r
- //\r
- // If the source files haven't been changed since last time the dependency\r
- // list file was generated, we need to check each file in the file list to\r
- // see if any of them is changed or not. If anyone of them is newer than\r
- // the dependency list file, MakeDeps.exe is needed to run again.\r
- //\r
- LineNumberReader lineReader = null;\r
- FileReader fileReader = null;\r
- boolean ret = false;\r
- try {\r
- fileReader = new FileReader(df);\r
- lineReader = new LineNumberReader(fileReader);\r
-\r
- String line = null;\r
- int lines = 0;\r
- while ((line = lineReader.readLine()) != null) {\r
- //\r
- // check file end flag "\t" to see if the .dep was generated correctly\r
- // \r
- if (line.equals("\t")) {\r
- ret = true;\r
- continue;\r
- }\r
- line = line.trim();\r
- //\r
- // skip empty line\r
- // \r
- if (line.length() == 0) {\r
- continue;\r
- }\r
- ++lines;\r
-\r
- //\r
- // If a file cannot be found (moved or removed) or newer, regenerate the dep file\r
- // \r
- File sourceFile = new File(line);\r
- if ((!sourceFile.exists()) || (FileTimeStamp.get(line) > depsFileTimeStamp)) {\r
- EdkLog.log(this, EdkLog.EDK_VERBOSE, sourceFile.getPath() + " has been (re)moved or changed since last build!");\r
- ret = false;\r
- break;\r
- }\r
- }\r
-\r
- //\r
- // check if the .dep file is empty\r
- // \r
- if (lines == 0) {\r
- EdkLog.log(this, EdkLog.EDK_VERBOSE, dfName + " is empty!");\r
- ret = false;\r
- }\r
-\r
- lineReader.close();\r
- fileReader.close();\r
- } catch (IOException e) {\r
- throw new BuildException(e.getMessage());\r
- }\r
-\r
- return ret;\r
- }\r
-}\r
-\r
projects / mirror_edk2.git / blobdiff