97ec3ef4ab
This patch adds start and end line numbers to clang-doc. Currently clang-doc only encodes the start line numbers of records, struct, etc. This patch adds start and end line number to clang-doc bitcode which is passed to the generator. This will be used by the mustache backend to generate line ranges. Based on the orginal patch in #135081. Co-author: Paul Kirth <paulkirth@google.com> Co-authored-by: PeterChou1 <peter.chou@mail.utoronto.ca>
65 lines
2.3 KiB
C++
65 lines
2.3 KiB
C++
//===-- Mapper.h - ClangDoc Mapper ------------------------------*- C++ -*-===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file implements the Mapper piece of the clang-doc tool. It implements
|
|
// a RecursiveASTVisitor to look at each declaration and populate the info
|
|
// into the internal representation. Each seen declaration is serialized to
|
|
// to bitcode and written out to the ExecutionContext as a KV pair where the
|
|
// key is the declaration's USR and the value is the serialized bitcode.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_MAPPER_H
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_MAPPER_H
|
|
|
|
#include "Representation.h"
|
|
#include "clang/AST/RecursiveASTVisitor.h"
|
|
#include "clang/Tooling/Execution.h"
|
|
|
|
using namespace clang::comments;
|
|
using namespace clang::tooling;
|
|
|
|
namespace clang {
|
|
namespace doc {
|
|
|
|
class MapASTVisitor : public clang::RecursiveASTVisitor<MapASTVisitor>,
|
|
public ASTConsumer {
|
|
public:
|
|
explicit MapASTVisitor(ASTContext *Ctx, ClangDocContext CDCtx)
|
|
: CDCtx(CDCtx) {}
|
|
|
|
void HandleTranslationUnit(ASTContext &Context) override;
|
|
bool VisitNamespaceDecl(const NamespaceDecl *D);
|
|
bool VisitRecordDecl(const RecordDecl *D);
|
|
bool VisitEnumDecl(const EnumDecl *D);
|
|
bool VisitCXXMethodDecl(const CXXMethodDecl *D);
|
|
bool VisitFunctionDecl(const FunctionDecl *D);
|
|
bool VisitTypedefDecl(const TypedefDecl *D);
|
|
bool VisitTypeAliasDecl(const TypeAliasDecl *D);
|
|
|
|
private:
|
|
template <typename T> bool mapDecl(const T *D, bool IsDefinition);
|
|
|
|
int getLine(const NamedDecl *D, const ASTContext &Context) const;
|
|
|
|
Location getDeclLocation(const NamedDecl *D) const;
|
|
|
|
llvm::SmallString<128> getFile(const NamedDecl *D, const ASTContext &Context,
|
|
StringRef RootDir,
|
|
bool &IsFileInRootDir) const;
|
|
comments::FullComment *getComment(const NamedDecl *D,
|
|
const ASTContext &Context) const;
|
|
|
|
ClangDocContext CDCtx;
|
|
};
|
|
|
|
} // namespace doc
|
|
} // namespace clang
|
|
|
|
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_MAPPER_H
|