From 0ee58d929564a833a4aae8339132f257b0380683 Mon Sep 17 00:00:00 2001 From: Terence Parr Date: Thu, 22 Jan 2015 13:28:22 -0800 Subject: [PATCH] rm JavaAnnotations --- runtime/JavaAnnotations/nb-configuration.xml | 39 -- .../javax.annotation.processing.Processor | 1 - .../org/antlr/v4/runtime/misc/NotNull.java | 72 ---- .../v4/runtime/misc/NullUsageProcessor.java | 332 ------------------ .../org/antlr/v4/runtime/misc/Nullable.java | 72 ---- 5 files changed, 516 deletions(-) delete mode 100644 runtime/JavaAnnotations/nb-configuration.xml delete mode 100644 runtime/JavaAnnotations/resources/META-INF/services/javax.annotation.processing.Processor delete mode 100644 runtime/JavaAnnotations/src/org/antlr/v4/runtime/misc/NotNull.java delete mode 100644 runtime/JavaAnnotations/src/org/antlr/v4/runtime/misc/NullUsageProcessor.java delete mode 100644 runtime/JavaAnnotations/src/org/antlr/v4/runtime/misc/Nullable.java diff --git a/runtime/JavaAnnotations/nb-configuration.xml b/runtime/JavaAnnotations/nb-configuration.xml deleted file mode 100644 index 8ecf24501..000000000 --- a/runtime/JavaAnnotations/nb-configuration.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - rule's - validator - - - - project - 4 - 4 - 4 - true - 80 - none - false - 4 - 4 - 4 - false - 80 - none - 4 - *;javax;java - test - false - - diff --git a/runtime/JavaAnnotations/resources/META-INF/services/javax.annotation.processing.Processor b/runtime/JavaAnnotations/resources/META-INF/services/javax.annotation.processing.Processor deleted file mode 100644 index 1a8dc1b9a..000000000 --- a/runtime/JavaAnnotations/resources/META-INF/services/javax.annotation.processing.Processor +++ /dev/null @@ -1 +0,0 @@ -org.antlr.v4.runtime.misc.NullUsageProcessor \ No newline at end of file diff --git a/runtime/JavaAnnotations/src/org/antlr/v4/runtime/misc/NotNull.java b/runtime/JavaAnnotations/src/org/antlr/v4/runtime/misc/NotNull.java deleted file mode 100644 index 55edba7fe..000000000 --- a/runtime/JavaAnnotations/src/org/antlr/v4/runtime/misc/NotNull.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * [The "BSD license"] - * Copyright (c) 2012 Terence Parr - * Copyright (c) 2012 Sam Harwell - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * 3. The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -package org.antlr.v4.runtime.misc; - -import java.lang.annotation.Documented; -import java.lang.annotation.ElementType; -import java.lang.annotation.Retention; -import java.lang.annotation.RetentionPolicy; -import java.lang.annotation.Target; - -/** - * This annotation marks a field, parameter, local variable, or method (return - * value) as never being {@code null}. The specific semantics implied by this - * annotation depend on the kind of element the annotation is applied to. - * - * - * - *

- * The {@link NullUsageProcessor} annotation processor validates certain usage - * scenarios for this annotation, with compile-time errors or warnings reported - * for misuse. For detailed information about the supported analysis, see the - * documentation for {@link NullUsageProcessor}.

- */ -@Documented -@Retention(RetentionPolicy.CLASS) -@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.LOCAL_VARIABLE}) -public @interface NotNull { -} diff --git a/runtime/JavaAnnotations/src/org/antlr/v4/runtime/misc/NullUsageProcessor.java b/runtime/JavaAnnotations/src/org/antlr/v4/runtime/misc/NullUsageProcessor.java deleted file mode 100644 index 4dba946d4..000000000 --- a/runtime/JavaAnnotations/src/org/antlr/v4/runtime/misc/NullUsageProcessor.java +++ /dev/null @@ -1,332 +0,0 @@ -/* - * [The "BSD license"] - * Copyright (c) 2013 Terence Parr - * Copyright (c) 2013 Sam Harwell - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * 3. The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -package org.antlr.v4.runtime.misc; - -import javax.annotation.processing.AbstractProcessor; -import javax.annotation.processing.RoundEnvironment; -import javax.annotation.processing.SupportedAnnotationTypes; -import javax.lang.model.SourceVersion; -import javax.lang.model.element.AnnotationMirror; -import javax.lang.model.element.Element; -import javax.lang.model.element.ElementKind; -import javax.lang.model.element.ExecutableElement; -import javax.lang.model.element.TypeElement; -import javax.lang.model.element.VariableElement; -import javax.lang.model.type.NoType; -import javax.lang.model.type.PrimitiveType; -import javax.lang.model.type.TypeKind; -import javax.lang.model.type.TypeMirror; -import javax.tools.Diagnostic; - -import java.util.ArrayDeque; -import java.util.ArrayList; -import java.util.Deque; -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; - -/** - * A compile-time validator for correct usage of the {@link NotNull} and - * {@link Nullable} annotations. - * - *

The validation process checks the following items.

- * - * - * - *

In the future, the validation process may be updated to check the following additional items.

- * - * - * - * @author Sam Harwell - */ -@SupportedAnnotationTypes({NullUsageProcessor.NotNullClassName, NullUsageProcessor.NullableClassName}) -public class NullUsageProcessor extends AbstractProcessor { - public static final String NotNullClassName = "org.antlr.v4.runtime.misc.NotNull"; - public static final String NullableClassName = "org.antlr.v4.runtime.misc.Nullable"; - - private TypeElement notNullType; - private TypeElement nullableType; - - public NullUsageProcessor() { - } - - @Override - public SourceVersion getSupportedSourceVersion() { - SourceVersion latestSupported = SourceVersion.latestSupported(); - - if (latestSupported.ordinal() <= 6) { - return SourceVersion.RELEASE_6; - } - else if (latestSupported.ordinal() <= 8) { - return latestSupported; - } - else { - // this annotation processor is tested through Java 8 - return SourceVersion.values()[8]; - } - } - - @Override - public boolean process(Set annotations, RoundEnvironment roundEnv) { - if (!checkClassNameConstants()) { - return true; - } - - notNullType = processingEnv.getElementUtils().getTypeElement(NotNullClassName); - nullableType = processingEnv.getElementUtils().getTypeElement(NullableClassName); - Set notNullElements = roundEnv.getElementsAnnotatedWith(notNullType); - Set nullableElements = roundEnv.getElementsAnnotatedWith(nullableType); - - Set intersection = new HashSet(notNullElements); - intersection.retainAll(nullableElements); - for (Element element : intersection) { - String error = String.format("%s cannot be annotated with both %s and %s", element.getKind().toString().replace('_', ' ').toLowerCase(), notNullType.getSimpleName(), nullableType.getSimpleName()); - processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, error, element); - } - - checkVoidMethodAnnotations(notNullElements, notNullType); - checkVoidMethodAnnotations(nullableElements, nullableType); - - checkPrimitiveTypeAnnotations(nullableElements, Diagnostic.Kind.ERROR, nullableType); - checkPrimitiveTypeAnnotations(notNullElements, Diagnostic.Kind.WARNING, notNullType); - - // method name -> method -> annotated elements of method - Map>> namedMethodMap = - new HashMap>>(); - addElementsToNamedMethodMap(notNullElements, namedMethodMap); - addElementsToNamedMethodMap(nullableElements, namedMethodMap); - - for (Map.Entry>> entry : namedMethodMap.entrySet()) { - for (Map.Entry> subentry : entry.getValue().entrySet()) { - checkOverriddenMethods(subentry.getKey()); - } - } - - return true; - } - - private boolean checkClassNameConstants() { - boolean success = checkClassNameConstant(NotNullClassName, NotNull.class); - success &= checkClassNameConstant(NullableClassName, Nullable.class); - return success; - } - - private boolean checkClassNameConstant(String className, Class clazz) { - if (className == null) { - throw new NullPointerException("className"); - } - - if (clazz == null) { - throw new NullPointerException("clazz"); - } - - if (!className.equals(clazz.getCanonicalName())) { - processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, String.format("Unable to process null usage annotations due to class name mismatch: %s != %s", className, clazz.getCanonicalName())); - return false; - } - - return true; - } - - private void checkVoidMethodAnnotations(Set elements, TypeElement annotationType) { - for (Element element : elements) { - if (element.getKind() != ElementKind.METHOD) { - continue; - } - - ExecutableElement executableElement = (ExecutableElement)element; - TypeMirror returnType = executableElement.getReturnType(); - if (returnType instanceof NoType && returnType.getKind() == TypeKind.VOID) { - String error = String.format("void method cannot be annotated with %s", annotationType.getSimpleName()); - processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, error, element, getAnnotationMirror(element, annotationType)); - } - } - } - - private void checkPrimitiveTypeAnnotations(Set elements, Diagnostic.Kind kind, TypeElement annotationType) { - for (Element element : elements) { - TypeMirror typeToCheck; - switch (element.getKind()) { - case FIELD: - case PARAMETER: - case LOCAL_VARIABLE: - // checking variable type - VariableElement variableElement = (VariableElement)element; - typeToCheck = variableElement.asType(); - break; - - case METHOD: - // checking return type - ExecutableElement executableElement = (ExecutableElement)element; - typeToCheck = executableElement.getReturnType(); - break; - - default: - continue; - } - - if (typeToCheck instanceof PrimitiveType && typeToCheck.getKind().isPrimitive()) { - String error = String.format("%s with a primitive type %s be annotated with %s", element.getKind().toString().replace('_', ' ').toLowerCase(), kind == Diagnostic.Kind.ERROR ? "cannot" : "should not", annotationType.getSimpleName()); - processingEnv.getMessager().printMessage(kind, error, element, getAnnotationMirror(element, annotationType)); - } - } - } - - private void addElementsToNamedMethodMap(Set elements, Map>> namedMethodMap) { - for (Element element : elements) { - ExecutableElement method; - switch (element.getKind()) { - case PARAMETER: - method = (ExecutableElement)element.getEnclosingElement(); - assert method.getKind() == ElementKind.METHOD; - break; - - case METHOD: - method = (ExecutableElement)element; - break; - - default: - continue; - } - - Map> annotatedMethodWithName = - namedMethodMap.get(method.getSimpleName().toString()); - if (annotatedMethodWithName == null) { - annotatedMethodWithName = new HashMap>(); - namedMethodMap.put(method.getSimpleName().toString(), annotatedMethodWithName); - } - - List annotatedElementsOfMethod = annotatedMethodWithName.get(method); - if (annotatedElementsOfMethod == null) { - annotatedElementsOfMethod = new ArrayList(); - annotatedMethodWithName.put(method, annotatedElementsOfMethod); - } - - annotatedElementsOfMethod.add(element); - } - } - - private void checkOverriddenMethods(ExecutableElement method) { - TypeElement declaringType = (TypeElement)method.getEnclosingElement(); - Set errorElements = new HashSet(); - Set warnedElements = new HashSet(); - typeLoop: - for (TypeMirror supertypeMirror : getAllSupertypes(processingEnv.getTypeUtils().getDeclaredType(declaringType))) { - for (Element element : ((TypeElement)processingEnv.getTypeUtils().asElement(supertypeMirror)).getEnclosedElements()) { - if (element instanceof ExecutableElement) { - if (processingEnv.getElementUtils().overrides(method, (ExecutableElement)element, declaringType)) { - checkOverriddenMethod(method, (ExecutableElement)element, errorElements, warnedElements); - continue typeLoop; - } - } - } - } - } - - private List getAllSupertypes(TypeMirror type) { - Set supertypes = new HashSet(); - Deque worklist = new ArrayDeque(); - worklist.add(type); - while (!worklist.isEmpty()) { - List next = processingEnv.getTypeUtils().directSupertypes(worklist.poll()); - if (supertypes.addAll(next)) { - worklist.addAll(next); - } - } - - return new ArrayList(supertypes); - } - - private void checkOverriddenMethod(ExecutableElement overrider, ExecutableElement overridden, Set errorElements, Set warnedElements) { - // check method annotation - if (isNullable(overrider) && isNotNull(overridden) && errorElements.add(overrider)) { - String error = String.format("method annotated with %s cannot override or implement a method annotated with %s", nullableType.getSimpleName(), notNullType.getSimpleName()); - processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, error, overrider, getNullableAnnotationMirror(overrider)); - } - else if (isNullable(overrider) && !(isNullable(overridden) || isNotNull(overridden)) && !errorElements.contains(overrider) && warnedElements.add(overrider)) { - String error = String.format("method annotated with %s overrides a method that is not annotated", nullableType.getSimpleName()); - processingEnv.getMessager().printMessage(Diagnostic.Kind.WARNING, error, overrider, getNullableAnnotationMirror(overrider)); - } - - List overriderParameters = overrider.getParameters(); - List overriddenParameters = overridden.getParameters(); - for (int i = 0; i < overriderParameters.size(); i++) { - if (isNotNull(overriderParameters.get(i)) && isNullable(overriddenParameters.get(i)) && errorElements.add(overriderParameters.get(i))) { - String error = String.format("parameter %s annotated with %s cannot override or implement a parameter annotated with %s", overriderParameters.get(i).getSimpleName(), notNullType.getSimpleName(), nullableType.getSimpleName()); - processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, error, overriderParameters.get(i), getNotNullAnnotationMirror(overriderParameters.get(i))); - } - else if (isNotNull(overriderParameters.get(i)) && !(isNullable(overriddenParameters.get(i)) || isNotNull(overriddenParameters.get(i))) && !errorElements.contains(overriderParameters.get(i)) && warnedElements.add(overriderParameters.get(i))) { - String error = String.format("parameter %s annotated with %s overrides a parameter that is not annotated", overriderParameters.get(i).getSimpleName(), notNullType.getSimpleName()); - processingEnv.getMessager().printMessage(Diagnostic.Kind.WARNING, error, overriderParameters.get(i), getNotNullAnnotationMirror(overriderParameters.get(i))); - } - } - } - - private boolean isNotNull(Element element) { - return getNotNullAnnotationMirror(element) != null; - } - - private boolean isNullable(Element element) { - return getNullableAnnotationMirror(element) != null; - } - - private AnnotationMirror getNotNullAnnotationMirror(Element element) { - return getAnnotationMirror(element, notNullType); - } - - private AnnotationMirror getNullableAnnotationMirror(Element element) { - return getAnnotationMirror(element, nullableType); - } - - private AnnotationMirror getAnnotationMirror(Element element, TypeElement annotationType) { - for (AnnotationMirror annotationMirror : element.getAnnotationMirrors()) { - if (annotationMirror.getAnnotationType().asElement() == annotationType) { - return annotationMirror; - } - } - - return null; - } -} diff --git a/runtime/JavaAnnotations/src/org/antlr/v4/runtime/misc/Nullable.java b/runtime/JavaAnnotations/src/org/antlr/v4/runtime/misc/Nullable.java deleted file mode 100644 index 7b9836ad2..000000000 --- a/runtime/JavaAnnotations/src/org/antlr/v4/runtime/misc/Nullable.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * [The "BSD license"] - * Copyright (c) 2012 Terence Parr - * Copyright (c) 2012 Sam Harwell - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * 3. The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -package org.antlr.v4.runtime.misc; - -import java.lang.annotation.Documented; -import java.lang.annotation.ElementType; -import java.lang.annotation.Retention; -import java.lang.annotation.RetentionPolicy; -import java.lang.annotation.Target; - -/** - * This annotation marks a field, parameter, local variable, or method (return - * value) as potentially having the value {@code null}. The specific semantics - * implied by this annotation depend on the kind of element the annotation is - * applied to. - * - *
    - *
  • Field or Local Variable: Code reading the field or local - * variable may not assume that the value is never {@code null}.
    • - *
  • Parameter: Code calling the method might pass - * {@code null} for this parameter. The documentation for the method should - * describe the behavior of the method in the event this parameter is - * {@code null}. - *
    • - *
  • Method (Return Value): Code calling the method may not - * assume that the result of the method is never {@code null}. The documentation - * for the method should describe the meaning of a {@code null} reference being - * returned. Overriding methods may optionally use the {@link NotNull} - * annotation instead of this annotation for the method, indicating that the - * overriding method (and any method which overrides it) will never return a - * {@code null} reference.
    • - *
- * - *

- * The {@link NullUsageProcessor} annotation processor validates certain usage - * scenarios for this annotation, with compile-time errors or warnings reported - * for misuse. For detailed information about the supported analysis, see the - * documentation for {@link NullUsageProcessor}.

- */ -@Documented -@Retention(RetentionPolicy.CLASS) -@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.LOCAL_VARIABLE}) -public @interface Nullable { -}