Introduced comment-tag to avoid removing include in iwyu & trial and error removal.

Fixes #38

Author: Wumpf

IncludeToolbox/Formatter/IncludeLineInfo.cs

@@ -314,6 +314,16 @@ public string RawLine
         /// </remarks>
         public int LineNumber { get; private set; } = -1;
 
+        public static bool ContainsPreserveFlag(string lineText)
+        {
+            return lineText.Contains("$include-toolbox-preserve$");
+        }
+
+        /// <summary>
+        /// Whether the include line should not be removed by iwyu and Trial & Error Removal.
+        /// </summary>
+        public bool ShouldBePreserved { get { return ContainsPreserveFlag(lineText); } }
+
         private int delimiter0 = -1;
         private int delimiter1 = -1;
 

IncludeToolbox/IncludeWhatYouUse/IWYU.cs

@@ -189,7 +189,8 @@ static private void ApplyTasks(Dictionary<string, FormatTask> tasks, bool applyF
                     {
                         foreach (int lineToRemove in entry.Value.linesToRemove.Reverse())
                         {
-                            edit.Delete(originalLines[lineToRemove].ExtentIncludingLineBreak);
+                            if (!Formatter.IncludeLineInfo.ContainsPreserveFlag(originalLines[lineToRemove].GetText()))
+                                edit.Delete(originalLines[lineToRemove].ExtentIncludingLineBreak);
                         }
                     }
 

IncludeToolbox/TrialAndErrorRemoval.cs

@@ -122,6 +122,10 @@ private void ExtractSelectionAndIncludes(EnvDTE.Document document, TrialAndError
             // Optionally skip top most include.
             if (settings.IgnoreFirstInclude)
                 includeLines = includeLines.Skip(1);
+
+            // Skip everything with preserve flag.
+            includeLines = includeLines.Where(x => !x.ShouldBePreserved);
+
             // Apply filter ignore regex.
             {
                 string documentName = Path.GetFileNameWithoutExtension(document.FullName);

Tests/IncludeLineInfoTests.cs

@@ -194,5 +194,17 @@ public void MixedLineEndings()
             var parseWithEmpty = IncludeLineInfo.ParseIncludes(sourceCode, ParseOptions.None);
             Assert.AreEqual(6, parseWithEmpty.Count);
         }
+
+        [TestMethod]
+        public void PreserveFlag()
+        {
+            string testCode = @"#include <blorg> // $include-toolbox-preserve$
+#include ""test""";
+
+            var parsedLines = IncludeLineInfo.ParseIncludes(testCode, ParseOptions.RemoveEmptyLines);
+            Assert.AreEqual(2, parsedLines.Count);
+            Assert.IsTrue(parsedLines[0].ShouldBePreserved);
+            Assert.IsFalse(parsedLines[1].ShouldBePreserved);
+        }
     }
 }