From 4a6d816275fbee49540170e63a7db49ea472c34f Mon Sep 17 00:00:00 2001
From: Saleem Abdulrasool <compnerd@compnerd.org>
Date: Fri, 26 May 2023 09:41:01 -0700
Subject: [PATCH] WiX: version the installations of the toolchain, devtools,
 runtime

These packages are meant to be parallel installed with different
releases except in the case of development releases.  Wire up the
package version information into the path.
---
 platforms/Windows/devtools-amd64.wxs  |  3 ++-
 platforms/Windows/devtools-arm64.wxs  |  3 ++-
 platforms/Windows/runtime-amd64.wxs   |  8 ++++----
 platforms/Windows/runtime-arm64.wxs   |  6 +++---
 platforms/Windows/runtime-x86.wxs     |  8 ++++----
 platforms/Windows/toolchain-amd64.wxs | 16 ++++------------
 platforms/Windows/toolchain-arm64.wxs | 16 ++++------------
 platforms/Windows/version.wxi         | 11 +++++++++++
 8 files changed, 34 insertions(+), 37 deletions(-)
 create mode 100644 platforms/Windows/version.wxi

diff --git a/platforms/Windows/devtools-amd64.wxs b/platforms/Windows/devtools-amd64.wxs
index 08c3b648..9a5660b1 100644
--- a/platforms/Windows/devtools-amd64.wxs
+++ b/platforms/Windows/devtools-amd64.wxs
@@ -1,4 +1,5 @@
 <Wix xmlns="http://wixtoolset.org/schemas/v4/wxs" xmlns:ui="http://wixtoolset.org/schemas/v4/wxs/ui">
+  <?include version.wxi?>
   <Package
       Language="1033"
       Manufacturer="swift.org"
@@ -18,7 +19,7 @@
         <Directory Id="Library" Name="Library">
           <Directory Id="Developer" Name="Developer">
             <Directory Id="Toolchains" Name="Toolchains">
-              <Directory Id="xctoolchain" Name="unknown-Asserts-development.xctoolchain">
+              <Directory Id="xctoolchain" Name="$(var.ToolchainName)">
                 <Directory Id="_usr" Name="usr">
                   <Directory Id="_usr_bin" Name="bin">
                   </Directory>
diff --git a/platforms/Windows/devtools-arm64.wxs b/platforms/Windows/devtools-arm64.wxs
index 3fd8fc1a..7ff26d80 100644
--- a/platforms/Windows/devtools-arm64.wxs
+++ b/platforms/Windows/devtools-arm64.wxs
@@ -1,4 +1,5 @@
 <Wix xmlns="http://wixtoolset.org/schemas/v4/wxs" xmlns:ui="http://wixtoolset.org/schemas/v4/wxs/ui">
+  <?include version.wxi?>
   <Package
       Language="1033"
       Manufacturer="swift.org"
@@ -18,7 +19,7 @@
         <Directory Id="Library" Name="Library">
           <Directory Id="Developer" Name="Developer">
             <Directory Id="Toolchains" Name="Toolchains">
-              <Directory Id="xctoolchain" Name="unknown-Asserts-development.xctoolchain">
+              <Directory Id="xctoolchain" Name="$(var.ToolchainName)">
                 <Directory Id="_usr" Name="usr">
                   <Directory Id="_usr_bin" Name="bin">
                   </Directory>
diff --git a/platforms/Windows/runtime-amd64.wxs b/platforms/Windows/runtime-amd64.wxs
index 9e21e300..eec196c5 100644
--- a/platforms/Windows/runtime-amd64.wxs
+++ b/platforms/Windows/runtime-amd64.wxs
@@ -1,4 +1,5 @@
 <Wix xmlns="http://wixtoolset.org/schemas/v4/wxs" xmlns:ui="http://wixtoolset.org/schemas/v4/wxs/ui">
+  <?include version.wxi?>
   <Package
       Language="1033"
       Manufacturer="swift.org"
@@ -13,8 +14,7 @@
     <!-- Directory Structure -->
     <StandardDirectory Id="ProgramFiles64Folder">
       <Directory Id="INSTALLDIR" Name="Swift">
-        <!-- TODO(compnerd) use $(var.ProductVersion) -->
-        <Directory Id="_" Name="runtime-development">
+        <Directory Id="_" Name="$(var.RuntimeName)">
           <Directory Id="_usr" Name="usr">
             <Directory Id="_usr_bin" Name="bin">
             </Directory>
@@ -90,9 +90,9 @@
     </ComponentGroup>
 
     <Component Id="EnvironmentVariables" Directory="INSTALLDIR" Guid="f249625e-aacd-4b17-a464-8f8df05ba5f3">
-      <Environment Id="Path" Action="set" Name="Path" Part="last" Permanent="no" System="yes" Value="[INSTALLDIR]runtime-development\usr\bin" />
+      <Environment Id="Path" Action="set" Name="Path" Part="last" Permanent="no" System="yes" Value="[INSTALLDIR]$(var.RuntimeName)\usr\bin" />
     </Component>
-    
+
     <!-- Feature -->
     <Feature Id="WinX64SwiftRuntime" AllowAbsent="no" AllowAdvertise="yes" ConfigurableDirectory="INSTALLDIR" Description="Swift Runtime for Windows x86_64" Level="1" Title="Swift Runtime for Windows x86_64">
       <ComponentGroupRef Id="SwiftRuntime" />
diff --git a/platforms/Windows/runtime-arm64.wxs b/platforms/Windows/runtime-arm64.wxs
index 81c5414d..c0101d63 100644
--- a/platforms/Windows/runtime-arm64.wxs
+++ b/platforms/Windows/runtime-arm64.wxs
@@ -1,4 +1,5 @@
 <Wix xmlns="http://wixtoolset.org/schemas/v4/wxs" xmlns:ui="http://wixtoolset.org/schemas/v4/wxs/ui">
+  <?include version.wxi?>
   <Package
       Language="1033"
       Manufacturer="swift.org"
@@ -13,8 +14,7 @@
     <!-- Directory Structure -->
     <StandardDirectory Id="ProgramFiles64Folder">
       <Directory Id="INSTALLDIR" Name="Swift">
-        <!-- TODO(compnerd) use $(var.ProductVersion) -->
-        <Directory Id="_" Name="runtime-development">
+        <Directory Id="_" Name="$(var.RuntimeName)">
           <Directory Id="_usr" Name="usr">
             <Directory Id="_usr_bin" Name="bin">
             </Directory>
@@ -90,7 +90,7 @@
     </ComponentGroup>
 
     <Component Id="EnvironmentVariables" Directory="INSTALLDIR" Guid="8681d813-eb32-46f9-8b1c-f622b38b5eaf">
-      <Environment Id="Path" Action="set" Name="Path" Part="last" Permanent="no" System="yes" Value="[INSTALLDIR]runtime-development\usr\bin" />
+      <Environment Id="Path" Action="set" Name="Path" Part="last" Permanent="no" System="yes" Value="[INSTALLDIR]$(var.RuntimeName)\usr\bin" />
     </Component>
 
     <!-- Feature -->
diff --git a/platforms/Windows/runtime-x86.wxs b/platforms/Windows/runtime-x86.wxs
index 03da6202..0708198e 100644
--- a/platforms/Windows/runtime-x86.wxs
+++ b/platforms/Windows/runtime-x86.wxs
@@ -1,4 +1,5 @@
 <Wix xmlns="http://wixtoolset.org/schemas/v4/wxs" xmlns:ui="http://wixtoolset.org/schemas/v4/wxs/ui">
+  <?include version.wxi?>
   <Package
       Language="1033"
       Manufacturer="swift.org"
@@ -7,14 +8,13 @@
       Version="$(var.ProductVersion)"
       Scope="perMachine">
     <SummaryInformation Description="Swift Runtime for Windows i686" />
-    
+
     <Media Id="1" Cabinet="runtime.cab" EmbedCab="yes" />
 
     <!-- Directory Structure -->
     <StandardDirectory Id="ProgramFilesFolder">
       <Directory Id="INSTALLDIR" Name="Swift">
-        <!-- TODO(compnerd) use $(var.ProductVersion) -->
-        <Directory Id="_" Name="runtime-development">
+        <Directory Id="_" Name="$(var.RuntimeName)">
           <Directory Id="_usr" Name="usr">
             <Directory Id="_usr_bin" Name="bin">
             </Directory>
@@ -90,7 +90,7 @@
     </ComponentGroup>
 
     <Component Id="EnvironmentVariables" Directory="INSTALLDIR" Guid="3b4386ac-3341-407d-b946-6e670f4a83f6">
-      <Environment Id="Path" Action="set" Name="Path" Part="last" Permanent="no" System="yes" Value="[INSTALLDIR]runtime-development\usr\bin" />
+      <Environment Id="Path" Action="set" Name="Path" Part="last" Permanent="no" System="yes" Value="[INSTALLDIR]$(var.RuntimeName)\usr\bin" />
     </Component>
 
     <!-- Feature -->
diff --git a/platforms/Windows/toolchain-amd64.wxs b/platforms/Windows/toolchain-amd64.wxs
index 3139063f..a512f4a2 100644
--- a/platforms/Windows/toolchain-amd64.wxs
+++ b/platforms/Windows/toolchain-amd64.wxs
@@ -1,4 +1,5 @@
 <Wix xmlns="http://wixtoolset.org/schemas/v4/wxs" xmlns:ui="http://wixtoolset.org/schemas/v4/wxs/ui">
+  <?include version.wxi?>
   <Package
       Language="1033"
       Manufacturer="swift.org"
@@ -26,17 +27,8 @@
         <Directory Id="Library" Name="Library">
           <Directory Id="Developer" Name="Developer">
             <Directory Id="Toolchains" Name="Toolchains">
-              <!-- TODO(compnerd):
-                This really should be
-                unknown-Asserts-$(var.ProductVersion).xctoolchain,
-                though before changing, we should setup a
-                `unknown-Asserts-current.xctoolchain`
-                symlink. Additionally, beware that the environment chagnes
-                below will need to be updated to reflect this change. Ideally,
-                we would have as part of this a tool to select the different
-                toolchain versions.
-              -->
-              <Directory Id="xctoolchain" Name="unknown-Asserts-development.xctoolchain">
+              <!-- TODO(compnerd) We should setup a `unknown-Asserts-current.xctoolchain` symlink  -->
+              <Directory Id="xctoolchain" Name="$(var.ToolchainName)">
                 <Directory Id="_usr" Name="usr">
                   <Directory Id="_usr_bin" Name="bin">
                   </Directory>
@@ -544,7 +536,7 @@
 
     <Component Id="EnvironmentVariables" Directory="INSTALLDIR" Guid="d01ea5b8-0f8a-4388-9b61-1186efddfc39">
       <Environment Id="DeveloperDir" Action="set" Name="DEVELOPER_DIR" Part="all" Permanent="no" System="yes" Value="[INSTALLDIR]Library\Developer" />
-      <Environment Id="Path" Action="set" Name="Path" Part="last" Permanent="no" System="yes" Value="[INSTALLDIR]Library\Developer\Toolchains\unknown-Asserts-development.xctoolchain\usr\bin" />
+      <Environment Id="Path" Action="set" Name="Path" Part="last" Permanent="no" System="yes" Value="[INSTALLDIR]Library\Developer\Toolchains\$(var.ToolchainName)\usr\bin" />
     </Component>
 
     <Feature Id="Toolchain" AllowAbsent="no" AllowAdvertise="yes" ConfigurableDirectory="INSTALLDIR" Description="Swift Toolchain for Windows x86_64" Level="1" Title="Swift Toolchain for Windows x86_64">
diff --git a/platforms/Windows/toolchain-arm64.wxs b/platforms/Windows/toolchain-arm64.wxs
index 8776df5d..1730b8bb 100644
--- a/platforms/Windows/toolchain-arm64.wxs
+++ b/platforms/Windows/toolchain-arm64.wxs
@@ -1,4 +1,5 @@
 <Wix xmlns="http://wixtoolset.org/schemas/v4/wxs" xmlns:ui="http://wixtoolset.org/schemas/v4/wxs/ui">
+  <?include version.wxs?>
   <Package
       Language="1033"
       Manufacturer="swift.org"
@@ -26,17 +27,8 @@
         <Directory Id="Library" Name="Library">
           <Directory Id="Developer" Name="Developer">
             <Directory Id="Toolchains" Name="Toolchains">
-              <!-- TODO(compnerd):
-                This really should be
-                unknown-Asserts-$(var.ProductVersion).xctoolchain,
-                though before changing, we should setup a
-                `unknown-Asserts-current.xctoolchain`
-                symlink. Additionally, beware that the environment chagnes
-                below will need to be updated to reflect this change. Ideally,
-                we would have as part of this a tool to select the different
-                toolchain versions.
-              -->
-              <Directory Id="xctoolchain" Name="unknown-Asserts-development.xctoolchain">
+              <!-- TODO(compnerd) We should setup a `unknown-Asserts-current.xctoolchain` symlink  -->
+              <Directory Id="xctoolchain" Name="$(var.ToolchainName)">
                 <Directory Id="_usr" Name="usr">
                   <Directory Id="_usr_bin" Name="bin">
                   </Directory>
@@ -544,7 +536,7 @@
 
     <Component Id="EnvironmentVariables" Directory="INSTALLDIR" Guid="d01ea5b8-0f8a-4388-9b61-1186efddfc39">
       <Environment Id="DeveloperDir" Action="set" Name="DEVELOPER_DIR" Part="all" Permanent="no" System="yes" Value="[INSTALLDIR]Library\Developer" />
-      <Environment Id="Path" Action="set" Name="Path" Part="last" Permanent="no" System="yes" Value="[INSTALLDIR]Library\Developer\Toolchains\unknown-Asserts-development.xctoolchain\usr\bin" />
+      <Environment Id="Path" Action="set" Name="Path" Part="last" Permanent="no" System="yes" Value="[INSTALLDIR]Library\Developer\Toolchains\$(var.ToolchainName)\usr\bin" />
     </Component>
 
     <Feature Id="Toolchain" AllowAbsent="no" AllowAdvertise="yes" ConfigurableDirectory="INSTALLDIR" Description="Swift Toolchain for Windows aarch64" Level="1" Title="Swift Toolchain for Windows aarch64">
diff --git a/platforms/Windows/version.wxi b/platforms/Windows/version.wxi
new file mode 100644
index 00000000..c16f26bc
--- /dev/null
+++ b/platforms/Windows/version.wxi
@@ -0,0 +1,11 @@
+<?xml version='1.0' encoding='utf-8'?>
+
+<Include>
+<?if $(var.ProductVersion) = "0.0.0"?>
+<?define RuntimeName = "runtime-development"?>
+<?define ToolchainName = "unknown-Asserts-development.xctoolchain"?>
+<?else?>
+<?define RuntimeName = "runtime-$(var.ProductVersion)"?>
+<?define ToolchainName = "unknown-Asserts-$(var.ProductVersion).xctoolchain"?>
+<?endif?>
+</Include>