C#: Add active preprocessor conditions as suffix in all TRAP .push instructions

Author: hvitved

csharp/extractor/Semmle.Extraction.CSharp/Entities/CommentBlock.cs

@@ -42,7 +42,5 @@ private class CommentBlockFactory : CachedEntityFactory<Comments.CommentBlock, C
 
             public override CommentBlock Create(Context cx, Comments.CommentBlock init) => new CommentBlock(cx, init);
         }
-
-        public override TrapStackBehaviour TrapStackBehaviour => TrapStackBehaviour.NoLabel;
     }
 }

csharp/extractor/Semmle.Extraction.CSharp/Entities/Compilations/Compilation.cs

@@ -87,8 +87,6 @@ public override void WriteId(EscapingTextWriter trapFile)
             trapFile.Write(";compilation");
         }
 
-        public override TrapStackBehaviour TrapStackBehaviour => TrapStackBehaviour.NoLabel;
-
         public override Location ReportingLocation => throw new NotImplementedException();
 
         public override bool NeedsPopulation => Context.IsAssemblyScope;

csharp/extractor/Semmle.Extraction.CSharp/Entities/Compilations/Diagnostic.cs

@@ -4,8 +4,6 @@ namespace Semmle.Extraction.CSharp.Entities
 {
     internal class Diagnostic : FreshEntity
     {
-        public override TrapStackBehaviour TrapStackBehaviour => TrapStackBehaviour.NoLabel;
-
         private readonly Microsoft.CodeAnalysis.Diagnostic diagnostic;
 
         public Diagnostic(Context cx, Microsoft.CodeAnalysis.Diagnostic diag) : base(cx)

csharp/extractor/Semmle.Extraction.CSharp/Entities/Event.cs

@@ -71,7 +71,5 @@ private class EventFactory : CachedEntityFactory<IEventSymbol, Event>
 
             public override Event Create(Context cx, IEventSymbol init) => new Event(cx, init);
         }
-
-        public override TrapStackBehaviour TrapStackBehaviour => TrapStackBehaviour.NoLabel;
     }
 }

csharp/extractor/Semmle.Extraction.CSharp/Entities/Namespace.cs

@@ -43,8 +43,6 @@ private class NamespaceFactory : CachedEntityFactory<INamespaceSymbol, Namespace
             public override Namespace Create(Context cx, INamespaceSymbol init) => new Namespace(cx, init);
         }
 
-        public override TrapStackBehaviour TrapStackBehaviour => TrapStackBehaviour.NoLabel;
-
         public override int GetHashCode() => QualifiedName.GetHashCode();
 
         private string QualifiedName => Symbol.ToDisplayString();

csharp/extractor/Semmle.Extraction.CSharp/Entities/NamespaceDeclaration.cs

@@ -60,8 +60,6 @@ public override NamespaceDeclaration Create(Context cx, (NamespaceDeclarationSyn
                 new NamespaceDeclaration(cx, init.decl, init.parent);
         }
 
-        public override TrapStackBehaviour TrapStackBehaviour => TrapStackBehaviour.NoLabel;
-
         public override Microsoft.CodeAnalysis.Location ReportingLocation => node.Name.GetLocation();
 
         public override bool NeedsPopulation => true;

csharp/extractor/Semmle.Extraction.CSharp/Entities/PreprocessorDirectives/DefineDirective.cs

@@ -5,14 +5,24 @@ namespace Semmle.Extraction.CSharp.Entities
 {
     internal class DefineDirective : PreprocessorDirective<DefineDirectiveTriviaSyntax>
     {
-        public DefineDirective(Context cx, DefineDirectiveTriviaSyntax trivia)
+        private DefineDirective(Context cx, DefineDirectiveTriviaSyntax trivia)
             : base(cx, trivia)
         {
         }
 
         protected override void PopulatePreprocessor(TextWriter trapFile)
         {
-            trapFile.directive_defines(this, trivia.Name.ToString());
+            trapFile.directive_defines(this, Symbol.Name.ToString());
+        }
+
+        public static DefineDirective Create(Context cx, DefineDirectiveTriviaSyntax def) =>
+            DefineDirectiveFactory.Instance.CreateEntity(cx, def, def);
+
+        private class DefineDirectiveFactory : CachedEntityFactory<DefineDirectiveTriviaSyntax, DefineDirective>
+        {
+            public static DefineDirectiveFactory Instance { get; } = new DefineDirectiveFactory();
+
+            public override DefineDirective Create(Context cx, DefineDirectiveTriviaSyntax init) => new(cx, init);
         }
     }
 }

csharp/extractor/Semmle.Extraction.CSharp/Entities/PreprocessorDirectives/ElifDirective.cs

@@ -8,21 +8,39 @@ internal class ElifDirective : PreprocessorDirective<ElifDirectiveTriviaSyntax>,
         private readonly IfDirective start;
         private readonly int index;
 
-        public ElifDirective(Context cx, ElifDirectiveTriviaSyntax trivia, IfDirective start, int index)
-            : base(cx, trivia, populateFromBase: false)
+        private ElifDirective(Context cx, ElifDirectiveTriviaSyntax trivia, IfDirective start, int index)
+            : base(cx, trivia)
         {
             this.start = start;
             this.index = index;
-            TryPopulate();
         }
 
         public bool IsTopLevelParent => true;
 
+        public override void WriteId(EscapingTextWriter trapFile)
+        {
+            trapFile.WriteSubId(Context.CreateLocation(ReportingLocation));
+            trapFile.Write(Symbol.IsActive);
+            trapFile.Write(',');
+            trapFile.Write(Symbol.ConditionValue);
+            trapFile.Write(";trivia");
+        }
+
         protected override void PopulatePreprocessor(TextWriter trapFile)
         {
-            trapFile.directive_elifs(this, trivia.BranchTaken, trivia.ConditionValue, start, index);
+            trapFile.directive_elifs(this, Symbol.BranchTaken, Symbol.ConditionValue, start, index);
+
+            Expression.Create(Context, Symbol.Condition, this, 0);
+        }
+
+        public static ElifDirective Create(Context cx, ElifDirectiveTriviaSyntax elif, IfDirective start, int index) =>
+            ElifDirectiveFactory.Instance.CreateEntity(cx, elif, (elif, start, index));
+
+        private class ElifDirectiveFactory : CachedEntityFactory<(ElifDirectiveTriviaSyntax elif, IfDirective start, int index), ElifDirective>
+        {
+            public static ElifDirectiveFactory Instance { get; } = new ElifDirectiveFactory();
 
-            Expression.Create(Context, trivia.Condition, this, 0);
+            public override ElifDirective Create(Context cx, (ElifDirectiveTriviaSyntax elif, IfDirective start, int index) init) => new(cx, init.elif, init.start, init.index);
         }
     }
 }

csharp/extractor/Semmle.Extraction.CSharp/Entities/PreprocessorDirectives/ElseDirective.cs

@@ -8,17 +8,26 @@ internal class ElseDirective : PreprocessorDirective<ElseDirectiveTriviaSyntax>,
         private readonly IfDirective start;
         private readonly int index;
 
-        public ElseDirective(Context cx, ElseDirectiveTriviaSyntax trivia, IfDirective start, int index)
-            : base(cx, trivia, populateFromBase: false)
+        private ElseDirective(Context cx, ElseDirectiveTriviaSyntax trivia, IfDirective start, int index)
+            : base(cx, trivia)
         {
             this.start = start;
             this.index = index;
-            TryPopulate();
         }
 
         protected override void PopulatePreprocessor(TextWriter trapFile)
         {
-            trapFile.directive_elses(this, trivia.BranchTaken, start, index);
+            trapFile.directive_elses(this, Symbol.BranchTaken, start, index);
+        }
+
+        public static ElseDirective Create(Context cx, ElseDirectiveTriviaSyntax @else, IfDirective start, int index) =>
+            ElseDirectiveFactory.Instance.CreateEntity(cx, @else, (@else, start, index));
+
+        private class ElseDirectiveFactory : CachedEntityFactory<(ElseDirectiveTriviaSyntax @else, IfDirective start, int index), ElseDirective>
+        {
+            public static ElseDirectiveFactory Instance { get; } = new ElseDirectiveFactory();
+
+            public override ElseDirective Create(Context cx, (ElseDirectiveTriviaSyntax @else, IfDirective start, int index) init) => new(cx, init.@else, init.start, init.index);
         }
     }
 }

csharp/extractor/Semmle.Extraction.CSharp/Entities/PreprocessorDirectives/EndIfDirective.cs

@@ -7,16 +7,25 @@ internal class EndIfDirective : PreprocessorDirective<EndIfDirectiveTriviaSyntax
     {
         private readonly IfDirective start;
 
-        public EndIfDirective(Context cx, EndIfDirectiveTriviaSyntax trivia, IfDirective start)
-            : base(cx, trivia, populateFromBase: false)
+        private EndIfDirective(Context cx, EndIfDirectiveTriviaSyntax trivia, IfDirective start)
+            : base(cx, trivia)
         {
             this.start = start;
-            TryPopulate();
         }
 
         protected override void PopulatePreprocessor(TextWriter trapFile)
         {
             trapFile.directive_endifs(this, start);
         }
+
+        public static EndIfDirective Create(Context cx, EndIfDirectiveTriviaSyntax endif, IfDirective start) =>
+            EndIfDirectiveFactory.Instance.CreateEntity(cx, endif, (endif, start));
+
+        private class EndIfDirectiveFactory : CachedEntityFactory<(EndIfDirectiveTriviaSyntax endif, IfDirective start), EndIfDirective>
+        {
+            public static EndIfDirectiveFactory Instance { get; } = new EndIfDirectiveFactory();
+
+            public override EndIfDirective Create(Context cx, (EndIfDirectiveTriviaSyntax endif, IfDirective start) init) => new(cx, init.endif, init.start);
+        }
     }
 }