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
|
//===--- CodeCompletionDiagnostics.cpp ------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2021 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
#include "CodeCompletionDiagnostics.h"
#include "swift/AST/ASTContext.h"
#include "swift/AST/Decl.h"
#include "swift/AST/DiagnosticEngine.h"
#include "swift/AST/DiagnosticsIDE.h"
#include "swift/AST/DiagnosticsSema.h"
using namespace swift;
using namespace ide;
namespace {
CodeCompletionDiagnosticSeverity getSeverity(DiagnosticKind DiagKind) {
switch (DiagKind) {
case DiagnosticKind::Error:
return CodeCompletionDiagnosticSeverity::Error;
break;
case DiagnosticKind::Warning:
return CodeCompletionDiagnosticSeverity::Warning;
break;
case DiagnosticKind::Remark:
return CodeCompletionDiagnosticSeverity::Remark;
break;
case DiagnosticKind::Note:
return CodeCompletionDiagnosticSeverity::Note;
break;
}
llvm_unreachable("unhandled DiagnosticKind");
}
class CodeCompletionDiagnostics {
const ASTContext &Ctx;
DiagnosticEngine &Engine;
public:
CodeCompletionDiagnostics(const ASTContext &Ctx)
: Ctx(Ctx), Engine(Ctx.Diags) {}
template <typename... ArgTypes>
bool
getDiagnostics(CodeCompletionDiagnosticSeverity &severity,
llvm::raw_ostream &Out, Diag<ArgTypes...> ID,
typename swift::detail::PassArgument<ArgTypes>::type... VArgs);
bool getDiagnosticForDeprecated(const ValueDecl *D,
CodeCompletionDiagnosticSeverity &severity,
llvm::raw_ostream &Out);
};
template <typename... ArgTypes>
bool CodeCompletionDiagnostics::getDiagnostics(
CodeCompletionDiagnosticSeverity &severity, llvm::raw_ostream &Out,
Diag<ArgTypes...> ID,
typename swift::detail::PassArgument<ArgTypes>::type... VArgs) {
DiagID id = ID.ID;
std::vector<DiagnosticArgument> DiagArgs{std::move(VArgs)...};
auto format = Engine.diagnosticStringFor(id, /*printDiagnosticNames=*/false);
DiagnosticEngine::formatDiagnosticText(Out, format, DiagArgs);
severity = getSeverity(Engine.declaredDiagnosticKindFor(id));
return false;
}
bool CodeCompletionDiagnostics::getDiagnosticForDeprecated(
const ValueDecl *D, CodeCompletionDiagnosticSeverity &severity,
llvm::raw_ostream &Out) {
bool isSoftDeprecated = false;
const AvailableAttr *Attr = D->getAttrs().getDeprecated(Ctx);
if (!Attr) {
Attr = D->getAttrs().getSoftDeprecated(Ctx);
isSoftDeprecated = true;
}
if (!Attr)
return true;
// FIXME: Code completion doesn't offer accessors. It only emits 'VarDecl's.
// So getter/setter specific availability doesn't work in code completion.
StringRef Platform = Attr->prettyPlatformString();
llvm::VersionTuple DeprecatedVersion;
if (Attr->Deprecated)
DeprecatedVersion = Attr->Deprecated.value();
llvm::VersionTuple RemappedDeprecatedVersion;
if (AvailabilityInference::updateDeprecatedPlatformForFallback(
Attr, Ctx, Platform, RemappedDeprecatedVersion))
DeprecatedVersion = RemappedDeprecatedVersion;
if (!isSoftDeprecated) {
if (Attr->Message.empty() && Attr->Rename.empty()) {
getDiagnostics(severity, Out, diag::availability_deprecated,
D, Attr->hasPlatform(), Platform,
Attr->Deprecated.has_value(), DeprecatedVersion,
/*message*/ StringRef());
} else if (!Attr->Message.empty()) {
EncodedDiagnosticMessage EncodedMessage(Attr->Message);
getDiagnostics(severity, Out, diag::availability_deprecated,
D, Attr->hasPlatform(), Platform,
Attr->Deprecated.has_value(), DeprecatedVersion,
EncodedMessage.Message);
} else {
getDiagnostics(severity, Out, diag::availability_deprecated_rename,
D, Attr->hasPlatform(), Platform,
Attr->Deprecated.has_value(), DeprecatedVersion, false,
/*ReplaceKind*/ 0, Attr->Rename);
}
} else {
// '100000' is used as a version number in API that will be deprecated in an
// upcoming release. This number is to match the 'API_TO_BE_DEPRECATED'
// macro defined in Darwin platforms.
static llvm::VersionTuple DISTANT_FUTURE_VESION(100000);
bool isDistantFuture = DeprecatedVersion >= DISTANT_FUTURE_VESION;
if (Attr->Message.empty() && Attr->Rename.empty()) {
getDiagnostics(severity, Out, diag::ide_availability_softdeprecated,
D, Attr->hasPlatform(), Platform,
!isDistantFuture, DeprecatedVersion,
/*message*/ StringRef());
} else if (!Attr->Message.empty()) {
EncodedDiagnosticMessage EncodedMessage(Attr->Message);
getDiagnostics(severity, Out, diag::ide_availability_softdeprecated,
D, Attr->hasPlatform(), Platform,
!isDistantFuture, DeprecatedVersion,
EncodedMessage.Message);
} else {
getDiagnostics(severity, Out, diag::ide_availability_softdeprecated_rename,
D, Attr->hasPlatform(), Platform,
!isDistantFuture, DeprecatedVersion, Attr->Rename);
}
}
return false;;
}
} // namespace
bool swift::ide::getContextFreeCompletionDiagnostics(
ContextFreeNotRecommendedReason Reason, const ValueDecl *D,
CodeCompletionDiagnosticSeverity &Severity, llvm::raw_ostream &Out) {
CodeCompletionDiagnostics Diag(D->getASTContext());
switch (Reason) {
case ContextFreeNotRecommendedReason::Deprecated:
case ContextFreeNotRecommendedReason::SoftDeprecated:
return Diag.getDiagnosticForDeprecated(D, Severity, Out);
case ContextFreeNotRecommendedReason::None:
llvm_unreachable("invalid not recommended reason");
}
return true;
}
bool swift::ide::getContextualCompletionDiagnostics(
ContextualNotRecommendedReason Reason, StringRef NameForDiagnostics,
CodeCompletionDiagnosticSeverity &Severity, llvm::raw_ostream &Out,
const ASTContext &Ctx) {
CodeCompletionDiagnostics Diag(Ctx);
switch (Reason) {
case ContextualNotRecommendedReason::RedundantImport:
return Diag.getDiagnostics(Severity, Out, diag::ide_redundant_import,
NameForDiagnostics);
case ContextualNotRecommendedReason::RedundantImportIndirect:
return Diag.getDiagnostics(
Severity, Out, diag::ide_redundant_import_indirect, NameForDiagnostics);
case ContextualNotRecommendedReason::VariableUsedInOwnDefinition:
return Diag.getDiagnostics(Severity, Out,
diag::ide_recursive_accessor_reference,
NameForDiagnostics, /*"getter"*/ 0);
case ContextualNotRecommendedReason::NonAsyncAlternativeUsedInAsyncContext:
return Diag.getDiagnostics(
Severity, Out, diag::ide_has_async_alternative, NameForDiagnostics);
case ContextualNotRecommendedReason::None:
llvm_unreachable("invalid not recommended reason");
}
return true;
}
|
