JavaCC and JJTree optional tasks for use with the javacc suite of tools.

Submitted by:	Michael Saunders <michael@amtec.com>


git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@267933 13f79535-47bb-0310-9956-ffa450edef68

src/main/org/apache/tools/ant/taskdefs/defaults.properties

@@ -55,6 +55,8 @@ mparse=org.apache.tools.ant.taskdefs.optional.metamata.MParse
 junit=org.apache.tools.ant.taskdefs.optional.junit.JUnitTask
 cab=org.apache.tools.ant.taskdefs.optional.Cab
 ftp=org.apache.tools.ant.taskdefs.optional.FTP
+javacc=org.apache.tools.ant.taskdefs.optional.javacc.JavaCC
+jjtree=org.apache.tools.ant.taskdefs.optional.javacc.JJTree
 
 # deprecated ant tasks (kept for back compatibility)
 javadoc2=org.apache.tools.ant.taskdefs.Javadoc

src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java

@@ -0,0 +1,222 @@
+/*
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2000 The Apache Software Foundation.  All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ *
+ * 3. The end-user documentation included with the redistribution, if
+ *    any, must include the following acknowlegement:
+ *       "This product includes software developed by the
+ *        Apache Software Foundation (http://www.apache.org/)."
+ *    Alternately, this acknowlegement may appear in the software itself,
+ *    if and wherever such third-party acknowlegements normally appear.
+ *
+ * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
+ *    Foundation" must not be used to endorse or promote products derived
+ *    from this software without prior written permission. For written
+ *    permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache"
+ *    nor may "Apache" appear in their names without prior written
+ *    permission of the Apache Group.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation.  For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ */
+
+package org.apache.tools.ant.taskdefs.optional.javacc;
+
+import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.Project;
+import org.apache.tools.ant.Task;
+import org.apache.tools.ant.taskdefs.Execute;
+import org.apache.tools.ant.taskdefs.LogStreamHandler;
+import org.apache.tools.ant.types.Commandline;
+import org.apache.tools.ant.types.CommandlineJava;
+import org.apache.tools.ant.types.Path;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.Hashtable;
+import java.util.Enumeration;
+
+/**
+ * Taskdef for the JJTree compiler compiler.
+ *
+ * @author thomas.haas@softwired-inc.com
+ * @author Michael Saunders <a href="mailto:michael@amtec.com">michael@amtec.com</a>
+ */
+public class JJTree extends Task {
+
+    // keys to optional attributes
+    private static final String BUILD_NODE_FILES  = "BUILD_NODE_FILES";
+    private static final String MULTI             = "MULTI";
+    private static final String NODE_DEFAULT_VOID = "NODE_DEFAULT_VOID";
+    private static final String NODE_FACTORY      = "NODE_FACTORY";
+    private static final String NODE_SCOPE_HOOK   = "NODE_SCOPE_HOOK";
+    private static final String NODE_USES_PARSER  = "NODE_USES_PARSER";
+    private static final String STATIC            = "STATIC";
+    private static final String VISITOR           = "VISITOR";
+
+    private static final String NODE_PACKAGE      = "NODE_PACKAGE";
+    private static final String VISITOR_EXCEPTION = "VISITOR_EXCEPTION";
+    private static final String NODE_PREFIX       = "NODE_PREFIX";
+
+    private final Hashtable optionalAttrs = new Hashtable();
+
+    // required attributes
+    private File outputDirectory = null;
+    private File target          = null;
+    private File javaccHome      = null;
+
+    private CommandlineJava cmdl = new CommandlineJava();
+
+
+    public void setBuildnodefiles(boolean buildNodeFiles) {
+        optionalAttrs.put(BUILD_NODE_FILES, new Boolean(buildNodeFiles));
+    }
+
+    public void setMulti(boolean multi) {
+        optionalAttrs.put(MULTI, new Boolean(multi));
+    }
+
+    public void setNodedefaultvoid(boolean nodeDefaultVoid) {
+        optionalAttrs.put(NODE_DEFAULT_VOID, new Boolean(nodeDefaultVoid));
+    }
+
+    public void setNodefactory(boolean nodeFactory) {
+        optionalAttrs.put(NODE_FACTORY, new Boolean(nodeFactory));
+    }
+
+    public void setNodescopehook(boolean nodeScopeHook) {
+        optionalAttrs.put(NODE_SCOPE_HOOK, new Boolean(nodeScopeHook));
+    }
+
+    public void setNodeusesparser(boolean nodeUsesParser) {
+        optionalAttrs.put(NODE_USES_PARSER, new Boolean(nodeUsesParser));
+    }
+
+    public void setStatic(boolean staticParser) {
+        optionalAttrs.put(STATIC, new Boolean(staticParser));
+    }
+
+    public void setVisitor(boolean visitor) {
+        optionalAttrs.put(VISITOR, new Boolean(visitor));
+    }
+
+    public void setNodepackage(String nodePackage) {
+        optionalAttrs.put(NODE_PACKAGE, new String(nodePackage));
+    }
+
+    public void setVisitorException(String visitorException) {
+        optionalAttrs.put(VISITOR_EXCEPTION, new String(visitorException));
+    }
+
+    public void setNodeprefix(String nodePrefix) {
+        optionalAttrs.put(NODE_PREFIX, new String(nodePrefix));
+    }
+
+    public void setOutputdirectory(File outputDirectory) {
+        this.outputDirectory = outputDirectory;
+    }
+
+    public void setTarget(File target) {
+        this.target = target;
+    }
+
+    public void setJavacchome(File javaccHome) {
+        this.javaccHome = javaccHome;
+    }
+
+    public JJTree() {
+        cmdl.setVm("java");
+        cmdl.setClassname("COM.sun.labs.jjtree.Main");
+    }
+
+    public void execute() throws BuildException {
+
+        // load command line with optional attributes
+        Enumeration iter = optionalAttrs.keys();
+        while (iter.hasMoreElements()) {
+            String name  = (String)iter.nextElement();
+            Object value = optionalAttrs.get(name);
+            cmdl.createArgument().setValue("-"+name+":"+value.toString());
+        }
+
+        // load command line with required attributes
+        if (outputDirectory != null) {
+            if (!outputDirectory.isDirectory()) {
+                throw new BuildException("Outputdir not a directory.");
+            }
+            cmdl.createArgument().setValue(
+                "-OUTPUT_DIRECTORY:"+outputDirectory.getAbsolutePath());
+        }
+
+        if (target == null || !target.isFile()) {
+            throw new BuildException("Invalid target: " + target);
+        }
+        final File javaFile = new File(
+            target.toString().substring(0, target.toString().indexOf(".jjt")) + ".jj");
+        if (javaFile.exists() && target.lastModified() < javaFile.lastModified()) {
+            project.log("Target is already built - skipping (" + target + ")");
+            return;
+        }
+        cmdl.createArgument().setValue(target.getAbsolutePath());
+
+        if (javaccHome == null || !javaccHome.isDirectory()) {
+            throw new BuildException("Javacchome not set.");
+        }
+        final Path classpath = cmdl.createClasspath(project);
+        classpath.createPathElement().setPath(javaccHome.getAbsolutePath() +
+                                                  "/JavaCC.zip");
+
+        final Commandline.Argument arg = cmdl.createVmArgument();
+        arg.setValue("-mx140M");
+        arg.setValue("-Dinstall.root="+javaccHome.getAbsolutePath());
+
+        final Execute process =
+            new Execute(new LogStreamHandler(this,
+                                             Project.MSG_INFO,
+                                             Project.MSG_INFO),
+                        null);
+        log(cmdl.toString(), Project.MSG_VERBOSE);
+        process.setCommandline(cmdl.getCommandline());
+
+        try {
+            if (process.execute() != 0) {
+                throw new BuildException("JJTree failed.");
+            }
+        }
+        catch (IOException e) {
+            throw new BuildException("Failed to launch JJTree: " + e);
+        }
+    }
+}

src/main/org/apache/tools/ant/taskdefs/optional/javacc/JavaCC.java

@@ -0,0 +1,267 @@
+/*
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2000 The Apache Software Foundation.  All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ *
+ * 3. The end-user documentation included with the redistribution, if
+ *    any, must include the following acknowlegement:
+ *       "This product includes software developed by the
+ *        Apache Software Foundation (http://www.apache.org/)."
+ *    Alternately, this acknowlegement may appear in the software itself,
+ *    if and wherever such third-party acknowlegements normally appear.
+ *
+ * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
+ *    Foundation" must not be used to endorse or promote products derived
+ *    from this software without prior written permission. For written
+ *    permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache"
+ *    nor may "Apache" appear in their names without prior written
+ *    permission of the Apache Group.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation.  For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ */
+
+package org.apache.tools.ant.taskdefs.optional.javacc;
+
+import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.Project;
+import org.apache.tools.ant.Task;
+import org.apache.tools.ant.taskdefs.Execute;
+import org.apache.tools.ant.taskdefs.LogStreamHandler;
+import org.apache.tools.ant.types.Commandline;
+import org.apache.tools.ant.types.CommandlineJava;
+import org.apache.tools.ant.types.Path;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.Hashtable;
+import java.util.Enumeration;
+
+/**
+ * Taskdef for the JavaCC compiler compiler.
+ *
+ * @author thomas.haas@softwired-inc.com
+ * @author Michael Saunders <a href="mailto:michael@amtec.com">michael@amtec.com</a>
+ */
+public class JavaCC extends Task {
+
+    // keys to optional attributes
+    private static final String LOOKAHEAD              = "LOOKAHEAD";
+    private static final String CHOICE_AMBIGUITY_CHECK = "CHOICE_AMBIGUITY_CHECK";
+    private static final String OTHER_AMBIGUITY_CHECK  = "OTHER_AMBIGUITY_CHECK";
+
+    private static final String STATIC                 = "STATIC";
+    private static final String DEBUG_PARSER           = "DEBUG_PARSER";
+    private static final String DEBUG_LOOKAHEAD        = "DEBUG_LOOKAHEAD";
+    private static final String DEBUG_TOKEN_MANAGER    = "DEBUG_TOKEN_MANAGER";
+    private static final String OPTIMIZE_TOKEN_MANAGER = "OPTIMIZE_TOKEN_MANAGER";
+    private static final String ERROR_REPORTING        = "ERROR_REPORTING";
+    private static final String JAVA_UNICODE_ESCAPE    = "JAVA_UNICODE_ESCAPE";
+    private static final String UNICODE_INPUT          = "UNICODE_INPUT";
+    private static final String IGNORE_CASE            = "IGNORE_CASE";
+    private static final String COMMON_TOKEN_ACTION    = "COMMON_TOKEN_ACTION";
+    private static final String USER_TOKEN_MANAGER     = "USER_TOKEN_MANAGER";
+    private static final String USER_CHAR_STREAM       = "USER_CHAR_STREAM";
+    private static final String BUILD_PARSER           = "BUILD_PARSER";
+    private static final String BUILD_TOKEN_MANAGER    = "BUILD_TOKEN_MANAGER";
+    private static final String SANITY_CHECK           = "SANITY_CHECK";
+    private static final String FORCE_LA_CHECK         = "FORCE_LA_CHECK";
+    private static final String CACHE_TOKENS           = "CACHE_TOKENS";
+
+    private final Hashtable optionalAttrs = new Hashtable();
+
+    // required attributes
+    private File outputDirectory = null;
+    private File target          = null;
+    private File javaccHome      = null;
+
+    private CommandlineJava cmdl = new CommandlineJava();
+
+
+    public void setLookahead(int lookahead) {
+        optionalAttrs.put(LOOKAHEAD, new Integer(lookahead));
+    }
+
+    public void setChoiceambiguitycheck(int choiceAmbiguityCheck) {
+        optionalAttrs.put(CHOICE_AMBIGUITY_CHECK, new Integer(choiceAmbiguityCheck));
+    }
+
+    public void setOtherambiguityCheck(int otherAmbiguityCheck) {
+        optionalAttrs.put(OTHER_AMBIGUITY_CHECK, new Integer(otherAmbiguityCheck));
+    }
+
+    public void setStatic(boolean staticParser) {
+        optionalAttrs.put(STATIC, new Boolean(staticParser));
+    }
+
+    public void setDebugparser(boolean debugParser) {
+        optionalAttrs.put(DEBUG_PARSER, new Boolean(debugParser));
+    }
+
+    public void setDebuglookahead(boolean debugLookahead) {
+        optionalAttrs.put(DEBUG_LOOKAHEAD, new Boolean(debugLookahead));
+    }
+
+    public void setDebugtokenmanager(boolean debugTokenManager) {
+        optionalAttrs.put(DEBUG_TOKEN_MANAGER, new Boolean(debugTokenManager));
+    }
+
+    public void setOptimizetokenmanager(boolean optimizeTokenManager) {
+        optionalAttrs.put(OPTIMIZE_TOKEN_MANAGER, new Boolean(optimizeTokenManager));
+    }
+
+    public void setErrorreporting(boolean errorReporting) {
+        optionalAttrs.put(ERROR_REPORTING, new Boolean(errorReporting));
+    }
+
+    public void setJavaunicodeescape(boolean javaUnicodeEscape) {
+        optionalAttrs.put(JAVA_UNICODE_ESCAPE, new Boolean(javaUnicodeEscape));
+    }
+
+    public void setUnicodeinput(boolean unicodeInput) {
+        optionalAttrs.put(UNICODE_INPUT, new Boolean(unicodeInput));
+    }
+
+    public void setIgnorecase(boolean ignoreCase) {
+        optionalAttrs.put(IGNORE_CASE, new Boolean(ignoreCase));
+    }
+
+    public void setCommontokenaction(boolean commonTokenAction) {
+        optionalAttrs.put(COMMON_TOKEN_ACTION, new Boolean(commonTokenAction));
+    }
+
+    public void setUsertokenmanager(boolean userTokenManager) {
+        optionalAttrs.put(USER_TOKEN_MANAGER, new Boolean(userTokenManager));
+    }
+
+    public void setUsercharstream(boolean userCharStream) {
+        optionalAttrs.put(USER_CHAR_STREAM, new Boolean(userCharStream));
+    }
+
+    public void setBuildparser(boolean buildParser) {
+        optionalAttrs.put(BUILD_PARSER, new Boolean(buildParser));
+    }
+
+    public void setBuildtokenmanager(boolean buildTokenManager) {
+        optionalAttrs.put(BUILD_TOKEN_MANAGER, new Boolean(buildTokenManager));
+    }
+
+    public void setSanitycheck(boolean sanityCheck) {
+        optionalAttrs.put(SANITY_CHECK, new Boolean(sanityCheck));
+    }
+
+    public void setForcelacheck(boolean forceLACheck) {
+        optionalAttrs.put(FORCE_LA_CHECK, new Boolean(forceLACheck));
+    }
+
+    public void setCachetokens(boolean cacheTokens) {
+        optionalAttrs.put(CACHE_TOKENS, new Boolean(cacheTokens));
+    }
+
+    public void setOutputdirectory(File outputDirectory) {
+        this.outputDirectory = outputDirectory;
+    }
+
+    public void setTarget(File target) {
+        this.target = target;
+    }
+
+    public void setJavacchome(File javaccHome) {
+        this.javaccHome = javaccHome;
+    }
+
+    public JavaCC() {
+        cmdl.setVm("java");
+        cmdl.setClassname("COM.sun.labs.javacc.Main");
+    }
+
+    public void execute() throws BuildException {
+
+        // load command line with optional attributes
+        Enumeration iter = optionalAttrs.keys();
+        while (iter.hasMoreElements()) {
+            String name  = (String)iter.nextElement();
+            Object value = optionalAttrs.get(name);
+            cmdl.createArgument().setValue("-"+name+":"+value.toString());
+        }
+
+        // load command line with required attributes
+        if (outputDirectory != null) {
+            if (!outputDirectory.isDirectory()) {
+                throw new BuildException("Outputdir not a directory.");
+            }
+            cmdl.createArgument().setValue(
+                "-OUTPUT_DIRECTORY:"+outputDirectory.getAbsolutePath());
+        }
+
+        if (target == null || !target.isFile()) {
+            throw new BuildException("Invalid target: " + target);
+        }
+        final File javaFile = new File(
+            target.toString().substring(0, target.toString().indexOf(".jj")) + ".java");
+        if (javaFile.exists() && target.lastModified() < javaFile.lastModified()) {
+            project.log("Target is already built - skipping (" + target + ")");
+            return;
+        }
+        cmdl.createArgument().setValue(target.getAbsolutePath());
+
+        if (javaccHome == null || !javaccHome.isDirectory()) {
+            throw new BuildException("Javacchome not set.");
+        }
+        final Path classpath = cmdl.createClasspath(project);
+        classpath.createPathElement().setPath(javaccHome.getAbsolutePath() +
+                                                  "/JavaCC.zip");
+
+        final Commandline.Argument arg = cmdl.createVmArgument();
+        arg.setValue("-mx140M");
+        arg.setValue("-Dinstall.root="+javaccHome.getAbsolutePath());
+
+        final Execute process =
+            new Execute(new LogStreamHandler(this,
+                                             Project.MSG_INFO,
+                                             Project.MSG_INFO),
+                        null);
+        log(cmdl.toString(), Project.MSG_VERBOSE);
+        process.setCommandline(cmdl.getCommandline());
+
+        try {
+            if (process.execute() != 0) {
+                throw new BuildException("JavaCC failed.");
+            }
+        }
+        catch (IOException e) {
+            throw new BuildException("Failed to launch JavaCC: " + e);
+        }
+    }
+}