KaDanglingFileModule¶

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.

The non-dangling module that represents the base context of the KaDanglingFileModule, skipping any context modules which are themselves KaDanglingFileModules.

When a dangling file is a code fragment, the dangling file module may itself have a dangling file module as a context. baseContextModule can be used to find the non-dangling context at the base of the chain.

See also

• KaDanglingFileModule.contextModule

The KaModule's baseContextModule, or the module itself if it's not a KaDanglingFileModule.

Declarations generated by compiler plugins for this module, not including the generated declarations for dependencies of this module.

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.

The module against which files are analyzed.

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.

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.

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.

All dangling files analyzed together, as a single module.

Throws an exception when the files are no longer valid (see isValid).

Whether at least one of the files is a code fragment.

This is useful to recognize code fragments when their PSI was collected.

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.

Whether the dangling file module supports partial invalidation on PSI modifications. The sessions for such modules can be cached for a longer time.

For a dangling file module to be stable, its context module must also be stable. Otherwise, cache inconsistencies may occur.

In more detail, caches for unstable dangling file modules are invalidated after any PSI modification, while stable dangling file modules react to modification events. A stable module with an unstable context risks cache inconsistencies, as the context module's invalidation scope is much broader.

Whether the dangling file module's files are still valid.

See also

• KtFile.isValid

A human-readable description of the module, such as "main sources of module 'analysis-api'".

The Project to which the module belongs.

All the module's dependencies should belong to the same Project as the module itself.

The mode which determines how references to non-local declarations in the dangling file are resolved.

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.

A platform which the module represents (e.g, JVM, JS, Native).

See also

• TargetPlatform

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.

A list of all modules that the given module directly depends on.

See also

• KaModule.directRegularDependencies
• KaModule.directDependsOnDependencies
• KaModule.directFriendDependencies

A list of all modules of type M that the given module directly depends on.

See also

• KaModule.directRegularDependencies
• KaModule.directDependsOnDependencies
• KaModule.directFriendDependencies

A list of all modules of type M that the given module directly depends on with a depends-on dependency.

See also

• KaModule.directDependsOnDependencies

A list of all modules of type M that the given module directly depends on with a friend dependency.

See also

• KaModule.directFriendDependencies

A list of all modules of type M that the given module directly depends on with a regular dependency.

See also

• KaModule.directRegularDependencies