Merge pull request #4055 from tamasvajk/feature/partial-methods

hvitved · web-flow · commit 65b4d35add69 · 2020-08-20T10:14:56.000+02:00
C#: Add body to partial methods
diff --git a/csharp/.gitignore b/csharp/.gitignore
@@ -10,4 +10,5 @@ csharp.log
 **/bin/Release
 *.tlog
 .vs
-*.user
+*.user
+.vscode/launch.json
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/Method.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/Method.cs
@@ -80,7 +80,7 @@ void PopulateMethodBody(TextWriter trapFile)
                         else
                             Expression.Create(Context, expr, this, 0);
 
-                        Context.NumberOfLines(trapFile, symbol, this);
+                        Context.NumberOfLines(trapFile, BodyDeclaringSymbol, this);
                     });
         }
 
@@ -126,7 +126,7 @@ protected static void BuildMethodId(Method m, TextWriter trapFile)
                 {
                     trapFile.Write('<');
                     // Encode the nullability of the type arguments in the label.
-                    // Type arguments with different nullability can result in 
+                    // Type arguments with different nullability can result in
                     // a constructed method with different nullability of its parameters and return type,
                     // so we need to create a distinct database entity for it.
                     trapFile.BuildList(",", m.symbol.GetAnnotatedTypeArguments(), (ta, tb0) => { AddSignatureTypeToId(m.Context, tb0, m.symbol, ta.Symbol); trapFile.Write((int)ta.Nullability); });
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/OrdinaryMethod.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/OrdinaryMethod.cs
@@ -13,6 +13,8 @@ class OrdinaryMethod : Method
 
         public override string Name => symbol.GetName();
 
+        protected override IMethodSymbol BodyDeclaringSymbol => symbol.PartialImplementationPart ?? symbol;
+
         public IMethodSymbol SourceDeclaration
         {
             get
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/Symbol.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/Symbol.cs
@@ -95,14 +95,15 @@ protected void BindComments()
                 Context.BindComments(this, FullLocation);
         }
 
+        protected virtual T BodyDeclaringSymbol => symbol;
+
         public BlockSyntax Block
         {
             get
             {
-                return symbol.
+                return BodyDeclaringSymbol.
                     DeclaringSyntaxReferences.
-                    Select(r => r.GetSyntax()).
-                    SelectMany(n => n.ChildNodes()).
+                    SelectMany(r => r.GetSyntax().ChildNodes()).
                     OfType<BlockSyntax>().
                     FirstOrDefault();
             }
@@ -112,7 +113,7 @@ public ExpressionSyntax ExpressionBody
         {
             get
             {
-                return symbol.
+                return BodyDeclaringSymbol.
                     DeclaringSyntaxReferences.
                     SelectMany(r => r.GetSyntax().ChildNodes()).
                     OfType<ArrowExpressionClauseSyntax>().
diff --git a/csharp/ql/test/library-tests/partial/MethodIsPartial.expected b/csharp/ql/test/library-tests/partial/MethodIsPartial.expected
@@ -0,0 +1,7 @@
+| Partial.cs:3:18:3:39 | PartialMethodWithBody1 | true |
+| Partial.cs:4:18:4:42 | PartialMethodWithoutBody1 | true |
+| Partial.cs:5:17:5:23 | Method2 | false |
+| Partial.cs:11:17:11:23 | Method3 | false |
+| Partial.cs:16:18:16:42 | PartialMethodWithoutBody2 | true |
+| Partial.cs:17:17:17:23 | Method4 | false |
+| Partial.cs:22:17:22:23 | Method5 | false |
diff --git a/csharp/ql/test/library-tests/partial/MethodIsPartial.ql b/csharp/ql/test/library-tests/partial/MethodIsPartial.ql
@@ -0,0 +1,7 @@
+import csharp
+
+private boolean isPartial(Method m) { if m.isPartial() then result = true else result = false }
+
+from Method m
+where m.fromSource()
+select m, isPartial(m)
diff --git a/csharp/ql/test/library-tests/partial/Partial.cs b/csharp/ql/test/library-tests/partial/Partial.cs
@@ -1,11 +1,23 @@
-partial class A
+partial class TwoPartClass
 {
-    partial void M();
-    public void M2() { }
+    partial void PartialMethodWithBody1();
+    partial void PartialMethodWithoutBody1();
+    public void Method2() { }
 }
 
-partial class A
+partial class TwoPartClass
 {
-    partial void M() { }
-    public void M3() { }
+    partial void PartialMethodWithBody1() { }
+    public void Method3() { }
 }
+
+partial class OnePartPartialClass
+{
+    partial void PartialMethodWithoutBody2();
+    public void Method4() { }
+}
+
+class NonPartialClass
+{
+    public void Method5() { }
+}
diff --git a/csharp/ql/test/library-tests/partial/Partial1.expected b/csharp/ql/test/library-tests/partial/Partial1.expected
@@ -1,3 +1,6 @@
-| Partial.cs:1:15:1:15 | A |
-| Partial.cs:3:18:3:18 | M |
-| Partial.cs:7:15:7:15 | A |
+| Partial.cs:1:15:1:26 | TwoPartClass |
+| Partial.cs:3:18:3:39 | PartialMethodWithBody1 |
+| Partial.cs:4:18:4:42 | PartialMethodWithoutBody1 |
+| Partial.cs:8:15:8:26 | TwoPartClass |
+| Partial.cs:14:15:14:33 | OnePartPartialClass |
+| Partial.cs:16:18:16:42 | PartialMethodWithoutBody2 |
diff --git a/csharp/ql/test/library-tests/partial/Partial2.expected b/csharp/ql/test/library-tests/partial/Partial2.expected
@@ -1,6 +1,10 @@
-| Partial.cs:1:15:1:15 | A | Partial.cs:3:18:3:18 | M |
-| Partial.cs:1:15:1:15 | A | Partial.cs:4:17:4:18 | M2 |
-| Partial.cs:1:15:1:15 | A | Partial.cs:10:17:10:18 | M3 |
-| Partial.cs:7:15:7:15 | A | Partial.cs:3:18:3:18 | M |
-| Partial.cs:7:15:7:15 | A | Partial.cs:4:17:4:18 | M2 |
-| Partial.cs:7:15:7:15 | A | Partial.cs:10:17:10:18 | M3 |
+| Partial.cs:1:15:1:26 | TwoPartClass | Partial.cs:3:18:3:39 | PartialMethodWithBody1 |
+| Partial.cs:1:15:1:26 | TwoPartClass | Partial.cs:4:18:4:42 | PartialMethodWithoutBody1 |
+| Partial.cs:1:15:1:26 | TwoPartClass | Partial.cs:5:17:5:23 | Method2 |
+| Partial.cs:1:15:1:26 | TwoPartClass | Partial.cs:11:17:11:23 | Method3 |
+| Partial.cs:8:15:8:26 | TwoPartClass | Partial.cs:3:18:3:39 | PartialMethodWithBody1 |
+| Partial.cs:8:15:8:26 | TwoPartClass | Partial.cs:4:18:4:42 | PartialMethodWithoutBody1 |
+| Partial.cs:8:15:8:26 | TwoPartClass | Partial.cs:5:17:5:23 | Method2 |
+| Partial.cs:8:15:8:26 | TwoPartClass | Partial.cs:11:17:11:23 | Method3 |
+| Partial.cs:14:15:14:33 | OnePartPartialClass | Partial.cs:16:18:16:42 | PartialMethodWithoutBody2 |
+| Partial.cs:14:15:14:33 | OnePartPartialClass | Partial.cs:17:17:17:23 | Method4 |
diff --git a/csharp/ql/test/library-tests/partial/PartialMethodBody.expected b/csharp/ql/test/library-tests/partial/PartialMethodBody.expected
@@ -0,0 +1,3 @@
+| Partial.cs:3:18:3:39 | PartialMethodWithBody1 | true |
+| Partial.cs:4:18:4:42 | PartialMethodWithoutBody1 | false |
+| Partial.cs:16:18:16:42 | PartialMethodWithoutBody2 | false |
diff --git a/csharp/ql/test/library-tests/partial/PartialMethodBody.ql b/csharp/ql/test/library-tests/partial/PartialMethodBody.ql
@@ -0,0 +1,7 @@
+import csharp
+
+private boolean hasBody(Method m) { if m.hasBody() then result = true else result = false }
+
+from Method m
+where m.fromSource() and m.isPartial()
+select m, hasBody(m)

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@ class OrdinaryMethod : Method`
`13`	`13`
`14`	`14`	`public override string Name => symbol.GetName();`
`15`	`15`
	`16`	`+ protected override IMethodSymbol BodyDeclaringSymbol => symbol.PartialImplementationPart ?? symbol;`
	`17`	`+`
`16`	`18`	`public IMethodSymbol SourceDeclaration`
`17`	`19`	`{`
`18`	`20`	`get`
Original file line number	Diff line number	Diff line change
`@@ -95,14 +95,15 @@ protected void BindComments()`
`95`	`95`	`Context.BindComments(this, FullLocation);`
`96`	`96`	`}`
`97`	`97`
	`98`	`+ protected virtual T BodyDeclaringSymbol => symbol;`
	`99`	`+`
`98`	`100`	`public BlockSyntax Block`
`99`	`101`	`{`
`100`	`102`	`get`
`101`	`103`	`{`
`102`		`- return symbol.`
	`104`	`+ return BodyDeclaringSymbol.`
`103`	`105`	`DeclaringSyntaxReferences.`
`104`		`- Select(r => r.GetSyntax()).`
`105`		`- SelectMany(n => n.ChildNodes()).`
	`106`	`+ SelectMany(r => r.GetSyntax().ChildNodes()).`
`106`	`107`	`OfType<BlockSyntax>().`
`107`	`108`	`FirstOrDefault();`
`108`	`109`	`}`
`@@ -112,7 +113,7 @@ public ExpressionSyntax ExpressionBody`
`112`	`113`	`{`
`113`	`114`	`get`
`114`	`115`	`{`
`115`		`- return symbol.`
	`116`	`+ return BodyDeclaringSymbol.`
`116`	`117`	`DeclaringSyntaxReferences.`
`117`	`118`	`SelectMany(r => r.GetSyntax().ChildNodes()).`
`118`	`119`	`OfType<ArrowExpressionClauseSyntax>().`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+\| Partial.cs:3:18:3:39 \| PartialMethodWithBody1 \| true \|`
	`2`	`+\| Partial.cs:4:18:4:42 \| PartialMethodWithoutBody1 \| false \|`
	`3`	`+\| Partial.cs:16:18:16:42 \| PartialMethodWithoutBody2 \| false \|`