Swift: subsume IterableDeclContext into Decl [codegen'd]

Author: d10c

swift/ql/.generated.list

@@ -35,7 +35,6 @@ import codeql.swift.elements.decl.GenericTypeParamDecl
 import codeql.swift.elements.decl.IfConfigDecl
 import codeql.swift.elements.decl.ImportDecl
 import codeql.swift.elements.decl.InfixOperatorDecl
-import codeql.swift.elements.decl.IterableDeclContext
 import codeql.swift.elements.decl.MissingMemberDecl
 import codeql.swift.elements.decl.ModuleDecl
 import codeql.swift.elements.decl.NominalTypeDecl

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

@@ -198,14 +198,18 @@ private module Impl {
   }
 
   private Element getImmediateChildOfDecl(Decl e, int index, string partialPredicateCall) {
-    exists(int b, int bAstNode, int n |
+    exists(int b, int bAstNode, int n, int nMember |
       b = 0 and
       bAstNode = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfAstNode(e, i, _)) | i) and
       n = bAstNode and
+      nMember = n + 1 + max(int i | i = -1 or exists(e.getImmediateMember(i)) | i) and
       (
         none()
         or
         result = getImmediateChildOfAstNode(e, index - b, partialPredicateCall)
+        or
+        result = e.getImmediateMember(index - n) and
+        partialPredicateCall = "Member(" + (index - n).toString() + ")"
       )
     )
   }
@@ -230,25 +234,6 @@ private module Impl {
     )
   }
 
-  private Element getImmediateChildOfIterableDeclContext(
-    IterableDeclContext e, int index, string partialPredicateCall
-  ) {
-    exists(int b, int bElement, int n, int nMember |
-      b = 0 and
-      bElement = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfElement(e, i, _)) | i) and
-      n = bElement and
-      nMember = n + 1 + max(int i | i = -1 or exists(e.getImmediateMember(i)) | i) and
-      (
-        none()
-        or
-        result = getImmediateChildOfElement(e, index - b, partialPredicateCall)
-        or
-        result = e.getImmediateMember(index - n) and
-        partialPredicateCall = "Member(" + (index - n).toString() + ")"
-      )
-    )
-  }
-
   private Element getImmediateChildOfEnumCaseDecl(
     EnumCaseDecl e, int index, string partialPredicateCall
   ) {
@@ -267,26 +252,19 @@ private module Impl {
   private Element getImmediateChildOfExtensionDecl(
     ExtensionDecl e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bGenericContext, int bIterableDeclContext, int bDecl, int n |
+    exists(int b, int bGenericContext, int bDecl, int n |
       b = 0 and
       bGenericContext =
         b + 1 + max(int i | i = -1 or exists(getImmediateChildOfGenericContext(e, i, _)) | i) and
-      bIterableDeclContext =
-        bGenericContext + 1 +
-          max(int i | i = -1 or exists(getImmediateChildOfIterableDeclContext(e, i, _)) | i) and
       bDecl =
-        bIterableDeclContext + 1 +
-          max(int i | i = -1 or exists(getImmediateChildOfDecl(e, i, _)) | i) and
+        bGenericContext + 1 + max(int i | i = -1 or exists(getImmediateChildOfDecl(e, i, _)) | i) and
       n = bDecl and
       (
         none()
         or
         result = getImmediateChildOfGenericContext(e, index - b, partialPredicateCall)
         or
-        result =
-          getImmediateChildOfIterableDeclContext(e, index - bGenericContext, partialPredicateCall)
-        or
-        result = getImmediateChildOfDecl(e, index - bIterableDeclContext, partialPredicateCall)
+        result = getImmediateChildOfDecl(e, index - bGenericContext, partialPredicateCall)
       )
     )
   }
@@ -799,21 +777,15 @@ private module Impl {
   private Element getImmediateChildOfNominalTypeDecl(
     NominalTypeDecl e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bGenericTypeDecl, int bIterableDeclContext, int n |
+    exists(int b, int bGenericTypeDecl, int n |
       b = 0 and
       bGenericTypeDecl =
         b + 1 + max(int i | i = -1 or exists(getImmediateChildOfGenericTypeDecl(e, i, _)) | i) and
-      bIterableDeclContext =
-        bGenericTypeDecl + 1 +
-          max(int i | i = -1 or exists(getImmediateChildOfIterableDeclContext(e, i, _)) | i) and
-      n = bIterableDeclContext and
+      n = bGenericTypeDecl and
       (
         none()
         or
         result = getImmediateChildOfGenericTypeDecl(e, index - b, partialPredicateCall)
-        or
-        result =
-          getImmediateChildOfIterableDeclContext(e, index - bGenericTypeDecl, partialPredicateCall)
       )
     )
   }

swift/ql/lib/codeql/swift/generated/ParentChild.qll

@@ -75,6 +75,8 @@ module Raw {
 
   class Decl extends @decl, AstNode {
     ModuleDecl getModule() { decls(this, result) }
+
+    Decl getMember(int index) { decl_members(this, index, result) }
   }
 
   class GenericContext extends @generic_context, Element {
@@ -83,17 +85,13 @@ module Raw {
     }
   }
 
-  class IterableDeclContext extends @iterable_decl_context, Element {
-    Decl getMember(int index) { iterable_decl_context_members(this, index, result) }
-  }
-
   class EnumCaseDecl extends @enum_case_decl, Decl {
     override string toString() { result = "EnumCaseDecl" }
 
     EnumElementDecl getElement(int index) { enum_case_decl_elements(this, index, result) }
   }
 
-  class ExtensionDecl extends @extension_decl, GenericContext, IterableDeclContext, Decl {
+  class ExtensionDecl extends @extension_decl, GenericContext, Decl {
     override string toString() { result = "ExtensionDecl" }
 
     NominalTypeDecl getExtendedTypeDecl() { extension_decls(this, result) }
@@ -292,7 +290,7 @@ module Raw {
     override string toString() { result = "GenericTypeParamDecl" }
   }
 
-  class NominalTypeDecl extends @nominal_type_decl, GenericTypeDecl, IterableDeclContext {
+  class NominalTypeDecl extends @nominal_type_decl, GenericTypeDecl {
     Type getType() { nominal_type_decls(this, result) }
   }
 

swift/ql/lib/codeql/swift/generated/Raw.qll

@@ -338,8 +338,6 @@ module Synth {
 
   class TGenericTypeDecl = TNominalTypeDecl or TOpaqueTypeDecl or TTypeAliasDecl;
 
-  class TIterableDeclContext = TExtensionDecl or TNominalTypeDecl;
-
   class TNominalTypeDecl = TClassDecl or TEnumDecl or TProtocolDecl or TStructDecl;
 
   class TOperatorDecl = TInfixOperatorDecl or TPostfixOperatorDecl or TPrefixOperatorDecl;
@@ -1381,8 +1379,6 @@ module Synth {
     or
     result = convertGenericContextFromRaw(e)
     or
-    result = convertIterableDeclContextFromRaw(e)
-    or
     result = convertLocatableFromRaw(e)
     or
     result = convertLocationFromRaw(e)
@@ -1519,13 +1515,6 @@ module Synth {
     result = convertTypeAliasDeclFromRaw(e)
   }
 
-  cached
-  TIterableDeclContext convertIterableDeclContextFromRaw(Raw::Element e) {
-    result = convertExtensionDeclFromRaw(e)
-    or
-    result = convertNominalTypeDeclFromRaw(e)
-  }
-
   cached
   TNominalTypeDecl convertNominalTypeDeclFromRaw(Raw::Element e) {
     result = convertClassDeclFromRaw(e)
@@ -3019,8 +3008,6 @@ module Synth {
     or
     result = convertGenericContextToRaw(e)
     or
-    result = convertIterableDeclContextToRaw(e)
-    or
     result = convertLocatableToRaw(e)
     or
     result = convertLocationToRaw(e)
@@ -3157,13 +3144,6 @@ module Synth {
     result = convertTypeAliasDeclToRaw(e)
   }
 
-  cached
-  Raw::Element convertIterableDeclContextToRaw(TIterableDeclContext e) {
-    result = convertExtensionDeclToRaw(e)
-    or
-    result = convertNominalTypeDeclToRaw(e)
-  }
-
   cached
   Raw::Element convertNominalTypeDeclToRaw(TNominalTypeDecl e) {
     result = convertClassDeclToRaw(e)

swift/ql/lib/codeql/swift/generated/Synth.qll

@@ -21,5 +21,30 @@ module Generated {
      * Gets the module of this declaration.
      */
     final ModuleDecl getModule() { result = getImmediateModule().resolve() }
+
+    /**
+     * Gets the `index`th member of this declaration (0-based).
+     *
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behavior of both the `Immediate` and non-`Immediate` versions.
+     */
+    Decl getImmediateMember(int index) {
+      result = Synth::convertDeclFromRaw(Synth::convertDeclToRaw(this).(Raw::Decl).getMember(index))
+    }
+
+    /**
+     * Gets the `index`th member of this declaration (0-based).
+     */
+    final Decl getMember(int index) { result = getImmediateMember(index).resolve() }
+
+    /**
+     * Gets any of the members of this declaration.
+     */
+    final Decl getAMember() { result = getMember(_) }
+
+    /**
+     * Gets the number of members of this declaration.
+     */
+    final int getNumberOfMembers() { result = count(int i | exists(getMember(i))) }
   }
 }

swift/ql/lib/codeql/swift/generated/decl/Decl.qll

@@ -3,12 +3,11 @@ private import codeql.swift.generated.Synth
 private import codeql.swift.generated.Raw
 import codeql.swift.elements.decl.Decl
 import codeql.swift.elements.decl.GenericContext
-import codeql.swift.elements.decl.IterableDeclContext
 import codeql.swift.elements.decl.NominalTypeDecl
 import codeql.swift.elements.decl.ProtocolDecl
 
 module Generated {
-  class ExtensionDecl extends Synth::TExtensionDecl, GenericContext, IterableDeclContext, Decl {
+  class ExtensionDecl extends Synth::TExtensionDecl, GenericContext, Decl {
     override string getAPrimaryQlClass() { result = "ExtensionDecl" }
 
     /**

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

@@ -2,11 +2,10 @@
 private import codeql.swift.generated.Synth
 private import codeql.swift.generated.Raw
 import codeql.swift.elements.decl.GenericTypeDecl
-import codeql.swift.elements.decl.IterableDeclContext
 import codeql.swift.elements.type.Type
 
 module Generated {
-  class NominalTypeDecl extends Synth::TNominalTypeDecl, GenericTypeDecl, IterableDeclContext {
+  class NominalTypeDecl extends Synth::TNominalTypeDecl, GenericTypeDecl {
     /**
      * Gets the type of this nominal type declaration.
      *

swift/ql/lib/codeql/swift/generated/decl/IterableDeclContext.qll

@@ -15,7 +15,6 @@ sourceLocationPrefix(
   @callable
 | @file
 | @generic_context
-| @iterable_decl_context
 | @locatable
 | @location
 | @type
@@ -177,6 +176,13 @@ decls(  //dir=decl
   int module: @module_decl_or_none ref
 );
 
+#keyset[id, index]
+decl_members(  //dir=decl
+  int id: @decl ref,
+  int index: int ref,
+  int member: @decl_or_none ref
+);
+
 @generic_context =
   @abstract_function_decl
 | @extension_decl
@@ -191,18 +197,6 @@ generic_context_generic_type_params(  //dir=decl
   int generic_type_param: @generic_type_param_decl_or_none ref
 );
 
-@iterable_decl_context =
-  @extension_decl
-| @nominal_type_decl
-;
-
-#keyset[id, index]
-iterable_decl_context_members(  //dir=decl
-  int id: @iterable_decl_context ref,
-  int index: int ref,
-  int member: @decl_or_none ref
-);
-
 enum_case_decls(  //dir=decl
   unique int id: @enum_case_decl
 );