c/crafting-interpreters
1
Fork 0
Code Issues Releases Activity

Code Generation for Expression trees

Browse Source 
- Ditched Gradle because I couldn't get annotation processing to work,
  switched to maven instead
This commit is contained in:
ctsk
2022-09-06 17:34:55 +02:00
parent 3857580ff0
commit e68f0edc1c
19 changed files with 242 additions and 366 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
flake.nix
View File

@@ -14,12 +14,14 @@
gcc = pkgs.gcc;
openjdk = pkgs.openjdk;
maven = pkgs.maven;
in
{
devShell = pkgs.mkShell {
buildInputs = [
gcc
openjdk
maven
];
};
}

2
jlox/.gitignore vendored
View File

@@ -4,6 +4,8 @@ build/
!**/src/main/**/build/
!**/src/test/**/build/
*/target/
### IntelliJ IDEA ###
.idea/modules.xml
.idea/jarRepositories.xml

34
jlox/build.gradle.kts
View File

@@ -1,34 +0,0 @@
plugins {
id("application")
}
group = "xyz.ctsk"
version = "1.0-SNAPSHOT"
repositories {
mavenCentral()
}
dependencies {
testImplementation("org.junit.jupiter:junit-jupiter-api:5.9.0")
testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.9.0")
}
application {
mainClass.set("xyz.ctsk.lox.Lox")
}
tasks.jar {
manifest {
attributes(mapOf("Main-Class" to "xyz.ctsk.lox.Lox"))
}
}
tasks.getByName<Test>("test") {
useJUnitPlatform()
}
tasks.named<JavaExec>("run") {
standardInput = System.`in`
}

BIN
jlox/gradle/wrapper/gradle-wrapper.jar vendored
View File

Binary file not shown.

5
jlox/gradle/wrapper/gradle-wrapper.properties vendored
View File

@@ -1,5 +0,0 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

234
jlox/gradlew vendored
View File

@@ -1,234 +0,0 @@
#!/bin/sh
#
# Copyright © 2015-2021 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
##############################################################################
#
# Gradle start up script for POSIX generated by Gradle.
#
# Important for running:
#
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
# noncompliant, but you have some other compliant shell such as ksh or
# bash, then to run this script, type that shell name before the whole
# command line, like:
#
# ksh Gradle
#
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
# * compound commands having a testable exit status, especially «case»;
# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
# (2) This script targets any POSIX shell, so it avoids extensions provided
# by Bash, Ksh, etc; in particular arrays are avoided.
#
# The "traditional" practice of packing multiple parameters into a
# space-separated string is a well documented source of bugs and security
# problems, so this is (mostly) avoided, by progressively accumulating
# options in "$@", and eventually passing that to Java.
#
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
# see the in-line comments for details.
#
# There are tweaks for specific operating systems such as AIX, CygWin,
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
#
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
app_path=$0
# Need this for daisy-chained symlinks.
while
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
[ -h "$app_path" ]
do
ls=$( ls -ld "$app_path" )
link=${ls#*' -> '}
case $link in #(
/*) app_path=$link ;; #(
*) app_path=$APP_HOME$link ;;
esac
done
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
APP_NAME="Gradle"
APP_BASE_NAME=${0##*/}
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
warn () {
echo "$*"
} >&2
die () {
echo
echo "$*"
echo
exit 1
} >&2
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "$( uname )" in #(
CYGWIN* ) cygwin=true ;; #(
Darwin* ) darwin=true ;; #(
MSYS* | MINGW* ) msys=true ;; #(
NONSTOP* ) nonstop=true ;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD=$JAVA_HOME/jre/sh/java
else
JAVACMD=$JAVA_HOME/bin/java
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD=java
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
fi
# Collect all arguments for the java command, stacking in reverse order:
# * args from the command line
# * the main class name
# * -classpath
# * -D...appname settings
# * --module-path (only if needed)
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
JAVACMD=$( cygpath --unix "$JAVACMD" )
# Now convert the arguments - kludge to limit ourselves to /bin/sh
for arg do
if
case $arg in #(
-*) false ;; # don't mess with options #(
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
[ -e "$t" ] ;; #(
*) false ;;
esac
then
arg=$( cygpath --path --ignore --mixed "$arg" )
fi
# Roll the args list around exactly as many times as the number of
# args, so each arg winds up back in the position where it started, but
# possibly modified.
#
# NB: a `for` loop captures its iteration list before it begins, so
# changing the positional parameters here affects neither the number of
# iterations, nor the values presented in `arg`.
shift # remove old arg
set -- "$@" "$arg" # push replacement arg
done
fi
# Collect all arguments for the java command;
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
# shell script including quotes and variable substitutions, so put them in
# double quotes to make sure that they get re-expanded; and
# * put everything else in single quotes, so that it's not re-expanded.
set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-classpath "$CLASSPATH" \
org.gradle.wrapper.GradleWrapperMain \
"$@"
# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
# set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#
eval "set -- $(
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
xargs -n1 |
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
tr '\n' ' '
)" '"$@"'
exec "$JAVACMD" "$@"

89
jlox/gradlew.bat vendored
View File

@@ -1,89 +0,0 @@
@rem
@rem Copyright 2015 the original author or authors.
@rem
@rem Licensed under the Apache License, Version 2.0 (the "License");
@rem you may not use this file except in compliance with the License.
@rem You may obtain a copy of the License at
@rem
@rem https://www.apache.org/licenses/LICENSE-2.0
@rem
@rem Unless required by applicable law or agreed to in writing, software
@rem distributed under the License is distributed on an "AS IS" BASIS,
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto execute
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto execute
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

30
jlox/lox/pom.xml Normal file
View File

@@ -0,0 +1,30 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>xyz.ctsk.lox</groupId>
<artifactId>lox</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>
<artifactId>interpreter</artifactId>
<packaging>jar</packaging>
<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>xyz.ctsk.lox</groupId>
<artifactId>tools</artifactId>
<version>1.0-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
</dependencies>
</project>

0
jlox/src/main/java/xyz/ctsk/lox/Lox.java → jlox/lox/src/main/java/xyz/ctsk/lox/Lox.java
View File

1
jlox/src/main/java/xyz/ctsk/lox/Scanner.java → jlox/lox/src/main/java/xyz/ctsk/lox/Scanner.java
View File

@@ -3,7 +3,6 @@ package xyz.ctsk.lox;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import static java.util.Map.entry;
import static xyz.ctsk.lox.TokenType.*;

0
jlox/src/main/java/xyz/ctsk/lox/Token.java → jlox/lox/src/main/java/xyz/ctsk/lox/Token.java
View File

0
jlox/src/main/java/xyz/ctsk/lox/TokenType.java → jlox/lox/src/main/java/xyz/ctsk/lox/TokenType.java
View File

15
jlox/lox/src/main/java/xyz/ctsk/lox/package-info.java Normal file
View File

@@ -0,0 +1,15 @@
@Grammar({
@Root(name = "Expr",
rules = {
@Rule(head = "Binary", body = {"Expr left", "Token operator", "Expr right"}),
@Rule(head = "Grouping", body = {"Expr expression"}),
@Rule(head = "Literal", body = {"Object value"}),
@Rule(head = "Unary", body = {"Token operator", "Expr right"})
})
})
package xyz.ctsk.lox;
import xyz.ctsk.lox.codegen.Grammar;
import static xyz.ctsk.lox.codegen.Grammar.Rule;
import static xyz.ctsk.lox.codegen.Grammar.Root;

20
jlox/pom.xml Normal file
View File

@@ -0,0 +1,20 @@
<project xmlns="http://maven.apache.org/POM/4.0.0">
<modelVersion>4.0.0</modelVersion>
<groupId>xyz.ctsk.lox</groupId>
<artifactId>lox</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>pom</packaging>
<modules>
<module>tools</module>
<module>lox</module>
</modules>
<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
</project>

2
jlox/settings.gradle.kts
View File

@@ -1,2 +0,0 @@
rootProject.name = "jlox"

34
jlox/tools/pom.xml Normal file
View File

@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>xyz.ctsk.lox</groupId>
<artifactId>lox</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>
<artifactId>tools</artifactId>
<packaging>jar</packaging>
<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.10.1</version>
<configuration>
<compilerArgument>-proc:none</compilerArgument>
</configuration>
</plugin>
</plugins>
</build>
</project>

19
jlox/tools/src/main/java/xyz/ctsk/lox/codegen/Grammar.java Normal file
View File

@@ -0,0 +1,19 @@
package xyz.ctsk.lox.codegen;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@Retention(RetentionPolicy.SOURCE)
public @interface Grammar {
Root[] value();
@interface Root {
String name();
Rule[] rules();
}
@interface Rule {
String head();
String[] body();
}
}

118
jlox/tools/src/main/java/xyz/ctsk/lox/codegen/GrammarProcessor.java Normal file
View File

@@ -0,0 +1,118 @@
package xyz.ctsk.lox.codegen;
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.RoundEnvironment;
import javax.annotation.processing.SupportedAnnotationTypes;
import javax.lang.model.element.Element;
import javax.lang.model.element.Name;
import javax.lang.model.element.PackageElement;
import javax.lang.model.element.TypeElement;
import javax.tools.Diagnostic;
import java.io.IOException;
import java.io.Writer;
import java.util.Set;
import static xyz.ctsk.lox.codegen.Grammar.Rule;
import static xyz.ctsk.lox.codegen.Grammar.Root;
@SupportedAnnotationTypes(
"xyz.ctsk.lox.codegen.Grammar"
)
public class GrammarProcessor extends AbstractProcessor {
private static final int INDENT = 4;
private String getVisitorName(String className, String parentName) {
return "visit%s%s".formatted(className, parentName);
}
@SuppressWarnings("SameParameterValue")
private void writeVisitor(Rule[] rules, String parentName, Writer writer, int indent) throws IOException {
writer.write("""
interface Visitor<R> {
""".indent(indent));
for (var rule : rules) {
var visitorName = getVisitorName(rule.head(), parentName);
var parameter = "%s %s".formatted(rule.head(), rule.head().toLowerCase());
writer.write("""
R %s(%s);
""".formatted(visitorName, parameter).indent(indent + INDENT));
}
writer.write("""
}
""".indent(indent));
}
@SuppressWarnings("SameParameterValue")
private void processRule(Rule rule, String parentBaseName, Writer writer, int indent) throws IOException {
var fields = String.join(", ", rule.body());
var recordName = rule.head();
var visitorName = getVisitorName(recordName, parentBaseName);
writer.write("""
record %s(%s) implements %s {
@Override
public <R> R accept(Visitor<R> visitor) {
return visitor.%s(this);
}
}
""".formatted(recordName, fields, parentBaseName, visitorName).indent(indent));
}
private void processRoot(Root root, Name packageName) {
var baseName = root.name();
var qualifiedName = "%s.%s".formatted(packageName, baseName);
try {
var file = processingEnv.getFiler().createSourceFile(qualifiedName);
try (var writer = file.openWriter()) {
writer.write("""
package %s;
interface %s {
""".formatted(packageName, baseName)
);
writeVisitor(root.rules(), baseName, writer, INDENT);
writer.write("""
<R> R accept(Visitor<R> visitor);
"""
);
for (var rule : root.rules()) {
processRule(rule, baseName, writer, INDENT);
}
writer.write("""
}
""");
}
} catch (IOException e) {
throw new RuntimeException(e);
}
}
private void processGrammar(Element element) {
if (element instanceof PackageElement packageElement) {
for (var root : element.getAnnotation(Grammar.class).value()) {
processRoot(root, packageElement.getQualifiedName());
}
} else {
processingEnv.getMessager()
.printMessage(Diagnostic.Kind.ERROR, "@Grammar annotation can only be applied to a package");
}
}
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
for (var annotation : annotations) {
roundEnv.getElementsAnnotatedWith(annotation)
.forEach(this::processGrammar);
}
return true;
}
}

1
jlox/tools/src/main/resources/META-INF/services/javax.annotation.processing.Processor Normal file
View File

@@ -0,0 +1 @@
xyz.ctsk.lox.codegen.GrammarProcessor