1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qt Creator.
7 **
8 ** Commercial License Usage
9 ** Licensees holding valid commercial Qt licenses may use this file in
10 ** accordance with the commercial license agreement provided with the
11 ** Software or, alternatively, in accordance with the terms contained in
12 ** a written agreement between you and The Qt Company. For licensing terms
13 ** and conditions see https://www.qt.io/terms-conditions. For further
14 ** information use the contact form at https://www.qt.io/contact-us.
15 **
16 ** GNU General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU
18 ** General Public License version 3 as published by the Free Software
19 ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
20 ** included in the packaging of this file. Please review the following
21 ** information to ensure the GNU General Public License requirements will
22 ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
23 **
24 ****************************************************************************/
25 
26 #pragma once
27 
28 #include <qmljseditor/qmljseditor_global.h>
29 #include <qmljs/qmljsmodelmanagerinterface.h>
30 #include <texteditor/basehoverhandler.h>
31 
32 #include <QColor>
33 #include <QCoreApplication>
34 
35 namespace QmlJS {
36 class ScopeChain;
37 class Context;
38 using ContextPtr = QSharedPointer<const Context>;
39 class Value;
40 class ObjectValue;
41 }
42 
43 namespace QmlJSEditor {
44 
45 class QmlJSEditorWidget;
46 
47 class QMLJSEDITOR_EXPORT QmlJSHoverHandler : public TextEditor::BaseHoverHandler
48 {
49     Q_DECLARE_TR_FUNCTIONS(QmlJSHoverHandler)
50 
51 public:
52     QmlJSHoverHandler();
53 
54 private:
55     void reset();
56 
57     void identifyMatch(TextEditor::TextEditorWidget *editorWidget,
58                        int pos,
59                        ReportPriority report) override;
60     void operateTooltip(TextEditor::TextEditorWidget *editorWidget, const QPoint &point) override;
61 
62     bool matchDiagnosticMessage(QmlJSEditorWidget *qmlEditor, int pos);
63     bool matchColorItem(const QmlJS::ScopeChain &lookupContext,
64                         const QmlJS::Document::Ptr &qmlDocument,
65                         const QList<QmlJS::AST::Node *> &astPath,
66                         unsigned pos);
67     void handleOrdinaryMatch(const QmlJS::ScopeChain &lookupContext,
68                              QmlJS::AST::Node *node);
69     void handleImport(const QmlJS::ScopeChain &lookupContext,
70                       QmlJS::AST::UiImport *node);
71 
72     void prettyPrintTooltip(const QmlJS::Value *value,
73                             const QmlJS::ContextPtr &context);
74 
75     bool setQmlTypeHelp(const QmlJS::ScopeChain &scopeChain, const QmlJS::Document::Ptr &qmlDocument,
76                         const QmlJS::ObjectValue *value, const QStringList &qName);
77     bool setQmlHelpItem(const QmlJS::ScopeChain &lookupContext,
78                         const QmlJS::Document::Ptr &qmlDocument,
79                         QmlJS::AST::Node *node);
80 
81     QmlJS::ModelManagerInterface *m_modelManager = nullptr;
82     QColor m_colorTip;
83 };
84 
85 } // namespace QmlJSEditor
86