projectfilewizardextension.cpp 15.6 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2
3
4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
** Commercial Usage
10
**
11
12
13
14
** 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.
15
**
16
** GNU Lesser General Public License Usage
17
**
18
19
20
21
22
23
** 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.
24
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30
31
#include "projectfilewizardextension.h"
#include "projectexplorer.h"
32
#include "session.h"
con's avatar
con committed
33
34
35
36
#include "projectnodes.h"
#include "nodesvisitor.h"
#include "projectwizardpage.h"

37
38
39
#include <utils/qtcassert.h>
#include <utils/stringutils.h>

con's avatar
con committed
40
41
42
43
44
#include <coreplugin/basefilewizard.h>
#include <coreplugin/filemanager.h>
#include <coreplugin/icore.h>
#include <coreplugin/iversioncontrol.h>
#include <coreplugin/vcsmanager.h>
45
#include <extensionsystem/pluginmanager.h>
con's avatar
con committed
46
47

#include <QtCore/QVariant>
48
#include <QtCore/QtAlgorithms>
con's avatar
con committed
49
50
51
#include <QtCore/QDebug>
#include <QtCore/QFileInfo>
#include <QtCore/QMultiMap>
52
#include <QtCore/QDir>
con's avatar
con committed
53
54
55
56
57
58
59
60
61

enum { debugExtension = 0 };

namespace ProjectExplorer {

typedef QList<ProjectNode *> ProjectNodeList;

namespace Internal {

dt's avatar
dt committed
62
63
// AllProjectNodesVisitor: Retrieve all projects (*.pri/*.pro)
// which support adding files
con's avatar
con committed
64
65
66
class AllProjectNodesVisitor : public NodesVisitor
{
public:
dt's avatar
dt committed
67
68
69
70
71
    AllProjectNodesVisitor(ProjectNode::ProjectAction action)
        : m_action(action)
        {}

    static ProjectNodeList allProjects(ProjectNode::ProjectAction action);
con's avatar
con committed
72
73
74
75

    virtual void visitProjectNode(ProjectNode *node);

private:
76
    ProjectNodeList m_projectNodes;
dt's avatar
dt committed
77
    ProjectNode::ProjectAction m_action;
con's avatar
con committed
78
79
};

dt's avatar
dt committed
80
ProjectNodeList AllProjectNodesVisitor::allProjects(ProjectNode::ProjectAction action)
con's avatar
con committed
81
{
dt's avatar
dt committed
82
    AllProjectNodesVisitor visitor(action);
83
84
    ProjectExplorerPlugin::instance()->session()->sessionNode()->accept(&visitor);
    return visitor.m_projectNodes;
con's avatar
con committed
85
86
87
88
}

void AllProjectNodesVisitor::visitProjectNode(ProjectNode *node)
{
dt's avatar
dt committed
89
    if (node->supportedActions(node).contains(m_action))
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
        m_projectNodes.push_back(node);
}

// ProjectEntry: Context entry for a *.pri/*.pro file. Stores name and path
// for quick sort and path search, provides operator<() for maps.
struct ProjectEntry {
    enum Type { ProFile, PriFile }; // Sort order: 'pro' before 'pri'

    ProjectEntry() : node(0), type(ProFile) {}
    explicit ProjectEntry(ProjectNode *node);

    int compare(const ProjectEntry &rhs) const;

    ProjectNode *node;
    QString nativeDirectory; // For matching against wizards' files, which are native.
    QString fileName;
    QString baseName;
    Type type;
};

ProjectEntry::ProjectEntry(ProjectNode *n) :
    node(n),
    type(ProFile)
{
    const QFileInfo fi(node->path());
    fileName = fi.fileName();
    baseName = fi.baseName();
    if (fi.suffix() != QLatin1String("pro"))
118
        type = PriFile;
119
120
121
122
123
124
    nativeDirectory = QDir::toNativeSeparators(fi.absolutePath());
}

// Sort helper that sorts by base name and puts '*.pro' before '*.pri'
int ProjectEntry::compare(const ProjectEntry &rhs) const
{
125
126
    if (const int drc = nativeDirectory.compare(rhs.nativeDirectory))
        return drc;
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
    if (const int brc = baseName.compare(rhs.baseName))
        return brc;
    if (type < rhs.type)
        return -1;
    if (type > rhs.type)
        return 1;
    return 0;
}

inline bool operator<(const ProjectEntry &pe1, const ProjectEntry &pe2)
{
    return pe1.compare(pe2) < 0;
}

QDebug operator<<(QDebug d, const ProjectEntry &e)
{
    d.nospace() << e.nativeDirectory << ' ' << e.fileName << ' ' << e.type;
    return d;
con's avatar
con committed
145
146
147
}

// --------- ProjectWizardContext
148
149
struct ProjectWizardContext
{
150
151
152
153
154
    ProjectWizardContext();
    void clear();

    QList<Core::IVersionControl*> versionControls;
    QList<ProjectEntry> projects;
con's avatar
con committed
155
    ProjectWizardPage *page;
156
157
    bool repositoryExists; // Is VCS 'add' sufficient, or should a repository be created?
    QString commonDirectory;
158
    const Core::IWizard *wizard;
con's avatar
con committed
159
160
};

161
162
ProjectWizardContext::ProjectWizardContext() :
    page(0),
163
164
    repositoryExists(false),
    wizard(0)
165
166
167
168
169
170
171
172
173
174
{
}

void ProjectWizardContext::clear()
{
    versionControls.clear();
    projects.clear();
    commonDirectory.clear();
    page = 0;
    repositoryExists = false;
175
    wizard = 0;
176
177
}

con's avatar
con committed
178
// ---- ProjectFileWizardExtension
179
180
ProjectFileWizardExtension::ProjectFileWizardExtension()
  : m_context(0)
con's avatar
con committed
181
182
183
184
185
186
187
188
{
}

ProjectFileWizardExtension::~ProjectFileWizardExtension()
{
    delete m_context;
}

dt's avatar
dt committed
189
190
191
192
193
194
195
196
197
198
static QList<ProjectEntry> findDeployProject(const QList<ProjectEntry> &projects,
                                 QString &commonPath)
{
    QList<ProjectEntry> filtered;
    foreach (const ProjectEntry &project, projects)
        if (project.node->deploysFolder(commonPath))
            filtered << project;
    return filtered;
}

199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
// Find the project the new files should be added to given their common
// path. Either a direct match on the directory or the directory with
// the longest matching path (list containing"/project/subproject1" matching
// common path "/project/subproject1/newuserpath").
// This relies on 'pro' occurring before 'pri' in the list.
static int findMatchingProject(const QList<ProjectEntry> &projects,
                               const QString &commonPath)
{
    if (projects.isEmpty() || commonPath.isEmpty())
        return -1;

    int bestMatch = -1;
    int bestMatchLength = 0;
    const int count = projects.size();
    for (int p = 0; p < count; p++) {
        // Direct match or better match? (note that the wizards' files are native).
        const QString &projectDirectory = projects.at(p).nativeDirectory;
        if (projectDirectory == commonPath)
            return p;
        if (projectDirectory.size() > bestMatchLength
            && commonPath.startsWith(projectDirectory)) {
            bestMatchLength = projectDirectory.size();
            bestMatch = p;
        }
    }
    return bestMatch;
}

227
228
229
void ProjectFileWizardExtension::firstExtensionPageShown(
        const QList<Core::GeneratedFile> &files,
        const QString &generatedProjectFilePath)
con's avatar
con committed
230
{
231
232
    initProjectChoices(generatedProjectFilePath);

con's avatar
con committed
233
234
    if (debugExtension)
        qDebug() << Q_FUNC_INFO << files.size();
235
236
    // Parametrize wizard page: find best project to add to, set up files display and
    // version control depending on path
con's avatar
con committed
237
238
239
    QStringList fileNames;
    foreach (const Core::GeneratedFile &f, files)
        fileNames.push_back(f.path());
240
241
242
    m_context->commonDirectory = Utils::commonPath(fileNames);
    m_context->page->setFilesDisplay(m_context->commonDirectory, fileNames);
    // Find best project (Entry at 0 is 'None').
dt's avatar
dt committed
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264

    int bestProjectIndex = -1;

    QList<ProjectEntry> deployingProjects = findDeployProject(m_context->projects, m_context->commonDirectory);
    if (!deployingProjects.isEmpty()) {
        // Oh we do have someone that deploys it
        // then the best match is NONE
        // We display a label explaining that and rename <None> to
        // <Implictly Add>
        m_context->page->setNoneLabel(tr("<Implictly Add>"));

        QString text = tr("The files are implicitly added to the projects:\n");
        foreach (ProjectEntry project, deployingProjects)
            text += project.fileName + "\n";

        m_context->page->setAdditionalInfo(text);
        bestProjectIndex = -1;
    } else {
        bestProjectIndex = findMatchingProject(m_context->projects, m_context->commonDirectory);
        m_context->page->setNoneLabel(tr("<None>"));
    }

265
266
267
268
269
270
    if (bestProjectIndex == -1) {
        m_context->page->setCurrentProjectIndex(0);
    } else {
        m_context->page->setCurrentProjectIndex(bestProjectIndex + 1);
    }
    initializeVersionControlChoices();
con's avatar
con committed
271
272
}

273
void ProjectFileWizardExtension::initializeVersionControlChoices()
con's avatar
con committed
274
{
275
276
277
278
    // Figure out version control situation:
    // 1) Directory is managed and VCS supports "Add" -> List it
    // 2) Directory is managed and VCS does not support "Add" -> None available
    // 3) Directory is not managed -> Offer all VCS that support "CreateRepository"
279
    m_context->versionControls.clear();
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
    if (!m_context->commonDirectory.isEmpty()) {
        Core::IVersionControl *managingControl = Core::ICore::instance()->vcsManager()->findVersionControlForDirectory(m_context->commonDirectory);
        if (managingControl) {
            // Under VCS
            if (managingControl->supportsOperation(Core::IVersionControl::AddOperation)) {
                m_context->versionControls.push_back(managingControl);
                m_context->repositoryExists = true;
            }
        } else {
            // Create
            foreach (Core::IVersionControl *vc, ExtensionSystem::PluginManager::instance()->getObjects<Core::IVersionControl>())
                if (vc->supportsOperation(Core::IVersionControl::CreateRepositoryOperation))
                    m_context->versionControls.push_back(vc);
            m_context->repositoryExists = false;
        }
    } // has a common root.
    // Compile names
    //: No version control system selected
    QStringList versionControlChoices = QStringList(tr("<None>"));
    foreach(const Core::IVersionControl *c, m_context->versionControls)
        versionControlChoices.push_back(c->displayName());
    m_context->page->setVersionControls(versionControlChoices);
    // Enable adding to version control by default.
    if (m_context->repositoryExists && versionControlChoices.size() >= 2)
        m_context->page->setVersionControlIndex(1);
con's avatar
con committed
305
306
307
308
}

QList<QWizardPage *> ProjectFileWizardExtension::extensionPages(const Core::IWizard *wizard)
{
309
    if (!m_context) {
con's avatar
con committed
310
        m_context = new ProjectWizardContext;
311
312
313
    } else {
        m_context->clear();
    }
con's avatar
con committed
314
315
    // Init context with page and projects
    m_context->page = new ProjectWizardPage;
316
    m_context->wizard = wizard;
317
318
319
    return QList<QWizardPage *>() << m_context->page;
}

320
void ProjectFileWizardExtension::initProjectChoices(const QString &generatedProjectFilePath)
321
{
con's avatar
con committed
322
    // Set up project list which remains the same over duration of wizard execution
323
324
    // As tooltip, set the directory for disambiguation (should someone have
    // duplicate base names in differing directories).
325
326
    //: No project selected
    QStringList projectChoices(tr("<None>"));
hjk's avatar
hjk committed
327
    QStringList projectToolTips((QString()));
dt's avatar
dt committed
328

329
330
331
332
333
334
335
336
337
338
339
340
    typedef QMap<ProjectEntry, bool> ProjectEntryMap;
    // Sort by base name and purge duplicated entries (resulting from dependencies)
    // via Map.
    ProjectEntryMap entryMap;

    ProjectNode::ProjectAction projectAction =
            m_context->wizard->kind() == Core::IWizard::ProjectWizard
            ? ProjectNode::AddSubProject : ProjectNode::AddNewFile;
    foreach(ProjectNode *n, AllProjectNodesVisitor::allProjects(projectAction)) {
        if (projectAction == ProjectNode::AddNewFile
                || (projectAction == ProjectNode::AddSubProject
                && n->canAddSubProject(generatedProjectFilePath)))
341
            entryMap.insert(ProjectEntry(n), true);
con's avatar
con committed
342
    }
343
344
345
346
347
348
349
350
351
352
353

    m_context->projects.clear();

    // Collect names
    const ProjectEntryMap::const_iterator cend = entryMap.constEnd();
    for (ProjectEntryMap::const_iterator it = entryMap.constBegin(); it != cend; ++it) {
        m_context->projects.push_back(it.key());
        projectChoices.push_back(it.key().fileName);
        projectToolTips.push_back(it.key().nativeDirectory);
    }

354
    m_context->page->setProjects(projectChoices);
355
    m_context->page->setProjectToolTips(projectToolTips);
con's avatar
con committed
356
357
}

358
359
360
361
bool ProjectFileWizardExtension::process(
        const QList<Core::GeneratedFile> &files,
        const QString &generatedProjectFilePath,
        bool *removeOpenProjectAttribute, QString *errorMessage)
362
{
363
364
    return processProject(files, generatedProjectFilePath,
                          removeOpenProjectAttribute, errorMessage) &&
365
366
367
368
           processVersionControl(files, errorMessage);
}

// Add files to project && version control
369
370
371
372
bool ProjectFileWizardExtension::processProject(
        const QList<Core::GeneratedFile> &files,
        const QString &generatedProjectFilePath,
        bool *removeOpenProjectAttribute, QString *errorMessage)
con's avatar
con committed
373
374
{
    typedef QMultiMap<FileType, QString> TypeFileMap;
375

376
377
    *removeOpenProjectAttribute = false;

378
379
380
381
382
    // Add files to  project (Entry at 0 is 'None').
    const int projectIndex = m_context->page->currentProjectIndex() - 1;
    if (projectIndex < 0 || projectIndex >= m_context->projects.size())
        return true;
    ProjectNode *project = m_context->projects.at(projectIndex).node;
383
384
385
386
    if (m_context->wizard->kind() == Core::IWizard::ProjectWizard) {
        if (!project->addSubProjects(QStringList(generatedProjectFilePath))) {
            *errorMessage = tr("Failed to add subproject '%1'\nto project '%2'.")
                            .arg(generatedProjectFilePath).arg(project->path());
387
            return false;
con's avatar
con committed
388
        }
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
        *removeOpenProjectAttribute = true;
    } else {
        // Split into lists by file type and bulk-add them.
        TypeFileMap typeFileMap;
        const Core::MimeDatabase *mdb = Core::ICore::instance()->mimeDatabase();
        foreach (const Core::GeneratedFile &generatedFile, files) {
            const QString path = generatedFile.path();
            typeFileMap.insert(typeForFileName(mdb, path), path);
        }
        foreach (FileType type, typeFileMap.uniqueKeys()) {
            const QStringList typeFiles = typeFileMap.values(type);
            if (!project->addFiles(type, typeFiles)) {
                *errorMessage = tr("Failed to add one or more files to project\n'%1' (%2).").
                                arg(project->path(), typeFiles.join(QString(QLatin1Char(','))));
                return false;
            }
        }
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
    }
    return true;
}

bool ProjectFileWizardExtension::processVersionControl(const QList<Core::GeneratedFile> &files, QString *errorMessage)
{
    // Add files to  version control (Entry at 0 is 'None').
    const int vcsIndex = m_context->page->versionControlIndex() - 1;
    if (vcsIndex < 0 || vcsIndex >= m_context->versionControls.size())
        return true;
    QTC_ASSERT(!m_context->commonDirectory.isEmpty(), return false);
    Core::IVersionControl *versionControl = m_context->versionControls.at(vcsIndex);
    // Create repository?
    if (!m_context->repositoryExists) {
        QTC_ASSERT(versionControl->supportsOperation(Core::IVersionControl::CreateRepositoryOperation), return false);
        if (!versionControl->vcsCreateRepository(m_context->commonDirectory)) {
            *errorMessage = tr("A version control system repository could not be created in '%1'.").arg(m_context->commonDirectory);
            return false;
con's avatar
con committed
424
425
        }
    }
426
427
    // Add files if supported.
    if (versionControl->supportsOperation(Core::IVersionControl::AddOperation)) {
con's avatar
con committed
428
        foreach (const Core::GeneratedFile &generatedFile, files) {
429
            if (!versionControl->vcsAdd(generatedFile.path())) {
con's avatar
con committed
430
431
432
433
434
435
436
437
                *errorMessage = tr("Failed to add '%1' to the version control system.").arg(generatedFile.path());
                return false;
            }
        }
    }
    return true;
}

hjk's avatar
hjk committed
438
439
} // namespace Internal
} // namespace ProjectExplorer