Rust: reuse shared rust trap library

Author: Paolo Tranquilli

.pre-commit-config.yaml

@@ -45,7 +45,7 @@ repos:
 
       - id: sync-files
         name: Fix files required to be identical
-        files: \.(qll?|qhelp|swift)$|^config/identical-files\.json$
+        files: \.(qll?|qhelp|swift|toml)$|^config/identical-files\.json$
         language: system
         entry: python3 config/sync-files.py --latest
         pass_filenames: false

config/identical-files.json

@@ -358,6 +358,7 @@
   ],
   "shared tree-sitter extractor cargo.toml": [
     "shared/tree-sitter-extractor/Cargo.toml",
-    "ruby/extractor/codeql-extractor-fake-crate/Cargo.toml"
+    "ruby/extractor/codeql-extractor-fake-crate/Cargo.toml",
+    "rust/extractor/codeql-extractor-fake-crate/Cargo.toml"
   ]
 }

misc/codegen/generators/rustgen.py

@@ -13,14 +13,16 @@
 
 def _get_type(t: str) -> str:
     match t:
-        case None | "boolean":  # None means a predicate
+        case None:  # None means a predicate
             return "bool"
         case "string":
             return "String"
         case "int":
-            return "i32"
+            return "usize"
         case _ if t[0].isupper():
-            return "TrapLabel"
+            return "trap::Label"
+        case "boolean":
+            assert False, "boolean unsupported"
         case _:
             return t
 

misc/codegen/lib/rust.py

@@ -58,10 +58,6 @@
 }
 
 _field_overrides = [
-    (
-        re.compile(r"(start|end)_(line|column)|(.*_)?index|width|num_.*"),
-        {"base_type": "u32"},
-    ),
     (re.compile(r"(.*)_"), lambda m: {"field_name": m[1]}),
 ]
 
@@ -98,20 +94,13 @@ def type(self) -> str:
             type = f"Vec<{type}>"
         return type
 
-    # using @property breaks pystache internals here
-    def emitter(self):
-        if self.type == "String":
-            return lambda x: f"quoted(&{x})"
-        else:
-            return lambda x: x
-
     @property
     def is_single(self):
         return not (self.is_optional or self.is_repeated or self.is_predicate)
 
     @property
     def is_label(self):
-        return self.base_type == "TrapLabel"
+        return self.base_type == "trap::Label"
 
 
 @dataclasses.dataclass

misc/codegen/templates/rust_classes.mustache

@@ -1,7 +1,7 @@
 // generated by {{generator}}
 
-use crate::trap::{TrapLabel, TrapId, TrapEntry, quoted};
-use std::io::Write;
+use crate::trap::{TrapId, TrapEntry};
+use codeql_extractor::trap;
 {{#classes}}
 
 #[derive(Debug)]
@@ -17,37 +17,36 @@ impl TrapEntry for {{name}} {
         std::mem::replace(&mut self.id, TrapId::Star)
     }
 
-    fn emit<W: Write>(self, id: TrapLabel, out: &mut W) -> std::io::Result<()> {
+    fn emit(self, id: trap::Label, out: &mut trap::Writer) {
         {{#single_field_entries}}
-        write!(out, "{{table_name}}({id}{{#fields}}, {}{{/fields}})\n"{{#fields}}, {{#emitter}}self.{{field_name}}{{/emitter}}{{/fields}})?;
+        out.add_tuple("{{table_name}}", vec![trap::Arg::Label(id){{#fields}}, self.{{field_name}}.into(){{/fields}}]);
         {{/single_field_entries}}
         {{#fields}}
         {{#is_predicate}}
         if self.{{field_name}} {
-            write!(out, "{{table_name}}({id})\n")?;
+            out.add_tuple("{{table_name}}", vec![trap::Arg::Label(id)]);
         }
         {{/is_predicate}}
         {{#is_optional}}
         {{^is_repeated}}
-        if let Some(ref v) = &self.{{field_name}} {
-            write!(out, "{{table_name}}({id}, {})\n", {{#emitter}}v{{/emitter}})?;
+        if let Some(v) = self.{{field_name}} {
+            out.add_tuple("{{table_name}}", vec![trap::Arg::Label(id), v.into()]);
         }
         {{/is_repeated}}
         {{/is_optional}}
         {{#is_repeated}}
-        for (i, &ref v) in self.{{field_name}}.iter().enumerate() {
+        for (i, &v) in self.{{field_name}}.iter().enumerate() {
             {{^is_optional}}
-            write!(out, "{{table_name}}({id}, {{^is_unordered}}{}, {{/is_unordered}}{})\n", {{^is_unordered}}i, {{/is_unordered}}{{#emitter}}v{{/emitter}})?;
+            out.add_tuple("{{table_name}}", vec![trap::Arg::Label(id){{^is_unordered}}, i.into(){{/is_unordered}}, v.into()]);
             {{/is_optional}}
             {{#is_optional}}
-            if let Some(ref vv) = &v {
-                write!(out, "{{table_name}}({id}, {{^is_unordered}}{}, {{/is_unordered}}{})\n", {{^is_unordered}}i, {{/is_unordered}}{{#emitter}}vv{{/emitter}})?;
+            if let Some(vv) = v {
+                out.add_tuple("{{table_name}}", vec![trap::Arg::Label(id){{^is_unordered}}, i.into(){{/is_unordered}}, v.into()]);
             }
             {{/is_optional}}
         }
         {{/is_repeated}}
         {{/fields}}
-        Ok(())
     }
 }
 {{/classes}}

rust/extractor/.cargo/config.toml

@@ -0,0 +1 @@
+paths = ["../../shared/tree-sitter-extractor"]

rust/extractor/BUILD.bazel

@@ -11,5 +11,7 @@ codeql_rust_binary(
     visibility = ["//rust:__subpackages__"],
     deps = all_crate_deps(
         normal = True,
-    ),
+    ) + [
+        "//shared/tree-sitter-extractor:codeql-extractor",
+    ],
 )