Swift: move getAChild to a separate module

Author: redsun82

swift/codegen/generators/qlgen.py

@@ -99,6 +99,7 @@ def generate(opts, renderer):
     data = schema.load(input)
 
     classes = [get_ql_class(cls) for cls in data.classes]
+    classes.sort(key=lambda cls: cls.name)
     imports = {}
 
     for c in classes:
@@ -113,11 +114,15 @@ def generate(opts, renderer):
             stub = ql.Stub(name=c.name, base_import=get_import(qll, opts.swift_dir))
             renderer.render(stub, stub_file)
 
-    # for example path/to/syntax/generated -> path/to/syntax.qll
+    # for example path/to/elements -> path/to/elements.qll
     include_file = stub_out.with_suffix(".qll")
     all_imports = ql.ImportList([v for _, v in sorted(imports.items())])
     renderer.render(all_imports, include_file)
 
+    print(include_file)
+    renderer.render(ql.Children(classes=classes, imports=[get_import(include_file, opts.swift_dir)]),
+                    out / 'Children.qll')
+
     renderer.cleanup(existing)
     if opts.ql_format:
         format(opts.codeql_binary, renderer.written)

swift/codegen/lib/ql.py

@@ -92,3 +92,11 @@ class ImportList:
     template: ClassVar = 'ql_imports'
 
     imports: List[str] = field(default_factory=list)
+
+
+@dataclass
+class Children:
+    template: ClassVar = 'ql_children'
+
+    imports: List[str] = field(default_factory=list)
+    classes: List[Class] = field(default_factory=list)

swift/codegen/templates/ql_children.mustache

@@ -0,0 +1,20 @@
+// generated by {{generator}}
+
+{{#imports}}
+import {{.}}
+{{/imports}}
+
+cached
+Element getAChild(Element e) {
+  not exists(e.getResolveStep()) and (
+    none()
+    {{#classes}}
+    {{#properties}}
+    {{#is_child}}
+    or
+    result = e.({{name}}).{{getter}}({{#is_repeated}}_{{/is_repeated}})
+    {{/is_child}}
+    {{/properties}}
+    {{/classes}}
+  )
+}

swift/codegen/templates/ql_class.mustache

@@ -1,8 +1,5 @@
 // generated by {{generator}}
 
-{{^root}}
-import codeql.swift.elements.Element
-{{/root}}
 {{#imports}}
 import {{.}}
 {{/imports}}
@@ -22,26 +19,10 @@ class {{name}}Base extends {{db_id}}{{#bases}}, {{.}}{{/bases}} {
     or
     result = getResolveStep().resolve()
   }
-
-  {{name}}Base getAChild() { none() } // overridden by subclasses, internal use only
   {{/root}}
   {{#final}}
   override string getAPrimaryQlClass() { result = "{{name}}" }
   {{/final}}
-  {{^root}}
-
-  cached override Element getAChild() {
-    none()
-    {{#bases}}
-    or result = {{.}}.super.getAChild()
-    {{/bases}}
-    {{#properties}}
-    {{#is_child}}
-    or result = {{getter}}({{#is_repeated}}_{{/is_repeated}})
-    {{/is_child}}
-    {{/properties}}
-  }
-  {{/root}}
   {{#properties}}
 
   {{type}} {{getter}}({{#is_repeated}}int index{{/is_repeated}}) {