package archives
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.
- Source
- package.scala
- Alphabetic
- By Inheritance
- archives
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
trait
AggregatingBuildTarget extends TraversingBuildTarget
builds a folder by concatenating the build results of its children
builds a folder by concatenating the build results of its children
not used yet!
-
class
Archive extends ROArchive with Validate with ScalaCode with ZipArchive
archive management
archive management
Archive is a very big class, so most of its functionality is outsourced to various traits that are mixed in here
-
abstract
class
ArchiveChangeListener extends ChangeListener
a change listener that call a function exactly once for each open archive
-
abstract
class
ArchiveDimension extends AnyRef
an identifier for a subfolder of an archive
an identifier for a subfolder of an archive
use "archive / dim" to obtain the location of this folder in an archive
see the package object for predefined dimensions
-
case class
Build(update: Update) extends BuildTargetModifier with Product with Serializable
default modifier: build the target
- sealed abstract class BuildDependency extends Dependency
-
case class
BuildEmpty(str: String) extends BuildResult with Product with Serializable
default build result
-
case class
BuildError(archive: Archive, target: String, path: FilePath, data: ErrorContent) extends Product with Serializable
an Error as reconstructed from an error file
-
case class
BuildFailure(used: List[Dependency], provided: List[ResourceDependency]) extends BuildResult with Product with Serializable
unrecoverable failure
-
trait
BuildManager extends Extension
handles build tasks generated by a TraversingBuildTarget
-
class
BuildQueue extends ServerExtension with BuildManager
uses a queue of build tasks for multi-threaded execution, includes dependency management
-
sealed abstract
class
BuildResult extends AnyRef
output and result state of tasks in the build queue
-
case class
BuildSuccess(used: List[Dependency], provided: List[ResourceDependency]) extends BuildResult with Product with Serializable
successful build
-
abstract
class
BuildTarget extends FormatBasedExtension
A BuildTarget provides build/update/clean methods that generate one or more dimensions in an Archive from an input dimension.
- trait BuildTargetArguments extends AnyRef
-
sealed abstract
class
BuildTargetModifier extends AnyRef
when calling a BuildTarget we can use modifiers for, e.g., cleaning
-
class
BuildTask extends MMTTask
auxiliary type to represent the parameters and result of building a file/directory
auxiliary type to represent the parameters and result of building a file/directory
this is no case class due to a state-dependent error continuation
-
case class
Current(file: File, path: FilePath) extends Product with Serializable
convenience class for traversing an Archive
-
sealed abstract
class
Dependency extends AnyRef
dependency of a QueuedTask
-
case class
Dim(path: String*) extends ArchiveDimension with Product with Serializable
a dimension with a fixed location
-
case class
DirBuildDependency(key: String, archive: Archive, inPath: FilePath, children: List[BuildTask]) extends BuildDependency with Product with Serializable
like FileBuildDependency but for a directory
like FileBuildDependency but for a directory
- inPath
path to file (without inDim)
-
class
DummyBuildTarget extends TraversingBuildTarget
a simple build target for testing
- case class ErrorContent(child: Int, level: Level.Level, sourceRef: Option[SourceRef], shortMsg: String) extends Product with Serializable
-
class
ErrorManager extends Extension with Logger
maintains all errors produced while running BuildTargets on Archives
-
class
ErrorMap extends HashMap[(String, List[String]), List[BuildError]]
maintains the errors of an archive, mapping (target,path) to error list
- trait Exporter extends BuildTarget
-
abstract
class
ExternalImporter extends Importer
an importer implemented as a wrapper around an external tool
-
case class
FileBuildDependency(key: String, archive: Archive, inPath: FilePath) extends BuildDependency with Product with Serializable
dependency on another BuildTask
dependency on another BuildTask
- inPath
path to file (without inDim)
- class FlatExporter extends BuildTarget with Exporter
- class FlatteningMWSExporter extends BuildTarget with Exporter
- class FlatteningPresenter extends Presenter
-
abstract
class
FoundedExporter extends BuildTarget with Exporter
An Exporter that exports relative to a bifoundation
-
trait
GeneralImporter extends Extension
common functionality of importers
-
abstract
class
Git extends AnyRef
builds git commands
- class IDMathMLPresenter extends MathMLPresenter
-
abstract
class
Importer extends TraversingBuildTarget with GeneralImporter
a traversing build target for importing an archive in some source syntax
a traversing build target for importing an archive in some source syntax
This should only be needed when OMDoc is received from a third party. OMDoc produced by Compilers is indexed automatically.
-
abstract
class
LMHHub extends Logger
represents a hub of archives
-
trait
LMHHubArchiveEntry extends LMHHubDirectoryEntry
represents a single archive inside an LMHHub that is installed on disk
-
trait
LMHHubDirectoryEntry extends LMHHubEntry
Represents a simple LMHHub Directory entry
-
trait
LMHHubEntry extends Logger
represents a single git archive inside an LMHHub that is installed on disk
-
trait
LMHHubGroupEntry extends LMHHubDirectoryEntry
represents a group archive inside an LMHHub that is installed on disk
-
case class
LogicalDependency(mpath: MPath) extends ResourceDependency with Product with Serializable
a dependency on an MMT module that must be provided by building some other BuildTask
- class MWSHarvestExporter extends BuildTarget with Exporter
-
class
MathHub extends LMHHub
Represents a (mutable) MathHub instance
-
case class
MissingDependency(needed: List[Dependency], provided: List[ResourceDependency], used: List[Dependency]) extends BuildResult with Product with Serializable
recoverable failure: build should be retried after building a missing dependency
- sealed abstract class Modification extends AnyRef
-
abstract
class
NonTraversingImporter extends GeneralImporter
An importer that controls the entire import on its own and imports all documents at once.
An importer that controls the entire import on its own and imports all documents at once. It may import multiple archives at once. Implementations must call importDocument on every document they generate.
Importers that handle each source file individually should subclass Importer instead, which is also a build target.
-
case class
NotLoadableArchiveEntry(root: File) extends Error with Product with Serializable
Error that is thrown when an archive on disk is not an actual archive
-
case class
NotLoadableGroupEntry(root: File) extends Error with Product with Serializable
Error that is thrown when an archive on disk is not an actual archive
-
class
OMDocImporter extends Importer
a trivial importer that reads OMDoc documents and indexes them
-
case class
PhysicalDependency(file: File) extends ResourceDependency with Product with Serializable
a dependency on a physical resource
- class PythonExporter extends BuildTarget with Exporter
-
class
QueuedTask extends AnyRef
input and current state of tasks in the build queue
- abstract class ROArchive extends Storage with Logger
-
case class
RedirectableDimension(key: String, defaultOpt: Option[ArchiveDimension] = None) extends ArchiveDimension with Product with Serializable
a dimension with an archive-specific location
a dimension with an archive-specific location
- key
the property that can be used to define the location
- defaultOpt
the default location if the property is not set (equal to "key" if absent)
- sealed abstract class ResourceDependency extends Dependency
- trait ScalaCode extends AnyRef
-
class
ScalaCompiler extends BuildTarget
a build target that delegates to the standard scala compiler
-
case class
SimpleStatistics(theoryCount: Int, constantCount: Int) extends Product with Serializable
very simple statistics implementation
- case class TestModifiers(compareWithTest: Boolean = false, addTest: Boolean = false, updateTest: Boolean = false) extends Product with Serializable
-
case class
TraverseMode(includeFile: (String) ⇒ Boolean, includeDir: (String) ⇒ Boolean, parallel: Boolean) extends Product with Serializable
grouped argument when traversing
-
abstract
class
TraversingBuildTarget extends BuildTarget
This abstract class provides common functionality for BuildTargets that traverse all files in the input dimension.
This abstract class provides common functionality for BuildTargets that traverse all files in the input dimension.
It implements BuildTarget in terms of the abstract method buildFile called to build a file in the archive. It is also possible to override the method buildDir to post process directory content.
-
class
TrivialBuildManager extends BuildManager
builds tasks immediately (no queueing, no dependency management, no parallel processing)
-
case class
Update(errorLevel: Level.Level, dryRun: Boolean = false, testOpts: TestModifiers = TestModifiers(), dependencyLevel: Option[Level.Level] = Some(Level.Ignore)) extends Product with Serializable
incremental build: skip this build if it nothing has changed
-
trait
Validate extends AnyRef
This trait adds validation operations to Archive's
- class ValidationTask extends MMTTask
-
class
WindowsGit extends Git
git behaves rather weirdly under windows, especially if authentication is needed
git behaves rather weirdly under windows, especially if authentication is needed
this runs the UnixGit commands in the bash shell that comes with windows git
- trait ZipArchive extends AnyRef
-
case class
BuildDepsFirst(update: Update) extends BuildTargetModifier with Product with Serializable
- Annotations
- @MMT_TODO( message = "needs review" )
- Deprecated
needs review
Value Members
- val content: ArchiveDimension
- val errors: ArchiveDimension
- val export: ArchiveDimension
- val flat: ArchiveDimension
- val narration: ArchiveDimension
- val notational: ArchiveDimension
- val relational: ArchiveDimension
- val source: ArchiveDimension
- object Added extends Modification with Product with Serializable
- object Archive
-
object
Build extends Build
forces building independent of status
- object BuildResult
-
object
BuildTargetModifier
parsing method for build target modifiers
-
object
Clean extends BuildTargetModifier with Product with Serializable
don't run, just delete all output files
- object Deleted extends Modification with Product with Serializable
- object ErrorReader
-
object
ImporterAnnotator extends StringAnnotator
used to annotate the Importer to any imported document of module
- object LMHHub
- object MathHub
- object Modification
- object Modified extends Modification with Product with Serializable
-
object
Relational
an object to extract dependencies from a controller
- object ScalaOutDim extends RedirectableDimension
- object SimpleStatistics extends Serializable
- object Table
-
object
UnixGit extends Git
prepends the path to git to the git commands
- object Unmodified extends Modification with Product with Serializable