[SourceKit/CursorInfo] Include line and column in result

Add line/column in addition to offset so clients need not map it
themselves. For serialized locations only output offset/line/column if
the file is currently up to date with the one loaded in the semantic
source manager.

Author: bnbarham

include/swift/IDE/Utils.h

@@ -124,16 +124,6 @@ std::unique_ptr<llvm::MemoryBuffer>
   replacePlaceholders(std::unique_ptr<llvm::MemoryBuffer> InputBuf,
                       bool *HadPlaceholder = nullptr);
 
-void getLocationInfo(
-    const ValueDecl *VD,
-    llvm::Optional<std::pair<unsigned, unsigned>> &DeclarationLoc,
-    StringRef &Filename);
-
-void getLocationInfoForClangNode(ClangNode ClangNode,
-                                 ClangImporter *Importer,
-       llvm::Optional<std::pair<unsigned, unsigned>> &DeclarationLoc,
-                                 StringRef &Filename);
-
 Optional<std::pair<unsigned, unsigned>> parseLineCol(StringRef LineCol);
 
 class XMLEscapingPrinter : public StreamPrinter {

lib/IDE/SwiftSourceDocInfo.cpp

@@ -798,89 +798,6 @@ ReturnInfo(ASTContext &Ctx, ArrayRef<ReturnInfo> Branches):
   }
 }
 
-void swift::ide::getLocationInfoForClangNode(ClangNode ClangNode,
-                                             ClangImporter *Importer,
-                  llvm::Optional<std::pair<unsigned, unsigned>> &DeclarationLoc,
-                                             StringRef &Filename) {
-  clang::ASTContext &ClangCtx = Importer->getClangASTContext();
-  clang::SourceManager &ClangSM = ClangCtx.getSourceManager();
-
-  clang::SourceRange SR = ClangNode.getLocation();
-  if (auto MD = dyn_cast_or_null<clang::ObjCMethodDecl>(ClangNode.getAsDecl())) {
-    SR = clang::SourceRange(MD->getSelectorStartLoc(),
-                            MD->getDeclaratorEndLoc());
-  }
-
-  clang::CharSourceRange CharRange =
-      clang::Lexer::makeFileCharRange(clang::CharSourceRange::getTokenRange(SR),
-                                      ClangSM, ClangCtx.getLangOpts());
-  if (CharRange.isInvalid())
-    return;
-
-  std::pair<clang::FileID, unsigned>
-      Decomp = ClangSM.getDecomposedLoc(CharRange.getBegin());
-  if (!Decomp.first.isInvalid()) {
-    if (auto FE = ClangSM.getFileEntryForID(Decomp.first)) {
-      Filename = FE->getName();
-
-      std::pair<clang::FileID, unsigned>
-          EndDecomp = ClangSM.getDecomposedLoc(CharRange.getEnd());
-
-      DeclarationLoc = { Decomp.second, EndDecomp.second-Decomp.second };
-    }
-  }
-}
-
-static unsigned getCharLength(SourceManager &SM, SourceRange TokenRange) {
-  SourceLoc CharEndLoc = Lexer::getLocForEndOfToken(SM, TokenRange.End);
-  return SM.getByteDistance(TokenRange.Start, CharEndLoc);
-}
-
-void swift::ide::getLocationInfo(
-    const ValueDecl *VD,
-    llvm::Optional<std::pair<unsigned, unsigned>> &DeclarationLoc,
-    StringRef &Filename) {
-  ASTContext &Ctx = VD->getASTContext();
-  SourceManager &SM = Ctx.SourceMgr;
-
-  auto ClangNode = VD->getClangNode();
-
-  SourceLoc Loc = VD->getLoc(/*SerializedOK=*/false);
-  if (Loc.isValid()) {
-    auto getSignatureRange = [&](const ValueDecl *VD) -> Optional<unsigned> {
-      if (auto FD = dyn_cast<AbstractFunctionDecl>(VD)) {
-        SourceRange R = FD->getSignatureSourceRange();
-        if (R.isValid())
-          return getCharLength(SM, R);
-      }
-      return None;
-    };
-    unsigned NameLen;
-    if (auto SigLen = getSignatureRange(VD)) {
-      NameLen = SigLen.getValue();
-    } else if (VD->hasName()) {
-      NameLen = VD->getBaseName().userFacingName().size();
-    } else {
-      NameLen = getCharLength(SM, Loc);
-    }
-
-    unsigned DeclBufID = SM.findBufferContainingLoc(Loc);
-    DeclarationLoc = { SM.getLocOffsetInBuffer(Loc, DeclBufID),
-                       NameLen };
-    Filename = SM.getIdentifierForBuffer(DeclBufID);
-
-  } else if (auto *Positions =
-             VD->getSerializedLocs(/*Resolve=*/false).Positions) {
-    Filename = Positions->SourceFilePath;
-    // TODO: Add location if it is up-to-date
-  } else if (ClangNode) {
-    ClangImporter *Importer =
-        static_cast<ClangImporter*>(Ctx.getClangModuleLoader());
-    return getLocationInfoForClangNode(ClangNode, Importer,
-                                       DeclarationLoc, Filename);
-  }
-}
-
 CharSourceRange CallArgInfo::getEntireCharRange(const SourceManager &SM) const {
   return CharSourceRange(SM, LabelRange.getStart(),
                          Lexer::getLocForEndOfToken(SM, ArgExp->getEndLoc()));

test/SourceKit/CursorInfo/cursor_info.swift

@@ -284,7 +284,7 @@ func checkAnyIsAKeyword(x: Any) {}
 // CHECK5-NEXT: (Int) -> (){{$}}
 
 // RUN: %sourcekitd-test -req=global-config -req-opts=optimize_for_ide=0 == -req=cursor -pos=9:32 %s -- -F %S/../Inputs/libIDE-mock-sdk -I %t.tmp %s | %FileCheck -check-prefix=CHECK6 %s
-// CHECK6:      source.lang.swift.ref.function.free ({{.*}}/FooSwiftModule.swift)
+// CHECK6:      source.lang.swift.ref.function.free ({{.*}}/FooSwiftModule.swift:2:13-2:13)
 // CHECK6-NEXT: fooSwiftFunc
 // CHECK6-NEXT: s:14FooSwiftModule03fooB4FuncSiyF
 // CHECK6-NEXT: source.lang.swift

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::getLineAndColumn(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> getLineAndColumn(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->getLineAndColumn(Location.Offset);
 }
 
 
@@ -802,6 +810,106 @@ static ArrayRef<T> copyAndClearArray(llvm::BumpPtrAllocator &Allocator,
   return Ref;
 }
 
+static void setLocationInfoForClangNode(ClangNode ClangNode,
+                                        ClangImporter *Importer,
+                                        LocationInfo &Location) {
+  clang::ASTContext &ClangCtx = Importer->getClangASTContext();
+  clang::SourceManager &ClangSM = ClangCtx.getSourceManager();
+
+  clang::SourceRange SR = ClangNode.getLocation();
+  if (auto MD = dyn_cast_or_null<clang::ObjCMethodDecl>(ClangNode.getAsDecl())) {
+    SR = clang::SourceRange(MD->getSelectorStartLoc(),
+                            MD->getDeclaratorEndLoc());
+  }
+
+  clang::CharSourceRange CharRange =
+      clang::Lexer::makeFileCharRange(clang::CharSourceRange::getTokenRange(SR),
+                                      ClangSM, ClangCtx.getLangOpts());
+  if (CharRange.isInvalid())
+    return;
+
+  std::pair<clang::FileID, unsigned>
+      Decomp = ClangSM.getDecomposedLoc(CharRange.getBegin());
+  if (!Decomp.first.isInvalid()) {
+    if (auto FE = ClangSM.getFileEntryForID(Decomp.first)) {
+      Location.Filename = FE->getName();
+
+      std::pair<clang::FileID, unsigned>
+          EndDecomp = ClangSM.getDecomposedLoc(CharRange.getEnd());
+
+      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);
+    }
+  }
+}
+
+static unsigned getCharLength(SourceManager &SM, SourceRange TokenRange) {
+  SourceLoc CharEndLoc = Lexer::getLocForEndOfToken(SM, TokenRange.End);
+  return SM.getByteDistance(TokenRange.Start, CharEndLoc);
+}
+
+static void setLocationInfo(const ValueDecl *VD,
+                            LocationInfo &Location) {
+  ASTContext &Ctx = VD->getASTContext();
+  SourceManager &SM = Ctx.SourceMgr;
+
+  auto ClangNode = VD->getClangNode();
+
+  SourceLoc Loc = VD->getLoc(/*SerializedOK=*/false);
+  if (Loc.isValid()) {
+    auto getSignatureRange = [&](const ValueDecl *VD) -> Optional<unsigned> {
+      if (auto FD = dyn_cast<AbstractFunctionDecl>(VD)) {
+        SourceRange R = FD->getSignatureSourceRange();
+        if (R.isValid())
+          return getCharLength(SM, R);
+      }
+      return None;
+    };
+    unsigned NameLen;
+    if (auto SigLen = getSignatureRange(VD)) {
+      NameLen = SigLen.getValue();
+    } else if (VD->hasName()) {
+      NameLen = VD->getBaseName().userFacingName().size();
+    } else {
+      NameLen = getCharLength(SM, Loc);
+    }
+
+    unsigned DeclBufID = SM.findBufferContainingLoc(Loc);
+    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 (auto *Positions =
+             VD->getSerializedLocs(/*Resolve=*/false).Positions) {
+    Location.Filename = Positions->SourceFilePath;
+
+    // Only add position information if the file is up to date
+    if (auto *File = dyn_cast<LoadedFile>(
+        VD->getDeclContext()->getModuleScopeContext())) {
+      File->collectBasicSourceFileInfo([&](const BasicSourceFileInfo &Info) {
+        auto Stat = SM.getFileSystem()->status(Info.getFilePath());
+          if (!Stat)
+            return;
+
+          if (Stat->getLastModificationTime() == Info.getLastModified() &&
+              Stat->getSize() == Info.getFileSize()) {
+            Location.Offset = Positions->Loc.Offset;
+            Location.Length = 0;
+            Location.Line = Positions->Loc.Line;
+            Location.Column = Positions->Loc.Column;
+          }
+      });
+    }
+  } else if (ClangNode) {
+    ClangImporter *Importer =
+        static_cast<ClangImporter*>(Ctx.getClangModuleLoader());
+    setLocationInfoForClangNode(ClangNode, Importer, Location);
+  }
+}
+
 static llvm::Error
 fillSymbolInfo(CursorSymbolInfo &Symbol, const DeclInfo &DInfo,
                ModuleDecl *MainModule, SourceLoc CursorLoc, bool AddSymbolGraph,
@@ -934,12 +1042,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.");