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 parser

  The algorithm for parsing MMT content (strings to MMT data structures).

  The algorithm for parsing MMT content (strings to MMT data structures). See api for an overview of the algorithms.

  The main interfaces are - Parser: the main interface for parser (combining a structure and an object parser) - StructureParser: parsing structural elements - ObjectParser: parsing objects

  The main implementations are - KeywordBasedParser for structural elements in .mmt files - NotationBasedParser for objects

  The latter creates a Scanner for each string, which applies notations to parse user-defined mixifx syntax.

  Structure parsing is extensible using ParserExtensions. Object parsing is extensible using notations or LexerExtensions.

  Definition Classes

  api

• ActiveNotation
• ActiveParsingRule
• Ambiguous
• AnnotatedComment
• AnnotatedCommentToken
• AnnotatedConstant
• AnnotatedDPath
• AnnotatedDelimiter
• AnnotatedDerived
• AnnotatedDocument
• AnnotatedInclude
• AnnotatedKeyword
• AnnotatedName
• AnnotatedNotation
• AnnotatedOpaque
• AnnotatedOpaqueText
• AnnotatedPath
• AnnotatedTerm
• AnnotatedTermToken
• AnnotatedText
• AnnotatedTheory
• AsymmetricEscapeLexer
• BasicTheoryParser
• BoundName
• CFExternalToken
• Child
• CommentIgnorer
• DeclarationDelimiter
• DefaultObjectParser
• ErrorText
• EscapeManager
• ExternalToken
• ExternalTokenParsingInput
• FiniteKeywordsLexer
• FixedLengthLiteralLexer
• Found
• FoundArg
• FoundContent
• FoundDelim
• FoundOML
• FoundSeqArg
• FoundSeqOML
• FoundSimpArg
• FoundSimpSeqArg
• FoundVar
• HasParentInfo
• IsDoc
• IsMod
• IsRootDoc
• IsRootMod
• KeywordBasedParser
• LexFunction
• LexParseExtension
• LexerExtension
• LiteralParser
• MMTPart
• MMTStructureEstimator
• MMTURILexer
• MatchedList
• MetadataParser
• ModuleDelimiter
• NSImportDeclaration
• NamespaceDeclaration
• NotationBasedParser
• NumberLiteralLexer
• ObjectDelimiter
• ObjectParser
• ParentInfo
• ParseFunction
• ParseResult
• Parser
• ParserContext
• ParserExtension
• ParserExtensionArguments
• ParserState
• ParsingRule
• ParsingRuleGroup
• ParsingRuleTable
• ParsingStream
• ParsingUnit
• PrefixedTokenLexer
• PrimitiveTokenListElem
• QuotationLexer
• QuoteLexer
• Reader
• RootInfo
• Scanner
• ScannerBacktrack
• ScannerBacktrackInfo
• ScannerNoBacktrack
• SemanticText
• SemiFormalParser
• SingleFoundVar
• SourcePosition
• SourceRef
• SourceRegion
• StringInterpolationLexer
• StringInterpolationPart
• StringInterpolationToken
• StringPart
• StructureParser
• StructureParserContinuations
• SymmetricEscapeLexer
• Token
• TokenList
• TokenListElem
• TokenSlice
• UnicodeMap
• UnicodeReplacer
• UnmatchedList
• ViewKey
• Whitespace
• WordReplacer

info.kwarc.mmt.api.parser

SourceRef 

Companion object SourceRef