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
|
/*******************************************************************************
* Copyright (c) 2000, 2008 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
*******************************************************************************/
package org.eclipse.jface.text.reconciler;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IDocumentExtension3;
import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.ITypedRegion;
import org.eclipse.jface.text.Region;
import org.eclipse.jface.text.TextUtilities;
import org.eclipse.jface.text.TypedRegion;
/**
* Standard implementation of {@link org.eclipse.jface.text.reconciler.IReconciler}.
* The reconciler is configured with a set of {@linkplain org.eclipse.jface.text.reconciler.IReconcilingStrategy reconciling strategies}
* each of which is responsible for a particular content type.
* <p>
* Usually, clients instantiate this class and configure it before using it.
* </p>
*
* @see org.eclipse.jface.text.IDocumentListener
* @see org.eclipse.jface.text.ITextInputListener
* @see org.eclipse.jface.text.reconciler.DirtyRegion
*/
public class Reconciler extends AbstractReconciler implements IReconcilerExtension {
/** The map of reconciling strategies. */
private Map<String, IReconcilingStrategy> fStrategies;
/**
* The partitioning this reconciler uses.
*@since 3.0
*/
private String fPartitioning;
/**
* Creates a new reconciler with the following configuration: it is
* an incremental reconciler with a standard delay of 500 milliseconds. There
* are no predefined reconciling strategies. The partitioning it uses
* is the default partitioning {@link IDocumentExtension3#DEFAULT_PARTITIONING}.
*/
public Reconciler() {
super();
fPartitioning= IDocumentExtension3.DEFAULT_PARTITIONING;
}
/**
* Sets the document partitioning for this reconciler.
*
* @param partitioning the document partitioning for this reconciler
* @since 3.0
*/
public void setDocumentPartitioning(String partitioning) {
Assert.isNotNull(partitioning);
fPartitioning= partitioning;
}
@Override
public String getDocumentPartitioning() {
return fPartitioning;
}
/**
* Registers a given reconciling strategy for a particular content type.
* If there is already a strategy registered for this type, the new strategy
* is registered instead of the old one.
*
* @param strategy the reconciling strategy to register, or <code>null</code> to remove an existing one
* @param contentType the content type under which to register
*/
public void setReconcilingStrategy(IReconcilingStrategy strategy, String contentType) {
Assert.isNotNull(contentType);
if (fStrategies == null)
fStrategies= new HashMap<>();
if (strategy == null)
fStrategies.remove(contentType);
else {
fStrategies.put(contentType, strategy);
if (strategy instanceof IReconcilingStrategyExtension && getProgressMonitor() != null) {
IReconcilingStrategyExtension extension= (IReconcilingStrategyExtension) strategy;
extension.setProgressMonitor(getProgressMonitor());
}
}
}
@Override
public IReconcilingStrategy getReconcilingStrategy(String contentType) {
Assert.isNotNull(contentType);
if (fStrategies == null)
return null;
return fStrategies.get(contentType);
}
/**
* Processes a dirty region. If the dirty region is <code>null</code> the whole
* document is consider being dirty. The dirty region is partitioned by the
* document and each partition is handed over to a reconciling strategy registered
* for the partition's content type.
*
* @param dirtyRegion the dirty region to be processed
* @see AbstractReconciler#process(DirtyRegion)
*/
@Override
protected void process(DirtyRegion dirtyRegion) {
IRegion region= dirtyRegion;
if (region == null)
region= new Region(0, getDocument().getLength());
ITypedRegion[] regions= computePartitioning(region.getOffset(), region.getLength());
for (int i= 0; i < regions.length; i++) {
ITypedRegion r= regions[i];
IReconcilingStrategy s= getReconcilingStrategy(r.getType());
if (s == null)
continue;
if(dirtyRegion != null)
s.reconcile(dirtyRegion, r);
else
s.reconcile(r);
}
}
@Override
protected void reconcilerDocumentChanged(IDocument document) {
if (fStrategies != null) {
Iterator<IReconcilingStrategy> e= fStrategies.values().iterator();
while (e.hasNext()) {
IReconcilingStrategy strategy= e.next();
strategy.setDocument(document);
}
}
}
@Override
public void setProgressMonitor(IProgressMonitor monitor) {
super.setProgressMonitor(monitor);
if (fStrategies != null) {
Iterator<IReconcilingStrategy> e= fStrategies.values().iterator();
while (e.hasNext()) {
IReconcilingStrategy strategy= e.next();
if (strategy instanceof IReconcilingStrategyExtension) {
IReconcilingStrategyExtension extension= (IReconcilingStrategyExtension) strategy;
extension.setProgressMonitor(monitor);
}
}
}
}
@Override
protected void initialProcess() {
ITypedRegion[] regions= computePartitioning(0, getDocument().getLength());
List<String> contentTypes= new ArrayList<>(regions.length);
for (int i= 0; i < regions.length; i++) {
String contentType= regions[i].getType();
if( contentTypes.contains(contentType))
continue;
contentTypes.add(contentType);
IReconcilingStrategy s= getReconcilingStrategy(contentType);
if (s instanceof IReconcilingStrategyExtension) {
IReconcilingStrategyExtension e= (IReconcilingStrategyExtension) s;
e.initialReconcile();
}
}
}
/**
* Computes and returns the partitioning for the given region of the input document
* of the reconciler's connected text viewer.
*
* @param offset the region offset
* @param length the region length
* @return the computed partitioning
* @since 3.0
*/
private ITypedRegion[] computePartitioning(int offset, int length) {
ITypedRegion[] regions= null;
try {
regions= TextUtilities.computePartitioning(getDocument(), getDocumentPartitioning(), offset, length, false);
} catch (BadLocationException x) {
regions= new TypedRegion[0];
}
return regions;
}
}
|
