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.

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 archives

This package holds all classes related to MMT Archives (= project).

The BuildManager allows defining BuildTargets to run on archives, including in particular Importers and Exporters.

Most archives are stored in hub of git repositories such as and MathHub or GitHub. Such hubs are represented by the class LMHHub, which allows for cloning, etc. archives.

The list of currently open archives (from which MMT will load content if needed) is maintained by the backend.Backend.

Definition Classes: api

Added

AggregatingBuildTarget

BuildTask

class BuildTask extends MMTTask

auxiliary type to represent the parameters and result of building a file/directory

this is no case class due to a state-dependent error continuation

Source: BuildTarget.scala

Linear Supertypes

MMTTask, Killable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

BuildTask
MMTTask
Killable
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new BuildTask(key: String, archive: Archive, inFile: File, children: Option[List[BuildTask]], inPath: FilePath, outFile: File, errorCont: OpenCloseHandler)
inFile
the input file
children
the build tasks of the children if this task refers to a directory
inPath
the path of the input file inside the archive, relative to the input dimension
outFile
the intended output file
errorCont
BuildTargets should report errors here (instead of directly writing to errFile)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def addListener(l: MMTTaskProgressListener): Unit

Definition Classes
MMTTask
val archive: Archive
def asDependency: BuildDependency
final def asInstanceOf[T0]: T0

Definition Classes
Any
val base: URI
the narration-base of the containing archive
val children: Option[List[BuildTask]]
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
def contentDPath: DPath
the DPath corresponding to the inFile if inFile is a folder in a content-structured dimension
def contentMPath: MPath
the MPath corresponding to the inFile if inFile is a file in a content-structured dimension
def diesWith(implicit that: Killable): BuildTask.this.type
gives a killable object the same kill button as one that is already around
gives a killable object the same kill button as one that is already around
For example, when processing a task, generates a subtask, this should be called on the subtask to ensure killing the overall task also kills the subtask.

Definition Classes
Killable
def dirName: String
the name of the folder if inFile is a folder
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val errorCont: OpenCloseHandler
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def getReports: List[MMTTaskProgress]
get all reports in reverse chronological order
get all reports in reverse chronological order

Definition Classes
MMTTask
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
val inFile: File
val inPath: FilePath
def isDir: Boolean
def isEmptyDir: Boolean
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isKilled: Boolean
processing should be aborted gracefully if true
processing should be aborted gracefully if true

Definition Classes
Killable
val key: String
def kill: Unit
signals aborting of processing
signals aborting of processing

Definition Classes
Killable
def narrationDPath: DPath
the DPath corresponding to the inFile if inFile is in a narration-structured dimension
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
val outFile: File
def outPath: FilePath
(possibly shorter) output file name to be shown in user messages
def removeListener(l: MMTTaskProgressListener): Unit

Definition Classes
MMTTask
def reportProgress(a: MMTTaskProgress): Unit
adds a report and forwards it to all listeners
adds a report and forwards it to all listeners

Definition Classes
MMTTask
def setTimeout[A](millisec: Int)(f: () ⇒ Unit): BuildTask.this.type
presses the kill button after the specified number of milli seconds
presses the kill button after the specified number of milli seconds

Definition Classes
Killable
var skipped: Boolean
build targets should set this to true if they skipped the file so that it is not passed on to the parent directory
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()

Packages

Classes directly defined in the package

Subpackages

Data structures for the MMT language

The MMT main class and its internal state

User interfaces

Physical storage of the MMT language files

The central algorithms for processing MMT content

Other algorithms on the MMT data structures

General purpose utility functions

BuildTask

class BuildTask extends MMTTask

Instance Constructors

Value Members

Inherited from MMTTask

Inherited from Killable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Classes directly defined in the package

Subpackages

Data structures for the MMT language

The MMT main class and its internal state

User interfaces

Physical storage of the MMT language files

The central algorithms for processing MMT content

Other algorithms on the MMT data structures

General purpose utility functions

BuildTask 

class BuildTask extends MMTTask

Instance Constructors

Value Members

Inherited from MMTTask

Inherited from Killable

Inherited from AnyRef

Inherited from Any

Ungrouped

BuildTask