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
|
//===--- APIGen.cpp - Swift API Generation --------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// This file implements the entrypoints into API file generation.
//
//===----------------------------------------------------------------------===//
#include "llvm/ADT/StringSwitch.h"
#include "llvm/Support/JSON.h"
#include "llvm/Support/raw_ostream.h"
#include "APIGen.h"
namespace swift {
namespace apigen {
void API::addSymbol(StringRef symbol, APILoc loc, APILinkage linkage,
APIFlags flags, APIAccess access,
APIAvailability availability) {
auto *global = new (allocator) GlobalRecord(
symbol, loc, linkage, flags, access, GVKind::Function, availability);
globals.push_back(global);
}
ObjCInterfaceRecord *API::addObjCClass(StringRef name, APILinkage linkage,
APILoc loc, APIAccess access,
APIAvailability availability,
StringRef superClassName) {
auto *interface = new (allocator) ObjCInterfaceRecord(
name, linkage, loc, access, availability, superClassName);
interfaces.push_back(interface);
return interface;
}
ObjCCategoryRecord *API::addObjCCategory(StringRef name, APILinkage linkage,
APILoc loc, APIAccess access,
APIAvailability availability,
StringRef interface) {
auto *category = new (allocator)
ObjCCategoryRecord(name, linkage, loc, access, availability, interface);
categories.push_back(category);
return category;
}
void API::addObjCMethod(ObjCContainerRecord *record, StringRef name, APILoc loc,
APIAccess access, bool isInstanceMethod,
bool isOptional, APIAvailability availability) {
auto method = new (allocator) ObjCMethodRecord(
name, loc, access, isInstanceMethod, isOptional, availability);
record->methods.push_back(method);
}
static void serialize(llvm::json::OStream &OS, APIAccess access) {
switch (access) {
case APIAccess::Public:
OS.attribute("access", "public");
break;
case APIAccess::Private:
OS.attribute("access", "private");
break;
case APIAccess::Project:
OS.attribute("access", "project");
break;
case APIAccess::Unknown:
break;
}
}
static void serialize(llvm::json::OStream &OS, APIAvailability availability) {
if (availability.empty())
return;
if (!availability.introduced.empty())
OS.attribute("introduced", availability.introduced);
if (!availability.obsoleted.empty())
OS.attribute("obsoleted", availability.obsoleted);
if (availability.unavailable)
OS.attribute("unavailable", availability.unavailable);
}
static void serialize(llvm::json::OStream &OS, APILinkage linkage) {
switch (linkage) {
case APILinkage::Exported:
OS.attribute("linkage", "exported");
break;
case APILinkage::Reexported:
OS.attribute("linkage", "re-exported");
break;
case APILinkage::Internal:
OS.attribute("linkage", "internal");
break;
case APILinkage::External:
OS.attribute("linkage", "external");
break;
case APILinkage::Unknown:
// do nothing;
break;
}
}
static void serialize(llvm::json::OStream &OS, APILoc loc) {
OS.attribute("file", loc.getFilename());
}
static void serialize(llvm::json::OStream &OS, const GlobalRecord &record) {
OS.object([&]() {
OS.attribute("name", record.name);
serialize(OS, record.access);
serialize(OS, record.loc);
serialize(OS, record.linkage);
serialize(OS, record.availability);
});
}
static void serialize(llvm::json::OStream &OS, const ObjCMethodRecord &record) {
OS.object([&]() {
OS.attribute("name", record.name);
serialize(OS, record.access);
serialize(OS, record.loc);
serialize(OS, record.linkage);
serialize(OS, record.availability);
if (record.isOptional)
OS.attribute("optional", record.isOptional);
});
}
static bool sortAPIRecords(const APIRecord *base, const APIRecord *compare) {
return base->name < compare->name;
}
static void serialize(llvm::json::OStream &OS,
const ObjCInterfaceRecord &record) {
OS.object([&]() {
OS.attribute("name", record.name);
serialize(OS, record.access);
serialize(OS, record.loc);
serialize(OS, record.linkage);
serialize(OS, record.availability);
OS.attribute("super", record.superClassName);
OS.attributeArray("instanceMethods", [&]() {
for (auto &method : record.methods) {
if (method->isInstanceMethod)
serialize(OS, *method);
}
});
OS.attributeArray("classMethods", [&]() {
for (auto &method : record.methods) {
if (!method->isInstanceMethod)
serialize(OS, *method);
}
});
});
}
static void serialize(llvm::json::OStream &OS,
const ObjCCategoryRecord &record) {
OS.object([&]() {
OS.attribute("name", record.name);
serialize(OS, record.access);
serialize(OS, record.loc);
serialize(OS, record.linkage);
serialize(OS, record.availability);
OS.attribute("interface", record.interface);
OS.attributeArray("instanceMethods", [&]() {
for (auto &method : record.methods) {
if (method->isInstanceMethod)
serialize(OS, *method);
}
});
OS.attributeArray("classMethods", [&]() {
for (auto &method : record.methods) {
if (!method->isInstanceMethod)
serialize(OS, *method);
}
});
});
}
void API::writeAPIJSONFile(llvm::raw_ostream &os, bool PrettyPrint) {
unsigned indentSize = PrettyPrint ? 2 : 0;
llvm::json::OStream JSON(os, indentSize);
JSON.object([&]() {
JSON.attribute("target", target.str());
JSON.attributeArray("globals", [&]() {
llvm::sort(globals, sortAPIRecords);
for (const auto *g : globals)
serialize(JSON, *g);
});
JSON.attributeArray("interfaces", [&]() {
llvm::sort(interfaces, sortAPIRecords);
for (const auto *i : interfaces)
serialize(JSON, *i);
});
JSON.attributeArray("categories", [&]() {
llvm::sort(categories, sortAPIRecords);
for (const auto *c : categories)
serialize(JSON, *c);
});
JSON.attribute("version", "1.0");
});
}
} // end namespace apigen
} // end namespace swift
|
