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

[SourceKit] Incorporate synthesized extensions into DocInfo request. rdar://24912860

Browse Source 
This commit reuses our code for generating synthesized extensions from module printing to enhance
documentation generation.
This commit is contained in:
Xi Ge
2016-03-22 14:43:56 -07:00
parent 33c53a12eb
commit f338bdfbb7
10 changed files with 8706 additions and 2115 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
tools/SourceKit/lib/SwiftLang/SwiftDocSupport.cpp
View File

@@ -57,17 +57,23 @@ struct TextRange {
struct TextEntity {
const Decl *Dcl = nullptr;
const Decl *SynthesizeTarget = nullptr;
StringRef Argument;
TextRange Range;
unsigned LocOffset = 0;
std::vector<TextEntity> SubEntities;
TextEntity(const Decl *D, unsigned StartOffset)
: Dcl(D), Range{StartOffset, 0} {}
TextEntity(const Decl *D, TextRange TR, unsigned LocOffset)
: Dcl(D), Range(TR), LocOffset(LocOffset) {}
TextEntity(const Decl *D, StringRef Arg, TextRange TR, unsigned LocOffset)
: Dcl(D), Argument(Arg), Range(TR), LocOffset(LocOffset) {}
TextEntity(const Decl *D, const Decl *SynthesizeTarget, unsigned StartOffset)
: Dcl(D), SynthesizeTarget(SynthesizeTarget), Range{StartOffset, 0} {}
TextEntity(const Decl *D, const Decl *SynthesizeTarget, TextRange TR,
unsigned LocOffset) : Dcl(D), SynthesizeTarget(SynthesizeTarget),
Range(TR), LocOffset(LocOffset) {}
TextEntity(const Decl *D, const Decl *SynthesizeTarget, StringRef Arg,
TextRange TR, unsigned LocOffset)
: Dcl(D), SynthesizeTarget(SynthesizeTarget), Argument(Arg), Range(TR),
LocOffset(LocOffset) {}
};
struct TextReference {
@@ -80,6 +86,8 @@ struct TextReference {
};
class AnnotatingPrinter : public StreamPrinter {
const NominalTypeDecl *SynthesizeTarget = nullptr;
public:
std::vector<TextEntity> TopEntities;
std::vector<TextEntity> EntitiesStack;
@@ -91,11 +99,59 @@ public:
assert(EntitiesStack.empty());
}
bool shouldContinuePre(const Decl *D, Optional<BracketOptions> Bracket) {
assert(Bracket.hasValue());
if (!Bracket.getValue().shouldOpenExtension &&
D->getKind() == DeclKind::Extension)
return false;
return true;
}
bool shouldContinuePost(const Decl *D, Optional<BracketOptions> Bracket) {
assert(Bracket.hasValue());
if (!Bracket.getValue().shouldCloseNominal && dyn_cast<NominalTypeDecl>(D))
return false;
if (!Bracket.getValue().shouldCloseExtension &&
D->getKind() == DeclKind::Extension)
return false;
return true;
}
void printSynthesizedExtensionPre(const ExtensionDecl *ED,
const NominalTypeDecl *NTD,
Optional<BracketOptions> Bracket) override {
assert(!SynthesizeTarget);
SynthesizeTarget = NTD;
if (!shouldContinuePre(ED, Bracket))
return;
unsigned StartOffset = OS.tell();
EntitiesStack.emplace_back(ED, SynthesizeTarget, StartOffset);
}
void printSynthesizedExtensionPost(const ExtensionDecl *ED,
const NominalTypeDecl *NTD,
Optional<BracketOptions> Bracket) override {
assert(SynthesizeTarget);
SynthesizeTarget = nullptr;
if (!shouldContinuePost(ED, Bracket))
return;
TextEntity Entity = std::move(EntitiesStack.back());
EntitiesStack.pop_back();
unsigned EndOffset = OS.tell();
Entity.Range.Length = EndOffset - Entity.Range.Offset;
if (EntitiesStack.empty())
TopEntities.push_back(std::move(Entity));
else
EntitiesStack.back().SubEntities.push_back(std::move(Entity));
}
void printDeclPre(const Decl *D, Optional<BracketOptions> Bracket) override {
if (isa<ParamDecl>(D))
return; // Parameters are handled specially in addParameters().
if (!shouldContinuePre(D, Bracket))
return;
unsigned StartOffset = OS.tell();
EntitiesStack.emplace_back(D, StartOffset);
EntitiesStack.emplace_back(D, SynthesizeTarget, StartOffset);
}
void printDeclLoc(const Decl *D) override {
@@ -108,8 +164,9 @@ public:
void printDeclPost(const Decl *D, Optional<BracketOptions> Bracket) override {
if (isa<ParamDecl>(D))
return; // Parameters are handled specially in addParameters().
assert(EntitiesStack.back().Dcl == D);
if (!shouldContinuePost(D, Bracket))
return;
assert(!EntitiesStack.empty());
TextEntity Entity = std::move(EntitiesStack.back());
EntitiesStack.pop_back();
unsigned EndOffset = OS.tell();
@@ -169,7 +226,8 @@ static void initDocGenericParams(const Decl *D, DocEntityInfo &Info) {
}
}
static bool initDocEntityInfo(const Decl *D, bool IsRef, DocEntityInfo &Info,
static bool initDocEntityInfo(const Decl *D, const Decl *SynthesizedTarget,
bool IsRef, DocEntityInfo &Info,
StringRef Arg = StringRef()) {
if (!D || isa<ParamDecl>(D) ||
(isa<VarDecl>(D) && D->getDeclContext()->isLocalContext())) {
@@ -196,7 +254,14 @@ static bool initDocEntityInfo(const Decl *D, bool IsRef, DocEntityInfo &Info,
llvm::raw_svector_ostream OS(Info.USR);
SwiftLangSupport::printUSR(VD, OS);
if (SynthesizedTarget) {
llvm::raw_svector_ostream OS(Info.SynthesizedUSR);
SwiftLangSupport::printUSR(VD, OS);
OS << SwiftLangSupport::SynthesizedUSRSeparator;
SwiftLangSupport::printUSR(dyn_cast<ValueDecl>(SynthesizedTarget), OS);
}
}
Info.IsUnavailable = AvailableAttr::isUnavailable(D);
Info.IsDeprecated = D->getAttrs().getDeprecated(D->getASTContext()) != nullptr;
@@ -217,7 +282,8 @@ static bool initDocEntityInfo(const Decl *D, bool IsRef, DocEntityInfo &Info,
static bool initDocEntityInfo(const TextEntity &Entity,
DocEntityInfo &Info) {
if (initDocEntityInfo(Entity.Dcl, /*IsRef=*/false, Info, Entity.Argument))
if (initDocEntityInfo(Entity.Dcl, Entity.SynthesizeTarget,
/*IsRef=*/false, Info, Entity.Argument))
return true;
Info.Offset = Entity.Range.Offset;
Info.Length = Entity.Range.Length;
@@ -232,13 +298,13 @@ static const TypeDecl *getTypeDeclFromType(Type Ty) {
static void passInherits(const ValueDecl *D, DocInfoConsumer &Consumer) {
DocEntityInfo EntInfo;
if (initDocEntityInfo(D, /*IsRef=*/true, EntInfo))
if (initDocEntityInfo(D, nullptr, /*IsRef=*/true, EntInfo))
return;
Consumer.handleInheritsEntity(EntInfo);
}
static void passConforms(const ValueDecl *D, DocInfoConsumer &Consumer) {
DocEntityInfo EntInfo;
if (initDocEntityInfo(D, /*IsRef=*/true, EntInfo))
if (initDocEntityInfo(D, nullptr, /*IsRef=*/true, EntInfo))
return;
Consumer.handleConformsToEntity(EntInfo);
}
@@ -274,7 +340,7 @@ static void passConforms(ArrayRef<ValueDecl *> Dcls,
}
static void passExtends(const ValueDecl *D, DocInfoConsumer &Consumer) {
DocEntityInfo EntInfo;
if (initDocEntityInfo(D, /*IsRef=*/true, EntInfo))
if (initDocEntityInfo(D, nullptr, /*IsRef=*/true, EntInfo))
return;
Consumer.handleExtendsEntity(EntInfo);
}
@@ -481,7 +547,7 @@ private:
const TextReference &Ref = References.front();
References = References.slice(1);
DocEntityInfo Info;
if (initDocEntityInfo(Ref.Dcl, /*IsRef=*/true, Info))
if (initDocEntityInfo(Ref.Dcl, nullptr, /*IsRef=*/true, Info))
continue;
Info.Offset = Ref.Range.Offset;
Info.Length = Ref.Range.Length;
@@ -545,7 +611,7 @@ static void addParameters(ArrayRef<Identifier> &ArgNames,
SM.getLocOffsetInBuffer(Lexer::getLocForEndOfToken(SM, TypeRange.End),
BufferID);
TextRange TR{ StartOffs, EndOffs-StartOffs };
TextEntity Param(param, Arg, TR, StartOffs);
TextEntity Param(param, nullptr, Arg, TR, StartOffs);
Ent.SubEntities.push_back(std::move(Param));
}
}
@@ -676,8 +742,8 @@ static bool getModuleInterfaceInfo(ASTContext &Ctx, StringRef ModuleName,
SmallString<128> Text;
llvm::raw_svector_ostream OS(Text);
AnnotatingPrinter Printer(OS);
printModuleInterface(M, None, TraversalOptions, Printer, Options, false);
printModuleInterface(M, None, TraversalOptions, Printer, Options,
true);
Info.Text = OS.str();
Info.TopEntities = std::move(Printer.TopEntities);
Info.References = std::move(Printer.References);
@@ -739,7 +805,7 @@ public:
return true;
TextRange TR = getTextRange(D->getSourceRange());
unsigned LocOffset = getOffset(Range.getStart());
EntitiesStack.emplace_back(D, TR, LocOffset);
EntitiesStack.emplace_back(D, nullptr, TR, LocOffset);
return true;
}