2019-03-01 17:52:53 +08:00
|
|
|
//===-- Serialize.cpp - ClangDoc Serializer ---------------------*- C++ -*-===//
|
2018-03-23 07:34:46 +08:00
|
|
|
//
|
2019-01-19 16:50:56 +08:00
|
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
2018-03-23 07:34:46 +08:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#include "Serialize.h"
|
|
|
|
#include "BitcodeWriter.h"
|
|
|
|
#include "clang/AST/Comment.h"
|
|
|
|
#include "clang/Index/USRGeneration.h"
|
|
|
|
#include "llvm/ADT/Hashing.h"
|
|
|
|
#include "llvm/ADT/StringExtras.h"
|
|
|
|
#include "llvm/Support/SHA1.h"
|
|
|
|
|
|
|
|
using clang::comments::FullComment;
|
|
|
|
|
|
|
|
namespace clang {
|
|
|
|
namespace doc {
|
|
|
|
namespace serialize {
|
|
|
|
|
|
|
|
SymbolID hashUSR(llvm::StringRef USR) {
|
|
|
|
return llvm::SHA1::hash(arrayRefFromStringRef(USR));
|
|
|
|
}
|
|
|
|
|
2019-07-13 02:32:00 +08:00
|
|
|
template <typename T>
|
|
|
|
static void
|
|
|
|
populateParentNamespaces(llvm::SmallVector<Reference, 4> &Namespaces,
|
|
|
|
const T *D, bool &IsAnonymousNamespace);
|
|
|
|
|
|
|
|
// A function to extract the appropriate relative path for a given info's
|
|
|
|
// documentation. The path returned is a composite of the parent namespaces.
|
|
|
|
//
|
2020-01-04 23:28:41 +08:00
|
|
|
// Example: Given the below, the directory path for class C info will be
|
2019-07-13 02:32:00 +08:00
|
|
|
// <root>/A/B
|
|
|
|
//
|
|
|
|
// namespace A {
|
2020-04-05 14:28:11 +08:00
|
|
|
// namespace B {
|
2019-07-13 02:32:00 +08:00
|
|
|
//
|
|
|
|
// class C {};
|
|
|
|
//
|
|
|
|
// }
|
|
|
|
// }
|
|
|
|
llvm::SmallString<128>
|
|
|
|
getInfoRelativePath(const llvm::SmallVectorImpl<doc::Reference> &Namespaces) {
|
|
|
|
llvm::SmallString<128> Path;
|
|
|
|
for (auto R = Namespaces.rbegin(), E = Namespaces.rend(); R != E; ++R)
|
|
|
|
llvm::sys::path::append(Path, R->Name);
|
|
|
|
return Path;
|
|
|
|
}
|
|
|
|
|
|
|
|
llvm::SmallString<128> getInfoRelativePath(const Decl *D) {
|
|
|
|
llvm::SmallVector<Reference, 4> Namespaces;
|
|
|
|
// The third arg in populateParentNamespaces is a boolean passed by reference,
|
|
|
|
// its value is not relevant in here so it's not used anywhere besides the
|
|
|
|
// function call
|
|
|
|
bool B = true;
|
|
|
|
populateParentNamespaces(Namespaces, D, B);
|
|
|
|
return getInfoRelativePath(Namespaces);
|
|
|
|
}
|
|
|
|
|
2018-03-23 07:34:46 +08:00
|
|
|
class ClangDocCommentVisitor
|
|
|
|
: public ConstCommentVisitor<ClangDocCommentVisitor> {
|
|
|
|
public:
|
|
|
|
ClangDocCommentVisitor(CommentInfo &CI) : CurrentCI(CI) {}
|
|
|
|
|
|
|
|
void parseComment(const comments::Comment *C);
|
|
|
|
|
|
|
|
void visitTextComment(const TextComment *C);
|
|
|
|
void visitInlineCommandComment(const InlineCommandComment *C);
|
|
|
|
void visitHTMLStartTagComment(const HTMLStartTagComment *C);
|
|
|
|
void visitHTMLEndTagComment(const HTMLEndTagComment *C);
|
|
|
|
void visitBlockCommandComment(const BlockCommandComment *C);
|
|
|
|
void visitParamCommandComment(const ParamCommandComment *C);
|
|
|
|
void visitTParamCommandComment(const TParamCommandComment *C);
|
|
|
|
void visitVerbatimBlockComment(const VerbatimBlockComment *C);
|
|
|
|
void visitVerbatimBlockLineComment(const VerbatimBlockLineComment *C);
|
|
|
|
void visitVerbatimLineComment(const VerbatimLineComment *C);
|
|
|
|
|
|
|
|
private:
|
|
|
|
std::string getCommandName(unsigned CommandID) const;
|
|
|
|
bool isWhitespaceOnly(StringRef S) const;
|
|
|
|
|
|
|
|
CommentInfo &CurrentCI;
|
|
|
|
};
|
|
|
|
|
|
|
|
void ClangDocCommentVisitor::parseComment(const comments::Comment *C) {
|
|
|
|
CurrentCI.Kind = C->getCommentKindName();
|
|
|
|
ConstCommentVisitor<ClangDocCommentVisitor>::visit(C);
|
|
|
|
for (comments::Comment *Child :
|
|
|
|
llvm::make_range(C->child_begin(), C->child_end())) {
|
2019-08-15 07:52:23 +08:00
|
|
|
CurrentCI.Children.emplace_back(std::make_unique<CommentInfo>());
|
2018-03-23 07:34:46 +08:00
|
|
|
ClangDocCommentVisitor Visitor(*CurrentCI.Children.back());
|
|
|
|
Visitor.parseComment(Child);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void ClangDocCommentVisitor::visitTextComment(const TextComment *C) {
|
|
|
|
if (!isWhitespaceOnly(C->getText()))
|
|
|
|
CurrentCI.Text = C->getText();
|
|
|
|
}
|
|
|
|
|
|
|
|
void ClangDocCommentVisitor::visitInlineCommandComment(
|
|
|
|
const InlineCommandComment *C) {
|
|
|
|
CurrentCI.Name = getCommandName(C->getCommandID());
|
|
|
|
for (unsigned I = 0, E = C->getNumArgs(); I != E; ++I)
|
|
|
|
CurrentCI.Args.push_back(C->getArgText(I));
|
|
|
|
}
|
|
|
|
|
|
|
|
void ClangDocCommentVisitor::visitHTMLStartTagComment(
|
|
|
|
const HTMLStartTagComment *C) {
|
|
|
|
CurrentCI.Name = C->getTagName();
|
|
|
|
CurrentCI.SelfClosing = C->isSelfClosing();
|
|
|
|
for (unsigned I = 0, E = C->getNumAttrs(); I < E; ++I) {
|
|
|
|
const HTMLStartTagComment::Attribute &Attr = C->getAttr(I);
|
|
|
|
CurrentCI.AttrKeys.push_back(Attr.Name);
|
|
|
|
CurrentCI.AttrValues.push_back(Attr.Value);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void ClangDocCommentVisitor::visitHTMLEndTagComment(
|
|
|
|
const HTMLEndTagComment *C) {
|
|
|
|
CurrentCI.Name = C->getTagName();
|
|
|
|
CurrentCI.SelfClosing = true;
|
|
|
|
}
|
|
|
|
|
|
|
|
void ClangDocCommentVisitor::visitBlockCommandComment(
|
|
|
|
const BlockCommandComment *C) {
|
|
|
|
CurrentCI.Name = getCommandName(C->getCommandID());
|
|
|
|
for (unsigned I = 0, E = C->getNumArgs(); I < E; ++I)
|
|
|
|
CurrentCI.Args.push_back(C->getArgText(I));
|
|
|
|
}
|
|
|
|
|
|
|
|
void ClangDocCommentVisitor::visitParamCommandComment(
|
|
|
|
const ParamCommandComment *C) {
|
|
|
|
CurrentCI.Direction =
|
|
|
|
ParamCommandComment::getDirectionAsString(C->getDirection());
|
|
|
|
CurrentCI.Explicit = C->isDirectionExplicit();
|
|
|
|
if (C->hasParamName())
|
|
|
|
CurrentCI.ParamName = C->getParamNameAsWritten();
|
|
|
|
}
|
|
|
|
|
|
|
|
void ClangDocCommentVisitor::visitTParamCommandComment(
|
|
|
|
const TParamCommandComment *C) {
|
|
|
|
if (C->hasParamName())
|
|
|
|
CurrentCI.ParamName = C->getParamNameAsWritten();
|
|
|
|
}
|
|
|
|
|
|
|
|
void ClangDocCommentVisitor::visitVerbatimBlockComment(
|
|
|
|
const VerbatimBlockComment *C) {
|
|
|
|
CurrentCI.Name = getCommandName(C->getCommandID());
|
|
|
|
CurrentCI.CloseName = C->getCloseName();
|
|
|
|
}
|
|
|
|
|
|
|
|
void ClangDocCommentVisitor::visitVerbatimBlockLineComment(
|
|
|
|
const VerbatimBlockLineComment *C) {
|
|
|
|
if (!isWhitespaceOnly(C->getText()))
|
|
|
|
CurrentCI.Text = C->getText();
|
|
|
|
}
|
|
|
|
|
|
|
|
void ClangDocCommentVisitor::visitVerbatimLineComment(
|
|
|
|
const VerbatimLineComment *C) {
|
|
|
|
if (!isWhitespaceOnly(C->getText()))
|
|
|
|
CurrentCI.Text = C->getText();
|
|
|
|
}
|
|
|
|
|
|
|
|
bool ClangDocCommentVisitor::isWhitespaceOnly(llvm::StringRef S) const {
|
|
|
|
return std::all_of(S.begin(), S.end(), isspace);
|
|
|
|
}
|
|
|
|
|
|
|
|
std::string ClangDocCommentVisitor::getCommandName(unsigned CommandID) const {
|
|
|
|
const CommandInfo *Info = CommandTraits::getBuiltinCommandInfo(CommandID);
|
|
|
|
if (Info)
|
|
|
|
return Info->Name;
|
|
|
|
// TODO: Add parsing for \file command.
|
|
|
|
return "<not a builtin command>";
|
|
|
|
}
|
|
|
|
|
|
|
|
// Serializing functions.
|
|
|
|
|
|
|
|
template <typename T> static std::string serialize(T &I) {
|
|
|
|
SmallString<2048> Buffer;
|
|
|
|
llvm::BitstreamWriter Stream(Buffer);
|
|
|
|
ClangDocBitcodeWriter Writer(Stream);
|
|
|
|
Writer.emitBlock(I);
|
|
|
|
return Buffer.str().str();
|
|
|
|
}
|
|
|
|
|
2018-08-03 04:10:17 +08:00
|
|
|
std::string serialize(std::unique_ptr<Info> &I) {
|
|
|
|
switch (I->IT) {
|
|
|
|
case InfoType::IT_namespace:
|
|
|
|
return serialize(*static_cast<NamespaceInfo *>(I.get()));
|
|
|
|
case InfoType::IT_record:
|
|
|
|
return serialize(*static_cast<RecordInfo *>(I.get()));
|
|
|
|
case InfoType::IT_enum:
|
|
|
|
return serialize(*static_cast<EnumInfo *>(I.get()));
|
|
|
|
case InfoType::IT_function:
|
|
|
|
return serialize(*static_cast<FunctionInfo *>(I.get()));
|
|
|
|
default:
|
|
|
|
return "";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-03-23 07:34:46 +08:00
|
|
|
static void parseFullComment(const FullComment *C, CommentInfo &CI) {
|
|
|
|
ClangDocCommentVisitor Visitor(CI);
|
|
|
|
Visitor.parseComment(C);
|
|
|
|
}
|
|
|
|
|
|
|
|
static SymbolID getUSRForDecl(const Decl *D) {
|
|
|
|
llvm::SmallString<128> USR;
|
|
|
|
if (index::generateUSRForDecl(D, USR))
|
|
|
|
return SymbolID();
|
|
|
|
return hashUSR(USR);
|
|
|
|
}
|
|
|
|
|
|
|
|
static RecordDecl *getDeclForType(const QualType &T) {
|
2019-06-25 03:31:02 +08:00
|
|
|
if (const RecordDecl *D = T->getAsRecordDecl())
|
|
|
|
return D->getDefinition();
|
|
|
|
return nullptr;
|
2018-03-23 07:34:46 +08:00
|
|
|
}
|
|
|
|
|
2018-07-21 02:49:55 +08:00
|
|
|
static bool isPublic(const clang::AccessSpecifier AS,
|
|
|
|
const clang::Linkage Link) {
|
|
|
|
if (AS == clang::AccessSpecifier::AS_private)
|
|
|
|
return false;
|
|
|
|
else if ((Link == clang::Linkage::ModuleLinkage) ||
|
|
|
|
(Link == clang::Linkage::ExternalLinkage))
|
|
|
|
return true;
|
|
|
|
return false; // otherwise, linkage is some form of internal linkage
|
|
|
|
}
|
|
|
|
|
2019-08-16 08:10:49 +08:00
|
|
|
static bool shouldSerializeInfo(bool PublicOnly, bool IsInAnonymousNamespace,
|
|
|
|
const NamedDecl *D) {
|
|
|
|
bool IsAnonymousNamespace = false;
|
|
|
|
if (const auto *N = dyn_cast<NamespaceDecl>(D))
|
|
|
|
IsAnonymousNamespace = N->isAnonymousNamespace();
|
|
|
|
return !PublicOnly ||
|
|
|
|
(!IsInAnonymousNamespace && !IsAnonymousNamespace &&
|
|
|
|
isPublic(D->getAccessUnsafe(), D->getLinkageInternal()));
|
|
|
|
}
|
|
|
|
|
|
|
|
// There are two uses for this function.
|
|
|
|
// 1) Getting the resulting mode of inheritance of a record.
|
|
|
|
// Example: class A {}; class B : private A {}; class C : public B {};
|
|
|
|
// It's explicit that C is publicly inherited from C and B is privately
|
|
|
|
// inherited from A. It's not explicit but C is also privately inherited from
|
|
|
|
// A. This is the AS that this function calculates. FirstAS is the
|
|
|
|
// inheritance mode of `class C : B` and SecondAS is the inheritance mode of
|
|
|
|
// `class B : A`.
|
|
|
|
// 2) Getting the inheritance mode of an inherited attribute / method.
|
|
|
|
// Example : class A { public: int M; }; class B : private A {};
|
|
|
|
// Class B is inherited from class A, which has a public attribute. This
|
|
|
|
// attribute is now part of the derived class B but it's not public. This
|
|
|
|
// will be private because the inheritance is private. This is the AS that
|
|
|
|
// this function calculates. FirstAS is the inheritance mode and SecondAS is
|
|
|
|
// the AS of the attribute / method.
|
|
|
|
static AccessSpecifier getFinalAccessSpecifier(AccessSpecifier FirstAS,
|
|
|
|
AccessSpecifier SecondAS) {
|
|
|
|
if (FirstAS == AccessSpecifier::AS_none ||
|
|
|
|
SecondAS == AccessSpecifier::AS_none)
|
|
|
|
return AccessSpecifier::AS_none;
|
|
|
|
if (FirstAS == AccessSpecifier::AS_private ||
|
|
|
|
SecondAS == AccessSpecifier::AS_private)
|
|
|
|
return AccessSpecifier::AS_private;
|
|
|
|
if (FirstAS == AccessSpecifier::AS_protected ||
|
|
|
|
SecondAS == AccessSpecifier::AS_protected)
|
|
|
|
return AccessSpecifier::AS_protected;
|
|
|
|
return AccessSpecifier::AS_public;
|
|
|
|
}
|
|
|
|
|
|
|
|
// The Access parameter is only provided when parsing the field of an inherited
|
|
|
|
// record, the access specification of the field depends on the inheritance mode
|
|
|
|
static void parseFields(RecordInfo &I, const RecordDecl *D, bool PublicOnly,
|
|
|
|
AccessSpecifier Access = AccessSpecifier::AS_public) {
|
2018-03-23 07:34:46 +08:00
|
|
|
for (const FieldDecl *F : D->fields()) {
|
2019-08-16 08:10:49 +08:00
|
|
|
if (!shouldSerializeInfo(PublicOnly, /*IsInAnonymousNamespace=*/false, F))
|
2018-07-21 02:49:55 +08:00
|
|
|
continue;
|
2018-03-23 07:34:46 +08:00
|
|
|
if (const auto *T = getDeclForType(F->getTypeSourceInfo()->getType())) {
|
2018-05-05 01:02:13 +08:00
|
|
|
// Use getAccessUnsafe so that we just get the default AS_none if it's not
|
|
|
|
// valid, as opposed to an assert.
|
|
|
|
if (const auto *N = dyn_cast<EnumDecl>(T)) {
|
2019-08-16 08:10:49 +08:00
|
|
|
I.Members.emplace_back(
|
|
|
|
getUSRForDecl(T), N->getNameAsString(), InfoType::IT_enum,
|
|
|
|
getInfoRelativePath(N), F->getNameAsString(),
|
|
|
|
getFinalAccessSpecifier(Access, N->getAccessUnsafe()));
|
2018-05-05 01:02:13 +08:00
|
|
|
continue;
|
|
|
|
} else if (const auto *N = dyn_cast<RecordDecl>(T)) {
|
2019-08-16 08:10:49 +08:00
|
|
|
I.Members.emplace_back(
|
|
|
|
getUSRForDecl(T), N->getNameAsString(), InfoType::IT_record,
|
|
|
|
getInfoRelativePath(N), F->getNameAsString(),
|
|
|
|
getFinalAccessSpecifier(Access, N->getAccessUnsafe()));
|
2018-05-05 01:02:13 +08:00
|
|
|
continue;
|
|
|
|
}
|
2018-03-23 07:34:46 +08:00
|
|
|
}
|
2019-08-16 08:10:49 +08:00
|
|
|
I.Members.emplace_back(
|
|
|
|
F->getTypeSourceInfo()->getType().getAsString(), F->getNameAsString(),
|
|
|
|
getFinalAccessSpecifier(Access, F->getAccessUnsafe()));
|
2018-03-23 07:34:46 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
static void parseEnumerators(EnumInfo &I, const EnumDecl *D) {
|
|
|
|
for (const EnumConstantDecl *E : D->enumerators())
|
|
|
|
I.Members.emplace_back(E->getNameAsString());
|
|
|
|
}
|
|
|
|
|
|
|
|
static void parseParameters(FunctionInfo &I, const FunctionDecl *D) {
|
|
|
|
for (const ParmVarDecl *P : D->parameters()) {
|
|
|
|
if (const auto *T = getDeclForType(P->getOriginalType())) {
|
2018-05-05 01:02:13 +08:00
|
|
|
if (const auto *N = dyn_cast<EnumDecl>(T)) {
|
|
|
|
I.Params.emplace_back(getUSRForDecl(N), N->getNameAsString(),
|
2019-07-13 02:32:00 +08:00
|
|
|
InfoType::IT_enum, getInfoRelativePath(N),
|
|
|
|
P->getNameAsString());
|
2018-05-05 01:02:13 +08:00
|
|
|
continue;
|
|
|
|
} else if (const auto *N = dyn_cast<RecordDecl>(T)) {
|
|
|
|
I.Params.emplace_back(getUSRForDecl(N), N->getNameAsString(),
|
2019-07-13 02:32:00 +08:00
|
|
|
InfoType::IT_record, getInfoRelativePath(N),
|
|
|
|
P->getNameAsString());
|
2018-05-05 01:02:13 +08:00
|
|
|
continue;
|
|
|
|
}
|
2018-03-23 07:34:46 +08:00
|
|
|
}
|
2018-05-05 01:02:13 +08:00
|
|
|
I.Params.emplace_back(P->getOriginalType().getAsString(),
|
|
|
|
P->getNameAsString());
|
2018-03-23 07:34:46 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-08-16 08:10:49 +08:00
|
|
|
// TODO: Remove the serialization of Parents and VirtualParents, this
|
|
|
|
// information is also extracted in the other definition of parseBases.
|
2018-03-23 07:34:46 +08:00
|
|
|
static void parseBases(RecordInfo &I, const CXXRecordDecl *D) {
|
2018-10-04 02:25:27 +08:00
|
|
|
// Don't parse bases if this isn't a definition.
|
|
|
|
if (!D->isThisDeclarationADefinition())
|
|
|
|
return;
|
2018-03-23 07:34:46 +08:00
|
|
|
for (const CXXBaseSpecifier &B : D->bases()) {
|
|
|
|
if (B.isVirtual())
|
|
|
|
continue;
|
2019-06-25 03:31:02 +08:00
|
|
|
if (const auto *Ty = B.getType()->getAs<TemplateSpecializationType>()) {
|
|
|
|
const TemplateDecl *D = Ty->getTemplateName().getAsTemplateDecl();
|
|
|
|
I.Parents.emplace_back(getUSRForDecl(D), B.getType().getAsString(),
|
|
|
|
InfoType::IT_record);
|
|
|
|
} else if (const RecordDecl *P = getDeclForType(B.getType()))
|
2018-05-05 01:02:13 +08:00
|
|
|
I.Parents.emplace_back(getUSRForDecl(P), P->getNameAsString(),
|
2019-07-13 02:32:00 +08:00
|
|
|
InfoType::IT_record, getInfoRelativePath(P));
|
2018-03-23 07:34:46 +08:00
|
|
|
else
|
|
|
|
I.Parents.emplace_back(B.getType().getAsString());
|
|
|
|
}
|
|
|
|
for (const CXXBaseSpecifier &B : D->vbases()) {
|
|
|
|
if (const auto *P = getDeclForType(B.getType()))
|
2018-05-05 01:02:13 +08:00
|
|
|
I.VirtualParents.emplace_back(getUSRForDecl(P), P->getNameAsString(),
|
2019-07-13 02:32:00 +08:00
|
|
|
InfoType::IT_record,
|
|
|
|
getInfoRelativePath(P));
|
2018-03-23 07:34:46 +08:00
|
|
|
else
|
|
|
|
I.VirtualParents.emplace_back(B.getType().getAsString());
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
template <typename T>
|
|
|
|
static void
|
|
|
|
populateParentNamespaces(llvm::SmallVector<Reference, 4> &Namespaces,
|
2019-07-13 02:32:00 +08:00
|
|
|
const T *D, bool &IsInAnonymousNamespace) {
|
2018-03-23 07:34:46 +08:00
|
|
|
const auto *DC = dyn_cast<DeclContext>(D);
|
|
|
|
while ((DC = DC->getParent())) {
|
2019-06-29 03:07:56 +08:00
|
|
|
if (const auto *N = dyn_cast<NamespaceDecl>(DC)) {
|
|
|
|
std::string Namespace;
|
|
|
|
if (N->isAnonymousNamespace()) {
|
|
|
|
Namespace = "@nonymous_namespace";
|
2019-07-13 02:32:00 +08:00
|
|
|
IsInAnonymousNamespace = true;
|
2019-06-29 03:07:56 +08:00
|
|
|
} else
|
|
|
|
Namespace = N->getNameAsString();
|
|
|
|
Namespaces.emplace_back(getUSRForDecl(N), Namespace,
|
2018-05-05 01:02:13 +08:00
|
|
|
InfoType::IT_namespace);
|
2019-06-29 03:07:56 +08:00
|
|
|
} else if (const auto *N = dyn_cast<RecordDecl>(DC))
|
2018-05-05 01:02:13 +08:00
|
|
|
Namespaces.emplace_back(getUSRForDecl(N), N->getNameAsString(),
|
|
|
|
InfoType::IT_record);
|
2018-03-23 07:34:46 +08:00
|
|
|
else if (const auto *N = dyn_cast<FunctionDecl>(DC))
|
2018-05-05 01:02:13 +08:00
|
|
|
Namespaces.emplace_back(getUSRForDecl(N), N->getNameAsString(),
|
|
|
|
InfoType::IT_function);
|
2018-03-23 07:34:46 +08:00
|
|
|
else if (const auto *N = dyn_cast<EnumDecl>(DC))
|
2018-05-05 01:02:13 +08:00
|
|
|
Namespaces.emplace_back(getUSRForDecl(N), N->getNameAsString(),
|
|
|
|
InfoType::IT_enum);
|
2018-03-23 07:34:46 +08:00
|
|
|
}
|
2019-08-17 00:10:32 +08:00
|
|
|
// The global namespace should be added to the list of namespaces if the decl
|
|
|
|
// corresponds to a Record and if it doesn't have any namespace (because this
|
|
|
|
// means it's in the global namespace). Also if its outermost namespace is a
|
|
|
|
// record because that record matches the previous condition mentioned.
|
2021-12-25 13:22:27 +08:00
|
|
|
if ((Namespaces.empty() && isa<RecordDecl>(D)) ||
|
2019-08-17 00:10:32 +08:00
|
|
|
(!Namespaces.empty() && Namespaces.back().RefType == InfoType::IT_record))
|
|
|
|
Namespaces.emplace_back(SymbolID(), "GlobalNamespace",
|
|
|
|
InfoType::IT_namespace);
|
2018-03-23 07:34:46 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
template <typename T>
|
2019-06-29 03:07:56 +08:00
|
|
|
static void populateInfo(Info &I, const T *D, const FullComment *C,
|
|
|
|
bool &IsInAnonymousNamespace) {
|
2018-03-23 07:34:46 +08:00
|
|
|
I.USR = getUSRForDecl(D);
|
|
|
|
I.Name = D->getNameAsString();
|
2019-06-29 03:07:56 +08:00
|
|
|
populateParentNamespaces(I.Namespace, D, IsInAnonymousNamespace);
|
2018-03-23 07:34:46 +08:00
|
|
|
if (C) {
|
|
|
|
I.Description.emplace_back();
|
|
|
|
parseFullComment(C, I.Description.back());
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
template <typename T>
|
|
|
|
static void populateSymbolInfo(SymbolInfo &I, const T *D, const FullComment *C,
|
2019-06-29 03:07:56 +08:00
|
|
|
int LineNumber, StringRef Filename,
|
2019-08-10 01:49:41 +08:00
|
|
|
bool IsFileInRootDir,
|
2019-06-29 03:07:56 +08:00
|
|
|
bool &IsInAnonymousNamespace) {
|
|
|
|
populateInfo(I, D, C, IsInAnonymousNamespace);
|
2018-03-23 07:34:46 +08:00
|
|
|
if (D->isThisDeclarationADefinition())
|
2019-08-10 01:49:41 +08:00
|
|
|
I.DefLoc.emplace(LineNumber, Filename, IsFileInRootDir);
|
2018-03-23 07:34:46 +08:00
|
|
|
else
|
2019-08-10 01:49:41 +08:00
|
|
|
I.Loc.emplace_back(LineNumber, Filename, IsFileInRootDir);
|
2018-03-23 07:34:46 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
static void populateFunctionInfo(FunctionInfo &I, const FunctionDecl *D,
|
|
|
|
const FullComment *FC, int LineNumber,
|
2019-08-10 01:49:41 +08:00
|
|
|
StringRef Filename, bool IsFileInRootDir,
|
2019-06-29 03:07:56 +08:00
|
|
|
bool &IsInAnonymousNamespace) {
|
2019-08-10 01:49:41 +08:00
|
|
|
populateSymbolInfo(I, D, FC, LineNumber, Filename, IsFileInRootDir,
|
|
|
|
IsInAnonymousNamespace);
|
2018-03-23 07:34:46 +08:00
|
|
|
if (const auto *T = getDeclForType(D->getReturnType())) {
|
2021-12-25 13:22:27 +08:00
|
|
|
if (isa<EnumDecl>(T))
|
2019-07-13 02:32:00 +08:00
|
|
|
I.ReturnType = TypeInfo(getUSRForDecl(T), T->getNameAsString(),
|
|
|
|
InfoType::IT_enum, getInfoRelativePath(T));
|
2021-12-25 13:22:27 +08:00
|
|
|
else if (isa<RecordDecl>(T))
|
2019-07-13 02:32:00 +08:00
|
|
|
I.ReturnType = TypeInfo(getUSRForDecl(T), T->getNameAsString(),
|
|
|
|
InfoType::IT_record, getInfoRelativePath(T));
|
2018-03-23 07:34:46 +08:00
|
|
|
} else {
|
2018-05-05 01:02:13 +08:00
|
|
|
I.ReturnType = TypeInfo(D->getReturnType().getAsString());
|
2018-03-23 07:34:46 +08:00
|
|
|
}
|
|
|
|
parseParameters(I, D);
|
|
|
|
}
|
|
|
|
|
2019-08-16 08:10:49 +08:00
|
|
|
static void
|
|
|
|
parseBases(RecordInfo &I, const CXXRecordDecl *D, bool IsFileInRootDir,
|
|
|
|
bool PublicOnly, bool IsParent,
|
|
|
|
AccessSpecifier ParentAccess = AccessSpecifier::AS_public) {
|
|
|
|
// Don't parse bases if this isn't a definition.
|
|
|
|
if (!D->isThisDeclarationADefinition())
|
|
|
|
return;
|
|
|
|
for (const CXXBaseSpecifier &B : D->bases()) {
|
|
|
|
if (const RecordType *Ty = B.getType()->getAs<RecordType>()) {
|
|
|
|
if (const CXXRecordDecl *Base =
|
|
|
|
cast_or_null<CXXRecordDecl>(Ty->getDecl()->getDefinition())) {
|
|
|
|
// Initialized without USR and name, this will be set in the following
|
|
|
|
// if-else stmt.
|
|
|
|
BaseRecordInfo BI(
|
|
|
|
{}, "", getInfoRelativePath(Base), B.isVirtual(),
|
|
|
|
getFinalAccessSpecifier(ParentAccess, B.getAccessSpecifier()),
|
|
|
|
IsParent);
|
|
|
|
if (const auto *Ty = B.getType()->getAs<TemplateSpecializationType>()) {
|
|
|
|
const TemplateDecl *D = Ty->getTemplateName().getAsTemplateDecl();
|
|
|
|
BI.USR = getUSRForDecl(D);
|
|
|
|
BI.Name = B.getType().getAsString();
|
|
|
|
} else {
|
|
|
|
BI.USR = getUSRForDecl(Base);
|
|
|
|
BI.Name = Base->getNameAsString();
|
|
|
|
}
|
|
|
|
parseFields(BI, Base, PublicOnly, BI.Access);
|
|
|
|
for (const auto &Decl : Base->decls())
|
|
|
|
if (const auto *MD = dyn_cast<CXXMethodDecl>(Decl)) {
|
|
|
|
// Don't serialize private methods
|
|
|
|
if (MD->getAccessUnsafe() == AccessSpecifier::AS_private ||
|
|
|
|
!MD->isUserProvided())
|
|
|
|
continue;
|
|
|
|
FunctionInfo FI;
|
|
|
|
FI.IsMethod = true;
|
|
|
|
// The seventh arg in populateFunctionInfo is a boolean passed by
|
|
|
|
// reference, its value is not relevant in here so it's not used
|
|
|
|
// anywhere besides the function call.
|
|
|
|
bool IsInAnonymousNamespace;
|
|
|
|
populateFunctionInfo(FI, MD, /*FullComment=*/{}, /*LineNumber=*/{},
|
|
|
|
/*FileName=*/{}, IsFileInRootDir,
|
|
|
|
IsInAnonymousNamespace);
|
|
|
|
FI.Access =
|
|
|
|
getFinalAccessSpecifier(BI.Access, MD->getAccessUnsafe());
|
|
|
|
BI.ChildFunctions.emplace_back(std::move(FI));
|
|
|
|
}
|
|
|
|
I.Bases.emplace_back(std::move(BI));
|
|
|
|
// Call this function recursively to get the inherited classes of
|
|
|
|
// this base; these new bases will also get stored in the original
|
|
|
|
// RecordInfo: I.
|
|
|
|
parseBases(I, Base, IsFileInRootDir, PublicOnly, false,
|
|
|
|
I.Bases.back().Access);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-07-03 03:59:56 +08:00
|
|
|
std::pair<std::unique_ptr<Info>, std::unique_ptr<Info>>
|
|
|
|
emitInfo(const NamespaceDecl *D, const FullComment *FC, int LineNumber,
|
2019-08-10 01:49:41 +08:00
|
|
|
llvm::StringRef File, bool IsFileInRootDir, bool PublicOnly) {
|
2019-08-15 07:52:23 +08:00
|
|
|
auto I = std::make_unique<NamespaceInfo>();
|
2019-06-29 03:07:56 +08:00
|
|
|
bool IsInAnonymousNamespace = false;
|
|
|
|
populateInfo(*I, D, FC, IsInAnonymousNamespace);
|
2019-08-16 08:10:49 +08:00
|
|
|
if (!shouldSerializeInfo(PublicOnly, IsInAnonymousNamespace, D))
|
2019-07-03 03:59:56 +08:00
|
|
|
return {};
|
2019-08-16 08:10:49 +08:00
|
|
|
|
2019-06-29 03:07:56 +08:00
|
|
|
I->Name = D->isAnonymousNamespace()
|
|
|
|
? llvm::SmallString<16>("@nonymous_namespace")
|
|
|
|
: I->Name;
|
2019-07-13 02:32:00 +08:00
|
|
|
I->Path = getInfoRelativePath(I->Namespace);
|
2019-07-03 03:59:56 +08:00
|
|
|
if (I->Namespace.empty() && I->USR == SymbolID())
|
|
|
|
return {std::unique_ptr<Info>{std::move(I)}, nullptr};
|
|
|
|
|
2019-08-15 07:52:23 +08:00
|
|
|
auto ParentI = std::make_unique<NamespaceInfo>();
|
2019-07-13 02:32:00 +08:00
|
|
|
ParentI->USR = I->Namespace.empty() ? SymbolID() : I->Namespace[0].USR;
|
2019-08-13 02:42:46 +08:00
|
|
|
ParentI->ChildNamespaces.emplace_back(I->USR, I->Name, InfoType::IT_namespace,
|
|
|
|
getInfoRelativePath(I->Namespace));
|
2019-07-13 02:32:00 +08:00
|
|
|
if (I->Namespace.empty())
|
|
|
|
ParentI->Path = getInfoRelativePath(ParentI->Namespace);
|
2019-07-03 03:59:56 +08:00
|
|
|
return {std::unique_ptr<Info>{std::move(I)},
|
2019-07-13 02:32:00 +08:00
|
|
|
std::unique_ptr<Info>{std::move(ParentI)}};
|
2018-03-23 07:34:46 +08:00
|
|
|
}
|
|
|
|
|
2019-07-03 03:59:56 +08:00
|
|
|
std::pair<std::unique_ptr<Info>, std::unique_ptr<Info>>
|
|
|
|
emitInfo(const RecordDecl *D, const FullComment *FC, int LineNumber,
|
2019-08-10 01:49:41 +08:00
|
|
|
llvm::StringRef File, bool IsFileInRootDir, bool PublicOnly) {
|
2019-08-15 07:52:23 +08:00
|
|
|
auto I = std::make_unique<RecordInfo>();
|
2019-06-29 03:07:56 +08:00
|
|
|
bool IsInAnonymousNamespace = false;
|
2019-08-10 01:49:41 +08:00
|
|
|
populateSymbolInfo(*I, D, FC, LineNumber, File, IsFileInRootDir,
|
|
|
|
IsInAnonymousNamespace);
|
2019-08-16 08:10:49 +08:00
|
|
|
if (!shouldSerializeInfo(PublicOnly, IsInAnonymousNamespace, D))
|
2019-07-03 03:59:56 +08:00
|
|
|
return {};
|
2019-06-29 03:07:56 +08:00
|
|
|
|
2018-08-03 04:10:17 +08:00
|
|
|
I->TagType = D->getTagKind();
|
|
|
|
parseFields(*I, D, PublicOnly);
|
2019-06-25 03:31:02 +08:00
|
|
|
if (const auto *C = dyn_cast<CXXRecordDecl>(D)) {
|
|
|
|
if (const TypedefNameDecl *TD = C->getTypedefNameForAnonDecl()) {
|
|
|
|
I->Name = TD->getNameAsString();
|
|
|
|
I->IsTypeDef = true;
|
|
|
|
}
|
2019-08-16 08:10:49 +08:00
|
|
|
// TODO: remove first call to parseBases, that function should be deleted
|
2018-08-03 04:10:17 +08:00
|
|
|
parseBases(*I, C);
|
2019-08-16 08:10:49 +08:00
|
|
|
parseBases(*I, C, IsFileInRootDir, PublicOnly, true);
|
2019-06-25 03:31:02 +08:00
|
|
|
}
|
2019-07-13 02:32:00 +08:00
|
|
|
I->Path = getInfoRelativePath(I->Namespace);
|
2019-07-03 03:59:56 +08:00
|
|
|
|
|
|
|
switch (I->Namespace[0].RefType) {
|
|
|
|
case InfoType::IT_namespace: {
|
2019-08-15 07:52:23 +08:00
|
|
|
auto ParentI = std::make_unique<NamespaceInfo>();
|
2019-07-13 02:32:00 +08:00
|
|
|
ParentI->USR = I->Namespace[0].USR;
|
2019-08-13 02:42:46 +08:00
|
|
|
ParentI->ChildRecords.emplace_back(I->USR, I->Name, InfoType::IT_record,
|
|
|
|
getInfoRelativePath(I->Namespace));
|
2019-07-03 03:59:56 +08:00
|
|
|
return {std::unique_ptr<Info>{std::move(I)},
|
2019-07-13 02:32:00 +08:00
|
|
|
std::unique_ptr<Info>{std::move(ParentI)}};
|
2019-07-03 03:59:56 +08:00
|
|
|
}
|
|
|
|
case InfoType::IT_record: {
|
2019-08-15 07:52:23 +08:00
|
|
|
auto ParentI = std::make_unique<RecordInfo>();
|
2019-07-13 02:32:00 +08:00
|
|
|
ParentI->USR = I->Namespace[0].USR;
|
2019-08-13 02:42:46 +08:00
|
|
|
ParentI->ChildRecords.emplace_back(I->USR, I->Name, InfoType::IT_record,
|
|
|
|
getInfoRelativePath(I->Namespace));
|
2019-07-03 03:59:56 +08:00
|
|
|
return {std::unique_ptr<Info>{std::move(I)},
|
2019-07-13 02:32:00 +08:00
|
|
|
std::unique_ptr<Info>{std::move(ParentI)}};
|
2019-07-03 03:59:56 +08:00
|
|
|
}
|
|
|
|
default:
|
2019-07-13 02:32:00 +08:00
|
|
|
llvm_unreachable("Invalid reference type for parent namespace");
|
2019-07-03 03:59:56 +08:00
|
|
|
}
|
2018-03-23 07:34:46 +08:00
|
|
|
}
|
|
|
|
|
2019-07-03 03:59:56 +08:00
|
|
|
std::pair<std::unique_ptr<Info>, std::unique_ptr<Info>>
|
|
|
|
emitInfo(const FunctionDecl *D, const FullComment *FC, int LineNumber,
|
2019-08-10 01:49:41 +08:00
|
|
|
llvm::StringRef File, bool IsFileInRootDir, bool PublicOnly) {
|
2018-08-03 04:10:17 +08:00
|
|
|
FunctionInfo Func;
|
2019-06-29 03:07:56 +08:00
|
|
|
bool IsInAnonymousNamespace = false;
|
2019-08-10 01:49:41 +08:00
|
|
|
populateFunctionInfo(Func, D, FC, LineNumber, File, IsFileInRootDir,
|
|
|
|
IsInAnonymousNamespace);
|
2019-08-16 07:04:27 +08:00
|
|
|
Func.Access = clang::AccessSpecifier::AS_none;
|
2019-08-16 08:10:49 +08:00
|
|
|
if (!shouldSerializeInfo(PublicOnly, IsInAnonymousNamespace, D))
|
2019-07-03 03:59:56 +08:00
|
|
|
return {};
|
2019-06-29 03:07:56 +08:00
|
|
|
|
2018-08-03 04:10:17 +08:00
|
|
|
// Wrap in enclosing scope
|
2019-08-15 07:52:23 +08:00
|
|
|
auto ParentI = std::make_unique<NamespaceInfo>();
|
2018-08-03 04:10:17 +08:00
|
|
|
if (!Func.Namespace.empty())
|
2019-07-13 02:32:00 +08:00
|
|
|
ParentI->USR = Func.Namespace[0].USR;
|
2018-08-03 04:10:17 +08:00
|
|
|
else
|
2019-07-13 02:32:00 +08:00
|
|
|
ParentI->USR = SymbolID();
|
|
|
|
if (Func.Namespace.empty())
|
|
|
|
ParentI->Path = getInfoRelativePath(ParentI->Namespace);
|
|
|
|
ParentI->ChildFunctions.emplace_back(std::move(Func));
|
|
|
|
// Info is wrapped in its parent scope so it's returned in the second position
|
|
|
|
return {nullptr, std::unique_ptr<Info>{std::move(ParentI)}};
|
2018-03-23 07:34:46 +08:00
|
|
|
}
|
|
|
|
|
2019-07-03 03:59:56 +08:00
|
|
|
std::pair<std::unique_ptr<Info>, std::unique_ptr<Info>>
|
|
|
|
emitInfo(const CXXMethodDecl *D, const FullComment *FC, int LineNumber,
|
2019-08-10 01:49:41 +08:00
|
|
|
llvm::StringRef File, bool IsFileInRootDir, bool PublicOnly) {
|
2018-08-03 04:10:17 +08:00
|
|
|
FunctionInfo Func;
|
2019-06-29 03:07:56 +08:00
|
|
|
bool IsInAnonymousNamespace = false;
|
2019-08-10 01:49:41 +08:00
|
|
|
populateFunctionInfo(Func, D, FC, LineNumber, File, IsFileInRootDir,
|
|
|
|
IsInAnonymousNamespace);
|
2019-08-16 08:10:49 +08:00
|
|
|
if (!shouldSerializeInfo(PublicOnly, IsInAnonymousNamespace, D))
|
2019-07-03 03:59:56 +08:00
|
|
|
return {};
|
2019-06-29 03:07:56 +08:00
|
|
|
|
2018-08-03 04:10:17 +08:00
|
|
|
Func.IsMethod = true;
|
|
|
|
|
2019-06-25 03:31:02 +08:00
|
|
|
const NamedDecl *Parent = nullptr;
|
|
|
|
if (const auto *SD =
|
|
|
|
dyn_cast<ClassTemplateSpecializationDecl>(D->getParent()))
|
|
|
|
Parent = SD->getSpecializedTemplate();
|
|
|
|
else
|
|
|
|
Parent = D->getParent();
|
|
|
|
|
|
|
|
SymbolID ParentUSR = getUSRForDecl(Parent);
|
|
|
|
Func.Parent =
|
|
|
|
Reference{ParentUSR, Parent->getNameAsString(), InfoType::IT_record};
|
2018-08-03 04:10:17 +08:00
|
|
|
Func.Access = D->getAccess();
|
|
|
|
|
|
|
|
// Wrap in enclosing scope
|
2019-08-15 07:52:23 +08:00
|
|
|
auto ParentI = std::make_unique<RecordInfo>();
|
2019-07-13 02:32:00 +08:00
|
|
|
ParentI->USR = ParentUSR;
|
|
|
|
ParentI->ChildFunctions.emplace_back(std::move(Func));
|
2019-07-03 03:59:56 +08:00
|
|
|
// Info is wrapped in its parent scope so it's returned in the second position
|
2019-07-13 02:32:00 +08:00
|
|
|
return {nullptr, std::unique_ptr<Info>{std::move(ParentI)}};
|
2018-03-23 07:34:46 +08:00
|
|
|
}
|
|
|
|
|
2019-07-03 03:59:56 +08:00
|
|
|
std::pair<std::unique_ptr<Info>, std::unique_ptr<Info>>
|
|
|
|
emitInfo(const EnumDecl *D, const FullComment *FC, int LineNumber,
|
2019-08-10 01:49:41 +08:00
|
|
|
llvm::StringRef File, bool IsFileInRootDir, bool PublicOnly) {
|
2018-08-03 04:10:17 +08:00
|
|
|
EnumInfo Enum;
|
2019-06-29 03:07:56 +08:00
|
|
|
bool IsInAnonymousNamespace = false;
|
2019-08-10 01:49:41 +08:00
|
|
|
populateSymbolInfo(Enum, D, FC, LineNumber, File, IsFileInRootDir,
|
|
|
|
IsInAnonymousNamespace);
|
2019-08-16 08:10:49 +08:00
|
|
|
if (!shouldSerializeInfo(PublicOnly, IsInAnonymousNamespace, D))
|
2019-07-03 03:59:56 +08:00
|
|
|
return {};
|
2019-06-29 03:07:56 +08:00
|
|
|
|
2018-08-03 04:10:17 +08:00
|
|
|
Enum.Scoped = D->isScoped();
|
|
|
|
parseEnumerators(Enum, D);
|
|
|
|
|
2019-07-13 02:32:00 +08:00
|
|
|
// Put in global namespace
|
|
|
|
if (Enum.Namespace.empty()) {
|
2019-08-15 07:52:23 +08:00
|
|
|
auto ParentI = std::make_unique<NamespaceInfo>();
|
2019-07-13 02:32:00 +08:00
|
|
|
ParentI->USR = SymbolID();
|
|
|
|
ParentI->ChildEnums.emplace_back(std::move(Enum));
|
|
|
|
ParentI->Path = getInfoRelativePath(ParentI->Namespace);
|
|
|
|
// Info is wrapped in its parent scope so it's returned in the second
|
|
|
|
// position
|
|
|
|
return {nullptr, std::unique_ptr<Info>{std::move(ParentI)}};
|
2018-08-03 04:10:17 +08:00
|
|
|
}
|
|
|
|
|
2019-07-13 02:32:00 +08:00
|
|
|
// Wrap in enclosing scope
|
|
|
|
switch (Enum.Namespace[0].RefType) {
|
|
|
|
case InfoType::IT_namespace: {
|
2019-08-15 07:52:23 +08:00
|
|
|
auto ParentI = std::make_unique<NamespaceInfo>();
|
2019-07-13 02:32:00 +08:00
|
|
|
ParentI->USR = Enum.Namespace[0].USR;
|
|
|
|
ParentI->ChildEnums.emplace_back(std::move(Enum));
|
|
|
|
// Info is wrapped in its parent scope so it's returned in the second
|
|
|
|
// position
|
|
|
|
return {nullptr, std::unique_ptr<Info>{std::move(ParentI)}};
|
|
|
|
}
|
|
|
|
case InfoType::IT_record: {
|
2019-08-15 07:52:23 +08:00
|
|
|
auto ParentI = std::make_unique<RecordInfo>();
|
2019-07-13 02:32:00 +08:00
|
|
|
ParentI->USR = Enum.Namespace[0].USR;
|
|
|
|
ParentI->ChildEnums.emplace_back(std::move(Enum));
|
|
|
|
// Info is wrapped in its parent scope so it's returned in the second
|
|
|
|
// position
|
|
|
|
return {nullptr, std::unique_ptr<Info>{std::move(ParentI)}};
|
|
|
|
}
|
|
|
|
default:
|
|
|
|
llvm_unreachable("Invalid reference type for parent namespace");
|
|
|
|
}
|
2018-03-23 07:34:46 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
} // namespace serialize
|
|
|
|
} // namespace doc
|
|
|
|
} // namespace clang
|