Merge pull request #18968 from hvitved/rust/cache-to-string

Rust/Swift: Cache `Element.toString`

Author: redsun82

misc/codegen/templates/ql_class.mustache

@@ -29,7 +29,15 @@ module Generated {
     /**
      * Gets the string representation of this element.
      */
-    string toString() { none() } // overridden by subclasses
+    cached
+    final string toString() { result = this.toStringImpl() }
+
+    /**
+     * INTERNAL: Do not use.
+     *
+     * Gets the string representation of this element.
+     */
+    abstract string toStringImpl();
 
     /**
      * Gets the name of a primary CodeQL class to which this element belongs.

rust/ql/.generated.list

@@ -22,6 +22,6 @@ module Impl {
    * ```
    */
   class ArrayListExpr extends Generated::ArrayListExpr {
-    override string toString() { result = "[...]" }
+    override string toStringImpl() { result = "[...]" }
   }
 }

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

@@ -21,7 +21,7 @@ module Impl {
    * ```
    */
   class ArrayRepeatExpr extends Generated::ArrayRepeatExpr {
-    override string toString() {
+    override string toStringImpl() {
       result =
         "[" + this.getRepeatOperand().toAbbreviatedString() + "; " +
           this.getRepeatLength().toAbbreviatedString() + "]"

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

@@ -22,6 +22,6 @@ module Impl {
    * ```
    */
   class AwaitExpr extends Generated::AwaitExpr {
-    override string toString() { result = "await " + this.getExpr().toAbbreviatedString() }
+    override string toStringImpl() { result = "await " + this.getExpr().toAbbreviatedString() }
   }
 }

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

@@ -25,6 +25,6 @@ module Impl {
    * ```
    */
   class BecomeExpr extends Generated::BecomeExpr {
-    override string toString() { result = "become " + this.getExpr().toAbbreviatedString() }
+    override string toStringImpl() { result = "become " + this.getExpr().toAbbreviatedString() }
   }
 }

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

@@ -23,6 +23,6 @@ module Impl {
    * ```
    */
   class BinaryExpr extends Generated::BinaryExpr {
-    override string toString() { result = "... " + this.getOperatorName() + " ..." }
+    override string toStringImpl() { result = "... " + this.getOperatorName() + " ..." }
   }
 }

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

@@ -22,6 +22,6 @@ module Impl {
    * ```
    */
   class BoxPat extends Generated::BoxPat {
-    override string toString() { result = "box " + this.getPat().toAbbreviatedString() }
+    override string toStringImpl() { result = "box " + this.getPat().toAbbreviatedString() }
   }
 }

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

@@ -104,14 +104,14 @@ module Impl {
       )
     }
 
-    override string toString() {
+    override string toStringImpl() {
       result = strictconcat(int i | | this.toStringPart(i), " " order by i)
     }
 
     private string toStringPart(int index) {
       index = 0 and result = "break"
       or
-      index = 1 and result = this.getLifetime().toString()
+      index = 1 and result = this.getLifetime().toStringImpl()
       or
       index = 2 and result = this.getExpr().toAbbreviatedString()
     }

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

@@ -34,7 +34,7 @@ module Impl {
    * ```
    */
   class CallExpr extends Generated::CallExpr {
-    override string toString() { result = this.getFunction().toAbbreviatedString() + "(...)" }
+    override string toStringImpl() { result = this.getFunction().toAbbreviatedString() + "(...)" }
 
     override Callable getStaticTarget() { result = getResolvedFunction(this) }
 

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

@@ -19,7 +19,7 @@ module Impl {
    * ```
    */
   class CastExpr extends Generated::CastExpr {
-    override string toString() {
+    override string toStringImpl() {
       result =
         this.getExpr().toAbbreviatedString() + " as " + this.getTypeRepr().toAbbreviatedString()
     }

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

@@ -25,6 +25,6 @@ module Impl {
    * ```
    */
   class ClosureExpr extends Generated::ClosureExpr {
-    override string toString() { result = "|...| " + this.getBody().toAbbreviatedString() }
+    override string toStringImpl() { result = "|...| " + this.getBody().toAbbreviatedString() }
   }
 }

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

@@ -20,7 +20,7 @@ module Impl {
    * ```
    */
   class Comment extends Generated::Comment {
-    override string toString() {
+    override string toStringImpl() {
       result = this.getCommentMarker() + "..." + this.getCommentEndMarker()
     }
 

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

@@ -49,7 +49,7 @@ module Impl {
    * ```
    */
   class ContinueExpr extends Generated::ContinueExpr {
-    override string toString() {
+    override string toStringImpl() {
       result = strictconcat(int i | | this.toStringPart(i), " " order by i)
     }
 

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

@@ -14,7 +14,9 @@ module Impl {
   private import rust
 
   class Crate extends Generated::Crate {
-    override string toString() { result = strictconcat(int i | | this.toStringPart(i) order by i) }
+    override string toStringImpl() {
+      result = strictconcat(int i | | this.toStringPart(i) order by i)
+    }
 
     private string toStringPart(int i) {
       i = 0 and result = "Crate("

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

@@ -12,13 +12,13 @@ private import codeql.rust.elements.internal.generated.Element
  */
 module Impl {
   class Element extends Generated::Element {
-    override string toString() { result = this.getAPrimaryQlClass() }
+    override string toStringImpl() { result = this.getAPrimaryQlClass() }
 
     /**
+     * INTERNAL: Do not use.
+     *
      * Returns a string suitable to be inserted into the name of the parent. Typically `"..."`,
      * but may be overridden by subclasses.
-     *
-     * INTERNAL: Do not use.
      */
     string toAbbreviatedString() { result = "..." }
 

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

@@ -19,6 +19,6 @@ module Impl {
    * ```
    */
   class Enum extends Generated::Enum {
-    override string toString() { result = "enum " + this.getName().getText() }
+    override string toStringImpl() { result = "enum " + this.getName().getText() }
   }
 }

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

@@ -12,7 +12,7 @@ private import codeql.rust.elements.internal.generated.ExtractorStep
  */
 module Impl {
   class ExtractorStep extends Generated::ExtractorStep {
-    override string toString() {
+    override string toStringImpl() {
       result = this.getAction() + "(" + this.getFile().getAbsolutePath() + ")"
       or
       not this.hasFile() and result = this.getAction()

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

@@ -28,7 +28,7 @@ module Impl {
     /** Gets the tuple field that this access references, if any. */
     TupleField getTupleField() { result = TypeInference::resolveTupleFieldExpr(this) }
 
-    override string toString() {
+    override string toStringImpl() {
       exists(string abbr, string name |
         abbr = this.getExpr().toAbbreviatedString() and
         name = this.getNameRef().getText() and

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

@@ -36,7 +36,7 @@ module Impl {
 
     FormatArgument() { this = Synth::TFormatArgument(parent, index, kind, name, _, offset) }
 
-    override string toString() { result = name }
+    override string toStringImpl() { result = name }
 
     override Format getParent() { result = Synth::TFormat(parent, index, _, _) }
 

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

@@ -36,7 +36,7 @@ module Impl {
 
     Format() { this = Synth::TFormat(parent, index, text, offset) }
 
-    override string toString() { result = text }
+    override string toStringImpl() { result = text }
 
     override FormatArgsExpr getParent() { result = Synth::convertFormatArgsExprFromRaw(parent) }
 

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

@@ -29,7 +29,7 @@ module Impl {
 
     override Location getLocation() { result = argument.getLocation() }
 
-    override string toString() { result = this.getName() }
+    override string toStringImpl() { result = this.getName() }
 
     /** Gets the name of the variable */
     string getName() { result = argument.getName() }

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

@@ -25,6 +25,6 @@ module Impl {
    * ```
    */
   class Function extends Generated::Function {
-    override string toString() { result = "fn " + this.getName().getText() }
+    override string toStringImpl() { result = "fn " + this.getName().getText() }
   }
 }

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

@@ -21,7 +21,7 @@ module Impl {
    * ```
    */
   class GenericArgList extends Generated::GenericArgList {
-    override string toString() { result = this.toAbbreviatedString() }
+    override string toStringImpl() { result = this.toAbbreviatedString() }
 
     override string toAbbreviatedString() { result = "<...>" }
 

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

@@ -21,7 +21,7 @@ module Impl {
    * ```
    */
   class GenericParamList extends Generated::GenericParamList {
-    override string toString() { result = this.toAbbreviatedString() }
+    override string toStringImpl() { result = this.toAbbreviatedString() }
 
     override string toAbbreviatedString() { result = "<...>" }
 

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

@@ -28,7 +28,7 @@ module Impl {
    * ```
    */
   class IdentPat extends Generated::IdentPat {
-    override string toString() {
+    override string toStringImpl() {
       result = strictconcat(int i | | this.toStringPart(i), " " order by i)
     }
 

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

@@ -28,7 +28,9 @@ module Impl {
    * ```
    */
   class IfExpr extends Generated::IfExpr {
-    override string toString() { result = concat(int i | | this.toStringPart(i), " " order by i) }
+    override string toStringImpl() {
+      result = concat(int i | | this.toStringPart(i), " " order by i)
+    }
 
     private string toStringPart(int index) {
       index = 0 and result = "if"

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

@@ -19,7 +19,7 @@ module Impl {
    * ```
    */
   class Impl extends Generated::Impl {
-    override string toString() {
+    override string toStringImpl() {
       exists(string trait |
         (
           trait = this.getTrait().toAbbreviatedString() + " for "

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

@@ -20,7 +20,7 @@ module Impl {
    * ```
    */
   class IndexExpr extends Generated::IndexExpr {
-    override string toString() {
+    override string toStringImpl() {
       result =
         this.getBase().toAbbreviatedString() + "[" + this.getIndex().toAbbreviatedString() + "]"
     }

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

@@ -19,7 +19,7 @@ module Impl {
    * ```
    */
   class InferTypeRepr extends Generated::InferTypeRepr {
-    override string toString() { result = this.toAbbreviatedString() }
+    override string toStringImpl() { result = this.toAbbreviatedString() }
 
     override string toAbbreviatedString() { result = "_" }
   }

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

@@ -22,7 +22,7 @@ module Impl {
    * ```
    */
   class Label extends Generated::Label {
-    override string toString() { result = this.getText() }
+    override string toStringImpl() { result = this.getText() }
 
     override string toAbbreviatedString() { result = this.getText() }
 

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

@@ -16,7 +16,7 @@ module Impl {
    * The base class for expressions that can be labeled (`LoopExpr`, `ForExpr`, `WhileExpr` or `BlockExpr`).
    */
   class LabelableExpr extends Generated::LabelableExpr {
-    final override string toString() {
+    final override string toStringImpl() {
       result = strictconcat(int i | | this.toStringPart(i), " " order by i)
     }
 

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

@@ -19,7 +19,7 @@ module Impl {
    * ```
    */
   class LetElse extends Generated::LetElse {
-    override string toString() { result = this.toAbbreviatedString() }
+    override string toStringImpl() { result = this.toAbbreviatedString() }
 
     override string toAbbreviatedString() { result = "else {...}" }
   }

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

@@ -21,7 +21,9 @@ module Impl {
    * ```
    */
   class LetExpr extends Generated::LetExpr {
-    override string toString() { result = concat(int i | | this.toStringPart(i), " " order by i) }
+    override string toStringImpl() {
+      result = concat(int i | | this.toStringPart(i), " " order by i)
+    }
 
     private string toStringPart(int index) {
       index = 0 and result = "let"

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

@@ -26,7 +26,7 @@ module Impl {
    * ```
    */
   class LetStmt extends Generated::LetStmt {
-    override string toString() {
+    override string toStringImpl() {
       result = strictconcat(int i | | this.toStringPart(i), " " order by i)
     }
 

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

@@ -19,7 +19,7 @@ module Impl {
    * ```
    */
   class Lifetime extends Generated::Lifetime {
-    override string toString() {
+    override string toStringImpl() {
       result = "'" + this.getText()
       or
       not this.hasText() and result = "'_"

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

@@ -26,7 +26,7 @@ module Impl {
    * ```
    */
   class LiteralExpr extends Generated::LiteralExpr {
-    override string toString() { result = this.getTrimmedText() }
+    override string toStringImpl() { result = this.getTrimmedText() }
 
     override string toAbbreviatedString() { result = this.getTrimmedText() }
 

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

@@ -22,7 +22,7 @@ module Impl {
    * ```
    */
   class LiteralPat extends Generated::LiteralPat {
-    override string toString() { result = this.toAbbreviatedString() }
+    override string toStringImpl() { result = this.toAbbreviatedString() }
 
     override string toAbbreviatedString() { result = this.getLiteral().getTrimmedText() }
   }

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

@@ -19,6 +19,6 @@ module Impl {
    * ```
    */
   class MacroCall extends Generated::MacroCall {
-    override string toString() { result = this.getPath().toAbbreviatedString() + "!..." }
+    override string toStringImpl() { result = this.getPath().toAbbreviatedString() + "!..." }
   }
 }

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

@@ -28,7 +28,9 @@ module Impl {
    * ```
    */
   class MatchArm extends Generated::MatchArm {
-    override string toString() { result = concat(int i | | this.toStringPart(i), " " order by i) }
+    override string toStringImpl() {
+      result = concat(int i | | this.toStringPart(i), " " order by i)
+    }
 
     private string toStringPart(int index) {
       index = 0 and result = this.getPat().toAbbreviatedString()

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

@@ -28,7 +28,7 @@ module Impl {
    * ```
    */
   class MatchExpr extends Generated::MatchExpr {
-    override string toString() {
+    override string toStringImpl() {
       result = "match " + this.getScrutinee().toAbbreviatedString() + " { ... }"
     }