mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
d5d00011f3
* treat children of underscored protocols as public Children of underscored protocols should be treated as native children of their conforming types. To accomplish this, ignore underscored protocols in the isInherentlyPrivate check. rdar://124483146 * include underscored protocol methods even when skipping protocols rdar://128143861
103 lines
3.0 KiB
C++
103 lines
3.0 KiB
C++
//===--- 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());
|
|
});
|
|
}
|
|
});
|
|
}
|