summaryrefslogtreecommitdiff
path: root/src/lib/buildgraph/executor.h
blob: 9180453086e0b0163d961c8a6e2c9ea399bcb292 (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
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Build Suite.
**
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/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 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#ifndef QBS_BUILDGRAPHEXECUTOR_H
#define QBS_BUILDGRAPHEXECUTOR_H

#include "forward_decls.h"
#include <buildgraph/artifact.h>
#include <buildgraph/scanresultcache.h>
#include <tools/buildoptions.h>
#include <tools/error.h>
#include <tools/settings.h>

#include <QObject>
#include <QVariant>

namespace qbs {
namespace Internal {
class AutoMoc;
class ExecutorJob;
class InputArtifactScannerContext;
class ProgressObserver;
class ScanResultCache;
class ScriptEngine;

class Executor : public QObject
{
    Q_OBJECT
public:
    Executor(QObject *parent = 0);
    ~Executor();

    void build(const QList<BuildProductPtr> &productsToBuild);

    void setEngine(ScriptEngine *engine);
    void setBuildOptions(const BuildOptions &buildOptions);
    void setProgressObserver(ProgressObserver *observer) { m_progressObserver = observer; }

    Error error() const { return m_error; }
    bool hasError() const { return !error().entries().isEmpty(); }

signals:
    void finished();

private slots:
    void onProcessError(const QString &errorString);
    void onProcessSuccess();
    void finish();

private:
    enum ExecutorState { ExecutorIdle, ExecutorRunning, ExecutorCanceling };

    void doBuild(const QList<BuildProductPtr> &productsToBuild);
    void prepareBuildGraph(const Artifact::BuildState buildState, bool *sourceFilesChanged);
    void prepareBuildGraph_impl(Artifact *artifact, const Artifact::BuildState buildState, bool *sourceFilesChanged);
    void updateBuildGraph(Artifact::BuildState buildState);
    void updateBuildGraph_impl(Artifact *artifact, Artifact::BuildState buildState, QSet<Artifact *> &seenArtifacts);
    void initLeaves(const QList<Artifact *> &changedArtifacts);
    void initLeavesTopDown(Artifact *artifact, QSet<Artifact *> &seenArtifacts);
    bool scheduleJobs();
    void buildArtifact(Artifact *artifact);
    void finishJob(ExecutorJob *job, bool success);
    void finishArtifact(Artifact *artifact);
    void initializeArtifactsState();
    void setState(ExecutorState);
    void addExecutorJobs(int jobNumber);
    void removeExecutorJobs(int jobNumber);
    void runAutoMoc();
    void insertLeavesAfterAddingDependencies(QVector<Artifact *> dependencies);
    void cancelJobs();
    void setupProgressObserver(bool mocWillRun);

    ScriptEngine *m_engine;
    BuildOptions m_buildOptions;
    ProgressObserver *m_progressObserver;
    QList<ExecutorJob*> m_availableJobs;
    QHash<ExecutorJob*, Artifact *> m_processingJobs;
    ExecutorState m_state;
    QList<BuildProductPtr> m_productsToBuild;
    QList<Artifact *> m_roots;
    QList<Artifact *> m_leaves;
    ScanResultCache m_scanResultCache;
    InputArtifactScannerContext *m_inputArtifactScanContext;
    AutoMoc *m_autoMoc;
    int m_mocEffort;
    Error m_error;
    bool m_explicitlyCanceled;
};

} // namespace Internal
} // namespace qbs

#endif // QBS_BUILDGRAPHEXECUTOR_H