Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit f235a28

Browse files
tamasvajktamasvajk
committed
C# Add relational patterns extraction
1 parent 545451e commit f235a28

12 files changed

Lines changed: 174 additions & 1 deletion

File tree

‎csharp/change-notes/2020-11-19-Relational-pattern.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
lgtm,codescanning
2+
* The `RelationalPatternExpr` and its 4 sub class have been added to support C# 9
3+
relational `<`, `>`, `<=`, and `>=` patterns.

‎csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/Patterns/Pattern.cs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ internal static Expression Create(Context cx, PatternSyntax syntax, IExpressionP
4545
case RecursivePatternSyntax recPattern:
4646
return new RecursivePattern(cx, recPattern, parent, child);
4747

48+
case RelationalPatternSyntax relPattern:
49+
return new RelationalPattern(cx, relPattern, parent, child);
50+
4851
case VarPatternSyntax varPattern:
4952
switch (varPattern.Designation)
5053
{

‎csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/Patterns/RecursivePattern.cs‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ internal class RecursivePattern : Expression
1515
/// <param name="syntax">The syntax node of the recursive pattern.</param>
1616
/// <param name="parent">The parent pattern/expression.</param>
1717
/// <param name="child">The child index of this pattern.</param>
18-
/// <param name="isTopLevel">If this pattern is in the top level of a case/is. In that case, the variable and type access are populated elsewhere.</param>
1918
public RecursivePattern(Context cx, RecursivePatternSyntax syntax, IExpressionParentEntity parent, int child) :
2019
base(new ExpressionInfo(cx, Entities.NullType.Create(cx), cx.Create(syntax.GetLocation()), ExprKind.RECURSIVE_PATTERN, parent, child, false, null))
2120
{

‎csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/Patterns/RelationalPattern.cs‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
using Microsoft.CodeAnalysis;
2+
using Microsoft.CodeAnalysis.CSharp.Syntax;
3+
using Microsoft.CodeAnalysis.CSharp;
4+
using Semmle.Extraction.Kinds;
5+
using Semmle.Extraction.Entities;
6+
7+
namespace Semmle.Extraction.CSharp.Entities.Expressions
8+
{
9+
internal class RelationalPattern : Expression
10+
{
11+
public RelationalPattern(Context cx, RelationalPatternSyntax syntax, IExpressionParentEntity parent, int child) :
12+
base(new ExpressionInfo(cx, NullType.Create(cx), cx.Create(syntax.GetLocation()), GetKind(syntax.OperatorToken), parent, child, false, null))
13+
{
14+
Expression.Create(cx, syntax.Expression, this, 0);
15+
}
16+
17+
private static ExprKind GetKind(SyntaxToken operatorToken)
18+
{
19+
return operatorToken.Kind() switch
20+
{
21+
SyntaxKind.LessThanEqualsToken => ExprKind.LE_PATTERN,
22+
SyntaxKind.GreaterThanEqualsToken => ExprKind.GE_PATTERN,
23+
SyntaxKind.LessThanToken => ExprKind.LT_PATTERN,
24+
SyntaxKind.GreaterThanToken => ExprKind.GT_PATTERN,
25+
_ => throw new InternalError(operatorToken.Parent, $"Relation pattern with operator token '{operatorToken.Kind()}' is not supported."),
26+
};
27+
}
28+
}
29+
}

‎csharp/extractor/Semmle.Extraction.CSharp/Kinds/ExprKind.cs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,10 @@ public enum ExprKind
116116
ASSIGN_COALESCE = 119,
117117
SUPPRESS_NULLABLE_WARNING = 120,
118118
NAMESPACE_ACCESS = 121,
119+
LT_PATTERN = 122,
120+
GT_PATTERN = 123,
121+
LE_PATTERN = 124,
122+
GE_PATTERN = 125,
119123
NOT_PATTERN = 126
120124
}
121125
}

‎csharp/ql/src/semmle/code/csharp/exprs/Expr.qll‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,45 @@ class ConstantPatternExpr extends PatternExpr {
345345
override string getAPrimaryQlClass() { result = "ConstantPatternExpr" }
346346
}
347347

348+
/** A relational pattern, for example `>1` in `x is >1`. */
349+
class RelationalPatternExpr extends PatternExpr, @relational_pattern_expr {
350+
/** Gets the name of the operator in this pattern. */
351+
string getOperator() { none() }
352+
353+
/** Gets the expression of this relational pattern. */
354+
Expr getExpr() { result = this.getChild(0) }
355+
356+
override string toString() { result = getOperator() + " ..." }
357+
}
358+
359+
/** A less-than pattern, for example `< 10` in `x is < 10`. */
360+
class LTPattern extends RelationalPatternExpr, @lt_pattern_expr {
361+
override string getOperator() { result = "<" }
362+
363+
override string getAPrimaryQlClass() { result = "LTPattern" }
364+
}
365+
366+
/** A greater-than pattern, for example `> 10` in `x is > 10`. */
367+
class GTPattern extends RelationalPatternExpr, @gt_pattern_expr {
368+
override string getOperator() { result = ">" }
369+
370+
override string getAPrimaryQlClass() { result = "GTPattern" }
371+
}
372+
373+
/** A less-than or equals pattern, for example `<= 10` in `x is <= 10`. */
374+
class LEPattern extends RelationalPatternExpr, @le_pattern_expr {
375+
override string getOperator() { result = "<=" }
376+
377+
override string getAPrimaryQlClass() { result = "LEPattern" }
378+
}
379+
380+
/** A greater-than or equals pattern, for example `>= 10` in `x is >= 10` */
381+
class GEPattern extends RelationalPatternExpr, @ge_pattern_expr {
382+
override string getOperator() { result = ">=" }
383+
384+
override string getAPrimaryQlClass() { result = "GEPattern" }
385+
}
386+
348387
/**
349388
* A type pattern, for example `string` in `x is string`, `string s` in
350389
* `x is string s`, or `string _` in `x is string _`.

‎csharp/ql/src/semmlecode.csharp.dbscheme‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1010,13 +1010,18 @@ case @expr.kind of
10101010
| 120 = @suppress_nullable_warning_expr
10111011
| 121 = @namespace_access_expr
10121012
/* C# 9.0 */
1013+
| 122 = @lt_pattern_expr
1014+
| 123 = @gt_pattern_expr
1015+
| 124 = @le_pattern_expr
1016+
| 125 = @ge_pattern_expr
10131017
| 126 = @not_pattern_expr
10141018
;
10151019

10161020
@switch = @switch_stmt | @switch_expr;
10171021
@case = @case_stmt | @switch_case_expr;
10181022
@pattern_match = @case | @is_expr;
10191023
@unary_pattern_expr = @not_pattern_expr;
1024+
@relational_pattern_expr = @gt_pattern_expr | @lt_pattern_expr | @ge_pattern_expr | @le_pattern_expr;
10201025

10211026
@integer_literal_expr = @int_literal_expr | @long_literal_expr | @uint_literal_expr | @ulong_literal_expr;
10221027
@real_literal_expr = @float_literal_expr | @double_literal_expr | @decimal_literal_expr;

‎csharp/ql/test/library-tests/csharp9/PrintAst.expected‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -473,6 +473,63 @@ ParenthesizedPattern.cs:
473473
# 27| 0: [TypeAccessPatternExpr] access to type String
474474
# 27| 0: [TypeMention] string
475475
# 27| 2: [IntLiteral] 5
476+
RelationalPattern.cs:
477+
# 3| [Class] RelationalPattern
478+
# 5| 5: [Method] M1
479+
# 5| -1: [TypeMention] bool
480+
#-----| 2: (Parameters)
481+
# 5| 0: [Parameter] c
482+
# 5| -1: [TypeMention] char
483+
# 6| 4: [IsExpr] ... is ...
484+
# 6| 0: [ParameterAccess] access to parameter c
485+
# 6| 1: [GEPattern] >= ...
486+
# 6| 0: [CharLiteral] a
487+
# 7| 6: [Method] M2
488+
# 7| -1: [TypeMention] bool
489+
#-----| 2: (Parameters)
490+
# 7| 0: [Parameter] c
491+
# 7| -1: [TypeMention] char
492+
# 8| 4: [IsExpr] ... is ...
493+
# 8| 0: [ParameterAccess] access to parameter c
494+
# 8| 1: [GTPattern] > ...
495+
# 8| 0: [CharLiteral] a
496+
# 9| 7: [Method] M3
497+
# 9| -1: [TypeMention] bool
498+
#-----| 2: (Parameters)
499+
# 9| 0: [Parameter] c
500+
# 9| -1: [TypeMention] char
501+
# 10| 4: [IsExpr] ... is ...
502+
# 10| 0: [ParameterAccess] access to parameter c
503+
# 10| 1: [LEPattern] <= ...
504+
# 10| 0: [CharLiteral] a
505+
# 11| 8: [Method] M4
506+
# 11| -1: [TypeMention] bool
507+
#-----| 2: (Parameters)
508+
# 11| 0: [Parameter] c
509+
# 11| -1: [TypeMention] char
510+
# 12| 4: [IsExpr] ... is ...
511+
# 12| 0: [ParameterAccess] access to parameter c
512+
# 12| 1: [LTPattern] < ...
513+
# 12| 0: [CharLiteral] a
514+
# 14| 9: [Method] M5
515+
# 14| -1: [TypeMention] string
516+
#-----| 2: (Parameters)
517+
# 14| 0: [Parameter] i
518+
# 14| -1: [TypeMention] int
519+
# 15| 4: [BlockStmt] {...}
520+
# 16| 0: [ReturnStmt] return ...;
521+
# 16| 0: [SwitchExpr] ... switch { ... }
522+
# 16| -1: [ParameterAccess] access to parameter i
523+
# 18| 0: [SwitchCaseExpr] ... => ...
524+
# 18| 0: [ConstantPatternExpr,IntLiteral] 1
525+
# 18| 2: [StringLiteral] "1"
526+
# 19| 1: [SwitchCaseExpr] ... => ...
527+
# 19| 0: [GTPattern] > ...
528+
# 19| 0: [IntLiteral] 1
529+
# 19| 2: [StringLiteral] ">1"
530+
# 20| 2: [SwitchCaseExpr] ... => ...
531+
# 20| 0: [DiscardPatternExpr] _
532+
# 20| 2: [StringLiteral] "other"
476533
TargetType.cs:
477534
# 5| [Class] TargetType
478535
# 7| 5: [Method] M2

‎csharp/ql/test/library-tests/csharp9/RelationalPattern.cs‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
using System;
2+
3+
public class RelationalPattern
4+
{
5+
public static bool M1(char c) =>
6+
c is >= 'a';
7+
public static bool M2(char c) =>
8+
c is > 'a';
9+
public static bool M3(char c) =>
10+
c is <= 'a';
11+
public static bool M4(char c) =>
12+
c is < 'a';
13+
14+
public static string M5(int i)
15+
{
16+
return i switch
17+
{
18+
1 => "1",
19+
>1 => ">1",
20+
_ => "other"
21+
};
22+
}
23+
}

‎csharp/ql/test/library-tests/csharp9/relationalPattern.expected‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
| RelationalPattern.cs:6:14:6:19 | >= ... | >= |
2+
| RelationalPattern.cs:8:14:8:18 | > ... | > |
3+
| RelationalPattern.cs:10:14:10:19 | <= ... | <= |
4+
| RelationalPattern.cs:12:14:12:18 | < ... | < |
5+
| RelationalPattern.cs:19:13:19:14 | > ... | > |

0 commit comments

Comments
 (0)