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 execution

    The algorithm for imperatively executing MMT content.

    The algorithm for imperatively executing MMT content. This is currently very young and immature.

    See api for an overview of the algorithms.

    Definition Classes
    api
  • ExecutionCallback
  • ExecutionRule
  • Executor
  • Heap
  • Instance
  • PureExecutionCallback
  • RuleBasedExecutor
  • Runtime
  • RuntimeEnvironment
  • ShellCommand
  • Stack

class Instance extends Structure

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Instance
  2. Structure
  3. HasType
  4. Link
  5. ModuleOrLink
  6. HasDefiniens
  7. ContainerElement
  8. MutableElementContainer
  9. ElementContainer
  10. Declaration
  11. ContentElement
  12. StructuralElement
  13. NamedElement
  14. Content
  15. ClientProperties
  16. HasMetaData
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Instance(heap: MPath, of: MPath, id: Int)

Type Members

  1. type ThisType = Structure

    to allow for sharper types of fields, every subclass of Declaration defines this to be itself

    to allow for sharper types of fields, every subclass of Declaration defines this to be itself

    Definition Classes
    Structure → Declaration

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 add(d: Declaration, at: AddPosition = AtEnd): Unit

    adds a named declaration, throws exception if name already declared

    adds a named declaration, throws exception if name already declared

    d

    declaration to add

    at

    the position where to add, at end by default this throws an errors if a declaration for that name already exists; exception: if the two declarations are equivalent, the old one is overridden

    Definition Classes
    ModuleOrLink → MutableElementContainer
  5. def addAfterNarrative(d: Declaration, after: LocalName): Unit

    like add, but treats the second argument as the name of a NarrativeElement

    like add, but treats the second argument as the name of a NarrativeElement

    Definition Classes
    ModuleOrLink
  6. def alternativeNames: List[LocalName]

    an alternative name

    an alternative name

    None by default; overridden in particular by Constant

    Definition Classes
    Declaration
  7. def asDocument: Document

    the narrative structure

    the narrative structure

    Definition Classes
    ModuleOrLink
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def assign(p: GlobalName, t: Term): Unit
  10. lazy val clientProperty: ListMap[URI, Any]
    Definition Classes
    ClientProperties
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. def codomainAsContext: Context

    the codomain as a context; pre: same as to

    the codomain as a context; pre: same as to

    Definition Classes
    Link
  13. def compatible(that: StructuralElement): Boolean

    two StructuralElement's are compatible if they have the same type, same Path, and agree in all parts that are TermContainer's

    two StructuralElement's are compatible if they have the same type, same Path, and agree in all parts that are TermContainer's

    Definition Classes
    StructuralElement
  14. def declares(name: LocalName): Boolean

    true iff a declaration for a name is present

    true iff a declaration for a name is present

    Definition Classes
    ModuleOrLink
  15. def delete(name: LocalName): Option[Declaration]

    delete a named declaration (does not have to exist)

    delete a named declaration (does not have to exist)

    returns

    the deleted declaration

    Definition Classes
    ModuleOrLink → MutableElementContainer
  16. def df: Option[Term]
    Definition Classes
    HasDefiniens
  17. val dfC: TermContainer
    Definition Classes
    Structure → HasDefiniens
  18. def dfNode: Seq[Node] with AbstractSeq[Node] with Serializable
    Definition Classes
    HasDefiniens
  19. def documentHome: DPath
    Definition Classes
    Declaration
  20. def domain: List[LocalName]

    the list of names of all declarations

    the list of names of all declarations

    Definition Classes
    ModuleOrLink → ElementContainer
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. def equivalentTo(that: StructuralElement): Boolean

    logically equivalent: compares headerInfo, components, and declarations

    logically equivalent: compares headerInfo, components, and declarations

    Definition Classes
    StructuralElement
  24. val feature: String

    the kind of declaration, e.g., "constant"

    the kind of declaration, e.g., "constant"

    Definition Classes
    Structure → ContentElement → StructuralElement
  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. def foreachComponent(f: (CPath, ComponentContainer) ⇒ Unit): Unit

    recursively applies a function to all components in this element (in declaration order)

    recursively applies a function to all components in this element (in declaration order)

    Definition Classes
    ContentElement
  27. def foreachDeclaration(f: (ContentElement) ⇒ Unit): Unit

    recursively applies a function to all declarations in this element (in declaration order)

    recursively applies a function to all declarations in this element (in declaration order)

    Definition Classes
    ContentElement
  28. def from: Term

    the domain of this link; pre: must have be given explicitly or have been inferred

    the domain of this link; pre: must have be given explicitly or have been inferred

    Definition Classes
    Link
  29. def fromC: TermContainer

    the domain of a structure is its type

    the domain of a structure is its type

    Definition Classes
    Structure → Link
  30. def get(name: LocalName): Declaration
    Definition Classes
    ElementContainer
  31. def getAllIncludes: List[IncludeData]

    like getIncludes but also with includes of parametric theories and their instantiations

    like getIncludes but also with includes of parametric theories and their instantiations

    Definition Classes
    Link → ModuleOrLink
  32. def getAllIncludesWithSelf: List[IncludeData]

    Get all transitive-reflexive inclusions.

    Get all transitive-reflexive inclusions.

    Definition Classes
    ModuleOrLink
  33. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. def getComponent(k: ComponentKey): Option[ComponentContainer]

    returns a specific component if present

    returns a specific component if present

    Definition Classes
    StructuralElement
  35. def getComponentContext(k: ComponentKey): Context

    like getComponent but returns the additional context (in addition to the context of the element) of the component, empty by default, override as needed unspecified if the component does not exist

    like getComponent but returns the additional context (in addition to the context of the element) of the component, empty by default, override as needed unspecified if the component does not exist

    Definition Classes
    StructuralElement
  36. def getComponents: List[DeclarationComponent]

    returns all term components of this elements

    returns all term components of this elements

    Definition Classes
    Structure → StructuralElement
  37. def getDeclarations: List[Declaration]

    the list of declarations in narrative order, includes generated declarations

    the list of declarations in narrative order, includes generated declarations

    Definition Classes
    ModuleOrLink → ElementContainer → ContentElement → StructuralElement
  38. def getDeclarationsBefore(n: LocalName): List[Declaration]
    Definition Classes
    ElementContainer
  39. def getDeclarationsElaborated: List[Declaration]

    the list of declarations using elaborated declarations where possible these are: primitive elements: includes, constants other elements if they have not been fully elaborated

    the list of declarations using elaborated declarations where possible these are: primitive elements: includes, constants other elements if they have not been fully elaborated

    Definition Classes
    ContainerElement
  40. def getInnerContext: Context

    the context of all declarations in this body

    the context of all declarations in this body

    Definition Classes
    Structure → ModuleOrLink
  41. def getMetaDataNode: NodeSeq
    Definition Classes
    HasMetaData
  42. def getMostSpecific(name: LocalName): Option[(Declaration, LocalName)]
    Definition Classes
    ModuleOrLink → ElementContainer
  43. def getO(name: LocalName): Option[Declaration]

    retrieve a declaration

    retrieve a declaration

    Definition Classes
    ModuleOrLink → ElementContainer
  44. def getO(name: String): Option[Declaration]

    same as get(LocalName(name))

    same as get(LocalName(name))

    Definition Classes
    ElementContainer
  45. def getOrigin: Origin
    Definition Classes
    StructuralElement
  46. def getPrimitiveDeclarations: List[Declaration]

    the list of declarations in the order of addition, excludes generated declarations

    the list of declarations in the order of addition, excludes generated declarations

    Definition Classes
    ContainerElement
  47. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  48. def headerInfo: HeaderInfo

    header information of this elements includes the MMT types (e.g., domain, codomain of links) but not the logical types of constants

    header information of this elements includes the MMT types (e.g., domain, codomain of links) but not the logical types of constants

    Definition Classes
    StructuralElement
  49. def headerNodes: Seq[Node]

    common inner nodes: definiens (metadata is part of document)

    common inner nodes: definiens (metadata is part of document)

    Attributes
    protected
    Definition Classes
    ModuleOrLink
  50. val home: Term

    the containing module

    the containing module

    this is almost always OMMOD(p:MPath), the main exception are generated anonymous modules

    Definition Classes
    Structure → Declaration
  51. def implicitString: String
    Attributes
    protected
    Definition Classes
    Link
  52. def innerNodes: NodeSeq

    getPrimitiveDeclarations, with narrative structure

    getPrimitiveDeclarations, with narrative structure

    Attributes
    protected
    Definition Classes
    ModuleOrLink
  53. def innerNodesElab: List[Node]

    getDeclarationsElaborated, without narrative structure

    getDeclarationsElaborated, without narrative structure

    Attributes
    protected
    Definition Classes
    ModuleOrLink
  54. def innerString: String

    body as a string

    body as a string

    Definition Classes
    ModuleOrLink
  55. def isDeclared(name: LocalName): Boolean
    Definition Classes
    ElementContainer
  56. def isEmpty: Boolean

    true iff no declarations present

    true iff no declarations present

    Definition Classes
    ModuleOrLink
  57. def isGenerated: Boolean
    Definition Classes
    StructuralElement
  58. val isImplicit: Boolean

    true if this link is implicit

    true if this link is implicit

    Definition Classes
    Structure → Link
  59. def isInclude: Boolean
    Definition Classes
    Structure
  60. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  61. val isTotal: Boolean
    Definition Classes
    Structure
  62. def merge(that: Declaration): Structure

    a new declaration with the same path obtained by replacing fields in 'this' with corresponding fields of 'that' Unfortunately, this must take any declaration and throw an error if 'not (that : ThisType)'

    a new declaration with the same path obtained by replacing fields in 'this' with corresponding fields of 'that' Unfortunately, this must take any declaration and throw an error if 'not (that : ThisType)'

    Definition Classes
    Structure → Declaration
  63. def merge(that: StructuralElement): Unit

    merge all properties of 'that' into 'this' except for components and declarations

    merge all properties of 'that' into 'this' except for components and declarations

    Definition Classes
    Declaration → StructuralElement
  64. def mergeError(that: Declaration): Nothing

    called to throw an error from within 'merge'

    called to throw an error from within 'merge'

    Attributes
    protected
    Definition Classes
    Declaration
  65. val metadata: MetaData
    Definition Classes
    HasMetaData
  66. def modulePath: MPath

    path if seen as a module

    path if seen as a module

    Definition Classes
    ModuleOrLink
  67. val name: LocalName

    the local name in the containing module

    the local name in the containing module

    for symbols: the name of the symbols

    for assignments: the name of the symbols to which a value is assigned

    Definition Classes
    Structure → Declaration → ContentElement → NamedElement
  68. def namePrefix: LocalName

    the prefix used when translating declarations along this link

    the prefix used when translating declarations along this link

    Definition Classes
    Structure → Link
  69. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  70. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  71. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  72. def outerString: String

    header as a string (without definiens)

    header as a string (without definiens)

    Attributes
    protected
    Definition Classes
    Structure → ModuleOrLink
  73. lazy val parent: MPath

    the containing module

    the containing module

    Definition Classes
    Declaration → StructuralElement
  74. def path: GlobalName

    the full MMT URI, parent ? name

    the full MMT URI, parent ? name

    Definition Classes
    Declaration → ContentElement → StructuralElement
  75. def primaryNameAndAliases: (LocalName, List[LocalName])

    returns

    the shortest name and all other names

    Definition Classes
    Declaration
  76. def relativeDocumentHome: LocalName
    Definition Classes
    Declaration
  77. def reorder(ln: LocalName): Unit

    moves a declaration to the end of its section (if the relDocHome of ln has changed, it is also moved to the new section) also moves all subsequent ln/X declarations (and updates their relDocHome)

    moves a declaration to the end of its section (if the relDocHome of ln has changed, it is also moved to the new section) also moves all subsequent ln/X declarations (and updates their relDocHome)

    Definition Classes
    ModuleOrLink → MutableElementContainer
  78. def selfInclude: IncludeData

    Get an IncludeData referencing from as the domain and this very link as the definiens (via OMMOD(modulePath)).

    Get an IncludeData referencing from as the domain and this very link as the definiens (via OMMOD(modulePath)).

    Definition Classes
    Link → ModuleOrLink
  79. def setDocumentHome(ln: LocalName): Unit
    Definition Classes
    Declaration
  80. def setOrigin(o: Origin): Unit
    Definition Classes
    StructuralElement
  81. val statements: HashMap[LocalName, Declaration]

    the set of named statements, indexed by name if a statement has an alternativeName, it occurs twice in this map

    the set of named statements, indexed by name if a statement has an alternativeName, it occurs twice in this map

    Attributes
    protected
    Definition Classes
    ModuleOrLink
  82. def streamInnerNodes(rh: RenderingHandler): Unit
    Definition Classes
    ModuleOrLink
  83. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  84. def to: Term

    the codomain of this link; pre: must have been given explicitly or have been inferred

    the codomain of this link; pre: must have been given explicitly or have been inferred

    Definition Classes
    Link
  85. val toC: FinalTermContainer

    the codomain of a structure is its home theory

    the codomain of a structure is its home theory

    Definition Classes
    Structure → Link
  86. def toNode: Elem

    XML representation

    XML representation

    Definition Classes
    Structure → Content
  87. 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
  88. def toString(): String

    outerString, definiens, innerString

    outerString, definiens, innerString

    Definition Classes
    ModuleOrLink → AnyRef → Any
  89. def toTerm: OMID

    the OMS referencing this declaration

    the OMS referencing this declaration

    Definition Classes
    Declaration → ContentElement
  90. def totalString: String
    Attributes
    protected
    Definition Classes
    Structure
  91. def tp: Option[Term]
    Definition Classes
    HasType
  92. val tpC: TermContainer
    Definition Classes
    Structure → HasType
  93. def tpNode: Seq[Node] with AbstractSeq[Node] with Serializable
    Definition Classes
    HasType
  94. def translate(newHome: Term, prefix: LocalName, translator: Translator, context: Context): Structure

    a recursively translated copy of this declaration with a URI

    a recursively translated copy of this declaration with a URI

    newHome

    the home theory of the result

    prefix

    the prefix used to form the name of the new declaration

    Definition Classes
    Structure → Declaration
  95. def translate(translator: Translator, context: Context): ThisType

    a recursively translated copy of this declaration

    a recursively translated copy of this declaration

    Definition Classes
    Declaration
  96. def translateDf(translator: Translator, context: Context): TermContainer
    Definition Classes
    HasDefiniens
  97. def translateTp(translator: Translator, context: Context): TermContainer
    Definition Classes
    HasType
  98. def update(s: Declaration): Unit

    updates a named declaration (preserving the order)

    updates a named declaration (preserving the order)

    Definition Classes
    ModuleOrLink → MutableElementContainer
  99. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  100. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  101. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Structure

Inherited from HasType

Inherited from Link

Inherited from ModuleOrLink

Inherited from HasDefiniens

Inherited from ContainerElement[Declaration]

Inherited from MutableElementContainer[Declaration]

Inherited from ElementContainer[Declaration]

Inherited from Declaration

Inherited from ContentElement

Inherited from StructuralElement

Inherited from NamedElement

Inherited from Content

Inherited from ClientProperties

Inherited from HasMetaData

Inherited from AnyRef

Inherited from Any

Ungrouped