krch/org.danbrough.krch/KrchContext

KrchContext

abstract class KrchContext<R : KrchContext.Command>(val scope:

CoroutineScope

, val envVarPrefix: String = "KRCH", val rootCommandName: String = "krch", val defaultHomeDirName: String = ".krch", val defaultConfigName: String = "krch.properties", contextBuilder:

Context.Builder

.() -> Unit = { autoEnvvarPrefix = envVarPrefix terminal = Terminal(ansiLevel = AnsiLevel.TRUECOLOR, interactive = false) })

Inheritors

KrchContextJVMAndroid

KrchContextNative

Constructors

constructor(scope:

CoroutineScope

, envVarPrefix: String = "KRCH", rootCommandName: String = "krch", defaultHomeDirName: String = ".krch", defaultConfigName: String = "krch.properties", contextBuilder:

Context.Builder

.() -> Unit = { autoEnvvarPrefix = envVarPrefix terminal = Terminal(ansiLevel = AnsiLevel.TRUECOLOR, interactive = false) })

Types

abstract class Command(name: String) : CliktCommand, AutoCloseable

open inner class RootCommand : KrchContext.Command

Top level command

Properties

open val configFilePath:

Path

coroutineContextDefault

open val coroutineContextDefault: CoroutineContext

coroutineContextIO

open val coroutineContextIO: CoroutineContext

coroutineContextMain

open val coroutineContextMain: CoroutineContext

defaultConfigName

val defaultConfigName: String

defaultHomeDirName

val defaultHomeDirName: String

val envVarPrefix: String

open val rootCommand: R

rootCommandName

val rootCommandName: String

var running: Boolean

val scope:

CoroutineScope

Functions

abstract fun getEnv(name: String): String?

fun KrchContext<*>.main(cmdLineArgs: Array<String>, commandMap: CommandMap)

fun onStop(handler: () -> Unit)

open fun pathToSink(path: String):

Sink

open fun pathToSource(path: String):

Source

registerCloseable

fun registerCloseable(closeable: AutoCloseable)

runInBackground

fun runInBackground(coroutineContext: CoroutineContext = coroutineContextDefault, block: suspend

CoroutineScope

.() -> Unit)

runInForeground

fun <T> runInForeground(block: suspend

CoroutineScope

.() -> T): T

abstract fun threadName(): String

waitForAllToFinish

suspend fun waitForAllToFinish()