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

ActiveNotation

ActiveParsingRule

Ambiguous

AnnotatedComment

AnnotatedCommentToken

AnnotatedConstant

AnnotatedDPath

AnnotatedDelimiter

AnnotatedDerived

AnnotatedDocument

AnnotatedInclude

AnnotatedKeyword

AnnotatedName

AnnotatedNotation

AnnotatedOpaque

AnnotatedOpaqueText

AnnotatedPath

AnnotatedTerm

AnnotatedTermToken

AnnotatedText

AnnotatedTheory

AsymmetricEscapeLexer

BasicTheoryParser

BoundName

CFExternalToken

Child

CommentIgnorer

DeclarationDelimiter

DefaultObjectParser

ErrorText

EscapeManager

ExternalToken

ExternalTokenParsingInput

FiniteKeywordsLexer

FixedLengthLiteralLexer

Found

FoundArg

FoundContent

FoundDelim

FoundOML

FoundSeqArg

FoundSeqOML

FoundSimpArg

FoundSimpSeqArg

FoundVar

HasParentInfo

IsDoc

IsMod

IsRootDoc

IsRootMod

KeywordBasedParser

LexFunction

LexParseExtension

LexerExtension

LiteralParser

MMTPart

MMTStructureEstimator

MMTURILexer

MatchedList

MetadataParser

ModuleDelimiter

NSImportDeclaration

NamespaceDeclaration

NotationBasedParser

NumberLiteralLexer

ObjectDelimiter

ObjectParser

ParentInfo

ParseFunction

ParseResult

Parser

ParserContext

ParserExtension

ParserExtensionArguments

ParserState

ParsingRule

ParsingRuleGroup

ParsingRuleTable

ParsingStream

ParsingUnit

PrefixedTokenLexer

PrimitiveTokenListElem

QuotationLexer

QuoteLexer

Reader

RootInfo

Scanner

ScannerBacktrack

ScannerBacktrackInfo

ScannerNoBacktrack

SemanticText

SemiFormalParser

SingleFoundVar

SourcePosition

SourceRef

SourceRegion

StringInterpolationLexer

StringInterpolationPart

StringInterpolationToken

StringPart

StructureParser

StructureParserContinuations

SymmetricEscapeLexer

Token

TokenList

TokenListElem

TokenSlice

UnicodeMap

UnicodeReplacer

UnmatchedList

ViewKey

Whitespace

WordReplacer

info.kwarc.mmt.api.parser

Parser

abstract class Parser extends StructureParser with ObjectParser with LeveledExtension

the designated super class for all parsers

Source: Parser.scala

Linear Supertypes

LeveledExtension, ObjectParser, StructureParser, FormatBasedExtension, Extension, Logger, AnyRef, Any

Known Subclasses

XMLStreamer, BasicTheoryParser, KeywordBasedParser, TwelfParser, TPTPParser

Ordering

Alphabetic
By Inheritance

Inherited

Parser
LeveledExtension
ObjectParser
StructureParser
FormatBasedExtension
Extension
Logger
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new Parser(objectLevel: ObjectParser)

Type Members

case class LocalError(s: String) extends ExtensionError with Product with Serializable
a custom error class for this extension
a custom error class for this extension

Definition Classes
Extension

Abstract Value Members

abstract def apply(ps: ParsingStream)(implicit cont: StructureParserContinuations): StructuralElement
the main interface function: parses a stream and registers all elements (usually a single document) in it
the main interface function: parses a stream and registers all elements (usually a single document) in it
ps
the encapsulated input stream
cont
continuations for errors and parsed elements
returns
the element into which the stream was parsed (of the type corresponding to ps.parentInfo)

Definition Classes
StructureParser
abstract def format: String

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 apply(pu: ParsingUnit)(implicit errorCont: ErrorHandler): ParseResult
relegates to objectParser
relegates to objectParser

Definition Classes
Parser → ObjectParser
final def asInstanceOf[T0]: T0

Definition Classes
Any
def asInterpreter: OneStepInterpreter
an interpreter that does not check
def catchErrors[A](msg: String, recoverWith: ⇒ A)(code: ⇒ A): A
like its partner but with return value
like its partner but with return value

Attributes
protected
Definition Classes
Extension
def catchErrors(msg: String)(code: ⇒ Unit): Unit
convenience method for wrapping code in error handler that throws LocalError
convenience method for wrapping code in error handler that throws LocalError

Attributes
protected
Definition Classes
Extension
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
val controller: Controller
the controller that this extension is added to; only valid after creation of the extension, i.e., will return null if used in a non-lazy val-field
the controller that this extension is added to; only valid after creation of the extension, i.e., will return null if used in a non-lazy val-field

Attributes
protected
Definition Classes
Extension
lazy val defaultPrefix: String

Definition Classes
Extension
def destroy: Unit
extension-specific cleanup (override as needed, empty by default)
extension-specific cleanup (override as needed, empty by default)
Extensions may create persistent data structures and threads, but they must clean up after themselves in this method

Definition Classes
LeveledExtension → Extension
def destroyWhenRemainingTasksFinished: Unit
convenience for calling waitUntilRemainingTasksFinished and then destroy
convenience for calling waitUntilRemainingTasksFinished and then destroy

Definition Classes
Extension
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 getFromFirstArgOrEnvvar(args: List[String], name: String, default: String = ""): String

Attributes
protected
Definition Classes
Extension
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
def init(controller: Controller): Unit
MMT initialization (idempotent)
MMT initialization (idempotent)

Definition Classes
LeveledExtension → Extension
def initOther(e: Extension): Unit
any extension can initialize other extensions if those are not meant to be added to the ExtensionManager
any extension can initialize other extensions if those are not meant to be added to the ExtensionManager

Attributes
protected
Definition Classes
Extension
def isApplicable(s: String): Boolean
returns
true if this extension is applicable

Definition Classes
Parser → FormatBasedExtension
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def log(e: Error): Unit
logs an error - always logged
logs an error - always logged

Attributes
protected
Definition Classes
Logger
def log(s: ⇒ String, subgroup: Option[String] = None): Unit
logs a message with this logger's logprefix
logs a message with this logger's logprefix

Attributes
protected
Definition Classes
Logger
def logError(s: ⇒ String): Unit
log as an error message
log as an error message

Attributes
protected
Definition Classes
Logger
def logGroup[A](a: ⇒ A): A
wraps around a group to create nested logging
wraps around a group to create nested logging

Attributes
protected
Definition Classes
Logger
def logPrefix: String
the prefix used to identify this extension for logging, by default the class name
the prefix used to identify this extension for logging, by default the class name

Definition Classes
Extension → Logger
def logTemp(s: ⇒ String): Unit
temporary logging - always logged
temporary logging - always logged

Attributes
protected
Definition Classes
Logger
def makeErrorThrower(msg: String): ErrorHandler
an ErrorHandler that wraps an error in a LocalError and throws it
an ErrorHandler that wraps an error in a LocalError and throws it

Attributes
protected
Definition Classes
Extension
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 objectLevel: ObjectParser

Definition Classes
Parser → LeveledExtension
val report: Report

Attributes
protected
Definition Classes
Extension → Logger
def start(args: List[String]): Unit
extension-specific initialization (override as needed, empty by default)
extension-specific initialization (override as needed, empty by default)

Definition Classes
Extension
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()
def waitUntilRemainingTasksFinished: Unit
extensions that process tasks in separate threads should override this and wait until those threads are done
extensions that process tasks in separate threads should override this and wait until those threads are done

Definition Classes
Extension

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

Parser

abstract class Parser extends StructureParser with ObjectParser with LeveledExtension

Instance Constructors

Type Members

Abstract Value Members

Concrete Value Members

Inherited from LeveledExtension

Inherited from ObjectParser

Inherited from StructureParser

Inherited from FormatBasedExtension

Inherited from Extension

Inherited from Logger

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

Parser 

abstract class Parser extends StructureParser with ObjectParser with LeveledExtension

Instance Constructors

Type Members

Abstract Value Members

Concrete Value Members

Inherited from LeveledExtension

Inherited from ObjectParser

Inherited from StructureParser

Inherited from FormatBasedExtension

Inherited from Extension

Inherited from Logger

Inherited from AnyRef

Inherited from Any

Ungrouped

Parser