forked from apple/swift
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Refactoring.h
151 lines (125 loc) · 4.55 KB
/
Refactoring.h
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
//===--- Refactoring.h - APIs for refactoring --------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_IDE_REFACTORING_H
#define SWIFT_IDE_REFACTORING_H
#include "llvm/ADT/StringRef.h"
#include "swift/Basic/LLVM.h"
#include "swift/AST/DiagnosticConsumer.h"
#include "swift/IDE/Utils.h"
namespace swift {
class ModuleDecl;
class SourceLoc;
class SourceManager;
namespace ide {
struct SemaToken;
enum class RefactoringKind : int8_t {
None,
#define REFACTORING(KIND, NAME, ID) KIND,
#include "RefactoringKinds.def"
};
struct RangeConfig {
unsigned BufferId;
unsigned Line;
unsigned Column;
unsigned Length;
SourceLoc getStart(SourceManager &SM);
SourceLoc getEnd(SourceManager &SM);
};
enum class NameUsage {
Unknown,
Reference,
Definition,
Call
};
struct RenameLoc {
unsigned Line;
unsigned Column;
NameUsage Usage;
StringRef OldName;
StringRef NewName; // May be empty.
const bool IsFunctionLike;
const bool IsNonProtocolType;
};
struct RefactoringOptions {
RefactoringKind Kind;
RangeConfig Range;
std::string PreferredName;
RefactoringOptions(RefactoringKind Kind) : Kind(Kind) {}
};
// TODO: Merge with NoteRegion – range needs to change to start/end line/column
struct RenameRangeDetail {
CharSourceRange Range;
RefactoringRangeKind RangeKind;
Optional<unsigned> Index;
};
enum class RenameAvailableKind {
Available,
Unavailable_system_symbol,
Unavailable_has_no_location,
Unavailable_has_no_name,
Unavailable_has_no_accessibility,
Unavailable_decl_from_clang,
};
struct RenameAvailabiliyInfo {
RefactoringKind Kind;
RenameAvailableKind AvailableKind;
RenameAvailabiliyInfo(RefactoringKind Kind, RenameAvailableKind AvailableKind) :
Kind(Kind), AvailableKind(AvailableKind) {}
RenameAvailabiliyInfo(RefactoringKind Kind) :
RenameAvailabiliyInfo(Kind, RenameAvailableKind::Available) {}
};
class FindRenameRangesConsumer {
public:
virtual void accept(SourceManager &SM, RegionType RegionType,
ArrayRef<RenameRangeDetail> Ranges) = 0;
virtual ~FindRenameRangesConsumer() = default;
};
class FindRenameRangesAnnotatingConsumer : public FindRenameRangesConsumer {
struct Implementation;
Implementation &Impl;
public:
FindRenameRangesAnnotatingConsumer(SourceManager &SM, unsigned BufferId,
llvm::raw_ostream &OS);
~FindRenameRangesAnnotatingConsumer();
void accept(SourceManager &SM, RegionType RegionType,
ArrayRef<RenameRangeDetail> Ranges) override;
};
StringRef getDescriptiveRefactoringKindName(RefactoringKind Kind);
StringRef getDescriptiveRenameUnavailableReason(RenameAvailableKind Kind);
bool refactorSwiftModule(ModuleDecl *M, RefactoringOptions Opts,
SourceEditConsumer &EditConsumer,
DiagnosticConsumer &DiagConsumer);
int syntacticRename(SourceFile *SF, llvm::ArrayRef<RenameLoc> RenameLocs,
SourceEditConsumer &EditConsumer,
DiagnosticConsumer &DiagConsumer);
int findSyntacticRenameRanges(SourceFile *SF,
llvm::ArrayRef<RenameLoc> RenameLocs,
FindRenameRangesConsumer &RenameConsumer,
DiagnosticConsumer &DiagConsumer);
int findLocalRenameRanges(SourceFile *SF, RangeConfig Range,
FindRenameRangesConsumer &RenameConsumer,
DiagnosticConsumer &DiagConsumer);
ArrayRef<RefactoringKind>
collectAvailableRefactorings(SourceFile *SF, RangeConfig Range,
bool &RangeStartMayNeedRename,
std::vector<RefactoringKind> &Scratch,
llvm::ArrayRef<DiagnosticConsumer*> DiagConsumers);
ArrayRef<RefactoringKind>
collectAvailableRefactorings(SourceFile *SF, SemaToken Tok,
std::vector<RefactoringKind> &Scratch,
bool ExcludeRename);
ArrayRef<RenameAvailabiliyInfo>
collectRenameAvailabilityInfo(const ValueDecl *VD,
std::vector<RenameAvailabiliyInfo> &Scratch);
} // namespace ide
} // namespace swift
#endif // SWIFT_IDE_REFACTORING_H