aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/corelib/buildgraph/artifactsscriptvalue.cpp
blob: 2adb77d47779267cb203a525162c50542e6b51db (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
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
/****************************************************************************
**
** Copyright (C) 2018 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$
**
****************************************************************************/
#include "artifactsscriptvalue.h"

#include "artifact.h"
#include "productbuilddata.h"
#include "transformer.h"

#include <language/language.h>
#include <language/scriptengine.h>

#include <QtScript/qscriptclass.h>
#include <QtScript/qscriptcontext.h>

namespace qbs {
namespace Internal {

enum BuildGraphScriptValueCommonPropertyKeys : quint32 {
    CachedValueKey,
    FileTagKey,
    ProductPtrKey,
};

class ArtifactsScriptClass : public QScriptClass
{
public:
    ArtifactsScriptClass(QScriptEngine *engine) : QScriptClass(engine) { }

private:
    QueryFlags queryProperty(const QScriptValue &object, const QScriptString &name,
                             QueryFlags flags, uint *id) override
    {
        getProduct(object);
        qbsEngine()->setNonExistingArtifactSetRequested(m_product, name.toString());
        return QScriptClass::queryProperty(object, name, flags, id);
    }

    QScriptClassPropertyIterator *newIterator(const QScriptValue &object) override
    {
        getProduct(object);
        qbsEngine()->setArtifactsEnumerated(m_product);
        return QScriptClass::newIterator(object);
    }

    void getProduct(const QScriptValue &object)
    {
        if (m_lastObjectId != object.objectId()) {
            m_lastObjectId = object.objectId();
            m_product = reinterpret_cast<const ResolvedProduct *>(
                        object.data().property(ProductPtrKey).toVariant().value<quintptr>());
        }
    }

    ScriptEngine *qbsEngine() const { return static_cast<ScriptEngine *>(engine()); }

    qint64 m_lastObjectId = 0;
    const ResolvedProduct *m_product = nullptr;
};

static bool isRelevantArtifact(const ResolvedProduct *, const Artifact *artifact)
{
    return !artifact->isTargetOfModule();
}
static bool isRelevantArtifact(const ResolvedModule *module, const Artifact *artifact)
{
    return artifact->targetOfModule == module->name;
}

static ArtifactSetByFileTag artifactsMap(const ResolvedProduct *product)
{
    return product->buildData->artifactsByFileTag();
}

static ArtifactSetByFileTag artifactsMap(const ResolvedModule *module)
{
    return artifactsMap(module->product);
}

static QScriptValue createArtifactsObject(const ResolvedProduct *product, ScriptEngine *engine)
{
    QScriptClass *scriptClass = engine->artifactsScriptClass();
    if (!scriptClass) {
        scriptClass = new ArtifactsScriptClass(engine);
        engine->setArtifactsScriptClass(scriptClass);
    }
    QScriptValue artifactsObj = engine->newObject(scriptClass);
    QScriptValue data = engine->newObject();
    QVariant v;
    v.setValue<quintptr>(reinterpret_cast<quintptr>(product));
    data.setProperty(ProductPtrKey, engine->newVariant(v));
    artifactsObj.setData(data);
    return artifactsObj;
}

static QScriptValue createArtifactsObject(const ResolvedModule *, ScriptEngine *engine)
{
    return engine->newObject();
}

static bool checkAndSetArtifactsMapUpToDateFlag(const ResolvedProduct *p)
{
    return p->buildData->checkAndSetJsArtifactsMapUpToDateFlag();
}
static bool checkAndSetArtifactsMapUpToDateFlag(const ResolvedModule *) { return true; }

static void registerArtifactsMapAccess(const ResolvedProduct *p, ScriptEngine *e, bool forceUpdate)
{
    e->setArtifactsMapRequested(p, forceUpdate);
}
static void registerArtifactsMapAccess(const ResolvedModule *, ScriptEngine *, bool) {}
static void registerArtifactsSetAccess(const ResolvedProduct *p, const FileTag &t, ScriptEngine *e)
{
    e->setArtifactSetRequestedForTag(p, t);
}
static void registerArtifactsSetAccess(const ResolvedModule *, const FileTag &, ScriptEngine *) {}

template<class ProductOrModule> static QScriptValue js_artifactsForFileTag(
        QScriptContext *ctx, ScriptEngine *engine, const ProductOrModule *productOrModule)
{
    const FileTag fileTag = FileTag(ctx->callee().property(FileTagKey).toString().toUtf8());
    registerArtifactsSetAccess(productOrModule, fileTag, engine);
    QScriptValue result = ctx->callee().property(CachedValueKey);
    if (result.isArray())
        return result;
    auto artifacts = artifactsMap(productOrModule).value(fileTag);
    const auto filter = [productOrModule](const Artifact *a) {
        return !isRelevantArtifact(productOrModule, a);
    };
    artifacts.erase(std::remove_if(artifacts.begin(), artifacts.end(), filter), artifacts.end());
    result = engine->newArray(uint(artifacts.size()));
    ctx->callee().setProperty(CachedValueKey, result);
    int k = 0;
    for (const Artifact * const artifact : artifacts)
        result.setProperty(k++, Transformer::translateFileConfig(engine, artifact, QString()));
    return result;
}

template<class ProductOrModule> static QScriptValue js_artifacts(
        QScriptContext *ctx, ScriptEngine *engine, const ProductOrModule *productOrModule)
{
    QScriptValue artifactsObj = ctx->callee().property(CachedValueKey);
    if (artifactsObj.isObject() && checkAndSetArtifactsMapUpToDateFlag(productOrModule)) {
        registerArtifactsMapAccess(productOrModule, engine, false);
        return artifactsObj;
    }
    registerArtifactsMapAccess(productOrModule, engine, true);
    artifactsObj = createArtifactsObject(productOrModule, engine);
    ctx->callee().setProperty(CachedValueKey, artifactsObj);
    const auto &map = artifactsMap(productOrModule);
    for (auto it = map.cbegin(); it != map.cend(); ++it) {
        const auto filter = [productOrModule](const Artifact *a) {
            return isRelevantArtifact(productOrModule, a);
        };
        if (std::none_of(it.value().cbegin(), it.value().cend(), filter))
            continue;
        QScriptValue fileTagFunc = engine->newFunction(&js_artifactsForFileTag<ProductOrModule>,
                                                       productOrModule);
        const QString fileTag = it.key().toString();
        fileTagFunc.setProperty(FileTagKey, fileTag);
        artifactsObj.setProperty(fileTag, fileTagFunc,
                                 QScriptValue::ReadOnly | QScriptValue::Undeletable
                                 | QScriptValue::PropertyGetter);
    }
    return artifactsObj;
}

QScriptValue artifactsScriptValueForProduct(QScriptContext *ctx, ScriptEngine *engine,
                                            const ResolvedProduct *product)
{
    return js_artifacts(ctx, engine, product);
}

QScriptValue artifactsScriptValueForModule(QScriptContext *ctx, ScriptEngine *engine,
                                           const ResolvedModule *module)
{
    return js_artifacts(ctx, engine, module);
}

} // namespace Internal
} // namespace qbs