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
|
//===--- MetadataObjectBuilder.h -------------------------------*- C++ -*--===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2022 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
//
//===----------------------------------------------------------------------===//
//
// Defines routines for use with ObjectBuilder that are specifically
// useful for building metadata objects.
//
//===----------------------------------------------------------------------===//
#ifndef METADATA_OBJECT_BUILDER_H
#define METADATA_OBJECT_BUILDER_H
#include "ObjectBuilder.h"
#include "SpecifierDSL.h"
#include "swift/ABI/Metadata.h"
#include <sstream>
#include <type_traits>
namespace swift {
using namespace specifierDSL;
/// Add a simple ModuleContextDescriptor with the given name.
inline void addModuleContextDescriptor(AnyObjectBuilder &builder,
StringRef moduleName) {
// Context descriptor flags
auto contextFlags = ContextDescriptorFlags(ContextDescriptorKind::Module,
/*generic*/ false,
/*unique*/ true,
/*hasInvertibleProtocols*/ false,
/*kindSpecific*/ 0);
builder.add32(contextFlags.getIntValue());
// Parent
builder.add32(0);
// Name
builder.addRelativeReferenceToString(moduleName);
}
/// Add a simple ProtocolDescriptor with the given base protocols
/// but no other requirements.
inline void addProtocolDescriptor(AnyObjectBuilder &builder,
const ModuleContextDescriptor *module,
StringRef protocolName,
llvm::ArrayRef<ProtocolSpecifier> baseProtocols) {
// Context descriptor flags
auto contextFlags = ContextDescriptorFlags(ContextDescriptorKind::Protocol,
/*generic*/ false,
/*unique*/ true,
/*hasInvertibleProtocols*/ false,
/*kindSpecific*/ 0);
builder.add32(contextFlags.getIntValue());
// Parent
builder.addRelativeIndirectReference(module, /*addend*/ 1);
// Name
builder.addRelativeReferenceToString(protocolName);
// NumRequirementsInSignature
builder.add32(baseProtocols.size());
// NumRequirements
builder.add32(baseProtocols.size());
// Associated type names
builder.add32(0);
ObjectRef<const char> selfType;
if (!baseProtocols.empty()) {
selfType = createMangledTypeString(builder, typeParam(0, 0));
}
// Requirement signature requirement descriptors
for (auto &baseProtocol : baseProtocols) {
addConformanceRequirement(builder, selfType, baseProtocol);
}
// Protocol requirement descriptors
for (auto baseProtocol : baseProtocols) {
(void) baseProtocol; // Requirements don't actually collect specifics here
// Flags
auto flags = ProtocolRequirementFlags(
ProtocolRequirementFlags::Kind::BaseProtocol);
builder.add32(flags.getIntValue());
// Default implementation
builder.add32(0);
}
}
template <class T>
class GlobalObjectBuilder {
ObjectBuilder<T> builder;
public:
template <class Fn>
GlobalObjectBuilder(Fn &&fn) {
std::forward<Fn>(fn)(builder);
(void) builder.finish();
}
const T *get() const { return builder.get(); }
};
/// Build a global object with the given lambda.
///
/// This uses a static local to magically cache and preserve the
/// global object. This global caching is uniqued by the template
/// arguments to this function, so callers should not re-use lambdas
/// for different calls.
template <class T, class Fn>
inline const T *buildGlobalObject(Fn &&fn) {
static const GlobalObjectBuilder<T> builder(std::forward<Fn>(fn));
return builder.get();
}
/// Build a global ModuleContextDescriptor with the name returned by the
/// given lambda.
///
/// This uses a static local to magically cache and preserve the
/// global object. This global caching is uniqued by the template
/// arguments to this function, so callers should not re-use lambdas
/// for different calls.
template <class Fn>
inline const ModuleContextDescriptor *
buildGlobalModuleContextDescriptor(Fn &&fn) {
static const GlobalObjectBuilder<ModuleContextDescriptor> builder(
[&](AnyObjectBuilder &builder) {
addModuleContextDescriptor(builder, std::forward<Fn>(fn)());
});
return builder.get();
}
/// Build a global protocol descriptor for an empty protocol with
/// the name returned by the given lambda.
///
/// This uses a static local to magically cache and preserve the
/// global object. This global caching is uniqued by the template
/// arguments to this function, so callers should not re-use lambdas
/// for different calls.
template <class Fn>
inline const ProtocolDescriptor *
buildGlobalProtocolDescriptor(const ModuleContextDescriptor *module, Fn &&fn) {
static const GlobalObjectBuilder<ProtocolDescriptor> builder(
[&](AnyObjectBuilder &builder) {
addProtocolDescriptor(builder, module, std::forward<Fn>(fn)(), {});
});
return builder.get();
}
} // end namespace swift
#endif
|
