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.

    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 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
  • AlreadyDefined
  • Completion
  • FailingNotFoundHandler
  • ImplicitGraph
  • InactiveElement
  • IncludeOption
  • LabeledHashRelation
  • Library
  • Lookup
  • LookupWithNotFoundHandler
  • ModuleHashMap
  • Names
  • ThinGeneratedCategory
  • UniqueGraph

abstract class Lookup extends AnyRef

A read-only abstraction of a library. A Library is a Lookup with write methods

Self Type
Lookup
Source
Lookup.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Library, LookupWithNotFoundHandler
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Lookup
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Lookup()

Abstract Value Members

  1. abstract def forDeclarationsInScope(mod: Term)(f: (MPath, Term, Declaration) ⇒ Unit): Unit

    apply a function to all declarations that are visible (based on what is currently loaded) to a theory

    apply a function to all declarations that are visible (based on what is currently loaded) to a theory

    mod

    the theory

    f

    applied to (theory t declaring d, morphism mod->t that makes d visible, d)

  2. abstract def get(home: Term, name: LocalName, error: (String) ⇒ Nothing): Declaration

    lookup a declaration in a (possibly complex) module

    lookup a declaration in a (possibly complex) module

    home

    the module in which to look up

    name

    the name look up; must start with ComplexStep unless it is local to home

    error

    the continuation to call on the error message

    returns

    the declaration

  3. abstract def get(path: Path): StructuralElement

    lookup a path

  4. abstract def getImplicit(from: Term, to: Term): Option[Term]
  5. abstract def preImage(p: GlobalName): Option[GlobalName]

    if p is imported by a structure, returns the preimage of the symbol under the outermost structure

  6. abstract def visible(to: Term): Iterable[MPath]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(path: ContentPath): StructuralElement
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def getAs[E <: ContentElement](cls: Class[E], home: Term, name: LocalName, error: (String) ⇒ Nothing): E

    like get but with restricted return type

  11. def getAs[E <: StructuralElement](cls: Class[E], path: Path): E

    like get but with restricted return type example: getAs(classOf[Constant], path): Constant

  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def getComponent(path: CPath): ComponentContainer
  14. def getConstant(path: GlobalName, msg: (Path) ⇒ String = defmsg): Constant
  15. def getDomain(a: Declaration): (AbstractTheory, Option[Link])

    gets the domain in which a Declaration was declared

    gets the domain in which a Declaration was declared

    This can be used to retrieve the source of an assignment declared in a DeclaredLink. It is also the official way to test whether a Constant is an assignment.

    a

    the Constant declaration/assignment

    returns

    if assignment: the source theory and the containing link; if declaration: the containing theory

  16. def getImplicit(from: MPath, to: MPath): Option[Term]
  17. def getLink(path: ContentPath, msg: (Path) ⇒ String = defmsg): Link
  18. def getModule(path: MPath): Module

    important special case

  19. def getO(home: Term, name: LocalName): Option[Declaration]

    like get but returns optional

  20. def getO(path: Path): Option[StructuralElement]

    like get, but returns option

  21. def getParent(d: Declaration): ModuleOrLink

    returns the container element that contains a declarations

  22. def getStructure(path: GlobalName, msg: (Path) ⇒ String = defmsg): Structure
  23. def getSymbol(path: GlobalName, msg: (Path) ⇒ String = defmsg): Declaration
  24. def getTheory(path: MPath, msg: (Path) ⇒ String = defmsg): Theory
  25. def getView(path: MPath, msg: (Path) ⇒ String = defmsg): View
  26. def hasImplicit(from: Term, to: Term): Boolean
  27. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. def quasiAliasFor(c: GlobalName): List[GlobalName]

    all constants for which c is a quasi-alias (recursively) a quasi-alias is defined by a definition c = OMS(d)

  33. def resolveName(parents: List[MPath], name: LocalName): List[GlobalName]

    resolves a name in a list of theories using any included theory, possibly inserting include steps

  34. def resolveRealizedName(parent: ModuleOrLink, name: LocalName): List[GlobalName]

    resolves a name in a module using any included or realized theories

  35. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  40. object ApplyMorphs extends Traverser[Term]

    A Traverser that recursively eliminates all explicit morphism applications.

    A Traverser that recursively eliminates all explicit morphism applications. apply(t,m) can be used to apply a morphism to a term.

  41. object ExpandDefinitions extends Traverser[(ContentPath) ⇒ Boolean]

    A Traverser that recursively expands definitions of Constants.

    A Traverser that recursively expands definitions of Constants. It carries along a test function that is used to determine when a constant should be expanded.

Inherited from AnyRef

Inherited from Any

Ungrouped