Shorten module names
This commit is contained in:
32
proc/.classpath
Normal file
32
proc/.classpath
Normal file
@ -0,0 +1,32 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<classpath>
|
||||
<classpathentry kind="src" output="target/classes" path="src/main/java">
|
||||
<attributes>
|
||||
<attribute name="optional" value="true"/>
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-11">
|
||||
<attributes>
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
|
||||
<attributes>
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry kind="src" output="target/test-classes" path="home/kske/git/event-bus/event-bus-ap">
|
||||
<attributes>
|
||||
<attribute name="optional" value="true"/>
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
<attribute name="test" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
|
||||
<attributes>
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry kind="output" path="target/classes"/>
|
||||
</classpath>
|
||||
23
proc/.project
Normal file
23
proc/.project
Normal file
@ -0,0 +1,23 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<projectDescription>
|
||||
<name>event-bus-proc</name>
|
||||
<comment></comment>
|
||||
<projects>
|
||||
</projects>
|
||||
<buildSpec>
|
||||
<buildCommand>
|
||||
<name>org.eclipse.jdt.core.javabuilder</name>
|
||||
<arguments>
|
||||
</arguments>
|
||||
</buildCommand>
|
||||
<buildCommand>
|
||||
<name>org.eclipse.m2e.core.maven2Builder</name>
|
||||
<arguments>
|
||||
</arguments>
|
||||
</buildCommand>
|
||||
</buildSpec>
|
||||
<natures>
|
||||
<nature>org.eclipse.jdt.core.javanature</nature>
|
||||
<nature>org.eclipse.m2e.core.maven2Nature</nature>
|
||||
</natures>
|
||||
</projectDescription>
|
||||
75
proc/pom.xml
Normal file
75
proc/pom.xml
Normal file
@ -0,0 +1,75 @@
|
||||
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<artifactId>event-bus-proc</artifactId>
|
||||
|
||||
<name>Event Bus Annotation Processor</name>
|
||||
<description>Annotation processor checking for errors related to the @Event annotation from Event Bus.</description>
|
||||
|
||||
<parent>
|
||||
<groupId>dev.kske</groupId>
|
||||
<artifactId>event-bus</artifactId>
|
||||
<version>1.2.0</version>
|
||||
</parent>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>dev.kske</groupId>
|
||||
<artifactId>event-bus-core</artifactId>
|
||||
<version>${project.version}</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<build>
|
||||
|
||||
<!-- Disable test folder -->
|
||||
<testSourceDirectory />
|
||||
|
||||
<plugins>
|
||||
|
||||
<!-- Prevent annotation processing error during compilation -->
|
||||
<plugin>
|
||||
<artifactId>maven-compiler-plugin</artifactId>
|
||||
<configuration>
|
||||
<compilerArgument>-proc:none</compilerArgument>
|
||||
</configuration>
|
||||
</plugin>
|
||||
|
||||
<!-- Include event-bus-core classes into JAR -->
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-shade-plugin</artifactId>
|
||||
<version>3.2.4</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<phase>package</phase>
|
||||
<goals>
|
||||
<goal>shade</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<minimizeJar>true</minimizeJar>
|
||||
<filters>
|
||||
<filter>
|
||||
<artifact>dev.kske:event-bus-core</artifact>
|
||||
<excludes>
|
||||
<exclude>META-INF/MANIFEST.MF</exclude>
|
||||
</excludes>
|
||||
</filter>
|
||||
<filter>
|
||||
<artifact>*:*</artifact>
|
||||
<excludes>
|
||||
<exclude>module-info.class</exclude>
|
||||
<exclude>META-INF/maven/**</exclude>
|
||||
</excludes>
|
||||
</filter>
|
||||
</filters>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
|
||||
</build>
|
||||
</project>
|
||||
155
proc/src/main/java/dev/kske/eventbus/proc/EventProcessor.java
Normal file
155
proc/src/main/java/dev/kske/eventbus/proc/EventProcessor.java
Normal file
@ -0,0 +1,155 @@
|
||||
package dev.kske.eventbus.proc;
|
||||
|
||||
import java.util.Set;
|
||||
|
||||
import javax.annotation.processing.*;
|
||||
import javax.lang.model.SourceVersion;
|
||||
import javax.lang.model.element.*;
|
||||
import javax.lang.model.type.*;
|
||||
import javax.tools.Diagnostic.Kind;
|
||||
|
||||
import dev.kske.eventbus.core.*;
|
||||
|
||||
/**
|
||||
* This annotation processor checks event handlers for common mistakes which can only be detected
|
||||
* during runtime otherwise.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SupportedAnnotationTypes("dev.kske.eventbus.core.Event")
|
||||
@SupportedSourceVersion(SourceVersion.RELEASE_11)
|
||||
public class EventProcessor extends AbstractProcessor {
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
@Override
|
||||
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
|
||||
if (!roundEnv.errorRaised() && !roundEnv.processingOver())
|
||||
processRound(
|
||||
(Set<ExecutableElement>) roundEnv.getElementsAnnotatedWith(Event.class));
|
||||
|
||||
// Do not claim the processed annotations
|
||||
return false;
|
||||
}
|
||||
|
||||
private void processRound(Set<ExecutableElement> eventHandlers) {
|
||||
for (ExecutableElement eventHandler : eventHandlers) {
|
||||
Event eventAnnotation = eventHandler.getAnnotation(Event.class);
|
||||
TypeMirror eventType;
|
||||
|
||||
// Determine the event type and how it is defined
|
||||
boolean useParameter;
|
||||
try {
|
||||
eventAnnotation.value();
|
||||
throw new EventBusException(
|
||||
"Could not determine event type of handler " + eventHandler);
|
||||
} catch (MirroredTypeException e) {
|
||||
|
||||
// Task failed successfully
|
||||
eventType = e.getTypeMirror();
|
||||
useParameter = processingEnv.getTypeUtils().isSameType(eventType,
|
||||
getTypeMirror(Event.USE_PARAMETER.class));
|
||||
}
|
||||
|
||||
// Check handler signature
|
||||
boolean pass = false;
|
||||
if (useParameter && eventHandler.getParameters().size() == 0)
|
||||
error(eventHandler, "The method or the annotation must define the event type");
|
||||
else if (!useParameter && eventHandler.getParameters().size() == 1)
|
||||
error(eventHandler,
|
||||
"Either the method or the annotation must define the event type");
|
||||
else if (eventHandler.getParameters().size() > 1)
|
||||
error(eventHandler, "Method must not have more than one parameter");
|
||||
else
|
||||
pass = true;
|
||||
|
||||
// Warn the user about unused return values
|
||||
if (useParameter && eventHandler.getReturnType().getKind() != TypeKind.VOID)
|
||||
warning(eventHandler, "Unused return value");
|
||||
|
||||
// Abort checking if the handler signature is incorrect
|
||||
if (!pass)
|
||||
continue;
|
||||
|
||||
// Additional checks if parameter is used
|
||||
if (useParameter) {
|
||||
VariableElement paramElement = eventHandler.getParameters().get(0);
|
||||
eventType = paramElement.asType();
|
||||
|
||||
// Check if parameter is object
|
||||
// Abort checking otherwise
|
||||
if (eventType.getKind() != TypeKind.DECLARED) {
|
||||
error(paramElement, "Event must be an object");
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
// Get the listener containing this handler
|
||||
TypeElement listener = (TypeElement) eventHandler.getEnclosingElement();
|
||||
|
||||
// Default properties
|
||||
boolean defPolymorphic = false;
|
||||
int defPriority = 100;
|
||||
|
||||
// Listener-level polymorphism
|
||||
Polymorphic listenerPolymorphic = listener.getAnnotation(Polymorphic.class);
|
||||
boolean hasListenerPolymorphic = listenerPolymorphic != null;
|
||||
|
||||
// Listener-level priority
|
||||
Priority listenerPriority = listener.getAnnotation(Priority.class);
|
||||
boolean hasListenerPriority = listenerPriority != null;
|
||||
|
||||
// Effective polymorphism
|
||||
boolean polymorphic =
|
||||
hasListenerPolymorphic ? listenerPolymorphic.value() : defPolymorphic;
|
||||
boolean hasHandlerPolymorphic = eventHandler.getAnnotation(Polymorphic.class) != null;
|
||||
if (hasHandlerPolymorphic)
|
||||
polymorphic = eventHandler.getAnnotation(Polymorphic.class).value();
|
||||
|
||||
// Effective priority
|
||||
int priority = hasListenerPriority ? listenerPriority.value() : defPriority;
|
||||
boolean hasHandlerPriority = eventHandler.getAnnotation(Priority.class) != null;
|
||||
if (hasHandlerPriority)
|
||||
priority = eventHandler.getAnnotation(Priority.class).value();
|
||||
|
||||
// Detect useless polymorphism redefinition
|
||||
if (hasListenerPolymorphic && hasHandlerPolymorphic
|
||||
&& listenerPolymorphic.value() == polymorphic)
|
||||
warning(eventHandler, "@Polymorphism is already defined at listener level");
|
||||
|
||||
// Detect useless priority redefinition
|
||||
if (hasListenerPriority && hasHandlerPriority && listenerPriority.value() == priority)
|
||||
warning(eventHandler, "@Priority is already defined at the listener level");
|
||||
|
||||
// Detect missing or useless @Polymorphic
|
||||
Element eventElement = ((DeclaredType) eventType).asElement();
|
||||
|
||||
// Check for handlers for abstract types that aren't polymorphic
|
||||
if (!polymorphic && (eventElement.getKind() == ElementKind.INTERFACE
|
||||
|| eventElement.getModifiers().contains(Modifier.ABSTRACT)))
|
||||
warning(eventHandler,
|
||||
"Parameter should be instantiable or handler should use @Polymorphic");
|
||||
|
||||
// Check for handlers for final types that are polymorphic
|
||||
else if (polymorphic && eventElement.getModifiers().contains(Modifier.FINAL))
|
||||
warning(eventHandler,
|
||||
"@Polymorphic should be removed as parameter cannot be subclassed");
|
||||
}
|
||||
}
|
||||
|
||||
private TypeMirror getTypeMirror(Class<?> clazz) {
|
||||
return getTypeElement(clazz).asType();
|
||||
}
|
||||
|
||||
private TypeElement getTypeElement(Class<?> clazz) {
|
||||
return processingEnv.getElementUtils().getTypeElement(clazz.getCanonicalName());
|
||||
}
|
||||
|
||||
private void warning(Element e, String msg, Object... args) {
|
||||
processingEnv.getMessager().printMessage(Kind.WARNING, String.format(msg, args), e);
|
||||
}
|
||||
|
||||
private void error(Element e, String msg, Object... args) {
|
||||
processingEnv.getMessager().printMessage(Kind.ERROR, String.format(msg, args), e);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,7 @@
|
||||
/**
|
||||
* Contains the Event Bus annotation processor.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.0.0
|
||||
*/
|
||||
package dev.kske.eventbus.proc;
|
||||
12
proc/src/main/java/module-info.java
Normal file
12
proc/src/main/java/module-info.java
Normal file
@ -0,0 +1,12 @@
|
||||
/**
|
||||
* Contains an annotation processor for checking for errors related to the
|
||||
* {@link dev.kske.eventbus.core.Event} annotation from Event Bus.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.0.0
|
||||
*/
|
||||
module dev.kske.eventbus.ap {
|
||||
|
||||
requires java.compiler;
|
||||
requires dev.kske.eventbus.core;
|
||||
}
|
||||
@ -0,0 +1 @@
|
||||
dev.kske.eventbus.proc.EventProcessor
|
||||
Reference in New Issue
Block a user