Support dual-purpose packages in Burn.bob/ConfigurableScopeBundles

Fixes https://github.com/wixtoolset/issues/issues/8958

5 files changed, 48 insertions, 14 deletions

diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/BootstrapperCommand.cs b/src/api/burn/WixToolset.BootstrapperApplicationApi/BootstrapperCommand.cs
index 612e8ce9..795a40d4 100644
--- a/src/api/burn/WixToolset.BootstrapperApplicationApi/BootstrapperCommand.cs
+++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/BootstrapperCommand.cs
@@ -20,6 +20,7 @@ namespace WixToolset.BootstrapperApplicationApi
         [MarshalAs(UnmanagedType.I4)] internal int cbSize;
         [MarshalAs(UnmanagedType.U4)] private readonly LaunchAction action;
         [MarshalAs(UnmanagedType.U4)] private readonly Display display;
+        [MarshalAs(UnmanagedType.U4)] private readonly BundleScope scope;
         private readonly IntPtr wzCommandLine;
         [MarshalAs(UnmanagedType.I4)] private readonly int nCmdShow;
         [MarshalAs(UnmanagedType.U4)] private readonly ResumeType resume;
@@ -39,6 +40,7 @@ namespace WixToolset.BootstrapperApplicationApi
             return new BootstrapperCommand(
                 this.action,
                 this.display,
+                this.scope,
                 Marshal.PtrToStringUni(this.wzCommandLine),
                 this.nCmdShow,
                 this.resume,
@@ -62,6 +64,7 @@ namespace WixToolset.BootstrapperApplicationApi
         public BootstrapperCommand(
             LaunchAction action,
             Display display,
+            BundleScope scope,
             string commandLine,
             int cmdShow,
             ResumeType resume,
@@ -74,6 +77,7 @@ namespace WixToolset.BootstrapperApplicationApi
         {
             this.Action = action;
             this.Display = display;
+            this.Scope = scope;
             this.CommandLine = commandLine;
             this.CmdShow = cmdShow;
             this.Resume = resume;
@@ -92,6 +96,9 @@ namespace WixToolset.BootstrapperApplicationApi
         public Display Display { get; }
 
         /// <inheritdoc/>
+        public BundleScope Scope { get; }
+
+        /// <inheritdoc/>
         public string CommandLine { get; }
 
         /// <inheritdoc/>
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/Engine.cs b/src/api/burn/WixToolset.BootstrapperApplicationApi/Engine.cs
index 25413790..82978b7d 100644
--- a/src/api/burn/WixToolset.BootstrapperApplicationApi/Engine.cs
+++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/Engine.cs
@@ -12,7 +12,7 @@ namespace WixToolset.BootstrapperApplicationApi
     /// </summary>
     public sealed class Engine : IEngine
     {
-        private IBootstrapperEngine engine;
+        private readonly IBootstrapperEngine engine;
 
         internal Engine(IBootstrapperEngine engine)
         {
@@ -24,8 +24,7 @@ namespace WixToolset.BootstrapperApplicationApi
         {
             get
             {
-                int count;
-                this.engine.GetPackageCount(out count);
+                this.engine.GetPackageCount(out var count);
 
                 return count;
             }
@@ -110,8 +109,7 @@ namespace WixToolset.BootstrapperApplicationApi
         /// <inheritdoc/>
         public bool EvaluateCondition(string condition)
         {
-            bool value;
-            this.engine.EvaluateCondition(condition, out value);
+            this.engine.EvaluateCondition(condition, out var value);
 
             return value;
         }
@@ -247,9 +245,9 @@ namespace WixToolset.BootstrapperApplicationApi
         }
 
         /// <inheritdoc/>
-        public void Plan(LaunchAction action)
+        public void Plan(LaunchAction action, BundleScope plannedScope)
         {
-            this.engine.Plan(action);
+            this.engine.Plan(action, plannedScope);
         }
 
         /// <inheritdoc/>
@@ -327,16 +325,16 @@ namespace WixToolset.BootstrapperApplicationApi
         /// <inheritdoc/>
         public int SendEmbeddedError(int errorCode, string message, int uiHint)
         {
-            int result = 0;
-            this.engine.SendEmbeddedError(errorCode, message, uiHint, out result);
+            this.engine.SendEmbeddedError(errorCode, message, uiHint, out var result);
+
             return result;
         }
 
         /// <inheritdoc/>
         public int SendEmbeddedProgress(int progressPercentage, int overallPercentage)
         {
-            int result = 0;
-            this.engine.SendEmbeddedProgress(progressPercentage, overallPercentage, out result);
+            this.engine.SendEmbeddedProgress(progressPercentage, overallPercentage, out var result);
+
             return result;
         }
 
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/IBootstrapperCommand.cs b/src/api/burn/WixToolset.BootstrapperApplicationApi/IBootstrapperCommand.cs
index a1f8bfe0..7a5a4cfd 100644
--- a/src/api/burn/WixToolset.BootstrapperApplicationApi/IBootstrapperCommand.cs
+++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/IBootstrapperCommand.cs
@@ -20,6 +20,11 @@ namespace WixToolset.BootstrapperApplicationApi
         Display Display { get; }
 
         /// <summary>
+        /// Gets the bundle scope if set at the command line.
+        /// </summary>
+        BundleScope Scope { get; }
+
+        /// <summary>
         /// Gets the command line arguments.
         /// </summary>
         /// <returns>
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/IBootstrapperEngine.cs b/src/api/burn/WixToolset.BootstrapperApplicationApi/IBootstrapperEngine.cs
index 13702757..9df57cd3 100644
--- a/src/api/burn/WixToolset.BootstrapperApplicationApi/IBootstrapperEngine.cs
+++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/IBootstrapperEngine.cs
@@ -178,10 +178,11 @@ namespace WixToolset.BootstrapperApplicationApi
             );
 
         /// <summary>
-        /// See <see cref="IEngine.Plan(LaunchAction)"/>.
+        /// See <see cref="IEngine.Plan(LaunchAction, BundleScope)"/>.
         /// </summary>
         void Plan(
-            [MarshalAs(UnmanagedType.U4)] LaunchAction action
+            [MarshalAs(UnmanagedType.U4)] LaunchAction action,
+            [MarshalAs(UnmanagedType.U4)] BundleScope plannedScope
             );
 
         /// <summary>
@@ -344,6 +345,28 @@ namespace WixToolset.BootstrapperApplicationApi
     }
 
     /// <summary>
+    /// The scope of the bundle when the chain contains per-user-or-machine or per-machone-or-user packages.
+    /// </summary>
+    public enum BundleScope
+    {
+        /// <summary>
+        /// Let Burn choose the scope. Per-user-or-machine packages will be
+        /// planned as per-machine packages.
+        /// </summary>
+        Default,
+
+        /// <summary>
+        /// Set per-machine scope for per-user-or-machine packages.
+        /// </summary>
+        PerMachine,
+
+        /// <summary>
+        /// Set per-user scope for per-user-or-machine packages.
+        /// </summary>
+        PerUser,
+    }
+
+    /// <summary>
     /// The message log level.
     /// </summary>
     public enum LogLevel
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/IEngine.cs b/src/api/burn/WixToolset.BootstrapperApplicationApi/IEngine.cs
index 03ceed06..a763d741 100644
--- a/src/api/burn/WixToolset.BootstrapperApplicationApi/IEngine.cs
+++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/IEngine.cs
@@ -139,7 +139,8 @@ namespace WixToolset.BootstrapperApplicationApi
         /// Determine the installation sequencing and costing.
         /// </summary>
         /// <param name="action">The action to perform when planning.</param>
-        void Plan(LaunchAction action);
+        /// <param name="plannedScope">The bundle scope for per-user-or-machine packages.</param>
+        void Plan(LaunchAction action, BundleScope plannedScope);
 
         /// <summary>
         /// Set the update information for a bundle.