From 4041669e1f3b3f094579e4f3368e6f57f46d7177 Mon Sep 17 00:00:00 2001
From: Rob Mensching <rob@firegiant.com>
Date: Fri, 2 Apr 2021 14:00:05 -0700
Subject: Add resolved codepage and LCID to bind context

Plus some XML documentation updates.

Contributes to wixtoolset/issues#5801
---
 src/WixToolset.Extensibility/Data/IBindContext.cs  | 20 +++++++++----
 .../Data/IResolveContext.cs                        | 34 +++++++++++++++++++++-
 .../Data/IResolveResult.cs                         | 28 ++++++++++++++++--
 3 files changed, 74 insertions(+), 8 deletions(-)

(limited to 'src')

diff --git a/src/WixToolset.Extensibility/Data/IBindContext.cs b/src/WixToolset.Extensibility/Data/IBindContext.cs
index ee165671..f1977c01 100644
--- a/src/WixToolset.Extensibility/Data/IBindContext.cs
+++ b/src/WixToolset.Extensibility/Data/IBindContext.cs
@@ -27,11 +27,6 @@ namespace WixToolset.Extensibility.Data
         /// </summary>
         string CabCachePath { get; set; }
 
-        /// <summary>
-        /// Codepage for result.
-        /// </summary>
-        int Codepage { get; set; }
-
         /// <summary>
         /// Default compression level.
         /// </summary>
@@ -87,6 +82,21 @@ namespace WixToolset.Extensibility.Data
         /// </summary>
         string PdbPath { get; set; }
 
+        /// <summary>
+        /// Codepage from resolve.
+        /// </summary>
+        int? ResolvedCodepage { get; set; }
+
+        /// <summary>
+        /// Summary information codepage from resolve.
+        /// </summary>
+        int? ResolvedSummaryInformationCodepage { get; set; }
+
+        /// <summary>
+        /// LCID from resolve.
+        /// </summary>
+        int? ResolvedLcid { get; set; }
+
         /// <summary>
         /// Set of ICEs to skip.
         /// </summary>
diff --git a/src/WixToolset.Extensibility/Data/IResolveContext.cs b/src/WixToolset.Extensibility/Data/IResolveContext.cs
index 79191a15..6ab5b545 100644
--- a/src/WixToolset.Extensibility/Data/IResolveContext.cs
+++ b/src/WixToolset.Extensibility/Data/IResolveContext.cs
@@ -7,27 +7,59 @@ namespace WixToolset.Extensibility.Data
     using System.Threading;
     using WixToolset.Data;
 
-#pragma warning disable 1591 // TODO: add documentation
+    /// <summary>
+    /// Context for resolve.
+    /// </summary>
     public interface IResolveContext
     {
+        /// <summary>
+        /// Service provider.
+        /// </summary>
         IServiceProvider ServiceProvider { get; }
 
+        /// <summary>
+        /// Bind paths used during resolution.
+        /// </summary>
         IEnumerable<IBindPath> BindPaths { get; set; }
 
+        /// <summary>
+        /// Resolve extensions.
+        /// </summary>
         IEnumerable<IResolverExtension> Extensions { get; set; }
 
+        /// <summary>
+        /// Extension data.
+        /// </summary>
         IEnumerable<IExtensionData> ExtensionData { get; set; }
 
+        /// <summary>
+        /// List of cultures to filter the localizations.
+        /// </summary>
         IEnumerable<string> FilterCultures { get; set; }
 
+        /// <summary>
+        /// Intermediate folder.
+        /// </summary>
         string IntermediateFolder { get; set; }
 
+        /// <summary>
+        /// Intermediate to resolve.
+        /// </summary>
         Intermediate IntermediateRepresentation { get; set; }
 
+        /// <summary>
+        /// Localizations used to resolve.
+        /// </summary>
         IEnumerable<Localization> Localizations { get; set; }
 
+        /// <summary>
+        /// Indicates whether to allow localization and bind variables to remain unresolved.
+        /// </summary>
         bool AllowUnresolvedVariables { get; set; }
 
+        /// <summary>
+        /// Cancellation token.
+        /// </summary>
         CancellationToken CancellationToken { get; set; }
     }
 }
diff --git a/src/WixToolset.Extensibility/Data/IResolveResult.cs b/src/WixToolset.Extensibility/Data/IResolveResult.cs
index 7c3403d4..abffb415 100644
--- a/src/WixToolset.Extensibility/Data/IResolveResult.cs
+++ b/src/WixToolset.Extensibility/Data/IResolveResult.cs
@@ -5,15 +5,39 @@ namespace WixToolset.Extensibility.Data
     using System.Collections.Generic;
     using WixToolset.Data;
 
-#pragma warning disable 1591 // TODO: add documentation
+    /// <summary>
+    /// Result of resolving localization and bind variables.
+    /// </summary>
     public interface IResolveResult
     {
-        int Codepage { get; set; }
+        /// <summary>
+        /// Resolved codepage, if provided.
+        /// </summary>
+        int? Codepage { get; set; }
 
+        /// <summary>
+        /// Resolved summary information codepage, if provided.
+        /// </summary>
+        int? SummaryInformationCodepage { get; set; }
+
+        /// <summary>
+        /// Resolved package language, if provided.
+        /// </summary>
+        int? PackageLcid { get; set; }
+
+        /// <summary>
+        /// Fields still requiring resolution.
+        /// </summary>
         IEnumerable<IDelayedField> DelayedFields { get; set; }
 
+        /// <summary>
+        /// Files to extract from embedded .wixlibs.
+        /// </summary>
         IEnumerable<IExpectedExtractFile> ExpectedEmbeddedFiles { get; set; }
 
+        /// <summary>
+        /// Resolved intermediate.
+        /// </summary>
         Intermediate IntermediateRepresentation { get; set; }
     }
 }
-- 
cgit v1.2.3-55-g6feb