Checker.java revision 553
0N/A/*
553N/A * Copyright (c) 2006, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
0N/A * published by the Free Software Foundation.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
553N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
553N/A * or visit www.oracle.com if you need additional information or have any
553N/A * questions.
0N/A */
0N/A
0N/Aimport java.io.*;
0N/Aimport java.util.*;
0N/Aimport javax.lang.model.util.*;
0N/Aimport javax.tools.*;
0N/Aimport com.sun.tools.javac.api.*;
0N/Aimport com.sun.source.tree.*;
0N/Aimport com.sun.source.util.*;
0N/Aimport com.sun.tools.javac.tree.JCTree;
0N/Aimport com.sun.tools.javac.tree.JCTree.*;
0N/Aimport com.sun.tools.javac.util.Position;
0N/A
0N/A/*
0N/A * Abstract class to help check the scopes in a parsed source file.
0N/A * -- parse source file
0N/A * -- scan trees looking for string literals
0N/A * -- check the scope at that point against the string, using
0N/A * boolean check(Scope s, String ref)
0N/A */
0N/Aabstract class Checker {
0N/A // parse the source file and call check(scope, string) for each string literal found
0N/A void check(String... fileNames) throws IOException {
0N/A File testSrc = new File(System.getProperty("test.src"));
0N/A
0N/A DiagnosticListener<JavaFileObject> dl = new DiagnosticListener<JavaFileObject>() {
0N/A public void report(Diagnostic d) {
0N/A System.err.println(d);
0N/A if (d.getKind() == Diagnostic.Kind.ERROR)
0N/A errors = true;
0N/A new Exception().printStackTrace();
0N/A }
0N/A };
0N/A
0N/A JavacTool tool = JavacTool.create();
0N/A StandardJavaFileManager fm = tool.getStandardFileManager(dl, null, null);
0N/A Iterable<? extends JavaFileObject> files =
0N/A fm.getJavaFileObjectsFromFiles(getFiles(testSrc, fileNames));
0N/A task = tool.getTask(null, fm, dl, null, null, files);
0N/A Iterable<? extends CompilationUnitTree> units = task.parse();
0N/A
0N/A if (errors)
0N/A throw new AssertionError("errors occurred creating trees");
0N/A
0N/A ScopeScanner s = new ScopeScanner();
0N/A for (CompilationUnitTree unit: units) {
0N/A TreePath p = new TreePath(unit);
0N/A s.scan(p, getTrees());
0N/A }
0N/A task = null;
0N/A
0N/A if (errors)
0N/A throw new AssertionError("errors occurred checking scopes");
0N/A }
0N/A
0N/A // default impl: split ref at ";" and call checkLocal(scope, ref_segment) on scope and its enclosing scopes
0N/A protected boolean check(Scope s, String ref) {
0N/A // System.err.println("check scope: " + s);
0N/A // System.err.println("check ref: " + ref);
0N/A if (s == null && (ref == null || ref.trim().length() == 0))
0N/A return true;
0N/A
0N/A if (s == null) {
0N/A error(s, ref, "scope missing");
0N/A return false;
0N/A }
0N/A
0N/A if (ref == null) {
0N/A error(s, ref, "scope unexpected");
0N/A return false;
0N/A }
0N/A
0N/A String local;
0N/A String encl;
0N/A int semi = ref.indexOf(';');
0N/A if (semi == -1) {
0N/A local = ref;
0N/A encl = null;
0N/A } else {
0N/A local = ref.substring(0, semi);
0N/A encl = ref.substring(semi + 1);
0N/A }
0N/A
0N/A return checkLocal(s, local.trim())
0N/A & check(s.getEnclosingScope(), encl);
0N/A }
0N/A
0N/A // override if using default check(Scope,String)
0N/A boolean checkLocal(Scope s, String ref) {
0N/A throw new IllegalStateException();
0N/A }
0N/A
0N/A void error(Scope s, String ref, String msg) {
0N/A System.err.println("Error: " + msg);
0N/A System.err.println("Scope: " + (s == null ? null : asList(s.getLocalElements())));
0N/A System.err.println("Expect: " + ref);
0N/A System.err.println("javac: " + (s == null ? null : ((JavacScope) s).getEnv()));
0N/A errors = true;
0N/A }
0N/A
0N/A protected Elements getElements() {
0N/A return task.getElements();
0N/A }
0N/A
0N/A protected Trees getTrees() {
0N/A return Trees.instance(task);
0N/A }
0N/A
0N/A boolean errors = false;
0N/A protected JavacTask task;
0N/A
0N/A // scan a parse tree, and for every string literal found, call check(scope, string) with
0N/A // the string value at the scope at that point
0N/A class ScopeScanner extends TreePathScanner<Boolean,Trees> {
0N/A public Boolean visitLiteral(LiteralTree tree, Trees trees) {
0N/A TreePath path = getCurrentPath();
0N/A CompilationUnitTree unit = path.getCompilationUnit();
0N/A Position.LineMap lineMap = ((JCCompilationUnit)unit).lineMap;
0N/A// long line = lineMap.getLineNumber(((JCTree)tree).pos/*trees.getSourcePositions().getStartPosition(tree)*/);
0N/A// System.err.println(line + ": " + abbrev(tree));
0N/A Scope s = trees.getScope(path);
0N/A if (tree.getKind() == Tree.Kind.STRING_LITERAL)
0N/A check(s, tree.getValue().toString().trim());
0N/A return null;
0N/A }
0N/A
0N/A private String abbrev(Tree tree) {
0N/A int max = 48;
0N/A String s = tree.toString().replaceAll("[ \n]+", " ");
0N/A return (s.length() < max ? s : s.substring(0, max-3) + "...");
0N/A }
0N/A }
0N/A
0N/A // prefix filenames with a directory
0N/A static Iterable<File> getFiles(File dir, String... names) {
0N/A List<File> files = new ArrayList<File>(names.length);
0N/A for (String name: names)
0N/A files.add(new File(dir, name));
0N/A return files;
0N/A }
0N/A
0N/A static private <T> List<T> asList(Iterable<T> iter) {
0N/A List<T> l = new ArrayList<T>();
0N/A for (T t: iter)
0N/A l.add(t);
0N/A return l;
0N/A }
0N/A}