[SourceKit/CursorInfo] Include line and column in result

Add line/column in addition to offset so clients need not map it
themselves.

Author: bnbarham

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

@@ -405,6 +405,14 @@ struct ReferencedDeclInfo {
         IsSPI(SPI), ParentContexts(Parents) {}
 };
 
+struct LocationInfo {
+  StringRef Filename;
+  unsigned Offset = 0;
+  unsigned Length = 0;
+  unsigned Line = 0;
+  unsigned Column = 0;
+};
+
 struct CursorSymbolInfo {
   UIdent Kind;
   UIdent DeclarationLang;
@@ -430,11 +438,8 @@ struct CursorSymbolInfo {
   /// Non-empty if a generated interface editor document has previously been
   /// opened for the module the symbol came from.
   StringRef ModuleInterfaceName;
-  /// This is an (offset,length) pair. It is set only if the declaration has a
-  /// source location.
-  llvm::Optional<std::pair<unsigned, unsigned>> DeclarationLoc = None;
-  /// Set only if the declaration has a source location.
-  StringRef Filename;
+  /// Filename is non-empty if there's a source location.
+  LocationInfo Location;
   /// For methods this lists the USRs of the overrides in the class hierarchy.
   ArrayRef<StringRef> OverrideUSRs;
   /// Related declarations, overloaded functions etc., in annotated XML form.

tools/SourceKit/lib/SwiftLang/SwiftEditor.cpp

@@ -2295,6 +2295,17 @@ ImmutableTextSnapshotRef SwiftEditorDocument::getLatestSnapshot() const {
   return Impl.EditableBuffer->getSnapshot();
 }
 
+std::pair<unsigned, unsigned>
+SwiftEditorDocument::getLineAndColumnInBuffer(unsigned Offset) {
+  llvm::sys::ScopedLock L(Impl.AccessMtx);
+
+  auto SyntaxInfo = Impl.getSyntaxInfo();
+  auto &SM = SyntaxInfo->getSourceManager();
+
+  auto Loc = SM.getLocForOffset(SyntaxInfo->getBufferID(), Offset);
+  return SM.getLineAndColumnInBuffer(Loc);
+}
+
 void SwiftEditorDocument::reportDocumentStructure(SourceFile &SrcFile,
                                                   EditorConsumer &Consumer) {
   ide::SyntaxModelContext ModelContext(SrcFile);

tools/SourceKit/lib/SwiftLang/SwiftLangSupport.h

@@ -105,6 +105,7 @@ class SwiftEditorDocument :
   void removeCachedAST();
 
   ImmutableTextSnapshotRef getLatestSnapshot() const;
+  std::pair<unsigned, unsigned> getLineAndColumnInBuffer(unsigned Offset);
 
   void parse(ImmutableTextSnapshotRef Snapshot, SwiftLangSupport &Lang,
              bool BuildSyntaxTree,

tools/SourceKit/lib/SwiftLang/SwiftSourceDocInfo.cpp

@@ -600,38 +600,46 @@ mapOffsetToNewerSnapshot(unsigned Offset,
   return None;
 }
 
-/// Tries to remap the location from a previous snapshot to the latest one.
-static llvm::Optional<std::pair<unsigned, unsigned>>
-tryRemappingLocToLatestSnapshot(SwiftLangSupport &Lang,
-                                std::pair<unsigned, unsigned> Range,
-                                StringRef Filename,
-                         ArrayRef<ImmutableTextSnapshotRef> PreviousASTSnaps) {
-  ImmutableTextSnapshotRef LatestSnap;
-  if (auto EditorDoc = Lang.getEditorDocuments()->findByPath(Filename))
-    LatestSnap = EditorDoc->getLatestSnapshot();
+/// Tries to remap the location from a previous snapshot to the latest one and
+/// then sets the location's line and column.
+static void mapLocToLatestSnapshot(
+    SwiftLangSupport &Lang, LocationInfo &Location,
+    ArrayRef<ImmutableTextSnapshotRef> PreviousASTSnaps) {
+  auto EditorDoc = Lang.getEditorDocuments()->findByPath(Location.Filename);
+  if (!EditorDoc)
+    return;
+
+  ImmutableTextSnapshotRef LatestSnap = EditorDoc->getLatestSnapshot();
   if (!LatestSnap)
-    return Range;
+    return;
 
   for (auto &PrevSnap : PreviousASTSnaps) {
     if (PrevSnap->isFromSameBuffer(LatestSnap)) {
       if (PrevSnap->getStamp() == LatestSnap->getStamp())
-        return Range;
+        break;
 
-      auto OptBegin = mapOffsetToNewerSnapshot(Range.first,
+      auto OptBegin = mapOffsetToNewerSnapshot(Location.Offset,
                                                PrevSnap, LatestSnap);
-      if (!OptBegin.hasValue())
-        return None;
+      if (!OptBegin.hasValue()) {
+        Location.Filename = StringRef();
+        return;
+      }
 
-      auto OptEnd = mapOffsetToNewerSnapshot(Range.first+Range.second,
+      auto OptEnd = mapOffsetToNewerSnapshot(Location.Offset +
+                                             Location.Length,
                                              PrevSnap, LatestSnap);
-      if (!OptEnd.hasValue())
-        return None;
+      if (!OptEnd.hasValue()) {
+        Location.Filename = StringRef();
+        return;
+      }
 
-      return std::make_pair(*OptBegin, *OptEnd-*OptBegin);
+      Location.Offset = *OptBegin;
+      Location.Length = *OptEnd - *OptBegin;
     }
   }
 
-  return Range;
+  std::tie(Location.Line, Location.Column) =
+      EditorDoc->getLineAndColumnInBuffer(Location.Offset);
 }
 
 
@@ -802,10 +810,9 @@ static ArrayRef<T> copyAndClearArray(llvm::BumpPtrAllocator &Allocator,
   return Ref;
 }
 
-static void getLocationInfoForClangNode(
-    ClangNode ClangNode, ClangImporter *Importer,
-    llvm::Optional<std::pair<unsigned, unsigned>> &DeclarationLoc,
-    StringRef &Filename) {
+static void setLocationInfoForClangNode(ClangNode ClangNode,
+                                        ClangImporter *Importer,
+                                        LocationInfo &Location) {
   clang::ASTContext &ClangCtx = Importer->getClangASTContext();
   clang::SourceManager &ClangSM = ClangCtx.getSourceManager();
 
@@ -826,12 +833,15 @@ static void getLocationInfoForClangNode(
       ClangSM.getDecomposedLoc(CharRange.getBegin());
   if (!Decomp.first.isInvalid()) {
     if (auto FE = ClangSM.getFileEntryForID(Decomp.first)) {
-      Filename = FE->getName();
+      Location.Filename = FE->getName();
 
       std::pair<clang::FileID, unsigned> EndDecomp =
           ClangSM.getDecomposedLoc(CharRange.getEnd());
 
-      DeclarationLoc = {Decomp.second, EndDecomp.second - Decomp.second};
+      Location.Offset = Decomp.second;
+      Location.Length = EndDecomp.second-Decomp.second;
+      Location.Line = ClangSM.getLineNumber(Decomp.first, Decomp.second);
+      Location.Column = ClangSM.getColumnNumber(Decomp.first, Decomp.second);
     }
   }
 }
@@ -841,10 +851,8 @@ static unsigned getCharLength(SourceManager &SM, SourceRange TokenRange) {
   return SM.getByteDistance(TokenRange.Start, CharEndLoc);
 }
 
-static void
-getLocationInfo(const ValueDecl *VD,
-                llvm::Optional<std::pair<unsigned, unsigned>> &DeclarationLoc,
-                StringRef &Filename) {
+static void setLocationInfo(const ValueDecl *VD,
+                            LocationInfo &Location) {
   ASTContext &Ctx = VD->getASTContext();
   SourceManager &SM = Ctx.SourceMgr;
 
@@ -870,14 +878,15 @@ getLocationInfo(const ValueDecl *VD,
     }
 
     unsigned DeclBufID = SM.findBufferContainingLoc(Loc);
-    DeclarationLoc = {SM.getLocOffsetInBuffer(Loc, DeclBufID),
-                      NameLen};
-    Filename = SM.getIdentifierForBuffer(DeclBufID);
+    Location.Filename = SM.getIdentifierForBuffer(DeclBufID);
+    Location.Offset = SM.getLocOffsetInBuffer(Loc, DeclBufID);
+    Location.Length = NameLen;
+    std::tie(Location.Line, Location.Column) = SM.getLineAndColumnInBuffer(
+        Loc, DeclBufID);
   } else if (ClangNode) {
     ClangImporter *Importer =
-        static_cast<ClangImporter *>(Ctx.getClangModuleLoader());
-    return getLocationInfoForClangNode(ClangNode, Importer, DeclarationLoc,
-                                       Filename);
+        static_cast<ClangImporter*>(Ctx.getClangModuleLoader());
+    setLocationInfoForClangNode(ClangNode, Importer, Location);
   }
 }
 
@@ -1011,12 +1020,10 @@ fillSymbolInfo(CursorSymbolInfo &Symbol, const DeclInfo &DInfo,
           Lang.getIFaceGenContexts().find(Symbol.ModuleName, Invoc))
     Symbol.ModuleInterfaceName = IFaceGenRef->getDocumentName();
 
-  getLocationInfo(DInfo.OriginalProperty, Symbol.DeclarationLoc,
-                  Symbol.Filename);
-  if (Symbol.DeclarationLoc.hasValue()) {
-    Symbol.DeclarationLoc = tryRemappingLocToLatestSnapshot(
-        Lang, *Symbol.DeclarationLoc, Symbol.Filename, PreviousSnaps);
-    if (!Symbol.DeclarationLoc.hasValue()) {
+  setLocationInfo(DInfo.OriginalProperty, Symbol.Location);
+  if (!Symbol.Location.Filename.empty()) {
+    mapLocToLatestSnapshot(Lang, Symbol.Location, PreviousSnaps);
+    if (Symbol.Location.Filename.empty()) {
       return llvm::createStringError(
           llvm::inconvertibleErrorCode(),
           "Failed to remap declaration to latest snapshot.");

tools/SourceKit/tools/sourcekitd-test/sourcekitd-test.cpp

@@ -1609,9 +1609,11 @@ struct ResponseSymbolInfo {
   const char *SymbolGraph = nullptr;
   const char *ModuleName = nullptr;
   const char *ModuleInterfaceName = nullptr;
-  llvm::Optional<int64_t> Offset;
-  unsigned Length = 0;
   const char *FilePath = nullptr;
+  unsigned Offset = 0;
+  unsigned Length = 0;
+  unsigned Line = 0;
+  unsigned Column = 0;
   std::vector<const char *> OverrideUSRs;
   std::vector<const char *> AnnotatedRelatedDeclarations;
   std::vector<const char *> ModuleGroups;
@@ -1665,15 +1667,14 @@ struct ResponseSymbolInfo {
     Symbol.ModuleInterfaceName =
         sourcekitd_variant_dictionary_get_string(Info, KeyModuleInterfaceName);
 
-    sourcekitd_variant_t OffsetObj =
-        sourcekitd_variant_dictionary_get_value(Info, KeyOffset);
-    if (sourcekitd_variant_get_type(OffsetObj) !=
-        SOURCEKITD_VARIANT_TYPE_NULL) {
-      Symbol.Offset = sourcekitd_variant_int64_get_value(OffsetObj);
-      Symbol.Length = sourcekitd_variant_dictionary_get_int64(Info, KeyLength);
-    }
     Symbol.FilePath =
         sourcekitd_variant_dictionary_get_string(Info, KeyFilePath);
+    if (Symbol.FilePath) {
+      Symbol.Offset = sourcekitd_variant_dictionary_get_int64(Info, KeyOffset);
+      Symbol.Length = sourcekitd_variant_dictionary_get_int64(Info, KeyLength);
+      Symbol.Line = sourcekitd_variant_dictionary_get_int64(Info, KeyLine);
+      Symbol.Column = sourcekitd_variant_dictionary_get_int64(Info, KeyColumn);
+    }
 
     Symbol.OverrideUSRs = readStringArray(Info, KeyOverrides, KeyUSR);
     Symbol.AnnotatedRelatedDeclarations =
@@ -1728,14 +1729,19 @@ struct ResponseSymbolInfo {
     }
 
     OS << Kind << " (";
-    if (Offset.hasValue()) {
+    if (FilePath) {
       if (CurrentFilename != StringRef(FilePath))
-        OS << FilePath << ":";
-      auto LineCol = resolveToLineCol(Offset.getValue(), FilePath, VFSFiles);
-      OS << LineCol.first << ':' << LineCol.second;
-      auto EndLineCol =
-          resolveToLineCol(Offset.getValue() + Length, FilePath, VFSFiles);
-      OS << '-' << EndLineCol.first << ':' << EndLineCol.second;
+        OS << FilePath << ':';
+
+      auto LineCol = resolveToLineCol(Offset, FilePath, VFSFiles);
+      if (LineCol.first != Line || LineCol.second != Column) {
+        OS << "*offset does not match line/column in response*";
+      } else {
+        OS << LineCol.first << ':' << LineCol.second;
+        auto EndLineCol = resolveToLineCol(Offset + Length, FilePath,
+                                           VFSFiles);
+        OS << '-' << EndLineCol.first << ':' << EndLineCol.second;
+      }
     }
     OS << ")" << '\n';
 

tools/SourceKit/tools/sourcekitd/lib/API/Requests.cpp

@@ -1764,11 +1764,12 @@ static void addCursorSymbolInfo(const CursorSymbolInfo &Symbol,
     Elem.set(KeyModuleName, Symbol.ModuleName);
   if (!Symbol.ModuleInterfaceName.empty())
     Elem.set(KeyModuleInterfaceName, Symbol.ModuleInterfaceName);
-  if (Symbol.DeclarationLoc.hasValue()) {
-    Elem.set(KeyOffset, Symbol.DeclarationLoc.getValue().first);
-    Elem.set(KeyLength, Symbol.DeclarationLoc.getValue().second);
-    if (!Symbol.Filename.empty())
-      Elem.set(KeyFilePath, Symbol.Filename);
+  if (!Symbol.Location.Filename.empty()) {
+    Elem.set(KeyFilePath, Symbol.Location.Filename);
+    Elem.set(KeyOffset, Symbol.Location.Offset);
+    Elem.set(KeyLength, Symbol.Location.Length);
+    Elem.set(KeyLine, Symbol.Location.Line);
+    Elem.set(KeyColumn, Symbol.Location.Column);
   }
 
   if (!Symbol.OverrideUSRs.empty()) {