[SymbolGraph][CursorInfo] Add option to SourceKit's CursorInfo request to include the SymbolGraph JSON #34934

nathawes · 2020-12-03T11:06:38Z

Adds a new key.retrieve_symbol_graph option to the request. When set to 1 the JSON for a SymbolGraph containing a single node corresponding to the symbol at the cursor position will be included in the response under key.symbol_graph.

This extends the SymbolGraph with a new entry point to get a graph for a single symbol, and to additionally support type substitution to match the existing CursorInfo behavior (e.g. so that when invoked on first in Array<Int>().first, the type is reported as Int? rather than Element?).

Resolves rdar://problem/70551509

nathawes · 2020-12-03T11:07:40Z

@swift-ci Please Build Toolchain macOS Platform

swift-ci · 2020-12-03T13:43:03Z

macOS Toolchain
Download Toolchain
Git Sha - cee3e5af433d8008809e373d16fbcdf0aa4eb766

Install command
tar -zxf swift-PR-34934-801-osx.tar.gz --directory ~/

nathawes · 2020-12-04T02:15:39Z

@swift-ci Please Build Toolchain macOS Platform

swift-ci · 2020-12-04T04:34:32Z

macOS Toolchain
Download Toolchain
Git Sha - 03b4b5d6c8365404534c21b599c7493a65a703f6

Install command
tar -zxf swift-PR-34934-803-osx.tar.gz --directory ~/

nathawes · 2020-12-10T21:47:10Z

@swift-ci please test

nathawes · 2020-12-10T21:47:21Z

@swift-ci Please Build Toolchain macOS Platform

swift-ci · 2020-12-10T22:10:37Z

Build failed
Swift Test Linux Platform
Git Sha - f955085f69ac7fe4b9f290a4329c7365696a3579

swift-ci · 2020-12-10T22:57:53Z

Build failed
Swift Test OS X Platform
Git Sha - f955085f69ac7fe4b9f290a4329c7365696a3579

nathawes · 2020-12-11T00:01:03Z

lib/SymbolGraphGen/SymbolGraph.cpp

+      StringRef ModuleName = M.getNameStr();
+      SmallVector<Identifier, 4> Bystanders;
+
+      // If the decl is from a cross-import overlay module, report the overlay's
+      // declaring module as the owning module.
+      if (auto *Declaring = M.getDeclaringModuleIfCrossImportOverlay()) {
+        ModuleName = Declaring->getNameStr();
+        M.getRequiredBystandersIfCrossImportOverlay(Declaring, Bystanders);
+      }
+
+      OS.attribute("name", ModuleName);
+      if (!Bystanders.empty()) {
+        OS.attributeArray("bystanders", [&](){
+          for (auto &Id: Bystanders)
+            OS.value(Id.str());
+        });
+      }


This part will go away once #34922 lands.

nathawes · 2020-12-11T00:01:30Z

@swift-ci please test

nathawes · 2020-12-11T00:01:48Z

@swift-ci Please Build Toolchain macOS Platform

swift-ci · 2020-12-11T01:13:21Z

Build failed
Swift Test Linux Platform
Git Sha - 1b21814976590aa4f68ce9b6b83db0e65a0612ef

swift-ci · 2020-12-11T03:28:52Z

macOS Toolchain
Download Toolchain
Git Sha - 1b21814976590aa4f68ce9b6b83db0e65a0612ef

Install command
tar -zxf swift-PR-34934-805-osx.tar.gz --directory ~/

nathawes · 2020-12-11T04:29:38Z

@swift-ci please test

swift-ci · 2020-12-11T05:29:55Z

Build failed
Swift Test Linux Platform
Git Sha - 146fa1880a52308cc5aa86621d778c1dd6c00378

swift-ci · 2020-12-11T07:40:50Z

Build failed
Swift Test OS X Platform
Git Sha - 146fa1880a52308cc5aa86621d778c1dd6c00378

nathawes · 2020-12-11T10:47:58Z

@swift-ci please test OS X Platform

nathawes · 2020-12-11T10:48:14Z

@swift-ci please test Linux Platform

swift-ci · 2020-12-11T11:47:28Z

Build failed
Swift Test Linux Platform
Git Sha - 146fa1880a52308cc5aa86621d778c1dd6c00378

swift-ci · 2020-12-11T13:09:54Z

Build failed
Swift Test OS X Platform
Git Sha - 146fa1880a52308cc5aa86621d778c1dd6c00378

QuietMisdreavus

Symbol graph stuff looks good! One little nit in the new entry point, otherwise i think this is nice.

lib/SymbolGraphGen/SymbolGraphGen.cpp

…t to include the SymbolGraph JSON Adds a new 'key.retrieve_symbol_graph' option to the request. When set to 1 it includes the JSON for a SymbolGraph containing a single node for the symbol at the requested position. This also extends the SymbolGraph library with a new entry point to get a graph for a single symbol, and to additionally support type substitution to match the existing CursorInfo behavior (e.g. so that when invoked on `first` in `Array<Int>().first`, the type is given as `Int?` rather than `Element?`). Resolves rdar://problem/70551509

…symbol_graph_objc.swift It requires objc interop.

…cl entrypoint. Change it to use EXIT_SUCCESS/FAILURE rather than a bool to match emitSymbolGraphForModule.

nathawes · 2020-12-12T04:54:24Z

@swift-ci please test

nathawes · 2020-12-12T08:37:13Z

@akyrtzi I'm going to go ahead and merge this. If you have time to take a look still I'll address any comments you have in a follow-up PR.

nathawes · 2020-12-14T21:54:53Z

@swift-ci Please Build Toolchain macOS Platform

nathawes force-pushed the cursor-info-symbol-graph branch from 03b4b5d to f955085 Compare December 10, 2020 21:43

nathawes changed the title ~~[Draft][SourceKit] Add option to include symbol graph json in Cursor info response~~ [SymbolGraph][CursorInfo] Add option to SourceKit's CursorInfo request to include the SymbolGraph JSON Dec 10, 2020

nathawes force-pushed the cursor-info-symbol-graph branch 2 times, most recently from 5048823 to 1b21814 Compare December 10, 2020 23:32

nathawes commented Dec 11, 2020

View reviewed changes

nathawes requested review from QuietMisdreavus and bitjammer December 11, 2020 00:03

nathawes marked this pull request as ready for review December 11, 2020 00:04

nathawes requested a review from akyrtzi December 11, 2020 00:04

nathawes force-pushed the cursor-info-symbol-graph branch from 1b21814 to 146fa18 Compare December 11, 2020 04:29

QuietMisdreavus approved these changes Dec 11, 2020

View reviewed changes

lib/SymbolGraphGen/SymbolGraphGen.cpp Outdated Show resolved Hide resolved

nathawes force-pushed the cursor-info-symbol-graph branch from 146fa18 to ba47a58 Compare December 12, 2020 04:34

Nathan Hawes added 3 commits December 12, 2020 14:38

[test] Add missing requires line in test/SourceKit/CursorInfo/cursor_…

6b1722e

…symbol_graph_objc.swift It requires objc interop.

[SymbolGraphGen] Address review comments on new printSymbolGraphForDe…

968504d

…cl entrypoint. Change it to use EXIT_SUCCESS/FAILURE rather than a bool to match emitSymbolGraphForModule.

nathawes force-pushed the cursor-info-symbol-graph branch from ba47a58 to 968504d Compare December 12, 2020 04:49

nathawes merged commit 632dfcf into swiftlang:main Dec 12, 2020

nathawes deleted the cursor-info-symbol-graph branch December 12, 2020 08:37

[SymbolGraph][CursorInfo] Add option to SourceKit's CursorInfo request to include the SymbolGraph JSON #34934

[SymbolGraph][CursorInfo] Add option to SourceKit's CursorInfo request to include the SymbolGraph JSON #34934

Uh oh!

Conversation

nathawes commented Dec 3, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nathawes commented Dec 3, 2020

Uh oh!

swift-ci commented Dec 3, 2020

Uh oh!

nathawes commented Dec 4, 2020

Uh oh!

swift-ci commented Dec 4, 2020

Uh oh!

nathawes commented Dec 10, 2020

Uh oh!

nathawes commented Dec 10, 2020

Uh oh!

swift-ci commented Dec 10, 2020

Uh oh!

swift-ci commented Dec 10, 2020

Uh oh!

nathawes Dec 11, 2020

Choose a reason for hiding this comment

Uh oh!

nathawes commented Dec 11, 2020

Uh oh!

nathawes commented Dec 11, 2020

Uh oh!

swift-ci commented Dec 11, 2020

Uh oh!

swift-ci commented Dec 11, 2020

Uh oh!

nathawes commented Dec 11, 2020

Uh oh!

swift-ci commented Dec 11, 2020

Uh oh!

swift-ci commented Dec 11, 2020

Uh oh!

nathawes commented Dec 11, 2020

Uh oh!

nathawes commented Dec 11, 2020

Uh oh!

swift-ci commented Dec 11, 2020

Uh oh!

swift-ci commented Dec 11, 2020

Uh oh!

QuietMisdreavus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nathawes commented Dec 12, 2020

Uh oh!

nathawes commented Dec 12, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nathawes commented Dec 14, 2020

Uh oh!

Uh oh!

nathawes commented Dec 3, 2020 •

edited

Loading

nathawes commented Dec 12, 2020 •

edited

Loading