minor + docs

Signed-off-by: Evgeniy Moiseenko <[email protected]>

Author: eupp

src/jvm/main/org/jetbrains/kotlinx/lincheck/strategy/managed/TraceReporter.kt

@@ -427,21 +427,10 @@ private fun isSyntheticFieldAccess(methodName: String): Boolean =
     methodName.contains("access\$get") || methodName.contains("access\$set")
 
 /**
- * Merges fun$default(...) calls.
- * Kotlin functions with default values are represented as two nested calls in the stack trace.
- * For example:
- * ```
- * A.calLMe$default(A#1, 3, null, 2, null) at A.operation(A.kt:23)
- *     A.callMe(3, "Hey") at A.callMe$default(A.kt:27)
- * ```
- * 
- * This function collapses such pairs in the provided [callStackTrace]:
+ * Merges two consecutive calls in the stack trace into one call if they form a compressible pair,
+ * see [isCompressiblePair] for details.
  *
- * ```
- * A.callMe(3, "Hey") at A.operation(A.kt:23)
- * ```
- * 
- * Since each tracePoint itself contains a [callStackTrace] of it's own,
+ * Since each tracePoint itself contains a [callStackTrace] of its own,
  * we need to recursively traverse each point.
  */
 private fun compressCallStackTrace(
@@ -471,9 +460,8 @@ private fun compressCallStackTrace(
             break
         }
 
-        // Check if current and next are a "default" or "access" combo
-        if (isDefaultPair(currentElement.tracePoint.methodName, nextElement.tracePoint.methodName)
-            || isAccessPair(currentElement.tracePoint.methodName, nextElement.tracePoint.methodName)) {
+        // Check if current and next are compressible
+        if (isCompressiblePair(currentElement.tracePoint.methodName, nextElement.tracePoint.methodName)) {
             // Combine fields of next and current, and store in current
             currentElement.tracePoint.methodName = nextElement.tracePoint.methodName
             currentElement.tracePoint.parameters = nextElement.tracePoint.parameters
@@ -509,22 +497,50 @@ private fun actorNodeResultRepresentation(result: Result?, failure: LincheckFail
     }
 }
 
+private fun isCompressiblePair(currentName: String, nextName: String): Boolean =
+    isDefaultPair(currentName, nextName) || isAccessPair(currentName, nextName)
+
 /**
- * Default pair example:
+ * Used by [compressCallStackTrace] to merge `fun$default(...)` calls.
+ *
+ * Kotlin functions with default values are represented as two nested calls in the stack trace.
+ *
+ * For example:
+ *
  * ```
  * A.calLMe$default(A#1, 3, null, 2, null) at A.operation(A.kt:23)
- *  A.callMe(3, "Hey") at A.callMe$default(A.kt:27)
- *```
+ *   A.callMe(3, "Hey") at A.callMe$default(A.kt:27)
+ * ```
+ *
+ * will be collapsed into:
+ *
+ * ```
+ * A.callMe(3, "Hey") at A.operation(A.kt:23)
+ * ```
+ *
  */
 private fun isDefaultPair(currentName: String, nextName: String): Boolean =
     currentName == "${nextName}\$default"
 
 /**
- * Access pair example:
+ * Used by [compressCallStackTrace] to merge `.access$` calls.
+ *
+ * The `.access$` methods are generated by the Kotlin compiler to access otherwise inaccessible members
+ * (e.g., private) from lambdas, inner classes, etc.
+ *
+ * For example:
+ *
  * ```
  * A.access$callMe() at A.operation(A.kt:N)
- *  A.callMe() at A.callMe$default(A.kt:N)
- *```
+ *  A.callMe() at A.access$callMe(A.kt:N)
+ * ```
+ *
+ * will be collapsed into:
+ *
+ * ```
+ * A.callMe() at A.operation(A.kt:N)
+ * ```
+ *
  */
 private fun isAccessPair(currentName: String, nextName: String): Boolean =
     currentName == "access$${nextName}"