Files
openide/platform/syntax/syntax-api
Mikhail Filippov 68e20d9aa8 IJPL-188202 bump Kotlin version to 2.2.0
(cherry picked from commit 4086267a8b175d5cd1fb1c0ee77b4e0ddf999524)

IJ-CR-168727

GitOrigin-RevId: 96790b1a0aa125c07767685caa008369fb7496b6
2025-07-12 00:51:47 +00:00
..

Syntax Library

IntelliJ Platform Syntax Library provides an engine for parsing files. See Syntax PSI library for more information on how to build PSI tree

Main concepts

com.intellij.platform.syntax.SyntaxElementType represents a type of a node in the syntax tree (both for leafs and composites).

com.intellij.platform.syntax.parser.SyntaxTreeBuilder allows parsing the tree. You can obtain an instance of SyntaxTreeBuilder with the help of com.intellij.platform.syntax.parser.SyntaxTreeBuilderFactory.

com.intellij.platform.syntax.parser.ProductionResultKt.prepareProduction allows to obtain the raw result of parsing.

com.intellij.platform.syntax.lexer.Lexer provides lexing functionality.

Example of usage

val builder = SyntaxTreeBuilderFactory.builder(
  text = "my file text", 
  whitespaces = setOf(SyntaxTokenTypes.WHITE_SPACE),
  comments = emptySet(),
  lexer = myLexer
)
val marker = builder.mark()
parseMyFileContent()
marker.done(type = MyLangSyntaxElementTypes.FILE)

val production = prepareProduction(builder = builder)