Kotlin (Android) API Reference

Kotlin (Android) API Reference v1.12.5

Functions

detectLanguageFromExtension()

Detect language name from a file extension (without leading dot).

Returns null for unrecognized extensions. The match is case-insensitive.

Signature:

fun detectLanguageFromExtension(ext: String): String?

Example:

val result = detectLanguageFromExtension("value")

Parameters:

Name	Type	Required	Description
`ext`	`String`	Yes	The ext

Returns: String?

detectLanguageFromPath()

Detect language name from a file path.

Extracts the file extension and looks it up. Returns null if the path has no extension or the extension is not recognized.

Signature:

fun detectLanguageFromPath(path: String): String?

Example:

val result = detectLanguageFromPath("value")

Parameters:

Name	Type	Required	Description
`path`	`String`	Yes	Path to the file

Returns: String?

detectLanguageFromContent()

Detect language name from file content using the shebang line (#!).

Inspects only the first line of content. If it begins with #!, the interpreter name is extracted and mapped to a language name.

Handles common patterns:

#!/usr/bin/env python3 → "python"
#!/bin/bash → "bash"
#!/usr/bin/env node → "javascript"

The -S flag accepted by some env implementations is skipped automatically. Version suffixes (e.g. python3.11, ruby3.2) are stripped before matching.

Returns null when content does not start with #!, the shebang is malformed, or the interpreter is not recognised.

Signature:

fun detectLanguageFromContent(content: String): String?

Example:

val result = detectLanguageFromContent("value")

Parameters:

Name	Type	Required	Description
`content`	`String`	Yes	The content to process

Returns: String?

getHighlightsQuery()

Get the highlights query for a language, if bundled.

Returns the contents of highlights.scm as a static string, or null if no highlights query is bundled for this language.

Signature:

fun getHighlightsQuery(language: String): String?

Example:

val result = getHighlightsQuery("value")

Parameters:

Name	Type	Required	Description
`language`	`String`	Yes	The language

Returns: String?

getInjectionsQuery()

Get the injections query for a language, if bundled.

Returns the contents of injections.scm as a static string, or null if no injections query is bundled for this language.

Signature:

fun getInjectionsQuery(language: String): String?

Example:

val result = getInjectionsQuery("value")

Parameters:

Name	Type	Required	Description
`language`	`String`	Yes	The language

Returns: String?

getLocalsQuery()

Get the locals query for a language, if bundled.

Returns the contents of locals.scm as a static string, or null if no locals query is bundled for this language.

Signature:

fun getLocalsQuery(language: String): String?

Example:

val result = getLocalsQuery("value")

Parameters:

Name	Type	Required	Description
`language`	`String`	Yes	The language

Returns: String?

getTagsQuery()

Get the tags query for a language, if bundled.

Returns the contents of tags.scm as a static string, or null if no tags query is bundled for this language.

Signature:

fun getTagsQuery(language: String): String?

Example:

val result = getTagsQuery("value")

Parameters:

Name	Type	Required	Description
`language`	`String`	Yes	The language

Returns: String?

getIndentsQuery()

Get the indents query for a language, if bundled.

Returns the contents of indents.scm (used for auto-indentation) as a static string, or null if no indents query is bundled for this language.

Signature:

fun getIndentsQuery(language: String): String?

Example:

val result = getIndentsQuery("value")

Parameters:

Name	Type	Required	Description
`language`	`String`	Yes	The language

Returns: String?

getFoldsQuery()

Get the folds query for a language, if bundled.

Returns the contents of folds.scm (used for code folding) as a static string, or null if no folds query is bundled for this language.

Signature:

fun getFoldsQuery(language: String): String?

Example:

val result = getFoldsQuery("value")

Parameters:

Name	Type	Required	Description
`language`	`String`	Yes	The language

Returns: String?

getLanguage()

Get a tree-sitter Language by name using the global registry.

Resolves language aliases (e.g., "shell" maps to "bash"). When the download feature is enabled (default), automatically downloads the parser from GitHub releases if not found locally.

Errors:

Returns Error.LanguageNotFound if the language is not recognized, or Error.Download if auto-download fails.

Signature:

@Throws(Error::class)
fun getLanguage(name: String): Language

Example:

val result = getLanguage("value")

Parameters:

Name	Type	Required	Description
`name`	`String`	Yes	The name

Returns: Language

Errors: Throws Error.

getParser()

Get a Parser pre-configured for the given language.

This is a convenience function that calls get_language and configures a new parser in one step.

Errors:

Returns Error.LanguageNotFound if the language is not recognized, or Error.ParserSetup if the language cannot be applied to the parser.

Signature:

@Throws(Error::class)
fun getParser(name: String): Parser

Example:

val result = getParser("value")

Parameters:

Name	Type	Required	Description
`name`	`String`	Yes	The name

Returns: Parser

Errors: Throws Error.

detectLanguage()

Detect language name from a file path or extension.

This compatibility alias matches the pre-Alef Python binding API.

Signature:

fun detectLanguage(path: String): String?

Example:

val result = detectLanguage("value")

Parameters:

Name	Type	Required	Description
`path`	`String`	Yes	Path to the file

Returns: String?

availableLanguages()

List all available language names (sorted, deduplicated, includes aliases).

Returns names of both statically compiled and dynamically loadable languages, plus any configured aliases.

Signature:

fun availableLanguages(): List<String>

Example:

val result = availableLanguages()

Returns: List<String>

hasLanguage()

Check if a language is available by name or alias.

Returns true if the language can be loaded (statically compiled, dynamically available, or a known alias for one of these).

Signature:

fun hasLanguage(name: String): Boolean

Example:

val result = hasLanguage("value")

Parameters:

Name	Type	Required	Description
`name`	`String`	Yes	The name

Returns: Boolean

languageCount()

Return the number of available languages.

Includes statically compiled languages, dynamically loadable languages, and aliases.

Signature:

fun languageCount(): Long

Example:

val result = languageCount()

Returns: Long

process()

Process source code and extract file intelligence using the global registry.

Parses the source with tree-sitter and extracts metrics, structure, imports, exports, comments, docstrings, symbols, diagnostics, and/or chunks based on the flags set in ProcessConfig.

Errors:

Returns an error if the language is not found or parsing fails.

Signature:

@Throws(Error::class)
fun process(source: String, config: ProcessConfig): ProcessResult

Example:

val result = process("value", ProcessConfig())

Parameters:

Name	Type	Required	Description
`source`	`String`	Yes	The source
`config`	`ProcessConfig`	Yes	The configuration options

Returns: ProcessResult

Errors: Throws Error.

init()

Initialize the language pack with the given configuration.

Applies any custom cache directory, then downloads all languages and groups specified in the config. This is the recommended entry point when you want to pre-warm the cache before use.

Errors:

Returns an error if configuration cannot be applied or if downloads fail.

Signature:

@Throws(Error::class)
fun init(config: PackConfig)

Example:

init(PackConfig())

Parameters:

Name	Type	Required	Description
`config`	`PackConfig`	Yes	The configuration options

Returns: No return value.

Errors: Throws Error.

configure()

Apply download configuration without downloading anything.

Use this to set a custom cache directory before the first call to get_language or any download function. Changing the cache dir after languages have been registered has no effect on already-loaded languages.

Errors:

Returns an error if the lock cannot be acquired.

Signature:

@Throws(Error::class)
fun configure(config: PackConfig)

Example:

configure(PackConfig())

Parameters:

Name	Type	Required	Description
`config`	`PackConfig`	Yes	The configuration options

Returns: No return value.

Errors: Throws Error.

download()

Download specific languages to the local cache.

Returns the number of requested languages available after the call. Already compiled or cached languages are included in the count.

Errors:

Returns an error if any language is not available in the manifest or if the download fails.

Signature:

@Throws(Error::class)
fun download(names: List<String>): Long

Example:

val result = download([])

Parameters:

Name	Type	Required	Description
`names`	`List<String>`	Yes	The names

Returns: Long

Errors: Throws Error.

prefetch()

Prefetch grammars: download any not already loadable from disk, then load every requested language into the process registry so a subsequent hot loop only parses.

Unlike download(), this does not trust in-memory availability — it downloads whenever a grammar is not actually loadable from disk (fixing the case where a known-but-not-downloaded grammar is reported present), then resolves and caches every requested language. Call it once, up front, before a parallel workload.

Errors:

Returns Error.Download if a required grammar cannot be fetched, or Error.LanguageNotFound if a requested name is unknown.

Signature:

@Throws(Error::class)
fun prefetch(languages: List<String>)

Example:

prefetch([])

Parameters:

Name	Type	Required	Description
`languages`	`List<String>`	Yes	The languages

Returns: No return value.

Errors: Throws Error.

prefetch()

Prefetch grammars by loading each into the registry.

Without the download feature there is no network step — every requested language must already be statically compiled or present on disk.

Errors:

Returns Error.LanguageNotFound if a requested language is not available.

Signature:

@Throws(Error::class)
fun prefetch(languages: List<String>)

Example:

prefetch([])

Parameters:

Name	Type	Required	Description
`languages`	`List<String>`	Yes	The languages

Returns: No return value.

Errors: Throws Error.

downloadAll()

Download all available languages from the remote manifest.

Downloads the platform bundle and extracts every library it contains. Languages that appear in the manifest but are absent from the bundle (e.g. grammars that failed to compile at release time) are silently skipped — they are not treated as an error.

Returns the total number of languages now available (statically compiled plus downloaded and cached).

Errors:

Returns an error if the manifest cannot be fetched or the bundle download fails.

Signature:

@Throws(Error::class)
fun downloadAll(): Long

Example:

val result = downloadAll()

Returns: Long

Errors: Throws Error.

downloadGroup()

Download every language in a named group (e.g. "web", "data").

Groups are defined in the remote manifest and let you ensure a curated set of related grammars in one call instead of listing each name to download(). Already-cached languages are skipped.

Returns the total number of languages now available (statically compiled plus downloaded and cached).

Errors:

Returns an error if the manifest cannot be fetched, the group is unknown, or any constituent language fails to download.

Signature:

@Throws(Error::class)
fun downloadGroup(name: String): Long

Example:

val result = downloadGroup("value")

Parameters:

Name	Type	Required	Description
`name`	`String`	Yes	The name

Returns: Long

Errors: Throws Error.

manifestLanguages()

Return all language names available in the remote manifest (306).

Fetches (and caches) the remote manifest to discover the full list of downloadable languages. Use downloaded_languages to list what is already cached locally.

Errors:

Returns an error if the manifest cannot be fetched.

Signature:

@Throws(Error::class)
fun manifestLanguages(): List<String>

Example:

val result = manifestLanguages()

Returns: List<String>

Errors: Throws Error.

downloadedLanguages()

Return languages that are already downloaded and cached locally.

Does not perform any network requests. Returns an empty list if the cache directory does not exist or cannot be read.

Signature:

fun downloadedLanguages(): List<String>

Example:

val result = downloadedLanguages()

Returns: List<String>

cleanCache()

Delete all cached parser shared libraries.

Resets the cache registration so the next call to get_language or a download function will re-register the (now empty) cache directory.

Errors:

Returns an error if the cache directory cannot be removed.

Signature:

@Throws(Error::class)
fun cleanCache()

Example:

cleanCache()

Returns: No return value.

Errors: Throws Error.

cacheDir()

Return the effective cache directory path.

This is either the custom path set via configure / init or the default: ~/.cache/tree-sitter-language-pack/v{version}/libs/.

Errors:

Returns an error if the system cache directory cannot be determined.

Signature:

@Throws(Error::class)
fun cacheDir(): String

Example:

val result = cacheDir()

Returns: String

Errors: Throws Error.

Types

ByteRange

A byte range — start (inclusive) to end (exclusive).

Field	Type	Default	Description
`start`	`Long`	—	Inclusive start byte offset.
`end`	`Long`	—	Exclusive end byte offset.

ChunkContext

Metadata for a single chunk of source code.

Field	Type	Default	Description
`language`	`String`	—	Language name used to parse this chunk.
`chunkIndex`	`Long`	—	Zero-indexed position of this chunk within the file’s chunk list.
`totalChunks`	`Long`	—	Total number of chunks the file was split into.
`nodeTypes`	`List<String>`	`\[\]`	Tree-sitter node kinds that appear at the top level of this chunk.
`contextPath`	`List<String>`	`\[\]`	Hierarchical path of enclosing structural items (e.g., `\["MyClass", "my_method"\]`).
`symbolsDefined`	`List<String>`	`\[\]`	Names of symbols defined within this chunk.
`comments`	`List<CommentInfo>`	`\[\]`	Comments contained within this chunk.
`docstrings`	`List<DocstringInfo>`	`\[\]`	Docstrings contained within this chunk.
`hasErrorNodes`	`Boolean`	—	Whether this chunk contains any tree-sitter error nodes.

CodeChunk

A chunk of source code with rich metadata.

Field	Type	Default	Description
`content`	`String`	—	The raw source text of this chunk.
`startByte`	`Long`	—	Inclusive start byte offset of this chunk in the original source.
`endByte`	`Long`	—	Exclusive end byte offset of this chunk in the original source.
`startLine`	`Long`	—	Zero-indexed start line of this chunk.
`endLine`	`Long`	—	Zero-indexed end line of this chunk.
`metadata`	`ChunkContext`	—	Contextual metadata about this chunk.

CommentInfo

A comment extracted from source code.

Field	Type	Default	Description
`text`	`String`	—	The raw text content of the comment.
`kind`	`CommentKind`	`CommentKind.Line`	The kind of comment (line, block, or doc).
`span`	`Span`	—	Source span covering the comment.
`associatedNode`	`String?`	`null`	Name of the syntax node this comment is directly associated with.

DataAttribute

An XML-style attribute attached to an Element node.

Populated only for DataNodeKind.Element; always empty for KeyValue and Sequence nodes.

Field	Type	Default	Description
`name`	`String`	—	Attribute name (e.g. `"class"`, `"href"`).
`value`	`String`	—	Attribute value as a raw string (quotes stripped).
`span`	`Span`	—	Source span covering the entire `name="value"` attribute token.

DataNode

A node in the hierarchical data tree produced by data-format extraction.

When ProcessConfig.data_extraction is true, ProcessResult.data is populated with a root DataNode whose children mirror the structure of the parsed file.

The kind field determines which other fields are meaningful:

`kind`	`key`	`value`	`attributes`	`children`
`KeyValue`	key / mapping key / index	leaf value	empty	nested map
`Element`	XML tag name	text content	XML attrs	child elements
`Sequence`	positional index (`"0"`)	leaf value	empty	sub-items

Field	Type	Default	Description
`kind`	`DataNodeKind`	`DataNodeKind.KeyValue`	Whether this node is a key/value pair, XML element, or sequence item.
`key`	`String?`	`null`	Key, attribute name, tag name, or positional index (`"0"`, `"1"`, …). `null` at the document root.
`value`	`String?`	`null`	Leaf scalar value, if any. `null` for containers (objects, arrays, XML elements with child elements).
`attributes`	`List<DataAttribute>`	`\[\]`	Attributes on element-shape nodes (XML `STag` attributes). Empty for all other kinds.
`children`	`List<DataNode>`	`\[\]`	Children for nested containers and XML element bodies.
`span`	`Span`	—	Source span covering this node in the original source file.

Diagnostic

A diagnostic (syntax error, missing node, etc.) from parsing.

Field	Type	Default	Description
`message`	`String`	—	Human-readable description of the diagnostic.
`severity`	`DiagnosticSeverity`	`DiagnosticSeverity.Error`	Severity of the diagnostic.
`span`	`Span`	—	Source span where the diagnostic was detected.

DocSection

A section within a docstring (e.g., Args, Returns, Raises).

Field	Type	Default	Description
`kind`	`String`	—	Section kind (e.g., `"args"`, `"returns"`, `"raises"`).
`name`	`String?`	`null`	Parameter or return value name, if applicable.
`description`	`String`	—	Description text for this section.

DocstringInfo

A docstring extracted from source code.

Field	Type	Default	Description
`text`	`String`	—	The raw text of the docstring.
`format`	`DocstringFormat`	`DocstringFormat.PythonTripleQuote`	The docstring format (Python, JSDoc, Rustdoc, etc.).
`span`	`Span`	—	Source span covering the docstring.
`associatedItem`	`String?`	`null`	Name of the item this docstring documents.
`parsedSections`	`List<DocSection>`	`\[\]`	Parsed sections of the docstring (Args, Returns, Raises, etc.).

DownloadManager

Manages downloading and caching of pre-built parser shared libraries.

Methods

new()

Create a new download manager for the given version.

Signature:

@Throws(Error::class)
@JvmStatic
fun new(version: String): DownloadManager

Example:

val result = DownloadManager.new("value")

Parameters:

Name	Type	Required	Description
`version`	`String`	Yes	The version

Returns: DownloadManager

Errors: Throws Error.

installedLanguages()

List languages that are already downloaded and cached.

Signature:

fun installedLanguages(): List<String>

Example:

val result = instance.installedLanguages()

Returns: List<String>

downloadAllBestEffort()

Download the platform bundle and extract every library file it contains.

Unlike Self.ensure_languages, this does not check the manifest language list against archive contents — it simply extracts all .so/.dylib/.dll files from the bundle. Languages in the manifest that are missing from the archive are silently ignored rather than returning an error.

Returns the number of library files extracted (including those already cached).

Signature:

@Throws(Error::class)
fun downloadAllBestEffort(): Long

Example:

val result = instance.downloadAllBestEffort()

Returns: Long

Errors: Throws Error.

cleanCache()

Remove all cached parser libraries.

Acquires the cross-process lock so clean_cache cannot race a concurrent downloader (avoids Windows sharing-violation errors against an in-flight bundle write). The .download.lock file itself is not removed — it is permanent infrastructure; deleting it could allow a concurrent process that already opened the file to continue holding a stale lock handle while a new process opens a fresh inode, breaking the mutual-exclusion guarantee.

Signature:

@Throws(Error::class)
fun cleanCache()

Example:

instance.cleanCache()

Returns: No return value.

Errors: Throws Error.

ExportInfo

An export statement extracted from source code.

Field	Type	Default	Description
`name`	`String`	—	The exported name.
`kind`	`ExportKind`	`ExportKind.Named`	The kind of export (named, default, or re-export).
`span`	`Span`	—	Source span covering the export statement.

FileMetrics

Aggregate metrics for a source file.

Field	Type	Default	Description
`totalLines`	`Long`	—	Total number of lines (including blank and comment lines).
`codeLines`	`Long`	—	Number of lines containing non-blank, non-comment source code.
`commentLines`	`Long`	—	Number of lines that are entirely comments.
`blankLines`	`Long`	—	Number of blank (whitespace-only) lines.
`totalBytes`	`Long`	—	Total byte length of the source file.
`nodeCount`	`Long`	—	Total number of nodes in the syntax tree.
`errorCount`	`Long`	—	Number of error nodes in the syntax tree (parse errors).
`maxDepth`	`Long`	—	Maximum nesting depth reached in the syntax tree.

ImportInfo

An import statement extracted from source code.

Field	Type	Default	Description
`source`	`String`	—	The module or path being imported from.
`items`	`List<String>`	`\[\]`	Specific names imported from the source module.
`alias`	`String?`	`null`	Alias assigned to the import (e.g., `import numpy as np`).
`isWildcard`	`Boolean`	—	Whether this is a wildcard import (e.g., `import ` or `use foo.`).
`span`	`Span`	—	Source span covering the import statement.

Language

LanguageRegistry

Thread-safe registry of tree-sitter language parsers.

Manages both statically compiled and dynamically loaded language grammars. Use LanguageRegistry.new() for the default registry, or access the global instance via the module-level convenience functions (get_language, available_languages, etc.).

Methods

new()

Create a new registry populated with all statically compiled languages.

When the dynamic-loading feature is enabled, the registry also knows about dynamically loadable grammars and will load them on demand.

Signature:

@JvmStatic
fun new(): LanguageRegistry

Example:

val result = LanguageRegistry.new()

Returns: LanguageRegistry

getLanguage()

Get a tree-sitter Language by name.

Resolves aliases (e.g., "shell" -> "bash", "makefile" -> "make"), then looks up the language in the static table. When the dynamic-loading feature is enabled, falls back to loading a shared library on demand.

Errors:

Returns Error.LanguageNotFound if the name (after alias resolution) does not match any known grammar.

Signature:

@Throws(Error::class)
fun getLanguage(name: String): Language

Example:

val result = instance.getLanguage("value")

Parameters:

Name	Type	Required	Description
`name`	`String`	Yes	The name

Returns: Language

Errors: Throws Error.

availableLanguages()

List all available language names, sorted and deduplicated.

Includes statically compiled languages, dynamically loadable languages (if the dynamic-loading feature is enabled), and all configured aliases.

Signature:

fun availableLanguages(): List<String>

Example:

val result = instance.availableLanguages()

Returns: List<String>

hasParser()

Check whether a parser is statically compiled into this build.

Returns true only when the grammar was compiled in at build time (i.e. it appears in the STATIC_LANGUAGES table). This is independent of the extension-to-language mapping: detect_language_from_extension consults the static ext table for all 306 grammars regardless of which parsers are compiled in.

Use this when you need to distinguish “we know the language name” from “we can actually parse files in that language right now”.

use tree_sitter_language_pack::{detect_language_from_extension, LanguageRegistry};

let registry = LanguageRegistry::new();
// Extension detection uses the static table — independent of compiled parsers.
let lang = detect_language_from_extension("feature"); // always returns Some("gherkin")
// Parser availability depends on which grammars were compiled in.
let can_parse = lang.map(|name| registry.has_parser(name)).unwrap_or(false);

Signature:

fun hasParser(name: String): Boolean

Example:

val result = instance.hasParser("value")

Parameters:

Name	Type	Required	Description
`name`	`String`	Yes	The name

Returns: Boolean

hasLanguage()

Check whether a language is available by name or alias.

Returns true if the language can be loaded, either from the static table or from a dynamic library on disk.

Signature:

fun hasLanguage(name: String): Boolean

Example:

val result = instance.hasLanguage("value")

Parameters:

Name	Type	Required	Description
`name`	`String`	Yes	The name

Returns: Boolean

languageCount()

Return the total number of available languages (including aliases).

Signature:

fun languageCount(): Long

Example:

val result = instance.languageCount()

Returns: Long

process()

Parse source code and extract file intelligence based on config in a single pass.

Signature:

@Throws(Error::class)
fun process(source: String, config: ProcessConfig): ProcessResult

Example:

val result = instance.process("value", ProcessConfig())

Parameters:

Name	Type	Required	Description
`source`	`String`	Yes	The source
`config`	`ProcessConfig`	Yes	The configuration options

Returns: ProcessResult

Errors: Throws Error.

default()

Signature:

@JvmStatic
fun default(): LanguageRegistry

Example:

val result = LanguageRegistry.default()

Returns: LanguageRegistry

Node

A single syntax node within a Tree.

Nodes hold a strong reference to their parent tree so they remain valid regardless of how the tree is moved or stored at the FFI boundary.

Methods

clone()

Signature:

fun clone(): Node

Example:

val result = instance.clone()

Returns: Node

kind()

Return the node’s kind name (e.g. "function_definition").

Signature:

fun kind(): String

Example:

val result = instance.kind()

Returns: String

kindId()

Return the node’s numeric kind ID.

Tree-sitter assigns a stable u16 ID to every node kind in a grammar (e.g. "function_definition" → 42). Comparing kind_id() is cheaper than comparing the string kind() in tight AST loops.

Signature:

fun kindId(): Short

Example:

val result = instance.kindId()

Returns: Short

startByte()

Return the inclusive start byte offset of this node.

Signature:

fun startByte(): Long

Example:

val result = instance.startByte()

Returns: Long

endByte()

Return the exclusive end byte offset of this node.

Signature:

fun endByte(): Long

Example:

val result = instance.endByte()

Returns: Long

byteRange()

Return the node’s byte range as a ByteRange.

Callers should slice their own source bytes — this is a zero-copy text accessor.

Signature:

fun byteRange(): ByteRange

Example:

val result = instance.byteRange()

Returns: ByteRange

startPosition()

Return the start Point (row, column).

Signature:

fun startPosition(): Point

Example:

val result = instance.startPosition()

Returns: Point

endPosition()

Return the end Point (row, column).

Signature:

fun endPosition(): Point

Example:

val result = instance.endPosition()

Returns: Point

isNamed()

True when this node is named (not punctuation/whitespace).

Signature:

fun isNamed(): Boolean

Example:

val result = instance.isNamed()

Returns: Boolean

isError()

True when this is an error node.

Signature:

fun isError(): Boolean

Example:

val result = instance.isError()

Returns: Boolean

isMissing()

True when this is a missing-token node.

Signature:

fun isMissing(): Boolean

Example:

val result = instance.isMissing()

Returns: Boolean

isExtra()

True when this is an “extra” node (e.g. a comment).

Signature:

fun isExtra(): Boolean

Example:

val result = instance.isExtra()

Returns: Boolean

hasError()

True when this node or any descendant is an error.

Signature:

fun hasError(): Boolean

Example:

val result = instance.hasError()

Returns: Boolean

parent()

Return this node’s parent, if any.

Signature:

fun parent(): Node?

Example:

val result = instance.parent()

Returns: Node?

child()

Return the i-th child of this node, if any.

Signature:

fun child(index: Int): Node?

Example:

val result = instance.child(42)

Parameters:

Name	Type	Required	Description
`index`	`Int`	Yes	The index

Returns: Node?

childCount()

Total number of children (including unnamed).

Signature:

fun childCount(): Long

Example:

val result = instance.childCount()

Returns: Long

namedChild()

Return the i-th named child of this node, if any.

Signature:

fun namedChild(index: Int): Node?

Example:

val result = instance.namedChild(42)

Parameters:

Name	Type	Required	Description
`index`	`Int`	Yes	The index

Returns: Node?

namedChildCount()

Number of named children of this node.

Signature:

fun namedChildCount(): Long

Example:

val result = instance.namedChildCount()

Returns: Long

childByFieldName()

Look up a child by its grammar-defined field name.

Signature:

fun childByFieldName(name: String): Node?

Example:

val result = instance.childByFieldName("value")

Parameters:

Name	Type	Required	Description
`name`	`String`	Yes	The name

Returns: Node?

toSexp()

Return the S-expression form of this node’s subtree.

Signature:

fun toSexp(): String

Example:

val result = instance.toSexp()

Returns: String

walk()

Return a TreeCursor positioned at this node.

Signature:

fun walk(): TreeCursor

Example:

val result = instance.walk()

Returns: TreeCursor

PackConfig

Configuration for the tree-sitter language pack.

Controls cache directory and which languages to pre-download. Can be loaded from a TOML file, constructed programmatically, or passed as a dict/object from language bindings.

Field	Type	Default	Description
`cacheDir`	`Path?`	`null`	Override default cache directory. Default: `~/.cache/tree-sitter-language-pack/v{version}/libs/`
`languages`	`List<String>?`	`\[\]`	Languages to pre-download on init. Each entry is a language name (e.g. `"python"`, `"rust"`).
`groups`	`List<String>?`	`\[\]`	Language groups to pre-download (e.g. `"web"`, `"systems"`, `"scripting"`).

Parser

A tree-sitter parser configured for one language at a time.

Methods

new()

Construct a new parser with no language set.

Call Parser.set_language before parsing.

Signature:

@JvmStatic
fun new(): Parser

Example:

val result = Parser.new()

Returns: Parser

setLanguage()

Configure the parser to use the language identified by name (e.g. "python").

Resolves the language through the global registry — auto-downloading if necessary, when the download feature is enabled.

Errors:

Returns Error.LanguageNotFound if the language is not recognized, or Error.ParserSetup if the language ABI is incompatible.

Signature:

@Throws(Error::class)
fun setLanguage(name: String)

Example:

instance.setLanguage("value")

Parameters:

Name	Type	Required	Description
`name`	`String`	Yes	The name

Returns: No return value.

Errors: Throws Error.

parse()

Parse a UTF-8 source string. Returns null if parsing was cancelled or no language is set.

Signature:

fun parse(source: String): Tree?

Example:

val result = instance.parse("value")

Parameters:

Name	Type	Required	Description
`source`	`String`	Yes	The source

Returns: Tree?

parseBytes()

Parse a raw byte slice. Returns null if parsing was cancelled or no language is set.

Signature:

fun parseBytes(source: ByteArray): Tree?

Example:

val result = instance.parseBytes("data".toByteArray())

Parameters:

Name	Type	Required	Description
`source`	`ByteArray`	Yes	The source

Returns: Tree?

reset()

Reset internal state. The next call to parse will not be incremental.

Signature:

fun reset()

Example:

instance.reset()

Returns: No return value.

default()

Signature:

@JvmStatic
fun default(): Parser

Example:

val result = Parser.default()

Returns: Parser

Point

A source position — row + column, zero-indexed.

Field	Type	Default	Description
`row`	`Long`	—	Zero-indexed row number.
`column`	`Long`	—	Zero-indexed column number, in UTF-16 code units.

ProcessConfig

Configuration for the process() function.

Controls which analysis features are enabled and whether chunking is performed.

Field	Type	Default	Description
`language`	`String`	—	Language name (required).
`structure`	`Boolean`	`true`	Extract structural items (functions, classes, etc.). Default: true.
`imports`	`Boolean`	`true`	Extract import statements. Default: true.
`exports`	`Boolean`	`true`	Extract export statements. Default: true.
`comments`	`Boolean`	`false`	Extract comments. Default: false.
`docstrings`	`Boolean`	`false`	Extract docstrings. Default: false.
`symbols`	`Boolean`	`false`	Extract symbol definitions. Default: false.
`diagnostics`	`Boolean`	`false`	Include parse diagnostics. Default: false.
`chunkMaxSize`	`Long?`	`null`	Maximum chunk size in bytes. `null` disables chunking.
`dataExtraction`	`Boolean`	`false`	Extract hierarchical key/value data tree from data-format files. Default: false. When `true`, `ProcessResult.data` is populated with a `DataNode` tree for supported languages: JSON, YAML, TOML, `.properties`, HCL/HOCON, INI, editorconfig, KDL, CUE, CSV, PSV, PO, nginx config, Caddy config, XML, and DTD. For languages outside this set the field is left as `null`.

Methods

default()

Signature:

@JvmStatic
fun default(): ProcessConfig

Example:

val result = ProcessConfig.default()

Returns: ProcessConfig

withChunking()

Enable chunking with the given maximum chunk size in bytes.

Signature:

fun withChunking(maxSize: Long): ProcessConfig

Example:

val result = instance.withChunking(42)

Parameters:

Name	Type	Required	Description
`maxSize`	`Long`	Yes	The max size

Returns: ProcessConfig

all()

Enable all analysis features.

Signature:

fun all(): ProcessConfig

Example:

val result = instance.all()

Returns: ProcessConfig

minimal()

Disable all analysis features (only metrics computed).

Signature:

fun minimal(): ProcessConfig

Example:

val result = instance.minimal()

Returns: ProcessConfig

withDataExtraction()

Enable or disable hierarchical data extraction for data-format files.

When true, ProcessResult.data is populated with a key/value tree for supported data-format languages.

Signature:

fun withDataExtraction(enabled: Boolean): ProcessConfig

Example:

val result = instance.withDataExtraction(true)

Parameters:

Name	Type	Required	Description
`enabled`	`Boolean`	Yes	The enabled

Returns: ProcessConfig

ProcessResult

Complete analysis result from processing a source file.

Contains metrics, structural analysis, imports/exports, comments, docstrings, symbols, diagnostics, and optionally chunked code segments. Fields are populated based on the ProcessConfig flags.

Field	Type	Default	Description
`language`	`String`	—	The language name used to parse the source file.
`metrics`	`FileMetrics`	—	File-level metrics (line counts, byte size, error count).
`structure`	`List<StructureItem>`	`\[\]`	Top-level structural items (functions, classes, etc.).
`imports`	`List<ImportInfo>`	`\[\]`	Import statements extracted from the source.
`exports`	`List<ExportInfo>`	`\[\]`	Export statements extracted from the source.
`comments`	`List<CommentInfo>`	`\[\]`	Comments extracted from the source.
`docstrings`	`List<DocstringInfo>`	`\[\]`	Docstrings extracted from the source.
`symbols`	`List<SymbolInfo>`	`\[\]`	Symbol definitions (variables, types, functions) extracted from the source.
`diagnostics`	`List<Diagnostic>`	`\[\]`	Parse diagnostics (syntax errors, missing nodes) from tree-sitter.
`chunks`	`List<CodeChunk>`	`\[\]`	Syntax-aware code chunks produced when chunking is enabled.
`data`	`DataNode?`	`null`	Hierarchical data tree extracted when `config.data_extraction` is `true`. Populated for supported data-format languages (JSON, YAML, TOML, properties, HCL, INI, XML, CSV, and more). `null` when `data_extraction` is `false` (the default) or when the language is not a recognised data format. See `DataNode` for the shape of the returned tree.

Span

Byte and line/column range in source code.

Represents both byte offsets (for slicing) and human-readable line/column positions (for display and diagnostics).

Field	Type	Default	Description
`startByte`	`Long`	—	Inclusive start byte offset in the source.
`endByte`	`Long`	—	Exclusive end byte offset in the source.
`startLine`	`Long`	—	Zero-indexed line number of the span’s start.
`startColumn`	`Long`	—	Zero-indexed column number of the span’s start.
`endLine`	`Long`	—	Zero-indexed line number of the span’s end.
`endColumn`	`Long`	—	Zero-indexed column number of the span’s end.

StructureItem

A structural item (function, class, struct, etc.) in source code.

Field	Type	Default	Description
`kind`	`StructureKind`	`StructureKind.Function`	The kind of structural item.
`name`	`String?`	`null`	The declared name of the item, if present.
`visibility`	`String?`	`null`	Visibility modifier (e.g., `"pub"`, `"public"`, `"private"`).
`span`	`Span`	—	Source span covering the entire item declaration.
`children`	`List<StructureItem>`	`\[\]`	Nested structural items (e.g., methods within a class).
`decorators`	`List<String>`	`\[\]`	Decorator or attribute names applied to the item.
`docComment`	`String?`	`null`	Documentation comment attached to the item, if any.
`signature`	`String?`	`null`	Full signature text of the item (e.g., function parameters and return type).
`bodySpan`	`Span?`	`null`	Source span covering only the body of the item, if distinct from the declaration.

SymbolInfo

A symbol (variable, function, type, etc.) extracted from source code.

Field	Type	Default	Description
`name`	`String`	—	The name of the symbol.
`kind`	`SymbolKind`	`SymbolKind.Variable`	The kind of symbol (variable, function, class, etc.).
`span`	`Span`	—	Source span covering the symbol definition.
`typeAnnotation`	`String?`	`null`	Explicit type annotation, if present in the source.
`doc`	`String?`	`null`	Documentation comment associated with this symbol.

Tree

A parsed syntax tree. Cheap to clone (refcount bump).

Methods

rootNode()

Return the root Node of this tree.

Signature:

fun rootNode(): Node

Example:

val result = instance.rootNode()

Returns: Node

walk()

Return a TreeCursor positioned at the root.

Signature:

fun walk(): TreeCursor

Example:

val result = instance.walk()

Returns: TreeCursor

TreeCursor

A cursor for traversing a Tree.

Methods

node()

Return the Node at the cursor’s current position.

Signature:

fun node(): Node

Example:

val result = instance.node()

Returns: Node

gotoFirstChild()

Move the cursor to the first child of the current node. Returns true if a child existed.

Signature:

fun gotoFirstChild(): Boolean

Example:

val result = instance.gotoFirstChild()

Returns: Boolean

gotoParent()

Move the cursor to the parent of the current node. Returns true if a parent existed.

Signature:

fun gotoParent(): Boolean

Example:

val result = instance.gotoParent()

Returns: Boolean

gotoNextSibling()

Move the cursor to the next sibling of the current node. Returns true if a sibling existed.

Signature:

fun gotoNextSibling(): Boolean

Example:

val result = instance.gotoNextSibling()

Returns: Boolean

fieldName()

Return the field name for the current node, if any.

Signature:

fun fieldName(): String?

Example:

val result = instance.fieldName()

Returns: String?

Enums

DataNodeKind

The kind of a data node extracted from a data-format file.

Classifies each node in the hierarchical DataNode tree returned when data_extraction is enabled on ProcessConfig.

Wire format (public JSON contract)

Unit variants serialize as a bare string ("KeyValue"). DO NOT add #[serde(tag = "...")] or rename variants — every language binding has a hand-written deserializer matching this exact shape, and any change breaks all bindings’ process() tests simultaneously. Covered by tests/wire_format.rs.

Value	Description
`KeyValue`	A key/value pair or mapping (json/toml/properties/yaml/hcl/cue/kdl pair, or a wrapper “object”/“mapping” container).
`Element`	An XML element with a tag name in `key` and attributes in `attributes`.
`Sequence`	A positional sequence item (JSON array element, YAML block sequence item, CSV/PSV row or cell).

StructureKind

The kind of structural item found in source code.

Categorizes top-level and nested declarations such as functions, classes, structs, enums, traits, and more. Use Other for language-specific constructs that do not fit a standard category.

Wire format (public JSON contract)

Unit variants serialize as a bare string ("Function"); the Other variant serializes as a single-keyed object ({"Other": "macro"}). DO NOT add #[serde(tag = "...")] or rename variants — every language binding has a hand-written deserializer matching this exact shape, and any change breaks all bindings’ process() tests simultaneously. Covered by tests/wire_format.rs.

Value	Description
`Function`	A free-standing or associated function.
`Method`	A method defined inside a class, struct, trait, or impl block.
`Class`	A class definition.
`Struct`	A struct definition.
`Interface`	An interface or protocol definition.
`Enum`	An enum definition.
`Module`	A module or package declaration.
`Trait`	A trait definition.
`Impl`	An impl block (Rust) or similar implementation block.
`Namespace`	A namespace declaration.
`Other`	A language-specific construct that does not fit any standard category. — Fields: `0`: `String`

CommentKind

The kind of a comment found in source code.

Distinguishes between single-line comments, block (multi-line) comments, and documentation comments.

Value	Description
`Line`	A single-line comment (e.g., `// ...` or `# ...`).
`Block`	A block or multi-line comment using slash-star delimiters.
`Doc`	A documentation comment such as `/// ...` or slash-double-star block.

DocstringFormat

The format of a docstring extracted from source code.

Identifies the docstring convention used, which varies by language (e.g., Python triple-quoted strings, JSDoc, Rustdoc /// comments).

Wire format (public JSON contract)

Unit variants serialize as a bare string ("JSDoc"); the Other variant serializes as a single-keyed object ({"Other": "rst"}). DO NOT add #[serde(tag = "...")]. Covered by tests/wire_format.rs.

Value	Description
`PythonTripleQuote`	Python triple-quoted string docstring (`"""..."""`).
`JsDoc`	JavaScript/TypeScript JSDoc block comment (opens with two stars, closes with star-slash).
`Rustdoc`	Rust `///` or `//!` doc comment.
`GoDoc`	Go doc comment (a comment block immediately preceding a declaration).
`JavaDoc`	Java Javadoc block comment (opens with two stars, closes with star-slash).
`Other`	A language-specific docstring format not covered by the standard variants. — Fields: `0`: `String`

ExportKind

The kind of an export statement found in source code.

Covers named exports, default exports, and re-exports from other modules.

Value	Description
`Named`	A named export (e.g., `export { foo }`).
`Default`	A default export (e.g., `export default foo`).
`ReExport`	A re-export from another module (e.g., `export { foo } from 'bar'`).

SymbolKind

The kind of a symbol definition found in source code.

Categorizes symbol definitions such as variables, constants, functions, classes, types, interfaces, enums, and modules.

Wire format (public JSON contract)

Unit variants serialize as a bare string ("Function"); the Other variant serializes as a single-keyed object ({"Other": "macro"}). DO NOT add #[serde(tag = "...")]. Covered by tests/wire_format.rs.

Value	Description
`Variable`	A variable binding.
`Constant`	A constant (immutable binding).
`Function`	A function definition.
`Class`	A class definition.
`Type`	A type alias or typedef.
`Interface`	An interface definition.
`Enum`	An enum definition.
`Module`	A module declaration.
`Other`	A symbol kind not covered by the standard variants. — Fields: `0`: `String`

DiagnosticSeverity

Severity level of a diagnostic produced during parsing.

Used to classify parse errors, warnings, and informational messages found in the syntax tree.

Value	Description
`Error`	A parse error (e.g., an `ERROR` or `MISSING` node in the tree).
`Warning`	A warning-level diagnostic.
`Info`	An informational diagnostic.

Errors

Error

Errors that can occur when using the tree-sitter language pack.

Covers language lookup failures, parse errors, query errors, and I/O issues. Feature-gated variants are included when config, download, or related features are enabled.

Variant	Description
`LanguageNotFound`	The requested language name (or alias) was not found in the registry.
`DynamicLoad`	A dynamic shared library could not be loaded at runtime.
`NullLanguagePointer`	The tree-sitter language function returned a null pointer for the given language name.
`ParserSetup`	The language could not be applied to the parser (e.g., ABI version mismatch).
`LockPoisoned`	An internal `RwLock` or `Mutex` was poisoned by a previous panic.
`Config`	A configuration file or value was invalid or could not be applied.
`ParseFailed`	The tree-sitter parser returned no tree for the given source input.
`QueryError`	A tree-sitter query could not be compiled or executed.
`InvalidRange`	A byte range was invalid (e.g., end before start, or out of bounds).
`Download`	A parser download from GitHub releases failed.
`ChecksumMismatch`	The downloaded file’s SHA-256 digest did not match the manifest’s expected value.
`CacheLock`	The cross-process download cache lock file could not be acquired or created.