org.jetbrains.kotlin.analysis.api.base.KaConstantValue.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2010-2021 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.api.base

import org.jetbrains.kotlin.psi.KtElement
import org.jetbrains.kotlin.types.ConstantValueKind

/**
 * Represents a constant value.
 * Can be used as a `const val` initializer or as an annotation argument.
 *
 * [KaConstantValue] can also represent evaluated values. Such as, the `1 + 2` can be represented as an [IntValue] with a value `3`.
 *
 * For more info on constant values, see the [Kotlin documentation](https://kotlinlang.org/docs/properties.html#compile-time-constants]).
 */
public sealed interface KaConstantValue {
    /**
     * The constant.
     * Type of [value] matches its represented class, e.g. [BooleanValue.value] will return a [Boolean].
     *
     * Note that for [NullValue] and [ErrorValue], special values are returned.
     */
    public val value: Any?

    @Deprecated("Check the class type instead.")
    public val constantValueKind: ConstantValueKind

    /**
     * A source element from which the value was created.
     * Might be `null` for constants from non-source files.
     */
    public val sourcePsi: KtElement?

    /**
     * Renders the value as a representable constant value [String].
     * E.g., `1`, `2f, `3u` `null`, `"text"`.
     */
    public fun render(): String

    @Deprecated("Use 'render()' instead.", replaceWith = ReplaceWith("render()"))
    public fun renderAsKotlinConstant(): String = render()

    /** Represents a `null` value of some class type. */
    public interface NullValue : KaConstantValue

    /** Represents a [Boolean] value. */
    public interface BooleanValue : KaConstantValue {
        override val value: Boolean
    }

    /** Represents a [Char] value. */
    public interface CharValue : KaConstantValue {
        override val value: Char
    }

    /** Represents a [Byte] value. */
    public interface ByteValue : KaConstantValue {
        override val value: Byte
    }

    /** Represents a [UByte] value. */
    public interface UByteValue : KaConstantValue {
        override val value: UByte
    }

    /** Represents a [Short] value. */
    public interface ShortValue : KaConstantValue {
        override val value: Short
    }

    /** Represents a [UShort] value. */
    public interface UShortValue : KaConstantValue {
        override val value: UShort
    }

    /** Represents an [Int] value. */
    public interface IntValue : KaConstantValue {
        override val value: Int
    }

    /** Represents a [UInt] value. */
    public interface UIntValue : KaConstantValue {
        override val value: UInt
    }

    /** Represents a [Long] value. */
    public interface LongValue : KaConstantValue {
        override val value: Long
    }

    /** Represents a [ULong] value. */
    public interface ULongValue : KaConstantValue {
        override val value: ULong
    }

    /** Represents a [Float] value. */
    public interface FloatValue : KaConstantValue {
        override val value: Float
    }

    /** Represents a [Double] value. */
    public interface DoubleValue : KaConstantValue {
        override val value: Double
    }

    /** Represents a [String] value. */
    public interface StringValue : KaConstantValue {
        override val value: String
    }

    /** Represents either a non-constant value, or a constant evaluation error (such as, a division by zero). */
    public interface ErrorValue : KaConstantValue {
        public val errorMessage: String
        override val value: Nothing
    }

    @Deprecated("Use 'NullValue' instead.", replaceWith = ReplaceWith("NullValue"))
    public interface KaNullConstantValue : NullValue

    @Deprecated("Use 'BooleanValue' instead.", replaceWith = ReplaceWith("BooleanValue"))
    public interface KaBooleanConstantValue : BooleanValue

    @Deprecated("Use 'CharValue' instead.", replaceWith = ReplaceWith("CharValue"))
    public interface KaCharConstantValue : CharValue

    @Deprecated("Use 'ByteValue' instead.", replaceWith = ReplaceWith("ByteValue"))
    public interface KaByteConstantValue : ByteValue

    @Deprecated("Use 'UByteValue' instead.", replaceWith = ReplaceWith("UByteValue"))
    public interface KaUnsignedByteConstantValue : UByteValue

    @Deprecated("Use 'ShortValue' instead.", replaceWith = ReplaceWith("ShortValue"))
    public interface KaShortConstantValue : ShortValue

    @Deprecated("Use 'UShortValue' instead.", replaceWith = ReplaceWith("UShortValue"))
    public interface KaUnsignedShortConstantValue : UShortValue

    @Deprecated("Use 'IntValue' instead.", replaceWith = ReplaceWith("IntValue"))
    public interface KaIntConstantValue : IntValue

    @Deprecated("Use 'UIntValue' instead.", replaceWith = ReplaceWith("UIntValue"))
    public interface KaUnsignedIntConstantValue : UIntValue

    @Deprecated("Use 'LongValue' instead.", replaceWith = ReplaceWith("LongValue"))
    public interface KaLongConstantValue : LongValue

    @Deprecated("Use 'ULongValue' instead.", replaceWith = ReplaceWith("ULongValue"))
    public interface KaUnsignedLongConstantValue : ULongValue

    @Deprecated("Use 'FloatValue' instead.", replaceWith = ReplaceWith("FloatValue"))
    public interface KaFloatConstantValue : FloatValue

    @Deprecated("Use 'DoubleValue' instead.", replaceWith = ReplaceWith("DoubleValue"))
    public interface KaDoubleConstantValue : DoubleValue

    @Deprecated("Use 'StringValue' instead.", replaceWith = ReplaceWith("StringValue"))
    public interface KaStringConstantValue : StringValue

    @Deprecated("Use 'ErrorValue' instead.", replaceWith = ReplaceWith("ErrorValue"))
    public interface KaErrorConstantValue : ErrorValue
}

@Deprecated("Use 'KaConstantValue' instead.", ReplaceWith("KaConstantValue"))
public typealias KtConstantValue = KaConstantValue