Add more safety around adding annotations

Author: MDoerner

Rubberduck.Parsing/VBA/AnnotationUpdater.cs

@@ -9,6 +9,7 @@
 using Rubberduck.Parsing.Grammar;
 using Rubberduck.Parsing.Rewriter;
 using Rubberduck.Parsing.Symbols;
+using Rubberduck.Parsing.VBA.Parsing;
 
 namespace Rubberduck.Parsing.VBA
 {
@@ -27,6 +28,13 @@ public void AddAnnotation(IRewriteSession rewriteSession, QualifiedContext conte
                 return;
             }
 
+            if (rewriteSession.TargetCodeKind != CodeKind.CodePaneCode)
+            {
+                _logger.Warn($"Tried to add an annotation with a rewriter not suitable for annotationss. (target code kind = {rewriteSession.TargetCodeKind})");
+                _logger.Trace($"Tried to add annotation {annotationType} with values {AnnotationValuesText(annotationValues)} to {context.Context.GetText()} at {context.Context.GetSelection()} in module {context.ModuleName} using a rewriter not suitable for annotations.");
+                return;
+            }
+
             var annotationText = AnnotationText(annotationType, annotationValues);
 
             string codeToAdd;
@@ -111,43 +119,64 @@ public void AddAnnotation(IRewriteSession rewriteSession, Declaration declaratio
             }
         }
 
-        private void AddModuleAnnotation(IRewriteSession rewriteSession, Declaration declaration, AnnotationType annotationType, IReadOnlyList<string> values)
+        private void AddModuleAnnotation(IRewriteSession rewriteSession, Declaration declaration, AnnotationType annotationType, IReadOnlyList<string> annotationValues)
         {
             if (!annotationType.HasFlag(AnnotationType.ModuleAnnotation))
             {
                 _logger.Warn("Tried to add an annotation without the module annotation flag to a module.");
-                _logger.Trace($"Tried to add the annotation {annotationType} with values {AnnotationValuesText(values)} to the module {declaration.QualifiedModuleName}.");
+                _logger.Trace($"Tried to add the annotation {annotationType} with values {AnnotationValuesText(annotationValues)} to the module {declaration.QualifiedModuleName}.");
+                return;
+            }
+
+            if (rewriteSession.TargetCodeKind != CodeKind.CodePaneCode)
+            {
+                _logger.Warn($"Tried to add an annotation to a module with a rewriter not suitable for annotationss. (target code kind = {rewriteSession.TargetCodeKind})");
+                _logger.Trace($"Tried to add annotation {annotationType} with values {AnnotationValuesText(annotationValues)} to the module {declaration.QualifiedModuleName} using a rewriter not suitable for annotations.");
                 return;
             }
 
-            var codeToAdd = $"{AnnotationText(annotationType, values)}{Environment.NewLine}";
+            var codeToAdd = $"{AnnotationText(annotationType, annotationValues)}{Environment.NewLine}";
 
             var rewriter = rewriteSession.CheckOutModuleRewriter(declaration.QualifiedModuleName);
             rewriter.InsertBefore(0, codeToAdd);
         }
 
-        private void AddVariableAnnotation(IRewriteSession rewriteSession, Declaration declaration, AnnotationType annotationType, IReadOnlyList<string> values)
+        private void AddVariableAnnotation(IRewriteSession rewriteSession, Declaration declaration, AnnotationType annotationType, IReadOnlyList<string> annotationValues)
         {
             if (!annotationType.HasFlag(AnnotationType.VariableAnnotation))
             {
                 _logger.Warn("Tried to add an annotation without the variable annotation flag to a variable declaration.");
-                _logger.Trace($"Tried to add the annotation {annotationType} with values {AnnotationValuesText(values)} to the variable declaration for {declaration.QualifiedName}.");
+                _logger.Trace($"Tried to add the annotation {annotationType} with values {AnnotationValuesText(annotationValues)} to the variable declaration for {declaration.QualifiedName}.");
                 return;
             }
 
-            AddAnnotation(rewriteSession, new QualifiedContext(declaration.QualifiedName, declaration.Context), annotationType, values);
+            if (rewriteSession.TargetCodeKind != CodeKind.CodePaneCode)
+            {
+                _logger.Warn($"Tried to add an annotation to a variable with a rewriter not suitable for annotationss. (target code kind = {rewriteSession.TargetCodeKind})");
+                _logger.Trace($"Tried to add annotation {annotationType} with values {AnnotationValuesText(annotationValues)} to the the variable {declaration.IdentifierName} at {declaration.Selection} in module {declaration.QualifiedModuleName} using a rewriter not suitable for annotations.");
+                return;
+            }
+
+            AddAnnotation(rewriteSession, new QualifiedContext(declaration.QualifiedName, declaration.Context), annotationType, annotationValues);
         }
 
-        private void AddMemberAnnotation(IRewriteSession rewriteSession, Declaration declaration, AnnotationType annotationType, IReadOnlyList<string> values)
+        private void AddMemberAnnotation(IRewriteSession rewriteSession, Declaration declaration, AnnotationType annotationType, IReadOnlyList<string> annotationValues)
         {
             if (!annotationType.HasFlag(AnnotationType.MemberAnnotation))
             {
                 _logger.Warn("Tried to add an annotation without the member annotation flag to a member declaration.");
-                _logger.Trace($"Tried to add the annotation {annotationType} with values {AnnotationValuesText(values)} to the member declaration for {declaration.QualifiedName}.");
+                _logger.Trace($"Tried to add the annotation {annotationType} with values {AnnotationValuesText(annotationValues)} to the member declaration for {declaration.QualifiedName}.");
+                return;
+            }
+
+            if (rewriteSession.TargetCodeKind != CodeKind.CodePaneCode)
+            {
+                _logger.Warn($"Tried to add an annotation to a member with a rewriter not suitable for annotationss. (target code kind = {rewriteSession.TargetCodeKind})");
+                _logger.Trace($"Tried to add annotation {annotationType} with values {AnnotationValuesText(annotationValues)} to the the member {declaration.IdentifierName} at {declaration.Selection} in module {declaration.QualifiedModuleName} using a rewriter not suitable for annotations.");
                 return;
             }
 
-            AddAnnotation(rewriteSession, new QualifiedContext(declaration.QualifiedName, declaration.Context), annotationType, values);
+            AddAnnotation(rewriteSession, new QualifiedContext(declaration.QualifiedName, declaration.Context), annotationType, annotationValues);
         }
 
 
@@ -170,6 +199,13 @@ public void AddAnnotation(IRewriteSession rewriteSession, IdentifierReference re
                 return;
             }
 
+            if (rewriteSession.TargetCodeKind != CodeKind.CodePaneCode)
+            {
+                _logger.Warn($"Tried to add an annotation to an identifier reference with a rewriter not suitable for annotationss. (target code kind = {rewriteSession.TargetCodeKind})");
+                _logger.Trace($"Tried to add annotation {annotationType} with values {AnnotationValuesText(annotationValues)} to the the identifier reference {reference.IdentifierName} at {reference.Selection} in module {reference.QualifiedModuleName} using a rewriter not suitable for annotations.");
+                return;
+            }
+
             AddAnnotation(rewriteSession, new QualifiedContext(reference.QualifiedModuleName, reference.Context), annotationType, annotationValues);
         }
 
@@ -181,6 +217,13 @@ public void RemoveAnnotation(IRewriteSession rewriteSession, IAnnotation annotat
                 return;
             }
 
+            if (rewriteSession.TargetCodeKind != CodeKind.CodePaneCode)
+            {
+                _logger.Warn($"Tried to remove an annotation with a rewriter not suitable for annotationss. (target code kind = {rewriteSession.TargetCodeKind})");
+                _logger.Trace($"Tried to remove annotation {annotation.AnnotationType} at {annotation.QualifiedSelection.Selection} in module {annotation.QualifiedSelection.QualifiedName} using a rewriter not suitable for annotations.");
+                return;
+            }
+
             var annotationContext = annotation.Context;
             var annotationList = (VBAParser.AnnotationListContext)annotationContext.Parent;
 
@@ -246,6 +289,12 @@ public void RemoveAnnotations(IRewriteSession rewriteSession, IEnumerable<IAnnot
                 return;
             }
 
+            if (rewriteSession.TargetCodeKind != CodeKind.CodePaneCode)
+            {
+                _logger.Warn($"Tried to remove multiple annotations with a rewriter not suitable for annotations. (target code kind = {rewriteSession.TargetCodeKind})");
+                return;
+            }
+
             var annotationsByAnnotationList = annotations.Distinct()
                 .GroupBy(annotation => new QualifiedContext(annotation.QualifiedSelection.QualifiedName, (ParserRuleContext)annotation.Context.Parent))
                 .ToDictionary(grouping => grouping.Key, grouping => grouping.ToList());
@@ -287,6 +336,13 @@ public void UpdateAnnotation(IRewriteSession rewriteSession, IAnnotation annotat
                 return;
             }
 
+            if (rewriteSession.TargetCodeKind != CodeKind.CodePaneCode)
+            {
+                _logger.Warn($"Tried to update an annotation with a rewriter not suitable for annotationss. (target code kind = {rewriteSession.TargetCodeKind})");
+                _logger.Trace($"Tried to update annotation {annotation.AnnotationType} at {annotation.QualifiedSelection.Selection} in module {annotation.QualifiedSelection.QualifiedName} with annotation {newAnnotationType} with values {AnnotationValuesText(newAnnotationValues)} using a rewriter not suitable for annotations.");
+                return;
+            }
+
             //If there are no common flags, the annotations cannot apply to the same target.
             if ((annotation.AnnotationType & newAnnotationType) == 0)
             {