summaryrefslogtreecommitdiff
path: root/src/plugins/cpptools/cppelementevaluator.h
blob: 51c4ce28fff11ee7c1768741822cd8d4bd9c3bd4 (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
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/

#pragma once

#include "cpptools_global.h"

#include <coreplugin/helpitem.h>
#include <texteditor/texteditor.h>

#include <cplusplus/CppDocument.h>

#include <QFuture>
#include <QIcon>
#include <QSharedPointer>
#include <QString>
#include <QStringList>
#include <QTextCursor>

namespace CPlusPlus {
class LookupItem;
class LookupContext;
}

namespace CppTools {
class CppElement;
class CppModelManager;

class CPPTOOLS_EXPORT CppElementEvaluator
{
public:
    explicit CppElementEvaluator(TextEditor::TextEditorWidget *editor);

    void setTextCursor(const QTextCursor &tc);
    void setLookupBaseClasses(const bool lookup);
    void setLookupDerivedClasses(const bool lookup);
    void setExpression(const QString &expression, const QString &fileName);

    void execute();
    QFuture<QSharedPointer<CppElement>> asyncExecute();
    QFuture<QSharedPointer<CppElement>> asyncExpressionExecute();
    bool identifiedCppElement() const;
    const QSharedPointer<CppElement> &cppElement() const;
    bool hasDiagnosis() const;
    const QString &diagnosis() const;

    static Utils::Link linkFromExpression(const QString &expression, const QString &fileName);

private:
    void clear();
    using ExecFunction = QFuture<QSharedPointer<CppElement>>(CppElementEvaluator::*)
                (const CPlusPlus::Snapshot &, const CPlusPlus::LookupItem &,
                 const CPlusPlus::LookupContext &);
    using SourceFunction = bool(CppElementEvaluator::*)
                (const CPlusPlus::Snapshot &, CPlusPlus::Document::Ptr &,
                 CPlusPlus::Scope **, QString &);

    QFuture<QSharedPointer<CppElement>> execute(SourceFunction sourceFunction,
                                                ExecFunction execFuntion);
    QFuture<QSharedPointer<CppElement>> syncExec(const CPlusPlus::Snapshot &,
                     const CPlusPlus::LookupItem &, const CPlusPlus::LookupContext &);
    QFuture<QSharedPointer<CppElement>> asyncExec(const CPlusPlus::Snapshot &,
                     const CPlusPlus::LookupItem &, const CPlusPlus::LookupContext &);
    bool sourceDataFromGui(const CPlusPlus::Snapshot &snapshot,
                           CPlusPlus::Document::Ptr &doc,
                           CPlusPlus::Scope **scope,
                           QString &expression);
    bool sourceDataFromExpression(const CPlusPlus::Snapshot &snapshot,
                           CPlusPlus::Document::Ptr &doc,
                           CPlusPlus::Scope **scope,
                           QString &expression);
    void checkDiagnosticMessage(int pos);
    bool matchIncludeFile(const CPlusPlus::Document::Ptr &document, int line);
    bool matchMacroInUse(const CPlusPlus::Document::Ptr &document, int pos);

    TextEditor::TextEditorWidget *m_editor;
    CppTools::CppModelManager *m_modelManager;
    QTextCursor m_tc;
    QString m_expression;
    QString m_fileName;
    bool m_lookupBaseClasses;
    bool m_lookupDerivedClasses;
    QSharedPointer<CppElement> m_element;
    QString m_diagnosis;
};

class CppClass;

class CPPTOOLS_EXPORT CppElement
{
protected:
    CppElement();

public:
    virtual ~CppElement();

    virtual CppClass *toCppClass();

    Core::HelpItem::Category helpCategory = Core::HelpItem::Unknown;
    QStringList helpIdCandidates;
    QString helpMark;
    Utils::Link link;
    QString tooltip;
};

class CPPTOOLS_EXPORT CppDeclarableElement : public CppElement
{
public:
    explicit CppDeclarableElement(CPlusPlus::Symbol *declaration);

public:
    CPlusPlus::Symbol *declaration;
    QString name;
    QString qualifiedName;
    QString type;
    QIcon icon;
};

class CPPTOOLS_EXPORT CppClass : public CppDeclarableElement
{
public:
    CppClass();
    explicit CppClass(CPlusPlus::Symbol *declaration);

    bool operator==(const CppClass &other);

    CppClass *toCppClass() final;

    void lookupBases(QFutureInterfaceBase &futureInterface,
                     CPlusPlus::Symbol *declaration, const CPlusPlus::LookupContext &context);
    void lookupDerived(QFutureInterfaceBase &futureInterface,
                       CPlusPlus::Symbol *declaration, const CPlusPlus::Snapshot &snapshot);

public:
    QList<CppClass> bases;
    QList<CppClass> derived;
};

} // namespace CppTools