org.quattor.ant

Class PanCompilerTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.quattor.ant.PanCompilerTask

All Implemented Interfaces:

Cloneable

public class PanCompilerTask
extends org.apache.tools.ant.Task

An ant task which permits calling the pan compiler from an ant build file. This task allows all of the compiler parameters to be accessed and will optionally check dependency files before starting a build. See individual setter methods for the parameters which can be used in the build file.

Author:

loomis

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	debugIndent

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
PanCompilerTask()

Method Summary

Methods

Modifier and Type	Method and Description
void	addConfiguredFileSet(org.apache.tools.ant.types.FileSet fileset) Support nested fileset elements.
void	addConfiguredPath(org.apache.tools.ant.types.Path path) Support nested path elements.
void	execute()
int	getBatchSize()
int	getNthread()
void	setBatchSize(int batchSize)
void	setCheckDependencies(boolean checkDependencies) This any task can check machine profile dependencies to avoid processing machine profiles which are already up-to-date.
void	setDebugNsExclude(String pattern) Set the regular expression used to exclude pan namespaces for debugging.
void	setDebugNsInclude(String pattern) Set the regular expression used to include pan namespaces for debugging.
void	setDebugTask(int debugTask) Setting this flag will print debugging information from the task itself.
void	setFormats(String fmts) Defines the formatters used to generate the output files.
void	setIgnoreDependencyPattern(String ignoreDependencyPattern) Dependencies that must be ignored when selecting the profiles to rebuild.
void	setIncludeRoot(File includeroot) Set the directory to use for the include globs.
void	setIncludes(String includes) Set the include globs to use for the pan compiler loadpath.
void	setInitialData(String initialData) Provides a dict() with a data structure that will be used to initialize all generated profiles.
void	setLogfile(File logFile) Set the log file to use for logging.
void	setLogging(String loggingFlags) Enable the given types of logging.
void	setMaxIteration(int maxIteration) The pan compiler allows an iteration limit to be set to avoid infinite loops.
void	setMaxRecursion(int maxRecursion) Sets the default maximum number of recursions.
void	setNthread(int nthread)
void	setOutputDir(File outputDir) Set the output directory for generated machine profiles and dependency files.
void	setVerbose(boolean verbose) Flag to indicate that extra information should be written to the standard output.
void	setWarnings(String warnings) Determines whether deprecation warnings are emitted and if so, whether to treat them as fatal errors.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Field Detail

debugIndent

protected static final String debugIndent

See Also:

Constant Field Values

Constructor Detail

PanCompilerTask

public PanCompilerTask()

Method Detail

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

setIncludeRoot

public void setIncludeRoot(File includeroot)

Set the directory to use for the include globs. This is required only if the includes parameter is set.

Parameters:

includeroot - File giving the root directory for the include globs

setIncludes

public void setIncludes(String includes)

Set the include globs to use for the pan compiler loadpath.

Parameters:

includes - String of comma- or space-separated file globs

addConfiguredPath

public void addConfiguredPath(org.apache.tools.ant.types.Path path)

Support nested path elements. This is called by ant only after all of the children of the path have been processed. These are the include directories to find non-object templates. Non-directory elements will be silently ignored.

Parameters:

path - a configured Path

addConfiguredFileSet

public void addConfiguredFileSet(org.apache.tools.ant.types.FileSet fileset)

Support nested fileset elements. This is called by ant only after all of the children of the fileset have been processed. Collect all of the selected files from the fileset.

Parameters:

fileset - a configured FileSet

setDebugTask

public void setDebugTask(int debugTask)

Setting this flag will print debugging information from the task itself. This is primarily useful if one wants to debug a build using the command line interface.

Parameters:

debugTask - flag to print task debugging information

setDebugNsInclude

public void setDebugNsInclude(String pattern)

Set the regular expression used to include pan namespaces for debugging.

Parameters:

pattern -

setDebugNsExclude

public void setDebugNsExclude(String pattern)

Set the regular expression used to exclude pan namespaces for debugging.

Parameters:

pattern -

setInitialData

public void setInitialData(String initialData)

Provides a dict() with a data structure that will be used to initialize all generated profiles.

Parameters:

initialData -

setOutputDir

public void setOutputDir(File outputDir)

Set the output directory for generated machine profiles and dependency files.

Parameters:

outputDir - directory for produced files

setFormats

public void setFormats(String fmts)

Defines the formatters used to generate the output files. The default value is "pan,dep".

Parameters:

fmts - comma-separated list of formatters to use

setMaxIteration

public void setMaxIteration(int maxIteration)

The pan compiler allows an iteration limit to be set to avoid infinite loops. Non-positive values indicate that no limit should be used.

Parameters:

maxIteration - maximum number of permitted iterations

setMaxRecursion

public void setMaxRecursion(int maxRecursion)

Sets the default maximum number of recursions.

Parameters:

maxRecursion -

setLogging

public void setLogging(String loggingFlags)

Enable the given types of logging. Note that NONE will take precedence over active logging flags and turn all logging off.

Parameters:

loggingFlags - a comma-separated list of logging types to enable

setLogfile

public void setLogfile(File logFile)

Set the log file to use for logging.

Parameters:

logFile - file to use for logging

setWarnings

public void setWarnings(String warnings)

Determines whether deprecation warnings are emitted and if so, whether to treat them as fatal errors.

Parameters:

warnings -

setVerbose

public void setVerbose(boolean verbose)

Flag to indicate that extra information should be written to the standard output. This gives the total number of files which will be processed and statistics coming from the compilation.

Parameters:

verbose -

setCheckDependencies

public void setCheckDependencies(boolean checkDependencies)

This any task can check machine profile dependencies to avoid processing machine profiles which are already up-to-date. Setting this flag allows the dependency checking to minimize the number of files which are built.

Parameters:

checkDependencies -

setIgnoreDependencyPattern

public void setIgnoreDependencyPattern(String ignoreDependencyPattern)

Dependencies that must be ignored when selecting the profiles to rebuild. Value must be a regular expression matching a (namespaced) template name. NOTE: Use of this option may cause incomplete builds. Use this option with extreme caution.

Parameters:

ignoreDependencyPattern - regular expression used to match namespaced template names to ignore

getBatchSize

public int getBatchSize()

setBatchSize

public void setBatchSize(int batchSize)

getNthread

public int getNthread()

setNthread

public void setNthread(int nthread)