Merge pull request #9328 from MathiasVP/swift-to-string

Swift: Improve `toString` implementations for Ast classes

Author: MathiasVP

swift/ql/lib/codeql/swift/elements/decl/AbstractFunctionDecl.qll

@@ -1,4 +1,5 @@
-// generated by codegen/codegen.py, remove this comment if you wish to edit this file
 private import codeql.swift.generated.decl.AbstractFunctionDecl
 
-class AbstractFunctionDecl extends AbstractFunctionDeclBase { }
+class AbstractFunctionDecl extends AbstractFunctionDeclBase {
+  override string toString() { result = this.getName() }
+}

swift/ql/lib/codeql/swift/elements/decl/AccessorDecl.qll

@@ -1,9 +1,26 @@
 private import codeql.swift.generated.decl.AccessorDecl
 
+private predicate isKnownAccessorKind(AccessorDecl decl, string kind) {
+  decl.isGetter() and kind = "get"
+  or
+  decl.isSetter() and kind = "set"
+  or
+  decl.isWillSet() and kind = "willSet"
+  or
+  decl.isDidSet() and kind = "didSet"
+}
+
 class AccessorDecl extends AccessorDeclBase {
   predicate isPropertyObserver() {
     this instanceof WillSetObserver or this instanceof DidSetObserver
   }
+
+  override string toString() {
+    isKnownAccessorKind(this, result)
+    or
+    not isKnownAccessorKind(this, _) and
+    result = super.toString()
+  }
 }
 
 class WillSetObserver extends AccessorDecl {

swift/ql/lib/codeql/swift/elements/decl/ConstructorDecl.qll

@@ -1,4 +1,5 @@
-// generated by codegen/codegen.py, remove this comment if you wish to edit this file
 private import codeql.swift.generated.decl.ConstructorDecl
 
-class ConstructorDecl extends ConstructorDeclBase { }
+class ConstructorDecl extends ConstructorDeclBase {
+  override string toString() { result = "deinit" }
+}

swift/ql/lib/codeql/swift/elements/decl/DestructorDecl.qll

@@ -1,4 +1,5 @@
-// generated by codegen/codegen.py, remove this comment if you wish to edit this file
 private import codeql.swift.generated.decl.DestructorDecl
 
-class DestructorDecl extends DestructorDeclBase { }
+class DestructorDecl extends DestructorDeclBase {
+  override string toString() { result = "init" }
+}

swift/ql/lib/codeql/swift/elements/decl/EnumCaseDecl.qll

@@ -1,4 +1,5 @@
-// generated by codegen/codegen.py, remove this comment if you wish to edit this file
 private import codeql.swift.generated.decl.EnumCaseDecl
 
-class EnumCaseDecl extends EnumCaseDeclBase { }
+class EnumCaseDecl extends EnumCaseDeclBase {
+  override string toString() { result = "case ..." }
+}

swift/ql/lib/codeql/swift/elements/decl/EnumElementDecl.qll

@@ -1,4 +1,5 @@
-// generated by codegen/codegen.py, remove this comment if you wish to edit this file
 private import codeql.swift.generated.decl.EnumElementDecl
 
-class EnumElementDecl extends EnumElementDeclBase { }
+class EnumElementDecl extends EnumElementDeclBase {
+  override string toString() { result = this.getName() }
+}

swift/ql/lib/codeql/swift/elements/decl/ExtensionDecl.qll

@@ -1,4 +1,7 @@
-// generated by codegen/codegen.py, remove this comment if you wish to edit this file
 private import codeql.swift.generated.decl.ExtensionDecl
 
-class ExtensionDecl extends ExtensionDeclBase { }
+class ExtensionDecl extends ExtensionDeclBase {
+  override string toString() {
+    result = "extension" // TODO: Once we extract the name of this one we can provide a better `toString`.
+  }
+}

swift/ql/lib/codeql/swift/elements/decl/IfConfigDecl.qll

@@ -1,4 +1,5 @@
-// generated by codegen/codegen.py, remove this comment if you wish to edit this file
 private import codeql.swift.generated.decl.IfConfigDecl
 
-class IfConfigDecl extends IfConfigDeclBase { }
+class IfConfigDecl extends IfConfigDeclBase {
+  override string toString() { result = "#if ..." }
+}

swift/ql/lib/codeql/swift/elements/decl/ImportDecl.qll

@@ -1,4 +1,5 @@
-// generated by codegen/codegen.py, remove this comment if you wish to edit this file
 private import codeql.swift.generated.decl.ImportDecl
 
-class ImportDecl extends ImportDeclBase { }
+class ImportDecl extends ImportDeclBase {
+  override string toString() { result = "import ..." }
+}

swift/ql/lib/codeql/swift/elements/decl/OperatorDecl.qll

@@ -1,4 +1,5 @@
-// generated by codegen/codegen.py, remove this comment if you wish to edit this file
 private import codeql.swift.generated.decl.OperatorDecl
 
-class OperatorDecl extends OperatorDeclBase { }
+class OperatorDecl extends OperatorDeclBase {
+  override string toString() { result = this.getName() }
+}