File: InsertionPoint.h

package info (click to toggle)
llvm-toolchain-14 1%3A14.0.6-16
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,496,368 kB
  • sloc: cpp: 5,593,980; ansic: 986,873; asm: 585,869; python: 184,223; objc: 72,530; lisp: 31,119; f90: 27,793; javascript: 9,780; pascal: 9,762; sh: 9,482; perl: 7,468; ml: 5,432; awk: 3,523; makefile: 2,547; xml: 953; cs: 573; fortran: 567
file content (53 lines) | stat: -rw-r--r-- 2,458 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
//===--- InsertionPoint.h - Where should we add new code? --------*- 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
//
//===----------------------------------------------------------------------===//

#include "clang/AST/DeclCXX.h"
#include "clang/Basic/Specifiers.h"
#include "clang/Tooling/Core/Replacement.h"

namespace clang {
namespace clangd {

// An anchor describes where to insert code into a decl sequence.
//
// It allows inserting above or below a block of decls matching some criterion.
// For example, "insert after existing constructors".
struct Anchor {
  // A predicate describing which decls are considered part of a block.
  // Match need not handle TemplateDecls, which are unwrapped before matching.
  std::function<bool(const Decl *)> Match;
  // Whether the insertion point should be before or after the matching block.
  enum Dir { Above, Below } Direction = Below;
};

// Returns the point to insert a declaration according to Anchors.
// Anchors are tried in order. For each, the first matching location is chosen.
SourceLocation insertionPoint(const DeclContext &Ctx,
                              llvm::ArrayRef<Anchor> Anchors);

// Returns an edit inserting Code inside Ctx.
// Location is chosen according to Anchors, falling back to the end of Ctx.
// Fails if the chosen insertion point is in a different file than Ctx itself.
llvm::Expected<tooling::Replacement> insertDecl(llvm::StringRef Code,
                                                const DeclContext &Ctx,
                                                llvm::ArrayRef<Anchor> Anchors);

// Variant for C++ classes that ensures the right access control.
SourceLocation insertionPoint(const CXXRecordDecl &InClass,
                              std::vector<Anchor> Anchors,
                              AccessSpecifier Protection);

// Variant for C++ classes that ensures the right access control.
// May insert a new access specifier if needed.
llvm::Expected<tooling::Replacement> insertDecl(llvm::StringRef Code,
                                                const CXXRecordDecl &InClass,
                                                std::vector<Anchor> Anchors,
                                                AccessSpecifier Protection);

} // namespace clangd
} // namespace clang