Skip to content

[java] Expose symbol annotations#4243

Merged
oowekyala merged 44 commits into
pmd:pmd/7.0.xfrom
jsotuyod:cle-typeres-annotations
Nov 29, 2022
Merged

[java] Expose symbol annotations#4243
oowekyala merged 44 commits into
pmd:pmd/7.0.xfrom
jsotuyod:cle-typeres-annotations

Conversation

@jsotuyod

@jsotuyod jsotuyod commented Nov 29, 2022 •
edited by adangel
Loading

Copy link
Copy Markdown
Member

Describe the PR

This PR takes on @oowekyala's work on symbol annotations (see #4241) and expands on it to finalize it with a few minor improvements along the way.

Notice this PR focuses solely on symbolic annotations, that is, those that Java reflection will retrieve through AnnotatedElement.getDeclaredAnnotations(), which excludes both those with Target ElementType.TYPE_USE and ElementType.TYPE_PARAMETER, as those are actually impacting on the types (and in the reflection API obtainable only through getAnnotated*Type() family of methods. Targeting those are a next step, but both, independent, and massive enough to be worth a separate PR.

Related issues

Ready?

  • Added unit tests for fixed bug/feature
  • Passing all unit tests
  • Complete build ./mvnw clean verify passes (checked automatically by github actions)
  • Added (in-code) documentation (if needed)

oowekyala and others added 30 commits September 13, 2020 13:37
@oowekyala
Add more info to reflected formal params
c8737e2
@oowekyala
Add annotation default values
79e35b9
@oowekyala
Remove info about parameters
45f45e5
@oowekyala
Test symbolic values
4ee8d52
@oowekyala
Tests for enums
0480655
@oowekyala
Support enums properly
d8f36ed
@oowekyala
Add interface for annots
81f5e75
@oowekyala
Finish annotations
73227d4
@oowekyala
Fix isExhaustiveEnumSwitch
9e2c9da
@oowekyala
Doc
82c31f4
@oowekyala
Add annots to all members
207c1b4
@oowekyala
Cleanup default value access
9de36f9
@oowekyala
Cleanup array logic
9be39b0
@oowekyala
Test equality routines
75264db
@oowekyala
Reduce api of SymAnnot
c35f864
@oowekyala
Implement annot attributes
f81ec66
@oowekyala
Merge branch 'java-const-values' into typeres-fwd
d829cbe
@oowekyala
Draft of AST annotation
7230224
@oowekyala
Consider class constants
5127c58
@oowekyala
Merge branch '7.0.x' into typeres-annotations
627d6a4
@oowekyala
Change enum constant name set to enum constant itself
834dadb
@oowekyala
Merge branch '7.0.x' into typeres-annotations
191f14e
@oowekyala
Fix merge
d29a2b0
@oowekyala
checkstyle
a3bdd62
@oowekyala
Factorize equality routines for SymAnnot
457568a
@oowekyala
pmd warnings
c488af3
@oowekyala
pmd warnings
b5c9101
@jsotuyod
Parse formal param annotations in ASM
83070f8 
 - Only type annotations are missing from ASM, but those are a world of pain…
@jsotuyod
Parse annotations for field/param/locals in AST
cbe551f
@jsotuyod
Parse annotations in ctors/methods in AST
8980a8d
@jsotuyod jsotuyod added the in:type-resolution Affects the type resolution code label Nov 29, 2022
@jsotuyod jsotuyod added this to the 7.0.0 milestone Nov 29, 2022
@jsotuyod jsotuyod requested a review from oowekyala November 29, 2022 05:27
@jsotuyod jsotuyod mentioned this pull request Nov 29, 2022
Closed
4 tasks
oowekyala
oowekyala reviewed Nov 29, 2022
View reviewed changes

@oowekyala oowekyala left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks fine to me, thanks! I have a couple of minor comments.

I implemented type annotation recovery from ASM in this branch. This does no interfere with your effort I think, but that may be a candidate for the next PR, to avoid diverging

Comment thread pmd-java/src/main/java/net/sourceforge/pmd/lang/java/symbols/internal/asm/GenericSigBase.java Outdated
Comment thread .../src/main/java/net/sourceforge/pmd/lang/java/symbols/internal/ast/AbstractAstExecSymbol.java Outdated
Comment thread ...src/main/java/net/sourceforge/pmd/lang/java/symbols/internal/ast/AbstractAstVariableSym.java Outdated
Comment thread pmd-java/src/main/java/net/sourceforge/pmd/lang/java/symbols/internal/ast/AstClassSym.java Outdated
jsotuyod and others added 4 commits November 29, 2022 09:58
@jsotuyod @oowekyala
Update pmd-java/src/main/java/net/sourceforge/pmd/lang/java/symbols/i…
0443e8a 
…nternal/ast/AbstractAstExecSymbol.java

Co-authored-by: Clément Fournier <clement.fournier@tu-dresden.de>
@jsotuyod @oowekyala
Update pmd-java/src/main/java/net/sourceforge/pmd/lang/java/symbols/i…
bdcca56 
…nternal/ast/AstClassSym.java

Co-authored-by: Clément Fournier <clement.fournier@tu-dresden.de>
@jsotuyod @oowekyala
Update pmd-java/src/main/java/net/sourceforge/pmd/lang/java/symbols/i…
1a5a576 
…nternal/ast/AbstractAstVariableSym.java

Co-authored-by: Clément Fournier <clement.fournier@tu-dresden.de>
@jsotuyod
Fix build
43d2c3d
@ghost

ghost commented Nov 29, 2022 •
edited by ghost
Loading

Copy link
Copy Markdown
2 Messages
📖 Compared to pmd/7.0.x:
This changeset changes 24 violations,
introduces 19 new violations, 0 new errors and 0 new configuration errors,
removes 14 violations, 0 errors and 0 configuration errors.
Full report
📖 Compared to master:
This changeset changes 50509 violations,
introduces 34666 new violations, 9 new errors and 0 new configuration errors,
removes 138300 violations, 4 errors and 7 configuration errors.
Full report
✅ Compared to pmd/7.0.x:
This changeset changes 32 violations,
introduces 28 new violations, 0 new errors and 0 new configuration errors,
removes 20 violations, 0 errors and 0 configuration errors.
Full report
✅ Compared to master:
This changeset changes 50508 violations,
introduces 34670 new violations, 9 new errors and 0 new configuration errors,
removes 138301 violations, 4 errors and 7 configuration errors.
Full report

Generated by 🚫 Danger

@jsotuyod

jsotuyod commented Nov 29, 2022

Copy link
Copy Markdown
Member Author

This should be ready now!

@oowekyala, as for how to let type annotations flow through type inference, keeping equality and what not… I've been thinking, maybe an option here is to do something similar to what Java'a reflection API actually does. Have the "annotated" types be wrappers on the standard types, and expose both (ie: Method.getReturnType() vs Method.getAnnotatedReturnType()). Equality can always be delegated to the not annotated one, and using a decorator can help minimize the number of classes we need to cope with.

I'm yet to take a look into what you did with https://github.com/oowekyala/pmd/tree/clem.type-annotations-support, but hope this helps. Let me know if I can assist you in any way with this.

@oowekyala oowekyala added the in:symbol-table Affects the symbol table code label Nov 29, 2022
@oowekyala oowekyala merged commit 5848e51 into pmd:pmd/7.0.x Nov 29, 2022
@jsotuyod jsotuyod deleted the cle-typeres-annotations branch November 29, 2022 20:43
This was referenced Jan 11, 2023
Closed
Closed
@jsotuyod jsotuyod mentioned this pull request Jan 16, 2023
Open
8 tasks
@adangel adangel mentioned this pull request Jan 23, 2023
Closed
55 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@oowekyala oowekyala oowekyala left review comments

Assignees

No one assigned

Labels

in:symbol-table Affects the symbol table code in:type-resolution Affects the type resolution code

Projects

None yet

Milestone

7.0.0

Development

Successfully merging this pull request may close these issues.

2 participants

@jsotuyod @oowekyala