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
|
//===--- MiscDiagnostics.h - AST-Level Diagnostics --------------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 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
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_SEMA_MISC_DIAGNOSTICS_H
#define SWIFT_SEMA_MISC_DIAGNOSTICS_H
#include "swift/AST/ASTWalker.h"
#include "swift/AST/AttrKind.h"
#include "swift/AST/Expr.h"
#include "swift/AST/Identifier.h"
#include "swift/AST/Pattern.h"
#include "swift/Basic/LLVM.h"
#include "swift/Basic/SourceLoc.h"
#include "llvm/ADT/ArrayRef.h"
#include <optional>
namespace swift {
class AbstractFunctionDecl;
class ApplyExpr;
class CallExpr;
class ClosureExpr;
enum ContextualTypePurpose : uint8_t;
class DeclContext;
class Decl;
class Expr;
class InFlightDiagnostic;
class Stmt;
class TopLevelCodeDecl;
class ValueDecl;
class ForEachStmt;
/// Diagnose any expressions that appear in an unsupported position. If visiting
/// an expression directly, its \p contextualPurpose should be provided to
/// evaluate its position.
void diagnoseOutOfPlaceExprs(
ASTContext &ctx, ASTNode root,
std::optional<ContextualTypePurpose> contextualPurpose);
/// Emit diagnostics for syntactic restrictions on a given expression.
///
/// Note: \p contextualPurpose must be non-nil, unless
/// \p disableOutOfPlaceExprChecking is set to \c true.
void performSyntacticExprDiagnostics(
const Expr *E, const DeclContext *DC,
std::optional<ContextualTypePurpose> contextualPurpose, bool isExprStmt,
bool disableExprAvailabilityChecking = false,
bool disableOutOfPlaceExprChecking = false);
/// Emit diagnostics for a given statement.
void performStmtDiagnostics(const Stmt *S, DeclContext *DC);
void performAbstractFuncDeclDiagnostics(AbstractFunctionDecl *AFD);
/// Perform diagnostics on the top level code declaration.
void performTopLevelDeclDiagnostics(TopLevelCodeDecl *TLCD);
/// Emit a fix-it to set the access of \p VD to \p desiredAccess.
///
/// This actually updates \p VD as well.
void fixItAccess(InFlightDiagnostic &diag, ValueDecl *VD,
AccessLevel desiredAccess, bool isForSetter = false,
bool shouldUseDefaultAccess = false);
/// Compute the location of the 'var' keyword for a 'var'-to-'let' Fix-It.
SourceLoc getFixItLocForVarToLet(VarDecl *var);
/// Describes the context of a parameter, for use in diagnosing argument
/// label problems.
enum class ParameterContext : unsigned {
Call = 0,
Subscript = 1,
MacroExpansion = 2
};
/// Emit fix-its to correct the argument labels in \p argList.
///
/// If \p existingDiag is null, the fix-its will be attached to an appropriate
/// error diagnostic.
///
/// \returns true if the issue was diagnosed
bool diagnoseArgumentLabelError(ASTContext &ctx, const ArgumentList *argList,
ArrayRef<Identifier> newNames,
ParameterContext paramContext,
InFlightDiagnostic *existingDiag = nullptr);
/// If \p assignExpr has a destination expression that refers to a declaration
/// with a non-owning attribute, such as 'weak' or 'unowned' and the
/// initializer expression refers to a class constructor, emit a warning that
/// the assigned instance will be immediately deallocated.
void diagnoseUnownedImmediateDeallocation(ASTContext &ctx,
const AssignExpr *assignExpr);
/// If \p pattern binds to a declaration with a non-owning attribute, such as
/// 'weak' or 'unowned' and \p initializer refers to a class constructor,
/// emit a warning that the bound instance will be immediately deallocated.
void diagnoseUnownedImmediateDeallocation(ASTContext &ctx,
const Pattern *pattern,
SourceLoc equalLoc,
const Expr *initializer);
/// If \p expr is a call to a known function with a requirement that some
/// arguments must be constants, whether those arguments are passed only
/// constants. Otherwise, diagnose and emit errors.
void diagnoseConstantArgumentRequirement(const Expr *expr,
const DeclContext *declContext);
/// Attempt to fix the type of \p decl so that it's a valid override for
/// \p base...but only if we're highly confident that we know what the user
/// should have written.
///
/// The \p diag closure allows the caller to control the diagnostic that is
/// emitted. It is passed true if the diagnostic will be emitted with fixits
/// attached, and false otherwise. If None is returned, no diagnostics are
/// emitted. Else the fixits are attached to the returned diagnostic.
///
/// \returns true iff any fix-its were attached to \p diag.
bool computeFixitsForOverriddenDeclaration(
ValueDecl *decl, const ValueDecl *base,
llvm::function_ref<std::optional<InFlightDiagnostic>(bool)> diag);
/// Emit fix-its to enclose trailing closure in argument parens.
void fixItEncloseTrailingClosure(ASTContext &ctx, InFlightDiagnostic &diag,
const CallExpr *call,
Identifier closureLabel);
/// Check that we use the async version of a function where available
///
/// If a completion-handler function is called from an async context and it
/// has a '@available' attribute with renamed field pointing to an async
/// function, we emit a diagnostic suggesting the async call.
void checkFunctionAsyncUsage(AbstractFunctionDecl *decl);
void checkPatternBindingDeclAsyncUsage(PatternBindingDecl *decl);
/// Detect and diagnose a missing `try` in `for-in` loop sequence
/// expression in async context (denoted with `await` keyword).
bool diagnoseUnhandledThrowsInAsyncContext(DeclContext *dc,
ForEachStmt *forEach);
class BaseDiagnosticWalker : public ASTWalker {
PreWalkAction walkToDeclPre(Decl *D) override;
bool shouldWalkIntoSeparatelyCheckedClosure(ClosureExpr *expr) override {
return false;
}
// Only emit diagnostics in the expansion of macros.
MacroWalking getMacroWalkingBehavior() const override {
return MacroWalking::Expansion;
}
private:
static bool shouldWalkIntoDeclInClosureContext(Decl *D);
};
// A simple, deferred diagnostic container.
struct DeferredDiag {
SourceLoc loc;
ZeroArgDiagnostic diag;
DeferredDiag(SourceLoc loc, ZeroArgDiagnostic diag)
: loc(loc), diag(diag) {}
// Emits this diagnostic.
void emit(ASTContext &ctx);
};
using DeferredDiags = SmallVector<DeferredDiag, 2>;
/// Search for syntactic errors in the given sub-expression of a ConsumeExpr,
/// collecting them without actually emitting them.
///
/// \param loc corresponds to the location of the 'consume' for which
/// diagnostics should be collected, if any.
///
/// \returns an empty collection if there are no errors.
DeferredDiags findSyntacticErrorForConsume(ModuleDecl *module,
SourceLoc loc,
Expr *subExpr);
} // namespace swift
#endif // SWIFT_SEMA_MISC_DIAGNOSTICS_H
|
