← Back to branch summary

~ubuntu-branches/debian/sid/kdevelop/sid

« back to all changes in this revision

Viewing changes to projectbuilders/makebuilder/makejob.cpp

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy Lainé
  • Date: 2010-05-05 07:21:55 UTC
  • mfrom: (1.2.3 upstream) (5.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100505072155-h78lx19pu04sbhtn
Tags: 4:4.0.0-2
http://bugs.debian.org/579947
http://bugs.debian.org/481832
http://bugs.debian.org/562410
http://bugs.debian.org/546961
* Upload to unstable (Closes: #579947, #481832).
* Acknowledge obsolete NMU fixes (Closes: #562410, #546961).

Show diffs side-by-side

added added

removed removed

Lines of Context:
projectbuilders/makebuilder/makejob.cpp
 
1
/* This file is part of KDevelop
 
2
    Copyright 2004 Roberto Raggi <roberto@kdevelop.org>
 
3
    Copyright 2007 Andreas Pakulat <apaku@gmx.de>
 
4
    Copyright 2007 Dukju Ahn <dukjuahn@gmail.com>
 
5
    Copyright 2008 Hamish Rodda <rodda@kde.org>
 
6
 
 
7
    This library is free software; you can redistribute it and/or
 
8
    modify it under the terms of the GNU Library General Public
 
9
    License as published by the Free Software Foundation; either
 
10
    version 2 of the License, or (at your option) any later version.
 
11
 
 
12
    This library is distributed in the hope that it will be useful,
 
13
    but WITHOUT ANY WARRANTY; without even the implied warranty of
 
14
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
15
    Library General Public License for more details.
 
16
 
 
17
    You should have received a copy of the GNU Library General Public License
 
18
    along with this library; see the file COPYING.LIB.  If not, write to
 
19
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 
20
    Boston, MA 02110-1301, USA.
 
21
*/
 
22
 
 
23
#include "makejob.h"
 
24
 
 
25
#include <QtCore/QStringList>
 
26
#include <QtCore/QProcess>
 
27
 
 
28
#include <KDebug>
 
29
#include <kshell.h>
 
30
#include <kglobal.h>
 
31
#include <klocale.h>
 
32
#include <kprocess.h>
 
33
 
 
34
#include <interfaces/icore.h>
 
35
#include <interfaces/iplugincontroller.h>
 
36
#include <util/environmentgrouplist.h>
 
37
#include <project/projectmodel.h>
 
38
#include <project/interfaces/ibuildsystemmanager.h>
 
39
#include <util/processlinemaker.h>
 
40
#include <interfaces/iproject.h>
 
41
 
 
42
#include "makeoutputdelegate.h"
 
43
#include "makeoutputmodel.h"
 
44
#include "makebuilder.h"
 
45
 
 
46
using namespace KDevelop;
 
47
 
 
48
MakeJob::MakeJob(MakeBuilder* builder, KDevelop::ProjectBaseItem* item, CommandType c,  const QString& overrideTarget )
 
49
    : OutputJob(builder)
 
50
    , m_builder(builder)
 
51
    , m_item(item)
 
52
    , m_command(c)
 
53
    , m_overrideTarget(overrideTarget)
 
54
    , m_lineMaker(0)
 
55
    , m_process(0)
 
56
    , m_killed(false)
 
57
    , firstError(false)
 
58
{
 
59
    setCapabilities(Killable);
 
60
 
 
61
    QString title;
 
62
    if( !m_overrideTarget.isEmpty() )
 
63
        title = i18n("Make: %1", m_overrideTarget);
 
64
    else
 
65
        title = i18n("Make: %1", m_item->text());
 
66
 
 
67
    setTitle(title);
 
68
    setObjectName(title);
 
69
}
 
70
 
 
71
void MakeJob::start()
 
72
{
 
73
    kDebug(9037) << "Building with make" << m_command << m_overrideTarget;
 
74
 
 
75
    if( m_item->type() == KDevelop::ProjectBaseItem::File ) {
 
76
        setError(IncorrectItemError);
 
77
        setErrorText("Internal error: cannot build a file item");
 
78
        return emitResult();
 
79
    }
 
80
 
 
81
    KUrl buildDir = computeBuildDir(m_item);
 
82
    if( !buildDir.isValid() ) {
 
83
        setError(InvalidBuildDirectoryError);
 
84
        setErrorText(i18n("Invalid build directory '%1'", buildDir.prettyUrl()));
 
85
        return emitResult();
 
86
    }
 
87
 
 
88
    QStringList cmd = computeBuildCommand();
 
89
    if( cmd.isEmpty() ) {
 
90
        setError(BuildCommandError);
 
91
        setErrorText(i18n("Could not create build command for target '%1'", m_overrideTarget));
 
92
        return emitResult();
 
93
    }
 
94
 
 
95
    setStandardToolView(IOutputView::BuildView);
 
96
    setBehaviours(KDevelop::IOutputView::AllowUserClose | KDevelop::IOutputView::AutoScroll);
 
97
 
 
98
    setModel(new MakeOutputModel(buildDir), IOutputView::TakeOwnership);
 
99
    setDelegate(m_builder->delegate());
 
100
 
 
101
    startOutput();
 
102
 
 
103
    model()->addLine( buildDir.toLocalFile() + "> " + cmd.join(" ") );
 
104
 
 
105
    QString command = cmd.first();
 
106
    cmd.pop_front();
 
107
 
 
108
    m_process = new KProcess(this);
 
109
    m_process->setOutputChannelMode( KProcess::MergedChannels );
 
110
    m_lineMaker = new ProcessLineMaker( m_process );
 
111
    connect( m_lineMaker, SIGNAL(receivedStdoutLines( const QStringList& ) ),
 
112
             this, SLOT( addStandardOutput( const QStringList& ) ) );
 
113
    connect( m_process, SIGNAL( error( QProcess::ProcessError ) ),
 
114
             this, SLOT( procError( QProcess::ProcessError ) ) );
 
115
    connect( m_process, SIGNAL( finished( int, QProcess::ExitStatus ) ),
 
116
             this, SLOT( procFinished( int, QProcess::ExitStatus ) ) );
 
117
 
 
118
    m_process->setEnvironment( environmentVars() );
 
119
    m_process->setWorkingDirectory( buildDir.toLocalFile() );
 
120
    m_process->setProgram( command, cmd );
 
121
    kDebug(9037) << "Starting build:" << cmd << "Build directory" << buildDir;
 
122
    m_process->start();
 
123
}
 
124
 
 
125
KDevelop::ProjectBaseItem * MakeJob::item() const
 
126
{
 
127
    return m_item;
 
128
}
 
129
 
 
130
MakeJob::CommandType MakeJob::commandType()
 
131
{
 
132
    return m_command;
 
133
}
 
134
 
 
135
const QString & MakeJob::customTarget() const
 
136
{
 
137
    return m_overrideTarget;
 
138
}
 
139
 
 
140
KUrl MakeJob::computeBuildDir(KDevelop::ProjectBaseItem* item) const
 
141
{
 
142
    KUrl buildDir;
 
143
    KDevelop::IBuildSystemManager *bldMan = item->project()->buildSystemManager();
 
144
    if( bldMan )
 
145
        buildDir = bldMan->buildDirectory( item ); // the correct build dir
 
146
    else
 
147
    {
 
148
        switch( item->type() )
 
149
        {
 
150
            case KDevelop::ProjectBaseItem::Folder:
 
151
            case KDevelop::ProjectBaseItem::BuildFolder:
 
152
                return static_cast<KDevelop::ProjectFolderItem*>(item)->url();
 
153
                break;
 
154
            case KDevelop::ProjectBaseItem::Target:
 
155
            case KDevelop::ProjectBaseItem::File:
 
156
                buildDir = computeBuildDir( static_cast<KDevelop::ProjectBaseItem*>( item->parent() ) );
 
157
                break;
 
158
        }
 
159
    }
 
160
    return buildDir;
 
161
}
 
162
 
 
163
QStringList MakeJob::computeBuildCommand() const
 
164
{
 
165
    QStringList cmdline;
 
166
//     QString cmdline = DomUtil::readEntry(dom, makeTool);
 
167
//     int prio = DomUtil::readIntEntry(dom, priority);
 
168
//     QString nice;
 
169
//     if (prio != 0) {
 
170
//         nice = QString("nice -n%1 ").arg(prio);
 
171
//     }
 
172
 
 
173
    KSharedConfig::Ptr configPtr = m_item->project()->projectConfiguration();
 
174
    KConfigGroup builderGroup( configPtr, "MakeBuilder" );
 
175
 
 
176
    QString makeBin = builderGroup.readEntry("Make Binary", "make");
 
177
    cmdline << makeBin;
 
178
 
 
179
    if( ! builderGroup.readEntry("Abort on First Error", true) )
 
180
    {
 
181
        cmdline << "-k";
 
182
    }
 
183
    
 
184
    int jobnumber = builderGroup.readEntry("Number Of Jobs", 1);
 
185
    if(jobnumber>1) {
 
186
        QString jobNumberArg = QString("-j%1").arg(jobnumber);
 
187
        cmdline << jobNumberArg;
 
188
    }
 
189
    
 
190
    if( builderGroup.readEntry("Display Only", false) )
 
191
    {
 
192
        cmdline << "-n";
 
193
    }
 
194
    QString extraOptions = builderGroup.readEntry("Additional Options", QString());
 
195
    if( ! extraOptions.isEmpty() )
 
196
    {
 
197
        foreach(const QString& option, KShell::splitArgs( extraOptions ) )
 
198
            cmdline << option;
 
199
    }
 
200
 
 
201
    if( m_overrideTarget.isEmpty() )
 
202
    {
 
203
        QString target;
 
204
        switch (m_item->type()) {
 
205
        case KDevelop::ProjectBaseItem::Target:
 
206
        case KDevelop::ProjectBaseItem::ExecutableTarget:
 
207
        case KDevelop::ProjectBaseItem::LibraryTarget:
 
208
            Q_ASSERT(m_item->target());
 
209
            cmdline << m_item->target()->text();
 
210
            break;
 
211
        case KDevelop::ProjectBaseItem::BuildFolder:
 
212
            target = builderGroup.readEntry("Default Target", QString());
 
213
            if( !target.isEmpty() )
 
214
                cmdline << target;
 
215
            break;
 
216
        default: break; }
 
217
    }else
 
218
    {
 
219
        cmdline << m_overrideTarget;
 
220
    }
 
221
 
 
222
    bool runAsRoot = builderGroup.readEntry("Install As Root", false);
 
223
    if (runAsRoot && m_command == InstallCommand)
 
224
    {
 
225
        int suCommand = builderGroup.readEntry("Su Command", 0);
 
226
        QStringList kdesuline;
 
227
        kdesuline << ((suCommand == 0) ? "kdesu" : "kdesudo" ) << "-t" << "-c" << cmdline.join(" ");
 
228
        cmdline = kdesuline;
 
229
    }
 
230
 
 
231
    return cmdline;
 
232
}
 
233
 
 
234
QStringList MakeJob::environmentVars() const
 
235
{
 
236
    KSharedConfig::Ptr configPtr = m_item->project()->projectConfiguration();
 
237
    KConfigGroup builderGroup( configPtr, "MakeBuilder" );
 
238
    QString defaultProfile = builderGroup.readEntry(
 
239
            "Default Make Environment Profile", "default" );
 
240
 
 
241
    const KDevelop::EnvironmentGroupList l(KGlobal::config());
 
242
    QStringList env = QProcess::systemEnvironment();
 
243
    QStringList::iterator it, end = env.end();
 
244
    for( it = env.begin(); it != end; it++ ) {
 
245
        if( (*it).startsWith("LC_MESSAGES") || (*it).startsWith("LC_ALL") ) {
 
246
            env.erase( it );
 
247
        }
 
248
    }
 
249
    env.append( "LC_MESSAGES=C" );
 
250
    return l.createEnvironment( defaultProfile, env );
 
251
}
 
252
 
 
253
void MakeJob::addStandardOutput( const QStringList& lines )
 
254
{
 
255
    model()->addLines( lines );
 
256
}
 
257
 
 
258
void MakeJob::procError( QProcess::ProcessError err )
 
259
{
 
260
    //This slot might be called twice for a given process, once when a real error 
 
261
    //occurs and then again when the process has exited due to the error
 
262
    //via procFinished() slot. So make sure we run the code only once.
 
263
    if( error() )
 
264
    {
 
265
        return;
 
266
    } 
 
267
    Q_UNUSED(err)
 
268
    m_lineMaker->flushBuffers();
 
269
 
 
270
    if (!m_killed) {
 
271
        setError(FailedError);
 
272
        setErrorText(i18n("Job failed"));
 
273
        model()->addLine( i18n("*** Failed ***") );
 
274
 
 
275
    }
 
276
    emitResult();
 
277
}
 
278
void MakeJob::procFinished( int code, QProcess::ExitStatus status )
 
279
{
 
280
    Q_UNUSED(code)
 
281
    m_lineMaker->flushBuffers();
 
282
    if( code==0 && status == QProcess::NormalExit )
 
283
    {
 
284
        model()->addLine( i18n("*** Finished ***") );
 
285
        emitResult();
 
286
    }
 
287
    else
 
288
    {
 
289
        procError(QProcess::UnknownError);
 
290
    }
 
291
}
 
292
 
 
293
bool MakeJob::doKill()
 
294
{
 
295
    model()->addLine( i18n("*** Aborted ***") );
 
296
    m_killed = true;
 
297
    m_process->kill();
 
298
    return true;
 
299
}
 
300
 
 
301
MakeOutputModel* MakeJob::model() const
 
302
{
 
303
    return dynamic_cast<MakeOutputModel*>( OutputJob::model() );
 
304
}
 
305
 
 
306
void MakeJob::setItem( ProjectBaseItem* item )
 
307
{
 
308
    m_item = item;
 
309
}
 
310
 
 
311
 
 
312
#include "makejob.moc"