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

package backend

This package maintains the interface between MMT content in persistent physical storage and MMT content loaded into memory.

The class Storage is the interface for individual physical storage containers. Most of the time this corresponds to a folder containing an archives.Archive.

Content is usually stored in OMDoc XML format, which is parsed by the XMLStreamer.

The class Backend maintains the registered storages and performs conversion between logical MMT URIs and physical locations.

The frontend.Controller owns an instance of Backend. Any referenced MMT URI is lazily and transparently loaded from the backend into memory and unloaded if MMT runs out of memory.

Definition Classes: api

package checking

The algorithm for checking MMT content.

The algorithm for checking MMT content. See api for an overview of the algorithms.

The main interfaces are - Checker: the main interface for checkers (combining a structure and an object checker) - StructureChecker: checking structural elements - ObjectChecker: checking objects

The main implementations are - MMTStructureChecker for structural elements - RuleBasedChecker for objects

The latter creates a Solver for each judgment, which perform type reconstruction.

Structure checking is not extensible except through DerivedElements. Object checking is extensible through Rules.

Definition Classes: api

package documents

NarrativeElements are all elements that do not have a semantics of their own.

The most important case are Documents. Inside, documents a few other other documents may occur.

Definition Classes: api

package execution

The algorithm for imperatively executing MMT content.

The algorithm for imperatively executing MMT content. This is currently very young and immature.

See api for an overview of the algorithms.

Definition Classes: api

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 gui

GUIPanel and [GUIFrame]] maintain a swing-based graphical interface to the frontend.Controller and its children.

Definition Classes: api

package informal

Definition Classes: api

package libraries

Library maintains the structural elements that have been loaded into memory.

Library maintains the structural elements that have been loaded into memory. That includes the theory diagram and all documents.

ImplicitGraph maintains the commutative sub-diagram of implicit morphisms.

Definition Classes: api

package metadata

MetaDatum is the stateless class that represents metadata items.

MetaData statefully maintains a set of MetaDatums.

Elements that have metadata inherit from HasMetaData.

Linker and Tagger make setting and getting metadata easier.

Definition Classes: api

package moc

Change is the main class statelessly representing differences/changes.

Differ is a differ for MMT data structures.

Definition Classes: api

package modules

MMT Modules, i.e., Theorys and Views.

Link unifies Views and symbols.Structures, the two kinds of atomic theory morphisms.

ModuleOrLink unifies the two. That class defines most of the state of a module, in particular the body.

Definition Classes: api

package notations

This package maintains the common data structures for parsing and presentation.

TextNotation is the main notation class. It is similar to MMT objects, in particular it is stateless.

NotationContainer statefully maintains the notations assigned to a declaration. These are owned by StructuralElements to carry notations, akin to how they carry type/definition.

Definition Classes: api

package objects

MMT objects are

Terms
Contexts, which are lists of VarDecl
Substitutions, which are lists of Sub

AnonymousDiagram, AnonymousTheory, and AnonymousMorphism represent anonymous counterparts to libraries.Library modules.Module}.

This package also contains various auxiliary classes: - Position defines paths within objects - SubstitutionApplier is the main interface for substitution strategies. - Matcher is a simple matcher.

Definition Classes: api

package ontology

This package contains a relational ontology and a query engine for it.

The main classes are: - RelationalElement defines the concepts and relation of the ontology (TBox) - RelationalManager extracts the ABox from MMT content - RelStore maintains the model of the ontology (ABox) - RelationGraphExporter allows exporting the ABox as a graph. - Query defines a query language for the ontology - Evaluator implements the query language for a given ABox. - Search maintains classes for faceted search, in particular the facet for MathWebSearch.

Definition Classes: api

package opaque

Informal or unknown content that MMT does not process.

Informal or unknown content that MMT does not process. The main classes are - OpaqueElement: such content - OpaqueElementInterpreter the abstract interface for extensions that interpret it

Definition Classes: api

package parser

The algorithm for parsing MMT content (strings to MMT data structures).

The algorithm for parsing MMT content (strings to MMT data structures). See api for an overview of the algorithms.

The main interfaces are - Parser: the main interface for parser (combining a structure and an object parser) - StructureParser: parsing structural elements - ObjectParser: parsing objects

The main implementations are - KeywordBasedParser for structural elements in .mmt files - NotationBasedParser for objects

The latter creates a Scanner for each string, which applies notations to parse user-defined mixifx syntax.

Structure parsing is extensible using ParserExtensions. Object parsing is extensible using notations or LexerExtensions.

Definition Classes: api

package patterns

Declaration patterns in the sense of Horozal's PhD thesis, realized as two special cases of structural features: - Pattern for the patterns (elaborates to nothing) - Instance for the instances of patterns (elaborates by looking up the pattern)

Definition Classes: api

package presentation

The algorithm for presenting MMT content (data structures to user-facing formats).

The algorithm for presenting MMT content (data structures to user-facing formats). See api for an overview of the algorithms.

The main interfaces are - Presenter: the main interface for parser (combining a structure and an object parser) - StructurePresenter: presenting structural elements - ObjectPresenter: presenting objects

The main implementations are (in each case for structural elements and objects) - for OMDoc XML: OMDocPresenter resp. OpenMathPresenter - for plain strings (using the toString methods): TextPresenter resp. ObjectTextPresenter - for nice human-oriented strings: MMTStructurePresenter resp. NotationBasedParser - for HTML: HTMLPresenter resp. MathMLPresenter

Definition Classes: api

package proving

The algorithm for proving theorems about MMT content.

The algorithm for proving theorems about MMT content. This is very premature and experimental.

See api for an overview of the algorithms.

The main interfaces are - Prover: object level proving

Structure level proving does not exist yet.

The main implementations are - RuleBasedProver for object-level proving

The latter creates a Searcher for each proving task, which applies search rules to find MMT objects.

Definition Classes: api

package refactoring

Definition Classes: api

package symbols

MMT Declarations are the elements of Modules.

MMT Declarations are the elements of Modules. The kinds of declarations are documented at Declaration.

ObjContainer are owned by structural elements, in particular by declarations, to store objects.

Definition Classes: api

package uom

The algorithm for immutably computing with MMT content, i.e., simplification (strings to MMT data structures).

Simplification

The algorithm for immutably computing with MMT content, i.e., simplification (strings to MMT data structures). See api for an overview of the algorithms.

The main interfaces are - Simplifier: the main interface for parser (combining a structure and an object simplifier) - StructureSimplifier: simplifying structural elements - ObjectSimplifier: simplifying objects

The main implementations are - ElaborationBasedSimplifier for structural elements - RuleBasedSimplifier for objects

Structure simplification is extensible using derived elements. Object simplification is extensible using rules.

Literals and semantic objects

This package also contains the classes for using Scala objects as MMT literals.

SemanticType defines types as sets of Scala objects. SemanticValue defines a distinguished element of such a type. SemanitcOperator defines functions on such types as Scala functions.

Literals and operations on them are injected into the MMT language by declaring RealizedValue, RealizedType and RealizedOperator rules, which tie a syntactic type/operator (i.e., an MMT term) to a semantic counterpart.

StandardLiterals defines semantic types for the most important types.

RealizedTheory represents an MMT theory programmed in Scala, usually as a Scala class.

Scala companion objects for MMT theories

TheoryScala and ConstantScala are auxiliary classes that are useful when implementing MMT rules or other logic-specific algorithms.

Definition Classes: api

package utils

This package defines various MMT-independent high-level APIs.

This package defines various MMT-independent high-level APIs. Various basic functions are declared directly in this package object in order to be easily available.

Most other files in this package are self-contained and independent of the rest of MMT and each other. We describe them in groups below.

Data structures*

- Union disjoint union of Scala types - MyList extensions of Scala's lists (via implicit conversions) - HashRelation, HashMapToSet, and HashEquality: hash-related data structures for - While while loops that allow for break and continue

General purpose utilities

- Killable tasks that can be notified that they should be canceled. In particular, MMTTasks can be aborted without risking an inconsistent state. - Unparsed for simple parsing of strings - ScalaTo serialization helpers for Scala objects - ValueCache factory methods that introduce structure sharing by resuing previous pointers - XMLToScala framework for conveniently turning a set of case classes into an XML parser for the corresponding schema

Wrappers for low-level APIs

MMT provides various APIs that extend or simplify APIs provided Java or Scala: - File file paths and interacting with files - URI URIs - xml various helper function for working with XML and dereferencing URLs (not really a wrapper but fits best here) - ShellCommand commands executed on the system shell

APIs for external languages

- Dot the dot languages for graph layouting - JSON the JSON language - HTML API for building HTML pages programmatically

Definition Classes: api

package valuebases

This package maintains databases of cocnrete mathematical objects.

Concrete objects are special MMT Terms that can be represented as concrete database objects (e.g., JSON). The connection between the two is mediated by Codecs and CodecOerator. The codec-based translation is implemented in the Coder.

Definition Classes: api

package web

Server maintains the HTTP interface of MMT.

Server maintains the HTTP interface of MMT. The server is owned by the frontend.Controller.

It can be customized by ServerExtensions.

The REPLServer maintains a set of independent REPL loops for MMT content.

Definition Classes: api

AbstractObjectContainer

AbstractTermContainer

AddError

AddMessage

AddPosition

After

AtBegin

AtEnd

BackendError

Before

BooleanClientProperty

BooleanTermProperty

CPath

Checked

ClientProperties

ClientProperty

CodComponent

CompilerError

ComplexStep

ComponentContainer

ComponentKey

ComponentParent

ConfigurationError

ContainerElement

Content

ContentElement

ContentError

ContentPath

DPath

DeclarationComponent

DefComponent

DefaultAssignment

DefaultLookup

DefaultMutability

DeleteError

DeleteMessage

DomComponent

Elaborated

ElaborationOf

ElaborationOfDefinition

ElementContainer

Error

ErrorContainer

ErrorHandler

ErrorLogger

ErrorResponse

ErrorThrower

ErrorWriter

EvaluateMessage

ExecutionError

ExtensionError

FilteringErrorHandler

FinalTermContainer

GeneralError

GeneratedBy

GeneratedMRef

GetError

GetMessage

GlobalName

HeaderInfo

HeapLookupError

ImplementationError

InferMessage

Invalid

InvalidElement

InvalidObject

InvalidUnit

LNStep

Level

ListContainer

LocalName

LocalRef

LookupError

MMTInterpretationProgress

MMTTask

MMTTaskProgress

MMTTaskProgressListener

MPath

Materialized

Message

MetaDataComponent

MultipleErrorHandler

MutableElementContainer

MutableRuleSet

NamedElement

NamespaceMap

NarrativeElement

NotationComponent

NotationComponentKey

ObjComponentKey

ObjectMessage

ObjectResponse

OpenCloseHandler

Origin

Original

OtherComponent

ParametricRule

ParamsComponent

ParseError

Parsed

ParsingNotationComponent

Path

PatternBodyComponent

PresentationError

PresentationNotationComponent

ProveMessage

QuestionMarkFunctions

RegistrationError

RepeatedAdd

Response

Rule

RuleSet

SemanticObject

SimpleStep

SlashFunctions

SourceError

Stacktrace

StructuralElement

StructureMessage

StructureResponse

SubstitutionUndefined

SyntaxDrivenRule

TermComponent

TermComponentKey

TermProperty

TypeComponent

UpdateError

UpdateMessage

VerbalizationNotationComponent

info.kwarc.mmt.api

Path

Companion object Path

sealed abstract class Path extends BaseType

A Path represents an MMT path.

An MMT path refers to a document (doc), a module (doc?mod), or a symbol (M % sym). Use the objects ?, %, /, \, and ! for pattern matching paths.

Source: Path.scala

Linear Supertypes

BaseType, AnyRef, Any

Known Subclasses

CPath, ComponentParent, ContentPath, DPath, GlobalName, MPath

Ordering

Alphabetic
By Inheritance

Inherited

Path
BaseType
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Abstract Value Members

abstract def ^!: Path
goes one step up, identity if URI-path already empty
abstract def doc: DPath
the document part of the path
abstract def last: String
the last components of the path, human-oriented (i.e., no escaping), useful for short displays

Concrete Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def <=(that: Path): Boolean
checks whether this is a prefix of that
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def ancestors: List[Path]
the list of ancestors paths starting with this path
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
def dropComp: ComponentParent
remove the component, if any
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
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 hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toPath: String
as toPath(false)
def toPath(long: Boolean): String
string representation of a Path
string representation of a Path
long
add trailing ?
returns
the path as an MMT URI
def toPathEscaped: String
as toPath, but escapes XML-illegal characters
def toPathLong: String
as toPath(true)
def toString(): String
currently same as toPath, only toPath guarantees official string representation
currently same as toPath, only toPath guarantees official string representation

Definition Classes
Path → AnyRef → Any
def toTriple: (Option[DPath], Option[LocalName], Option[LocalName])
breaks an MMT URI reference into its components, all of which are optional
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

Simplification

Literals and semantic objects

Scala companion objects for MMT theories

Data structures*

General purpose utilities

Wrappers for low-level APIs

APIs for external languages

Path

Companion object Path

sealed abstract class Path extends BaseType

Abstract Value Members

Concrete Value Members

Inherited from BaseType

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

Simplification

Literals and semantic objects

Scala companion objects for MMT theories

Data structures*

General purpose utilities

Wrappers for low-level APIs

APIs for external languages

Path 

Companion object Path

sealed abstract class Path extends BaseType

Abstract Value Members

Concrete Value Members

Inherited from BaseType

Inherited from AnyRef

Inherited from Any

Ungrouped

Path