0.0.1-SNAPSHOT

symbols/dev.rnett.symbolexport.symbol/Symbol

Symbol

sealed interface Symbol : NameLike(source)

A referenced Kotlin symbol.

Inheritors

Types

abstract class Annotation<S : Symbol.Annotation<S, I>, I : Symbol.Annotation.Instance<S, I>>(val packageName: NameSegments, val classNames: NameSegments) : Symbol.ClassLike

A full representation of an annotation, as opposed to Classifier which just represents the type. Includes all parameters and the ability to constructor Instances for a given set of arguments.

data class Classifier(val packageName: NameSegments, val classNames: NameSegments) : Symbol.ClassLike, Symbol.TypeParamHost

A class, interface, object, etc. Annotations may either be exported as a classifier (if @ExportSymbol is used) or as an Annotation (if @ExportAnnotation is used).

sealed interface ClassLike : Symbol, Symbol.NamedSymbol

A Classifier or Annotation. May include type aliases someday.

data class Constructor(val classifier: Symbol.Classifier) : Symbol.Member

A constructor of a Classifier.

ContextParameter

data class ContextParameter(val owner: Symbol.Member, val index: Int, val indexInContextParameters: Int, val name: String) : Symbol.Parameter

A context parameter of a Member.

DispatchReceiverParameter

data class DispatchReceiverParameter(val owner: Symbol.Member, val index: Int, val name: String) : Symbol.Parameter

The dispatch receiver parameter of a Member.

data class EnumEntry(val enumClass: Symbol.Classifier, val entryName: String, val entryOrdinal: Int) : Symbol, Symbol.NamedSymbol

An enum entry.

ExtensionReceiverParameter

data class ExtensionReceiverParameter(val owner: Symbol.Member, val index: Int, val name: String) : Symbol.Parameter

The extension receiver parameter of a Member.

sealed interface Member : Symbol, Symbol.TypeParamHost

A member. Either of a Classifier or as a top-level symbol.

NamedClassifierMember

data class NamedClassifierMember(val classifier: Symbol.Classifier, val name: String) : Symbol.NamedMember

A named Member of a Classifier.

sealed interface NamedMember : Symbol.Member, Symbol.NamedSymbol

A member with a meaningful name.

sealed interface NamedSymbol : Symbol

A symbol with a meaningful simple name. This is most symbols except Constructor.

sealed class Parameter : Symbol, Symbol.NamedSymbol

A parameter of a Member.

data class TopLevelMember(val packageName: NameSegments, val name: String) : Symbol.NamedMember

A top-level member.

data class TypeParameter(val owner: Symbol.TypeParamHost, val index: Int, val name: String) : Symbol, Symbol.NamedSymbol

A type parameter.

sealed interface TypeParamHost : Symbol

A symbol that can have type parameters.

data class ValueParameter(val owner: Symbol.Member, val index: Int, val indexInValueParameters: Int, val name: String) : Symbol.Parameter

A value parameter of a Member.

Properties

abstract val fullName: NameSegments

The fully qualified name of the symbol.

open override val nameSegments: List<String>

The segments of the fully qualified name of this symbol.

Functions

open override fun asString(): String

The fully qualified name as a string.

open operator fun plus(segment: String): NameSegments

Resolves segment after this.

open operator override fun plus(other: NameSegments): NameSegments

Resolves other after this.

open fun resolve(vararg segments: String): NameSegments

Resolves segments after this.