Fix enums/errors case names conflicting with parameters to top level …

…type names (#95)

Signed-off-by: Kristupas Antanavičius <[email protected]>

README.md

@@ -52,12 +52,6 @@ The following uniffi features are unsupported.
 
 - Async functions [#41](https://github.com/NordSecurity/uniffi-bindgen-cs/issues/41)
 
-# Known Limitations
-
-The following valid Rust type definitions fail to be converted properly, but a simple work-around is given:
-
-- Enum variants having the same name as their member type [#60](https://github.com/NordSecurity/uniffi-bindgen-cs/issues/60)
-
 # Configuration options
 
 It's possible to [configure some settings](docs/CONFIGURATION.md) by passing `--config`

bindgen/templates/EnumTemplate.cs

@@ -48,8 +48,8 @@ public override void Write({{ type_name }} value, BigEndianStream stream) {
     public record {{ variant.name()|class_name }}: {{ type_name }} {}
     {% else -%}
     public record {{ variant.name()|class_name }} (
-        {% for field in variant.fields() -%}
-        {{ field|type_name}} {{ field.name()|var_name }}{% if !loop.last %},{% endif %}
+        {%- for field in variant.fields() %}
+        {% call cs::enum_parameter_type_name(field|type_name, variant.name()|class_name) %} {{ field.name()|var_name }}{% if !loop.last %},{% endif %}
         {%- endfor %}
     ) : {{ type_name }} {}
     {%- endif %}

bindgen/templates/ErrorTemplate.cs

@@ -64,13 +64,13 @@ public class {{ variant.name()|exception_name }} : {{ type_name }} {}
     public class {{ variant.name()|exception_name }} : {{ type_name }} {
         // Members
         {%- for field in variant.fields() %}
-        public {{ field|type_name}} {{ field.name()|var_name }};
+        public {% call cs::enum_parameter_type_name(field|type_name, variant.name()|exception_name) %} {{ field.name()|var_name }};
         {%- endfor %}
 
         // Constructor
         public {{ variant.name()|exception_name }}(
                 {%- for field in variant.fields() %}
-                {{ field|type_name}} {{ field.name()|var_name }}{% if loop.last %}{% else %}, {% endif %}
+                {% call cs::enum_parameter_type_name(field|type_name, variant.name()|exception_name) %} {{ field.name()|var_name }}{% if loop.last %}{% else %}, {% endif %}
                 {%- endfor %}) {
             {%- for field in variant.fields() %}
             this.{{ field.name()|var_name }} = {{ field.name()|var_name }};

bindgen/templates/macros.cs

@@ -121,4 +121,22 @@
 void
 {%- endmatch -%}
 {%- endif -%}
-{%- endmacro -%}
+{%- endmacro -%}
+
+{#
+// Break the following cycle, where `Rectangle` case name shadow top level `Rectangle` type name.
+// If param type name matches the enum name, prefix the param type name with top level namespace.
+// https://github.com/NordSecurity/uniffi-bindgen-cs/issues/60
+//     public record Rectangle(double @width, double @height) { }
+//     public record Shape
+//     {                    ____________
+//                          ∨          ∧
+//         public record Rectangle(Rectangle @s) : Shape { }
+//         public record Ellipse(Ellipse @s) : Shape { }
+//     }
+#}
+{%- macro enum_parameter_type_name(param_type_name, enum_name) %}
+{%- if param_type_name == enum_name %}{{ config.namespace() }}.{{ param_type_name }}
+{%- else %}{{ param_type_name }}
+{%- endif %}
+{%- endmacro %}

dotnet-tests/UniffiCS.BindingTests/TestIssue60.cs

@@ -0,0 +1,17 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+using uniffi.issue_60;
+
+namespace UniffiCS.BindingTests;
+
+public class ClassIssue60
+{
+    [Fact]
+    public void TestIssue60()
+    {
+        new Shape.Rectangle(new Rectangle(1f, 2f));
+        new ShapeException.Rectangle(new Rectangle(1f, 2f));
+    }
+}

fixtures/Cargo.toml

@@ -11,6 +11,7 @@ crate-type = ["cdylib", "lib"]
 [dependencies]
 global-methods-class-name = { path = "global-methods-class-name" }
 issue-28 = { path = "regressions/issue-28" }
+issue-60 = { path = "regressions/issue-60" }
 issue-75 = { path = "regressions/issue-75" }
 issue-76 = { path = "regressions/issue-76" }
 null-to-empty-string = { path = "null-to-empty-string" }

fixtures/regressions/issue-60/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "issue-60"
+version = "1.0.0"
+edition = "2021"
+publish = false
+
+[lib]
+crate-type = ["lib", "cdylib"]
+name = "issue_60"
+
+[dependencies]
+thiserror = "1.0"
+uniffi = {path = "../../../3rd-party/uniffi-rs/uniffi", features=["build"]}
+uniffi_macros = {path = "../../../3rd-party/uniffi-rs/uniffi_macros"}
+
+[build-dependencies]
+uniffi = {path = "../../../3rd-party/uniffi-rs/uniffi", features=["bindgen-tests"]}

fixtures/regressions/issue-60/README.md

@@ -0,0 +1,13 @@
+# https://github.com/NordSecurity/uniffi-bindgen-cs/issues/60
+
+Associated enum class names conflict with top level type definitions.
+
+```C#
+public record Rectangle(double @width, double @height) { }
+public record Shape
+{                    ____________
+                     ∨          ∧
+    public record Rectangle(Rectangle @s) : Shape { }
+    public record Ellipse(Ellipse @s) : Shape { }
+}
+```

fixtures/regressions/issue-60/src/lib.rs

@@ -0,0 +1,45 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+use std::fmt;
+
+#[derive(uniffi::Enum)]
+pub enum Shape {
+    Rectangle { s: Rectangle },
+    Ellipse { s: Ellipse },
+}
+
+#[derive(Debug, thiserror::Error, uniffi::Error)]
+pub enum ShapeError {
+    #[error("Rectangle: {s}")]
+    Rectangle { s: Rectangle },
+    #[error("Ellipse: {s}")]
+    Ellipse { s: Ellipse },
+}
+
+#[derive(uniffi::Record, Debug)]
+pub struct Rectangle {
+    width: f64,
+    height: f64,
+}
+
+#[derive(uniffi::Record, Debug)]
+pub struct Ellipse {
+    x_radius: f64,
+    y_radius: f64,
+}
+
+impl fmt::Display for Rectangle {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(f, "width: {}, height: {}", self.width, self.height)
+    }
+}
+
+impl fmt::Display for Ellipse {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(f, "x_radius: {}, y_radius: {}", self.x_radius, self.y_radius)
+    }
+}
+
+uniffi::setup_scaffolding!();

fixtures/src/lib.rs

@@ -25,6 +25,7 @@ mod uniffi_fixtures {
     uniffi_cs_optional_parameters::uniffi_reexport_scaffolding!();
     stringify::uniffi_reexport_scaffolding!();
     issue_28::uniffi_reexport_scaffolding!();
+    issue_60::uniffi_reexport_scaffolding!();
     issue_75::uniffi_reexport_scaffolding!();
     issue_76::uniffi_reexport_scaffolding!();
 }