* As this task is not a core ANT task, you will need to declare it in your
* build file. You will need to add something such as the following (the nested
* classpath element tells ANT where to find the task).
*
*
* <taskdef name="template-compiler" classname="org.bodington.ant.TemplateBuilderTask">
* <classpath>
* <pathelement location="${build}/bodserver.jar"/>
* </classpath>
* </taskdef>
*
*
*
* | Attribute | *Description | *Required | *
|---|---|---|
| srcdir | *the source directory of the (HTML) templates. | *Yes | *
| destdir | *the output directory for the template class files. | *Yes | *
| classpath | *the CLASSPATH to be used by the underlying task. | *Yes (or classpathref) | *
| classpathref | *a reference to the CLASSPATH required by the underlying task. See the * example below. | *Yes (or classpath) | *
| xmlwarn | *sets whether or not XML parsing errors and warnings in the templates are
* reported; defaults to true (see
* {@link org.xml.sax.ErrorHandler}). |
* No | *
| failonerror | *Indicates whether the build should stop if a template contains
* unrecoverable errors; defaults to true. |
* No | *
| templatedir | *Deprecated: use srcdir instead. | *Yes | *
| classesdir | *Deprecated: use destdir instead. | *Yes | *
| buildpath | *Deprecated: use classpath instead. | *Yes | *
| buildpathref | *Deprecated: use classpathref instead. | *Yes | *
FileSet and supports all
* attributes of <fileset> (dir becomes
* srcdir) as well as the nested <include>,
* <exclude> and <patternset>
* elements. If no pattern is specified, then the default is to include all
* *.html files found under the directory specified by the
* srcdir attribute.
* classpathref
* refers in the following way.
*
*
*
* <path id="template.build.path">
* <pathelement location="${java.home}/lib/tools.jar"/>
* <pathelement location="${build.bodington.classes}"/>
* <pathelement location="${tomcat-4}/common/lib/servlet.jar"/>
* </path>
*
*
*
* You can then call the task (within a target) using the following entry:
*
*
*
* <template-compiler srcdir="${build.bodington}/templates"
* destdir="${build.bodington}/WEB-INF/template_classes"
* classpathref="template.build.path"/>
*
*
*
* The following restricts the templates that get compiled, to those called
* main.html, wherever they appear in the directory tree under
* the directory specified by srcdir.
*
*
*
* <template-compiler srcdir="${build.bodington}/templates"
* destdir="${build.bodington}/WEB-INF/template_classes"
* classpathref="template.build.path">
* <include name="**/main.html" />
* </template-compiler<
*
*
*
* @author Alexis O'Connor
* @see org.xml.sax.ErrorHandler
* @see Apache ANT
* @see Jikes
*/
public class TemplateBuilderTask extends MatchingTask
{
/**
* Helper class to handle XML parsing errors and warnings.
*/
private static class ErrorReporter implements ErrorHandler
{
private Vector messages = new Vector();
private String currentFile = null;
private boolean warnings = false;
private SAXParseException fatalError = null;
public void error( SAXParseException exception ) throws SAXException
{
if (warnings)
logProblem(exception, "classpath attribute via a reference.
* @param classpathref the value to be set.
*/
public void setClasspathRef(Reference classpathref)
{
Path path = new Path(getProject());
path.setRefid(classpathref);
this.classpath = path.toString();
}
/**
* Set the value of the buildpath attribute via a reference.
* @param buildpathref the value to be set.
* @deprecated use {@link #setClasspathRef(Reference)} instead.
*/
public void setBuildpathRef(Reference buildpathref)
{
setClasspathRef(buildpathref);
}
/**
* Set the value of the classpath attribute.
* @param classpath the value to be set.
*/
public void setClasspath(String classpath)
{
this.classpath = classpath;
}
/**
* Set the value of the buildpath attribute.
* @param buildpath the value to be set.
* @deprecated use {@link #setClasspath(String)} instead.
*/
public void setBuildpath(String buildpath)
{
setClasspath(buildpath);
}
/**
* Set the value of the srcdir attribute.
* @param srcdir the value to be set.
*/
public void setSrcdir(File srcdir)
{
this.srcdir = srcdir;
}
/**
* Set the value of the templatedir attribute.
* @param templatedir the value to be set.
* @deprecated use {@link #setSrcdir(File)} instead.
*/
public void setTemplatedir(File templatedir)
{
setSrcdir(templatedir);
}
/**
* Set the value of the destdir attribute.
* @param destdir the value to be set.
*/
public void setDestdir(File destdir)
{
this.destdir = destdir;
}
/**
* Set the value of the templatedir attribute.
* @param templatedir the value to be set.
* @deprecated use {@link #setDestdir(File)} instead.
*/
public void setTemplateclasses(File templatedir)
{
setDestdir(templatedir);
}
/**
* Set the value of the xmlwarn attribute. If
* true, errors and warnings in the XML templates will be
* reported (default: true).
* @param xmlWarn the value to be set.
*/
public void setXmlWarn(boolean xmlWarn)
{
this.xmlWarn = xmlWarn;
}
/**
* Set the value of the failonerror attribute. If
* true, the build as a whole will be halted if there are any
* errors in the templates (default: true).
* @param failonerror the value to be set.
*/
public void setFailOnError(boolean failonerror)
{
this.failonerror = failonerror;
}
protected void checkParameters() throws BuildException
{
// Mandatory arguements present?
if ( classpath == null )
throw new BuildException(
"\"classpath\" property has not been set." );
if ( destdir == null )
throw new BuildException(
"\"destdir\" property has not been set." );
if ( srcdir == null )
throw new BuildException(
"\"srcdir\" property has not been set." );
// Valid parameters?
if ( !srcdir.exists() || !srcdir.isDirectory() )
throw new BuildException( "Template directory not found: "
+ srcdir.getPath() );
if ( !destdir.exists() || !destdir.isDirectory() )
throw new BuildException( "Template directory not found: "
+ destdir.getPath() );
}
protected int iterateTemplates( ErrorReporter errorReporter,
PrintWriter errorWriter, boolean compile )
{
FileSet fs = getImplicitFileSet();
if (!fs.hasPatterns() && !fs.hasSelectors())
fs.setIncludes("**/*.html");
fs.setDir(srcdir);
DirectoryScanner ds = fs.getDirectoryScanner(getProject());
String[] files = ds.getIncludedFiles();
int templateCount = 0;
int errorCount = 0;
for (int i = 0; i < files.length; i++)
{
XmlTemplate template = new XmlTemplate( srcdir,
new File(srcdir, files[i]), destdir, classpath );
template.setTimestampLatency( 0 ); // design-time so none!
templateCount += template.needsCompiling() ? 1 : 0;
if ( compile )
{
template.setErrorHandler( errorReporter );
template.setErrorWriter( errorWriter );
try
{
if ( template.compile()
!= XmlTemplate.JAVA_COMPILE_SUCCESS )
{
throw new BuildException("Error(s) compiling "
+ "template (java -> bytecode)." );
}
if (errorReporter.getFatalError() != null)
throw errorReporter.getFatalError();
}
catch ( SAXParseException e )
{
// Most likely a problem parsing the XML file:
++errorCount;
--templateCount;
System.err.println( "Error(s) found with \""
+ e.getSystemId() + "\":" );
System.err.println( e.getLineNumber() + ". "
+ e.getMessage() );
if (failonerror)
throw new BuildException(e);
}
catch ( Exception e )
{
// Most likely a problem with the XML -> java stage:
++errorCount;
--templateCount;
System.err.println( "Error(s) found with \""
+ files[i] + "\":" );
System.err.println( e.getMessage() );
if (failonerror)
throw new BuildException(e);
}
}
}
if (errorCount > 0)
System.err.println("*** WARNING: " + errorCount + " template(s) "
+ "contain unrecoverable errors. ***");
return templateCount;
}
/**
* Execute the task.
* @see org.apache.tools.ant.Task#execute()
*/
public void execute()
{
checkParameters();
// 1st time round, count how many templates needs compiling:
int templateCount = iterateTemplates( null, null, false );
String templates = (templateCount > 1) ? "templates" : "template";
if ( templateCount > 0 )
System.out.println( "Compiling " + templateCount + " " + templates
+ " to " + destdir );
else
return;
// 2nd time round, compile the templates:
ErrorReporter errorReporter = new TemplateBuilderTask.ErrorReporter();
errorReporter.setWarnings( xmlWarn );
PrintWriter errorWriter = new PrintWriter( System.err );
iterateTemplates( errorReporter, errorWriter, true );
}
}