+++ /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.BufferedInputStream;\r
-import java.io.BufferedReader;\r
-import java.io.BufferedWriter;\r
-import java.io.File;\r
-import java.io.FileInputStream;\r
-import java.io.FileReader;\r
-import java.io.FileWriter;\r
-import java.io.IOException;\r
-import java.io.LineNumberReader;\r
-import java.util.HashMap;\r
-import java.util.HashSet;\r
-import java.util.Iterator;\r
-import java.util.LinkedHashSet;\r
-import java.util.List;\r
-import java.util.Set;\r
-import java.util.Stack;\r
-import java.util.regex.Matcher;\r
-import java.util.regex.Pattern;\r
-\r
-import org.apache.tools.ant.BuildException;\r
-import org.apache.tools.ant.Task;\r
-import org.tianocore.common.cache.FileTimeStamp;\r
-import org.tianocore.common.logger.EdkLog;\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 String targetFile = "";\r
- private String depsFilePath = "";\r
- private IncludePath includePathList = new IncludePath();\r
- private Input inputFileList = new Input();\r
- //\r
- // cache the including files to speed up dependency check\r
- // \r
- private static HashMap<String, Set<String>> includesCache = new HashMap<String, Set<String>>();\r
- //\r
- // regular expression for "#include ..." directive\r
- // \r
- private static final Pattern incPattern = Pattern.compile("[\n\r \t#]*include[ \t]+[\"<]*([^\n\r\"<>]+)[>\" \t]*");\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
- // if target file is specified and it hasn't been generated, don't generate\r
- // dep file\r
- // \r
- if (targetFile.length() != 0 && (new File(targetFile)).exists() == false) {\r
- return;\r
- }\r
- //\r
- // check if the dependency list file is uptodate or not\r
- //\r
- if (isUptodate()) {\r
- return;\r
- }\r
-\r
- //\r
- // if no include path is specified, try locally\r
- // \r
- if (includePathList.isEmpty()) {\r
- includePathList.insPath(".");\r
- }\r
-\r
- Set<String> depFiles = getDependencies(inputFileList.toArray());\r
-\r
- File depsFile = new File(depsFilePath);\r
- FileWriter fileWriter = null;\r
- BufferedWriter bufWriter = null;\r
-\r
- try {\r
- fileWriter = new FileWriter(depsFile);\r
- bufWriter = new BufferedWriter(fileWriter);\r
-\r
-\r
- for (Iterator it = depFiles.iterator(); it.hasNext();) {\r
- String depFile = (String)it.next();\r
- bufWriter.write(depFile, 0, depFile.length());\r
- bufWriter.write("\n", 0, 1);\r
- }\r
- //\r
- // put a "tab" at the end of file as file ending flag\r
- // \r
- bufWriter.write("\t", 0, 1);\r
- } catch (Exception e) {\r
- throw new BuildException(e.getMessage());\r
- } finally {\r
- try {\r
- if (bufWriter != null) {\r
- bufWriter.close();\r
- }\r
- if (fileWriter != null) {\r
- fileWriter.close();\r
- }\r
- } catch (Exception e) {\r
- throw new BuildException(e.getMessage());\r
- }\r
- }\r
-\r
- //\r
- // update time stamp of dependency file\r
- // \r
- FileTimeStamp.update(depsFilePath, depsFile.lastModified());\r
- }\r
-\r
- public void setTargetFile(String name) {\r
- targetFile = name;\r
- }\r
-\r
- public String getTargetFile() {\r
- return targetFile;\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
- depsFilePath = 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 depsFilePath;\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
- File df = new File(depsFilePath);\r
- if (!df.exists()) {\r
- EdkLog.log(this, EdkLog.EDK_VERBOSE, depsFilePath + " 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(depsFilePath);\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, depsFilePath + " is empty!");\r
- ret = false;\r
- }\r
- } catch (IOException e) {\r
- throw new BuildException(e.getMessage());\r
- } finally {\r
- try {\r
- if (lineReader != null) {\r
- lineReader.close();\r
- }\r
- if (fileReader != null) {\r
- fileReader.close();\r
- }\r
- } catch (Exception e) {\r
- throw new BuildException(e.getMessage());\r
- }\r
- }\r
-\r
- return ret;\r
- }\r
-\r
- //\r
- // get dependent files list by parsing "#include" directive\r
- // \r
- private synchronized Set<String> getDependencies(String[] sourceFiles) {\r
- Set<String> dependencies = new LinkedHashSet<String>();\r
- String[] searchPathList = includePathList.toArray();\r
-\r
- Stack<String> pendingFiles = new Stack<String>();\r
- for (int i = 0; i < sourceFiles.length; ++i) {\r
- File srcFile = new File(sourceFiles[i]);\r
- if (srcFile.exists()) {\r
- //\r
- // a file must depend itself\r
- // \r
- dependencies.add(srcFile.getAbsolutePath());\r
- pendingFiles.push(sourceFiles[i]);\r
- }\r
- }\r
-\r
- while (!pendingFiles.empty()) {\r
- String src = pendingFiles.pop();\r
- File srcFile = new File(src);\r
- int fileLength = (int)srcFile.length();\r
- if (!srcFile.exists() || fileLength == 0) {\r
- continue;\r
- }\r
- //\r
- // try cache first\r
- // \r
- Set<String> incFiles = includesCache.get(src);\r
- if (incFiles == null) {\r
- incFiles = new HashSet<String>();\r
- FileInputStream fileReader = null;\r
- BufferedInputStream bufReader = null;\r
- String fileContent = "";\r
-\r
- try {\r
- fileReader = new FileInputStream(srcFile);\r
- bufReader = new BufferedInputStream(fileReader);\r
- byte[] buf = new byte[fileLength];\r
-\r
- bufReader.read(buf, 0, fileLength);\r
- //\r
- // check if the file is utf-16 encoded\r
- // \r
- if (buf[0] == (byte)0xff || buf[0] == (byte)0xfe) {\r
- fileContent = new String(buf, "UTF-16");\r
- buf = fileContent.getBytes("UTF-8");\r
- }\r
- fileContent = new String(buf);\r
- } catch (IOException e) {\r
- throw new BuildException(e.getMessage());\r
- } finally {\r
- try {\r
- if (bufReader != null) {\r
- bufReader.close();\r
- }\r
- if (fileReader != null) {\r
- fileReader.close();\r
- }\r
- } catch (Exception e) {\r
- throw new BuildException(e.getMessage());\r
- }\r
- }\r
-\r
- //\r
- // find out all "#include" lines\r
- // \r
- Matcher matcher = incPattern.matcher(fileContent);\r
- while (matcher.find()) {\r
- String incFilePath = fileContent.substring(matcher.start(1), matcher.end(1));\r
- incFiles.add(incFilePath);\r
- }\r
-\r
- //\r
- // put the includes in cache to avoid re-parsing\r
- // \r
- includesCache.put(src, incFiles);\r
- }\r
-\r
- //\r
- // try each include search path to see if the include file exists or not\r
- // \r
- for (Iterator<String> it = incFiles.iterator(); it.hasNext();) {\r
- String depFilePath = it.next();\r
-\r
- for (int i = 0; i < searchPathList.length; ++i) {\r
- File depFile = new File(searchPathList[i] + File.separator + depFilePath);\r
- String filePath = depFile.getAbsolutePath();\r
- //\r
- // following check is a must. it can prevent dead loop if two\r
- // files include each other\r
- // \r
- if (depFile.exists() && !dependencies.contains(filePath)) {\r
- dependencies.add(filePath);\r
- pendingFiles.push(filePath);\r
- break;\r
- }\r
- }\r
- }\r
- }\r
-\r
- return dependencies;\r
- }\r
-}\r
-\r
projects / mirror_edk2.git / blobdiff