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 presentation

    The algorithm for presenting MMT content (data structures to user-facing formats).

    The algorithm for presenting MMT content (data structures to user-facing formats). See api for an overview of the algorithms.

    The main interfaces are - Presenter: the main interface for parser (combining a structure and an object parser) - StructurePresenter: presenting structural elements - ObjectPresenter: presenting objects

    The main implementations are (in each case for structural elements and objects) - for OMDoc XML: OMDocPresenter resp. OpenMathPresenter - for plain strings (using the toString methods): TextPresenter resp. ObjectTextPresenter - for nice human-oriented strings: MMTStructurePresenter resp. NotationBasedParser - for HTML: HTMLPresenter resp. MathMLPresenter

    Definition Classes
    api
  • ConsoleWriter
  • FileWriter
  • FlatMMTSyntaxPresenter
  • HTMLAttributes
  • HTMLPresenter
  • HTMLRenderingHandler
  • MMTDocExporter
  • MMTSyntaxPresenter
  • MathMLPresenter
  • NotationBasedPresenter
  • OMDocPresenter
  • ObjectPresenter
  • ObjectTextPresenter
  • OpenMathPresenter
  • PresentationContext
  • Presenter
  • RenderingHandler
  • RenderingResult
  • StringBuilder
  • StructurePresenter
  • TextPresenter
  • VarData
t

info.kwarc.mmt.api.presentation

RenderingResult

trait RenderingResult[A] extends RenderingHandler

Source
RenderingBuilder.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RenderingResult
  2. RenderingHandler
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def get: A

    releases all resources and returns the result of building

  2. abstract def write(s: String): Unit

    writes a string, to be implemented by subclasses

    writes a string, to be implemented by subclasses

    Definition Classes
    RenderingHandler

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def <<[A](a: A)(implicit arg0: (A) ⇒ String): Unit

    shortcut for write

    shortcut for write

    Definition Classes
    RenderingHandler
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. var afterIndentationString: String
    Attributes
    protected
    Definition Classes
    RenderingHandler
  6. def apply(N: NodeSeq): Unit

    output an XML node

    output an XML node

    Definition Classes
    RenderingHandler
  7. def apply(s: String): Unit

    output a string

    output a string

    Definition Classes
    RenderingHandler
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. def done: Unit

    releases all resources without returning a result

    releases all resources without returning a result

    Definition Classes
    RenderingResultRenderingHandler
  11. def elem(tag: String, attributes: (String, String)*)(body: ⇒ Unit): Unit

    write an XML element in a way that the XML nesting is reflected in the code (attribute values will be escaped)

    write an XML element in a way that the XML nesting is reflected in the code (attribute values will be escaped)

    Definition Classes
    RenderingHandler
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def indent(body: ⇒ Unit): Unit

    renders the body in such a way that all calls to nl create indentation one level deeper

    renders the body in such a way that all calls to nl create indentation one level deeper

    Definition Classes
    RenderingHandler
  18. val indentString: String
    Definition Classes
    RenderingHandler
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def nl: Unit

    renders a newline followed by indentation

    renders a newline followed by indentation

    Definition Classes
    RenderingHandler
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  29. def wrap(before: String, after: String)(body: ⇒ Unit): Unit

    wraps output in a pair of brackets

    wraps output in a pair of brackets

    Definition Classes
    RenderingHandler
  30. def writeln(s: String): Unit

    output a string with line ending

    output a string with line ending

    Definition Classes
    RenderingHandler
  31. def xmltext(s: String): Unit

    write text inside an xml element (will be escaped)

    write text inside an xml element (will be escaped)

    Definition Classes
    RenderingHandler

Deprecated Value Members

  1. def writeEndTag(prefix: String, label: String): Unit
    Definition Classes
    RenderingHandler
    Annotations
    @MMT_TODO( message = "probably not needed anymore" )
    Deprecated

    probably not needed anymore

  2. def writeStartTag(prefix: String, label: String, attributes: MetaData, scope: NamespaceBinding): Unit
    Definition Classes
    RenderingHandler
    Annotations
    @MMT_TODO( message = "probably not needed anymore" )
    Deprecated

    probably not needed anymore

Inherited from RenderingHandler

Inherited from AnyRef

Inherited from Any

Ungrouped