org.gradle.api.plugins.antlr.internal.AntlrExecuter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 6.8 API redistribution.
/*
* Copyright 2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.api.plugins.antlr.internal;
import com.google.common.collect.Lists;
import org.gradle.api.GradleException;
import org.gradle.api.plugins.antlr.internal.antlr2.GenerationPlan;
import org.gradle.api.plugins.antlr.internal.antlr2.GenerationPlanBuilder;
import org.gradle.api.plugins.antlr.internal.antlr2.MetadataExtracter;
import org.gradle.api.plugins.antlr.internal.antlr2.XRef;
import org.gradle.internal.UncheckedException;
import org.gradle.internal.os.OperatingSystem;
import org.gradle.internal.reflect.JavaMethod;
import org.gradle.internal.reflect.JavaReflectionUtil;
import org.gradle.process.internal.worker.RequestHandler;
import org.gradle.util.RelativePathUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.File;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.util.List;
public class AntlrExecuter implements RequestHandler {
private static final Logger LOGGER = LoggerFactory.getLogger(AntlrExecuter.class);
@Override
public AntlrResult run(AntlrSpec spec) {
AntlrTool antlrTool = new Antlr4Tool();
if (antlrTool.available()) {
LOGGER.info("Processing with ANTLR 4");
return antlrTool.process(spec);
}
antlrTool = new Antlr3Tool();
if (antlrTool.available()) {
LOGGER.info("Processing with ANTLR 3");
return antlrTool.process(spec);
}
antlrTool = new Antlr2Tool();
if (antlrTool.available()) {
LOGGER.info("Processing with ANTLR 2");
return antlrTool.process(spec);
}
throw new IllegalStateException("No Antlr implementation available");
}
private static class Antlr3Tool extends AntlrTool {
@Override
int invoke(List arguments, File inputDirectory) throws ClassNotFoundException {
final Object backedObject = loadTool("org.antlr.Tool", null);
String[] argArray = arguments.toArray(new String[0]);
if (inputDirectory != null) {
JavaMethod.of(backedObject, Void.class, "setInputDirectory", String.class).invoke(backedObject, inputDirectory.getAbsolutePath());
JavaMethod.of(backedObject, Void.class, "setForceRelativeOutput", boolean.class).invoke(backedObject, true);
}
JavaMethod.of(backedObject, Void.class, "processArgs", String[].class).invoke(backedObject, new Object[]{argArray});
JavaMethod.of(backedObject, Void.class, "process").invoke(backedObject);
return JavaMethod.of(backedObject, Integer.class, "getNumErrors").invoke(backedObject);
}
@Override
public boolean available() {
try {
loadTool("org.antlr.Tool", null);
} catch (ClassNotFoundException cnf) {
return false;
}
return true;
}
}
private abstract static class AntlrTool {
/**
* Utility method to create an instance of the Tool class.
*
* @throws ClassNotFoundException if class was not on the runtime classpath.
*/
static Object loadTool(String className, String[] args) throws ClassNotFoundException {
try {
Class toolClass = Class.forName(className); // ok to use caller classloader
if (args == null) {
return JavaReflectionUtil.newInstance(toolClass);
} else {
Constructor constructor = toolClass.getConstructor(String[].class);
return constructor.newInstance(new Object[]{args});
}
}catch(ClassNotFoundException cnf){
throw cnf;
} catch (InvocationTargetException e) {
throw new GradleException("Failed to load ANTLR", e.getCause());
} catch (Exception e) {
throw new GradleException("Failed to load ANTLR", e);
}
}
public final AntlrResult process(AntlrSpec spec) {
try {
return doProcess(spec);
} catch (ClassNotFoundException e) {
//this shouldn't happen if you call check availability with #available first
throw new GradleException("Cannot process antlr sources", e);
}
}
/**
* process used for antlr3/4
*/
public AntlrResult doProcess(AntlrSpec spec) throws ClassNotFoundException {
int numErrors = 0;
if (spec.getInputDirectories().size() == 0) {
// we have not root source folder information for the grammar files,
// so we don't force relativeOutput as we can't calculate it.
// This results in flat generated sources in the output directory
numErrors += invoke(spec.asArgumentsWithFiles(), null);
} else {
boolean onWindows = OperatingSystem.current().isWindows();
for (File inputDirectory : spec.getInputDirectories()) {
final List arguments = spec.getArguments();
arguments.add("-o");
arguments.add(spec.getOutputDirectory().getAbsolutePath());
for (File grammarFile : spec.getGrammarFiles()) {
String relativeGrammarFilePath = RelativePathUtil.relativePath(inputDirectory, grammarFile);
if (onWindows) {
relativeGrammarFilePath = relativeGrammarFilePath.replace('/', File.separatorChar);
}
arguments.add(relativeGrammarFilePath);
}
numErrors += invoke(arguments, inputDirectory);
}
}
return new AntlrResult(numErrors);
}
abstract int invoke(List arguments, File inputDirectory) throws ClassNotFoundException;
public abstract boolean available();
protected static String[] toArray(List strings) {
return strings.toArray(new String[0]);
}
}
static class Antlr4Tool extends AntlrTool {
@Override
int invoke(List arguments, File inputDirectory) throws ClassNotFoundException {
final Object backedObject = loadTool("org.antlr.v4.Tool", toArray(arguments));
if (inputDirectory != null) {
setField(backedObject, "inputDirectory", inputDirectory);
}
JavaMethod.of(backedObject, Void.class, "processGrammarsOnCommandLine").invoke(backedObject);
return JavaMethod.of(backedObject, Integer.class, "getNumErrors").invoke(backedObject);
}
private static void setField(Object object, String fieldName, File value) {
try {
Field field = object.getClass().getField(fieldName);
field.set(object, value);
} catch (NoSuchFieldException | IllegalAccessException e) {
throw UncheckedException.throwAsUncheckedException(e);
}
}
@Override
public boolean available() {
try {
loadTool("org.antlr.v4.Tool", null);
} catch (ClassNotFoundException cnf) {
return false;
}
return true;
}
}
private static class Antlr2Tool extends AntlrTool {
@Override
public AntlrResult doProcess(AntlrSpec spec) throws ClassNotFoundException {
XRef xref = new MetadataExtracter().extractMetadata(spec.getGrammarFiles());
List generationPlans = new GenerationPlanBuilder(spec.getOutputDirectory()).buildGenerationPlans(xref);
for (GenerationPlan generationPlan : generationPlans) {
List generationPlanArguments = Lists.newArrayList(spec.getArguments());
generationPlanArguments.add("-o");
generationPlanArguments.add(generationPlan.getGenerationDirectory().getAbsolutePath());
generationPlanArguments.add(generationPlan.getSource().getAbsolutePath());
try {
invoke(generationPlanArguments, null);
} catch (RuntimeException e) {
if (e.getMessage().equals("ANTLR Panic: Exiting due to errors.")) {
return new AntlrResult(-1, e);
}
throw e;
}
}
return new AntlrResult(0); // ANTLR 2 always returning 0
}
/**
* inputDirectory is not used in antlr2
* */
@Override
int invoke(List arguments, File inputDirectory) throws ClassNotFoundException {
final Object backedAntlrTool = loadTool("antlr.Tool", null);
JavaMethod.of(backedAntlrTool, Integer.class, "doEverything", String[].class).invoke(backedAntlrTool, new Object[]{toArray(arguments)});
return 0;
}
@Override
public boolean available() {
try {
loadTool("antlr.Tool", null);
} catch (ClassNotFoundException cnf) {
return false;
}
return true;
}
}
}