Koremods/wtf.gofancy.koremods

Package-level declarations

Types

CompileEvalLoad

class CompileEvalLoad(val libraries: Array<out String>) : LoaderMode

Compiles Koremods Scripts in source form with the supplied libraries.

EvalLoad

object EvalLoad : LoaderMode

Evaluates compiled Koremods Scripts.

Identifier

data class Identifier(val namespace: String, val name: String) : Serializable

Uniquely identifies objects within Koremods, such as scripts and transformers. Both namespaces and names must follow a set of rules and are check against their respective patterns - NAMESPACE_PATTERN for namespaces and NAME_PATTERN for names.

KJvmCompiledScriptLoadedFromJar

internal class KJvmCompiledScriptLoadedFromJar(scriptClassFQName: String, path: Path) : CompiledScript

Represents a CompiledScript loaded from a Path. The script will prefer the ClassLoader created by the active KoremodsLaunchPlugin if available.

KoremodsLoader

class KoremodsLoader(mode: LoaderMode)

Handles locating, parsing, evaluating and optionally compiling Koremods Scripts and Koremods Script Packs.

KoremodsPackConfig

data class KoremodsPackConfig(val namespace: String, val scripts: List<String>)

Dedicated Koremods script pack config

KoremodsScript

data class KoremodsScript(val identifier: Identifier, val handler: TransformerHandler)

A loaded and initialized Koremods Script.

KoremodsScriptPack

data class KoremodsScriptPack(val namespace: String, val path: Path, val scripts: List<KoremodsScript>)

A loaded and initialized Koremods Script Pack.

LoaderMode

sealed class LoaderMode(val extension: String)

Defines behavior for how Koremods should proceed when loading Script Packs.

MemoryClassLoader

internal class MemoryClassLoader(resources: Map<String, ByteArray>, parent: ClassLoader?) : ClassLoader

Loads classes from bytes stored in program memory. Used by KJvmCompiledScriptLoadedFromJar to load compiled script classes.

PathScriptSource

class PathScriptSource(path: Path) : ExternalSourceCode, Serializable

A Script Source that points to a java NIO Path.

RawScript

data class RawScript<T>(val identifier: Identifier, val source: T)

Represents a Koremods Script in raw, unfinalized form with a source attached.

RawScriptPack

data class RawScriptPack<T>(val namespace: String, val path: Path, val scripts: List<RawScript<T>>)

Represents a Koremods Script Pack in raw, unfinalized form with script sources.

ScriptEvaluationException

class ScriptEvaluationException(msg: String, cause: Throwable? = null) : RuntimeException

An exception thrown when an error is encountered during the script evaluation process.

Properties

CONFIG_FILE

const val CONFIG_FILE: String

File name used by both global and script pack config files

CONFIG_FILE_LOCATION

const val CONFIG_FILE_LOCATION: String

Path to a script pack's configuration file relative to its root

LOGGER_GROUP

const val LOGGER_GROUP: String

Logger name prefix used by Koremods logger instances

NAMESPACE

const val NAMESPACE: String

Koremods self identifier.

Functions

applyTransform

fun <T : Transformer<U>, U> applyTransform(identifier: Any, transformers: List<T>, node: U): Collection<TransformerPropertiesStore>

Transform an ASM node using Koremods Transformers

compileScript

fun compileScript(identifier: Identifier, source: SourceCode, configBuilder: ScriptCompilationConfiguration.Builder.() -> Unit): ResultWithDiagnostics<CompiledScript>

Invoke the kotlin script compiler.

compileScriptPacks

internal fun compileScriptPacks(packs: Collection<RawScriptPack<SourceCode>>, libraries: Array<out String> = emptyArray()): List<RawScriptPack<CompiledScript>>

Process and compile scripts from each script pack, returning a new list of packs with the compiled results.

compileScriptResult

fun compileScriptResult(identifier: Identifier, source: SourceCode, configBuilder: ScriptCompilationConfiguration.Builder.() -> Unit): CompiledScript

Compile a source script and ensure the process was successful.

compileScriptResult

fun RawScript<SourceCode>.compileScriptResult(libraries: Array<out String>): CompiledScript

Compile a Source script with additional configuration and return the compilation result.

createLogger

fun createLogger(name: String): Logger

evalScript

fun evalScript(identifier: Identifier, script: CompiledScript, logger: Logger): ResultWithDiagnostics<EvaluationResult>

Evaluate a compiled script by loading its classes and return the evaluation result.

evalScriptPacks

internal fun evalScriptPacks(compiledPacks: Collection<RawScriptPack<CompiledScript>>): List<KoremodsScriptPack>

Evaluate a set of raw, compiled koremods scripts by loading their classes into the JVM and retrieving their list of transformers.

evalTransformers

fun evalTransformers(identifier: Identifier, script: CompiledScript, logger: Logger): TransformerHandler

Evaluate a compiled script by loading its classes and retrieving its defined transformers.

loadScriptFromJar

fun Path.loadScriptFromJar(): CompiledScript

Load a compiled script from a Path that points to a valid jar file.

locateScripts

internal fun locateScripts(namespace: String, scripts: List<String>, rootPath: Path, scriptExt: String): List<RawScript<Path>>

Locate defined scripts within a script pack at the given path

logResultErrors

fun Logger.logResultErrors(result: ResultWithDiagnostics.Failure)

Dump errors from a ResultWithDiagnostics to a Log4J Logger.

measureMillis

fun <T> Logger.measureMillis(level: Level, message: String, block: () -> T): T

Measure and log code execution time in milliseconds.

parseConfig

inline fun <T> parseConfig(reader: Reader): T

Parses a config object from a raw data stream.

readCompiledScripts

internal fun readCompiledScripts(packs: Collection<RawScriptPack<Path>>): List<RawScriptPack<CompiledScript>>

Read the bytecode contents of compiled scripts from script packs.

readEntries

fun JarInputStream.readEntries(): Map<String, ByteArray>

Read the byte contents of all entries in a JarInputStream.

readScriptPack

internal fun readScriptPack(parent: Path, configPath: Path, rootPath: Path, extension: String): RawScriptPack<Path>?

Read the contents of a Koremods Script Pack at the specified path

readScriptSource

fun readScriptSource(identifier: Identifier, path: Path): SourceCode

Read the contents of a script from a Path and return its SourceCode.

readScriptSources

fun readScriptSources(packs: Collection<RawScriptPack<Path>>): List<RawScriptPack<SourceCode>>

Read the Source Code contents of pack scripts.

scanPath

fun scanPath(path: Path, scriptExtension: String = KOREMODS_SCRIPT_EXTENSION): RawScriptPack<Path>?

Search for a Koremods Script Pack in the specified path

scanPaths

fun scanPaths(paths: Iterable<Path>, scriptExtension: String): List<RawScriptPack<Path>>

Search for Koremods Script Packs in the specified paths