[WIP] Fully support cross-compilation model based on destination.json

docs/settings.md

@@ -58,11 +58,22 @@ This is a list of environment variables to set when running swift (build, resolv
 
 - **Runtime Path**
 
-Where to find Swift runtime libraries. This is mainly of use when these libraries cannot be discovered via the RPATH. On Windows the runtime path is added to the `Path` environment variable. This is of less use on macOS and Linux but will be added to `DYLD_LIBRARY_PATH` and `LD_LIBRARY_PATH` environment variables respectively on each platform. This is of use when supporting non-standard SDK layouts on Windows
+Where to find Swift runtime libraries. This is mainly of use when these libraries cannot be discovered via the RPATH. On Windows the runtime path is added to the `Path` environment variable. This is of less use on macOS and Linux but will be added to `DYLD_LIBRARY_PATH` and `LD_LIBRARY_PATH` environment variables respectively on each platform.
 
-- **SDK**
+- **Destination**
 
-The path of the target SDK to compile against. The default SDK is determined by the environment on macOS and Windows. This is of use when supporting non-standard SDK layouts on Windows and using custom SDKs. This adds the `--sdk` command line parameter to the relevant `swift` calls.
+The build destination for SwiftPM projects. If the value is a string, the plugin will load the `destination.json` file at the given path. If the value is an object, the plugin will map the value as follows and generate the `destination.json` automatically.
+
+| Configuration key | Description | `destination.json` key | Default value |
+|---|---|---|---|
+| `target`| The target triple of build destination. | `target` | `null` |
+| `sdk` | The path of the SDK to build against. | `sdk` | `null` |
+| `binDir` | The path of the folder containing tool binaries. | `toolchain-bin-dir` | The `usr/bin` subdirectory of the Swift toolchain. |
+| `extraSwiftCFlags` | Additional arguments to pass to the Swift compiler. | `extra-swiftc-flags` | `[]` |
+| `extraCCFlags` | Additional arguments to pass to the C compiler. | `extra-cc-flags` | `[]` |
+| `extraCPPFlags` | Additional arguments to pass to the C++ compiler. | `extra-cpp-flags` | `[]` |
+
+Hot reload is available for either way of specifying build destination.
 
 - **Diagnostics**
 

package.json

@@ -216,10 +216,49 @@
             "description": "The path of the folder containing the Swift runtime libraries. Only effective when they can't be discovered by RPath.",
             "order": 2
           },
-          "swift.SDK": {
-            "type": "string",
+          "swift.destination": {
+            "type": [
+              "object",
+              "string"
+            ],
+            "properties": {
+              "target": {
+                "type": "string",
+                "default": "",
+                "description": "The target triple of build destination."
+              },
+              "sdk": {
+                "type": "string",
+                "default": "",
+                "description": "The path of the SDK to build against."
+              },
+              "binDir": {
+                "type": "string",
+                "default": "",
+                "description": "The path of the folder containing tool binaries. The default is to look in current toolchain."
+              },
+              "extraSwiftCFlags": {
+                "type": "array",
+                "items": "string",
+                "default": [],
+                "description": "Additional arguments to pass to the Swift compiler."
+              },
+              "extraCCFlags": {
+                "type": "array",
+                "items": "string",
+                "default": [],
+                "description": "Additional arguments to pass to the C compiler."
+              },
+              "extraCPPFlags": {
+                "type": "array",
+                "items": "string",
+                "default": [],
+                "description": "Additional arguments to pass to the C++ compiler."
+              }
+            },
+            "additionalProperties": false,
             "default": "",
-            "description": "The path of the SDK to compile against (`--sdk` parameter). The default SDK is determined by the environment on macOS and Windows.",
+            "markdownDescription": "Destination configuration object or path to the `destination.json` file.",
             "order": 3
           },
           "swift.diagnostics": {
@@ -433,4 +472,4 @@
     "plist": "^3.0.5",
     "vscode-languageclient": "^8.0.0"
   }
-}
+}

src/SwiftPluginTaskProvider.ts

@@ -17,7 +17,7 @@ import * as path from "path";
 import { WorkspaceContext } from "./WorkspaceContext";
 import { PackagePlugin } from "./SwiftPackage";
 import configuration from "./configuration";
-import { getSwiftExecutable, swiftRuntimeEnv, withSwiftSDKFlags } from "./utilities/utilities";
+import { getSwiftExecutable, swiftRuntimeEnv, withSwiftFlags } from "./utilities/utilities";
 
 // Interface class for defining task configuration
 interface TaskConfig {
@@ -80,7 +80,7 @@ export class SwiftPluginTaskProvider implements vscode.TaskProvider {
             task.definition.command,
             ...task.definition.args,
         ];
-        swiftArgs = withSwiftSDKFlags(swiftArgs);
+        swiftArgs = withSwiftFlags(swiftArgs, undefined);
 
         const newTask = new vscode.Task(
             task.definition,
@@ -108,7 +108,7 @@ export class SwiftPluginTaskProvider implements vscode.TaskProvider {
     createSwiftPluginTask(plugin: PackagePlugin, args: string[], config: TaskConfig): vscode.Task {
         const swift = getSwiftExecutable();
         let swiftArgs = ["package", plugin.command, ...args];
-        swiftArgs = withSwiftSDKFlags(swiftArgs);
+        swiftArgs = withSwiftFlags(swiftArgs, undefined);
 
         // Add relative path current working directory
         const relativeCwd = path.relative(config.scope.uri.fsPath, config.cwd?.fsPath);

src/SwiftTaskProvider.ts

@@ -18,8 +18,9 @@ import { WorkspaceContext } from "./WorkspaceContext";
 import { FolderContext } from "./FolderContext";
 import { Product } from "./SwiftPackage";
 import configuration from "./configuration";
-import { getSwiftExecutable, swiftRuntimeEnv, withSwiftSDKFlags } from "./utilities/utilities";
+import { getSwiftExecutable, swiftRuntimeEnv, withSwiftFlags } from "./utilities/utilities";
 import { Version } from "./utilities/version";
+import { Destination } from "./toolchain/destination";
 
 /**
  * References:
@@ -40,6 +41,7 @@ interface TaskConfig {
     problemMatcher?: string | string[];
     presentationOptions?: vscode.TaskPresentationOptions;
     prefix?: string;
+    destination?: Destination;
 }
 
 /** flag for enabling test discovery */
@@ -92,6 +94,7 @@ export function createBuildAllTask(folderContext: FolderContext): vscode.Task {
                 reveal: vscode.TaskRevealKind.Silent,
             },
             problemMatcher: configuration.problemMatchCompileErrors ? "$swiftc" : undefined,
+            destination: folderContext.workspaceContext.toolchain.destination,
         }
     );
 }
@@ -160,6 +163,7 @@ function createBuildTasks(product: Product, folderContext: FolderContext): vscod
                     reveal: vscode.TaskRevealKind.Silent,
                 },
                 problemMatcher: configuration.problemMatchCompileErrors ? "$swiftc" : undefined,
+                destination: folderContext.workspaceContext.toolchain.destination,
             }
         ),
         createSwiftTask(
@@ -173,6 +177,7 @@ function createBuildTasks(product: Product, folderContext: FolderContext): vscod
                     reveal: vscode.TaskRevealKind.Silent,
                 },
                 problemMatcher: configuration.problemMatchCompileErrors ? "$swiftc" : undefined,
+                destination: folderContext.workspaceContext.toolchain.destination,
             }
         ),
     ];
@@ -183,7 +188,7 @@ function createBuildTasks(product: Product, folderContext: FolderContext): vscod
  */
 export function createSwiftTask(args: string[], name: string, config: TaskConfig): vscode.Task {
     const swift = getSwiftExecutable();
-    args = withSwiftSDKFlags(args);
+    args = withSwiftFlags(args, config.destination);
 
     // Add relative path current working directory
     const cwd = config.cwd.fsPath;

src/WorkspaceContext.ts

@@ -157,9 +157,9 @@ export class WorkspaceContext implements vscode.Disposable {
     }
 
     /** Get swift version and create WorkspaceContext */
-    static async create(): Promise<WorkspaceContext> {
+    static async create(context: vscode.ExtensionContext): Promise<WorkspaceContext> {
         const tempFolder = await TemporaryFolder.create();
-        const toolchain = await SwiftToolchain.create();
+        const toolchain = await SwiftToolchain.create(context.storageUri!);
         return new WorkspaceContext(tempFolder, toolchain);
     }
 

src/configuration.ts

@@ -24,6 +24,22 @@ export interface LSPConfiguration {
     readonly inlayHintsEnabled: boolean;
 }
 
+/** build destination configuration */
+export interface DestinationConfiguration {
+    /** Target triple */
+    target: string | undefined;
+    /** Path to destination SDK */
+    sdk: string | undefined;
+    /** Path to tools directory */
+    binDir: string | undefined;
+    /** Extra arguments to pass to Swift compiler */
+    extraSwiftCFlags: string[] | undefined;
+    /** Extra arguments to pass to C compiler */
+    extraCCFlags: string[] | undefined;
+    /** Extra arguments to pass to C++ compiler */
+    extraCPPFlags: string[] | undefined;
+}
+
 /**
  * Type-safe wrapper around configuration settings.
  */
@@ -49,6 +65,14 @@ const configuration = {
         };
     },
 
+    /** build destination configuration */
+    get destination(): DestinationConfiguration | string {
+        const configuration = vscode.workspace
+            .getConfiguration("swift")
+            .get<string | DestinationConfiguration>("destination", "");
+        return configuration;
+    },
+
     /** Files and directories to exclude from the Package Dependencies view. */
     get excludePathsFromPackageDependencies(): string[] {
         return vscode.workspace
@@ -69,10 +93,6 @@ const configuration = {
     get runtimePath(): string {
         return vscode.workspace.getConfiguration("swift").get<string>("runtimePath", "");
     },
-    /** Path to custom swift sdk */
-    get sdk(): string {
-        return vscode.workspace.getConfiguration("swift").get<string>("SDK", "");
-    },
     /** swift build arguments */
     get buildArguments(): string[] {
         return vscode.workspace.getConfiguration("swift").get<string[]>("buildArguments", []);

src/debugger/launch.ts

@@ -197,7 +197,7 @@ export function createTestConfiguration(
         if (xcTestPath !== runtimePath) {
             testEnv.Path = `${xcTestPath};${testEnv.Path ?? process.env.Path}`;
         }
-        const sdkroot = configuration.sdk === "" ? process.env.SDKROOT : configuration.sdk;
+        const sdkroot = ctx.workspaceContext.toolchain.targetSDK;
         if (sdkroot === undefined) {
             return null;
         }

src/extension.ts

@@ -39,7 +39,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<Api> {
     try {
         console.debug("Activating Swift for Visual Studio Code...");
 
-        const workspaceContext = await WorkspaceContext.create();
+        const workspaceContext = await WorkspaceContext.create(context);
 
         context.subscriptions.push(workspaceContext);
 

src/sourcekit-lsp/LanguageClientManager.ts

@@ -20,7 +20,6 @@ import {
     filterArguments,
     getSwiftExecutable,
     isPathInsidePath,
-    swiftDriverSDKFlags,
     buildPathFlags,
     swiftRuntimeEnv,
 } from "../utilities/utilities";
@@ -29,6 +28,7 @@ import { FolderEvent, WorkspaceContext } from "../WorkspaceContext";
 import { activateLegacyInlayHints } from "./inlayHints";
 import { FolderContext } from "../FolderContext";
 import { LanguageClient } from "vscode-languageclient/node";
+import { Destination } from "../toolchain/destination";
 
 /** Manages the creation and destruction of Language clients as we move between
  * workspace folders
@@ -80,11 +80,13 @@ export class LanguageClientManager {
     // used by single server support to keep a record of the project folders
     // that are not at the root of their workspace
     private subFolderWorkspaces: vscode.Uri[];
+    private destination?: Destination;
 
     constructor(public workspaceContext: WorkspaceContext) {
         this.singleServerSupport = workspaceContext.swiftVersion >= new Version(5, 7, 0);
         this.subscriptions = [];
         this.subFolderWorkspaces = [];
+        this.destination = workspaceContext.toolchain.destination;
         if (this.singleServerSupport) {
             // add/remove folders from server
             const observeFoldersDisposable = workspaceContext.observeFolders(
@@ -343,8 +345,8 @@ export class LanguageClientManager {
         const serverPathConfig = lspConfig.serverPath;
         const serverPath =
             serverPathConfig.length > 0 ? serverPathConfig : getSwiftExecutable("sourcekit-lsp");
-        const sdkArguments = [
-            ...swiftDriverSDKFlags(true),
+        const extraArguments = [
+            ...(this.destination?.extraSourcekitLSPFlags ?? []),
             ...filterArguments(
                 configuration.buildArguments.concat(buildPathFlags()),
                 LanguageClientManager.buildArgumentFilter
@@ -353,7 +355,7 @@ export class LanguageClientManager {
 
         const sourcekit: langclient.Executable = {
             command: serverPath,
-            args: lspConfig.serverArguments.concat(sdkArguments),
+            args: lspConfig.serverArguments.concat(extraArguments),
             options: {
                 env: {
                     ...process.env,