1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
// 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.
namespace WixToolset.Core
{
using System;
using System.Collections.Generic;
using System.Text;
using WixToolset.Data;
using WixToolset.Data.Bind;
using WixToolset.Extensibility.Services;
/// <summary>
/// WiX variable resolver.
/// </summary>
internal class VariableResolver : IVariableResolver
{
private readonly Dictionary<string, BindVariable> locVariables;
private readonly Dictionary<string, BindVariable> wixVariables;
private readonly Dictionary<string, LocalizedControl> localizedControls;
/// <summary>
/// Instantiate a new VariableResolver.
/// </summary>
internal VariableResolver(IWixToolsetServiceProvider serviceProvider)
{
this.ServiceProvider = serviceProvider;
this.Messaging = serviceProvider.GetService<IMessaging>();
this.locVariables = new Dictionary<string, BindVariable>();
this.wixVariables = new Dictionary<string, BindVariable>();
this.localizedControls = new Dictionary<string, LocalizedControl>();
}
private IWixToolsetServiceProvider ServiceProvider { get; }
private IMessaging Messaging { get; }
public int VariableCount => this.wixVariables.Count;
public void AddLocalization(Localization localization)
{
foreach (var variable in localization.Variables)
{
if (!TryAddWixVariable(this.locVariables, variable))
{
this.Messaging.Write(ErrorMessages.DuplicateLocalizationIdentifier(variable.SourceLineNumbers, variable.Id));
}
}
foreach (KeyValuePair<string, LocalizedControl> localizedControl in localization.LocalizedControls)
{
if (!this.localizedControls.ContainsKey(localizedControl.Key))
{
this.localizedControls.Add(localizedControl.Key, localizedControl.Value);
}
}
}
public void AddVariable(SourceLineNumber sourceLineNumber, string name, string value, bool overridable)
{
var bindVariable = new BindVariable { Id = name, Value = value, Overridable = overridable, SourceLineNumbers = sourceLineNumber };
if (!TryAddWixVariable(this.wixVariables, bindVariable))
{
this.Messaging.Write(ErrorMessages.WixVariableCollision(sourceLineNumber, name));
}
}
public IVariableResolution ResolveVariables(SourceLineNumber sourceLineNumbers, string value)
{
return this.ResolveVariables(sourceLineNumbers, value, errorOnUnknown: true);
}
public bool TryGetLocalizedControl(string dialog, string control, out LocalizedControl localizedControl)
{
var key = LocalizedControl.GetKey(dialog, control);
return this.localizedControls.TryGetValue(key, out localizedControl);
}
public IVariableResolution ResolveVariables(SourceLineNumber sourceLineNumbers, string value, bool errorOnUnknown)
{
var start = 0;
var defaulted = true;
var delayed = false;
var updated = false;
while (Common.TryParseWixVariable(value, start, out var parsed))
{
var variableNamespace = parsed.Namespace;
var variableId = parsed.Name;
var variableDefaultValue = parsed.DefaultValue;
// check for an escape sequence of !! indicating the match is not a variable expression
if (0 < parsed.Index && '!' == value[parsed.Index - 1])
{
var sb = new StringBuilder(value);
sb.Remove(parsed.Index - 1, 1);
value = sb.ToString();
updated = true;
start = parsed.Index + parsed.Length - 1;
continue;
}
string resolvedValue = null;
if ("loc" == variableNamespace)
{
// localization variables do not support inline default values
if (variableDefaultValue != null)
{
this.Messaging.Write(ErrorMessages.IllegalInlineLocVariable(sourceLineNumbers, variableId, variableDefaultValue));
continue;
}
if (this.locVariables.TryGetValue(variableId, out var bindVariable))
{
resolvedValue = bindVariable.Value;
}
}
else if ("wix" == variableNamespace)
{
if (this.wixVariables.TryGetValue(variableId, out var bindVariable))
{
resolvedValue = bindVariable.Value ?? String.Empty;
defaulted = false;
}
else if (null != variableDefaultValue) // default the resolved value to the inline value if one was specified
{
resolvedValue = variableDefaultValue;
}
}
if ("bind" == variableNamespace)
{
// Can't resolve these yet, but keep track of where we find them so they can be resolved later with less effort.
delayed = true;
start = parsed.Index + parsed.Length - 1;
}
else
{
// insert the resolved value if it was found or display an error
if (null != resolvedValue)
{
if (parsed.Index == 0 && parsed.Length == value.Length)
{
value = resolvedValue;
}
else
{
var sb = new StringBuilder(value);
sb.Remove(parsed.Index, parsed.Length);
sb.Insert(parsed.Index, resolvedValue);
value = sb.ToString();
}
updated = true;
start = parsed.Index;
}
else
{
if ("loc" == variableNamespace && errorOnUnknown) // unresolved loc variable
{
this.Messaging.Write(ErrorMessages.LocalizationVariableUnknown(sourceLineNumbers, variableId));
}
else if ("wix" == variableNamespace && errorOnUnknown) // unresolved wix variable
{
this.Messaging.Write(ErrorMessages.WixVariableUnknown(sourceLineNumbers, variableId));
}
start = parsed.Index + parsed.Length;
}
}
}
return new VariableResolution
{
DelayedResolve = delayed,
IsDefault = defaulted,
UpdatedValue = updated,
Value = value,
};
}
private static bool TryAddWixVariable(IDictionary<string, BindVariable> variables, BindVariable variable)
{
if (!variables.TryGetValue(variable.Id, out var existingWixVariableRow) || (existingWixVariableRow.Overridable && !variable.Overridable))
{
variables[variable.Id] = variable;
return true;
}
return variable.Overridable;
}
}
}
|
