repl/it.unibo.tuprolog.ui.repl/AbstractTuPrologCommand

AbstractTuPrologCommand

abstract class AbstractTuPrologCommand(help: String = "", epilog: String = "", name: String? = null, val invokeWithoutSubcommand: Boolean = false, val printHelpOnEmptyArgs: Boolean = false, val helpTags: Map<String, String> = emptyMap(), val autoCompleteEnvvar: String? = "", val allowMultipleSubcommands: Boolean = false, val treatUnknownOptionsAsArgs: Boolean = false, val hiddenFromHelp: Boolean = false) : CliktCommand

Base class for the clikt commands that make up the 2P-Kt REPL CLI (TuPrologCmd and its solve subcommand TuPrologSolveQuery): it factors out everything both commands need to interact with a user at a terminal -- reading (possibly multi-line, dot-terminated) Prolog queries, and printing the it.unibo.tuprolog.solve.Solutions a it.unibo.tuprolog.solve.Solver produces for them -- so that subclasses only have to configure clikt options/arguments and implement run.

All constructor parameters simply forward to the corresponding com.github.ajalt.clikt.core.CliktCommand configuration points; help and epilog are exposed instead through help and helpEpilog so they can be set once from the constructor rather than overridden per-subclass.

Parameters

help

the one-line help text shown for this command, e.g. in --help output or a parent command's subcommand listing.

epilog

extra text appended after the option/argument listing in --help output.

Inheritors

TuPrologCmd

TuPrologSolveQuery

Constructors

AbstractTuPrologCommand

constructor(help: String = "", epilog: String = "", name: String? = null, invokeWithoutSubcommand: Boolean = false, printHelpOnEmptyArgs: Boolean = false, helpTags: Map<String, String> = emptyMap(), autoCompleteEnvvar: String? = "", allowMultipleSubcommands: Boolean = false, treatUnknownOptionsAsArgs: Boolean = false, hiddenFromHelp: Boolean = false)