Package io.github.treesitter.jtreesitter

Class Language

java.lang.Object

io.github.treesitter.jtreesitter.Language

All Implemented Interfaces:

Cloneable

@NullMarked
public final class Language
extends Object
implements Cloneable

A class that defines how to parse a particular language.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LANGUAGE_VERSION	The latest ABI version that is supported by the current version of the library.
static final int	MIN_COMPATIBLE_LANGUAGE_VERSION	The earliest ABI version that is supported by the current version of the library.

Constructor Summary

Constructors

Constructor	Description
Language(MemorySegment self)	Creates a new instance from the given language pointer.

Method Summary

Modifier and Type	Method	Description
Language	clone()	Get another reference to the language.
boolean	equals(Object o)
int	getFieldCount()	Get the number of distinct field names in this language
short	getFieldIdForName(String name)	Get the numerical ID for the given field name.
@Nullable String	getFieldNameForId(short id)	Get the field name for the given numerical id.
int	getStateCount()	Get the number of valid states in this language
int	getSymbolCount()	Get the number of distinct node types in this language.
short	getSymbolForName(String name, boolean isNamed)	Get the numerical ID for the given node type, or 0 if not found.
@Nullable String	getSymbolName(short symbol)	Get the node type for the given numerical ID.
int	getVersion()	Get the ABI version number for this language.
int	hashCode()
boolean	isNamed(short symbol)	Check if the node for the given numerical ID is named.
boolean	isSupertype(short symbol)	Check if the node for the given numerical ID is a supertype.
boolean	isVisible(short symbol)	Check if the node for the given numerical ID is visible.
static Language	load(SymbolLookup symbols, String language)	Load a language by looking for its function in the given symbols.
LookaheadIterator	lookaheadIterator(short state)	Create a new lookahead iterator for the given parse state.
short	nextState(short state, short symbol)	Get the next parse state.
Query	query(String source)	Create a new query from a string containing one or more S-expression patterns.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

LANGUAGE_VERSION

@Unsigned
public static final int LANGUAGE_VERSION

The latest ABI version that is supported by the current version of the library.

API Note:

The Tree-sitter library is generally backwards-compatible with languages generated using older CLI versions, but is not forwards-compatible.

MIN_COMPATIBLE_LANGUAGE_VERSION

@Unsigned
public static final int MIN_COMPATIBLE_LANGUAGE_VERSION

The earliest ABI version that is supported by the current version of the library.

Constructor Details

Language

public Language(MemorySegment self)
         throws IllegalArgumentException

Creates a new instance from the given language pointer.

Throws:

IllegalArgumentException - If the language version is incompatible.

Implementation Note:

It is up to the caller to ensure that the pointer is valid.

Method Details

load

public static Language load(SymbolLookup symbols,
 String language)
                     throws RuntimeException

Load a language by looking for its function in the given symbols.

Example

String library = System.mapLibraryName("tree-sitter-java");
SymbolLookup symbols = SymbolLookup.libraryLookup(library, Arena.global());
Language language = Language.load(symbols, "tree_sitter_java");

The Arena used to load the language must not be closed while the language is being used.

Throws:

RuntimeException - If the language could not be loaded.

Since:

0.23.1

getVersion

@Unsigned
public int getVersion()

Get the ABI version number for this language.

When a language is generated by the Tree-sitter CLI, it is assigned an ABI version number that corresponds to the current CLI version.

getSymbolCount

@Unsigned
public int getSymbolCount()

Get the number of distinct node types in this language.

getStateCount

@Unsigned
public int getStateCount()

Get the number of valid states in this language

getFieldCount

@Unsigned
public int getFieldCount()

Get the number of distinct field names in this language

getSymbolName

public @Nullable String getSymbolName(@Unsigned
 short symbol)

Get the node type for the given numerical ID.

getSymbolForName

@Unsigned
public short getSymbolForName(String name,
 boolean isNamed)

Get the numerical ID for the given node type, or 0 if not found.

isNamed

public boolean isNamed(@Unsigned
 short symbol)

Check if the node for the given numerical ID is named.

See Also:

• Node.isNamed()

isVisible

public boolean isVisible(@Unsigned
 short symbol)

Check if the node for the given numerical ID is visible.

isSupertype

public boolean isSupertype(@Unsigned
 short symbol)

Check if the node for the given numerical ID is a supertype.

Since:

0.24.0

getFieldNameForId

public @Nullable String getFieldNameForId(@Unsigned
 short id)

Get the field name for the given numerical id.

getFieldIdForName

@Unsigned
public short getFieldIdForName(String name)

Get the numerical ID for the given field name.

nextState

@Unsigned
public short nextState(@Unsigned
 short state,
 @Unsigned
 short symbol)

Get the next parse state.

short state = language.nextState(node.getParseState(), node.getGrammarSymbol());

Combine this with lookaheadIterator(state) to generate completion suggestions or valid symbols in ERROR nodes.

lookaheadIterator

public LookaheadIterator lookaheadIterator(@Unsigned
 short state)
                                    throws IllegalArgumentException

Create a new lookahead iterator for the given parse state.

Throws:

IllegalArgumentException - If the state is invalid for this language.

query

public Query query(String source)
            throws QueryError

Create a new query from a string containing one or more S-expression patterns.

Throws:

QueryError - If an error occurred while creating the query.

clone

public Language clone()

Get another reference to the language.

Since:

0.24.0

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object