aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/buildgraph/executor.h
blob: 08d65efc99bac23a5b1e41887510bb5af7010805 (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
/****************************************************************************
**
** 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 BUILDGRAPHEXECUTOR_H
#define BUILDGRAPHEXECUTOR_H

#include "buildgraph.h"

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

#include <QObject>
#include <QVariant>

namespace qbs {
class ProgressObserver;

namespace Internal {

class AutoMoc;
class ExecutorJob;
class InputArtifactScannerContext;
class ScanResultCache;

class Executor : public QObject
{
    Q_OBJECT
public:
    Executor();
    ~Executor();

    void build(const QList<BuildProduct::Ptr> &productsToBuild);

    enum ExecutorState {
        ExecutorIdle,
        ExecutorRunning,
        ExecutorCanceled,
        ExecutorError
    };

    enum BuildResult {
        SuccessfulBuild,
        FailedBuild
    };

    void setEngine(ScriptEngine *engine);
    void setBuildOptions(const BuildOptions &buildOptions);
    void setProgressObserver(ProgressObserver *observer) { m_progressObserver = observer; }
    ExecutorState state() const { return m_state; }
    BuildResult buildResult() const { return m_buildResult; }

signals:
    void error();
    void finished();

private slots:
    void onProcessError(QString errorString);
    void onProcessSuccess();

private:
    void doBuild(const QList<BuildProduct::Ptr> &productsToBuild);
    void cancelBuild();
    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 buildNextArtifact();
    void buildArtifact(Artifact *artifact);
    void finishJob(ExecutorJob *job);
    void finishArtifact(Artifact *artifact);
    void finish();
    void initializeArtifactsState();
    void setState(ExecutorState);
    void setError(const QString &errorMessage);
    void addExecutorJobs(int jobNumber);
    void removeExecutorJobs(int jobNumber);
    void runAutoMoc();
    void printScanningMessageOnce();
    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;
    BuildResult m_buildResult;
    QList<BuildProduct::Ptr> m_productsToBuild;
    QList<Artifact *> m_roots;
    QList<Artifact *> m_leaves;
    ScanResultCache m_scanResultCache;
    InputArtifactScannerContext *m_inputArtifactScanContext;
    AutoMoc *m_autoMoc;
    int m_mocEffort;

    friend class ExecutorJob;
};

} // namespace Internal
} // namespace qbs

#endif // BUILDGRAPHEXECUTOR_H