ColorTheme.kt

@file:Suppress("SpellCheckingInspection")

package org.hexworks.zircon.api.component

import org.hexworks.zircon.api.builder.component.ColorThemeBuilder
import org.hexworks.zircon.api.builder.component.ComponentStyleSetBuilder
import org.hexworks.zircon.api.builder.graphics.StyleSetBuilder
import org.hexworks.zircon.api.color.TileColor
import org.hexworks.zircon.api.component.data.ComponentState

/**
 * A [ColorTheme] can be used to give a [Component] context-dependent styles.
 * The current style depends on the [ComponentState] of the [Component].
 * For each [ComponentState] there is a corresponding [ComponentStyleSet]
 * that gets applied whenever the state of the [Component] changes.
 * These states include:
 * - [ComponentState.ACTIVE]
 * - [ComponentState.DEFAULT]
 * - [ComponentState.DISABLED]
 * - [ComponentState.FOCUSED]
 * - [ComponentState.HIGHLIGHTED]
 * @see ComponentState and
 * @see ComponentStyleSet for more info
 */
interface ColorTheme {

    /**
     * A unique name for this [ColorTheme].
     */
    val name: String

    /**
     * This color is typically used for the text of non-interactive components
     * that have emphasis on them (like [Header]s).
     */
    val primaryForegroundColor: TileColor

    /**
     * This color is typically used for the text of non-interactive components
     * that don't have emphasis on them (like [Paragraph]s).
     */
    val secondaryForegroundColor: TileColor

    /**
     * This color is typically used for the background of [Container]s.
     */
    val primaryBackgroundColor: TileColor

    /**
     * This color is typically used for the root container.
     */
    val secondaryBackgroundColor: TileColor

    /**
     * This color is typically used for the text and decorations of interactive components.
     */
    val accentColor: TileColor

    val isUnknown: Boolean
        get() = this === UNKNOWN

    val isNotUnknown: Boolean
        get() = isUnknown.not()

    @Deprecated(
        message = "contains a typo, use toInteractiveStyle instead",
        replaceWith = ReplaceWith("this.toInteractiveStyle()")
    )
    fun toInteractableStyle(): ComponentStyleSet = toInteractiveStyle()

    /**
     * Creates a [ComponentStyleSet] which is intended to be used as a default
     * for interactive components (eg: [Button]s, [ToggleButton]s and so on).
     */
    fun toInteractiveStyle(): ComponentStyleSet = ComponentStyleSetBuilder.newBuilder()
        .withDefaultStyle(
            StyleSetBuilder.newBuilder()
                .withForegroundColor(accentColor)
                .withBackgroundColor(TileColor.transparent())
                .build()
        )
        .withHighlightedStyle(
            StyleSetBuilder.newBuilder()
                .withForegroundColor(secondaryForegroundColor)
                .withBackgroundColor(accentColor)
                .build()
        )
        .withFocusedStyle(
            StyleSetBuilder.newBuilder()
                .withForegroundColor(primaryBackgroundColor)
                .withBackgroundColor(accentColor)
                .build()
        )
        .withActiveStyle(
            StyleSetBuilder.newBuilder()
                .withForegroundColor(primaryForegroundColor)
                .withBackgroundColor(accentColor)
                .build()
        )
        .withDisabledStyle(
            StyleSetBuilder.newBuilder()
                .withForegroundColor(accentColor.desaturate(.85).darkenByPercent(.1))
                .withBackgroundColor(TileColor.transparent())
                .build()
        )
        .build()

    /**
     * Creates a [ComponentStyleSet] which is intended to be used as a default
     * for containers (eg: [Panel]s, [HBox]es, [VBox]es.
     */
    fun toContainerStyle(): ComponentStyleSet = ComponentStyleSetBuilder.newBuilder()
        .withDefaultStyle(
            StyleSetBuilder.newBuilder()
                .withForegroundColor(secondaryForegroundColor)
                .withBackgroundColor(primaryBackgroundColor)
                .build()
        )
        .withDisabledStyle(
            StyleSetBuilder.newBuilder()
                .withForegroundColor(secondaryForegroundColor.desaturate(.85).darkenByPercent(.1))
                .withBackgroundColor(primaryBackgroundColor.desaturate(.85).darkenByPercent(.1))
                .build()
        )
        .build()

    /**
     * Creates a [ComponentStyleSet] which is intended to be used as a default
     * for emphasized content (eg: [Header]s).
     */
    fun toPrimaryContentStyle(): ComponentStyleSet = ComponentStyleSetBuilder.newBuilder()
        .withDefaultStyle(
            StyleSetBuilder.newBuilder()
                .withForegroundColor(primaryForegroundColor)
                .withBackgroundColor(TileColor.transparent())
                .build()
        )
        .withDisabledStyle(
            StyleSetBuilder.newBuilder()
                .withForegroundColor(primaryForegroundColor.desaturate(.85).darkenByPercent(.1))
                .withBackgroundColor(TileColor.transparent())
                .build()
        )
        .build()

    /**
     * Creates a [ComponentStyleSet] which is intended to be used as a default
     * for non-emphasized content (eg: [Label]s, [Paragraph]s, and so on).
     */
    fun toSecondaryContentStyle(): ComponentStyleSet = ComponentStyleSetBuilder.newBuilder()
        .withDefaultStyle(
            StyleSetBuilder.newBuilder()
                .withForegroundColor(secondaryForegroundColor)
                .withBackgroundColor(TileColor.transparent())
                .build()
        )
        .withDisabledStyle(
            StyleSetBuilder.newBuilder()
                .withForegroundColor(secondaryForegroundColor.desaturate(.85).darkenByPercent(.1))
                .withBackgroundColor(TileColor.transparent())
                .build()
        )
        .build()

    companion object {

        private val UNKNOWN = ColorThemeBuilder.newBuilder()
            .withName("unknown")
            .build()

        fun unknown() = UNKNOWN

    }
}