An ANT {@link org.apache.tools.ant.Task} * for using {@link com.jogamp.gluegen.opengl.BuildStaticGLInfo}.
* *Usage:
*
<staticglgen package="[generated files package]"
headers="[file pattern of GL headers]"
outputdir="[directory to output the generated files]" />
*
*
* @author Rob Grzywinski rgrzywinski@yahoo.com
*/
// FIXME: blow out javadoc
public class StaticGLGenTask extends Task
{
/**
* The {@link com.jogamp.gluegen.opengl.BuildStaticGLInfo} classname.
*/ private static final String GL_GEN = "com.jogamp.gluegen.opengl.BuildStaticGLInfo"; // ========================================================================= /** *The {@link org.apache.tools.ant.types.CommandlineJava} that is used * to execute {@link com.jogamp.gluegen.opengl.BuildStaticGLInfo}.
*/ private CommandlineJava glgenCommandline; // ========================================================================= /** *The package name for the generated files.
*/ private String packageName; /** *The output directory.
*/ private String outputDirectory; /** *The {@link org.apache.tools.ant.types.FileSet} of GL headers.
*/ private FileSet headerSet = new FileSet(); // ========================================================================= /** *Create and add the VM and classname to {@link org.apache.tools.ant.types.CommandlineJava}.
*/ public StaticGLGenTask() { // create the CommandlineJava that will be used to call BuildStaticGLInfo glgenCommandline = new CommandlineJava(); // set the VM and classname in the commandline glgenCommandline.setVm(JavaEnvUtils.getJreExecutable("java")); glgenCommandline.setClassname(GL_GEN); } // ========================================================================= // ANT getters and setters /** *Set the package name for the generated files. This is called by ANT.
* * @param packageName the name of the package for the generated files */ public void setPackage(String packageName) { log( ("Setting package name to: " + packageName), Project.MSG_VERBOSE); this.packageName = packageName; } /** *Set the output directory. This is called by ANT.
* * @param directory the output directory */ public void setOutputDir(String directory) { log( ("Setting output directory to: " + directory), Project.MSG_VERBOSE); this.outputDirectory = directory; } /** *Add a header 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 createHeader() { return headerSet.createInclude(); } /** *Add a header 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 createHeadersFile() { return headerSet.createIncludesFile(); } /** *Set the set of header patterns. Patterns may be separated by a comma * or a space. This is called by ANT.
* * @param headers the string containing the header patterns */ public void setHeaders(String headers) { headerSet.setIncludes(headers); } /** *Add an optional classpath that defines the location of {@link com.jogamp.gluegen.opengl.BuildStaticGLInfo}
* and BuildStaticGLInfo'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(glgenCommandline.describeCommand(), Project.MSG_VERBOSE); // execute the command and throw on error final int error = execute(glgenCommandline.getCommandline()); if(error == 1) throw new BuildException( ("BuildStaticGLInfo 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 package name is set if(!isValid(packageName)) throw new BuildException("Invalid package name: " + packageName); // validate that the output directory is set // TODO: switch to file and ensure that it exists if(!isValid(outputDirectory)) throw new BuildException("Invalid output directory name: " + outputDirectory); // TODO: validate that there are headers set } /** *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() { // add the package name glgenCommandline.createArgument().setValue(packageName); // add the output directory name glgenCommandline.createArgument().setValue(outputDirectory); // add the header -files- from the FileSet headerSet.setDir(getProject().getBaseDir()); DirectoryScanner directoryScanner = headerSet.getDirectoryScanner(getProject()); String[] directoryFiles = directoryScanner.getIncludedFiles(); for(int i=0; i