Swift: fix derived IPA type properties

Also rename `IpaTypes.qll` to `Ipa.qll`

Author: redsun82

swift/codegen/generators/qlgen.py

@@ -29,7 +29,7 @@ class ModifiedStubMarkedAsGeneratedError(Error):
     pass
 
 
-def get_ql_property(cls: schema.Class, source: schema.Class, prop: schema.Property) -> ql.Property:
+def get_ql_property(cls: schema.Class, prop: schema.Property) -> ql.Property:
     args = dict(
         type=prop.type if not prop.is_predicate else "predicate",
         qltest_skip="qltest_skip" in prop.pragmas,
@@ -40,30 +40,30 @@ def get_ql_property(cls: schema.Class, source: schema.Class, prop: schema.Proper
     if prop.is_single:
         args.update(
             singular=inflection.camelize(prop.name),
-            tablename=inflection.tableize(source.name),
-            tableparams=["this"] + ["result" if p is prop else "_" for p in source.properties if p.is_single],
+            tablename=inflection.tableize(cls.name),
+            tableparams=["this"] + ["result" if p is prop else "_" for p in cls.properties if p.is_single],
         )
     elif prop.is_repeated:
         args.update(
             singular=inflection.singularize(inflection.camelize(prop.name)),
             plural=inflection.pluralize(inflection.camelize(prop.name)),
-            tablename=inflection.tableize(f"{source.name}_{prop.name}"),
+            tablename=inflection.tableize(f"{cls.name}_{prop.name}"),
             tableparams=["this", "index", "result"],
         )
     elif prop.is_optional:
         args.update(
             singular=inflection.camelize(prop.name),
-            tablename=inflection.tableize(f"{source.name}_{prop.name}"),
+            tablename=inflection.tableize(f"{cls.name}_{prop.name}"),
             tableparams=["this", "result"],
         )
     elif prop.is_predicate:
         args.update(
             singular=inflection.camelize(prop.name, uppercase_first_letter=False),
-            tablename=inflection.underscore(f"{source.name}_{prop.name}"),
+            tablename=inflection.underscore(f"{cls.name}_{prop.name}"),
             tableparams=["this"],
         )
     else:
-        raise ValueError(f"unknown property kind for {prop.name} from {source.name}")
+        raise ValueError(f"unknown property kind for {prop.name} from {cls.name}")
     return ql.Property(**args)
 
 
@@ -73,10 +73,8 @@ def get_ql_class(cls: schema.Class, lookup: typing.Dict[str, schema.Class]):
         name=cls.name,
         bases=cls.bases,
         final=not cls.derived,
-
-        properties=[get_ql_property(cls, cls, p) for p in cls.properties],
+        properties=[get_ql_property(cls, p) for p in cls.properties],
         dir=cls.dir,
-        has_db_id=not cls.ipa or cls.ipa.from_class,
         ipa=bool(cls.ipa),
         **pragmas,
     )
@@ -179,7 +177,7 @@ def _get_all_properties_to_be_tested(cls: schema.Class, lookup: typing.Dict[str,
     for c, p in _get_all_properties(cls, lookup):
         if not ("qltest_skip" in c.pragmas or "qltest_skip" in p.pragmas):
             # TODO here operations are duplicated, but should be better if we split ql and qltest generation
-            p = get_ql_property(cls, c, p)
+            p = get_ql_property(c, p)
             yield ql.PropertyForTest(p.getter, p.type, p.is_single, p.is_predicate, p.is_repeated)
 
 
@@ -282,7 +280,7 @@ def generate(opts, renderer):
         else:
             non_final_ipa_types.append(ipa_type)
 
-    renderer.render(ql.Ipa.Types(schema.root_class_name, final_ipa_types, non_final_ipa_types), out / "IpaTypes.qll")
+    renderer.render(ql.Ipa.Types(schema.root_class_name, final_ipa_types, non_final_ipa_types), out / "Ipa.qll")
     renderer.render(ql.ImportList(constructor_imports), out / "IpaConstructors.qll")
 
     renderer.cleanup(existing)

swift/codegen/lib/ql.py

@@ -79,7 +79,6 @@ class Class:
     qltest_skip: bool = False
     qltest_collapse_hierarchy: bool = False
     qltest_uncollapse_hierarchy: bool = False
-    has_db_id: bool = True
     ipa: bool = False
 
     def __post_init__(self):
@@ -96,9 +95,8 @@ def path(self) -> pathlib.Path:
         return self.dir / self.name
 
     @property
-    def db_id(self) -> Optional[str]:
-        if self.has_db_id:
-            return "@" + inflection.underscore(self.name)
+    def db_id(self):
+        return "@" + inflection.underscore(self.name)
 
 
 @dataclass

swift/codegen/templates/ql_class.mustache

@@ -1,5 +1,5 @@
 // generated by {{generator}}
-private import codeql.swift.generated.IpaTypes
+private import codeql.swift.generated.Ipa
 private import codeql.swift.generated.Db
 {{#imports}}
 import {{.}}
@@ -28,12 +28,12 @@ class {{name}}Base extends Ipa::T{{name}}{{#bases}}, {{.}}{{/bases}} {
 
   {{#type_is_class}}
   {{type}} getImmediate{{singular}}({{#is_repeated}}int index{{/is_repeated}}) {
-    {{#has_db_id}}
+    {{^ipa}}
     result = Ipa::convert{{type}}FromDb(Ipa::convert{{name}}ToDb(this){{^root}}.(Db::{{name}}){{/root}}.{{getter}}({{#is_repeated}}index{{/is_repeated}}))
-    {{/has_db_id}}
-    {{^has_db_id}}
+    {{/ipa}}
+    {{#ipa}}
     none()
-    {{/has_db_id}}
+    {{/ipa}}
   }
 
   final {{type}} {{getter}}({{#is_repeated}}int index{{/is_repeated}}) {
@@ -43,12 +43,12 @@ class {{name}}Base extends Ipa::T{{name}}{{#bases}}, {{.}}{{/bases}} {
   {{/type_is_class}}
   {{^type_is_class}}
   {{type}} {{getter}}({{#is_repeated}}int index{{/is_repeated}}) {
-    {{#has_db_id}}
+    {{^ipa}}
     {{^is_predicate}}result = {{/is_predicate}}Ipa::convert{{name}}ToDb(this){{^root}}.(Db::{{name}}){{/root}}.{{getter}}({{#is_repeated}}index{{/is_repeated}})
-    {{/has_db_id}}
-    {{^has_db_id}}
+    {{/ipa}}
+    {{#ipa}}
     none()
-    {{/has_db_id}}
+    {{/ipa}}
   }
 
   {{/type_is_class}}

swift/codegen/templates/ql_ipa_constructor_stub.mustache

@@ -1,4 +1,4 @@
 // generated by {{generator}}, remove this comment if you wish to edit this file
-import codeql.swift.generated.Db
+private import codeql.swift.generated.Db
 
 predicate construct{{cls.name}}({{#cls.params}}{{^first}}, {{/first}}{{type}} {{param}}{{/cls.params}}) { none() }

swift/codegen/test/test_qlgen.py

@@ -101,7 +101,7 @@ def _filter_generated_classes(ret, output_test_files=False):
             str(f): ret[ql_test_output_path() / f]
             for f in test_files
         }
-    base_files -= {pathlib.Path(f"{name}.qll") for name in ("Db", "IpaTypes", "IpaConstructors")}
+    base_files -= {pathlib.Path(f"{name}.qll") for name in ("Db", "Ipa", "IpaConstructors")}
     assert stub_files == base_files
     return {
         str(f): (ret[stub_path() / f], ret[ql_output_path() / f])
@@ -129,7 +129,7 @@ def test_empty(generate):
     assert generate([]) == {
         import_file(): ql.ImportList(),
         children_file(): ql.GetParentImplementation(),
-        ql_output_path() / "IpaTypes.qll": ql.Ipa.Types(schema.root_class_name),
+        ql_output_path() / "Ipa.qll": ql.Ipa.Types(schema.root_class_name),
         ql_output_path() / "IpaConstructors.qll": ql.ImportList(),
         ql_output_path() / "Db.qll": ql.DbClasses(),
         ql_output_path() / "Db.qll": ql.DbClasses(),

swift/ql/lib/codeql/swift/controlflow/BasicBlocks.qll

@@ -7,7 +7,7 @@ private import internal.ControlFlowElements
 private import CfgNodes
 private import SuccessorTypes
 private import codeql.swift.generated.Db
-private import codeql.swift.generated.IpaTypes
+private import codeql.swift.generated.Ipa
 
 /**
  * A basic block, that is, a maximal straight-line sequence of control flow nodes

swift/ql/lib/codeql/swift/controlflow/internal/ControlFlowGraphImpl.qll

@@ -33,7 +33,7 @@
 
 private import swift
 private import codeql.swift.controlflow.ControlFlowGraph
-private import codeql.swift.generated.IpaTypes
+private import codeql.swift.generated.Ipa
 private import Completion
 private import Scope
 import ControlFlowGraphImplShared

swift/ql/lib/codeql/swift/controlflow/internal/Scope.qll

@@ -1,6 +1,6 @@
 private import swift
 private import codeql.swift.generated.GetImmediateParent
-private import codeql.swift.generated.IpaTypes
+private import codeql.swift.generated.Ipa
 
 module CallableBase {
   class TypeRange = Ipa::TAbstractFunctionDecl or Ipa::TKeyPathExpr or Ipa::TClosureExpr;

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

@@ -1,5 +1,5 @@
 // generated by codegen/codegen.py
-private import codeql.swift.generated.IpaTypes
+private import codeql.swift.generated.Ipa
 private import codeql.swift.generated.Db
 import codeql.swift.elements.Locatable
 

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

@@ -1,5 +1,5 @@
 // generated by codegen/codegen.py
-private import codeql.swift.generated.IpaTypes
+private import codeql.swift.generated.Ipa
 private import codeql.swift.generated.Db
 import codeql.swift.elements.stmt.BraceStmt
 import codeql.swift.elements.Element