Skip to content

KaCompoundVariableAccessCall

@SubclassOptInRequired(markerClass = [KaImplementationDetail::class])
interface KaCompoundVariableAccessCall : KaMultiCall, KaCall, KaCompoundAccessCall

A compound access of a mutable variable. Such accesses combine reading, modifying, and writing to the variable in a single expression, using operators like +=, -=, ++, or --.

Example

fun test() {
  var i = 0
  i += 1
  // variablePartiallyAppliedSymbol: {
  //   symbol: `i`
  //   dispatchReceiver: null
  //   extensionReceiver: null
  // }
  // accessType: OpAssign {
  //   kind: PLUS
  //   operand: 1
  //   operationSymbol: Int.plus()
  // }

  i++
  // variablePartiallyAppliedSymbol: {
  //   symbol: `i`
  //   dispatchReceiver: null
  //   extensionReceiver: null
  // }
  // accessType: IncDec {
  //   kind: INC
  //   precedence: POSTFIX
  //   operationSymbol: Int.inc()
  // }
}

<op>Assign function calls

If the variable has an <op>Assign operator, then it's represented as a simple KaFunctionCall:

fun test(m: MutableList<String>) {
  m += "a" //
}

m += "a" is a simple KaFunctionCall to MutableList.plusAssign, not a KaCompoundVariableAccessCall. However, the dispatch receiver of this call, m, is a simple read access represented as a KaVariableAccessCall.

Properties

calls

abstract val calls: List<KaSimpleCall<*, *>>

The non-empty list of KaSimpleCalls that were discovered during resolution of KtResolvableCall

calls

The list of KaCalls associated with the KaCallInfo. The list contains a single KaCall in case of a successful call, but may contain multiple candidates in case of an error call.

The flattened list of resolved calls.

The flattened list of KaSimpleCalls.

compoundOperation

The corresponding compound operation.

constructor

this call as a call to a constructor, or null if it is not a constructor call.

Example

annotation class Anno

class Foo

@Anno
fun usage() {
   Foo()
}

Both the Foo() call and the @Anno annotation entry are constructor calls, so constructor returns the call itself.

See also

function

this call as a KaFunctionCall, or null if it is not a call to a function.

Example

class Foo {
   fun function() {}
   var int: Int = 1
}

fun Foo.usage() {
   function()
   int
}

For function(), function is the call to function. For int, which is a KaVariableAccessCall, function is null.

See also

operationCall

Represents a call of the operator

simple

this call as a KaSimpleCall, or null if it is a KaMultiCall.

Example

var int: Int = 1

fun usage() {
   int = 2
   int++
}

For int = 2, simple is the write access to int. For int++, which is a KaMultiCall, simple is null.

See also

symbols

The flattened list of KaSymbols for the resolved calls.

A list of KaSymbol.

See also

token

abstract val token: KaLifetimeToken

The KaLifetimeToken which determines the lifetime of the lifetime owner.

variable

this call as a KaVariableAccessCall, or null if it is not an access to a variable.

Example

class Foo {
   fun function() {}
   var int: Int = 1
}

fun Foo.usage() {
   int
   function()
}

For int, variable is the read access to int. For function(), which is a KaFunctionCall, variable is null.

See also

variableCall

Represents a call of the mutated variable

Functions

assertIsValidAndAccessible

isValid

Whether the lifetime owner is still valid, i.e. we are still in the scope of the lifetime owner's regular lifetime.

withValidityAssertion

inline fun <R> KaLifetimeOwner.withValidityAssertion(action: () -> R): R

Executes action only if the KaLifetimeOwner is still valid and accessible. Otherwise, throws a validity exception based on the concrete violation.