Merge pull request #6898 from apple/dl/lldb-improve-getobjectdescription-for-variables

[lldb] Improve GetObjectDescription for Swift variables

Author: adrian-prantl

lldb/source/Plugins/LanguageRuntime/Swift/SwiftLanguageRuntime.cpp

@@ -24,8 +24,10 @@
 #include "lldb/Core/PluginManager.h"
 #include "lldb/Core/Progress.h"
 #include "lldb/Core/Section.h"
+#include "lldb/Core/ValueObject.h"
 #include "lldb/Core/ValueObjectCast.h"
 #include "lldb/Core/ValueObjectConstResult.h"
+#include "lldb/Core/ValueObjectVariable.h"
 #include "lldb/DataFormatters/StringPrinter.h"
 #include "lldb/Host/OptionParser.h"
 #include "lldb/Interpreter/CommandInterpreter.h"
@@ -1110,6 +1112,13 @@ SwiftLanguageRuntimeImpl::RunObjectDescriptionExpr(ValueObject &object,
   }
 }
 
+static bool IsVariable(ValueObject &object) {
+  if (object.IsSynthetic())
+    return IsVariable(*object.GetNonSyntheticValue());
+
+  return bool(object.GetVariable());
+}
+
 static bool IsSwiftResultVariable(ConstString name) {
   if (name) {
     llvm::StringRef name_sr(name.GetStringRef());
@@ -1140,10 +1149,9 @@ bool SwiftLanguageRuntimeImpl::GetObjectDescription(Stream &str,
   }
 
   std::string expr_string;
-  
-  if (::IsSwiftResultVariable(object.GetName())) {
-    // if this thing is a Swift expression result variable, it has two
-    // properties:
+
+  if (::IsVariable(object) || ::IsSwiftResultVariable(object.GetName())) {
+    // if the object is a Swift variable, it has two properties:
     // a) its name is something we can refer to in expressions for free
     // b) its type may be something we can't actually talk about in expressions
     // so, just use the result variable's name in the expression and be done

lldb/test/API/lang/swift/cf/uuid/Makefile

@@ -0,0 +1,3 @@
+SWIFT_SOURCES := main.swift
+
+include Makefile.rules

lldb/test/API/lang/swift/cf/uuid/TestCFUUID.py

@@ -0,0 +1,23 @@
+"""
+Test CFUUID object description.
+"""
+
+import lldb
+from lldbsuite.test.lldbtest import *
+from lldbsuite.test.decorators import *
+import lldbsuite.test.lldbutil as lldbutil
+
+
+class TestCase(TestBase):
+    @swiftTest
+    @skipUnlessFoundation
+    def test(self):
+        """Test CFUUID object description prints the UUID string."""
+        self.build()
+        lldbutil.run_to_source_breakpoint(self, "break here", lldb.SBFileSpec("main.swift"))
+        # Swift type validation fails in IsPossibleDynamicType rdar://109611675
+        self.runCmd("settings set symbols.swift-validate-typesystem false")
+        uuid = "68753A44-4D6F-1226-9C60-0050E4C00067"
+        self.expect("frame variable -O uuid", substrs=[uuid])
+        self.expect("dwim-print -O -- uuid", substrs=[uuid])
+        self.expect("expression -O -- uuid", substrs=[uuid])

lldb/test/API/lang/swift/cf/uuid/main.swift

@@ -0,0 +1,9 @@
+import CoreFoundation
+import Foundation // Needed for `as CFString` cast
+
+func main() {
+    let uuid = CFUUIDCreateFromString(nil, "68753A44-4D6F-1226-9C60-0050E4C00067" as CFString)
+    print("break here")
+}
+
+main()