eu.simuline.m2latex.core

Enum LatexPreProcessor.SuffixHandler

java.lang.Object

java.lang.Enum<LatexPreProcessor.SuffixHandler>

eu.simuline.m2latex.core.LatexPreProcessor.SuffixHandler

All Implemented Interfaces:

Serializable, Comparable<LatexPreProcessor.SuffixHandler>

Enclosing class:

LatexPreProcessor

static enum LatexPreProcessor.SuffixHandler
extends Enum<LatexPreProcessor.SuffixHandler>

Handler for each suffix of a source file. Mostly, these represent graphic formats but also LatexPreProcessor.SUFFIX_TEX is required to detect the latex main files and LatexPreProcessor.SUFFIX_TEX and LatexPreProcessor.SUFFIX_BIB are needed for proper cleaning of the tex souce directory.

Enum Constant Summary

Enum Constants

Enum Constant and Description
bib Handler for .bib-files representing the BibTeX format for bibliographies.
fig Handler for .fig-files representing the native xfig format.
gp Handler for .gp-files representing the native gnuplot format.
jpg Handler for .jpg-files representing a format definde by the Joint Photographic Experts Group (jp(e)g).
mp Handler for .mp-files representing the metapost format.
png Handler for .png-files representing the Portable Network Graphics format.
svg Handler for .svg-files representing scaleable vector graphics.
tex Handler for .tex-files representing the TeX format, to be more precise the LaTeX format.

Method Summary

Modifier and Type	Method and Description
(package private) abstract void	clearTarget(File file, LatexPreProcessor proc) Deletes the files potentially created from the source file file using proc.
(package private) void	clearTarget(File file, LatexPreProcessor proc, Map<File,LatexPreProcessor.SuffixHandler> file2handler) Typically, .i.e. for fig-, gp-, mp- and svg-files just associates file with this handler in file2handler to schedule according targets for deletion except for tex-files for which the target is cleared immediately if it is a latex main file, otherwise ignoring by invoking LatexPreProcessor.clearTargetTexIfLatexMain(File).
(package private) abstract String	getSuffix() Returns the suffix of the file type of the file type, this is the handler for.
(package private) abstract void	procSrc(File file, LatexPreProcessor proc) Typically, .i.e. for fig-, gp-, mp- and associates file Does the transformation of the file file using proc immediately, except for svg-files for which an info message is logged, that transformation is done by need in the course of a LaTeX run.
(package private) void	scheduleProcSrc(File file, Map<File,LatexPreProcessor.SuffixHandler> file2handler, LatexPreProcessor proc, Collection<File> latexMainFiles)
static LatexPreProcessor.SuffixHandler	valueOf(String name) Returns the enum constant of this type with the specified name.
static LatexPreProcessor.SuffixHandler[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

fig

public static final LatexPreProcessor.SuffixHandler fig

Handler for .fig-files representing the native xfig format.

gp

public static final LatexPreProcessor.SuffixHandler gp

Handler for .gp-files representing the native gnuplot format.

mp

public static final LatexPreProcessor.SuffixHandler mp

Handler for .mp-files representing the metapost format.

svg

public static final LatexPreProcessor.SuffixHandler svg

Handler for .svg-files representing scaleable vector graphics.

jpg

public static final LatexPreProcessor.SuffixHandler jpg

Handler for .jpg-files representing a format definde by the Joint Photographic Experts Group (jp(e)g).

png

public static final LatexPreProcessor.SuffixHandler png

Handler for .png-files representing the Portable Network Graphics format.

tex

public static final LatexPreProcessor.SuffixHandler tex

Handler for .tex-files representing the TeX format, to be more precise the LaTeX format.

bib

public static final LatexPreProcessor.SuffixHandler bib

Handler for .bib-files representing the BibTeX format for bibliographies.

Method Detail

values

public static LatexPreProcessor.SuffixHandler[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LatexPreProcessor.SuffixHandler c : LatexPreProcessor.SuffixHandler.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LatexPreProcessor.SuffixHandler valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

scheduleProcSrc

void scheduleProcSrc(File file,
                     Map<File,LatexPreProcessor.SuffixHandler> file2handler,
                     LatexPreProcessor proc,
                     Collection<File> latexMainFiles)

procSrc

abstract void procSrc(File file,
                      LatexPreProcessor proc)
               throws BuildFailureException

Typically, .i.e. for fig-, gp-, mp- and associates file Does the transformation of the file file using proc immediately, except for

• svg-files for which an info message is logged, that transformation is done by need in the course of a LaTeX run. What occurs are files .pdf and .pdf_tex even if Settings.pdfViaDvi indicates creation of dvi files.
• tex-files which are only scheduled for later translation just by adding them to latexMainFiles if they are latex main files, and ignored otherwise (see LatexPreProcessor.addIfLatexMain(File, Collection)).
• bib-files for which just an info message that a bib file was found is logged.

Logging:

• WFU03: cannot close
• WPP02: tex file may be latex main file
• EEX01, EEX02, EEX03, WEX04, WEX05: if applications for preprocessing graphic files failed.
• EFU06: if moving a file fails.

Parameters:

file - a file with ending given by getSuffix().

proc - a latex pre-processor.

Throws:

BuildFailureException - TEX01 only for fig, gp and mp because these invoke external programs.

clearTarget

void clearTarget(File file,
                 LatexPreProcessor proc,
                 Map<File,LatexPreProcessor.SuffixHandler> file2handler)

Typically, .i.e. for fig-, gp-, mp- and svg-files just associates file with this handler in file2handler to schedule according targets for deletion except for

• tex-files for which the target is cleared immediately if it is a latex main file, otherwise ignoring by invoking LatexPreProcessor.clearTargetTexIfLatexMain(File).
• bib-files (maybe appropriate also for jpg-files and for png-files) for which there are no targets and so the association is not added to file2handler.

Logging:

• WPP02: tex file may be latex main file
• WFU01: Cannot read directory...
• WFU03: cannot close tex file
• EFU05: Failed to delete file

Parameters:

file - a file with ending given by getSuffix(), i.e. a file which can be handled by this handler.

proc - a latex pre-processor.

file2handler - maps file to its handler. In general, this method adds file to file2handler together with its handler which is just this.

See Also:

clearTarget(File, LatexPreProcessor)

clearTarget

abstract void clearTarget(File file,
                          LatexPreProcessor proc)

Deletes the files potentially created from the source file file using proc.

Logging:

• WFU01: Cannot read directory...
• EFU05: Failed to delete file

Parameters:

file - a file with ending given by getSuffix().

proc - a latex pre-processor.

Throws:

IllegalStateException -

• if file has no targets to be deleted as for jpg-files, png-files and bib-files.
• if targets of file should have been cleared already by clearTarget(File, LatexPreProcessor, Map) as for tex-files.

See Also:

clearTarget(File, LatexPreProcessor, Map)

getSuffix

abstract String getSuffix()

Returns the suffix of the file type of the file type, this is the handler for.