Wix脚本中的转义括号

时间:2017-05-15 01:59:47

标签: wix

我有一个名为MyProject(P2P)的视觉工作室项目,它一直很好用。

现在我使用Wix 3将此项目打包到MSI中,其中一个步骤是编写Component节点:

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

现在我遇到了Wix Project的构建错误:

  

Product.wxs(807,0):错误CNDL0234:错误的预处理器功能&#39; $ var.MyProject(P2P).TargetPath&#39;。函数必须有一个前缀(例如&#39; fun。&#39;),一个至少1个字符长的名称,以及匹配的开括号和右括号。

看起来需要逃避()?怎么样?

1 个答案:

答案 0 :(得分:2)

从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