WI #2185 #2319 Add last 5 incremental changes into debug trace (#2426)

Author: fm-117

TypeCobol/Compiler/CompilationUnit.cs

@@ -49,6 +49,7 @@ public CompilationUnit(TextSourceInfo textSourceInfo, bool isImported, IEnumerab
                 _analyzerProvider = null;
             }
 
+            _history = this.TrackChanges(5);
         }
 
         /// <summary>
@@ -235,6 +236,8 @@ public void RefreshProgramClassDocumentSnapshot()
 #endif
         }
 
+        private readonly IncrementalChangesHistory _history;
+
         /// <summary>
         /// Creates a temporary snapshot which contains element before the cross check phase
         /// Usefull to create a program symboltable without checking nodes.
@@ -263,6 +266,7 @@ public void ProduceTemporarySemanticDocument()
                         CustomSymbols,
                         perfStatsForParserInvocation,
                         customAnalyzers,
+                        _history,
                         out var root,
                         out var newDiagnostics,
                         out var nodeCodeElementLinkers,

TypeCobol/Compiler/CupParser/NodeBuilder/ProgramClassBuilder.cs

@@ -37,10 +37,26 @@ private void LogErrorIncludingFullSourceCode(string message)
                 }
             }
 
+            var changes = new StringBuilder();
+            int i = -4; //Number last 5 changes from -4 to 0
+            foreach (var textChangedEvent in _history.TextChangedEvents)
+            {
+                changes.AppendLine($"change {i}:");
+                foreach (var documentChange in textChangedEvent.DocumentChanges)
+                {
+                    string text = documentChange.NewLine == null
+                        ? string.Empty
+                        : '"' + documentChange.NewLine.Text + '"';
+                    changes.AppendLine($"{documentChange.Type}@{documentChange.LineIndex} {text}");
+                }
+                i++;
+            }
+
             var contextData = new Dictionary<string, object>()
                               {
                                   { "codeElements", codeElements.ToString() },
-                                  { "sourceCode", sourceCode.ToString() }
+                                  { "sourceCode", sourceCode.ToString() },
+                                  { "changes", changes.ToString() }
                               };
             LoggingSystem.LogMessage(LogLevel.Error, message, contextData);
 
@@ -88,8 +104,9 @@ private Program CurrentProgram
         private readonly SymbolTable TableOfNamespaces;
 
         private readonly IReadOnlyList<CodeElementsLine> _codeElementsLines;
+        private readonly IncrementalChangesHistory _history;
 
-        public ProgramClassBuilder(IReadOnlyList<CodeElementsLine> codeElementsLines)
+        public ProgramClassBuilder(IReadOnlyList<CodeElementsLine> codeElementsLines, IncrementalChangesHistory history)
         {
             // Intrinsics and Namespaces always exist. Intrinsic table has no enclosing scope.
             TableOfIntrinsics = new SymbolTable(null, SymbolTable.Scope.Intrinsic);
@@ -98,6 +115,7 @@ public ProgramClassBuilder(IReadOnlyList<CodeElementsLine> codeElementsLines)
             programsStack = new Stack<Program>();
 
             _codeElementsLines = codeElementsLines;
+            _history = history;
         }
 
         public SymbolTable CustomSymbols

TypeCobol/Compiler/Parser/ProgramClassParserStep.cs

@@ -47,6 +47,7 @@ public static void CupParseProgramOrClass(
             SymbolTable customSymbols,
             PerfStatsForParserInvocation perfStatsForParserInvocation,
             ISyntaxDrivenAnalyzer[] customAnalyzers,
+            IncrementalChangesHistory history,
             out SourceFile root,
             out List<Diagnostic> diagnostics, 
             out Dictionary<CodeElement, Node> nodeCodeElementLinkers,
@@ -69,7 +70,7 @@ public static void CupParseProgramOrClass(
             CupParser.TypeCobolProgramParser parser = new CupParser.TypeCobolProgramParser(scanner);
             CupParserTypeCobolProgramDiagnosticErrorReporter diagReporter = new CupParserTypeCobolProgramDiagnosticErrorReporter();
             parser.ErrorReporter = diagReporter;
-            ProgramClassBuilder builder = new ProgramClassBuilder(codeElementsLines);
+            ProgramClassBuilder builder = new ProgramClassBuilder(codeElementsLines, history);
             parser.Builder = builder;
             ParserDiagnostic programClassBuilderError = null;