An ANT {@link org.apache.tools.ant.Task} * for using {@link net.java.games.gluegen.GlueGen}.
* *Usage:
*
<gluegen src="[source C file]"
includes="[optional directory pattern of include files to include]"
excludes="[optional directory pattern of include files to exclude]"
includeRefid="[optional FileSet or DirSet for include files]"
literalInclude="[optional hack to get around FileSet / DirSet issues with different drives]"
emitter="[emitter class name]"
config="[configuration file]" />
*
*
* @author Rob Grzywinski rgrzywinski@yahoo.com
*/
// FIXME: blow out javadoc
// NOTE: this has not been exhaustively tested
public class GlueGenTask extends Task
{
/**
* The {@link net.java.games.gluegen.GlueGen} classname.
*/ private static final String GLUE_GEN = "net.java.games.gluegen.GlueGen"; // ========================================================================= /** *The {@link org.apache.tools.ant.types.CommandlineJava} that is used * to execute {@link net.java.games.gluegen.GlueGen}.
*/ private CommandlineJava gluegenCommandline; // ========================================================================= /** *The name of the emitter class.
*/ private String emitter; /** *The configuration file name.
*/ private String configuration; /** *The name of the source C file that is to be parsed.
*/ private String sourceFile; /** *The {@link org.apache.tools.ant.types.FileSet} of includes.
*/ private FileSet includeSet = new FileSet(); /** *Because a {@link org.apache.tools.ant.types.FileSet} will include
* everything in its base directory if it is left untouched, the includeSet
* must only be added to the set of includes if it has been explicitly
* set.
The set of include sets. This allows includes to be added in multiple * fashions.
*/ // FIXME: rename to listXXXX private List setOfIncludeSets = new LinkedList(); /** *A single literal directory to include. This is to get around the
* fact that neither {@link org.apache.tools.ant.types.FileSet} nor
* {@link org.apache.tools.ant.types.DirSet} can handle multiple drives in
* a sane manner. If null then it has not been specified.
Create and add the VM and classname to {@link org.apache.tools.ant.types.CommandlineJava}.
*/ public GlueGenTask() { // create the CommandlineJava that will be used to call GlueGen gluegenCommandline = new CommandlineJava(); // set the VM and classname in the commandline gluegenCommandline.setVm(JavaEnvUtils.getJreExecutable("java")); gluegenCommandline.setClassname(GLUE_GEN); } // ========================================================================= // ANT getters and setters /** *Set the emitter class name. This is called by ANT.
* * @param emitter the name of the emitter class */ public void setEmitter(String emitter) { log( ("Setting emitter class name to: " + emitter), Project.MSG_VERBOSE); this.emitter = emitter; } /** *Set the configuration file name. This is called by ANT.
* * @param configuration the name of the configuration file */ public void setConfig(String configuration) { log( ("Setting configuration file name to: " + configuration), Project.MSG_VERBOSE); this.configuration = configuration; } /** *Set the source C file that is to be parsed. This is called by ANT.
* * @param sourceFile the name of the source file */ public void setSrc(String sourceFile) { log( ("Setting source file name to: " + sourceFile), Project.MSG_VERBOSE); this.sourceFile = sourceFile; } /** *Set a single literal include directory. See the literalInclude
* javadoc for more information.
Add an include file to the list. This is called by ANT for a nested * element.
* * @return {@link org.apache.tools.ant.types.PatternSet.NameEntry} */ public PatternSet.NameEntry createInclude() { usedIncludeSet = true; return includeSet.createInclude(); } /** *Add an include file to the list. This is called by ANT for a nested * element.
* * @return {@link org.apache.tools.ant.types.PatternSet.NameEntry} */ public PatternSet.NameEntry createIncludesFile() { usedIncludeSet = true; return includeSet.createIncludesFile(); } /** *Set the set of include patterns. Patterns may be separated by a comma * or a space. This is called by ANT.
* * @param includes the string containing the include patterns */ public void setIncludes(String includes) { usedIncludeSet = true; includeSet.setIncludes(includes); } /** *Add an include file to the list that is to be exluded. This is called * by ANT for a nested element.
* * @return {@link org.apache.tools.ant.types.PatternSet.NameEntry} */ public PatternSet.NameEntry createExclude() { usedIncludeSet = true; return includeSet.createExclude(); } /** *Add an exclude file to the list. This is called by ANT for a nested * element.
* * @return {@link org.apache.tools.ant.types.PatternSet.NameEntry} */ public PatternSet.NameEntry createExcludesFile() { usedIncludeSet = true; return includeSet.createExcludesFile(); } /** *Set the set of exclude patterns. Patterns may be separated by a comma * or a space. This is called by ANT.
* * @param includes the string containing the exclude patterns */ public void setExcludes(String excludes) { usedIncludeSet = true; includeSet.setExcludes(excludes); } /** *Set a {@link org.apache.tools.ant.types.Reference} to simplify adding * of complex sets of files to include. This is called by ANT.
? * * @param reference aReference to a {@link org.apache.tools.ant.types.FileSet}
* or {@link org.apache.tools.ant.types.DirSet}
* @throws BuildException if the specified Reference is not
* either a FileSet or DirSet
*/
public void setIncludeRefid(Reference reference)
{
// ensure that the referenced object is either a FileSet or DirSet
final Object referencedObject = reference.getReferencedObject(getProject());
if( !( (referencedObject instanceof FileSet) ||
(referencedObject instanceof DirSet)) )
{
throw new BuildException("Only FileSets or DirSets are allowed as an include refid.");
}
// add the referenced object to the set of include sets
setOfIncludeSets.add(referencedObject);
}
/**
* Add a nested {@link org.apache.tools.ant.types.DirSet} to specify * the files to include. This is called by ANT.
* * @param dirset theDirSet to be added
*/
public void addDirset(DirSet dirset)
{
setOfIncludeSets.add(dirset);
}
/**
* Add an optional classpath that defines the location of {@link net.java.games.gluegen.GlueGen}
* and GlueGen's dependencies.
Run the task. This involves validating the set attributes, creating * the command line to be executed and finally executing the command.
* * @see org.apache.tools.ant.Task#execute() */ public void execute() throws BuildException { // validate that all of the required attributes have been set validateAttributes(); // TODO: add logic to determine if the generated file needs to be // regenerated // add the attributes to the CommandlineJava addAttributes(); log(gluegenCommandline.describeCommand(), Project.MSG_VERBOSE); // execute the command and throw on error final int error = execute(gluegenCommandline.getCommandline()); if(error == 1) throw new BuildException( ("GlueGen returned: " + error), location); } /** *Ensure that the user specified all required arguments.
* * @throws BuildException if there are required arguments that are not * present or not valid */ private void validateAttributes() throws BuildException { // validate that the emitter class is set if(!isValid(emitter)) throw new BuildException("Invalid emitter class name: " + emitter); // validate that the configuration file is set if(!isValid(configuration)) throw new BuildException("Invalid configuration file name: " + configuration); // validate that the source file is set if(!isValid(sourceFile)) throw new BuildException("Invalid source file name: " + sourceFile); // CHECK: do there need to be includes to be valid? } /** *Is the specified string valid? A valid string is non-null
* and has a non-zero length.
true if the string is valid. false
* otherwise.
*/
private boolean isValid(String string)
{
// check for null
if(string == null)
return false;
// ensure that the string has a non-zero length
// NOTE: must trim() to remove leading and trailing whitespace
if(string.trim().length() < 1)
return false;
// the string is valid
return true;
}
/**
* Add all of the attributes to the command line. They have already * been validated.
*/ private void addAttributes() throws BuildException { // NOTE: GlueGen uses concatenated flag / value rather than two // separate arguments // add the emitter class name gluegenCommandline.createArgument().setValue("-E" + emitter); // add the configuration file name gluegenCommandline.createArgument().setValue("-C" + configuration); // add the includedSet to the setOfIncludeSets to simplify processing // all types of include sets ONLY if it has been set. // NOTE: see the usedIncludeSet member javadoc for more info // NOTE: references and nested DirSets have already been added to the // set of include sets if(usedIncludeSet) { includeSet.setDir(getProject().getBaseDir()); // NOTE: the base dir must be set setOfIncludeSets.add(includeSet); } // iterate over all include sets and add their directories to the // list of included directories. final List includedDirectories = new LinkedList(); for(Iterator includes=setOfIncludeSets.iterator(); includes.hasNext(); ) { // get the included set and based on its type add the directories // to includedDirectories Object include = (Object)includes.next(); final String[] directoryDirs; if(include instanceof FileSet) { final FileSet fileSet = (FileSet)include; DirectoryScanner directoryScanner = fileSet.getDirectoryScanner(getProject()); directoryDirs = directoryScanner.getIncludedDirectories(); } else if(include instanceof DirSet) { final DirSet dirSet = (DirSet)include; DirectoryScanner directoryScanner = dirSet.getDirectoryScanner(getProject()); directoryDirs = directoryScanner.getIncludedDirectories(); } else { // NOTE: this cannot occur as it is checked on setXXX() but // just to be pedantic this is here throw new BuildException("Invalid included construct."); } // add the directoryDirs to the includedDirectories // TODO: exclude any directory that is already in the list for(int i=0; i