Fix bracket escaping in end of line comments. Closes #2696

Author: comintern

Rubberduck.SmartIndenter/AbsoluteCodeLine.cs

@@ -10,8 +10,6 @@ namespace Rubberduck.SmartIndenter
     internal class AbsoluteCodeLine
     {
         private const string StupidLineEnding = ": _";
-        private static readonly Regex StringReplaceRegex = new Regex(StringLiteralAndBracketEscaper.StringPlaceholder.ToString(CultureInfo.InvariantCulture));
-        private static readonly Regex BracketReplaceRegex = new Regex(StringLiteralAndBracketEscaper.BracketPlaceholder.ToString(CultureInfo.InvariantCulture));
         private static readonly Regex LineNumberRegex = new Regex(@"^(?<number>(-?\d+)|(&H[0-9A-F]{1,8}))\s+(?<code>.*)", RegexOptions.ExplicitCapture);
         private static readonly Regex EndOfLineCommentRegex = new Regex(@"^(?!(Rem\s)|('))(?<code>[^']*)(\s(?<comment>'.*))$", RegexOptions.ExplicitCapture);      
         private static readonly Regex ProcedureStartRegex = new Regex(@"^(Public\s|Private\s|Friend\s)?(Static\s)?(Sub|Function|Property\s(Let|Get|Set))\s");
@@ -61,8 +59,8 @@ public AbsoluteCodeLine(string code, IIndenterSettings settings, AbsoluteCodeLin
             ExtractLineNumber();
             ExtractEndOfLineComment();
 
-            _code = Regex.Replace(_code, StringLiteralAndBracketEscaper.StringPlaceholder + "+", StringLiteralAndBracketEscaper.StringPlaceholder.ToString(CultureInfo.InvariantCulture));
-            _code = Regex.Replace(_code, StringLiteralAndBracketEscaper.BracketPlaceholder + "+", StringLiteralAndBracketEscaper.BracketPlaceholder.ToString(CultureInfo.InvariantCulture)).Trim();
+            //_code = Regex.Replace(_code, StringLiteralAndBracketEscaper.StringPlaceholder + "+", StringLiteralAndBracketEscaper.StringPlaceholder.ToString(CultureInfo.InvariantCulture));
+            //_code = Regex.Replace(_code, StringLiteralAndBracketEscaper.BracketPlaceholder + "+", StringLiteralAndBracketEscaper.BracketPlaceholder.ToString(CultureInfo.InvariantCulture)).Trim();
             _segments = _code.Split(new[] { ": " }, StringSplitOptions.None);
         }
 
@@ -267,38 +265,29 @@ public string Indent(int indents, bool atProcStart, bool absolute = false)
             }
 
             var code = string.Join(": ", _segments);
-            if (_escaper.EscapedStrings.Any())
-            {
-                code = _escaper.EscapedStrings.Aggregate(code, (current, literal) => StringReplaceRegex.Replace(current, literal, 1));
-            }
-            if (_escaper.EscapedBrackets.Any())
-            {
-                code = _escaper.EscapedBrackets.Aggregate(code, (current, expr) => BracketReplaceRegex.Replace(current, expr, 1));
-            }
-
             code = string.Join(string.Empty, number, new string(' ', gap), code);
             if (string.IsNullOrEmpty(EndOfLineComment))
             {
-                return code + (_stupidLineEnding ? StupidLineEnding : string.Empty);
+                return _escaper.UnescapeIndented(code + (_stupidLineEnding ? StupidLineEnding : string.Empty));
             }
 
             var position = Original.LastIndexOf(EndOfLineComment, StringComparison.Ordinal);
             switch (_settings.EndOfLineCommentStyle)
             {
                 case EndOfLineCommentStyle.Absolute:
-                    return string.Format("{0}{1}{2}{3}", code, new string(' ', Math.Max(position - code.Length, 1)),
-                                                         EndOfLineComment, _stupidLineEnding ? StupidLineEnding : string.Empty);
+                    return _escaper.UnescapeIndented(string.Format("{0}{1}{2}{3}", code, new string(' ', Math.Max(position - code.Length, 1)),
+                                                     EndOfLineComment, _stupidLineEnding ? StupidLineEnding : string.Empty));
                 case EndOfLineCommentStyle.SameGap:
                     var uncommented = Original.Substring(0, position - 1);
-                    return string.Format("{0}{1}{2}{3}", code, new string(' ', uncommented.Length - uncommented.TrimEnd().Length + 1), 
-                                                         EndOfLineComment, _stupidLineEnding ? StupidLineEnding : string.Empty);
+                    return _escaper.UnescapeIndented(string.Format("{0}{1}{2}{3}", code, new string(' ', uncommented.Length - uncommented.TrimEnd().Length + 1), 
+                                                     EndOfLineComment, _stupidLineEnding ? StupidLineEnding : string.Empty));
                 case EndOfLineCommentStyle.StandardGap:
-                    return string.Format("{0}{1}{2}{3}", code, new string(' ', _settings.IndentSpaces * 2), EndOfLineComment,
-                                                        _stupidLineEnding ? StupidLineEnding : string.Empty);
+                    return _escaper.UnescapeIndented(string.Format("{0}{1}{2}{3}", code, new string(' ', _settings.IndentSpaces * 2), EndOfLineComment,
+                                                     _stupidLineEnding ? StupidLineEnding : string.Empty));
                 case EndOfLineCommentStyle.AlignInColumn:
                     var align = _settings.EndOfLineCommentColumnSpaceAlignment - code.Length;
-                    return string.Format("{0}{1}{2}{3}", code, new string(' ', Math.Max(align - 1, 1)), EndOfLineComment,
-                                                        _stupidLineEnding ? StupidLineEnding : string.Empty);
+                    return _escaper.UnescapeIndented(string.Format("{0}{1}{2}{3}", code, new string(' ', Math.Max(align - 1, 1)), EndOfLineComment,
+                                                     _stupidLineEnding ? StupidLineEnding : string.Empty));
                 default:
                     throw new InvalidEnumArgumentException();
             }

Rubberduck.SmartIndenter/StringLiteralAndBracketEscaper.cs

@@ -1,12 +1,17 @@
 using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
+using System.Text.RegularExpressions;
 
 namespace Rubberduck.SmartIndenter
 {
     internal class StringLiteralAndBracketEscaper
     {
         public const char StringPlaceholder = '\a';
-        public const char BracketPlaceholder = '\x2';
+        public const char BracketPlaceholder = '\x02';
+
+        private static readonly Regex StringReplaceRegex = new Regex("\a+");
+        private static readonly Regex BracketReplaceRegex = new Regex("\x02+");
 
         private readonly List<string> _strings = new List<string>();
         private readonly List<string> _brackets = new List<string>();
@@ -18,6 +23,20 @@ internal class StringLiteralAndBracketEscaper
         public IEnumerable<string> EscapedStrings { get { return _strings; } }
         public IEnumerable<string> EscapedBrackets { get { return _brackets; } }
 
+        public string UnescapeIndented(string indented)
+        {
+            var code = indented;
+            if (_strings.Any())
+            {
+                code = _strings.Aggregate(code, (current, literal) => StringReplaceRegex.Replace(current, literal, 1));
+            }
+            if (_brackets.Any())
+            {
+                code = _brackets.Aggregate(code, (current, expr) => BracketReplaceRegex.Replace(current, expr, 1));
+            }
+            return code;
+        }
+
         public StringLiteralAndBracketEscaper(string code)
         {
             _unescaped = code;
@@ -63,8 +82,8 @@ public StringLiteralAndBracketEscaper(string code)
                         continue;
                     }
                     bracketed = false;
-                    _brackets.Add(new string(chars.Skip(brkpos).Take(c - brkpos).ToArray()));
-                    for (var e = brkpos; e < c; e++)
+                    _brackets.Add(new string(chars.Skip(brkpos).Take(c - brkpos + 1).ToArray()));
+                    for (var e = brkpos; e <= c; e++)
                     {
                         chars[e] = BracketPlaceholder;
                     }

RubberduckTests/SmartIndenter/MiscAndCornerCaseTests.cs

@@ -746,6 +746,31 @@ public void BracketedIdentifiersWork()
             Assert.IsTrue(expected.SequenceEqual(actual));
         }
 
+        //https://github.com/rubberduck-vba/Rubberduck/issues/2696
+        [TestMethod]
+        // Broken in VB6 SmartIndenter.
+        [TestCategory("Indenter")]
+        public void BracketsInEndOfLineCommentsWork()
+        {
+            var code = new[]
+            {
+                "Public Sub Test()",
+                "Debug.Print \"foo\" \'update [foo].[bar] in the frob.",
+                "End Sub"
+            };
+
+            var expected = new[]
+            {
+                "Public Sub Test()",
+                "    Debug.Print \"foo\"                            'update [foo].[bar] in the frob.",
+                "End Sub"
+            };
+
+            var indenter = new Indenter(null, () => IndenterSettingsTests.GetMockIndenterSettings());
+            var actual = indenter.Indent(code);
+            Assert.IsTrue(expected.SequenceEqual(actual));
+        }
+
         //https://github.com/rubberduck-vba/Rubberduck/issues/2604
         [TestMethod]
         [TestCategory("Indenter")]