sourcekit-lsp/Sources/SourceKitLSP/SourceKitServer+Options.swift

//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

import LanguageServerProtocol
import SKCore
import struct TSCBasic.AbsolutePath
import SKSupport

extension SourceKitServer {

  /// Configuration options for the SourceKitServer.
  public struct Options {

    /// Additional compiler flags (e.g. `-Xswiftc` for SwiftPM projects) and other build-related
    /// configuration.
    public var buildSetup: BuildSetup

    /// Additional arguments to pass to `clangd` on the command-line.
    public var clangdOptions: [String]

    /// Additional options for the index.
    public var indexOptions: IndexOptions

    /// Options for code-completion.
    public var completionOptions: SKCompletionOptions
    
    /// Override the default directory where generated interfaces will be stored
    public var generatedInterfacesPath: AbsolutePath

    public init(
      buildSetup: BuildSetup = .default,
      clangdOptions: [String] = [],
      indexOptions: IndexOptions = .init(),
      completionOptions: SKCompletionOptions = .init(),
      generatedInterfacesPath: AbsolutePath = defaultDirectoryForGeneratedInterfaces)
    {
      self.buildSetup = buildSetup
      self.clangdOptions = clangdOptions
      self.indexOptions = indexOptions
      self.completionOptions = completionOptions
      self.generatedInterfacesPath = generatedInterfacesPath
    }
  }
}