Comment and sourcekitd-test fixes

DavidGoldman · DavidGoldman · commit 1c819820fa59 · 2019-05-21T10:40:22.000-04:00
diff --git a/test/SourceKit/CompileNotifications/cursor-info.swift b/test/SourceKit/CompileNotifications/cursor-info.swift
@@ -8,6 +8,6 @@
 // COMPILE_1:   key.notification: source.notification.compile-did-finish,
 // COMPILE_1:   key.compileid: [[CID1]]
 // COMPILE_1: }
-// COMPILE_1: <diagnostic "Unable to resolve cursor info.">
+// COMPILE_1: <empty cursor info; internal diagnostic: "Unable to resolve cursor info.">
 // COMPILE_1-NOT: compile-will-start
 // COMPILE_1-NOT: compile-did-finish
diff --git a/test/SourceKit/CursorInfo/cursor_getter.swift b/test/SourceKit/CursorInfo/cursor_getter.swift
@@ -21,4 +21,4 @@ struct S1 {
 // RUN: %sourcekitd-test -req=cursor -pos=3:41 %s -- %s | %FileCheck %s
 // RUN: %sourcekitd-test -req=cursor -pos=6:29 %s -- %s | %FileCheck %s
 // RUN: %sourcekitd-test -req=cursor -pos=6:31 %s -- %s | %FileCheck %s
-// CHECK: <diagnostic "Unable to resolve cursor info.">
+// CHECK: <empty cursor info; internal diagnostic: "Unable to resolve cursor info.">
diff --git a/test/SourceKit/CursorInfo/cursor_info.swift b/test/SourceKit/CursorInfo/cursor_info.swift
@@ -379,17 +379,17 @@ enum E7: String {
 // CHECK22: <decl.function.method.instance><syntaxtype.keyword>func</syntaxtype.keyword> <decl.name>availabilityIntroduced</decl.name>()</decl.function.method.instance>
 
 // RUN: %sourcekitd-test -req=cursor -pos=56:15 %s -- -F %S/../Inputs/libIDE-mock-sdk -I %t.tmp %mcp_opt %s | %FileCheck -check-prefix=CHECK23 %s
-// CHECK23: <diagnostic "Unavailable in the current compilation context.">
+// CHECK23: <empty cursor info; internal diagnostic: "Unavailable in the current compilation context.">
 
 // RUN: %sourcekitd-test -req=cursor -pos=57:15 %s -- -F %S/../Inputs/libIDE-mock-sdk -I %t.tmp %mcp_opt %s | %FileCheck -check-prefix=CHECK24 %s
-// CHECK24: <diagnostic "Unavailable in the current compilation context.">
+// CHECK24: <empty cursor info; internal diagnostic: "Unavailable in the current compilation context.">
 
 // RUN: %sourcekitd-test -req=cursor -pos=58:15 %s -- -F %S/../Inputs/libIDE-mock-sdk -I %t.tmp %mcp_opt %s | %FileCheck -check-prefix=CHECK25 %s
 // CHECK25: <Declaration>func availabilityIntroducedMsg()</Declaration>
 // CHECK25: <decl.function.method.instance><syntaxtype.keyword>func</syntaxtype.keyword> <decl.name>availabilityIntroducedMsg</decl.name>()</decl.function.method.instance>
 
 // RUN: %sourcekitd-test -req=cursor -pos=59:15 %s -- -F %S/../Inputs/libIDE-mock-sdk -I %t.tmp %mcp_opt %s | %FileCheck -check-prefix=CHECK26 %s
-// CHECK26: <diagnostic "Unavailable in the current compilation context.">
+// CHECK26: <empty cursor info; internal diagnostic: "Unavailable in the current compilation context.">
 
 // RUN: %sourcekitd-test -req=cursor -pos=69:14 %s -- -F %S/../Inputs/libIDE-mock-sdk -I %t.tmp %mcp_opt %s | %FileCheck -check-prefix=CHECK27 %s
 // CHECK27: <Declaration>public subscript(i: <Type usr="s:Si">Int</Type>) -&gt; <Type usr="s:Si">Int</Type> { get }</Declaration>
diff --git a/test/SourceKit/CursorInfo/cursor_invalid.swift b/test/SourceKit/CursorInfo/cursor_invalid.swift
@@ -46,7 +46,7 @@ func resyncParser2() {}
 
 // RUN: %sourcekitd-test -req=cursor -pos=7:12 %s -- %s | %FileCheck -check-prefix=DIAG %s
 // RUN: %sourcekitd-test -req=cursor -pos=9:7 %s -- %s | %FileCheck -check-prefix=DIAG %s
-// DIAG: <diagnostic "Unable to resolve cursor info.">
+// DIAG: <empty cursor info; internal diagnostic: "Unable to resolve cursor info.">
 
 // RUN: %sourcekitd-test -req=cursor -pos=18:6 %s -- %s | %FileCheck -check-prefix=EQEQ1 %s
 // RUN: %sourcekitd-test -req=cursor -pos=19:6 %s -- %s | %FileCheck -check-prefix=EQEQ1 %s
diff --git a/test/SourceKit/CursorInfo/cursor_unavailable.swift b/test/SourceKit/CursorInfo/cursor_unavailable.swift
@@ -5,4 +5,4 @@ find([1,2,3],1)
 // RUN: %sourcekitd-test -req=cursor -pos=2:1 %s -- %s | %FileCheck -check-prefix=CHECK2 %s
 
 // CHECK1: source.lang.swift.ref.function.free
-// CHECK2: <diagnostic "Resolved to incomplete expression or statement.">
+// CHECK2: <empty cursor info; internal diagnostic: "Resolved to incomplete expression or statement.">
diff --git a/test/SourceKit/CursorInfo/cursor_usr.swift b/test/SourceKit/CursorInfo/cursor_usr.swift
@@ -28,11 +28,11 @@ func foo(x: FooStruct1) -> S1 {}
 // RUN: %sourcekitd-test -req=cursor -usr "s:blahblahblah" %s -- -I %t -F %S/../Inputs/libIDE-mock-sdk %mcp_opt %s | %FileCheck %s -check-prefix=RESOLVE
 // Missing s: prefix.
 // RUN: %sourcekitd-test -req=cursor -usr "10cursor_usr6globalSivp" %s -- -I %t -F %S/../Inputs/libIDE-mock-sdk %mcp_opt %s | %FileCheck %s -check-prefix=RESOLVE
-// RESOLVE: <diagnostic "Unable to resolve type from USR.">
+// RESOLVE: <empty cursor info; internal diagnostic: "Unable to resolve type from USR.">
 
 // FIXME: no support for clang USRs.
 // RUN: %sourcekitd-test -req=cursor -usr "c:@S@FooStruct1" %s -- -I %t -F %S/../Inputs/libIDE-mock-sdk %mcp_opt %s | %FileCheck %s -check-prefix=CSUPPORT
-// CSUPPORT: <diagnostic "Lookup for C/C++/ObjC USRs not implemented.">
+// CSUPPORT: <empty cursor info; internal diagnostic: "Lookup for C/C++/ObjC USRs not implemented.">
 
 // RUN: %sourcekitd-test -req=cursor -usr "s:10cursor_usr2S1V" %s -- -I %t -F %S/../Inputs/libIDE-mock-sdk %mcp_opt %s | %FileCheck %s -check-prefix=CHECK1
 // CHECK1: source.lang.swift.decl.struct (5:8-5:10)
diff --git a/test/SourceKit/CursorInfo/ignore-llvm-args.swift b/test/SourceKit/CursorInfo/ignore-llvm-args.swift
@@ -3,4 +3,4 @@ _ = ""
 // rdar://problem/38314383
 // RUN: %sourcekitd-test -req=cursor -offset=0 %s -- -Xllvm -aarch64-use-tbi %s | %FileCheck %s
 
-// CHECK: <diagnostic "Resolved to incomplete expression or statement.">
+// CHECK: <empty cursor info; internal diagnostic: "Resolved to incomplete expression or statement.">
diff --git a/test/SourceKit/CursorInfo/rdar_18677108-1.swift b/test/SourceKit/CursorInfo/rdar_18677108-1.swift
@@ -1,6 +1,6 @@
 // Checks that we don't crash.
 // RUN: %sourcekitd-test -req=cursor -pos=7:5 %s -- %s | %FileCheck %s
-// CHECK: <diagnostic "Unable to resolve cursor info.">
+// CHECK: <empty cursor info; internal diagnostic: "Unable to resolve cursor info.">
 
 class CameraViewController
 {
diff --git a/test/SourceKit/NameTranslation/basic.swift b/test/SourceKit/NameTranslation/basic.swift
@@ -56,7 +56,7 @@ class MyDerived: FooClassDerived {
 // RUN: %sourcekitd-test -req=translate -objc-selector fooInstanceFunc01 -pos=23:10 %s -- -F %S/../Inputs/libIDE-mock-sdk -I %t.tmp %mcp_opt %s | %FileCheck -check-prefix=CHECK5 %s
 
 // CHECK1: FooClassDerived2
-// CHECK-DIAG: <diagnostic "Unable to resolve ObjC declaration name.">
+// CHECK-DIAG: <empty name translation info; internal diagnostic: "Unable to resolve ObjC declaration name.">
 // CHECK2: fooProperty2
 // CHECK3: fooInstanceFunc1
 // CHECK4: fooBaseInstanceFuncOverridden1
diff --git a/test/SourceKit/NameTranslation/enum.swift b/test/SourceKit/NameTranslation/enum.swift
@@ -17,6 +17,6 @@ func foo1() {
 // RUN: %sourcekitd-test -req=translate -objc-name FooRinEnableThird -pos=7:30 %s -- -F %S/Inputs/mock-sdk -I %t.tmp %mcp_opt %s | %FileCheck -check-prefix=CHECK3 %s
 
 // CHECK1: orderedSome
-// CHECK-DIAG: <diagnostic "Unable to resolve ObjC declaration name.">
+// CHECK-DIAG: <empty name translation info; internal diagnostic: "Unable to resolve ObjC declaration name.">
 // CHECK2: enableThird
 // CHECK3: inEnableThird
diff --git a/test/SourceKit/NameTranslation/init.swift b/test/SourceKit/NameTranslation/init.swift
@@ -12,6 +12,6 @@ func foo2 () {
 // RUN: %sourcekitd-test -req=translate -objc-selector initWithFloat2:second2:third: -pos=5:15 %s -- -F %S/Inputs/mock-sdk -I %t.tmp %mcp_opt %s | %FileCheck -check-prefix=CHECK-DIAG %s
 // RUN: %sourcekitd-test -req=translate -objc-selector initFloat2:second2: -pos=5:15 %s -- -F %S/Inputs/mock-sdk -I %t.tmp %mcp_opt %s | %FileCheck -check-prefix=CHECK2 %s
 
-// CHECK-DIAG: <diagnostic "Unable to resolve ObjC declaration name.">
+// CHECK-DIAG: <empty name translation info; internal diagnostic: "Unable to resolve ObjC declaration name.">
 // CHECK1: init(float2:)
 // CHECK2: init(float2:second2:)
diff --git a/test/SourceKit/NameTranslation/swiftnames.swift b/test/SourceKit/NameTranslation/swiftnames.swift
@@ -86,7 +86,7 @@ class C3: NSObject {
 // RUN: %sourcekitd-test -req=translate -swift-name "zoo(m:)" -pos=55:14 %s -- -F %S/Inputs/mock-sdk -I %t.tmp %mcp_opt %s | %FileCheck -check-prefix=CHECK17 %s
 // RUN: %sourcekitd-test -req=translate -swift-name "zoo(m:)" -pos=55:14 %s -print-raw-response -- -F %S/Inputs/mock-sdk -I %t.tmp %mcp_opt %s | %FileCheck -check-prefix=CHECK_RAW17 %s
 
-// CHECK-DIAG: <diagnostic "Unable to resolve Swift declaration name.">
+// CHECK-DIAG: <empty name translation info; internal diagnostic: "Unable to resolve Swift declaration name.">
 // CHECK1: fooWithA:b:c:
 // CHECK2: fooWithA1:b1:c1:
 // CHECK3: foo:b1:c1:
diff --git a/tools/SourceKit/include/SourceKit/Core/LangSupport.h b/tools/SourceKit/include/SourceKit/Core/LangSupport.h
@@ -302,13 +302,17 @@ class OptionsDictionary {
 struct Statistic;
 typedef std::function<void(ArrayRef<Statistic *> stats)> StatisticsReceiver;
 
-// Used to wrap the result of a request. There are three possibilities:
-// - The request succeeded (`value` is valid)
-// - The request was cancelled
-// - The request failed (with an `error`)
+/// Used to wrap the result of a request. There are three possibilities:
+/// - The request succeeded (`value` is valid)
+/// - The request was cancelled
+/// - The request failed (with an `error`)
+///
+/// NOTE: This type does not own its `value` or `error`. Therefore, it's not
+/// safe to store this type, nor is it safe to store its `value` or `error`.
+/// Instead, any needed information should be fetched and stored (e.g. reading
+/// properties from `value` or getting a `std::string` from `error`).
 template <typename T>
 class RequestResult {
-private:
   enum Type {
     Value,
     Error,
diff --git a/tools/SourceKit/tools/sourcekitd-test/sourcekitd-test.cpp b/tools/SourceKit/tools/sourcekitd-test/sourcekitd-test.cpp
@@ -1306,7 +1306,8 @@ static void printNameTranslationInfo(sourcekitd_variant_t Info,
   const char *InternalDiagnostic =
       sourcekitd_variant_dictionary_get_string(Info, KeyInternalDiagnostic);
   if (InternalDiagnostic) {
-    OS << "<diagnostic \"" << InternalDiagnostic << "\">\n";
+    OS << "<empty name translation info; internal diagnostic: \""
+       << InternalDiagnostic << "\">\n";
     return;
   }
   sourcekitd_uid_t KindUID = sourcekitd_variant_dictionary_get_uid(Info,
@@ -1371,7 +1372,8 @@ static void printCursorInfo(sourcekitd_variant_t Info, StringRef FilenameIn,
   const char *InternalDiagnostic =
       sourcekitd_variant_dictionary_get_string(Info, KeyInternalDiagnostic);
   if (InternalDiagnostic) {
-    OS << "<diagnostic \"" << InternalDiagnostic << "\">\n";
+    OS << "<empty cursor info; internal diagnostic: \""
+       << InternalDiagnostic << "\">\n";
     return;
   }
   sourcekitd_uid_t KindUID = sourcekitd_variant_dictionary_get_uid(Info,

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`// Checks that we don't crash.`
`2`	`2`	`// RUN: %sourcekitd-test -req=cursor -pos=7:5 %s -- %s \| %FileCheck %s`
`3`		`-// CHECK: <diagnostic "Unable to resolve cursor info.">`
	`3`	`+// CHECK: <empty cursor info; internal diagnostic: "Unable to resolve cursor info.">`
`4`	`4`
`5`	`5`	`class CameraViewController`
`6`	`6`	`{`