Merge pull request #20924 from paldepind/rust/struct-field-tostring

Rust: Implement `toString` for struct fields and visibility

Author: paldepind

rust/ql/.generated.list

@@ -29,5 +29,19 @@ module Impl {
 
     /** Holds if this record field is named `name` and belongs to the struct `s`. */
     predicate isStructField(Struct s, string name) { this = s.getStructField(name) }
+
+    override string toStringImpl() {
+      result = strictconcat(int i | | this.toStringPart(i) order by i)
+    }
+
+    private string toStringPart(int index) {
+      index = 0 and result = this.getVisibility().toAbbreviatedString() + " "
+      or
+      index = 1 and result = this.getName().getText()
+      or
+      index = 2 and result = ": "
+      or
+      index = 3 and result = this.getTypeRepr().toAbbreviatedString()
+    }
   }
 }

rust/ql/.gitattributes

@@ -1,4 +1,3 @@
-// generated by codegen, remove this comment if you wish to edit this file
 /**
  * This module provides a hand-modifiable wrapper around the generated class `Visibility`.
  *
@@ -12,6 +11,7 @@ private import codeql.rust.elements.internal.generated.Visibility
  * be referenced directly.
  */
 module Impl {
+  // the following QLdoc is generated: if you need to edit it, do it in the schema file
   /**
    * A visibility modifier.
    *
@@ -21,5 +21,13 @@ module Impl {
    * //^^^
    * ```
    */
-  class Visibility extends Generated::Visibility { }
+  class Visibility extends Generated::Visibility {
+    override string toStringImpl() { result = this.toAbbreviatedString() }
+
+    override string toAbbreviatedString() {
+      result = "pub(" + this.getPath().toAbbreviatedString() + ")"
+      or
+      not this.hasPath() and result = "pub"
+    }
+  }
 }

rust/ql/lib/codeql/rust/elements/internal/StructFieldImpl.qll

@@ -9,4 +9,4 @@ getBody
 getName
 | gen_macro_def.rs:4:5:9:5 | MacroDef | gen_macro_def.rs:7:15:7:24 | vec_of_two |
 getVisibility
-| gen_macro_def.rs:4:5:9:5 | MacroDef | gen_macro_def.rs:7:5:7:7 | Visibility |
+| gen_macro_def.rs:4:5:9:5 | MacroDef | gen_macro_def.rs:7:5:7:7 | pub |

rust/ql/lib/codeql/rust/elements/internal/VisibilityImpl.qll

@@ -11,4 +11,4 @@ getName
 | gen_module.rs:5:1:7:1 | mod bar | gen_module.rs:5:5:5:7 | bar |
 | lib.rs:1:1:1:19 | mod gen_module | lib.rs:1:9:1:18 | gen_module |
 getVisibility
-| lib.rs:1:1:1:19 | mod gen_module | lib.rs:1:1:1:3 | Visibility |
+| lib.rs:1:1:1:19 | mod gen_module | lib.rs:1:1:1:3 | pub |

rust/ql/test/extractor-tests/generated/MacroDef/MacroDef.expected

@@ -1,9 +1,9 @@
 instances
-| gen_struct_field.rs:7:16:7:21 | StructField | isUnsafe: | no |
+| gen_struct_field.rs:7:16:7:21 | x: i32 | isUnsafe: | no |
 getAttr
 getDefault
 getName
-| gen_struct_field.rs:7:16:7:21 | StructField | gen_struct_field.rs:7:16:7:16 | x |
+| gen_struct_field.rs:7:16:7:21 | x: i32 | gen_struct_field.rs:7:16:7:16 | x |
 getTypeRepr
-| gen_struct_field.rs:7:16:7:21 | StructField | gen_struct_field.rs:7:19:7:21 | i32 |
+| gen_struct_field.rs:7:16:7:21 | x: i32 | gen_struct_field.rs:7:19:7:21 | i32 |
 getVisibility

rust/ql/test/extractor-tests/generated/Module/Module.expected

@@ -1,5 +1,5 @@
 instances
 | gen_struct_field_list.rs:7:14:7:31 | StructFieldList |
 getField
-| gen_struct_field_list.rs:7:14:7:31 | StructFieldList | 0 | gen_struct_field_list.rs:7:16:7:21 | StructField |
-| gen_struct_field_list.rs:7:14:7:31 | StructFieldList | 1 | gen_struct_field_list.rs:7:24:7:29 | StructField |
+| gen_struct_field_list.rs:7:14:7:31 | StructFieldList | 0 | gen_struct_field_list.rs:7:16:7:21 | x: i32 |
+| gen_struct_field_list.rs:7:14:7:31 | StructFieldList | 1 | gen_struct_field_list.rs:7:24:7:29 | y: i32 |

rust/ql/test/extractor-tests/generated/StructField/StructField.expected

@@ -13,6 +13,6 @@ getName
 | gen_trait.rs:10:1:10:57 | trait Foo | gen_trait.rs:10:11:10:13 | Foo |
 getTypeBoundList
 getVisibility
-| gen_trait.rs:10:1:10:57 | trait Foo | gen_trait.rs:10:1:10:3 | Visibility |
+| gen_trait.rs:10:1:10:57 | trait Foo | gen_trait.rs:10:1:10:3 | pub |
 getWhereClause
 | gen_trait.rs:10:1:10:57 | trait Foo | gen_trait.rs:10:32:10:54 | WhereClause |

rust/ql/test/extractor-tests/generated/StructFieldList/StructFieldList.expected

@@ -1,4 +1,4 @@
 instances
-| gen_visibility.rs:7:7:7:9 | Visibility |
-| lib.rs:1:1:1:3 | Visibility |
+| gen_visibility.rs:7:7:7:9 | pub |
+| lib.rs:1:1:1:3 | pub |
 getPath