genericproject.cpp 16.3 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
    if (options & Files)
175
        m_files = convertToAbsoluteFiles(readLines(filesFileName()));
176

177
    if (options & Configuration) {
178
        m_projectIncludePaths = convertToAbsoluteFiles(readLines(includesFileName()));
179

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

183
        m_defines.clear();
Roberto Raggi's avatar
Roberto Raggi committed
184

185 186 187 188
        QFile configFile(configFileName());
        if (configFile.open(QFile::ReadOnly))
            m_defines = configFile.readAll();
    }
189

190 191
    if (options & Files)
        emit fileListChanged();
Roberto Raggi's avatar
Roberto Raggi committed
192 193
}

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

200 201 202 203
    parseProject(options);

    if (options & Files)
        m_rootNode->refresh();
Roberto Raggi's avatar
Roberto Raggi committed
204 205 206 207

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

208 209 210
    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
211 212 213

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

        QStringList allIncludePaths, allFrameworkPaths;

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

Roberto Raggi's avatar
Roberto Raggi committed
226
        allIncludePaths += this->allIncludePaths();
Roberto Raggi's avatar
Roberto Raggi committed
227 228 229 230 231

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

        // ### add _defines.
Roberto Raggi's avatar
Roberto Raggi committed
232 233
        pinfo.sourceFiles = files();
        pinfo.sourceFiles += generated();
Roberto Raggi's avatar
Roberto Raggi committed
234

235 236 237 238 239 240 241 242 243 244 245
        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());
        }
246

Roberto Raggi's avatar
Roberto Raggi committed
247
        modelManager->updateProjectInfo(pinfo);
248
        modelManager->updateSourceFiles(filesToUpdate);
Roberto Raggi's avatar
Roberto Raggi committed
249 250 251
    }
}

Roberto Raggi's avatar
Roberto Raggi committed
252 253
QStringList GenericProject::convertToAbsoluteFiles(const QStringList &paths) const
{
254
    const QDir projectDir(QFileInfo(m_fileName).dir());
Roberto Raggi's avatar
Roberto Raggi committed
255 256 257 258 259 260 261 262 263
    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
264 265 266
QStringList GenericProject::allIncludePaths() const
{
    QStringList paths;
267 268
    paths += m_includePaths;
    paths += m_projectIncludePaths;
Roberto Raggi's avatar
Roberto Raggi committed
269 270 271 272 273
    paths.removeDuplicates();
    return paths;
}

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

Roberto Raggi's avatar
Roberto Raggi committed
276
QStringList GenericProject::files() const
277
{ return m_files; }
Roberto Raggi's avatar
Roberto Raggi committed
278 279

QStringList GenericProject::generated() const
280
{ return m_generated; }
Roberto Raggi's avatar
Roberto Raggi committed
281 282

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

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

Roberto Raggi's avatar
Roberto Raggi committed
288
QByteArray GenericProject::defines() const
289
{ return m_defines; }
Roberto Raggi's avatar
Roberto Raggi committed
290 291

void GenericProject::setToolChainId(const QString &toolChainId)
Roberto Raggi's avatar
Roberto Raggi committed
292 293 294
{
    using namespace ProjectExplorer;

295
    m_toolChainId = toolChainId;
296

297 298
    delete m_toolChain;
    m_toolChain = 0;
Roberto Raggi's avatar
Roberto Raggi committed
299 300 301 302 303

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

304
        m_toolChain = ToolChain::createMinGWToolChain(qmake_cxx, mingwDirectory);
Roberto Raggi's avatar
Roberto Raggi committed
305 306 307

    } else if (toolChainId == QLatin1String("msvc")) {
        const QString msvcVersion; // ### FIXME
308
        m_toolChain = ToolChain::createMSVCToolChain(msvcVersion, false);
Roberto Raggi's avatar
Roberto Raggi committed
309 310 311

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

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

QString GenericProject::buildParser(const QString &buildConfiguration) const
{
322 323
    if (m_toolChain) {
        switch (m_toolChain->type()) {
Roberto Raggi's avatar
Roberto Raggi committed
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
        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();
}

341 342 343 344 345
ProjectExplorer::ToolChain *GenericProject::toolChain() const
{
    return m_toolChain;
}

346
QString GenericProject::toolChainId() const
347
{ return m_toolChainId; }
348

Roberto Raggi's avatar
Roberto Raggi committed
349 350
QString GenericProject::name() const
{
351
    return m_projectName;
Roberto Raggi's avatar
Roberto Raggi committed
352 353 354 355
}

Core::IFile *GenericProject::file() const
{
356
    return m_file;
Roberto Raggi's avatar
Roberto Raggi committed
357 358 359 360
}

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

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()) {
384
        QFileInfo fileInfo(m_fileName);
Roberto Raggi's avatar
Roberto Raggi committed
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406

        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);
 }

407
GenericProjectNode *GenericProject::rootProjectNode() const
Roberto Raggi's avatar
Roberto Raggi committed
408
{
409
    return m_rootNode;
Roberto Raggi's avatar
Roberto Raggi committed
410 411 412 413
}

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

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

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

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

    if (buildConfigurations().isEmpty()) {
439
        GenericMakeStep *makeStep = new GenericMakeStep(this);
Roberto Raggi's avatar
Roberto Raggi committed
440 441 442 443 444 445 446 447 448 449 450 451 452
        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());
    }
453 454 455 456 457

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

Roberto Raggi's avatar
Roberto Raggi committed
458
    setToolChainId(toolChainId.toLower()); // ### move
Roberto Raggi's avatar
Roberto Raggi committed
459 460 461 462 463

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

    setIncludePaths(allIncludePaths());
464

465
    refresh(Everything);
466 467 468 469 470 471
}

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

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

////////////////////////////////////////////////////////////////////////////////////
// GenericBuildSettingsWidget
////////////////////////////////////////////////////////////////////////////////////
479

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

    // build directory
486 487 488 489
    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()));
490

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

GenericBuildSettingsWidget::~GenericBuildSettingsWidget()
{ }

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

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

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

////////////////////////////////////////////////////////////////////////////////////
// GenericProjectFile
////////////////////////////////////////////////////////////////////////////////////
519

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

GenericProjectFile::~GenericProjectFile()
{ }

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

QString GenericProjectFile::fileName() const
{
536
    return m_fileName;
Roberto Raggi's avatar
Roberto Raggi committed
537 538 539 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
}

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 *)
{
}