package actions
- Alphabetic
- Public
- All
Type Members
-
trait
Action extends Extension with MMTTask
An instance of the Action class represents an atomic command that can be run by a Controller.
An instance of the Action class represents an atomic command that can be run by a Controller.
All Action instances are extensions and therefore have access to the Controller. (They are initialized immediately after parsing.)
All subclasses of Action must have a companion object of type ActionCompanion that implements parsing for that action.
-
abstract
class
ActionCompanion extends FormatBasedExtension
common superclass of all companion objects of subclasses of Action
- case class ActionExecutionError(error: Error) extends ActionResultError with Product with Serializable
-
trait
ActionHandling extends ArchiveActionHandling with CheckActionHandling with ControlActionHandling with DefineActionHandling with ExecActionHandling with MathPathActionHandling with PrintActionHandling with LMHActionHandling
An auxilary class to split the Controller into several files and implement the handling of Actions.
- case class ActionParsingError(error: ParseError) extends ActionResultError with Product with Serializable
-
sealed abstract
class
ActionResult extends AnyRef
the result of parsing and/or evaluation an action
- sealed abstract class ActionResultError extends ActionResult
- case class ActionResultOK() extends ActionResult with Product with Serializable
-
class
ActionState extends AnyRef
the state used by ActionCompanions
- case class AddArchive(folder: File) extends MathPathAction with Product with Serializable
- case class AddExtension(cls: String, args: List[String]) extends ExtensionAction with Product with Serializable
- case class AddMWS(uri: URI) extends ExtensionAction with Product with Serializable
- case class AddMathPathFS(uri: URI, file: File) extends MathPathAction with Product with Serializable
- case class AddMathPathJava(javapath: File) extends MathPathAction with Product with Serializable
- case class AddReportHandler(h: ReportHandler) extends LoggingAction with Product with Serializable
-
sealed abstract
class
ArchiveAction extends Action
Shared base class for Actions that are related to Archives
-
trait
ArchiveActionHandling extends AnyRef
helper functions of ArchiveActions
- case class ArchiveBuild(ids: List[String], dim: String, modifier: BuildTargetModifier, in: FilePath = EmptyPath) extends ArchiveAction with Product with Serializable
- case class ArchiveMar(id: String, file: File) extends ArchiveAction with Product with Serializable
- case class Check(p: Path, id: String) extends CheckAction with Product with Serializable
-
sealed abstract
class
CheckAction extends Action
shared base class for actions checking objects
-
trait
CheckActionHandling extends AnyRef
Implements handling of CheckActions
- case class CheckTerm(s: String) extends CheckAction with Product with Serializable
- case class Compare(p: Path, r: Int) extends CheckAction with Product with Serializable
- case class ConfBuild(mod: String, targets: List[String], profile: String) extends ArchiveAction with Product with Serializable
-
sealed abstract
class
ControlAction extends Action
shared base class for actions controlling the shell or other actions
-
trait
ControlActionHandling extends AnyRef
Implements handling of ControlActions
- case class Define(name: String) extends DefineAction with Product with Serializable
-
sealed abstract
class
DefineAction extends Action
shared base class for actions defining and using procedures
-
trait
DefineActionHandling extends AnyRef
helper functions of DefineActions
-
case class
Defined(file: File, name: String, body: List[Action]) extends Product with Serializable
stores a command binding done with Define
- case class Do(file: Option[File], name: String) extends DefineAction with Product with Serializable
-
sealed abstract
class
ExecAction extends Action
shared base class for actions related to execution of Action code
-
trait
ExecActionHandling extends AnyRef
helper functions for ExecActions
-
case class
ExecFile(file: File, name: Option[String]) extends ExecAction with Product with Serializable
load a file containing commands and execute them, fails on first error if any
load a file containing commands and execute them, fails on first error if any
concrete syntax: file file:FILE
-
sealed abstract
class
ExtensionAction extends Action
Shared base class for Actions relating to adding and removing Extensions
-
case class
GetAction(o: Output) extends Action with Product with Serializable
Objects of type GetAction represent commands
Objects of type GetAction represent commands
that - retrieve knowledge items in abstract/internal syntax - post-process them to obtain concrete/external syntax - then output the concrete form in various ways.
The concrete syntax is described by the following grammar: get ABSTRACT [CONCRETE] [OUTPUT] where ABSTRACT ::= URI | URI component STRING | URI closure | URI elaboration CONCRETE ::= present param | deps OUTPUT ::= write FILE | window | respond | CONCRETE The productions for ABSTRACT, CONCRETE, OUTPUT correspond to the instances of MakeAbstract, MakeConcrete, and Output.
- o
the instance of Output that executes all three steps.
- case class HelpAction(topic: String) extends PrintAction with Product with Serializable
- case class InspectDefine(name: Option[String]) extends DefineAction with ResponsiveAction with Product with Serializable
-
sealed abstract
class
LMHAction extends Action
shared base class for Actions relating to lmh (formerly oaf)
- trait LMHActionHandling extends AnyRef
- case class LMHInit(path: String, template: Option[String]) extends LMHAction with Product with Serializable
- case class LMHInstall(spec: List[String]) extends LMHAction with Product with Serializable
- case class LMHList(spec: List[String]) extends LMHAction with LocalAction with ResponsiveAction with Product with Serializable
- case class LMHListRemote(spec: List[String]) extends LMHAction with ResponsiveAction with Product with Serializable
- case class LMHOpen(id: String) extends LMHAction with Product with Serializable
- case class LMHPull(spec: List[String]) extends LMHAction with Product with Serializable
- case class LMHPush(spec: List[String]) extends LMHAction with LocalAction with Product with Serializable
- case class LMHSetRemote(spec: List[String]) extends LMHAction with LocalAction with Product with Serializable
- case class LMHUse(spec: List[String]) extends LMHAction with Product with Serializable
-
sealed
trait
LocalAction extends LMHAction
shared trait for local lmh actions
-
sealed abstract
class
LoggingAction extends Action
shared base class for actions related to logging
- case class LoggingOff(group: String) extends LoggingAction with Product with Serializable
- case class LoggingOn(group: String) extends LoggingAction with Product with Serializable
-
case class
MBT(file: File) extends ExecAction with Product with Serializable
run an .mbt file
- case class MakeAction(key: String, args: List[String]) extends ArchiveAction with Product with Serializable
-
sealed abstract
class
MathPathAction extends Action
Shared base class for Actions updating the mathpath
-
trait
MathPathActionHandling extends AnyRef
implements helper functions of MathPathActions
-
sealed abstract
class
MetaAction extends Action
Shared base class for Actions that are meta and do not actually do something
- case class Navigate(p: Path) extends CheckAction with Product with Serializable
-
abstract
class
ObjectActionCompanion extends ActionCompanion
convenience class for ActionCompanion objects of Actions that do not take any arguments and thus have a trivial parser
-
sealed abstract
class
PrintAction extends ResponsiveAction
Shared base class for Actions for printing something
-
trait
PrintActionHandling extends AnyRef
utility methods for handling PrintActions
- case class Read(file: File, interpret: Boolean) extends MathPathAction with Product with Serializable
-
case class
RemoteAction(id: String, action: Action) extends MetaAction with Product with Serializable
run an action on a remotely administered client
run an action on a remotely administered client
concrete syntax: remote id:STRING ACTION
- case class RemoveExtension(cls: String) extends ExtensionAction with Product with Serializable
-
trait
ResponsiveAction extends Action
an action that responds to the user
-
case class
Scala(init: Option[String]) extends ExecAction with Product with Serializable
run a Scala interpreter or evaluate a Scala expression
-
sealed abstract
class
ServerAction extends Action
Shared base class for Actions for controlling the webserver
- case class ServerOn(port: Int = 8080, bindHost: String = "127.0.0.1") extends ServerAction with Product with Serializable
- case class SetBase(base: Path) extends ControlAction with Product with Serializable
- case class SetLMHRoot(path: String, https: Boolean) extends LMHAction with Product with Serializable
-
sealed abstract
class
WindowAction extends Action
Shared base class for Actions that are related to Windows
-
case class
WindowClose(window: String) extends WindowAction with Product with Serializable
close a window with a given ID
close a window with a given ID
See ToWindow on how to open windows concrete syntax: window window:STRING close
-
case class
WindowPosition(window: String, x: Int, y: Int) extends WindowAction with Product with Serializable
position a window with a given ID
position a window with a given ID
See ToWindow on how to open windows concrete syntax: window window:STRING position x:INT y:INT
Value Members
-
object
Action extends CompRegexParsers
parsing of Actions relative to the parser provided by companion objects (of type ActionCompanion of the subclasses of Action
- object AddArchiveCompanion extends ActionCompanion
- object AddExtensionCompanion extends ActionCompanion
- object AddMWSCompanion extends ActionCompanion
- object AddMathPathFSCompanion extends ActionCompanion
- object AddMathPathJavaCompanion extends ActionCompanion
- object AddReportHandlerCompanion extends ActionCompanion
- object ArchiveBuildCompanion extends ActionCompanion
- object ArchiveMarCompanion extends ActionCompanion
- object CheckCompanion extends ActionCompanion
- object CheckTermCompanion extends ActionCompanion
- object Clear extends ControlAction with Product with Serializable
- object ClearCompanion extends ObjectActionCompanion
-
object
ClearConsole extends PrintAction with Product with Serializable
print all loaded knowledge items to STDOUT in text syntax
- object ClearConsoleCompanion extends ObjectActionCompanion
- object CompareCompanion extends ActionCompanion
- object ConfBuildCompanion extends ActionCompanion
- object DefineCompanion extends ActionCompanion
- object DoCompanion extends ActionCompanion
- object EndDefine extends DefineAction with Product with Serializable
- object EndDefineCompanion extends ObjectActionCompanion
- object ExecFileCompanion extends ActionCompanion
-
object
Exit extends ControlAction with Product with Serializable
release all resources and exit
release all resources and exit
concrete syntax: exit
- object ExitCompanion extends ObjectActionCompanion
- object FinishBuild extends ArchiveAction with ResponsiveAction with Product with Serializable
- object FinishBuildCompanion extends ObjectActionCompanion
-
object
GUIOff extends WindowAction with Product with Serializable
hides the GUI window
- object GUIOffCompanion extends ObjectActionCompanion
-
object
GUIOn extends WindowAction with Product with Serializable
show the GUI window
- object GUIOnCompanion extends ObjectActionCompanion
- object GetActionCompanion extends ActionCompanion
- object HelpActionCompanion extends ActionCompanion
- object InspectDefineCompanion extends ActionCompanion
- object LMHInitCompanion extends ActionCompanion
- object LMHInstallCompanion extends ActionCompanion
- object LMHListCompanion extends ActionCompanion
- object LMHListRemoteCompanion extends ActionCompanion
- object LMHOpenCompanion extends ActionCompanion
- object LMHPullCompanion extends ActionCompanion
- object LMHPushCompanion extends ActionCompanion
- object LMHSetRemoteCompanion extends ActionCompanion
- object LMHUseCompanion extends ActionCompanion
- object ListExtensions extends ExtensionAction with ResponsiveAction with Product with Serializable
- object ListExtensionsCompanion extends ObjectActionCompanion
- object ListReportGroups extends LoggingAction with ResponsiveAction with Product with Serializable
- object ListReportGroupsCompanion extends ObjectActionCompanion
- object Local extends MathPathAction with Product with Serializable
- object LocalCompanion extends ObjectActionCompanion
- object LoggingOffCompanion extends ActionCompanion
- object LoggingOnCompanion extends ActionCompanion
- object MBTCompanion extends ActionCompanion
- object MMTInfo extends PrintAction with Product with Serializable
- object MMTInfoCompanion extends ObjectActionCompanion
- object MMTLegal extends PrintAction with Product with Serializable
- object MMTLegalCompanion extends ObjectActionCompanion
- object MMTVersion extends PrintAction with Product with Serializable
- object MMTVersionCompanion extends ObjectActionCompanion
- object MakeActionCompanion extends ActionCompanion
- object NavigateCompanion extends ActionCompanion
- object NoAction extends MetaAction with Product with Serializable
- object NoActionCompanion extends ObjectActionCompanion
-
object
PrintAll extends PrintAction with Product with Serializable
print all loaded knowledge items to STDOUT in text syntax
- object PrintAllCompanion extends ObjectActionCompanion
-
object
PrintAllXML extends PrintAction with Product with Serializable
print all loaded knowledge items to STDOUT in XML syntax
- object PrintAllXMLCompanion extends ObjectActionCompanion
-
object
PrintConfig extends PrintAction with Product with Serializable
print all configuration entries to STDOUT
- object PrintConfigCompanion extends ObjectActionCompanion
- object ReadCompanion extends ActionCompanion
- object RemoteActionCompanion extends ActionCompanion
- object RemoveExtensionCompanion extends ActionCompanion
- object ScalaCompanion extends ActionCompanion
- object ServerInfoAction extends ServerAction with ResponsiveAction with Product with Serializable
- object ServerInfoActionCompanion extends ObjectActionCompanion
- object ServerOff extends ServerAction with Product with Serializable
- object ServerOffCompanion extends ObjectActionCompanion
- object ServerOnCompanion extends ActionCompanion
- object SetBaseCompanion extends ActionCompanion
- object SetLMHRootCompanion extends ActionCompanion
- object ShowArchives extends MathPathAction with ResponsiveAction with Product with Serializable
- object ShowArchivesCompanion extends ObjectActionCompanion
- object ShowLMH extends LMHAction with ResponsiveAction with Product with Serializable
- object ShowLMHCompanion extends ObjectActionCompanion
- object WindowCloseCompanion extends ActionCompanion
- object WindowPositionCompanion extends ActionCompanion