Stop writing solutions that are equivalent to default annotations #339
Conversation
| if (TreeUtils.isTypeTree(node)) { | ||
| annotatedType = realTypeFactory.getAnnotatedTypeFromTypeTree(node); | ||
|
|
||
| if (annotatedType instanceof AnnotatedTypeMirror.AnnotatedTypeVariable) { |
| } else { | ||
| annotatedType = realTypeFactory.getAnnotatedType(node); | ||
| } | ||
| Set<AnnotationMirror> annotations = annotatedType.getAnnotations(); |
There was a problem hiding this comment.
use annotatedType.getAnnotationInHierarchy(top); instead
|
find how we filter out the annotations for local variables |
|
check whether |
| type, fullyQualifiedName, location); | ||
| } | ||
|
|
||
| return realTypeFactory.getAnnotatedType(typeElement); |
There was a problem hiding this comment.
find out the correct method for fetching default annotation
There was a problem hiding this comment.
try to see if getTypeDeclarationBounds is the method we want
| if (TreeUtils.isTypeTree(node)) { | ||
| annotatedType = realTypeFactory.getAnnotatedTypeFromTypeTree(node); | ||
|
|
||
| if (annotatedType.isDeclaration() && annotatedType instanceof AnnotatedTypeMirror.AnnotatedTypeVariable) { |
There was a problem hiding this comment.
try to write some test cases for this
|
handle "extends A & B" in a separate PR |
| @@ -122,6 +122,9 @@ | |||
| @Option("For inference, add debug on the port indicated") | |||
| public static String debug; | |||
|
|
|||
| @Option("If ture, don't insert solutions that are equivalent to the default ones back to the code.") | |||
There was a problem hiding this comment.
"Debugging" doesn't sound like the best option group for this.
There was a problem hiding this comment.
Moved to "Annotation File Utilities options" because I think it's more related to annotation insertion.
| addToSlots(sourceVarSlot); | ||
| locationCache.put(location, sourceVarSlot.getId()); | ||
| } | ||
| return sourceVarSlot; | ||
| } | ||
|
|
||
| /** | ||
| * Find the default annotation for this location by checking the real type factory. | ||
| * @param location Location to create a new {@link SourceVariableSlot}. |
There was a problem hiding this comment.
Nit: I think the @param and @return text fragments should not end with a .. Can you find and suggest a good javadoc style guide?
There was a problem hiding this comment.
Parameter names are lowercase by convention. The data type starts with a lowercase letter to indicate an object rather than a class. The description begins with a lowercase letter if it is a phrase (contains no verb), or an uppercase letter if it is a sentence. End the phrase with a period only if another phrase or sentence follows it.
For return:
Use the same capitalization and punctuation as you used in @ param.
from https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html
| slotManager = new DefaultSlotManager(inferenceChecker.getProcessingEnvironment(), | ||
| realTypeFactory.getSupportedTypeQualifiers(), true ); | ||
| Set<? extends AnnotationMirror> tops = realTypeFactory.getQualifierHierarchy().getTopAnnotations(); | ||
| if (tops.size() != 1) { |
There was a problem hiding this comment.
In PICO I think we have two tops, one for immutability and one for initialization. Only one hierarchy, immutability, is inferred, the other one is not. Haifeng will run in problems with this, but I'm fine with solving it then.
There was a problem hiding this comment.
Ok, we should discuss more about this in his PR.
Problem Description: Currently, we write all solutions back to insertable slots, even if some of them are equivalent to the default assumptions for those slots. This behavior has caused a lot of noises in the generaterd files; for example, in the following piece of code:
@NonNull's are superfluous information.This PR introduces a new field
AnnotationMirror defaultAnnotationtoSourceVariableSlot. The field contains the default annotation that's associated withSourceVariableSlot.locationfrom the real type factory. Before writing solutions to Jaif,InferenceMainwill check if a solution is equivalent to the default annotation. If the answer is yes, the solution won't be written back into the code.This PR also adds a new option
--insertDefaultAnnotationsso we can still insert all solutions for debugging.