langtools/test/tools/javac/plugin/showtype/ShowTypePlugin.java
author jjg
Mon, 19 Nov 2012 11:38:49 -0800
changeset 14548 aa687b312c97
child 14954 f8eea2960bcb
permissions -rw-r--r--
8001098: Provide a simple light-weight "plug-in" mechanism for javac Reviewed-by: mcimadamore
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
14548
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
     1
/*
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
     2
 * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
     4
 *
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
     7
 * published by the Free Software Foundation.
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
     8
 *
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    13
 * accompanied this code).
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    14
 *
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    18
 *
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    21
 * questions.
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    22
 */
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    23
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    24
import com.sun.source.tree.CompilationUnitTree;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    25
import com.sun.source.tree.IdentifierTree;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    26
import com.sun.source.tree.MemberSelectTree;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    27
import com.sun.source.tree.Tree;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    28
import com.sun.source.util.JavacTask;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    29
import com.sun.source.util.Plugin;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    30
import com.sun.source.util.TaskEvent;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    31
import com.sun.source.util.TaskListener;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    32
import com.sun.source.util.TreePathScanner;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    33
import com.sun.source.util.Trees;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    34
import java.util.regex.Pattern;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    35
import javax.lang.model.type.TypeMirror;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    36
import javax.tools.Diagnostic.Kind;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    37
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    38
public class ShowTypePlugin implements Plugin {
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    39
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    40
    public String getName() {
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    41
        return "showtype";
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    42
    }
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    43
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    44
    public void call(JavacTask task, String... args) {
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    45
        Pattern pattern = null;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    46
        if (args.length == 1)
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    47
            pattern = Pattern.compile(args[0]);
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    48
        task.addTaskListener(new PostAnalyzeTaskListener(task, pattern));
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    49
    }
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    50
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    51
    private static class PostAnalyzeTaskListener implements TaskListener {
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    52
        private final ShowTypeTreeVisitor visitor;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    53
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    54
        PostAnalyzeTaskListener(JavacTask task, Pattern pattern) {
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    55
            visitor = new ShowTypeTreeVisitor(task, pattern);
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    56
        }
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    57
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    58
        @Override
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    59
        public void started(TaskEvent taskEvent) { }
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    60
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    61
        @Override
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    62
        public void finished(TaskEvent taskEvent) {
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    63
            if (taskEvent.getKind().equals(TaskEvent.Kind.ANALYZE)) {
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    64
                CompilationUnitTree compilationUnit = taskEvent.getCompilationUnit();
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    65
                visitor.scan(compilationUnit, null);
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    66
            }
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    67
        }
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    68
    }
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    69
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    70
    private static class ShowTypeTreeVisitor extends TreePathScanner<Void, Void> {
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    71
        private final Trees trees;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    72
        private final Pattern pattern;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    73
        private CompilationUnitTree currCompUnit;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    74
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    75
        ShowTypeTreeVisitor(JavacTask task, Pattern pattern) {
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    76
            trees = Trees.instance(task);
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    77
            this.pattern = pattern;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    78
        }
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    79
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    80
        @Override
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    81
        public Void visitCompilationUnit(CompilationUnitTree tree, Void ignore) {
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    82
            currCompUnit = tree;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    83
            return super.visitCompilationUnit(tree, ignore);
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    84
        }
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    85
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    86
        @Override
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    87
        public Void visitIdentifier(IdentifierTree tree, Void ignore) {
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    88
            show(tree, tree.getName());
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    89
            return super.visitIdentifier(tree, ignore);
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    90
        }
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    91
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    92
        @Override
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    93
        public Void visitMemberSelect(MemberSelectTree tree, Void ignore) {
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    94
            show(tree, tree.getIdentifier());
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    95
            return super.visitMemberSelect(tree, ignore);
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    96
        }
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    97
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    98
        void show(Tree tree, CharSequence name) {
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
    99
            if (pattern == null || pattern.matcher(name).matches()) {
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
   100
                TypeMirror type = trees.getTypeMirror(getCurrentPath());
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
   101
                trees.printMessage(Kind.NOTE, "type is " + type, tree, currCompUnit);
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
   102
            }
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
   103
        }
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
   104
    }
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
   105
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents:
diff changeset
   106
}