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

Arg

ArgumentComponent

ArgumentMarker

Arity

ArityComponent

AtomicPresentationMarker

AttributedObject

Bindfix

CommonMarkerProperties

Delim

Delimiter

ErrorMarker

Finite

Fixity

FixityParser

FractionMarker

GlyphMarker

GroupMarker

HOAS

HOASApplySpine

HOASNotation

IdenMarker

ImplicitArg

InfInt

InferenceMarker

Infinite

Infix

InstanceName

InvalidNotation

LabelArg

LabelInfo

LabelMarker

LabelSeqArg

LocalNotationInfo

Marker

Mixfix

MixfixNotation

NegInfinite

NestedHOASNotation

NotationCache

NotationContainer

NotationConversions

NotationDimension

NotationExtension

NotationLexFunction

NotationRealizedType

NotationScope

NotationSemanticType

NotationType

NumberMarker

OMAUnder

PhantomMarker

PlaceholderDelimiter

Postfix

PragmaticTerm

Pragmatics

Precedence

Prefix

PresentationMarker

PresentationMarkerWrappingMarkerList

RootMarker

ScriptMarker

SeqArg

SimpArg

SimpSeqArg

SimpleFixity

SymbolName

TableMarker

TdMarker

TextMarker

TextNotation

TrMarker

Var

VariableComponent

VerbalizationMarker

WordMarker

info.kwarc.mmt.api.notations

TextNotation

Companion object TextNotation

case class TextNotation(fixity: Fixity, precedence: Precedence, meta: Option[MPath], scope: NotationScope = NotationScope.default) extends HasMetaData with Product with Serializable

A TextNotation is a Notation that can be used for parsing objects in text syntax

fixity: the mixfix notation
precedence: the precedence, notations with lower precedence are tried first, thus grab larger subterms
meta: the meta-theory of this notation if different from the current meta-theory
scope: a typed Var must be preceded by a Delim because Var.key does not trigger the notation not all markers may be Arg because such notations cannot be parsed if the only marker is SeqArg, it must hold that OMA(name, List(x)) = x because sequences of length 1 are parsed as themselves

Source: Notation.scala

Linear Supertypes

Serializable, Serializable, Product, Equals, HasMetaData, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

TextNotation
Serializable
Serializable
Product
Equals
HasMetaData
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new TextNotation(fixity: Fixity, precedence: Precedence, meta: Option[MPath], scope: NotationScope = NotationScope.default)
fixity
the mixfix notation
precedence
the precedence, notations with lower precedence are tried first, thus grab larger subterms
meta
the meta-theory of this notation if different from the current meta-theory
scope
a typed Var must be preceded by a Delim because Var.key does not trigger the notation not all markers may be Arg because such notations cannot be parsed if the only marker is SeqArg, it must hold that OMA(name, List(x)) = x because sequences of length 1 are parsed as themselves

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
lazy val arity: Arity
returns
the arity of this notation
final def asInstanceOf[T0]: T0

Definition Classes
Any
def canHandle(subs: Int, vars: Int, args: Int, att: Boolean): Boolean
returns
true if this arity can present ComplexTerm(name, subs, vars, args) and has an attribution if necessary
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

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

Definition Classes
HasMetaData
def hasDelimiter: Boolean
true if there is definitely a delimiter (i.e., not just a sequence separator)
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isLeftOpen: Boolean
there are argumetns before the first delimiter
def isRightOpen: Boolean
there are argumetns after the last delimiter
lazy val markers: List[Marker]
returns
the list of markers used for parsing/presenting with this notations
val meta: Option[MPath]
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 openArgs(fromRight: Boolean): Int
number of arguments before the first delimiter
lazy val parsingMarkers: List[Marker]
returns
the list of markers that should be used for parsing
val precedence: Precedence
lazy val presentationMarkers: List[Marker]
val scope: NotationScope
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toNode: Elem
def toString(): String

Definition Classes
TextNotation → AnyRef → Any
def toText: String
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

TextNotation

Companion object TextNotation

case class TextNotation(fixity: Fixity, precedence: Precedence, meta: Option[MPath], scope: NotationScope = NotationScope.default) extends HasMetaData with Product with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

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

TextNotation 

Companion object TextNotation

case class TextNotation(fixity: Fixity, precedence: Precedence, meta: Option[MPath], scope: NotationScope = NotationScope.default) extends HasMetaData with Product with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HasMetaData

Inherited from AnyRef

Inherited from Any

Ungrouped

TextNotation