Rust: implement Format and FormatArgument classes

Author: aibaars

rust/ql/.generated.list

@@ -0,0 +1,7 @@
+/**
+ * This module provides the public class `NamedFormatArgument`.
+ */
+
+private import internal.FormatArgumentImpl
+
+final class NamedFormatArgument = Impl::NamedFormatArgument;

rust/ql/.gitattributes

@@ -0,0 +1,7 @@
+/**
+ * This module provides the public class `PositionalFormatArgument`.
+ */
+
+private import internal.FormatArgumentImpl
+
+final class PositionalFormatArgument = Impl::PositionalFormatArgument;

rust/ql/lib/codeql/rust/elements/FormatTemplate.qll

@@ -5,7 +5,7 @@
  */
 
 private import codeql.rust.elements.internal.generated.FormatArgsExpr
-private import codeql.rust.elements.FormatTemplate
+private import codeql.rust.elements.Format
 
 /**
  * INTERNAL: This module contains the customizable definition of `FormatArgsExpr` and should not

rust/ql/lib/codeql/rust/elements/NamedFormatArgument.qll

@@ -1,14 +1,37 @@
-// generated by codegen, remove this comment if you wish to edit this file
 /**
  *  This module defines the hook used internally to tweak the characteristic predicate of
  *  `FormatArgument` synthesized instances.
  *  INTERNAL: Do not use.
  */
 
 private import codeql.rust.elements.internal.generated.Raw
+private import codeql.rust.elements.internal.generated.Synth
+private import codeql.rust.elements.internal.FormatConstructor
 
 /**
  *  The characteristic predicate of `FormatArgument` synthesized instances.
  *  INTERNAL: Do not use.
  */
-predicate constructFormatArgument(Raw::FormatArgsExpr parent, int index, int kind) { none() }
+predicate constructFormatArgument(Raw::FormatArgsExpr parent, int index, int kind) {
+  formatArgument(parent, index, kind, _, _, _)
+}
+
+predicate formatArgument(
+  Raw::FormatArgsExpr parent, int index, int kind, string value, boolean positional, int offset
+) {
+  exists(string text, int formatOffset, int group |
+    group = [3, 4] and offset = formatOffset + 1 and kind = 0
+    or
+    group = [15, 16] and
+    offset = formatOffset + min(text.indexOf(value + "$")) and
+    kind = 1
+    or
+    group = [23, 24] and
+    offset = formatOffset + max(text.indexOf(value + "$")) and
+    kind = 2
+  |
+    text = formatElement(parent, index, formatOffset) and
+    value = text.regexpCapture(formatRegex(), group) and
+    if group % 2 = 1 then positional = true else positional = false
+  )
+}