Add defaultLibrary modifier to tokens with is_system

Author: fwcd

Sources/SourceKitD/sourcekitd_uids.swift

@@ -41,6 +41,7 @@ public struct sourcekitd_keys {
   public let filepath: sourcekitd_uid_t
   public let fixits: sourcekitd_uid_t
   public let id: sourcekitd_uid_t
+  public let is_system: sourcekitd_uid_t
   public let kind: sourcekitd_uid_t
   public let length: sourcekitd_uid_t
   public let line: sourcekitd_uid_t
@@ -113,6 +114,7 @@ public struct sourcekitd_keys {
     filepath = api.uid_get_from_cstr("key.filepath")!
     fixits = api.uid_get_from_cstr("key.fixits")!
     id = api.uid_get_from_cstr("key.id")!
+    is_system = api.uid_get_from_cstr("key.is_system")!
     kind = api.uid_get_from_cstr("key.kind")!
     length = api.uid_get_from_cstr("key.length")!
     line = api.uid_get_from_cstr("key.line")!

Sources/SourceKitLSP/Swift/SyntaxHighlightingTokenParser.swift

@@ -37,7 +37,12 @@ struct SyntaxHighlightingTokenParser {
        var length: Int = useName ? response[keys.namelength] : response[keys.length],
        let start: Position = snapshot.positionOf(utf8Offset: offset),
        let skKind: sourcekitd_uid_t = response[keys.kind],
-       let (kind, modifiers) = parseKindAndModifiers(skKind) {
+       let kindAndModifiers = parseKindAndModifiers(skKind) {
+
+      // We destructure separately since Swift doesn't support mixed var-let
+      // bindings in patterns (yet)
+      let (kind, _) = kindAndModifiers
+      var (_, modifiers) = kindAndModifiers
 
       // We treat function declaration and enum member name tokens as a special
       // case, e.g. SourceKit returns `f(x: Int, y: Int)` as a name instead of just `f`.
@@ -55,6 +60,10 @@ struct SyntaxHighlightingTokenParser {
         length += 2
       }
 
+      if let isSystem: Bool = response[keys.is_system], isSystem {
+        modifiers.insert(.defaultLibrary)
+      }
+
       if let end: Position = snapshot.positionOf(utf8Offset: offset + length) {
         let multiLineRange = start..<end
         let ranges = multiLineRange.splitToSingleLineRanges(in: snapshot)

Tests/SourceKitLSPTests/SemanticTokensTests.swift

@@ -362,9 +362,9 @@ final class SemanticTokensTests: XCTestCase {
       makeToken(line: 0, utf16index: 5, length: 1, kind: .function, modifiers: .declaration),
       // Parameter labels use .function as a kind, see parseKindAndModifiers for rationale
       makeToken(line: 0, utf16index: 7, length: 1, kind: .function, modifiers: .declaration),
-      makeToken(line: 0, utf16index: 10, length: 3, kind: .struct),
+      makeToken(line: 0, utf16index: 10, length: 3, kind: .struct, modifiers: .defaultLibrary),
       makeToken(line: 0, utf16index: 15, length: 1, kind: .keyword),
-      makeToken(line: 0, utf16index: 20, length: 6, kind: .struct),
+      makeToken(line: 0, utf16index: 20, length: 6, kind: .struct, modifiers: .defaultLibrary),
     ])
   }
 
@@ -438,7 +438,7 @@ final class SemanticTokensTests: XCTestCase {
       makeToken(line: 5, utf16index: 0, length: 3, kind: .keyword),
       makeToken(line: 5, utf16index: 4, length: 1, kind: .variable, modifiers: .declaration),
       makeToken(line: 5, utf16index: 8, length: 5, kind: .enum),
-      makeToken(line: 5, utf16index: 14, length: 6, kind: .struct),
+      makeToken(line: 5, utf16index: 14, length: 6, kind: .struct, modifiers: .defaultLibrary),
       makeToken(line: 5, utf16index: 22, length: 4, kind: .enumMember),
       // let y: Maybe = .some(42)
       makeToken(line: 6, utf16index: 0, length: 3, kind: .keyword),
@@ -498,7 +498,7 @@ final class SemanticTokensTests: XCTestCase {
 
     let before = performSemanticTokensRequest(text: text)
     XCTAssertEqual(before, [
-      makeToken(line: 0, utf16index: 0, length: 10, kind: .function),
+      makeToken(line: 0, utf16index: 0, length: 10, kind: .function, modifiers: .defaultLibrary),
       makeToken(line: 0, utf16index: 11, length: 5, kind: .string),
     ])
 
@@ -508,7 +508,7 @@ final class SemanticTokensTests: XCTestCase {
 
     let after = performSemanticTokensRequest(text: text)
     XCTAssertEqual(after, [
-      makeToken(line: 0, utf16index: 0, length: 10, kind: .function),
+      makeToken(line: 0, utf16index: 0, length: 10, kind: .function, modifiers: .defaultLibrary),
       makeToken(line: 0, utf16index: 11, length: 6, kind: .string),
     ])
   }