1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qbs.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QBS_TRANSFORMER_H
41 #define QBS_TRANSFORMER_H
42 
43 #include "artifact.h"
44 #include "forward_decls.h"
45 #include "requestedartifacts.h"
46 #include "requesteddependencies.h"
47 #include "rulecommands.h"
48 #include <language/forward_decls.h>
49 #include <language/language.h>
50 #include <language/property.h>
51 #include <language/scriptengine.h>
52 #include <tools/filetime.h>
53 #include <tools/persistence.h>
54 
55 #include <QtCore/qhash.h>
56 
57 namespace qbs {
58 namespace Internal {
59 class Artifact;
60 class AbstractCommand;
61 class Rule;
62 
63 class Transformer
64 {
65 public:
create()66     static TransformerPtr create() { return TransformerPtr(new Transformer); }
67 
68     ~Transformer();
69 
70     ArtifactSet inputs; // Subset of "children of all outputs".
71     ArtifactSet outputs;
72     ArtifactSet explicitlyDependsOn;
73     RuleConstPtr rule;
74     CommandList commands;
75     PropertySet propertiesRequestedInPrepareScript;
76     PropertySet propertiesRequestedInCommands;
77     QHash<QString, PropertySet> propertiesRequestedFromArtifactInPrepareScript;
78     QHash<QString, PropertySet> propertiesRequestedFromArtifactInCommands;
79     std::vector<QString> importedFilesUsedInPrepareScript;
80     std::vector<QString> importedFilesUsedInCommands;
81     RequestedDependencies depsRequestedInPrepareScript;
82     RequestedDependencies depsRequestedInCommands;
83     RequestedArtifacts artifactsMapRequestedInPrepareScript;
84     RequestedArtifacts artifactsMapRequestedInCommands;
85     FileTime lastPrepareScriptExecutionTime;
86     FileTime lastCommandExecutionTime;
87     std::unordered_map<QString, ExportedModule> exportedModulesAccessedInPrepareScript;
88     std::unordered_map<QString, ExportedModule> exportedModulesAccessedInCommands;
89     bool alwaysRun;
90     bool prepareScriptNeedsChangeTracking = false;
91     bool commandsNeedChangeTracking = false;
92     bool markedForRerun = false;
93 
94     static QScriptValue translateFileConfig(ScriptEngine *scriptEngine,
95                                             const Artifact *artifact,
96                                             const QString &defaultModuleName);
97     ResolvedProductPtr product() const;
98     void setupInputs(const QScriptValue &targetScriptValue);
99     void setupOutputs(QScriptValue targetScriptValue);
100     void setupExplicitlyDependsOn(QScriptValue targetScriptValue);
101     void createCommands(ScriptEngine *engine, const PrivateScriptFunction &script,
102                         const QScriptValueList &args);
103     void rescueChangeTrackingData(const TransformerConstPtr &other);
104 
105     Set<QString> jobPools() const;
106 
completeSerializationOp(PersistentPool & pool)107     template<PersistentPool::OpType opType> void completeSerializationOp(PersistentPool &pool)
108     {
109         pool.serializationOp<opType>(rule, inputs, outputs, explicitlyDependsOn,
110                                      propertiesRequestedInPrepareScript,
111                                      propertiesRequestedInCommands,
112                                      propertiesRequestedFromArtifactInPrepareScript,
113                                      propertiesRequestedFromArtifactInCommands,
114                                      importedFilesUsedInPrepareScript, importedFilesUsedInCommands,
115                                      depsRequestedInPrepareScript, depsRequestedInCommands,
116                                      commands, artifactsMapRequestedInPrepareScript,
117                                      artifactsMapRequestedInCommands,
118                                      lastPrepareScriptExecutionTime, lastCommandExecutionTime,
119                                      exportedModulesAccessedInPrepareScript,
120                                      exportedModulesAccessedInCommands,
121                                      alwaysRun, prepareScriptNeedsChangeTracking,
122                                      commandsNeedChangeTracking, markedForRerun);
123     }
124 
125 private:
126     Transformer();
127     AbstractCommandPtr createCommandFromScriptValue(const QScriptValue &scriptValue,
128                                                     const CodeLocation &codeLocation);
129 
130     static void setupInputs(QScriptValue targetScriptValue, const ArtifactSet &inputs,
131             const QString &defaultModuleName);
132     static QScriptValue translateInOutputs(ScriptEngine *scriptEngine,
133                                            const ArtifactSet &artifacts,
134                                            const QString &defaultModuleName);
135 };
136 
137 } // namespace Internal
138 } // namespace qbs
139 
140 #endif // QBS_TRANSFORMER_H
141