azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[AA] Add KtEnumEntryInitializerSymbol

Browse Source 
- An enum entry's body is an initializer with members only accessible
  within that body. Because users of the Analysis API might want to
  analyze the members of the enum entry initializer, we expose this
  initializer via `KtEnumEntrySymbol`. The initializer only exists if
  the enum entry has a body.
  - We already have some usages of the initializer inside symbol light
    classes, which generate a light class for each enum entry, which
    includes the enum entry's hidden members.
- To hide the implementation detail that initializers are anonymous
  objects, `KtEnumEntryInitializerSymbol` is simply a
  `KtSymbolWithMembers`.
- The advantage of making it a `KtSymbolWithMembers`, instead of
  providing a custom way to get a member scope, is that we can pass
  around the initializer easily, e.g. in `KtEnumEntrySymbolRenderer`.
- We implement `KtEnumEntryInitializerSymbol` directly as a
  `KtFirAnonymousObjectSymbol` without a wrapper. This has a few
  advantages:
  1. We can directly benefit from the anonymous object symbol being a
     `KtSymbolWithMembers`, so we don't have to handle enum entry
     initializers specially in e.g. `KtFirScopeProvider`.
  2. We don't have to implement a new symbol restoration mechanism for
     the initializer.
  3. This implementation matches the actual FIR tree structure (with a
     simplification that the connecting anonymous object expression
     between the enum entry and the initializing anonymous object is
     omitted).

^KT-61425 fixed
This commit is contained in:
Marco Pennekamp
2023-08-24 21:54:02 +02:00
committed by Space Team
parent e72a38dc82
commit 80efa34926
21 changed files with 106 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/renderer/declarations/renderers/callables/KtEnumEntrySymbolRenderer.kt
+1 -1
View File
@@ -21,7 +21,7 @@ public interface KtEnumEntrySymbolRenderer {
" ".separated(
{ renderAnnotationsModifiersAndContextReceivers(symbol, printer) },
{ nameRenderer.renderName(symbol, printer) },
{ classifierBodyRenderer.renderBody(symbol, printer) },
{ symbol.enumEntryInitializer?.let { classifierBodyRenderer.renderBody(it, printer) } },
)
}
}
analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/symbols/KtVariableLikeSymbol.kt
+27
View File
@@ -91,10 +91,37 @@ public abstract class KtEnumEntrySymbol : KtVariableLikeSymbol(), KtSymbolWithKi
//todo reduntant, remove
public abstract val containingEnumClassIdIfNonLocal: ClassId?
/**
* Returns the enum entry's initializer, or `null` if the enum entry doesn't have a body.
*/
public abstract val enumEntryInitializer: KtEnumEntryInitializerSymbol?
context(KtAnalysisSession)
abstract override fun createPointer(): KtSymbolPointer<KtEnumEntrySymbol>
}
/**
* An initializer for enum entries with a body. The initializer may contain its own declarations (especially overrides of members declared
* by the enum class), and is [similar to an object declaration](https://kotlinlang.org/spec/declarations.html#enum-class-declaration).
*
* #### Example
*
* ```kotlin
* enum class E {
* // `A` is declared with an initializer.
* A {
* val x: Int = 5
* },
*
* // `B` has no initializer.
* B
* }
* ```
*
* The initializer of `A` declares a member `x: Int`, which is inaccessible outside the initializer. Still, the corresponding
* [KtEnumEntryInitializerSymbol] can be used to get a declared member scope that contains `x`.
*/
public interface KtEnumEntryInitializerSymbol : KtSymbolWithMembers
public sealed class KtVariableSymbol : KtVariableLikeSymbol() {
public abstract val isVal: Boolean
analysis/analysis-api/testData/components/scopeProvider/scopeContextForPosition/enumEntry.txt
Vendored
+1
View File
@@ -519,6 +519,7 @@ scopes:
callableIdIfNonLocal: /E.A
containingEnumClassIdIfNonLocal: E
contextReceivers: []
enumEntryInitializer: KtAnonymousObjectSymbol(<local>/<no name provided>)
isExtension: false
name: A
origin: SOURCE
analysis/analysis-api/testData/symbols/symbolByFqName/enumEntry.descriptors.txt
Vendored
+1
View File
@@ -3,6 +3,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: kotlin/LazyThreadSafetyMode.SYNCHRONIZED
containingEnumClassIdIfNonLocal: kotlin/LazyThreadSafetyMode
contextReceivers: []
enumEntryInitializer: KtEnumEntrySymbol(kotlin/LazyThreadSafetyMode.SYNCHRONIZED)
isExtension: false
name: SYNCHRONIZED
origin: LIBRARY
analysis/analysis-api/testData/symbols/symbolByFqName/enumEntry.txt
Vendored
+1
View File
@@ -3,6 +3,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: kotlin/LazyThreadSafetyMode.SYNCHRONIZED
containingEnumClassIdIfNonLocal: kotlin/LazyThreadSafetyMode
contextReceivers: []
enumEntryInitializer: null
isExtension: false
name: SYNCHRONIZED
origin: LIBRARY
analysis/analysis-api/testData/symbols/symbolByPsi/enum.txt
Vendored
+2
View File
@@ -3,6 +3,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /X.Y
containingEnumClassIdIfNonLocal: X
contextReceivers: []
enumEntryInitializer: null
isExtension: false
name: Y
origin: SOURCE
@@ -21,6 +22,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /X.Z
containingEnumClassIdIfNonLocal: X
contextReceivers: []
enumEntryInitializer: null
isExtension: false
name: Z
origin: SOURCE
analysis/analysis-api/testData/symbols/symbolByPsi/enumEntryFunctions.descriptors.txt
Vendored
+3
View File
@@ -39,6 +39,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.FirstEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: KtEnumEntrySymbol(/MyEnumClass.FirstEntry)
isExtension: false
name: FirstEntry
origin: SOURCE
@@ -57,6 +58,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.SecondEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: null
isExtension: false
name: SecondEntry
origin: SOURCE
@@ -170,6 +172,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.ThirdEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: KtEnumEntrySymbol(/MyEnumClass.ThirdEntry)
isExtension: false
name: ThirdEntry
origin: SOURCE
analysis/analysis-api/testData/symbols/symbolByPsi/enumEntryFunctions.txt
Vendored
+3
View File
@@ -39,6 +39,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.FirstEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: KtAnonymousObjectSymbol(<local>/<no name provided>)
isExtension: false
name: FirstEntry
origin: SOURCE
@@ -57,6 +58,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.SecondEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: null
isExtension: false
name: SecondEntry
origin: SOURCE
@@ -170,6 +172,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.ThirdEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: KtAnonymousObjectSymbol(<local>/<no name provided>)
isExtension: false
name: ThirdEntry
origin: SOURCE
analysis/analysis-api/testData/symbols/symbolByPsi/enumEntryOverride.descriptors.txt
Vendored
+3
View File
@@ -75,6 +75,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.FirstEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: KtEnumEntrySymbol(/MyEnumClass.FirstEntry)
isExtension: false
name: FirstEntry
origin: SOURCE
@@ -214,6 +215,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.SecondEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: KtEnumEntrySymbol(/MyEnumClass.SecondEntry)
isExtension: false
name: SecondEntry
origin: SOURCE
@@ -327,6 +329,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.ThirdEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: KtEnumEntrySymbol(/MyEnumClass.ThirdEntry)
isExtension: false
name: ThirdEntry
origin: SOURCE
analysis/analysis-api/testData/symbols/symbolByPsi/enumEntryOverride.txt
Vendored
+3
View File
@@ -75,6 +75,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.FirstEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: KtAnonymousObjectSymbol(<local>/<no name provided>)
isExtension: false
name: FirstEntry
origin: SOURCE
@@ -210,6 +211,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.SecondEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: KtAnonymousObjectSymbol(<local>/<no name provided>)
isExtension: false
name: SecondEntry
origin: SOURCE
@@ -323,6 +325,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.ThirdEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: KtAnonymousObjectSymbol(<local>/<no name provided>)
isExtension: false
name: ThirdEntry
origin: SOURCE
analysis/analysis-api/testData/symbols/symbolByPsi/enumEntryProperties.descriptors.txt
Vendored
+3
View File
@@ -88,6 +88,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.FirstEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: KtEnumEntrySymbol(/MyEnumClass.FirstEntry)
isExtension: false
name: FirstEntry
origin: SOURCE
@@ -106,6 +107,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.SecondEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: null
isExtension: false
name: SecondEntry
origin: SOURCE
@@ -312,6 +314,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.ThirdEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: KtEnumEntrySymbol(/MyEnumClass.ThirdEntry)
isExtension: false
name: ThirdEntry
origin: SOURCE
analysis/analysis-api/testData/symbols/symbolByPsi/enumEntryProperties.txt
Vendored
+3
View File
@@ -88,6 +88,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.FirstEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: KtAnonymousObjectSymbol(<local>/<no name provided>)
isExtension: false
name: FirstEntry
origin: SOURCE
@@ -106,6 +107,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.SecondEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: null
isExtension: false
name: SecondEntry
origin: SOURCE
@@ -308,6 +310,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /MyEnumClass.ThirdEntry
containingEnumClassIdIfNonLocal: MyEnumClass
contextReceivers: []
enumEntryInitializer: KtAnonymousObjectSymbol(<local>/<no name provided>)
isExtension: false
name: ThirdEntry
origin: SOURCE
analysis/analysis-api/testData/symbols/symbolByPsi/enumValueMember.descriptors.txt
Vendored
+1
View File
@@ -217,6 +217,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /Style.SHEET
containingEnumClassIdIfNonLocal: Style
contextReceivers: []
enumEntryInitializer: KtEnumEntrySymbol(/Style.SHEET)
isExtension: false
name: SHEET
origin: SOURCE
analysis/analysis-api/testData/symbols/symbolByPsi/enumValueMember.txt
Vendored
+1
View File
@@ -213,6 +213,7 @@ KtEnumEntrySymbol:
callableIdIfNonLocal: /Style.SHEET
containingEnumClassIdIfNonLocal: Style
contextReceivers: []
enumEntryInitializer: KtAnonymousObjectSymbol(<local>/<no name provided>)
isExtension: false
name: SHEET
origin: SOURCE