src.main.lombok.ast.app.Main Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lombok-ast Show documentation
This is a very small fork of lombok.ast as some Android tools needed a few modifications. The normal repository for lombok.ast is here https://github.com/rzwitserloot/lombok.ast and our changes for 0.2.3 are in this pull request: https://github.com/rzwitserloot/lombok.ast/pull/8
The newest version!
/*
 * Copyright (C) 2011 The Project Lombok Authors.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package lombok.ast.app;

import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import javax.tools.SimpleJavaFileObject;

import lombok.AccessLevel;
import lombok.Data;
import lombok.RequiredArgsConstructor;
import lombok.val;
import lombok.ast.Node;
import lombok.ast.Version;
import lombok.ast.ecj.EcjTreeBuilder;
import lombok.ast.ecj.EcjTreeConverter;
import lombok.ast.ecj.EcjTreeOperations;
import lombok.ast.ecj.EcjTreePrinter;
import lombok.ast.grammar.ParseProblem;
import lombok.ast.grammar.Source;
import lombok.ast.javac.JcTreeBuilder;
import lombok.ast.javac.JcTreeConverter;
import lombok.ast.javac.JcTreePrinter;
import lombok.ast.printer.HtmlFormatter;
import lombok.ast.printer.SourceFormatter;
import lombok.ast.printer.SourcePrinter;
import lombok.ast.printer.StructureFormatter;
import lombok.ast.printer.TextFormatter;

import org.eclipse.jdt.internal.compiler.CompilationResult;
import org.eclipse.jdt.internal.compiler.DefaultErrorHandlingPolicies;
import org.eclipse.jdt.internal.compiler.ast.ASTNode;
import org.eclipse.jdt.internal.compiler.ast.CompilationUnitDeclaration;
import org.eclipse.jdt.internal.compiler.batch.CompilationUnit;
import org.eclipse.jdt.internal.compiler.classfmt.ClassFileConstants;
import org.eclipse.jdt.internal.compiler.impl.CompilerOptions;
import org.eclipse.jdt.internal.compiler.parser.Parser;
import org.eclipse.jdt.internal.compiler.problem.DefaultProblemFactory;
import org.eclipse.jdt.internal.compiler.problem.ProblemReporter;
import org.parboiled.google.collect.Lists;

import com.google.common.base.Joiner;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.io.Files;
import com.sun.tools.javac.main.JavaCompiler;
import com.sun.tools.javac.main.OptionName;
import com.sun.tools.javac.tree.JCTree;
import com.sun.tools.javac.tree.JCTree.JCCompilationUnit;
import com.sun.tools.javac.util.Context;
import com.sun.tools.javac.util.Options;
import com.zwitserloot.cmdreader.CmdReader;
import com.zwitserloot.cmdreader.Description;
import com.zwitserloot.cmdreader.FullName;
import com.zwitserloot.cmdreader.InvalidCommandLineException;
import com.zwitserloot.cmdreader.Mandatory;
import com.zwitserloot.cmdreader.Sequential;
import com.zwitserloot.cmdreader.Shorthand;

@RequiredArgsConstructor(access = AccessLevel.PRIVATE)
public class Main {
	private static class CmdArgs {
		@Shorthand("v")
		@Description("Print the name of each file as it is being converted.")
		private boolean verbose;
		
		@Description("Show version number and exit.")
		private boolean version;
		
		@Shorthand("h")
		@Description("Show this help text and exit.")
		private boolean help;
		
		@Shorthand("e")
		@Description("Sets the encoding of your source files. Defaults to the system default charset. Example: \"UTF-8\"")
		private String encoding;
		
		@Shorthand("p")
		@Description("Print converted code to standard output instead of saving it in target directory")
		private boolean print;
		
		@Shorthand("d")
		@Description("Directory to save converted files to")
		@Mandatory(onlyIfNot={"print", "help", "version"})
		private String target;
		
		@Shorthand("i")
		@Description("Save the result of each (intermediate) operation as 'text' representation. Do not use any text/source/html operations if you use this option.")
		@FullName("save-intermediate")
		private boolean saveIntermediate;
		
		@Shorthand("z")
		@Description("Normalize the way various different nodes are printed when using the structural printer ('text'), when these nodes are semantically identical")
		private boolean normalize;
		
		@Shorthand("n")
		@Description("Omit printing the start and end position of nodes for structural output")
		@FullName("no-positions")
		private boolean noPositions;
		
		@Mandatory(onlyIfNot={"help", "version"})
		@Sequential
		@Description("Operations to apply to each source file. Comma-separated (no spaces). Valid options: ecj/javac/lombok first to decide how the file is parsed initially, " +
				"then any number of further ecj/javac/lombok keywords to convert ASTs, and finally text/source/html.")
		private String program;
		
		@Description("Files to convert. Provide either a file, or a directory. If you use a directory, all files in it (recursive) are converted")
		@Mandatory(onlyIfNot={"help", "version"})
		@Sequential
		private List input = new ArrayList();
	}
	
	public static void main(String[] rawArgs) throws Exception {
		CmdArgs args;
		CmdReader reader = CmdReader.of(CmdArgs.class);
		
		try {
			args = reader.make(rawArgs);
		} catch (InvalidCommandLineException e) {
			System.err.println(e.getMessage());
			System.err.println(reader.generateCommandLineHelp("java -jar lombok.ast.jar"));
			System.exit(1);
			return;
		}
		
		if (args.help) {
			System.out.println("lombok.ast java AST tool " + Version.getVersion());
			System.out.println(reader.generateCommandLineHelp("java -jar lombok.ast.jar"));
			System.exit(0);
			return;
		}
		
		if (args.version) {
			System.out.println(Version.getVersion());
			System.exit(0);
			return;
		}
		
		try {
			Charset charset = args.encoding == null ? Charset.defaultCharset() : Charset.forName(args.encoding);
			Main main = new Main(charset, args.verbose, args.normalize, !args.noPositions, args.saveIntermediate);
			main.compile(args.program);
			if (!args.print) {
				File targetDir = new File(args.target);
				if (!targetDir.exists()) targetDir.mkdirs();
				if (!targetDir.isDirectory()) {
					System.err.printf("%s is not a directory or cannot be created\n", targetDir.getCanonicalPath());
					System.exit(1);
					return;
				}
				main.setOutputDir(targetDir);
			}
			
			for (String input : args.input) {
				main.addToQueue(input);
			}
			
			main.go();
		} catch (IllegalArgumentException e) {
			System.err.println(e.getMessage());
			System.exit(1);
			return;
		}
	}
	
	private void go() throws IOException {
		for (Plan p : files) {
			process(p.getFile(), outDir, p.getRelativeName());
		}
		if (errors > 0) {
			System.err.printf("%d errors\n", errors);
		}
		System.exit(errors > 0 ? 2 : 0);
	}
	
	private void setOutputDir(File f) {
		this.outDir = f;
	}
	
	private void addToQueue(String item) throws IOException {
		addToQueue0(new File(item), "");
	}
	
	private void addToQueue0(File f, String pathSoFar) throws IOException {
		pathSoFar += (pathSoFar.isEmpty() ? "" : "/") + f.getName();
		if (f.isFile()) {
			if (f.getName().endsWith(".java")) {
				files.add(new Plan(f, pathSoFar));
			}
		} else if (f.isDirectory()) {
			for (File inner : f.listFiles()) {
				addToQueue0(inner, pathSoFar);
			}
		} else {
			throw new IllegalArgumentException("Unknown file: " + f.getCanonicalPath());
		}
	}
	
	@Data
	private static class Plan {
		final File file;
		final String relativeName;
	}
	
	private void process(File in, File outDir, String relativeName) throws IOException {
		File out = outDir == null ? null : new File(outDir, relativeName);
		
		if (verbose && !saveIntermediate) {
			System.out.printf("Processing: %s to %s\n", in.getCanonicalPath(), out == null ? "sysout" : out.getCanonicalPath());
		}
		
		Source source = new Source(Files.toString(in, charset), in.getCanonicalPath());
		Object transfer = null;
		String chain = "/";
		
		try {
			for (Operation programElem : program) {
				transfer = programElem.process(source, transfer);
				if (saveIntermediate) {
					if (!"/".equals(chain)) {
						chain += "-";
					}
					chain += getDestinationType(programElem);
					File intermediate = new File(outDir.getCanonicalPath() + chain + "/" + relativeName);
					intermediate.getParentFile().mkdirs();
					
					if (verbose) {
						System.out.printf("Processing: %s to %s\n", in.getCanonicalPath(), intermediate.getCanonicalPath());
					}
					
					if (TO_JAVAC.contains(programElem)) {
						Files.write(javacToText.process(source, (JCCompilationUnit) transfer).toString(), intermediate, charset);
					}
					else if (TO_ECJ.contains(programElem)) {
						Files.write(ecjToText.process(source, (CompilationUnitDeclaration) transfer).toString(), intermediate, charset);
					}
					else if (TO_LOMBOK.contains(programElem)) {
						Files.write(lombokToText.process(source, (Node) transfer).toString(), intermediate, charset);
					}
				}
			}
			
			if (out == null) {
				System.out.println(transfer);
			} else if (!saveIntermediate) {
				out.getParentFile().mkdirs();
				Files.write(transfer.toString(), out, charset);
			}
		} catch (ConversionProblem cp) {
			System.err.printf("Can't convert: %s due to %s\n", in.getCanonicalPath(), cp.getMessage());
			errors++;
		} catch (RuntimeException e) {
			System.err.printf("Error during convert: %s\n%s\n", in.getCanonicalPath(), printEx(e));
			errors++;
		}
	}
	
	private String getDestinationType(Operation operation) {
		if (TO_LOMBOK.contains(operation)) return "lombok";
		else if (TO_ECJ.contains(operation)) return "ecj";
		else if (TO_JAVAC.contains(operation)) return "javac";
		else if (TO_TEXT.contains(operation)) return "text";
		else return null;
	}
	
	private static String printEx(Throwable t) {
		val sb = new StringBuilder();
		sb.append(t.toString());
		sb.append("\n");
		Joiner.on("\n").appendTo(sb, t.getStackTrace());
		return sb.toString();
	}
	
	private void compile(String program) {
		this.program = compile0(program);
	}
	
	@Data
	private static final class ChainElement {
		private final String type, subtype;
		
		@Override public String toString() {
			return subtype.length() == 0 ? type : String.format("%s:%s", type, subtype);
		}
		
		public boolean hasSubtype() {
			return subtype.length() > 0;
		}
	}
	
	private List toChainElements(String program) {
		val out = new ArrayList();
		for (String part : program.split("\\s*,\\s*")) {
			int idx = part.indexOf(':');
			if (idx == -1) out.add(new ChainElement(part.trim(), ""));
			else out.add(new ChainElement(part.substring(0, idx).trim(), part.substring(idx+1).trim()));
		}
		return out;
	}
	
	@SuppressWarnings("unchecked")
	private void addNormalization(List> list, ChainElement element) {
		if (!element.hasSubtype()) return;
		Operation operation = NORMALIZATION.get(element.toString());
		if (operation == null) {
			List normalizations = Lists.newArrayList();
			for (String n : NORMALIZATION.keySet()) if (n.startsWith(element.getType() + ":")) normalizations.add(n);
			throw new IllegalArgumentException(String.format(
					"Illegal normalization operation: %s. Valid normalizations: %s", element, Joiner.on(",").join(normalizations)));
		}
		list.add((Operation) operation);
	}
	
	@SuppressWarnings("unchecked")
	private List> compile0(String program) {
		List parts = toChainElements(program);
		List> out = Lists.newArrayList();
		if (parts.isEmpty()) throw new IllegalArgumentException("No operations");
		Operation initialOp = CONVERSIONS.get("_," + parts.get(0).getType());
		if (initialOp == null) {
			List initialOps = Lists.newArrayList();
			for (String key : CONVERSIONS.keySet()) {
				if (key.startsWith("_,")) initialOps.add(key.substring(2));
			}
			throw new IllegalArgumentException(String.format(
					"Illegal initial operation: %s\nLegal initial operations: %s",
					parts.get(0), Joiner.on(",").join(initialOps)));
		}
		
		out.add((Operation) initialOp);
		addNormalization(out, parts.get(0));
		for (int i = 0; i < parts.size() - 1; i++) {
			String convKey = String.format("%s,%s", parts.get(i).getType(), parts.get(i + 1).getType());
			Operation convOp = CONVERSIONS.get(convKey);
			if (convOp == null) {
				List convOps = Lists.newArrayList();
				for (String key : CONVERSIONS.keySet()) {
					if (key.startsWith(parts.get(i).getType() + ",")) convOps.add(key.substring(parts.get(i).getType().length() + 1));
				}
				throw new IllegalArgumentException(String.format(
						"Illegal conversion operation: %s\nLegal conversion operations from %s: %s",
						convKey, parts.get(i), Joiner.on(",").join(convOps)));
			}
			out.add((Operation) convOp);
			addNormalization(out, parts.get(i + 1));
		}
		
		String lastPart = parts.get(parts.size() - 1).getType();
		if (!LEGAL_FINAL.contains(lastPart) && !saveIntermediate) {
			throw new IllegalArgumentException(String.format(
					"Illegal final operation: %s\nLegal final operations: %s",
					lastPart, Joiner.on(",").join(LEGAL_FINAL)));
		}
		
		return out;
	}
	
	private final Charset charset;
	private List> program;
	private final boolean verbose;
	private final boolean normalize;
	private final boolean positions;
	private final boolean saveIntermediate;
	private int errors;
	private File outDir = null;
	private final List files = Lists.newArrayList();
	
	interface Operation {
		B process(Source source, A in) throws ConversionProblem;
	}
	
	static class ConversionProblem extends Exception {
		ConversionProblem(String message) {
			super(message);
		}
	}
	
	protected CompilerOptions ecjCompilerOptions() {
		CompilerOptions options = new CompilerOptions();
		options.complianceLevel = ClassFileConstants.JDK1_6;
		options.sourceLevel = ClassFileConstants.JDK1_6;
		options.targetJDK = ClassFileConstants.JDK1_6;
		options.parseLiteralExpressionsAsConstants = true;
		return options;
	}
	
	private final Operation parseWithLombok = new Operation() {
		@Override public Node process(Source in, Void irrelevant) throws ConversionProblem {
			List nodes = in.getNodes();
			List problems = in.getProblems();
			if (problems.size() > 0) throw new ConversionProblem(String.format("Can't read file %s due to parse error: %s", in.getName(), problems.get(0)));
			if (nodes.size() == 1) return nodes.get(0);
			if (nodes.size() == 0) throw new ConversionProblem("No nodes parsed by lombok.ast");
			throw new ConversionProblem("More than 1 node parsed by lombok.ast");
		}
	};
	
	private final Operation parseWithEcj = new Operation() {
		@Override public ASTNode process(Source in, Void irrelevant) throws ConversionProblem {
			CompilerOptions compilerOptions = ecjCompilerOptions();
			Parser parser = new Parser(new ProblemReporter(
					DefaultErrorHandlingPolicies.proceedWithAllProblems(),
					compilerOptions,
					new DefaultProblemFactory()
				), compilerOptions.parseLiteralExpressionsAsConstants);
			parser.javadocParser.checkDocComment = true;
			CompilationUnit sourceUnit = new CompilationUnit(in.getRawInput().toCharArray(), in.getName(), charset.name());
			CompilationResult compilationResult = new CompilationResult(sourceUnit, 0, 0, 0);
			CompilationUnitDeclaration cud = parser.parse(sourceUnit, compilationResult);
			
			if (cud.hasErrors()) {
				throw new ConversionProblem(String.format("Can't read file %s due to parse error: %s", in.getName(), compilationResult.getErrors()[0]));
			}
			
			return cud;
		}
	};
	
	private final Operation parseWithJavac = new Operation() {
		@Override public JCCompilationUnit process(Source in, Void irrelevant) throws ConversionProblem {
			Context context = new Context();
			
			Options.instance(context).put(OptionName.ENCODING, charset.name());
			
			JavaCompiler compiler = new JavaCompiler(context);
			compiler.genEndPos = true;
			compiler.keepComments = true;
			
			JCCompilationUnit cu = compiler.parse(new ContentBasedJavaFileObject(in.getName(), in.getRawInput()));
			
			return cu;
		}
	};
	
	private final Operation javacToLombok = new Operation() {
		@Override public Node process(Source source, JCCompilationUnit in) throws ConversionProblem {
			JcTreeConverter converter = new JcTreeConverter();
			converter.visit(in);
			return converter.getResult();
		}
	};
	
	private final Operation ecjToLombok = new Operation() {
		@Override public Node process(Source source, CompilationUnitDeclaration in) throws ConversionProblem {
			EcjTreeConverter converter = new EcjTreeConverter();
			converter.visit(source.getRawInput(), in);
			return converter.get();
		}
	};
	
	private final Operation lombokToJavac = new Operation() {
		@Override public JCCompilationUnit process(Source source, Node in) throws ConversionProblem {
			JcTreeBuilder builder = new JcTreeBuilder();
			builder.visit(in);
			JCTree out = builder.get();
			if (out instanceof JCCompilationUnit) return (JCCompilationUnit) out;
			throw new ConversionProblem("result from lombokToJavac is not JCCompilationUnit");
		}
	};
	
	private final Operation lombokToEcj = new Operation() {
		@Override public CompilationUnitDeclaration process(Source source, Node in) throws ConversionProblem {
			EcjTreeBuilder builder = new EcjTreeBuilder(source, ecjCompilerOptions());
			builder.visit(in);
			ASTNode out = builder.get();
			if (out instanceof CompilationUnitDeclaration) return (CompilationUnitDeclaration) out;
			throw new ConversionProblem("result from lombokToEcj is not CompilationUnitDeclaration");
		}
	};
	
	private final Operation lombokToHtml = new Operation() {
		@Override public String process(Source source, Node in) throws ConversionProblem {
			SourceFormatter formatter = new HtmlFormatter(source.getRawInput());
			in.accept(new SourcePrinter(formatter));
			
			for (ParseProblem x : source.getProblems()) {
				formatter.addError(x.getPosition().getStart(), x.getPosition().getEnd(), x.getMessage());
			}
			
			return formatter.finish();
		}
	};
	
	private final Operation lombokToSource = new Operation() {
		@Override public String process(Source source, Node in) throws ConversionProblem {
			SourceFormatter formatter = new TextFormatter();
			in.accept(new SourcePrinter(formatter));
			
			for (ParseProblem x : source.getProblems()) {
				formatter.addError(x.getPosition().getStart(), x.getPosition().getEnd(), x.getMessage());
			}
			
			return formatter.finish();
		}
	};
	
	private final Operation lombokToText = new Operation() {
		@Override public String process(Source source, Node in) throws ConversionProblem {
			SourceFormatter formatter = positions ? StructureFormatter.formatterWithPositions() : StructureFormatter.formatterWithoutPositions();
			in.accept(new SourcePrinter(formatter));
			
			for (ParseProblem x : source.getProblems()) {
				formatter.addError(x.getPosition().getStart(), x.getPosition().getEnd(), x.getMessage());
			}
			
			return formatter.finish();
		}
	};
	
	private final Operation javacToText = new Operation() {
		@Override public String process(Source source, JCCompilationUnit in) throws ConversionProblem {
			JcTreePrinter printer = positions ? JcTreePrinter.printerWithPositions() : JcTreePrinter.printerWithoutPositions();
			printer.visit(in);
			return printer.toString();
		}
	};
	
	private final Operation ecjToText = new Operation() {
		@Override public String process(Source source, CompilationUnitDeclaration in) throws ConversionProblem {
			if (normalize) {
				return positions ? EcjTreeOperations.convertToString(in) : EcjTreeOperations.convertToStringNoPositions(in);
			} else {
				EcjTreePrinter printer = positions ? EcjTreePrinter.printerWithPositions() : EcjTreePrinter.printerWithoutPositions();
				printer.visit(in);
				return printer.getContent();
			}
		}
	};
	
	private final Map> CONVERSIONS = ImmutableMap.>builder()
			.put("_,ecj", parseWithEcj)
			.put("_,lombok", parseWithLombok)
			.put("_,javac", parseWithJavac)
			.put("javac,lombok", javacToLombok)
			.put("lombok,javac", lombokToJavac)
			.put("ecj,lombok", ecjToLombok)
			.put("lombok,ecj", lombokToEcj)
			.put("lombok,text", lombokToText)
			.put("lombok,source", lombokToSource)
			.put("lombok,html", lombokToHtml)
			.put("ecj,text", ecjToText)
			.put("javac,text", javacToText)
			.build();
	
	private final Map> NORMALIZATION = ImmutableMap.>builder()
			.put("ecj:ecjbugs", EcjBugsNormalization.ecjToEcjBugsNormalizedEcj)
			.put("lombok:ecjbugs", EcjBugsNormalization.lombokToEcjBugsNormalizedLombok)
			.build();
	
	private final List LEGAL_FINAL = ImmutableList.of("source", "html", "text");
	
	private final List> TO_LOMBOK = ImmutableList.of(ecjToLombok, javacToLombok, parseWithLombok);
	private final List> TO_ECJ = ImmutableList.of(lombokToEcj, parseWithEcj);
	private final List> TO_JAVAC = ImmutableList.of(lombokToJavac, parseWithJavac);
	private final List> TO_TEXT = ImmutableList.of(ecjToText, javacToText, lombokToText);
	
	private static class ContentBasedJavaFileObject extends SimpleJavaFileObject {
		private final String content;
		
		public ContentBasedJavaFileObject(String name, String content) {
			super(new File(name).toURI(), Kind.SOURCE);
			this.content = content;
		}
		
		@Override
		public CharSequence getCharContent(boolean ignoreEncodingErrors) throws IOException {
			return content;
		}
	}
}