blob: 1230ea0f797bea315d097062a6145f2f7635eeb1 (
plain) (
blame)
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
#pragma once
#ifdef __GNUC__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
#endif
//===--- RefactoringActionRule.h - Clang refactoring library -------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_CLANG_TOOLING_REFACTORING_REFACTORINGACTIONRULE_H
#define LLVM_CLANG_TOOLING_REFACTORING_REFACTORINGACTIONRULE_H
#include "clang/Basic/LLVM.h"
#include "llvm/ADT/Optional.h"
#include "llvm/ADT/StringRef.h"
namespace clang {
namespace tooling {
class RefactoringOptionVisitor;
class RefactoringResultConsumer;
class RefactoringRuleContext;
struct RefactoringDescriptor {
/// A unique identifier for the specific refactoring.
StringRef Name;
/// A human readable title for the refactoring.
StringRef Title;
/// A human readable description of what the refactoring does.
StringRef Description;
};
/// A common refactoring action rule interface that defines the 'invoke'
/// function that performs the refactoring operation (either fully or
/// partially).
class RefactoringActionRuleBase {
public:
virtual ~RefactoringActionRuleBase() {}
/// Initiates and performs a specific refactoring action.
///
/// The specific rule will invoke an appropriate \c handle method on a
/// consumer to propagate the result of the refactoring action.
virtual void invoke(RefactoringResultConsumer &Consumer,
RefactoringRuleContext &Context) = 0;
/// Returns the structure that describes the refactoring.
// static const RefactoringDescriptor &describe() = 0;
};
/// A refactoring action rule is a wrapper class around a specific refactoring
/// action rule (SourceChangeRefactoringRule, etc) that, in addition to invoking
/// the action, describes the requirements that determine when the action can be
/// initiated.
class RefactoringActionRule : public RefactoringActionRuleBase {
public:
/// Returns true when the rule has a source selection requirement that has
/// to be fulfilled before refactoring can be performed.
virtual bool hasSelectionRequirement() = 0;
/// Traverses each refactoring option used by the rule and invokes the
/// \c visit callback in the consumer for each option.
///
/// Options are visited in the order of use, e.g. if a rule has two
/// requirements that use options, the options from the first requirement
/// are visited before the options in the second requirement.
virtual void visitRefactoringOptions(RefactoringOptionVisitor &Visitor) = 0;
};
} // end namespace tooling
} // end namespace clang
#endif // LLVM_CLANG_TOOLING_REFACTORING_REFACTORINGACTIONRULE_H
#ifdef __GNUC__
#pragma GCC diagnostic pop
#endif
|
