Package net.sf.antcontrib.cpptasks

Class DependencyTable

java.lang.Object

net.sf.antcontrib.cpptasks.DependencyTable

public final class DependencyTable
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	DependencyTable.DependencyTableHandler	This class handles populates the TargetHistory hashtable in response to SAX parse events
class	DependencyTable.DependencyVisitor
class	DependencyTable.TimestampChecker

Field Summary

Fields

Modifier and Type	Field	Description
private File	baseDir
private String	baseDirPath
private final Hashtable	dependencies	a hashtable of DependencyInfo[] keyed by output file name
private File	dependenciesFile	The file the cache was loaded from.
private boolean	dirty	Flag indicating whether the cache should be written back to file.

Constructor Summary

Constructors

Constructor	Description
DependencyTable(File baseDir)	Creates a target history table from dependencies.xml in the prject directory, if it exists.

Method Summary

Modifier and Type	Method	Description
void	commit(CCTask task)
Enumeration	elements()	Returns an enumerator of DependencyInfo's
DependencyInfo	getDependencyInfo(String sourceRelativeName, String includePathIdentifier)	This method returns a DependencyInfo for the specific source file and include path identifier
private Vector	getIncludePaths()
void	load()
boolean	needsRebuild(CCTask task, TargetInfo target, int dependencyDepth)	Determines if the specified target needs to be rebuilt.
DependencyInfo	parseIncludes(CCTask task, CompilerConfiguration compiler, File source)
private void	putDependencyInfo(String key, DependencyInfo dependInfo)
void	walkDependencies(CCTask task, DependencyInfo dependInfo, CompilerConfiguration compiler, DependencyInfo[] stack, DependencyTable.DependencyVisitor visitor)
private void	writeDependencyInfo(BufferedWriter writer, StringBuffer buf, DependencyInfo dependInfo)
private void	writeIncludePathDependencies(String includePathIdentifier, BufferedWriter writer, StringBuffer buf)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

baseDir

private File baseDir

baseDirPath

private String baseDirPath

dependencies

private final Hashtable dependencies

a hashtable of DependencyInfo[] keyed by output file name

dependenciesFile

private File dependenciesFile

The file the cache was loaded from.

dirty

private boolean dirty

Flag indicating whether the cache should be written back to file.

Constructor Details

DependencyTable

public DependencyTable(File baseDir)

Creates a target history table from dependencies.xml in the prject directory, if it exists. Otherwise, initializes the dependencies empty.

Parameters:

baseDir - output directory for task

Method Details

commit

public void commit(CCTask task)

elements

public Enumeration elements()

Returns an enumerator of DependencyInfo's

getDependencyInfo

public DependencyInfo getDependencyInfo(String sourceRelativeName,
 String includePathIdentifier)

This method returns a DependencyInfo for the specific source file and include path identifier

getIncludePaths

private Vector getIncludePaths()

load

public void load()
          throws IOException,
ParserConfigurationException,
SAXException

Throws:

IOException

ParserConfigurationException

SAXException

needsRebuild

public boolean needsRebuild(CCTask task,
 TargetInfo target,
 int dependencyDepth)

Determines if the specified target needs to be rebuilt. This task may result in substantial IO as files are parsed to determine their dependencies

parseIncludes

public DependencyInfo parseIncludes(CCTask task,
 CompilerConfiguration compiler,
 File source)

putDependencyInfo

private void putDependencyInfo(String key,
 DependencyInfo dependInfo)

walkDependencies

public void walkDependencies(CCTask task,
 DependencyInfo dependInfo,
 CompilerConfiguration compiler,
 DependencyInfo[] stack,
 DependencyTable.DependencyVisitor visitor)
                      throws org.apache.tools.ant.BuildException

Throws:

org.apache.tools.ant.BuildException

writeDependencyInfo

private void writeDependencyInfo(BufferedWriter writer,
 StringBuffer buf,
 DependencyInfo dependInfo)
                          throws IOException

Throws:

IOException

writeIncludePathDependencies

private void writeIncludePathDependencies(String includePathIdentifier,
 BufferedWriter writer,
 StringBuffer buf)
                                   throws IOException

Throws:

IOException