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
t

info.kwarc.mmt.api.symbols

ObjContainer

trait ObjContainer[T <: Obj] extends AbstractObjectContainer

TermContainer acts as the interface between the structural and the object level

Elements like info.kwarc.mmt.api.symbols.Constant that have a info.kwarc.mmt.api.objects.Term as a component will not declare a term directly but a TermContainer.

TermContainer keeps track of different syntactic representations of the same semantic term. It also stores additional status information.

The representations are read < parsed < analyzed < normalized. Setting a representation marks the higher representations as dirty.

T

the type of objects stored; the type bound is not actually needed, but it helps putting sharper bound on some return types

Source
MultiDimTerm.scala
Linear Supertypes
AbstractObjectContainer, ComponentContainer, AnyRef, Any
Known Subclasses
ContextContainer, TermContainer
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ObjContainer
  2. AbstractObjectContainer
  3. ComponentContainer
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type ThisType <: ObjContainer[T]

Abstract Value Members

  1. abstract def getAnalyzedIfFullyChecked: Option[T]
  2. abstract def hasSameType(oc: ObjContainer[_]): Boolean

    checks if a container stores objects of the same type

    checks if a container stores objects of the same type

    Attributes
    protected
  3. abstract def newEmpty: ThisType

    creates a new empty container for the same type

    creates a new empty container for the same type

    Attributes
    protected

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 analyzed: Option[T]

    the analyzed representation after type and argument reconstruction (if non-dirty)

  5. def analyzed_=(t: T): Boolean
  6. def analyzed_=(t: Option[T]): Boolean

    setter for the analyzed representation

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. def copy: ThisType

    creates a deep copy of this container, dirty parts are dropped

  10. def delete: Unit

    delete this component

    delete this component

    Definition Classes
    ObjContainer → ComponentContainer
  11. lazy val dependsOn: HashSet[CPath]

    stores the set of components that analysis depended on

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def equivalentTo(that: ComponentContainer): Boolean

    true if two containers have the same content

    true if two containers have the same content

    Definition Classes
    ComponentContainer
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def get: Option[T]

    getter for the best available non-dirty representation: analyzed or parsed

    getter for the best available non-dirty representation: analyzed or parsed

    Definition Classes
    ObjContainer → AbstractObjectContainer
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def isAnalyzedDirty: Boolean

    true if the term must be (re)analyzed

  20. def isDefined: Boolean

    true if any dimension is present, i.e., if the component is present

    true if any dimension is present, i.e., if the component is present

    Definition Classes
    ObjContainer → ComponentContainer
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def isParsedDirty: Boolean

    true if the term must still be (re)parsed

  23. def lastChangeAnalyzed: Long

    time of the last change

  24. def lastChangeParsed: Long

    time of the last change

  25. def merge(that: ThisType): ThisType
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def normalize(normFun: (T) ⇒ T): Unit

    sets the normalized representation (if not already set) using a normalization function Because normalization is need-based, this should be called, if possible, before accessing the normalized representation.

  28. def normalized: Option[T]

    the normalized representation after type and argument reconstruction (if non-dirty)

    the normalized representation after type and argument reconstruction (if non-dirty)

    This is not always computed, and even if it is, it is not returned by default by the get method. It is intended for optimizations where the normalized form of a Term would otherwise have to be recomputed.

  29. def normalized_=(t: Option[T]): Boolean

    setter for the normalized representation

  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. def parsed: Option[T]

    the parsed representation without further analysis (if non-dirty)

  33. def parsed_=(t: T): Unit
  34. def parsed_=(t: Option[T]): Boolean

    setter for the parsed representation without further analysis

  35. def read: Option[String]

    the unparsed string representation

  36. def read_=(s: String): Unit
  37. def read_=(s: Option[String]): Boolean

    setter for the unparsed string representation

  38. def set(t: T): Unit

    clears the contents of this component and sets it to a new value

  39. def setAnalyzedDirty: Unit

    marks this term for re-analysis

  40. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  41. def toString(): String
    Definition Classes
    ObjContainer → AnyRef → Any
  42. def update(tc: ComponentContainer): Boolean

    copies over the non-dirty components of another TermContainer dependent dimensions that are not part of tc become dirty

    copies over the non-dirty components of another TermContainer dependent dimensions that are not part of tc become dirty

    returns

    true if a change took place

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

Inherited from AbstractObjectContainer

Inherited from ComponentContainer

Inherited from AnyRef

Inherited from Any

Ungrouped