diff --git a/.gitignore b/.gitignore index 7be691a9fdda6f1bd2c0b8d60d66f7f481e44ddf..017dc80de5bc43f8d3ff4db2e8a40fc311a532a4 100644 --- a/.gitignore +++ b/.gitignore @@ -13,4 +13,3 @@ src/test/jastadd/*/*.ast src/test/jastadd/*/*.jadd src/test/jastadd/*/*ResolverStubs.jrag !src/test/jastadd/*/MyRefResolver.jadd -/gradle.properties diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 4884f2220ab10392bd45d6ed532d7ae536ffcca0..8a37876249b513e66993553cde15e5e4a7023972 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -15,7 +15,7 @@ build: image: openjdk:8 stage: build script: - - ./gradlew --console=plain --no-daemon assemble jar + - ./gradlew --console=plain --no-daemon assemble fatJar artifacts: paths: - "/builds/jastadd/relational-rags/build/libs/relast-*.jar" @@ -36,5 +36,28 @@ pages: paths: - public only: - - master + - master + - main +publish: + image: openjdk:8 + stage: deploy + needs: + - test + script: + - "./gradlew publish" + only: + - master + - main + +publish_dev: + image: openjdk:8 + stage: deploy + needs: + - test + script: + - "./gradlew setDevVersionForCI" + - "./gradlew publish" + except: + - master + - main diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 46997637b262d0b2c2696a43154fc008f4afa3b5..8a44f97d5c135c9262f166256036043ad49748be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,33 +23,27 @@ This location can be [configured](#build-configuration). ## Build configuration -Currently, the test setup is configured within `build.gradle` using a specialized Gradle task `RelastTest`. +Currently, the test setup is configured within `build.gradle` using a specialized Gradle task `RelastTest` provided by the [preprocessor testing Gradle plugin][preprocessor-testing]. An example configuration might look like: ```groovy task compileMultipleTest(type: RelastTest) { - relastFiles 'src/test/jastadd/multiple/Part1.relast', - 'src/test/jastadd/multiple/Part2.relast', - 'src/test/jastadd/multiple/Part3.relast' - grammarName = 'src/test/jastadd/multiple/Multiple' - useJastAddNames = true - packageName = 'multiple.ast' - moreInputFiles 'src/test/jastadd/Utils.jadd' + relast { + inputFiles = [file('src/test/jastadd/multiple/Part1.relast'), + file('src/test/jastadd/multiple/Part2.relast'), + file('src/test/jastadd/multiple/Part3.relast')] + grammarName = 'src/test/jastadd/multiple/Multiple' + useJastAddNames = true + noResolverHelper = true + } + jastadd { + packageName = 'multiple.ast' + inputFiles = [file('src/test/jastadd/Utils.jadd')] + } } ``` -The following options are supported, similar to the [command-line options](/../#supported-command-line-options): - -| Name | Description | Required | Default | -|-------------------|--------------------------------------------------------------------------------------------------------|--------------------|---------------------| -| `relastFiles` | Input grammar(s). Either one or multiple files separated by comma. | Yes | _none_ | -| `grammarName` | Directory and file prefix for the generated grammar and jrag created by RelAST. | Yes | _none_ | -| `useJastAddNames` | Set to `true` to use accessor names for relations matching JastAdd naming convention. | No | `false` | -| `packageName` | Name of the package for the Java files generated by JastAdd. | Yes (not enforced) | The empty package | -| `moreInputFiles` | Additional files as input for JastAdd. | No | No additional files | -| `resolverHelper` | Set to `true` to generate means for lazy resolving. | No | `false` | -| `jastAddList` | Alternative name for `List` nodes. Will be passed to both RelAST and JastAdd. | No | `List` | -| `serializer` | Name of supported serializer. One of {`jackson`, `jackson-json-pointer`, `jackson-manual-references`}. | No | No serializer | +Please see the [documentation of the plugin][preprocessor-testing] for all options. ## Test files @@ -106,3 +100,4 @@ The workflow: [semantic-versioning]: https://semver.org/ [create-release]: /../-/tags/new [create-issue]: https://git-st.inf.tu-dresden.de/jastadd/relational-rags/issues/new +[preprocessor-testing]: https://jastadd.pages.st.inf.tu-dresden.de/testing/ diff --git a/README.md b/README.md index b49c377f9290f661896b992cc1d363d9334d0053..f034b04e8263eeb6065b4e30fb1da197a903219b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@  -See [releases page](/../../releases) for the latest version. +See [releases page](/../../releases) for the latest version and <https://jastadd.pages.st.inf.tu-dresden.de/relational-rags/> for more documentation. The RelAST preprocessor takes a `.relast` file as input comprising AST rules and relations. It produces files that afterwards are processed by JastAdd to generated Java code. To use it in your project, build the JAR file running @@ -52,21 +52,23 @@ Note that you may have to change ## Supported relations - // Directed relations - A.b -> B; - A.b? -> B; - A.bs* -> B; - B <- A.b ; - B <- A.b? ; - B <- A.bs*; +``` +// Directed relations +A.b -> B; +A.b? -> B; +A.bs* -> B; +B <- A.b ; +B <- A.b? ; +B <- A.bs*; - // Bidirectional relations - A.b <-> B.a; - A.b <-> B.a?; - A.b <-> B.as*; - A.b? <-> B.a; - A.b? <-> B.a?; - A.b? <-> B.as*; - A.bs* <-> B.a; - A.bs* <-> B.a?; - A.bs* <-> B.as*; +// Bidirectional relations +A.b <-> B.a; +A.b <-> B.a?; +A.b <-> B.as*; +A.b? <-> B.a; +A.b? <-> B.a?; +A.b? <-> B.as*; +A.bs* <-> B.a; +A.bs* <-> B.a?; +A.bs* <-> B.as*; +``` diff --git a/build.gradle b/build.gradle index 12190cc26ee02a10d14db6e3f93dcfe27d1534f5..1fafdb14e6010af678a0ab9e8d42c0d564e63428 100644 --- a/build.gradle +++ b/build.gradle @@ -1,58 +1,71 @@ -import org.jastadd.relast.plugin.RelastTest +buildscript { + repositories { + maven { + name "gitlab-maven" + url "https://git-st.inf.tu-dresden.de/api/v4/groups/jastadd/-/packages/maven" + } + } + dependencies { + classpath 'org.jastadd.preprocessor:testing:0.2.14-32' + } +} -apply plugin: "com.github.ben-manes.versions" -apply plugin: 'java' -apply plugin: 'java-library' -apply plugin: 'jastadd' -apply plugin: 'application' -apply plugin: "idea" -apply plugin: "org.jastadd.relast.plugin" +import org.jastadd.preprocessor.testing.plugin.PreprocessorPlugin +import org.jastadd.preprocessor.testing.plugin.RelastTest + +//file:noinspection HardCodedStringLiteral +plugins { + id 'java' + id 'java-library' + id 'application' + id 'idea' + id 'maven-publish' + id 'org.jastadd' version '1.14.5' +} -sourceCompatibility = 1.8 +apply plugin: PreprocessorPlugin -mainClassName = 'org.jastadd.relast.compiler.Compiler' +java.toolchain.languageVersion = JavaLanguageVersion.of(8) -repositories { - jcenter() +ext { + mainClassName = 'org.jastadd.relast.compiler.Compiler' } -group = 'org.jastadd' -apply plugin: 'maven-publish' - -buildscript { - repositories.jcenter() - dependencies { - classpath 'org.jastadd:jastaddgradle:1.13.3' - classpath "com.github.ben-manes:gradle-versions-plugin:0.34.0" +repositories { + mavenCentral() + maven { + name 'gitlab-maven' + url 'https://git-st.inf.tu-dresden.de/api/v4/groups/jastadd/-/packages/maven' } } -dependencyUpdates.gradleReleaseChannel="current" -dependencyUpdates.revision="release" +group = 'org.jastadd' + +// set the main class name for `gradle run` +application.mainClass = "${mainClassName}" dependencies { - testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.0' - testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.0' - testImplementation 'org.assertj:assertj-core:3.18.0' - testImplementation 'com.fasterxml.jackson.core:jackson-core:2.11.3' - testImplementation 'com.fasterxml.jackson.core:jackson-databind:2.11.3' - implementation group: 'org.jastadd', name: 'jastadd', version: '2.3.4' - api group: 'net.sf.beaver', name: 'beaver-rt', version: '0.9.11' + testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.2' + testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.2' + testImplementation 'org.assertj:assertj-core:3.22.0' + testImplementation 'com.fasterxml.jackson.core:jackson-core:2.13.1' + testImplementation 'com.fasterxml.jackson.core:jackson-databind:2.13.1' + api 'org.jastadd:jastadd:2.3.5' + api 'net.sf.beaver:beaver-rt:0.9.11' } -File genSrc = file("src/gen/java") -File testGenSrc = file("src/test/java-gen") +File genSrc = file('src/gen/java') +File testGenSrc = file('src/test/java-gen') sourceSets.main.java.srcDir genSrc -sourceSets.main.java.srcDir "buildSrc/gen/java" sourceSets.test.java.srcDir testGenSrc idea.module.generatedSourceDirs += genSrc idea.module.generatedSourceDirs += testGenSrc def versionFile = 'src/main/resources/RelASTVersion.properties' -def oldProps = new Properties() try { + def oldProps = new Properties() file(versionFile).withInputStream { stream -> oldProps.load(stream) } version = oldProps['version'] } catch (ignored) { @@ -68,110 +81,129 @@ task newVersion() { } } -jar { - manifest { - attributes "Main-Class": 'org.jastadd.relast.compiler.Compiler' +task printVersion() { + doLast { + println(version) } +} - from { - configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) } +task setDevVersionForCI() { + doFirst { + def props = new Properties() + props['version'] = version + "-$System.env.CI_PIPELINE_IID" + props.store(file(versionFile).newWriter(), null) } +} + +jar.archiveBaseName = 'relast' +task fatJar(type: Jar) { + dependsOn jar + group = "build" archiveBaseName = 'relast' + archiveAppendix = "fatjar" + from sourceSets.main.output + from { + configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) } + } + manifest { + attributes "Main-Class": "${mainClassName}" + } } jastadd { configureModuleBuild() modules { //noinspection GroovyAssignabilityCheck - module("RelAst") { - - java { - basedir "." - include "src/main/**/*.java" - include "src/gen/**/*.java" - } + module('RelAst') { jastadd { - basedir "src/main/jastadd/" - include "**/*.ast" - include "**/*.jadd" - include "**/*.jrag" + basedir 'src/main/jastadd/' + include '**/*.ast' + include '**/*.jadd' + include '**/*.jrag' } scanner { - include "src/main/jastadd/RelAst.flex" + include 'src/main/jastadd/RelAst.flex' } parser { - include "src/main/jastadd/Preamble.parser" - include "src/main/jastadd/RelAst.parser" + include 'src/main/jastadd/Preamble.parser' + include 'src/main/jastadd/RelAst.parser' } } } cleanGen.doFirst { - delete "src/gen/java/org" - delete "src/gen-res/BuildInfo.properties" + delete 'src/gen/' + delete 'src/gen-res/' } preprocessParser.doFirst { - args += ["--no-beaver-symbol"] - } - module = "RelAst" - + module = 'RelAst' astPackage = 'org.jastadd.relast.ast' - parser.name = 'RelAstParser' - genDir = 'src/gen/java' - buildInfoDir = 'src/gen-res' + scanner.genDir = 'src/gen/java/org/jastadd/relast/scanner' + parser.genDir = 'src/gen/java/org/jastadd/relast/parser' - scanner.genDir = "src/gen/java/org/jastadd/relast/scanner" - parser.genDir = "src/gen/java/org/jastadd/relast/parser" - - jastaddOptions = ["--lineColumnNumbers", "--safeLazy", "--visitCheck=true", "--rewrite=cnta", "--cache=all"] + // default options are: ['--rewrite=cnta', '--safeLazy', '--visitCheck=false', '--cacheCycle=false'] + extraJastAddOptions = ['--lineColumnNumbers', '--visitCheck=true'] } +// publish gitlab project publishing { publications { maven(MavenPublication) { - artifact("build/libs/relast-${version}.jar") { - extension 'jar' - } + artifactId = 'relast' + from components.java } } repositories { maven { - name 'nexus' - url "http://172.22.1.152:8081/repository/" + (project.hasProperty('asSnapshot') ? "maven-snapshots" : "maven-releases/") - credentials { - username project.ext.properties.repoUser - password project.ext.properties.repoPassword + url "https://git-st.inf.tu-dresden.de/api/v4/projects/$System.env.CI_PROJECT_ID/packages/maven" + credentials(HttpHeaderCredentials) { + name = 'Job-Token' + value = System.getenv('CI_JOB_TOKEN') + } + authentication { + header(HttpHeaderAuthentication) } } + } } -publish.dependsOn jar - task firstRelationsRun(type: RelastTest) { - relastFiles 'src/test/jastadd/relations/Relations.relast' - grammarName = 'src/test/jastadd/relations/Relations' - useJastAddNames = true - packageName = 'relations.ast' - moreInputFiles 'src/test/jastadd/Utils.jadd', 'src/test/jastadd/relations/Relations.jrag' + relast { + inputFiles = [file('src/test/jastadd/relations/Relations.relast')] + grammarName = 'src/test/jastadd/relations/Relations' + useJastAddNames = true + noResolverHelper = true + } + jastadd { + packageName = 'relations.ast' + inputFiles = [file('src/test/jastadd/Utils.jadd'), + file('src/test/jastadd/relations/Relations.jrag')] + } } task secondRelationsRun(type: RelastTest, dependsOn: firstRelationsRun) { - relastFiles 'src/test/jastadd/relations/Relations.ast' - grammarName = 'src/test/jastadd/relations/Relations2' - useJastAddNames = true - packageName = 'ignored' + relast { + inputFiles = [file('src/test/jastadd/relations/Relations.ast')] + grammarName = 'src/test/jastadd/relations/Relations2' + useJastAddNames = true + noResolverHelper = true + } + jastadd { + skipRun = true + packageName = 'ignored' + } doLast { delete fileTree('src/test/java-gen/ignored') @@ -180,131 +212,198 @@ task secondRelationsRun(type: RelastTest, dependsOn: firstRelationsRun) { } task compileConstructorTest(type: RelastTest) { - relastFiles 'src/test/jastadd/constructors/Constructors.relast' - grammarName = 'src/test/jastadd/constructors/Constructors' - packageName = 'constructors.ast' - moreInputFiles 'src/test/jastadd/constructors/Constructors.jrag' + relast { + inputFiles = [file('src/test/jastadd/constructors/Constructors.relast')] + grammarName = 'src/test/jastadd/constructors/Constructors' + noResolverHelper = true + } + jastadd { + packageName = 'constructors.ast' + inputFiles = [file('src/test/jastadd/constructors/Constructors.jrag')] + } } task compileDefaultNamesTest(type: RelastTest) { - relastFiles 'src/test/jastadd/relations/Relations.relast' - grammarName = 'src/test/jastadd/relations/Relations3' - packageName = 'defaultnames.ast' - moreInputFiles 'src/test/jastadd/Utils.jadd', 'src/test/jastadd/relations/Relations.jrag' + relast { + inputFiles = [file('src/test/jastadd/relations/Relations.relast')] + grammarName = 'src/test/jastadd/relations/Relations3' + useJastAddNames = false + noResolverHelper = true + } + jastadd { + packageName = 'defaultnames.ast' + inputFiles = [file('src/test/jastadd/Utils.jadd'), + file('src/test/jastadd/relations/Relations.jrag')] + } } task compileDefaultNamesResolverTest(type: RelastTest) { - relastFiles 'src/test/jastadd/resolver/Resolver.relast' - grammarName = 'src/test/jastadd/resolver/Resolver2' - resolverHelper = true - packageName = 'defaultnames.resolver.ast' - moreInputFiles 'src/test/jastadd/Utils.jadd', - 'src/test/jastadd/resolver/ResolverUtils.jadd', - 'src/test/jastadd/resolver/MyRefResolver.jadd' + relast { + inputFiles = [file('src/test/jastadd/resolver/Resolver.relast')] + grammarName = 'src/test/jastadd/resolver/Resolver2' + useJastAddNames = false + } + jastadd { + packageName = 'defaultnames.resolver.ast' + inputFiles = [file('src/test/jastadd/Utils.jadd'), + file('src/test/jastadd/resolver/ResolverUtils.jadd'), + file('src/test/jastadd/resolver/MyRefResolver.jadd')] + } } task compileLowerBoundsTest(type: RelastTest) { - relastFiles 'src/test/jastadd/lowerbounds/LowerBounds.relast' - grammarName = 'src/test/jastadd/lowerbounds/LowerBounds' - useJastAddNames = true - packageName = 'lowerbounds.ast' - moreInputFiles 'src/test/jastadd/Utils.jadd' + relast { + inputFiles = [file('src/test/jastadd/lowerbounds/LowerBounds.relast')] + grammarName = 'src/test/jastadd/lowerbounds/LowerBounds' + useJastAddNames = true + noResolverHelper = true + } + jastadd { + packageName = 'lowerbounds.ast' + inputFiles = [file('src/test/jastadd/Utils.jadd')] + } } task compileMultipleTest(type: RelastTest) { - relastFiles 'src/test/jastadd/multiple/Part1.relast', - 'src/test/jastadd/multiple/Part2.relast', - 'src/test/jastadd/multiple/Part3.relast' - grammarName = 'src/test/jastadd/multiple/Multiple' - useJastAddNames = true - packageName = 'multiple.ast' - moreInputFiles 'src/test/jastadd/Utils.jadd' + relast { + inputFiles = [file('src/test/jastadd/multiple/Part1.relast'), + file('src/test/jastadd/multiple/Part2.relast'), + file('src/test/jastadd/multiple/Part3.relast')] + grammarName = 'src/test/jastadd/multiple/Multiple' + useJastAddNames = true + noResolverHelper = true + } + jastadd { + packageName = 'multiple.ast' + inputFiles = [file('src/test/jastadd/Utils.jadd')] + } } task compileMultipleMixedTest(type: RelastTest) { - relastFiles 'src/test/jastadd/multiple-mixed/Part1.relast', - 'src/test/jastadd/multiple-mixed/Part2.relast', - 'src/test/jastadd/multiple-mixed/Part3.relast' - grammarName = 'src/test/jastadd/multiple/Multiple' - useJastAddNames = true - packageName = 'mixed.multiple.ast' - moreInputFiles 'src/test/jastadd/Utils.jadd' + relast { + inputFiles = [file('src/test/jastadd/multiple-mixed/Part1.relast'), + file('src/test/jastadd/multiple-mixed/Part2.relast'), + file('src/test/jastadd/multiple-mixed/Part3.relast')] + grammarName = 'src/test/jastadd/multiple/Multiple' + useJastAddNames = true + noResolverHelper = true + } + jastadd { + packageName = 'mixed.multiple.ast' + inputFiles = [file('src/test/jastadd/Utils.jadd')] + } } task compileResolverTest(type: RelastTest) { - relastFiles 'src/test/jastadd/resolver/Resolver.relast' - grammarName = 'src/test/jastadd/resolver/Resolver' - useJastAddNames = true - resolverHelper = true - packageName = 'resolver.ast' - moreInputFiles 'src/test/jastadd/Utils.jadd', - 'src/test/jastadd/resolver/ResolverUtils.jadd', - 'src/test/jastadd/resolver/MyRefResolver.jadd' + relast { + inputFiles = [file('src/test/jastadd/resolver/Resolver.relast')] + grammarName = 'src/test/jastadd/resolver/Resolver' + useJastAddNames = true + } + jastadd { + packageName = 'resolver.ast' + inputFiles = [file('src/test/jastadd/Utils.jadd'), + file('src/test/jastadd/resolver/ResolverUtils.jadd'), + file('src/test/jastadd/resolver/MyRefResolver.jadd')] + } } task compileResolver2Test(type: RelastTest) { - relastFiles 'src/test/jastadd/resolver2/Resolver.relast' - grammarName = 'src/test/jastadd/resolver2/Resolver' - useJastAddNames = true - resolverHelper = true - packageName = 'resolver2.ast' - moreInputFiles 'src/test/jastadd/Utils.jadd', - 'src/test/jastadd/resolver2/ResolverUtils.jadd', - 'src/test/jastadd/resolver2/MyRefResolver.jadd' + relast { + inputFiles = [file('src/test/jastadd/resolver2/Resolver.relast')] + grammarName = 'src/test/jastadd/resolver2/Resolver' + useJastAddNames = true + } + jastadd { + packageName = 'resolver2.ast' + inputFiles = [file('src/test/jastadd/Utils.jadd'), + file('src/test/jastadd/resolver2/ResolverUtils.jadd'), + file('src/test/jastadd/resolver2/MyRefResolver.jadd')] + } } task compileListNamesTest(type: RelastTest) { - relastFiles 'src/test/jastadd/listnames/ListNames.relast' - grammarName = 'src/test/jastadd/listnames/ListNames' - useJastAddNames = true - jastAddList = 'ListyMcListface' - listClass = 'java.util.LinkedList' - packageName = 'listnames.ast' - moreInputFiles 'src/test/jastadd/Utils.jadd' + relast { + inputFiles = [file('src/test/jastadd/listnames/ListNames.relast')] + grammarName = 'src/test/jastadd/listnames/ListNames' + useJastAddNames = true + noResolverHelper = true + listClass = 'java.util.LinkedList' + } + jastadd { + jastAddList = 'ListyMcListface' + packageName = 'listnames.ast' + inputFiles = [file('src/test/jastadd/Utils.jadd')] + } } task compileSerializerTest(type: RelastTest) { - relastFiles 'src/test/jastadd/serializer/Serializer.relast' - grammarName = 'src/test/jastadd/serializer/Serializer' - useJastAddNames = true - serializer = 'jackson' - packageName = 'serializer.ast' - moreInputFiles 'src/test/jastadd/Utils.jadd' + relast { + inputFiles = [file('src/test/jastadd/serializer/Serializer.relast')] + grammarName = 'src/test/jastadd/serializer/Serializer' + useJastAddNames = true + serializer = 'jackson' + noResolverHelper = true + } + jastadd { + packageName = 'serializer.ast' + inputFiles = [file('src/test/jastadd/Utils.jadd')] + } } task compileSerializerDefaultNamesTest(type: RelastTest) { - relastFiles 'src/test/jastadd/serializer-names/Serializer.relast' - grammarName = 'src/test/jastadd/serializer-names/Serializer' - serializer = 'jackson' - packageName = 'defaultnames.serializer.ast' - moreInputFiles 'src/test/jastadd/Utils.jadd' + relast { + inputFiles = [file('src/test/jastadd/serializer-names/Serializer.relast')] + grammarName = 'src/test/jastadd/serializer-names/Serializer' + serializer = 'jackson' + useJastAddNames = false + noResolverHelper = true + } + jastadd { + packageName = 'defaultnames.serializer.ast' + inputFiles = [file('src/test/jastadd/Utils.jadd')] + } } task compileSerializerPointerTest(type: RelastTest) { - resolverHelper = true - relastFiles 'src/test/jastadd/serializer-pointer/Serializer.relast' - grammarName = 'src/test/jastadd/serializer-pointer/Serializer' - serializer = 'jackson-json-pointer' - packageName = 'pointer.serializer.ast' - moreInputFiles 'src/test/jastadd/Utils.jadd' + relast { + inputFiles = [file('src/test/jastadd/serializer-pointer/Serializer.relast')] + grammarName = 'src/test/jastadd/serializer-pointer/Serializer' + serializer = 'jackson-json-pointer' + useJastAddNames = false + } + jastadd { + packageName = 'pointer.serializer.ast' + inputFiles = [file('src/test/jastadd/Utils.jadd')] + } } task compileSerializerManualTest(type: RelastTest) { - resolverHelper = true - relastFiles 'src/test/jastadd/serializer-manual/Serializer.relast' - grammarName = 'src/test/jastadd/serializer-manual/Serializer' - serializer = 'jackson-manual-references' - packageName = 'manual.serializer.ast' - moreInputFiles 'src/test/jastadd/Utils.jadd', 'src/test/jastadd/serializer-manual/JsonPointer.jrag' + relast { + inputFiles = [file('src/test/jastadd/serializer-manual/Serializer.relast')] + grammarName = 'src/test/jastadd/serializer-manual/Serializer' + serializer = 'jackson-manual-references' + useJastAddNames = false + } + jastadd { + packageName = 'manual.serializer.ast' + inputFiles = [file('src/test/jastadd/Utils.jadd'), + file('src/test/jastadd/serializer-manual/JsonPointer.jrag')] + } } task compileSerializerManualRelativeTest(type: RelastTest) { - resolverHelper = true - relastFiles 'src/test/jastadd/serializer-manual-relative/Serializer.relast' - grammarName = 'src/test/jastadd/serializer-manual-relative/Serializer' - serializer = 'jackson-manual-references' - packageName = 'manual.relative.serializer.ast' - moreInputFiles 'src/test/jastadd/Utils.jadd', 'src/test/jastadd/serializer-manual-relative/JsonPointer.jrag' + relast { + inputFiles = [file('src/test/jastadd/serializer-manual-relative/Serializer.relast')] + grammarName = 'src/test/jastadd/serializer-manual-relative/Serializer' + serializer = 'jackson-manual-references' + useJastAddNames = false + } + jastadd { + packageName = 'manual.relative.serializer.ast' + inputFiles = [file('src/test/jastadd/Utils.jadd'), + file('src/test/jastadd/serializer-manual-relative/JsonPointer.jrag')] + } } task cleanTestGen(type: Delete) { diff --git a/buildSrc/src/main/java/org/jastadd/relast/plugin/RelastPlugin.java b/buildSrc/src/main/java/org/jastadd/relast/plugin/RelastPlugin.java deleted file mode 100644 index 392c2e03c57c3d5235770b4dadc402504ef9cb5f..0000000000000000000000000000000000000000 --- a/buildSrc/src/main/java/org/jastadd/relast/plugin/RelastPlugin.java +++ /dev/null @@ -1,33 +0,0 @@ -package org.jastadd.relast.plugin; - -import org.gradle.api.Plugin; -import org.gradle.api.Project; -import org.gradle.api.Task; -import org.gradle.api.tasks.TaskCollection; - -import java.util.Set; - -/** - * Plugin for RelAst-Test. - * - * @author rschoene - Initial contribution - */ -public class RelastPlugin implements Plugin<Project> { - - private Task testTask; - - @Override - public void apply(Project project) { - Set<Task> tasks = project.getTasksByName("test", false); - // there should be only one task "test" - testTask = tasks.iterator().next(); - TaskCollection<RelastTest> relastTests = project.getTasks().withType(RelastTest.class); - relastTests.forEach(this::setupRelastTest); - relastTests.whenTaskAdded(this::setupRelastTest); - } - - private void setupRelastTest(RelastTest relastTest) { - testTask.dependsOn(relastTest); - relastTest.setGroup("verification"); - } -} diff --git a/buildSrc/src/main/java/org/jastadd/relast/plugin/RelastTest.java b/buildSrc/src/main/java/org/jastadd/relast/plugin/RelastTest.java deleted file mode 100644 index 5098a85916ee63c0af3c5c0045a221cb0f83939c..0000000000000000000000000000000000000000 --- a/buildSrc/src/main/java/org/jastadd/relast/plugin/RelastTest.java +++ /dev/null @@ -1,252 +0,0 @@ -package org.jastadd.relast.plugin; - -import org.gradle.api.DefaultTask; -import org.gradle.api.Project; -import org.gradle.api.file.FileCollection; -import org.gradle.api.plugins.JavaPlugin; -import org.gradle.api.tasks.SourceSet; -import org.gradle.api.tasks.SourceSetContainer; -import org.gradle.api.tasks.TaskAction; - -import java.nio.file.Paths; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; - -/** - * RelAst Test Task - * - * @author rschoene - Initial contribution - */ -@SuppressWarnings({"unused", "WeakerAccess"}) -public class RelastTest extends DefaultTask { - // general options - private boolean verbose = false; - // pre-process options - private List<String> relastFiles = new ArrayList<>(); - private boolean useJastAddNames; - private boolean resolverHelper; - private boolean writeToFile = true; - private String grammarName; - private String listClass; - private String jastAddList; - private String serializer; - - // compile options - private boolean runJastAdd = true; - private String outputDir = "src/test/java-gen/"; - private String packageName; - private List<String> moreInputFiles = new ArrayList<>(); - - public boolean isVerbose() { - return verbose; - } - - public void setVerbose(boolean verbose) { - this.verbose = verbose; - } - - // pre-process options - public List<String> getRelastFiles() { - return relastFiles; - } - - public void relastFiles(String relastFile) { - this.relastFiles.add(relastFile); - } - - public void relastFiles(String[] relastFilesArray) { - this.relastFiles = Arrays.asList(relastFilesArray); - } - - public boolean isUseJastAddNames() { - return useJastAddNames; - } - - public void setUseJastAddNames(boolean useJastAddNames) { - this.useJastAddNames = useJastAddNames; - } - - public boolean isResolverHelper() { - return resolverHelper; - } - - public void setResolverHelper(boolean resolverHelper) { - this.resolverHelper = resolverHelper; - } - - public boolean isWriteToFile() { - return writeToFile; - } - - public void setWriteToFile(boolean writeToFile) { - this.writeToFile = writeToFile; - } - - public String getGrammarName() { - return grammarName; - } - - public void setGrammarName(String grammarName) { - this.grammarName = grammarName; - } - - public String getListClass() { - return listClass; - } - - public void setListClass(String listClass) { - this.listClass = listClass; - } - - public String getJastAddList() { - return jastAddList; - } - - public void setJastAddList(String jastAddList) { - this.jastAddList = jastAddList; - } - - public String getSerializer() { - return serializer; - } - - public void setSerializer(String serializer) { - this.serializer = serializer; - } - - // compile options - public boolean isRunJastAdd() { - return runJastAdd; - } - - public void setRunJastAdd(boolean runJastAdd) { - this.runJastAdd = runJastAdd; - } - - public String getOutputDir() { - return outputDir; - } - - public void setOutputDir(String outputDir) { - this.outputDir = outputDir; - } - - public String getPackageName() { - return packageName; - } - - public void setPackageName(String packageName) { - this.packageName = packageName; - } - - public List<String> getMoreInputFiles() { - return moreInputFiles; - } - - public void moreInputFiles(String f) { - this.moreInputFiles.add(f); - } - - public void moreInputFiles(String[] fileArray) { - this.moreInputFiles.addAll(Arrays.asList(fileArray)); - } - - private boolean isSet(String option) { - return option != null && !option.isEmpty(); - } - - private String[] genSuffixes = {".ast", ".jadd", "RefResolver.jadd", "ResolverStubs.jrag", "Serializer.jadd"}; - - @TaskAction - void runTest() { - setGroup("verification"); - setDescription("Runs a relast test"); - Project project = getProject(); - if (isVerbose()) { - System.out.println("Running relast test"); - System.out.println("relast files: " + getRelastFiles()); - System.out.println("Deleting files"); - } - // first, delete generated files - List<String> genFiles = new ArrayList<>(); - for (String suffix : genSuffixes) { - genFiles.add(getGrammarName() + suffix); - } - if (isVerbose()) { - System.out.println("gen files: " + genFiles); - } - project.delete(deleteSpec -> { - deleteSpec.delete(genFiles); - if (isSet(getPackageName())) { - deleteSpec.delete(Paths.get(getOutputDir(), getPackageName())); - } - }); - if (isVerbose()) { - System.out.println("Pre processing, running relast"); - } - // then, run relast pre processing - project.getPlugins().withType(JavaPlugin.class, javaPlugin -> { - SourceSetContainer sourceSets = (SourceSetContainer) project.getProperties().get("sourceSets"); - FileCollection runtimeClasspath = sourceSets.getByName(SourceSet.MAIN_SOURCE_SET_NAME).getRuntimeClasspath(); - project.javaexec(javaExecSpec -> { - javaExecSpec.setClasspath(runtimeClasspath); - javaExecSpec.setMain("org.jastadd.relast.compiler.Compiler"); - List<Object> args = new ArrayList<>(getRelastFiles()); - args.add("--quiet"); - if (isWriteToFile()) { - args.add("--file"); - } - if (isUseJastAddNames()) { - args.add("--useJastAddNames"); - } - if (isResolverHelper()) { - args.add("--resolverHelper"); - } - if (isSet(getJastAddList())) { - args.add("--jastAddList=" + getJastAddList()); - } - if (isSet(getListClass())) { - args.add("--listClass=" + getListClass()); - } - if (isSet(getSerializer())) { - args.add("--serializer=" + getSerializer()); - } - args.add("--grammarName=" + getGrammarName()); - if (isVerbose()) { - System.out.println("Start relast with args: " + args); - } - javaExecSpec.args(args); - }); - }); - if (isRunJastAdd()) { - if (isVerbose()) { - System.out.println("Compile with JastAdd"); - } - // check which files were actually generated - genFiles.removeIf(s -> !Paths.get(s).toFile().exists()); - // finally, compile generated files - project.getPlugins().withType(JavaPlugin.class, javaPlugin -> { - SourceSetContainer sourceSets = (SourceSetContainer) project.getProperties().get("sourceSets"); - FileCollection runtimeClasspath = sourceSets.getByName(SourceSet.MAIN_SOURCE_SET_NAME).getRuntimeClasspath(); - project.javaexec(javaExecSpec -> { - javaExecSpec.setClasspath(runtimeClasspath); - javaExecSpec.setMain("org.jastadd.JastAdd"); - List<Object> args = new ArrayList<>(); - args.add("--o=" + getOutputDir()); - args.add("--package=" + getPackageName()); - if (isSet(getJastAddList())) { - args.add("--List=" + getJastAddList()); - } - args.addAll(genFiles); - args.addAll(getMoreInputFiles()); - if (isVerbose()) { - System.out.println("Start JastAdd with args: " + args); - } - javaExecSpec.args(args); - }); - }); - } - } - -} diff --git a/buildSrc/src/main/resources/META-INF/gradle-plugins/org.jastadd.relast.plugin.properties b/buildSrc/src/main/resources/META-INF/gradle-plugins/org.jastadd.relast.plugin.properties deleted file mode 100644 index 20222b8953522469ec2c0340ea3aeb5ed6294d13..0000000000000000000000000000000000000000 --- a/buildSrc/src/main/resources/META-INF/gradle-plugins/org.jastadd.relast.plugin.properties +++ /dev/null @@ -1 +0,0 @@ -implementation-class=org.jastadd.relast.plugin.RelastPlugin diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 94336fcae912db8a11d55634156fa011f4686124..e708b1c023ec8b20f512888fe07c5bd3ff77bb8f 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 5028f28f8e4755a78a5bf0fef4644577b199c8c4..41dfb87909a877d96c3af4adccce4c7a301b55a2 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index cccdd3d517fc5249beaefa600691cf150f2fa3e6..4f906e0c811fc9e230eb44819f509cd0627f2600 100755 --- a/gradlew +++ b/gradlew @@ -1,5 +1,21 @@ #!/usr/bin/env sh +# +# Copyright 2015 the original author or 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 UN*X @@ -28,7 +44,7 @@ APP_NAME="Gradle" APP_BASE_NAME=`basename "$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="" +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' # Use the maximum available, or set MAX_FD != -1 to use that value. MAX_FD="maximum" @@ -66,6 +82,7 @@ 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 @@ -109,10 +126,11 @@ if $darwin; then GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" fi -# For Cygwin, switch paths to Windows format before running java -if $cygwin ; then +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then APP_HOME=`cygpath --path --mixed "$APP_HOME"` CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` # We build the pattern for arguments to be converted via cygpath @@ -138,19 +156,19 @@ if $cygwin ; then else eval `echo args$i`="\"$arg\"" fi - i=$((i+1)) + i=`expr $i + 1` done case $i in - (0) set -- ;; - (1) set -- "$args0" ;; - (2) set -- "$args0" "$args1" ;; - (3) set -- "$args0" "$args1" "$args2" ;; - (4) set -- "$args0" "$args1" "$args2" "$args3" ;; - (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; esac fi @@ -159,14 +177,9 @@ save () { for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done echo " " } -APP_ARGS=$(save "$@") +APP_ARGS=`save "$@"` # Collect all arguments for the java command, following the shell quoting and substitution rules eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" -# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong -if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then - cd "$(dirname "$0")" -fi - exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat index e95643d6a2ca62258464e83c72f5156dc941c609..ac1b06f93825db68fb0c0b5150917f340eaa5d02 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -1,3 +1,19 @@ +@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 @@ -13,15 +29,18 @@ 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= +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 init +if "%ERRORLEVEL%" == "0" goto execute echo. echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. @@ -35,7 +54,7 @@ goto fail set JAVA_HOME=%JAVA_HOME:"=% set JAVA_EXE=%JAVA_HOME%/bin/java.exe -if exist "%JAVA_EXE%" goto init +if exist "%JAVA_EXE%" goto execute echo. echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% @@ -45,28 +64,14 @@ echo location of your Java installation. goto fail -:init -@rem Get command-line arguments, handling Windows variants - -if not "%OS%" == "Windows_NT" goto win9xME_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* - :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 %CMD_LINE_ARGS% +"%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 diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000000000000000000000000000000000000..0d12b34fc0f5973338efb7ba84cf7e4e6e970b4e --- /dev/null +++ b/settings.gradle @@ -0,0 +1,3 @@ +rootProject.name = 'RelAST' + + diff --git a/src/main/jastadd/backend/Serializer.jadd b/src/main/jastadd/backend/Serializer.jadd index ac811f1598a2fd0578ae3618c2510e27190cb09a..6973c630367428d01c42410cbb74dc19b040f938 100644 --- a/src/main/jastadd/backend/Serializer.jadd +++ b/src/main/jastadd/backend/Serializer.jadd @@ -592,7 +592,7 @@ aspect Serializer { sb.append(ind(3) + "if (map.keySet().contains(unique$Id())) {\n"); sb.append(ind(4) + "throw new RuntimeException(new SerializationException(\"UID \" + this.unique$Id() + \" is assigned to both \" + this.getClass().getSimpleName() + \":\" + this.hashCode() + \" and \" + map.get(unique$Id()).getClass().getSimpleName() + \":\" + map.get(unique$Id()).hashCode()));\n"); sb.append(ind(3) + "} else {\n"); - sb.append(ind(4) + "map.put(this.unique$Id, new java.lang.ref.WeakReference(this));\n"); + sb.append(ind(4) + "map.put(this.unique$Id(), new java.lang.ref.WeakReference(this));\n"); sb.append(ind(3) + "}\n"); sb.append(ind(2) + "}\n"); sb.append(ind(2) + "for (ASTNode child : astChildren()) {\n"); diff --git a/src/main/resources/RelASTVersion.properties b/src/main/resources/RelASTVersion.properties index 909fca73c343468a25475a043d5e03ca356550cf..1c4dba180c7eb18acb7c959cb64271b53da6458b 100644 --- a/src/main/resources/RelASTVersion.properties +++ b/src/main/resources/RelASTVersion.properties @@ -1,2 +1,2 @@ -#Thu Apr 16 11:22:48 CEST 2020 -version=0.3.0 +#Fri Mar 11 17:24:51 CET 2022 +version=0.4.0