Package io.github.treesitter.jtreesitter

package io.github.treesitter.jtreesitter

Java bindings to the tree-sitter parsing library.

Requirements

• JDK 22 (for the Foreign Function and Memory API )
• Tree-sitter shared library
• Generated bindings for languages
• Shared libraries for languages

Basic Usage

 Language language = new Language(TreeSitterJava.language());
 try (Parser parser = new Parser(language)) {
     try (Tree tree = parser.parse("void main() {}", InputEncoding.UTF_8).orElseThrow()) {
         Node rootNode = tree.getRootNode();
         assert rootNode.getType().equals("program");
         assert rootNode.getStartPoint().column() == 0;
         assert rootNode.getEndPoint().column() == 14;
     }
 }

Library Loading

There are three ways to load the shared libraries:

1. The libraries can be installed in the OS-specific library search path or in java.library.path. The search path can be amended using the LD_LIBRARY_PATH environment variable on Linux, DYLD_LIBRARY_PATH on macOS, or PATH on Windows. The libraries will be loaded automatically by SymbolLookup.libraryLookup(String, Arena)^RESTRICTED.
2. The libraries can be loaded manually by calling System.loadLibrary(String), if the library is installed in java.library.path, or System.load(String).
3. The libraries can be loaded manually by registering a custom implementation of NativeLibraryLookup. This can be used, for example, to load libraries from inside a JAR file.

Class	Description
InputEdit	An edit to a text document.
InputEncoding	The encoding of source code.
Language	A class that defines how to parse a particular language.
LanguageMetadata	The metadata associated with a Language.
LanguageMetadata.Version	The Semantic Version of the Language.
Logger	A function that logs parsing results.
Logger.Type	The type of a log message.
LookaheadIterator	A class that is used to look up valid symbols in a specific parse state.
LookaheadIterator.Symbol	A class that pairs a symbol ID with its name.
NativeLibraryLookup	An interface implemented by clients that wish to customize the SymbolLookup used for the tree-sitter native library.
Node	A single node within a syntax tree.
ParseCallback	A function that retrieves a chunk of text at a given byte offset and point.
Parser	A class that is used to produce a syntax tree from source code.
Parser.CancellationFlag	Deprecated. Use Parser.Options instead.
Parser.Options	A class representing the parser options.
Parser.State	A class representing the current state of the parser.
Point	A position in a text document in terms of rows and columns.
Query	A class that represents a set of patterns which match nodes in a syntax tree.
QueryCapture	A Node that was captured with a certain capture name.
QueryCursor	A class that can be used to execute a query on a syntax tree.
QueryCursor.Options	A class representing the query cursor options.
QueryCursor.State	A class representing the current state of the query cursor.
QueryError	Any error that occurred while instantiating a Query.
QueryError.Capture	A capture name error.
QueryError.Field	A field name error.
QueryError.NodeType	A node type error.
QueryError.Predicate	A query predicate error.
QueryError.Structure	A pattern structure error.
QueryError.Syntax	A query syntax error.
QueryMatch	A match that corresponds to a certain pattern in the query.
QueryPredicate	A query predicate that associates conditions (or arbitrary metadata) with a pattern.
QueryPredicate.AnyOf	Handles the following predicates: #any-of?, #not-any-of?
QueryPredicate.Eq	Handles the following predicates: #eq?, #not-eq?, #any-eq?, #any-not-eq?
QueryPredicate.Match	Handles the following predicates: #match?, #not-match?, #any-match?, #any-not-match?
QueryPredicateArg	An argument to a QueryPredicate.
QueryPredicateArg.Capture	A capture argument (@value).
QueryPredicateArg.Literal	A literal string argument ("value").
Range	A range of positions in a text document, both in terms of bytes and of row-column points.
Tree	A class that represents a syntax tree.
TreeCursor	A class that can be used to efficiently walk a syntax tree.
Unsigned	Specifies that the value is of an unsigned data type.