library/io.github.baole.konture/SourceUsage

SourceUsage

@Serializable

data class SourceUsage(val kind: UsageKind, val targetFqName: String, val filePath: String, val line: Int, val column: Int, val enclosingFunction: String? = null, val enclosingClass: String? = null, val enclosingProperty: String? = null, val rawExpression: String = targetFqName, val sourceSets: List<SourceSetId> = emptyList(), val possibleTargetFqNames: List<String> = emptyList(), val unresolvedPossibleUsage: Boolean = false, val confidence: ResolutionConfidence = if (unresolvedPossibleUsage) { ResolutionConfidence.POSSIBLE } else { ResolutionConfidence.RESOLVED }, val sourceStartOffset: Int = -1, val sourceEndOffset: Int = -1, val enclosingFunctionStartOffset: Int = -1, val enclosingFunctionEndOffset: Int = -1)

A resolved (or conservatively possible) Kotlin source usage.

Constructors

constructor(kind: UsageKind, targetFqName: String, filePath: String, line: Int, column: Int, enclosingFunction: String? = null, enclosingClass: String? = null, enclosingProperty: String? = null, rawExpression: String = targetFqName, sourceSets: List<SourceSetId> = emptyList(), possibleTargetFqNames: List<String> = emptyList(), unresolvedPossibleUsage: Boolean = false, confidence: ResolutionConfidence = if (unresolvedPossibleUsage) { ResolutionConfidence.POSSIBLE } else { ResolutionConfidence.RESOLVED }, sourceStartOffset: Int = -1, sourceEndOffset: Int = -1, enclosingFunctionStartOffset: Int = -1, enclosingFunctionEndOffset: Int = -1)

Properties

val column: Int

Filter or assertion criteria for column.

val confidence: ResolutionConfidence

Filter or assertion criteria for confidence.

val enclosingClass: String? = null

Filter or assertion criteria for enclosing class.

enclosingFunction

val enclosingFunction: String? = null

Filter or assertion criteria for enclosing function.

enclosingFunctionEndOffset

val enclosingFunctionEndOffset: Int

Filter or assertion criteria for enclosing function end offset.

enclosingFunctionStartOffset

val enclosingFunctionStartOffset: Int

Filter or assertion criteria for enclosing function start offset.

enclosingProperty

val enclosingProperty: String? = null

Filter or assertion criteria for enclosing property.

val filePath: String

Filter or assertion criteria for file path.

val kind: UsageKind

Filter or assertion criteria for kind.

Filter or assertion criteria for line.

possibleTargetFqNames

val possibleTargetFqNames: List<String>

Filter or assertion criteria for possible target fq names.

val rawExpression: String

Filter or assertion criteria for raw expression.

sourceEndOffset

val sourceEndOffset: Int

Filter or assertion criteria for source end offset.

val sourceSets: List<SourceSetId>

Filter or assertion criteria for source sets.

sourceStartOffset

val sourceStartOffset: Int

Filter or assertion criteria for source start offset.

val targetFqName: String

Filter or assertion criteria for target fq name.

unresolvedPossibleUsage

val unresolvedPossibleUsage: Boolean = false

Filter or assertion criteria for unresolved possible usage.

Functions

isEnclosedInClass

fun SourceUsage.isEnclosedInClass(classFqName: String, className: String? = null): Boolean

Returns true if this usage is enclosed in the class specified by classFqName and optional className.

isEnclosedInProperty

fun SourceUsage.isEnclosedInProperty(propertyName: String, classFqName: String? = null, className: String? = null): Boolean

Returns true if this usage is enclosed in the property specified by propertyName and optional class contexts.