cpphoverhandler.cpp 12.5 KB
Newer Older
con's avatar
con committed
1
2
3
4
/***************************************************************************
**
** This file is part of Qt Creator
**
5
** Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
7
8
**
** Contact:  Qt Software Information (qt-info@nokia.com)
**
9
10
11
**
** Non-Open Source Usage
**
con's avatar
con committed
12
13
14
** Licensees may use this file in accordance with the Qt Beta Version
** License Agreement, Agreement version 2.2 provided with the Software or,
** alternatively, in accordance with the terms contained in a written
15
16
17
18
** agreement between you and Nokia.
**
** GNU General Public License Usage
**
con's avatar
con committed
19
20
21
22
23
24
25
26
27
28
** Alternatively, this file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the packaging
** of this file.  Please review the following information to ensure GNU
** General Public Licensing requirements will be met:
**
** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
** http://www.gnu.org/copyleft/gpl.html.
**
** In addition, as a special exception, Nokia gives you certain additional
29
** rights. These rights are described in the Nokia Qt GPL Exception
30
** version 1.3, included in the file GPL_EXCEPTION.txt in this package.
31
32
**
***************************************************************************/
hjk's avatar
hjk committed
33

con's avatar
con committed
34
#include "cpphoverhandler.h"
35
36
#include "cppeditor.h"
#include "cppplugin.h"
con's avatar
con committed
37
38
39

#include <coreplugin/icore.h>
#include <coreplugin/uniqueidmanager.h>
40
41
#include <coreplugin/editormanager/editormanager.h>
#include <cpptools/cppmodelmanagerinterface.h>
42
#include <extensionsystem/pluginmanager.h>
con's avatar
con committed
43
#include <texteditor/itexteditor.h>
Roberto Raggi's avatar
Roberto Raggi committed
44
#include <texteditor/basetexteditor.h>
con's avatar
con committed
45
46
47
48
49
#include <debugger/debuggerconstants.h>

#include <CoreTypes.h>
#include <FullySpecifiedType.h>
#include <Literals.h>
50
#include <Control.h>
con's avatar
con committed
51
52
53
54
55
56
57
#include <Names.h>
#include <Scope.h>
#include <Symbol.h>
#include <Symbols.h>
#include <cplusplus/ExpressionUnderCursor.h>
#include <cplusplus/Overview.h>
#include <cplusplus/TypeOfExpression.h>
58
#include <cplusplus/SimpleLexer.h>
con's avatar
con committed
59

60
61
62
63
#include <QtCore/QDebug>
#include <QtCore/QDir>
#include <QtCore/QFileInfo>
#include <QtCore/QSettings>
con's avatar
con committed
64
65
66
67
68
#include <QtGui/QToolTip>
#include <QtGui/QTextCursor>
#include <QtGui/QTextBlock>
#include <QtHelp/QHelpEngineCore>

69
using namespace CppEditor::Internal;
Roberto Raggi's avatar
Roberto Raggi committed
70
using namespace CPlusPlus;
71
using namespace Core;
con's avatar
con committed
72

73
74
75
CppHoverHandler::CppHoverHandler(QObject *parent)
    : QObject(parent)
    , m_helpEngineNeedsSetup(false)
con's avatar
con committed
76
{
77
    m_modelManager = ExtensionSystem::PluginManager::instance()->getObject<CppTools::CppModelManagerInterface>();
78

79
80
    ICore *core = ICore::instance();
    QFileInfo fi(core->settings()->fileName());
81
82
83
84
85
86
    // FIXME shouldn't the help engine create the directory if it doesn't exist?
    QDir directory(fi.absolutePath()+"/qtcreator");
    if (!directory.exists())
        directory.mkpath(directory.absolutePath());

    m_helpEngine = new QHelpEngineCore(directory.absolutePath()
con's avatar
con committed
87
88
                                       + QLatin1String("/helpcollection.qhc"), this);
    //m_helpEngine->setAutoSaveFilter(false);
89
90
    if (!m_helpEngine->setupData())
        qWarning() << "Could not initialize help engine:" << m_helpEngine->error();
con's avatar
con committed
91
    m_helpEngine->setCurrentFilter(tr("Unfiltered"));
92
    m_helpEngineNeedsSetup = m_helpEngine->registeredDocumentations().count() == 0;
93
94

    // Listen for editor opened events in order to connect to tooltip/helpid requests
95
    connect(core->editorManager(), SIGNAL(editorOpened(Core::IEditor *)),
96
            this, SLOT(editorOpened(Core::IEditor *)));
con's avatar
con committed
97
98
99
100
101
102
103
}

void CppHoverHandler::updateContextHelpId(TextEditor::ITextEditor *editor, int pos)
{
    updateHelpIdAndTooltip(editor, pos);
}

104
void CppHoverHandler::editorOpened(IEditor *editor)
con's avatar
con committed
105
{
106
107
108
109
110
111
112
113
114
115
    CPPEditorEditable *cppEditor = qobject_cast<CPPEditorEditable *>(editor);
    if (!cppEditor)
        return;

    connect(cppEditor, SIGNAL(tooltipRequested(TextEditor::ITextEditor*, QPoint, int)),
            this, SLOT(showToolTip(TextEditor::ITextEditor*, QPoint, int)));

    connect(cppEditor, SIGNAL(contextHelpIdRequested(TextEditor::ITextEditor*, int)),
            this, SLOT(updateContextHelpId(TextEditor::ITextEditor*, int)));
}
con's avatar
con committed
116

117
118
119
void CppHoverHandler::showToolTip(TextEditor::ITextEditor *editor, const QPoint &point, int pos)
{
    if (!editor)
con's avatar
con committed
120
121
        return;

122
123
    ICore *core = ICore::instance();
    const int dbgcontext = core->uniqueIDManager()->uniqueIdentifier(Debugger::Constants::C_GDBDEBUGGER);
124

125
    if (core->hasContext(dbgcontext))
con's avatar
con committed
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
        return;

    updateHelpIdAndTooltip(editor, pos);

    if (m_toolTip.isEmpty())
        QToolTip::hideText();
    else {
        const QPoint pnt = point - QPoint(0,
#ifdef Q_WS_WIN
        24
#else
        16
#endif
        );

        QToolTip::showText(pnt, m_toolTip);
    }
}

145
static QString buildHelpId(Symbol *symbol, Name *name)
con's avatar
con committed
146
147
148
{
    Scope *scope = 0;

149
150
151
    if (symbol) {
        scope = symbol->scope();
        name = symbol->name();
con's avatar
con committed
152
153
    }

Roberto Raggi's avatar
Roberto Raggi committed
154
155
156
    if (! name)
        return QString();

con's avatar
con committed
157
158
159
160
161
162
163
164
    Overview overview;
    overview.setShowArgumentNames(false);
    overview.setShowReturnTypes(false);

    QStringList qualifiedNames;
    qualifiedNames.prepend(overview.prettyName(name));

    for (; scope; scope = scope->enclosingScope()) {
165
166
167
168
        Symbol *owner = scope->owner();

        if (owner && owner->name() && ! scope->isEnumScope()) {
            Name *name = owner->name();
con's avatar
con committed
169
            Identifier *id = 0;
170

171
            if (NameId *nameId = name->asNameId())
con's avatar
con committed
172
                id = nameId->identifier();
173
174

            else if (TemplateNameId *nameId = name->asTemplateNameId())
con's avatar
con committed
175
                id = nameId->identifier();
176

con's avatar
con committed
177
178
179
180
181
182
183
184
            if (id)
                qualifiedNames.prepend(QString::fromLatin1(id->chars(), id->size()));
        }
    }

    return qualifiedNames.join(QLatin1String("::"));
}

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
// ### move me
static FullySpecifiedType resolve(const FullySpecifiedType &ty,
                                  const LookupContext &context,
                                  Symbol **resolvedSymbol,
                                  Name **resolvedName)
{
    Control *control = context.control();

    if (const PointerType *ptrTy = ty->asPointerType()) {
        return control->pointerType(resolve(ptrTy->elementType(), context,
                                            resolvedSymbol, resolvedName));

    } else if (const ReferenceType *refTy = ty->asReferenceType()) {
        return control->referenceType(resolve(refTy->elementType(), context,
                                              resolvedSymbol, resolvedName));

    } else if (const PointerToMemberType *ptrToMemTy = ty->asPointerToMemberType()) {
        return control->pointerToMemberType(ptrToMemTy->memberName(),
                                            resolve(ptrToMemTy->elementType(), context,
                                                    resolvedSymbol, resolvedName));

    } else if (const NamedType *namedTy = ty->asNamedType()) {
        if (resolvedName)
            *resolvedName = namedTy->name();

        const QList<Symbol *> candidates = context.resolve(namedTy->name());

        foreach (Symbol *c, candidates) {
            if (c->isClass() || c->isEnum()) {
                if (resolvedSymbol)
                    *resolvedSymbol = c;

                return c->type();
            }
        }

    } else if (const Namespace *nsTy = ty->asNamespaceType()) {
        if (resolvedName)
            *resolvedName = nsTy->name();

    } else if (const Class *classTy = ty->asClassType()) {
        if (resolvedName)
            *resolvedName = classTy->name();

        if (resolvedSymbol)
            *resolvedSymbol = const_cast<Class *>(classTy);

    } else if (const ForwardClassDeclaration *fwdClassTy = ty->asForwardClassDeclarationType()) {
        if (resolvedName)
            *resolvedName = fwdClassTy->name();

    } else if (const Enum *enumTy = ty->asEnumType()) {
        if (resolvedName)
            *resolvedName = enumTy->name();

    } else if (const Function *funTy = ty->asFunctionType()) {
        if (resolvedName)
            *resolvedName = funTy->name();

    }

    return ty;
}

con's avatar
con committed
249
250
251
252
253
void CppHoverHandler::updateHelpIdAndTooltip(TextEditor::ITextEditor *editor, int pos)
{
    m_helpId.clear();
    m_toolTip.clear();

254
255
256
    if (!m_modelManager)
        return;

Roberto Raggi's avatar
Roberto Raggi committed
257
    TextEditor::BaseTextEditor *edit = qobject_cast<TextEditor::BaseTextEditor *>(editor->widget());
con's avatar
con committed
258
259
260
    if (!edit)
        return;

261
262
263
264
265
266
    const Snapshot documents = m_modelManager->snapshot();
    const QString fileName = editor->file()->fileName();
    Document::Ptr doc = documents.value(fileName);
    if (! doc)
        return; // nothing to do

con's avatar
con committed
267
268
    QTextCursor tc(edit->document());
    tc.setPosition(pos);
269
    const unsigned lineNumber = tc.block().blockNumber() + 1;
con's avatar
con committed
270

271
272
273
274
    // Find the last symbol up to the cursor position
    int line = 0, column = 0;
    editor->convertPosition(tc.position(), &line, &column);
    Symbol *lastSymbol = doc->findSymbolAt(line, column);
275

276
277
278
279
280
281
282
    TypeOfExpression typeOfExpression;
    typeOfExpression.setSnapshot(documents);

    foreach (Document::DiagnosticMessage m, doc->diagnosticMessages()) {
        if (m.line() == lineNumber) {
            m_toolTip = m.text();
            break;
con's avatar
con committed
283
        }
284
    }
con's avatar
con committed
285

286
287
288
289
290
    if (m_toolTip.isEmpty()) {
        foreach (const Document::Include &incl, doc->includes()) {
            if (incl.line() == lineNumber) {
                m_toolTip = incl.fileName();
                break;
291
292
293
294
            }
        }
    }

con's avatar
con committed
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
    if (m_toolTip.isEmpty()) {
        // Move to the end of a qualified name
        bool stop = false;
        while (!stop) {
            const QChar ch = editor->characterAt(tc.position());
            if (ch.isLetterOrNumber() || ch == QLatin1Char('_'))
                tc.setPosition(tc.position() + 1);
            else if (ch == QLatin1Char(':') && editor->characterAt(tc.position() + 1) == QLatin1Char(':')) {
                tc.setPosition(tc.position() + 2);
            } else {
                stop = true;
            }
        }

        // Fetch the expression's code.
        ExpressionUnderCursor expressionUnderCursor;
        const QString expression = expressionUnderCursor(tc);

313
314
315
        const QList<TypeOfExpression::Result> types =
                typeOfExpression(expression, doc, lastSymbol);

316
        if (!types.isEmpty()) {
317
            const TypeOfExpression::Result result = types.first();
318

319
320
            FullySpecifiedType firstType = result.first; // result of `type of expression'.
            Symbol *lookupSymbol = result.second;        // lookup symbol
321

322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
            Symbol *resolvedSymbol = 0;
            Name *resolvedName = 0;
            firstType = resolve(firstType, typeOfExpression.lookupContext(),
                                &resolvedSymbol, &resolvedName);

            m_helpId = buildHelpId(resolvedSymbol, resolvedName);

            Symbol *symbol = result.second;
            if (resolvedSymbol)
                symbol = resolvedSymbol;

            Overview overview;
            overview.setShowArgumentNames(true);
            overview.setShowReturnTypes(true);
            overview.setShowFullyQualifiedNamed(true);

            if (lookupSymbol && lookupSymbol->isDeclaration()) {
                Declaration *decl = lookupSymbol->asDeclaration();
                m_toolTip = overview.prettyType(firstType, decl->name());

            } else if (firstType->isClassType() || firstType->isEnumType() ||
                       firstType->isForwardClassDeclarationType()) {
344
                m_toolTip = m_helpId;
345
346
347
348

            } else {
                m_toolTip = overview.prettyType(firstType, m_helpId);

con's avatar
con committed
349
350
351
352
            }
        }
    }

353
    if (m_toolTip.isEmpty()) {
354
355
        foreach (const Document::MacroUse &use, doc->macroUses()) {
            if (use.contains(pos)) {
356
357
358
                const Macro m = use.macro();
                m_toolTip = m.toString();
                m_helpId = m.name();
359
360
361
362
363
                break;
            }
        }
    }

364
365
366
367
368
369
    if (m_helpEngineNeedsSetup
        && m_helpEngine->registeredDocumentations().count() > 0) {
        m_helpEngine->setupData();
        m_helpEngineNeedsSetup = false;
    }

370
    if (!m_toolTip.isEmpty())
371
372
        m_toolTip = Qt::escape(m_toolTip);

con's avatar
con committed
373
374
    if (!m_helpId.isEmpty() && !m_helpEngine->linksForIdentifier(m_helpId).isEmpty()) {
        m_toolTip = QString(QLatin1String("<table><tr><td valign=middle><nobr>%1</td>"
375
                                          "<td><img src=\":/cppeditor/images/f1.svg\"></td></tr></table>"))
376
                    .arg(m_toolTip);
con's avatar
con committed
377
378
        editor->setContextHelpId(m_helpId);
    } else if (!m_toolTip.isEmpty()) {
379
        m_toolTip = QString(QLatin1String("<nobr>%1")).arg(m_toolTip);
con's avatar
con committed
380
381
    }
}