summaryrefslogtreecommitdiff
path: root/src/lib/corelib/loader/modulepropertymerger.h
blob: fc388cfbfab193e19470ab654c4612b575763ea9 (plain)
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
/****************************************************************************
**
** Copyright (C) 2023 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#pragma once

#include <QtGlobal>

namespace qbs {
class SetupProjectParameters;
namespace Internal {
class Evaluator;
class Item;
class Logger;

// This class comprises functions for collecting values attached to module properties
// in different contexts.
// For example, in the Qt.core module you will find a property binding such as this:
//   cpp.defines: "QT_CORE_LIB"
// while in the Qt.widgets module, it will look like this:
//   cpp.defines: "QT_WIDGETS_LIB"
// A product with a dependency on both these modules will end up with a value of
// ["QT_WIDGETS_LIB", "QT_CORE_LIB"], plus potentially other defines set elsewhere.
// Each of these values is assigned a priority that roughly corresponds to the "level" at which
// the module containing the property binding resides in the dependency hierarchy.
// For list properties, the priorities determine the order of the respecive values in the
// final array, for scalar values they determine which one survives. Different scalar values
// with the same priority trigger a warning message.
// Since the right-hand side of a binding can refer to properties of the surrounding context,
// each such value gets its own scope.
class ModulePropertyMerger
{
public:
    ModulePropertyMerger(const SetupProjectParameters &parameters, Evaluator &evaluator,
                         Logger &logger);
    ~ModulePropertyMerger();

    // This function is called when a module is loaded via a Depends item.
    // loadingItem is the product or module containing the Depends item.
    // loadingName is the name of that module. It is used as a tie-breaker for list property values
    //             with equal priority.
    // localInstance is the module instance placeholder in the ItemValue of a property binding,
    //               i.e. the "cpp" in "cpp.defines".
    // globalInstance is the actual module into which the properties from localInstance get merged.
    void mergeFromLocalInstance(const Item *productItem, Item *loadingItem,
                                const QString &loadingName, const Item *localInstance,
                                Item *globalInstance);

    // This function is called after all dependencies have been resolved. It uses its global
    // knowledge of module priorities to potentially adjust the order of list values or
    // favor different scalar values. It can also remove previously merged-in values again;
    // this can happen if a module fails to load after it already merged some values, or
    // if it fails validation in the end.
    void doFinalMerge(const Item *productItem);

    void printProfilingInfo(int indent);

private:
    class Private;
    Private * const d;
};

} // namespace Internal
} // namespace qbs