WIXFEAT:4763 Change "string" variable type to literal and add "formatted".

6 files changed, 77 insertions, 34 deletions

diff --git a/src/bextutil/BextBundleExtensionEngine.cpp b/src/bextutil/BextBundleExtensionEngine.cpp
index 02070a6f..a78b3130 100644
--- a/src/bextutil/BextBundleExtensionEngine.cpp
+++ b/src/bextutil/BextBundleExtensionEngine.cpp
@@ -225,23 +225,6 @@ public: // IBundleExtensionEngine
         return m_pfnBundleExtensionEngineProc(BUNDLE_EXTENSION_ENGINE_MESSAGE_LOG, &args, &results, m_pvBundleExtensionEngineProcContext);
     }
 
-    virtual STDMETHODIMP SetVariableLiteralString(
-        __in_z LPCWSTR wzVariable,
-        __in_z_opt LPCWSTR wzValue
-        )
-    {
-        BUNDLE_EXTENSION_ENGINE_SETVARIABLELITERALSTRING_ARGS args = { };
-        BUNDLE_EXTENSION_ENGINE_SETVARIABLELITERALSTRING_RESULTS results = { };
-
-        args.cbSize = sizeof(args);
-        args.wzVariable = wzVariable;
-        args.wzValue = wzValue;
-
-        results.cbSize = sizeof(results);
-
-        return m_pfnBundleExtensionEngineProc(BUNDLE_EXTENSION_ENGINE_MESSAGE_SETVARIABLELITERALSTRING, &args, &results, m_pvBundleExtensionEngineProcContext);
-    }
-
     virtual STDMETHODIMP SetVariableNumeric(
         __in_z LPCWSTR wzVariable,
         __in LONGLONG llValue
@@ -261,7 +244,8 @@ public: // IBundleExtensionEngine
 
     virtual STDMETHODIMP SetVariableString(
         __in_z LPCWSTR wzVariable,
-        __in_z_opt LPCWSTR wzValue
+        __in_z_opt LPCWSTR wzValue,
+        __in BOOL fFormatted
         )
     {
         BUNDLE_EXTENSION_ENGINE_SETVARIABLESTRING_ARGS args = { };
@@ -270,6 +254,7 @@ public: // IBundleExtensionEngine
         args.cbSize = sizeof(args);
         args.wzVariable = wzVariable;
         args.wzValue = wzValue;
+        args.fFormatted = fFormatted;
 
         results.cbSize = sizeof(results);
 
diff --git a/src/bextutil/bextutil.cpp b/src/bextutil/bextutil.cpp
index baf35591..4b22d502 100644
--- a/src/bextutil/bextutil.cpp
+++ b/src/bextutil/bextutil.cpp
@@ -119,6 +119,29 @@ DAPIV_(HRESULT) BextLog(
 {
     HRESULT hr = S_OK;
     va_list args;
+
+    if (!vpEngine)
+    {
+        hr = E_POINTER;
+        ExitOnRootFailure(hr, "BextInitialize() must be called first.");
+    }
+
+    va_start(args, szFormat);
+    hr = BextLogArgs(level, szFormat, args);
+    va_end(args);
+
+LExit:
+    return hr;
+}
+
+
+DAPI_(HRESULT) BextLogArgs(
+    __in BUNDLE_EXTENSION_LOG_LEVEL level,
+    __in_z __format_string LPCSTR szFormat,
+    __in va_list args
+    )
+{
+    HRESULT hr = S_OK;
     LPSTR sczFormattedAnsi = NULL;
     LPWSTR sczMessage = NULL;
 
@@ -128,9 +151,7 @@ DAPIV_(HRESULT) BextLog(
         ExitOnRootFailure(hr, "BextInitialize() must be called first.");
     }
 
-    va_start(args, szFormat);
     hr = StrAnsiAllocFormattedArgs(&sczFormattedAnsi, szFormat, args);
-    va_end(args);
     ExitOnFailure(hr, "Failed to format log string.");
 
     hr = StrAllocStringAnsi(&sczMessage, sczFormattedAnsi, 0, CP_UTF8);
@@ -153,6 +174,29 @@ DAPIV_(HRESULT) BextLogError(
 {
     HRESULT hr = S_OK;
     va_list args;
+
+    if (!vpEngine)
+    {
+        hr = E_POINTER;
+        ExitOnRootFailure(hr, "BextInitialize() must be called first.");
+    }
+
+    va_start(args, szFormat);
+    hr = BextLogErrorArgs(hrError, szFormat, args);
+    va_end(args);
+
+LExit:
+    return hr;
+}
+
+
+DAPI_(HRESULT) BextLogErrorArgs(
+    __in HRESULT hrError,
+    __in_z __format_string LPCSTR szFormat,
+    __in va_list args
+    )
+{
+    HRESULT hr = S_OK;
     LPSTR sczFormattedAnsi = NULL;
     LPWSTR sczMessage = NULL;
 
@@ -162,9 +206,7 @@ DAPIV_(HRESULT) BextLogError(
         ExitOnRootFailure(hr, "BextInitialize() must be called first.");
     }
 
-    va_start(args, szFormat);
     hr = StrAnsiAllocFormattedArgs(&sczFormattedAnsi, szFormat, args);
-    va_end(args);
     ExitOnFailure(hr, "Failed to format error log string.");
 
     hr = StrAllocFormatted(&sczMessage, L"Error 0x%08x: %S", hrError, sczFormattedAnsi);
diff --git a/src/bextutil/bextutil.vcxproj b/src/bextutil/bextutil.vcxproj
index 78ff290d..32518202 100644
--- a/src/bextutil/bextutil.vcxproj
+++ b/src/bextutil/bextutil.vcxproj
@@ -2,8 +2,8 @@
 <!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
 
 <Project DefaultTargets="Build" ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
-  <Import Project="..\..\packages\WixToolset.BootstrapperCore.Native.4.0.31\build\WixToolset.BootstrapperCore.Native.props" Condition="Exists('..\..\packages\WixToolset.BootstrapperCore.Native.4.0.31\build\WixToolset.BootstrapperCore.Native.props')" />
-  <Import Project="..\..\packages\WixToolset.DUtil.4.0.45\build\WixToolset.DUtil.props" Condition="Exists('..\..\packages\WixToolset.DUtil.4.0.45\build\WixToolset.DUtil.props')" />
+  <Import Project="..\..\packages\WixToolset.BootstrapperCore.Native.4.0.33\build\WixToolset.BootstrapperCore.Native.props" Condition="Exists('..\..\packages\WixToolset.BootstrapperCore.Native.4.0.33\build\WixToolset.BootstrapperCore.Native.props')" />
+  <Import Project="..\..\packages\WixToolset.DUtil.4.0.49\build\WixToolset.DUtil.props" Condition="Exists('..\..\packages\WixToolset.DUtil.4.0.49\build\WixToolset.DUtil.props')" />
 
   <ItemGroup Label="ProjectConfigurations">
     <ProjectConfiguration Include="Debug|ARM">
@@ -95,8 +95,8 @@
     <PropertyGroup>
       <ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
     </PropertyGroup>
-    <Error Condition="!Exists('..\..\packages\WixToolset.BootstrapperCore.Native.4.0.31\build\WixToolset.BootstrapperCore.Native.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\WixToolset.BootstrapperCore.Native.4.0.31\build\WixToolset.BootstrapperCore.Native.props'))" />
-    <Error Condition="!Exists('..\..\packages\WixToolset.DUtil.4.0.45\build\WixToolset.DUtil.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\WixToolset.DUtil.4.0.45\build\WixToolset.DUtil.props'))" />
+    <Error Condition="!Exists('..\..\packages\WixToolset.BootstrapperCore.Native.4.0.33\build\WixToolset.BootstrapperCore.Native.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\WixToolset.BootstrapperCore.Native.4.0.33\build\WixToolset.BootstrapperCore.Native.props'))" />
+    <Error Condition="!Exists('..\..\packages\WixToolset.DUtil.4.0.49\build\WixToolset.DUtil.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\WixToolset.DUtil.4.0.49\build\WixToolset.DUtil.props'))" />
     <Error Condition="!Exists('..\..\packages\Nerdbank.GitVersioning.2.1.65\build\Nerdbank.GitVersioning.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\Nerdbank.GitVersioning.2.1.65\build\Nerdbank.GitVersioning.targets'))" />
   </Target>
 </Project>
diff --git a/src/bextutil/inc/IBundleExtensionEngine.h b/src/bextutil/inc/IBundleExtensionEngine.h
index 869c6695..7772b016 100644
--- a/src/bextutil/inc/IBundleExtensionEngine.h
+++ b/src/bextutil/inc/IBundleExtensionEngine.h
@@ -42,11 +42,6 @@ DECLARE_INTERFACE_IID_(IBundleExtensionEngine, IUnknown, "9D027A39-F6B6-42CC-973
         __in_z LPCWSTR wzMessage
         ) = 0;
 
-    STDMETHOD(SetVariableLiteralString)(
-        __in_z LPCWSTR wzVariable,
-        __in_z_opt LPCWSTR wzValue
-        ) = 0;
-
     STDMETHOD(SetVariableNumeric)(
         __in_z LPCWSTR wzVariable,
         __in LONGLONG llValue
@@ -54,7 +49,8 @@ DECLARE_INTERFACE_IID_(IBundleExtensionEngine, IUnknown, "9D027A39-F6B6-42CC-973
 
     STDMETHOD(SetVariableString)(
         __in_z LPCWSTR wzVariable,
-        __in_z_opt LPCWSTR wzValue
+        __in_z_opt LPCWSTR wzValue,
+        __in BOOL fFormatted
         ) = 0;
 
     STDMETHOD(SetVariableVersion)(
diff --git a/src/bextutil/inc/bextutil.h b/src/bextutil/inc/bextutil.h
index e80d3944..ac9c0062 100644
--- a/src/bextutil/inc/bextutil.h
+++ b/src/bextutil/inc/bextutil.h
@@ -72,6 +72,16 @@ DAPIV_(HRESULT) BextLog(
     );
 
 /*******************************************************************
+ BextLogArgs - logs a message with the engine.
+
+********************************************************************/
+DAPI_(HRESULT) BextLogArgs(
+    __in BUNDLE_EXTENSION_LOG_LEVEL level,
+    __in_z __format_string LPCSTR szFormat,
+    __in va_list args
+    );
+
+/*******************************************************************
  BextLogError - logs an error message with the engine.
 
 ********************************************************************/
@@ -81,6 +91,16 @@ DAPIV_(HRESULT) BextLogError(
     ...
     );
 
+/*******************************************************************
+ BextLogErrorArgs - logs an error message with the engine.
+
+********************************************************************/
+DAPI_(HRESULT) BextLogErrorArgs(
+    __in HRESULT hr,
+    __in_z __format_string LPCSTR szFormat,
+    __in va_list args
+    );
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/src/bextutil/packages.config b/src/bextutil/packages.config
index 56f0cea3..e8417860 100644
--- a/src/bextutil/packages.config
+++ b/src/bextutil/packages.config
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="Nerdbank.GitVersioning" version="2.1.65" targetFramework="native" developmentDependency="true" />
-  <package id="WixToolset.BootstrapperCore.Native" version="4.0.31" targetFramework="native" />
-  <package id="WixToolset.DUtil" version="4.0.45" targetFramework="native" />
+  <package id="WixToolset.BootstrapperCore.Native" version="4.0.33" targetFramework="native" />
+  <package id="WixToolset.DUtil" version="4.0.49" targetFramework="native" />
 </packages>
\ No newline at end of file