Merge pull request swiftlang#298 from benlangmuir/completion-server-side-filtering1

[completion] Filter completions on the server side

Author: benlangmuir

Sources/LanguageServerProtocol/Requests/CompletionRequest.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -22,6 +22,8 @@
 /// - Parameters:
 ///   - textDocument: The document to perform completion in.
 ///   - position: The location to perform completion at.
+///   - context: Optional code-completion context.
+///   - sourcekitlspOptions: **(LSP Extension)** code-completion options for sourcekit-lsp.
 ///
 /// - Returns: A list of completion items to complete the code at the given position.
 public struct CompletionRequest: TextDocumentRequest, Hashable {
@@ -34,9 +36,18 @@ public struct CompletionRequest: TextDocumentRequest, Hashable {
 
   public var context: CompletionContext?
 
-  public init(textDocument: TextDocumentIdentifier, position: Position) {
+  public var sourcekitlspOptions: SKCompletionOptions?
+
+  public init(
+    textDocument: TextDocumentIdentifier,
+    position: Position,
+    context: CompletionContext? = nil,
+    sourcekitlspOptions: SKCompletionOptions? = nil)
+  {
     self.textDocument = textDocument
     self.position = position
+    self.context = context
+    self.sourcekitlspOptions = sourcekitlspOptions
   }
 }
 

Sources/LanguageServerProtocol/SupportTypes/Position.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -56,3 +56,13 @@ extension Position: LSPAnyCodable {
     ])
   }
 }
+
+extension Position: CustomStringConvertible, CustomDebugStringConvertible {
+  public var description: String {
+    "\(line + 1):\(utf16index+1)"
+  }
+
+  public var debugDescription: String {
+    "Position(line: \(line), utf16index: \(utf16index))"
+  }
+}

Sources/LanguageServerProtocol/SupportTypes/SKCompletionOptions.swift

@@ -0,0 +1,30 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+/// Code-completion configuration.
+///
+/// **(LSP Extension)**: This is used as part of an extension to the
+/// code-completion request.
+public struct SKCompletionOptions: Codable, Hashable {
+
+  /// Whether to use server-side filtering or to return all results and let the
+  /// client handle all filtering.
+  public var serverSideFiltering: Bool
+
+  /// The maximum number of completion results to return, or `nil` for unlimited.
+  public var maxResults: Int?
+
+  public init(serverSideFiltering: Bool = true, maxResults: Int? = 200) {
+    self.serverSideFiltering = serverSideFiltering
+    self.maxResults = maxResults
+  }
+}

Sources/SourceKitD/sourcekitd_uids.swift

@@ -13,105 +13,120 @@
 import Csourcekitd
 
 public struct sourcekitd_keys {
-  public let request: sourcekitd_uid_t
+  public let actionname: sourcekitd_uid_t
+  public let actionuid: sourcekitd_uid_t
+  public let annotated_decl: sourcekitd_uid_t
+  public let associated_usrs: sourcekitd_uid_t
+  public let bodylength: sourcekitd_uid_t
+  public let bodyoffset: sourcekitd_uid_t
+  public let categorizededits: sourcekitd_uid_t
+  public let column: sourcekitd_uid_t
   public let compilerargs: sourcekitd_uid_t
-  public let offset: sourcekitd_uid_t
-  public let length: sourcekitd_uid_t
-  public let sourcefile: sourcekitd_uid_t
-  public let sourcetext: sourcekitd_uid_t
-  public let results: sourcekitd_uid_t
+  public let context: sourcekitd_uid_t
   public let description: sourcekitd_uid_t
-  public let name: sourcekitd_uid_t
-  public let kind: sourcekitd_uid_t
-  public let notification: sourcekitd_uid_t
-  public let fixits: sourcekitd_uid_t
-  public let diagnostics: sourcekitd_uid_t
   public let diagnostic_stage: sourcekitd_uid_t
-  public let severity: sourcekitd_uid_t
-  public let line: sourcekitd_uid_t
-  public let column: sourcekitd_uid_t
-  public let endline: sourcekitd_uid_t
+  public let diagnostics: sourcekitd_uid_t
+  public let doc_brief: sourcekitd_uid_t
+  public let doc_full_as_xml: sourcekitd_uid_t
+  public let edits: sourcekitd_uid_t
   public let endcolumn: sourcekitd_uid_t
+  public let endline: sourcekitd_uid_t
   public let filepath: sourcekitd_uid_t
-  public let ranges: sourcekitd_uid_t
-  public let usr: sourcekitd_uid_t
-  public let typename: sourcekitd_uid_t
-  public let annotated_decl: sourcekitd_uid_t
-  public let doc_full_as_xml: sourcekitd_uid_t
-  public let syntactic_only: sourcekitd_uid_t
-  public let substructure: sourcekitd_uid_t
-  public let bodyoffset: sourcekitd_uid_t
-  public let bodylength: sourcekitd_uid_t
-  public let syntaxmap: sourcekitd_uid_t
+  public let fixits: sourcekitd_uid_t
+  public let kind: sourcekitd_uid_t
+  public let length: sourcekitd_uid_t
+  public let line: sourcekitd_uid_t
+  public let name: sourcekitd_uid_t
   public let namelength: sourcekitd_uid_t
   public let nameoffset: sourcekitd_uid_t
-  public let retrieve_refactor_actions: sourcekitd_uid_t
+  public let not_recommended: sourcekitd_uid_t
+  public let notification: sourcekitd_uid_t
+  public let num_bytes_to_erase: sourcekitd_uid_t
+  public let offset: sourcekitd_uid_t
+  public let ranges: sourcekitd_uid_t
   public let refactor_actions: sourcekitd_uid_t
-  public let actionname: sourcekitd_uid_t
-  public let actionuid: sourcekitd_uid_t
-  public let categorizededits: sourcekitd_uid_t
-  public let edits: sourcekitd_uid_t
+  public let request: sourcekitd_uid_t
+  public let results: sourcekitd_uid_t
+  public let retrieve_refactor_actions: sourcekitd_uid_t
+  public let severity: sourcekitd_uid_t
+  public let sourcefile: sourcekitd_uid_t
+  public let sourcetext: sourcekitd_uid_t
+  public let substructure: sourcekitd_uid_t
+  public let syntactic_only: sourcekitd_uid_t
+  public let syntaxmap: sourcekitd_uid_t
   public let text: sourcekitd_uid_t
+  public let typename: sourcekitd_uid_t
+  public let usr: sourcekitd_uid_t
 
-  // Code Completion related keys.
+  // Code Completion options.
   public let codecomplete_options: sourcekitd_uid_t
   public let codecomplete_sort_byname: sourcekitd_uid_t
-  public let context: sourcekitd_uid_t
-  public let doc: sourcekitd_uid_t
-  public let not_recommended: sourcekitd_uid_t
-  public let num_bytes_to_erase: sourcekitd_uid_t
-  public let associated_usrs: sourcekitd_uid_t
-
+  public let codecomplete_filtertext: sourcekitd_uid_t
+  public let codecomplete_requestlimit: sourcekitd_uid_t
+  public let codecomplete_hideunderscores: sourcekitd_uid_t
+  public let codecomplete_hidelowpriority: sourcekitd_uid_t
+  public let codecomplete_hidebyname: sourcekitd_uid_t
+  public let codecomplete_addinneroperators: sourcekitd_uid_t
+  public let codecomplete_callpatternheuristics: sourcekitd_uid_t
+  public let codecomplete_showtopnonliteralresults: sourcekitd_uid_t
 
   public init(api: sourcekitd_functions_t) {
-    request = api.uid_get_from_cstr("key.request")!
+    actionname = api.uid_get_from_cstr("key.actionname")!
+    actionuid = api.uid_get_from_cstr("key.actionuid")!
+    annotated_decl = api.uid_get_from_cstr("key.annotated_decl")!
+    associated_usrs = api.uid_get_from_cstr("key.associated_usrs")!
+    bodylength = api.uid_get_from_cstr("key.bodylength")!
+    bodyoffset = api.uid_get_from_cstr("key.bodyoffset")!
+    categorizededits = api.uid_get_from_cstr("key.categorizededits")!
+    column = api.uid_get_from_cstr("key.column")!
     compilerargs = api.uid_get_from_cstr("key.compilerargs")!
-    offset = api.uid_get_from_cstr("key.offset")!
-    length = api.uid_get_from_cstr("key.length")!
-    sourcefile = api.uid_get_from_cstr("key.sourcefile")!
-    sourcetext = api.uid_get_from_cstr("key.sourcetext")!
-    results = api.uid_get_from_cstr("key.results")!
+    context = api.uid_get_from_cstr("key.context")!
     description = api.uid_get_from_cstr("key.description")!
-    name = api.uid_get_from_cstr("key.name")!
-    kind = api.uid_get_from_cstr("key.kind")!
-    notification = api.uid_get_from_cstr("key.notification")!
-    fixits = api.uid_get_from_cstr("key.fixits")!
-    diagnostics = api.uid_get_from_cstr("key.diagnostics")!
     diagnostic_stage = api.uid_get_from_cstr("key.diagnostic_stage")!
-    severity = api.uid_get_from_cstr("key.severity")!
-    line = api.uid_get_from_cstr("key.line")!
-    column = api.uid_get_from_cstr("key.column")!
-    endline = api.uid_get_from_cstr("key.endline")!
+    diagnostics = api.uid_get_from_cstr("key.diagnostics")!
+    doc_brief = api.uid_get_from_cstr("key.doc.brief")!
+    doc_full_as_xml = api.uid_get_from_cstr("key.doc.full_as_xml")!
+    edits = api.uid_get_from_cstr("key.edits")!
     endcolumn = api.uid_get_from_cstr("key.endcolumn")!
+    endline = api.uid_get_from_cstr("key.endline")!
     filepath = api.uid_get_from_cstr("key.filepath")!
-    ranges = api.uid_get_from_cstr("key.ranges")!
-    usr = api.uid_get_from_cstr("key.usr")!
-    typename = api.uid_get_from_cstr("key.typename")!
-    annotated_decl = api.uid_get_from_cstr("key.annotated_decl")!
-    doc_full_as_xml = api.uid_get_from_cstr("key.doc.full_as_xml")!
-    syntactic_only = api.uid_get_from_cstr("key.syntactic_only")!
-    substructure = api.uid_get_from_cstr("key.substructure")!
-    bodyoffset = api.uid_get_from_cstr("key.bodyoffset")!
-    bodylength = api.uid_get_from_cstr("key.bodylength")!
-    syntaxmap = api.uid_get_from_cstr("key.syntaxmap")!
+    fixits = api.uid_get_from_cstr("key.fixits")!
+    kind = api.uid_get_from_cstr("key.kind")!
+    length = api.uid_get_from_cstr("key.length")!
+    line = api.uid_get_from_cstr("key.line")!
+    name = api.uid_get_from_cstr("key.name")!
     namelength = api.uid_get_from_cstr("key.namelength")!
     nameoffset = api.uid_get_from_cstr("key.nameoffset")!
-    retrieve_refactor_actions = api.uid_get_from_cstr("key.retrieve_refactor_actions")!
+    not_recommended = api.uid_get_from_cstr("key.not_recommended")!
+    notification = api.uid_get_from_cstr("key.notification")!
+    num_bytes_to_erase = api.uid_get_from_cstr("key.num_bytes_to_erase")!
+    offset = api.uid_get_from_cstr("key.offset")!
+    ranges = api.uid_get_from_cstr("key.ranges")!
     refactor_actions = api.uid_get_from_cstr("key.refactor_actions")!
-    actionname = api.uid_get_from_cstr("key.actionname")!
-    actionuid = api.uid_get_from_cstr("key.actionuid")!
-    categorizededits = api.uid_get_from_cstr("key.categorizededits")!
-    edits = api.uid_get_from_cstr("key.edits")!
+    request = api.uid_get_from_cstr("key.request")!
+    results = api.uid_get_from_cstr("key.results")!
+    retrieve_refactor_actions = api.uid_get_from_cstr("key.retrieve_refactor_actions")!
+    severity = api.uid_get_from_cstr("key.severity")!
+    sourcefile = api.uid_get_from_cstr("key.sourcefile")!
+    sourcetext = api.uid_get_from_cstr("key.sourcetext")!
+    substructure = api.uid_get_from_cstr("key.substructure")!
+    syntactic_only = api.uid_get_from_cstr("key.syntactic_only")!
+    syntaxmap = api.uid_get_from_cstr("key.syntaxmap")!
     text = api.uid_get_from_cstr("key.text")!
+    typename = api.uid_get_from_cstr("key.typename")!
+    usr = api.uid_get_from_cstr("key.usr")!
 
-    // Code Completion related keys.
+    // Code Completion options
     codecomplete_options = api.uid_get_from_cstr("key.codecomplete.options")!
     codecomplete_sort_byname = api.uid_get_from_cstr("key.codecomplete.sort.byname")!
-    context = api.uid_get_from_cstr("key.context")!
-    doc = api.uid_get_from_cstr("key.doc.brief")!
-    not_recommended = api.uid_get_from_cstr("key.not_recommended")!
-    num_bytes_to_erase = api.uid_get_from_cstr("key.num_bytes_to_erase")!
-    associated_usrs = api.uid_get_from_cstr("key.associated_usrs")!
+    codecomplete_filtertext = api.uid_get_from_cstr("key.codecomplete.filtertext")!
+    codecomplete_requestlimit = api.uid_get_from_cstr("key.codecomplete.requestlimit")!
+    codecomplete_hideunderscores = api.uid_get_from_cstr("key.codecomplete.hideunderscores")!
+    codecomplete_hidelowpriority = api.uid_get_from_cstr("key.codecomplete.hidelowpriority")!
+    codecomplete_hidebyname = api.uid_get_from_cstr("key.codecomplete.hidebyname")!
+    codecomplete_addinneroperators = api.uid_get_from_cstr("key.codecomplete.addinneroperators")!
+    codecomplete_callpatternheuristics = api.uid_get_from_cstr("key.codecomplete.callpatternheuristics")!
+    codecomplete_showtopnonliteralresults = api.uid_get_from_cstr("key.codecomplete.showtopnonliteralresults")!
   }
 }
 
@@ -120,6 +135,9 @@ public struct sourcekitd_requests {
   public let editor_close: sourcekitd_uid_t
   public let editor_replacetext: sourcekitd_uid_t
   public let codecomplete: sourcekitd_uid_t
+  public let codecomplete_open: sourcekitd_uid_t
+  public let codecomplete_update: sourcekitd_uid_t
+  public let codecomplete_close: sourcekitd_uid_t
   public let cursorinfo: sourcekitd_uid_t
   public let relatedidents: sourcekitd_uid_t
   public let semantic_refactoring: sourcekitd_uid_t
@@ -129,6 +147,9 @@ public struct sourcekitd_requests {
     editor_close = api.uid_get_from_cstr("source.request.editor.close")!
     editor_replacetext = api.uid_get_from_cstr("source.request.editor.replacetext")!
     codecomplete = api.uid_get_from_cstr("source.request.codecomplete")!
+    codecomplete_open = api.uid_get_from_cstr("source.request.codecomplete.open")!
+    codecomplete_update = api.uid_get_from_cstr("source.request.codecomplete.update")!
+    codecomplete_close = api.uid_get_from_cstr("source.request.codecomplete.close")!
     cursorinfo = api.uid_get_from_cstr("source.request.cursorinfo")!
     relatedidents = api.uid_get_from_cstr("source.request.relatedidents")!
     semantic_refactoring = api.uid_get_from_cstr("source.request.semantic.refactoring")!

Sources/SourceKitLSP/SourceKitServer+Options.swift

@@ -2,14 +2,15 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
 // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
 //
 //===----------------------------------------------------------------------===//
 
+import LanguageServerProtocol
 import SKCore
 
 extension SourceKitServer {
@@ -27,10 +28,19 @@ extension SourceKitServer {
     /// Additional options for the index.
     public var indexOptions: IndexOptions
 
-    public init(buildSetup: BuildSetup = .default, clangdOptions: [String] = [], indexOptions: IndexOptions = .init()) {
+    /// Options for code-completion.
+    public var completionOptions: SKCompletionOptions
+
+    public init(
+      buildSetup: BuildSetup = .default,
+      clangdOptions: [String] = [],
+      indexOptions: IndexOptions = .init(),
+      completionOptions: SKCompletionOptions = .init())
+    {
       self.buildSetup = buildSetup
       self.clangdOptions = clangdOptions
       self.indexOptions = indexOptions
+      self.completionOptions = completionOptions
     }
   }
 }

Sources/SourceKitLSP/SourceKitServer.swift

@@ -36,7 +36,7 @@ public final class SourceKitServer: LanguageServer {
     var language: Language
   }
 
-  let options: Options
+  var options: Options
 
   let toolchainRegistry: ToolchainRegistry
 
@@ -412,6 +412,21 @@ extension SourceKitServer {
       if case .bool(let listenToUnitEvents) = options["listenToUnitEvents"] {
         indexOptions.listenToUnitEvents = listenToUnitEvents
       }
+      if case .dictionary(let completionOptions) = options["completion"] {
+        if case .bool(let serverSideFiltering) = completionOptions["serverSideFiltering"] {
+          self.options.completionOptions.serverSideFiltering = serverSideFiltering
+        }
+        switch completionOptions["maxResults"] {
+        case .none:
+          break
+        case .some(.null):
+          self.options.completionOptions.maxResults = nil
+        case .some(.int(let maxResults)):
+          self.options.completionOptions.maxResults = maxResults
+        case .some(let invalid):
+          log("expected null or int for 'maxResults'; got \(invalid)", level: .warning)
+        }
+      }
     }
 
     // Any messages sent before initialize returns are expected to fail, so this will run before
@@ -460,7 +475,7 @@ extension SourceKitServer {
         save: .value(TextDocumentSyncOptions.SaveOptions(includeText: false))
       ),
       hoverProvider: true,
-      completionProvider: CompletionOptions(
+      completionProvider: LanguageServerProtocol.CompletionOptions(
         resolveProvider: false,
         triggerCharacters: ["."]
       ),
@@ -996,7 +1011,11 @@ public func languageService(
 
   case .swift:
     guard let sourcekitd = toolchain.sourcekitd else { return nil }
-    return try makeLocalSwiftServer(client: client, sourcekitd: sourcekitd, clientCapabilities: workspace.clientCapabilities)
+    return try makeLocalSwiftServer(
+      client: client,
+      sourcekitd: sourcekitd,
+      clientCapabilities: workspace.clientCapabilities,
+      options: options)
 
   default:
     return nil