Swift: Cache Element.toString

Author: hvitved

swift/ql/.generated.list

@@ -25,11 +25,11 @@ module Impl {
       this instanceof WillSetObserver or this instanceof DidSetObserver
     }
 
-    override string toString() {
+    override string toStringImpl() {
       isKnownAccessorKind(this, result)
       or
       not isKnownAccessorKind(this, _) and
-      result = super.toString()
+      result = super.toStringImpl()
     }
   }
 }

swift/ql/lib/codeql/swift/elements/decl/internal/AccessorImpl.qll

@@ -7,7 +7,7 @@ module Impl {
    * A captured variable or function parameter in the scope of a closure.
    */
   class CapturedDecl extends Generated::CapturedDecl {
-    override string toString() { result = this.getDecl().toString() }
+    override string toStringImpl() { result = this.getDecl().toStringImpl() }
 
     /**
      * Gets the closure or function that captures this variable.

swift/ql/lib/codeql/swift/elements/decl/internal/CapturedDeclImpl.qll

@@ -4,7 +4,8 @@ private import codeql.swift.elements.decl.ExtensionDecl
 
 module Impl {
   class Decl extends Generated::Decl {
-    override string toString() { result = super.toString() }
+    // needed to avoid spurious non-monotonicity error
+    override string toStringImpl() { result = super.toStringImpl() }
 
     /**
      * Gets the `NominalTypeDecl` corresponding to this `Decl`, if any. This

swift/ql/lib/codeql/swift/elements/decl/internal/DeclImpl.qll

@@ -6,6 +6,8 @@ module Impl {
    * A deinitializer of a class.
    */
   class Deinitializer extends Generated::Deinitializer {
-    override string toString() { result = this.getSelfParam().getType() + "." + super.toString() }
+    override string toStringImpl() {
+      result = this.getSelfParam().getType().toStringImpl() + "." + super.toStringImpl()
+    }
   }
 }

swift/ql/lib/codeql/swift/elements/decl/internal/DeinitializerImpl.qll

@@ -2,6 +2,6 @@ private import codeql.swift.generated.decl.EnumCaseDecl
 
 module Impl {
   class EnumCaseDecl extends Generated::EnumCaseDecl {
-    override string toString() { result = "case ..." }
+    override string toStringImpl() { result = "case ..." }
   }
 }

swift/ql/lib/codeql/swift/elements/decl/internal/EnumCaseDeclImpl.qll

@@ -12,7 +12,7 @@ module Impl {
    * ```
    */
   class EnumElementDecl extends Generated::EnumElementDecl {
-    override string toString() { result = this.getName() }
+    override string toStringImpl() { result = this.getName() }
 
     /**
      * Holds if this enum element declaration is called `enumElementName` and is a member of an

swift/ql/lib/codeql/swift/elements/decl/internal/EnumElementDeclImpl.qll

@@ -2,9 +2,10 @@ private import codeql.swift.generated.decl.ExtensionDecl
 
 module Impl {
   class ExtensionDecl extends Generated::ExtensionDecl {
-    override string toString() {
+    override string toStringImpl() {
       result =
-        "extension of " + unique(NominalTypeDecl td | td = this.getExtendedTypeDecl()).toString()
+        "extension of " +
+          unique(NominalTypeDecl td | td = this.getExtendedTypeDecl()).toStringImpl()
       or
       count(this.getExtendedTypeDecl()) != 1 and
       result = "extension"

swift/ql/lib/codeql/swift/elements/decl/internal/ExtensionDeclImpl.qll

@@ -6,7 +6,7 @@ module Impl {
    * A function.
    */
   class Function extends Generated::Function {
-    override string toString() { result = this.getName() }
+    override string toStringImpl() { result = this.getName() }
 
     /**
      * Gets the name of this function, without the argument list. For example

swift/ql/lib/codeql/swift/elements/decl/internal/FunctionImpl.qll

@@ -2,6 +2,6 @@ private import codeql.swift.generated.decl.IfConfigDecl
 
 module Impl {
   class IfConfigDecl extends Generated::IfConfigDecl {
-    override string toString() { result = "#if ..." }
+    override string toStringImpl() { result = "#if ..." }
   }
 }