Added SuspendParserFailureException

Author: BZngr

Rubberduck.Core/UI/Command/Refactorings/Notifiers/ExtractInterfaceFailedNotifier.cs

@@ -22,6 +22,9 @@ protected override string Message(RefactoringException exception)
                         invalidDeclarationType.TargetDeclaration.QualifiedModuleName,
                         invalidDeclarationType.TargetDeclaration.DeclarationType,
                         DeclarationType.ClassModule);
+                case SuspendParserFailureException suspendParserFailure:
+                    Logger.Warn(suspendParserFailure);
+                    return Resources.RubberduckUI.RefactoringFailure_SuspendParserFailure;
                 default:
                     return base.Message(exception);
             }

Rubberduck.Core/UI/Command/Refactorings/Notifiers/RenameFailedNotifier.cs

@@ -21,9 +21,12 @@ protected override string Message(RefactoringException exception)
                     return string.Format(Resources.RubberduckUI.RenameFailure_TargetModuleWithoutCodeModule, codeModuleNotFound.TargetDeclaration.QualifiedModuleName);
                 case TargetControlNotFoundException controlNotFound:
                     Logger.Warn(controlNotFound);
-                    return string.Format(Resources.RubberduckUI.RenameFailure_TargetContriolNotFound, controlNotFound.TargetDeclaration.QualifiedName);
+                    return string.Format(Resources.RubberduckUI.RenameFailure_TargetControlNotFound, controlNotFound.TargetDeclaration.QualifiedName);
                 case TargetDeclarationIsStandardEventHandlerException standardHandler:
                     return string.Format(Resources.RubberduckUI.RenameFailure_StandardEventHandler, standardHandler.TargetDeclaration.QualifiedName);
+                case SuspendParserFailureException suspendParserFailure:
+                    Logger.Warn(suspendParserFailure);
+                    return Resources.RubberduckUI.RefactoringFailure_SuspendParserFailure;
                 default:
                     return base.Message(exception);
             }

Rubberduck.Refactorings/Exceptions/SuspendParserFailureException.cs

@@ -0,0 +1,11 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Rubberduck.Refactorings.Exceptions
+{
+    public class SuspendParserFailureException : RefactoringException
+    { }
+}

Rubberduck.Refactorings/ExtractInterface/ExtractInterfaceRefactoring.cs

@@ -59,21 +59,21 @@ protected override ExtractInterfaceModel InitializeModel(Declaration target)
 
         protected override void RefactorImpl(ExtractInterfaceModel model)
         {
-            AddInterface(model);
+            AddInterfaceWithSuspendedParser(model);
         }
 
-        private void AddInterface(ExtractInterfaceModel model)
+        private void AddInterfaceWithSuspendedParser(ExtractInterfaceModel model)
         {
             //We need to suspend here since adding the interface and rewriting will both trigger a reparse.
-            var suspendResult = _parseManager.OnSuspendParser(this, new[] {ParserState.Ready}, () => AddInterfaceInternal(model));
+            var suspendResult = _parseManager.OnSuspendParser(this, new[] {ParserState.Ready}, () => AddInterface(model));
             if (suspendResult != SuspensionResult.Completed)
             {
-                _logger.Warn($"Extract interface failed because a parser suspension request could not be fulfilled.The request's result was '{suspendResult.ToString()}'.");
-                throw new OperationCanceledException(RubberduckUI.RefactoringFailure_BaseMessage);
+                _logger.Warn($"{nameof(AddInterface)} failed because a parser suspension request could not be fulfilled.  The request's result was '{suspendResult.ToString()}'.");
+                throw new SuspendParserFailureException();
             }
         }
 
-        private void AddInterfaceInternal(ExtractInterfaceModel model)
+        private void AddInterface(ExtractInterfaceModel model)
         {
             var targetProject = model.TargetDeclaration.Project;
             if (targetProject == null)

Rubberduck.Refactorings/Rename/RenameRefactoring.cs

@@ -44,8 +44,8 @@ public RenameRefactoring(IRefactoringPresenterFactory factory, IDeclarationFinde
                 {DeclarationType.Parameter, RenameParameter},
                 {DeclarationType.Event, RenameEvent},
                 {DeclarationType.Variable, RenameVariable},
-                {DeclarationType.Module, RenameModule},
-                {DeclarationType.Project, RenameProject}
+                {DeclarationType.Module, RenameModuleWithSuspendedParser},
+                {DeclarationType.Project, RenameProjectWithSuspendedParser}
             };
         }
 
@@ -334,18 +334,11 @@ private void RenameVariable(RenameModel model, IRewriteSession rewriteSession)
             }
         }
 
-        private void RenameModule(RenameModel model, IRewriteSession rewriteSession)
-        {
-            //The parser needs to be suspended during the refactoring of a component because the VBE API object rename causes a separate reparse. 
-            var suspendResult = _parseManager.OnSuspendParser(this, new[] { ParserState.Ready }, () => RenameModuleInternal(model, rewriteSession));
-            if (suspendResult != SuspensionResult.Completed)
-            {
-                _logger.Warn($"RenameModule failed because a parser suspension request could not be fulfilled.The request's result was '{suspendResult.ToString()}'.");
-                throw new OperationCanceledException(RubberduckUI.RefactoringFailure_BaseMessage);
-            }
-        }
+        //The parser needs to be suspended during the refactoring of a component because the VBE API object rename causes a separate reparse. 
+        private void RenameModuleWithSuspendedParser(RenameModel model, IRewriteSession rewriteSession)
+            => SuspendParserForRefactoring(nameof(RenameModule), () => RenameModule(model, rewriteSession));
 
-        private void RenameModuleInternal(RenameModel model, IRewriteSession rewriteSession)
+        private void RenameModule(RenameModel model, IRewriteSession rewriteSession)
         {
             RenameReferences(model.Target, model.NewName, rewriteSession);
 
@@ -413,19 +406,12 @@ private void RenameModuleInternal(RenameModel model, IRewriteSession rewriteSess
             }
         }
 
-        private void RenameProject(RenameModel model, IRewriteSession rewriteSession)
-        {
-            //The parser needs to be suspended during the refactoring of a project because the VBE API object rename causes a separate reparse. 
-            var suspendResult = _parseManager.OnSuspendParser(this, new[] { ParserState.Ready }, () => RenameProjectInternal(model, rewriteSession));
-            if (suspendResult != SuspensionResult.Completed)
-            {
-                _logger.Warn($"RenameProject failed because a parser suspension request could not be fulfilled.The request's result was '{suspendResult.ToString()}'.");
-                throw new OperationCanceledException(RubberduckUI.RefactoringFailure_BaseMessage);
-            }
-        }
+        //The parser needs to be suspended during the refactoring of a project because the VBE API object rename causes a separate reparse. 
+        private void RenameProjectWithSuspendedParser(RenameModel model, IRewriteSession rewriteSession)
+            => SuspendParserForRefactoring(nameof(RenameProject), () => RenameProject(model, rewriteSession));
 
         //TODO: Implement renaming references to the project in code.
-        private void RenameProjectInternal(RenameModel model, IRewriteSession rewriteSession)
+        private void RenameProject(RenameModel model, IRewriteSession rewriteSession)
         {
             var project = _projectsProvider.Project(model.Target.ProjectId);
 
@@ -499,6 +485,16 @@ private List<string> StandardEventHandlerNames()
                             || ev.IdentifierName.StartsWith("auto_"))
                     .Select(dec => dec.IdentifierName).ToList();
         }
+
+        private void SuspendParserForRefactoring(string procedureName, Action busyAction)
+        {
+            var suspendResult = _parseManager.OnSuspendParser(this, new[] { ParserState.Ready }, busyAction);
+            if (suspendResult != SuspensionResult.Completed)
+            {
+                _logger.Warn($"{procedureName} failed because a parser suspension request could not be fulfilled.  The request's result was '{suspendResult.ToString()}'.");
+                throw new SuspendParserFailureException();
+            }
+        }
     }
 }
 

Rubberduck.Resources/RubberduckUI.Designer.cs

@@ -1547,7 +1547,7 @@ NOTE: Restart is required for the setting to take effect.</value>
     <value>No code module found for the target module '{0}'.</value>
     <comment>{0}: name of module</comment>
   </data>
-  <data name="RenameFailure_TargetContriolNotFound" xml:space="preserve">
+  <data name="RenameFailure_TargetControlNotFound" xml:space="preserve">
     <value>Target control '{0}' not found.</value>
     <comment>{0}: name of control</comment>
   </data>
@@ -1641,4 +1641,7 @@ NOTE: Restart is required for the setting to take effect.</value>
     <value>{0} Consider choosing a different name.</value>
     <comment>{0} = Meaningless name message</comment>
   </data>
+  <data name="RefactoringFailure_SuspendParserFailure" xml:space="preserve">
+    <value>Unable to suspend the Parser to perform the refactoring operation</value>
+  </data>
 </root>