Merge pull request swiftlang#65 from krzyzanowskim/cli-arguments

Command line arguments

Author: benlangmuir

Sources/SKCore/BuildSetup.swift

@@ -0,0 +1,39 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2019 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 Foundation
+import Utility
+import SKSupport
+
+/// Build configuration
+public struct BuildSetup {
+
+  /// Default configuration
+  public static let `default` = BuildSetup(configuration: .debug,
+                                           path: "./.build",
+                                           flags: BuildFlags())
+
+  /// Build configuration
+  public let configuration: BuildConfiguration
+
+  /// Build artefacts directory path
+  public let path: String
+
+  /// Additional build flags
+  public let flags: BuildFlags
+
+  public init(configuration: BuildConfiguration, path: String, flags: BuildFlags) {
+    self.configuration = configuration
+    self.path = path
+    self.flags = flags
+  }
+}

Sources/SKSupport/BuildConfiguration.swift

@@ -0,0 +1,30 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2019 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 Foundation
+import Utility
+
+public enum BuildConfiguration: String {
+  case debug
+  case release
+}
+
+extension BuildConfiguration: ArgumentKind {
+  public init(argument: String) throws {
+    self = BuildConfiguration(rawValue: argument) ?? .debug
+  }
+
+  /// Type of shell completion to provide for this argument.
+  public static var completion: ShellCompletion {
+    return ShellCompletion.none
+  }
+}

Sources/SKSupport/Logging.swift

@@ -12,6 +12,7 @@
 
 import Basic
 import Foundation
+import Utility
 
 #if canImport(os)
 import os // os_log
@@ -26,6 +27,45 @@ public enum LogLevel: Int, Equatable {
   public static let `default`: LogLevel = .info
 }
 
+extension LogLevel: CustomStringConvertible {
+
+  public var description: String {
+    switch self {
+    case .error:
+      return "error"
+    case .warning:
+      return "warning"
+    case .info:
+      return "info"
+    case .debug:
+      return "debug"
+    }
+  }
+}
+
+extension LogLevel: ArgumentKind {
+
+  public init(argument: String) throws {
+    switch argument {
+    case "error":
+      self = .error
+    case "warning":
+      self = .warning
+    case "info":
+      self = .info
+    case "debug":
+      self = .debug
+    default:
+      self = LogLevel.default
+    }
+  }
+
+  /// Type of shell completion to provide for this argument.
+  public static var completion: ShellCompletion {
+    return ShellCompletion.none
+  }
+}
+
 /// Log the given message.
 ///
 /// If `level >= Logger.shared.currentLevel`, it will be emitted. However, the converse is not necessarily true: on platforms that provide `os_log`, the message may be emitted by `os_log` according to its own rules about log level.

Sources/SKSwiftPMWorkspace/SwiftPMWorkspace.swift

@@ -58,7 +58,8 @@ public final class SwiftPMWorkspace {
   public init(
     workspacePath: AbsolutePath,
     toolchainRegistry: ToolchainRegistry,
-    fileSystem: FileSystem = localFileSystem) throws
+    fileSystem: FileSystem = localFileSystem,
+    buildSetup: BuildSetup) throws
   {
     self.workspacePath = workspacePath
     self.toolchainRegistry = toolchainRegistry
@@ -112,7 +113,13 @@ public final class SwiftPMWorkspace {
     swiftPMToolchain.extraSwiftCFlags = extraSwiftFlags
     swiftPMToolchain.extraCPPFlags = extraClangFlags
 
-    let buildPath = packageRoot.appending(component: ".build")
+
+    let buildPath: AbsolutePath
+    if let absoluteBuildPath = try? AbsolutePath(validating: buildSetup.path) {
+      buildPath = absoluteBuildPath
+    } else {
+      buildPath = packageRoot.appending(component: buildSetup.path)
+    }
 
     self.workspace = Workspace(
       dataPath: buildPath,
@@ -125,12 +132,19 @@ public final class SwiftPMWorkspace {
 
     let triple = Triple.hostTriple
 
-    // FIXME: make these configurable
+    let swiftPMConfiguration: PackageModel.BuildConfiguration
+    switch buildSetup.configuration {
+    case .debug:
+      swiftPMConfiguration = .debug
+    case .release:
+      swiftPMConfiguration = .release
+    }
+
     self.buildParameters = BuildParameters(
       dataPath: buildPath.appending(component: triple.tripleString),
-      configuration: .debug,
+      configuration: swiftPMConfiguration,
       toolchain: swiftPMToolchain,
-      flags: BuildFlags())
+      flags: buildSetup.flags)
 
     self.packageGraph = PackageGraph(rootPackages: [])
 
@@ -140,13 +154,16 @@ public final class SwiftPMWorkspace {
   /// Creates a build system using the Swift Package Manager, if this workspace is a package.
   ///
   /// - Returns: nil if `workspacePath` is not part of a package or there is an error.
-  public convenience init?(url: LanguageServerProtocol.URL, toolchainRegistry: ToolchainRegistry) {
+  public convenience init?(url: LanguageServerProtocol.URL,
+                           toolchainRegistry: ToolchainRegistry,
+                           buildSetup: BuildSetup)
+  {
     do {
       try self.init(
         workspacePath: try AbsolutePath(validating: url.path),
         toolchainRegistry: toolchainRegistry,
-        fileSystem: localFileSystem)
-
+        fileSystem: localFileSystem,
+        buildSetup: buildSetup)
     } catch Error.noManifest(let path) {
       log("could not find manifest, or not a SwiftPM package: \(path.asString)", level: .warning)
       return nil

Sources/SKTestSupport/TestServer.swift

@@ -11,6 +11,8 @@
 //===----------------------------------------------------------------------===//
 
 import SKSupport
+import SKCore
+import Utility
 import LanguageServerProtocol
 import LanguageServerProtocolJSONRPC
 import SourceKit
@@ -32,6 +34,10 @@ public struct TestSourceKitServer {
       serverConnection: JSONRPCConection)
   }
 
+  public static let buildSetup: BuildSetup = BuildSetup(configuration: .debug,
+                                                        path: ".build",
+                                                        flags: BuildFlags())
+
   public let client: TestClient
   let connImpl: ConnectionImpl
 
@@ -46,7 +52,7 @@ public struct TestSourceKitServer {
         let clientConnection = LocalConnection()
         let serverConnection = LocalConnection()
         client = TestClient(server: serverConnection)
-        server = SourceKitServer(client: clientConnection, onExit: {
+        server = SourceKitServer(client: clientConnection, buildSetup: TestSourceKitServer.buildSetup, onExit: {
           clientConnection.close()
         })
 
@@ -74,7 +80,7 @@ public struct TestSourceKitServer {
         )
 
         client = TestClient(server: clientConnection)
-        server = SourceKitServer(client: serverConnection, onExit: {
+        server = SourceKitServer(client: serverConnection, buildSetup: TestSourceKitServer.buildSetup, onExit: {
           serverConnection.close()
         })
 

Sources/SourceKit/SourceKitServer.swift

@@ -15,9 +15,13 @@ import SKCore
 import SKSupport
 import IndexStoreDB
 import Basic
+import Utility
 import Dispatch
+import Foundation
 import SPMLibc
 
+public typealias URL = Foundation.URL
+
 /// The SourceKit language server.
 ///
 /// This is the client-facing language server implementation, providing indexing, multiple-toolchain
@@ -30,6 +34,8 @@ public final class SourceKitServer: LanguageServer {
     var language: Language
   }
 
+  let buildSetup: BuildSetup
+
   let toolchainRegistry: ToolchainRegistry
 
   var languageService: [LanguageServiceKey: Connection] = [:]
@@ -41,10 +47,11 @@ public final class SourceKitServer: LanguageServer {
   let onExit: () -> Void
 
   /// Creates a language server for the given client.
-  public init(client: Connection, fileSystem: FileSystem = localFileSystem, onExit: @escaping () -> Void = {}) {
+  public init(client: Connection, fileSystem: FileSystem = localFileSystem, buildSetup: BuildSetup, onExit: @escaping () -> Void = {}) {
 
     self.fs = fileSystem
     self.toolchainRegistry = ToolchainRegistry.shared
+    self.buildSetup = buildSetup
     self.onExit = onExit
 
     super.init(client: client)
@@ -212,14 +219,14 @@ extension SourceKitServer {
       self.workspace = try? Workspace(
         url: url,
         clientCapabilities: req.params.capabilities,
-        toolchainRegistry: toolchainRegistry
-      )
+        toolchainRegistry: self.toolchainRegistry,
+        buildSetup: self.buildSetup)
     } else if let path = req.params.rootPath {
       self.workspace = try? Workspace(
         url: URL(fileURLWithPath: path),
         clientCapabilities: req.params.capabilities,
-        toolchainRegistry: toolchainRegistry
-      )
+        toolchainRegistry: self.toolchainRegistry,
+        buildSetup: self.buildSetup)
     }
 
     if self.workspace == nil {
@@ -229,7 +236,8 @@ extension SourceKitServer {
         rootPath: nil,
         clientCapabilities: req.params.capabilities,
         buildSettings: BuildSystemList(),
-        index: nil
+        index: nil,
+        buildSetup: self.buildSetup
       )
     }
 

Sources/SourceKit/Workspace.swift

@@ -15,6 +15,7 @@ import SKCore
 import SKSupport
 import IndexStoreDB
 import Basic
+import Utility
 import SKSwiftPMWorkspace
 
 /// Represents the configuration and sate of a project or combination of projects being worked on
@@ -34,6 +35,9 @@ public final class Workspace {
   /// The build settings provider to use for documents in this workspace.
   public let buildSettings: BuildSystem
 
+  /// Build setup
+  public let buildSetup: BuildSetup
+
   /// The source code index, if available.
   public var index: IndexStoreDB? = nil
 
@@ -47,12 +51,14 @@ public final class Workspace {
     rootPath: AbsolutePath?,
     clientCapabilities: ClientCapabilities,
     buildSettings: BuildSystem,
-    index: IndexStoreDB?)
+    index: IndexStoreDB?,
+    buildSetup: BuildSetup)
   {
     self.rootPath = rootPath
     self.clientCapabilities = clientCapabilities
     self.buildSettings = buildSettings
     self.index = index
+    self.buildSetup = buildSetup
   }
 
   /// Creates a workspace for a given root `URL`, inferring the `ExternalWorkspace` if possible.
@@ -64,17 +70,23 @@ public final class Workspace {
   public init(
     url: URL,
     clientCapabilities: ClientCapabilities,
-    toolchainRegistry: ToolchainRegistry
+    toolchainRegistry: ToolchainRegistry,
+    buildSetup: BuildSetup
   ) throws {
 
+    self.buildSetup = buildSetup
+
     self.rootPath = try AbsolutePath(validating: url.path)
     self.clientCapabilities = clientCapabilities
     let settings = BuildSystemList()
     self.buildSettings = settings
 
     settings.providers.insert(CompilationDatabaseBuildSystem(projectRoot: rootPath), at: 0)
 
-    if let swiftpm = SwiftPMWorkspace(url: url, toolchainRegistry: toolchainRegistry) {
+    if let swiftpm = SwiftPMWorkspace(url: url,
+                                      toolchainRegistry: toolchainRegistry,
+                                      buildSetup: buildSetup
+      ) {
       settings.providers.insert(swiftpm, at: 0)
     }