Packages

c

info.kwarc.mmt.api.archives

BuildTarget

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.

Source
BuildTarget.scala
Linear Supertypes
FormatBasedExtension, Extension, Logger, AnyRef, Any
Known Subclasses
AggregatingBuildTarget, DummyBuildTarget, Exporter, ExternalImporter, FlatExporter, FlatteningMWSExporter, FlatteningPresenter, FoundedExporter, Importer, asInterpreter, MWSHarvestExporter, OMDocImporter, PythonExporter, ScalaCompiler, TraversingBuildTarget, Interpreter, OneStepInterpreter, TwoStepInterpreter, DeclarationTreeExporter, DependencyGraphExporter, PathGraphExporter, RelationGraphExporter, SimpleRelationGraphExporter, StatisticsExporter, TheoryGraphExporter, FlatMMTSyntaxPresenter, HTMLPresenter, MMTDocExporter, MMTSyntaxPresenter, OMDocPresenter, Presenter, StructurePresenter, TextPresenter, GenericScalaExporter, OpenMathScalaExporter, URIProducer, Importer, GfImporter, GraphOptimizationTool, IMPSImporter, MacroGeneratingPresenter, ScalaExporter, TPTPPresenter, Twelf, ELPIExporter, Importer, MizarCompiler, GAPDocImporter, GAPGraphExporter, GAPImporter, GAPJSONImporter, ODKGraph, SageImporter, SingularImporter, OEISImporter, OEISPresenter, Exporter, OWLCompiler, MathHubFormalPresenter, PlanetaryAbstractPresenter, PlanetaryPresenter, PVSImporter, AsNotebookPresenter, AsNotebookStructurePresenter, InNotebookHTMLPresenter, NotebookImporter, SpecwareImporter, AllPdf, AllTeX, DepsGenerator, LaTeXBuildTarget, LaTeXDirTarget, LaTeXML, PdfLatex, STeXImporter, SmsGenerator, TikzSvg, TPSImporter, TPTPImporter, TPTPInterpreter
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BuildTarget
  2. FormatBasedExtension
  3. Extension
  4. Logger
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BuildTarget()

Type Members

  1. case class LocalError(s: String) extends ExtensionError with Product with Serializable

    a custom error class for this extension

    a custom error class for this extension

    Definition Classes
    Extension

Abstract Value Members

  1. abstract def build(a: Archive, up: Update, in: FilePath): Unit

    build or update this target in a given archive

  2. abstract def clean(a: Archive, in: FilePath): Unit

    clean this target in a given archive

  3. abstract def key: String

    a string identifying this build target, used for parsing commands, logging, error messages

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(modifier: BuildTargetModifier, arch: Archive, in: FilePath): Unit

    the main function to run the build target

    the main function to run the build target

    en empty in filepath addresses the whole archive

    modifier

    chooses build, clean, or update

    arch

    the archive to build on

    in

    the folder inside the archive's inDim folder to which building is restricted

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def buildDepsFirst(a: Archive, up: Update, in: FilePath = EmptyPath): Unit

    build estimated dependencies first

    build estimated dependencies first

    this can be used by the trivial build manager to build targets (like latexml) in dependency order provided that estimated dependencies are correct.

    For a queue build manager this code is obsolete

  7. def catchErrors[A](msg: String, recoverWith: ⇒ A)(code: ⇒ A): A

    like its partner but with return value

    like its partner but with return value

    Attributes
    protected
    Definition Classes
    Extension
  8. def catchErrors(msg: String)(code: ⇒ Unit): Unit

    convenience method for wrapping code in error handler that throws LocalError

    convenience method for wrapping code in error handler that throws LocalError

    Attributes
    protected
    Definition Classes
    Extension
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. val controller: Controller

    the controller that this extension is added to; only valid after creation of the extension, i.e., will return null if used in a non-lazy val-field

    the controller that this extension is added to; only valid after creation of the extension, i.e., will return null if used in a non-lazy val-field

    Attributes
    protected
    Definition Classes
    Extension
  11. lazy val defaultPrefix: String
    Definition Classes
    Extension
  12. def delete(f: File): Unit

    auxiliary method for deleting a file

    auxiliary method for deleting a file

    Attributes
    protected
  13. def destroy: Unit

    extension-specific cleanup (override as needed, empty by default)

    extension-specific cleanup (override as needed, empty by default)

    Extensions may create persistent data structures and threads, but they must clean up after themselves in this method

    Definition Classes
    Extension
  14. def destroyWhenRemainingTasksFinished: Unit

    convenience for calling waitUntilRemainingTasksFinished and then destroy

    convenience for calling waitUntilRemainingTasksFinished and then destroy

    Definition Classes
    Extension
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def getFromFirstArgOrEnvvar(args: List[String], name: String, default: String = ""): String
    Attributes
    protected
    Definition Classes
    Extension
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def initOther(e: Extension): Unit

    any extension can initialize other extensions if those are not meant to be added to the ExtensionManager

    any extension can initialize other extensions if those are not meant to be added to the ExtensionManager

    Attributes
    protected
    Definition Classes
    Extension
  22. def isApplicable(format: String): Boolean

    format

    the format/key/other identifier, for which an extension is needed

    returns

    true if this extension is applicable

    Definition Classes
    BuildTarget → FormatBasedExtension
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def log(e: Error): Unit

    logs an error - always logged

    logs an error - always logged

    Attributes
    protected
    Definition Classes
    Logger
  25. def log(s: ⇒ String, subgroup: Option[String] = None): Unit

    logs a message with this logger's logprefix

    logs a message with this logger's logprefix

    Attributes
    protected
    Definition Classes
    Logger
  26. def logError(s: ⇒ String): Unit

    log as an error message

    log as an error message

    Attributes
    protected
    Definition Classes
    Logger
  27. def logGroup[A](a: ⇒ A): A

    wraps around a group to create nested logging

    wraps around a group to create nested logging

    Attributes
    protected
    Definition Classes
    Logger
  28. def logPrefix: String

    defaults to the key

    defaults to the key

    Definition Classes
    BuildTarget → Extension → Logger
  29. def logTemp(s: ⇒ String): Unit

    temporary logging - always logged

    temporary logging - always logged

    Attributes
    protected
    Definition Classes
    Logger
  30. def makeErrorThrower(msg: String): ErrorHandler

    an ErrorHandler that wraps an error in a LocalError and throws it

    an ErrorHandler that wraps an error in a LocalError and throws it

    Attributes
    protected
    Definition Classes
    Extension
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. val report: Report
    Attributes
    protected
    Definition Classes
    Extension → Logger
  35. def start(args: List[String]): Unit

    extension-specific initialization (override as needed, empty by default)

    extension-specific initialization (override as needed, empty by default)

    Definition Classes
    Extension
  36. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  37. def toString(): String
    Definition Classes
    BuildTarget → AnyRef → Any
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  41. def waitUntilRemainingTasksFinished: Unit

    extensions that process tasks in separate threads should override this and wait until those threads are done

    extensions that process tasks in separate threads should override this and wait until those threads are done

    Definition Classes
    Extension

Inherited from FormatBasedExtension

Inherited from Extension

Inherited from Logger

Inherited from AnyRef

Inherited from Any

Ungrouped