aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/debugger/moduleshandler.cpp
blob: 3e793a424b6b2374578dedcb2e21d5057a6940f6 (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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of 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 http://www.qt.io/terms-conditions.  For further information
** use the contact form at http://www.qt.io/contact-us.
**
** 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 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#include "moduleshandler.h"

#include <utils/qtcassert.h>
#include <utils/treemodel.h>

#include <QCoreApplication>
#include <QDebug>
#include <QSortFilterProxyModel>

using namespace Utils;

//////////////////////////////////////////////////////////////////
//
// ModulesModel
//
//////////////////////////////////////////////////////////////////

namespace Debugger {
namespace Internal {

class ModuleItem : public TreeItem
{
public:
    QVariant data(int column, int role) const;

public:
    Module module;
    bool updated;
};

QVariant ModuleItem::data(int column, int role) const
{
    switch (column) {
    case 0:
        if (role == Qt::DisplayRole)
            return module.moduleName;
        // FIXME: add icons
        //if (role == Qt::DecorationRole)
        //    return module.symbolsRead ? icon2 : icon;
        break;
    case 1:
        if (role == Qt::DisplayRole)
            return module.modulePath;
        if (role == Qt::ToolTipRole) {
            QString msg;
            if (!module.elfData.buildId.isEmpty())
                msg += QString::fromLatin1("Build Id: " + module.elfData.buildId);
            if (!module.elfData.debugLink.isEmpty())
                msg += QString::fromLatin1("Debug Link: " + module.elfData.debugLink);
            return msg;
        }
        break;
    case 2:
        if (role == Qt::DisplayRole)
            switch (module.symbolsRead) {
            case Module::UnknownReadState: return ModulesHandler::tr("Unknown");
            case Module::ReadFailed: return ModulesHandler::tr("No");
            case Module::ReadOk: return ModulesHandler::tr("Yes");
            }
        break;
    case 3:
        if (role == Qt::DisplayRole)
            switch (module.elfData.symbolsType) {
            case UnknownSymbols:
                return ModulesHandler::tr("Unknown");
            case NoSymbols:
                return ModulesHandler::tr("None");
            case PlainSymbols:
                return ModulesHandler::tr("Plain");
            case FastSymbols:
                return ModulesHandler::tr("Fast");
            case LinkedSymbols:
                return ModulesHandler::tr("debuglnk");
            case BuildIdSymbols:
                return ModulesHandler::tr("buildid");
            }
        else if (role == Qt::ToolTipRole)
            switch (module.elfData.symbolsType) {
            case UnknownSymbols:
                return ModulesHandler::tr(
                            "It is unknown whether this module contains debug "
                            "information.\nUse \"Examine Symbols\" from the "
                            "context menu to initiate a check.");
            case NoSymbols:
                return ModulesHandler::tr(
                            "This module neither contains nor references debug "
                            "information.\nStepping into the module or setting "
                            "breakpoints by file and line will not work.");
            case PlainSymbols:
                return ModulesHandler::tr(
                            "This module contains debug information.\nStepping "
                            "into the module or setting breakpoints by file and "
                            "line is expected to work.");
            case FastSymbols:
                return ModulesHandler::tr(
                            "This module contains debug information.\nStepping "
                            "into the module or setting breakpoints by file and "
                            "line is expected to work.");
            case LinkedSymbols:
            case BuildIdSymbols:
                return ModulesHandler::tr(
                            "This module does not contain debug information "
                            "itself, but contains a reference to external "
                            "debug information.");
            }
        break;
    case 4:
        if (role == Qt::DisplayRole)
            if (module.startAddress)
                return QString(QLatin1String("0x")
                               + QString::number(module.startAddress, 16));
        break;
    case 5:
        if (role == Qt::DisplayRole) {
            if (module.endAddress)
                return QString(QLatin1String("0x")
                               + QString::number(module.endAddress, 16));
            //: End address of loaded module
            return ModulesHandler::tr("<unknown>", "address");
        }
        break;
    }
    return QVariant();
}

//////////////////////////////////////////////////////////////////
//
// ModulesHandler
//
//////////////////////////////////////////////////////////////////

static ModuleItem *moduleFromPath(TreeItem *root, const QString &modulePath)
{
    // Recent modules are more likely to be unloaded first.
    for (int i = root->rowCount(); --i >= 0; ) {
        auto item = static_cast<ModuleItem *>(root->child(i));
        if (item->module.modulePath == modulePath)
            return item;
    }
    return 0;
}

ModulesHandler::ModulesHandler(DebuggerEngine *engine)
{
    m_engine = engine;

    QString pad = QLatin1String("        ");
    m_model = new TreeModel(this);
    m_model->setObjectName(QLatin1String("ModulesModel"));
    m_model->setHeader(QStringList()
        << ModulesHandler::tr("Module Name") + pad
        << ModulesHandler::tr("Module Path") + pad
        << ModulesHandler::tr("Symbols Read") + pad
        << ModulesHandler::tr("Symbols Type") + pad
        << ModulesHandler::tr("Start Address") + pad
        << ModulesHandler::tr("End Address") + pad);

    m_proxyModel = new QSortFilterProxyModel(this);
    m_proxyModel->setObjectName(QLatin1String("ModulesProxyModel"));
    m_proxyModel->setSourceModel(m_model);
}

QAbstractItemModel *ModulesHandler::model() const
{
    return m_proxyModel;
}

void ModulesHandler::removeAll()
{
    m_model->removeItems();
}

Modules ModulesHandler::modules() const
{
    Modules mods;
    TreeItem *root = m_model->rootItem();
    for (int i = root->rowCount(); --i >= 0; )
        mods.append(static_cast<ModuleItem *>(root->child(i))->module);
    return mods;
}

void ModulesHandler::removeModule(const QString &modulePath)
{
    if (ModuleItem *item = moduleFromPath(m_model->rootItem(), modulePath))
        m_model->removeItem(item);
}

void ModulesHandler::updateModule(const Module &module)
{
    const QString path = module.modulePath;
    if (path.isEmpty())
        return;

    ModuleItem *item = moduleFromPath(m_model->rootItem(), path);
    if (item) {
        item->module = module;
    } else {
        item = new ModuleItem;
        item->module = module;
        m_model->rootItem()->appendChild(item);
    }

    try { // MinGW occasionallly throws std::bad_alloc.
        ElfReader reader(path);
        item->module.elfData = reader.readHeaders();
        item->update();
    } catch(...) {
        qWarning("%s: An exception occurred while reading module '%s'",
                 Q_FUNC_INFO, qPrintable(module.modulePath));
    }
    item->updated = true;
}

void ModulesHandler::beginUpdateAll()
{
    TreeItem *root = m_model->rootItem();
    for (int i = root->rowCount(); --i >= 0; )
        static_cast<ModuleItem *>(root->child(i))->updated = false;
}

void ModulesHandler::endUpdateAll()
{
    TreeItem *root = m_model->rootItem();
    for (int i = root->rowCount(); --i >= 0; ) {
        auto item = static_cast<ModuleItem *>(root->child(i));
        if (!item->updated)
            m_model->removeItem(item);
    }
}

} // namespace Internal
} // namespace Debugger