Add support for Overwrite annotation on non-obfuscated methods

This commit is contained in:
Mumfrey committed 2017-07-05 09:15:03 +01:00
1 parent 87a3837b13
commit 41e53c4942
5 files changed
+38 -19

No files matched your search

@@ -32,8 +32,8 @@ import java.lang.annotation.Target;
import org.spongepowered.asm.util.ConstraintParser.Constraint;
/**
* <p>Annotation used to indicate a mixin class member which must overwrite an
* obfuscated method in the target class.</p>
* <p>Annotation used to indicate a mixin class member which must overwrite a
* method in the target class.</p>
*
* <p>The default behaviour of mixin classes when merging mixin methods is to
* replace methods in the target class which already exist, and simply add any
@@ -46,11 +46,8 @@ import org.spongepowered.asm.util.ConstraintParser.Constraint;
* traverse the obfuscation boundary, this association with the target method is
* lost because the method name will change. The {@link Overwrite} annotation is
* used to indicate to the annotation processor that this method is intended to
* overwrite a member in the target class, and should therefore be added to the
* obfuscation table.</p>
*
* <p>Adding this annotation to a non-obfuscated method will cause the
* annotation processor to raise an error at compile time.</p>
* overwrite a member in the target class, and should be added to the
* obfuscation table if {@link #remap} is true.</p>
*/
@Target({ ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@@ -80,4 +77,20 @@ public @interface Overwrite {
*/
public String[] aliases() default { };
/**
* By default, the annotation processor will attempt to locate an
* obfuscation mapping for all {@link Overwrite} methods since it is
* anticipated that in general the target of a {@link Overwrite} annotation
* will be an obfuscated method in the target class. However since it is
* possible to also overwrite methods in non-obfuscated targets it may be
* necessary to suppress the compiler error which would otherwise be
* generated. Setting this value to <em>false</em> will cause the annotation
* processor to skip this annotation when attempting to build the
* obfuscation table for the mixin.
*
* @return True to instruct the annotation processor to search for
* obfuscation mappings for this method
*/
public boolean remap() default true;
}
@@ -31,7 +31,7 @@ import java.lang.annotation.Target;
/**
* This annotation, when applied to a member method or field in a mixin,
* indicates that the member <b>should never</b> overwrite a matching membver in
* indicates that the member <b>should never</b> overwrite a matching member in
* the target class. This indicates that the member differs from the normal
* "overlay-like" behaviour of mixins in general, and should only ever be
* <em>added</em> to the target. For public fields, the annotation has no