genericproject.cpp 14.2 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
Roberto Raggi's avatar
Roberto Raggi committed
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
Roberto Raggi's avatar
Roberto Raggi committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
Roberto Raggi's avatar
Roberto Raggi committed
7
**
hjk's avatar
hjk committed
8
9
10
11
12
13
14
** 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.
Roberto Raggi's avatar
Roberto Raggi committed
15
16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
18
19
20
21
22
23
24
25
** 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
con's avatar
con committed
26
27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
Roberto Raggi's avatar
Roberto Raggi committed
29
30

#include "genericproject.h"
Tobias Hunger's avatar
Tobias Hunger committed
31

dt's avatar
dt committed
32
#include "genericbuildconfiguration.h"
Tobias Hunger's avatar
Tobias Hunger committed
33
#include "genericmakestep.h"
hjk's avatar
hjk committed
34
#include "genericprojectconstants.h"
Roberto Raggi's avatar
Roberto Raggi committed
35

hjk's avatar
hjk committed
36
37
38
#include <coreplugin/documentmanager.h>
#include <coreplugin/icontext.h>
#include <coreplugin/icore.h>
39
40
#include <coreplugin/mimedatabase.h>
#include <cpptools/cpptoolsconstants.h>
41
#include <cpptools/cppmodelmanagerinterface.h>
hjk's avatar
hjk committed
42
#include <extensionsystem/pluginmanager.h>
43
#include <projectexplorer/abi.h>
Tobias Hunger's avatar
Tobias Hunger committed
44
#include <projectexplorer/buildsteplist.h>
45
#include <projectexplorer/headerpath.h>
Tobias Hunger's avatar
Tobias Hunger committed
46
47
#include <projectexplorer/kitinformation.h>
#include <projectexplorer/kitmanager.h>
Roberto Raggi's avatar
Roberto Raggi committed
48
#include <projectexplorer/projectexplorerconstants.h>
49
#include <qtsupport/customexecutablerunconfiguration.h>
50
#include <utils/fileutils.h>
hjk's avatar
hjk committed
51
#include <utils/qtcassert.h>
Roberto Raggi's avatar
Roberto Raggi committed
52

53
54
#include <QDir>
#include <QProcessEnvironment>
Roberto Raggi's avatar
Roberto Raggi committed
55

hjk's avatar
hjk committed
56
using namespace Core;
57
using namespace ProjectExplorer;
Roberto Raggi's avatar
Roberto Raggi committed
58

hjk's avatar
hjk committed
59
60
61
namespace GenericProjectManager {
namespace Internal {

62
////////////////////////////////////////////////////////////////////////////////////
hjk's avatar
hjk committed
63
//
64
// GenericProject
hjk's avatar
hjk committed
65
//
66
67
////////////////////////////////////////////////////////////////////////////////////

Roberto Raggi's avatar
Roberto Raggi committed
68
GenericProject::GenericProject(Manager *manager, const QString &fileName)
69
    : m_manager(manager),
Tobias Hunger's avatar
Tobias Hunger committed
70
      m_fileName(fileName)
Roberto Raggi's avatar
Roberto Raggi committed
71
{
hjk's avatar
hjk committed
72
    setProjectContext(Context(GenericProjectManager::Constants::PROJECTCONTEXT));
73
    setProjectLanguages(Context(ProjectExplorer::Constants::LANG_CXX));
74

75
    QFileInfo fileInfo(m_fileName);
76
77
    QDir dir = fileInfo.dir();

78
    m_projectName      = fileInfo.completeBaseName();
79
80
81
    m_filesFileName    = QFileInfo(dir, m_projectName + QLatin1String(".files")).absoluteFilePath();
    m_includesFileName = QFileInfo(dir, m_projectName + QLatin1String(".includes")).absoluteFilePath();
    m_configFileName   = QFileInfo(dir, m_projectName + QLatin1String(".config")).absoluteFilePath();
82

83
84
85
86
    m_creatorIDocument  = new GenericProjectFile(this, m_fileName, GenericProject::Everything);
    m_filesIDocument    = new GenericProjectFile(this, m_filesFileName, GenericProject::Files);
    m_includesIDocument = new GenericProjectFile(this, m_includesFileName, GenericProject::Configuration);
    m_configIDocument   = new GenericProjectFile(this, m_configFileName, GenericProject::Configuration);
87

hjk's avatar
hjk committed
88
89
90
91
    DocumentManager::addDocument(m_creatorIDocument);
    DocumentManager::addDocument(m_filesIDocument);
    DocumentManager::addDocument(m_includesIDocument);
    DocumentManager::addDocument(m_configIDocument);
92

93
    m_rootNode = new GenericProjectNode(this, m_creatorIDocument);
94

95
    m_manager->registerProject(this);
Roberto Raggi's avatar
Roberto Raggi committed
96
97
98
99
}

GenericProject::~GenericProject()
{
100
    m_codeModelFuture.cancel();
101
    m_manager->unregisterProject(this);
102

103
    delete m_rootNode;
104
105
}

106
QString GenericProject::filesFileName() const
hjk's avatar
hjk committed
107
108
109
{
    return m_filesFileName;
}
110
111

QString GenericProject::includesFileName() const
hjk's avatar
hjk committed
112
113
114
{
    return m_includesFileName;
}
115
116

QString GenericProject::configFileName() const
hjk's avatar
hjk committed
117
118
119
{
    return m_configFileName;
}
120

121
static QStringList readLines(const QString &absoluteFileName)
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
{
    QStringList lines;

    QFile file(absoluteFileName);
    if (file.open(QFile::ReadOnly)) {
        QTextStream stream(&file);

        forever {
            QString line = stream.readLine();
            if (line.isNull())
                break;

            lines.append(line);
        }
    }

    return lines;
}

141
bool GenericProject::saveRawFileList(const QStringList &rawFileList)
142
{
143
    // Make sure we can open the file for writing
144
145
146
147
148
149
150
    Utils::FileSaver saver(filesFileName(), QIODevice::Text);
    if (!saver.hasError()) {
        QTextStream stream(saver.file());
        foreach (const QString &filePath, rawFileList)
            stream << filePath << QLatin1Char('\n');
        saver.setResult(&stream);
    }
hjk's avatar
hjk committed
151
    if (!saver.finalize(ICore::mainWindow()))
152
153
154
        return false;
    refresh(GenericProject::Files);
    return true;
155
}
156

157
158
bool GenericProject::addFiles(const QStringList &filePaths)
{
159
160
161
162
163
    QStringList newList = m_rawFileList;

    QDir baseDir(QFileInfo(m_fileName).dir());
    foreach (const QString &filePath, filePaths)
        newList.append(baseDir.relativeFilePath(filePath));
164

165
    return saveRawFileList(newList);
166
167
168
169
}

bool GenericProject::removeFiles(const QStringList &filePaths)
{
170
    QStringList newList = m_rawFileList;
171

172
173
174
175
    foreach (const QString &filePath, filePaths) {
        QHash<QString, QString>::iterator i = m_rawListEntries.find(filePath);
        if (i != m_rawListEntries.end())
            newList.removeOne(i.value());
176
    }
177

178
    return saveRawFileList(newList);
179
180
}

181
182
183
184
185
186
187
188
189
190
bool GenericProject::setFiles(const QStringList &filePaths)
{
    QStringList newList;
    QDir baseDir(QFileInfo(m_fileName).dir());
    foreach (const QString &filePath, filePaths)
        newList.append(baseDir.relativeFilePath(filePath));

    return saveRawFileList(newList);
}

191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
bool GenericProject::renameFile(const QString &filePath, const QString &newFilePath)
{
    QStringList newList = m_rawFileList;

    QHash<QString, QString>::iterator i = m_rawListEntries.find(filePath);
    if (i != m_rawListEntries.end()) {
        int index = newList.indexOf(i.value());
        if (index != -1) {
            QDir baseDir(QFileInfo(m_fileName).dir());
            newList.replace(index, baseDir.relativeFilePath(newFilePath));
        }
    }

    return saveRawFileList(newList);
}

207
void GenericProject::parseProject(RefreshOptions options)
Roberto Raggi's avatar
Roberto Raggi committed
208
{
209
210
211
    if (options & Files) {
        m_rawListEntries.clear();
        m_rawFileList = readLines(filesFileName());
212
        m_files = processEntries(m_rawFileList, &m_rawListEntries);
213
    }
214

215
    if (options & Configuration) {
216
        m_projectIncludePaths = processEntries(readLines(includesFileName()));
217

218
219
        // TODO: Possibly load some configuration from the project file
        //QSettings projectInfo(m_fileName, QSettings::IniFormat);
Roberto Raggi's avatar
Roberto Raggi committed
220

221
        m_defines.clear();
Roberto Raggi's avatar
Roberto Raggi committed
222

223
        QFile configFile(configFileName());
224
225
226
227
228
        if (configFile.open(QFile::ReadOnly)) {
            // convert from local/file encoding to UTF-8
            QTextStream configStream(&configFile);
            m_defines = configStream.readAll().toUtf8();
        }
229
    }
230

231
232
    if (options & Files)
        emit fileListChanged();
Roberto Raggi's avatar
Roberto Raggi committed
233
234
}

235
void GenericProject::refresh(RefreshOptions options)
Roberto Raggi's avatar
Roberto Raggi committed
236
{
237
238
239
    QSet<QString> oldFileList;
    if (!(options & Configuration))
        oldFileList = m_files.toSet();
240

241
242
243
    parseProject(options);

    if (options & Files)
244
        m_rootNode->refresh(oldFileList);
Roberto Raggi's avatar
Roberto Raggi committed
245

246
247
    CppTools::CppModelManagerInterface *modelManager =
        CppTools::CppModelManagerInterface::instance();
Roberto Raggi's avatar
Roberto Raggi committed
248

249
    if (modelManager) {
250
        CppTools::CppModelManagerInterface::ProjectInfo pinfo = modelManager->projectInfo(this);
251
        pinfo.clearProjectParts();
252
        CppTools::ProjectPart::Ptr part(new CppTools::ProjectPart);
253
254
255
        part->project = this;
        part->displayName = displayName();
        part->projectFile = projectFilePath();
Roberto Raggi's avatar
Roberto Raggi committed
256

257
        Kit *k = activeTarget() ? activeTarget()->kit() : KitManager::defaultKit();
258
        if (ToolChain *tc = ToolChainKitInformation::toolChain(k)) {
259
            QStringList cxxflags; // FIXME: Can we do better?
260
261
            part->evaluateToolchain(tc, cxxflags, cxxflags,
                                    SysRootKitInformation::sysRoot(k));
Roberto Raggi's avatar
Roberto Raggi committed
262
263
        }

264
        part->cxxVersion = CppTools::ProjectPart::CXX11; // assume C++11
265
266
        part->includePaths += allIncludePaths();
        part->defines += m_defines;
Roberto Raggi's avatar
Roberto Raggi committed
267
268

        // ### add _defines.
269
270

        // Add any C/C++ files to be parsed
271
        CppTools::ProjectFileAdder adder(part->files);
272
273
        foreach (const QString &file, files())
            adder.maybeAdd(file);
Roberto Raggi's avatar
Roberto Raggi committed
274

275
        m_codeModelFuture.cancel();
276

277
        pinfo.appendProjectPart(part);
278
        setProjectLanguage(ProjectExplorer::Constants::LANG_CXX, !part->files.isEmpty());
279

280
        m_codeModelFuture = modelManager->updateProjectInfo(pinfo);
Roberto Raggi's avatar
Roberto Raggi committed
281
282
283
    }
}

284
/**
285
286
287
288
289
 * Expands environment variables in the given \a string when they are written
 * like $$(VARIABLE).
 */
static void expandEnvironmentVariables(const QProcessEnvironment &env, QString &string)
{
290
    static QRegExp candidate(QLatin1String("\\$\\$\\((.+)\\)"));
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306

    int index = candidate.indexIn(string);
    while (index != -1) {
        const QString value = env.value(candidate.cap(1));

        string.replace(index, candidate.matchedLength(), value);
        index += value.length();

        index = candidate.indexIn(string, index);
    }
}

/**
 * Expands environment variables and converts the path from relative to the
 * project to an absolute path.
 *
307
 * The \a map variable is an optional argument that will map the returned
308
 * absolute paths back to their original \a entries.
309
 */
310
311
QStringList GenericProject::processEntries(const QStringList &paths,
                                           QHash<QString, QString> *map) const
Roberto Raggi's avatar
Roberto Raggi committed
312
{
313
    const QProcessEnvironment env = QProcessEnvironment::systemEnvironment();
314
    const QDir projectDir(QFileInfo(m_fileName).dir());
315

316
    QFileInfo fileInfo;
Roberto Raggi's avatar
Roberto Raggi committed
317
    QStringList absolutePaths;
318
    foreach (const QString &path, paths) {
319
320
        QString trimmedPath = path.trimmed();
        if (trimmedPath.isEmpty())
321
322
            continue;

323
324
        expandEnvironmentVariables(env, trimmedPath);

325
326
        trimmedPath = Utils::FileName::fromUserInput(trimmedPath).toString();

327
328
329
330
331
332
333
        fileInfo.setFile(projectDir, trimmedPath);
        if (fileInfo.exists()) {
            const QString absPath = fileInfo.absoluteFilePath();
            absolutePaths.append(absPath);
            if (map)
                map->insert(absPath, trimmedPath);
        }
Roberto Raggi's avatar
Roberto Raggi committed
334
335
336
337
338
    }
    absolutePaths.removeDuplicates();
    return absolutePaths;
}

Roberto Raggi's avatar
Roberto Raggi committed
339
340
341
QStringList GenericProject::allIncludePaths() const
{
    QStringList paths;
342
343
    paths += m_includePaths;
    paths += m_projectIncludePaths;
Roberto Raggi's avatar
Roberto Raggi committed
344
345
346
347
348
    paths.removeDuplicates();
    return paths;
}

QStringList GenericProject::projectIncludePaths() const
hjk's avatar
hjk committed
349
350
351
{
    return m_projectIncludePaths;
}
Roberto Raggi's avatar
Roberto Raggi committed
352

Roberto Raggi's avatar
Roberto Raggi committed
353
QStringList GenericProject::files() const
hjk's avatar
hjk committed
354
355
356
{
    return m_files;
}
Roberto Raggi's avatar
Roberto Raggi committed
357
358

QStringList GenericProject::includePaths() const
hjk's avatar
hjk committed
359
360
361
{
    return m_includePaths;
}
Roberto Raggi's avatar
Roberto Raggi committed
362
363

void GenericProject::setIncludePaths(const QStringList &includePaths)
hjk's avatar
hjk committed
364
365
366
{
    m_includePaths = includePaths;
}
Roberto Raggi's avatar
Roberto Raggi committed
367

Roberto Raggi's avatar
Roberto Raggi committed
368
QByteArray GenericProject::defines() const
hjk's avatar
hjk committed
369
370
371
{
    return m_defines;
}
Roberto Raggi's avatar
Roberto Raggi committed
372

373
QString GenericProject::displayName() const
Roberto Raggi's avatar
Roberto Raggi committed
374
{
375
    return m_projectName;
Roberto Raggi's avatar
Roberto Raggi committed
376
377
}

hjk's avatar
hjk committed
378
Id GenericProject::id() const
Tobias Hunger's avatar
Tobias Hunger committed
379
{
hjk's avatar
hjk committed
380
    return Id(Constants::GENERICPROJECT_ID);
Tobias Hunger's avatar
Tobias Hunger committed
381
382
}

hjk's avatar
hjk committed
383
IDocument *GenericProject::document() const
Roberto Raggi's avatar
Roberto Raggi committed
384
{
385
    return m_creatorIDocument;
Roberto Raggi's avatar
Roberto Raggi committed
386
387
}

388
IProjectManager *GenericProject::projectManager() const
Roberto Raggi's avatar
Roberto Raggi committed
389
{
390
    return m_manager;
Roberto Raggi's avatar
Roberto Raggi committed
391
392
}

393
GenericProjectNode *GenericProject::rootProjectNode() const
Roberto Raggi's avatar
Roberto Raggi committed
394
{
395
    return m_rootNode;
Roberto Raggi's avatar
Roberto Raggi committed
396
397
398
399
}

QStringList GenericProject::files(FilesMode fileMode) const
{
400
    Q_UNUSED(fileMode)
401
    return m_files;
Roberto Raggi's avatar
Roberto Raggi committed
402
403
}

Tobias Hunger's avatar
Tobias Hunger committed
404
QStringList GenericProject::buildTargets() const
Roberto Raggi's avatar
Roberto Raggi committed
405
406
407
408
409
410
411
{
    QStringList targets;
    targets.append(QLatin1String("all"));
    targets.append(QLatin1String("clean"));
    return targets;
}

412
413
414
415
bool GenericProject::fromMap(const QVariantMap &map)
{
    if (!Project::fromMap(map))
        return false;
Roberto Raggi's avatar
Roberto Raggi committed
416

417
    Kit *defaultKit = KitManager::defaultKit();
Tobias Hunger's avatar
Tobias Hunger committed
418
419
    if (!activeTarget() && defaultKit)
        addTarget(createTarget(defaultKit));
Tobias Hunger's avatar
Tobias Hunger committed
420

421
422
423
424
425
426
427
428
    // Sanity check: We need both a buildconfiguration and a runconfiguration!
    QList<Target *> targetList = targets();
    foreach (Target *t, targetList) {
        if (!t->activeBuildConfiguration()) {
            removeTarget(t);
            continue;
        }
        if (!t->activeRunConfiguration())
429
            t->addRunConfiguration(new QtSupport::CustomExecutableRunConfiguration(t));
430
431
    }

Roberto Raggi's avatar
Roberto Raggi committed
432
    setIncludePaths(allIncludePaths());
433

Tobias Hunger's avatar
Tobias Hunger committed
434
    refresh(Everything);
435
    return true;
436
437
}

Roberto Raggi's avatar
Roberto Raggi committed
438
////////////////////////////////////////////////////////////////////////////////////
hjk's avatar
hjk committed
439
//
Roberto Raggi's avatar
Roberto Raggi committed
440
// GenericProjectFile
hjk's avatar
hjk committed
441
//
Roberto Raggi's avatar
Roberto Raggi committed
442
////////////////////////////////////////////////////////////////////////////////////
443

444
GenericProjectFile::GenericProjectFile(GenericProject *parent, QString fileName, GenericProject::RefreshOptions options)
hjk's avatar
hjk committed
445
    : IDocument(parent),
446
      m_project(parent),
447
      m_options(options)
Roberto Raggi's avatar
Roberto Raggi committed
448
{
449
    setFilePath(fileName);
Roberto Raggi's avatar
Roberto Raggi committed
450
451
}

452
bool GenericProjectFile::save(QString *, const QString &, bool)
Roberto Raggi's avatar
Roberto Raggi committed
453
{
454
    return false;
Roberto Raggi's avatar
Roberto Raggi committed
455
456
457
458
459
460
461
462
463
464
465
466
467
468
}

QString GenericProjectFile::defaultPath() const
{
    return QString();
}

QString GenericProjectFile::suggestedFileName() const
{
    return QString();
}

QString GenericProjectFile::mimeType() const
{
469
    return QLatin1String(Constants::GENERICMIMETYPE);
Roberto Raggi's avatar
Roberto Raggi committed
470
471
472
473
474
475
476
477
478
479
480
481
}

bool GenericProjectFile::isModified() const
{
    return false;
}

bool GenericProjectFile::isSaveAsAllowed() const
{
    return false;
}

hjk's avatar
hjk committed
482
IDocument::ReloadBehavior GenericProjectFile::reloadBehavior(ChangeTrigger state, ChangeType type) const
Roberto Raggi's avatar
Roberto Raggi committed
483
{
484
485
486
487
488
    Q_UNUSED(state)
    Q_UNUSED(type)
    return BehaviorSilent;
}

489
bool GenericProjectFile::reload(QString *errorString, ReloadFlag flag, ChangeType type)
490
{
491
    Q_UNUSED(errorString)
492
    Q_UNUSED(flag)
493
494
495
    if (type == TypePermissions)
        return true;
    m_project->refresh(m_options);
496
    return true;
Roberto Raggi's avatar
Roberto Raggi committed
497
}
hjk's avatar
hjk committed
498
499
500

} // namespace Internal
} // namespace GenericProjectManager