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
|
/*
This file is part of the KDE project
SPDX-FileCopyrightText: 2007-2008 Hamish Rodda <rodda@kde.org>
SPDX-FileCopyrightText: 2023 Igor Kushnir <igorkuo@gmail.com>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#include "ksequentialcompoundjob.h"
#include "ksequentialcompoundjob_p.h"
#include "debug.h"
using namespace KDevCoreAddons;
KSequentialCompoundJobPrivate::KSequentialCompoundJobPrivate() = default;
KSequentialCompoundJobPrivate::~KSequentialCompoundJobPrivate() = default;
bool KSequentialCompoundJobPrivate::isCurrentlyRunningSubjob(KJob *job) const
{
return m_jobIndex >= 0 && !m_subjobs.empty() && job == m_subjobs.constFirst();
}
void KSequentialCompoundJobPrivate::startNextSubjob()
{
++m_jobIndex;
Q_ASSERT(!m_subjobs.empty());
auto *const job = m_subjobs.front();
qCDebug(UTIL) << "starting subjob" << m_jobIndex + 1 << "of" << m_jobCount << ':' << job;
job->start();
}
void KSequentialCompoundJobPrivate::disconnectSubjob(KJob *job)
{
Q_Q(KSequentialCompoundJob);
QObject::disconnect(job, &KJob::percentChanged, q, &KSequentialCompoundJob::subjobPercentChanged);
KCompoundJobPrivate::disconnectSubjob(job);
}
KSequentialCompoundJob::KSequentialCompoundJob(QObject *parent)
: KSequentialCompoundJob(*new KSequentialCompoundJobPrivate, parent)
{
}
KSequentialCompoundJob::KSequentialCompoundJob(KSequentialCompoundJobPrivate &dd, QObject *parent)
: KCompoundJob(dd, parent)
{
setCapabilities(Killable);
}
KSequentialCompoundJob::~KSequentialCompoundJob() = default;
void KSequentialCompoundJob::setAbortOnSubjobError(bool abort)
{
Q_D(KSequentialCompoundJob);
d->m_abortOnSubjobError = abort;
}
void KSequentialCompoundJob::start()
{
Q_D(KSequentialCompoundJob);
if (d->m_subjobs.empty()) {
qCDebug(UTIL) << "no subjobs, finishing in start()";
emitResult();
return;
}
d->startNextSubjob();
}
void KSequentialCompoundJob::subjobPercentChanged(KJob *job, unsigned long percent)
{
Q_D(KSequentialCompoundJob);
Q_ASSERT(d->m_jobIndex < d->m_jobCount); // invariant
if (!d->isCurrentlyRunningSubjob(job)) {
qCDebug(UTIL) << "ignoring percentChanged() signal emitted by an unstarted or finished subjob" << job;
return;
}
Q_ASSERT(d->m_jobIndex >= 0);
const unsigned long totalPercent = (100.0 * d->m_jobIndex + percent) / d->m_jobCount;
qCDebug(UTIL) << "subjob percent:" << percent << "; total percent:" << totalPercent;
setPercent(totalPercent);
}
void KSequentialCompoundJob::subjobFinished(KJob *job)
{
Q_D(KSequentialCompoundJob);
if (d->m_killingSubjob || isFinished()) {
// doKill() will return true and this compound job will finish, or already finished
removeSubjob(job);
return;
}
Q_ASSERT(d->m_jobIndex < d->m_jobCount); // invariant
// Note: isCurrentlyRunningSubjob(job) must be checked before calling removeSubjob(job).
if (!d->isCurrentlyRunningSubjob(job)) {
qCDebug(UTIL) << "unstarted subjob finished:" << job;
removeSubjob(job);
return;
}
const bool registeredSubjob = removeSubjob(job);
Q_ASSERT(registeredSubjob); // because isCurrentlyRunningSubjob(job) returned true
Q_ASSERT(d->m_jobIndex >= 0); // because isCurrentlyRunningSubjob(job) returned true
const unsigned long totalPercent = 100.0 * (d->m_jobIndex + 1) / d->m_jobCount;
qCDebug(UTIL) << "subjob finished:" << job << "; total percent:" << totalPercent;
setPercent(totalPercent);
int error = job->error();
if (!error && d->m_killingFailed) {
error = KilledJobError;
}
// Abort if job is the subjob we failed to kill and in case of error.
const bool abort = d->m_killingFailed || (d->m_abortOnSubjobError && error);
if (abort) {
qCDebug(UTIL) << "aborting on subjob error:" << error << job->errorText();
}
// Finish in order to abort, or if all subjobs have finished. Propagate the last-run subjob's error.
if (abort || d->m_subjobs.empty()) {
setError(error);
setErrorText(job->errorText());
emitResult();
return;
}
qCDebug(UTIL) << "remaining subjobs:" << d->m_subjobs;
d->startNextSubjob();
}
bool KSequentialCompoundJob::addSubjob(KJob *job)
{
Q_D(KSequentialCompoundJob);
if (!KCompoundJob::addSubjob(job)) {
return false;
}
++d->m_jobCount;
connect(job, &KJob::percentChanged, this, &KSequentialCompoundJob::subjobPercentChanged);
return true;
}
bool KSequentialCompoundJob::doKill()
{
Q_D(KSequentialCompoundJob);
// Don't check isFinished() here, because KJob::kill() calls doKill() only if the job has not finished.
if (d->m_killingSubjob) {
qCDebug(UTIL) << "killing sequential compound job recursively fails";
return false;
}
if (d->m_jobIndex == -1) {
qCDebug(UTIL) << "killing unstarted sequential compound job";
// Any unstarted subjobs will be deleted along with this compound job, which is their parent.
return true;
}
if (d->m_subjobs.empty()) {
qCDebug(UTIL) << "killing sequential compound job with zero remaining subjobs";
return true;
}
auto *const job = d->m_subjobs.front();
qCDebug(UTIL) << "killing running subjob" << job;
d->m_killingSubjob = true;
const bool killed = job->kill();
d->m_killingSubjob = false;
d->m_killingFailed = !killed;
if (d->m_killingFailed) {
qCDebug(UTIL) << "failed to kill subjob" << job;
if (d->m_subjobs.empty() || d->m_subjobs.constFirst() != job) {
qCDebug(UTIL) << "... but the subjob finished or was removed, assume killed. Remaining subjobs:" << d->m_subjobs;
return true;
}
}
return killed;
}
#include "moc_ksequentialcompoundjob.cpp"
#include "moc_ksimplesequentialcompoundjob.cpp"
|
