[SourceKit] Add print and dump methods for cursor info results

We will be using the string serialized results to verify that solver-based cursor info results match the old implementation. This is necessary because cursor info results on their own contain stack references that cannot be stored.

Author: ahoppen

tools/SourceKit/include/SourceKit/Core/LangSupport.h

@@ -386,6 +386,15 @@ struct RefactoringInfo {
 
   RefactoringInfo(UIdent Kind, StringRef KindName, StringRef UnavailableReason)
       : Kind(Kind), KindName(KindName), UnavailableReason(UnavailableReason) {}
+
+  void print(llvm::raw_ostream &OS, std::string Indentation) const {
+    OS << Indentation << "RefactoringInfo" << '\n';
+    OS << Indentation << "  Kind: " << Kind.getName() << '\n';
+    OS << Indentation << "  KindName: " << KindName << '\n';
+    OS << Indentation << "  UnavailableReason: " << UnavailableReason << '\n';
+  }
+
+  SWIFT_DEBUG_DUMP { print(llvm::errs(), ""); }
 };
 
 struct ParentInfo {
@@ -395,6 +404,15 @@ struct ParentInfo {
 
   ParentInfo(StringRef Title, StringRef KindName, StringRef USR)
       : Title(Title), KindName(KindName), USR(USR) {}
+
+  void print(llvm::raw_ostream &OS, std::string Indentation) const {
+    OS << Indentation << "ParentInfo" << '\n';
+    OS << Indentation << "  Title: " << Title << '\n';
+    OS << Indentation << "  KindName: " << KindName << '\n';
+    OS << Indentation << "  USR: " << USR << '\n';
+  }
+
+  SWIFT_DEBUG_DUMP { print(llvm::errs(), ""); }
 };
 
 struct ReferencedDeclInfo {
@@ -413,6 +431,24 @@ struct ReferencedDeclInfo {
       : USR(USR), DeclarationLang(DeclLang), AccessLevel(AccessLevel),
         FilePath(FilePath), ModuleName(ModuleName), IsSystem(System),
         IsSPI(SPI), ParentContexts(Parents) {}
+
+  void print(llvm::raw_ostream &OS, std::string Indentation) const {
+    OS << Indentation << "ReferencedDeclInfo" << '\n';
+    OS << Indentation << "  USR: " << USR << '\n';
+    OS << Indentation << "  DeclarationLang: " << DeclarationLang.getName()
+       << '\n';
+    OS << Indentation << "  AccessLevel: " << AccessLevel << '\n';
+    OS << Indentation << "  FilePath: " << FilePath << '\n';
+    OS << Indentation << "  ModuleName: " << ModuleName << '\n';
+    OS << Indentation << "  IsSystem: " << IsSystem << '\n';
+    OS << Indentation << "  IsSPI: " << IsSPI << '\n';
+    OS << Indentation << "  ParentContexts:" << '\n';
+    for (auto ParentCtx : ParentContexts) {
+      ParentCtx.print(OS, Indentation + "   ");
+    }
+  }
+
+  SWIFT_DEBUG_DUMP { print(llvm::errs(), ""); }
 };
 
 struct LocationInfo {
@@ -421,6 +457,17 @@ struct LocationInfo {
   unsigned Length = 0;
   unsigned Line = 0;
   unsigned Column = 0;
+
+  void print(llvm::raw_ostream &OS, std::string Indentation) const {
+    OS << Indentation << "LocationInfo" << '\n';
+    OS << Indentation << "  Filename: " << Filename << '\n';
+    OS << Indentation << "  Offset: " << Offset << '\n';
+    OS << Indentation << "  Length: " << Length << '\n';
+    OS << Indentation << "  Line: " << Line << '\n';
+    OS << Indentation << "  Column: " << Column << '\n';
+  }
+
+  SWIFT_DEBUG_DUMP { print(llvm::errs(), ""); }
 };
 
 struct CursorSymbolInfo {
@@ -470,6 +517,60 @@ struct CursorSymbolInfo {
   bool IsSynthesized = false;
 
   llvm::Optional<unsigned> ParentNameOffset;
+
+  void print(llvm::raw_ostream &OS, std::string Indentation) const {
+    OS << Indentation << "CursorSymbolInfo" << '\n';
+    OS << Indentation << "  Kind: " << Kind.getName() << '\n';
+    OS << Indentation << "  DeclarationLang: " << DeclarationLang.getName()
+       << '\n';
+    OS << Indentation << "  Name: " << Name << '\n';
+    OS << Indentation << "  USR: " << USR << '\n';
+    OS << Indentation << "  TypeName: " << TypeName << '\n';
+    OS << Indentation << "  TypeUSR: " << TypeUSR << '\n';
+    OS << Indentation << "  ContainerTypeUSR: " << ContainerTypeUSR << '\n';
+    OS << Indentation << "  DocComment: " << DocComment << '\n';
+    OS << Indentation << "  GroupName: " << GroupName << '\n';
+    OS << Indentation << "  LocalizationKey: " << LocalizationKey << '\n';
+    OS << Indentation << "  AnnotatedDeclaration: " << AnnotatedDeclaration
+       << '\n';
+    OS << Indentation
+       << "  FullyAnnotatedDeclaration: " << FullyAnnotatedDeclaration << '\n';
+    OS << Indentation << "  SymbolGraph: " << SymbolGraph << '\n';
+    OS << Indentation << "  ModuleName: " << ModuleName << '\n';
+    OS << Indentation << "  ModuleInterfaceName: " << ModuleInterfaceName
+       << '\n';
+    Location.print(OS, Indentation + "  ");
+    OS << Indentation << "  OverrideUSRs:" << '\n';
+    for (auto OverrideUSR : OverrideUSRs) {
+      OS << Indentation << "    " << OverrideUSR << '\n';
+    }
+    OS << Indentation << "  AnnotatedRelatedDeclarations:" << '\n';
+    for (auto AnnotatedRelatedDeclaration : AnnotatedRelatedDeclarations) {
+      OS << Indentation << "    " << AnnotatedRelatedDeclaration << '\n';
+    }
+    OS << Indentation << "  ModuleGroupArray:" << '\n';
+    for (auto ModuleGroup : ModuleGroupArray) {
+      OS << Indentation << "    " << ModuleGroup << '\n';
+    }
+    OS << Indentation << "  ParentContexts:" << '\n';
+    for (auto ParentContext : ParentContexts) {
+      ParentContext.print(OS, Indentation + "    ");
+    }
+    OS << Indentation << "ReferencedSymbols:" << '\n';
+    for (auto ReferencedSymbol : ReferencedSymbols) {
+      ReferencedSymbol.print(OS, Indentation + "    ");
+    }
+    OS << Indentation << "ReceiverUSRs:" << '\n';
+    for (auto ReceiverUSR : ReceiverUSRs) {
+      OS << Indentation << "    " << ReceiverUSR << '\n';
+    }
+    OS << Indentation << "IsSystem: " << IsSystem << '\n';
+    OS << Indentation << "IsDynamic: " << IsDynamic << '\n';
+    OS << Indentation << "IsSynthesized: " << IsSynthesized << '\n';
+    OS << Indentation << "ParentNameOffset: " << ParentNameOffset << '\n';
+  }
+
+  SWIFT_DEBUG_DUMP { print(llvm::errs(), ""); }
 };
 
 struct CursorInfoData {
@@ -480,6 +581,20 @@ struct CursorInfoData {
   llvm::ArrayRef<CursorSymbolInfo> Symbols;
   /// All available actions on the code under cursor.
   llvm::ArrayRef<RefactoringInfo> AvailableActions;
+
+  void print(llvm::raw_ostream &OS, std::string Indentation) const {
+    OS << Indentation << "CursorInfoData" << '\n';
+    OS << Indentation << "  Symbols:" << '\n';
+    for (auto Symbol : Symbols) {
+      Symbol.print(OS, Indentation + "    ");
+    }
+    OS << Indentation << "  AvailableActions:" << '\n';
+    for (auto AvailableAction : AvailableActions) {
+      AvailableAction.print(OS, Indentation + "    ");
+    }
+  }
+
+  SWIFT_DEBUG_DUMP { print(llvm::errs(), ""); }
 };
 
 /// The result type of `LangSupport::getDiagnostics`