GROOVY-11977: val type placeholder for final declarations (#2464)

Author: paulk-asert

src/antlr/GroovyLexer.g4

@@ -483,6 +483,7 @@ THROW         : 'throw';
 THROWS        : 'throws';
 TRANSIENT     : 'transient';
 TRY           : 'try';
+VAL           : 'val';
 VAR           : 'var';
 VOID          : 'void';
 VOLATILE      : 'volatile';

src/antlr/GroovyParser.g4

@@ -134,6 +134,7 @@ modifier
           |   TRANSIENT
           |   VOLATILE
           |   DEF
+          |   VAL
           |   VAR
           )
     ;
@@ -175,6 +176,7 @@ variableModifier
     :   annotation
     |   m=( FINAL
           | DEF
+          | VAL
           | VAR
           // Groovy supports declaring local variables as instance/class fields,
           // e.g. import groovy.transform.*; @Field static List awe = [1, 2, 3]
@@ -706,7 +708,7 @@ enhancedForControl
     ;
 
 indexVariable
-    :   (BuiltInPrimitiveType | DEF | VAR)? identifier
+    :   (BuiltInPrimitiveType | DEF | VAL | VAR)? identifier
     ;
 
 originalForControl
@@ -1254,6 +1256,7 @@ identifier
     |   RECORD
     |   SEALED
     |   TRAIT
+    |   VAL
     |   VAR
     |   YIELD
     ;
@@ -1312,6 +1315,7 @@ keywords
     |   TRAIT
     |   THREADSAFE
     |   TRY
+    |   VAL
     |   VAR
     |   VOLATILE
     |   WHILE

src/main/java/org/apache/groovy/parser/antlr4/AstBuilder.java

@@ -1225,8 +1225,8 @@ public ClassNode visitTypeDeclaration(final TypeDeclarationContext ctx) {
     public ClassNode visitClassDeclaration(final ClassDeclarationContext ctx) {
         String packageName = Optional.ofNullable(this.moduleNode.getPackageName()).orElse("");
         String className = this.visitIdentifier(ctx.identifier());
-        if ("var".equals(className)) {
-            throw createParsingFailedException("var cannot be used for type declarations", ctx.identifier());
+        if ("var".equals(className) || "val".equals(className)) {
+            throw createParsingFailedException(className + " cannot be used for type declarations", ctx.identifier());
         }
 
         boolean isAnnotation = asBoolean(ctx.AT());
@@ -1747,8 +1747,8 @@ public MethodNode visitCompactConstructorDeclaration(final CompactConstructorDec
             throw createParsingFailedException("Only record can have compact constructor", ctx);
         }
 
-        if (new ModifierManager(this, ctx.getNodeMetaData(COMPACT_CONSTRUCTOR_DECLARATION_MODIFIERS)).containsAny(VAR)) {
-            throw createParsingFailedException("var cannot be used for compact constructor declaration", ctx);
+        if (new ModifierManager(this, ctx.getNodeMetaData(COMPACT_CONSTRUCTOR_DECLARATION_MODIFIERS)).containsAny(VAL, VAR)) {
+            throw createParsingFailedException("val/var cannot be used for compact constructor declaration", ctx);
         }
 
         String methodName = this.visitMethodName(ctx.methodName());
@@ -1785,8 +1785,8 @@ public void visitPropertyExpression(final PropertyExpression expression) {
     public MethodNode visitMethodDeclaration(final MethodDeclarationContext ctx) {
         ModifierManager modifierManager = createModifierManager(ctx);
 
-        if (modifierManager.containsAny(VAR)) {
-            throw createParsingFailedException("var cannot be used for method declarations", ctx);
+        if (modifierManager.containsAny(VAL, VAR)) {
+            throw createParsingFailedException("val/var cannot be used for method return types", ctx);
         }
 
         String methodName = this.visitMethodName(ctx.methodName());
@@ -4691,7 +4691,7 @@ private boolean isSyntheticPublic(final boolean isAnnotationDeclaration, final b
             return true;
         }
 
-        if (hasReturnType && (modifierManager.containsAny(DEF, VAR))) {
+        if (hasReturnType && (modifierManager.containsAny(DEF, VAL, VAR))) {
             return true;
         }
 

src/main/java/org/codehaus/groovy/ast/ModifierNode.java

@@ -38,6 +38,7 @@
 import static org.apache.groovy.parser.antlr4.GroovyParser.STRICTFP;
 import static org.apache.groovy.parser.antlr4.GroovyParser.SYNCHRONIZED;
 import static org.apache.groovy.parser.antlr4.GroovyParser.TRANSIENT;
+import static org.apache.groovy.parser.antlr4.GroovyParser.VAL;
 import static org.apache.groovy.parser.antlr4.GroovyParser.VAR;
 import static org.apache.groovy.parser.antlr4.GroovyParser.VOLATILE;
 import static org.codehaus.groovy.runtime.DefaultGroovyMethods.asBoolean;
@@ -56,6 +57,7 @@ public class ModifierNode extends ASTNode {
     public static final Map<Integer, Integer> MODIFIER_OPCODE_MAP = Maps.of(
             ANNOTATION_TYPE, 0,
             DEF, 0,
+            VAL, Opcodes.ACC_FINAL,
             VAR, 0,
 
             NATIVE, Opcodes.ACC_NATIVE,
@@ -129,7 +131,11 @@ public boolean isAnnotation() {
     }
 
     public boolean isDef() {
-        return Objects.equals(DEF, this.type) || Objects.equals(VAR, this.type);
+        return Objects.equals(DEF, this.type) || Objects.equals(VAL, this.type) || Objects.equals(VAR, this.type);
+    }
+
+    public boolean isVal() {
+        return Objects.equals(VAL, this.type);
     }
 
     public Integer getType() {

src/test-resources/core/Val_01x.groovy

@@ -0,0 +1,57 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you 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
+ *
+ *    http://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.
+ */
+
+// basic val declaration
+val name = "Groovy"
+assert "Groovy" == name
+
+// val as closure parameter name
+[1, 2, 3].each { val ->
+    assert 0 < val && val < 4
+}
+
+// val as variable name (contextual keyword)
+val val = "val variable name"
+assert "val variable name" == val
+
+// val in map key
+def m = [val: 42]
+assert m.val == 42
+
+// val with different types
+val x = 42
+assert x == 42
+val s = "hello"
+assert s.class == String
+
+// shallow finality - mutation OK
+val list = [1, 2, 3]
+list << 4
+assert list == [1, 2, 3, 4]
+
+// final val is redundant but works
+final val y = 10
+assert y == 10
+
+// for loop with val
+for (val i in [1, 2, 3]) { assert i > 0 }
+
+// GString interpolation
+val g = 99
+assert "$g" == "99"

src/test-resources/fail/Val_01x.groovy

@@ -0,0 +1,20 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you 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
+ *
+ *    http://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.
+ */
+
+class val {}

src/test-resources/fail/Val_02x.groovy

@@ -0,0 +1,20 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you 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
+ *
+ *    http://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.
+ */
+
+val someMethod() {}

src/test-resources/fail/Val_03x.groovy

@@ -0,0 +1,21 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you 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
+ *
+ *    http://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.
+ */
+
+val x = 1
+x = 2

src/test/groovy/bugs/Groovy5358.groovy

@@ -71,25 +71,25 @@ final class Groovy5358 {
     void testSetPropertyOverrides() {
         assertScript '''
             class FooWorksAsMap {
-                def val
+                def stored
                 void setProperty(String name, value) {
-                    val = "OK:FooWorksAsMap.$value"
+                    stored = "OK:FooWorksAsMap.$value"
                 }
             }
             class BarWorksAsMap {
-                def val
+                def stored
             }
             @Category(BarWorksAsMap) class C {
                 void setProperty(String name, value) {
-                    setVal("OK:BarWorksAsMap.$value")
+                    setStored("OK:BarWorksAsMap.$value")
                 }
             }
             BarWorksAsMap.mixin C
             class BazWorksAsMap {
-                def val
+                def stored
             }
             BazWorksAsMap.metaClass.setProperty = { String name, value ->
-                    setVal("OK:BazWorksAsMap.$value")
+                    setStored("OK:BazWorksAsMap.$value")
             }
 
             def objects = [
@@ -99,10 +99,10 @@ final class Groovy5358 {
                 [:]
             ]
             for (def obj in objects) {
-                def which = "${obj.getClass().getSimpleName()}.val"
+                def which = "${obj.getClass().getSimpleName()}.stored"
                 try {
-                    obj.val = which.startsWith('LinkedHashMap') ? "OK:LinkedHashMap.bar" : 'bar'
-                    assert obj.val.startsWith('OK:') : "$which -> $obj.val"
+                    obj.stored = which.startsWith('LinkedHashMap') ? "OK:LinkedHashMap.bar" : 'bar'
+                    assert obj.stored.startsWith('OK:') : "$which -> $obj.stored"
                 } catch (any) {
                     assert false : "$which -> FAIL:$any"
                 }

src/test/groovy/groovy/transform/stc/LambdaTest.groovy

@@ -817,7 +817,7 @@ final class LambdaTest {
                     this.val = v
                 }
                 String toString() {
-                    val as String
+                    this.val as String
                 }
                 def <Out> Value<Out> replace(Supplier<Out> supplier) {
                     new Value<>(supplier.get())