开源软件名称（OpenSource Name）：

开源软件地址(OpenSource Url)：

开源编程语言(OpenSource Language)：

开源软件介绍(OpenSource Introduction)：

kotlin-grammar-tools

Description

This library allows tokenize and parse Kotlin code in your program using the Kotlin grammar.

Simple example:

fun main() {
    val tokens = tokenizeKotlinCode("val x = foo() + 10;")
    val parseTree = parseKotlinCode(tokens)
    // or just `val parseTree = parseKotlinCode("val x = foo() + 10;")`

    println(parseTree)
}

Tokens or parse tree can be used for various Kotlin code analysis.

Note that the parse tree may not match exactly to PSI (parse tree generated by Kotlin compiler). This is due to the fact that some errors for the user convenience are not generated at the parser level, but later; the grammar, in turn, takes into account such cases and may not allow the code that could be parsed by the Kotlin compiler parser.

Kotlin grammar

The grammar is located in the Kotlin specification repository.

Status

The library is develped only for internal purposes of the Kotlin team, and actual state of the library isn't guaranteed.

Using

To use the library you can run the publishToMavenLocal gradle task and add mavenLocal to repositories in your program, and then add dependency from this library. For example (gradle): compile("org.jetbrains.kotlin.spec.grammar.tools:kotlin-grammar-tools:0.1").

Also, you can just download jar from Releases or TeamCity (kotlin-grammar-tools artifacts can be found on the TeamCity Kotlin grammar builds pages).

Exceptions

Lexer and parser are throwing exceptions if it has been inputted the invalid code (in terms of lexer or parser): KotlinLexerException and KotlinParserException.

Example of handling this exceptions:

fun foo(): ParseTree? {
    val tokens = try {
        tokenizeKotlinCode("val x = foo() + 10;")
    } catch (e: KotlinLexerException) {
        println("Tokenization the code fails")
        return null
    }
    val parseTree = try {
        parseKotlinCode(tokens)
    } catch (e: KotlinParserException) {
        println("Parsing the code fails")
        return null
    }

    return parseTree
}