runner-api/dev.ust.zinc.grader.util/CmdLang

CmdLang

interface CmdLang : CmdUtils.Buildable

Language interface for making commands.

Important syntax of the language used in command line or shell are captured so that CmdBuilder can use them in a language-agnostic manner.

Inheritors

Types

open class DiffIgnoreFlag(val flagsMap: Map<Settings.DiffIgnoreFlag, String>)

An interface for diff ignore flags that allows for choosing implementations.

class HereDoc(val heredocDelimiters: Pair<String, String>)

Heredoc definition utilities

Properties

DEFAULT_EXITCODE

abstract val DEFAULT_EXITCODE: Int

Default exitcode of a variable if stage execution timed out.

abstract val hereDoc: CmdLang.HereDoc

Heredoc with certain delimiters under this CmdLang.

Functions

abstract fun catFile(path: String): String

Read-out file into stdout

abstract fun deref(variable: String): String

Interpret the variable if it is defined the command line environment by dereferencing.

abstract fun exitCmd(exitcode: String): String

Command for exiting with a given exitcode integer or expression.

abstract fun expand(cmd: String): String

Expand and interpret the command expression in the shell, so that it can be used to construct further commands by substituting.

abstract fun <T> from(result: CmdUtils.Var.Result<T>): String

Command building combinators to pipe contents from previously saved Var.baseName's stdout/stderr.

abstract fun makeHeredoc(content: String): String

Command building combinator to make heredocs normally. Usually to be registed into a Var or piped into other commands.

makePipedHeredoc

abstract fun makePipedHeredoc(content: String, pipeToCmd: String): String

Command building combinator to make heredocs and then have a command to pipe the heredoc into. Usually to be registed into a Var or piped into other commands.

abstract fun print(content: String): String

Command to print content into the console.

open operator fun String.rangeTo(rest: String): String

Command building combinator to concat different parts of the command with proper spacing.