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
229
|
/*******************************************************************************
* Copyright (c) 2001, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* Jens Lukowski/Innoopract - initial renaming/restructuring
*
*******************************************************************************/
package org.eclipse.wst.sse.ui.internal.reconcile;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import org.eclipse.core.runtime.Platform;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.ITypedRegion;
import org.eclipse.jface.text.TextUtilities;
import org.eclipse.jface.text.reconciler.AbstractReconcileStep;
import org.eclipse.jface.text.reconciler.DirtyRegion;
import org.eclipse.jface.text.reconciler.IReconcilableModel;
import org.eclipse.jface.text.reconciler.IReconcileResult;
import org.eclipse.jface.text.reconciler.IReconcileStep;
import org.eclipse.wst.sse.core.internal.provisional.text.IStructuredDocument;
import org.eclipse.wst.sse.core.internal.provisional.text.IStructuredDocumentRegion;
import org.eclipse.wst.sse.core.internal.provisional.text.IStructuredPartitionTypes;
import org.eclipse.wst.sse.core.internal.provisional.text.IStructuredPartitioning;
import org.eclipse.wst.sse.ui.internal.IReleasable;
import org.eclipse.wst.sse.ui.internal.Logger;
/**
* ReconcileStep that knows about the annotation that it adds to the
* AnnotationModel. It knows how to create an annotation key (for smart
* removal later) It knows the partition types on which it can operate. It
* knows the scope on which it operates (for short circuiting) It knows if the
* Reconciler is reconciling the entire document.
*
* Clients must subclass this class.
*
* @author pavery
*/
public abstract class StructuredReconcileStep extends AbstractReconcileStep implements IReleasable {
/** debug flag */
protected static final boolean DEBUG;
static {
String value = Platform.getDebugOption("org.eclipse.wst.sse.ui/debug/reconcilerjob"); //$NON-NLS-1$
DEBUG = value != null && value.equalsIgnoreCase("true"); //$NON-NLS-1$
}
protected final IReconcileResult[] EMPTY_RECONCILE_RESULT_SET = new IReconcileResult[0];
private StructuredReconcileStep fNextStructuredStep = null;
/**
* It's possible for a partial step to get called on the same area twice
* (as w/ a full document reconcile) this list keeps track of area already
* covered. Should be reset() after the "batch" of reconciling is
* finished.
*/
private HashSet fPartitionTypes = null;
public StructuredReconcileStep() {
super();
fPartitionTypes = new HashSet();
}
public StructuredReconcileStep(IReconcileStep step) {
super(step);
if (step instanceof StructuredReconcileStep)
fNextStructuredStep = (StructuredReconcileStep) step;
fPartitionTypes = new HashSet();
}
public ReconcileAnnotationKey createKey(IStructuredDocumentRegion sdRegion, int scope) {
ITypedRegion tr = getPartition(sdRegion);
String partitionType = (tr != null) ? tr.getType() : IStructuredPartitionTypes.UNKNOWN_PARTITION;
return createKey(partitionType, scope);
}
/**
* @param sdRegion
* @return
*/
protected ITypedRegion getPartition(IStructuredDocumentRegion sdRegion) {
ITypedRegion tr = null;
if (!sdRegion.isDeleted())
tr = getPartition(sdRegion.getParentDocument(), sdRegion.getStartOffset());
return tr;
}
private ITypedRegion getPartition(IDocument doc, int offset) {
ITypedRegion tr = null;
// not sure why document would ever be null, but put in this
// guard for
// https://bugs.eclipse.org/bugs/show_bug.cgi?id=86069
if (doc != null) {
try {
tr = TextUtilities.getPartition(doc, IStructuredPartitioning.DEFAULT_STRUCTURED_PARTITIONING, offset, false);
} catch (BadLocationException e) {
if (DEBUG)
Logger.logException("problem getting partition at: " + offset, e); //$NON-NLS-1$
}
}
return tr;
}
/**
* Clients should use this method to create annotation keys as it
* registers the key for removal later.
*
* @param partitionType
* @param scope
* @return
*/
public ReconcileAnnotationKey createKey(String partitionType, int scope) {
fPartitionTypes.add(partitionType);
return new ReconcileAnnotationKey(this, partitionType, scope);
}
protected IDocument getDocument() {
IDocument doc = null;
IReconcilableModel rModel = getModel();
if (rModel instanceof DocumentAdapter) {
doc = ((DocumentAdapter) rModel).getDocument();
}
return doc;
}
public IReconcilableModel getModel() {
return getInputModel();
}
public String getPartitionType(IDocument doc, int offset) {
ITypedRegion tr = getPartition(doc, offset);
return (tr != null) ? tr.getType() : IStructuredPartitionTypes.UNKNOWN_PARTITION;
}
public String[] getPartitionTypes() {
// using hash set to automatically get rid of dupes
HashSet tempResults = new HashSet();
// add these partition types
tempResults.addAll(fPartitionTypes);
// add next step's partition types
if (fNextStructuredStep != null) {
String[] nextResults = fNextStructuredStep.getPartitionTypes();
for (int i = 0; i < nextResults.length; i++)
tempResults.add(nextResults[i]);
}
return (String[]) tempResults.toArray(new String[tempResults.size()]);
}
protected IStructuredDocument getStructuredDocument() {
IStructuredDocument sDoc = null;
IDocument doc = getDocument();
if (doc instanceof IStructuredDocument)
sDoc = (IStructuredDocument) getDocument();
return sDoc;
}
/**
* If step passed in is found somewhere in the chain of steps.
*
* @return true if step passed in is found somewhere in the chain of
* steps, else false
*/
public boolean isSiblingStep(IReconcileStep step) {
if (step == null)
return false;
else if (step.equals(this))
return true;
else if (isLastStep())
return false;
else
return fNextStructuredStep.isSiblingStep(step);
}
/**
* Removes duplicates.
*
* @param results1
* @param results2
* @return
*/
protected IReconcileResult[] merge(IReconcileResult[] results1, IReconcileResult[] results2) {
if (results1 == null)
return results2;
if (results2 == null)
return results1;
List results = new ArrayList();
results.addAll(Arrays.asList(results1));
for (int i = 0; i < results2.length; i++) {
results.add(results2[i]);
}
return (IReconcileResult[]) results.toArray(new IReconcileResult[results.size()]);
}
/*
* (non-Javadoc)
*
* @see org.eclipse.jface.text.reconciler.AbstractReconcileStep#reconcileModel(org.eclipse.jface.text.reconciler.DirtyRegion,
* org.eclipse.jface.text.IRegion)
*/
protected IReconcileResult[] reconcileModel(DirtyRegion dirtyRegion, IRegion subRegion) {
return EMPTY_RECONCILE_RESULT_SET;
}
/**
* Release resources used by the step here as needed. Be sure to call
* super.release() when you override this method as to propagate the
* release through all steps.
*/
public void release() {
if (fNextStructuredStep != null)
fNextStructuredStep.release();
// we don't to null out the steps, in case
// it's reconfigured later
// fNextStructuredStep = null;
}
}
|
