[GROOVY-4934] incorrect signature attributes in class files for inner class generics

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.8.0
• Fix Version/s: 1.8.6, 2.0-beta-3, 1.7.11
• Component/s: bytecode, class generator
• Assignee: Jochen Theodorou
• Reporter: Andy Clement
• Created: 19/Jul/11 19:53
• Updated: 01/Feb/12 12:47
• Resolved: 01/Feb/12 12:47

Description

When an inner type shares state with its outer type, and that shared state is generic, the signature attributes generated inside the inner class are not correct. This is not normally a problem because once created they are rarely processed again, however, Eclipse checks these things and discovers the inconsistencies, reporting an 'inconsistent class file' error when it sees a type variable referenced that is not in scope.

Here is a simple groovy program:

import groovy.lang.Closure

import java.io.Serializable
import java.util.Map

class GormInstanceApi<D> {

	void delete(D instance) {
		new VoidSessionCallback() {
			void doInSession() {
				print instance
			}
		}
	}

}

interface VoidSessionCallback {
	void doInSession();
}

When this gets compiled, a field of type Reference is created in the inner type (in the InnerClassVisitor.visitConstructorCallExpression()) code, and this is added to the constructor. The signature attribute for the new field and the constructor of the inner type encodes a generic reference that isn't quite right - it refers to a type variable that isn't in scope. Here is the generic signature attribute for the constructor:

(LGormInstanceApi<TD;>;Lgroovy/lang/Reference<TT;>;)V;

The first bit is OK, the 'D' referred to is defined by the declaring type and so visible from the inner. However the 'T' is not visible - I would have expected a reference to the raw type there:

(LGormInstanceApi<TD;>;Lgroovy/lang/Reference;)V;

Or, if it was being used in parameterized form:

(LGormInstanceApi<TD;>;Lgroovy/lang/Reference<Ljava/lang/Object;>;)V;

Similarly it is wrong for the field:

Lgroovy/lang/Reference<TT;>;;

T is not in scope (not declared by this type or a surrounding type).

To see this problem in Eclipse, define a project containing that code above and then create a pure java project that depends upon it. Add this file to the java project:

class Simple<D> extends GormInstanceApi<D> {
	 
	void foo() {	 
		new VoidSessionCallback() {
			public void doInSession() {
			}  
		} ;
	}    
}  

This code is enough to force JDT to load in the GormInstanceApi inner class and discover the inconsistency in signatures:

Inconsistent classfile encountered: The undefined type parameter T is referenced from within GormInstanceApi<D>.1

I'd propose the type of the newly created field is set to the raw type for groovy.lang.Reference, but I don't know how to create a raw ClassNode.