toolsettings.cpp 8.2 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
hjk's avatar
hjk committed
3
4
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
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.
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
****************************************************************************/
29
30

#include "toolsettings.h"
31
#include "dialogs/externaltoolconfig.h"
32
#include "externaltool.h"
33
#include "externaltoolmanager.h"
34
#include "coreconstants.h"
35
#include "icore.h"
36

37
38
#include <utils/qtcassert.h>

39
40
41
42
43
#include <QCoreApplication>
#include <QFileInfo>
#include <QDir>
#include <QTime>
#include <QIcon>
con's avatar
con committed
44

hjk's avatar
hjk committed
45
#include <QDebug>
46
47
48
49
50
51
52

using namespace Core;
using namespace Core::Internal;

ToolSettings::ToolSettings(QObject *parent) :
    IOptionsPage(parent)
{
hjk's avatar
hjk committed
53
    setId(Core::Constants::SETTINGS_ID_TOOLS);
54
    setDisplayName(tr("External Tools"));
hjk's avatar
hjk committed
55
    setCategory(Core::Constants::SETTINGS_CATEGORY_CORE);
56
57
    setDisplayCategory(QCoreApplication::translate("Core", Constants::SETTINGS_TR_CATEGORY_CORE));
    setCategoryIcon(QLatin1String(Core::Constants::SETTINGS_CATEGORY_CORE_ICON));
58
59
60
61
62
63
64
65
66
67
68
}


bool ToolSettings::matches(const QString & searchKeyWord) const
{
    return m_searchKeywords.contains(searchKeyWord, Qt::CaseInsensitive);
}

QWidget *ToolSettings::createPage(QWidget *parent)
{
    m_widget = new ExternalToolConfig(parent);
69
    m_widget->setTools(ExternalToolManager::instance()->toolsByCategory());
70
    if (m_searchKeywords.isEmpty())
71
72
73
74
75
        m_searchKeywords = m_widget->searchKeywords();
    return m_widget;
}


con's avatar
con committed
76
77
78
static QString getUserFilePath(const QString &proposalFileName)
{
    static bool seeded = false;
hjk's avatar
hjk committed
79
    QDir resourceDir(ICore::userResourcePath());
con's avatar
con committed
80
81
82
83
    if (!resourceDir.exists(QLatin1String("externaltools")))
        resourceDir.mkpath(QLatin1String("externaltools"));
    QFileInfo fi(proposalFileName);
    const QString &suffix = QLatin1String(".") + fi.completeSuffix();
hjk's avatar
hjk committed
84
    const QString &newFilePath = ICore::userResourcePath()
con's avatar
con committed
85
86
87
88
89
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
118
119
120
121
122
123
124
125
126
            + QLatin1String("/externaltools/") + fi.baseName();
    int count = 0;
    QString tryPath = newFilePath + suffix;
    while (QFile::exists(tryPath)) {
        if (count > 15)
            return QString();
        // add random number
        if (!seeded) {
            seeded = true;
            qsrand(QTime::currentTime().msec());
        }
        int number = qrand() % 1000;
        tryPath = newFilePath + QString::number(number) + suffix;
    }
    return tryPath;
}

static QString idFromDisplayName(const QString &displayName)
{
    QString id = displayName;
    QChar *c = id.data();
    while (!c->isNull()) {
        if (!c->isLetterOrNumber())
            *c = QLatin1Char('_');
        ++c;
    }
    return id;
}

static QString findUnusedId(const QString &proposal, const QMap<QString, QList<ExternalTool *> > &tools)
{
    int number = 0;
    QString result;
    bool found = false;
    do {
        result = proposal + (number > 0 ? QString::number(number) : QString::fromLatin1(""));
        ++number;
        found = false;
        QMapIterator<QString, QList<ExternalTool *> > it(tools);
        while (!found && it.hasNext()) {
            it.next();
            foreach (ExternalTool *tool, it.value()) {
con's avatar
con committed
127
                if (tool->id() == result) {
con's avatar
con committed
128
129
130
131
132
133
134
135
136
                    found = true;
                    break;
                }
            }
        }
    } while (found);
    return result;
}

137
138
void ToolSettings::apply()
{
139
140
    if (!m_widget)
        return;
141
    m_widget->apply();
142
143
144
145
146
147
148
149
150
151
    QMap<QString, ExternalTool *> originalTools = ExternalToolManager::instance()->toolsById();
    QMap<QString, QList<ExternalTool *> > newToolsMap = m_widget->tools();
    QMap<QString, QList<ExternalTool *> > resultMap;
    QMapIterator<QString, QList<ExternalTool *> > it(newToolsMap);
    while (it.hasNext()) {
        it.next();
        QList<ExternalTool *> items;
        foreach (ExternalTool *tool, it.value()) {
            ExternalTool *toolToAdd = 0;
            if (ExternalTool *originalTool = originalTools.take(tool->id())) {
152
                // check if it has different category and is custom tool
153
                if (tool->displayCategory() != it.key() && !tool->preset())
154
                    tool->setDisplayCategory(it.key());
155
156
157
158
                // check if the tool has changed
                if ((*originalTool) == (*tool)) {
                    toolToAdd = originalTool;
                } else {
159
160
161
162
163
                    // case 1: tool is changed preset
                    if (tool->preset() && (*tool) != (*(tool->preset()))) {
                        // check if we need to choose a new file name
                        if (tool->preset()->fileName() == tool->fileName()) {
                            const QString &fileName = QFileInfo(tool->preset()->fileName()).fileName();
con's avatar
con committed
164
165
                            const QString &newFilePath = getUserFilePath(fileName);
                            // TODO error handling if newFilePath.isEmpty() (i.e. failed to find a unused name)
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
                            tool->setFileName(newFilePath);
                        }
                        // TODO error handling
                        tool->save();
                    // case 2: tool is previously changed preset but now same as preset
                    } else if (tool->preset() && (*tool) == (*(tool->preset()))) {
                        // check if we need to delete the changed description
                        if (originalTool->fileName() != tool->preset()->fileName()
                                && QFile::exists(originalTool->fileName())) {
                            // TODO error handling
                            QFile::remove(originalTool->fileName());
                        }
                        tool->setFileName(tool->preset()->fileName());
                        // no need to save, it's the same as the preset
                    // case 3: tool is custom tool
                    } else {
                        // TODO error handling
                        tool->save();
184
                    }
185
186

                     // 'tool' is deleted by config page, 'originalTool' is deleted by setToolsByCategory
187
188
                    toolToAdd = new ExternalTool(tool);
                }
con's avatar
con committed
189
190
191
192
193
194
195
196
197
198
            } else {
                // new tool. 'tool' is deleted by config page
                QString id = idFromDisplayName(tool->displayName());
                id = findUnusedId(id, newToolsMap);
                tool->setId(id);
                // TODO error handling if newFilePath.isEmpty() (i.e. failed to find a unused name)
                tool->setFileName(getUserFilePath(id + QLatin1String(".xml")));
                // TODO error handling
                tool->save();
                toolToAdd = new ExternalTool(tool);
199
200
201
            }
            items.append(toolToAdd);
        }
con's avatar
con committed
202
203
        if (!items.isEmpty())
            resultMap.insert(it.key(), items);
204
    }
205
206
207
208
209
210
211
    // Remove tools that have been deleted from the settings (and are no preset)
    foreach (ExternalTool *tool, originalTools) {
        QTC_ASSERT(!tool->preset(), continue);
        // TODO error handling
        QFile::remove(tool->fileName());
    }

212
    ExternalToolManager::instance()->setToolsByCategory(resultMap);
213
214
215
216
217
218
}


void ToolSettings::finish()
{
}