Package org.jline.builtins

Class SyntaxHighlighter

java.lang.Object

org.jline.builtins.SyntaxHighlighter

public class SyntaxHighlighter
extends Object

Java implementation of a syntax highlighter based on nanorc format.

This class provides syntax highlighting capabilities for JLine applications, using configuration files in a format similar to GNU nano's nanorc files. It supports:

• Regular expression based highlighting rules
• Theme-based styling
• File type detection
• Inclusion of other configuration files

The highlighter can be used to add syntax coloring to various text displays in terminal applications, such as file viewers, editors, and REPLs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SyntaxHighlighter.BlockCommentDelimiters
(package private) static class	SyntaxHighlighter.HighlightRule
(package private) static class	SyntaxHighlighter.NanorcParser
private static class	SyntaxHighlighter.ParsedToken
(package private) static class	SyntaxHighlighter.Parser
private static class	SyntaxHighlighter.PathParts	Represents the static and glob parts of a path pattern.
protected static class	SyntaxHighlighter.RuleSplitter

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	COMMAND_INCLUDE
protected static final String	COMMAND_THEME
private Path	currentTheme
protected static final String	DEFAULT_LESSRC_FILE
static final String	DEFAULT_NANORC_FILE
private final Path	nanorc
private final String	nanorcUrl
private SyntaxHighlighter.Parser	parser
static final String	REGEX_TOKEN_NAME
private final Map<String,List<SyntaxHighlighter.HighlightRule>>	rules
private int	ruleStartId
private boolean	startEndHighlight
private final String	syntaxName
private static final String	TOKEN_NANORC
static final String	TYPE_NANORCTHEME

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SyntaxHighlighter()
private	SyntaxHighlighter(String nanorcUrl)
private	SyntaxHighlighter(Path nanorc, String syntaxName)
private	SyntaxHighlighter(Path nanorc, String syntaxName, String nanorcUrl)

Method Summary

Modifier and Type	Method	Description
private AttributedStringBuilder	_highlight(AttributedString line, List<SyntaxHighlighter.HighlightRule> rules)
private AttributedStringBuilder	_highlight(AttributedString line, List<SyntaxHighlighter.HighlightRule> rules, CharSequence startWith, CharSequence continueAs)
protected static void	addFiles(Path nanorc, String parameter, Consumer<Stream<Path>> consumer)
private void	addRules(Map<String,List<SyntaxHighlighter.HighlightRule>> rules)
static SyntaxHighlighter	build(String nanorcUrl)	Build SyntaxHighlighter
static SyntaxHighlighter	build(Path nanorc, String syntaxName)	Build SyntaxHighlighter
protected static SyntaxHighlighter	build(List<Path> syntaxFiles, String file, String syntaxName)
protected static SyntaxHighlighter	build(List<Path> syntaxFiles, String file, String syntaxName, boolean ignoreErrors)
private static SyntaxHighlighter.PathParts	extractPathParts(String pattern)	Extracts the static (non-wildcard) path prefix and the glob pattern from a path.
Path	getCurrentTheme()
AttributedString	highlight(String string)
AttributedString	highlight(AttributedString attributedString)
AttributedString	highlight(AttributedStringBuilder asb)
protected static void	nanorcInclude(Path nanorc, String parameter, List<Path> syntaxFiles)
protected static void	nanorcTheme(Path nanorc, String parameter, List<Path> syntaxFiles)
void	refresh()
SyntaxHighlighter	reset()
void	setCurrentTheme(Path currentTheme)
void	setParser(SyntaxHighlighter.Parser parser)
private AttributedString	splitAndHighlight(AttributedString attributedString)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

REGEX_TOKEN_NAME

public static final String REGEX_TOKEN_NAME

See Also:

• Constant Field Values

TYPE_NANORCTHEME

public static final String TYPE_NANORCTHEME

See Also:

• Constant Field Values

DEFAULT_NANORC_FILE

public static final String DEFAULT_NANORC_FILE

See Also:

• Constant Field Values

DEFAULT_LESSRC_FILE

protected static final String DEFAULT_LESSRC_FILE

See Also:

• Constant Field Values

COMMAND_INCLUDE

protected static final String COMMAND_INCLUDE

See Also:

• Constant Field Values

COMMAND_THEME

protected static final String COMMAND_THEME

See Also:

• Constant Field Values

TOKEN_NANORC

private static final String TOKEN_NANORC

See Also:

• Constant Field Values

nanorc

private final Path nanorc

syntaxName

private final String syntaxName

nanorcUrl

private final String nanorcUrl

rules

private final Map<String,List<SyntaxHighlighter.HighlightRule>> rules

currentTheme

private Path currentTheme

startEndHighlight

private boolean startEndHighlight

ruleStartId

private int ruleStartId

parser

private SyntaxHighlighter.Parser parser

Constructor Details

SyntaxHighlighter

private SyntaxHighlighter()

SyntaxHighlighter

private SyntaxHighlighter(String nanorcUrl)

SyntaxHighlighter

private SyntaxHighlighter(Path nanorc,
 String syntaxName)

SyntaxHighlighter

private SyntaxHighlighter(Path nanorc,
 String syntaxName,
 String nanorcUrl)

Method Details

build

protected static SyntaxHighlighter build(List<Path> syntaxFiles,
 String file,
 String syntaxName)

build

protected static SyntaxHighlighter build(List<Path> syntaxFiles,
 String file,
 String syntaxName,
 boolean ignoreErrors)

build

public static SyntaxHighlighter build(Path nanorc,
 String syntaxName)

Build SyntaxHighlighter

Parameters:

nanorc - Path of nano config file jnanorc

syntaxName - syntax name e.g 'Java'

Returns:

SyntaxHighlighter

nanorcInclude

protected static void nanorcInclude(Path nanorc,
 String parameter,
 List<Path> syntaxFiles)
                             throws IOException

Throws:

IOException

nanorcTheme

protected static void nanorcTheme(Path nanorc,
 String parameter,
 List<Path> syntaxFiles)
                           throws IOException

Throws:

IOException

addFiles

protected static void addFiles(Path nanorc,
 String parameter,
 Consumer<Stream<Path>> consumer)
                        throws IOException

Throws:

IOException

extractPathParts

private static SyntaxHighlighter.PathParts extractPathParts(String pattern)

Extracts the static (non-wildcard) path prefix and the glob pattern from a path. For example:

• foo/bar/*.nanorc returns PathParts("foo/bar", "*.nanorc")
• foo/bar/**/*.nanorc returns PathParts("foo/bar", "**/*.nanorc")
• *.nanorc returns PathParts("", "*.nanorc")
• /usr/share/nano/*.nanorc returns PathParts("/usr/share/nano", "*.nanorc")

build

public static SyntaxHighlighter build(String nanorcUrl)

Build SyntaxHighlighter

This method builds a SyntaxHighlighter from a URL or classpath resource. The URL can be a file URL, an HTTP URL, or a classpath resource URL.

For classpath resources, use the "classpath:" prefix followed by the resource path. For example: "classpath:/nano/jnanorc"

Parameters:

nanorcUrl - URL or classpath resource path of nanorc file

Returns:

SyntaxHighlighter

addRules

private void addRules(Map<String,List<SyntaxHighlighter.HighlightRule>> rules)

setCurrentTheme

public void setCurrentTheme(Path currentTheme)

getCurrentTheme

public Path getCurrentTheme()

setParser

public void setParser(SyntaxHighlighter.Parser parser)

reset

public SyntaxHighlighter reset()

refresh

public void refresh()

highlight

public AttributedString highlight(String string)

highlight

public AttributedString highlight(AttributedStringBuilder asb)

highlight

public AttributedString highlight(AttributedString attributedString)

splitAndHighlight

private AttributedString splitAndHighlight(AttributedString attributedString)

_highlight

private AttributedStringBuilder _highlight(AttributedString line,
 List<SyntaxHighlighter.HighlightRule> rules)

_highlight

private AttributedStringBuilder _highlight(AttributedString line,
 List<SyntaxHighlighter.HighlightRule> rules,
 CharSequence startWith,
 CharSequence continueAs)