Nested and Inner Type Summary

Modifier and Type	Class and Description
public static record	BibTeXSyntaxHighlighter.BibTeXHighlightRegion
public static enum	BibTeXSyntaxHighlighter.BibTeXTokenCategory

Constructor Summary

Access	Constructor and Description
public	BibTeXSyntaxHighlighter()
public	BibTeXSyntaxHighlighter(boolean showLineNumbers)
public	BibTeXSyntaxHighlighter(SyntaxTheme theme)
public	BibTeXSyntaxHighlighter(SyntaxTheme theme, boolean showLineNumbers)

Method Summary

Modifier and Type	Method and Description
private void	appendBraceString(String text, StyleBuilder sb)
private void	appendCiteKey(String text, StyleBuilder sb)
private void	applyStyles(Token token, StyleBuilder sb, List<Token> tokens, int index)
private void	applyWithLines(StyleBuilder sb, BufferedTokenStream tokenStream)
private void	applyWithoutLines(StyleBuilder sb, BufferedTokenStream tokenStream)
private BibTeXSyntaxHighlighter.BibTeXTokenCategory	classify(Token token, List<Token> tokens, int index)
public List<BibTeXSyntaxHighlighter.BibTeXHighlightRegion>	Returns: a list of non-overlapping highlight regions covering the source, ordered by their start offset computeHighlightRegions(String the BibTeX source to analyze s) Computes highlight regions (start/end offsets + category) without producing ANSI-styled output.
public String	highlight(String s) Implements io.github.kusoroadeolu.veneer.SyntaxHighlighter.highlight. Highlights the given Java source string.
pack-priv boolean	isBraceString(Token token)
pack-priv boolean	isCiteKey(Token token, List<Token> tokens, int index)
pack-priv boolean	isComment(Token token)
pack-priv boolean	isFieldName(Token token, List<Token> tokens, int index)
pack-priv boolean	isKeyword(Token token)
pack-priv boolean	isMultiLineToken(Token token)
pack-priv boolean	isName(Token token)
pack-priv boolean	isNumber(Token token)
pack-priv boolean	isString(Token token)
private Token	nextDefaultToken(List<Token> tokens, int index)
private Token	previousDefaultToken(List<Token> tokens, int index)

Constructor Detail

BibTeXSyntaxHighlighter	back to summary
public BibTeXSyntaxHighlighter()

BibTeXSyntaxHighlighter	back to summary
public BibTeXSyntaxHighlighter(boolean showLineNumbers)

BibTeXSyntaxHighlighter	back to summary
public BibTeXSyntaxHighlighter(SyntaxTheme theme)

BibTeXSyntaxHighlighter	back to summary
public BibTeXSyntaxHighlighter(SyntaxTheme theme, boolean showLineNumbers)

Method Detail

appendBraceString	back to summary
private void appendBraceString(String text, StyleBuilder sb)

appendCiteKey	back to summary
private void appendCiteKey(String text, StyleBuilder sb)

applyStyles	back to summary
private void applyStyles(Token token, StyleBuilder sb, List<Token> tokens, int index)

applyWithLines	back to summary
private void applyWithLines(StyleBuilder sb, BufferedTokenStream tokenStream)

applyWithoutLines	back to summary
private void applyWithoutLines(StyleBuilder sb, BufferedTokenStream tokenStream)

classify	back to summary
private BibTeXSyntaxHighlighter.BibTeXTokenCategory classify(Token token, List<Token> tokens, int index)

computeHighlightRegions	back to summary
public List<BibTeXSyntaxHighlighter.BibTeXHighlightRegion> computeHighlightRegions(String s) Computes highlight regions (start/end offsets + category) without producing ANSI-styled output. Useful for consumers (e.g. GUI text editors) that need to apply their own styling mechanism (CSS classes, text attributes, etc.) instead of ANSI escape codes. Parameters s:String the BibTeX source to analyze Returns:List<BibTeXSyntaxHighlighter.BibTeXHighlightRegion> a list of non-overlapping highlight regions covering the source, ordered by their start offset

computeHighlightRegions

back to summary

public List<BibTeXSyntaxHighlighter.BibTeXHighlightRegion> computeHighlightRegions(String s)

Computes highlight regions (start/end offsets + category) without producing ANSI-styled output. Useful for consumers (e.g. GUI text editors) that need to apply their own styling mechanism (CSS classes, text attributes, etc.) instead of ANSI escape codes.

Parameters

s:String: the BibTeX source to analyze

Returns:List<BibTeXSyntaxHighlighter.BibTeXHighlightRegion>

a list of non-overlapping highlight regions covering the source, ordered by their start offset

highlight	back to summary
public String highlight(String s) Implements io.github.kusoroadeolu.veneer.SyntaxHighlighter.highlight. Doc from io.github.kusoroadeolu.veneer.SyntaxHighlighter.highlight. Highlights the given Java source string. Annotations @Override

highlight

back to summary

public String highlight(String s)

Implements io.github.kusoroadeolu.veneer.SyntaxHighlighter.highlight.

Doc from io.github.kusoroadeolu.veneer.SyntaxHighlighter.highlight.

Highlights the given Java source string.

Annotations

@Override

isBraceString	back to summary
pack-priv boolean isBraceString(Token token)

isCiteKey	back to summary
pack-priv boolean isCiteKey(Token token, List<Token> tokens, int index)

isComment	back to summary
pack-priv boolean isComment(Token token)

isFieldName	back to summary
pack-priv boolean isFieldName(Token token, List<Token> tokens, int index)

isKeyword	back to summary
pack-priv boolean isKeyword(Token token)

isMultiLineToken	back to summary
pack-priv boolean isMultiLineToken(Token token)

isName	back to summary
pack-priv boolean isName(Token token)

isNumber	back to summary
pack-priv boolean isNumber(Token token)

isString	back to summary
pack-priv boolean isString(Token token)

nextDefaultToken	back to summary
private Token nextDefaultToken(List<Token> tokens, int index)

previousDefaultToken	back to summary
private Token previousDefaultToken(List<Token> tokens, int index)

io.github.kusoroadeolu.veneer back to summary

public final Record BibTeXSyntaxHighlighter.BibTeXHighlightRegion

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
io.github.kusoroadeolu.veneer.BibTeXSyntaxHighlighter.BibTeXHighlightRegion

Record Components

start:int
end:int
category:BibTeXSyntaxHighlighter.BibTeXTokenCategory

Field Summary

Modifier and Type	Field and Description
private final BibTeXSyntaxHighlighter.BibTeXTokenCategory	category Record Component accessed by category().
private final int	end Record Component accessed by end().
private final int	start Record Component accessed by start().

Constructor Summary

Access	Constructor and Description
public	BibTeXHighlightRegion(int start, int end, BibTeXSyntaxHighlighter.BibTeXTokenCategory category)

Method Summary

Modifier and Type	Method and Description
public BibTeXSyntaxHighlighter.BibTeXTokenCategory	category() Record Component getter of category.
public int	end() Record Component getter of end.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public int	start() Record Component getter of start.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

category	back to summary
private final BibTeXSyntaxHighlighter.BibTeXTokenCategory category Record Component accessed by category().

end	back to summary
private final int end Record Component accessed by end().

start	back to summary
private final int start Record Component accessed by start().

Constructor Detail

BibTeXHighlightRegion	back to summary
public BibTeXHighlightRegion(int start, int end, BibTeXSyntaxHighlighter.BibTeXTokenCategory category)

Method Detail

category	back to summary
public BibTeXSyntaxHighlighter.BibTeXTokenCategory category() Record Component getter of category.

end	back to summary
public int end() Record Component getter of end.

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

start	back to summary
public int start() Record Component getter of start.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

io.github.kusoroadeolu.veneer back to summary

public final Enum BibTeXSyntaxHighlighter.BibTeXTokenCategory

Class Inheritance

extends Enum<BibTeXSyntaxHighlighter.BibTeXTokenCategory>

java.lang.Object
java.lang.Enum
io.github.kusoroadeolu.veneer.BibTeXSyntaxHighlighter.BibTeXTokenCategory

Field Summary

Modifier and Type	Field and Description
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory	CITE_KEY
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory	COMMENT
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory	DEFAULT
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory	FIELD_NAME
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory	KEYWORD
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory	MACRO
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory	NUMBER
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory	STRING

Constructor Summary

Access	Constructor and Description
private	BibTeXTokenCategory()

Method Summary

Modifier and Type	Method and Description
public static BibTeXSyntaxHighlighter.BibTeXTokenCategory	valueOf(String name)
public static BibTeXSyntaxHighlighter.BibTeXTokenCategory[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CITE_KEY	back to summary
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory CITE_KEY

COMMENT	back to summary
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory COMMENT

DEFAULT	back to summary
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory DEFAULT

FIELD_NAME	back to summary
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory FIELD_NAME

KEYWORD	back to summary
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory KEYWORD

MACRO	back to summary
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory MACRO

NUMBER	back to summary
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory NUMBER

STRING	back to summary
public static final BibTeXSyntaxHighlighter.BibTeXTokenCategory STRING

Constructor Detail

BibTeXTokenCategory	back to summary
private BibTeXTokenCategory()

Method Detail

valueOf	back to summary
public static BibTeXSyntaxHighlighter.BibTeXTokenCategory valueOf(String name)

values	back to summary
public static BibTeXSyntaxHighlighter.BibTeXTokenCategory[] values()

public Class BibTeXSyntaxHighlighter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Record BibTeXSyntaxHighlighter.BibTeXHighlightRegion

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum BibTeXSyntaxHighlighter.BibTeXTokenCategory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail