forked from jasder/antlr
Terence Parr
commit
97b5d77976
|
|
@ -209,7 +209,7 @@
|
||||||
<path refid="cp.antlr3"/>
|
<path refid="cp.antlr3"/>
|
||||||
<pathelement location="${basedir}/runtime/Java/lib/org.abego.treelayout.core.jar"/>
|
<pathelement location="${basedir}/runtime/Java/lib/org.abego.treelayout.core.jar"/>
|
||||||
</classpath>
|
</classpath>
|
||||||
<src path="${basedir}/tool/src:${basedir}/runtime/Java/src:${build.antlr3.dir}:${build.antlr4.dir}"/>
|
<src path="${basedir}/tool/src:${basedir}/runtime/JavaAnnotations/src:${basedir}/runtime/Java/src:${build.antlr3.dir}:${build.antlr4.dir}"/>
|
||||||
</javac>
|
</javac>
|
||||||
</target>
|
</target>
|
||||||
|
|
||||||
|
|
@ -246,6 +246,12 @@
|
||||||
<include name="**/*.st"/>
|
<include name="**/*.st"/>
|
||||||
<include name="**/*.stg"/>
|
<include name="**/*.stg"/>
|
||||||
</fileset>
|
</fileset>
|
||||||
|
<fileset dir="${basedir}/runtime/JavaAnnotations/resources/">
|
||||||
|
<include name="**/*.Processor"/>
|
||||||
|
</fileset>
|
||||||
|
<fileset dir="${basedir}/runtime/JavaAnnotations/src/">
|
||||||
|
<include name="**/*.java"/>
|
||||||
|
</fileset>
|
||||||
<fileset dir="${basedir}/runtime/Java/src/">
|
<fileset dir="${basedir}/runtime/Java/src/">
|
||||||
<include name="**/*.java"/>
|
<include name="**/*.java"/>
|
||||||
<include name="**/*.g"/>
|
<include name="**/*.g"/>
|
||||||
|
|
|
||||||
1
pom.xml
1
pom.xml
|
|
@ -61,6 +61,7 @@
|
||||||
|
|
||||||
<modules>
|
<modules>
|
||||||
<module>runtime/Java</module>
|
<module>runtime/Java</module>
|
||||||
|
<module>runtime/JavaAnnotations</module>
|
||||||
<module>tool</module>
|
<module>tool</module>
|
||||||
<module>antlr4-maven-plugin</module>
|
<module>antlr4-maven-plugin</module>
|
||||||
</modules>
|
</modules>
|
||||||
|
|
|
||||||
|
|
@ -27,6 +27,13 @@
|
||||||
<version>1.0.1</version>
|
<version>1.0.1</version>
|
||||||
<scope>compile</scope>
|
<scope>compile</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.antlr</groupId>
|
||||||
|
<artifactId>antlr4-annotations</artifactId>
|
||||||
|
<version>${project.version}</version>
|
||||||
|
<scope>compile</scope>
|
||||||
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
|
|
||||||
<profiles>
|
<profiles>
|
||||||
|
|
|
||||||
|
|
@ -1,37 +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;
|
|
||||||
|
|
||||||
@java.lang.annotation.Documented
|
|
||||||
@java.lang.annotation.Retention(java.lang.annotation.RetentionPolicy.CLASS)
|
|
||||||
@java.lang.annotation.Target({java.lang.annotation.ElementType.FIELD, java.lang.annotation.ElementType.METHOD, java.lang.annotation.ElementType.PARAMETER, java.lang.annotation.ElementType.LOCAL_VARIABLE})
|
|
||||||
public @interface NotNull {
|
|
||||||
}
|
|
||||||
|
|
@ -1,37 +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;
|
|
||||||
|
|
||||||
@java.lang.annotation.Documented
|
|
||||||
@java.lang.annotation.Retention(java.lang.annotation.RetentionPolicy.CLASS)
|
|
||||||
@java.lang.annotation.Target({java.lang.annotation.ElementType.FIELD, java.lang.annotation.ElementType.METHOD, java.lang.annotation.ElementType.PARAMETER, java.lang.annotation.ElementType.LOCAL_VARIABLE})
|
|
||||||
public @interface Nullable {
|
|
||||||
}
|
|
||||||
|
|
@ -0,0 +1,39 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project-shared-configuration>
|
||||||
|
<!--
|
||||||
|
This file contains additional configuration written by modules in the NetBeans IDE.
|
||||||
|
The configuration is intended to be shared among all the users of project and
|
||||||
|
therefore it is assumed to be part of version control checkout.
|
||||||
|
Without this configuration present, some functionality in the IDE may be limited or fail altogether.
|
||||||
|
-->
|
||||||
|
<spellchecker-wordlist xmlns="http://www.netbeans.org/ns/spellchecker-wordlist/1">
|
||||||
|
<word>rule's</word>
|
||||||
|
<word>validator</word>
|
||||||
|
</spellchecker-wordlist>
|
||||||
|
<properties xmlns="http://www.netbeans.org/ns/maven-properties-data/1">
|
||||||
|
<!--
|
||||||
|
Properties that influence various parts of the IDE, especially code formatting and the like.
|
||||||
|
You can copy and paste the single properties, into the pom.xml file and the IDE will pick them up.
|
||||||
|
That way multiple projects can share the same settings (useful for formatting rules for example).
|
||||||
|
Any value defined here will override the pom.xml file value but is only applicable to the current project.
|
||||||
|
-->
|
||||||
|
<org-netbeans-modules-editor-indent.CodeStyle.usedProfile>project</org-netbeans-modules-editor-indent.CodeStyle.usedProfile>
|
||||||
|
<org-netbeans-modules-editor-indent.CodeStyle.project.spaces-per-tab>4</org-netbeans-modules-editor-indent.CodeStyle.project.spaces-per-tab>
|
||||||
|
<org-netbeans-modules-editor-indent.CodeStyle.project.tab-size>4</org-netbeans-modules-editor-indent.CodeStyle.project.tab-size>
|
||||||
|
<org-netbeans-modules-editor-indent.CodeStyle.project.indent-shift-width>4</org-netbeans-modules-editor-indent.CodeStyle.project.indent-shift-width>
|
||||||
|
<org-netbeans-modules-editor-indent.CodeStyle.project.expand-tabs>true</org-netbeans-modules-editor-indent.CodeStyle.project.expand-tabs>
|
||||||
|
<org-netbeans-modules-editor-indent.CodeStyle.project.text-limit-width>80</org-netbeans-modules-editor-indent.CodeStyle.project.text-limit-width>
|
||||||
|
<org-netbeans-modules-editor-indent.CodeStyle.project.text-line-wrap>none</org-netbeans-modules-editor-indent.CodeStyle.project.text-line-wrap>
|
||||||
|
<org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.indentCasesFromSwitch>false</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.indentCasesFromSwitch>
|
||||||
|
<org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaces-per-tab>4</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaces-per-tab>
|
||||||
|
<org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.tab-size>4</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.tab-size>
|
||||||
|
<org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.indent-shift-width>4</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.indent-shift-width>
|
||||||
|
<org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.expand-tabs>false</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.expand-tabs>
|
||||||
|
<org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.text-limit-width>80</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.text-limit-width>
|
||||||
|
<org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.text-line-wrap>none</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.text-line-wrap>
|
||||||
|
<org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.continuationIndentSize>4</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.continuationIndentSize>
|
||||||
|
<org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.importGroupsOrder>*;javax;java</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.importGroupsOrder>
|
||||||
|
<netbeans.compile.on.save>test</netbeans.compile.on.save>
|
||||||
|
<org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceAfterTypeCast>false</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceAfterTypeCast>
|
||||||
|
</properties>
|
||||||
|
</project-shared-configuration>
|
||||||
|
|
@ -0,0 +1,66 @@
|
||||||
|
|
||||||
|
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
|
<modelVersion>4.0.0</modelVersion>
|
||||||
|
|
||||||
|
<parent>
|
||||||
|
<groupId>org.antlr</groupId>
|
||||||
|
<artifactId>antlr4-master</artifactId>
|
||||||
|
<version>4.2-SNAPSHOT</version>
|
||||||
|
<relativePath>../..</relativePath>
|
||||||
|
</parent>
|
||||||
|
|
||||||
|
<artifactId>antlr4-annotations</artifactId>
|
||||||
|
|
||||||
|
<name>ANTLR 4 Runtime Annotations</name>
|
||||||
|
<description>A set of annotations used within the ANTLR 4 Runtime</description>
|
||||||
|
|
||||||
|
<profiles>
|
||||||
|
<profile>
|
||||||
|
<id>sonatype-oss-release</id>
|
||||||
|
<build>
|
||||||
|
<plugins>
|
||||||
|
<plugin>
|
||||||
|
<groupId>us.bryon</groupId>
|
||||||
|
<artifactId>graphviz-maven-plugin</artifactId>
|
||||||
|
<version>1.0</version>
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<goals>
|
||||||
|
<goal>dot</goal>
|
||||||
|
</goals>
|
||||||
|
<configuration>
|
||||||
|
<dot>${dot.path}</dot>
|
||||||
|
<destdir>${project.build.directory}/apidocs</destdir>
|
||||||
|
<output>svg</output>
|
||||||
|
</configuration>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
</plugin>
|
||||||
|
</plugins>
|
||||||
|
</build>
|
||||||
|
</profile>
|
||||||
|
</profiles>
|
||||||
|
|
||||||
|
<build>
|
||||||
|
<sourceDirectory>src</sourceDirectory>
|
||||||
|
<resources>
|
||||||
|
<resource>
|
||||||
|
<directory>resources</directory>
|
||||||
|
</resource>
|
||||||
|
</resources>
|
||||||
|
|
||||||
|
<plugins>
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.apache.maven.plugins</groupId>
|
||||||
|
<artifactId>maven-compiler-plugin</artifactId>
|
||||||
|
<configuration>
|
||||||
|
<compilerArgs>
|
||||||
|
<compilerArg>-proc:none</compilerArg>
|
||||||
|
</compilerArgs>
|
||||||
|
</configuration>
|
||||||
|
</plugin>
|
||||||
|
</plugins>
|
||||||
|
</build>
|
||||||
|
|
||||||
|
</project>
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
org.antlr.v4.runtime.misc.NullUsageProcessor
|
||||||
|
|
@ -0,0 +1,72 @@
|
||||||
|
/*
|
||||||
|
* [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.
|
||||||
|
*
|
||||||
|
* <ul>
|
||||||
|
* <li><strong>Field or Local Variable:</strong> Code reading the field or local
|
||||||
|
* variable may assume that the value is never {@code null}. Code writing to the
|
||||||
|
* field or local variable should ensure that a {@code null} reference is never
|
||||||
|
* written.</li>
|
||||||
|
* <li><strong>Parameter:</strong> Code calling the method should never pass
|
||||||
|
* {@code null} for this parameter. The implementation may assume that the value
|
||||||
|
* is never {@code null}, and the behavior of the method if the parameter is
|
||||||
|
* {@code null} is undefined. Overriding methods may optionally use the
|
||||||
|
* {@link Nullable} annotation instead of this annotation for the parameter,
|
||||||
|
* indicating that the overriding method provides additional code to handle a
|
||||||
|
* {@code null} reference passed for the parameter.</li>
|
||||||
|
* <li><strong>Method (Return Value):</strong> Code calling the method may
|
||||||
|
* assume that the result of the method is never {@code null}. The
|
||||||
|
* implementation of the method should ensure that a {@code null} reference is
|
||||||
|
* never returned.</li>
|
||||||
|
* </ul>
|
||||||
|
*
|
||||||
|
* <p>
|
||||||
|
* 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}.</p>
|
||||||
|
*/
|
||||||
|
@Documented
|
||||||
|
@Retention(RetentionPolicy.CLASS)
|
||||||
|
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.LOCAL_VARIABLE})
|
||||||
|
public @interface NotNull {
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,318 @@
|
||||||
|
/*
|
||||||
|
* [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.annotation.processing.SupportedSourceVersion;
|
||||||
|
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.
|
||||||
|
*
|
||||||
|
* <p>The validation process checks the following items.</p>
|
||||||
|
*
|
||||||
|
* <ul>
|
||||||
|
* <li><strong>Error</strong>: an element is annotated with both {@link NotNull} and {@link Nullable}.</li>
|
||||||
|
* <li><strong>Error</strong>: an method which returns {@code void} is annotated with {@link NotNull} or {@link Nullable}.</li>
|
||||||
|
* <li><strong>Error</strong>: an element with a primitive type is annotated with {@link Nullable}.</li>
|
||||||
|
* <li><strong>Error</strong>: a parameter is annotated with {@link NotNull}, but the method overrides or implements a method where the parameter is annotated {@link Nullable}.</li>
|
||||||
|
* <li><strong>Error</strong>: a method is annotated with {@link Nullable}, but the method overrides or implements a method that is annotated with {@link NotNull}.</li>
|
||||||
|
* <li><strong>Warning</strong>: an element with a primitive type is annotated with {@link NotNull}.</li>
|
||||||
|
* <li><strong>Warning</strong>: a parameter is annotated with {@link NotNull}, but the method overrides or implements a method where the parameter is not annotated.</li>
|
||||||
|
* <li><strong>Warning</strong>: a method is annotated with {@link Nullable}, but the method overrides or implements a method that is not annotated.</li>
|
||||||
|
* </ul>
|
||||||
|
*
|
||||||
|
* <p>In the future, the validation process may be updated to check the following additional items.</p>
|
||||||
|
*
|
||||||
|
* <ul>
|
||||||
|
* <li><strong>Warning</strong>: a parameter is not annotated, but the method overrides or implements a method where the parameter is annotated with {@link NotNull} or {@link Nullable}.</li>
|
||||||
|
* <li><strong>Warning</strong>: a method is not annotated, but the method overrides or implements a method that is annotated with with {@link NotNull} or {@link Nullable}.</li>
|
||||||
|
* </ul>
|
||||||
|
*
|
||||||
|
* @author Sam Harwell
|
||||||
|
*/
|
||||||
|
@SupportedAnnotationTypes({NullUsageProcessor.NotNullClassName, NullUsageProcessor.NullableClassName})
|
||||||
|
@SupportedSourceVersion(SourceVersion.RELEASE_6)
|
||||||
|
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 boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
|
||||||
|
if (!checkClassNameConstants()) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
notNullType = processingEnv.getElementUtils().getTypeElement(NotNullClassName);
|
||||||
|
nullableType = processingEnv.getElementUtils().getTypeElement(NullableClassName);
|
||||||
|
Set<? extends Element> notNullElements = roundEnv.getElementsAnnotatedWith(notNullType);
|
||||||
|
Set<? extends Element> nullableElements = roundEnv.getElementsAnnotatedWith(nullableType);
|
||||||
|
|
||||||
|
Set<Element> intersection = new HashSet<Element>(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<String, Map<ExecutableElement, List<Element>>> namedMethodMap =
|
||||||
|
new HashMap<String, Map<ExecutableElement, List<Element>>>();
|
||||||
|
addElementsToNamedMethodMap(notNullElements, namedMethodMap);
|
||||||
|
addElementsToNamedMethodMap(nullableElements, namedMethodMap);
|
||||||
|
|
||||||
|
for (Map.Entry<String, Map<ExecutableElement, List<Element>>> entry : namedMethodMap.entrySet()) {
|
||||||
|
for (Map.Entry<ExecutableElement, List<Element>> 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<? extends Element> 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<? extends Element> 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<? extends Element> elements, Map<String, Map<ExecutableElement, List<Element>>> 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<ExecutableElement, List<Element>> annotatedMethodWithName =
|
||||||
|
namedMethodMap.get(method.getSimpleName().toString());
|
||||||
|
if (annotatedMethodWithName == null) {
|
||||||
|
annotatedMethodWithName = new HashMap<ExecutableElement, List<Element>>();
|
||||||
|
namedMethodMap.put(method.getSimpleName().toString(), annotatedMethodWithName);
|
||||||
|
}
|
||||||
|
|
||||||
|
List<Element> annotatedElementsOfMethod = annotatedMethodWithName.get(method);
|
||||||
|
if (annotatedElementsOfMethod == null) {
|
||||||
|
annotatedElementsOfMethod = new ArrayList<Element>();
|
||||||
|
annotatedMethodWithName.put(method, annotatedElementsOfMethod);
|
||||||
|
}
|
||||||
|
|
||||||
|
annotatedElementsOfMethod.add(element);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private void checkOverriddenMethods(ExecutableElement method) {
|
||||||
|
TypeElement declaringType = (TypeElement)method.getEnclosingElement();
|
||||||
|
Set<Element> errorElements = new HashSet<Element>();
|
||||||
|
Set<Element> warnedElements = new HashSet<Element>();
|
||||||
|
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<? extends TypeMirror> getAllSupertypes(TypeMirror type) {
|
||||||
|
Set<TypeMirror> supertypes = new HashSet<TypeMirror>();
|
||||||
|
Deque<TypeMirror> worklist = new ArrayDeque<TypeMirror>();
|
||||||
|
worklist.add(type);
|
||||||
|
while (!worklist.isEmpty()) {
|
||||||
|
List<? extends TypeMirror> next = processingEnv.getTypeUtils().directSupertypes(worklist.poll());
|
||||||
|
if (supertypes.addAll(next)) {
|
||||||
|
worklist.addAll(next);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return new ArrayList<TypeMirror>(supertypes);
|
||||||
|
}
|
||||||
|
|
||||||
|
private void checkOverriddenMethod(ExecutableElement overrider, ExecutableElement overridden, Set<Element> errorElements, Set<Element> 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<? extends VariableElement> overriderParameters = overrider.getParameters();
|
||||||
|
List<? extends VariableElement> 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;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,72 @@
|
||||||
|
/*
|
||||||
|
* [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.
|
||||||
|
*
|
||||||
|
* <ul>
|
||||||
|
* <li><strong>Field or Local Variable:</strong> Code reading the field or local
|
||||||
|
* variable may not assume that the value is never {@code null}.</li>
|
||||||
|
* <li><strong>Parameter:</strong> 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}.
|
||||||
|
* </li>
|
||||||
|
* <li><strong>Method (Return Value):</strong> 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.</li>
|
||||||
|
* </ul>
|
||||||
|
*
|
||||||
|
* <p>
|
||||||
|
* 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}.</p>
|
||||||
|
*/
|
||||||
|
@Documented
|
||||||
|
@Retention(RetentionPolicy.CLASS)
|
||||||
|
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.LOCAL_VARIABLE})
|
||||||
|
public @interface Nullable {
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue