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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of Qbs.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms and
** conditions see http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#include "modulemerger.h"
#include "value.h"
#include <logging/translator.h>
#include <tools/qbsassert.h>
namespace qbs {
namespace Internal {
ModuleMerger::ModuleMerger(const Logger &logger, Item *root, Item::Module &moduleToMerge)
: m_logger(logger)
, m_rootItem(root)
, m_mergedModule(moduleToMerge)
, m_required(moduleToMerge.required)
, m_versionRange(moduleToMerge.versionRange)
{
QBS_CHECK(moduleToMerge.item->type() == ItemType::ModuleInstance);
}
void ModuleMerger::replaceItemInValues(QualifiedId moduleName, Item *containerItem, Item *toReplace)
{
QBS_CHECK(!moduleName.isEmpty());
QBS_CHECK(containerItem != m_mergedModule.item);
const QString moduleNamePrefix = moduleName.takeFirst();
Item::PropertyMap properties = containerItem->properties();
for (auto it = properties.begin(); it != properties.end(); ++it) {
if (it.key() != moduleNamePrefix)
continue;
Value * const val = it.value().data();
QBS_CHECK(val);
QBS_CHECK(val->type() == Value::ItemValueType);
ItemValue * const itemVal = static_cast<ItemValue *>(val);
if (moduleName.isEmpty()) {
QBS_CHECK(itemVal->item() == toReplace);
itemVal->setItem(m_mergedModule.item);
} else {
replaceItemInValues(moduleName, itemVal->item(), toReplace);
}
}
}
void ModuleMerger::replaceItemInScopes(Item *toReplace)
{
// In insertProperties(), we potentially call setDefiningItem() with the "wrong"
// (to-be-replaced) module instance as an argument. If such module instances
// are dependencies of other modules, they have the depending module's instance
// as their "instance scope", which is the scope of their scope. This function takes
// care that the "wrong" definingItem of values in sub-modules still has the "right"
// instance scope, namely our merged module instead of some other instance.
foreach (const Item::Module &module, toReplace->modules()) {
foreach (const ValuePtr &property, module.item->properties()) {
if (property->definingItem() && property->definingItem()->scope()
&& property->definingItem()->scope()->scope() == toReplace) {
property->definingItem()->scope()->setScope(m_mergedModule.item);
}
}
}
}
void ModuleMerger::start()
{
Item::Module m;
m.item = m_rootItem;
const Item::PropertyMap props = dfs(m, Item::PropertyMap());
if (m_required)
m_mergedModule.required = true;
m_mergedModule.versionRange.narrowDown(m_versionRange);
Item::PropertyMap mergedProps = m_mergedModule.item->properties();
Item *moduleProto = m_mergedModule.item->prototype();
while (moduleProto->prototype())
moduleProto = moduleProto->prototype();
for (auto it = props.constBegin(); it != props.constEnd(); ++it) {
appendPrototypeValueToNextChain(moduleProto, it.key(), it.value());
mergedProps[it.key()] = it.value();
}
m_mergedModule.item->setProperties(mergedProps);
foreach (Item *moduleInstanceContainer, m_moduleInstanceContainers) {
QList<Item::Module> modules;
foreach (const Item::Module &dep, moduleInstanceContainer->modules()) {
const bool isTheModule = dep.name == m_mergedModule.name;
Item::Module m = dep;
if (isTheModule && m.item != m_mergedModule.item) {
QBS_CHECK(m.item->type() == ItemType::ModuleInstance);
replaceItemInValues(m.name, moduleInstanceContainer, m.item);
replaceItemInScopes(m.item);
m.item = m_mergedModule.item;
if (m_required)
m.required = true;
m.versionRange.narrowDown(m_versionRange);
}
modules << m;
}
moduleInstanceContainer->setModules(modules);
}
}
Item::PropertyMap ModuleMerger::dfs(const Item::Module &m, Item::PropertyMap props)
{
Item *moduleInstance = 0;
int numberOfOutprops = m.item->modules().count();
foreach (const Item::Module &dep, m.item->modules()) {
if (dep.name == m_mergedModule.name) {
--numberOfOutprops;
moduleInstance = dep.item;
insertProperties(&props, moduleInstance, ScalarProperties);
m_moduleInstanceContainers << m.item;
if (dep.required)
m_required = true;
m_versionRange.narrowDown(dep.versionRange);
break;
}
}
QVector<Item::PropertyMap> outprops;
outprops.reserve(numberOfOutprops);
foreach (const Item::Module &dep, m.item->modules()) {
if (dep.item != moduleInstance)
outprops << dfs(dep, props);
}
if (!outprops.isEmpty()) {
props = outprops.first();
for (int i = 1; i < outprops.count(); ++i)
mergeOutProps(&props, outprops.at(i));
}
if (moduleInstance)
insertProperties(&props, moduleInstance, ListProperties);
return props;
}
void ModuleMerger::mergeOutProps(Item::PropertyMap *dst, const Item::PropertyMap &src)
{
for (auto it = src.constBegin(); it != src.constEnd(); ++it) {
ValuePtr &v = (*dst)[it.key()];
if (!v) {
v = it.value();
QBS_ASSERT(it.value(), continue);
continue;
}
// possible conflict
JSSourceValuePtr dstVal = v.dynamicCast<JSSourceValue>();
if (!dstVal)
continue;
JSSourceValuePtr srcVal = it.value().dynamicCast<JSSourceValue>();
if (!srcVal)
continue;
const PropertyDeclaration pd = m_decls.value(srcVal);
QBS_CHECK(pd.isValid());
if (pd.isScalar()) {
if (dstVal->sourceCode() != srcVal->sourceCode()
&& dstVal->isInExportItem() == srcVal->isInExportItem()) {
m_logger.qbsWarning() << Tr::tr("Conflicting scalar values at %1 and %2.").arg(
dstVal->location().toString(),
srcVal->location().toString());
// TODO: yield error with a hint how to solve the conflict.
}
if (!dstVal->isInExportItem())
v = it.value();
} else {
lastInNextChain(dstVal)->setNext(srcVal);
}
}
}
void ModuleMerger::insertProperties(Item::PropertyMap *dst, Item *srcItem, PropertiesType type)
{
QSet<const Item *> &seenInstances
= type == ScalarProperties ? m_seenInstancesTopDown : m_seenInstancesBottomUp;
Item *origSrcItem = srcItem;
do {
if (!seenInstances.contains(srcItem)) {
seenInstances.insert(srcItem);
for (Item::PropertyMap::const_iterator it = srcItem->properties().constBegin();
it != srcItem->properties().constEnd(); ++it) {
const ValuePtr &srcVal = it.value();
if (srcVal->type() != Value::JSSourceValueType)
continue;
const PropertyDeclaration srcDecl = srcItem->propertyDeclaration(it.key());
if (!srcDecl.isValid() || srcDecl.isScalar() != (type == ScalarProperties))
continue;
ValuePtr &v = (*dst)[it.key()];
if (v && type == ScalarProperties)
continue;
ValuePtr clonedVal = srcVal->clone();
m_decls[clonedVal] = srcDecl;
clonedVal->setDefiningItem(origSrcItem);
if (v) {
QBS_CHECK(!clonedVal->next());
clonedVal->setNext(v);
}
v = clonedVal;
}
}
srcItem = srcItem->prototype();
} while (srcItem && srcItem->type() == ItemType::ModuleInstance);
}
void ModuleMerger::appendPrototypeValueToNextChain(Item *moduleProto, const QString &propertyName,
const ValuePtr &sv)
{
const PropertyDeclaration pd = m_mergedModule.item->propertyDeclaration(propertyName);
if (pd.isScalar())
return;
if (!m_clonedModulePrototype) {
m_clonedModulePrototype = moduleProto->clone();
m_clonedModulePrototype->setScope(m_mergedModule.item->scope());
}
const ValuePtr clonedValue = m_clonedModulePrototype->property(propertyName);
QBS_CHECK(clonedValue);
clonedValue->setDefiningItem(m_clonedModulePrototype);
lastInNextChain(sv)->setNext(clonedValue);
}
ValuePtr ModuleMerger::lastInNextChain(const ValuePtr &v)
{
ValuePtr n = v;
while (n->next())
n = n->next();
return n;
}
} // namespace Internal
} // namespace qbs
|
