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 symbols

    MMT Declarations are the elements of Modules.

    MMT Declarations are the elements of Modules. The kinds of declarations are documented at Declaration.

    ObjContainer are owned by structural elements, in particular by declarations, to store objects.

    Definition Classes
    api
  • ApplyMorphism
  • ApplyMorphismLazy
  • ApplySubs
  • BoundTheoryParameters
  • Constant
  • ConstantAssignment
  • ContextContainer
  • Declaration
  • DefLinkAssignment
  • DerivedContentElement
  • DerivedDeclaration
  • DerivedModule
  • Elaboration
  • FinalConstant
  • GeneralStructuralFeature
  • GenerativePushout
  • HasDefiniens
  • HasNotation
  • HasType
  • IdentityInclude
  • IdentityTranslator
  • Include
  • IncludeData
  • IncludeLike
  • LazyConstant
  • LinkInclude
  • ModuleLevelFeature
  • NestedModule
  • OMLReplacer
  • OMSReplacer
  • ObjContainer
  • ObjDimension
  • ParametricTheoryLike
  • PlainInclude
  • Renamer
  • RuleConstant
  • RuleConstantInterpreter
  • RuleConstantParser
  • SimpleDeclaredStructure
  • SimpleLazyConstant
  • SimpleStructure
  • StructuralFeature
  • StructuralFeatureRule
  • StructuralFeatureUtil
  • Structure
  • TermContainer
  • TheoryLike
  • Translator
  • TraversingTranslator
  • TypedConstantLike
  • TypedParametricTheoryLike
  • UniformTranslator
  • UnnamedUntyped
  • Untyped
  • Visibility
c

info.kwarc.mmt.api.symbols

Declaration

abstract class Declaration extends ContentElement

Declarations are the children of Modules.

They are mostly Constants for the syntax and RuleConstants for the semantics (= rule-based implementation). The MMT data model is extensible via DerivedDeclarations.

Structures (except for includes) are conceptually a derived declaration but are hard-coded as a separate kind of declaration. Inlcudes are represented as special cases of structures.

Source
Declaration.scala
Linear Supertypes
ContentElement, StructuralElement, NamedElement, Content, ClientProperties, HasMetaData, AnyRef, Any
Known Subclasses
Instance, Constant, DerivedDeclaration, FinalConstant, LazyConstant, NestedModule, RuleConstant, SimpleLazyConstant, Structure, ElaboratedConstant
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Declaration
  2. ContentElement
  3. StructuralElement
  4. NamedElement
  5. Content
  6. ClientProperties
  7. HasMetaData
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Declaration()

Type Members

  1. abstract type ThisType >: Declaration.this.type <: Declaration

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

Abstract Value Members

  1. abstract val feature: String

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

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

    Definition Classes
    ContentElement → StructuralElement
  2. abstract def getComponents: List[DeclarationComponent]

    returns all term components of this elements

    returns all term components of this elements

    Definition Classes
    StructuralElement
  3. abstract def getDeclarations: List[Declaration]

    returns all children of this elements

    returns all children of this elements

    Definition Classes
    Declaration → ContentElement → StructuralElement
  4. abstract val home: Term

    the containing module

    the containing module

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

  5. abstract def merge(that: Declaration): 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)'

  6. abstract 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
    Declaration → ContentElement → NamedElement
  7. abstract def toNode: Node

    XML representation

    XML representation

    Definition Classes
    Content
  8. abstract def translate(newHome: Term, prefix: LocalName, translator: Translator, context: Context): ThisType

    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

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 alternativeNames: List[LocalName]

    an alternative name

    an alternative name

    None by default; overridden in particular by Constant

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. lazy val clientProperty: ListMap[URI, Any]
    Definition Classes
    ClientProperties
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. 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
  9. def documentHome: DPath
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def equivalentTo(that: StructuralElement): Boolean

    logically equivalent: compares headerInfo, components, and declarations

    logically equivalent: compares headerInfo, components, and declarations

    Definition Classes
    StructuralElement
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. 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
  15. 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
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getComponent(k: ComponentKey): Option[ComponentContainer]

    returns a specific component if present

    returns a specific component if present

    Definition Classes
    StructuralElement
  18. 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
  19. def getMetaDataNode: NodeSeq
    Definition Classes
    HasMetaData
  20. def getOrigin: Origin
    Definition Classes
    StructuralElement
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. 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
  23. def isGenerated: Boolean
    Definition Classes
    StructuralElement
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. 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
  26. def mergeError(that: Declaration): Nothing

    called to throw an error from within 'merge'

    called to throw an error from within 'merge'

    Attributes
    protected
  27. val metadata: MetaData
    Definition Classes
    HasMetaData
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. lazy val parent: MPath

    the containing module

    the containing module

    Definition Classes
    Declaration → StructuralElement
  32. def path: GlobalName

    the full MMT URI, parent ? name

    the full MMT URI, parent ? name

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

    returns

    the shortest name and all other names

  34. def relativeDocumentHome: LocalName
  35. def setDocumentHome(ln: LocalName): Unit
  36. def setOrigin(o: Origin): Unit
    Definition Classes
    StructuralElement
  37. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  38. 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
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. def toTerm: OMID

    the OMS referencing this declaration

    the OMS referencing this declaration

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

    a recursively translated copy of this declaration

  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

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