cpphoverhandler.cpp 8.66 KB
Newer Older
con's avatar
con committed
1
2
3
4
5
6
7
8
/***************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
**
** 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
30
31
32
** rights. These rights are described in the Nokia Qt GPL Exception
** version 1.2, included in the file GPL_EXCEPTION.txt in this package.
**
***************************************************************************/
hjk's avatar
hjk committed
33

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

#include <coreplugin/icore.h>
#include <coreplugin/uniqueidmanager.h>
#include <texteditor/itexteditor.h>
Roberto Raggi's avatar
Roberto Raggi committed
40
#include <texteditor/basetexteditor.h>
con's avatar
con committed
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
#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>

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

using namespace CppTools::Internal;
Roberto Raggi's avatar
Roberto Raggi committed
61
using namespace CPlusPlus;
con's avatar
con committed
62
63

CppHoverHandler::CppHoverHandler(CppModelManager *manager, QObject *parent)
64
    : QObject(parent), m_manager(manager), m_helpEngineNeedsSetup(false)
con's avatar
con committed
65
66
67
68
69
70
71
{
    QFileInfo fi(ExtensionSystem::PluginManager::instance()->getObject<Core::ICore>()->settings()->fileName());
    m_helpEngine = new QHelpEngineCore(fi.absolutePath()
                                       + QLatin1String("/helpcollection.qhc"), this);
    //m_helpEngine->setAutoSaveFilter(false);
    m_helpEngine->setupData();
    m_helpEngine->setCurrentFilter(tr("Unfiltered"));
72
    m_helpEngineNeedsSetup = m_helpEngine->registeredDocumentations().count() == 0;
con's avatar
con committed
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
}

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

void CppHoverHandler::showToolTip(TextEditor::ITextEditor *editor, const QPoint &point, int pos)
{
    const int dbgcontext = m_manager->core()->
        uniqueIDManager()->uniqueIdentifier(Debugger::Constants::C_GDBDEBUGGER);

    if (m_manager->core()->hasContext(dbgcontext))
        return;

    if (! editor)
        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
108
109
static QString buildHelpId(const FullySpecifiedType &type,
                           const Symbol *symbol)
con's avatar
con committed
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
{
    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();

Roberto Raggi's avatar
Roberto Raggi committed
161
    TextEditor::BaseTextEditor *edit = qobject_cast<TextEditor::BaseTextEditor *>(editor->widget());
con's avatar
con committed
162
163
164
165
166
167
168
    if (!edit)
        return;

    QTextCursor tc(edit->document());
    tc.setPosition(pos);

    const int lineNumber = tc.block().blockNumber() + 1;
Roberto Raggi's avatar
Roberto Raggi committed
169
    const QString fileName = editor->file()->fileName();
con's avatar
con committed
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
    Document::Ptr doc = m_manager->document(fileName);
    if (doc) {
        foreach (Document::DiagnosticMessage m, doc->diagnosticMessages()) {
            if (m.line() == lineNumber) {
                m_toolTip = m.text();
                break;
            }
        }
    }

    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);

        if (doc) {
            // 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);

            TypeOfExpression typeOfExpression;
            typeOfExpression.setDocuments(m_manager->documents());
            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;
                }
            }
        }
    }

234
235
236
237
    if (doc && m_toolTip.isEmpty()) {
        foreach (const Document::MacroUse &use, doc->macroUses()) {
            if (use.contains(pos)) {
                m_toolTip = use.macro().toString();
238
                m_helpId = use.macro().name;
239
240
241
242
243
                break;
            }
        }
    }

244
245
246
247
248
249
    if (m_helpEngineNeedsSetup
        && m_helpEngine->registeredDocumentations().count() > 0) {
        m_helpEngine->setupData();
        m_helpEngineNeedsSetup = false;
    }

con's avatar
con committed
250
251
    if (!m_helpId.isEmpty() && !m_helpEngine->linksForIdentifier(m_helpId).isEmpty()) {
        m_toolTip = QString(QLatin1String("<table><tr><td valign=middle><nobr>%1</td>"
252
253
                                          "<td><img src=\":/cpptools/images/f1.svg\"></td></tr></table>"))
                    .arg(Qt::escape(m_toolTip));
con's avatar
con committed
254
255
256
257
258
        editor->setContextHelpId(m_helpId);
    } else if (!m_toolTip.isEmpty()) {
        m_toolTip = QString(QLatin1String("<nobr>%1")).arg(Qt::escape(m_toolTip));
    }
}