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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
/*******************************************************************************
* 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.validator;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Platform;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.reconciler.DirtyRegion;
import org.eclipse.jface.text.reconciler.IReconcileResult;
import org.eclipse.jface.text.reconciler.IReconcileStep;
import org.eclipse.wst.sse.core.IStructuredModel;
import org.eclipse.wst.sse.core.StructuredModelManager;
import org.eclipse.wst.sse.core.internal.util.URIResolver;
import org.eclipse.wst.sse.ui.internal.Logger;
import org.eclipse.wst.sse.ui.internal.reconcile.ReconcileAnnotationKey;
import org.eclipse.wst.sse.ui.internal.reconcile.StructuredReconcileStep;
import org.eclipse.wst.sse.ui.internal.reconcile.TemporaryAnnotation;
import org.eclipse.wst.validation.internal.provisional.core.IMessage;
import org.eclipse.wst.validation.internal.provisional.core.IValidator;
/**
* A reconcile step for an IValidator for reconcile. Used the reconcile
* framework to create TemporaryAnnotations from the validator messages.
*
* @author pavery
*/
public class ReconcileStepForValidator extends StructuredReconcileStep {
/** 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$
}
private final IReconcileResult[] EMPTY_RECONCILE_RESULT_SET = new IReconcileResult[0];
private IncrementalHelper fHelper = null;
private IncrementalReporter fReporter = null;
private int fScope = -1;
private IValidator fValidator = null;
public ReconcileStepForValidator(IValidator v, int scope) {
super();
if(v == null)
throw new IllegalArgumentException("validator cannot be null"); //$NON-NLS-1$
fValidator = v;
fScope = scope;
}
public ReconcileStepForValidator(IValidator v, IReconcileStep step, int scope) {
super(step);
fValidator = v;
fScope = scope;
}
/**
* Converts a map of IValidatorForReconcile to List to annotations based
* on those messages
*
* @param messages
* @return
*/
protected IReconcileResult[] createAnnotations(List messageList) {
List annotations = new ArrayList();
for (int i = 0; i < messageList.size(); i++) {
IMessage validationMessage = (IMessage) messageList.get(i);
int offset = validationMessage.getOffset();
if (offset < 0)
continue;
String messageText = null;
try {
messageText = validationMessage.getText(validationMessage.getClass().getClassLoader());
} catch (Exception t) {
Logger.logException("exception reporting message from validator", t); //$NON-NLS-1$
continue;
}
String type = TemporaryAnnotation.ANNOT_INFO;
switch (validationMessage.getSeverity()) {
case IMessage.HIGH_SEVERITY :
type = TemporaryAnnotation.ANNOT_ERROR;
break;
case IMessage.NORMAL_SEVERITY :
type = TemporaryAnnotation.ANNOT_WARNING;
break;
case IMessage.LOW_SEVERITY :
type = TemporaryAnnotation.ANNOT_WARNING;
break;
case IMessage.ERROR_AND_WARNING :
type = TemporaryAnnotation.ANNOT_WARNING;
break;
}
Position p = new Position(offset, validationMessage.getLength());
ReconcileAnnotationKey key = createKey(getPartitionType(getDocument(), offset), getScope());
annotations.add(new TemporaryAnnotation(p, type, messageText, key));
}
return (IReconcileResult[]) annotations.toArray(new IReconcileResult[annotations.size()]);
}
private IFile getFile(IProject project) {
IFile file = null;
if (project != null) {
IDocument doc = getDocument();
// document may be null inbetween model/document swap
if (doc != null) {
IStructuredModel model = null;
try {
model = StructuredModelManager.getModelManager().getExistingModelForRead(doc);
// (pa) with FileBuffers, model base location is relative
// so we need to use the getFile(...) call
// file =
// project.getWorkspace().getRoot().getFileForLocation(new
// Path(model.getBaseLocation()));
file = project.getWorkspace().getRoot().getFile(new Path(model.getBaseLocation()));
} finally {
if (model != null)
model.releaseFromRead();
}
}
}
return file;
}
private IncrementalHelper getHelper(IProject project) {
if (fHelper == null)
fHelper = new IncrementalHelper(getStructuredDocument(), project);
return fHelper;
}
private IProject getProject() {
URIResolver resolver = null;
IDocument doc = getDocument();
if (doc != null) {
IStructuredModel model = StructuredModelManager.getModelManager().getExistingModelForRead(doc);
try {
if (model != null)
resolver = model.getResolver();
} finally {
if (model != null)
model.releaseFromRead();
}
}
return (resolver != null) ? resolver.getProject() : null;
}
private IncrementalReporter getReporter() {
if (fReporter == null)
fReporter = new IncrementalReporter(getProgressMonitor());
return fReporter;
}
/**
* remove from extension point
*
* @return
*/
public int getScope() {
return fScope;
}
public void initialReconcile() {
// do nothing
}
protected IReconcileResult[] reconcileModel(DirtyRegion dirtyRegion, IRegion subRegion) {
if(DEBUG)
System.out.println("[trace reconciler] > reconciling model in VALIDATOR step w/ dirty region: [" + dirtyRegion.getText() + "]"); //$NON-NLS-1$ //$NON-NLS-2$
// pa_TODO need to use dirty region if Validators can ever handle
// partial file validation
IReconcileResult[] results = EMPTY_RECONCILE_RESULT_SET;
if (dirtyRegion != null) {
try {
results = validate();
} catch (Exception ex) {
Logger.logException("EXEPTION IN RECONCILE STEP FOR VALIDATOR", ex); //$NON-NLS-1$
}
}
if(DEBUG)
System.out.println("[trace reconciler] > VALIDATOR step done"); //$NON-NLS-1$
return results;
}
public String toString() {
StringBuffer debugString = new StringBuffer("ValidatorStep: "); //$NON-NLS-1$
if (fValidator != null)
debugString.append(fValidator.getClass().toString());
return debugString.toString();
}
protected IReconcileResult[] validate() {
IReconcileResult[] results = EMPTY_RECONCILE_RESULT_SET;
IProject project = getProject();
IFile file = getFile(project);
if (file != null) {
try {
IncrementalHelper helper = getHelper(project);
IncrementalReporter reporter = getReporter();
helper.setURI(file.getFullPath().toString());
fValidator.validate(helper, reporter);
results = createAnnotations(reporter.getMessages());
reporter.removeAllMessages(fValidator);
} catch (Exception e) {
Logger.logException(e);
}
}
return results;
}
}
|
