Skip to content

Commit

Permalink
New Xlint warning 'arrayCannotBeVoid' when resolving 'void[]'
Browse files Browse the repository at this point in the history
Because void arrays are illegal (and nonsensical), now there is a new
Xlint warning whenever World.resolve resolves a new 'void[]'. Because
in the World class we do not have any source context, no path + line
number are logged. The user only sees something like:

  [warning] arrays cannot have a void type, but found 'void[]' in
  pointcut [Xlint:arrayCannotBeVoid]

Then later, if due to the returned MissingResolvedTypeWithKnownSignature
type a joinpoint does not match, there is an additional

  my/path/MyAspect.aj:42 [warning] advice defined in MyAspect has not
  been applied [Xlint:adviceDidNotMatch]

log line, but not necessarily anywhere near the former one.

On the one hand, this is better than nothing. OTOH, comparing the
situation with no logging message other than Xlint:adviceDidNotMatch in
case of something equally illegal like 'Foo<int>' (primitive generic
type parameter), this is actually more than we have in several other
situations and might even be regarded as superfluous. In case of
multiple 'void[]' cases within a big number of aspects, the same aspect
or even the same pointcut, the user would have no clue where exactly to
search for it. He would just see multiple log messages without source
context.

One option would be to set 'arrayCannotBeVoid=ignore' in
XlintDefault.properties, so the user would have to explicitly activate
it. But IMO, this message should be visible by default.

Another option would be to find out how to defer logging the messages
until later similarly to BcelWeaver.warnOnUnmatchedAdvice and then to
bulk-print them. But in order to achieve that, the information about the
existence of any 'void[]' occurrences would have to be stored in a flag
similar to BcelAdvice.hasMatchedAtLeastOnce, bloating BcelAdvice for
that rare case. Alternatively, each advice pointcut could be
heuristically scanned for the literal substring 'void[]', logging the
Xlint message if it is found anywhere.

Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
  • Loading branch information
kriegaex committed Apr 12, 2024
1 parent cad9346 commit ed0a8ea
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,8 @@ public class Lint {
public final Kind missingAspectForReweaving = new Kind("missingAspectForReweaving",
"aspect {0} cannot be found when reweaving {1}");

public final Kind arrayCannotBeVoid = new Kind("arrayCannotBeVoid", "arrays cannot have a void type, but found ''{0}'' in pointcut");

private static final Trace trace = TraceFactory.getTraceFactory().getTrace(Lint.class);

public Lint(World world) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,15 @@ public ResolvedType resolve(UnresolvedType ty, boolean allowMissing) {
synchronized (buildingTypeLock) {
if (ty.isArray()) {
ResolvedType componentType = resolve(ty.getComponentType(), allowMissing);
if (componentType.isVoid()) {
if (isInJava5Mode() && getLint().adviceDidNotMatch.isEnabled()) {
getLint().arrayCannotBeVoid.signal(ty.toString(), null);
}
ret = new MissingResolvedTypeWithKnownSignature(signature, this);
}
else {
ret = new ArrayReferenceType(signature, "[" + componentType.getErasureSignature(), this, componentType);
}
} else {
ret = resolveToReferenceType(ty, allowMissing);
if (!allowMissing && ret.isMissing()) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,5 @@ missingAspectForReweaving=error
cannotAdviseJoinpointInInterfaceWithAroundAdvice=warning

nonReweavableTypeEncountered=error

arrayCannotBeVoid=warning
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,9 @@ public void testPrimitiveArrays() {
ResolvedType[] primitives = world.resolve(primitiveTypes);
for (ResolvedType ty : primitives) {
UnresolvedType tx = UnresolvedType.forSignature("[" + ty.getSignature());
// 'void[]' is an illegal type -> skip
if (tx.getSignature().equals("[V"))
continue;
ResolvedType aty = world.resolve(tx, true);
assertTrue("Couldnt find type " + tx, !aty.isMissing());
modifiersTest(aty, Modifier.PUBLIC | Modifier.FINAL);
Expand All @@ -128,6 +131,9 @@ public void testPrimitiveArrays() {
for (ResolvedType ty1 : primitives) {
isCoerceableFromTest(aty, ty1, false);
tx = UnresolvedType.forSignature("[" + ty1.getSignature());
// 'void[]' is an illegal type -> skip
if (tx.getSignature().equals("[V"))
continue;
ResolvedType aty1 = getWorld().resolve(tx, true);
assertTrue("Couldnt find type " + tx, !aty1.isMissing());
if (ty.equals(ty1)) {
Expand All @@ -142,6 +148,9 @@ public void testPrimitiveArrays() {
// double dimension arrays
for (ResolvedType ty : primitives) {
UnresolvedType tx = UnresolvedType.forSignature("[[" + ty.getSignature());
// 'void[][]' is an illegal type -> skip
if (tx.getSignature().equals("[[V"))
continue;
ResolvedType aty = world.resolve(tx, true);
assertTrue("Couldnt find type " + tx, !aty.isMissing());
modifiersTest(aty, Modifier.PUBLIC | Modifier.FINAL);
Expand All @@ -160,6 +169,9 @@ public void testPrimitiveArrays() {
for (ResolvedType ty1 : primitives) {
isCoerceableFromTest(aty, ty1, false);
tx = UnresolvedType.forSignature("[[" + ty1.getSignature());
// 'void[][]' is an illegal type -> skip
if (tx.getSignature().equals("[[V"))
continue;
ResolvedType aty1 = getWorld().resolve(tx, true);
assertTrue("Couldnt find type " + tx, !aty1.isMissing());
if (ty.equals(ty1)) {
Expand Down

0 comments on commit ed0a8ea

Please sign in to comment.