Swift: specialize Ipa <-> Db conversions

Author: redsun82

swift/codegen/generators/qlgen.py

@@ -93,7 +93,7 @@ def _to_db_type(x: str) -> str:
 
 def get_ql_ipa_class(cls: schema.Class):
     if cls.derived:
-        return ql.Ipa.NonFinalClass(name=cls.name, derived=sorted(cls.derived))
+        return ql.Ipa.NonFinalClass(name=cls.name, derived=sorted(cls.derived), root=(cls.name == schema.root_class_name))
     if cls.ipa and cls.ipa.from_class is not None:
         source = cls.ipa.from_class
         _final_db_class_lookup.setdefault(source, ql.Ipa.FinalClassDb(source)).subtract_type(cls.name)
@@ -276,7 +276,7 @@ def generate(opts, renderer):
                 if not stub_file.is_file() or _is_generated_stub(stub_file):
                     renderer.render(ql.Ipa.ConstructorStub(ipa_type), stub_file)
                 constructor_imports.append(get_import(stub_file, opts.swift_dir))
-        elif cls.name != schema.root_class_name:
+        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")

swift/codegen/lib/ql.py

@@ -229,6 +229,7 @@ def db_id(self):
     @dataclass
     class NonFinalClass(Class):
         derived: List["Ipa.Class"] = field(default_factory=list)
+        root: bool = False
 
         def __post_init__(self):
             self.derived = [Ipa.Class(c) for c in self.derived]

swift/codegen/templates/ql_class.mustache

@@ -29,7 +29,7 @@ class {{name}}Base extends Ipa::T{{name}}{{#bases}}, {{.}}{{/bases}} {
   {{#type_is_class}}
   {{type}} getImmediate{{singular}}({{#is_repeated}}int index{{/is_repeated}}) {
     {{#has_db_id}}
-    result = Ipa::fromDbInstance(Ipa::toDbInstance(this).(Db::{{name}}).{{getter}}({{#is_repeated}}index{{/is_repeated}}))
+    result = Ipa::convert{{type}}FromDb(Ipa::convert{{name}}ToDb(this).(Db::{{name}}).{{getter}}({{#is_repeated}}index{{/is_repeated}}))
     {{/has_db_id}}
     {{^has_db_id}}
     none()
@@ -44,7 +44,7 @@ class {{name}}Base extends Ipa::T{{name}}{{#bases}}, {{.}}{{/bases}} {
   {{^type_is_class}}
   {{type}} {{getter}}({{#is_repeated}}int index{{/is_repeated}}) {
     {{#has_db_id}}
-    {{^is_predicate}}result = {{/is_predicate}}Ipa::toDbInstance(this).(Db::{{name}}).{{getter}}({{#is_repeated}}index{{/is_repeated}})
+    {{^is_predicate}}result = {{/is_predicate}}Ipa::convert{{name}}ToDb(this).(Db::{{name}}).{{getter}}({{#is_repeated}}index{{/is_repeated}})
     {{/has_db_id}}
     {{^has_db_id}}
     none()

swift/codegen/templates/ql_ipa_types.mustache

@@ -8,7 +8,7 @@ cached module Ipa {
     or
     {{/first}}
     {{#is_ipa_from}}
-    T{{name}}({{type}} id) { construct{{name}}(id) }
+    T{{name}}(Db::{{type}} id) { construct{{name}}(id) }
     {{/is_ipa_from}}
     {{#is_ipa_on}}
     T{{name}}({{#params}}{{^first}}, {{/first}}{{type}} {{param}}{{/params}}){{#has_params}} { construct{{name}}({{#params}}{{^first}}, {{/first}}{{param}}{{/params}}) }{{/has_params}}
@@ -19,20 +19,52 @@ cached module Ipa {
     {{/final_classes}}
 
   {{#non_final_classes}}
+  {{^root}}
   class T{{name}} = {{#derived}}{{^first}} or {{/first}}T{{name}}{{/derived}};
+  {{/root}}
   {{/non_final_classes}}
 
-  cached TElement fromDbInstance(Db::Element e) {
-    none()
-    {{#final_classes}}
+  {{#final_classes}}
+  cached T{{name}} convert{{name}}FromDb(Db::Element e) {
     {{^is_ipa_on}}
-    or
     result = T{{name}}(e)
     {{/is_ipa_on}}
-    {{/final_classes}}
+    {{#is_ipa_on}}
+    none()
+    {{/is_ipa_on}}
+  }
+  {{/final_classes}}
+
+  {{#non_final_classes}}
+  cached T{{name}} convert{{name}}FromDb(Db::Element e) {
+    {{#derived}}
+    {{^first}}
+    or
+    {{/first}}
+    result = convert{{name}}FromDb(e)
+    {{/derived}}
   }
+  {{/non_final_classes}}
 
-  cached Db::Element toDbInstance(TElement e) {
-    e = fromDbInstance(result)
+  {{#final_classes}}
+  cached Db::Element convert{{name}}ToDb(T{{name}} e) {
+    {{^is_ipa_on}}
+    e = T{{name}}(result)
+    {{/is_ipa_on}}
+    {{#is_ipa_on}}
+    none()
+    {{/is_ipa_on}}
   }
+  {{/final_classes}}
+
+  {{#non_final_classes}}
+  cached Db::Element convert{{name}}ToDb(T{{name}} e) {
+    {{#derived}}
+    {{^first}}
+    or
+    {{/first}}
+    result = convert{{name}}ToDb(e)
+    {{/derived}}
+  }
+  {{/non_final_classes}}
 }

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

@@ -7,7 +7,8 @@ import codeql.swift.elements.decl.ParamDecl
 
 class CallableBase extends Ipa::TCallable, Element {
   ParamDecl getImmediateParam(int index) {
-    result = Ipa::fromDbInstance(Ipa::toDbInstance(this).(Db::Callable).getParam(index))
+    result =
+      Ipa::convertParamDeclFromDb(Ipa::convertCallableToDb(this).(Db::Callable).getParam(index))
   }
 
   final ParamDecl getParam(int index) { result = getImmediateParam(index).resolve() }
@@ -17,7 +18,7 @@ class CallableBase extends Ipa::TCallable, Element {
   final int getNumberOfParams() { result = count(getAParam()) }
 
   BraceStmt getImmediateBody() {
-    result = Ipa::fromDbInstance(Ipa::toDbInstance(this).(Db::Callable).getBody())
+    result = Ipa::convertBraceStmtFromDb(Ipa::convertCallableToDb(this).(Db::Callable).getBody())
   }
 
   final BraceStmt getBody() { result = getImmediateBody().resolve() }

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

@@ -17,5 +17,5 @@ class ElementBase extends Ipa::TElement {
     result = getResolveStep().resolve()
   }
 
-  predicate isUnknown() { Ipa::toDbInstance(this).(Db::Element).isUnknown() }
+  predicate isUnknown() { Ipa::convertElementToDb(this).(Db::Element).isUnknown() }
 }

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

@@ -4,5 +4,5 @@ private import codeql.swift.generated.Db
 import codeql.swift.elements.Element
 
 class FileBase extends Ipa::TFile, Element {
-  string getName() { result = Ipa::toDbInstance(this).(Db::File).getName() }
+  string getName() { result = Ipa::convertFileToDb(this).(Db::File).getName() }
 }