Adding str support back (#369)

rust-diplomat · Nov 28, 2023 · a0586ac · a0586ac
1 parent 5e392d5
commit a0586ac
Show file tree

Hide file tree

Showing 46 changed files with 268 additions and 63 deletions.
diff --git a/core/src/ast/types.rs b/core/src/ast/types.rs
@@ -396,6 +396,8 @@ pub enum TypeName {
 pub enum StringEncoding {
     UnvalidatedUtf8,
     UnvalidatedUtf16,
+    /// The caller guarantees that they're passing valid UTF-8, under penalty of UB
+    Utf8,
 }
 
 impl TypeName {
@@ -514,6 +516,11 @@ impl TypeName {
                 ))
                 .unwrap()
             }
+            TypeName::StrReference(lifetime, StringEncoding::Utf8) => syn::parse_str(&format!(
+                "{}str",
+                ReferenceDisplay(lifetime, &Mutability::Immutable)
+            ))
+            .unwrap(),
             TypeName::PrimitiveSlice(lifetime, mutability, name) => {
                 let primitive_name = PRIMITIVE_TO_STRING.get(name).unwrap();
                 let formatted_str = format!(
@@ -549,14 +556,16 @@ impl TypeName {
                 let mutability = Mutability::from_syn(&r.mutability);
 
                 let name = r.elem.to_token_stream().to_string();
-                if name.starts_with("DiplomatStr") {
+                if name.starts_with("DiplomatStr") || name == "str" {
                     if mutability.is_mutable() {
-                        panic!("mutable `DiplomatStr*` references are disallowed");
+                        panic!("mutable string references are disallowed");
                     }
                     if name == "DiplomatStr" {
                         return TypeName::StrReference(lifetime, StringEncoding::UnvalidatedUtf8);
                     } else if name == "DiplomatStr16" {
                         return TypeName::StrReference(lifetime, StringEncoding::UnvalidatedUtf16);
+                    } else if name == "str" {
+                        return TypeName::StrReference(lifetime, StringEncoding::Utf8);
                     }
                 }
                 if let syn::Type::Slice(slice) = &*r.elem {
@@ -951,6 +960,13 @@ impl fmt::Display for TypeName {
                     ReferenceDisplay(lifetime, &Mutability::Immutable)
                 )
             }
+            TypeName::StrReference(lifetime, StringEncoding::Utf8) => {
+                write!(
+                    f,
+                    "{}str",
+                    ReferenceDisplay(lifetime, &Mutability::Immutable)
+                )
+            }
             TypeName::PrimitiveSlice(lifetime, mutability, typ) => {
                 write!(f, "{}[{typ}]", ReferenceDisplay(lifetime, mutability))
             }

diff --git a/feature_tests/c/include/BorrowedFields.h b/feature_tests/c/include/BorrowedFields.h
diff --git a/feature_tests/c/include/MyString.h b/feature_tests/c/include/MyString.h
diff --git a/feature_tests/c2/include/BorrowedFields.d.h b/feature_tests/c2/include/BorrowedFields.d.h
diff --git a/feature_tests/c2/include/MyString.h b/feature_tests/c2/include/MyString.h
diff --git a/feature_tests/cpp/docs/source/lifetimes_ffi.rst b/feature_tests/cpp/docs/source/lifetimes_ffi.rst
diff --git a/feature_tests/cpp/docs/source/slices_ffi.rst b/feature_tests/cpp/docs/source/slices_ffi.rst
diff --git a/feature_tests/cpp/include/BorrowedFields.h b/feature_tests/cpp/include/BorrowedFields.h
diff --git a/feature_tests/cpp/include/BorrowedFields.hpp b/feature_tests/cpp/include/BorrowedFields.hpp
diff --git a/feature_tests/cpp/include/Foo.hpp b/feature_tests/cpp/include/Foo.hpp
diff --git a/feature_tests/cpp/include/MyString.h b/feature_tests/cpp/include/MyString.h
diff --git a/feature_tests/cpp/include/MyString.hpp b/feature_tests/cpp/include/MyString.hpp
diff --git a/feature_tests/cpp2/include/BorrowedFields.d.h b/feature_tests/cpp2/include/BorrowedFields.d.h
diff --git a/feature_tests/cpp2/include/BorrowedFields.d.hpp b/feature_tests/cpp2/include/BorrowedFields.d.hpp
diff --git a/feature_tests/cpp2/include/BorrowedFields.hpp b/feature_tests/cpp2/include/BorrowedFields.hpp
diff --git a/feature_tests/cpp2/include/MyString.d.hpp b/feature_tests/cpp2/include/MyString.d.hpp
diff --git a/feature_tests/cpp2/include/MyString.h b/feature_tests/cpp2/include/MyString.h
diff --git a/feature_tests/cpp2/include/MyString.hpp b/feature_tests/cpp2/include/MyString.hpp
diff --git a/feature_tests/dart/lib/BorrowedFields.g.dart b/feature_tests/dart/lib/BorrowedFields.g.dart
diff --git a/feature_tests/dart/lib/MyString.g.dart b/feature_tests/dart/lib/MyString.g.dart
diff --git a/feature_tests/dotnet/Lib/Generated/MyString.cs b/feature_tests/dotnet/Lib/Generated/MyString.cs
diff --git a/feature_tests/dotnet/Lib/Generated/RawBorrowedFields.cs b/feature_tests/dotnet/Lib/Generated/RawBorrowedFields.cs
diff --git a/feature_tests/dotnet/Lib/Generated/RawMyString.cs b/feature_tests/dotnet/Lib/Generated/RawMyString.cs
diff --git a/feature_tests/js/api/BorrowedFields.d.ts b/feature_tests/js/api/BorrowedFields.d.ts
diff --git a/feature_tests/js/api/BorrowedFields.js b/feature_tests/js/api/BorrowedFields.js
diff --git a/feature_tests/js/api/Foo.js b/feature_tests/js/api/Foo.js
diff --git a/feature_tests/js/api/MyString.d.ts b/feature_tests/js/api/MyString.d.ts
diff --git a/feature_tests/js/api/MyString.js b/feature_tests/js/api/MyString.js
diff --git a/feature_tests/js/docs/source/lifetimes_ffi.rst b/feature_tests/js/docs/source/lifetimes_ffi.rst
diff --git a/feature_tests/js/docs/source/slices_ffi.rst b/feature_tests/js/docs/source/slices_ffi.rst