fix: Fix group variables for sql statements (#2001)

Author: Nurkambay

server/engine/src/main/antlr4/org/eclipse/lsp/cobol/core/parser/Db2SqlLexer.g4

@@ -823,7 +823,7 @@ DATELITERAL: '\'' (DIGIT DIGIT DIGIT DIGIT '-' DIGIT DIGIT '-' DIGIT DIGIT | //y
                    DIGIT DIGIT '-' DIGIT DIGIT '-' DIGIT DIGIT DIGIT DIGIT) TIMESTAMPLITERAL? '\'';//yyyy-mm-dd
 
 INTEGERLITERAL : DIGIT+ ;
-IDENTIFIER : [a-zA-Z0-9][_a-zA-Z0-9]*;
+IDENTIFIER : [a-zA-Z0-9][_a-zA-Z0-9-]*;
 COPYBOOK_IDENTIFIER : [a-zA-Z0-9#@$][_a-zA-Z0-9#@$]*;
 
 fragment BXNUMBER :

server/engine/src/main/java/org/eclipse/lsp/cobol/core/engine/analysis/Db2SqlVisitor.java

@@ -72,22 +72,11 @@ public List<Node> visitDbs_host_names_var(Db2SqlParser.Dbs_host_names_varContext
   @Override
   public List<Node> visitDbs_host_name_container(Db2SqlParser.Dbs_host_name_containerContext ctx) {
     if (isVariableUsage(ctx.getParent())) {
-      return addTreeNode(
-          ctx,
-          locality -> new VariableUsageNode(VisitorHelper.getName(ctx), locality)
-      );
+      return addVariableUsageNodes(ctx);
     }
     return ImmutableList.of();
   }
 
-  @Override
-  public List<Node> visitDbs_sql_identifier(Db2SqlParser.Dbs_sql_identifierContext ctx) {
-    return addTreeNode(
-        ctx,
-        locality -> new VariableUsageNode(VisitorHelper.getName(ctx), locality)
-    );
-  }
-
   // NOTE: Visitor is not managed by Guice DI, so can't use annotation here.
   @Override
   public List<Node> visitChildren(RuleNode node) {
@@ -160,4 +149,25 @@ private List<Node> addTreeNode(ParserRuleContext ctx, Function<Locality, Node> n
     visitChildren(ctx).forEach(node::addChild);
     return ImmutableList.of(node);
   }
+
+  private List<Node> addVariableUsageNodes(ParserRuleContext ctx) {
+    String name = VisitorHelper.getName(ctx);
+    boolean hasColumn = name.startsWith(":");
+    if (hasColumn) {
+      name = name.substring(1);
+    }
+
+    if (Db2SqlVisitorHelper.isGroupName(name)) {
+      Locality locality = VisitorHelper.buildNameRangeLocality(ctx, name, programUri);
+      locality.setRange(RangeUtils.shiftRangeWithPosition(new Position(position.getLine(),
+          position.getCharacter() + (hasColumn ? 1 : 0)), locality.getRange()));
+
+      return Db2SqlVisitorHelper.generateGroupNodes(name, locality);
+    }
+    String finalName = name;
+    return addTreeNode(
+        ctx,
+        locality -> new VariableUsageNode(finalName, locality)
+    );
+  }
 }

server/engine/src/main/java/org/eclipse/lsp/cobol/core/engine/analysis/Db2SqlVisitorHelper.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2023 Broadcom.
+ * The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *    Broadcom, Inc. - initial API and implementation
+ *
+ */
+package org.eclipse.lsp.cobol.core.engine.analysis;
+
+import com.google.common.collect.ImmutableList;
+import lombok.experimental.UtilityClass;
+import org.eclipse.lsp.cobol.common.model.Locality;
+import org.eclipse.lsp.cobol.common.model.tree.Node;
+import org.eclipse.lsp.cobol.common.model.tree.variable.QualifiedReferenceNode;
+import org.eclipse.lsp.cobol.common.model.tree.variable.VariableUsageNode;
+import org.eclipse.lsp4j.Position;
+import org.eclipse.lsp4j.Range;
+
+import java.util.List;
+
+/**
+ * Helper class for Db2SqlVisitor
+ */
+@UtilityClass
+class Db2SqlVisitorHelper {
+
+  public boolean isGroupName(String name) {
+    return name.contains(".");
+  }
+
+  public String[] splitNames(String name) {
+    return name.split("\\.");
+  }
+
+  public Range[] splitRange(Range range, String[] names) {
+    Range[] result = new Range[names.length];
+    int pos = range.getStart().getCharacter();
+    int line = range.getStart().getLine();
+    for (int i = 0; i < names.length; i++) {
+      result[i] = new Range(new Position(line, pos), new Position(line, pos + names[i].length()));
+      pos += names[i].length() + 1;
+    }
+    return result;
+  }
+
+  public List<Node> generateGroupNodes(String name, Locality locality) {
+    String[] names = splitNames(name);
+    Range[] ranges = splitRange(locality.getRange(), names);
+
+    QualifiedReferenceNode groupNode = new QualifiedReferenceNode(locality);
+    for (int i = ranges.length - 1; i >= 0; i--) {
+      Locality nodeLocality = locality.toBuilder().range(ranges[i]).build();
+      groupNode.addChild(new VariableUsageNode(names[i], nodeLocality));
+    }
+    return ImmutableList.of(groupNode);
+  }
+}

server/engine/src/test/java/org/eclipse/lsp/cobol/usecases/TestSqlGroupVariableUsage.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2023 Broadcom.
+ * The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *    Broadcom, Inc. - initial API and implementation
+ *
+ */
+package org.eclipse.lsp.cobol.usecases;
+
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
+import org.eclipse.lsp.cobol.test.engine.UseCaseEngine;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Tests Group Variable usage in the EXEC SQL block
+ */
+class TestSqlGroupVariableUsage {
+
+  private static final String TEXT = "       IDENTIFICATION DIVISION.\n"
+      + "       PROGRAM-ID. SM106A.\n"
+      + "       DATA DIVISION.\n"
+      + "       WORKING-STORAGE SECTION. \n"
+      + "       01 {$*INP} PIC X(9).\n"
+      + "       01 {$*A}.\n"
+      + "          05 {$*BBB} PIC X(9).\n"
+      + "       PROCEDURE DIVISION.\n"
+      + "           EXEC SQL SELECT :{$INP} INTO :{$A}.{$BBB} FROM CACHE END-EXEC.\n";
+  @Test
+  void test() {
+    UseCaseEngine.runTest(TEXT, ImmutableList.of(), ImmutableMap.of());
+  }
+}