ns-scripting-core/net.democritus.scripting.common

Package-level declarations

This package supplies APIs that do not relate to any specific technology.

Types

interface ConditionalScope : ScriptScope

This scoping object is created by the ScriptScope.conditional functions. This scope exists purely to provide a declarative conditional scope without any additional functionality.

DirScope

interface DirScope : ScriptScope

This scoping object is created by the ScriptScope.dir functions. The ScopeContext.path parameter in the ctx property for this object is modified by the ScriptScope.dir functions to provide a different path then its parent scope.

ExecExecutionTemplate

interface ExecExecutionTemplate : ExecutionTemplate

The ExecutionTemplate which is created using the exec execution builder function. This template class is used as a builder to construct the arguments to starts a process on the machine.

Functions

conditional

fun ScriptScope.conditional(condition: ScopeActivationCondition = always, body: ConditionalScope.() -> Unit)

A scoping function to execute a code block conditionally based on the declarative condition argument.

dir

fun ScriptScope.dir(dirPath: Path, body: DirScope.() -> Unit)

fun ScriptScope.dir(dirPath: String, body: DirScope.() -> Unit)

A scoping function to execute a code block within the context of a DirScope instance, which adapts the path in the scope context at ScopeContext.path to the given value of dirPath. The value of dirPath is automatically resolved if it is a relative path.

exec

fun ScriptScope.exec(body: ExecExecutionTemplate.() -> Unit)

This execution function is used to run a process on the machine. The body parameter is supplied as a higher-order function that executes within the scope of a ExecExecutionTemplate object, in which the arguments for the process can be declared.