JabRef 6.0-beta.1 · org.jabref.logic.preview.BstPreviewLayout

Field Summary

Modifier and Type	Field and Description
private static final Pattern	BIBITEM_PATTERN
private static final Pattern	BRACED_MATH_COMMAND_PATTERN Matches a single LaTeX math command wrapped in the `{{$...$}}` form written by some exporters, e.g. `{{$\Sigma$}}`.
private @Nullable BstVM	bstVM
private static final Pattern	COMMENT_PATTERN
private static final Pattern	EMPH_PATTERN
private @Nullable String	error
private static final Pattern	GROUP_BF_PATTERN
private static final Pattern	GROUP_EM_PATTERN
private static final Pattern	GROUP_IT_PATTERN
private static final Pattern	LATEX_COMMAND_PATTERN
private static final Logger	LOGGER
private static final Pattern	MULTIPLE_SPACES_PATTERN
private final String	name
private final Path	path
private String	source
private static final Pattern	TEXTBF_PATTERN
private static final Pattern	TEXTIT_PATTERN

Constructor Summary

Access	Constructor and Description
private	BstPreviewLayout(Path path, String source, @Nullable BstVM bstVM, @Nullable String error) Private constructor used by `of(BstStyle)` for pre-built internal styles.
public	BstPreviewLayout(Path path)

Method Summary

Modifier and Type	Method and Description
private static void	convertBracedMathToUnicode(BibEntry entry) Replaces `{{$\Cmd$}}` math expressions in all fields of the given entry by the corresponding Unicode character, wrapped in braces.
private static String	convertInlineSmallCapsToHtml(String latex)
private static int	findBalancedGroupEnd(String input, int contentStart)
public String	generatePreview(BibEntry originalEntry, BibDatabaseContext databaseContext) Implements org.jabref.logic.preview.PreviewLayout.generatePreview.
public String	getDisplayName() Implements org.jabref.logic.preview.PreviewLayout.getDisplayName.
public Path	getFilePath()
public String	getName() Implements org.jabref.logic.preview.PreviewLayout.getName.
public String	getShortTitle() Implements org.jabref.logic.preview.PreviewLayout.getShortTitle.
public String	getText() Implements org.jabref.logic.preview.PreviewLayout.getText.
public static boolean	isBstStyleFile(String styleFile) Checks if the given style file is a BST file by checking the extension
private static boolean	isEscaped(String input, int index)
public static BstPreviewLayout	of(BstStyle style) Creates a `BstPreviewLayout` for the given `BstStyle`, supporting both internal (classpath) and external (filesystem) styles.
private static String	replaceCommandWithBalancedArgument(String input, String command)
private static String	replaceLegacySwitchWithBalancedArgument(String input, String command)
private static int	skipWhitespace(String input, int startIndex)

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

Field Detail

BIBITEM_PATTERN	back to summary
private static final Pattern BIBITEM_PATTERN

BRACED_MATH_COMMAND_PATTERN	back to summary
private static final Pattern BRACED_MATH_COMMAND_PATTERN Matches a single LaTeX math command wrapped in the `{{$...$}}` form written by some exporters, e.g. `{{$\Sigma$}}`. Group 1 is the command without its leading backslash (`Sigma`). Reads as: `{{` `$` `\` (command) `$` `}}`.

bstVM	back to summary
private @Nullable BstVM bstVM

COMMENT_PATTERN	back to summary
private static final Pattern COMMENT_PATTERN

EMPH_PATTERN	back to summary
private static final Pattern EMPH_PATTERN

error	back to summary
private @Nullable String error

GROUP_BF_PATTERN	back to summary
private static final Pattern GROUP_BF_PATTERN

GROUP_EM_PATTERN	back to summary
private static final Pattern GROUP_EM_PATTERN

GROUP_IT_PATTERN	back to summary
private static final Pattern GROUP_IT_PATTERN

LATEX_COMMAND_PATTERN	back to summary
private static final Pattern LATEX_COMMAND_PATTERN

LOGGER	back to summary
private static final Logger LOGGER

MULTIPLE_SPACES_PATTERN	back to summary
private static final Pattern MULTIPLE_SPACES_PATTERN

name	back to summary
private final String name

path	back to summary
private final Path path

source	back to summary
private String source

TEXTBF_PATTERN	back to summary
private static final Pattern TEXTBF_PATTERN

TEXTIT_PATTERN	back to summary
private static final Pattern TEXTIT_PATTERN

Constructor Detail

BstPreviewLayout	back to summary
private BstPreviewLayout(Path path, String source, @Nullable BstVM bstVM, @Nullable String error) Private constructor used by `of(BstStyle)` for pre-built internal styles.

BstPreviewLayout	back to summary
public BstPreviewLayout(Path path)

Method Detail

convertBracedMathToUnicode back to summary

convertBracedMathToUnicode	back to summary
private static void convertBracedMathToUnicode(BibEntry entry) Replaces `{{$\Cmd$}}` math expressions in all fields of the given entry by the corresponding Unicode character, wrapped in braces. The entry is modified in place, so it has to be a copy. The BST engine passes $...$ through unchanged, so without this step the raw math reaches the preview and is then stripped by `RemoveLatexCommandsFormatter`. The braces around the result are required: they keep `BstCaseChanger` from lowercasing the symbol (Σ would become σ). This is also the reason `BibEntry#getFieldLatexFree` cannot be used here -- it resolves the LaTeX, but does not add the protecting braces. Commands that cannot be resolved are kept as they are: `LatexToUnicodeAdapter#format` returns its (NFC-normalized) input if parsing fails, so replacing unconditionally would corrupt them.

private static void convertBracedMathToUnicode(BibEntry entry)

Replaces {{$\Cmd$}} math expressions in all fields of the given entry by the corresponding Unicode character, wrapped in braces. The entry is modified in place, so it has to be a copy.

The BST engine passes $...$ through unchanged, so without this step the raw math reaches the preview and is then stripped by RemoveLatexCommandsFormatter.

The braces around the result are required: they keep BstCaseChanger from lowercasing the symbol (Σ would become σ). This is also the reason BibEntry#getFieldLatexFree cannot be used here -- it resolves the LaTeX, but does not add the protecting braces.

Commands that cannot be resolved are kept as they are: LatexToUnicodeAdapter#format returns its (NFC-normalized) input if parsing fails, so replacing unconditionally would corrupt them.

convertInlineSmallCapsToHtml	back to summary
private static String convertInlineSmallCapsToHtml(String latex)

findBalancedGroupEnd	back to summary
private static int findBalancedGroupEnd(String input, int contentStart)

generatePreview	back to summary
public String generatePreview(BibEntry originalEntry, BibDatabaseContext databaseContext) Implements org.jabref.logic.preview.PreviewLayout.generatePreview. Annotations @Override

generatePreview

back to summary

public String generatePreview(BibEntry originalEntry, BibDatabaseContext databaseContext)

Implements org.jabref.logic.preview.PreviewLayout.generatePreview.

Annotations

@Override

getDisplayName	back to summary
public String getDisplayName() Implements org.jabref.logic.preview.PreviewLayout.getDisplayName. Annotations @Override

getDisplayName

back to summary

public String getDisplayName()

Implements org.jabref.logic.preview.PreviewLayout.getDisplayName.

Annotations

@Override

getFilePath	back to summary
public Path getFilePath()

getName	back to summary
public String getName() Implements org.jabref.logic.preview.PreviewLayout.getName. Annotations @Override

getName

back to summary

public String getName()

Implements org.jabref.logic.preview.PreviewLayout.getName.

Annotations

@Override

getShortTitle	back to summary
public String getShortTitle() Implements org.jabref.logic.preview.PreviewLayout.getShortTitle. Annotations @Override

getShortTitle

back to summary

public String getShortTitle()

Implements org.jabref.logic.preview.PreviewLayout.getShortTitle.

Annotations

@Override

getText	back to summary
public String getText() Implements org.jabref.logic.preview.PreviewLayout.getText. Annotations @Override

getText

back to summary

public String getText()

Implements org.jabref.logic.preview.PreviewLayout.getText.

Annotations

@Override

isBstStyleFile	back to summary
public static boolean isBstStyleFile(String styleFile) Checks if the given style file is a BST file by checking the extension

isEscaped	back to summary
private static boolean isEscaped(String input, int index)

of	back to summary
public static BstPreviewLayout of(BstStyle style) Creates a `BstPreviewLayout` for the given `BstStyle`, supporting both internal (classpath) and external (filesystem) styles.

replaceCommandWithBalancedArgument	back to summary
private static String replaceCommandWithBalancedArgument(String input, String command)

replaceLegacySwitchWithBalancedArgument	back to summary
private static String replaceLegacySwitchWithBalancedArgument(String input, String command)

skipWhitespace	back to summary
private static int skipWhitespace(String input, int startIndex)

public final Class BstPreviewLayout

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail