langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/processing/JavacMessager.java
author jlahoda
Wed, 27 Aug 2014 07:44:00 +0200
changeset 26266 2d24bda701dc
parent 25874 83c19f00452c
child 28455 41245007c074
permissions -rw-r--r--
8056061: Mark implementations of public interfaces with an annotation Summary: Adding @DefinedBy annotation to mark methods that implement public API methods; annotating the methods; adding a coding rules analyzer to enforce all such methods are annotated. Reviewed-by: jjg, mcimadamore, jfranck Contributed-by: jan.lahoda@oracle.com, jonathan.gibbons@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
23810
b92eb80925f0 8038455: Use single Context for all rounds of annotation processing
jlahoda
parents: 12714
diff changeset
     2
 * Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
    23
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
package com.sun.tools.javac.processing;
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
import com.sun.tools.javac.model.JavacElements;
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
import com.sun.tools.javac.util.*;
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
    30
import com.sun.tools.javac.util.DefinedBy.Api;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
import com.sun.tools.javac.tree.JCTree;
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
import com.sun.tools.javac.tree.JCTree.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
import javax.lang.model.element.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
import javax.tools.JavaFileObject;
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
import javax.tools.Diagnostic;
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
import javax.annotation.processing.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
 * An implementation of the Messager built on top of log.
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
 *
5847
1908176fd6e3 6944312: Potential rebranding issues in openjdk/langtools repository sources
jjg
parents: 5520
diff changeset
    41
 * <p><b>This is NOT part of any supported API.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
 * If you write code that depends on this, you do so at your own risk.
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
 * This code and its internal interfaces are subject to change or
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
 * deletion without notice.</b>
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
public class JavacMessager implements Messager {
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
    Log log;
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
    JavacProcessingEnvironment processingEnv;
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
    int errorCount = 0;
6153
277c719ff46e 6403456: -Werror should work with annotation processing
jjg
parents: 5847
diff changeset
    50
    int warningCount = 0;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
    JavacMessager(Context context, JavacProcessingEnvironment processingEnv) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
        log = Log.instance(context);
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
        this.processingEnv = processingEnv;
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
    // processingEnv.getElementUtils()
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
    59
    @DefinedBy(Api.ANNOTATION_PROCESSING)
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
    public void printMessage(Diagnostic.Kind kind, CharSequence msg) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
        printMessage(kind, msg, null, null, null);
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
    64
    @DefinedBy(Api.ANNOTATION_PROCESSING)
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
    public void printMessage(Diagnostic.Kind kind, CharSequence msg,
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
                      Element e) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
        printMessage(kind, msg, e, null, null);
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
     * Prints a message of the specified kind at the location of the
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
     * annotation mirror of the annotated element.
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
     * @param kind the kind of message
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
     * @param msg  the message, or an empty string if none
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
     * @param e    the annotated element
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
     * @param a    the annotation to use as a position hint
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
     */
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
    79
    @DefinedBy(Api.ANNOTATION_PROCESSING)
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
    public void printMessage(Diagnostic.Kind kind, CharSequence msg,
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
                      Element e, AnnotationMirror a) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
        printMessage(kind, msg, e, a, null);
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
     * Prints a message of the specified kind at the location of the
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
     * annotation value inside the annotation mirror of the annotated
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
     * element.
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
     * @param kind the kind of message
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
     * @param msg  the message, or an empty string if none
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
     * @param e    the annotated element
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
     * @param a    the annotation containing the annotaiton value
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
     * @param v    the annotation value to use as a position hint
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
     */
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
    96
    @DefinedBy(Api.ANNOTATION_PROCESSING)
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
    public void printMessage(Diagnostic.Kind kind, CharSequence msg,
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
                      Element e, AnnotationMirror a, AnnotationValue v) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
        JavaFileObject oldSource = null;
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
        JavaFileObject newSource = null;
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
        JCDiagnostic.DiagnosticPosition pos = null;
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
        JavacElements elemUtils = processingEnv.getElementUtils();
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
        Pair<JCTree, JCCompilationUnit> treeTop = elemUtils.getTreeAndTopLevel(e, a, v);
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
        if (treeTop != null) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
            newSource = treeTop.snd.sourcefile;
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
            if (newSource != null) {
12714
73f1f7097c5e 7166010: (javac) JavacMessager incorrectly restores log source file
ksrini
parents: 7681
diff changeset
   107
                // save the old version and reinstate it later
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
                oldSource = log.useSource(newSource);
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
                pos = treeTop.fst.pos();
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
        try {
06bc494ca11e Initial load
duke
parents:
diff changeset
   113
            switch (kind) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   114
            case ERROR:
06bc494ca11e Initial load
duke
parents:
diff changeset
   115
                errorCount++;
06bc494ca11e Initial load
duke
parents:
diff changeset
   116
                boolean prev = log.multipleErrors;
06bc494ca11e Initial load
duke
parents:
diff changeset
   117
                log.multipleErrors = true;
06bc494ca11e Initial load
duke
parents:
diff changeset
   118
                try {
06bc494ca11e Initial load
duke
parents:
diff changeset
   119
                    log.error(pos, "proc.messager", msg.toString());
06bc494ca11e Initial load
duke
parents:
diff changeset
   120
                } finally {
06bc494ca11e Initial load
duke
parents:
diff changeset
   121
                    log.multipleErrors = prev;
06bc494ca11e Initial load
duke
parents:
diff changeset
   122
                }
06bc494ca11e Initial load
duke
parents:
diff changeset
   123
                break;
06bc494ca11e Initial load
duke
parents:
diff changeset
   124
06bc494ca11e Initial load
duke
parents:
diff changeset
   125
            case WARNING:
6153
277c719ff46e 6403456: -Werror should work with annotation processing
jjg
parents: 5847
diff changeset
   126
                warningCount++;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   127
                log.warning(pos, "proc.messager", msg.toString());
06bc494ca11e Initial load
duke
parents:
diff changeset
   128
                break;
06bc494ca11e Initial load
duke
parents:
diff changeset
   129
06bc494ca11e Initial load
duke
parents:
diff changeset
   130
            case MANDATORY_WARNING:
6153
277c719ff46e 6403456: -Werror should work with annotation processing
jjg
parents: 5847
diff changeset
   131
                warningCount++;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   132
                log.mandatoryWarning(pos, "proc.messager", msg.toString());
06bc494ca11e Initial load
duke
parents:
diff changeset
   133
                break;
06bc494ca11e Initial load
duke
parents:
diff changeset
   134
06bc494ca11e Initial load
duke
parents:
diff changeset
   135
            default:
06bc494ca11e Initial load
duke
parents:
diff changeset
   136
                log.note(pos, "proc.messager", msg.toString());
06bc494ca11e Initial load
duke
parents:
diff changeset
   137
                break;
06bc494ca11e Initial load
duke
parents:
diff changeset
   138
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
   139
        } finally {
12714
73f1f7097c5e 7166010: (javac) JavacMessager incorrectly restores log source file
ksrini
parents: 7681
diff changeset
   140
            // reinstate the saved version, only if it was saved earlier
73f1f7097c5e 7166010: (javac) JavacMessager incorrectly restores log source file
ksrini
parents: 7681
diff changeset
   141
            if (newSource != null)
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   142
                log.useSource(oldSource);
06bc494ca11e Initial load
duke
parents:
diff changeset
   143
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   144
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   145
06bc494ca11e Initial load
duke
parents:
diff changeset
   146
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   147
     * Prints an error message.
06bc494ca11e Initial load
duke
parents:
diff changeset
   148
     * Equivalent to {@code printError(null, msg)}.
06bc494ca11e Initial load
duke
parents:
diff changeset
   149
     * @param msg  the message, or an empty string if none
06bc494ca11e Initial load
duke
parents:
diff changeset
   150
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   151
    public void printError(String msg) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   152
        printMessage(Diagnostic.Kind.ERROR, msg);
06bc494ca11e Initial load
duke
parents:
diff changeset
   153
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   154
06bc494ca11e Initial load
duke
parents:
diff changeset
   155
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   156
     * Prints a warning message.
06bc494ca11e Initial load
duke
parents:
diff changeset
   157
     * Equivalent to {@code printWarning(null, msg)}.
06bc494ca11e Initial load
duke
parents:
diff changeset
   158
     * @param msg  the message, or an empty string if none
06bc494ca11e Initial load
duke
parents:
diff changeset
   159
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   160
    public void printWarning(String msg) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   161
        printMessage(Diagnostic.Kind.WARNING, msg);
06bc494ca11e Initial load
duke
parents:
diff changeset
   162
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   163
06bc494ca11e Initial load
duke
parents:
diff changeset
   164
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   165
     * Prints a notice.
06bc494ca11e Initial load
duke
parents:
diff changeset
   166
     * @param msg  the message, or an empty string if none
06bc494ca11e Initial load
duke
parents:
diff changeset
   167
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   168
    public void printNotice(String msg) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   169
        printMessage(Diagnostic.Kind.NOTE, msg);
06bc494ca11e Initial load
duke
parents:
diff changeset
   170
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   171
06bc494ca11e Initial load
duke
parents:
diff changeset
   172
    public boolean errorRaised() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   173
        return errorCount > 0;
06bc494ca11e Initial load
duke
parents:
diff changeset
   174
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   175
06bc494ca11e Initial load
duke
parents:
diff changeset
   176
    public int errorCount() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   177
        return errorCount;
06bc494ca11e Initial load
duke
parents:
diff changeset
   178
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   179
6153
277c719ff46e 6403456: -Werror should work with annotation processing
jjg
parents: 5847
diff changeset
   180
    public int warningCount() {
277c719ff46e 6403456: -Werror should work with annotation processing
jjg
parents: 5847
diff changeset
   181
        return warningCount;
277c719ff46e 6403456: -Werror should work with annotation processing
jjg
parents: 5847
diff changeset
   182
    }
277c719ff46e 6403456: -Werror should work with annotation processing
jjg
parents: 5847
diff changeset
   183
23810
b92eb80925f0 8038455: Use single Context for all rounds of annotation processing
jlahoda
parents: 12714
diff changeset
   184
    public void newRound() {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   185
        errorCount = 0;
06bc494ca11e Initial load
duke
parents:
diff changeset
   186
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   187
06bc494ca11e Initial load
duke
parents:
diff changeset
   188
    public String toString() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   189
        return "javac Messager";
06bc494ca11e Initial load
duke
parents:
diff changeset
   190
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   191
}