averello/swift-mirror
1
0
Fork 0
mirror of https://github.com/apple/swift.git synced 2025-12-21 12:14:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

[Serialization] Serialize doc comments for extensions. Need this for rdar://25157796

Browse Source 
We did not serialize them because getting USR for extensions is tricky (USRs are
usually for value decls). This commit starts to make up an USR for an extension by combining
the extended nominal's USR with the USR of the first value member of the extension. We use
this made-up USR to associate doc comments when (de)serializing them.
This commit is contained in:
Xi Ge
2016-03-15 12:50:09 -07:00
parent f0e96f1e70
commit d0e176810f
7 changed files with 87 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
lib/Serialization/Serialization.cpp
View File

@@ -3600,8 +3600,8 @@ class DeclGroupNameContext {
const bool Enable;
GroupNameCollector(bool Enable) : Enable(Enable) {}
virtual ~GroupNameCollector() = default;
virtual StringRef getGroupNameInternal(const ValueDecl *VD) = 0;
StringRef getGroupName(const ValueDecl *VD) {
virtual StringRef getGroupNameInternal(const Decl *VD) = 0;
StringRef getGroupName(const Decl *VD) {
return Enable ? getGroupNameInternal(VD) : StringRef(NullGroupName);
};
};
@@ -3609,7 +3609,7 @@ class DeclGroupNameContext {
// FIXME: Implement better name collectors.
struct GroupNameCollectorFromFileName : public GroupNameCollector {
GroupNameCollectorFromFileName(bool Enable) : GroupNameCollector(Enable) {}
StringRef getGroupNameInternal(const ValueDecl *VD) override {
StringRef getGroupNameInternal(const Decl *VD) override {
auto PathOp = VD->getDeclContext()->getParentSourceFile()->getBufferID();
if (!PathOp.hasValue())
return NullGroupName;
@@ -3627,7 +3627,7 @@ class DeclGroupNameContext {
GroupNameCollectorFromJson(StringRef RecordPath, ASTContext &Ctx) :
GroupNameCollector(!RecordPath.empty()), RecordPath(RecordPath),
Ctx(Ctx) {}
StringRef getGroupNameInternal(const ValueDecl *VD) override {
StringRef getGroupNameInternal(const Decl *VD) override {
// We need the file path, so there has to be a location.
if (VD->getLoc().isInvalid())
return NullGroupName;
@@ -3663,7 +3663,7 @@ class DeclGroupNameContext {
public:
DeclGroupNameContext(StringRef RecordPath, ASTContext &Ctx) :
pNameCollector(new GroupNameCollectorFromJson(RecordPath, Ctx)) {}
uint32_t getGroupSequence(const ValueDecl *VD) {
uint32_t getGroupSequence(const Decl *VD) {
return Map.insert(std::make_pair(pNameCollector->getGroupName(VD),
Map.size())).first->second;
}
@@ -3721,7 +3721,29 @@ static void writeDeclCommentTable(
return StringRef(Mem, String.size());
}
void writeDocForExtensionDecl(ExtensionDecl *ED) {
RawComment Raw = ED->getRawComment();
if (Raw.Comments.empty() && !GroupContext.isEnable())
return;
// Compute USR.
{
USRBuffer.clear();
llvm::raw_svector_ostream OS(USRBuffer);
if (ide::printExtensionUSR(ED, OS))
return;
}
generator.insert(copyString(USRBuffer.str()),
{ ED->getBriefComment(), Raw,
GroupContext.getGroupSequence(ED),
SourceOrder ++ });
}
bool walkToDeclPre(Decl *D) override {
if (auto *ED = dyn_cast<ExtensionDecl>(D)) {
writeDocForExtensionDecl(ED);
return true;
}
auto *VD = dyn_cast<ValueDecl>(D);
if (!VD)
return true;