Package ch.usi.si.seart.treesitter

Enum Language

java.lang.Object

java.lang.Enum<Language>

ch.usi.si.seart.treesitter.Language

All Implemented Interfaces:

Serializable, Comparable<Language>

public enum Language
extends Enum<Language>

Enum that consists of all the officially recognized programming languages.

Only languages whose ABI version is within the range of the library's supported versions are included in this enum. For this reason, the enum is not exhaustive and may not include all languages developed by the community.

Since:

1.0.0

Author:

Ozren Dabić

See Also:

tree-sitter language list

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Language.Metadata	Represents Git metadata related to the grammar submodule that a language was built from.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADA	Ada programming language.
BASH	Bash: Bourne Again SHell.
C	C programming language.
C_SHARP	C# programming language.
CLOJURE	Clojure programming language.
CMAKE	The CMake language.
COMMON_LISP	Common Lisp programming language.
CPP	C++ programming language.
CSS	CSS: Cascading Style Sheets.
DART	Dart programming language.
DOT	DOT graph description language.
DTD	DTD: Document Type Definition.
ELIXIR	Elixir programming language.
ELM	Elm programming language.
EMBEDDED_TEMPLATE	Embedded HTML templates: EJS & ERS.
ERLANG	Erlang programming language.
FORTRAN	Fortran programming language.
GITATTRIBUTES	Configurations used for associating attributes with file and path patterns in a repository.
GITIGNORE	Patterns for intentionally untracked files in a repository.
GO	Go programming language.
GRAPHQL	GraphQL: Graph Query Language.
HASKELL	Haskell programming language.
HCL	HCL: HashiCorp Configuration Language.
HTML	HTML: HyperText Markup Language.
JAVA	Java programming language.
JAVASCRIPT	JavaScript programming language.
JSON	JSON: JavaScript Object Notation.
JULIA	Julia programming language.
KOTLIN	Kotlin programming language.
LATEX	LaTeX markup language for document typesetting.
LUA	Lua programming language.
MARKDOWN	Markdown markup language for creating formatted text.
NIX	Nix programming language.
OBJECTIVE_C	Objective-C programming language.
OCAML	OCaml programming language.
PASCAL	Pascal programming language.
PHP	PHP: Hypertext Preprocessor.
PYTHON	Python programming language.
R	R programming language.
RACKET	Racket programming language.
RUBY	Ruby programming language.
RUST	Rust programming language.
SCALA	Scala programming language.
SCHEME	Scheme programming language.
SCSS	SCSS: Sassy CSS.
SVELTE	Svelte front-end component framework.
SWIFT	Swift programming language.
THRIFT	Thrift interface description language.
TOML	TOML: Tom's Obvious Minimal Language.
TSX	JSX-enhanced TypeScript.
TWIG	Twig template language.
TYPESCRIPT	TypeScript programming language.
VERILOG	Verilog hardware description language.
XML	XML: Extensible Markup Language.
YAML	YAML: YAML Ain't Markup Language.
ZIG	Zig programming language.

Method Summary

Modifier and Type	Method	Description
static @NotNull Collection<Language>	associatedWith(@NotNull Path path)	Selects enum values potentially associated with a file at a given path.
Language.Metadata	getMetadata()	Get the Git metadata for the language.
int	getTotalFields()	Deprecated, for removal: This API element is subject to removal in a future version. Just calculate the size of the list returned by fields getter.
int	getTotalSymbols()	Deprecated, for removal: This API element is subject to removal in a future version. Just calculate the size of the list returned by symbols getter.
LookaheadIterator	iterator(int state)	Create a lookahead iterator, beginning from a specific parse state.
int	nextState(@NotNull Node node)	Obtain the next language parse state for a given Node.
String	toString()
static void	validate(@NotNull Language language)	Validates an enum value to ensure it is not null and has a valid (nonzero) identifier.
static Language	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Language[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADA

public static final Language ADA

Ada programming language.

See Also:

tree-sitter-ada

BASH

public static final Language BASH

Bash: Bourne Again SHell.

See Also:

tree-sitter-bash

C

public static final Language C

C programming language.

See Also:

tree-sitter-c

CLOJURE

public static final Language CLOJURE

Clojure programming language.

See Also:

tree-sitter-clojure

CMAKE

public static final Language CMAKE

The CMake language.

See Also:

tree-sitter-cmake

COMMON_LISP

public static final Language COMMON_LISP

Common Lisp programming language.

See Also:

tree-sitter-commonlisp

C_SHARP

public static final Language C_SHARP

C# programming language.

See Also:

tree-sitter-c-sharp

CPP

public static final Language CPP

C++ programming language.

See Also:

tree-sitter-cpp

CSS

public static final Language CSS

CSS: Cascading Style Sheets.

See Also:

tree-sitter-css

DART

public static final Language DART

Dart programming language.

See Also:

tree-sitter-dart

DOT

public static final Language DOT

DOT graph description language.

See Also:

tree-sitter-dot

DTD

public static final Language DTD

DTD: Document Type Definition.

See Also:

tree-sitter-xml

ELIXIR

public static final Language ELIXIR

Elixir programming language.

See Also:

tree-sitter-elixir

ELM

public static final Language ELM

Elm programming language.

See Also:

tree-sitter-elm

EMBEDDED_TEMPLATE

public static final Language EMBEDDED_TEMPLATE

Embedded HTML templates: EJS & ERS.

See Also:

tree-sitter-embedded-template

ERLANG

public static final Language ERLANG

Erlang programming language.

See Also:

tree-sitter-erlang

FORTRAN

public static final Language FORTRAN

Fortran programming language.

See Also:

tree-sitter-fortran

GITATTRIBUTES

public static final Language GITATTRIBUTES

Configurations used for associating attributes with file and path patterns in a repository.

See Also:

tree-sitter-gitattributes

GITIGNORE

public static final Language GITIGNORE

Patterns for intentionally untracked files in a repository.

See Also:

tree-sitter-gitignore

GO

public static final Language GO

Go programming language.

See Also:

tree-sitter-go

GRAPHQL

public static final Language GRAPHQL

GraphQL: Graph Query Language.

See Also:

tree-sitter-graphql

HCL

public static final Language HCL

HCL: HashiCorp Configuration Language.

See Also:

tree-sitter-hcl

HASKELL

public static final Language HASKELL

Haskell programming language.

See Also:

tree-sitter-haskell

HTML

public static final Language HTML

HTML: HyperText Markup Language.

See Also:

tree-sitter-html

JAVA

public static final Language JAVA

Java programming language.

See Also:

tree-sitter-java

JAVASCRIPT

public static final Language JAVASCRIPT

JavaScript programming language.

See Also:

tree-sitter-javascript

JSON

public static final Language JSON

JSON: JavaScript Object Notation.

See Also:

tree-sitter-json

JULIA

public static final Language JULIA

Julia programming language.

See Also:

tree-sitter-julia

KOTLIN

public static final Language KOTLIN

Kotlin programming language.

See Also:

tree-sitter-kotlin

LATEX

public static final Language LATEX

LaTeX markup language for document typesetting.

See Also:

tree-sitter-latex

LUA

public static final Language LUA

Lua programming language.

See Also:

tree-sitter-lua

MARKDOWN

public static final Language MARKDOWN

Markdown markup language for creating formatted text.

See Also:

tree-sitter-markdown

NIX

public static final Language NIX

Nix programming language.

See Also:

tree-sitter-nix

OBJECTIVE_C

public static final Language OBJECTIVE_C

Objective-C programming language.

See Also:

tree-sitter-objc

OCAML

public static final Language OCAML

OCaml programming language.

See Also:

tree-sitter-ocaml

PASCAL

public static final Language PASCAL

Pascal programming language.

See Also:

tree-sitter-pascal

PHP

public static final Language PHP

PHP: Hypertext Preprocessor.

See Also:

tree-sitter-php

PYTHON

public static final Language PYTHON

Python programming language.

See Also:

tree-sitter-python

R

public static final Language R

R programming language.

See Also:

tree-sitter-r

RACKET

public static final Language RACKET

Racket programming language.

See Also:

tree-sitter-racket

RUBY

public static final Language RUBY

Ruby programming language.

See Also:

tree-sitter-ruby

RUST

public static final Language RUST

Rust programming language.

See Also:

tree-sitter-rust

SCALA

public static final Language SCALA

Scala programming language.

See Also:

tree-sitter-scala

SCHEME

public static final Language SCHEME

Scheme programming language.

See Also:

tree-sitter-scheme

SCSS

public static final Language SCSS

SCSS: Sassy CSS.

See Also:

tree-sitter-scss

SVELTE

public static final Language SVELTE

Svelte front-end component framework.

See Also:

tree-sitter-svelte

SWIFT

public static final Language SWIFT

Swift programming language.

See Also:

tree-sitter-swift

THRIFT

public static final Language THRIFT

Thrift interface description language.

See Also:

tree-sitter-thrift

TOML

public static final Language TOML

TOML: Tom's Obvious Minimal Language.

See Also:

tree-sitter-toml

TSX

public static final Language TSX

JSX-enhanced TypeScript.

See Also:

tree-sitter-typescript

TWIG

public static final Language TWIG

Twig template language.

See Also:

tree-sitter-twig

TYPESCRIPT

public static final Language TYPESCRIPT

TypeScript programming language.

See Also:

tree-sitter-typescript

VERILOG

public static final Language VERILOG

Verilog hardware description language.

See Also:

tree-sitter-verilog

XML

public static final Language XML

XML: Extensible Markup Language.

See Also:

tree-sitter-xml

YAML

public static final Language YAML

YAML: YAML Ain't Markup Language.

See Also:

tree-sitter-yaml

ZIG

public static final Language ZIG

Zig programming language.

See Also:

tree-sitter-zig

Method Detail

values

public static Language[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Language c : Language.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Language valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

validate

public static void validate(@NotNull
                            @NotNull Language language)

Validates an enum value to ensure it is not null and has a valid (nonzero) identifier.

Parameters:

language - the instance to validate

Throws:

NullPointerException - if the language is null

UnsatisfiedLinkError - if the language was not linked to native code

ABIVersionError - if the language ABI version is outdated

associatedWith

@NotNull
public static @NotNull Collection<Language> associatedWith(@NotNull
                                                           @NotNull Path path)

Selects enum values potentially associated with a file at a given path. This method checks the file's extension or name to determine the candidate language(s). Returns an empty collection if no associations can be made to a file.

Parameters:

path - location of the file whose language associations we want to determine

Returns:

An immutable collection of languages associated with the file (never null)

Throws:

NullPointerException - if path is null

IllegalArgumentException - if path is a directory

Since:

1.6.0

iterator

public LookaheadIterator iterator(int state)

Create a lookahead iterator, beginning from a specific parse state.

Parameters:

state - the parse state

Returns:

a lookahead iterator

Throws:

IllegalArgumentException - if:

• state < 0
• state ≥ totalStates

Since:

1.12.0

nextState

public int nextState(@NotNull
                     @NotNull Node node)

Obtain the next language parse state for a given Node.

Combine this with lookahead iterators to generate completion suggestions or valid symbols in ERROR nodes.

Parameters:

node - the node

Returns:

the next parse state

Throws:

NullPointerException - if node is null

IllegalArgumentException - if this language was not used to parse the node and its syntax tree

Since:

1.12.0

getTotalSymbols

@Deprecated(forRemoval=true,
            since="1.12.0")
public int getTotalSymbols()

Deprecated, for removal: This API element is subject to removal in a future version.

Just calculate the size of the list returned by symbols getter.

getTotalFields

@Deprecated(forRemoval=true,
            since="1.12.0")
public int getTotalFields()

Deprecated, for removal: This API element is subject to removal in a future version.

Just calculate the size of the list returned by fields getter.

toString

public String toString()

Overrides:

toString in class Enum<Language>

getMetadata

public Language.Metadata getMetadata()

Get the Git metadata for the language.

Returns:

the language metadata

Since:

1.11.0