2 This file is to wrap MakeDeps.exe tool as ANT task, which is used to generate
3 dependency files for source code.
5 Copyright (c) 2006, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 package org
.tianocore
.framework
.tasks
;
18 import java
.io
.FileReader
;
19 import java
.io
.IOException
;
20 import java
.io
.LineNumberReader
;
21 import java
.util
.List
;
23 import org
.apache
.tools
.ant
.BuildException
;
24 import org
.apache
.tools
.ant
.Project
;
25 import org
.apache
.tools
.ant
.Task
;
26 import org
.apache
.tools
.ant
.taskdefs
.Execute
;
27 import org
.apache
.tools
.ant
.taskdefs
.LogStreamHandler
;
28 import org
.apache
.tools
.ant
.types
.Commandline
;
30 import org
.tianocore
.common
.logger
.EdkLog
;
31 import org
.tianocore
.common
.cache
.FileTimeStamp
;
34 Class MakeDeps is used to wrap MakeDeps.exe as an ANT task.
36 public class MakeDeps
extends Task
{
39 // private members, use set/get to access them
41 private static final String toolName
= "MakeDeps";
42 private FileArg depsFile
= new FileArg();
43 private ToolArg subDir
= new ToolArg();
44 private ToolArg quietMode
= new ToolArg(" -", "q");
45 private ToolArg ignoreError
= new ToolArg(" -", "ignorenotfound");
46 private IncludePath includePathList
= new IncludePath();
47 private Input inputFileList
= new Input();
48 private ToolArg target
= new FileArg(" -target ", "dummy");
55 The Standard execute method for ANT task. It will check if it's necessary
56 to generate the dependency list file. If no file is found or the dependency
57 is changed, it will compose the command line and call MakeDeps.exe to
58 generate the dependency list file.
60 @throws BuildException
62 public void execute() throws BuildException
{
64 /// check if the dependency list file is uptodate or not
70 Project prj
= this.getOwningTarget().getProject();
71 String toolPath
= prj
.getProperty("env.FRAMEWORK_TOOLS_PATH");
74 /// compose full tool path
76 if (toolPath
== null || toolPath
.length() == 0) {
79 if (toolPath
.endsWith("/") || toolPath
.endsWith("\\")) {
80 toolPath
= toolPath
+ toolName
;
82 toolPath
= toolPath
+ File
.separator
+ toolName
;
87 /// compose tool arguments
89 String argument
= "" + inputFileList
+ includePathList
+ subDir
90 + quietMode
+ ignoreError
+ target
+ depsFile
;
93 /// prepare to execute the tool
95 Commandline cmd
= new Commandline();
96 cmd
.setExecutable(toolPath
);
97 cmd
.createArgument().setLine(argument
);
99 LogStreamHandler streamHandler
= new LogStreamHandler(this, Project
.MSG_INFO
, Project
.MSG_WARN
);
100 Execute runner
= new Execute(streamHandler
, null);
102 runner
.setAntRun(prj
);
103 runner
.setCommandline(cmd
.getCommandline());
105 EdkLog
.log(this, EdkLog
.EDK_VERBOSE
, Commandline
.toString(cmd
.getCommandline()));
109 result
= runner
.execute();
110 } catch (IOException e
) {
111 throw new BuildException(e
.getMessage());
115 EdkLog
.log(this, EdkLog
.EDK_INFO
, toolName
+ " failed!");
116 throw new BuildException(toolName
+ ": failed to generate dependency file!");
118 EdkLog
.log(this, EdkLog
.EDK_VERBOSE
, toolName
+ " succeeded!");
123 Set method for "DepsFile" attribute
125 @param name The name of dependency list file
127 public void setDepsFile(String name
) {
128 depsFile
.setArg(" -o ", name
);
132 Get method for "DepsFile" attribute
134 @returns The name of dependency list file
136 public String
getDepsFile() {
137 return depsFile
.getValue();
141 Set method for "IgnoreError" attribute
143 @param ignore flag to control error handling (true/false)
145 public void setIgnoreError(boolean ignore
) {
147 ignoreError
.setArg(" ", " ");
152 Get method for "IgnoreError" attribute
154 @returns The value of current IgnoreError flag
156 public boolean getIgnoreError() {
157 return ignoreError
.getValue().length() > 0;
161 Set method for "QuietMode" attribute
163 @param quiet flag to control the output information (true/false)
165 public void setQuietMode(boolean quiet
) {
167 quietMode
.setArg(" ", " ");
172 Get method for "QuietMode" attribute
174 @returns value of current QuietMode flag
176 public boolean getQuietMode() {
177 return quietMode
.getValue().length() > 0;
181 Set method for "SubDir" attribute
183 @param dir The name of sub-directory in which source files will be scanned
185 public void setSubDir(String dir
) {
186 subDir
.setArg(" -s ", dir
);
190 Get method for "SubDir" attribute
192 @returns The name of sub-directory
194 public String
getSubDir() {
195 return subDir
.getValue();
199 Add method for "IncludePath" nested element
201 @param path The IncludePath object from nested IncludePath type of element
203 public void addConfiguredIncludepath(IncludePath path
) {
204 includePathList
.insert(path
);
208 Add method for "Input" nested element
210 @param input The Input object from nested Input type of element
212 public void addConfiguredInput(Input inputFile
) {
213 inputFileList
.insert(inputFile
);
217 Check if the dependency list file should be (re-)generated or not.
219 @returns true The dependency list file is uptodate. No re-generation is needed.
220 @returns false The dependency list file is outofdate. Re-generation is needed.
222 private boolean isUptodate() {
223 String dfName
= depsFile
.getValue();
224 File df
= new File(dfName
);
226 EdkLog
.log(this, EdkLog
.EDK_VERBOSE
, dfName
+ " doesn't exist!");
231 // If the source file(s) is newer than dependency list file, we need to
232 // re-generate the dependency list file
234 long depsFileTimeStamp
= FileTimeStamp
.get(dfName
);
235 List
<String
> fileList
= inputFileList
.getNameList();
236 for (int i
= 0, length
= fileList
.size(); i
< length
; ++i
) {
237 String sf
= fileList
.get(i
);
238 if (FileTimeStamp
.get(sf
) > depsFileTimeStamp
) {
239 EdkLog
.log(this, EdkLog
.EDK_VERBOSE
, sf
+ " has been changed since last build!");
245 // If the source files haven't been changed since last time the dependency
246 // list file was generated, we need to check each file in the file list to
247 // see if any of them is changed or not. If anyone of them is newer than
248 // the dependency list file, MakeDeps.exe is needed to run again.
250 LineNumberReader lineReader
= null;
251 FileReader fileReader
= null;
254 fileReader
= new FileReader(df
);
255 lineReader
= new LineNumberReader(fileReader
);
259 while ((line
= lineReader
.readLine()) != null) {
261 // check file end flag "\t" to see if the .dep was generated correctly
263 if (line
.equals("\t")) {
271 if (line
.length() == 0) {
277 // If a file cannot be found (moved or removed) or newer, regenerate the dep file
279 File sourceFile
= new File(line
);
280 if ((!sourceFile
.exists()) || (FileTimeStamp
.get(line
) > depsFileTimeStamp
)) {
281 EdkLog
.log(this, EdkLog
.EDK_VERBOSE
, sourceFile
.getPath() + " has been (re)moved or changed since last build!");
288 // check if the .dep file is empty
291 EdkLog
.log(this, EdkLog
.EDK_VERBOSE
, dfName
+ " is empty!");
297 } catch (IOException e
) {
298 throw new BuildException(e
.getMessage());