Copy @use and @consume annotations to parameter types
#23324
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR ensures that the @use and @consume annotations on parameter symbols are correctly copied to their parameter types so that they persist after tree copying. Key changes include:
- Updating error messages and test expectations in negative test cases.
- Modifying printers and type handling code to include the new annotations.
- Adjusting capture checking and transformation logic to accommodate the copied annotations.
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/pos-custom-args/captures/cc-use-iterable.scala | Adds persistence of annotations in Iterable methods. |
| tests/neg-custom-args/captures/unsound-reach-4.check | Updates expected error messages to reflect the annotations. |
| tests/neg-custom-args/captures/unbox-overrides.check | Adjusts error messages in override scenarios. |
| tests/neg-custom-args/captures/leak-problem-unboxed.scala | Reflects changes in function reference resolution. |
| tests/neg-custom-args/captures/cc-annot-value-classes2.scala | Updates value class tests for annotation correctness. |
| tests/neg-custom-args/captures/cc-annot-value-classes.scala | Updates tests regarding annotation use in value classes. |
| compiler/src/dotty/tools/dotc/printing/PlainPrinter.scala | Updates printing logic to include the new annotations. |
| compiler/src/dotty/tools/dotc/core/Types.scala | Implements copying of @use and @consume annotations. |
| compiler/src/dotty/tools/dotc/core/Definitions.scala | Adds the new annotations to silent annotations. |
| compiler/src/dotty/tools/dotc/cc/SepCheck.scala | Updates capture checking to refer to the new isConsumeParam check. |
| compiler/src/dotty/tools/dotc/cc/CheckCaptures.scala | Refines annotation propagation and handling in capture checking. |
| compiler/src/dotty/tools/dotc/cc/CaptureOps.scala | Adds methods for dropping and checking the new annotations. |
Comments suppressed due to low confidence (1)
compiler/src/dotty/tools/dotc/printing/PlainPrinter.scala:381
- [nitpick] Consider revising the documentation comment for grammatical correctness. For example, change 'the annotation that are meant' to 'the annotations that are meant' and 'but was moved' to 'but were moved'.
/** Print the annotation that are meant to be on the parameter symbol but was moved
odersky
approved these changes
Jun 9, 2025
| || sym.is(TypeParam) | ||
| && sym.owner.rawParamss.nestedExists: param => | ||
| param.is(TermParam) && param.hasAnnotation(defn.UseAnnot) | ||
| && param.info.deepCaptureSet.elems.exists: | ||
| case c: TypeRef => c.symbol == sym | ||
| case _ => false | ||
|
|
||
| /** `sym` or its info is annotated with `@consume`. */ | ||
| def isConsumeParam(using Context): Boolean = |
There was a problem hiding this comment.
Do we need the sym.hasAnnotation(...) part? If not it's better to remove that clause.
There was a problem hiding this comment.
I tried to drop the check but the tests failed. I think we still need it because there are cases when we check whether a symbol is declared @use (or @consume) that comes directly from the original method, whose info is not adapted by the new logic.
There was a problem hiding this comment.
OK, let's leave it in then.
| @@ -490,18 +493,24 @@ extension (sym: Symbol) | |||
| def hasTrackedParts(using Context): Boolean = | |||
| !CaptureSet.ofTypeDeeply(sym.info).isAlwaysEmpty | |||
|
|
|||
| /** `sym` is annotated @use or it is a type parameter with a matching | |||
| /** `sym` itself or its info is annotated @use or it is a type parameter with a matching | |||
| * @use-annotated term parameter that contains `sym` in its deep capture set. | |||
| */ | |||
| def isUseParam(using Context): Boolean = | |||
| sym.hasAnnotation(defn.UseAnnot) | |||
There was a problem hiding this comment.
Do we still need the sym.hasAnnotation(...) part? If not it's better to remove that clause.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
... so that they will persist after tree copying.
fixes #23302.