WIP

Author: stevapple

package.json

@@ -184,6 +184,17 @@
           }
         }
       },
+      {
+        "title": "Cross compilation (Experimental)",
+        "properties": {
+          "destination.SDK": {
+            "type": "string",
+            "default": "",
+            "description": "The path of the SDK to compile against. The default SDK is determined by the environment on macOS and Windows.",
+            "order": 1
+          }
+        }
+      },
       {
         "title": "Advanced",
         "properties": {
@@ -193,12 +204,6 @@
             "description": "The path of the folder containing the Swift runtime libraries. Only effective when they can't be discovered by RPath.",
             "order": 1
           },
-          "swift.SDK": {
-            "type": "string",
-            "default": "",
-            "description": "The path of the SDK to compile against. The default SDK is determined by the environment on macOS and Windows.",
-            "order": 2
-          },
           "swift.diagnostics": {
             "type": "boolean",
             "default": false,

src/SwiftTaskProvider.ts

@@ -17,7 +17,11 @@ 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,
+    withSwiftDestinationFlags,
+} from "./utilities/utilities";
 import { Version } from "./utilities/version";
 
 /**
@@ -180,7 +184,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 = withSwiftDestinationFlags(args);
     const task = new vscode.Task(
         { type: "swift", command: swift, args: args, cwd: config?.cwd?.fsPath },
         config?.scope ?? vscode.TaskScope.Workspace,

src/WorkspaceContext.ts

@@ -66,21 +66,6 @@ export class WorkspaceContext implements vscode.Disposable {
                         }
                     });
             }
-            // on sdk config change, restart sourcekit-lsp
-            if (event.affectsConfiguration("swift.SDK")) {
-                // FIXME: There is a bug stopping us from restarting SourceKit-LSP directly.
-                // As long as it's fixed we won't need to reload on newer versions.
-                vscode.window
-                    .showInformationMessage(
-                        "Changing the Swift SDK path requires the project be reloaded.",
-                        "Ok"
-                    )
-                    .then(selected => {
-                        if (selected === "Ok") {
-                            vscode.commands.executeCommand("workbench.action.reloadWindow");
-                        }
-                    });
-            }
             // on runtime path config change, regenerate launch.json
             if (event.affectsConfiguration("swift.runtimePath")) {
                 if (!configuration.autoGenerateLaunchConfigurations) {
@@ -100,6 +85,21 @@ export class WorkspaceContext implements vscode.Disposable {
                         }
                     });
             }
+            // on destination config change, restart sourcekit-lsp
+            if (event.affectsConfiguration("destination.SDK")) {
+                // FIXME: There is a bug stopping us from restarting SourceKit-LSP directly.
+                // As long as it's fixed we won't need to reload on newer versions.
+                vscode.window
+                    .showInformationMessage(
+                        "Changing the destination SDK path requires the project be reloaded.",
+                        "Ok"
+                    )
+                    .then(selected => {
+                        if (selected === "Ok") {
+                            vscode.commands.executeCommand("workbench.action.reloadWindow");
+                        }
+                    });
+            }
         });
         const backgroundCompilationOnDidSave = BackgroundCompilation.start(this);
         this.subscriptions = [

src/configuration.ts

@@ -24,6 +24,12 @@ export interface LSPConfiguration {
     readonly inlayHintsEnabled: boolean;
 }
 
+/** destination configuration */
+export interface DestinationConfiguration {
+    /** Path to destination sdk */
+    readonly sdk: string;
+}
+
 /**
  * Type-safe wrapper around configuration settings.
  */
@@ -48,6 +54,14 @@ const configuration = {
             },
         };
     },
+    /** destination configuration */
+    get destination(): DestinationConfiguration {
+        return {
+            get sdk(): string {
+                return vscode.workspace.getConfiguration("destination").get<string>("SDK", "");
+            },
+        };
+    },
 
     /** Files and directories to exclude from the Package Dependencies view. */
     get excludePathsFromPackageDependencies(): string[] {
@@ -69,10 +83,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

@@ -183,7 +183,10 @@ 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 =
+            configuration.destination.sdk === ""
+                ? process.env.SDKROOT
+                : configuration.destination.sdk;
         if (sdkroot === undefined) {
             return null;
         }

src/sourcekit-lsp/LanguageClientManager.ts

@@ -18,7 +18,7 @@ import configuration from "../configuration";
 import {
     getSwiftExecutable,
     isPathInsidePath,
-    swiftDriverSDKFlags,
+    swiftDriverDestinationFlags,
     swiftRuntimeEnv,
 } from "../utilities/utilities";
 import { Version } from "../utilities/version";
@@ -243,7 +243,7 @@ export class LanguageClientManager {
         const serverPathConfig = lspConfig.serverPath;
         const serverPath =
             serverPathConfig.length > 0 ? serverPathConfig : getSwiftExecutable("sourcekit-lsp");
-        const sdkArguments = swiftDriverSDKFlags(true);
+        const sdkArguments = swiftDriverDestinationFlags(true);
         const sourcekit: langclient.Executable = {
             command: serverPath,
             args: lspConfig.serverArguments.concat(sdkArguments),

src/toolchain/toolchain.ts

@@ -178,7 +178,8 @@ export class SwiftToolchain {
      * @returns path to custom SDK
      */
     private static getCustomSDK(): string | undefined {
-        return configuration.sdk !== "" ? configuration.sdk : undefined;
+        const destination = configuration.destination;
+        return destination.sdk !== "" ? destination.sdk : undefined;
     }
 
     /**

src/utilities/utilities.ts

@@ -137,67 +137,69 @@ export async function execFileStreamOutput(
  *
  * @param args array of arguments to pass to swift executable
  * @param options execution options
- * @param setSDKFlags whether to set SDK flags
+ * @param setDestinationFlags whether to set destination flags
  */
 export async function execSwift(
     args: string[],
     options: cp.ExecFileOptions = {},
-    setSDKFlags = false,
+    setDestinationFlags = false,
     folderContext?: FolderContext
 ): Promise<{ stdout: string; stderr: string }> {
     const swift = getSwiftExecutable();
-    if (setSDKFlags) {
-        args = withSwiftSDKFlags(args);
+    if (setDestinationFlags) {
+        args = withSwiftDestinationFlags(args);
     }
     return await execFile(swift, args, options, folderContext);
 }
 
 /**
- * Get modified swift arguments with SDK flags.
+ * Get modified swift arguments with config-based destination flags.
  *
  * @param args original commandline arguments
  */
-export function withSwiftSDKFlags(args: string[]): string[] {
+export function withSwiftDestinationFlags(args: string[]): string[] {
     switch (args.length > 0 ? args[0] : null) {
         case "package": {
-            // swift-package requires SDK flags to be placed before subcommand options
+            // swift-package requires destination flags to be placed before arguments
             // eg. ["package", "describe", "--type", "json"] should be turned into
             // ["package", "describe", "--sdk", "/path/to/sdk", "--type", "json"]
             if (args.length <= 2) {
-                return args.concat(swiftpmSDKFlags());
+                return args.concat(swiftpmDestinationFlags());
             }
             const subcommand = args.splice(0, 2);
-            return [...subcommand, ...swiftpmSDKFlags(), ...args];
+            return [...subcommand, ...swiftpmDestinationFlags(), ...args];
         }
         case "build":
         case "run":
         case "test":
-            return args.concat(swiftpmSDKFlags());
+            return args.concat(swiftpmDestinationFlags());
         default:
-            return args.concat(swiftDriverSDKFlags());
+            return args.concat(swiftDriverDestinationFlags());
     }
 }
 
 /**
- * Get SDK flags for SwiftPM
+ * Get destination flags for SwiftPM
  */
-export function swiftpmSDKFlags(): string[] {
-    if (configuration.sdk !== "") {
-        return ["--sdk", configuration.sdk];
+export function swiftpmDestinationFlags(): string[] {
+    const destination = configuration.destination;
+    if (destination.sdk !== "") {
+        return ["--sdk", destination.sdk];
     }
     return [];
 }
 
 /**
- * Get SDK flags for swiftc
+ * Get destination flags for swiftc
  *
  * @param indirect whether to pass the flags by -Xswiftc
  */
-export function swiftDriverSDKFlags(indirect = false): string[] {
-    if (configuration.sdk === "") {
+export function swiftDriverDestinationFlags(indirect = false): string[] {
+    const destination = configuration.destination;
+    if (destination.sdk === "") {
         return [];
     }
-    const args = ["-sdk", configuration.sdk];
+    const args = ["-sdk", destination.sdk];
     return indirect ? args.flatMap(arg => ["-Xswiftc", arg]) : args;
 }