reimplement "Insert 'TODO' comment in new event handler" option in Windows Forms Designer

Author: siegfriedpammer

src/AddIns/BackendBindings/CSharpBinding/Project/Src/FormsDesigner/CSharpEventBindingService.cs

@@ -31,6 +31,7 @@
 using ICSharpCode.SharpDevelop;
 using ICSharpCode.SharpDevelop.Editor;
 using ICSharpCode.SharpDevelop.Project;
+using ICSharpCode.SharpDevelop.Refactoring;
 using CSharpBinding.Refactoring;
 
 namespace CSharpBinding.FormsDesigner
@@ -147,7 +148,8 @@ void InsertEventHandlerInternal(string methodName, IEvent evt)
 			var primary = loader.GetPrimaryTypeDefinition();
 			var evtHandler = primary.GetMethods(m => m.Name == methodName, GetMemberOptions.IgnoreInheritedMembers).FirstOrDefault();
 			if (evtHandler == null) {
-				generator.InsertEventHandler(primary, methodName, evt, true);
+				var insertionType = GeneralOptionsPanel.InsertTodoComment ? InsertEventHandlerBodyKind.TodoComment : InsertEventHandlerBodyKind.Nothing;
+				generator.InsertEventHandler(primary, methodName, evt, true, insertionType);
 			} else {
 				CSharpBinding.Parser.CSharpFullParseInformation parseInfo;
 				var node = evtHandler.GetDeclaration(out parseInfo) as MethodDeclaration;

src/AddIns/BackendBindings/CSharpBinding/Project/Src/Refactoring/CSharpCodeGenerator.cs

@@ -66,7 +66,7 @@ public override void AddReturnTypeAttribute(IMethod target, IAttribute attribute
 			AddAttribute(target.Region, attribute, "return");
 		}
 
-		public override void InsertEventHandler(ITypeDefinition target, string name, IEvent eventDefinition, bool jumpTo)
+		public override void InsertEventHandler(ITypeDefinition target, string name, IEvent eventDefinition, bool jumpTo, InsertEventHandlerBodyKind bodyKind = InsertEventHandlerBodyKind.ThrowNotImplementedException)
 		{
 			IUnresolvedTypeDefinition match = null;
 
@@ -103,12 +103,30 @@ public override void InsertEventHandler(ITypeDefinition target, string name, IEv
 			decl.Parameters.AddRange(param);
 
 			using (Script script = context.StartScript()) {
-				// FIXME : will not work properly if there are no members.
+				int eolLen = 0;
 				if (last == match) {
-					script.InsertWithCursor("Insert event handler", Script.InsertPosition.End, decl).FireAndForget();
+					eolLen = 2;
+					script.AddTo((TypeDeclaration)node, decl);
 				} else {
 					script.InsertAfter(node, decl);
-					script.Select(throwStmt);
+				}
+				switch (bodyKind) {
+					case InsertEventHandlerBodyKind.TodoComment:
+						Comment comment = new Comment(" TODO: Implement " + name);
+						script.Replace(throwStmt, comment);
+						script.Select(comment);
+						break;
+					case InsertEventHandlerBodyKind.Nothing:
+						var segment = script.GetSegment(throwStmt);
+						if (script is DocumentScript && eolLen > 0) {
+							eolLen = ((DocumentScript)script).CurrentDocument.GetLineByOffset(segment.Offset).DelimiterLength;
+						}
+						script.RemoveText(segment.Offset, segment.Length - eolLen);
+						script.Select(segment.Offset, segment.Offset);
+						break;
+					case InsertEventHandlerBodyKind.ThrowNotImplementedException:
+						script.Select(throwStmt);
+						break;
 				}
 			}
 		}

src/AddIns/BackendBindings/CSharpBinding/Project/Src/Refactoring/EditorScript.cs

@@ -81,6 +81,16 @@ public override void Select(AstNode node)
 			editor.Select(startOffset, endOffset - startOffset);
 		}
 
+		public override void Select(int startOffset, int endOffset)
+		{
+			editor.Select(Math.Min(startOffset, endOffset), Math.Abs(endOffset - startOffset));
+		}
+		
+		public override void Select(TextLocation start, TextLocation end)
+		{
+			Select(editor.Document.GetOffset(start), editor.Document.GetOffset(end));
+		}
+		
 		public override Task Link(params AstNode[] nodes)
 		{
 			var segs = nodes.Select(node => GetSegment(node)).ToArray();

src/Main/Base/Project/Refactoring/CodeGenerator.cs

@@ -43,7 +43,7 @@ public virtual void AddReturnTypeAttribute(IMethod target, IAttribute attribute)
 			throw new NotSupportedException("Feature not supported!");
 		}
 
-		public virtual void InsertEventHandler(ITypeDefinition target, string name, IEvent eventDefinition, bool jumpTo)
+		public virtual void InsertEventHandler(ITypeDefinition target, string name, IEvent eventDefinition, bool jumpTo, InsertEventHandlerBodyKind bodyKind = InsertEventHandlerBodyKind.ThrowNotImplementedException)
 		{
 			throw new NotSupportedException("Feature not supported!");
 		}
@@ -123,4 +123,11 @@ public virtual void AddImport(FileName fileName, string namespaceName)
 			throw new NotSupportedException("Feature not supported!");
 		}
 	}
+	
+	public enum InsertEventHandlerBodyKind
+	{
+		Nothing,
+		TodoComment,
+		ThrowNotImplementedException
+	}
 }