Files
swift-mirror/lib/SymbolGraphGen/Edge.cpp
Ashley Garland f0887fa245 [SymbolGraph] Emit synthesized members
Emit copies of default implementations in protocol extensions and superclass declarations in conforming types and subclasses respectively using a virtual USR, i.e. `${REAL_USR}::SYNTHESIZED::${CONFORMING_OR_SUBCLASS_TYPE_USR}`.

- Add a -skip-synthesized-members option to skip these synthesized members.

- Create a new wrapping `Symbol` type that can also contain a base type declaration as well as the inherited declaration for those synthesized cases. Move some symbol-specific APIs there.

- Doc comments can “cascade” down to protocol extensions or refinements in concrete types. When emitting the doc comment for a symbol, look up through to superclasses or protocol requirements for where a doc comment is actually written.

- Clean up filtering of implicitly private (e.g. “public underscored”) types

rdar://problem/59128787
2020-03-04 16:04:21 -08:00

48 lines
1.5 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"
using namespace swift;
using namespace symbolgraphgen;
void Edge::serialize(llvm::json::OStream &OS) const {
OS.object([&](){
OS.attribute("kind", Kind.Name);
if (Kind == RelationshipKind::DefaultImplementationOf() && Source.getSynthesizedBaseTypeDecl()) {
abort();
}
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());
}
});
}