aboutsummaryrefslogtreecommitdiffstats
path: root/src/datasources/kitsource.cpp
blob: 6cf724e7ba9bd68219f3370d740ac5e192f470fd (plain)
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
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
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
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
227
228
229
230
231
232
233
234
235
236
237
238
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company
** Contact: https://www.qt.io/licensing/
**
** This file is part of UsageStatistic plugin for Qt Creator.
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#include "kitsource.h"

#include <QtCore/QSettings>

#include <projectexplorer/buildmanager.h>
#include <projectexplorer/gcctoolchain.h>
#include <projectexplorer/kitinformation.h>
#include <projectexplorer/kitmanager.h>
#include <projectexplorer/project.h>
#include <projectexplorer/projectexplorerconstants.h>
#include <projectexplorer/session.h>
#include <projectexplorer/target.h>

#include <qtsupport/qtkitinformation.h>

#include <debugger/debuggerkitinformation.h>
#include <debugger/debuggeritem.h>

#include "common/scopedsettingsgroupsetter.h"

namespace UsageStatistic {
namespace Internal {

using namespace KUserFeedback;
using namespace ProjectExplorer;

KitSource::KitSource()
    : AbstractDataSource(QStringLiteral("kits"), Provider::DetailedUsageStatistics)
{
    QObject::connect(ProjectExplorer::BuildManager::instance(),
                     &ProjectExplorer::BuildManager::buildQueueFinished,
                     [&](bool success) {
        const Project *project = SessionManager::startupProject();
        const Target *target = project ? project->activeTarget() : nullptr;
        const Kit *kit = target ? target->kit() : nullptr;
        const ToolChain *toolChain = ToolChainKitAspect::toolChain(kit, Constants::CXX_LANGUAGE_ID);
        const Abi abi = toolChain ? toolChain->targetAbi() : Abi();
        const QString abiName = abi.toString();
        QVariantMap &bucket = success ? m_buildSuccessesForToolChain : m_buildFailsForToolChain;
        bucket[abiName] = bucket.value(abiName, 0).toInt() + 1;
    });
}

KitSource::~KitSource() = default;

QString KitSource::name() const
{
    return tr("Kits");
}

QString KitSource::description() const
{
    return tr("Kits usage statistics: compilers, debuggers, target architecture, and so on.");
}

static QString kitsInfoKey() { return QStringLiteral("kitsInfo"); }
static QString buildSuccessesKey() { return  QStringLiteral("buildSuccesses"); }
static QString buildFailsKey() { return QStringLiteral("buildFails"); }

static QString extractToolChainVersion(const ToolChain &toolChain)
{
    try {
        return dynamic_cast<const GccToolChain &>(toolChain).version();
    } catch (...) {
        return {};
    }
}

void KitSource::loadImpl(QSettings *settings)
{
    auto setter = ScopedSettingsGroupSetter::forDataSource(*this, *settings);
    m_buildSuccessesForToolChain = settings->value(buildSuccessesKey(), QVariantMap{}).toMap();
    m_buildFailsForToolChain = settings->value(buildFailsKey(), QVariantMap{}).toMap();
}

void KitSource::storeImpl(QSettings *settings)
{
    auto setter = ScopedSettingsGroupSetter::forDataSource(*this, *settings);
    settings->setValue(buildSuccessesKey(), m_buildSuccessesForToolChain);
    settings->setValue(buildFailsKey(), m_buildFailsForToolChain);
}

void KitSource::resetImpl(QSettings *settings)
{
    m_buildSuccessesForToolChain.clear();
    m_buildFailsForToolChain.clear();

    storeImpl(settings);
}

class KitInfo
{
public:
    KitInfo(Kit &kit, const KitSource &source) : m_kit(kit), m_source(source)
    {
        addKitInfo();
    }

    KitInfo &withQtVersionInfo()
    {
        static const QString qtKey = QStringLiteral("qt");
        static const QString qtQmlDebuggingSupportKey = QStringLiteral("qmlDebugging");
        static const QString qtQmlCompilerSupportKey = QStringLiteral("qmlCompiler");
        static const QString qtAbisKey = QStringLiteral("abis");

        if (auto qtVersion = QtSupport::QtKitAspect::qtVersion(&m_kit)) {
            QVariantMap qtData;
            qtData.insert(versionKey(), qtVersion->qtVersionString());
            qtData.insert(qtQmlDebuggingSupportKey, qtVersion->isQmlDebuggingSupported());
            qtData.insert(qtQmlCompilerSupportKey, qtVersion->isQtQuickCompilerSupported());
            qtData.insert(qtAbisKey, abisToVarinatList(qtVersion->qtAbis()));

            m_map.insert(qtKey, qtData);
        }

        return *this;
    }

    KitInfo &withCompilerInfo()
    {
        static const QString compilerKey = QStringLiteral("compiler");

        if (auto toolChain = ToolChainKitAspect::toolChain(&m_kit, Constants::CXX_LANGUAGE_ID)) {
            const QString abiName = toolChain->targetAbi().toString();
            m_map.insert(compilerKey, QVariantMap{
                {nameKey(), toolChain->typeDisplayName()},
                {abiKey(), abiName},
                {versionKey(), extractToolChainVersion(*toolChain)},
                {buildSuccessesKey(), m_source.m_buildSuccessesForToolChain.value(abiName).toInt()},
                {buildFailsKey(), m_source.m_buildFailsForToolChain.value(abiName).toInt()}
            });
        }

        return *this;
    }

    KitInfo &withDebuggerInfo()
    {
        static const QString debuggerKey = QStringLiteral("debugger");

        if (auto debuggerInfo = Debugger::DebuggerKitAspect::debugger(&m_kit)) {
            m_map.insert(debuggerKey,
                         QVariantMap{{nameKey(), debuggerInfo->engineTypeName()},
                                     {versionKey(), debuggerInfo->version()}});
        }

        return *this;
    }

    QVariantMap extract() const { return m_map; }

private: // Methods

    void addKitInfo()
    {
        static QString defaultKitKey = QStringLiteral("default");

        m_map.insert(defaultKitKey, &m_kit == KitManager::defaultKit());
    }

    static QVariantMap abiToVariantMap(const Abi &abi)
    {
        static const QString archKey = QStringLiteral("arch");
        static const QString osKey = QStringLiteral("os");
        static const QString osFlavorKey = QStringLiteral("osFlavor");
        static const QString binaryFormatKey = QStringLiteral("binaryFormat");
        static const QString wordWidthKey = QStringLiteral("wordWidth");

        return QVariantMap{{archKey        , Abi::toString(abi.architecture())},
                           {osKey          , Abi::toString(abi.os())          },
                           {osFlavorKey    , Abi::toString(abi.osFlavor())    },
                           {binaryFormatKey, Abi::toString(abi.binaryFormat())},
                           {wordWidthKey   , Abi::toString(abi.wordWidth())   }};
    }

    template <class Container>
    QVariantList abisToVarinatList(const Container &abis)
    {
        QVariantList result;
        for (auto &&abi : abis) {
            result << abiToVariantMap(abi);
        }

        return result;
    }

    static QString versionKey() { return QStringLiteral("version"); }
    static QString nameKey() { return QStringLiteral("name"); }
    static QString abiKey() { return QStringLiteral("abi"); }

private: // Data
    Kit &m_kit;
    const KitSource &m_source;
    QVariantMap m_map;
};

QVariant KitSource::data()
{
    QVariantList kitsInfoList;
    for (auto &&kit : KitManager::instance()->kits()) {
        if (kit && kit->isValid()) {
            kitsInfoList << KitInfo(*kit, *this)
                            .withCompilerInfo()
                            .withDebuggerInfo()
                            .withQtVersionInfo()
                            .extract();
        }
    }

    return QVariantMap{{kitsInfoKey(), kitsInfoList}};
}

} // namespace Internal
} // namespace UsageStatistic