Packages

  • package root
    Definition Classes
    root
  • package info
    Definition Classes
    root
  • package kwarc
    Definition Classes
    info
  • package mmt
    Definition Classes
    kwarc
  • package MitM
    Definition Classes
    mmt
  • 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 argsemcomp
    Definition Classes
    mmt
  • package concepts
    Definition Classes
    mmt
  • package coq
    Definition Classes
    mmt
  • package doc
    Definition Classes
    mmt
  • package frameit
    Definition Classes
    mmt
  • package glf
    Definition Classes
    mmt
  • package got
    Definition Classes
    mmt
  • package imps
    Definition Classes
    mmt
  • package intellij
    Definition Classes
    mmt
  • package interviews
    Definition Classes
    mmt
  • package isabelle_dummy
    Definition Classes
    mmt
  • package itp
    Definition Classes
    mmt
  • package jedit
    Definition Classes
    mmt
  • package jeditsetup
    Definition Classes
    mmt
  • package latex
    Definition Classes
    mmt
  • package lf
    Definition Classes
    mmt
  • package lsp
    Definition Classes
    mmt
  • package mathhub
    Definition Classes
    mmt
  • package mathscheme
    Definition Classes
    mmt
  • package metamath
    Definition Classes
    mmt
  • package mizar
    Definition Classes
    mmt
  • package moduleexpressions
    Definition Classes
    mmt
  • package odk
    Definition Classes
    mmt
  • package oeis
    Definition Classes
    mmt
  • package openmath
    Definition Classes
    mmt
  • package owl
    Definition Classes
    mmt
  • package planetary
    Definition Classes
    mmt
  • package pvs
    Definition Classes
    mmt
  • package python
    Definition Classes
    mmt
  • package refactoring
    Definition Classes
    mmt
  • package reflection
    Definition Classes
    mmt
  • package repl
    Definition Classes
    mmt
  • package sequences
    Definition Classes
    mmt
  • package specware
    Definition Classes
    mmt
  • package sql
    Definition Classes
    mmt
  • package stex
    Definition Classes
    mmt
  • package test
    Definition Classes
    mmt
  • package tps
    Definition Classes
    mmt
  • package tptp
    Definition Classes
    mmt
  • package twelf
    Definition Classes
    mmt
  • AssignmentBlock
  • BackgroundCrawler
  • BackgroundEliminator
  • Block
  • Catalog
  • CatalogError
  • ConflictGuard
  • CstAssignmentBlock
  • CstDeclBlock
  • DeclBlock
  • Document
  • EncodingException
  • FileCrawler
  • FileOpenError
  • InexistentLocation
  • ModuleBlock
  • NamedBlock
  • ParseError
  • PortUnavailable
  • Position
  • Run
  • SemanticCommentBlock
  • SigBlock
  • StrAssignmentBlock
  • StrDeclBlock
  • Time
  • URI
  • ViewBlock
  • WebServer
  • isTaken
  • loadResource

package twelf

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. abstract class AssignmentBlock extends NamedBlock

    A constant or structure assignment

  2. class BackgroundCrawler extends Thread

    A thread that checks for updated files and crawls them every crawlingInterval seconds

  3. class BackgroundEliminator extends Thread

    A thread that checks for deleted files every deletingInterval seconds and eliminates them from the hashes

  4. abstract class Block extends AnyRef

    A block of information within a document

  5. class Catalog extends AnyRef

    The information maintained by crawling all the locations

  6. case class CatalogError(s: String) extends Exception with Product with Serializable

    Exception thrown by the catalog if a query is unsuccessul

  7. case class CstAssignmentBlock(uri: URI, url: URI, name: String, pos: Position) extends AssignmentBlock with Product with Serializable

    A constant assignment

  8. case class CstDeclBlock(uri: URI, url: URI, name: String, pos: Position) extends DeclBlock with Product with Serializable

    A constant declaration

  9. abstract class DeclBlock extends NamedBlock

    A constant or structure declaration

  10. class Document extends AnyRef

    All information extracted from a file

  11. case class EncodingException(s: String) extends Exception with Product with Serializable

    Occurs during file opening

  12. class FileCrawler extends AnyRef

    Algorithms for crawling a file

  13. case class FileOpenError(s: String) extends Exception with Product with Serializable

    Exception thrown if a file cannot be opened

  14. case class InexistentLocation(s: String) extends Exception with Product with Serializable

    Exception thrown when a location specified does not exist on disk

  15. abstract class ModuleBlock extends NamedBlock

    A theory or view

  16. abstract class NamedBlock extends Block

    A block with name and URI

  17. case class ParseError(s: String) extends Exception with Product with Serializable

    Exception related to parsing

  18. case class PortUnavailable(s: String) extends Exception with Product with Serializable

    Exception thrown when the web server cannot be started because the specified port is already in use

  19. class Position extends AnyRef

    Start and end two-dimensional coordinates of a block

  20. case class SemanticCommentBlock(comment: String, properties: LinkedHashMap[String, String], pos: Position) extends Block with Product with Serializable

    A semantic comment The "short" property is the text on the first line of the comment, if it is not preceded by a '@' The "long" property is the text starting on the second line of the comment, until the first line that starts with '@' Each subsequent lines must start with '@'.

    A semantic comment The "short" property is the text on the first line of the comment, if it is not preceded by a '@' The "long" property is the text starting on the second line of the comment, until the first line that starts with '@' Each subsequent lines must start with '@'. The first word after '@' is the key, the rest of the line is the value.

  21. case class SigBlock(uri: URI, url: URI, name: String, children: MutableList[DeclBlock], deps: LinkedHashSet[URI], pos: Position) extends ModuleBlock with Product with Serializable

    A theory

  22. case class StrAssignmentBlock(uri: URI, url: URI, name: String, pos: Position) extends AssignmentBlock with Product with Serializable

    A structure assignment

  23. case class StrDeclBlock(uri: URI, url: URI, name: String, children: MutableList[AssignmentBlock], domain: Option[URI], pos: Position) extends DeclBlock with Product with Serializable

    A structure declaration

  24. case class URI(uri: java.net.URI) extends Product with Serializable
  25. case class ViewBlock(uri: URI, url: URI, name: String, children: MutableList[AssignmentBlock], deps: LinkedHashSet[URI], domain: URI, codomain: LinkedHashSet[URI], pos: Position) extends ModuleBlock with Product with Serializable

    A view

  26. class WebServer extends HServer

    An HTTP RESTful server.

Value Members

  1. object Catalog

    Utility object

  2. object ConflictGuard

    For synchronization of update operations

  3. object FileCrawler

    Crawl a file

  4. object Run

    Run the web server and console input

  5. object Time

    Current time as a string

  6. object URI extends Serializable
  7. object isTaken

    Checks if a port is used

    Checks if a port is used

    returns

    true if the port is used, false if it is available

  8. object loadResource

    Get a stream to a resource within the JAR file.

    Get a stream to a resource within the JAR file. If it's not found in the JAR, then it looks into the file system

    returns

    Some(stream to the resource) if found, None otherwise. **The caller must close the stream after reading!**

    Exceptions thrown

    EncodingException(message) if the file is not in the given encoding

Ungrouped