From b40592fcf3a7ef965dbe688276326e07bfe953ef Mon Sep 17 00:00:00 2001
From: Roman Golyshev <roman.golyshev@jetbrains.com>
Date: Mon, 15 Nov 2021 17:01:35 +0300
Subject: [PATCH] Rename some functions in
 `FirAbstractAnnotationResolveTransformer`

Also add a kdoc for them
---
 ...FirAbstractAnnotationResolveTransformer.kt | 33 +++++++++++++------
 .../FirPluginAnnotationsResolveTransformer.kt |  6 ++--
 2 files changed, 26 insertions(+), 13 deletions(-)

diff --git a/compiler/fir/resolve/src/org/jetbrains/kotlin/fir/resolve/transformers/plugin/FirAbstractAnnotationResolveTransformer.kt b/compiler/fir/resolve/src/org/jetbrains/kotlin/fir/resolve/transformers/plugin/FirAbstractAnnotationResolveTransformer.kt
index c03e38ea981..f0fafea37a9 100644
--- a/compiler/fir/resolve/src/org/jetbrains/kotlin/fir/resolve/transformers/plugin/FirAbstractAnnotationResolveTransformer.kt
+++ b/compiler/fir/resolve/src/org/jetbrains/kotlin/fir/resolve/transformers/plugin/FirAbstractAnnotationResolveTransformer.kt
@@ -27,9 +27,9 @@ internal abstract class FirAbstractAnnotationResolveTransformer<D, S>(
 
     override fun transformFile(file: FirFile, data: D): FirFile {
         scopes = createImportingScopes(file, session, scopeSession, useCaching = false)
-        val state = beforeChildren(file)
+        val state = beforeTransformingChildren(file)
         file.transformDeclarations(this, data)
-        afterChildren(state)
+        afterTransformingChildren(state)
         return transformDeclaration(file, data) as FirFile
     }
 
@@ -42,11 +42,11 @@ internal abstract class FirAbstractAnnotationResolveTransformer<D, S>(
         data: D
     ): FirStatement {
         return transformDeclaration(regularClass, data).also {
-            val state = beforeChildren(regularClass)
+            val state = beforeTransformingChildren(regularClass)
             regularClass.transformDeclarations(this, data)
             regularClass.transformCompanionObject(this, data)
             regularClass.transformSuperTypeRefs(this, data)
-            afterChildren(state)
+            afterTransformingChildren(state)
         } as FirStatement
     }
 
@@ -55,9 +55,9 @@ internal abstract class FirAbstractAnnotationResolveTransformer<D, S>(
         data: D
     ): FirSimpleFunction {
         return transformDeclaration(simpleFunction, data).also {
-            val state = beforeChildren(simpleFunction)
+            val state = beforeTransformingChildren(simpleFunction)
             simpleFunction.transformValueParameters(this, data)
-            afterChildren(state)
+            afterTransformingChildren(state)
         } as FirSimpleFunction
     }
 
@@ -66,9 +66,9 @@ internal abstract class FirAbstractAnnotationResolveTransformer<D, S>(
         data: D
     ): FirConstructor {
         return transformDeclaration(constructor, data).also {
-            val state = beforeChildren(constructor)
+            val state = beforeTransformingChildren(constructor)
             constructor.transformValueParameters(this, data)
-            afterChildren(state)
+            afterTransformingChildren(state)
         } as FirConstructor
     }
 
@@ -102,9 +102,22 @@ internal abstract class FirAbstractAnnotationResolveTransformer<D, S>(
         return element
     }
 
-    protected open fun beforeChildren(declaration: FirDeclaration): S? {
+    /**
+     * Gets called before transforming [parentDeclaration]'s nested declarations (like in a class of a file).
+     *
+     * @param parentDeclaration A declaration whose nested declarations are about to be transformed.
+     * @return Some state of the transformer; when the nested declarations are transformed, this state will be
+     * passed to the [afterTransformingChildren].
+     */
+    protected open fun beforeTransformingChildren(parentDeclaration: FirDeclaration): S? {
         return null
     }
 
-    protected open fun afterChildren(state: S?) {}
+    /**
+     * Gets called after performing transformation of some declaration's nested declarations; can be used to restore the internal
+     * state of the transformer.
+     *
+     * @param state A state produced by the [beforeTransformingChildren] call before the transformation.
+     */
+    protected open fun afterTransformingChildren(state: S?) {}
 }
diff --git a/compiler/fir/resolve/src/org/jetbrains/kotlin/fir/resolve/transformers/plugin/FirPluginAnnotationsResolveTransformer.kt b/compiler/fir/resolve/src/org/jetbrains/kotlin/fir/resolve/transformers/plugin/FirPluginAnnotationsResolveTransformer.kt
index 84ab3459029..79b8974e726 100644
--- a/compiler/fir/resolve/src/org/jetbrains/kotlin/fir/resolve/transformers/plugin/FirPluginAnnotationsResolveTransformer.kt
+++ b/compiler/fir/resolve/src/org/jetbrains/kotlin/fir/resolve/transformers/plugin/FirPluginAnnotationsResolveTransformer.kt
@@ -94,13 +94,13 @@ private class FirAnnotationResolveTransformer(
     private var owners: PersistentList<FirDeclaration> = persistentListOf()
     private val classDeclarationsStack = ArrayDeque<FirRegularClass>()
 
-    override fun beforeChildren(declaration: FirDeclaration): PersistentList<FirDeclaration> {
+    override fun beforeTransformingChildren(parentDeclaration: FirDeclaration): PersistentList<FirDeclaration> {
         val current = owners
-        owners = owners.add(declaration)
+        owners = owners.add(parentDeclaration)
         return current
     }
 
-    override fun afterChildren(state: PersistentList<FirDeclaration>?) {
+    override fun afterTransformingChildren(state: PersistentList<FirDeclaration>?) {
         requireNotNull(state)
         owners = state
     }