1260 cfg semantic domain lite

CLI/src/CLI.cs

@@ -5,6 +5,7 @@
 using System.IO;
 using System.Linq;
 using System.Text;
+using TypeCobol.Analysis;
 using TypeCobol.CLI.CustomExceptions;
 using TypeCobol.Codegen;
 using TypeCobol.Compiler;
@@ -107,8 +108,9 @@ private ReturnCode Compile()
             //Load intrinsics and dependencies, it will build the root symbol table
             var rootSymbolTable = LoadIntrinsicsAndDependencies();
 
-            //Add report listeners
-            var reports = InitializeReports();
+            //Add analyzers
+            var analyzerProvider = new AnalyzerProvider();
+            var reports = RegisterAnalyzers(analyzerProvider);
 
             //Normalize TypeCobolOptions, the parser does not need to go beyond SemanticCheck for the first phase
             var typeCobolOptions = new TypeCobolOptions(_configuration);
@@ -121,7 +123,7 @@ private ReturnCode Compile()
             foreach (var inputFilePath in _configuration.InputFiles)
             {
                 var parser = new Parser(rootSymbolTable);
-                parser.Init(inputFilePath, typeCobolOptions, _configuration.Format, _configuration.CopyFolders);
+                parser.Init(inputFilePath, typeCobolOptions, _configuration.Format, _configuration.CopyFolders, analyzerProvider);
                 parser.Parse(inputFilePath);
 
                 //Collect results : parsing results, used and missing copies
@@ -229,30 +231,35 @@ private void CollectMissingCopies(IEnumerable<string> missingCopies)
             }
         }
 
-        private List<AbstractReport> InitializeReports()
+        private Dictionary<string, IReport> RegisterAnalyzers(AnalyzerProvider analyzerProvider)
         {
-            List<AbstractReport> reports = new List<AbstractReport>();
+            var reports = new Dictionary<string, IReport>();
             if (_configuration.ExecToStep >= ExecutionStep.CrossCheck)
             {
+                //CFG/DFA
+                analyzerProvider.AddActivator(
+                    (o, t) =>
+                        CfgDfaAnalyzerFactory.CreateCfgDfaAnalyzer("cfg-dfa", _configuration.CfgBuildingMode));
+
                 if (!string.IsNullOrEmpty(_configuration.ReportCopyMoveInitializeFilePath))
                 {
-                    Compiler.Parser.NodeDispatcher.RegisterStaticNodeListenerFactory(
-                        () =>
+                    analyzerProvider.AddActivator(
+                        (o, t) =>
                         {
-                            var report = new CopyMoveInitializeReport(_configuration.ReportCopyMoveInitializeFilePath);
-                            reports.Add(report);
+                            var report = new CopyMoveInitializeReport();
+                            reports.Add(_configuration.ReportCopyMoveInitializeFilePath, report);
                             return report;
                         });
 
                 }
 
                 if (!string.IsNullOrEmpty(_configuration.ReportZCallFilePath))
                 {
-                    Compiler.Parser.NodeDispatcher.RegisterStaticNodeListenerFactory(
-                        () =>
+                    analyzerProvider.AddActivator(
+                        (o, t) =>
                         {
-                            var report = new ZCallPgmReport(_configuration.ReportZCallFilePath);
-                            reports.Add(report);
+                            var report = new ZCallPgmReport();
+                            reports.Add(_configuration.ReportZCallFilePath, report);
                             return report;
                         });
 
@@ -318,19 +325,23 @@ private void StoreGenerationException(string inputFilePath, GenerationException
             generationExceptions.Add(generationException);
         }
 
-        private void CreateReports(string inputFilePath, IEnumerable<AbstractReport> reports)
+        private void CreateReports(string inputFilePath, Dictionary<string, IReport> reports)
         {
             foreach (var report in reports)
             {
+                string filePath = report.Key;
                 try
                 {
-                    report.Report();
-                    Console.WriteLine($"Succeed to emit report '{report.Filepath}'");
+                    using (var writer = File.CreateText(filePath))
+                    {
+                        report.Value.Report(writer);
+                    }
+                    Console.WriteLine($"Succeed to emit report '{filePath}'");
                 }
                 catch (Exception exception)
                 {
                     Console.Error.WriteLine(exception.Message);
-                    var generationException = new GenerationException(exception.Message, report.Filepath, exception);
+                    var generationException = new GenerationException(exception.Message, filePath, exception);
                     StoreGenerationException(inputFilePath, generationException);
                 }
             }
@@ -426,7 +437,7 @@ private void WriteCopiesFile(string copiesFilePath, IEnumerable<string> copies)
         private ReturnCode AddErrorsAndComputeReturnCode()
         {
             /*
-             * Here we start with a Sucesss return code, then we check all diagnostics from
+             * Here we start with a Success return code, then we check all diagnostics from
              * lowest to highest priority.
              */
 
@@ -507,7 +518,7 @@ private ReturnCode AddErrorsAndComputeReturnCode()
                 UpdateReturnCode(_intrinsicsDiagnostics.Select(dee => dee.Diagnostic).ToList());
             }
 
-            //Always retrun MissingCopy when there is at least one missing copy because it could help the developer to correct several parsing errors at once
+            //Always return MissingCopy when there is at least one missing copy because it could help the developer to correct several parsing errors at once
             if (_missingCopies.Count > 0)
             {
                 returnCode = ReturnCode.MissingCopy;

CLI/src/CLI.csproj

@@ -26,6 +26,10 @@
       <Project>{4034cbc5-d3dc-45e5-81f2-605579e6b876}</Project>
       <Name>Codegen</Name>
     </ProjectReference>
+    <ProjectReference Include="..\..\TypeCobol.Analysis\TypeCobol.Analysis.csproj">
+      <Project>{c3250314-c22b-4eb6-9174-17d0791af7be}</Project>
+      <Name>TypeCobol.Analysis</Name>
+    </ProjectReference>
     <ProjectReference Include="..\..\TypeCobol\TypeCobol.csproj">
       <Project>{7ac7a3e5-91f2-44bf-955d-86cc61375742}</Project>
       <Name>TypeCobol</Name>

Codegen/test/Performance.cs

@@ -59,7 +59,8 @@ private static void Test(string path, bool forceFullParsing = false)
                 Path.GetDirectoryName(path),
                 new[] { ".tcbl", ".cbl", ".cpy" },
                 DocumentFormat.RDZReferenceFormat,
-                new TypeCobolOptions());
+                new TypeCobolOptions(),
+                null);
             FileCompiler fileCompiler = new FileCompiler(compilationProject, fileName, false);
             fileCompiler.CompileOnce();
 

TypeCobol.Analysis.Test/BasicCfgInstrs/Alter0.cbl

@@ -0,0 +1,24 @@
+       IDENTIFICATION DIVISION.
+       PROGRAM-ID. HELLO.
+
+       PROCEDURE DIVISION.
+
+       A-PARA.
+           PERFORM  DISPLAY 'IN A-PARA'
+           END-PERFORM.
+           PERFORM C-PARA THRU E-PARA.
+           ALTER B-PARA TO PROCEED TO E-PARA.
+       B-PARA. GO TO B-PARA.
+           DISPLAY 'IN B-PARA'.
+           GOBACK.
+
+       C-PARA.
+           DISPLAY 'IN C-PARA'.
+
+       D-PARA.
+           DISPLAY 'IN D-PARA'.
+
+       E-PARA.
+           DISPLAY 'IN E-PARA'.
+       END PROGRAM HELLO.
+

TypeCobol.Analysis.Test/BasicCfgInstrs/Alter0.diag

@@ -0,0 +1,2 @@
+--- Diagnostics ---
+Line 10[12,16] <37, Warning, General> - Warning: ALTER should not be used

TypeCobol.Analysis.Test/BasicCfgInstrs/Alter0.dot

@@ -0,0 +1,73 @@
+digraph Cfg {
+compound=true;
+node [
+shape = "record"
+]
+
+edge [
+arrowtail = "empty"
+]
+Block0 [
+label = "{START|}"
+]
+Block1 [
+label = "{A-PARA. Block1|}"
+]
+Block2 [
+label = "{Block2|    PERFORM\l}"
+]
+Block3 [
+label = "{Block3|             DISPLAY 'IN A-PARA'\l}"
+]
+Block4 [
+label = "{Block4|}"
+]
+Block5 [
+label = "{A-PARA. Block5|}"
+]
+Block6 [
+label = "{Block6|    PERFORM C-PARA THRU E-PARA\l}"
+]
+subgraph cluster_1{
+color = blue;
+label = "C-PARA";
+Block17 [
+label = "{C-PARA. Block17|    DISPLAY 'IN C-PARA'\l}"
+]
+Block18 [
+label = "{D-PARA. Block18|    DISPLAY 'IN D-PARA'\l}"
+]
+Block19 [
+label = "{E-PARA. Block19|    DISPLAY 'IN E-PARA'\l}"
+]
+
+}
+Block6 -> Block17 [style=dashed]
+
+Block7 [
+label = "{Block7|}"
+]
+Block8 [
+label = "{A-PARA. Block8|    ALTER B-PARA TO PROCEED TO E-PARA\l}"
+]
+Block9 [
+label = "{B-PARA. Block9|        GO TO B-PARA\l}"
+]
+Block16 [
+label = "{E-PARA. Block16|    DISPLAY 'IN E-PARA'\l}"
+]
+Block0 -> Block1
+Block1 -> Block2
+Block2 -> Block3
+Block3 -> Block4
+Block4 -> Block5
+Block5 -> Block6
+Block17 -> Block18
+Block18 -> Block19
+Block6 -> Block7
+Block7 -> Block8
+Block8 -> Block9
+Block9 -> Block9
+Block9 -> Block16
+
+}

TypeCobol.Analysis.Test/BasicCfgInstrs/Alter1.cbl

@@ -0,0 +1,37 @@
+       IDENTIFICATION DIVISION.
+       PROGRAM-ID. ALTER1.
+       procedure division.
+       main section.
+
+      *> And now do some altering.
+       entrance.
+           ALTER front TO PROCEED TO atstart
+           GO TO front
+           .
+
+      *> Jump to a part of the front
+       front.
+           GO TO atstart.
+
+      *> the first part
+       atstart.
+           ALTER front TO PROCEED to middle
+           DISPLAY "This is the start of a changing front"
+           GO TO front
+           .
+
+      *> the middle bit
+       middle.
+           ALTER front TO PROCEED to atfinish
+           DISPLAY "The front progresses"
+           GO TO front
+           .
+
+      *> the climatic finish
+       atfinish.
+           DISPLAY "The front ends, happily ever after"
+           .
+
+      *> fall through to the exit
+       END PROGRAM ALTER1.
+

TypeCobol.Analysis.Test/BasicCfgInstrs/Alter1.diag

@@ -0,0 +1,4 @@
+--- Diagnostics ---
+Line 8[12,16] <37, Warning, General> - Warning: ALTER should not be used
+Line 18[12,16] <37, Warning, General> - Warning: ALTER should not be used
+Line 25[12,16] <37, Warning, General> - Warning: ALTER should not be used

TypeCobol.Analysis.Test/BasicCfgInstrs/Alter1.dot

@@ -0,0 +1,35 @@
+digraph Cfg {
+node [
+shape = "record"
+]
+
+edge [
+arrowtail = "empty"
+]
+Block0 [
+label = "{START|}"
+]
+Block1 [
+label = "{ENTRANCE. Block1|    ALTER front TO PROCEED TO atstart\l    GO TO front\l}"
+]
+Block3 [
+label = "{FRONT. Block3|    GO TO atstart\l}"
+]
+Block5 [
+label = "{ATSTART. Block5|    ALTER front TO PROCEED to middle\l    DISPLAY \"This is the start of a changing front\"\l    GO TO front\l}"
+]
+Block7 [
+label = "{MIDDLE. Block7|    ALTER front TO PROCEED to atfinish\l    DISPLAY \"The front progresses\"\l    GO TO front\l}"
+]
+Block9 [
+label = "{ATFINISH. Block9|    DISPLAY \"The front ends, happily ever after\"\l}"
+]
+Block0 -> Block1
+Block1 -> Block3
+Block3 -> Block5
+Block3 -> Block7
+Block3 -> Block9
+Block5 -> Block3
+Block7 -> Block3
+
+}

TypeCobol.Analysis.Test/BasicCfgInstrs/Alter2.cbl

@@ -0,0 +1,37 @@
+       IDENTIFICATION DIVISION.
+       PROGRAM-ID. ALTER2.
+       procedure division.
+       main section.
+
+      *> And now do some altering.
+       entrance.
+           ALTER front TO PROCEED TO atstart OF MAIN
+           GO TO front
+           .
+
+      *> Jump to a part of the front
+       front.
+           GO TO atstart.
+
+      *> the first part
+       atstart.
+           ALTER front TO PROCEED to middle of MAIN
+           DISPLAY "This is the start of a changing front"
+           GO TO front
+           .
+
+      *> the middle bit
+       middle.
+           ALTER front TO PROCEED to main::atfinish
+           DISPLAY "The front progresses"
+           GO TO main::front
+           .
+
+      *> the climatic finish
+       atfinish.
+           DISPLAY "The front ends, happily ever after"
+           .
+
+      *> fall through to the exit
+       END PROGRAM ALTER2.
+

TypeCobol.Analysis.Test/BasicCfgInstrs/Alter2.diag

@@ -0,0 +1,4 @@
+--- Diagnostics ---
+Line 8[12,16] <37, Warning, General> - Warning: ALTER should not be used
+Line 18[12,16] <37, Warning, General> - Warning: ALTER should not be used
+Line 25[12,16] <37, Warning, General> - Warning: ALTER should not be used