feat: Support for REDEFINES clause eclipse-che4z#867

Signed-off-by: Leonid Baranov <[email protected]>

Author: Nurkambay

server/src/main/java/org/eclipse/lsp/cobol/core/model/tree/NodeType.java

@@ -22,6 +22,7 @@ public enum NodeType {
   PROGRAM,
   SECTION,
   VARIABLE_DEFINITION,
+  VARIABLE_REDEFINITION,
   VARIABLE_USAGE,
   ANTLR_VARIABLE_DEFINITION,
   PROGRAM_ID,

server/src/main/java/org/eclipse/lsp/cobol/core/model/tree/VariableRedefinitionNode.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2021 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.model.tree;
+
+import org.eclipse.lsp.cobol.core.CobolParser;
+import org.eclipse.lsp.cobol.core.model.Locality;
+
+import java.util.Optional;
+
+/**
+ * The node represents a variable redefinition clause
+ */
+public class VariableRedefinitionNode extends Node {
+
+  private final CobolParser.DataRedefinesClauseContext redefinesClauseContext;
+
+  public VariableRedefinitionNode(Locality locality, CobolParser.DataRedefinesClauseContext redefinesClauseContext) {
+    super(locality, NodeType.VARIABLE_REDEFINITION);
+    this.redefinesClauseContext = redefinesClauseContext;
+  }
+
+  @Override
+  public void process() {
+    getNearestParentByType(NodeType.PROGRAM)
+        .map(ProgramNode.class::cast)
+        .map(ProgramNode::getVariableDefinitionDelegate)
+        .ifPresent(variablesDelegate -> {
+          Optional.ofNullable(redefinesClauseContext).ifPresent(variablesDelegate::handleRedefine);
+        });
+  }
+}

server/src/main/java/org/eclipse/lsp/cobol/core/visitor/CobolVisitor.java

@@ -478,14 +478,10 @@ public List<Node> visitParagraphName(ParagraphNameContext ctx) {
   @Override
   public List<Node> visitDataDescriptionEntryFormat1(DataDescriptionEntryFormat1Context ctx) {
     variablesDelegate.defineVariable(ctx);
-    String name =
-        ofNullable(ctx.entryName())
-            .map(EntryNameContext::dataName1)
-            .map(RuleContext::getText)
-            .orElse(FILLER_NAME);
-    String levelNumber = ctx.LEVEL_NUMBER().getText();
-    int level = Integer.parseInt(levelNumber);
-    outlineTreeBuilder.addVariable(level, name, getDataDescriptionNodeType(ctx), ctx);
+    String name = VisitorHelper.getName(ctx.entryName());
+    NodeType nodeType = getDataDescriptionNodeType(ctx);
+    int level = VisitorHelper.getLevel(ctx.LEVEL_NUMBER());
+    outlineTreeBuilder.addVariable(level, name, nodeType, ctx);
     Node node = new AntlrVariableDefinitionNode(ctx);
     visitChildren(ctx).forEach(node::addChild);
     return ImmutableList.of(node);
@@ -517,25 +513,34 @@ public List<Node> visitEnvironmentSwitchNameClause(EnvironmentSwitchNameClauseCo
   @Override
   public List<Node> visitDataDescriptionEntryFormat2(DataDescriptionEntryFormat2Context ctx) {
     variablesDelegate.defineVariable(ctx);
-    String name =
-        ofNullable(ctx.entryName())
-            .map(EntryNameContext::dataName1)
-            .map(RuleContext::getText)
-            .orElse(FILLER_NAME);
+    String name = VisitorHelper.getName(ctx.entryName());
     outlineTreeBuilder.addVariable(LEVEL_66, name, NodeType.FIELD_66, ctx);
     Node node = new AntlrVariableDefinitionNode(ctx);
     visitChildren(ctx).forEach(node::addChild);
     return ImmutableList.of(node);
   }
 
+  @Override
+  public List<Node> visitDataRedefinesClause(DataRedefinesClauseContext ctx) {
+    String name = VisitorHelper.getName(ctx.dataName());
+    List<Node> result = new ArrayList<>();
+
+    getLocality(ctx.dataName().getStart())
+        .ifPresent(locality -> {
+          Node node = new VariableRedefinitionNode(locality, ctx);
+          visitChildren(ctx).forEach(node::addChild);
+
+          variableUsageDelegate.handleDataName(name, locality);
+          node.addChild(new VariableUsageNode(name, locality));
+          result.add(node);
+        });
+    return result;
+  }
+
   @Override
   public List<Node> visitDataDescriptionEntryFormat3(DataDescriptionEntryFormat3Context ctx) {
     variablesDelegate.defineVariable(ctx);
-    String name =
-        ofNullable(ctx.entryName())
-            .map(EntryNameContext::dataName1)
-            .map(RuleContext::getText)
-            .orElse(FILLER_NAME);
+    String name = VisitorHelper.getName(ctx.entryName());
     outlineTreeBuilder.addVariable(LEVEL_88, name, NodeType.FIELD_88, ctx);
     Node node = new AntlrVariableDefinitionNode(ctx);
     visitChildren(ctx).forEach(node::addChild);
@@ -546,12 +551,7 @@ public List<Node> visitDataDescriptionEntryFormat3(DataDescriptionEntryFormat3Co
   public List<Node> visitDataDescriptionEntryFormat1Level77(
       DataDescriptionEntryFormat1Level77Context ctx) {
     variablesDelegate.defineVariable(ctx);
-    String name =
-        ofNullable(ctx.entryName())
-            .map(EntryNameContext::dataName1)
-            .map(RuleContext::getText)
-            .orElse(FILLER_NAME);
-
+    String name = VisitorHelper.getName(ctx.entryName());
     outlineTreeBuilder.addVariable(LEVEL_77, name, NodeType.FIELD, ctx);
     Node node = new AntlrVariableDefinitionNode(ctx);
     visitChildren(ctx).forEach(node::addChild);
@@ -681,7 +681,6 @@ public List<Node> visitIfStatement(IfStatementContext ctx) {
     return addTreeNode(ctx, locality -> new IfNode(locality, ctx));
   }
 
-
   private void throwException(String wrongToken, @NonNull Locality locality, String message) {
     SyntaxError error =
         SyntaxError.syntaxError()
@@ -700,21 +699,12 @@ private Optional<Locality> getLocality(Token childToken) {
     return ofNullable(positionMapping.get(childToken));
   }
 
-  private Locality getIntervalPosition(Locality start, Locality stop) {
-    return Locality.builder()
-        .uri(start.getUri())
-        .range(new Range(start.getRange().getStart(), stop.getRange().getEnd()))
-        .recognizer(CobolVisitor.class)
-        .copybookId(start.getCopybookId())
-        .build();
-  }
-
   private void reportSubroutineNotDefined(String name, Locality locality) {
     SyntaxError error =
         SyntaxError.syntaxError()
             .suggestion(messageService.getMessage("CobolVisitor.subroutineNotFound", name))
             .severity(ErrorSeverity.INFO)
-            .locality(getIntervalPosition(locality, locality))
+            .locality(VisitorHelper.getIntervalPosition(locality, locality))
             .build();
     LOG.debug("Syntax error by CobolVisitor#reportSubroutineNotDefined: {}", error);
     errors.add(error);

server/src/main/java/org/eclipse/lsp/cobol/core/visitor/VariableDefinitionDelegate.java

@@ -14,6 +14,7 @@
  */
 package org.eclipse.lsp.cobol.core.visitor;
 
+import lombok.*;
 import org.eclipse.lsp.cobol.core.CobolParser.*;
 import org.eclipse.lsp.cobol.core.messages.MessageService;
 import org.eclipse.lsp.cobol.core.model.ErrorSeverity;
@@ -23,10 +24,6 @@
 import org.eclipse.lsp.cobol.core.model.variables.*;
 import org.eclipse.lsp.cobol.core.semantics.outline.OutlineNodeNames;
 import com.google.common.collect.ImmutableList;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NonNull;
-import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.antlr.v4.runtime.ParserRuleContext;
 import org.antlr.v4.runtime.RuleContext;
@@ -83,6 +80,8 @@ public class VariableDefinitionDelegate {
   private final Map<Token, Locality> positions;
   private final MessageService messages;
 
+  private final Map<String, String> redefinedVariables = new HashMap<>();
+
   /**
    * Create and accumulate a variable of level 01-49 out of the given context. Add errors if the
    * variable definition contains is invalid
@@ -115,6 +114,7 @@ public void defineVariable(@NonNull DataDescriptionEntryFormat1Context ctx) {
             .occursClauses(ctx.dataOccursClause())
             .valueClauses(ctx.dataValueClause())
             .usageClauses(ctx.dataUsageClause())
+            .redefinesClauses(ctx.dataRedefinesClause())
             .build();
 
     // TODO: Add check that name does not present in the predefined variables list (? - to check)
@@ -128,6 +128,8 @@ public void defineVariable(@NonNull DataDescriptionEntryFormat1Context ctx) {
     checkGlobalFlagFor01Level(variableDefinitionContext);
     setValueClauseText(variableDefinitionContext);
     saveGlobalVariable(variableDefinitionContext);
+    checkRedefinesContainsValue(variableDefinitionContext);
+    checkRedefinesClauseIsSingle(variableDefinitionContext);
     // TODO: check the same way that the other clauses are singular or absent
 
     defineVariable(
@@ -264,6 +266,43 @@ public ResultWithErrors<Collection<Variable>> finishDefinitionAnalysis() {
     return new ResultWithErrors<>(new ArrayList<>(variables), new ArrayList<>(errors));
   }
 
+  /**
+   * Handle and process REDEFINES clause
+   * @param context is a ParserRuleContext context
+   */
+  public void handleRedefine(DataRedefinesClauseContext context) {
+    String redefinesName = VisitorHelper.getName(context.dataName());
+    Locality locality = positions.get(context.dataName().getStart());
+    if (locality == null) {
+      return;
+    }
+
+    boolean notFound = true;
+    Iterator<Variable> iterator = variables.iterator();
+    if (iterator.hasNext()) {
+      Variable currentVariable = iterator.next();
+
+      while (iterator.hasNext()) {
+        Variable variable = iterator.next();
+        if (redefinesName.equals(variable.getName())) {
+          if (currentVariable.getLevelNumber() != variable.getLevelNumber()) {
+            addError(messages.getMessage("semantics.levelsMustMatch", redefinesName), positions.get(context.getParent().getStart()));
+          }
+          notFound = false;
+          break;
+        } else {
+          if (variable.getLevelNumber() == currentVariable.getLevelNumber()
+              && !redefinesName.equals(redefinedVariables.get(variable.getName()))) {
+            break;
+          }
+        }
+      }
+      if (notFound) {
+        addError(messages.getMessage("semantics.redefineImmediatelyFollow", redefinesName), locality);
+      }
+    }
+  }
+
   private String retrieveName(RuleContext context) {
     return ofNullable(context)
         .map(RuleContext::getText)
@@ -345,6 +384,13 @@ private void addError(String suggestion, Locality locality, ErrorSeverity severi
         format("Syntax error defined by %s: %s", getClass().getSimpleName(), error.toString()));
   }
 
+  private void checkRedefinesContainsValue(VariableDefinitionContext variable) {
+    if (!(variable.getRedefinesClauses().isEmpty() || variable.getValueClauses().isEmpty())) {
+      Locality valueLocality = positions.get(variable.getValueClauses().get(0).getStart());
+      addError(messages.getMessage("semantics.redefinedContainValue", variable.getName()), valueLocality);
+    }
+  }
+
   private void checkStartingArea(VariableDefinitionContext variable) {
     if ((variable.getNumber() == LEVEL_01 || variable.getNumber() == LEVEL_77)
         && variable.getStarting().getRange().getStart().getCharacter() > AREA_A_FINISH) {
@@ -382,6 +428,10 @@ private void checkValueClauseIsSingle(VariableDefinitionContext variable) {
     checkClauseIsSingle(variable.getDefinition(), variable.getValueClauses(), "VALUE");
   }
 
+  private void checkRedefinesClauseIsSingle(VariableDefinitionContext variable) {
+    checkClauseIsSingle(variable.getDefinition(), variable.getRedefinesClauses(), "REDEFINES");
+  }
+
   private void checkUsageClauseIsSingle(VariableDefinitionContext variable) {
     checkClauseIsSingle(variable.getDefinition(), variable.getUsageClauses(), "USAGE");
   }
@@ -436,6 +486,11 @@ private void defineVariable(
               }
               variables.push(variable);
             });
+    Optional.ofNullable(variableDefinitionContext.getRedefinesClauses())
+        .filter(l -> !l.isEmpty())
+        .ifPresent(b ->
+            redefinedVariables.put(variableDefinitionContext.getName(),
+                VisitorHelper.getName(variableDefinitionContext.getRedefinesClauses().get(0).dataName())));
   }
 
   private Variable multiTableDataNameMatcher(VariableDefinitionContext variable) {
@@ -655,6 +710,7 @@ private static class VariableDefinitionContext {
     List<DataOccursClauseContext> occursClauses;
     List<DataValueClauseContext> valueClauses;
     List<DataUsageClauseContext> usageClauses;
+    List<DataRedefinesClauseContext> redefinesClauses;
     String valueClauseTest;
     String thruValue;
     Variable container;

server/src/main/java/org/eclipse/lsp/cobol/core/visitor/VariableUsageDelegate.java

@@ -59,6 +59,15 @@ public void handleDataName(String dataName, Locality locality, QualifiedDataName
     variableUsages.add(new VariableUsage(dataName, parents, locality, parentVariables));
   }
 
+  /**
+   * Accumulate variable appearance for analise its definition later.
+   * @param dataName the variable name
+   * @param locality the variable text position
+   */
+  public void handleDataName(String dataName, Locality locality) {
+    variableUsages.add(new VariableUsage(dataName, Collections.emptyList(), locality, Collections.emptyMap()));
+  }
+
   /**
    * Accumulate variable appearance for analise its definition later.
    *

server/src/main/java/org/eclipse/lsp/cobol/core/visitor/VisitorHelper.java

@@ -0,0 +1,79 @@
+/*
+ * Copyright (c) 2021 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.visitor;
+
+import lombok.experimental.UtilityClass;
+import org.antlr.v4.runtime.RuleContext;
+import org.antlr.v4.runtime.tree.TerminalNode;
+import org.eclipse.lsp.cobol.core.model.Locality;
+import org.eclipse.lsp4j.Range;
+
+import static org.eclipse.lsp.cobol.core.CobolParser.*;
+
+import static java.util.Optional.ofNullable;
+import static org.eclipse.lsp.cobol.core.semantics.outline.OutlineNodeNames.FILLER_NAME;
+
+/**
+ * Utility class for visitor and delegates classes with useful methods
+ */
+@UtilityClass
+public class VisitorHelper {
+
+  /**
+   * Get variable level from TerminalNode object
+   * @param terminalNode is a TerminalNode
+   * @return a level of defined variable
+   */
+  public int getLevel(TerminalNode terminalNode) {
+    String levelNumber = terminalNode.getText();
+    return Integer.parseInt(levelNumber);
+  }
+
+  /**
+   * Get name of the statement object
+   * @param context is a statement context object
+   * @return a name of the statement
+   */
+  public String getName(EntryNameContext context) {
+    return ofNullable(context)
+            .map(EntryNameContext::dataName1)
+            .map(RuleContext::getText)
+            .orElse(FILLER_NAME);
+  }
+
+  /**
+   * Get name of statement context
+   * @param context is a statement context
+   * @return a name of statement context
+   */
+  public String getName(DataNameContext context) {
+    return context.getStart().getText().toUpperCase();
+  }
+
+  /**
+   * Get interval position of 2 localities
+   * @param start is a start position
+   * @param stop is end position
+   * @return Locality with interval position
+   */
+  public Locality getIntervalPosition(Locality start, Locality stop) {
+    return Locality.builder()
+        .uri(start.getUri())
+        .range(new Range(start.getRange().getStart(), stop.getRange().getEnd()))
+        .recognizer(VisitorHelper.class)
+        .copybookId(start.getCopybookId())
+        .build();
+  }
+}