Merge pull request #2053 from pdelvo/whitespaceperf

sharwell · sharwell · commit da9bc63926ab · 2016-07-15T22:31:57.000-05:00
Improve performance of IsPrecededByWhitespace
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/TokenHelper.cs b/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/TokenHelper.cs
@@ -3,6 +3,7 @@
 
 namespace StyleCop.Analyzers.Helpers
 {
+    using System.Threading;
     using Microsoft.CodeAnalysis;
     using Microsoft.CodeAnalysis.CSharp;
 
@@ -61,17 +62,18 @@ internal static bool IsLastInLine(this SyntaxToken token)
         /// Gets a value indicating whether the <paramref name="token"/> is preceded by a whitespace.
         /// </summary>
         /// <param name="token">The token to process.</param>
+        /// <param name="cancellationToken">The cancellation token that the operation will observe.</param>
         /// <returns>true if token is preceded by a whitespace, otherwise false.</returns>
-        internal static bool IsPrecededByWhitespace(this SyntaxToken token)
+        internal static bool IsPrecededByWhitespace(this SyntaxToken token, CancellationToken cancellationToken)
         {
-            SyntaxTriviaList triviaList = token.LeadingTrivia;
-            if (triviaList.Count > 0)
+            // Perf: Directly access the text instead of the trivia.
+            int pos = token.Span.Start - 1;
+            if (pos < 0 || token.SyntaxTree == null)
             {
-                return triviaList.Last().IsKind(SyntaxKind.WhitespaceTrivia);
+                return false;
             }
 
-            triviaList = token.GetPreviousToken().TrailingTrivia;
-            return triviaList.Count > 0 && triviaList.Last().IsKind(SyntaxKind.WhitespaceTrivia);
+            return char.IsWhiteSpace(token.SyntaxTree.GetText(cancellationToken)[pos]);
         }
 
         /// <summary>
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1001CommasMustBeSpacedCorrectly.cs b/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1001CommasMustBeSpacedCorrectly.cs
@@ -96,7 +96,7 @@ private static void HandleCommaToken(SyntaxTreeAnalysisContext context, SyntaxTo
                 }
             }
 
-            if (token.IsFirstInLine() || token.IsPrecededByWhitespace())
+            if (token.IsFirstInLine() || token.IsPrecededByWhitespace(context.CancellationToken))
             {
                 // comma must{ not} be {preceded} by whitespace
                 context.ReportDiagnostic(Diagnostic.Create(Descriptor, token.GetLocation(), TokenSpacingProperties.RemovePrecedingPreserveLayout, " not", "preceded"));
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1009ClosingParenthesisMustBeSpacedCorrectly.cs b/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1009ClosingParenthesisMustBeSpacedCorrectly.cs
@@ -76,7 +76,7 @@ private static void HandleCloseParenToken(SyntaxTreeAnalysisContext context, Syn
                 return;
             }
 
-            bool precededBySpace = token.IsFirstInLine() || token.IsPrecededByWhitespace();
+            bool precededBySpace = token.IsFirstInLine() || token.IsPrecededByWhitespace(context.CancellationToken);
             bool followedBySpace = token.IsFollowedByWhitespace();
             bool lastInLine = token.IsLastInLine();
             bool precedesStickyCharacter;
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1010OpeningSquareBracketsMustBeSpacedCorrectly.cs b/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1010OpeningSquareBracketsMustBeSpacedCorrectly.cs
@@ -76,7 +76,7 @@ private static void HandleOpenBracketToken(SyntaxTreeAnalysisContext context, Sy
 
             if (!firstInLine)
             {
-                precededBySpace = token.IsPrecededByWhitespace();
+                precededBySpace = token.IsPrecededByWhitespace(context.CancellationToken);
 
                 // ignore if handled by SA1026
                 ignorePrecedingSpaceProblem = precededBySpace && token.GetPreviousToken().IsKind(SyntaxKind.NewKeyword);
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1011ClosingSquareBracketsMustBeSpacedCorrectly.cs b/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1011ClosingSquareBracketsMustBeSpacedCorrectly.cs
@@ -82,7 +82,7 @@ private static void HandleCloseBracketToken(SyntaxTreeAnalysisContext context, S
             }
 
             bool firstInLine = token.IsFirstInLine();
-            bool precededBySpace = firstInLine || token.IsPrecededByWhitespace();
+            bool precededBySpace = firstInLine || token.IsPrecededByWhitespace(context.CancellationToken);
             bool followedBySpace = token.IsFollowedByWhitespace();
             bool lastInLine = token.IsLastInLine();
             bool precedesSpecialCharacter;
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1012OpeningBracesMustBeSpacedCorrectly.cs b/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1012OpeningBracesMustBeSpacedCorrectly.cs
@@ -88,7 +88,7 @@ private static void HandleOpenBraceToken(SyntaxTreeAnalysisContext context, Synt
                 return;
             }
 
-            bool precededBySpace = token.IsFirstInLine() || token.IsPrecededByWhitespace();
+            bool precededBySpace = token.IsFirstInLine() || token.IsPrecededByWhitespace(context.CancellationToken);
 
             if (!precededBySpace)
             {
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1013ClosingBracesMustBeSpacedCorrectly.cs b/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1013ClosingBracesMustBeSpacedCorrectly.cs
@@ -73,7 +73,7 @@ private static void HandleCloseBraceToken(SyntaxTreeAnalysisContext context, Syn
                 return;
             }
 
-            bool precededBySpace = token.IsFirstInLine() || token.IsPrecededByWhitespace();
+            bool precededBySpace = token.IsFirstInLine() || token.IsPrecededByWhitespace(context.CancellationToken);
 
             if (token.Parent is InterpolationSyntax)
             {
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1014OpeningGenericBracketsMustBeSpacedCorrectly.cs b/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1014OpeningGenericBracketsMustBeSpacedCorrectly.cs
@@ -81,7 +81,7 @@ private static void HandleLessThanToken(SyntaxTreeAnalysisContext context, Synta
             }
 
             bool firstInLine = token.IsFirstInLine();
-            bool precededBySpace = firstInLine || token.IsPrecededByWhitespace();
+            bool precededBySpace = firstInLine || token.IsPrecededByWhitespace(context.CancellationToken);
             bool followedBySpace = token.IsFollowedByWhitespace();
 
             if (!firstInLine && precededBySpace)
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1015ClosingGenericBracketsMustBeSpacedCorrectly.cs b/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1015ClosingGenericBracketsMustBeSpacedCorrectly.cs
@@ -84,7 +84,7 @@ private static void HandleGreaterThanToken(SyntaxTreeAnalysisContext context, Sy
 
             bool firstInLine = token.IsFirstInLine();
             bool lastInLine = token.IsLastInLine();
-            bool precededBySpace = firstInLine || token.IsPrecededByWhitespace();
+            bool precededBySpace = firstInLine || token.IsPrecededByWhitespace(context.CancellationToken);
             bool followedBySpace = token.IsFollowedByWhitespace();
             bool allowTrailingNoSpace;
             bool allowTrailingSpace;
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1019MemberAccessSymbolsMustBeSpacedCorrectly.cs b/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1019MemberAccessSymbolsMustBeSpacedCorrectly.cs
@@ -98,7 +98,7 @@ private static void HandleQuestionToken(SyntaxTreeAnalysisContext context, Synta
         private static void HandleMemberAccessSymbol(SyntaxTreeAnalysisContext context, SyntaxToken token)
         {
             bool firstInLine = token.IsFirstInLine();
-            bool precededBySpace = firstInLine || token.IsPrecededByWhitespace();
+            bool precededBySpace = firstInLine || token.IsPrecededByWhitespace(context.CancellationToken);
             bool followedBySpace = token.IsFollowedByWhitespace();
 
             if (!firstInLine && precededBySpace)
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1021NegativeSignsMustBeSpacedCorrectly.cs b/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1021NegativeSignsMustBeSpacedCorrectly.cs
@@ -90,7 +90,7 @@ private static void HandleMinusToken(SyntaxTreeAnalysisContext context, SyntaxTo
 
             if (!firstInLine)
             {
-                precededBySpace = token.IsPrecededByWhitespace();
+                precededBySpace = token.IsPrecededByWhitespace(context.CancellationToken);
                 SyntaxToken precedingToken = token.GetPreviousToken();
 
                 followsSpecialCharacter =
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1022PositiveSignsMustBeSpacedCorrectly.cs b/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1022PositiveSignsMustBeSpacedCorrectly.cs
@@ -90,7 +90,7 @@ private static void HandlePlusToken(SyntaxTreeAnalysisContext context, SyntaxTok
 
             if (!firstInLine)
             {
-                precededBySpace = token.IsPrecededByWhitespace();
+                precededBySpace = token.IsPrecededByWhitespace(context.CancellationToken);
                 SyntaxToken precedingToken = token.GetPreviousToken();
 
                 followsSpecialCharacter =
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1023DereferenceAndAccessOfSymbolsMustBeSpacedCorrectly.cs b/StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1023DereferenceAndAccessOfSymbolsMustBeSpacedCorrectly.cs
@@ -139,7 +139,7 @@ private static void HandleAsteriskToken(SyntaxTreeAnalysisContext context, Synta
             }
 
             bool firstInLine = token.IsFirstInLine();
-            bool precededBySpace = firstInLine || token.IsPrecededByWhitespace();
+            bool precededBySpace = firstInLine || token.IsPrecededByWhitespace(context.CancellationToken);
             bool followedBySpace = token.IsFollowedByWhitespace();
             bool lastInLine = token.IsLastInLine();
 

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace StyleCop.Analyzers.Helpers`
`5`	`5`	`{`
	`6`	`+ using System.Threading;`
`6`	`7`	`using Microsoft.CodeAnalysis;`
`7`	`8`	`using Microsoft.CodeAnalysis.CSharp;`
`8`	`9`
`@@ -61,17 +62,18 @@ internal static bool IsLastInLine(this SyntaxToken token)`
`61`	`62`	`/// Gets a value indicating whether the <paramref name="token"/> is preceded by a whitespace.`
`62`	`63`	`/// </summary>`
`63`	`64`	`/// <param name="token">The token to process.</param>`
	`65`	`+ /// <param name="cancellationToken">The cancellation token that the operation will observe.</param>`
`64`	`66`	`/// <returns>true if token is preceded by a whitespace, otherwise false.</returns>`
`65`		`- internal static bool IsPrecededByWhitespace(this SyntaxToken token)`
	`67`	`+ internal static bool IsPrecededByWhitespace(this SyntaxToken token, CancellationToken cancellationToken)`
`66`	`68`	`{`
`67`		`- SyntaxTriviaList triviaList = token.LeadingTrivia;`
`68`		`- if (triviaList.Count > 0)`
	`69`	`+ // Perf: Directly access the text instead of the trivia.`
	`70`	`+ int pos = token.Span.Start - 1;`
	`71`	`+ if (pos < 0 \|\| token.SyntaxTree == null)`
`69`	`72`	`{`
`70`		`- return triviaList.Last().IsKind(SyntaxKind.WhitespaceTrivia);`
	`73`	`+ return false;`
`71`	`74`	`}`
`72`	`75`
`73`		`- triviaList = token.GetPreviousToken().TrailingTrivia;`
`74`		`- return triviaList.Count > 0 && triviaList.Last().IsKind(SyntaxKind.WhitespaceTrivia);`
	`76`	`+ return char.IsWhiteSpace(token.SyntaxTree.GetText(cancellationToken)[pos]);`
`75`	`77`	`}`
`76`	`78`
`77`	`79`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ private static void HandleCommaToken(SyntaxTreeAnalysisContext context, SyntaxTo`
`96`	`96`	`}`
`97`	`97`	`}`
`98`	`98`
`99`		`- if (token.IsFirstInLine() \|\| token.IsPrecededByWhitespace())`
	`99`	`+ if (token.IsFirstInLine() \|\| token.IsPrecededByWhitespace(context.CancellationToken))`
`100`	`100`	`{`
`101`	`101`	`// comma must{ not} be {preceded} by whitespace`
`102`	`102`	`context.ReportDiagnostic(Diagnostic.Create(Descriptor, token.GetLocation(), TokenSpacingProperties.RemovePrecedingPreserveLayout, " not", "preceded"));`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ private static void HandleCloseParenToken(SyntaxTreeAnalysisContext context, Syn`
`76`	`76`	`return;`
`77`	`77`	`}`
`78`	`78`
`79`		`- bool precededBySpace = token.IsFirstInLine() \|\| token.IsPrecededByWhitespace();`
	`79`	`+ bool precededBySpace = token.IsFirstInLine() \|\| token.IsPrecededByWhitespace(context.CancellationToken);`
`80`	`80`	`bool followedBySpace = token.IsFollowedByWhitespace();`
`81`	`81`	`bool lastInLine = token.IsLastInLine();`
`82`	`82`	`bool precedesStickyCharacter;`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ private static void HandleCloseBracketToken(SyntaxTreeAnalysisContext context, S`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`bool firstInLine = token.IsFirstInLine();`
`85`		`- bool precededBySpace = firstInLine \|\| token.IsPrecededByWhitespace();`
	`85`	`+ bool precededBySpace = firstInLine \|\| token.IsPrecededByWhitespace(context.CancellationToken);`
`86`	`86`	`bool followedBySpace = token.IsFollowedByWhitespace();`
`87`	`87`	`bool lastInLine = token.IsLastInLine();`
`88`	`88`	`bool precedesSpecialCharacter;`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ private static void HandleOpenBraceToken(SyntaxTreeAnalysisContext context, Synt`
`88`	`88`	`return;`
`89`	`89`	`}`
`90`	`90`
`91`		`- bool precededBySpace = token.IsFirstInLine() \|\| token.IsPrecededByWhitespace();`
	`91`	`+ bool precededBySpace = token.IsFirstInLine() \|\| token.IsPrecededByWhitespace(context.CancellationToken);`
`92`	`92`
`93`	`93`	`if (!precededBySpace)`
`94`	`94`	`{`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ private static void HandleCloseBraceToken(SyntaxTreeAnalysisContext context, Syn`
`73`	`73`	`return;`
`74`	`74`	`}`
`75`	`75`
`76`		`- bool precededBySpace = token.IsFirstInLine() \|\| token.IsPrecededByWhitespace();`
	`76`	`+ bool precededBySpace = token.IsFirstInLine() \|\| token.IsPrecededByWhitespace(context.CancellationToken);`
`77`	`77`
`78`	`78`	`if (token.Parent is InterpolationSyntax)`
`79`	`79`	`{`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ private static void HandleLessThanToken(SyntaxTreeAnalysisContext context, Synta`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`bool firstInLine = token.IsFirstInLine();`
`84`		`- bool precededBySpace = firstInLine \|\| token.IsPrecededByWhitespace();`
	`84`	`+ bool precededBySpace = firstInLine \|\| token.IsPrecededByWhitespace(context.CancellationToken);`
`85`	`85`	`bool followedBySpace = token.IsFollowedByWhitespace();`
`86`	`86`
`87`	`87`	`if (!firstInLine && precededBySpace)`
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ private static void HandleQuestionToken(SyntaxTreeAnalysisContext context, Synta`
`98`	`98`	`private static void HandleMemberAccessSymbol(SyntaxTreeAnalysisContext context, SyntaxToken token)`
`99`	`99`	`{`
`100`	`100`	`bool firstInLine = token.IsFirstInLine();`
`101`		`- bool precededBySpace = firstInLine \|\| token.IsPrecededByWhitespace();`
	`101`	`+ bool precededBySpace = firstInLine \|\| token.IsPrecededByWhitespace(context.CancellationToken);`
`102`	`102`	`bool followedBySpace = token.IsFollowedByWhitespace();`
`103`	`103`
`104`	`104`	`if (!firstInLine && precededBySpace)`