commonMain.com.bkahlert.kommons.Platform.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kommons-core-jvm Show documentation

Kommons Core is a Kotlin Multiplatform Library that offers shared features for all Kommons modules.

There is a newer version: 2.8.0

package com.bkahlert.kommons

/** Platforms a program can run on. */
public expect enum class Platform {

    /** Browser platform */
    Browser,

    /** NodeJS platform */
    NodeJS,

    /** Java virtual machine */
    JVM,

    /** Native platform */
    Native,
    ;

    public companion object {
        /** The platform this program runs on. */
        public val Current: Platform
    }

    /** Supported level for [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code). */
    public val ansiSupport: AnsiSupport

    /** The separator used to separate path segments. */
    public val fileSeparator: String
}

/** Support level for [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code). */
public enum class AnsiSupport {
    /** Denotes no support for ANSI escape codes. */
    NONE,

    /** Denotes support for [4-Bit ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code#3-bit_and_4-bit). */
    ANSI4,

    /** Denotes support for [8-Bit ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit). */
    ANSI8,

    /** Denotes support for [24-Bit ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code#24-bit). */
    ANSI24
}