Skip to content

Commit 7fa27c3

Browse files
cominterncomintern
committed
Escape strings in the function aligner. Closes #2604 
1 parent 8dbf851 commit 7fa27c3

File tree

5 files changed

+139
-78
lines changed

5 files changed

+139
-78
lines changed

‎Rubberduck.SmartIndenter/AbsoluteCodeLine.cs

Lines changed: 21 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,8 @@ namespace Rubberduck.SmartIndenter
1010
internal class AbsoluteCodeLine
1111
{
1212
private const string StupidLineEnding = ": _";
13-
private const char StringPlaceholder = '\a';
14-
private const char BracketPlaceholder = '\x2';
15-
private static readonly Regex StringReplaceRegex = new Regex(StringPlaceholder.ToString(CultureInfo.InvariantCulture));
16-
private static readonly Regex BracketReplaceRegex = new Regex(BracketPlaceholder.ToString(CultureInfo.InvariantCulture));
13+
private static readonly Regex StringReplaceRegex = new Regex(StringLiteralAndBracketEscaper.StringPlaceholder.ToString(CultureInfo.InvariantCulture));
14+
private static readonly Regex BracketReplaceRegex = new Regex(StringLiteralAndBracketEscaper.BracketPlaceholder.ToString(CultureInfo.InvariantCulture));
1715
private static readonly Regex LineNumberRegex = new Regex(@"^(?<number>(-?\d+)|(&H[0-9A-F]{1,8}))\s+(?<code>.*)", RegexOptions.ExplicitCapture);
1816
private static readonly Regex EndOfLineCommentRegex = new Regex(@"^(?!(Rem\s)|('))(?<code>[^']*)(\s(?<comment>'.*))$", RegexOptions.ExplicitCapture);
1917
private static readonly Regex ProcedureStartRegex = new Regex(@"^(Public\s|Private\s|Friend\s)?(Static\s)?(Sub|Function|Property\s(Let|Get|Set))\s");
@@ -34,8 +32,9 @@ internal class AbsoluteCodeLine
3432
private string _code;
3533
private readonly bool _stupidLineEnding;
3634
private readonly string[] _segments;
37-
private List<string> _strings;
38-
private List<string> _brackets;
35+
private readonly StringLiteralAndBracketEscaper _escaper;
36+
//private List<string> _strings;
37+
//private List<string> _brackets;
3938

4039
public AbsoluteCodeLine(string code, IIndenterSettings settings) : this(code, settings, null) { }
4140

@@ -56,72 +55,17 @@ public AbsoluteCodeLine(string code, IIndenterSettings settings, AbsoluteCodeLin
5655

5756
Original = code;
5857

59-
ExtractStringLiteralsAndBrackets();
58+
_escaper = new StringLiteralAndBracketEscaper(_code);
59+
_code = _escaper.EscapedString;
60+
6061
ExtractLineNumber();
6162
ExtractEndOfLineComment();
6263

63-
_code = Regex.Replace(_code, StringPlaceholder + "+", StringPlaceholder.ToString(CultureInfo.InvariantCulture));
64-
_code = Regex.Replace(_code, BracketPlaceholder + "+", BracketPlaceholder.ToString(CultureInfo.InvariantCulture)).Trim();
64+
_code = Regex.Replace(_code, StringLiteralAndBracketEscaper.StringPlaceholder + "+", StringLiteralAndBracketEscaper.StringPlaceholder.ToString(CultureInfo.InvariantCulture));
65+
_code = Regex.Replace(_code, StringLiteralAndBracketEscaper.BracketPlaceholder + "+", StringLiteralAndBracketEscaper.BracketPlaceholder.ToString(CultureInfo.InvariantCulture)).Trim();
6566
_segments = _code.Split(new[] { ": " }, StringSplitOptions.None);
6667
}
6768

68-
//TODO: This should be a class.
69-
private void ExtractStringLiteralsAndBrackets()
70-
{
71-
_strings = new List<string>();
72-
_brackets = new List<string>();
73-
74-
var chars = _code.ToCharArray();
75-
var quoted = false;
76-
var bracketed = false;
77-
var ins = 0;
78-
var strpos = 0;
79-
var brkpos = 0;
80-
for (var c = 0; c < chars.Length; c++)
81-
{
82-
if (chars[c] == '"' && !bracketed)
83-
{
84-
if (!quoted)
85-
{
86-
strpos = c;
87-
quoted = true;
88-
continue;
89-
}
90-
if (c + 1 < chars.Length && chars[c] == '"')
91-
{
92-
c++;
93-
}
94-
quoted = false;
95-
_strings.Add(new string(chars.Skip(strpos).Take(c - strpos).ToArray()));
96-
for (var e = strpos; e < c; e++)
97-
{
98-
chars[e] = StringPlaceholder;
99-
}
100-
}
101-
else if (!quoted && !bracketed && chars[c] == '[')
102-
{
103-
bracketed = true;
104-
brkpos = c;
105-
ins++;
106-
}
107-
else if (!quoted && bracketed && chars[c] == ']')
108-
{
109-
ins--;
110-
if (ins != 0)
111-
{
112-
continue;
113-
}
114-
bracketed = false;
115-
_brackets.Add(new string(chars.Skip(brkpos).Take(c - brkpos).ToArray()));
116-
for (var e = brkpos; e < c; e++)
117-
{
118-
chars[e] = BracketPlaceholder;
119-
}
120-
}
121-
}
122-
_code = new string(chars);
123-
}
124-
12569
private void ExtractLineNumber()
12670
{
12771
if (Previous == null || !Previous.HasContinuation)
@@ -162,15 +106,18 @@ public string Escaped
162106
{
163107
get
164108
{
109+
// ReSharper disable LoopCanBeConvertedToQuery
165110
var output = Original;
166-
foreach (var item in _strings)
111+
foreach (var item in _escaper.EscapedStrings)
112+
167113
{
168-
output = output.Replace(item, new string(StringPlaceholder, item.Length));
114+
output = output.Replace(item, new string(StringLiteralAndBracketEscaper.StringPlaceholder, item.Length));
169115
}
170-
foreach (var item in _brackets)
116+
foreach (var item in _escaper.EscapedBrackets)
171117
{
172-
output = output.Replace(item, new string(BracketPlaceholder, item.Length));
118+
output = output.Replace(item, new string(StringLiteralAndBracketEscaper.BracketPlaceholder, item.Length));
173119
}
120+
// ReSharper restore LoopCanBeConvertedToQuery
174121
return output;
175122
}
176123
}
@@ -320,13 +267,13 @@ public string Indent(int indents, bool atProcStart, bool absolute = false)
320267
}
321268

322269
var code = string.Join(": ", _segments);
323-
if (_strings.Any())
270+
if (_escaper.EscapedStrings.Any())
324271
{
325-
code = _strings.Aggregate(code, (current, literal) => StringReplaceRegex.Replace(current, literal, 1));
272+
code = _escaper.EscapedStrings.Aggregate(code, (current, literal) => StringReplaceRegex.Replace(current, literal, 1));
326273
}
327-
if (_brackets.Any())
274+
if (_escaper.EscapedBrackets.Any())
328275
{
329-
code = _brackets.Aggregate(code, (current, expr) => BracketReplaceRegex.Replace(current, expr, 1));
276+
code = _escaper.EscapedBrackets.Aggregate(code, (current, expr) => BracketReplaceRegex.Replace(current, expr, 1));
330277
}
331278

332279
code = string.Join(string.Empty, number, new string(' ', gap), code);

‎Rubberduck.SmartIndenter/LogicalCodeLine.cs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ namespace Rubberduck.SmartIndenter
77
{
88
internal class LogicalCodeLine
99
{
10-
private List<AbsoluteCodeLine> _lines = new List<AbsoluteCodeLine>();
10+
private readonly List<AbsoluteCodeLine> _lines = new List<AbsoluteCodeLine>();
1111
private AbsoluteCodeLine _rebuilt;
1212
private readonly IIndenterSettings _settings;
1313

@@ -186,6 +186,7 @@ public override string ToString()
186186
//The splitNamed parameter is a straight up hack for fixing https://github.com/rubberduck-vba/Rubberduck/issues/2402
187187
private int FunctionAlign(string line, bool splitNamed)
188188
{
189+
line = new StringLiteralAndBracketEscaper(line).EscapedString;
189190
var stackPos = _alignment.Count;
190191

191192
for (var index = StartIgnoreRegex.Match(line).Length + 1; index <= line.Length; index++)
@@ -194,10 +195,8 @@ private int FunctionAlign(string line, bool splitNamed)
194195
switch (character)
195196
{
196197
case "\a":
197-
while (!line.Substring(index++, 1).Equals("\a")) { }
198-
break;
199198
case "\x2":
200-
while (!line.Substring(index++, 1).Equals("\x2")) { }
199+
index++;
201200
break;
202201
case "(":
203202
//Start of another function => remember this position

‎Rubberduck.SmartIndenter/Rubberduck.SmartIndenter.csproj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@
5757
<Compile Include="LogicalCodeLine.cs" />
5858
<Compile Include="Properties\AssemblyInfo.cs" />
5959
<Compile Include="Selection.cs" />
60+
<Compile Include="StringLiteralAndBracketEscaper.cs" />
6061
</ItemGroup>
6162
<ItemGroup>
6263
<None Include="Legacy\CBtnEvents.cls" />

‎Rubberduck.SmartIndenter/StringLiteralAndBracketEscaper.cs

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
using System.Collections.Generic;
2+
using System.Linq;
3+
4+
namespace Rubberduck.SmartIndenter
5+
{
6+
internal class StringLiteralAndBracketEscaper
7+
{
8+
public const char StringPlaceholder = '\a';
9+
public const char BracketPlaceholder = '\x2';
10+
11+
private readonly List<string> _strings = new List<string>();
12+
private readonly List<string> _brackets = new List<string>();
13+
private readonly string _unescaped;
14+
private readonly string _escaped;
15+
16+
public string EscapedString { get { return _escaped; } }
17+
public string OriginalString { get { return _unescaped; } }
18+
public IEnumerable<string> EscapedStrings { get { return _strings; } }
19+
public IEnumerable<string> EscapedBrackets { get { return _brackets; } }
20+
21+
public StringLiteralAndBracketEscaper(string code)
22+
{
23+
_unescaped = code;
24+
25+
var chars = _unescaped.ToCharArray();
26+
var quoted = false;
27+
var bracketed = false;
28+
var ins = 0;
29+
var strpos = 0;
30+
var brkpos = 0;
31+
for (var c = 0; c < chars.Length; c++)
32+
{
33+
if (chars[c] == '"' && !bracketed)
34+
{
35+
if (!quoted)
36+
{
37+
strpos = c;
38+
quoted = true;
39+
continue;
40+
}
41+
if (c + 1 < chars.Length && chars[c] == '"')
42+
{
43+
c++;
44+
}
45+
quoted = false;
46+
_strings.Add(new string(chars.Skip(strpos).Take(c - strpos).ToArray()));
47+
for (var e = strpos; e < c; e++)
48+
{
49+
chars[e] = StringPlaceholder;
50+
}
51+
}
52+
else if (!quoted && !bracketed && chars[c] == '[')
53+
{
54+
bracketed = true;
55+
brkpos = c;
56+
ins++;
57+
}
58+
else if (!quoted && bracketed && chars[c] == ']')
59+
{
60+
ins--;
61+
if (ins != 0)
62+
{
63+
continue;
64+
}
65+
bracketed = false;
66+
_brackets.Add(new string(chars.Skip(brkpos).Take(c - brkpos).ToArray()));
67+
for (var e = brkpos; e < c; e++)
68+
{
69+
chars[e] = BracketPlaceholder;
70+
}
71+
}
72+
}
73+
_escaped = new string(chars);
74+
}
75+
}
76+
}

‎RubberduckTests/SmartIndenter/MiscAndCornerCaseTests.cs

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -745,5 +745,43 @@ public void BracketedIdentifiersWork()
745745
var actual = indenter.Indent(code);
746746
Assert.IsTrue(expected.SequenceEqual(actual));
747747
}
748+
749+
//https://github.com/rubberduck-vba/Rubberduck/issues/2604
750+
[TestMethod]
751+
[TestCategory("Indenter")]
752+
public void AlignmentAnchorsInStringLiteralsAreIgnored()
753+
{
754+
var code = new[]
755+
{
756+
"Sub Test()",
757+
"Dim LoremIpsum As String",
758+
@"LoremIpsum = ""Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam dictum,"" & vbCrLf _",
759+
@"& ""felis in tempor finibus, arcu lectus molestie urna, eget interdum turpis"" & vbCrLf _",
760+
@"& ""tellus ac diam. Nulla mauris lectus, vulputate et fringilla ac, iaculis eget urna."" & vbCrLf _",
761+
@"& ""Ut feugiat felis lacinia eros vestibulum facilisis. Ut euismod dapibus augue,"" & vbCrLf _",
762+
@"& ""lacinia elementum elit dictum in. Nam in imperdiet tortor. Curabitur efficitur libero"" & vbCrLf _",
763+
@"& ""lacus, et placerat metus sodales sit amet.""",
764+
"Debug.Print LoremIpsum",
765+
"End Sub"
766+
};
767+
768+
var expected = new[]
769+
{
770+
"Sub Test()",
771+
" Dim LoremIpsum As String",
772+
@" LoremIpsum = ""Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam dictum,"" & vbCrLf _",
773+
@" & ""felis in tempor finibus, arcu lectus molestie urna, eget interdum turpis"" & vbCrLf _",
774+
@" & ""tellus ac diam. Nulla mauris lectus, vulputate et fringilla ac, iaculis eget urna."" & vbCrLf _",
775+
@" & ""Ut feugiat felis lacinia eros vestibulum facilisis. Ut euismod dapibus augue,"" & vbCrLf _",
776+
@" & ""lacinia elementum elit dictum in. Nam in imperdiet tortor. Curabitur efficitur libero"" & vbCrLf _",
777+
@" & ""lacus, et placerat metus sodales sit amet.""",
778+
" Debug.Print LoremIpsum",
779+
"End Sub"
780+
};
781+
782+
var indenter = new Indenter(null, () => IndenterSettingsTests.GetMockIndenterSettings());
783+
var actual = indenter.Indent(code);
784+
Assert.IsTrue(expected.SequenceEqual(actual));
785+
}
748786
}
749787
}

0 commit comments

Comments
 (0)