Merge pull request #18741 from paldepind/rust-identity-pattern-to-string

Rust: Tweak `toString` on identity pattern

Author: paldepind

rust/ql/lib/codeql/rust/elements/internal/IdentPatImpl.qll

@@ -28,6 +28,18 @@ module Impl {
    * ```
    */
   class IdentPat extends Generated::IdentPat {
-    override string toString() { result = this.getName().getText() }
+    override string toString() {
+      result = strictconcat(int i | | this.toStringPart(i), " " order by i)
+    }
+
+    private string toStringPart(int index) {
+      index = 0 and this.isRef() and result = "ref"
+      or
+      index = 1 and this.isMut() and result = "mut"
+      or
+      index = 2 and result = this.getName().getText()
+      or
+      index = 3 and this.hasPat() and result = "@ ..."
+    }
   }
 }

rust/ql/test/extractor-tests/generated/IdentPat/IdentPat.expected

@@ -1,2 +1,2 @@
 | gen_ident_pat.rs:6:22:6:22 | y | getNumberOfAttrs: | 0 | isMut: | no | isRef: | no | hasName: | yes | hasPat: | no |
-| gen_ident_pat.rs:10:9:10:25 | y | getNumberOfAttrs: | 0 | isMut: | no | isRef: | no | hasName: | yes | hasPat: | yes |
+| gen_ident_pat.rs:10:9:10:25 | y @ ... | getNumberOfAttrs: | 0 | isMut: | no | isRef: | no | hasName: | yes | hasPat: | yes |

rust/ql/test/extractor-tests/generated/IdentPat/IdentPat_getName.expected

@@ -1,2 +1,2 @@
 | gen_ident_pat.rs:6:22:6:22 | y | gen_ident_pat.rs:6:22:6:22 | y |
-| gen_ident_pat.rs:10:9:10:25 | y | gen_ident_pat.rs:10:9:10:9 | y |
+| gen_ident_pat.rs:10:9:10:25 | y @ ... | gen_ident_pat.rs:10:9:10:9 | y |

rust/ql/test/extractor-tests/generated/IdentPat/IdentPat_getPat.expected

@@ -1 +1 @@
-| gen_ident_pat.rs:10:9:10:25 | y | gen_ident_pat.rs:10:11:10:25 | ...::Some(...) |
+| gen_ident_pat.rs:10:9:10:25 | y @ ... | gen_ident_pat.rs:10:11:10:25 | ...::Some(...) |

rust/ql/test/library-tests/controlflow/BasicBlocks.expected

@@ -396,6 +396,22 @@ mod patterns {
             _ => 4,
         }
     }
+
+    fn identifier_pattern_with_subpattern() -> i64 {
+        match 43 {
+            n @ 1..10 => 2 * n,
+            _ => 0,
+        }
+    }
+
+    fn identifier_pattern_with_ref() -> i64 {
+        let mut a = 10;
+        match a {
+            ref mut n @ 1..10 => *n += 10,
+            ref mut n => *n = 0,
+        };
+        a
+    }
 }
 
 mod divergence {

rust/ql/test/library-tests/controlflow/Cfg.expected

@@ -72,9 +72,9 @@ localStep
 | main.rs:44:13:46:5 | loop { ... } | main.rs:44:9:44:9 | b |  |
 | main.rs:45:9:45:23 | break ... | main.rs:44:13:46:5 | loop { ... } |  |
 | main.rs:45:15:45:23 | source(...) | main.rs:45:9:45:23 | break ... |  |
-| main.rs:51:9:51:13 | [SSA] i | main.rs:52:10:52:10 | i |  |
-| main.rs:51:9:51:13 | i | main.rs:51:9:51:13 | [SSA] i |  |
-| main.rs:51:17:51:17 | 1 | main.rs:51:9:51:13 | i |  |
+| main.rs:51:9:51:13 | [SSA] mut i | main.rs:52:10:52:10 | i |  |
+| main.rs:51:9:51:13 | mut i | main.rs:51:9:51:13 | [SSA] mut i |  |
+| main.rs:51:17:51:17 | 1 | main.rs:51:9:51:13 | mut i |  |
 | main.rs:53:5:53:5 | [SSA] i | main.rs:54:10:54:10 | i |  |
 | main.rs:53:5:53:5 | i | main.rs:53:5:53:5 | [SSA] i |  |
 | main.rs:53:9:53:17 | source(...) | main.rs:53:5:53:5 | i |  |
@@ -122,9 +122,9 @@ localStep
 | main.rs:101:18:101:19 | [SSA] a2 | main.rs:104:10:104:11 | a2 |  |
 | main.rs:101:18:101:19 | a2 | main.rs:101:18:101:19 | [SSA] a2 |  |
 | main.rs:101:24:101:24 | a | main.rs:101:9:101:20 | TuplePat |  |
-| main.rs:108:9:108:13 | [SSA] a | main.rs:109:10:109:10 | a |  |
-| main.rs:108:9:108:13 | a | main.rs:108:9:108:13 | [SSA] a |  |
-| main.rs:108:17:108:31 | TupleExpr | main.rs:108:9:108:13 | a |  |
+| main.rs:108:9:108:13 | [SSA] mut a | main.rs:109:10:109:10 | a |  |
+| main.rs:108:9:108:13 | mut a | main.rs:108:9:108:13 | [SSA] mut a |  |
+| main.rs:108:17:108:31 | TupleExpr | main.rs:108:9:108:13 | mut a |  |
 | main.rs:109:10:109:10 | [post] a | main.rs:110:10:110:10 | a |  |
 | main.rs:109:10:109:10 | a | main.rs:110:10:110:10 | a |  |
 | main.rs:110:10:110:10 | [post] a | main.rs:111:5:111:5 | a |  |
@@ -152,9 +152,9 @@ localStep
 | main.rs:134:13:134:40 | Point {...} | main.rs:134:9:134:9 | p |  |
 | main.rs:135:10:135:10 | [post] p | main.rs:136:10:136:10 | p |  |
 | main.rs:135:10:135:10 | p | main.rs:136:10:136:10 | p |  |
-| main.rs:140:9:140:13 | [SSA] p | main.rs:141:10:141:10 | p |  |
-| main.rs:140:9:140:13 | p | main.rs:140:9:140:13 | [SSA] p |  |
-| main.rs:140:17:140:44 | Point {...} | main.rs:140:9:140:13 | p |  |
+| main.rs:140:9:140:13 | [SSA] mut p | main.rs:141:10:141:10 | p |  |
+| main.rs:140:9:140:13 | mut p | main.rs:140:9:140:13 | [SSA] mut p |  |
+| main.rs:140:17:140:44 | Point {...} | main.rs:140:9:140:13 | mut p |  |
 | main.rs:141:10:141:10 | [post] p | main.rs:142:5:142:5 | p |  |
 | main.rs:141:10:141:10 | p | main.rs:142:5:142:5 | p |  |
 | main.rs:142:5:142:5 | [post] p | main.rs:143:10:143:10 | p |  |
@@ -477,9 +477,9 @@ localStep
 | main.rs:403:16:403:16 | [SSA] c | main.rs:406:18:406:18 | c |  |
 | main.rs:403:16:403:16 | c | main.rs:403:16:403:16 | [SSA] c |  |
 | main.rs:403:22:407:9 | { ... } | main.rs:402:5:408:5 | match arr1 { ... } |  |
-| main.rs:412:9:412:19 | [SSA] mut_arr | main.rs:413:10:413:16 | mut_arr |  |
-| main.rs:412:9:412:19 | mut_arr | main.rs:412:9:412:19 | [SSA] mut_arr |  |
-| main.rs:412:23:412:31 | [...] | main.rs:412:9:412:19 | mut_arr |  |
+| main.rs:412:9:412:19 | [SSA] mut mut_arr | main.rs:413:10:413:16 | mut_arr |  |
+| main.rs:412:9:412:19 | mut mut_arr | main.rs:412:9:412:19 | [SSA] mut mut_arr |  |
+| main.rs:412:23:412:31 | [...] | main.rs:412:9:412:19 | mut mut_arr |  |
 | main.rs:413:10:413:16 | [post] mut_arr | main.rs:415:5:415:11 | mut_arr |  |
 | main.rs:413:10:413:16 | mut_arr | main.rs:415:5:415:11 | mut_arr |  |
 | main.rs:415:5:415:11 | [post] mut_arr | main.rs:416:13:416:19 | mut_arr |  |

rust/ql/test/library-tests/controlflow/test.rs

@@ -28,8 +28,8 @@ edges
 | main.rs:100:17:100:26 | source(...) | main.rs:100:13:100:30 | TupleExpr [tuple.1] | provenance |  |
 | main.rs:101:9:101:20 | TuplePat [tuple.1] | main.rs:101:14:101:15 | a1 | provenance |  |
 | main.rs:101:14:101:15 | a1 | main.rs:103:10:103:11 | a1 | provenance |  |
-| main.rs:108:9:108:13 | a [tuple.1] | main.rs:110:10:110:10 | a [tuple.1] | provenance |  |
-| main.rs:108:17:108:31 | TupleExpr [tuple.1] | main.rs:108:9:108:13 | a [tuple.1] | provenance |  |
+| main.rs:108:9:108:13 | mut a [tuple.1] | main.rs:110:10:110:10 | a [tuple.1] | provenance |  |
+| main.rs:108:17:108:31 | TupleExpr [tuple.1] | main.rs:108:9:108:13 | mut a [tuple.1] | provenance |  |
 | main.rs:108:21:108:30 | source(...) | main.rs:108:17:108:31 | TupleExpr [tuple.1] | provenance |  |
 | main.rs:110:10:110:10 | a [tuple.1] | main.rs:110:10:110:12 | a.1 | provenance |  |
 | main.rs:111:5:111:5 | [post] a [tuple.0] | main.rs:112:5:112:5 | a [tuple.0] | provenance |  |
@@ -217,7 +217,7 @@ nodes
 | main.rs:101:9:101:20 | TuplePat [tuple.1] | semmle.label | TuplePat [tuple.1] |
 | main.rs:101:14:101:15 | a1 | semmle.label | a1 |
 | main.rs:103:10:103:11 | a1 | semmle.label | a1 |
-| main.rs:108:9:108:13 | a [tuple.1] | semmle.label | a [tuple.1] |
+| main.rs:108:9:108:13 | mut a [tuple.1] | semmle.label | mut a [tuple.1] |
 | main.rs:108:17:108:31 | TupleExpr [tuple.1] | semmle.label | TupleExpr [tuple.1] |
 | main.rs:108:21:108:30 | source(...) | semmle.label | source(...) |
 | main.rs:110:10:110:10 | a [tuple.1] | semmle.label | a [tuple.1] |