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 archives

    This package holds all classes related to MMT Archives (= project).

    This package holds all classes related to MMT Archives (= project).

    The BuildManager allows defining BuildTargets to run on archives, including in particular Importers and Exporters.

    Most archives are stored in hub of git repositories such as and MathHub or GitHub. Such hubs are represented by the class LMHHub, which allows for cloning, etc. archives.

    The list of currently open archives (from which MMT will load content if needed) is maintained by the backend.Backend.

    Definition Classes
    api
  • class MathHub extends LMHHub

    Represents a (mutable) MathHub instance

    Represents a (mutable) MathHub instance

    Definition Classes
    archives
  • MathHubArchiveEntry
  • MathHubDirectoryEntry
  • MathHubEntry
  • MathHubGroupEntry
c

info.kwarc.mmt.api.archives.MathHub

MathHubDirectoryEntry

class MathHubDirectoryEntry extends MathHubEntry with LMHHubDirectoryEntry

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MathHubDirectoryEntry
  2. LMHHubDirectoryEntry
  3. MathHubEntry
  4. LMHHubEntry
  5. Logger
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MathHubDirectoryEntry(root: File)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def controller: Controller
    Attributes
    protected
    Definition Classes
    LMHHubEntry
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def fetch: Boolean

    download information about archive versions from the remote

    download information about archive versions from the remote

    Definition Classes
    MathHubEntry → LMHHubEntry
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def fixRemote: Boolean

    fix the remote url of the archive

    fix the remote url of the archive

    Definition Classes
    LMHHubEntry
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. lazy val group: String

    the name of the group of this entry

    the name of the group of this entry

    Definition Classes
    LMHHubEntry
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. val hub: MathHub

    the MathHub this LMHHubEntry belongs to

    the MathHub this LMHHubEntry belongs to

    Definition Classes
    MathHubEntry → LMHHubEntry
  16. lazy val id: String

    the id of this archive entry

    the id of this archive entry

    Definition Classes
    LMHHubDirectoryEntry → LMHHubEntry
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def load(): Unit

    loads the LMHHubEntry or throw an error if it is invalid

    loads the LMHHubEntry or throw an error if it is invalid

    Definition Classes
    LMHHubDirectoryEntry → LMHHubEntry
  19. def log(e: Error): Unit

    logs an error - always logged

    logs an error - always logged

    Attributes
    protected
    Definition Classes
    Logger
  20. def log(s: ⇒ String, subgroup: Option[String] = None): Unit

    logs a message with this logger's logprefix

    logs a message with this logger's logprefix

    Attributes
    protected
    Definition Classes
    Logger
  21. def logError(s: ⇒ String): Unit

    log as an error message

    log as an error message

    Attributes
    protected
    Definition Classes
    Logger
  22. def logGroup[A](a: ⇒ A): A

    wraps around a group to create nested logging

    wraps around a group to create nested logging

    Attributes
    protected
    Definition Classes
    Logger
  23. val logPrefix: String
    Definition Classes
    LMHHubEntry → Logger
  24. def logTemp(s: ⇒ String): Unit

    temporary logging - always logged

    temporary logging - always logged

    Attributes
    protected
    Definition Classes
    Logger
  25. def logicalVersion: Option[String]

    returns the logical version (a.k.a branch) of an installed archive

    returns the logical version (a.k.a branch) of an installed archive

    Definition Classes
    MathHubEntry → LMHHubEntry
  26. def matches(spec: String): Boolean

    check if this archive matches a given spec

    check if this archive matches a given spec

    Definition Classes
    LMHHubEntry
  27. lazy val name: String

    the name of this archive

    the name of this archive

    Definition Classes
    LMHHubEntry
  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. def physicalVersion: Option[String]

    returns the physical version (a.k.a commit hash) of an installed archive

    returns the physical version (a.k.a commit hash) of an installed archive

    Definition Classes
    MathHubEntry → LMHHubEntry
  32. def properties: Map[String, String]

    the properties of this entry, if any

    the properties of this entry, if any

    Definition Classes
    LMHHubDirectoryEntry → LMHHubEntry
  33. def pull: Boolean

    pull the newest version of this archive from the remote

    pull the newest version of this archive from the remote

    Definition Classes
    MathHubEntry → LMHHubEntry
  34. def push: Boolean

    push the newest version of this archive to the remote

    push the newest version of this archive to the remote

    Definition Classes
    MathHubEntry → LMHHubEntry
  35. def readLongDescription: Option[String]

    reads the long description

    reads the long description

    Definition Classes
    LMHHubEntry
  36. def report: Report
    Definition Classes
    LMHHubEntry → Logger
  37. val root: File

    the local root of this archive entry

    the local root of this archive entry

    Definition Classes
    MathHubEntry → LMHHubEntry
  38. def setRemote(remote: String): Boolean

    reset the remote url of this archive to a given one

    reset the remote url of this archive to a given one

    Definition Classes
    MathHubEntry → LMHHubEntry
  39. def statistics: Option[SimpleStatistics]
    Definition Classes
    LMHHubDirectoryEntry
  40. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. def version: Option[String]

    gets the version of an installed archive, a.k.a.

    gets the version of an installed archive, a.k.a. the branch of the git commit hash

    Definition Classes
    LMHHubEntry
  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 LMHHubDirectoryEntry

Inherited from MathHubEntry

Inherited from LMHHubEntry

Inherited from Logger

Inherited from AnyRef

Inherited from Any

Ungrouped