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 backend

    This package maintains the interface between MMT content in persistent physical storage and MMT content loaded into memory.

    This package maintains the interface between MMT content in persistent physical storage and MMT content loaded into memory.

    The class Storage is the interface for individual physical storage containers. Most of the time this corresponds to a folder containing an archives.Archive.

    Content is usually stored in OMDoc XML format, which is parsed by the XMLStreamer.

    The class Backend maintains the registered storages and performs conversion between logical MMT URIs and physical locations.

    The frontend.Controller owns an instance of Backend. Any referenced MMT URI is lazily and transparently loaded from the backend into memory and unloaded if MMT runs out of memory.

    Definition Classes
    api
  • ArchiveCustomization
  • ArchiveNarrationStorage
  • Backend
  • DefaultCustomization
  • DefaultRealizationLoader
  • LocalCopy
  • LocalSystem
  • MML
  • NotApplicable
  • QueryTransformer
  • ReadXML
  • RealizationArchive
  • RealizationStorage
  • SourceFromReader
  • Storage
  • TPTP
  • TrivialQueryTransformer
  • XMLObjectParser
  • XMLReader
  • XMLStreamer
c

info.kwarc.mmt.api.backend

SourceFromReader

class SourceFromReader extends Source

an awkward conversion from java.io.Reader to scala.io.Source needed in XMLStreamer because ParsingStream uses the former, but ConstructingParser the latter

Source
StreamXML.scala
Linear Supertypes
Source, Closeable, AutoCloseable, Iterator[Char], TraversableOnce[Char], GenTraversableOnce[Char], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SourceFromReader
  2. Source
  3. Closeable
  4. AutoCloseable
  5. Iterator
  6. TraversableOnce
  7. GenTraversableOnce
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SourceFromReader(r: Reader)

Type Members

  1. class GroupedIterator[B >: A] extends AbstractIterator[Seq[B]] with Iterator[Seq[B]]
    Definition Classes
    Iterator
  2. class LineIterator extends AbstractIterator[String] with Iterator[String]
    Definition Classes
    Source
  3. class Positioner extends AnyRef
    Definition Classes
    Source

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def ++[B >: Char](that: ⇒ GenTraversableOnce[B]): Iterator[B]
    Definition Classes
    Iterator
  4. def /:[B](z: B)(op: (B, Char) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  5. def :\[B](z: B)(op: (Char, B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def addString(b: StringBuilder): StringBuilder
    Definition Classes
    TraversableOnce
  8. def addString(b: StringBuilder, sep: String): StringBuilder
    Definition Classes
    TraversableOnce
  9. def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder
    Definition Classes
    TraversableOnce
  10. def aggregate[B](z: ⇒ B)(seqop: (B, Char) ⇒ B, combop: (B, B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def buffered: BufferedIterator[Char]
    Definition Classes
    Iterator
  13. def ch: Char
    Definition Classes
    Source
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  15. def close(): Unit
    Definition Classes
    Source → Closeable → AutoCloseable
  16. def collect[B](pf: PartialFunction[Char, B]): Iterator[B]
    Definition Classes
    Iterator
    Annotations
    @migration
    Migration

    (Changed in version 2.8.0) collect has changed. The previous behavior can be reproduced with toSeq.

  17. def collectFirst[B](pf: PartialFunction[Char, B]): Option[B]
    Definition Classes
    TraversableOnce
  18. def contains(elem: Any): Boolean
    Definition Classes
    Iterator
  19. def copyToArray[B >: Char](xs: Array[B], start: Int, len: Int): Unit
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  20. def copyToArray[B >: Char](xs: Array[B]): Unit
    Definition Classes
    TraversableOnce → GenTraversableOnce
  21. def copyToArray[B >: Char](xs: Array[B], start: Int): Unit
    Definition Classes
    TraversableOnce → GenTraversableOnce
  22. def copyToBuffer[B >: Char](dest: Buffer[B]): Unit
    Definition Classes
    TraversableOnce
  23. def corresponds[B](that: GenTraversableOnce[B])(p: (Char, B) ⇒ Boolean): Boolean
    Definition Classes
    Iterator
  24. def count(p: (Char) ⇒ Boolean): Int
    Definition Classes
    TraversableOnce → GenTraversableOnce
  25. var descr: String
    Definition Classes
    Source
  26. def drop(n: Int): Iterator[Char]
    Definition Classes
    Iterator
  27. def dropWhile(p: (Char) ⇒ Boolean): Iterator[Char]
    Definition Classes
    Iterator
  28. def duplicate: (Iterator[Char], Iterator[Char])
    Definition Classes
    Iterator
  29. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  31. def exists(p: (Char) ⇒ Boolean): Boolean
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  32. def filter(p: (Char) ⇒ Boolean): Iterator[Char]
    Definition Classes
    Iterator
  33. def filterNot(p: (Char) ⇒ Boolean): Iterator[Char]
    Definition Classes
    Iterator
  34. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. def find(p: (Char) ⇒ Boolean): Option[Char]
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  36. def flatMap[B](f: (Char) ⇒ GenTraversableOnce[B]): Iterator[B]
    Definition Classes
    Iterator
  37. def fold[A1 >: Char](z: A1)(op: (A1, A1) ⇒ A1): A1
    Definition Classes
    TraversableOnce → GenTraversableOnce
  38. def foldLeft[B](z: B)(op: (B, Char) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  39. def foldRight[B](z: B)(op: (Char, B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  40. def forall(p: (Char) ⇒ Boolean): Boolean
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  41. def foreach[U](f: (Char) ⇒ U): Unit
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  42. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  43. def getLines(): Iterator[String]
    Definition Classes
    Source
  44. def grouped[B >: Char](size: Int): GroupedIterator[B]
    Definition Classes
    Iterator
  45. def hasDefiniteSize: Boolean
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  46. def hasNext: Boolean
    Definition Classes
    Source → Iterator
  47. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  48. def indexOf[B >: Char](elem: B, from: Int): Int
    Definition Classes
    Iterator
  49. def indexOf[B >: Char](elem: B): Int
    Definition Classes
    Iterator
  50. def indexWhere(p: (Char) ⇒ Boolean, from: Int): Int
    Definition Classes
    Iterator
  51. def indexWhere(p: (Char) ⇒ Boolean): Int
    Definition Classes
    Iterator
  52. def isEmpty: Boolean
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  53. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  54. def isTraversableAgain: Boolean
    Definition Classes
    Iterator → GenTraversableOnce
  55. val iter: Iterator[Char]
    Definition Classes
    SourceFromReader → Source
  56. def length: Int
    Definition Classes
    Iterator
  57. def map[B](f: (Char) ⇒ B): Iterator[B]
    Definition Classes
    Iterator
  58. def max[B >: Char](implicit cmp: Ordering[B]): Char
    Definition Classes
    TraversableOnce → GenTraversableOnce
  59. def maxBy[B](f: (Char) ⇒ B)(implicit cmp: Ordering[B]): Char
    Definition Classes
    TraversableOnce → GenTraversableOnce
  60. def min[B >: Char](implicit cmp: Ordering[B]): Char
    Definition Classes
    TraversableOnce → GenTraversableOnce
  61. def minBy[B](f: (Char) ⇒ B)(implicit cmp: Ordering[B]): Char
    Definition Classes
    TraversableOnce → GenTraversableOnce
  62. def mkString: String
    Definition Classes
    TraversableOnce → GenTraversableOnce
  63. def mkString(sep: String): String
    Definition Classes
    TraversableOnce → GenTraversableOnce
  64. def mkString(start: String, sep: String, end: String): String
    Definition Classes
    TraversableOnce → GenTraversableOnce
  65. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  66. var nerrors: Int
    Definition Classes
    Source
  67. def next(): Char
    Definition Classes
    Source → Iterator
  68. def nonEmpty: Boolean
    Definition Classes
    TraversableOnce → GenTraversableOnce
  69. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  70. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  71. var nwarnings: Int
    Definition Classes
    Source
  72. def padTo[A1 >: Char](len: Int, elem: A1): Iterator[A1]
    Definition Classes
    Iterator
  73. def partition(p: (Char) ⇒ Boolean): (Iterator[Char], Iterator[Char])
    Definition Classes
    Iterator
  74. def patch[B >: Char](from: Int, patchElems: Iterator[B], replaced: Int): Iterator[B]
    Definition Classes
    Iterator
  75. def pos: Int
    Definition Classes
    Source
  76. def product[B >: Char](implicit num: Numeric[B]): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  77. def reduce[A1 >: Char](op: (A1, A1) ⇒ A1): A1
    Definition Classes
    TraversableOnce → GenTraversableOnce
  78. def reduceLeft[B >: Char](op: (B, Char) ⇒ B): B
    Definition Classes
    TraversableOnce
  79. def reduceLeftOption[B >: Char](op: (B, Char) ⇒ B): Option[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  80. def reduceOption[A1 >: Char](op: (A1, A1) ⇒ A1): Option[A1]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  81. def reduceRight[B >: Char](op: (Char, B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  82. def reduceRightOption[B >: Char](op: (Char, B) ⇒ B): Option[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  83. def report(pos: Int, msg: String, out: PrintStream): Unit
    Definition Classes
    Source
  84. def reportError(pos: Int, msg: String, out: PrintStream): Unit
    Definition Classes
    Source
  85. def reportWarning(pos: Int, msg: String, out: PrintStream): Unit
    Definition Classes
    Source
  86. def reset(): Source
    Definition Classes
    Source
  87. def reversed: List[Char]
    Attributes
    protected[this]
    Definition Classes
    TraversableOnce
  88. def sameElements(that: Iterator[_]): Boolean
    Definition Classes
    Iterator
  89. def scanLeft[B](z: B)(op: (B, Char) ⇒ B): Iterator[B]
    Definition Classes
    Iterator
  90. def scanRight[B](z: B)(op: (Char, B) ⇒ B): Iterator[B]
    Definition Classes
    Iterator
  91. def seq: Iterator[Char]
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  92. def size: Int
    Definition Classes
    TraversableOnce → GenTraversableOnce
  93. def sizeHintIfCheap: Int
    Attributes
    protected[collection]
    Definition Classes
    GenTraversableOnce
  94. def slice(from: Int, until: Int): Iterator[Char]
    Definition Classes
    Iterator
  95. def sliceIterator(from: Int, until: Int): Iterator[Char]
    Attributes
    protected
    Definition Classes
    Iterator
  96. def sliding[B >: Char](size: Int, step: Int): GroupedIterator[B]
    Definition Classes
    Iterator
  97. def span(p: (Char) ⇒ Boolean): (Iterator[Char], Iterator[Char])
    Definition Classes
    Iterator
  98. def sum[B >: Char](implicit num: Numeric[B]): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  99. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  100. def take(n: Int): Iterator[Char]
    Definition Classes
    Iterator
  101. def takeWhile(p: (Char) ⇒ Boolean): Iterator[Char]
    Definition Classes
    Iterator
  102. def to[Col[_]](implicit cbf: CanBuildFrom[Nothing, Char, Col[Char]]): Col[Char]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  103. def toArray[B >: Char](implicit arg0: ClassTag[B]): Array[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  104. def toBuffer[B >: Char]: Buffer[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  105. def toIndexedSeq: IndexedSeq[Char]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  106. def toIterable: Iterable[Char]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  107. def toIterator: Iterator[Char]
    Definition Classes
    Iterator → GenTraversableOnce
  108. def toList: List[Char]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  109. def toMap[T, U](implicit ev: <:<[Char, (T, U)]): Map[T, U]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  110. def toSeq: Seq[Char]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  111. def toSet[B >: Char]: Set[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  112. def toStream: Stream[Char]
    Definition Classes
    Iterator → GenTraversableOnce
  113. def toString(): String
    Definition Classes
    Iterator → AnyRef → Any
  114. def toTraversable: Traversable[Char]
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  115. def toVector: Vector[Char]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  116. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  117. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  118. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  119. def withClose(f: () ⇒ Unit): SourceFromReader.this.type
    Definition Classes
    Source
  120. def withDescription(text: String): SourceFromReader.this.type
    Definition Classes
    Source
  121. def withFilter(p: (Char) ⇒ Boolean): Iterator[Char]
    Definition Classes
    Iterator
  122. def withPositioning(pos: Positioner): SourceFromReader.this.type
    Definition Classes
    Source
  123. def withPositioning(on: Boolean): SourceFromReader.this.type
    Definition Classes
    Source
  124. def withReset(f: () ⇒ Source): SourceFromReader.this.type
    Definition Classes
    Source
  125. def zip[B](that: Iterator[B]): Iterator[(Char, B)]
    Definition Classes
    Iterator
  126. def zipAll[B, A1 >: Char, B1 >: B](that: Iterator[B], thisElem: A1, thatElem: B1): Iterator[(A1, B1)]
    Definition Classes
    Iterator
  127. def zipWithIndex: Iterator[(Char, Int)]
    Definition Classes
    Iterator

Inherited from Source

Inherited from Closeable

Inherited from AutoCloseable

Inherited from Iterator[Char]

Inherited from TraversableOnce[Char]

Inherited from GenTraversableOnce[Char]

Inherited from AnyRef

Inherited from Any

Ungrouped