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
84
85
86
87
88
89
90
| //===--- SymbolOccurrences.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_REFACTOR_RENAME_SYMBOL_OCCURRENCES_H
#define LLVM_CLANG_TOOLING_REFACTOR_RENAME_SYMBOL_OCCURRENCES_H
#include "clang/Basic/LLVM.h"
#include "clang/Basic/SourceLocation.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/StringRef.h"
#include <vector>
namespace clang {
namespace tooling {
class SymbolName;
/// An occurrence of a symbol in the source.
///
/// Occurrences can have difference kinds, that describe whether this occurrence
/// is an exact semantic match, or whether this is a weaker textual match that's
/// not guaranteed to represent the exact declaration.
///
/// A single occurrence of a symbol can span more than one source range. For
/// example, Objective-C selectors can contain multiple argument labels:
///
/// \code
/// [object selectorPiece1: ... selectorPiece2: ...];
/// // ^~~ range 0 ~~ ^~~ range 1 ~~
/// \endcode
///
/// We have to replace the text in both range 0 and range 1 when renaming the
/// Objective-C method 'selectorPiece1:selectorPiece2'.
class SymbolOccurrence {
public:
enum OccurrenceKind {
/// This occurrence is an exact match and can be renamed automatically.
///
/// Note:
/// Symbol occurrences in macro arguments that expand to different
/// declarations get marked as exact matches, and thus the renaming engine
/// will rename them e.g.:
///
/// \code
/// #define MACRO(x) x + ns::x
/// int foo(int var) {
/// return MACRO(var); // var is renamed automatically here when
/// // either var or ns::var is renamed.
/// };
/// \endcode
///
/// The user will have to fix their code manually after performing such a
/// rename.
/// FIXME: The rename verifier should notify user about this issue.
MatchingSymbol
};
SymbolOccurrence(const SymbolName &Name, OccurrenceKind Kind,
ArrayRef<SourceLocation> Locations);
SymbolOccurrence(SymbolOccurrence &&) = default;
SymbolOccurrence &operator=(SymbolOccurrence &&) = default;
OccurrenceKind getKind() const { return Kind; }
ArrayRef<SourceRange> getNameRanges() const {
if (MultipleRanges) {
return llvm::makeArrayRef(MultipleRanges.get(),
RangeOrNumRanges.getBegin().getRawEncoding());
}
return RangeOrNumRanges;
}
private:
OccurrenceKind Kind;
std::unique_ptr<SourceRange[]> MultipleRanges;
SourceRange RangeOrNumRanges;
};
using SymbolOccurrences = std::vector<SymbolOccurrence>;
} // end namespace tooling
} // end namespace clang
#endif // LLVM_CLANG_TOOLING_REFACTOR_RENAME_SYMBOL_OCCURRENCES_H
|