[CodeIssues] Add FormatStringIssue.

ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj

@@ -396,6 +396,7 @@
     <Compile Include="Refactoring\CodeIssues\ParameterCanBeDemotedIssue\TypeCriteriaCollector.cs" />
     <Compile Include="Refactoring\CodeIssues\ReferenceToStaticMemberViaDerivedTypeIssue.cs" />
     <Compile Include="Refactoring\CodeIssues\ParameterCanBeDemotedIssue\IsTypeCriterion.cs" />
+    <Compile Include="Refactoring\CodeIssues\FormatStringIssue.cs" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\ICSharpCode.NRefactory\ICSharpCode.NRefactory.csproj">

ICSharpCode.NRefactory.CSharp/Refactoring/BaseRefactoringContext.cs

@@ -35,6 +35,7 @@ using ICSharpCode.NRefactory.TypeSystem.Implementation;
 using ICSharpCode.NRefactory.Editor;
 using System.ComponentModel.Design;
 using ICSharpCode.NRefactory.CSharp.Analysis;
+using ICSharpCode.NRefactory.Utils;
 
 namespace ICSharpCode.NRefactory.CSharp.Refactoring
 {
@@ -135,6 +136,17 @@ namespace ICSharpCode.NRefactory.CSharp.Refactoring
 		{
 			return new DefiniteAssignmentAnalysis (root, resolver, CancellationToken);
 		}
+
+		/// <summary>
+		/// Parses a composite format string.
+		/// </summary>
+		/// <returns>
+		/// The format string parsing result.
+		/// </returns>
+		public virtual FormatStringParseResult ParseFormatString(string source)
+		{
+			return new CompositeFormatStringParser().Parse(source);
+		}
 		#endregion
 
 		/// <summary>

ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/FormatStringIssue.cs

@@ -0,0 +1,126 @@
+//
+// FormatStringIssue.cs
+//
+// Author:
+//       Simon Lindgren <simon.n.lindgren@gmail.com>
+//
+// Copyright (c) 2012 Simon Lindgren
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+using System;
+using System.Collections.Generic;
+using ICSharpCode.NRefactory.TypeSystem;
+using ICSharpCode.NRefactory.CSharp.Resolver;
+using System.Linq;
+using ICSharpCode.NRefactory.Utils;
+
+namespace ICSharpCode.NRefactory.CSharp.Refactoring
+{
+	[IssueDescription("Format string syntax error",
+	                  Description = "Finds issues with format strings.",
+	                  Category = IssueCategories.ConstraintViolations,
+	                  Severity = Severity.Error)]
+	public class FormatStringIssue : ICodeIssueProvider
+	{
+		public IEnumerable<CodeIssue> GetIssues(BaseRefactoringContext context)
+		{
+			return new GatherVisitor(context).GetIssues();
+		}
+		
+		class GatherVisitor : GatherVisitorBase
+		{
+			readonly BaseRefactoringContext context;
+			readonly IType stringType;
+			readonly IType objectType;
+			
+			public GatherVisitor(BaseRefactoringContext context) : base (context)
+			{
+				this.context = context;
+				stringType = context.Compilation.FindType(KnownTypeCode.String);
+				objectType = context.Compilation.FindType(KnownTypeCode.Object);
+			}
+
+			public override void VisitInvocationExpression(InvocationExpression invocationExpression)
+			{
+				base.VisitInvocationExpression(invocationExpression);
+				var invocationResolveResult = context.Resolve(invocationExpression) as CSharpInvocationResolveResult;
+				if (invocationResolveResult == null)
+					return;
+				string format;
+				IList<Expression> formatArguments;
+				TextLocation formatStart;
+				if (!TryGetFormattingParameters(invocationResolveResult, invocationExpression, out format, out formatStart, out formatArguments))
+					return;
+				var parsingResult = context.ParseFormatString(format);
+				var formatItems = (from segment in parsingResult.Segments
+					let formatItem = segment as FormatItem
+						where formatItem != null
+						select formatItem).ToList();
+				CheckFormatItems(formatItems, formatStart, formatArguments, invocationExpression);
+			}
+
+			void CheckFormatItems(List<FormatItem> formatItems, TextLocation formatStart, IList<Expression> formatArguments, AstNode anchor)
+			{
+				int argumentCount = formatArguments.Count;
+				foreach (var formatItem in formatItems) {
+					var itemStart = new TextLocation(formatStart.Line, formatStart.Column + formatItem.StartLocation + 1);
+					var itemEnd = new TextLocation(formatStart.Line, formatStart.Column + formatItem.EndLocation + 1);
+					if (formatItem.Index >= argumentCount) {
+						var messageFormat = context.TranslateString("The index '{0}' is out of bounds of the passed arguments");
+						AddIssue(itemStart, itemEnd, string.Format(messageFormat, formatItem.Index));
+					}
+					if (formatItem.HasErrors) {
+						var errors = formatItem.Errors;
+						var errorMessage = string.Join(Environment.NewLine, errors.Select(error => error.Message).ToArray());
+						string messageFormat;
+						if (errors.Count > 1)
+							messageFormat = context.TranslateString("Format string syntax errors:\n{0}");
+						else
+							messageFormat = context.TranslateString("Format string syntax error: {0}");
+						AddIssue(itemStart, itemEnd, string.Format(messageFormat, errorMessage));
+					}
+				}
+			}
+
+			static string[] parameterNames = { "format", "frmt", "fmt" };
+
+			bool TryGetFormattingParameters(CSharpInvocationResolveResult invocationResolveResult, InvocationExpression invocationExpression,
+			                                out string format, out TextLocation formatStart, out IList<Expression> arguments)
+			{
+				format = null;
+				formatStart = default(TextLocation);
+				arguments = new List<Expression>();
+				var argumentToParameterMap = invocationResolveResult.GetArgumentToParameterMap();
+				var resolvedParameters = invocationResolveResult.Member.Parameters;
+				for (int i = 0; i < invocationExpression.Arguments.Count; i++) {
+					var parameter = resolvedParameters[argumentToParameterMap[i]];
+					var argument = invocationExpression.Arguments.Skip(i).First();
+					if (parameter.Type.Equals(stringType) && parameterNames.Contains(parameter.Name) && argument is PrimitiveExpression) {
+						format = (string)((PrimitiveExpression)argument).Value;
+						formatStart = argument.StartLocation;
+					} else if (parameter.IsParams || parameter.Type.Equals(objectType)) {
+						arguments.Add(argument);
+					}
+				}
+				return format != null;
+			}
+		}
+	}
+}
+

ICSharpCode.NRefactory.Tests/CSharp/CodeIssues/FormatStringTests.cs

@@ -0,0 +1,121 @@
+//
+// FormatStringIssueTests.cs
+//
+// Author:
+//       Simon Lindgren <simon.n.lindgren@gmail.com>
+//
+// Copyright (c) 2012 Simon Lindgren
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+using NUnit.Framework;
+using ICSharpCode.NRefactory.CSharp.CodeActions;
+using ICSharpCode.NRefactory.CSharp.Refactoring;
+
+namespace ICSharpCode.NRefactory.CSharp.CodeIssues
+{
+	[TestFixture]
+	public class FormatStringTests : InspectionActionTestBase
+	{
+		[Test]
+		public void TooFewArguments()
+		{
+			var input = @"
+class TestClass
+{
+	void Foo()
+	{
+		string.Format(""{0}"");
+	}
+}";
+			
+			TestRefactoringContext context;
+			var issues = GetIssues (new FormatStringIssue (), input, out context);
+			Assert.AreEqual (1, issues.Count);
+		}
+
+		[Test]
+		public void FormatItemIndexOutOfRangeOfArguments()
+		{
+			var input = @"
+class TestClass
+{
+	void Foo()
+	{
+		string.Format(""{1}"", 1);
+	}
+}";
+			
+			TestRefactoringContext context;
+			var issues = GetIssues (new FormatStringIssue (), input, out context);
+			Assert.AreEqual (1, issues.Count);
+		}
+		
+		[Test]
+		public void FormatItemMissingEndBrace()
+		{
+			var input = @"
+class TestClass
+{
+	void Foo()
+	{
+		string.Format(""Text text text {0 text text text"", 1);
+	}
+}";
+
+			TestRefactoringContext context;
+			var issues = GetIssues (new FormatStringIssue (), input, out context);
+			Assert.AreEqual (1, issues.Count);
+		}
+
+		[Test]
+		public void IgnoresStringWithGoodArguments()
+		{
+			var input = @"
+class TestClass
+{
+	void Foo()
+	{
+		string.Format(""{0}"", ""arg0"");
+	}
+}";
+			
+			TestRefactoringContext context;
+			var issues = GetIssues (new FormatStringIssue (), input, out context);
+			Assert.AreEqual (0, issues.Count);
+		}
+
+		[Test]
+		public void IgnoresNonFormattingCall()
+		{
+			var input = @"
+class TestClass
+{
+	void Foo()
+	{
+		string lower = string.ToLower(""{0}"");
+	}
+}";
+			
+			TestRefactoringContext context;
+			var issues = GetIssues (new FormatStringIssue (), input, out context);
+			Assert.AreEqual (0, issues.Count);
+		}
+	}
+}
+

ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj

@@ -291,6 +291,7 @@
     <Compile Include="CSharp\CodeIssues\ReferenceToStaticMemberViaDerivedTypeTests.cs" />
     <Compile Include="CSharp\CodeIssues\ParameterCanBeDemotedIssue\IsTypeCriterionTests.cs" />
     <Compile Include="Utils\CompositeFormatStringParser\CompositeFormatStringParserTests.cs" />
+    <Compile Include="CSharp\CodeIssues\FormatStringTests.cs" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\..\Mono.Cecil\Mono.Cecil.csproj">