Swift: add generated docs for predicates

Author: redsun82

swift/codegen/generators/qlgen.py

@@ -96,6 +96,8 @@ def _get_doc(cls: schema.Class, prop: schema.Property, plural=None):
 
     prop_name = _humanize(prop.name)
     class_name = _humanize(inflection.underscore(cls.name))
+    if prop.is_predicate:
+        return f"this {class_name} {prop_name}"
     if plural is not None:
         prop_name = inflection.pluralize(prop_name) if plural else inflection.singularize(prop_name)
     return f"{prop_name} of this {class_name}"
@@ -138,6 +140,7 @@ def get_ql_property(cls: schema.Class, prop: schema.Property, prev_child: str =
             singular=inflection.camelize(prop.name, uppercase_first_letter=False),
             tablename=inflection.underscore(f"{cls.name}_{prop.name}"),
             tableparams=["this"],
+            doc=_get_doc(cls, prop),
         )
     else:
         raise ValueError(f"unknown property kind for {prop.name} from {cls.name}")

swift/codegen/lib/schema/defs.py

@@ -16,8 +16,6 @@ class _DocnameModifier(_schema.PropertyModifier):
     doc: str
 
     def modify(self, prop: _schema.Property):
-        if prop.is_predicate:
-            raise _schema.Error("Predicates cannot have a doc name")
         prop.doc = self.doc
 
 

swift/codegen/templates/ql_class.mustache

@@ -86,7 +86,6 @@ module Generated {
 
     {{/type_is_class}}
     {{^type_is_class}}
-    {{^is_predicate}}
     /**
      * {{>ql_property_doc}}     *
     {{#has_description}}
@@ -95,16 +94,6 @@ module Generated {
     {{/description}}
     {{/has_description}}
      */
-    {{/is_predicate}}
-    {{#is_predicate}}
-    {{#has_doc}}
-    /**
-    {{#doc}}
-     * {{.}}
-    {{/doc}}
-     */
-    {{/has_doc}}
-    {{/is_predicate}}
     {{type}} {{getter}}({{#is_repeated}}int index{{/is_repeated}}) {
       {{^ipa}}
       {{^is_predicate}}result = {{/is_predicate}}Synth::convert{{name}}ToRaw(this){{^root}}.(Raw::{{name}}){{/root}}.{{getter}}({{#is_repeated}}index{{/is_repeated}})

swift/codegen/templates/ql_property_doc.mustache

@@ -1 +1,6 @@
+{{^is_predicate}}
 Gets the {{#is_repeated}}`index`th {{/is_repeated}}{{doc}}{{#is_repeated}} (0-based){{/is_repeated}}{{#is_optional}}, if it exists{{/is_optional}}.
+{{/is_predicate}}
+{{#is_predicate}}
+Holds if {{doc}}.
+{{/is_predicate}}

swift/codegen/test/test_qlgen.py

@@ -328,7 +328,7 @@ def test_predicate_property(generate_classes):
         "MyObject.qll": (ql.Stub(name="MyObject", base_import=gen_import_prefix + "MyObject"),
                          ql.Class(name="MyObject", final=True, properties=[
                              ql.Property(singular="isFoo", type="predicate", tablename="my_object_is_foo",
-                                         tableparams=["this"], is_predicate=True),
+                                         tableparams=["this"], is_predicate=True, doc="this my object is foo"),
                          ])),
     }
 

swift/codegen/test/test_schema.py

@@ -554,13 +554,5 @@ class A:
     }
 
 
-def test_predicate_cannot_have_doc_override():
-    with pytest.raises(schema.Error):
-        @schema.load
-        class data:
-            class A:
-                x: defs.predicate | defs.doc("y")
-
-
 if __name__ == '__main__':
     sys.exit(pytest.main([__file__] + sys.argv[1:]))

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

@@ -41,6 +41,9 @@ module Generated {
       result = getResolveStep().resolve()
     }
 
+    /**
+     * Holds if this element is unknown.
+     */
     predicate isUnknown() { Synth::convertElementToRaw(this).isUnknown() }
   }
 }

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

@@ -7,12 +7,24 @@ module Generated {
   class AccessorDecl extends Synth::TAccessorDecl, FuncDecl {
     override string getAPrimaryQlClass() { result = "AccessorDecl" }
 
+    /**
+     * Holds if this accessor is a getter.
+     */
     predicate isGetter() { Synth::convertAccessorDeclToRaw(this).(Raw::AccessorDecl).isGetter() }
 
+    /**
+     * Holds if this accessor is a setter.
+     */
     predicate isSetter() { Synth::convertAccessorDeclToRaw(this).(Raw::AccessorDecl).isSetter() }
 
+    /**
+     * Holds if this accessor is a `willSet`, called before the property is set.
+     */
     predicate isWillSet() { Synth::convertAccessorDeclToRaw(this).(Raw::AccessorDecl).isWillSet() }
 
+    /**
+     * Holds if this accessor is a `didSet`, called after the property is set.
+     */
     predicate isDidSet() { Synth::convertAccessorDeclToRaw(this).(Raw::AccessorDecl).isDidSet() }
   }
 }

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

@@ -9,6 +9,9 @@ module Generated {
   class ImportDecl extends Synth::TImportDecl, Decl {
     override string getAPrimaryQlClass() { result = "ImportDecl" }
 
+    /**
+     * Holds if this import declaration is exported.
+     */
     predicate isExported() { Synth::convertImportDeclToRaw(this).(Raw::ImportDecl).isExported() }
 
     /**

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

@@ -7,10 +7,16 @@ module Generated {
   class ModuleDecl extends Synth::TModuleDecl, TypeDecl {
     override string getAPrimaryQlClass() { result = "ModuleDecl" }
 
+    /**
+     * Holds if this module is the built-in one.
+     */
     predicate isBuiltinModule() {
       Synth::convertModuleDeclToRaw(this).(Raw::ModuleDecl).isBuiltinModule()
     }
 
+    /**
+     * Holds if this module is a system one.
+     */
     predicate isSystemModule() {
       Synth::convertModuleDeclToRaw(this).(Raw::ModuleDecl).isSystemModule()
     }