-
Notifications
You must be signed in to change notification settings - Fork 10.5k
/
Copy pathTypeCheckMacros.cpp
1946 lines (1668 loc) · 68.8 KB
/
TypeCheckMacros.cpp
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//===--- TypeCheckMacros.cpp - Macro Handling ----------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2018 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
//
//===----------------------------------------------------------------------===//
//
// This file implements support for the evaluation of macros.
//
//===----------------------------------------------------------------------===//
#include "TypeCheckMacros.h"
#include "../AST/InlinableText.h"
#include "TypeCheckType.h"
#include "TypeChecker.h"
#include "swift/ABI/MetadataValues.h"
#include "swift/AST/ASTBridging.h"
#include "swift/AST/ASTContext.h"
#include "swift/AST/ASTMangler.h"
#include "swift/AST/ASTNode.h"
#include "swift/AST/DiagnosticsFrontend.h"
#include "swift/AST/Expr.h"
#include "swift/AST/FreestandingMacroExpansion.h"
#include "swift/AST/MacroDefinition.h"
#include "swift/AST/NameLookupRequests.h"
#include "swift/AST/PluginLoader.h"
#include "swift/AST/PluginRegistry.h"
#include "swift/AST/PrettyStackTrace.h"
#include "swift/AST/SourceFile.h"
#include "swift/AST/TypeCheckRequests.h"
#include "swift/Basic/Defer.h"
#include "swift/Basic/Lazy.h"
#include "swift/Basic/SourceManager.h"
#include "swift/Basic/StringExtras.h"
#include "swift/Bridging/ASTGen.h"
#include "swift/Demangling/Demangler.h"
#include "swift/Demangling/ManglingMacros.h"
#include "swift/Parse/Lexer.h"
#include "swift/Sema/IDETypeChecking.h"
#include "swift/Subsystems.h"
#include "llvm/Config/config.h"
using namespace swift;
#if SWIFT_BUILD_SWIFT_SYNTAX
/// Look for macro's type metadata given its external module and type name.
static void const *
lookupMacroTypeMetadataByExternalName(ASTContext &ctx, StringRef moduleName,
StringRef typeName,
LoadedLibraryPlugin *plugin) {
// Look up the type metadata accessor as a struct, enum, or class.
const Demangle::Node::Kind typeKinds[] = {
Demangle::Node::Kind::Structure,
Demangle::Node::Kind::Enum,
Demangle::Node::Kind::Class
};
void *accessorAddr = nullptr;
for (auto typeKind : typeKinds) {
auto symbolName = Demangle::mangledNameForTypeMetadataAccessor(
moduleName, typeName, typeKind);
accessorAddr = plugin->getAddressOfSymbol(symbolName.c_str());
if (accessorAddr)
break;
}
if (!accessorAddr)
return nullptr;
// Call the accessor to form type metadata.
using MetadataAccessFunc = const void *(MetadataRequest);
auto accessor = reinterpret_cast<MetadataAccessFunc*>(accessorAddr);
return accessor(MetadataRequest(MetadataState::Complete));
}
#endif
/// Translate an argument provided as a string literal into an identifier,
/// or return \c None and emit an error if it cannot be done.
llvm::Optional<Identifier> getIdentifierFromStringLiteralArgument(
ASTContext &ctx, MacroExpansionExpr *expansion, unsigned index) {
auto argList = expansion->getArgs();
// If there's no argument here, an error was diagnosed elsewhere.
if (!argList || index >= argList->size()) {
return llvm::None;
}
auto arg = argList->getExpr(index);
auto stringLiteral = dyn_cast<StringLiteralExpr>(arg);
if (!stringLiteral) {
ctx.Diags.diagnose(
arg->getLoc(), diag::external_macro_arg_not_type_name, index
);
return llvm::None;
}
auto contents = stringLiteral->getValue();
if (!Lexer::isIdentifier(contents)) {
ctx.Diags.diagnose(
arg->getLoc(), diag::external_macro_arg_not_type_name, index
);
return llvm::None;
}
return ctx.getIdentifier(contents);
}
/// For a macro expansion expression that is known to be #externalMacro,
/// handle the definition.
#if SWIFT_BUILD_SWIFT_SYNTAX
static MacroDefinition handleExternalMacroDefinition(
ASTContext &ctx, MacroExpansionExpr *expansion) {
// Dig out the module and type name.
auto moduleName = getIdentifierFromStringLiteralArgument(ctx, expansion, 0);
if (!moduleName) {
return MacroDefinition::forInvalid();
}
auto typeName = getIdentifierFromStringLiteralArgument(ctx, expansion, 1);
if (!typeName) {
return MacroDefinition::forInvalid();
}
return MacroDefinition::forExternal(*moduleName, *typeName);
}
#endif // SWIFT_BUILD_SWIFT_SYNTAX
MacroDefinition MacroDefinitionRequest::evaluate(
Evaluator &evaluator, MacroDecl *macro
) const {
// If no definition was provided, the macro is... undefined, of course.
auto definition = macro->definition;
if (!definition)
return MacroDefinition::forUndefined();
#if SWIFT_BUILD_SWIFT_SYNTAX
ASTContext &ctx = macro->getASTContext();
auto sourceFile = macro->getParentSourceFile();
BridgedStringRef externalMacroName{nullptr, 0};
ptrdiff_t *replacements = nullptr;
ptrdiff_t numReplacements = 0;
auto checkResult = swift_ASTGen_checkMacroDefinition(
&ctx.Diags, sourceFile->getExportedSourceFile(),
macro->getLoc().getOpaquePointerValue(), &externalMacroName,
&replacements, &numReplacements);
// Clean up after the call.
SWIFT_DEFER {
swift_ASTGen_freeBridgedString(externalMacroName);
swift_ASTGen_freeExpansionReplacements(replacements, numReplacements);
};
if (checkResult < 0 && ctx.CompletionCallback) {
// If the macro failed to check and we are in code completion mode, pretend
// it's an arbitrary macro. This allows us to get call argument completions
// inside `#externalMacro`.
checkResult = BridgedMacroDefinitionKind::BridgedExpandedMacro;
}
if (checkResult < 0)
return MacroDefinition::forInvalid();
switch (static_cast<BridgedMacroDefinitionKind>(checkResult)) {
case BridgedExpandedMacro:
// Handle expanded macros below.
break;
case BridgedExternalMacro: {
// An external macro described as ModuleName.TypeName. Get both identifiers.
assert(!replacements && "External macro doesn't have replacements");
StringRef externalMacroStr = externalMacroName.unbridged();
StringRef externalModuleName, externalTypeName;
std::tie(externalModuleName, externalTypeName) = externalMacroStr.split('.');
Identifier moduleName = ctx.getIdentifier(externalModuleName);
Identifier typeName = ctx.getIdentifier(externalTypeName);
return MacroDefinition::forExternal(moduleName, typeName);
}
case BridgedBuiltinExternalMacro:
return MacroDefinition::forBuiltin(BuiltinMacroKind::ExternalMacro);
}
// Type-check the macro expansion.
Type resultType = macro->mapTypeIntoContext(macro->getResultInterfaceType());
constraints::ContextualTypeInfo contextualType {
TypeLoc::withoutLoc(resultType),
// FIXME: Add a contextual type purpose for macro definition checking.
ContextualTypePurpose::CTP_CoerceOperand
};
PrettyStackTraceDecl debugStack("type checking macro definition", macro);
Type typeCheckedType = TypeChecker::typeCheckExpression(
definition, macro, contextualType,
TypeCheckExprFlags::DisableMacroExpansions);
if (!typeCheckedType)
return MacroDefinition::forInvalid();
// Dig out the macro that was expanded.
auto expansion = cast<MacroExpansionExpr>(definition);
auto expandedMacro =
dyn_cast_or_null<MacroDecl>(expansion->getMacroRef().getDecl());
if (!expandedMacro)
return MacroDefinition::forInvalid();
// Handle external macros after type-checking.
auto builtinKind = expandedMacro->getBuiltinKind();
if (builtinKind == BuiltinMacroKind::ExternalMacro)
return handleExternalMacroDefinition(ctx, expansion);
// Expansion string text.
StringRef expansionText = externalMacroName.unbridged();
// Copy over the replacements.
SmallVector<ExpandedMacroReplacement, 2> replacementsVec;
for (unsigned i: range(0, numReplacements)) {
replacementsVec.push_back(
{ static_cast<unsigned>(replacements[3*i]),
static_cast<unsigned>(replacements[3*i+1]),
static_cast<unsigned>(replacements[3*i+2])});
}
return MacroDefinition::forExpanded(ctx, expansionText, replacementsVec);
#else
macro->diagnose(diag::macro_unsupported);
return MacroDefinition::forInvalid();
#endif
}
static llvm::Expected<LoadedExecutablePlugin *>
initializeExecutablePlugin(ASTContext &ctx,
LoadedExecutablePlugin *executablePlugin,
StringRef libraryPath, Identifier moduleName) {
// Lock the plugin while initializing.
// Note that'executablePlugn' can be shared between multiple ASTContext.
executablePlugin->lock();
SWIFT_DEFER { executablePlugin->unlock(); };
// FIXME: Ideally this should be done right after invoking the plugin.
// But plugin loading is in libAST and it can't link ASTGen symbols.
if (!executablePlugin->isInitialized()) {
#if SWIFT_BUILD_SWIFT_SYNTAX
if (!swift_ASTGen_initializePlugin(executablePlugin, &ctx.Diags)) {
return llvm::createStringError(
llvm::inconvertibleErrorCode(), "'%s' produced malformed response",
executablePlugin->getExecutablePath().data());
}
// Resend the compiler capability on reconnect.
auto *callback = new std::function<void(void)>(
[executablePlugin]() {
(void)swift_ASTGen_initializePlugin(
executablePlugin, /*diags=*/nullptr);
});
executablePlugin->addOnReconnect(callback);
executablePlugin->setCleanup([executablePlugin] {
swift_ASTGen_deinitializePlugin(executablePlugin);
});
#endif
}
// If this is a plugin server, load the library.
if (!libraryPath.empty()) {
#if SWIFT_BUILD_SWIFT_SYNTAX
llvm::SmallString<128> resolvedLibraryPath;
auto fs = ctx.SourceMgr.getFileSystem();
if (auto err = fs->getRealPath(libraryPath, resolvedLibraryPath)) {
return llvm::createStringError(err, err.message());
}
std::string resolvedLibraryPathStr(resolvedLibraryPath);
std::string moduleNameStr(moduleName.str());
BridgedStringRef bridgedErrorOut{nullptr, 0};
bool loaded = swift_ASTGen_pluginServerLoadLibraryPlugin(
executablePlugin, resolvedLibraryPathStr.c_str(), moduleNameStr.c_str(),
&bridgedErrorOut);
auto errorOut = bridgedErrorOut.unbridged();
if (!loaded) {
SWIFT_DEFER { swift_ASTGen_freeBridgedString(errorOut); };
return llvm::createStringError(
llvm::inconvertibleErrorCode(),
"failed to load library plugin '%s' in plugin server '%s'; %s",
resolvedLibraryPathStr.c_str(),
executablePlugin->getExecutablePath().data(), errorOut.data());
}
assert(errorOut.data() == nullptr);
// Set a callback to load the library again on reconnections.
auto *callback = new std::function<void(void)>(
[executablePlugin, resolvedLibraryPathStr, moduleNameStr]() {
(void)swift_ASTGen_pluginServerLoadLibraryPlugin(
executablePlugin, resolvedLibraryPathStr.c_str(),
moduleNameStr.c_str(),
/*errorOut=*/nullptr);
});
executablePlugin->addOnReconnect(callback);
// Remove the callback and deallocate it when this ASTContext is destructed.
ctx.addCleanup([executablePlugin, callback]() {
executablePlugin->removeOnReconnect(callback);
delete callback;
});
#endif
}
return executablePlugin;
}
CompilerPluginLoadResult
CompilerPluginLoadRequest::evaluate(Evaluator &evaluator, ASTContext *ctx,
Identifier moduleName) const {
PluginLoader &loader = ctx->getPluginLoader();
const auto &entry = loader.lookupPluginByModuleName(moduleName);
SmallString<0> errorMessage;
if (!entry.executablePath.empty()) {
llvm::Expected<LoadedExecutablePlugin *> executablePlugin =
loader.loadExecutablePlugin(entry.executablePath);
if (executablePlugin) {
if (ctx->LangOpts.EnableMacroLoadingRemarks) {
unsigned tag = entry.libraryPath.empty() ? 1 : 2;
ctx->Diags.diagnose(SourceLoc(), diag::macro_loaded, moduleName, tag,
entry.executablePath, entry.libraryPath);
}
executablePlugin = initializeExecutablePlugin(
*ctx, executablePlugin.get(), entry.libraryPath, moduleName);
}
if (executablePlugin)
return executablePlugin.get();
llvm::handleAllErrors(executablePlugin.takeError(),
[&](const llvm::ErrorInfoBase &err) {
if (!errorMessage.empty())
errorMessage += ", ";
errorMessage += err.message();
});
} else if (!entry.libraryPath.empty()) {
llvm::Expected<LoadedLibraryPlugin *> libraryPlugin =
loader.loadLibraryPlugin(entry.libraryPath);
if (libraryPlugin) {
if (ctx->LangOpts.EnableMacroLoadingRemarks) {
ctx->Diags.diagnose(SourceLoc(), diag::macro_loaded, moduleName, 0,
entry.libraryPath, StringRef());
}
return libraryPlugin.get();
} else {
llvm::handleAllErrors(libraryPlugin.takeError(),
[&](const llvm::ErrorInfoBase &err) {
if (!errorMessage.empty())
errorMessage += ", ";
errorMessage += err.message();
});
}
}
if (!errorMessage.empty()) {
NullTerminatedStringRef err(errorMessage, *ctx);
return CompilerPluginLoadResult::error(err);
} else {
NullTerminatedStringRef errMsg(
"plugin for module '" + moduleName.str() + "' not found", *ctx);
return CompilerPluginLoadResult::error(errMsg);
}
}
static ExternalMacroDefinition
resolveInProcessMacro(ASTContext &ctx, Identifier moduleName,
Identifier typeName, LoadedLibraryPlugin *plugin) {
#if SWIFT_BUILD_SWIFT_SYNTAX
/// Look for the type metadata given the external module and type names.
auto macroMetatype = lookupMacroTypeMetadataByExternalName(
ctx, moduleName.str(), typeName.str(), plugin);
if (macroMetatype) {
// Check whether the macro metatype is in-process.
if (auto inProcess = swift_ASTGen_resolveMacroType(macroMetatype)) {
// Make sure we clean up after the macro.
ctx.addCleanup([inProcess]() {
swift_ASTGen_destroyMacro(inProcess);
});
return ExternalMacroDefinition{
ExternalMacroDefinition::PluginKind::InProcess, inProcess};
} else {
NullTerminatedStringRef err(
"'" + moduleName.str() + "." + typeName.str() +
"' is not a valid macro implementation type in library plugin '" +
StringRef(plugin->getLibraryPath()) + "'",
ctx);
return ExternalMacroDefinition::error(err);
}
}
NullTerminatedStringRef err("'" + moduleName.str() + "." + typeName.str() +
"' could not be found in library plugin '" +
StringRef(plugin->getLibraryPath()) + "'",
ctx);
return ExternalMacroDefinition::error(err);
#endif
return ExternalMacroDefinition::error(
"the current compiler was not built with macro support");
}
static ExternalMacroDefinition
resolveExecutableMacro(ASTContext &ctx,
LoadedExecutablePlugin *executablePlugin,
Identifier moduleName, Identifier typeName) {
#if SWIFT_BUILD_SWIFT_SYNTAX
if (auto *execMacro = swift_ASTGen_resolveExecutableMacro(
moduleName.get(), typeName.get(), executablePlugin)) {
// Make sure we clean up after the macro.
ctx.addCleanup(
[execMacro]() { swift_ASTGen_destroyExecutableMacro(execMacro); });
return ExternalMacroDefinition{
ExternalMacroDefinition::PluginKind::Executable, execMacro};
}
// NOTE: this is not reachable because executable macro resolution always
// succeeds.
NullTerminatedStringRef err(
"'" + moduleName.str() + "." + typeName.str() +
"' could not be found in executable plugin" +
StringRef(executablePlugin->getExecutablePath()),
ctx);
return ExternalMacroDefinition::error(err);
#endif
return ExternalMacroDefinition::error(
"the current compiler was not built with macro support");
}
ExternalMacroDefinition
ExternalMacroDefinitionRequest::evaluate(Evaluator &evaluator, ASTContext *ctx,
Identifier moduleName,
Identifier typeName) const {
// Try to load a plugin module from the plugin search paths. If it
// succeeds, resolve in-process from that plugin
CompilerPluginLoadRequest loadRequest{ctx, moduleName};
CompilerPluginLoadResult loaded = evaluateOrDefault(
evaluator, loadRequest, CompilerPluginLoadResult::error("request error"));
if (auto loadedLibrary = loaded.getAsLibraryPlugin()) {
return resolveInProcessMacro(*ctx, moduleName, typeName, loadedLibrary);
}
if (auto *executablePlugin = loaded.getAsExecutablePlugin()) {
return resolveExecutableMacro(*ctx, executablePlugin, moduleName, typeName);
}
return ExternalMacroDefinition::error(loaded.getErrorMessage());
}
/// Adjust the given mangled name for a macro expansion to produce a valid
/// buffer name.
static std::string adjustMacroExpansionBufferName(StringRef name) {
if (name.empty()) {
return "<macro-expansion>";
}
std::string result;
if (name.startswith(MANGLING_PREFIX_STR)) {
result += MACRO_EXPANSION_BUFFER_MANGLING_PREFIX;
name = name.drop_front(StringRef(MANGLING_PREFIX_STR).size());
}
result += name;
result += ".swift";
return result;
}
llvm::Optional<unsigned>
ExpandMacroExpansionExprRequest::evaluate(Evaluator &evaluator,
MacroExpansionExpr *mee) const {
ConcreteDeclRef macroRef = mee->getMacroRef();
assert(macroRef && isa<MacroDecl>(macroRef.getDecl()) &&
"MacroRef should be set before expansion");
auto *macro = cast<MacroDecl>(macroRef.getDecl());
if (macro->getMacroRoles().contains(MacroRole::Expression)) {
return expandMacroExpr(mee);
}
// For a non-expression macro, expand it as a declaration.
else if (macro->getMacroRoles().contains(MacroRole::Declaration) ||
macro->getMacroRoles().contains(MacroRole::CodeItem)) {
if (!mee->getSubstituteDecl()) {
(void)mee->createSubstituteDecl();
}
// Return the expanded buffer ID.
return evaluateOrDefault(
evaluator, ExpandMacroExpansionDeclRequest(mee->getSubstituteDecl()),
llvm::None);
}
// Other macro roles may also be encountered here, as they use
// `MacroExpansionExpr` for resolution. In those cases, do not expand.
return llvm::None;
}
ArrayRef<unsigned> ExpandMemberAttributeMacros::evaluate(Evaluator &evaluator,
Decl *decl) const {
if (decl->isImplicit())
return { };
// Member attribute macros do not apply to macro-expanded members.
if (decl->isInMacroExpansionInContext())
return { };
auto *parentDecl = decl->getDeclContext()->getAsDecl();
if (!parentDecl || !isa<IterableDeclContext>(parentDecl))
return { };
if (isa<PatternBindingDecl>(decl))
return { };
SmallVector<unsigned, 2> bufferIDs;
parentDecl->forEachAttachedMacro(MacroRole::MemberAttribute,
[&](CustomAttr *attr, MacroDecl *macro) {
if (auto bufferID = expandAttributes(attr, macro, decl))
bufferIDs.push_back(*bufferID);
});
return parentDecl->getASTContext().AllocateCopy(bufferIDs);
}
ArrayRef<unsigned> ExpandSynthesizedMemberMacroRequest::evaluate(
Evaluator &evaluator, Decl *decl
) const {
SmallVector<unsigned, 2> bufferIDs;
decl->forEachAttachedMacro(MacroRole::Member,
[&](CustomAttr *attr, MacroDecl *macro) {
if (auto bufferID = expandMembers(attr, macro, decl))
bufferIDs.push_back(*bufferID);
});
return decl->getASTContext().AllocateCopy(bufferIDs);
}
ArrayRef<unsigned>
ExpandPeerMacroRequest::evaluate(Evaluator &evaluator, Decl *decl) const {
SmallVector<unsigned, 2> bufferIDs;
decl->forEachAttachedMacro(MacroRole::Peer,
[&](CustomAttr *attr, MacroDecl *macro) {
if (auto bufferID = expandPeers(attr, macro, decl))
bufferIDs.push_back(*bufferID);
});
return decl->getASTContext().AllocateCopy(bufferIDs);
}
static Identifier makeIdentifier(ASTContext &ctx, StringRef name) {
return ctx.getIdentifier(name);
}
static Identifier makeIdentifier(ASTContext &ctx, std::nullptr_t) {
return Identifier();
}
bool swift::isInvalidAttachedMacro(MacroRole role,
Decl *attachedTo) {
switch (role) {
case MacroRole::Expression:
case MacroRole::Declaration:
case MacroRole::CodeItem:
llvm_unreachable("Invalid macro role for attached macro");
case MacroRole::Accessor:
// Only var decls and subscripts have accessors.
if (isa<AbstractStorageDecl>(attachedTo) && !isa<ParamDecl>(attachedTo))
return false;
break;
case MacroRole::MemberAttribute:
case MacroRole::Member:
// Nominal types and extensions can have members.
if (isa<NominalTypeDecl>(attachedTo) || isa<ExtensionDecl>(attachedTo))
return false;
break;
case MacroRole::Peer:
// Peer macros are allowed on everything except parameters.
if (!isa<ParamDecl>(attachedTo))
return false;
break;
case MacroRole::Conformance:
case MacroRole::Extension:
// Only primary declarations of nominal types
if (isa<NominalTypeDecl>(attachedTo))
return false;
break;
}
return true;
}
static void diagnoseInvalidDecl(Decl *decl,
MacroDecl *macro,
llvm::function_ref<bool(DeclName)> coversName) {
auto &ctx = decl->getASTContext();
// Diagnose invalid declaration kinds.
if (isa<ImportDecl>(decl) ||
isa<OperatorDecl>(decl) ||
isa<PrecedenceGroupDecl>(decl) ||
isa<MacroDecl>(decl) ||
isa<ExtensionDecl>(decl)) {
decl->diagnose(diag::invalid_decl_in_macro_expansion,
decl->getDescriptiveKind());
decl->setInvalid();
if (auto *extension = dyn_cast<ExtensionDecl>(decl)) {
extension->setExtendedNominal(nullptr);
}
return;
}
// Diagnose `@main` types.
if (auto *mainAttr = decl->getAttrs().getAttribute<MainTypeAttr>()) {
ctx.Diags.diagnose(mainAttr->getLocation(),
diag::invalid_main_type_in_macro_expansion);
mainAttr->setInvalid();
}
// Diagnose default literal type overrides.
if (auto *typeAlias = dyn_cast<TypeAliasDecl>(decl)) {
auto name = typeAlias->getBaseIdentifier();
#define EXPRESSIBLE_BY_LITERAL_PROTOCOL_WITH_NAME(_, __, typeName, \
supportsOverride) \
if (supportsOverride && name == makeIdentifier(ctx, typeName)) { \
typeAlias->diagnose(diag::literal_type_in_macro_expansion, \
makeIdentifier(ctx, typeName)); \
typeAlias->setInvalid(); \
return; \
}
#include "swift/AST/KnownProtocols.def"
#undef EXPRESSIBLE_BY_LITERAL_PROTOCOL_WITH_NAME
}
// Diagnose value decls with names not covered by the macro
if (auto *value = dyn_cast<ValueDecl>(decl)) {
auto name = value->getName();
// Unique names are always permitted.
if (MacroDecl::isUniqueMacroName(name.getBaseName().userFacingName()))
return;
if (coversName(name)) {
return;
}
value->diagnose(diag::invalid_macro_introduced_name,
name, macro->getBaseName());
}
}
/// Diagnose macro expansions that produce any of the following declarations:
/// - Import declarations
/// - Operator and precedence group declarations
/// - Macro declarations
/// - Extensions
/// - Types with `@main` attributes
/// - Top-level default literal type overrides
/// - Value decls with names not covered by the macro declaration.
static void validateMacroExpansion(SourceFile *expansionBuffer,
MacroDecl *macro,
ValueDecl *attachedTo,
MacroRole role) {
// Gather macro-introduced names
llvm::SmallVector<DeclName, 2> introducedNames;
macro->getIntroducedNames(role, attachedTo, introducedNames);
llvm::SmallDenseSet<DeclName, 2> introducedNameSet(
introducedNames.begin(), introducedNames.end());
auto coversName = [&](DeclName name) -> bool {
return (introducedNameSet.count(name) ||
introducedNameSet.count(name.getBaseName()) ||
introducedNameSet.count(MacroDecl::getArbitraryName()));
};
for (auto item : expansionBuffer->getTopLevelItems()) {
auto *decl = item.dyn_cast<Decl *>();
if (!decl) {
if (role != MacroRole::CodeItem) {
auto &ctx = expansionBuffer->getASTContext();
ctx.Diags.diagnose(item.getStartLoc(),
diag::expected_macro_expansion_decls);
}
continue;
}
// Certain macro roles can generate special declarations.
if ((isa<AccessorDecl>(decl) && role == MacroRole::Accessor) ||
(isa<ExtensionDecl>(decl) && role == MacroRole::Conformance)) {
continue;
}
if (role == MacroRole::Extension) {
auto *extension = dyn_cast<ExtensionDecl>(decl);
for (auto *member : extension->getMembers()) {
diagnoseInvalidDecl(member, macro, coversName);
}
continue;
}
diagnoseInvalidDecl(decl, macro, coversName);
}
}
/// Determine whether the given source file is from an expansion of the given
/// macro.
static bool isFromExpansionOfMacro(SourceFile *sourceFile, MacroDecl *macro,
MacroRole role) {
while (sourceFile) {
auto expansion = sourceFile->getMacroExpansion();
if (!expansion)
return false;
if (auto expansionExpr = dyn_cast_or_null<MacroExpansionExpr>(
expansion.dyn_cast<Expr *>())) {
if (expansionExpr->getMacroRef().getDecl() == macro)
return true;
} else if (auto expansionDecl = dyn_cast_or_null<MacroExpansionDecl>(
expansion.dyn_cast<Decl *>())) {
if (expansionDecl->getMacroRef().getDecl() == macro)
return true;
} else if (auto *macroAttr = sourceFile->getAttachedMacroAttribute()) {
auto *decl = expansion.dyn_cast<Decl *>();
auto *macroDecl = decl->getResolvedMacro(macroAttr);
if (!macroDecl)
return false;
return macroDecl == macro &&
sourceFile->getFulfilledMacroRole() == role;
} else {
llvm_unreachable("Unknown macro expansion node kind");
}
sourceFile = sourceFile->getEnclosingSourceFile();
}
return false;
}
/// Expand a macro definition.
static std::string expandMacroDefinition(
ExpandedMacroDefinition def, MacroDecl *macro, ArgumentList *args) {
ASTContext &ctx = macro->getASTContext();
std::string expandedResult;
StringRef originalText = def.getExpansionText();
unsigned startIdx = 0;
for (const auto replacement: def.getReplacements()) {
// Add the original text up to the first replacement.
expandedResult.append(
originalText.begin() + startIdx,
originalText.begin() + replacement.startOffset);
// Add the replacement text.
auto argExpr = args->getArgExprs()[replacement.parameterIndex];
SmallString<32> argTextBuffer;
auto argText = extractInlinableText(ctx.SourceMgr, argExpr, argTextBuffer);
expandedResult.append(argText);
// Update the starting position.
startIdx = replacement.endOffset;
}
// Add the remaining text.
expandedResult.append(
originalText.begin() + startIdx,
originalText.end());
return expandedResult;
}
static GeneratedSourceInfo::Kind getGeneratedSourceInfoKind(MacroRole role) {
switch (role) {
case MacroRole::Expression:
return GeneratedSourceInfo::ExpressionMacroExpansion;
case MacroRole::Declaration:
case MacroRole::CodeItem:
return GeneratedSourceInfo::FreestandingDeclMacroExpansion;
case MacroRole::Accessor:
return GeneratedSourceInfo::AccessorMacroExpansion;
case MacroRole::MemberAttribute:
return GeneratedSourceInfo::MemberAttributeMacroExpansion;
case MacroRole::Member:
return GeneratedSourceInfo::MemberMacroExpansion;
case MacroRole::Peer:
return GeneratedSourceInfo::PeerMacroExpansion;
case MacroRole::Conformance:
return GeneratedSourceInfo::ConformanceMacroExpansion;
case MacroRole::Extension:
return GeneratedSourceInfo::ExtensionMacroExpansion;
}
llvm_unreachable("unhandled MacroRole");
}
// If this storage declaration is a variable with an explicit initializer,
// return the range from the `=` to the end of the explicit initializer.
static llvm::Optional<SourceRange>
getExplicitInitializerRange(AbstractStorageDecl *storage) {
auto var = dyn_cast<VarDecl>(storage);
if (!var)
return llvm::None;
auto pattern = var->getParentPatternBinding();
if (!pattern)
return llvm::None;
unsigned index = pattern->getPatternEntryIndexForVarDecl(var);
SourceLoc equalLoc = pattern->getEqualLoc(index);
SourceRange initRange = pattern->getOriginalInitRange(index);
if (equalLoc.isInvalid() || initRange.End.isInvalid())
return llvm::None;
return SourceRange(equalLoc, initRange.End);
}
static CharSourceRange getExpansionInsertionRange(MacroRole role,
ASTNode target,
SourceManager &sourceMgr) {
switch (role) {
case MacroRole::Accessor: {
auto storage = cast<AbstractStorageDecl>(target.get<Decl *>());
auto bracesRange = storage->getBracesRange();
// Compute the location where the accessors will be added.
if (bracesRange.Start.isValid()) {
// We have braces already, so insert them inside the leading '{'.
return CharSourceRange(
Lexer::getLocForEndOfToken(sourceMgr, bracesRange.Start), 0);
} else if (auto initRange = getExplicitInitializerRange(storage)) {
// The accessor had an initializer, so the initializer (including
// the `=`) is replaced by the accessors.
return Lexer::getCharSourceRangeFromSourceRange(sourceMgr, *initRange);
} else {
// The accessors go at the end.
SourceLoc endLoc = storage->getEndLoc();
if (auto var = dyn_cast<VarDecl>(storage)) {
if (auto pattern = var->getParentPattern())
endLoc = pattern->getEndLoc();
}
return CharSourceRange(Lexer::getLocForEndOfToken(sourceMgr, endLoc), 0);
}
}
case MacroRole::MemberAttribute: {
SourceLoc startLoc;
if (auto valueDecl = dyn_cast<ValueDecl>(target.get<Decl *>()))
startLoc = valueDecl->getAttributeInsertionLoc(/*forModifier=*/false);
else
startLoc = target.getStartLoc();
return CharSourceRange(startLoc, 0);
}
case MacroRole::Member: {
// Semantically, we insert members right before the closing brace.
SourceLoc rightBraceLoc;
if (auto nominal = dyn_cast<NominalTypeDecl>(target.get<Decl *>())) {
rightBraceLoc = nominal->getBraces().End;
} else {
auto ext = cast<ExtensionDecl>(target.get<Decl *>());
rightBraceLoc = ext->getBraces().End;
}
return CharSourceRange(rightBraceLoc, 0);
}
case MacroRole::Peer: {
SourceLoc endLoc = target.getEndLoc();
if (auto var = dyn_cast<VarDecl>(target.get<Decl *>())) {
if (auto binding = var->getParentPatternBinding())
endLoc = binding->getEndLoc();
}
SourceLoc afterDeclLoc = Lexer::getLocForEndOfToken(sourceMgr, endLoc);
return CharSourceRange(afterDeclLoc, 0);
break;
}
case MacroRole::Conformance: {
SourceLoc afterDeclLoc =
Lexer::getLocForEndOfToken(sourceMgr, target.getEndLoc());
return CharSourceRange(afterDeclLoc, 0);
}
case MacroRole::Extension: {
SourceLoc afterDeclLoc =
Lexer::getLocForEndOfToken(sourceMgr, target.getEndLoc());
return CharSourceRange(afterDeclLoc, 0);
}
case MacroRole::Expression:
case MacroRole::Declaration:
case MacroRole::CodeItem:
return Lexer::getCharSourceRangeFromSourceRange(sourceMgr,
target.getSourceRange());
}
llvm_unreachable("unhandled MacroRole");
}
static SourceFile *
createMacroSourceFile(std::unique_ptr<llvm::MemoryBuffer> buffer,
MacroRole role, ASTNode target, DeclContext *dc,
CustomAttr *attr) {
ASTContext &ctx = dc->getASTContext();
SourceManager &sourceMgr = ctx.SourceMgr;
// Dump macro expansions to standard output, if requested.
if (ctx.LangOpts.DumpMacroExpansions) {
llvm::errs() << buffer->getBufferIdentifier()
<< "\n------------------------------\n"
<< buffer->getBuffer()
<< "\n------------------------------\n";
}
CharSourceRange generatedOriginalSourceRange =
getExpansionInsertionRange(role, target, sourceMgr);
GeneratedSourceInfo::Kind generatedSourceKind =
getGeneratedSourceInfoKind(role);
// Create a new source buffer with the contents of the expanded macro.
unsigned macroBufferID = sourceMgr.addNewSourceBuffer(std::move(buffer));
auto macroBufferRange = sourceMgr.getRangeForBuffer(macroBufferID);
GeneratedSourceInfo sourceInfo{generatedSourceKind,
generatedOriginalSourceRange,
macroBufferRange,
target.getOpaqueValue(),
dc,
attr};
sourceMgr.setGeneratedSourceInfo(macroBufferID, sourceInfo);
// Create a source file to hold the macro buffer. This is automatically
// registered with the enclosing module.
auto macroSourceFile = new (ctx) SourceFile(
*dc->getParentModule(), SourceFileKind::MacroExpansion, macroBufferID,
/*parsingOpts=*/{}, /*isPrimary=*/false);
macroSourceFile->setImports(dc->getParentSourceFile()->getImports());
return macroSourceFile;
}
#if SWIFT_BUILD_SWIFT_SYNTAX
static uint8_t getRawMacroRole(MacroRole role) {
switch (role) {
case MacroRole::Expression: return 0;
case MacroRole::Declaration: return 1;
case MacroRole::Accessor: return 2;
case MacroRole::MemberAttribute: return 3;
case MacroRole::Member: return 4;
case MacroRole::Peer: return 5;
case MacroRole::CodeItem: return 7;
// Use the same raw macro role for conformance and extension
// in ASTGen.
case MacroRole::Conformance:
case MacroRole::Extension: return 8;
}
}
#endif // SWIFT_BUILD_SWIFT_SYNTAX
/// Evaluate the given freestanding macro expansion.
static SourceFile *
evaluateFreestandingMacro(FreestandingMacroExpansion *expansion,
StringRef discriminatorStr = "") {
auto *dc = expansion->getDeclContext();
ASTContext &ctx = dc->getASTContext();
SourceLoc loc = expansion->getPoundLoc();
auto moduleDecl = dc->getParentModule();
auto sourceFile = moduleDecl->getSourceFileContainingLocation(loc);
if (!sourceFile)
return nullptr;
MacroDecl *macro = cast<MacroDecl>(expansion->getMacroRef().getDecl());
auto macroRoles = macro->getMacroRoles();
assert(macroRoles.contains(MacroRole::Expression) ||
macroRoles.contains(MacroRole::Declaration) ||
macroRoles.contains(MacroRole::CodeItem));
if (isFromExpansionOfMacro(sourceFile, macro, MacroRole::Expression) ||
isFromExpansionOfMacro(sourceFile, macro, MacroRole::Declaration) ||