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
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/****************************************************************************
**
** 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 "clangbackendipc_global.h"
#include "codecompletionchunk.h"
#include <utf8string.h>
#include <QDataStream>
#include <QVector>
namespace ClangBackEnd {
class CodeCompletion;
using CodeCompletions = QVector<CodeCompletion>;
class CodeCompletion
{
public:
enum Kind : quint32 {
Other = 0,
FunctionCompletionKind,
FunctionOverloadCompletionKind,
TemplateFunctionCompletionKind,
ConstructorCompletionKind,
DestructorCompletionKind,
VariableCompletionKind,
ClassCompletionKind,
TypeAliasCompletionKind,
TemplateClassCompletionKind,
EnumerationCompletionKind,
EnumeratorCompletionKind,
NamespaceCompletionKind,
PreProcessorCompletionKind,
SignalCompletionKind,
SlotCompletionKind,
ObjCMessageCompletionKind,
KeywordCompletionKind,
ClangSnippetKind
};
enum Availability : quint32 {
Available,
Deprecated,
NotAvailable,
NotAccessible
};
public:
CodeCompletion() = default;
CodeCompletion(const Utf8String &text,
quint32 priority = 0,
Kind completionKind = Other,
Availability availability = Available,
bool hasParameters = false)
: m_text(text),
m_priority(priority),
m_completionKind(completionKind),
m_availability(availability),
m_hasParameters(hasParameters)
{
}
void setText(const Utf8String &text)
{
m_text = text;
}
const Utf8String &text() const
{
return m_text;
}
void setCompletionKind(Kind completionKind)
{
m_completionKind = completionKind;
}
Kind completionKind() const
{
return m_completionKind;
}
void setChunks(const CodeCompletionChunks &chunks)
{
m_chunks = chunks;
}
const CodeCompletionChunks &chunks() const
{
return m_chunks;
}
void setAvailability(Availability availability)
{
m_availability = availability;
}
Availability availability() const
{
return m_availability;
}
void setHasParameters(bool hasParameters)
{
m_hasParameters = hasParameters;
}
bool hasParameters() const
{
return m_hasParameters;
}
void setPriority(quint32 priority)
{
m_priority = priority;
}
quint32 priority() const
{
return m_priority;
}
void setBriefComment(const Utf8String &briefComment)
{
m_briefComment = briefComment;
}
const Utf8String &briefComment() const
{
return m_briefComment;
}
friend QDataStream &operator<<(QDataStream &out, const CodeCompletion &message)
{
out << message.m_text;
out << message.m_briefComment;
out << message.m_chunks;
out << message.m_priority;
out << static_cast<quint32>(message.m_completionKind);
out << static_cast<quint32>(message.m_availability);
out << message.m_hasParameters;
return out;
}
friend QDataStream &operator>>(QDataStream &in, CodeCompletion &message)
{
quint32 completionKind;
quint32 availability;
in >> message.m_text;
in >> message.m_briefComment;
in >> message.m_chunks;
in >> message.m_priority;
in >> completionKind;
in >> availability;
in >> message.m_hasParameters;
message.m_completionKind = static_cast<CodeCompletion::Kind>(completionKind);
message.m_availability = static_cast<CodeCompletion::Availability>(availability);
return in;
}
friend bool operator==(const CodeCompletion &first, const CodeCompletion &second)
{
return first.m_text == second.m_text
&& first.m_completionKind == second.m_completionKind;
}
friend CMBIPC_EXPORT QDebug operator<<(QDebug debug, const CodeCompletion &message);
friend std::ostream &operator<<(std::ostream &os, const CodeCompletion &message);
private:
Utf8String m_text;
Utf8String m_briefComment;
CodeCompletionChunks m_chunks;
quint32 m_priority = 0;
Kind m_completionKind = Other;
Availability m_availability = NotAvailable;
bool m_hasParameters = false;
};
CMBIPC_EXPORT QDebug operator<<(QDebug debug, CodeCompletion::Kind kind);
CMBIPC_EXPORT std::ostream &operator<<(std::ostream &os, const CodeCompletion::Kind kind);
CMBIPC_EXPORT std::ostream &operator<<(std::ostream &os, const CodeCompletion::Availability availability);
} // namespace ClangBackEnd
|