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.

Author:

Matti Rinta-Nikkola

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
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
protected static final String	DEFAULT_LESSRC_FILE
static final String	DEFAULT_NANORC_FILE
static final String	REGEX_TOKEN_NAME
static final String	TYPE_NANORCTHEME

Method Summary

Modifier and Type	Method	Description
protected static void	addFiles(Path nanorc, String parameter, Consumer<Stream<Path>> consumer)
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)
Path	getCurrentTheme()
org.jline.utils.AttributedString	highlight(String string)
org.jline.utils.AttributedString	highlight(org.jline.utils.AttributedString attributedString)
org.jline.utils.AttributedString	highlight(org.jline.utils.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(org.jline.builtins.SyntaxHighlighter.Parser parser)

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

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

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

setCurrentTheme

public void setCurrentTheme(Path currentTheme)

getCurrentTheme

public Path getCurrentTheme()

setParser

public void setParser(org.jline.builtins.SyntaxHighlighter.Parser parser)

reset

public SyntaxHighlighter reset()

refresh

public void refresh()

highlight

public org.jline.utils.AttributedString highlight(String string)

highlight

public org.jline.utils.AttributedString highlight(org.jline.utils.AttributedStringBuilder asb)

highlight

public org.jline.utils.AttributedString highlight(org.jline.utils.AttributedString attributedString)