org.jetbrains.kotlin.analysis.api.platform.modification¶

KaElementModificationType describes which kind of modification was applied to a changed PsiElement. KaSourceModificationService uses this information to perform change locality detection.

KaSourceModificationLocality describes the scope of effect of a source modification detected by KaSourceModificationService.

KaSourceModificationService is an engine service which handles cache invalidation after source code changes:

This event signals that the context of any code fragment depending on module is changing. All code fragments depending on module, both directly or transitively, should be considered modified when this event is received.

This event signals that project settings or project structure are changing possibly globally.

This event signals that Kotlin script module settings or structure are changing possibly globally.

KotlinGlobalSourceModuleStateModificationEvent signals that source module settings or structure are changing possibly globally.

KotlinGlobalSourceOutOfBlockModificationEvent signals that out-of-block modification is occurring possibly globally.

In the Analysis API, KotlinModificationEvents signal changes in source code, module and project settings, or project structure. These events should be subscribed to and published via the TOPIC on the Analysis API message bus. They must be published in a write action.

KotlinModificationEventKind represents the kinds of KotlinModificationEvents. While it is not required to publish or subscribe to modification events, it can be useful when abstracting over modification events in general, for example in tests.

A listener for KotlinModificationEvents. It should be registered on the analysisMessageBus with KotlinModificationEvent.TOPIC.

A base implementation of KotlinModificationTrackerFactory which defines basic modification trackers that are incremented after receiving KotlinModificationEvents.

KotlinModificationTrackerFactory creates modification trackers for sources and libraries.

This event signals that an out-of-block modification is occurring in the sources of module.

This event signals that module's settings or structure are changing. The event is published in a write action before the module is updated or removed (see KotlinModuleStateModificationKind for specifics). This allows subscribers to access the module's properties and dependencies to invalidate or update caches.

Describes the kind of module state modification affecting a KaModule in more detail.

Creates a ModificationTracker which is incremented every time a library in the project is changed.

Creates a ModificationTracker which is incremented every time a Kotlin source file is affected by a modification, in any of the project's source modules.

Publishes a KotlinCodeFragmentContextModificationEvent for this KaModule. Must be called in a write action.

Publishes a KotlinGlobalModuleStateModificationEvent. Must be called in a write action.

Publishes a KotlinGlobalScriptModuleStateModificationEvent. Must be called in a write action.

Publishes a KotlinGlobalSourceModuleStateModificationEvent. Must be called in a write action.

Publishes a KotlinGlobalSourceOutOfBlockModificationEvent. Must be called in a write action.

Publishes a KotlinModificationEvent to the project's analysisMessageBus. Must be called in a write action.

Publishes a KotlinModuleOutOfBlockModificationEvent for this KaModule. Must be called in a write action.

Publishes a KotlinModuleStateModificationEvent for this KaModule. Must be called in a write action.