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 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

AnonymousBody

AnonymousDiagram

AnonymousDiagramCombinator

AnonymousMorphism

AnonymousMorphismCombinator

AnonymousTheory

AnonymousTheoryCombinator

Appendage

BinaryObjJudgement

ComplexMorphism

ComplexTerm

ComplexTheory

CongruenceClosure

Context

Conversions

DerivedOMLFeature

DerivedVarDeclFeature

DiagramArrow

DiagramElement

DiagramNode

DomainElement

Equality

EqualityContext

Formal

Free

FreeOrAny

IncludeOML

IncludeSub

IncludeVarDecl

Inhabitable

Inhabited

IsContext

IsMorphism

IsRealization

IsTheory

Judgement

MatchFail

MatchResult

MatchSuccess

Matcher

MemoizedSubstitutionApplier

ModExp

Morph

MorphType

OMA

OMATTR

OMATTRMany

OMAorAny

OMBIND

OMBINDC

OMCOMP

OMFOREIGN

OMID

OMIDENT

OMINST

OML

OMLIT

OMLITTrait

OMLList

OMM

OMMOD

OMPMOD

OMS

OMSemiFormal

OMStructuralInclude

OMV

Obj

PlainSubstitutionApplier

Position

RealizeOML

SemiFormalObject

SemiFormalObjectList

ShortURIPrinter

SmartSubstitutionApplier

Stack

StatelessTraverser

StructureOML

StructureSharingSubstitutionApplier

StructureSub

StructureVarDecl

Sub

Substitution

SubstitutionApplier

Subtyping

TUnion

Term

Text

TheoryExp

TheoryType

ThisTypeTrait

TorsoForm

TorsoNormalForm

Traverser

Typing

UnaryObjJudgement

Universe

UnknownOMLIT

VarDecl

WFJudgement

XMLNode

info.kwarc.mmt.api.objects

Obj

Companion object Obj

abstract class Obj extends Content with BaseType with ShortURIPrinter with HashEquality[Obj]

An Obj represents an MMT object. MMT objects are represented by immutable Scala objects.

Source: Obj.scala

Linear Supertypes

HashEquality[Obj], ShortURIPrinter, BaseType, Content, ClientProperties, HasMetaData, AnyRef, Any

Known Subclasses

Context, OMA, OMATTR, OMBINDC, OMFOREIGN, OMID, OML, OMLIT, OMLITTrait, OMV, Sub, Substitution, Term, UnknownOMLIT, VarDecl, OMSemiFormal

Ordering

Alphabetic
By Inheritance

Inherited

Obj
HashEquality
ShortURIPrinter
BaseType
Content
ClientProperties
HasMetaData
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new Obj()

Type Members

abstract type ThisType >: Obj.this.type <: Obj
the type of this instance
the type of this instance
This is needed to provide sharper return types for inductive functions, e.g., substitution returns Term if applied to Term, Context if applied to Context, etc.

Abstract Value Members

abstract def head: Option[ContentPath]
abstract def subobjects: List[(Context, Obj)]
all direct subobjects of this object with their context (excluding any outer context of this object)
abstract def substitute(sub: Substitution)(implicit sa: SubstitutionApplier): ThisType
generic version of substitution that does one step and recurses according to a SubstitutionApplier
generic version of substitution that does one step and recurses according to a SubstitutionApplier
capture is avoided by renaming bound variables that are free in sub
Individual SubstitutionAppliers can default to this method in order to recurse one level.
abstract def toCMLQVars(implicit qvars: Context): Node
abstract def toNode: Node
prints to OpenMath
prints to OpenMath

Definition Classes
Obj → Content
abstract def toStr(implicit shortURIs: Boolean): String
configurable string representation
configurable string representation
shortURIs
print OMS without namespace, theory

Definition Classes
ShortURIPrinter

Concrete 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 ^(sub: Substitution): ThisType
applies a substitution to an object (computed immediately) implemented in terms of ^^ and PlainSubstitutionApplier
def ^?(sub: Substitution): ThisType
optimized version of substitution defined in terms of SmartSubstitutionApplier
def ^^(sub: Substitution)(implicit sa: SubstitutionApplier): ThisType
convenience method that applies substitution by relegating to a SubstitutionApplier
convenience method that applies substitution by relegating to a SubstitutionApplier
This has the effect that o ^^ sub becomes an infix notation for substitution if an implicit SubstitutionApplier is available.
final def asInstanceOf[T0]: T0

Definition Classes
Any
lazy val clientProperty: ListMap[URI, Any]

Definition Classes
ClientProperties
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
def copyFrom(o: Obj): Unit
replaces metadata of this with pointer to those of o
replaces metadata of this with pointer to those of o
o
the original object call o2.copyFrom(o1) after transforming o1 into o2 in order to preserve metadata
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] )
lazy val freeVars: List[LocalName]
the free variables of this object in any order
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def getMetaDataNode: NodeSeq

Definition Classes
HasMetaData
def governingPath: Option[ContentPath]
the governing path required by Content is the head, if any
lazy val hash: Int
the hash code
the hash code

Definition Classes
HashEquality
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
def hasheq(that: HashEquality[Obj]): Boolean
this hasheq that is the same as this == that, but fails immediately if false
this hasheq that is the same as this == that, but fails immediately if false

Definition Classes
HashEquality
def hashneq(that: HashEquality[Obj]): Boolean
this hasheq that is the same as this == that, but fails immediately if false
this hasheq that is the same as this == that, but fails immediately if false

Definition Classes
HashEquality
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def mdNode: Seq[Node] with AbstractSeq[Node] with Serializable

Attributes
protected
val metadata: MetaData

Definition Classes
HasMetaData
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()
def subobject(pos: Position): (Context, Obj)
returns the subobject at a given position and its context
def subobjectsNoContext(os: List[Obj]): List[(Context, Obj)]
auxiliary function for subobjects in the absence of binding
auxiliary function for subobjects in the absence of binding

Attributes
protected
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toCML: Node
def toNode(rh: RenderingHandler): Unit
by default, this prints out toNode
by default, this prints out toNode
potentially large StructuralElements should override it with a memory-efficient implementation

Definition Classes
Content
def toOBJNode: Elem
prints to OpenMath (with OMOBJ wrapper)
def toString(): String
defaults to toStr(false)
defaults to toStr(false)

Definition Classes
ShortURIPrinter → 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

Obj

Companion object Obj

abstract class Obj extends Content with BaseType with ShortURIPrinter with HashEquality[Obj]

Instance Constructors

Type Members

Abstract Value Members

Concrete Value Members

Inherited from HashEquality[Obj]

Inherited from ShortURIPrinter

Inherited from BaseType

Inherited from Content

Inherited from ClientProperties

Inherited from HasMetaData

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

Obj 

Companion object Obj

abstract class Obj extends Content with BaseType with ShortURIPrinter with HashEquality[Obj]

Instance Constructors

Type Members

Abstract Value Members

Concrete Value Members

Inherited from HashEquality[Obj]

Inherited from ShortURIPrinter

Inherited from BaseType

Inherited from Content

Inherited from ClientProperties

Inherited from HasMetaData

Inherited from AnyRef

Inherited from Any

Ungrouped

Obj