wix - Wix 脚本中的转义括号

Question

我有一个名为 MyProject(P2P) 的 visual studio 项目，它一直运行良好。

现在我正在使用 Wix 3 将这个项目打包到 MSI 中，其中一个步骤是编写组件节点:

  <Component Id="MyProject(P2P).exe" Guid="34565d5d-07d6-495d-a184-bb3bdebe1fb8">
    <File Source="$(var.MyProject(P2P).TargetPath)" KeyPath="yes" />
  </Component>

现在我得到了 Wix 项目的构建错误:

Product.wxs(807,0): error CNDL0234: Ill-formed preprocessor function '$var.MyProject(P2P).TargetPath'. Functions must have a prefix (like 'fun.'), a name at least 1 character long, and matching opening and closing parentheses.

看起来需要转义 ( 和 )？以及如何？

Answer 1

从 WIX 3.11 开始，没有机制可以转义变量名中的括号。 WIX 预处理器应该处理这个而不需要转义括号，但在你的情况下不是因为预处理器中的错误和/或限制。

要了解发生了什么，我们需要查看相关的 WIX 源文件 src\tools\wix\PreProcessor.cs，该文件可以从 https://github.com/wixtoolset/wix3/releases/tag/wix311rtm 下载。在这个文件中，函数 PreprocessString() 接受一个字符串，并尝试用相应的定义(我没有包括这个函数的源代码，因为它很长)。

因为您的变量包含一个左括号字符，PreprocessString() 函数调用 EvaluateFunction():

    /// <summary>
    /// Evaluate a function.
    /// </summary>
    /// <param name="sourceLineNumbers">The source line information for the function.</param>
    /// <param name="function">The function expression including the prefix and name.</param>
    /// <returns>The function value.</returns>
    public string EvaluateFunction(SourceLineNumberCollection sourceLineNumbers, string function)
    {
        string[] prefixParts = function.Split(variableSplitter, 2);
        // Check to make sure there are 2 parts and neither is an empty string.
        if (2 != prefixParts.Length || 0 >= prefixParts[0].Length || 0 >= prefixParts[1].Length)
        {
            throw new WixException(WixErrors.InvalidPreprocessorFunction(sourceLineNumbers, function));
        }
        string prefix = prefixParts[0];

        string[] functionParts = prefixParts[1].Split(new char[] { '(' }, 2);
        // Check to make sure there are 2 parts, neither is an empty string, and the second part ends with a closing paren.
        if (2 != functionParts.Length || 0 >= functionParts[0].Length || 0 >= functionParts[1].Length || !functionParts[1].EndsWith(")", StringComparison.Ordinal))
        {
            throw new WixException(WixErrors.InvalidPreprocessorFunction(sourceLineNumbers, function));
        }
        string functionName = functionParts[0];

        // Remove the trailing closing paren.
        string allArgs = functionParts[1].Substring(0, functionParts[1].Length - 1);

        // Parse the arguments and preprocess them.
        string[] args = allArgs.Split(argumentSplitter);
        for (int i = 0; i < args.Length; i++)
        {
            args[i] = this.PreprocessString(sourceLineNumbers, args[i].Trim());
        }

        string result = this.EvaluateFunction(sourceLineNumbers, prefix, functionName, args);

        // If the function didn't evaluate, try to evaluate the original value as a variable to support 
        // the use of open and closed parens inside variable names. Example: $(env.ProgramFiles(x86)) should resolve.
        if (null == result)
        {
            result = this.GetVariableValue(sourceLineNumbers, function, false);
        }

        return result;

您的字符串由三部分组成，由 variableSplitter 字符“.”分隔，因此第一个测试 2 != prefixParts.length 失败，导致异常 InvalidPreprocessorFunction 抛出。

函数的进一步尝试将字符串作为函数求值，如果失败，则回退到将字符串作为变量求值。这适用于评论中所述的示例:$(env.ProgramFiles(x86))。

建议在 https://github.com/wixtoolset/issues/issues 上提出有关 WIX 问题错误跟踪器的错误报告。

作为变通方法，您可以使用从安装项目到您的应用程序项目的相对路径。例如:

<Component Id="MyProject(P2P).exe" Guid="34565d5d-07d6-495d-a184-bb3bdebe1fb8">
    <File Source="..\Release\MyProject(P2P).exe" KeyPath="yes" />
</Component