Packages

  • package root
    Definition Classes
    root
  • package info
    Definition Classes
    root
  • package kwarc
    Definition Classes
    info
  • package mmt
    Definition Classes
    kwarc
  • package api

    This is the main package of the MMT API.

    This is the main package of the MMT API.

    It holds subpackages for all data structures, data containers, and the central algorithms and services.

    Classes directly defined in the package

    Some minor classes that are used throughout MMT are defined in this package, in particular:

    • MMT URIs in the class Path and Namespace
    • processing and content errors in the class Error

    The package also contains root classes for certain types that are subclassed throughout the package. Most importantly:

    • StructuralElement: structure-level (= named) parts in the data structures for the MMT language: documents, theories, constants, ...
    • MMTTask: tasks for a single object: parsing, checking, ...
    • Rule: object-level part of the MMT language that is written in Scala

    Subpackages

    Data structures for the MMT language

    The data structures for the MMT languages are defined in 4 packages corresponding to the 4 levels: - documents: Documents and all other NarrativeElements - modules: Modules (= the toplevel declarations), in particular Theorys and Views - symbols: all Declarations inside modules, in particular Constants - objects: all anonymous Objects (e.g., formulas, functions, etc.), in particular Contexts and Terms

    The former 3 levels are jointly called 'structural' levels. All elements subclass StructuralElement, have an MMT URI, and carry an MMT URI referring to their parent in the MMT abstract syntax tree.

    Structural elements are extensible (via DerivedModules and DerivedDeclarations), and the package patterns defines declaration patterns as a built-in extension.

    All structural elements are mutable and implement the ContainerElement interface for changing their children. Objects, by contrast, are represented as immutable inductive types.(except for carrying metadata.Metadata and objects.ClientProperties). The boundary between structural elements and objects is mediated by ComponentContainers: these are mutable, owned by structural elements, and maintain objects.

    A few auxiliary data structures shifted to separate packages: - opaque: external (i.e., informal, computation) content - informal: partially outdated informal data structures - metadata: metadata annotations to all structural elements or objects

    The MMT main class and its internal state

    The package frontend contains the class Controller, which owns all state relevant for running MMT. Typically, each application creates a single instance of this class. The package also defines several other essential classes, most importantly MMT's extension (=plug-in, add-on) interfaces via the Extension class.

    The package libraries maintains the instances of MMT language data structures, in particular the Library class. Controller owns a Library, which stores all structural elements that have been loaded into memory.

    User interfaces

    The package frontend also contains the main executable classes, in particular the Shell class.

    The package gui collects all classes for building graphical user interfaces. This includes auxiliary classes for use in IDE plugins.

    The package web collects all classes for the HTTP interface of MMT.

    Physical storage of the MMT language files

    The package archives defines MMT Archives (= projects) as well as classes for building and working with archives. The latter include in particular the BuildManager and BuildTarget. Build targets include Importers and [Exporter]]s that translate between MMT and other formats.

    The package backend defines classes for maintaining archives and translating between the MMT URIs of structural elements and their physical storage locations.

    The central algorithms for processing MMT content

    The processing model of MMT consists of several major algorithms. - parser: read strings into MMT data structures - checking: check and refine MMT data structures - uom: pure computation on MMT data structures - proving: theorem proving on MMT data structures (in very early state)) - execution: imperative computation (in very, very early state) - presentation: rendering MMT data structures in user-facing formats (including HTML+presentation MathML)

    All algorithms are defined in Extensions coupled with default implementations. Moreover, all algorithms are split into two separate levels, one for structural elements and objects. See LeveledExtension.

    The package notations maintains the common code for parsing and presentation.

    The package valuebases maintains mathematical databases as a part of MMT.

    Other algorithms on the MMT data structures

    The package ontology contains a relational, semantic web-style ontology and query engine for it.

    The package moc contains change management.

    The package refactoring contains refactoring principles.

    General purpose utility functions

    The package utils defines general purpose APIs for files, URIs, HTML building, etc.

    Definition Classes
    mmt
  • package frontend

    This package defines several central classes: - Controller is the main MMT class.

    This package defines several central classes: - Controller is the main MMT class. - Shell is the main executable (which will create one controller). - MMTConfig is the MMT configuration data structure. A controller maintains one configuration. - Extension is the addon/plugin interface of MMT. Every extension has access to one controller instance. - Report handles logging, and every instance of Logger has access to a report instance.

    Definition Classes
    api
  • package actions
    Definition Classes
    frontend
  • ArchiveConf
  • BackendConf
  • ChangeListener
  • Closure
  • Component
  • ConfEntry
  • ConsoleHandler
  • Controller
  • ControllerState
  • DatabaseConf
  • Deps
  • Elaboration
  • EnvVarConf
  • Extension
  • ExtensionConf
  • ExtensionManager
  • FileHandler
  • FileServerHere
  • ForeignConf
  • FormatBasedExtension
  • FormatConf
  • Get
  • HtmlFileHandler
  • InteractiveSimplifier
  • LMHConf
  • LeveledExtension
  • Logger
  • MMTConfig
  • MMTILoop
  • MMTInterpolator
  • MMTScript
  • MMTScriptEngine
  • Make
  • MakeAbstract
  • MakeConcrete
  • MathPathConf
  • Memory
  • NamespaceConf
  • NotFound
  • Notify
  • Output
  • Plugin
  • Present
  • Print
  • ProfileConf
  • REPLExtension
  • ROController
  • ROMemory
  • RecordingHandler
  • Report
  • ReportHandler
  • Respond
  • Run
  • SemanticsConf
  • Shell
  • ShellArguments
  • ShellExtension
  • ShellSendCommand
  • StandardIOHelper
  • StandardREPL
  • StructureTrffaverser
  • TextFileHandler
  • ToFile
  • ToWindow

case class ShellArguments(help: Boolean, about: Boolean, mmtFiles: List[String], scalaFiles: List[String], cfgFiles: List[String], commands: List[String], shell: Boolean, noshell: Boolean, keepalive: Boolean, useQueue: Boolean, verbosity: Int) extends Product with Serializable

Represents arguments passed to MMT on the command line.

help

Should we print a help text

about

Should we print an about text

mmtFiles

List of MMT files to load

scalaFiles

List of Scala files to load

cfgFiles

List of config files to load

commands

List of commands to run

shell

interactive mode requested (show shell, terminate manually)

noshell

batch mode unrequested (no shell, terminate immediately)

keepalive

server mode requested (after shell (if at all) terminate only when processes finished)

verbosity

<0: no output, >=0: console output, >10: console output including debug

Source
ShellArguments.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShellArguments
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ShellArguments(help: Boolean, about: Boolean, mmtFiles: List[String], scalaFiles: List[String], cfgFiles: List[String], commands: List[String], shell: Boolean, noshell: Boolean, keepalive: Boolean, useQueue: Boolean, verbosity: Int)

    help

    Should we print a help text

    about

    Should we print an about text

    mmtFiles

    List of MMT files to load

    scalaFiles

    List of Scala files to load

    cfgFiles

    List of config files to load

    commands

    List of commands to run

    shell

    interactive mode requested (show shell, terminate manually)

    noshell

    batch mode unrequested (no shell, terminate immediately)

    keepalive

    server mode requested (after shell (if at all) terminate only when processes finished)

    verbosity

    <0: no output, >=0: console output, >10: console output including debug

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val about: Boolean
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val cfgFiles: List[String]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. val commands: List[String]
  9. def consoleLog: Boolean

    automatically log to console, true by default

  10. def debugOutput: Boolean

    automatically log debug output

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. val help: Boolean
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val keepalive: Boolean
  17. val mmtFiles: List[String]
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. val noshell: Boolean
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def prompt: Boolean

    decides whether to run in interactive/server or batch/server mode default behavior: interactive if nothing else is happening

  23. def runCleanup: Boolean

    decides whether to run in non-server or server mode default behavior: batch

  24. val scalaFiles: List[String]
  25. val shell: Boolean
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. val useQueue: Boolean
  28. val verbosity: Int
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped