genericproject.cpp 13.8 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
Roberto Raggi's avatar
Roberto Raggi committed
2
**
3
** Copyright (C) 2014 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
{
72
    setId(Constants::GENERICPROJECT_ID);
hjk's avatar
hjk committed
73
    setProjectContext(Context(GenericProjectManager::Constants::PROJECTCONTEXT));
74
    setProjectLanguages(Context(ProjectExplorer::Constants::LANG_CXX));
75

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

79
    m_projectName      = fileInfo.completeBaseName();
80 81 82
    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();
83

84 85 86 87
    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);
88

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

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

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

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

104
    delete m_rootNode;
105 106
}

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

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

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

122
static QStringList readLines(const QString &absoluteFileName)
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
{
    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;
}

142
bool GenericProject::saveRawFileList(const QStringList &rawFileList)
143 144 145 146 147 148 149
{
    bool result = saveRawList(rawFileList, filesFileName());
    refresh(GenericProject::Files);
    return result;
}

bool GenericProject::saveRawList(const QStringList &rawList, const QString &fileName)
150
{
151
    DocumentManager::expectFileChange(fileName);
152
    // Make sure we can open the file for writing
153
    Utils::FileSaver saver(fileName, QIODevice::Text);
154 155
    if (!saver.hasError()) {
        QTextStream stream(saver.file());
156
        foreach (const QString &filePath, rawList)
157 158 159
            stream << filePath << QLatin1Char('\n');
        saver.setResult(&stream);
    }
160 161 162
    bool result = saver.finalize(ICore::mainWindow());
    DocumentManager::unexpectFileChange(fileName);
    return result;
163
}
164

165 166
bool GenericProject::addFiles(const QStringList &filePaths)
{
167 168 169 170 171
    QStringList newList = m_rawFileList;

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

173 174 175 176 177 178 179 180 181 182 183 184 185 186 187

    QSet<QString> includes = projectIncludePaths().toSet();
    QSet<QString> toAdd;

    foreach (const QString &filePaths, filePaths) {
        QString directory = QFileInfo(filePaths).absolutePath();
        if (!includes.contains(directory)
                && !toAdd.contains(directory))
            toAdd << directory;
    }

    const QDir dir(projectDirectory().toString());
    foreach (const QString &path, toAdd) {
        QString relative = dir.relativeFilePath(path);
        if (relative.isEmpty())
188
            relative = QLatin1Char('.');
189 190 191 192 193 194 195 196
        m_rawProjectIncludePaths.append(relative);
    }

    bool result = saveRawList(newList, filesFileName());
    result &= saveRawList(m_rawProjectIncludePaths, includesFileName());
    refresh(GenericProject::Everything);

    return result;
197 198 199 200
}

bool GenericProject::removeFiles(const QStringList &filePaths)
{
201
    QStringList newList = m_rawFileList;
202

203 204 205 206
    foreach (const QString &filePath, filePaths) {
        QHash<QString, QString>::iterator i = m_rawListEntries.find(filePath);
        if (i != m_rawListEntries.end())
            newList.removeOne(i.value());
207
    }
208

209
    return saveRawFileList(newList);
210 211
}

212 213 214 215 216 217 218 219 220 221
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);
}

222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
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);
}

238
void GenericProject::parseProject(RefreshOptions options)
Roberto Raggi's avatar
Roberto Raggi committed
239
{
240 241 242
    if (options & Files) {
        m_rawListEntries.clear();
        m_rawFileList = readLines(filesFileName());
243
        m_files = processEntries(m_rawFileList, &m_rawListEntries);
244
    }
245

246
    if (options & Configuration) {
247 248
        m_rawProjectIncludePaths = readLines(includesFileName());
        m_projectIncludePaths = processEntries(m_rawProjectIncludePaths);
249

250 251
        // TODO: Possibly load some configuration from the project file
        //QSettings projectInfo(m_fileName, QSettings::IniFormat);
252
    }
253

254 255
    if (options & Files)
        emit fileListChanged();
Roberto Raggi's avatar
Roberto Raggi committed
256 257
}

258
void GenericProject::refresh(RefreshOptions options)
Roberto Raggi's avatar
Roberto Raggi committed
259
{
260
    QSet<QString> oldFileList;
261
    if (options & Files)
262
        oldFileList = m_files.toSet();
263

264 265 266
    parseProject(options);

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

269
    refreshCppCodeModel();
Roberto Raggi's avatar
Roberto Raggi committed
270 271
}

272
/**
273 274 275 276 277
 * Expands environment variables in the given \a string when they are written
 * like $$(VARIABLE).
 */
static void expandEnvironmentVariables(const QProcessEnvironment &env, QString &string)
{
278
    static QRegExp candidate(QLatin1String("\\$\\$\\((.+)\\)"));
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294

    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.
 *
295
 * The \a map variable is an optional argument that will map the returned
296
 * absolute paths back to their original \a entries.
297
 */
298 299
QStringList GenericProject::processEntries(const QStringList &paths,
                                           QHash<QString, QString> *map) const
Roberto Raggi's avatar
Roberto Raggi committed
300
{
301
    const QProcessEnvironment env = QProcessEnvironment::systemEnvironment();
302
    const QDir projectDir(QFileInfo(m_fileName).dir());
303

304
    QFileInfo fileInfo;
Roberto Raggi's avatar
Roberto Raggi committed
305
    QStringList absolutePaths;
306
    foreach (const QString &path, paths) {
307 308
        QString trimmedPath = path.trimmed();
        if (trimmedPath.isEmpty())
309 310
            continue;

311 312
        expandEnvironmentVariables(env, trimmedPath);

313 314
        trimmedPath = Utils::FileName::fromUserInput(trimmedPath).toString();

315 316 317 318 319 320 321
        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
322 323 324 325 326
    }
    absolutePaths.removeDuplicates();
    return absolutePaths;
}

327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
void GenericProject::refreshCppCodeModel()
{
    CppTools::CppModelManagerInterface *modelManager =
            CppTools::CppModelManagerInterface::instance();

    if (!modelManager)
        return;

    m_codeModelFuture.cancel();

    CppTools::ProjectInfo pInfo = modelManager->projectInfo(this);
    pInfo.clearProjectParts();

    CppTools::ProjectPartBuilder ppBuilder(pInfo);
    ppBuilder.setIncludePaths(projectIncludePaths());
    ppBuilder.setConfigFileName(configFileName());
    ppBuilder.setCxxFlags(QStringList() << QLatin1String("-std=c++11"));

    const QList<Core::Id> languages = ppBuilder.createProjectPartsForFiles(files());
    foreach (Core::Id language, languages)
        setProjectLanguage(language, true);

    m_codeModelFuture = modelManager->updateProjectInfo(pInfo);
}

Roberto Raggi's avatar
Roberto Raggi committed
352
QStringList GenericProject::projectIncludePaths() const
hjk's avatar
hjk committed
353 354 355
{
    return m_projectIncludePaths;
}
Roberto Raggi's avatar
Roberto Raggi committed
356

Roberto Raggi's avatar
Roberto Raggi committed
357
QStringList GenericProject::files() const
hjk's avatar
hjk committed
358 359 360
{
    return m_files;
}
Roberto Raggi's avatar
Roberto Raggi committed
361

362
QString GenericProject::displayName() const
Roberto Raggi's avatar
Roberto Raggi committed
363
{
364
    return m_projectName;
Roberto Raggi's avatar
Roberto Raggi committed
365 366
}

hjk's avatar
hjk committed
367
IDocument *GenericProject::document() const
Roberto Raggi's avatar
Roberto Raggi committed
368
{
369
    return m_creatorIDocument;
Roberto Raggi's avatar
Roberto Raggi committed
370 371
}

372
IProjectManager *GenericProject::projectManager() const
Roberto Raggi's avatar
Roberto Raggi committed
373
{
374
    return m_manager;
Roberto Raggi's avatar
Roberto Raggi committed
375 376
}

377
GenericProjectNode *GenericProject::rootProjectNode() const
Roberto Raggi's avatar
Roberto Raggi committed
378
{
379
    return m_rootNode;
Roberto Raggi's avatar
Roberto Raggi committed
380 381 382 383
}

QStringList GenericProject::files(FilesMode fileMode) const
{
384
    Q_UNUSED(fileMode)
385
    return m_files;
Roberto Raggi's avatar
Roberto Raggi committed
386 387
}

Tobias Hunger's avatar
Tobias Hunger committed
388
QStringList GenericProject::buildTargets() const
Roberto Raggi's avatar
Roberto Raggi committed
389 390 391 392 393 394 395
{
    QStringList targets;
    targets.append(QLatin1String("all"));
    targets.append(QLatin1String("clean"));
    return targets;
}

396 397 398 399
bool GenericProject::fromMap(const QVariantMap &map)
{
    if (!Project::fromMap(map))
        return false;
Roberto Raggi's avatar
Roberto Raggi committed
400

401
    Kit *defaultKit = KitManager::defaultKit();
Tobias Hunger's avatar
Tobias Hunger committed
402 403
    if (!activeTarget() && defaultKit)
        addTarget(createTarget(defaultKit));
Tobias Hunger's avatar
Tobias Hunger committed
404

405 406 407 408 409 410 411 412
    // 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())
413
            t->addRunConfiguration(new QtSupport::CustomExecutableRunConfiguration(t));
414 415
    }

Tobias Hunger's avatar
Tobias Hunger committed
416
    refresh(Everything);
417
    return true;
418 419
}

Roberto Raggi's avatar
Roberto Raggi committed
420
////////////////////////////////////////////////////////////////////////////////////
hjk's avatar
hjk committed
421
//
Roberto Raggi's avatar
Roberto Raggi committed
422
// GenericProjectFile
hjk's avatar
hjk committed
423
//
Roberto Raggi's avatar
Roberto Raggi committed
424
////////////////////////////////////////////////////////////////////////////////////
425

426
GenericProjectFile::GenericProjectFile(GenericProject *parent, QString fileName, GenericProject::RefreshOptions options)
hjk's avatar
hjk committed
427
    : IDocument(parent),
428
      m_project(parent),
429
      m_options(options)
Roberto Raggi's avatar
Roberto Raggi committed
430
{
431
    setId("Generic.ProjectFile");
hjk's avatar
hjk committed
432
    setMimeType(QLatin1String(Constants::GENERICMIMETYPE));
433
    setFilePath(fileName);
Roberto Raggi's avatar
Roberto Raggi committed
434 435
}

436
bool GenericProjectFile::save(QString *, const QString &, bool)
Roberto Raggi's avatar
Roberto Raggi committed
437
{
438
    return false;
Roberto Raggi's avatar
Roberto Raggi committed
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
}

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

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

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

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

hjk's avatar
hjk committed
461
IDocument::ReloadBehavior GenericProjectFile::reloadBehavior(ChangeTrigger state, ChangeType type) const
Roberto Raggi's avatar
Roberto Raggi committed
462
{
463 464 465 466 467
    Q_UNUSED(state)
    Q_UNUSED(type)
    return BehaviorSilent;
}

468
bool GenericProjectFile::reload(QString *errorString, ReloadFlag flag, ChangeType type)
469
{
470
    Q_UNUSED(errorString)
471
    Q_UNUSED(flag)
472 473 474
    if (type == TypePermissions)
        return true;
    m_project->refresh(m_options);
475
    return true;
Roberto Raggi's avatar
Roberto Raggi committed
476
}
hjk's avatar
hjk committed
477 478 479

} // namespace Internal
} // namespace GenericProjectManager