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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
/*******************************************************************************
* Copyright (c) 2000, 2007 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.text.edits;
/**
* A visitor for text edits.
* <p>
* For each different concrete text edit type <it>T</it> there is a method:
* <ul>
* <li><code>public boolean visit(<it>T</it> node)</code> - Visits the given edit to
* perform some arbitrary operation. If <code>true </code> is returned, the given edit's
* child edits will be visited next; however, if <code>false</code> is returned, the
* given edit's child edits will not be visited. The default implementation provided by
* this class calls a generic method <code>visitNode(<it>TextEdit</it> node)</code>.
* Subclasses may reimplement these method as needed.</li>
* </ul>
* </p>
* <p>
* In addition, there are methods for visiting text edits in the
* abstract, regardless of node type:
* <ul>
* <li><code>public void preVisit(TextEdit edit)</code> - Visits
* the given edit to perform some arbitrary operation.
* This method is invoked prior to the appropriate type-specific
* <code>visit</code> method.
* The default implementation of this method does nothing.
* Subclasses may reimplement this method as needed.</li>
*
* <li><code>public void postVisit(TextEdit edit)</code> - Visits
* the given edit to perform some arbitrary operation.
* This method is invoked after the appropriate type-specific
* <code>endVisit</code> method.
* The default implementation of this method does nothing.
* Subclasses may reimplement this method as needed.</li>
* </ul>
* </p>
* <p>
* For edits with children, the child nodes are visited in increasing order.
* </p>
*
* @see TextEdit#accept(TextEditVisitor)
* @since 3.0
*/
public class TextEditVisitor {
/**
* Visits the given text edit prior to the type-specific visit.
* (before <code>visit</code>).
* <p>
* The default implementation does nothing. Subclasses may reimplement.
* </p>
*
* @param edit the node to visit
*/
public void preVisit(TextEdit edit) {
// default implementation: do nothing
}
/**
* Visits the given text edit following the type-specific visit
* (after <code>endVisit</code>).
* <p>
* The default implementation does nothing. Subclasses may reimplement.
* </p>
*
* @param edit the node to visit
*/
public void postVisit(TextEdit edit) {
// default implementation: do nothing
}
/**
* Visits the given text edit. This method is called by default from
* type-specific visits. It is not called by an edit's accept method.
* The default implementation returns <code>true</code>.
*
* @param edit the node to visit
* @return If <code>true</code> is returned, the given node's child
* nodes will be visited next; however, if <code>false</code> is
* returned, the given node's child nodes will not be visited.
*/
public boolean visitNode(TextEdit edit) {
return true;
}
/**
* Visits a <code>CopySourceEdit</code> instance.
*
* @param edit the node to visit
* @return If <code>true</code> is returned, the given node's child
* nodes will be visited next; however, if <code>false</code> is
* returned, the given node's child nodes will not be visited.
*/
public boolean visit(CopySourceEdit edit) {
return visitNode(edit);
}
/**
* Visits a <code>CopyTargetEdit</code> instance.
*
* @param edit the node to visit
* @return If <code>true</code> is returned, the given node's child
* nodes will be visited next; however, if <code>false</code> is
* returned, the given node's child nodes will not be visited.
*/
public boolean visit(CopyTargetEdit edit) {
return visitNode(edit);
}
/**
* Visits a <code>MoveSourceEdit</code> instance.
*
* @param edit the node to visit
* @return If <code>true</code> is returned, the given node's child
* nodes will be visited next; however, if <code>false</code> is
* returned, the given node's child nodes will not be visited.
*/
public boolean visit(MoveSourceEdit edit) {
return visitNode(edit);
}
/**
* Visits a <code>MoveTargetEdit</code> instance.
*
* @param edit the node to visit
* @return If <code>true</code> is returned, the given node's child
* nodes will be visited next; however, if <code>false</code> is
* returned, the given node's child nodes will not be visited.
*/
public boolean visit(MoveTargetEdit edit) {
return visitNode(edit);
}
/**
* Visits a <code>RangeMarker</code> instance.
*
* @param edit the node to visit
* @return If <code>true</code> is returned, the given node's child
* nodes will be visited next; however, if <code>false</code> is
* returned, the given node's child nodes will not be visited.
*/
public boolean visit(RangeMarker edit) {
return visitNode(edit);
}
/**
* Visits a <code>CopyingRangeMarker</code> instance.
*
* @param edit the node to visit
* @return If <code>true</code> is returned, the given node's child
* nodes will be visited next; however, if <code>false</code> is
* returned, the given node's child nodes will not be visited.
*/
public boolean visit(CopyingRangeMarker edit) {
return visitNode(edit);
}
/**
* Visits a <code>DeleteEdit</code> instance.
*
* @param edit the node to visit
* @return If <code>true</code> is returned, the given node's child
* nodes will be visited next; however, if <code>false</code> is
* returned, the given node's child nodes will not be visited.
*/
public boolean visit(DeleteEdit edit) {
return visitNode(edit);
}
/**
* Visits a <code>InsertEdit</code> instance.
*
* @param edit the node to visit
* @return If <code>true</code> is returned, the given node's child
* nodes will be visited next; however, if <code>false</code> is
* returned, the given node's child nodes will not be visited.
*/
public boolean visit(InsertEdit edit) {
return visitNode(edit);
}
/**
* Visits a <code>ReplaceEdit</code> instance.
*
* @param edit the node to visit
* @return If <code>true</code> is returned, the given node's child
* nodes will be visited next; however, if <code>false</code> is
* returned, the given node's child nodes will not be visited.
*/
public boolean visit(ReplaceEdit edit) {
return visitNode(edit);
}
/**
* Visits a <code>UndoEdit</code> instance.
*
* @param edit the node to visit
* @return If <code>true</code> is returned, the given node's child
* nodes will be visited next; however, if <code>false</code> is
* returned, the given node's child nodes will not be visited.
*/
public boolean visit(UndoEdit edit) {
return visitNode(edit);
}
/**
* Visits a <code>MultiTextEdit</code> instance.
*
* @param edit the node to visit
* @return If <code>true</code> is returned, the given node's child
* nodes will be visited next; however, if <code>false</code> is
* returned, the given node's child nodes will not be visited.
*/
public boolean visit(MultiTextEdit edit) {
return visitNode(edit);
}
}
|
