clang-tools  14.0.0git
Mapper.h
Go to the documentation of this file.
1 //===-- Mapper.h - ClangDoc Mapper ------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements the Mapper piece of the clang-doc tool. It implements
10 // a RecursiveASTVisitor to look at each declaration and populate the info
11 // into the internal representation. Each seen declaration is serialized to
12 // to bitcode and written out to the ExecutionContext as a KV pair where the
13 // key is the declaration's USR and the value is the serialized bitcode.
14 //
15 //===----------------------------------------------------------------------===//
16 
17 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_MAPPER_H
18 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_MAPPER_H
19 
20 #include "Representation.h"
21 #include "clang/AST/RecursiveASTVisitor.h"
22 #include "clang/Tooling/Execution.h"
23 
24 using namespace clang::comments;
25 using namespace clang::tooling;
26 
27 namespace clang {
28 namespace doc {
29 
30 class MapASTVisitor : public clang::RecursiveASTVisitor<MapASTVisitor>,
31  public ASTConsumer {
32 public:
33  explicit MapASTVisitor(ASTContext *Ctx, ClangDocContext CDCtx)
34  : CDCtx(CDCtx) {}
35 
36  void HandleTranslationUnit(ASTContext &Context) override;
37  bool VisitNamespaceDecl(const NamespaceDecl *D);
38  bool VisitRecordDecl(const RecordDecl *D);
39  bool VisitEnumDecl(const EnumDecl *D);
40  bool VisitCXXMethodDecl(const CXXMethodDecl *D);
41  bool VisitFunctionDecl(const FunctionDecl *D);
42 
43 private:
44  template <typename T> bool mapDecl(const T *D);
45 
46  int getLine(const NamedDecl *D, const ASTContext &Context) const;
47  llvm::SmallString<128> getFile(const NamedDecl *D, const ASTContext &Context,
48  StringRef RootDir,
49  bool &IsFileInRootDir) const;
50  comments::FullComment *getComment(const NamedDecl *D,
51  const ASTContext &Context) const;
52 
53  ClangDocContext CDCtx;
54 };
55 
56 } // namespace doc
57 } // namespace clang
58 
59 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_MAPPER_H
clang::doc::MapASTVisitor::MapASTVisitor
MapASTVisitor(ASTContext *Ctx, ClangDocContext CDCtx)
Definition: Mapper.h:33
clang::doc::MapASTVisitor
Definition: Mapper.h:30
Ctx
Context Ctx
Definition: TUScheduler.cpp:460
Representation.h
ns1::ns2::D
@ D
Definition: CategoricalFeature.h:3
clang::tooling
Definition: ClangTidy.h:25
clang::doc::ClangDocContext
Definition: Representation.h:426
ASTConsumer
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27