Merge pull request #19198 from paldepind/rust-ti-inline-expectations

Rust: Add inline expectations test for type inference

Author: paldepind

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

@@ -4,7 +4,9 @@
  * INTERNAL: Do not use.
  */
 
+private import codeql.files.FileSystem
 private import codeql.rust.elements.internal.generated.Function
+private import codeql.rust.elements.Comment
 
 /**
  * INTERNAL: This module contains the customizable definition of `Function` and should not
@@ -26,5 +28,46 @@ module Impl {
    */
   class Function extends Generated::Function {
     override string toStringImpl() { result = "fn " + this.getName().getText() }
+
+    pragma[nomagic]
+    private predicate hasPotentialCommentAt(File f, int line) {
+      f = this.getLocation().getFile() and
+      // When a function is preceded by comments its start line is the line of
+      // the first comment. Hence all relevant comments are found by including
+      // comments from the start line and up to the line with the function
+      // name.
+      line in [this.getLocation().getStartLine() .. this.getName().getLocation().getStartLine()]
+    }
+
+    /**
+     * Gets a comment preceding this function.
+     *
+     * A comment is considered preceding if it occurs immediately before this
+     * function or if only other comments occur between the comment and this
+     * function.
+     */
+    Comment getAPrecedingComment() {
+      exists(File f, int line |
+        this.hasPotentialCommentAt(f, line) and
+        result.getLocation().hasLocationFileInfo(f, line, _, _, _)
+      )
+    }
+
+    /**
+     * Gets a comment preceding this function.
+     *
+     * A comment is considered preceding if it occurs immediately before this
+     * function or if only other comments occur between the comment and this
+     * function.
+     */
+    Comment getPrecedingComment() {
+      result.getLocation().getFile() = this.getLocation().getFile() and
+      // When a function is preceded by comments its start line is the line of
+      // the first comment. Hence all relevant comments are found by including
+      // comments from the start line and up to the line with the function
+      // name.
+      this.getLocation().getStartLine() <= result.getLocation().getStartLine() and
+      result.getLocation().getStartLine() <= this.getName().getLocation().getStartLine()
+    }
   }
 }

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

@@ -42,12 +42,22 @@ module Impl {
       )
     }
 
+    private string toStringPart(int index) {
+      index = 0 and
+      result = this.getReceiver().toAbbreviatedString()
+      or
+      index = 1 and
+      (if this.getReceiver().toAbbreviatedString() = "..." then result = " ." else result = ".")
+      or
+      index = 2 and
+      result = this.getIdentifier().toStringImpl()
+      or
+      index = 3 and
+      if this.getArgList().getNumberOfArgs() = 0 then result = "()" else result = "(...)"
+    }
+
     override string toStringImpl() {
-      exists(string base, string separator |
-        base = this.getReceiver().toAbbreviatedString() and
-        (if base = "..." then separator = " ." else separator = ".") and
-        result = base + separator + this.getIdentifier().toStringImpl() + "(...)"
-      )
+      result = strictconcat(int i | | this.toStringPart(i) order by i)
     }
   }
 }

rust/ql/lib/codeql/rust/internal/Type.qll

@@ -104,7 +104,7 @@ class StructType extends StructOrEnumType, TStruct {
     result = TTypeParamTypeParameter(struct.getGenericParamList().getTypeParam(i))
   }
 
-  override string toString() { result = struct.toString() }
+  override string toString() { result = struct.getName().getText() }
 
   override Location getLocation() { result = struct.getLocation() }
 }
@@ -125,7 +125,7 @@ class EnumType extends StructOrEnumType, TEnum {
     result = TTypeParamTypeParameter(enum.getGenericParamList().getTypeParam(i))
   }
 
-  override string toString() { result = enum.toString() }
+  override string toString() { result = enum.getName().getText() }
 
   override Location getLocation() { result = enum.getLocation() }
 }

rust/ql/lib/utils/test/InlineMadTest.qll

@@ -5,16 +5,7 @@ private module InlineMadTestLang implements InlineMadTestLangSig {
   class Callable = R::Function;
 
   string getComment(R::Function callable) {
-    exists(R::Comment comment |
-      result = comment.getCommentText() and
-      comment.getLocation().getFile() = callable.getLocation().getFile() and
-      // When a function is preceded by comments its start line is the line of
-      // the first comment. Hence all relevant comments are found by including
-      // comments from the start line and up to the line with the function
-      // name.
-      callable.getLocation().getStartLine() <= comment.getLocation().getStartLine() and
-      comment.getLocation().getStartLine() <= callable.getName().getLocation().getStartLine()
-    )
+    result = callable.getAPrecedingComment().getCommentText()
   }
 }
 

rust/ql/test/extractor-tests/canonical_path/CONSISTENCY/PathResolutionConsistency.expected

@@ -1,3 +1,3 @@
 multipleStaticCallTargets
-| regular.rs:29:5:29:9 | s.g(...) | anonymous.rs:15:9:15:22 | fn g |
-| regular.rs:29:5:29:9 | s.g(...) | regular.rs:13:5:13:18 | fn g |
+| regular.rs:29:5:29:9 | s.g() | anonymous.rs:15:9:15:22 | fn g |
+| regular.rs:29:5:29:9 | s.g() | regular.rs:13:5:13:18 | fn g |

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

@@ -38,17 +38,17 @@ canonicalPaths
 resolvedPaths
 | anonymous.rs:27:17:27:30 | OtherStruct {...} | None | None |
 | anonymous.rs:28:9:28:9 | s | None | None |
-| anonymous.rs:28:9:28:13 | s.f(...) | None | None |
+| anonymous.rs:28:9:28:13 | s.f() | None | None |
 | anonymous.rs:29:9:29:9 | s | None | None |
-| anonymous.rs:29:9:29:13 | s.g(...) | None | None |
+| anonymous.rs:29:9:29:13 | s.g() | None | None |
 | anonymous.rs:30:9:30:14 | nested | None | None |
 | regular.rs:27:13:27:21 | Struct {...} | repo::test | crate::regular::Struct |
 | regular.rs:28:5:28:5 | s | None | None |
-| regular.rs:28:5:28:9 | s.f(...) | repo::test | <crate::regular::Struct as crate::regular::Trait>::f |
+| regular.rs:28:5:28:9 | s.f() | repo::test | <crate::regular::Struct as crate::regular::Trait>::f |
 | regular.rs:29:5:29:5 | s | None | None |
-| regular.rs:29:5:29:9 | s.g(...) | repo::test | <crate::regular::Struct>::g |
+| regular.rs:29:5:29:9 | s.g() | repo::test | <crate::regular::Struct>::g |
 | regular.rs:30:5:30:5 | s | None | None |
-| regular.rs:30:5:30:9 | s.h(...) | repo::test | <_ as crate::regular::TraitWithBlanketImpl>::h |
+| regular.rs:30:5:30:9 | s.h() | repo::test | <_ as crate::regular::TraitWithBlanketImpl>::h |
 | regular.rs:31:5:31:8 | free | repo::test | crate::regular::free |
 | regular.rs:41:9:41:26 | ...::None::<...> | lang:core | crate::option::Option::None |
 | regular.rs:42:9:42:20 | ...::Some | lang:core | crate::option::Option::Some |

rust/ql/test/extractor-tests/canonical_path_disabled/CONSISTENCY/PathResolutionConsistency.expected

@@ -1,3 +1,3 @@
 multipleStaticCallTargets
-| regular.rs:32:5:32:9 | s.g(...) | anonymous.rs:18:9:18:22 | fn g |
-| regular.rs:32:5:32:9 | s.g(...) | regular.rs:16:5:16:18 | fn g |
+| regular.rs:32:5:32:9 | s.g() | anonymous.rs:18:9:18:22 | fn g |
+| regular.rs:32:5:32:9 | s.g() | regular.rs:16:5:16:18 | fn g |

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

@@ -38,17 +38,17 @@ canonicalPaths
 resolvedPaths
 | anonymous.rs:30:17:30:30 | OtherStruct {...} | None | None |
 | anonymous.rs:31:9:31:9 | s | None | None |
-| anonymous.rs:31:9:31:13 | s.f(...) | None | None |
+| anonymous.rs:31:9:31:13 | s.f() | None | None |
 | anonymous.rs:32:9:32:9 | s | None | None |
-| anonymous.rs:32:9:32:13 | s.g(...) | None | None |
+| anonymous.rs:32:9:32:13 | s.g() | None | None |
 | anonymous.rs:33:9:33:14 | nested | None | None |
 | regular.rs:30:13:30:21 | Struct {...} | None | None |
 | regular.rs:31:5:31:5 | s | None | None |
-| regular.rs:31:5:31:9 | s.f(...) | None | None |
+| regular.rs:31:5:31:9 | s.f() | None | None |
 | regular.rs:32:5:32:5 | s | None | None |
-| regular.rs:32:5:32:9 | s.g(...) | None | None |
+| regular.rs:32:5:32:9 | s.g() | None | None |
 | regular.rs:33:5:33:5 | s | None | None |
-| regular.rs:33:5:33:9 | s.h(...) | None | None |
+| regular.rs:33:5:33:9 | s.h() | None | None |
 | regular.rs:34:5:34:8 | free | None | None |
 | regular.rs:44:9:44:26 | ...::None::<...> | None | None |
 | regular.rs:45:9:45:20 | ...::Some | None | None |

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

@@ -1,5 +1,5 @@
 noLocation
-| file://:0:0:0:0 | ... .unwrap(...) |
+| file://:0:0:0:0 | ... .unwrap() |
 | file://:0:0:0:0 | ...: ... |
 | file://:0:0:0:0 | ...::Path |
 | file://:0:0:0:0 | ...::Path |
@@ -32,7 +32,7 @@ noLocation
 | file://:0:0:0:0 | path |
 | file://:0:0:0:0 | path |
 | file://:0:0:0:0 | path |
-| file://:0:0:0:0 | path.parent(...) |
+| file://:0:0:0:0 | path.parent() |
 | file://:0:0:0:0 | std |
 | file://:0:0:0:0 | std |
 | file://:0:0:0:0 | std |

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

@@ -205,8 +205,8 @@ edges
 | test.rs:99:19:99:25 | Some(...) | test.rs:99:24:99:24 | x | match |
 | test.rs:99:24:99:24 | x | test.rs:99:24:99:24 | x |  |
 | test.rs:99:24:99:24 | x | test.rs:100:17:100:17 | x | match |
-| test.rs:99:29:99:32 | iter | test.rs:99:29:99:39 | iter.next(...) |  |
-| test.rs:99:29:99:39 | iter.next(...) | test.rs:99:19:99:25 | Some(...) |  |
+| test.rs:99:29:99:32 | iter | test.rs:99:29:99:39 | iter.next() |  |
+| test.rs:99:29:99:39 | iter.next() | test.rs:99:19:99:25 | Some(...) |  |
 | test.rs:99:41:103:9 | { ... } | test.rs:99:15:99:39 | let ... = ... |  |
 | test.rs:100:13:102:13 | if ... {...} | test.rs:99:41:103:9 | { ... } |  |
 | test.rs:100:17:100:17 | x | test.rs:100:22:100:22 | 5 |  |
@@ -760,8 +760,8 @@ edges
 | test.rs:311:87:313:5 | { ... } | test.rs:311:5:313:5 | exit fn test_question_mark_operator_1 (normal) |  |
 | test.rs:312:9:312:10 | Ok | test.rs:312:12:312:12 | s |  |
 | test.rs:312:9:312:33 | Ok(...) | test.rs:311:87:313:5 | { ... } |  |
-| test.rs:312:12:312:12 | s | test.rs:312:12:312:27 | s.parse(...) |  |
-| test.rs:312:12:312:27 | s.parse(...) | test.rs:312:12:312:28 | TryExpr |  |
+| test.rs:312:12:312:12 | s | test.rs:312:12:312:27 | s.parse() |  |
+| test.rs:312:12:312:27 | s.parse() | test.rs:312:12:312:28 | TryExpr |  |
 | test.rs:312:12:312:28 | TryExpr | test.rs:311:5:313:5 | exit fn test_question_mark_operator_1 (normal) | return |
 | test.rs:312:12:312:28 | TryExpr | test.rs:312:32:312:32 | 4 | match |
 | test.rs:312:12:312:32 | ... + ... | test.rs:312:9:312:33 | Ok(...) |  |