cpphoverhandler.cpp 10.1 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>
con's avatar
con committed
42
#include <texteditor/itexteditor.h>
Roberto Raggi's avatar
Roberto Raggi committed
43
#include <texteditor/basetexteditor.h>
con's avatar
con committed
44
45
46
47
48
49
50
51
52
53
54
55
#include <debugger/debuggerconstants.h>

#include <CoreTypes.h>
#include <FullySpecifiedType.h>
#include <Literals.h>
#include <Names.h>
#include <Scope.h>
#include <Symbol.h>
#include <Symbols.h>
#include <cplusplus/ExpressionUnderCursor.h>
#include <cplusplus/Overview.h>
#include <cplusplus/TypeOfExpression.h>
56
#include <cplusplus/SimpleLexer.h>
con's avatar
con committed
57
58
59
60
61
62
63

#include <QtGui/QToolTip>
#include <QtGui/QTextCursor>
#include <QtGui/QTextBlock>
#include <QtHelp/QHelpEngineCore>
#include <QtCore/QtCore>

64
using namespace CppEditor::Internal;
Roberto Raggi's avatar
Roberto Raggi committed
65
using namespace CPlusPlus;
con's avatar
con committed
66

67
68
69
70
CppHoverHandler::CppHoverHandler(QObject *parent)
    : QObject(parent)
    , m_core(CppPlugin::core())
    , m_helpEngineNeedsSetup(false)
con's avatar
con committed
71
{
72
73
    m_modelManager = m_core->pluginManager()->getObject<CppTools::CppModelManagerInterface>();

con's avatar
con committed
74
    QFileInfo fi(ExtensionSystem::PluginManager::instance()->getObject<Core::ICore>()->settings()->fileName());
75
76
77
78
79
80
    // 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
81
82
                                       + QLatin1String("/helpcollection.qhc"), this);
    //m_helpEngine->setAutoSaveFilter(false);
83
84
    if (!m_helpEngine->setupData())
        qWarning() << "Could not initialize help engine:" << m_helpEngine->error();
con's avatar
con committed
85
    m_helpEngine->setCurrentFilter(tr("Unfiltered"));
86
    m_helpEngineNeedsSetup = m_helpEngine->registeredDocumentations().count() == 0;
87
88
89
90

    // Listen for editor opened events in order to connect to tooltip/helpid requests
    connect(m_core->editorManager(), SIGNAL(editorOpened(Core::IEditor *)),
            this, SLOT(editorOpened(Core::IEditor *)));
con's avatar
con committed
91
92
93
94
95
96
97
}

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

98
void CppHoverHandler::editorOpened(Core::IEditor *editor)
con's avatar
con committed
99
{
100
101
102
103
104
105
106
107
108
109
    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
110

111
112
113
void CppHoverHandler::showToolTip(TextEditor::ITextEditor *editor, const QPoint &point, int pos)
{
    if (!editor)
con's avatar
con committed
114
115
        return;

116
117
118
    const int dbgcontext = m_core->uniqueIDManager()->uniqueIdentifier(Debugger::Constants::C_GDBDEBUGGER);

    if (m_core->hasContext(dbgcontext))
con's avatar
con committed
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
        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);
    }
}

Roberto Raggi's avatar
Roberto Raggi committed
138
139
static QString buildHelpId(const FullySpecifiedType &type,
                           const Symbol *symbol)
con's avatar
con committed
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
{
    Name *name = 0;
    Scope *scope = 0;

    if (const Function *f = type->asFunction()) {
        name = f->name();
        scope = f->scope();
    } else if (const Class *c = type->asClass()) {
        name = c->name();
        scope = c->scope();
    } else if (const Enum *e = type->asEnum()) {
        name = e->name();
        scope = e->scope();
    } else if (const NamedType *t = type->asNamedType()) {
        name = t->name();
    } else if (const Declaration *d = symbol->asDeclaration()) {
        if (d->scope() && d->scope()->owner()->isEnum()) {
            name = d->name();
            scope = d->scope();
        }
    }

    Overview overview;
    overview.setShowArgumentNames(false);
    overview.setShowReturnTypes(false);

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

    for (; scope; scope = scope->enclosingScope()) {
        if (scope->owner() && scope->owner()->name() && !scope->isEnumScope()) {
            Name *name = scope->owner()->name();
            Identifier *id = 0;
            if (NameId *nameId = name->asNameId()) {
                id = nameId->identifier();
            } else if (TemplateNameId *nameId = name->asTemplateNameId()) {
                id = nameId->identifier();
            }
            if (id)
                qualifiedNames.prepend(QString::fromLatin1(id->chars(), id->size()));
        }
    }

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

void CppHoverHandler::updateHelpIdAndTooltip(TextEditor::ITextEditor *editor, int pos)
{
    m_helpId.clear();
    m_toolTip.clear();

191
192
193
    if (!m_modelManager)
        return;

Roberto Raggi's avatar
Roberto Raggi committed
194
    TextEditor::BaseTextEditor *edit = qobject_cast<TextEditor::BaseTextEditor *>(editor->widget());
con's avatar
con committed
195
196
197
    if (!edit)
        return;

198
199
200
201
202
203
    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
204
205
    QTextCursor tc(edit->document());
    tc.setPosition(pos);
206
    const unsigned lineNumber = tc.block().blockNumber() + 1;
con's avatar
con committed
207

208
209
210
211
    // 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);
212

213
214
215
216
217
218
219
    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
220
        }
221
    }
con's avatar
con committed
222

223
224
225
226
227
    if (m_toolTip.isEmpty()) {
        foreach (const Document::Include &incl, doc->includes()) {
            if (incl.line() == lineNumber) {
                m_toolTip = incl.fileName();
                break;
228
229
230
231
            }
        }
    }

con's avatar
con committed
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
    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);

250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
        const QList<TypeOfExpression::Result> types =
                typeOfExpression(expression, doc, lastSymbol);

        if (!types.isEmpty()) {
            FullySpecifiedType firstType = types.first().first;
            FullySpecifiedType docType = firstType;

            if (const PointerType *pt = firstType->asPointerType()) {
                docType = pt->elementType();
            } else if (const ReferenceType *rt = firstType->asReferenceType()) {
                docType = rt->elementType();
            }

            m_helpId = buildHelpId(docType, types.first().second);
            QString displayName = buildHelpId(firstType, types.first().second);

            if (!firstType->isClass() && !firstType->isNamedType()) {
                Overview overview;
                overview.setShowArgumentNames(true);
                overview.setShowReturnTypes(true);
                m_toolTip = overview.prettyType(firstType, displayName);
            } else {
                m_toolTip = m_helpId;
con's avatar
con committed
273
274
275
276
            }
        }
    }

277
    if (m_toolTip.isEmpty()) {
278
279
        foreach (const Document::MacroUse &use, doc->macroUses()) {
            if (use.contains(pos)) {
280
281
282
                const Macro m = use.macro();
                m_toolTip = m.toString();
                m_helpId = m.name();
283
284
285
286
287
                break;
            }
        }
    }

288
289
290
291
292
293
    if (m_helpEngineNeedsSetup
        && m_helpEngine->registeredDocumentations().count() > 0) {
        m_helpEngine->setupData();
        m_helpEngineNeedsSetup = false;
    }

294
295
296
    if (! m_toolTip.isEmpty())
        m_toolTip = Qt::escape(m_toolTip);

con's avatar
con committed
297
298
    if (!m_helpId.isEmpty() && !m_helpEngine->linksForIdentifier(m_helpId).isEmpty()) {
        m_toolTip = QString(QLatin1String("<table><tr><td valign=middle><nobr>%1</td>"
299
                                          "<td><img src=\":/cppeditor/images/f1.svg\"></td></tr></table>"))
300
                    .arg(m_toolTip);
con's avatar
con committed
301
302
        editor->setContextHelpId(m_helpId);
    } else if (!m_toolTip.isEmpty()) {
303
        m_toolTip = QString(QLatin1String("<nobr>%1")).arg(m_toolTip);
con's avatar
con committed
304
305
    }
}