Merge pull request #2051 from TypeCobolTeam/v1.5.7

V1.5.7

Author: mayanje

Analytics/packages.config

@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="Elasticsearch.Net" version="7.5.1" targetFramework="net47" />
-  <package id="NLog" version="4.7.2" targetFramework="net47" />
-  <package id="System.Buffers" version="4.5.0" targetFramework="net47" />
-  <package id="System.Diagnostics.DiagnosticSource" version="4.7.0" targetFramework="net47" />
-  <package id="System.Memory" version="4.5.3" targetFramework="net47" />
-  <package id="System.Numerics.Vectors" version="4.5.0" targetFramework="net47" />
-  <package id="System.Runtime.CompilerServices.Unsafe" version="4.7.0" targetFramework="net47" />
+  <package id="Elasticsearch.Net" version="7.5.1" targetFramework="net472" />
+  <package id="NLog" version="4.7.2" targetFramework="net472" />
+  <package id="System.Buffers" version="4.5.0" targetFramework="net472" />
+  <package id="System.Diagnostics.DiagnosticSource" version="4.7.0" targetFramework="net472" />
+  <package id="System.Memory" version="4.5.3" targetFramework="net472" />
+  <package id="System.Numerics.Vectors" version="4.5.0" targetFramework="net472" />
+  <package id="System.Runtime.CompilerServices.Unsafe" version="4.7.0" targetFramework="net472" />
 </packages>

CLI/src/CLI.cs

@@ -41,8 +41,7 @@ internal static ReturnCode runOnce(TypeCobolConfiguration config)
                 debugLine += Path.GetFileName(config.InputFiles[0]);
             }
             debugLine += "\n";
-            //Use user-defined log path if -log option used, otherwise use default location for log file
-            File.AppendAllText(config.LogFile ?? TypeCobolConfiguration.DefaultLogFileName, debugLine);
+            Logger(config, debugLine);
             Console.WriteLine(debugLine);
             TextWriter textWriter = config.ErrorFile == null ?  Console.Error : File.CreateText(config.ErrorFile);
             AbstractErrorWriter errorWriter;
@@ -84,8 +83,7 @@ internal static ReturnCode runOnce(TypeCobolConfiguration config)
 
             stopWatch.Stop();
             debugLine = "                         parsed in " + stopWatch.Elapsed + " ms\n";
-            //Use user-defined log path if -log option used, otherwise use default location for log file
-            File.AppendAllText(config.LogFile ?? TypeCobolConfiguration.DefaultLogFileName, debugLine);
+            Logger(config, debugLine);
             Console.WriteLine(debugLine);
 
             AnalyticsWrapper.Telemetry.TrackMetricsEvent(EventType.Duration, LogType.Genration, "ExecutionTime", stopWatch.Elapsed.Milliseconds);
@@ -122,11 +120,11 @@ private ReturnCode Compile()
             var rootSymbolTable = LoadIntrinsicsAndDependencies();
 
             //Add analyzers
-            var analyzerProvider = new CompositeAnalyzerProvider();
+            var analyzerProvider = new AnalyzerProviderWrapper(str => Logger(_configuration, str));
             var reports = RegisterAnalyzers(analyzerProvider);
 
             //Add external analyzers
-            analyzerProvider.AddCustomProviders(_configuration.CustomAnalyzerFiles);
+            analyzerProvider.AddCustomProviders(_configuration.CustomAnalyzerFiles, str => Logger(_configuration, str));
 
             //Normalize TypeCobolOptions, the parser does not need to go beyond SemanticCheck for the first phase
             var typeCobolOptions = new TypeCobolOptions(_configuration);
@@ -199,10 +197,24 @@ private ReturnCode Compile()
             //Write used and missing copies files
             WriteCopiesFile(_configuration.ExtractedCopiesFilePath, _usedCopies);
             WriteCopiesFile(_configuration.HaltOnMissingCopyFilePath, _missingCopies);
+#if EUROINFO_RULES
+            WriteUsedCopiesFile();
+#endif
 
             return AddErrorsAndComputeReturnCode();
         }
 
+        /// <summary>
+        /// Log a string in the LogFile provided by the configuration.
+        /// </summary>
+        /// <param name="config">Configuration containing the log file.</param>
+        /// <param name="message">String to log.</param>
+        private static void Logger(TypeCobolConfiguration config, string message)
+        {
+            //Use user-defined log path if -log option used, otherwise use default location for log file
+            File.AppendAllText(config.LogFile ?? TypeCobolConfiguration.DefaultLogFileName, message);
+        }
+
         private SymbolTable LoadIntrinsicsAndDependencies()
         {
             var intrinsicsAndDependenciesParser = new Parser();
@@ -251,21 +263,21 @@ private void CollectMissingCopies(IEnumerable<string> missingCopies)
             }
         }
 
-        private Dictionary<string, IReport> RegisterAnalyzers(AnalyzerProvider analyzerProvider)
+        private Dictionary<string, IReport> RegisterAnalyzers(AnalyzerProviderWrapper analyzerProviderWrapper)
         {
             var reports = new Dictionary<string, IReport>();
             if (_configuration.ExecToStep >= ExecutionStep.CrossCheck)
             {
                 //All purpose CFG/DFA
-                analyzerProvider.AddActivator((o, t) => CfgDfaAnalyzerFactory.CreateCfgAnalyzer(_configuration.CfgBuildingMode));
+                analyzerProviderWrapper.AddActivator((o, t) => CfgDfaAnalyzerFactory.CreateCfgAnalyzer(_configuration.CfgBuildingMode, o));
 
                 //CFG/DFA for ZCALL report
                 if (!string.IsNullOrEmpty(_configuration.ReportZCallFilePath))
                 {
                     if (_configuration.CfgBuildingMode != CfgBuildingMode.WithDfa)
                     {
                         //Need to create a dedicated CFG builder with DFA activated
-                        analyzerProvider.AddActivator((o, t) => CfgDfaAnalyzerFactory.CreateCfgAnalyzer(CfgBuildingMode.WithDfa));
+                        analyzerProviderWrapper.AddActivator((o, t) => CfgDfaAnalyzerFactory.CreateCfgAnalyzer(CfgBuildingMode.WithDfa, o));
                     }
 
                     string zCallCfgDfaId = CfgDfaAnalyzerFactory.GetIdForMode(CfgBuildingMode.WithDfa);
@@ -276,7 +288,7 @@ private Dictionary<string, IReport> RegisterAnalyzers(AnalyzerProvider analyzerP
                 //CopyMoveInitializeReport
                 if (!string.IsNullOrEmpty(_configuration.ReportCopyMoveInitializeFilePath))
                 {
-                    analyzerProvider.AddActivator(
+                    analyzerProviderWrapper.AddActivator(
                         (o, t) =>
                         {
                             var report = new CopyMoveInitializeReport();
@@ -461,6 +473,42 @@ private void WriteCopiesFile(string copiesFilePath, IEnumerable<string> copies)
             }
         }
 
+#if EUROINFO_RULES
+        private void WriteUsedCopiesFile()
+        {
+            if (_configuration.ReportUsedCopyNamesPath != null)
+            {
+                using (var output = File.CreateText(_configuration.ReportUsedCopyNamesPath))
+                {
+                    foreach (var parserResult in _parserResults)
+                    {
+                        string fileName = Path.GetFileNameWithoutExtension(parserResult.Key);
+                        var usedCopies = parserResult.Value.CollectedCopyNames;
+
+                        if (usedCopies == null)
+                        {
+                            output.WriteLine(fileName);
+                            continue;
+                        }
+
+                        foreach (var usedCopy in usedCopies)
+                        {
+                            output.Write(fileName);
+                            output.Write(';');
+                            output.Write(usedCopy.Key);
+                            foreach (var suffixedName in usedCopy.Value)
+                            {
+                                output.Write(';');
+                                output.Write(suffixedName);
+                            }
+                            output.WriteLine();
+                        }
+                    }
+                }
+            }
+        }
+#endif
+
         private ReturnCode AddErrorsAndComputeReturnCode()
         {
             /*
@@ -513,7 +561,7 @@ private ReturnCode AddErrorsAndComputeReturnCode()
                         if (generationException.Logged)
                         {
                             string message = generationException.Message + Environment.NewLine + generationException.StackTrace;
-                            var position = new Diagnostic.Position(generationException.LineNumber, generationException.ColumnStartIndex, generationException.ColumnEndIndex, null);
+                            var position = new Diagnostic.Position(generationException.LineNumber, generationException.ColumnStartIndex, generationException.LineNumber, generationException.ColumnEndIndex, null);
                             Server.AddError(_errorWriter, generationException.Path, new Diagnostic(generationException.MessageCode, position, message));
                         }
                     }
@@ -524,7 +572,20 @@ private ReturnCode AddErrorsAndComputeReturnCode()
             CheckExternalDiagnostics(_dependenciesDiagnostics);
             CheckExternalDiagnostics(_intrinsicsDiagnostics);
 
-            //Always return MissingCopy when there is at least one missing copy because it could help the developer to correct several parsing errors at once
+            //Avoid returning MissingCopy for users who are only interested in copies extraction
+            if (_configuration.ExecToStep <= ExecutionStep.Preprocessor)
+            {
+	            if (_configuration.ExtractedCopiesFilePath != null
+#if EUROINFO_RULES
+	                || _configuration.ReportUsedCopyNamesPath != null
+#endif
+	               )
+	            {
+		            return returnCode;
+	            }
+            }
+
+            //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/Writer.cs

@@ -141,7 +141,7 @@ private void writeMessage(string id, Diagnostic error) {
             writer.WriteStartElement("MESSAGE");
             writer.WriteElementString("MSGNUMBER",
                 "TC-" + error.Info.Code.ToString().PadLeft(5, '0') + AsIBMSuffix((int) error.Info.Severity));
-            writer.WriteElementString("MSGLINE", error.Line.ToString());
+            writer.WriteElementString("MSGLINE", error.LineStart.ToString());
             writer.WriteElementString("MSGFILE", id);
             writer.WriteElementString("MSGTEXT", error.Message);
             writer.WriteEndElement(); // MESSAGE
@@ -246,9 +246,9 @@ private void WriteDiagnostics()
 
                     //range
                     _xmlWriter.WriteStartElement("range");
-                    _xmlWriter.WriteAttributeString("line-start", diagnostic.Line.ToString());
+                    _xmlWriter.WriteAttributeString("line-start", diagnostic.LineStart.ToString());
                     _xmlWriter.WriteAttributeString("column-start", diagnostic.ColumnStart.ToString());
-                    _xmlWriter.WriteAttributeString("line-end", diagnostic.Line.ToString());
+                    _xmlWriter.WriteAttributeString("line-end", diagnostic.LineEnd.ToString());
                     _xmlWriter.WriteAttributeString("column-end", diagnostic.ColumnEnd.ToString());
                     _xmlWriter.WriteEndElement();
 

CLI/test/CLI.Test.csproj

@@ -18,18 +18,9 @@
   <ItemGroup>
     <Reference Include="System" />
   </ItemGroup>
-  <Choose>
-    <When Condition="('$(VisualStudioVersion)' == '10.0' or '$(VisualStudioVersion)' == '') and '$(TargetFrameworkVersion)' == 'v3.5'">
-      <ItemGroup>
-        <Reference Include="Microsoft.VisualStudio.QualityTools.UnitTestFramework, Version=10.1.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL" />
-      </ItemGroup>
-    </When>
-    <Otherwise>
-      <ItemGroup>
-        <Reference Include="Microsoft.VisualStudio.QualityTools.UnitTestFramework" />
-      </ItemGroup>
-    </Otherwise>
-  </Choose>
+  <ItemGroup>
+    <Reference Include="Microsoft.VisualStudio.QualityTools.UnitTestFramework" />
+  </ItemGroup>
   <ItemGroup>
     <Compile Include="*.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />

CLI/test/CLITest.cs

@@ -378,8 +378,8 @@ public void TestRDZFormatInputEncodings()
         [TestMethod]
         public void TestCustomAnalyzers()
         {
-            CLITestHelper.Test("custom_analyzers", ReturnCode.Warning);
-            CLITestHelper.Test("custom_analyzers_withcfg", ReturnCode.Warning);
+            CLITestHelper.Test("custom_analyzers", ReturnCode.ParsingDiagnostics);
+            CLITestHelper.Test("custom_analyzers_withcfg", ReturnCode.ParsingDiagnostics);
         }
 
 #if EUROINFO_RULES

CLI/test/ressources/custom_analyzers/output_expected/errors.txt

@@ -1,8 +1,9 @@
-ReturnCode=Warning_
-6 errors in "input\CustomAnalyzers.rdz.tcbl":
+ReturnCode=ParsingDiagnostics_
+7 errors in "input\CustomAnalyzers.rdz.tcbl":
 Line 0[0,0] <45, Warning, General> - Info: Analyzer 'DummySyntaxDrivenAnalyzer': starting AST building...
 Line 0[0,0] <45, Warning, General> - Info: Analyzer 'DummySyntaxDrivenAnalyzer': finished AST building.
 Line 0[0,0] <45, Warning, General> - Info: Analyzer 'DummyQualityAnalyzer': number of tokens (after preprocessing): 32
 Line 0[0,0] <45, Warning, General> - Info: Analyzer 'DummyQualityAnalyzer': number of code elements: 9
 Line 0[0,0] <45, Warning, General> - Info: Analyzer 'DummyQualityAnalyzer': source file has 1 program(s), main program is 'DVZZMFT0'.
+Line 0[0,0] <46, Error, CodeAnalysis> - CodeAnalysis: analyzer 'DummyQualityAnalyzerErrorInAnalysis' failed. Exception message is 'Exception in AST analysis intended.'
 Line 0[0,0] <45, Warning, General> - Info: CFG/DFA analysis: no control flow graph found for this file.

CLI/test/ressources/custom_analyzers_withcfg/output_expected/errors.txt

@@ -1,8 +1,9 @@
-ReturnCode=Warning_
-6 errors in "input\CustomAnalyzers.rdz.tcbl":
+ReturnCode=ParsingDiagnostics_
+7 errors in "input\CustomAnalyzers.rdz.tcbl":
 Line 0[0,0] <45, Warning, General> - Info: Analyzer 'DummySyntaxDrivenAnalyzer': starting AST building...
 Line 0[0,0] <45, Warning, General> - Info: Analyzer 'DummySyntaxDrivenAnalyzer': finished AST building.
 Line 0[0,0] <45, Warning, General> - Info: Analyzer 'DummyQualityAnalyzer': number of tokens (after preprocessing): 32
 Line 0[0,0] <45, Warning, General> - Info: Analyzer 'DummyQualityAnalyzer': number of code elements: 9
 Line 0[0,0] <45, Warning, General> - Info: Analyzer 'DummyQualityAnalyzer': source file has 1 program(s), main program is 'DVZZMFT0'.
+Line 0[0,0] <46, Error, CodeAnalysis> - CodeAnalysis: analyzer 'DummyQualityAnalyzerErrorInAnalysis' failed. Exception message is 'Exception in AST analysis intended.'
 Line 2[20,27] <45, Warning, General> - Info: CFG/DFA analysis: control flow graphs contains 2 blocks.

CLI/test/ressources/dependenciesNotLoadedInCorrectOrder/output_expected/error.txt

@@ -1,4 +1,4 @@
-ReturnCode=ParsingDiagnostics_
+ReturnCode=ParsingDiagnostics_
 2 errors in "input\MainPgm.rdz.tcbl":
-Line 15[12,20] <27, Error, Syntax> - Syntax error : Function 'DVZTEST1.GetTecMsg' expected parameter 'capt' of type DVZTEST2.Span and received 't1' of type TCOSMPL2.type1 
-Line 18[12,20] <27, Error, Syntax> - Syntax error : Function 'GetTecMsg' expected parameter 'capt' of type DVZTEST2.Span and received 't1' of type TCOSMPL2.type1 
+Range (15, 12) -> (16, 20) <27, Error, Syntax> - Syntax error : Function 'DVZTEST1.GetTecMsg' expected parameter 'capt' of type DVZTEST2.Span and received 't1' of type TCOSMPL2.type1 
+Range (18, 12) -> (19, 20) <27, Error, Syntax> - Syntax error : Function 'GetTecMsg' expected parameter 'capt' of type DVZTEST2.Span and received 't1' of type TCOSMPL2.type1 

CLI/test/ressources/dependencies_3/output_expected/error.txt

@@ -1,3 +1,3 @@
-ReturnCode=ParsingDiagnostics_
+ReturnCode=ParsingDiagnostics_
 1 error in "input\PGM3.rdz.tcbl":
-Line 26[12,39] <30, Error, Semantics> - Semantic error: Function not found 'MyPublicProcedure' input(DATE)
+Range (26, 12) -> (27, 39) <30, Error, Semantics> - Semantic error: Function not found 'MyPublicProcedure' input(DATE)

CLI/test/ressources/documentation/output_expected/error.txt

@@ -1,8 +1,8 @@
 ReturnCode=Warning_
 6 errors in "input\DocGen.tcbl":
-Line 9[13,18] <37, Warning, General> - Warning: Type Definition does not support Parameters field
 Line 9[13,18] <37, Warning, General> - Warning: Formalized comment field is declared more than once : params
 Line 13[12,17] <37, Warning, General> - Warning: Formalized comment field is declared more than once : Params
+Line 9[13,18] <37, Warning, General> - Warning: Type Definition does not support Parameters field
 Line 60[12,14] <37, Warning, General> - Warning: Parameter name does not match to any function parameter: blu
 Line 65[21,26] <37, Warning, General> - Warning: Parameter does not have any description inside the formalized comments: myBool
 Line 67[21,23] <37, Warning, General> - Warning: Parameter does not have any description inside the formalized comments: bli