KaLibrarySourceModule¶
@SubclassOptInRequired(markerClass = [KaPlatformInterface::class])
interface KaLibrarySourceModule : KaModule
A module which represents the sources for a KaLibraryModule.
For example, when viewing a library file in an IDE, the library sources are usually preferred over the library's binary files (if available). The KaLibrarySourceModule represents exactly such sources.
The library source module's dependencies must be the same as its binaryLibrary's dependencies. In particular, the library source module must also depend on a single KaLibraryFallbackDependenciesModule if its exact dependencies are unknown.
Properties¶
baseContentScope¶
abstract val baseContentScope: GlobalSearchScope
A base content scope of the module, which is not yet refined by extension and restriction scopes provided by KotlinContentScopeRefiner.
Note that baseContentScope doesn't represent the actual content scope of the current module. To get a content scope of the module, contentScope should be used instead.
baseContextModuleOrSelf¶
The KaModule's baseContextModule, or the module itself if it's not a KaDanglingFileModule.
binaryLibrary¶
abstract val binaryLibrary: KaLibraryModule
The binary library which corresponds to the library sources.
For example, if this module is a source JAR, then binaryLibrary corresponds to the binary JAR.
compilerPluginGeneratedDeclarations¶
context(session: KaSession)
val KaModule.compilerPluginGeneratedDeclarations: KaCompilerPluginGeneratedDeclarations
Declarations generated by compiler plugins for this module, not including the generated declarations for dependencies of this module.
contentScope¶
abstract val contentScope: GlobalSearchScope
Represents the content scope of a current module, i.e., a GlobalSearchScope which determines all the files that are contained in the module.
This scope should be lazily built from baseContentScope using KotlinContentScopeRefiner extension points.
directDependsOnDependencies¶
abstract val directDependsOnDependencies: List<KaModule>
The module's dependsOn dependencies.
A dependsOn dependency expresses that the current module can provide actual declarations for expect declarations from the dependency module, as well as see internal symbols of the dependency module. As such, dependsOn dependencies are a Kotlin Multiplatform concept.
dependsOn dependencies in general are transitive, but the resulting list is not a transitive closure. To get all transitive dependsOn dependencies, transitiveDependsOnDependencies should be used. The list also does not include the current module.
directFriendDependencies¶
abstract val directFriendDependencies: List<KaModule>
The module's friend dependencies. Friend dependencies allow the current module to use internal symbols from the dependency module.
The resulting list is not transitive and does not include the current module.
directRegularDependencies¶
abstract val directRegularDependencies: List<KaModule>
The module's regular dependencies. Regular dependencies allow the current module to use symbols from the dependency module.
The resulting list is not transitive and does not include the current module.
isResolvable¶
val KaModule.isResolvable: Boolean
Whether the given KaModule can be the use-site module of an analyze call. A module which is not resolvable will be rejected by analyze with an exception.
All modules returned by KaModuleProvider.getModule are guaranteed to be resolvable. By extension, all possible use-site PsiElements are also part of resolvable modules. As such, module resolvability is normally not a concern of an Analysis API user.
libraryName¶
abstract val libraryName: String
The name of the library sources.
In practice, the specific format of the libraryName depends on the Analysis API platform which provides the KaLibraryModule implementation.
moduleDescription¶
open override val moduleDescription: String
A human-readable description of the module, such as "main sources of module 'analysis-api'".
project¶
abstract val project: Project
The Project to which the module belongs.
All the module's dependencies should belong to the same Project as the module itself.
stableModuleName¶
open val stableModuleName: String?
A stable binary name of module from the Kotlin point of view. Having a correct module name is critical for internal-visibility mangling.
NOTE: stableModuleName will be removed in the future and replaced with a platform interface service.
targetPlatform¶
abstract val targetPlatform: TargetPlatform
A platform which the module represents (e.g, JVM, JS, Native).
See also
- TargetPlatform
transitiveDependsOnDependencies¶
abstract val transitiveDependsOnDependencies: List<KaModule>
A list of directDependsOnDependencies and all of their own dependsOn dependencies (directly and indirectly), sorted topologically with the nearest dependencies first in the list. The list does not include the current module.
Functions¶
allDirectDependencies¶
A list of all modules that the given module directly depends on.
See also
allDirectDependenciesOfType¶
A list of all modules of type M that the given module directly depends on.
See also
directDependsOnDependenciesOfType¶
A list of all modules of type M that the given module directly depends on with a depends-on dependency.
See also
directFriendDependenciesOfType¶
A list of all modules of type M that the given module directly depends on with a friend dependency.
See also
directRegularDependenciesOfType¶
A list of all modules of type M that the given module directly depends on with a regular dependency.
See also