Rework endregion extraction

tamasvajk · tamasvajk · commit 72547b89e60f · 2021-02-04T08:42:39.000+01:00
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/PreprocessorDirectives/EndRegionDirective.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/PreprocessorDirectives/EndRegionDirective.cs
@@ -5,19 +5,18 @@ namespace Semmle.Extraction.CSharp.Entities
 {
     internal class EndRegionDirective : PreprocessorDirective<EndRegionDirectiveTriviaSyntax>
     {
-        public EndRegionDirective(Context cx, EndRegionDirectiveTriviaSyntax trivia)
-            : base(cx, trivia)
-        {
-        }
+        private readonly RegionDirective region;
 
-        protected override void PopulatePreprocessor(TextWriter trapFile)
+        public EndRegionDirective(Context cx, EndRegionDirectiveTriviaSyntax trivia, RegionDirective region)
+            : base(cx, trivia, populateFromBase: false)
         {
-            trapFile.directive_endregions(this);
+            this.region = region;
+            TryPopulate();
         }
 
-        internal static void WriteRegionBlock(Context cx, RegionDirective region, EndRegionDirective endregion)
+        protected override void PopulatePreprocessor(TextWriter trapFile)
         {
-            cx.TrapWriter.Writer.regions(region, endregion);
+            trapFile.directive_endregions(this, region);
         }
     }
 }
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/PreprocessorDirectives/PreprocessorDirective.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/PreprocessorDirectives/PreprocessorDirective.cs
@@ -8,11 +8,14 @@ internal abstract class PreprocessorDirective<TDirective> : FreshEntity where TD
     {
         protected readonly TDirective trivia;
 
-        protected PreprocessorDirective(Context cx, TDirective trivia)
+        protected PreprocessorDirective(Context cx, TDirective trivia, bool populateFromBase = true)
             : base(cx)
         {
             this.trivia = trivia;
-            TryPopulate();
+            if (populateFromBase)
+            {
+                TryPopulate();
+            }
         }
 
         protected sealed override void Populate(TextWriter trapFile)
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Populators/DirectiveVisitor.cs b/csharp/extractor/Semmle.Extraction.CSharp/Populators/DirectiveVisitor.cs
@@ -65,15 +65,15 @@ public override void VisitRegionDirectiveTrivia(RegionDirectiveTriviaSyntax node
 
         public override void VisitEndRegionDirectiveTrivia(EndRegionDirectiveTriviaSyntax node)
         {
-            var endregion = new Entities.EndRegionDirective(cx, node);
             if (regionStarts.Count == 0)
             {
                 cx.ExtractionError("Couldn't find start region", null,
                     Extraction.Entities.Location.Create(cx, node.GetLocation()), null, Util.Logging.Severity.Warning);
                 return;
             }
+
             var start = regionStarts.Pop();
-            Entities.EndRegionDirective.WriteRegionBlock(cx, start, endregion);
+            new Entities.EndRegionDirective(cx, node, start);
         }
 
         private readonly Stack<Entities.IfDirective> ifStarts = new Stack<Entities.IfDirective>();
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Tuples.cs b/csharp/extractor/Semmle.Extraction.CSharp/Tuples.cs
@@ -669,9 +669,9 @@ internal static void directive_regions(this TextWriter trapFile, RegionDirective
             trapFile.WriteTuple("directive_regions", directive, name);
         }
 
-        internal static void directive_endregions(this TextWriter trapFile, EndRegionDirective directive)
+        internal static void directive_endregions(this TextWriter trapFile, EndRegionDirective directive, RegionDirective start)
         {
-            trapFile.WriteTuple("directive_endregions", directive);
+            trapFile.WriteTuple("directive_endregions", directive, start);
         }
 
         internal static void regions(this TextWriter trapFile, RegionDirective start, EndRegionDirective end)
diff --git a/csharp/ql/src/semmle/code/csharp/Preprocessor.qll b/csharp/ql/src/semmle/code/csharp/Preprocessor.qll
@@ -232,7 +232,7 @@ class RegionDirective extends PreprocessorDirective, @directive_region {
   string getName() { directive_regions(this, result) }
 
   /** Gets the closing `#endregion` directive. */
-  EndRegionDirective getEnd() { regions(this, result) }
+  EndRegionDirective getEnd() { directive_endregions(result, this) }
 
   override string toString() { result = "#region ..." }
 
diff --git a/csharp/ql/src/semmlecode.csharp.dbscheme b/csharp/ql/src/semmlecode.csharp.dbscheme
@@ -376,13 +376,10 @@ directive_regions(
   unique int id: @directive_region,
   string name: string ref);
 
+#keyset[id, start]
 directive_endregions(
-  unique int id: @directive_endregion);
-
-#keyset[start, end]
-regions(
-  unique int start: @directive_region ref,
-  unique int end: @directive_endregion ref);
+  unique int id: @directive_endregion,
+  unique int start: @directive_region ref);
 
 directive_lines(
   unique int id: @directive_line,

Original file line number	Diff line number	Diff line change
`@@ -5,19 +5,18 @@ namespace Semmle.Extraction.CSharp.Entities`
`5`	`5`	`{`
`6`	`6`	`internal class EndRegionDirective : PreprocessorDirective<EndRegionDirectiveTriviaSyntax>`
`7`	`7`	`{`
`8`		`- public EndRegionDirective(Context cx, EndRegionDirectiveTriviaSyntax trivia)`
`9`		`- : base(cx, trivia)`
`10`		`- {`
`11`		`- }`
	`8`	`+ private readonly RegionDirective region;`
`12`	`9`
`13`		`- protected override void PopulatePreprocessor(TextWriter trapFile)`
	`10`	`+ public EndRegionDirective(Context cx, EndRegionDirectiveTriviaSyntax trivia, RegionDirective region)`
	`11`	`+ : base(cx, trivia, populateFromBase: false)`
`14`	`12`	`{`
`15`		`- trapFile.directive_endregions(this);`
	`13`	`+ this.region = region;`
	`14`	`+ TryPopulate();`
`16`	`15`	`}`
`17`	`16`
`18`		`- internal static void WriteRegionBlock(Context cx, RegionDirective region, EndRegionDirective endregion)`
	`17`	`+ protected override void PopulatePreprocessor(TextWriter trapFile)`
`19`	`18`	`{`
`20`		`- cx.TrapWriter.Writer.regions(region, endregion);`
	`19`	`+ trapFile.directive_endregions(this, region);`
`21`	`20`	`}`
`22`	`21`	`}`
`23`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,11 +8,14 @@ internal abstract class PreprocessorDirective<TDirective> : FreshEntity where TD`
`8`	`8`	`{`
`9`	`9`	`protected readonly TDirective trivia;`
`10`	`10`
`11`		`- protected PreprocessorDirective(Context cx, TDirective trivia)`
	`11`	`+ protected PreprocessorDirective(Context cx, TDirective trivia, bool populateFromBase = true)`
`12`	`12`	`: base(cx)`
`13`	`13`	`{`
`14`	`14`	`this.trivia = trivia;`
`15`		`- TryPopulate();`
	`15`	`+ if (populateFromBase)`
	`16`	`+ {`
	`17`	`+ TryPopulate();`
	`18`	`+ }`
`16`	`19`	`}`
`17`	`20`
`18`	`21`	`protected sealed override void Populate(TextWriter trapFile)`
Original file line number	Diff line number	Diff line change
`@@ -65,15 +65,15 @@ public override void VisitRegionDirectiveTrivia(RegionDirectiveTriviaSyntax node`
`65`	`65`
`66`	`66`	`public override void VisitEndRegionDirectiveTrivia(EndRegionDirectiveTriviaSyntax node)`
`67`	`67`	`{`
`68`		`- var endregion = new Entities.EndRegionDirective(cx, node);`
`69`	`68`	`if (regionStarts.Count == 0)`
`70`	`69`	`{`
`71`	`70`	`cx.ExtractionError("Couldn't find start region", null,`
`72`	`71`	`Extraction.Entities.Location.Create(cx, node.GetLocation()), null, Util.Logging.Severity.Warning);`
`73`	`72`	`return;`
`74`	`73`	`}`
	`74`	`+`
`75`	`75`	`var start = regionStarts.Pop();`
`76`		`- Entities.EndRegionDirective.WriteRegionBlock(cx, start, endregion);`
	`76`	`+ new Entities.EndRegionDirective(cx, node, start);`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`private readonly Stack<Entities.IfDirective> ifStarts = new Stack<Entities.IfDirective>();`
Original file line number	Diff line number	Diff line change
`@@ -669,9 +669,9 @@ internal static void directive_regions(this TextWriter trapFile, RegionDirective`
`669`	`669`	`trapFile.WriteTuple("directive_regions", directive, name);`
`670`	`670`	`}`
`671`	`671`
`672`		`- internal static void directive_endregions(this TextWriter trapFile, EndRegionDirective directive)`
	`672`	`+ internal static void directive_endregions(this TextWriter trapFile, EndRegionDirective directive, RegionDirective start)`
`673`	`673`	`{`
`674`		`- trapFile.WriteTuple("directive_endregions", directive);`
	`674`	`+ trapFile.WriteTuple("directive_endregions", directive, start);`
`675`	`675`	`}`
`676`	`676`
`677`	`677`	`internal static void regions(this TextWriter trapFile, RegionDirective start, EndRegionDirective end)`