Package io.github.treesitter.ktreesitter.plugin

Interface GrammarExtension

public interface GrammarExtension
The grammar configuration extension.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gradle.api.provider.Property<File>
    getBaseDir()
    The base directory of the grammar.
    org.gradle.api.provider.Property<String>
    getClassName()
    The name of the class.
    org.gradle.api.provider.Property<File[]>
    getFiles()
    The source files of the grammar.
    org.gradle.api.provider.Property<String>
    getGrammarName()
    The name of the grammar.
    org.gradle.api.provider.Property<String>
    getInteropName()
    The name of the C interop def file.
    org.gradle.api.provider.MapProperty<String,String>
    getLanguageMethods()
    A map of Java methods to C functions.
    org.gradle.api.provider.Property<String>
    getLibraryName()
    The name of the JNI library.
    org.gradle.api.provider.Property<String>
    getPackageName()
    The name of the package.

  • Method Details

    • getBaseDir

      org.gradle.api.provider.Property<File> getBaseDir()
      The base directory of the grammar.

      Default: ../..

    • getGrammarName

      org.gradle.api.provider.Property<String> getGrammarName()
      The name of the grammar.

      Required

    • getFiles

      org.gradle.api.provider.Property<File[]> getFiles()
      The source files of the grammar.

      Required

    • getInteropName

      org.gradle.api.provider.Property<String> getInteropName()
      The name of the C interop def file.

      Default: grammar

    • getLibraryName

      org.gradle.api.provider.Property<String> getLibraryName()
      The name of the JNI library.

      Default: ktreesitter-${grammarName}

    • getPackageName

      org.gradle.api.provider.Property<String> getPackageName()
      The name of the package.

      Required

    • getClassName

      org.gradle.api.provider.Property<String> getClassName()
      The name of the class.

      Required

    • getLanguageMethods

      org.gradle.api.provider.MapProperty<String,String> getLanguageMethods()
      A map of Java methods to C functions.

      Default: language -> tree_sitter_${grammarName}