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

AbbreviationRuleGenerator

ApplicableUnder

BranchInfo

Branchpoint

Checker

CheckingCallback

CheckingEnvironment

CheckingResult

CheckingRule

CheckingUnit

Comment

ComputationRule

CongruenceRule

Continue

Contravariant

Covariant

DelarativeVarianceRule

DelayedConstraint

DelayedInference

DelayedJudgement

Disambiguation

DryRunResult

EliminationRule

Expectation

ExtendedCheckingEnvironment

ExtensionalityRule

FormationRule

ForwardSolutionRule

History

HistoryEntry

Hole

HoleTerm

Ignorevariant

IndentedHistoryEntry

InferAmbiguous

InferenceAndTypingRule

InferenceRule

InferredType

InhabitableRule

Interpreter

IntroductionRule

Invariant

MMTStructureChecker

MaytriggerBacktrack

MightFail

NoHistory

NullChecker

ObjectChecker

OneStepInterpreter

RelationHandler

RuleBasedChecker

SingleTermBasedCheckingRule

SolutionRule

Solver

SolverAlgorithms

SolverError

Stability

StructureChecker

SubtypingRule

Success

SupertypeRule

TermBasedEqualityRule

TermHeadBasedEqualityRule

TheoryExpRule

ThrowableDryRunResult

TwoStepInterpreter

TypeBasedEqualityRule

TypeBasedSolutionRule

TypeBound

TypeCoercionRule

TypeSolutionRule

TypingRule

UnaryTermRule

UncheckedElement

UniverseRule

ValueSolutionRule

Variance

VarianceRule

WouldFail

info.kwarc.mmt.api.checking

TypeCoercionRule

abstract class TypeCoercionRule extends CheckingRule with ApplicableUnder

a type coercion rule lifts a non-type A to the type lift(A) if A occurs where a type is expected

Self Type: TypeCoercionRule
Source: Rules.scala

Linear Supertypes

ApplicableUnder, SingleTermBasedCheckingRule, CheckingRule, SyntaxDrivenRule, Rule, SemanticObject, AnyRef, Any

Known Subclasses

LFTypeCoercionRule

Ordering

Alphabetic
By Inheritance

Inherited

TypeCoercionRule
ApplicableUnder
SingleTermBasedCheckingRule
CheckingRule
SyntaxDrivenRule
Rule
SemanticObject
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new TypeCoercionRule(head: GlobalName, under: List[GlobalName])

Type Members

case class DelayJudgment(msg: String) extends Throwable with Product with Serializable
may be thrown to indicate that the judgment that the rules was called on should be delayed
may be thrown to indicate that the judgment that the rules was called on should be delayed

Definition Classes
CheckingRule

Abstract Value Members

abstract def apply(tp: Term, tm: Term): Option[Term]
the lifting function pre: |- tm: tp and applicable(tp) post: |- apply(tm): type

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 alternativeHeads: List[GlobalName]
additional heads that can trigger the rule, e.g., arrow for a rule with head Pi
additional heads that can trigger the rule, e.g., arrow for a rule with head Pi

Definition Classes
CheckingRule
def applicable(tm: Term): Boolean

Definition Classes
ApplicableUnder → SingleTermBasedCheckingRule
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
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()
val head: GlobalName
an MMT URI that is used to indicate when the Rule is applicable
an MMT URI that is used to indicate when the Rule is applicable

Definition Classes
TypeCoercionRule → SyntaxDrivenRule
def heads: List[GlobalName]

Definition Classes
CheckingRule
def init: Unit
errors in Java initializers are hard to debug; therefore, objects should put initialization code here, which will be called by MMT empty by default, may throw errors
errors in Java initializers are hard to debug; therefore, objects should put initialization code here, which will be called by MMT empty by default, may throw errors

Definition Classes
SemanticObject
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
lazy val mpath: MPath
the MMT URI of this object, derived from its Scala name: scala://package?name
the MMT URI of this object, derived from its Scala name: scala://package?name

Definition Classes
SemanticObject
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 priority: Int
when multiple rules are applicable, rules with higher priorities are preferred
when multiple rules are applicable, rules with higher priorities are preferred
creating a new rule with higher priority can be used to effectively drop imported rules

Definition Classes
Rule
def providedRules: List[Rule]
normally the singleton list of this rule; but rules may bundle additional rules as well
normally the singleton list of this rule; but rules may bundle additional rules as well

Definition Classes
Rule
def shadowedRules: List[Rule]
normally the empty list; but rules may list rules here that should be removed from the context this can be used to override imported rules
normally the empty list; but rules may list rules here that should be removed from the context this can be used to override imported rules

Definition Classes
Rule
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
SyntaxDrivenRule → Rule → AnyRef → Any
val under: List[GlobalName]

Definition Classes
TypeCoercionRule → ApplicableUnder
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

TypeCoercionRule

abstract class TypeCoercionRule extends CheckingRule with ApplicableUnder

Instance Constructors

Type Members

Abstract Value Members

Concrete Value Members

Inherited from ApplicableUnder

Inherited from SingleTermBasedCheckingRule

Inherited from CheckingRule

Inherited from SyntaxDrivenRule

Inherited from Rule

Inherited from SemanticObject

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

TypeCoercionRule 

abstract class TypeCoercionRule extends CheckingRule with ApplicableUnder

Instance Constructors

Type Members

Abstract Value Members

Concrete Value Members

Inherited from ApplicableUnder

Inherited from SingleTermBasedCheckingRule

Inherited from CheckingRule

Inherited from SyntaxDrivenRule

Inherited from Rule

Inherited from SemanticObject

Inherited from AnyRef

Inherited from Any

Ungrouped

TypeCoercionRule