org.quattor.pan

Class CompilerOptions

java.lang.Object

org.quattor.pan.CompilerOptions

public class CompilerOptions
extends Object

Encapsulates the global options for the pan compiler. An instance of this class must be passed to the Compiler itself. Instances of this class are immutable and thread-safe.

Author:

loomis

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompilerOptions.DeprecationWarnings

Field Summary

Fields

Modifier and Type	Field and Description
File	annotationBaseDirectory Base directory of source files for generation of annotation output files.
File	annotationDirectory Directory that will contain the annotation output files.
CompilerOptions.DeprecationWarnings	deprecationWarnings Define the deprecation level for compilation: ON, OFF, or FATAL.
List<Formatter>	formatters The Formatter that will be used to format the machine profiles.
int	maxIteration The iteration limit during the compilation to avoid infinite loops.
int	maxRecursion The call depth limit which is used to prevent infinite recursion in the compiler.
int	nthread
File	outputDirectory The directory that will contain the produced machine profiles and dependency files (if any).
HashResource	rootElement
SourceRepository	sourceRepository

Constructor Summary

Constructors

Constructor and Description
CompilerOptions(Pattern debugNsInclude, Pattern debugNsExclude, int maxIteration, int maxRecursion, Set<Formatter> formatters, File outputDirectory, List<File> includeDirectories, CompilerOptions.DeprecationWarnings deprecationWarnings, File annotationDirectory, File annotationBaseDirectory, String rootElement, int nthread) Construct a CompilerOptions instance to drive a Compiler run.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkDebugEnabled(String tplName) A utility function that checks a given template name against the list of debug include and exclude patterns.
static CompilerOptions	createAnnotationOptions(File annotationDirectory, File annotationBaseDirectory) Create a CompilerOptions object that is appropriate for processing annotations
static CompilerOptions	createCheckSyntaxOptions(CompilerOptions.DeprecationWarnings deprecationWarnings) Create a CompilerOptions object that is appropriate for just doing a syntax check.
static HashResource	createRootElement(String rootElement)
static CompilerOptions.DeprecationWarnings	getDeprecationWarnings(int deprecationLevel, boolean failOnWarn)
static Set<Formatter>	getFormatters(String s)
Set<File>	resolveFileList(List<String> objectNames, Collection<File> tplFiles) Resolve a list of object template names and template Files to a set of files based on this instance's include directories.
String	toString() A verbose representation of all of the options in this instance.

Methods inherited from class java.lang.Object

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

Field Detail

maxIteration

public final int maxIteration

The iteration limit during the compilation to avoid infinite loops.

maxRecursion

public final int maxRecursion

The call depth limit which is used to prevent infinite recursion in the compiler.

formatters

public final List<Formatter> formatters

The Formatter that will be used to format the machine profiles.

outputDirectory

public final File outputDirectory

The directory that will contain the produced machine profiles and dependency files (if any).

deprecationWarnings

public final CompilerOptions.DeprecationWarnings deprecationWarnings

Define the deprecation level for compilation: ON, OFF, or FATAL.

sourceRepository

public final SourceRepository sourceRepository

annotationDirectory

public final File annotationDirectory

Directory that will contain the annotation output files.

annotationBaseDirectory

public final File annotationBaseDirectory

Base directory of source files for generation of annotation output files. These files will be generated at locations relative to the base directory in the specified output directory.

rootElement

public final HashResource rootElement

nthread

public final int nthread

Constructor Detail

CompilerOptions

public CompilerOptions(Pattern debugNsInclude,
               Pattern debugNsExclude,
               int maxIteration,
               int maxRecursion,
               Set<Formatter> formatters,
               File outputDirectory,
               List<File> includeDirectories,
               CompilerOptions.DeprecationWarnings deprecationWarnings,
               File annotationDirectory,
               File annotationBaseDirectory,
               String rootElement,
               int nthread)
                throws SyntaxException

Construct a CompilerOptions instance to drive a Compiler run. Instances of this class are immutable.

Parameters:

debugNsInclude - patterns to use to turn on debugging for matching templates

debugNsExclude - patterns to use to turn off debugging for matching templates

maxIteration - maximum number of iterations (<=0 unlimited)

maxRecursion - maximum call depth (<=0 unlimited)

formatters - formats for machine configuration files

outputDirectory - output directory for machine configuration and dependency files (cannot be null if either writeXmlEnable or writeDepEnabled is true)

includeDirectories - list of directories to check for template files; directories must exist and be absolute

deprecationWarnings - level for deprecation warnings (ON, OFF, or FATAL)

annotationDirectory - directory that will contain annotation output files

annotationBaseDirectory - base directory of source files for annotation output

rootElement - string containing description of root element to use; if null or empty string, this defaults to an empty dict

nthread - number of threads to use for each executor queue; 0 uses number of CPU cores on the machine

Throws:

SyntaxException - if the expression for the rootElement is invalid

Method Detail

getDeprecationWarnings

public static CompilerOptions.DeprecationWarnings getDeprecationWarnings(int deprecationLevel,
                                                         boolean failOnWarn)

createCheckSyntaxOptions

public static CompilerOptions createCheckSyntaxOptions(CompilerOptions.DeprecationWarnings deprecationWarnings)

Create a CompilerOptions object that is appropriate for just doing a syntax check.

Parameters:

deprecationWarnings - determine what deprecation warnings are provided

Returns:

CompilerOptions object configured for a syntax check.

createAnnotationOptions

public static CompilerOptions createAnnotationOptions(File annotationDirectory,
                                      File annotationBaseDirectory)

Create a CompilerOptions object that is appropriate for processing annotations

Parameters:

annotationDirectory - Output base directory that will contain the annotation xml files

annotationBaseDirectory - Base directory where template files are being looked up

Returns:

CompilerOptions object for processing annotations

createRootElement

public static HashResource createRootElement(String rootElement)
                                      throws SyntaxException

Throws:

SyntaxException

resolveFileList

public Set<File> resolveFileList(List<String> objectNames,
                        Collection<File> tplFiles)

Resolve a list of object template names and template Files to a set of files based on this instance's include directories.

Parameters:

objectNames - object template names to lookup

tplFiles - template Files to process

Returns:

unmodifiable set of the resolved file names

checkDebugEnabled

public boolean checkDebugEnabled(String tplName)

A utility function that checks a given template name against the list of debug include and exclude patterns.

Parameters:

tplName - name of the template to check

Returns:

flag indicating whether debugging should be activated or not

getFormatters

public static Set<Formatter> getFormatters(String s)

toString

public String toString()

A verbose representation of all of the options in this instance.

Overrides:

toString in class Object

Returns:

String representation of options