Rust: implement Use::toString

Author: aibaars

rust/ql/.generated.list

@@ -1,4 +1,3 @@
-// generated by codegen, remove this comment if you wish to edit this file
 /**
  * This module provides a hand-modifiable wrapper around the generated class `Use`.
  *
@@ -12,11 +11,14 @@ private import codeql.rust.elements.internal.generated.Use
  * be referenced directly.
  */
 module Impl {
+  // the following QLdoc is generated: if you need to edit it, do it in the schema file
   /**
    * A Use. For example:
    * ```rust
    * todo!()
    * ```
    */
-  class Use extends Generated::Use { }
+  class Use extends Generated::Use {
+    override string toStringImpl() { result = "use " + this.getUseTree() }
+  }
 }

rust/ql/.gitattributes

@@ -1,4 +1,3 @@
-// generated by codegen, remove this comment if you wish to edit this file
 /**
  * This module provides a hand-modifiable wrapper around the generated class `UseTree`.
  *
@@ -12,6 +11,7 @@ private import codeql.rust.elements.internal.generated.UseTree
  * be referenced directly.
  */
 module Impl {
+  // the following QLdoc is generated: if you need to edit it, do it in the schema file
   /**
    * A UseTree. For example:
    * ```rust
@@ -21,5 +21,19 @@ module Impl {
    * use std::collections::{self, HashMap, HashSet};
    * ```
    */
-  class UseTree extends Generated::UseTree { }
+  class UseTree extends Generated::UseTree {
+    override string toStringImpl() {
+      result = strictconcat(int i | | this.toStringPart(i) order by i)
+    }
+
+    private string toStringPart(int index) {
+      result = this.getPath().toStringImpl() and index = 0
+      or
+      result = "::{...}" and this.hasUseTreeList() and index = 1
+      or
+      result = "::*" and this.isGlob() and index = 2
+      or
+      result = " as " + this.getRename().getName().getText() and index = 3
+    }
+  }
 }

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

@@ -1,5 +1,5 @@
 canonicalPaths
-| anonymous.rs:1:1:1:26 | Use | None | None |
+| anonymous.rs:1:1:1:26 | use ...::Trait | None | None |
 | anonymous.rs:3:1:32:1 | fn canonicals | repo::test | crate::anonymous::canonicals |
 | anonymous.rs:4:5:4:23 | struct OtherStruct | None | None |
 | anonymous.rs:6:5:8:5 | trait OtherTrait | None | None |
@@ -33,7 +33,7 @@ canonicalPaths
 | regular.rs:34:1:38:1 | enum MyEnum | repo::test | crate::regular::MyEnum |
 | regular.rs:40:1:46:1 | fn enum_qualified_usage | repo::test | crate::regular::enum_qualified_usage |
 | regular.rs:48:1:55:1 | fn enum_unqualified_usage | repo::test | crate::regular::enum_unqualified_usage |
-| regular.rs:51:5:51:18 | Use | None | None |
+| regular.rs:51:5:51:18 | use MyEnum::* | None | None |
 | regular.rs:57:1:63:1 | fn enum_match | repo::test | crate::regular::enum_match |
 resolvedPaths
 | anonymous.rs:27:17:27:30 | OtherStruct {...} | None | None |

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

@@ -1,5 +1,5 @@
 canonicalPaths
-| anonymous.rs:4:1:4:26 | Use | None | None |
+| anonymous.rs:4:1:4:26 | use ...::Trait | None | None |
 | anonymous.rs:6:1:35:1 | fn canonicals | None | None |
 | anonymous.rs:7:5:7:23 | struct OtherStruct | None | None |
 | anonymous.rs:9:5:11:5 | trait OtherTrait | None | None |
@@ -33,7 +33,7 @@ canonicalPaths
 | regular.rs:37:1:41:1 | enum MyEnum | None | None |
 | regular.rs:43:1:49:1 | fn enum_qualified_usage | None | None |
 | regular.rs:51:1:58:1 | fn enum_unqualified_usage | None | None |
-| regular.rs:54:5:54:18 | Use | None | None |
+| regular.rs:54:5:54:18 | use MyEnum::* | None | None |
 | regular.rs:60:1:66:1 | fn enum_match | None | None |
 resolvedPaths
 | anonymous.rs:30:17:30:30 | OtherStruct {...} | None | None |

rust/ql/test/extractor-tests/canonical_path/canonical_paths.expected

@@ -2,6 +2,7 @@ noLocation
 | file://:0:0:0:0 | ... .unwrap(...) |
 | file://:0:0:0:0 | ...: ... |
 | file://:0:0:0:0 | ...::Path |
+| file://:0:0:0:0 | ...::Path |
 | file://:0:0:0:0 | ...::path |
 | file://:0:0:0:0 | ArgList |
 | file://:0:0:0:0 | ArgList |
@@ -20,8 +21,6 @@ noLocation
 | file://:0:0:0:0 | RefTypeRepr |
 | file://:0:0:0:0 | RetTypeRepr |
 | file://:0:0:0:0 | StmtList |
-| file://:0:0:0:0 | Use |
-| file://:0:0:0:0 | UseTree |
 | file://:0:0:0:0 | fn get_parent |
 | file://:0:0:0:0 | get_parent |
 | file://:0:0:0:0 | parent |
@@ -38,4 +37,5 @@ noLocation
 | file://:0:0:0:0 | std |
 | file://:0:0:0:0 | std |
 | file://:0:0:0:0 | unwrap |
+| file://:0:0:0:0 | use ...::Path |
 | file://:0:0:0:0 | { ... } |

rust/ql/test/extractor-tests/canonical_path_disabled/canonical_paths.expected

@@ -1,2 +1,2 @@
-| gen_macro_items.rs:5:5:5:38 | MacroItems | 0 | file://:0:0:0:0 | Use |
+| gen_macro_items.rs:5:5:5:38 | MacroItems | 0 | file://:0:0:0:0 | use ...::Path |
 | gen_macro_items.rs:5:5:5:38 | MacroItems | 1 | file://:0:0:0:0 | fn get_parent |

rust/ql/test/extractor-tests/generated/MacroItems/CONSISTENCY/AstConsistency.expected

@@ -1,7 +1,7 @@
-| gen_use_tree.rs:5:9:5:33 | UseTree | isGlob: | no | hasPath: | yes | hasRename: | no | hasUseTreeList: | no |
-| gen_use_tree.rs:6:9:6:27 | UseTree | isGlob: | yes | hasPath: | yes | hasRename: | no | hasUseTreeList: | no |
-| gen_use_tree.rs:7:9:7:46 | UseTree | isGlob: | no | hasPath: | yes | hasRename: | yes | hasUseTreeList: | no |
-| gen_use_tree.rs:8:9:8:50 | UseTree | isGlob: | no | hasPath: | yes | hasRename: | no | hasUseTreeList: | yes |
-| gen_use_tree.rs:8:28:8:31 | UseTree | isGlob: | no | hasPath: | yes | hasRename: | no | hasUseTreeList: | no |
-| gen_use_tree.rs:8:34:8:40 | UseTree | isGlob: | no | hasPath: | yes | hasRename: | no | hasUseTreeList: | no |
-| gen_use_tree.rs:8:43:8:49 | UseTree | isGlob: | no | hasPath: | yes | hasRename: | no | hasUseTreeList: | no |
+| gen_use_tree.rs:5:9:5:33 | ...::HashMap | isGlob: | no | hasPath: | yes | hasRename: | no | hasUseTreeList: | no |
+| gen_use_tree.rs:6:9:6:27 | ...::collections::* | isGlob: | yes | hasPath: | yes | hasRename: | no | hasUseTreeList: | no |
+| gen_use_tree.rs:7:9:7:46 | ...::HashMap as MyHashMap | isGlob: | no | hasPath: | yes | hasRename: | yes | hasUseTreeList: | no |
+| gen_use_tree.rs:8:9:8:50 | ...::collections::{...} | isGlob: | no | hasPath: | yes | hasRename: | no | hasUseTreeList: | yes |
+| gen_use_tree.rs:8:28:8:31 | self | isGlob: | no | hasPath: | yes | hasRename: | no | hasUseTreeList: | no |
+| gen_use_tree.rs:8:34:8:40 | HashMap | isGlob: | no | hasPath: | yes | hasRename: | no | hasUseTreeList: | no |
+| gen_use_tree.rs:8:43:8:49 | HashSet | isGlob: | no | hasPath: | yes | hasRename: | no | hasUseTreeList: | no |

rust/ql/test/extractor-tests/generated/MacroItems/MacroItems_getItem.expected

@@ -1,7 +1,7 @@
-| gen_use_tree.rs:5:9:5:33 | UseTree | gen_use_tree.rs:5:9:5:33 | ...::HashMap |
-| gen_use_tree.rs:6:9:6:27 | UseTree | gen_use_tree.rs:6:9:6:24 | ...::collections |
-| gen_use_tree.rs:7:9:7:46 | UseTree | gen_use_tree.rs:7:9:7:33 | ...::HashMap |
-| gen_use_tree.rs:8:9:8:50 | UseTree | gen_use_tree.rs:8:9:8:24 | ...::collections |
-| gen_use_tree.rs:8:28:8:31 | UseTree | gen_use_tree.rs:8:28:8:31 | self |
-| gen_use_tree.rs:8:34:8:40 | UseTree | gen_use_tree.rs:8:34:8:40 | HashMap |
-| gen_use_tree.rs:8:43:8:49 | UseTree | gen_use_tree.rs:8:43:8:49 | HashSet |
+| gen_use_tree.rs:5:9:5:33 | ...::HashMap | gen_use_tree.rs:5:9:5:33 | ...::HashMap |
+| gen_use_tree.rs:6:9:6:27 | ...::collections::* | gen_use_tree.rs:6:9:6:24 | ...::collections |
+| gen_use_tree.rs:7:9:7:46 | ...::HashMap as MyHashMap | gen_use_tree.rs:7:9:7:33 | ...::HashMap |
+| gen_use_tree.rs:8:9:8:50 | ...::collections::{...} | gen_use_tree.rs:8:9:8:24 | ...::collections |
+| gen_use_tree.rs:8:28:8:31 | self | gen_use_tree.rs:8:28:8:31 | self |
+| gen_use_tree.rs:8:34:8:40 | HashMap | gen_use_tree.rs:8:34:8:40 | HashMap |
+| gen_use_tree.rs:8:43:8:49 | HashSet | gen_use_tree.rs:8:43:8:49 | HashSet |

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

@@ -1 +1 @@
-| gen_use_tree.rs:7:9:7:46 | UseTree | gen_use_tree.rs:7:35:7:46 | Rename |
+| gen_use_tree.rs:7:9:7:46 | ...::HashMap as MyHashMap | gen_use_tree.rs:7:35:7:46 | Rename |

rust/ql/test/extractor-tests/generated/UseTree/UseTree_getPath.expected

@@ -1 +1 @@
-| gen_use_tree.rs:8:9:8:50 | UseTree | gen_use_tree.rs:8:27:8:50 | UseTreeList |
+| gen_use_tree.rs:8:9:8:50 | ...::collections::{...} | gen_use_tree.rs:8:27:8:50 | UseTreeList |