\r
import java.io.File;\r
import java.io.FileReader;\r
-import java.io.FileWriter;\r
import java.io.IOException;\r
import java.io.LineNumberReader;\r
import java.util.ArrayList;\r
-import java.util.HashSet;\r
import java.util.Iterator;\r
import java.util.List;\r
-import java.util.Set;\r
-import java.util.StringTokenizer;\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.Project;\r
import org.apache.tools.ant.taskdefs.LogStreamHandler;\r
import org.apache.tools.ant.types.Commandline;\r
import org.apache.tools.ant.types.Path;\r
-import org.tianocore.logger.EdkLog;\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
// private members, use set/get to access them\r
//\r
- private static final String cmdName = "MakeDeps";\r
- private static final String target = "dummy";\r
- private String includePath = null;\r
- private String depsFile = null;\r
- private String subDir = null;\r
- private boolean quietMode = true;\r
- private boolean ignoreError = true;\r
- private String extraDeps = "";\r
- private List<IncludePath> includePathList = new ArrayList<IncludePath>();\r
- private List<Input> inputFileList = new ArrayList<Input>();\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
Project prj = this.getOwningTarget().getProject();\r
String toolPath = prj.getProperty("env.FRAMEWORK_TOOLS_PATH");\r
- FrameworkLogger logger = new FrameworkLogger(prj, "makedeps");\r
- EdkLog.setLogLevel(prj.getProperty("env.LOGLEVEL"));\r
- EdkLog.setLogger(logger);\r
\r
///\r
/// compose full tool path\r
///\r
if (toolPath == null || toolPath.length() == 0) {\r
- toolPath = "./" + cmdName;\r
+ toolPath = toolName;\r
} else {\r
if (toolPath.endsWith("/") || toolPath.endsWith("\\")) {\r
- toolPath = toolPath + cmdName;\r
+ toolPath = toolPath + toolName;\r
} else {\r
- toolPath = toolPath + "/" + cmdName;\r
+ toolPath = toolPath + File.separator + toolName;\r
}\r
}\r
\r
///\r
/// compose tool arguments\r
///\r
- StringBuffer args = new StringBuffer(4096);\r
- if (ignoreError) {\r
- args.append(" -ignorenotfound");\r
- }\r
- if (quietMode) {\r
- args.append(" -q");\r
- }\r
- if (subDir != null && subDir.length() > 0) {\r
- args.append(" -s ");\r
- args.append(subDir);\r
- }\r
-\r
- ///\r
- /// if there's no source files, we can do nothing about dependency\r
- /// \r
- if (inputFileList.size() == 0) {\r
- throw new BuildException("No source files specified to scan");\r
- }\r
-\r
- ///\r
- /// compose source file arguments\r
- ///\r
- Iterator iterator = inputFileList.iterator();\r
- while (iterator.hasNext()) {\r
- Input inputFile = (Input)iterator.next();\r
- String inputFileString = cleanupPathName(inputFile.getFile());\r
- args.append(" -f ");\r
- args.append(inputFileString);\r
- }\r
-\r
- ///\r
- /// compose search pathes argument\r
- ///\r
- StringBuffer includePathArg = new StringBuffer(4096);\r
- if (includePath != null && includePath.length() > 0) {\r
- StringTokenizer pathTokens = new StringTokenizer(includePath, ";");\r
- while (pathTokens.hasMoreTokens()) {\r
- String tmpPath = pathTokens.nextToken().trim();\r
- if (tmpPath.length() == 0) {\r
- continue;\r
- }\r
-\r
- includePathArg.append(" -i ");\r
- includePathArg.append(cleanupPathName(tmpPath));\r
- }\r
- }\r
- iterator = includePathList.iterator();\r
- while (iterator.hasNext()) {\r
- IncludePath path = (IncludePath)iterator.next();\r
- includePathArg.append(cleanupPathName(path.getPath()));\r
- }\r
- args.append(includePathArg);\r
-\r
- ///\r
- /// We don't need a real target. So just a "dummy" is given\r
- ///\r
- args.append(" -target dummy");\r
- args.append(" -o ");\r
- args.append(cleanupPathName(depsFile));\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(args.toString());\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
runner.setAntRun(prj);\r
runner.setCommandline(cmd.getCommandline());\r
\r
- EdkLog.log(EdkLog.EDK_VERBOSE, Commandline.toString(cmd.getCommandline()));\r
+ EdkLog.log(this, EdkLog.EDK_VERBOSE, Commandline.toString(cmd.getCommandline()));\r
\r
int result = 0;\r
try {\r
}\r
\r
if (result != 0) {\r
- EdkLog.log(EdkLog.EDK_INFO, "MakeDeps failed!");\r
- return;\r
- }\r
-\r
- // change the old DEP file format (makefile compatible) to just file list\r
- if (!cleanup()) {\r
- throw new BuildException(depsFile + " was not generated");\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
- /// Remove any duplicated path separator or inconsistent path separator\r
- ///\r
- private String cleanupPathName(String path) {\r
- String separator = "\\" + File.separator;\r
- String duplicateSeparator = separator + "{2}";\r
- path = Path.translateFile(path);\r
- path = path.replaceAll(duplicateSeparator, separator);\r
- return path;\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 = cleanupPathName(name);\r
+ depsFile.setArg(" -o ", name);\r
}\r
\r
/**\r
@returns The name of dependency list file\r
**/\r
public String getDepsFile() {\r
- return depsFile;\r
+ return depsFile.getValue();\r
}\r
\r
/**\r
@param ignore flag to control error handling (true/false)\r
**/\r
public void setIgnoreError(boolean ignore) {\r
- ignoreError = ignore;\r
+ if (!ignore) {\r
+ ignoreError.setArg(" ", " ");\r
+ }\r
}\r
\r
/**\r
@returns The value of current IgnoreError flag\r
**/\r
public boolean getIgnoreError() {\r
- return ignoreError;\r
+ return ignoreError.getValue().length() > 0;\r
}\r
\r
/**\r
@param quiet flag to control the output information (true/false)\r
**/\r
public void setQuietMode(boolean quiet) {\r
- quietMode = quiet;\r
+ if (!quiet) {\r
+ quietMode.setArg(" ", " ");\r
+ }\r
}\r
\r
/**\r
@returns value of current QuietMode flag\r
**/\r
public boolean getQuietMode() {\r
- return quietMode;\r
+ return quietMode.getValue().length() > 0;\r
}\r
\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 = dir;\r
+ subDir.setArg(" -s ", dir);\r
}\r
\r
/**\r
@returns The name of sub-directory\r
**/\r
public String getSubDir() {\r
- return subDir;\r
- }\r
-\r
- /**\r
- Set method for "IncludePath" attribute\r
-\r
- @param path The name of include path\r
- **/\r
- public void setIncludePath(String path) {\r
- includePath = cleanupPathName(path);\r
- }\r
-\r
- /**\r
- Get method for "IncludePath" attribute\r
-\r
- @returns The name of include path\r
- **/\r
- public String getIncludePath() {\r
- return includePath;\r
- }\r
-\r
- /**\r
- Set method for "ExtraDeps" attribute\r
-\r
- @param deps The name of dependency file specified separately\r
- **/\r
- public void setExtraDeps(String deps) {\r
- extraDeps = deps;\r
- }\r
-\r
- /**\r
- Get method for "ExtraDeps" attribute\r
-\r
- @returns The name of dependency file specified separately\r
- **/\r
- public String getExtraDeps () {\r
- return extraDeps;\r
+ return subDir.getValue();\r
}\r
\r
/**\r
\r
@param path The IncludePath object from nested IncludePath type of element\r
**/\r
- public void addIncludepath(IncludePath path) {\r
- includePathList.add(path);\r
+ public void addConfiguredIncludepath(IncludePath path) {\r
+ includePathList.insert(path);\r
}\r
\r
/**\r
\r
@param input The Input object from nested Input type of element\r
**/\r
- public void addInput(Input inputFile) {\r
- inputFileList.add(inputFile);\r
- }\r
-\r
- /**\r
- The original file generated by MakeDeps.exe is for makefile uses. The target\r
- part (before :) is not useful for ANT. This method will do the removal.\r
-\r
- @returns true if cleaned files is saved successfully\r
- @returns false if error occurs in file I/O system\r
- **/\r
- private boolean cleanup() {\r
- File df = new File(depsFile);\r
-\r
- if (!df.exists()) {\r
- return false;\r
- }\r
-\r
- LineNumberReader lineReader = null;\r
- FileReader fileReader = null;\r
- Set<String> lineSet = new HashSet<String>(100); // used to remove duplicated lines\r
- try {\r
- fileReader = new FileReader(df);\r
- lineReader = new LineNumberReader(fileReader);\r
-\r
- ///\r
- /// clean-up each line in deps file\r
- //\r
- String line = null;\r
- while ((line = lineReader.readLine()) != null) {\r
- Pattern pattern = Pattern.compile(target + "[ ]*:[ ]*(.+)");\r
- Matcher matcher = pattern.matcher(line);\r
-\r
- while (matcher.find()) {\r
- ///\r
- /// keep the file name after ":"\r
- ///\r
- String filePath = line.substring(matcher.start(1), matcher.end(1));\r
- filePath = cleanupPathName(filePath);\r
- lineSet.add(filePath);\r
- }\r
- }\r
- lineReader.close();\r
- fileReader.close();\r
-\r
- ///\r
- /// we may have explicitly specified dependency files\r
- ///\r
- StringTokenizer fileTokens = new StringTokenizer(extraDeps, ";");\r
- while (fileTokens.hasMoreTokens()) {\r
- lineSet.add(cleanupPathName(fileTokens.nextToken()));\r
- }\r
-\r
- ///\r
- /// compose the final file content\r
- /// \r
- StringBuffer cleanedLines = new StringBuffer(40960);\r
- Iterator<String> it = lineSet.iterator();\r
- while (it.hasNext()) {\r
- String filePath = it.next();\r
- cleanedLines.append(filePath);\r
- cleanedLines.append("\n");\r
- }\r
- ///\r
- /// overwrite old dep file with new content\r
- ///\r
- FileWriter fileWriter = null;\r
- fileWriter = new FileWriter(df);\r
- fileWriter.write(cleanedLines.toString());\r
- fileWriter.close();\r
- } catch (IOException e) {\r
- log (e.getMessage());\r
- }\r
-\r
- return true;\r
+ public void addConfiguredInput(Input inputFile) {\r
+ inputFileList.insert(inputFile);\r
}\r
\r
/**\r
@returns false The dependency list file is outofdate. Re-generation is needed.\r
**/\r
private boolean isUptodate() {\r
- File df = new File(depsFile);\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 = df.lastModified();\r
- Iterator iterator = inputFileList.iterator();\r
- while (iterator.hasNext()) {\r
- Input inputFile = (Input)iterator.next();\r
- File sf = new File(inputFile.getFile());\r
- if (sf.lastModified() > depsFileTimeStamp) {\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
+ //\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 = true;\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.lastModified() > depsFileTimeStamp) {\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
- log (e.getMessage());\r
+ throw new BuildException(e.getMessage());\r
}\r
\r
return ret;\r