Rust: add "standard path"

Author: Paolo Tranquilli

rust/ql/.generated.list

@@ -29,14 +29,20 @@ module LibraryCallable {
 
     /** Gets a call to this library callable. */
     CallExprBase getACall() {
-      exists(Resolvable r, string crate |
-        r = CallExprBaseImpl::getCallResolvable(result) and
-        this = crate + r.getResolvedPath()
+      exists(
+        TypeItemCanonicalPath path, ModuleItemCanonicalPath item, Namespace namespace,
+        string namespace_path
       |
-        crate = r.getResolvedCrateOrigin() + "::_::"
-        or
-        not r.hasResolvedCrateOrigin() and
-        crate = ""
+        path = CallExprBaseImpl::getCallResolvable(result).getResolvedCanonicalPath() and
+        item = path.getParent() and
+        namespace = item.getNamespace() and
+        namespace_path = namespace.getPath() and
+        if namespace_path = ""
+        then this = namespace.getRoot().toString() + "::" + item.getName() + "::" + path.getName()
+        else
+          this =
+            namespace.getRoot().toString() + "::" + namespace_path + "::" + item.getName() + "::" +
+              path.getName()
       )
     }
   }

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 `CanonicalPath`.
  *
@@ -12,8 +11,25 @@ private import codeql.rust.elements.internal.generated.canonical_paths.Canonical
  * be referenced directly.
  */
 module Impl {
+  // the following QLdoc is generated: if you need to edit it, do it in the schema file
   /**
    * The base class for all canonical paths that can be the result of a path resolution.
    */
-  class CanonicalPath extends Generated::CanonicalPath { }
+  class CanonicalPath extends Generated::CanonicalPath {
+    /**
+     * If this canonical path is of the form `crate::mod1::mod2::Type::name`, then this predicate
+     * splits it into its components `crate::mod1::mod2`, `Type` and `name`. This applies to
+     * type, trait and type impl items, not to module items (see `hasStandardPath/2`) nor to
+     * trait impl items (TODO).
+     */
+    predicate hasStandardPath(string namespace, string type, string name) { none() }
+
+    /**
+     * If this canonical path is of the form `crate::mod1::mod2::name`, then this predicate
+     * splits it into its components `crate::mod1::mod2` and `name`. This applies to
+     * module items, but not to type, trait and type impl items (see `hasStandardPath/3`) nor to
+     * trait impl items (TODO).
+     */
+    predicate hasStandardPath(string namespace, string name) { none() }
+  }
 }

rust/ql/lib/codeql/rust/dataflow/FlowSummary.qll

@@ -19,5 +19,9 @@ module Impl {
     override string toString() {
       result = this.getNamespace().toAbbreviatedString() + "::" + this.getName()
     }
+
+    override predicate hasStandardPath(string namespace, string name) {
+      this.getName() = name and namespace = this.getNamespace().getNamespaceString()
+    }
   }
 }

rust/ql/lib/codeql/rust/elements/canonical_paths/internal/CanonicalPathImpl.qll

@@ -22,5 +22,17 @@ module Impl {
         if this.getPath() = "" then result = root else result = root + "::" + this.getPath()
       )
     }
+
+    /**
+     * Returns a string representation of this namespace, with the root and path separated by `::`.
+     */
+    cached
+    string getNamespaceString() {
+      exists(string root, string path |
+        root = this.getRoot().toString() and
+        path = this.getPath() and
+        if path = "" then result = root else result = root + "::" + path
+      )
+    }
   }
 }

rust/ql/lib/codeql/rust/elements/canonical_paths/internal/ModuleItemCanonicalPathImpl.qll

@@ -19,5 +19,9 @@ module Impl {
     override string toString() {
       result = "<" + this.getParent().toAbbreviatedString() + ">::" + this.getName()
     }
+
+    override predicate hasStandardPath(string namespace, string type, string name) {
+      this.getName() = name and this.getParent().hasStandardPath(namespace, type)
+    }
   }
 }

rust/ql/lib/codeql/rust/elements/canonical_paths/internal/NamespaceImpl.qll

@@ -19,5 +19,9 @@ module Impl {
     override string toString() {
       result = this.getParent().toAbbreviatedString() + "::" + this.getName()
     }
+
+    override predicate hasStandardPath(string namespace, string type, string name) {
+      this.getName() = name and this.getParent().hasStandardPath(namespace, type)
+    }
   }
 }

rust/ql/lib/codeql/rust/elements/canonical_paths/internal/TypeImplItemCanonicalPathImpl.qll

@@ -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 `Addressable`.
  *
@@ -12,10 +11,25 @@ private import codeql.rust.elements.internal.generated.Addressable
  * be referenced directly.
  */
 module Impl {
+  // the following QLdoc is generated: if you need to edit it, do it in the schema file
   /**
    * Something that can be addressed by a path.
    *
    * TODO: This does not yet include all possible cases.
    */
-  class Addressable extends Generated::Addressable { }
+  class Addressable extends Generated::Addressable {
+    /**
+     * Splits the standard path into its components (see `CanonicalPath::hasStandardPath/3`).
+     */
+    predicate hasStandardPath(string namespace, string type, string name) {
+      this.getCanonicalPath().hasStandardPath(namespace, type, name)
+    }
+
+    /**
+     * Splits the standard path into its components (see `CanonicalPath::hasStandardPath/2`).
+     */
+    predicate hasStandardPath(string namespace, string name) {
+      this.getCanonicalPath().hasStandardPath(namespace, name)
+    }
+  }
 }

rust/ql/lib/codeql/rust/elements/canonical_paths/internal/TypeItemCanonicalPathImpl.qll

@@ -20,16 +20,9 @@ module Impl {
   class Resolvable extends Generated::Resolvable {
     /**
      * Holds if this resolvable and the item `i` resolves to the same canonical
-     * path in the same crate
+     * path
      */
     pragma[nomagic]
-    predicate resolvesAsItem(Item i) {
-      this.getResolvedPath() = i.getExtendedCanonicalPath() and
-      (
-        this.getResolvedCrateOrigin() = i.getCrateOrigin()
-        or
-        not this.hasResolvedCrateOrigin() and not i.hasCrateOrigin()
-      )
-    }
+    predicate resolvesAsItem(Item i) { this.getResolvedCanonicalPath() = i.getCanonicalPath() }
   }
 }