feature: add semantics check for file IO operations

Signed-off-by: Aman Prashant <[email protected]>

Author: ap891843

server/common/src/main/java/org/eclipse/lsp/cobol/common/model/FileOperationKind.java

@@ -0,0 +1,24 @@
+/*
+ * 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.common.model;
+
+/** Enumeration of file operation types */
+public enum FileOperationKind {
+  INPUT,
+  OUTPUT,
+  I_O,
+  EXTEND
+}

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

@@ -16,49 +16,55 @@
 
 /** Enumeration of Node types. */
 public enum NodeType {
-  ROOT,
-  PROGRAM,
-  SECTION,
-  VARIABLE_DEFINITION,
-  VARIABLE_DEFINITION_NAME,
-  QUALIFIED_REFERENCE_NODE,
-  VARIABLE_USAGE,
-  VARIABLE,
-  FILE_USAGE,
-  FILE_CONTROL_ENTRY,
-  PROGRAM_ID,
-  PROGRAM_END,
-  PROCEDURE_DIVISION,
-  PARAGRAPH,
-  GO_TO,
-  PROCEDURE_SECTION,
-  PERFORM,
-  EXIT,
-  EXIT_SECTION,
-  GO_BACK,
-  STOP,
+  AT_END,
+  CODE_BLOCK_PARENT,
+  CODE_BLOCK_USAGE,
+  COMPILER_DIRECTIVE,
+  COPY,
+  CUSTOM,
+  DELETE_STATEMENT,
+  DIVISION,
+  EMBEDDED_CODE,
   EVALUATE,
   EVALUATE_WHEN,
   EVALUATE_WHEN_OTHER,
+  EXIT,
+  EXIT_SECTION,
+  FILE_CONTROL_ENTRY,
+  FILE_USAGE,
+  GO_BACK,
+  GO_TO,
   IF,
   IF_ELSE,
-  JSON_PARSE,
-  XML_PARSE,
   JSON_GENERATE,
+  JSON_PARSE,
+  LITERAL,
+  OBSOLETE,
+  OPEN_STATEMENT,
+  PARAGRAPH,
+  PARAGRAPH_NAME_NODE,
+  PERFORM,
+  PROCEDURE_DIVISION,
+  PROCEDURE_SECTION,
+  PROGRAM,
+  PROGRAM_END,
+  PROGRAM_ID,
+  QUALIFIED_REFERENCE_NODE,
+  READ_STATEMENT,
+  REWRITE_STATEMENT,
+  ROOT,
+  SECTION,
+  SECTION_NAME_NODE,
   SENTENCE,
+  START_STATEMENT,
   STATEMENT,
-  EMBEDDED_CODE,
-  CODE_BLOCK_USAGE,
-  CODE_BLOCK_PARENT,
-  COPY,
-  DIVISION,
-  LITERAL,
+  STOP,
   SUBROUTINE,
   SUBROUTINE_NAME_NODE,
-  PARAGRAPH_NAME_NODE,
-  SECTION_NAME_NODE,
-  CUSTOM,
-  OBSOLETE,
-  AT_END,
-  COMPILER_DIRECTIVE
+  VARIABLE,
+  VARIABLE_DEFINITION,
+  VARIABLE_DEFINITION_NAME,
+  VARIABLE_USAGE,
+  WRITE_STATEMENT,
+  XML_PARSE
 }

server/common/src/main/java/org/eclipse/lsp/cobol/common/model/tree/statements/StatementNode.java

@@ -17,6 +17,7 @@
 
 import lombok.extern.slf4j.Slf4j;
 import org.eclipse.lsp.cobol.common.model.Locality;
+import org.eclipse.lsp.cobol.common.model.NodeType;
 import org.eclipse.lsp.cobol.common.model.tree.Node;
 
 import static org.eclipse.lsp.cobol.common.model.NodeType.STATEMENT;
@@ -31,4 +32,8 @@ public abstract class StatementNode extends Node {
   protected StatementNode(Locality locality) {
     super(locality, STATEMENT);
   }
+
+  protected StatementNode(Locality locality, NodeType nodeType) {
+    super(locality, nodeType);
+  }
 }

server/common/src/main/java/org/eclipse/lsp/cobol/common/model/tree/variable/VariableDefinitionNode.java

@@ -56,6 +56,7 @@ public final class VariableDefinitionNode extends Node {
   private final boolean isSignClausePresent;
   private final String valueToken;
   private final String fileDescriptor;
+  private final boolean isExternal;
   @Setter private String fileControlClause;
   private final boolean isSortDescription;
   @Setter private List<UsageFormat> usageClauses;
@@ -85,7 +86,8 @@ private VariableDefinitionNode(
       boolean isSortDescription,
       boolean isDynamicLength,
       boolean isJustified,
-      boolean isUnBounded) {
+      boolean isUnBounded,
+      boolean isExternal) {
     super(location, NodeType.VARIABLE_DEFINITION);
     this.level = level;
     this.variableName = variableName;
@@ -108,6 +110,7 @@ private VariableDefinitionNode(
     this.isDynamicLength = isDynamicLength;
     this.isJustified = isJustified;
     this.isUnBounded = isUnBounded;
+    this.isExternal = isExternal;
   }
 
   private static SyntaxError checkClauseIsSingle(
@@ -356,6 +359,7 @@ public static final class Builder {
     boolean isDynamicLength;
     boolean isJustified;
     boolean isUnBounded;
+    boolean isExternal;
 
     private Builder() {}
 
@@ -387,7 +391,8 @@ public VariableDefinitionNode build() {
           isSortDescription,
           isDynamicLength,
           isJustified,
-          isUnBounded);
+          isUnBounded,
+          isExternal);
     }
   }
 }

server/common/src/main/java/org/eclipse/lsp/cobol/common/model/tree/variables/FileDescriptionNode.java

@@ -31,6 +31,7 @@
 @ToString(callSuper = true)
 @EqualsAndHashCode(callSuper = true)
 public class FileDescriptionNode extends VariableNode {
+  @Getter private final boolean isExternal;
   @Getter private final String fileDescriptorText;
   @Getter private final String fileControlClause;
 
@@ -39,9 +40,11 @@ public FileDescriptionNode(
       String name,
       VariableType variableType,
       boolean global,
+      boolean isExternal,
       String fileDescriptorText,
       String fileControlClause) {
     super(location, name, variableType, global);
+    this.isExternal = isExternal;
     this.fileDescriptorText = fileDescriptorText;
     this.fileControlClause = fileControlClause;
   }

server/engine/src/main/java/org/eclipse/lsp/cobol/cfg/CFASTBuilderImpl.java

@@ -15,6 +15,7 @@
 package org.eclipse.lsp.cobol.cfg;
 
 import org.eclipse.lsp.cobol.common.model.tree.*;
+import org.eclipse.lsp.cobol.common.model.tree.statements.StatementNode;
 import org.eclipse.lsp.cobol.common.model.variables.DivisionType;
 import org.eclipse.lsp.cobol.core.model.extendedapi.*;
 import org.eclipse.lsp4j.Position;
@@ -77,6 +78,8 @@ private void traverse(CFASTNode parent, Node node) {
       addChild(parent, new CFASTNode(CFASTNodeType.ENDIF.getValue()));
     } else if (node instanceof SentenceNode) {
       node.getChildren().forEach(child -> traverse(parent, child));
+    } else if (node instanceof StatementNode) {
+      node.getChildren().forEach(child -> traverse(parent, child));
     } else if (node instanceof IfElseNode) {
       addChild(parent, new CFASTNode(CFASTNodeType.ELSE.getValue()));
       node.getChildren().forEach(child -> traverse(parent, child));

server/engine/src/main/java/org/eclipse/lsp/cobol/core/engine/pipeline/stages/TransformTreeStage.java

@@ -37,6 +37,8 @@
 import org.eclipse.lsp.cobol.core.engine.processors.implicit.ImplicitVariablesProcessor;
 import org.eclipse.lsp.cobol.core.engine.symbols.SymbolAccumulatorService;
 import org.eclipse.lsp.cobol.core.engine.symbols.SymbolsRepository;
+import org.eclipse.lsp.cobol.core.model.tree.FileOperationStatementNode;
+import org.eclipse.lsp.cobol.core.model.tree.logic.FileOperationProcess;
 import org.eclipse.lsp.cobol.core.semantics.CopybooksRepository;
 import org.eclipse.lsp.cobol.core.visitor.CobolVisitor;
 import org.eclipse.lsp.cobol.service.settings.CachingConfigurationService;
@@ -207,6 +209,7 @@ private void registerProcessors(AnalysisConfig analysisConfig, ProcessingContext
     ctx.register(v, JsonGenerateNode.class, new JsonGenerateProcess(symbolAccumulatorService));
     ctx.register(v, XMLParseNode.class, new XMLParseProcess(symbolAccumulatorService));
     ctx.register(v, FileStatusNode.class, new FileStatusProcess(symbolAccumulatorService));
+    ctx.register(v, FileOperationStatementNode.class, new FileOperationProcess());
 
     // Dialects
     List<ProcessorDescription> pds = dialectService.getProcessors(analysisConfig.getDialects());