Top Description Fields Constructors Methods

org.jabref.logic.openoffice.bst

public Class PandocLatexConverter

Class Inheritance

extends Object

java.lang.Object
org.jabref.logic.openoffice.bst.PandocLatexConverter

Annotations

@NullMarked

Imports

java.io.IOException, .OutputStream, java.nio.charset.StandardCharsets, java.util.List, .Optional, java.util.concurrent.TimeUnit, java.util.stream.Stream, org.jabref.logic.os.OS, org.jabref.logic.util.HeadlessExecutorService, .StreamGobbler, com.google.common.annotations.VisibleForTesting, org.jspecify.annotations.NullMarked, org.slf4j.Logger, .LoggerFactory

Converts LaTeX fragments to HTML by shelling out to pandoc.

The path to pandoc is read from OpenOfficePreferences and can be changed by the user in Preferences > OpenOffice/LibreOffice. Use autoDetect to find pandoc automatically.

Field Summary

Modifier and Type	Field and Description
private static final List<String>	LINUX_CANDIDATES
private static final Logger	LOGGER
private static final List<String>	MACOS_CANDIDATES
private static final String	PANDOC_EXECUTABLE
private final String	pandocPath
private static final List<String>	WINDOWS_CANDIDATES Candidate commands tried by `autoDetect` on Windows, in priority order.
private static final List<String>	WINDOWS_INSTALL_DIRECTORY_HINTS Additional Windows install-directory hints resolved at runtime to absolute paths such as `C:\\Program Files\\Pandoc\\pandoc.exe`.

Constructor Summary

Access	Constructor and Description
public	PandocLatexConverter(String pandocPath)

Method Summary

Modifier and Type	Method and Description
public static Optional<String>	autoDetect() Returns the first pandoc executable found in the OS-specific candidate list, or `Optional.empty` if none responds to `--version` within 5 seconds.
pack-priv static List<String>	getAutoDetectCandidates(boolean windows, boolean osX)
public boolean	isAvailable()
public String	latexToHtml(String latex) Converts a LaTeX fragment to HTML via pandoc stdin/stdout (no temp files).
private static boolean	probeCandidate(String candidate)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

LINUX_CANDIDATES	back to summary
private static final List<String> LINUX_CANDIDATES

LOGGER	back to summary
private static final Logger LOGGER

MACOS_CANDIDATES	back to summary
private static final List<String> MACOS_CANDIDATES

PANDOC_EXECUTABLE	back to summary
private static final String PANDOC_EXECUTABLE

pandocPath	back to summary
private final String pandocPath

WINDOWS_CANDIDATES	back to summary
private static final List<String> WINDOWS_CANDIDATES Candidate commands tried by `autoDetect` on Windows, in priority order.

WINDOWS_INSTALL_DIRECTORY_HINTS	back to summary
private static final List<String> WINDOWS_INSTALL_DIRECTORY_HINTS Additional Windows install-directory hints resolved at runtime to absolute paths such as `C:\\Program Files\\Pandoc\\pandoc.exe`.

Constructor Detail

PandocLatexConverter	back to summary
public PandocLatexConverter(String pandocPath)

Method Detail

autoDetect	back to summary
public static Optional<String> autoDetect() Returns the first pandoc executable found in the OS-specific candidate list, or `Optional.empty` if none responds to `--version` within 5 seconds.

getAutoDetectCandidates	back to summary
pack-priv static List<String> getAutoDetectCandidates(boolean windows, boolean osX) Annotations @VisibleForTesting

isAvailable	back to summary
public boolean isAvailable()

latexToHtml	back to summary
public String latexToHtml(String latex) throws IOException, InterruptedException Converts a LaTeX fragment to HTML via pandoc stdin/stdout (no temp files). Both stdout and stderr are drained to prevent pipe-buffer deadlock. Throws `IOException` if pandoc exits non-zero, surfacing the real error message.

probeCandidate	back to summary
private static boolean probeCandidate(String candidate)