latex-conv 0.1.0 · org.jabref.latexconv.internal.TokenWalker

Walks a parsed SnuggleTeX token tree and renders it through the output hooks implemented by UnicodeEmitter and HtmlEmitter, driven by ConversionTable.

Recoverable parse errors are handled inline: unknown commands (TTEC00) are reproduced from the source per ConversionOptions.UnknownCommandPolicy, and stray _/^ in text mode (TTEM03) render as _(...)/^(...). Any other parse error aborts via UnsupportedLatexException, which the public API translates into returning the normalized input.

Field Summary

Modifier and Type	Field and Description
private static final Map<String, String>	MATH_ACCENT_ALIASES Math-mode accent commands expressed as the table's short accent spellings.
protected final ConversionOptions	options
private static final Map<String, Map<Integer, Integer>>	STYLE_MAP_CACHE

Constructor Summary

Access	Constructor and Description
protected	TokenWalker(ConversionOptions options)

Method Summary

Modifier and Type	Method and Description
private static Optional<String>	accentCombining(String commandName)
protected abstract void	appendEmphasized(StringBuilder out, String renderedContent) `\mkbibemph{..}` content, already rendered.
protected abstract void	appendMathPassthrough(StringBuilder out, String source) A math span emitted verbatim under `ConversionOptions.MathMode#PASSTHROUGH`, delimiters included.
protected abstract void	appendPlain(StringBuilder out, String text) Literal output text (converted characters, preserved commands, math characters).
protected abstract void	appendQuoted(StringBuilder out, String renderedContent) `\enquote{..}`/`\mkbibquote{..}` content, already rendered.
protected abstract void	appendScript(StringBuilder out, String renderedContent, boolean superscript) A super-/subscript whose content was already rendered by a nested walk.
protected abstract void	appendText(StringBuilder out, String text, @Nullable ComputedStyle style) A text run from the source, with the style SnuggleTeX computed for it (`\textit{..}` and friends survive only here).
private static String	applyCombining(String base, String combining) Inserts the combining mark after the base's first codepoint: the accent belongs to the first letter even when the tokenizer hands over a longer run (`\'nski` -> `ński`).
public String	emit(SnuggleSession session)
private int	emitCommand(List<FlowToken> tokens, int index, StringBuilder out)
private void	emitEnvironment(EnvironmentToken environment, StringBuilder out)
private int	emitError(List<FlowToken> tokens, int index, StringBuilder out)
private int	emitGenericCommand(List<FlowToken> tokens, int index, CommandToken command, String name, StringBuilder out)
private int	emitToken(List<FlowToken> tokens, int index, StringBuilder out) Emits the token at `index` (possibly consuming look-ahead siblings, e.g. an accent's operand) and returns the index of the next unconsumed token.
private static String	fenceText(CharSequence source) Normalizes a fence's source text (`(`, `[`, but also `\left(` or `\{`) to the bare bracket character.
private static int	findBalancedClose(WorkingDocument document, int openIndex)
private static boolean	hasArgument(CommandToken command, int argumentIndex)
private static boolean	hasWhitespaceGap(FlowToken previous, FlowToken current)
protected static String	mapThroughStyle(String text, String styleCommandName)
protected abstract boolean	scriptsAsSource() Whether scripts should be emitted as their verbatim source instead of converted (the `convertScripts=false` round-trip mode; meaningless for HTML output).
private static int	skipTokensBefore(List<FlowToken> tokens, int index, int documentEnd)
protected static Map<Integer, Integer>	styleMap(String styleCommandName)
protected String	walk(List<FlowToken> tokens)
private String	walkArgument(CommandToken command, int argumentIndex)

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

Field Detail

MATH_ACCENT_ALIASES	back to summary
private static final Map<String, String> MATH_ACCENT_ALIASES Math-mode accent commands expressed as the table's short accent spellings.

options	back to summary
protected final ConversionOptions options

STYLE_MAP_CACHE	back to summary
private static final Map<String, Map<Integer, Integer>> STYLE_MAP_CACHE

Constructor Detail

TokenWalker	back to summary
protected TokenWalker(ConversionOptions options)

Method Detail

accentCombining	back to summary
private static Optional<String> accentCombining(String commandName)

appendEmphasized	back to summary
protected abstract void appendEmphasized(StringBuilder out, String renderedContent) `\mkbibemph{..}` content, already rendered.

appendMathPassthrough	back to summary
protected abstract void appendMathPassthrough(StringBuilder out, String source) A math span emitted verbatim under `ConversionOptions.MathMode#PASSTHROUGH`, delimiters included.

appendPlain	back to summary
protected abstract void appendPlain(StringBuilder out, String text) Literal output text (converted characters, preserved commands, math characters).

appendQuoted	back to summary
protected abstract void appendQuoted(StringBuilder out, String renderedContent) `\enquote{..}`/`\mkbibquote{..}` content, already rendered.

appendScript	back to summary
protected abstract void appendScript(StringBuilder out, String renderedContent, boolean superscript) A super-/subscript whose content was already rendered by a nested walk.

appendText	back to summary
protected abstract void appendText(StringBuilder out, String text, @Nullable ComputedStyle style) A text run from the source, with the style SnuggleTeX computed for it (`\textit{..}` and friends survive only here). `text` already has `~` resolved to no-break space.

applyCombining	back to summary
private static String applyCombining(String base, String combining) Inserts the combining mark after the base's first codepoint: the accent belongs to the first letter even when the tokenizer hands over a longer run (`\'nski` -> `ński`).

emit	back to summary
public String emit(SnuggleSession session)

emitCommand	back to summary
private int emitCommand(List<FlowToken> tokens, int index, StringBuilder out)

emitEnvironment	back to summary
private void emitEnvironment(EnvironmentToken environment, StringBuilder out)

emitError	back to summary
private int emitError(List<FlowToken> tokens, int index, StringBuilder out)

emitGenericCommand	back to summary
private int emitGenericCommand(List<FlowToken> tokens, int index, CommandToken command, String name, StringBuilder out)

emitToken	back to summary
private int emitToken(List<FlowToken> tokens, int index, StringBuilder out) Emits the token at `index` (possibly consuming look-ahead siblings, e.g. an accent's operand) and returns the index of the next unconsumed token.

fenceText	back to summary
private static String fenceText(CharSequence source) Normalizes a fence's source text (`(`, `[`, but also `\left(` or `\{`) to the bare bracket character.

findBalancedClose	back to summary
private static int findBalancedClose(WorkingDocument document, int openIndex)

hasArgument	back to summary
private static boolean hasArgument(CommandToken command, int argumentIndex)

hasWhitespaceGap	back to summary
private static boolean hasWhitespaceGap(FlowToken previous, FlowToken current)

mapThroughStyle	back to summary
protected static String mapThroughStyle(String text, String styleCommandName)

scriptsAsSource	back to summary
protected abstract boolean scriptsAsSource() Whether scripts should be emitted as their verbatim source instead of converted (the `convertScripts=false` round-trip mode; meaningless for HTML output).

skipTokensBefore	back to summary
private static int skipTokensBefore(List<FlowToken> tokens, int index, int documentEnd)

styleMap	back to summary
protected static Map<Integer, Integer> styleMap(String styleCommandName)

walk	back to summary
protected String walk(List<FlowToken> tokens)