Package com.jogamp.gluegen.ant

Class GlueGenTask

  • public class GlueGenTask
extends Task

    An ANT org.apache.tools.ant.Task for using GlueGen.

    Usage:

        <gluegen src="[source C file]"
                outputrootdir="[optional output root dir]"
                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 comma separated list of literal include directories, avoiding limitations of FileSet / DirSet issues]"
                emitter="[emitter class name]"
                config="[configuration file]"
                dumpCPP="[optional boolean]"
                debug="[optional boolean]"
                logLevel="[optional string]" />
    Author:
    Rob Grzywinski rgrzywinski@yahoo.com

    • Constructor Detail

      • GlueGenTask

        public GlueGenTask()

        Create and add the VM and classname to org.apache.tools.ant.types.CommandlineJava.

    • Method Detail

      • setDebug

        public void setDebug​(boolean debug)

        Set the debug flag (optional). This is called by ANT.

      • setLogLevel

        public void setLogLevel​(String logLevel)

        Set the logLevel (optional). This is called by ANT.

      • setDumpCPP

        public void setDumpCPP​(boolean dumpCPP)

        Set the dumpCPP flag (optional). This is called by ANT.

      • setOutputRootDir

        public void setOutputRootDir​(String outputRootDir)

        Set the output root dir (optional). This is called by ANT.

        Parameters:
        outputRootDir - the optional output root dir

      • setEmitter

        public void setEmitter​(String emitter)

        Set the emitter class name. This is called by ANT.

        Parameters:
        emitter - the name of the emitter class

      • setConfig

        public void setConfig​(String configuration)

        Set the configuration file name. This is called by ANT.

        Parameters:
        configuration - the name of the configuration file

      • setSrc

        public void setSrc​(String sourceFile)

        Set the source C file that is to be parsed. This is called by ANT.

        Parameters:
        sourceFile - the name of the source file

      • setLiteralInclude

        public void setLiteralInclude​(String commaSeparatedIncludes)

        Set a literal include directories, separated with a comma. See the literalInclude javadoc for more information.

        Parameters:
        commaSeparatedIncludes - the comma separated directories to include

      • createInclude

        public PatternSet.NameEntry createInclude()

        Add an include file to the list. This is called by ANT for a nested element.

        Returns:
        org.apache.tools.ant.types.PatternSet.NameEntry

      • createIncludesFile

        public PatternSet.NameEntry createIncludesFile()

        Add an include file to the list. This is called by ANT for a nested element.

        Returns:
        org.apache.tools.ant.types.PatternSet.NameEntry

      • setIncludes

        public void setIncludes​(String includes)

        Set the set of include patterns. Patterns may be separated by a comma or a space. This is called by ANT.

        Parameters:
        includes - the string containing the include patterns

      • createExclude

        public PatternSet.NameEntry createExclude()

        Add an include file to the list that is to be exluded. This is called by ANT for a nested element.

        Returns:
        org.apache.tools.ant.types.PatternSet.NameEntry

      • createExcludesFile

        public PatternSet.NameEntry createExcludesFile()

        Add an exclude file to the list. This is called by ANT for a nested element.

        Returns:
        org.apache.tools.ant.types.PatternSet.NameEntry

      • setExcludes

        public void setExcludes​(String excludes)

        Set the set of exclude patterns. Patterns may be separated by a comma or a space. This is called by ANT.

        Parameters:
        includes - the string containing the exclude patterns

      • setIncludeRefid

        public void setIncludeRefid​(Reference reference)

        Set a org.apache.tools.ant.types.Reference to simplify adding of complex sets of files to include. This is called by ANT.

        ?
        Parameters:
        reference - a Reference to a org.apache.tools.ant.types.FileSet or org.apache.tools.ant.types.DirSet
        Throws:
        BuildException - if the specified Reference is not either a FileSet or DirSet

      • addDirset

        public void addDirset​(DirSet dirset)

        Add a nested org.apache.tools.ant.types.DirSet to specify the files to include. This is called by ANT.

        Parameters:
        dirset - the DirSet to be added

      • createClasspath

        public Path createClasspath()

        Add an optional classpath that defines the location of GlueGen and GlueGen's dependencies.

      • execute

        public void execute()
             throws BuildException

        Run the task. This involves validating the set attributes, creating the command line to be executed and finally executing the command.

        Throws:
        BuildException
        See Also:
        org.apache.tools.ant.Task#execute()