c

info.kwarc.mmt.stex

PdfLatex

class PdfLatex extends LaTeXBuildTarget

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PdfLatex
  2. LaTeXBuildTarget
  3. BuildTargetArguments
  4. STeXAnalysis
  5. TraversingBuildTarget
  6. BuildTarget
  7. FormatBasedExtension
  8. Extension
  9. Logger
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PdfLatex()

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
  2. case class LatexError(s: String, l: String) extends ExtensionError with Product with Serializable
    Attributes
    protected
    Definition Classes
    LaTeXBuildTarget

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 anaStartArgs(args: List[String]): Unit
    Definition Classes
    BuildTargetArguments
  5. 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

    Definition Classes
    BuildTarget
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def build(a: Archive, up: Update, in: FilePath, errorCont: Option[ErrorHandler]): Unit

    entry point for recursive building

    entry point for recursive building

    Definition Classes
    TraversingBuildTarget
  8. def build(a: Archive, up: Update, in: FilePath): Unit

    delegates to build

    delegates to build

    Definition Classes
    TraversingBuildTargetBuildTarget
  9. def buildDir(bd: BuildTask, builtChildren: List[BuildTask], level: Level): BuildResult

    similar to buildFile but called on every directory (after all its children have been processed)

    similar to buildFile but called on every directory (after all its children have been processed)

    This does nothing by default and can be overridden if needed.

    bd

    information about input/output file etc

    builtChildren

    tasks for building the children

    level

    error/force level to perform action depending on user input

    Definition Classes
    TraversingBuildTarget
  10. def buildFile(bt: BuildTask): BuildResult

    the main abstract method for building one file

    the main abstract method for building one file

    Definition Classes
    LaTeXBuildTargetTraversingBuildTarget
  11. def buildOpts: OptionDescrs

    options to be overridden by subclasses

    options to be overridden by subclasses

    Definition Classes
    LaTeXBuildTargetBuildTargetArguments
  12. 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
  13. 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
  14. def clean(a: Archive, in: FilePath = EmptyPath): Unit

    recursively delete output files in parallel (!)

    recursively delete output files in parallel (!)

    Definition Classes
    TraversingBuildTargetBuildTarget
  15. def cleanDir(a: Archive, curr: Current): Unit

    additional method that implementations may provide: cleans one directory

    additional method that implementations may provide: cleans one directory

    does nothing by default

    a

    the containing archive

    curr

    the outDim directory to be deleted

    Definition Classes
    PdfLatexLaTeXBuildTargetTraversingBuildTarget
  16. def cleanFile(arch: Archive, curr: Current): Unit

    additional method that implementations may provide: cleans one file

    additional method that implementations may provide: cleans one file

    deletes the output and error file by default, may be overridden to, e.g., delete auxiliary files

    curr

    the inDim whose output is to be deleted

    Definition Classes
    PdfLatexTraversingBuildTarget
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. def commonOpts: OptionDescrs
    Attributes
    protected
    Definition Classes
    LaTeXBuildTarget
  19. 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
  20. def createLocalPaths(a: Archive, dir: File): Unit
    Attributes
    protected
    Definition Classes
    LaTeXBuildTarget
  21. def createLocalPaths(bt: BuildTask): Unit
    Attributes
    protected
    Definition Classes
    LaTeXBuildTarget
  22. def createSms(a: Archive, inFile: File, outFile: File): Unit

    Collect sms content and write to outFile.

    Collect sms content and write to outFile.

    Definition Classes
    STeXAnalysis
  23. lazy val defaultPrefix: String
    Definition Classes
    Extension
  24. def delete(f: File): Unit

    auxiliary method for deleting a file

    auxiliary method for deleting a file

    Attributes
    protected
    Definition Classes
    BuildTarget
  25. def deleteWithLog(f: File): Unit
    Attributes
    protected
    Definition Classes
    LaTeXBuildTarget
  26. 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
  27. def destroyWhenRemainingTasksFinished: Unit

    convenience for calling waitUntilRemainingTasksFinished and then destroy

    convenience for calling waitUntilRemainingTasksFinished and then destroy

    Definition Classes
    Extension
  28. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  30. def estimateResult(bt: BuildTask): BuildSuccess

    estimate the BuildResult without building, e.g., to predict dependencies

    estimate the BuildResult without building, e.g., to predict dependencies

    Definition Classes
    PdfLatexLaTeXBuildTargetTraversingBuildTarget
  31. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  32. val folderName: String

    the name that is used for the special file representing the containing folder (without extension), empty by default

    the name that is used for the special file representing the containing folder (without extension), empty by default

    Attributes
    protected
    Definition Classes
    TraversingBuildTarget
  33. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. def getDeps(a: Archive, in: File, parents: Set[File], amble: Option[File] = None): List[Dependency]

    get dependencies

    get dependencies

    Definition Classes
    STeXAnalysis
  35. def getDirFiles(a: Archive, dir: File, includeFile: (String) ⇒ Boolean): List[String]
    Attributes
    protected
    Definition Classes
    LaTeXBuildTarget
  36. def getDirFilesByExt(a: Archive, dir: File, exts: List[String]): List[File]
    Attributes
    protected
    Definition Classes
    LaTeXBuildTarget
  37. def getErrorFile(a: Archive, inPath: FilePath): File
    Attributes
    protected
    Definition Classes
    TraversingBuildTarget
  38. def getFolderErrorFile(a: Archive, inPath: FilePath): File
    Definition Classes
    TraversingBuildTarget
  39. def getFolderOutFile(a: Archive, inPath: FilePath): File
    Attributes
    protected
    Definition Classes
    TraversingBuildTarget
  40. def getFromFirstArgOrEnvvar(args: List[String], name: String, default: String = ""): String
    Attributes
    protected
    Definition Classes
    Extension
  41. def getOutFile(a: Archive, inPath: FilePath): File
    Attributes
    protected
    Definition Classes
    TraversingBuildTarget
  42. def getOutPath(a: Archive, outFile: File): FilePath
    Attributes
    protected
    Definition Classes
    TraversingBuildTarget
  43. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. val inDim: ArchiveDimension

    the input dimension/archive folder

    the input dimension/archive folder

    Definition Classes
    LaTeXBuildTargetTraversingBuildTarget
  45. def includeDir(name: String): Boolean

    true by default; override to skip auxiliary directories

    true by default; override to skip auxiliary directories

    name

    the name of the directory (no path)

    Definition Classes
    TraversingBuildTarget
  46. def includeFile(n: String): Boolean

    there is no inExt, instead we test to check which files should be used; this is often a test for the file extension

    there is no inExt, instead we test to check which files should be used; this is often a test for the file extension

    This must be such that all auxiliary files are skipped. see defaultFileExtension if you need an inExt (for meta targets)

    Definition Classes
    PdfLatexLaTeXBuildTargetTraversingBuildTarget
  47. 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
  48. 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
    BuildTargetFormatBasedExtension
  49. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  50. val key: String

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

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

    Definition Classes
    PdfLatexBuildTarget
  51. val localpathsFile: String
    Definition Classes
    LaTeXBuildTarget
  52. def log(e: Error): Unit

    logs an error - always logged

    logs an error - always logged

    Attributes
    protected
    Definition Classes
    Logger
  53. 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
  54. def logError(s: ⇒ String): Unit

    log as an error message

    log as an error message

    Attributes
    protected
    Definition Classes
    Logger
  55. def logFailure(f: FilePath): Unit
    Attributes
    protected
    Definition Classes
    STeXAnalysis
  56. 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
  57. def logPrefix: String

    defaults to the key

    defaults to the key

    Definition Classes
    BuildTargetExtensionLogger
  58. def logResult(s: String): Unit

    auxiliary method for logging results

    auxiliary method for logging results

    Attributes
    protected
    Definition Classes
    TraversingBuildTarget
  59. def logSuccess(f: FilePath): Unit
    Attributes
    protected
    Definition Classes
    STeXAnalysis
  60. def logTemp(s: ⇒ String): Unit

    temporary logging - always logged

    temporary logging - always logged

    Attributes
    protected
    Definition Classes
    Logger
  61. def makeBuildTask(a: Archive, inPath: FilePath, children: List[BuildTask] = Nil): BuildTask

    makes a build task for a single file (ignoring built children) or directory

    makes a build task for a single file (ignoring built children) or directory

    Definition Classes
    TraversingBuildTarget
  62. 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
  63. def matchPathAndRepo(archive: Archive, inFile: File, line: String, parents: Set[File]): List[Dependency]
    Attributes
    protected
    Definition Classes
    STeXAnalysis
  64. def matchSmsEntry(a: Archive, line: String): List[STeXStructure]
    Definition Classes
    STeXAnalysis
  65. def mhRepos(a: Archive, r: String, b: String): List[Dependency]
    Definition Classes
    STeXAnalysis
  66. def mhReposClosure(archive: Archive, parents: Set[File], r: String, b: String): List[Dependency]
    Definition Classes
    STeXAnalysis
  67. def mkDep(a: Archive, ar: String, fp: FilePath): List[Dependency]
    Definition Classes
    STeXAnalysis
  68. def mkFileDep(archive: Archive, filePath: FilePath): Dependency
    Definition Classes
    STeXAnalysis
  69. def mkSTeXStructure(a: Archive, in: File, lines: Iterator[String], parents: Set[File]): STeXStructure

    Method for creating STeXStructures, used for generating sms content and finding dependencies.

    Method for creating STeXStructures, used for generating sms content and finding dependencies. inFile is used for relative \input paths

    Definition Classes
    STeXAnalysis
  70. var nameOfExecutable: String
    Attributes
    protected
    Definition Classes
    LaTeXBuildTarget
  71. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  72. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  73. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  74. val optionsMap: OptionMap

    the map computed from buildOpts

    the map computed from buildOpts

    Attributes
    protected
    Definition Classes
    BuildTargetArguments
  75. val outDim: ArchiveDimension

    the output archive folder

    the output archive folder

    Definition Classes
    PdfLatexTraversingBuildTarget
  76. val outExt: String

    the file extension used for generated files, defaults to outDim, override as needed

    the file extension used for generated files, defaults to outDim, override as needed

    Definition Classes
    PdfLatexTraversingBuildTarget
  77. def parallel: Boolean

    if true, multiple files/folders are built in parallel

    if true, multiple files/folders are built in parallel

    Definition Classes
    TraversingBuildTarget
  78. var pipeOutput: Boolean
    Definition Classes
    LaTeXBuildTarget
  79. val pipeOutputOption: String
    Definition Classes
    LaTeXBuildTarget
  80. def procLogger(output: StringBuffer, pipeOutput: Boolean): ProcessLogger
    Attributes
    protected
    Definition Classes
    LaTeXBuildTarget
  81. def producesFrom(outPath: FilePath): Option[FilePath]

    if this target produces additional files (e.g., the aux files of LaTeX), this method should map them to the respective main file

    if this target produces additional files (e.g., the aux files of LaTeX), this method should map them to the respective main file

    outPath

    the output path (relative to archive)

    returns

    the input path (relative to inDim)

    Definition Classes
    TraversingBuildTarget
  82. val quiet: Boolean
    Definition Classes
    BuildTargetArguments
  83. def readingSource(a: Archive, in: File, amble: Option[File] = None): List[Dependency]
    Attributes
    protected
    Definition Classes
    LaTeXBuildTarget
  84. def reallyBuildFile(bt: BuildTask): BuildResult

    to be implemented

    to be implemented

    Definition Classes
    PdfLatexLaTeXBuildTarget
  85. val remainingStartArguments: List[String]

    arguments to be consumed by subclasses

    arguments to be consumed by subclasses

    Attributes
    protected
    Definition Classes
    BuildTargetArguments
  86. val report: Report
    Attributes
    protected
    Definition Classes
    ExtensionLogger
  87. def runBuildTask(bt: BuildTask, level: Level): BuildResult

    wraps around buildFile and buildDir (which do the actual building) to add error handling, logging, etc.

    wraps around buildFile and buildDir (which do the actual building) to add error handling, logging, etc.

    Attributes
    protected
    Definition Classes
    TraversingBuildTarget
  88. def runBuildTaskIfNeeded(deps: Set[Dependency], bt: BuildTask, up: Update): BuildResult

    the entry point for build managers: runs a build task unless (depending on the modifier) nothing has changed

    the entry point for build managers: runs a build task unless (depending on the modifier) nothing has changed

    Definition Classes
    TraversingBuildTarget
  89. def runPdflatex(bt: BuildTask, output: StringBuffer): Int
    Attributes
    protected
  90. def skip(bt: BuildTask): Boolean
    Attributes
    protected
    Definition Classes
    LaTeXBuildTarget
  91. 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
    PdfLatexLaTeXBuildTargetExtension
  92. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  93. def timeout(pb: ProcessBuilder, log: ProcessLogger): Int

    run process with logger synchronously within the given timeout

    run process with logger synchronously within the given timeout

    returns

    exit code

    Attributes
    protected
    Definition Classes
    LaTeXBuildTarget
  94. val timeoutOption: String
    Attributes
    protected
    Definition Classes
    LaTeXBuildTarget
  95. var timeoutVal: Int
    Attributes
    protected
    Definition Classes
    LaTeXBuildTarget
  96. def toBeCleanedExts: List[String]
    Attributes
    protected
  97. def toKeyDep(d: Dependency, key: String): Dependency
    Attributes
    protected
    Definition Classes
    STeXAnalysis
  98. def toString(): String
    Definition Classes
    BuildTarget → AnyRef → Any
  99. def verbOpts: OptionDescrs
    Definition Classes
    BuildTargetArguments
  100. val verbose: Boolean
    Definition Classes
    BuildTargetArguments
  101. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  102. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  103. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  104. 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

Deprecated Value Members

  1. 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

    Definition Classes
    TraversingBuildTargetBuildTarget
    Annotations
    @MMT_TODO( message = "needs review" )
    Deprecated

    needs review

  2. def getDepsMap(args: Set[Dependency]): Map[Dependency, Set[Dependency]]
    Attributes
    protected
    Definition Classes
    TraversingBuildTarget
    Annotations
    @MMT_TODO( message = "needs review" )
    Deprecated

    needs review

  3. def getFilesRec(a: Archive, in: FilePath): Set[Dependency]
    Attributes
    protected
    Definition Classes
    TraversingBuildTarget
    Annotations
    @MMT_TODO( message = "needs review" )
    Deprecated

    needs review

  4. def getTestOutFile(a: Archive, inPath: FilePath): File
    Attributes
    protected
    Definition Classes
    TraversingBuildTarget
    Annotations
    @MMT_TODO( message = "needs review" )
    Deprecated

    needs review

Inherited from LaTeXBuildTarget

Inherited from BuildTargetArguments

Inherited from STeXAnalysis

Inherited from TraversingBuildTarget

Inherited from BuildTarget

Inherited from FormatBasedExtension

Inherited from Extension

Inherited from Logger

Inherited from AnyRef

Inherited from Any

Ungrouped