Migrate Reference Code Adaptation to JavaDSL

build.gradle

@@ -25,7 +25,7 @@ allprojects {
 subprojects {
     apply plugin: "java-library"
     apply plugin: "maven-publish"
-    apply plugin: "monticore"
+    apply plugin: "de.monticore.generator"
 
     java {
         toolchain {
@@ -36,13 +36,13 @@ subprojects {
         withSourcesJar()
     }
 
-    tasks.withType(JavaCompile) {
-        dependsOn(tasks.withType(MCTask))
+    tasks.withType(JavaCompile).configureEach {
+        dependsOn(tasks.withType(MCGenTask))
 
         options.encoding = "UTF-8"
     }
 
-    tasks.withType(Test) {
+    tasks.withType(Test).configureEach {
         useJUnitPlatform()
 
         testLogging {

gradle.properties

@@ -4,7 +4,7 @@ repo=https://nexus.se.rwth-aachen.de/content/groups/public
 
 useLocalRepo=false
 
-version=7.4.0-SNAPSHOT
+version=7.7.0-SNAPSHOT
 
 org.gradle.caching=true
-org.gradle.welcome=never
+org.gradle.welcome=never

gradle/corpus.versions.toml

@@ -0,0 +1,20 @@
+#
+# The corpus of libraries is used to test the generated infrastructure. For this
+# purpose, a variety of open-source libraries targeting different Java versions
+# are used. Only the sources of these libraries are used during testing. Their
+# versions must not necessarily align with the project's dependencies.
+#
+# Read more in javaDSL/src/main/grammars/de/monticore/java/JavaDSL.md
+#
+[libraries]
+# com.osmerion.quitte - Quitte
+# https://github.com/Osmerion/Quitte - Java 17
+quitte = { module = "com.osmerion.quitte:quitte", version = "0.7.0" }
+
+# com.google.guava - Guava
+# https://github.com/google/guava - Java 8
+guava = { module = "com.google.guava:guava", version = "31.1-jre" }
+
+# de.monticore - MontiCore
+# https://github.com/MontiCore/monticore - Java 11
+monticore-runtime = { module = "de.monticore:monticore-runtime", version = "7.6.0-SNAPSHOT" }

gradle/libs.versions.toml

@@ -3,7 +3,7 @@ emf = "2.15.0"
 gradle-shadow-plugin = "7.1.2"
 guava = "31.1-jre"
 junit = "5.9.0"
-monticore = "7.5.0-SNAPSHOT"
+monticore = "7.7.0-SNAPSHOT"
 
 
 [libraries]

javaDSL-emf/build.gradle

@@ -33,11 +33,26 @@ task copyTestSources(type: Copy) {
     from "${project(':javaDSL').projectDir}/src/main"
 }
 
-task generate(type: MCTask) {
+tasks.register("generateTextBlock", MCTask) {
+    dependsOn(copyMainSources, copyTestSources)
+
+    grammar = file "$grammarsDir/de/monticore/java/TextBlock.mc4"
+    outputDir = file "$buildDir/generated-sources/monticore/sourcecode"
+    handcodedPath "$srcMainDir/java"
+
+    script = "de/monticore/monticore_emf.groovy"
+
+    def upToDate = incCheck("de/monticore/java/TextBlock.mc4")
+    outputs.upToDateWhen { upToDate }
+}
+
+tasks.register("generate", MCTask) {
+    dependsOn(tasks.generateTextBlock)
     dependsOn(copyMainSources, copyTestSources)
 
     grammar = file "$grammarsDir/de/monticore/java/JavaDSL.mc4"
     outputDir = file "$buildDir/generated-sources/monticore/sourcecode"
+    modelPath "$grammarsDir"
     handcodedPath "$srcMainDir/java"
 
     script = "de/monticore/monticore_emf.groovy"
@@ -48,6 +63,7 @@ task generate(type: MCTask) {
 
 dependencies {
     implementation(platform(libs.junit.bom))
+    implementation "de.monticore.lang:cd4analysis:7.7.0-SNAPSHOT"
 
     api(libs.monticore.grammar.emf)
     api(libs.monticore.runtime.emf)
@@ -63,5 +79,6 @@ dependencies {
     }
 
     testImplementation(libs.junit.jupiter.api)
+    testImplementation(libs.junit.jupiter.params)
     testRuntimeOnly(libs.junit.jupiter.engine)
 }

javaDSL/build.gradle

@@ -4,13 +4,20 @@ def grammarsDir = "src/main/grammars"
 
 configurations {
     corpus {
+        canBeConsumed = false
+        canBeResolved = true
+
         transitive = false
+
+        resolutionStrategy.dependencySubstitution.all {
+            artifactSelection {
+                selectArtifact("jar", "jar", "sources")
+            }
+        }
     }
 }
 
 sourceSets {
-    main.java.srcDir("$buildDir/generated-sources/monticore/sourcecode")
-
     grammars {
         resources {
             srcDir(grammarsDir)
@@ -25,15 +32,6 @@ java {
     }
 }
 
-tasks.register('generate', MCTask) {
-    grammar = file "$projectDir/$grammarsDir/de/monticore/java/JavaDSL.mc4"
-    outputDir = file "$buildDir/generated-sources/monticore/sourcecode"
-    handcodedPath "$projectDir/src/main/java"
-
-    def upToDate = incCheck("de/monticore/java/JavaDSL.mc4")
-    outputs.upToDateWhen { upToDate }
-}
-
 tasks.register('extractCorpus') {
     dependsOn(configurations.corpus)
 
@@ -65,6 +63,7 @@ tasks.withType(Test).configureEach {
 
 dependencies {
     implementation(platform(libs.junit.bom))
+    implementation "de.monticore.lang:cd4analysis:$version"
 
     api(libs.monticore.grammar)
     api(libs.monticore.runtime)
@@ -79,6 +78,8 @@ dependencies {
     testImplementation(libs.junit.jupiter.params)
     testRuntimeOnly(libs.junit.jupiter.engine)
 
-    corpus(libs.guava) { artifact { classifier = "sources" } }
-    corpus(libs.monticore.runtime) { artifact { classifier = "sources" } }
+    corpus(corpus.guava)
+    corpus(corpus.monticore.runtime)
+    // TODO: fix parser for Java 17 and enable
+    //corpus(corpus.quitte)
 }

javaDSL/src/main/grammars/de/monticore/java/JavaDSL.mc4

@@ -58,27 +58,35 @@ package de.monticore.java;
  *     |-> de.monticore.types.MCSimpleGenericTypes
  *         |-> de.monticore.types.MCCollectionTypes
  *             |-> de.monticore.types.MCBasicTypes (*)
+ * |-> de.monticore.types.TypeParameters
+ *     |-> de.monticore.symbols.BasicSymbols
+ *         |-> de.monticore.MCBasics (*)
+ *     |-> de.monticore.types.MCBasicTypes
+ *         |-> de.monticore.MCBasics (*)
  *
- * (*) Dependencies are emitted because they have been listed previously.
+ * (*) Repeated Dependencies are omitted.
  */
-grammar JavaDSL extends de.monticore.JavaLight,
+grammar JavaDSL extends
+    de.monticore.java.TextBlock,
+    de.monticore.JavaLight,
 	de.monticore.expressions.BitExpressions,
 	de.monticore.expressions.LambdaExpressions, // TODO: move to JavaLight?
 	de.monticore.literals.MCJavaLiterals,
 	de.monticore.statements.MCFullJavaStatements,
 	de.monticore.types.MCArrayTypes,
-	de.monticore.types.MCFullGenericTypes {
+	de.monticore.types.MCFullGenericTypes,
+	de.monticore.types.TypeParameters {
 
 start CompilationUnit;
 
 // starting point for parsing a java file
-interface scope CompilationUnit;
+interface CompilationUnit;
 
-scope OrdinaryCompilationUnit implements CompilationUnit
+OrdinaryCompilationUnit implements CompilationUnit
     = PackageDeclaration? ImportDeclaration* TypeDeclaration*
     ;
 
-scope ModularCompilationUnit implements CompilationUnit
+ModularCompilationUnit implements CompilationUnit
     = ImportDeclaration* ModuleDeclaration
     ;
 
@@ -158,7 +166,40 @@ symbolrule ClassDeclaration =
 ClassBody
     =   "{" ClassBodyDeclaration* "}"
     ;
-
+
+/*
+ * Records Classes
+ *
+ * https://docs.oracle.com/javase/specs/jls/se19/html/jls-8.html#jls-8.10
+ */
+
+symbol scope RecordDeclaration extends TypeDeclaration
+    = JavaModifier* "record" Name TypeParameters? RecordHeader
+        ("implements" implementedInterface:(MCType || ",")+)?
+        RecordBody
+    ;
+
+RecordHeader
+    = "(" (RecordComponent || ",")* ")"
+    ;
+
+RecordComponent
+    = JavaModifier* MCType (arrayAnnotations:Annotation* variableArity:"...")? Name
+    ;
+
+astrule RecordComponent =
+    method public boolean isHasVariableArity() {
+      return this.isPresentVariableArity();
+    };
+
+RecordBody
+    = "{" (ClassBodyDeclaration | CompactConstructorDeclaration)* "}"
+    ;
+
+CompactConstructorDeclaration
+    = JavaModifier* Name body:MCJavaBlock
+    ;
+
 symbol scope InterfaceDeclaration extends TypeDeclaration
     =   JavaModifier* "interface" Name TypeParameters?
         ("extends" extendedInterface:(MCType || ",")+)?
@@ -187,18 +228,6 @@ EnumBody
     =   ";" ClassBodyDeclaration*
     ;
 
-TypeParameters
-    =   "<" (TypeParameter || ",")+ ">"
-    ;
-
-symbol TypeParameter
-    =   Name ("extends" TypeBound)?
-    ;
-
-TypeBound
-    =   (MCType || "&")+
-    ;
-
 ClassBlock implements ClassBodyDeclaration
     =   (["static"])? JavaBlock
     ;
@@ -260,8 +289,12 @@ AnnotatedName = Annotation* Name;
 
 @Override
 MCArrayType implements MCType
-    = MCType (AnnotatedDimension {_builder.setDimensions(_builder.getDimensions()+1);} )+
+    = MCType (AnnotatedDimension)+
     ;
+astrule MCArrayType =
+    method public int getDimensions() {
+      return this.sizeAnnotatedDimensions();
+    };
 
 @Override
 MCBasicGenericType implements MCGenericType <20>
@@ -330,17 +363,6 @@ ClassCreatorRest
     =   Arguments ClassBody?
     ;
 
-@Override ExtType = MCType;
-
-ExtLiteral = Literal;
-
-@Override ExtReturnType = MCReturnType;
-
-@Override ExtTypeArgument = MCTypeArgument;
-
-ExtTypeParameter = TypeParameter;
-@Override ExtTypeParameters = TypeParameters;
-
 /*
  * TODO Remove this
  * This is a workaround to a questionable behavior in the core grammar JavaLight
@@ -355,9 +377,8 @@ JavaAnnotation extends JavaModifier implements ElementValue
             ( "(" AnnotationArguments? ")" )?
     ;
 
-@Override
 AnonymousClass implements Creator
-    =   ExtType Arguments ClassBody?
+    =   MCType Arguments ClassBody?
     ;
 
 
@@ -375,5 +396,22 @@ interface MethodReferenceTarget;
 ConstructorReferenceTarget implements MethodReferenceTarget = "new";
 MethodNameReferenceTarget implements MethodReferenceTarget = Name;
 
+TextBlockLiteral implements Literal, SignedLiteral
+    = source:TextBlock
+    ;
+
+/*========================================================================*/
+/*============================ LEXER RULES ===============================*/
+/*========================================================================*/
+
+token TextBlock
+    = TextBlockDelimiter (TextBlockCharacters)? TextBlockDelimiter
+    : {setText(de.monticore.java.utils.TextBlockUtils.preprocessTextBlock(getText().substring(3, getText().length() - 4)));};
+
+fragment token TextBlockCharacters
+    = (' ' | '\t')* ('\r' | '\n') (. | EscapeSequence)*;
+
+fragment token TextBlockCharacter
+    = '"' | '\\' | EscapeSequence;
 
 }

javaDSL/src/main/grammars/de/monticore/java/JavaDSL.md

@@ -1,24 +1,27 @@
 # JavaDSL
-JavaDSL offers a full parser for Java (Spec 1.7), many context conditions and
-a pretty printer.
 
-The grammar file is [`de.monticore.java.JavaDSL`][JavaDSL].
+JavaDSL provides a full spec-compliant parser for Java 17, a pretty printer and
+additional tools for working with Java source artifacts.
 
-## Handwritten Extensions
-### AST
+The core grammar definition can be found in [`de.monticore.java.JavaDSL`][JavaDSL].
 
-## Parser
-## Symboltable
 
-## Functionality
-### CoCos
+## Testing
 
-### PrettyPrinter
+### Corpus Tests
 
-### Helper
+To ensure that the parser covers the entire specification, it is tested on a
+large corpus of open-source libraries. _Corpus Tests_ are executed as part of
+the regular unit tests.
+
+To add a library to the corpus, modifications should be made in two places:
+
+1. The dependency should be added to the [corpus' version catalog](../../../../../../../gradle/corpus.versions.toml), and
+2. the dependency should be added to the "corpus" configuration in the [build script](../../../../../../build.gradle).
+
+Note, that the libraries in the corpus must not be kept up-to-date. Instead, a
+variety of libraries targeting different Java language versions and use-cases
+should be used to cover different code-styles and language features.
 
-### Reporting
-
-### CLI Application
 
 [JavaDSL]: https://git.rwth-aachen.de/monticore/javaDSL/blob/dev/javaDSL/src/main/grammars/de/monticore/java/JavaDSL.mc4

javaDSL/src/main/grammars/de/monticore/java/TextBlock.mc4

@@ -0,0 +1,7 @@
+package de.monticore.java;
+
+component grammar TextBlock {
+
+    token TextBlockDelimiter = '"' '"' '"';
+
+}