migrate comment parsing to parse tree generated nodes

Author: Andrin Meier

RetailCoder.VBE/Inspections/OptionBaseInspectionResult.cs

@@ -1,3 +1,4 @@
+using Rubberduck.Parsing.Grammar;
 using Rubberduck.Parsing.Nodes;
 using Rubberduck.VBEditor;
 
@@ -6,7 +7,7 @@ namespace Rubberduck.Inspections
     public class OptionBaseInspectionResult : InspectionResultBase
     {
         public OptionBaseInspectionResult(IInspection inspection, QualifiedModuleName qualifiedName)
-            : base(inspection, new CommentNode(string.Empty, new QualifiedSelection(qualifiedName, Selection.Home)))
+            : base(inspection, new CommentNode(string.Empty, Tokens.CommentMarker, new QualifiedSelection(qualifiedName, Selection.Home)))
         {
         }
 

RetailCoder.VBE/Inspections/OptionExplicitInspectionResult.cs

@@ -13,7 +13,7 @@ public class OptionExplicitInspectionResult : InspectionResultBase
         private readonly IEnumerable<CodeInspectionQuickFix> _quickFixes; 
 
         public OptionExplicitInspectionResult(IInspection inspection, QualifiedModuleName qualifiedName) 
-            : base(inspection, new CommentNode(string.Empty, new QualifiedSelection(qualifiedName, Selection.Home)))
+            : base(inspection, new CommentNode(string.Empty, Tokens.CommentMarker, new QualifiedSelection(qualifiedName, Selection.Home)))
         {
             _quickFixes = new[]
             {

RetailCoder.VBE/UI/ToDoItems/ToDoExplorerViewModel.cs

@@ -118,7 +118,7 @@ private IEnumerable<ToDoItem> GetToDoMarkers(CommentNode comment)
         {
             var markers = _configService.LoadConfiguration().UserSettings.ToDoListSettings.ToDoMarkers;
             return markers.Where(marker => !string.IsNullOrEmpty(marker.Text)
-                                         && comment.Comment.ToLowerInvariant().Contains(marker.Text.ToLowerInvariant()))
+                                         && comment.CommentText.ToLowerInvariant().Contains(marker.Text.ToLowerInvariant()))
                            .Select(marker => new ToDoItem(marker.Text, comment));
         }
 

Rubberduck.Parsing/Nodes/CommentNode.cs

@@ -1,42 +1,32 @@
-using System;
-using Rubberduck.Parsing.Grammar;
 using Rubberduck.VBEditor;
 
 namespace Rubberduck.Parsing.Nodes
 {
     /// <summary>
     /// Represents a comment.
     /// </summary>
-    /// <remarks>
-    /// This is working around the limitations of the .g4 grammar file in use,
-    /// which ignores comments. Ideally comments would be part of the grammar,
-    /// and parsed along with the rest of the language syntax into an IParseTree.
-    /// </remarks>
     public class CommentNode
     {
         private readonly string _comment;
+        private readonly string _marker;
         private readonly QualifiedSelection _qualifiedSelection;
 
         /// <summary>
         /// Creates a new comment node.
         /// </summary>
-        /// <param name="comment">The comment line text, including the comment marker.</param>
+        /// <param name="comment">The comment line text, without the comment marker.</param>
         /// <param name="qualifiedSelection">The information required to locate and select this node in its VBE code pane.</param>
-        public CommentNode(string comment, QualifiedSelection qualifiedSelection)
+        public CommentNode(string comment, string marker, QualifiedSelection qualifiedSelection)
         {
             _comment = comment;
+            _marker = marker;
             _qualifiedSelection = qualifiedSelection;
         }
 
         /// <summary>
-        /// Gets the comment line text, including the comment marker.
+        /// Gets the comment text, without the comment marker.
         /// </summary>
-        public string Comment { get { return _comment; } }
-
-        /// <summary>
-        /// Gets the trimmed comment text, without the comment marker.
-        /// </summary>
-        public string CommentText { get { return _comment.Remove(_comment.IndexOf(Marker, StringComparison.Ordinal), Marker.Length).Trim(); } }
+        public string CommentText { get { return _comment; } }
 
         /// <summary>
         /// The token used to indicate a comment.
@@ -45,9 +35,7 @@ public string Marker
         {
             get
             {
-                return _comment.StartsWith(Tokens.CommentMarker)
-                                ? Tokens.CommentMarker
-                                : Tokens.Rem;
+                return _marker;
             }
         }
 

Rubberduck.Parsing/VBA/RubberduckParser.cs

@@ -182,48 +182,14 @@ public void Resolve(CancellationToken token)
             }
         }
 
-        private IEnumerable<CommentNode> ParseComments(QualifiedModuleName qualifiedName)
+        private IEnumerable<CommentNode> ParseComments(QualifiedModuleName qualifiedName, IEnumerable<VBAParser.CommentContext> comments, IEnumerable<VBAParser.RemCommentContext> remComments)
         {
-            var result = new List<CommentNode>();
-
-            var code = qualifiedName.Component.CodeModule.GetSanitizedCode();
-            var commentBuilder = new StringBuilder();
-            var continuing = false;
-
-            var startLine = 0;
-            var startColumn = 0;
-
-            for (var i = 0; i < code.Length; i++)
-            {
-                var line = code[i];
-                var index = 0;
-
-                if (continuing || line.HasComment(out index))
-                {
-                    startLine = continuing ? startLine : i;
-                    startColumn = continuing ? startColumn : index;
-
-                    var commentLength = line.Length - index;
-
-                    continuing = line.EndsWith("_");
-                    if (!continuing)
-                    {
-                        commentBuilder.Append(line.Substring(index, commentLength).TrimStart());
-                        var selection = new Selection(startLine + 1, startColumn + 1, i + 1, line.Length + 1);
-
-                        var comment = new CommentNode(commentBuilder.ToString(), new QualifiedSelection(qualifiedName, selection));
-                        commentBuilder.Clear();
-                        result.Add(comment);
-                    }
-                    else
-                    {
-                        // ignore line continuations in comment text:
-                        commentBuilder.Append(line.Substring(index, commentLength).TrimStart());
-                    }
-                }
-            }
-
-            return result;
+            var commentNodes = comments
+                .Select(comment => new CommentNode(comment.GetComment(), Tokens.CommentMarker, new QualifiedSelection(qualifiedName, comment.GetSelection())));
+            var remCommentNodes = remComments
+                .Select(comment => new CommentNode(comment.GetComment(), Tokens.Rem, new QualifiedSelection(qualifiedName, comment.GetSelection())));
+            var allCommentNodes = commentNodes.Union(remCommentNodes);
+            return allCommentNodes;
         }
 
         private void ParseInternal(VBComponent vbComponent, string code, CancellationToken token)
@@ -232,8 +198,6 @@ private void ParseInternal(VBComponent vbComponent, string code, CancellationTok
             State.SetModuleState(vbComponent, ParserState.Parsing);
 
             var qualifiedName = new QualifiedModuleName(vbComponent);
-            var comments = ParseComments(qualifiedName);
-            _state.SetModuleComments(vbComponent, comments);
 
             var obsoleteCallsListener = new ObsoleteCallStatementListener();
             var obsoleteLetListener = new ObsoleteLetStatementListener();
@@ -273,6 +237,9 @@ private void ParseInternal(VBComponent vbComponent, string code, CancellationTok
             walker.Walk(declarationsListener, tree);
             declarationsListener.NewDeclaration -= declarationsListener_NewDeclaration;
 
+            var comments = ParseComments(qualifiedName, commentListener.Comments, commentListener.RemComments);
+            _state.SetModuleComments(vbComponent, comments);
+
             _state.ObsoleteCallContexts = obsoleteCallsListener.Contexts.Select(context => new QualifiedContext(qualifiedName, context));
             _state.ObsoleteLetContexts = obsoleteLetListener.Contexts.Select(context => new QualifiedContext(qualifiedName, context));
             _state.EmptyStringLiterals = emptyStringLiteralListener.Contexts.Select(context => new QualifiedContext(qualifiedName, context));