Skip to content

Latest commit

 

History

History
84 lines (64 loc) · 3.46 KB

README.md

File metadata and controls

84 lines (64 loc) · 3.46 KB
Raw

Truffle Language Implementation Framework

Introduction

The Truffle language implementation framework (Truffle) is an open-source library for building programming language implementations as interpreters for self-modifying Abstract Syntax Trees. Together with the open-source Graal compiler, Truffle represents a significant step forward in programming language implementation technology in the current era of dynamic languages.

A growing body of shared implementation code and services reduces language implementation effort significantly, but leads to runtime performance that matches or exceeds the competition. The value of the platform is further increased by support for low-overhead language interoperability, as well as a general instrumentation framework that supports multilanguage debugging and other external developer tools.

Truffle is developed and maintained by Oracle and the Institute for System Software of the Johannes Kepler University Linz.

Using Truffle

If you are looking for documentation on how to use Truffle, please consult the documentation here or on the website.

Hacking Truffle

Truffle and the Graal compiler use the MX build tool, which needs to be installed before using this repository. To install it, run these commands in a clean directory:

$ git clone https://github.com/graalvm/mx.git/
$ mx/mx

The mx command is a wrapper around the Python script that serves as a build tool. Make sure you put it onto your PATH and then you can work with Truffle sources from a command line:

$ mx clean
$ mx build
$ mx unittest

The created ./mxbuild/dists directory contains all necessary jars and source bundles.

  • truffle-api.jar contains the framework
  • truffle-dsl-processor.jar contains the TruffleDSL annotation processor

You can open Truffle sources in your favorite Java IDE by invoking:

$ mx ideinit

The necessary IDE metadata will be generated into truffle/ subdirectory and its directories.

The mx tool supports Maven integration. To register prebuilt binaries into your local Maven repository, run:

$ mx build
$ mx maven-install

Then it is possible to add Truffle artifacts as dependencies to the Maven configuration file, pom.xml:

<dependency>
    <groupId>org.graalvm.truffle</groupId>
    <artifactId>truffle-api</artifactId>
    <version>24.0.0</version> <!-- or whether version got installed by mx maven-install -->
</dependency>
<dependency>
    <groupId>org.graalvm.truffle</groupId>
    <artifactId>truffle-dsl-processor</artifactId>
    <version>24.0.0</version>
    <scope>provided</scope>
</dependency>

Contributing

To contribute a change, verify it using:

$ mx gate

Then create a pull request. Detailed information can be found in the contributing document.

Community

To reach out to the Truffle community (as well as the wider GraalVM community) consider the information available at the GraalVM website. There is a dedicated Truffle channel (#truffle) on the GraalVM community slack.

License

The Truffle framework and the contained SimpleLanguage are licensed under the Universal Permissive License.