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
|
//===--- Edge.cpp - Symbol Graph Edge -------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
#include "swift/AST/Module.h"
#include "Edge.h"
#include "Symbol.h"
#include "SymbolGraphASTWalker.h"
#include <queue>
using namespace swift;
using namespace symbolgraphgen;
namespace {
bool parentDeclIsPrivate(const ValueDecl *VD, SymbolGraph *Graph) {
if (!VD)
return false;
auto *ParentDecl = VD->getDeclContext()->getAsDecl();
if (auto *ParentExtension = dyn_cast_or_null<ExtensionDecl>(ParentDecl)) {
if (auto *Nominal = ParentExtension->getExtendedNominal()) {
return Graph->isImplicitlyPrivate(Nominal);
}
}
if (ParentDecl) {
return Graph->isImplicitlyPrivate(ParentDecl);
} else {
return false;
}
}
} // anonymous namespace
void Edge::serialize(llvm::json::OStream &OS) const {
OS.object([&](){
OS.attribute("kind", Kind.Name);
SmallString<256> SourceUSR, TargetUSR;
Source.getUSR(SourceUSR);
OS.attribute("source", SourceUSR.str());
Target.getUSR(TargetUSR);
OS.attribute("target", TargetUSR.str());
// In case a dependent module isn't available, serialize a fallback name.
auto TargetModuleName = Target.getSymbolDecl()
->getModuleContext()->getName().str();
if (TargetModuleName != Graph->M.getName().str()) {
SmallString<128> Scratch(TargetModuleName);
llvm::raw_svector_ostream PathOS(Scratch);
PathOS << '.';
Target.printPath(PathOS);
OS.attribute("targetFallback", Scratch.str());
}
if (ConformanceExtension) {
SmallVector<Requirement, 4> FilteredRequirements;
filterGenericRequirements(
ConformanceExtension->getGenericRequirements(),
ConformanceExtension->getExtendedProtocolDecl(),
FilteredRequirements);
if (!FilteredRequirements.empty()) {
OS.attributeArray("swiftConstraints", [&](){
for (const auto &Req : FilteredRequirements) {
::serialize(Req, OS);
}
});
}
}
const ValueDecl *InheritingDecl = Source.getInheritedDecl();
// If our source symbol is a inheriting decl, write in information about
// where it's inheriting docs from.
if (InheritingDecl && !parentDeclIsPrivate(InheritingDecl, Graph)) {
Symbol inheritedSym(Graph, InheritingDecl, nullptr);
SmallString<256> USR, Display;
llvm::raw_svector_ostream DisplayOS(Display);
inheritedSym.getUSR(USR);
inheritedSym.printPath(DisplayOS);
OS.attributeObject("sourceOrigin", [&](){
OS.attribute("identifier", USR.str());
OS.attribute("displayName", Display.str());
});
}
});
}
|
