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
|
//===----- ModuleInterfaceBuilder.h - Compiles .swiftinterface files ------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2019 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_FRONTEND_MODULEINTERFACEBUILDER_H
#define SWIFT_FRONTEND_MODULEINTERFACEBUILDER_H
#include "swift/AST/ModuleLoader.h"
#include "swift/Basic/LLVM.h"
#include "swift/Basic/SourceLoc.h"
#include "swift/Frontend/Frontend.h"
#include "swift/Serialization/SerializationOptions.h"
#include "llvm/Support/StringSaver.h"
namespace llvm {
namespace vfs {
class FileSystem;
}
} // namespace llvm
namespace swift {
class DiagnosticEngine;
class LangOptions;
class SearchPathOptions;
class DependencyTracker;
/// A utility class to build a Swift interface file into a module
/// using a `CompilerInstance` constructed from the flags specified in the
/// interface file.
class ImplicitModuleInterfaceBuilder {
SourceManager &sourceMgr;
DiagnosticEngine *diags;
InterfaceSubContextDelegate &subASTDelegate;
const StringRef interfacePath;
const StringRef sdkPath;
const StringRef moduleName;
const StringRef moduleCachePath;
const StringRef prebuiltCachePath;
const StringRef backupInterfaceDir;
const StringRef ABIDescriptorPath;
const bool disableInterfaceFileLock;
const bool silenceInterfaceDiagnostics;
const SourceLoc diagnosticLoc;
DependencyTracker *const dependencyTracker;
SmallVector<StringRef, 3> extraDependencies;
public:
/// Emit a diagnostic tied to this declaration.
template <typename... ArgTypes>
static InFlightDiagnostic
diagnose(DiagnosticEngine *Diags, SourceManager &SM, StringRef InterfacePath,
SourceLoc Loc, Diag<ArgTypes...> ID,
typename detail::PassArgument<ArgTypes>::type... Args) {
if (Loc.isInvalid()) {
// Diagnose this inside the interface file, if possible.
Loc = SM.getLocFromExternalSource(InterfacePath, 1, 1);
}
return Diags->diagnose(Loc, ID, std::move(Args)...);
}
private:
/// Emit a diagnostic tied to this declaration.
template <typename... ArgTypes>
InFlightDiagnostic
diagnose(Diag<ArgTypes...> ID,
typename detail::PassArgument<ArgTypes>::type... Args) const {
return diagnose(diags, sourceMgr, interfacePath, diagnosticLoc, ID,
std::move(Args)...);
}
bool
buildSwiftModuleInternal(StringRef OutPath, bool ShouldSerializeDeps,
std::unique_ptr<llvm::MemoryBuffer> *ModuleBuffer,
ArrayRef<std::string> CandidateModules);
public:
ImplicitModuleInterfaceBuilder(
SourceManager &sourceMgr, DiagnosticEngine *diags,
InterfaceSubContextDelegate &subASTDelegate,
StringRef interfacePath, StringRef sdkPath,
StringRef moduleName, StringRef moduleCachePath,
StringRef backupInterfaceDir, StringRef prebuiltCachePath,
StringRef ABIDescriptorPath, bool disableInterfaceFileLock = false,
bool silenceInterfaceDiagnostics = false,
SourceLoc diagnosticLoc = SourceLoc(),
DependencyTracker *tracker = nullptr)
: sourceMgr(sourceMgr), diags(diags), subASTDelegate(subASTDelegate),
interfacePath(interfacePath), sdkPath(sdkPath), moduleName(moduleName),
moduleCachePath(moduleCachePath), prebuiltCachePath(prebuiltCachePath),
backupInterfaceDir(backupInterfaceDir),
ABIDescriptorPath(ABIDescriptorPath),
disableInterfaceFileLock(disableInterfaceFileLock),
silenceInterfaceDiagnostics(silenceInterfaceDiagnostics),
diagnosticLoc(diagnosticLoc), dependencyTracker(tracker) {}
/// Ensures the requested file name is added as a dependency of the resulting
/// module.
void addExtraDependency(StringRef path) { extraDependencies.push_back(path); }
bool buildSwiftModule(StringRef OutPath, bool ShouldSerializeDeps,
std::unique_ptr<llvm::MemoryBuffer> *ModuleBuffer,
llvm::function_ref<void()> RemarkRebuild = nullptr,
ArrayRef<std::string> CandidateModules = {});
};
/// Use the provided `CompilerInstance` to build a swift interface into a module
class ExplicitModuleInterfaceBuilder {
public:
ExplicitModuleInterfaceBuilder(CompilerInstance &Instance,
DiagnosticEngine *diags,
SourceManager &sourceMgr,
const StringRef moduleCachePath,
const StringRef backupInterfaceDir,
const StringRef prebuiltCachePath,
const StringRef ABIDescriptorPath,
const SmallVector<StringRef, 3> &extraDependencies,
SourceLoc diagnosticLoc = SourceLoc(),
DependencyTracker *tracker = nullptr)
: Instance(Instance),
diags(diags),
sourceMgr(sourceMgr),
moduleCachePath(moduleCachePath),
prebuiltCachePath(prebuiltCachePath),
backupInterfaceDir(backupInterfaceDir),
ABIDescriptorPath(ABIDescriptorPath),
extraDependencies(extraDependencies),
diagnosticLoc(diagnosticLoc),
dependencyTracker(tracker) {}
std::error_code buildSwiftModuleFromInterface(
StringRef interfacePath, StringRef outputPath, bool ShouldSerializeDeps,
std::unique_ptr<llvm::MemoryBuffer> *ModuleBuffer,
ArrayRef<std::string> CompiledCandidates,
StringRef CompilerVersion);
/// Populate the provided \p Deps with \c FileDependency entries for all
/// dependencies \p SubInstance's DependencyTracker recorded while compiling
/// the module, excepting .swiftmodules in \p moduleCachePath or
/// \p prebuiltCachePath. Those have _their_ dependencies added instead, both
/// to avoid having to do recursive scanning when rechecking this dependency
/// in future and to make the module caches relocatable.
bool collectDepsForSerialization(
SmallVectorImpl<SerializationOptions::FileDependency> &Deps,
StringRef interfacePath, bool IsHashBased);
/// Emit a diagnostic tied to this declaration.
template <typename... ArgTypes>
static InFlightDiagnostic
diagnose(DiagnosticEngine *Diags, SourceManager &SM, StringRef InterfacePath,
SourceLoc Loc, Diag<ArgTypes...> ID,
typename detail::PassArgument<ArgTypes>::type... Args) {
if (Loc.isInvalid()) {
// Diagnose this inside the interface file, if possible.
Loc = SM.getLocFromExternalSource(InterfacePath, 1, 1);
}
return Diags->diagnose(Loc, ID, std::move(Args)...);
}
private:
/// Emit a diagnostic tied to this declaration.
template<typename ...ArgTypes>
InFlightDiagnostic diagnose(
Diag<ArgTypes...> ID,
StringRef InterfacePath,
typename detail::PassArgument<ArgTypes>::type... Args) const {
return diagnose(diags, sourceMgr, InterfacePath, diagnosticLoc,
ID, std::move(Args)...);
}
private:
CompilerInstance &Instance;
DiagnosticEngine *diags;
SourceManager &sourceMgr;
StringRef moduleCachePath;
StringRef prebuiltCachePath;
StringRef backupInterfaceDir;
StringRef ABIDescriptorPath;
const SmallVector<StringRef, 3> extraDependencies;
const SourceLoc diagnosticLoc;
DependencyTracker *const dependencyTracker;
};
} // end namespace swift
#endif // defined(SWIFT_FRONTEND_MODULEINTERFACEBUILDER_H)
|
