-
Notifications
You must be signed in to change notification settings - Fork 3
/
Synchronizer.java
377 lines (341 loc) · 11.9 KB
/
Synchronizer.java
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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
/*******************************************************************************
* Copyright (c) 2023 Obeo.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v20.html
*
* Contributors:
* Obeo - initial API and implementation
*******************************************************************************/
package org.eclipse.acceleo.query.ide.runtime.impl.namespace.workspace;
import java.net.URI;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import org.eclipse.acceleo.query.ide.QueryPlugin;
import org.eclipse.acceleo.query.ide.runtime.namespace.workspace.IWorkspaceResolverProvider;
import org.eclipse.acceleo.query.runtime.namespace.workspace.IQueryWorkspace;
import org.eclipse.acceleo.query.runtime.namespace.workspace.IQueryWorkspaceQualifiedNameResolver;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IResourceChangeEvent;
import org.eclipse.core.resources.IResourceChangeListener;
import org.eclipse.core.resources.IResourceDelta;
import org.eclipse.core.resources.IResourceDeltaVisitor;
import org.eclipse.core.resources.IResourceVisitor;
import org.eclipse.core.resources.IWorkspace;
import org.eclipse.core.resources.IWorkspaceRoot;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.ICoreRunnable;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.SubMonitor;
import org.eclipse.core.runtime.jobs.Job;
/**
* Synchronizer that scan the initial state of the {@link IWorkspace} and listen to its changes.
*
* @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
*/
public abstract class Synchronizer<P> implements IResourceVisitor, IResourceChangeListener, IResourceDeltaVisitor, IWorkspaceResolverProvider {
/**
* Counts {@link IResource} i the workspace.
*
* @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
*/
private final class ResourceCounter implements IResourceVisitor {
private int count;
@Override
public boolean visit(IResource resource) throws CoreException {
final boolean res;
final IProject project = resource.getProject();
if (project == null || project.isOpen()) {
count++;
res = true;
} else {
res = resource instanceof IWorkspaceRoot;
}
return res;
}
public int getCount() {
return count;
}
}
/**
* The Eclipse {@link IWorkspace}.
*/
private final IWorkspace eclipseWorkspace;
/**
* The {@link IQueryWorkspace} to synchronize.
*/
private final IQueryWorkspace<P> queryWorkspace;
/**
* The mapping from {@link IProject} to project.
*/
private final Map<IProject, P> eclipseToProject = new HashMap<>();
/**
* The mapping from project to {@link IProject}.
*/
private final Map<P, IProject> projectToEclipse = new HashMap<>();
/**
* The {@link IProgressMonitor}.
*/
private IProgressMonitor monitor;
/**
* @param queryWorkspace
*/
public Synchronizer(IWorkspace eclipseWorkspace, IQueryWorkspace<P> queryWorkspace) {
this.eclipseWorkspace = eclipseWorkspace;
this.queryWorkspace = queryWorkspace;
}
/**
* Starts synchronizing.
*/
public void synchronize() {
final Job synchronizeJob = Job.create("Synchronizing " + queryWorkspace.getName(),
new ICoreRunnable() {
@Override
public void run(IProgressMonitor monitor) throws CoreException {
try {
// Keeping up-to-date with the workspace changes.
eclipseWorkspace.addResourceChangeListener(Synchronizer.this);
// walk the workspace for current state
final ResourceCounter resourceCounter = new ResourceCounter();
eclipseWorkspace.getRoot().accept(resourceCounter);
final SubMonitor subMonitor = SubMonitor.convert(monitor, "Validating",
resourceCounter.getCount());
Synchronizer.this.monitor = subMonitor;
try {
eclipseWorkspace.getRoot().accept(Synchronizer.this);
} finally {
Synchronizer.this.monitor = null;
}
} catch (Exception e) {
dispose();
QueryPlugin.INSTANCE.log(new Status(IStatus.ERROR, getClass(),
"can't visit the workspace current state: " + eclipseWorkspace.getRoot()
.getLocationURI().toString(), e));
}
}
});
synchronizeJob.schedule();
}
/**
* Disposes the synchronizer.
*/
public void dispose() {
eclipseWorkspace.removeResourceChangeListener(this);
}
@Override
public void resourceChanged(IResourceChangeEvent event) {
if (event.getType() != IResourceChangeEvent.POST_CHANGE) {
return;
}
IResourceDelta delta = event.getDelta();
try {
delta.accept(this);
} catch (CoreException coreException) {
final URI workspaceURI = this.eclipseWorkspace.getRoot().getLocationURI();
QueryPlugin.INSTANCE.log(new Status(IStatus.ERROR, getClass(),
"There was an issue while updating workspace" + workspaceURI, coreException));
}
}
@Override
public boolean visit(IResourceDelta delta) throws CoreException {
if (delta.getFlags() == IResourceDelta.MARKERS) {
// Only markers have changed.
// Do nothing.
} else {
IResource resource = delta.getResource();
if (resource.getType() == IResource.PROJECT) {
IProject workspaceProject = (IProject)resource;
visitProjectDelta(delta, workspaceProject);
} else if (resource.getType() == IResource.FILE) {
final IFile file = (IFile)resource;
visitFileDelta(delta, file);
}
}
return true;
}
/**
* When an {@link IFile} of the client workspace changes.
*
* @param delta
* the (non-{@code null}) {@link IResourceDelta}.
* @param file
* the (non-{@code null}) {@link IFile}.
*/
private void visitFileDelta(IResourceDelta delta, IFile file) {
if (delta.getKind() == IResourceDelta.CHANGED) {
if ((delta.getFlags() & IResourceDelta.CONTENT) != 0) {
// The contents of the IFile have changed.
this.queryWorkspace.changeResource(getProject(file.getProject()), file.getLocationURI());
}
if ((delta.getFlags() & IResourceDelta.ENCODING) != 0) {
// The encoding of the IFile has changed which means its contents have changed.
this.queryWorkspace.changeResource(getProject(file.getProject()), file.getLocationURI());
}
if ((delta.getFlags() & IResourceDelta.MOVED_FROM) != 0) {
// The location of the IFile has moved, maybe even changed container project, so
// re-compute it.
// TODO optimize move by calling moveResource() to limit validations
this.queryWorkspace.changeResource(getProject(file.getProject()), file.getLocationURI());
}
if ((delta.getFlags() & IResourceDelta.MOVED_TO) != 0) {
// Do nothing, this is a "ghost" from a past IFile.
}
if ((delta.getFlags() & IResourceDelta.REPLACED) != 0) {
// Re-compute the IFile->AcceleoTextDocument.
this.queryWorkspace.changeResource(getProject(file.getProject()), file.getLocationURI());
}
} else if (delta.getKind() == IResourceDelta.ADDED) {
this.queryWorkspace.addResource(getProject(file.getProject()), file.getLocationURI());
} else if (delta.getKind() == IResourceDelta.REMOVED) {
this.queryWorkspace.removeResource(getProject(file.getProject()), file.getLocationURI());
}
}
/**
* When an {@link IProject} of the client workspace changes.
*
* @param delta
* the (non-{@code null}) {@link IResourceDelta}.
* @param eclipseProject
* the (non-{@code null}) {@link IProject}.
*/
private void visitProjectDelta(IResourceDelta delta, IProject eclipseProject) {
if (delta.getKind() == IResourceDelta.CHANGED) {
if ((delta.getFlags() & IResourceDelta.ENCODING) != 0) {
// Changing the encoding of an IProject may affect the encoding of all its
// contained
// IFiles.
this.queryWorkspace.removeProject(getProject(eclipseProject));
this.queryWorkspace.addProject(getProject(eclipseProject));
}
if ((delta.getFlags() & IResourceDelta.MOVED_FROM) != 0) {
// The location of the IProject has changed
// TODO optimize this in QueryWorkspace like resource move
this.queryWorkspace.removeProject(getProject(eclipseProject));
this.queryWorkspace.addProject(getProject(eclipseProject));
}
if ((delta.getFlags() & IResourceDelta.MOVED_TO) != 0) {
// Do nothing, this is a "ghost" from a past IProject.
}
if ((delta.getFlags() & IResourceDelta.REPLACED) != 0) {
// Re-compute the IProject.
this.queryWorkspace.removeProject(getProject(eclipseProject));
this.queryWorkspace.addProject(getProject(eclipseProject));
}
} else if (delta.getKind() == IResourceDelta.ADDED) {
synchronized(this) {
if (!eclipseToProject.containsKey(eclipseProject)) {
final P project = createProject(queryWorkspace, eclipseProject);
eclipseToProject.put(eclipseProject, project);
projectToEclipse.put(project, eclipseProject);
this.queryWorkspace.addProject(project);
}
}
} else if (delta.getKind() == IResourceDelta.REMOVED) {
final P removedProject = eclipseToProject.remove(eclipseProject);
projectToEclipse.remove(removedProject);
this.queryWorkspace.removeProject(removedProject);
}
}
@Override
public boolean visit(IResource resource) throws CoreException {
final boolean res;
final IProject project = resource.getProject();
if (project == null || project.isOpen()) {
final boolean hasMonitor = monitor != null;
if (hasMonitor) {
monitor.subTask(resource.getFullPath().toString());
}
try {
add(resource);
} finally {
if (hasMonitor) {
monitor.worked(1);
}
}
res = true;
} else {
res = resource instanceof IWorkspaceRoot;
}
return res;
}
/**
* Synchronizes the given {@link IResource}.
*
* @param resource
* the (non-{@code null}) {@link IResource} to synchronize.
*/
public void add(IResource resource) {
Objects.requireNonNull(resource);
if (resource.getType() == IResource.PROJECT) {
final IProject eclipseProject = (IProject)resource;
synchronized(this) {
if (!eclipseToProject.containsKey(eclipseProject)) {
final P project = createProject(queryWorkspace, eclipseProject);
eclipseToProject.put(eclipseProject, project);
projectToEclipse.put(project, eclipseProject);
this.queryWorkspace.addProject(project);
}
}
} else if (resource.getType() == IResource.FILE) {
final IFile file = (IFile)resource;
final URI uri = file.getLocationURI();
this.queryWorkspace.addResource(getProject(file.getProject()), uri);
}
}
@Override
public IQueryWorkspaceQualifiedNameResolver getResolver(IProject project) {
return queryWorkspace.getResolver(eclipseToProject.get(project));
}
/**
* Gets the project for the given {@link IProject}.
*
* @param project
* the {@link IProject}
* @return the project
*/
public P getProject(IProject project) {
return eclipseToProject.get(project);
}
/**
* Gets the {@link IProject} for the given project.
*
* @param project
* the project
* @return the {@link IProject}
*/
public IProject getProject(P project) {
return projectToEclipse.get(project);
}
/**
* Gets the {@link IQueryWorkspace}.
*
* @return the {@link IQueryWorkspace}
*/
public IQueryWorkspace<P> getQueryWorkspace() {
return queryWorkspace;
}
/**
* Gets the Eclipse {@link IWorkspace}.
*
* @return the Eclipse {@link IWorkspace}
*/
public IWorkspace getEclipseWorkspace() {
return eclipseWorkspace;
}
/**
* Creates a project from the given {@link IProject}.
*
* @param the
* {@link IQueryWorkspace}
* @param eclipseProject
* the {@link IProject} form Eclipse
* @return the created project from the given {@link IProject}
*/
protected abstract P createProject(IQueryWorkspace<P> queryWorkspace, IProject eclipseProject);
}