genericproject.cpp 16.4 KB
Newer Older
Roberto Raggi's avatar
Roberto Raggi committed
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
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact:  Qt Software Information (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
**
**************************************************************************/

#include "genericproject.h"
#include "genericprojectconstants.h"
32
#include "genericmakestep.h"
Roberto Raggi's avatar
Roberto Raggi committed
33

34
#include <projectexplorer/toolchain.h>
Roberto Raggi's avatar
Roberto Raggi committed
35 36 37
#include <projectexplorer/projectexplorerconstants.h>
#include <cpptools/cppmodelmanagerinterface.h>
#include <extensionsystem/pluginmanager.h>
38
#include <utils/pathchooser.h>
Roberto Raggi's avatar
Roberto Raggi committed
39 40 41
#include <utils/qtcassert.h>
#include <coreplugin/icore.h>

42 43 44 45
#include <QtCore/QtDebug>
#include <QtCore/QDir>
#include <QtCore/QSettings>
#include <QtCore/QProcess>
46
#include <QtCore/QCoreApplication>
Roberto Raggi's avatar
Roberto Raggi committed
47

48 49 50
#include <QtGui/QFormLayout>
#include <QtGui/QMainWindow>
#include <QtGui/QComboBox>
51 52
#include <QtGui/QStringListModel>
#include <QtGui/QListWidget>
53
#include <QtGui/QPushButton>
Roberto Raggi's avatar
Roberto Raggi committed
54 55 56 57

using namespace GenericProjectManager;
using namespace GenericProjectManager::Internal;

58 59
namespace {

60 61 62 63
/**
 * An editable string list model. New strings can be added by editing the entry
 * called "<new>", displayed at the end.
 */
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
class ListModel: public QStringListModel
{
public:
    ListModel(QObject *parent)
        : QStringListModel(parent) {}

    virtual ~ListModel() {}

    virtual int rowCount(const QModelIndex &parent) const
    { return 1 + QStringListModel::rowCount(parent); }

    virtual Qt::ItemFlags flags(const QModelIndex &index) const
    { return QStringListModel::flags(index) | Qt::ItemIsEditable | Qt::ItemIsDragEnabled | Qt::ItemIsDropEnabled; }

    virtual QModelIndex index(int row, int column, const QModelIndex &parent) const
    {
        if (row == stringList().size())
            return createIndex(row, column);

        return QStringListModel::index(row, column, parent);
    }

    virtual QVariant data(const QModelIndex &index, int role) const
    {
        if (role == Qt::DisplayRole || role == Qt::EditRole) {
            if (index.row() == stringList().size())
90
                return QCoreApplication::translate("GenericProject", "<new>");
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
        }

        return QStringListModel::data(index, role);
    }

    virtual bool setData(const QModelIndex &index, const QVariant &value, int role)
    {
        if (role == Qt::EditRole && index.row() == stringList().size())
            insertRow(index.row(), QModelIndex());

        return QStringListModel::setData(index, value, role);
    }
};

} // end of anonymous namespace

107 108 109 110
////////////////////////////////////////////////////////////////////////////////////
// GenericProject
////////////////////////////////////////////////////////////////////////////////////

Roberto Raggi's avatar
Roberto Raggi committed
111
GenericProject::GenericProject(Manager *manager, const QString &fileName)
112 113 114
    : m_manager(manager),
      m_fileName(fileName),
      m_toolChain(0)
Roberto Raggi's avatar
Roberto Raggi committed
115
{
116
    QFileInfo fileInfo(m_fileName);
117 118
    QDir dir = fileInfo.dir();

119
    m_projectName      = fileInfo.completeBaseName();
120 121 122
    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();
123

124 125
    m_file = new GenericProjectFile(this, fileName);
    m_rootNode = new GenericProjectNode(this, m_file);
126

127
    m_manager->registerProject(this);
Roberto Raggi's avatar
Roberto Raggi committed
128 129 130 131
}

GenericProject::~GenericProject()
{
132
    m_manager->unregisterProject(this);
133

134 135
    delete m_rootNode;
    delete m_toolChain;
Roberto Raggi's avatar
Roberto Raggi committed
136 137
}

138
QString GenericProject::filesFileName() const
139
{ return m_filesFileName; }
140 141

QString GenericProject::includesFileName() const
142
{ return m_includesFileName; }
143 144

QString GenericProject::configFileName() const
145
{ return m_configFileName; }
146

147
static QStringList readLines(const QString &absoluteFileName)
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
{
    QStringList lines;

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

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

            line = line.trimmed();
            if (line.isEmpty())
                continue;

            lines.append(line);
        }
    }

    return lines;
}


172
void GenericProject::parseProject(RefreshOptions options)
Roberto Raggi's avatar
Roberto Raggi committed
173
{
174 175 176 177
    if (options & Files) {
        m_files = convertToAbsoluteFiles(readLines(filesFileName()));
        m_files.removeDuplicates();
    }
178

179 180 181
    if (options & Configuration) {
        m_projectIncludePaths = readLines(includesFileName());
        m_projectIncludePaths.removeDuplicates();
182

183 184
        QSettings projectInfo(m_fileName, QSettings::IniFormat);
        m_generated = convertToAbsoluteFiles(projectInfo.value(QLatin1String("generated")).toStringList());
Roberto Raggi's avatar
Roberto Raggi committed
185

186
        m_defines.clear();
Roberto Raggi's avatar
Roberto Raggi committed
187

188 189 190 191
        QFile configFile(configFileName());
        if (configFile.open(QFile::ReadOnly))
            m_defines = configFile.readAll();
    }
192

193 194
    if (options & Files)
        emit fileListChanged();
Roberto Raggi's avatar
Roberto Raggi committed
195 196
}

197
void GenericProject::refresh(RefreshOptions options)
Roberto Raggi's avatar
Roberto Raggi committed
198
{
199 200 201
    QSet<QString> oldFileList;
    if (!(options & Configuration))
        oldFileList = m_files.toSet();
202

203 204 205 206
    parseProject(options);

    if (options & Files)
        m_rootNode->refresh();
Roberto Raggi's avatar
Roberto Raggi committed
207 208 209 210

    CppTools::CppModelManagerInterface *modelManager =
        ExtensionSystem::PluginManager::instance()->getObject<CppTools::CppModelManagerInterface>();

211 212 213
    if (m_toolChain && modelManager) {
        const QByteArray predefinedMacros = m_toolChain->predefinedMacros();
        const QList<ProjectExplorer::HeaderPath> systemHeaderPaths = m_toolChain->systemHeaderPaths();
Roberto Raggi's avatar
Roberto Raggi committed
214 215 216

        CppTools::CppModelManagerInterface::ProjectInfo pinfo = modelManager->projectInfo(this);
        pinfo.defines = predefinedMacros;
Roberto Raggi's avatar
Roberto Raggi committed
217
        pinfo.defines += '\n';
218
        pinfo.defines += m_defines;
Roberto Raggi's avatar
Roberto Raggi committed
219 220 221

        QStringList allIncludePaths, allFrameworkPaths;

222
        foreach (const ProjectExplorer::HeaderPath &headerPath, m_toolChain->systemHeaderPaths()) {
Roberto Raggi's avatar
Roberto Raggi committed
223 224 225 226 227 228
            if (headerPath.kind() == ProjectExplorer::HeaderPath::FrameworkHeaderPath)
                allFrameworkPaths.append(headerPath.path());
            else
                allIncludePaths.append(headerPath.path());
        }

Roberto Raggi's avatar
Roberto Raggi committed
229
        allIncludePaths += this->allIncludePaths();
Roberto Raggi's avatar
Roberto Raggi committed
230 231 232 233 234

        pinfo.frameworkPaths = allFrameworkPaths;
        pinfo.includePaths = allIncludePaths;

        // ### add _defines.
Roberto Raggi's avatar
Roberto Raggi committed
235 236
        pinfo.sourceFiles = files();
        pinfo.sourceFiles += generated();
Roberto Raggi's avatar
Roberto Raggi committed
237

238 239 240 241 242 243 244 245 246 247 248
        QStringList filesToUpdate;

        if (options & Configuration) {
            filesToUpdate = pinfo.sourceFiles;
            filesToUpdate.append(QLatin1String("<configuration>")); // XXX don't hardcode configuration file name
        } else if (options & Files) {
            // Only update files that got added to the list
            QSet<QString> newFileList = m_files.toSet();
            newFileList.subtract(oldFileList);
            filesToUpdate.append(newFileList.toList());
        }
249

Roberto Raggi's avatar
Roberto Raggi committed
250
        modelManager->updateProjectInfo(pinfo);
251
        modelManager->updateSourceFiles(filesToUpdate);
Roberto Raggi's avatar
Roberto Raggi committed
252 253 254
    }
}

Roberto Raggi's avatar
Roberto Raggi committed
255 256
QStringList GenericProject::convertToAbsoluteFiles(const QStringList &paths) const
{
257
    const QDir projectDir(QFileInfo(m_fileName).dir());
Roberto Raggi's avatar
Roberto Raggi committed
258 259 260 261 262 263 264 265 266
    QStringList absolutePaths;
    foreach (const QString &file, paths) {
        QFileInfo fileInfo(projectDir, file);
        absolutePaths.append(fileInfo.absoluteFilePath());
    }
    absolutePaths.removeDuplicates();
    return absolutePaths;
}

Roberto Raggi's avatar
Roberto Raggi committed
267 268 269
QStringList GenericProject::allIncludePaths() const
{
    QStringList paths;
270 271
    paths += m_includePaths;
    paths += m_projectIncludePaths;
Roberto Raggi's avatar
Roberto Raggi committed
272 273 274 275 276
    paths.removeDuplicates();
    return paths;
}

QStringList GenericProject::projectIncludePaths() const
277
{ return m_projectIncludePaths; }
Roberto Raggi's avatar
Roberto Raggi committed
278

Roberto Raggi's avatar
Roberto Raggi committed
279
QStringList GenericProject::files() const
280
{ return m_files; }
Roberto Raggi's avatar
Roberto Raggi committed
281 282

QStringList GenericProject::generated() const
283
{ return m_generated; }
Roberto Raggi's avatar
Roberto Raggi committed
284 285

QStringList GenericProject::includePaths() const
286
{ return m_includePaths; }
Roberto Raggi's avatar
Roberto Raggi committed
287 288

void GenericProject::setIncludePaths(const QStringList &includePaths)
289
{ m_includePaths = includePaths; }
Roberto Raggi's avatar
Roberto Raggi committed
290

Roberto Raggi's avatar
Roberto Raggi committed
291
QByteArray GenericProject::defines() const
292
{ return m_defines; }
Roberto Raggi's avatar
Roberto Raggi committed
293 294

void GenericProject::setToolChainId(const QString &toolChainId)
Roberto Raggi's avatar
Roberto Raggi committed
295 296 297
{
    using namespace ProjectExplorer;

298
    m_toolChainId = toolChainId;
299

300 301
    delete m_toolChain;
    m_toolChain = 0;
Roberto Raggi's avatar
Roberto Raggi committed
302 303 304 305 306

    if (toolChainId == QLatin1String("mingw")) {
        const QLatin1String qmake_cxx("g++"); // ### FIXME
        const QString mingwDirectory; // ### FIXME

307
        m_toolChain = ToolChain::createMinGWToolChain(qmake_cxx, mingwDirectory);
Roberto Raggi's avatar
Roberto Raggi committed
308 309 310

    } else if (toolChainId == QLatin1String("msvc")) {
        const QString msvcVersion; // ### FIXME
311
        m_toolChain = ToolChain::createMSVCToolChain(msvcVersion);
Roberto Raggi's avatar
Roberto Raggi committed
312 313 314

    } else if (toolChainId == QLatin1String("wince")) {
        const QString msvcVersion, wincePlatform; // ### FIXME
315
        m_toolChain = ToolChain::createWinCEToolChain(msvcVersion, wincePlatform);
Roberto Raggi's avatar
Roberto Raggi committed
316 317 318

    } else if (toolChainId == QLatin1String("gcc") || toolChainId == QLatin1String("icc")) {
        const QLatin1String qmake_cxx("g++"); // ### FIXME
319
        m_toolChain = ToolChain::createGccToolChain(qmake_cxx);
Roberto Raggi's avatar
Roberto Raggi committed
320 321 322 323 324
    }
}

QString GenericProject::buildParser(const QString &buildConfiguration) const
{
325 326
    if (m_toolChain) {
        switch (m_toolChain->type()) {
Roberto Raggi's avatar
Roberto Raggi committed
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
        case ProjectExplorer::ToolChain::GCC:
        case ProjectExplorer::ToolChain::LinuxICC:
        case ProjectExplorer::ToolChain::MinGW:
            return QLatin1String(ProjectExplorer::Constants::BUILD_PARSER_GCC);

        case ProjectExplorer::ToolChain::MSVC:
        case ProjectExplorer::ToolChain::WINCE:
            return ProjectExplorer::Constants::BUILD_PARSER_MSVC;

        default:
            break;
        } // switch
    }

    return QString();
}

344 345 346 347 348
ProjectExplorer::ToolChain *GenericProject::toolChain() const
{
    return m_toolChain;
}

349
QString GenericProject::toolChainId() const
350
{ return m_toolChainId; }
351

Roberto Raggi's avatar
Roberto Raggi committed
352 353
QString GenericProject::name() const
{
354
    return m_projectName;
Roberto Raggi's avatar
Roberto Raggi committed
355 356 357 358
}

Core::IFile *GenericProject::file() const
{
359
    return m_file;
Roberto Raggi's avatar
Roberto Raggi committed
360 361 362 363
}

ProjectExplorer::IProjectManager *GenericProject::projectManager() const
{
364
    return m_manager;
Roberto Raggi's avatar
Roberto Raggi committed
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
}

QList<ProjectExplorer::Project *> GenericProject::dependsOn()
{
    return QList<Project *>();
}

bool GenericProject::isApplication() const
{
    return true;
}

ProjectExplorer::Environment GenericProject::environment(const QString &) const
{
    return ProjectExplorer::Environment::systemEnvironment();
}

QString GenericProject::buildDirectory(const QString &buildConfiguration) const
{
    QString buildDirectory = value(buildConfiguration, "buildDirectory").toString();

    if (buildDirectory.isEmpty()) {
387
        QFileInfo fileInfo(m_fileName);
Roberto Raggi's avatar
Roberto Raggi committed
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409

        buildDirectory = fileInfo.absolutePath();
    }

    return buildDirectory;
}

ProjectExplorer::BuildStepConfigWidget *GenericProject::createConfigWidget()
{
    return new GenericBuildSettingsWidget(this);
}

QList<ProjectExplorer::BuildStepConfigWidget*> GenericProject::subConfigWidgets()
{
    return QList<ProjectExplorer::BuildStepConfigWidget*>();
}

 void GenericProject::newBuildConfiguration(const QString &buildConfiguration)
 {
     makeStep()->setBuildTarget(buildConfiguration, "all", true);
 }

410
GenericProjectNode *GenericProject::rootProjectNode() const
Roberto Raggi's avatar
Roberto Raggi committed
411
{
412
    return m_rootNode;
Roberto Raggi's avatar
Roberto Raggi committed
413 414 415 416
}

QStringList GenericProject::files(FilesMode fileMode) const
{
417
    return m_files; // ### TODO: handle generated files here.
Roberto Raggi's avatar
Roberto Raggi committed
418 419 420 421 422 423 424 425 426 427
}

QStringList GenericProject::targets() const
{
    QStringList targets;
    targets.append(QLatin1String("all"));
    targets.append(QLatin1String("clean"));
    return targets;
}

428
GenericMakeStep *GenericProject::makeStep() const
Roberto Raggi's avatar
Roberto Raggi committed
429 430
{
    foreach (ProjectExplorer::BuildStep *bs, buildSteps()) {
431
        if (GenericMakeStep *ms = qobject_cast<GenericMakeStep *>(bs))
Roberto Raggi's avatar
Roberto Raggi committed
432 433 434 435 436 437 438 439 440 441
            return ms;
    }
    return 0;
}

void GenericProject::restoreSettingsImpl(ProjectExplorer::PersistentSettingsReader &reader)
{
    Project::restoreSettingsImpl(reader);

    if (buildConfigurations().isEmpty()) {
442
        GenericMakeStep *makeStep = new GenericMakeStep(this);
Roberto Raggi's avatar
Roberto Raggi committed
443 444 445 446 447 448 449 450 451 452 453 454 455
        insertBuildStep(0, makeStep);

        const QLatin1String all("all");

        addBuildConfiguration(all);
        setActiveBuildConfiguration(all);
        makeStep->setBuildTarget(all, all, /* on = */ true);

        const QLatin1String buildDirectory("buildDirectory");

        const QFileInfo fileInfo(file()->fileName());
        setValue(all, buildDirectory, fileInfo.absolutePath());
    }
456 457 458 459 460

    QString toolChainId = reader.restoreValue(QLatin1String("toolChain")).toString();
    if (toolChainId.isEmpty())
        toolChainId = QLatin1String("gcc");

Roberto Raggi's avatar
Roberto Raggi committed
461
    setToolChainId(toolChainId.toLower()); // ### move
Roberto Raggi's avatar
Roberto Raggi committed
462 463 464 465 466

    const QStringList userIncludePaths =
            reader.restoreValue(QLatin1String("includePaths")).toStringList();

    setIncludePaths(allIncludePaths());
467

468
    refresh(Everything);
469 470 471 472 473 474
}

void GenericProject::saveSettingsImpl(ProjectExplorer::PersistentSettingsWriter &writer)
{
    Project::saveSettingsImpl(writer);

475 476
    writer.saveValue(QLatin1String("toolChain"), m_toolChainId);
    writer.saveValue(QLatin1String("includePaths"), m_includePaths);
Roberto Raggi's avatar
Roberto Raggi committed
477 478 479 480 481
}

////////////////////////////////////////////////////////////////////////////////////
// GenericBuildSettingsWidget
////////////////////////////////////////////////////////////////////////////////////
482

Roberto Raggi's avatar
Roberto Raggi committed
483
GenericBuildSettingsWidget::GenericBuildSettingsWidget(GenericProject *project)
484
    : m_project(project)
Roberto Raggi's avatar
Roberto Raggi committed
485 486
{
    QFormLayout *fl = new QFormLayout(this);
487 488

    // build directory
489 490 491 492
    m_pathChooser = new Core::Utils::PathChooser(this);
    m_pathChooser->setEnabled(true);
    fl->addRow(tr("Build directory:"), m_pathChooser);
    connect(m_pathChooser, SIGNAL(changed()), this, SLOT(buildDirectoryChanged()));
493

494
    // tool chain
495 496
    QComboBox *toolChainChooser = new QComboBox;
    toolChainChooser->addItems(ProjectExplorer::ToolChain::supportedToolChains());
497
    toolChainChooser->setCurrentIndex(toolChainChooser->findText(m_project->toolChainId()));
498
    fl->addRow(tr("Toolchain:"), toolChainChooser);
499
    connect(toolChainChooser, SIGNAL(activated(QString)), m_project, SLOT(setToolChainId(QString)));
Roberto Raggi's avatar
Roberto Raggi committed
500 501 502 503 504 505 506 507 508 509
}

GenericBuildSettingsWidget::~GenericBuildSettingsWidget()
{ }

QString GenericBuildSettingsWidget::displayName() const
{ return tr("Generic Manager"); }

void GenericBuildSettingsWidget::init(const QString &buildConfiguration)
{
510 511
    m_buildConfiguration = buildConfiguration;
    m_pathChooser->setPath(m_project->buildDirectory(buildConfiguration));
Roberto Raggi's avatar
Roberto Raggi committed
512 513 514 515
}

void GenericBuildSettingsWidget::buildDirectoryChanged()
{
516
    m_project->setValue(m_buildConfiguration, "buildDirectory", m_pathChooser->path());
Roberto Raggi's avatar
Roberto Raggi committed
517 518 519 520 521
}

////////////////////////////////////////////////////////////////////////////////////
// GenericProjectFile
////////////////////////////////////////////////////////////////////////////////////
522

Roberto Raggi's avatar
Roberto Raggi committed
523 524
GenericProjectFile::GenericProjectFile(GenericProject *parent, QString fileName)
    : Core::IFile(parent),
525 526
      m_project(parent),
      m_fileName(fileName)
Roberto Raggi's avatar
Roberto Raggi committed
527 528 529 530 531 532 533 534 535 536 537 538
{ }

GenericProjectFile::~GenericProjectFile()
{ }

bool GenericProjectFile::save(const QString &)
{
    return false;
}

QString GenericProjectFile::fileName() const
{
539
    return m_fileName;
Roberto Raggi's avatar
Roberto Raggi committed
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
}

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

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

QString GenericProjectFile::mimeType() const
{
    return Constants::GENERICMIMETYPE;
}

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

bool GenericProjectFile::isReadOnly() const
{
    return true;
}

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

void GenericProjectFile::modified(ReloadBehavior *)
{
}