Merge pull request #63950 from augusto2112/print-debug-name

augusto2112 · web-flow · commit 6f68fb0dde4f · 2023-03-01T15:14:55.000-08:00
Print debug name
diff --git a/lib/PrintAsClang/ClangSyntaxPrinter.cpp b/lib/PrintAsClang/ClangSyntaxPrinter.cpp
@@ -433,3 +433,20 @@ void ClangSyntaxPrinter::printKnownCType(
   if (info->canBeNullable)
     os << " _Null_unspecified";
 }
+
+void ClangSyntaxPrinter::printSwiftMangledNameForDebugger(
+    const NominalTypeDecl *typeDecl) {
+  printIgnoredCxx17ExtensionDiagnosticBlock([&]() {
+
+  os << "#pragma clang diagnostic push\n";
+  os << "#pragma clang diagnostic ignored \"-Wreserved-identifier\"\n";
+    auto mangled_name = mangler.mangleTypeForDebugger(
+        typeDecl->getDeclaredInterfaceType(), nullptr);
+    if (!mangled_name.empty()) {
+      os << "  typedef char " << mangled_name << ";\n";
+      os << "  static inline constexpr " << mangled_name
+         << " __swift_mangled_name = 0;\n";
+    }
+  });
+  os << "#pragma clang diagnostic pop\n";
+}
diff --git a/lib/PrintAsClang/ClangSyntaxPrinter.h b/lib/PrintAsClang/ClangSyntaxPrinter.h
@@ -13,6 +13,7 @@
 #ifndef SWIFT_PRINTASCLANG_CLANGSYNTAXPRINTER_H
 #define SWIFT_PRINTASCLANG_CLANGSYNTAXPRINTER_H
 
+#include "swift/AST/ASTMangler.h"
 #include "swift/AST/Type.h"
 #include "swift/Basic/LLVM.h"
 #include "swift/ClangImporter/ClangImporter.h"
@@ -230,8 +231,14 @@ class ClangSyntaxPrinter {
   /// Print the given **known** type as a C type.
   void printKnownCType(Type t, PrimitiveTypeMapping &typeMapping) const;
 
+  /// Print the nominal type's Swift mangled name as a typedef from a char to
+  /// the mangled name, and a static constexpr variable declaration, whose type
+  /// is the aforementioned typedef, and whose name is known to the debugger.
+  void printSwiftMangledNameForDebugger(const NominalTypeDecl *typeDecl);
+
 protected:
   raw_ostream &os;
+  swift::Mangle::ASTMangler mangler;
 };
 
 } // end namespace swift
diff --git a/lib/PrintAsClang/PrintClangClassType.cpp b/lib/PrintAsClang/PrintClangClassType.cpp
@@ -83,6 +83,9 @@ void ClangClassTypePrinter::printClassTypeDecl(
   os << "  friend class " << cxx_synthesis::getCxxImplNamespaceName() << "::";
   printCxxImplClassName(os, typeDecl);
   os << ";\n";
+
+  printer.printSwiftMangledNameForDebugger(typeDecl);
+
   os << "};\n\n";
 
   // Print out the "hidden" _impl class.
diff --git a/lib/PrintAsClang/PrintClangValueType.cpp b/lib/PrintAsClang/PrintClangValueType.cpp
@@ -405,6 +405,9 @@ void ClangValueTypePrinter::printValueTypeDecl(
   printCxxImplClassName(os, typeDecl);
   printGenericParamRefs(os);
   os << ";\n";
+
+  printer.printSwiftMangledNameForDebugger(typeDecl);
+
   os << "};\n";
   os << '\n';
 
diff --git a/test/Interop/SwiftToCxx/class/swift-class-in-cxx.swift b/test/Interop/SwiftToCxx/class/swift-class-in-cxx.swift
@@ -63,6 +63,14 @@ public final class ClassWithIntField {
 // CHECK-NEXT:   SWIFT_INLINE_THUNK ClassWithIntField(void * _Nonnull ptr) noexcept : RefCountedClass(ptr) {}
 // CHECK-NEXT: private:
 // CHECK-NEXT:   friend class _impl::_impl_ClassWithIntField;
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wc++17-extensions"
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wreserved-identifier"
+// CHECK-NEXT:   typedef char $s5Class0A12WithIntFieldCD;
+// CHECK-NEXT:   static inline constexpr $s5Class0A12WithIntFieldCD __swift_mangled_name = 0;
+// CHECK-NEXT: #pragma clang diagnostic pop
+// CHECK-NEXT: #pragma clang diagnostic pop
 // CHECK-NEXT: };
 // CHECK-EMPTY:
 // CHECK-NEXT:namespace _impl {
diff --git a/test/Interop/SwiftToCxx/class/swift-class-inheritance-in-cxx.swift b/test/Interop/SwiftToCxx/class/swift-class-inheritance-in-cxx.swift
@@ -65,6 +65,14 @@ public func useDerivedClass(_ x: DerivedClass) {
 // CHECK-NEXT:    SWIFT_INLINE_THUNK DerivedClass(void * _Nonnull ptr) noexcept : BaseClass(ptr) {}
 // CHECK-NEXT:  private:
 // CHECK-NEXT:    friend class _impl::_impl_DerivedClass;
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wc++17-extensions"
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wreserved-identifier"
+// CHECK-NEXT:   typedef char $s5Class07DerivedA0CD;
+// CHECK-NEXT:   static inline constexpr $s5Class07DerivedA0CD __swift_mangled_name = 0;
+// CHECK-NEXT: #pragma clang diagnostic pop
+// CHECK-NEXT: #pragma clang diagnostic pop
 // CHECK-NEXT:  };
 
 // CHECK:      class SWIFT_SYMBOL("s:5Class07DerivedbA0C") DerivedDerivedClass final : public DerivedClass {
@@ -75,6 +83,14 @@ public func useDerivedClass(_ x: DerivedClass) {
 // CHECK-NEXT:   SWIFT_INLINE_THUNK DerivedDerivedClass(void * _Nonnull ptr) noexcept : DerivedClass(ptr) {}
 // CHECK-NEXT: private:
 // CHECK-NEXT:   friend class _impl::_impl_DerivedDerivedClass;
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wc++17-extensions"
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wreserved-identifier"
+// CHECK-NEXT:   typedef char $s5Class07DerivedbA0CD;
+// CHECK-NEXT:   static inline constexpr $s5Class07DerivedbA0CD __swift_mangled_name = 0;
+// CHECK-NEXT: #pragma clang diagnostic pop
+// CHECK-NEXT: #pragma clang diagnostic pop
 // CHECK-NEXT: };
 
 // Verify base class names are adjusted to avoid conflict with C++ keywords.
diff --git a/test/Interop/SwiftToCxx/generics/generic-struct-in-cxx.swift b/test/Interop/SwiftToCxx/generics/generic-struct-in-cxx.swift
@@ -231,6 +231,15 @@ public func inoutConcretePair(_ x: UInt16, _ y: inout GenericPair<UInt16, UInt16
 
 // CHECK: swift::_impl::OpaqueStorage _storage;
 // CHECK-NEXT: friend class _impl::_impl_GenericPair<T_0_0, T_0_1>;
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wc++17-extensions"
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wreserved-identifier"
+// CHECK-NEXT:  typedef char $s8Generics11GenericPairVyxq_GD;
+// CHECK-NEXT:  static inline constexpr $s8Generics11GenericPairVyxq_GD __swift_mangled_name = 0;
+// CHECK-NEXT: #pragma clang diagnostic pop
+// CHECK-NEXT: #pragma clang diagnostic pop
+
 // CHECK-NEXT: }
 
 // CHECK: template<class T_0_0, class T_0_1>
diff --git a/test/Interop/SwiftToCxx/generics/generic-struct-known-layout-direct-in-cxx.swift b/test/Interop/SwiftToCxx/generics/generic-struct-known-layout-direct-in-cxx.swift
@@ -85,6 +85,14 @@
 
 // CHECK: swift::_impl::OpaqueStorage _storage;
 // CHECK-NEXT: friend class _impl::_impl_GenericPair<T_0_0, T_0_1>;
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wc++17-extensions"
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wreserved-identifier"
+// CHECK-NEXT:  typedef char $s8Generics11GenericPairVyxq_GD;
+// CHECK-NEXT:  static inline constexpr $s8Generics11GenericPairVyxq_GD __swift_mangled_name = 0;
+// CHECK-NEXT: #pragma clang diagnostic pop
+// CHECK-NEXT: #pragma clang diagnostic pop
 // CHECK-NEXT: }
 
 // CHECK: SWIFT_INLINE_THUNK void inoutConcretePair(uint16_t x, GenericPair<uint16_t, uint16_t>& y) noexcept SWIFT_SYMBOL("s:8Generics17inoutConcretePairyys6UInt16V_AA07GenericD0VyA2DGztF") {
diff --git a/test/Interop/SwiftToCxx/structs/resilient-struct-in-cxx.swift b/test/Interop/SwiftToCxx/structs/resilient-struct-in-cxx.swift
@@ -62,6 +62,14 @@ public struct FirstSmallStruct {
 // CHECK-EMPTY:
 // CHECK-NEXT:  swift::_impl::OpaqueStorage _storage;
 // CHECK-NEXT:  friend class _impl::_impl_FirstSmallStruct;
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wc++17-extensions"
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wreserved-identifier"
+// CHECK-NEXT:  typedef char $s7Structs16FirstSmallStructVD;
+// CHECK-NEXT:  static inline constexpr $s7Structs16FirstSmallStructVD __swift_mangled_name = 0;
+// CHECK-NEXT: #pragma clang diagnostic pop
+// CHECK-NEXT: #pragma clang diagnostic pop
 // CHECK-NEXT:};
 
 // CHECK: class _impl_FirstSmallStruct {
@@ -100,6 +108,14 @@ public struct FirstSmallStruct {
 // CHECK: class SWIFT_SYMBOL("s:7Structs12FrozenStructV") FrozenStruct final {
 // CHECK:        alignas(4) char _storage[4];
 // CHECK-NEXT:   friend class _impl::_impl_FrozenStruct;
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wc++17-extensions"
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wreserved-identifier"
+// CHECK-NEXT:  typedef char $s7Structs12FrozenStructVD;
+// CHECK-NEXT:  static inline constexpr $s7Structs12FrozenStructVD __swift_mangled_name = 0;
+// CHECK-NEXT: #pragma clang diagnostic pop
+// CHECK-NEXT: #pragma clang diagnostic pop
 // CHECK-NEXT: };
 
 public struct LargeStruct {
@@ -145,6 +161,14 @@ public struct LargeStruct {
 // CHECK-EMPTY:
 // CHECK-NEXT:  swift::_impl::OpaqueStorage _storage;
 // CHECK-NEXT:  friend class _impl::_impl_LargeStruct;
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wc++17-extensions"
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wreserved-identifier"
+// CHECK-NEXT:  typedef char $s7Structs11LargeStructVD;
+// CHECK-NEXT:  static inline constexpr $s7Structs11LargeStructVD __swift_mangled_name = 0;
+// CHECK-NEXT: #pragma clang diagnostic pop
+// CHECK-NEXT: #pragma clang diagnostic pop
 // CHECK-NEXT: };
 
 private class RefCountedClass {
diff --git a/test/Interop/SwiftToCxx/structs/small-structs-pass-return-direct-in-cxx.swift b/test/Interop/SwiftToCxx/structs/small-structs-pass-return-direct-in-cxx.swift
@@ -52,6 +52,14 @@ public func printStructOneI64_resilient(_ x : StructOneI64_resilient) {
 // RESILIENT:       class SWIFT_SYMBOL({{.*}}) StructOneI64_resilient final {
 // RESILIENT:         swift::_impl::OpaqueStorage _storage;
 // RESILIENT-NEXT:    friend class _impl::_impl_StructOneI64_resilient;
+// RESILIENT-NEXT: #pragma clang diagnostic push
+// RESILIENT-NEXT: #pragma clang diagnostic ignored "-Wc++17-extensions"
+// RESILIENT-NEXT: #pragma clang diagnostic push
+// RESILIENT-NEXT: #pragma clang diagnostic ignored "-Wreserved-identifier"
+// RESILIENT-NEXT:  typedef char $s7Structs22StructOneI64_resilientVD;
+// RESILIENT-NEXT:  static inline constexpr $s7Structs22StructOneI64_resilientVD __swift_mangled_name = 0;
+// RESILIENT-NEXT: #pragma clang diagnostic pop
+// RESILIENT-NEXT: #pragma clang diagnostic pop
 // RESILIENT-NEXT:  };
 #endif
 
diff --git a/test/Interop/SwiftToCxx/structs/swift-struct-in-cxx.swift b/test/Interop/SwiftToCxx/structs/swift-struct-in-cxx.swift
@@ -47,6 +47,14 @@
 // CHECK-EMPTY:
 // CHECK-NEXT:   alignas(8) char _storage[8];
 // CHECK-NEXT:   friend class _impl::_impl_StructWithIntField;
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wc++17-extensions"
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wreserved-identifier"
+// CHECK-NEXT:  typedef char $s7Structs18StructWithIntFieldVD;
+// CHECK-NEXT:  static inline constexpr $s7Structs18StructWithIntFieldVD __swift_mangled_name = 0;
+// CHECK-NEXT: #pragma clang diagnostic pop
+// CHECK-NEXT: #pragma clang diagnostic pop
 // CHECK-NEXT: };
 
 // CHECK:      namespace _impl {
@@ -105,6 +113,14 @@ public struct StructWithIntField {
 // CHECK: class SWIFT_SYMBOL({{.*}}) register_ final {
 // CHECK: alignas(8) char _storage[16];
 // CHECK-NEXT:   friend class
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wc++17-extensions"
+// CHECK-NEXT: #pragma clang diagnostic push
+// CHECK-NEXT: #pragma clang diagnostic ignored "-Wreserved-identifier"
+// CHECK-NEXT:   typedef char $s7Structs8registerVD;
+// CHECK-NEXT:   static inline constexpr $s7Structs8registerVD __swift_mangled_name = 0;
+// CHECK-NEXT: #pragma clang diagnostic pop
+// CHECK-NEXT: #pragma clang diagnostic pop
 // CHECK-NEXT: };
 public struct register {
   let field1: Int64
