aoqi@0: /*
aoqi@0:  * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: import java.util.*;
aoqi@0: 
aoqi@0: import javax.annotation.processing.*;
aoqi@0: import javax.lang.model.*;
aoqi@0: import javax.lang.model.element.*;
aoqi@0: 
aoqi@0: import com.sun.source.doctree.DocCommentTree;
aoqi@0: import com.sun.source.doctree.ErroneousTree;
aoqi@0: import com.sun.source.tree.ClassTree;
aoqi@0: import com.sun.source.tree.MethodTree;
aoqi@0: import com.sun.source.tree.VariableTree;
aoqi@0: import com.sun.source.util.DocTreeScanner;
aoqi@0: import com.sun.source.util.DocTrees;
aoqi@0: import com.sun.source.util.TreePath;
aoqi@0: import com.sun.source.util.TreePathScanner;
aoqi@0: import com.sun.source.util.TreeScanner;
aoqi@0: import com.sun.tools.javac.tree.DocPretty;
aoqi@0: import java.io.PrintWriter;
aoqi@0: import javax.tools.Diagnostic;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Standard annotation processor for use by examples to
aoqi@0:  * scan DocCommentTree nodes looking for ErroneousTree,
aoqi@0:  * on which to call {@code getMessage}.
aoqi@0:  */
aoqi@0: @SupportedAnnotationTypes("*")
aoqi@0: public class DocCommentProcessor extends AbstractProcessor {
aoqi@0:     @Override
aoqi@0:     public SourceVersion getSupportedSourceVersion() {
aoqi@0:         return SourceVersion.latest();
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public void init(ProcessingEnvironment pEnv) {
aoqi@0:         super.init(pEnv);
aoqi@0:         trees = DocTrees.instance(pEnv);
aoqi@0:         messager = pEnv.getMessager();
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public boolean process(Set<? extends TypeElement> annos, RoundEnvironment rEnv) {
aoqi@0:         for (Element e : rEnv.getRootElements()) {
aoqi@0:             new DocCommentScanner().scan(e);
aoqi@0:         }
aoqi@0:         return true;
aoqi@0:     }
aoqi@0: 
aoqi@0:     class DocCommentScanner extends TreePathScanner<Void,Void> {
aoqi@0:         public void scan(Element e) {
aoqi@0:             scan(trees.getPath(e), null);
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public Void visitClass(ClassTree tree, Void ignore) {
aoqi@0:             check();
aoqi@0:             return super.visitClass(tree, ignore);
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public Void visitMethod(MethodTree tree, Void ignore) {
aoqi@0:             check();
aoqi@0:             return super.visitMethod(tree, ignore);
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public Void visitVariable(VariableTree tree, Void ignore) {
aoqi@0:             check();
aoqi@0:             return super.visitVariable(tree, ignore);
aoqi@0:         }
aoqi@0: 
aoqi@0:         private void check() {
aoqi@0:             DocCommentTree dc = trees.getDocCommentTree(getCurrentPath());
aoqi@0:             if (dc == null)
aoqi@0:                 return;
aoqi@0: 
aoqi@0:             DocTreeScanner<Void, Void> s = new DocTreeScanner<Void, Void>() {
aoqi@0:                 @Override
aoqi@0:                 public Void visitErroneous(ErroneousTree tree, Void ignore) {
aoqi@0:                     messager.printMessage(Diagnostic.Kind.NOTE, tree.getDiagnostic().getMessage(null));
aoqi@0:                     return null;
aoqi@0:                 }
aoqi@0:             };
aoqi@0: 
aoqi@0:             s.scan(dc, null);
aoqi@0:         }
aoqi@0: 
aoqi@0:     }
aoqi@0: 
aoqi@0:     private DocTrees trees;
aoqi@0:     private Messager messager;
aoqi@0: }