Extract define directives

tamasvajk · tamasvajk · commit 9b405144ffb9 · 2021-02-04T08:42:38.000+01:00
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/PreprocessorDirectives/DefineDirective.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/PreprocessorDirectives/DefineDirective.cs
@@ -0,0 +1,18 @@
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+using System.IO;
+
+namespace Semmle.Extraction.CSharp.Entities
+{
+    internal class DefineDirective : PreprocessorDirective<DefineDirectiveTriviaSyntax>
+    {
+        public DefineDirective(Context cx, DefineDirectiveTriviaSyntax trivia)
+            : base(cx, trivia)
+        {
+        }
+
+        protected override void PopulatePreprocessor(TextWriter trapFile)
+        {
+            trapFile.directive_defines(this, trivia.Name.ToString());
+        }
+    }
+}
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Populators/DirectiveVisitor.cs b/csharp/extractor/Semmle.Extraction.CSharp/Populators/DirectiveVisitor.cs
@@ -22,5 +22,10 @@ public override void VisitPragmaChecksumDirectiveTrivia(PragmaChecksumDirectiveT
         {
             new Entities.PragmaChecksumDirective(cx, node);
         }
+
+        public override void VisitDefineDirectiveTrivia(DefineDirectiveTriviaSyntax node)
+        {
+            new Entities.DefineDirective(cx, node);
+        }
     }
 }
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Tuples.cs b/csharp/extractor/Semmle.Extraction.CSharp/Tuples.cs
@@ -620,5 +620,10 @@ internal static void pragma_checksums(this TextWriter trapFile, PragmaChecksumDi
         {
             trapFile.WriteTuple("pragma_checksums", pragma, file, guid, bytes);
         }
+
+        internal static void directive_defines(this TextWriter trapFile, DefineDirective directive, string name)
+        {
+            trapFile.WriteTuple("directive_defines", directive, name);
+        }
     }
 }
diff --git a/csharp/ql/src/semmle/code/csharp/Preprocessor.qll b/csharp/ql/src/semmle/code/csharp/Preprocessor.qll
@@ -46,3 +46,15 @@ class PragmaChecksumDirective extends PreprocessorDirective, @pragma_checksum {
 
   override string getAPrimaryQlClass() { result = "PragmaChecksumDirective" }
 }
+
+/**
+ * An `#define` directive.
+ */
+class DefineDirective extends PreprocessorDirective, @directive_define {
+  /** Gets the name of the preprocessor symbol that is being set by this directive. */
+  string getName() { directive_defines(this, result) }
+
+  override string toString() { result = "#define ..." }
+
+  override string getAPrimaryQlClass() { result = "DefineDirective" }
+}
diff --git a/csharp/ql/src/semmlecode.csharp.dbscheme b/csharp/ql/src/semmlecode.csharp.dbscheme
@@ -331,7 +331,11 @@ using_directive_location(
   unique int id: @using_directive ref,
   int loc: @location ref);
 
-@preprocessor_directive = @pragma_warning | @pragma_checksum;
+@preprocessor_directive = @pragma_warning | @pragma_checksum | @directive_define;
+
+directive_defines(
+  unique int id: @directive_define,
+  string name: string ref);
 
 pragma_checksums(
   unique int id: @pragma_checksum,
diff --git a/csharp/ql/test/library-tests/comments/DefineDirectives.expected b/csharp/ql/test/library-tests/comments/DefineDirectives.expected
@@ -0,0 +1 @@
+| trivia.cs:4:1:4:13 | #define ... | DEBUG |
diff --git a/csharp/ql/test/library-tests/comments/DefineDirectives.ql b/csharp/ql/test/library-tests/comments/DefineDirectives.ql
@@ -0,0 +1,4 @@
+import csharp
+
+from DefineDirective d
+select d, d.getName()

Original file line number	Diff line number	Diff line change
`@@ -22,5 +22,10 @@ public override void VisitPragmaChecksumDirectiveTrivia(PragmaChecksumDirectiveT`
`22`	`22`	`{`
`23`	`23`	`new Entities.PragmaChecksumDirective(cx, node);`
`24`	`24`	`}`
	`25`	`+`
	`26`	`+ public override void VisitDefineDirectiveTrivia(DefineDirectiveTriviaSyntax node)`
	`27`	`+ {`
	`28`	`+ new Entities.DefineDirective(cx, node);`
	`29`	`+ }`
`25`	`30`	`}`
`26`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -620,5 +620,10 @@ internal static void pragma_checksums(this TextWriter trapFile, PragmaChecksumDi`
`620`	`620`	`{`
`621`	`621`	`trapFile.WriteTuple("pragma_checksums", pragma, file, guid, bytes);`
`622`	`622`	`}`
	`623`	`+`
	`624`	`+ internal static void directive_defines(this TextWriter trapFile, DefineDirective directive, string name)`
	`625`	`+ {`
	`626`	`+ trapFile.WriteTuple("directive_defines", directive, name);`
	`627`	`+ }`
`623`	`628`	`}`
`624`	`629`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+\| trivia.cs:4:1:4:13 \| #define ... \| DEBUG \|`