org.jetbrains.kotlin.analysis.providers.KotlinMessageBusProvider.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlin-compiler-embeddable Show documentation

the Kotlin compiler embeddable

There is a newer version: 2.1.0-RC

Show newest version

/*
 * Copyright 2010-2023 JetBrains s.r.o. and Kotlin Programming Language contributors.
 * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
 */

package org.jetbrains.kotlin.analysis.providers

import com.intellij.openapi.project.Project
import com.intellij.util.messages.MessageBus
import org.jetbrains.kotlin.analysis.providers.topics.KotlinTopics

/**
 * [KotlinMessageBusProvider] allows Analysis API implementations to provide a custom [MessageBus]. When subscribing to or publishing to
 * Analysis API topics ([KotlinTopics]), the message bus provided by [getMessageBus] should be used, not the [Project]'s message bus.
 */
public interface KotlinMessageBusProvider {
    public fun getMessageBus(): MessageBus

    public companion object {
        public fun getInstance(project: Project): KotlinMessageBusProvider =
            project.getService(KotlinMessageBusProvider::class.java)
    }
}

/**
 * The [MessageBus] used to subscribe to and publish to Analysis API topics ([KotlinTopics]).
 */
public val Project.analysisMessageBus: MessageBus
    get() = KotlinMessageBusProvider.getInstance(this).getMessageBus()