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
|
//===--- APIGen.h - Public interface to APIGen ------------------*- 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_APIGEN_APIGEN_H
#define SWIFT_APIGEN_APIGEN_H
#include "swift/Basic/LLVM.h"
#include "llvm/ADT/BitmaskEnum.h"
#include "llvm/ADT/MapVector.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/StringSet.h"
#include "llvm/Support/Allocator.h"
#include "llvm/Support/Error.h"
#include "llvm/TargetParser/Triple.h"
#include <optional>
namespace llvm {
class raw_ostream;
}
namespace swift {
namespace apigen {
LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE();
enum class APIAccess : uint8_t {
Unknown = 0, // No information about access.
Project = 1, // APIs available within the project.
Private = 2, // Private unstable APIs.
Public = 3, // Public stable APIs.
};
enum class APILinkage : uint8_t {
Unknown = 0, // Unknown.
Internal = 1, // API is internal.
External = 2, // External interface used.
Reexported = 3, // API is re-exported.
Exported = 4, // API is exported.
};
enum class APIFlags : uint8_t {
None = 0,
ThreadLocalValue = 1U << 0,
WeakDefined = 1U << 1,
WeakReferenced = 1U << 2,
LLVM_MARK_AS_BITMASK_ENUM(/*LargestValue=*/WeakReferenced)
};
class APILoc {
public:
APILoc() = default;
APILoc(std::string file, unsigned line, unsigned col)
: file(file), line(line), col(col) {}
StringRef getFilename() const { return file; }
unsigned getLine() const { return line; }
unsigned getColumn() const { return col; }
private:
std::string file;
unsigned line;
unsigned col;
};
struct APIAvailability {
std::string introduced;
std::string obsoleted;
bool unavailable = false;
bool empty() {
return introduced.empty() && obsoleted.empty() && !unavailable;
}
};
struct APIRecord {
std::string name;
APILoc loc;
APILinkage linkage;
APIFlags flags;
APIAccess access;
APIAvailability availability;
APIRecord(StringRef name, APILoc loc, APILinkage linkage, APIFlags flags,
APIAccess access, APIAvailability availability)
: name(name.data(), name.size()), loc(loc), linkage(linkage),
flags(flags), access(access), availability(availability) {}
bool isWeakDefined() const {
return (flags & APIFlags::WeakDefined) == APIFlags::WeakDefined;
}
bool isWeakReferenced() const {
return (flags & APIFlags::WeakReferenced) == APIFlags::WeakReferenced;
}
bool isThreadLocalValue() const {
return (flags & APIFlags::ThreadLocalValue) == APIFlags::ThreadLocalValue;
}
bool isExternal() const { return linkage == APILinkage::External; }
bool isExported() const { return linkage >= APILinkage::Reexported; }
bool isReexported() const { return linkage == APILinkage::Reexported; }
};
enum class GVKind : uint8_t {
Unknown = 0,
Variable = 1,
Function = 2,
};
struct GlobalRecord : APIRecord {
GVKind kind;
GlobalRecord(StringRef name, APILoc loc, APILinkage linkage, APIFlags flags,
APIAccess access, GVKind kind, APIAvailability availability)
: APIRecord(name, loc, linkage, flags, access, availability), kind(kind) {
}
};
struct ObjCMethodRecord : APIRecord {
bool isInstanceMethod;
bool isOptional;
ObjCMethodRecord(StringRef name, APILoc loc, APIAccess access,
bool isInstanceMethod, bool isOptional,
APIAvailability availability)
: APIRecord(name, loc, APILinkage::Unknown, APIFlags::None, access,
availability),
isInstanceMethod(isInstanceMethod), isOptional(isOptional) {}
};
struct ObjCContainerRecord : APIRecord {
std::vector<ObjCMethodRecord*> methods;
ObjCContainerRecord(StringRef name, APILinkage linkage, APILoc loc,
APIAccess access, const APIAvailability &availability)
: APIRecord(name, loc, linkage, APIFlags::None, access, availability) {}
};
struct ObjCInterfaceRecord : ObjCContainerRecord {
std::string superClassName;
ObjCInterfaceRecord(StringRef name, APILinkage linkage, APILoc loc,
APIAccess access, APIAvailability availability,
StringRef superClassName)
: ObjCContainerRecord(name, linkage, loc, access, availability),
superClassName(superClassName.data(), superClassName.size()) {}
};
struct ObjCCategoryRecord : ObjCContainerRecord {
std::string interface;
ObjCCategoryRecord(StringRef name, APILinkage linkage, APILoc loc,
APIAccess access, APIAvailability availability,
StringRef interface)
: ObjCContainerRecord(name, linkage, loc, access, availability),
interface(interface.data(), interface.size()) {}
};
class API {
public:
API(const llvm::Triple &triple) : target(triple) {}
const llvm::Triple &getTarget() const { return target; }
void addSymbol(StringRef symbol, APILoc loc, APILinkage linkage,
APIFlags flags, APIAccess access,
APIAvailability availability);
ObjCInterfaceRecord *addObjCClass(StringRef name, APILinkage linkage,
APILoc loc, APIAccess access,
APIAvailability availability,
StringRef superClassName);
ObjCCategoryRecord *addObjCCategory(StringRef name, APILinkage linkage,
APILoc loc, APIAccess access,
APIAvailability availability,
StringRef interface);
void addObjCMethod(ObjCContainerRecord *record, StringRef name, APILoc loc,
APIAccess access, bool isInstanceMethod, bool isOptional,
APIAvailability availability);
void writeAPIJSONFile(raw_ostream &os, bool PrettyPrint = false);
private:
const llvm::Triple target;
llvm::BumpPtrAllocator allocator;
std::vector<GlobalRecord*> globals;
std::vector<ObjCInterfaceRecord*> interfaces;
std::vector<ObjCCategoryRecord *> categories;
};
} // end namespace apigen
} // end namespace swift
#endif
|
