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
|
/*******************************************************************************
* Copyright (c) 2007, 2018 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.core.filebuffers.manipulation;
import java.util.ArrayList;
import org.eclipse.core.internal.filebuffers.FileBuffersPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.ISafeRunnable;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.core.runtime.SafeRunner;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.SubMonitor;
import org.eclipse.core.runtime.jobs.IJobManager;
import org.eclipse.core.runtime.jobs.ISchedulingRule;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.core.runtime.jobs.MultiRule;
import org.eclipse.core.filebuffers.FileBuffers;
import org.eclipse.core.filebuffers.IFileBuffer;
import org.eclipse.core.filebuffers.IFileBufferManager;
import org.eclipse.core.filebuffers.IFileBufferStatusCodes;
import org.eclipse.core.filebuffers.ITextFileBuffer;
import org.eclipse.core.filebuffers.ITextFileBufferManager;
import org.eclipse.core.filebuffers.LocationKind;
/**
* A <code>GenericFileBufferOperationRunner</code> executes
* {@link org.eclipse.core.filebuffers.manipulation.IFileBufferOperation}.
* The runner takes care of all aspects that are not operation specific.
* <p>
* This class is not intended to be subclassed. Clients instantiate this class.
* </p>
*
* @see org.eclipse.core.filebuffers.manipulation.IFileBufferOperation
* @since 3.3
* @noextend This class is not intended to be subclassed by clients.
*/
public class GenericFileBufferOperationRunner {
/** The validation context */
private final Object fValidationContext;
/** The file buffer manager */
private final IFileBufferManager fFileBufferManager;
/** The lock for waiting for completion of computation in the UI thread. */
private final Object fCompletionLock= new Object();
/** The flag indicating completion of computation in the UI thread. */
private transient boolean fIsCompleted;
/** The exception thrown during the computation in the UI thread. */
private transient Throwable fThrowable;
/**
* Creates a new file buffer operation runner.
*
* @param fileBufferManager the file buffer manager
* @param validationContext the validationContext
*/
public GenericFileBufferOperationRunner(IFileBufferManager fileBufferManager, Object validationContext) {
fFileBufferManager= fileBufferManager;
fValidationContext= validationContext;
}
/**
* Executes the given operation for all file buffers specified by the given locations.
*
* @param locations the file buffer locations
* @param operation the operation to be performed
* @param monitor the progress monitor, or <code>null</code> if progress reporting is not desired
* @throws CoreException in case of error
* @throws OperationCanceledException in case the execution get canceled
*/
public void execute(IPath[] locations, final IFileBufferOperation operation, IProgressMonitor monitor) throws CoreException, OperationCanceledException {
final int size= locations.length;
SubMonitor subMonitor= SubMonitor.convert(monitor, operation.getOperationName(), size * 200);
try {
IFileBuffer[] fileBuffers= createFileBuffers(locations, subMonitor.split(size * 10));
IFileBuffer[] fileBuffers2Save= findFileBuffersToSave(fileBuffers);
fFileBufferManager.validateState(fileBuffers2Save, subMonitor.split(size * 10), fValidationContext);
if (!isCommitable(fileBuffers2Save))
{
throw new OperationCanceledException();
}
IFileBuffer[] unsynchronizedFileBuffers= findUnsynchronizedFileBuffers(fileBuffers);
performOperation(unsynchronizedFileBuffers, operation, subMonitor.split(size * 40));
final IFileBuffer[] synchronizedFileBuffers= findSynchronizedFileBuffers(fileBuffers);
fIsCompleted= false;
fThrowable= null;
synchronized (fCompletionLock) {
executeInContext(() -> {
synchronized (fCompletionLock) {
try {
SafeRunner.run(new ISafeRunnable() {
@Override
public void handleException(Throwable throwable) {
fThrowable= throwable;
}
@Override
public void run() throws Exception {
performOperation(synchronizedFileBuffers, operation, subMonitor.split(50));
}
});
} finally {
fIsCompleted= true;
fCompletionLock.notifyAll();
}
}
});
while (!fIsCompleted) {
try {
fCompletionLock.wait(500);
} catch (InterruptedException x) {
}
}
}
if (fThrowable != null) {
if (fThrowable instanceof CoreException)
throw (CoreException) fThrowable;
throw new CoreException(new Status(IStatus.ERROR, FileBuffersPlugin.PLUGIN_ID, IFileBufferStatusCodes.CONTENT_CHANGE_FAILED, fThrowable.getLocalizedMessage(), fThrowable));
}
commit(fileBuffers2Save, subMonitor.split(size * 80));
} finally {
releaseFileBuffers(locations, subMonitor.split(size * 10));
}
}
private void performOperation(IFileBuffer fileBuffer, IFileBufferOperation operation, IProgressMonitor progressMonitor) throws CoreException, OperationCanceledException {
SubMonitor subMonitor= SubMonitor.convert(progressMonitor, 100);
ISchedulingRule rule= fileBuffer.computeCommitRule();
IJobManager manager= Job.getJobManager();
manager.beginRule(rule, subMonitor.split(1));
String name= fileBuffer.getLocation().lastSegment();
subMonitor.setTaskName(name);
operation.run(fileBuffer, subMonitor.split(99));
manager.endRule(rule);
}
private void performOperation(IFileBuffer[] fileBuffers, IFileBufferOperation operation, IProgressMonitor progressMonitor) throws CoreException, OperationCanceledException {
SubMonitor subMonitor= SubMonitor.convert(progressMonitor, fileBuffers.length);
for (IFileBuffer fileBuffer : fileBuffers) {
performOperation(fileBuffer, operation, subMonitor.split(1));
}
}
private void executeInContext(Runnable runnable) {
ITextFileBufferManager fileBufferManager= FileBuffers.getTextFileBufferManager();
fileBufferManager.execute(runnable);
}
private IFileBuffer[] findUnsynchronizedFileBuffers(IFileBuffer[] fileBuffers) {
ArrayList<IFileBuffer> list= new ArrayList<>();
for (int i= 0; i < fileBuffers.length; i++) {
if (!fileBuffers[i].isSynchronizationContextRequested())
list.add(fileBuffers[i]);
}
return list.toArray(new IFileBuffer[list.size()]);
}
private IFileBuffer[] findSynchronizedFileBuffers(IFileBuffer[] fileBuffers) {
ArrayList<IFileBuffer> list= new ArrayList<>();
for (IFileBuffer fileBuffer : fileBuffers) {
if (fileBuffer.isSynchronizationContextRequested())
list.add(fileBuffer);
}
return list.toArray(new IFileBuffer[list.size()]);
}
private IFileBuffer[] createFileBuffers(IPath[] locations, IProgressMonitor progressMonitor) throws CoreException {
SubMonitor subMonitor= SubMonitor.convert(progressMonitor, FileBuffersMessages.FileBufferOperationRunner_task_connecting, locations.length);
try {
IFileBuffer[] fileBuffers= new ITextFileBuffer[locations.length];
for (int i= 0; i < locations.length; i++) {
fFileBufferManager.connect(locations[i], LocationKind.NORMALIZE, subMonitor.split(1));
fileBuffers[i]= fFileBufferManager.getFileBuffer(locations[i], LocationKind.NORMALIZE);
}
return fileBuffers;
} catch (CoreException x) {
try {
releaseFileBuffers(locations, new NullProgressMonitor());
} catch (CoreException e) {
}
throw x;
}
}
private void releaseFileBuffers(IPath[] locations, IProgressMonitor progressMonitor) throws CoreException {
SubMonitor subMonitor= SubMonitor.convert(progressMonitor, FileBuffersMessages.FileBufferOperationRunner_task_disconnecting, locations.length);
final ITextFileBufferManager fileBufferManager= FileBuffers.getTextFileBufferManager();
for (IPath location : locations) {
fileBufferManager.disconnect(location, LocationKind.NORMALIZE, subMonitor.split(1));
}
}
private IFileBuffer[] findFileBuffersToSave(IFileBuffer[] fileBuffers) {
ArrayList<IFileBuffer> list= new ArrayList<>();
for (IFileBuffer fileBuffer : fileBuffers) {
IFileBuffer buffer= fileBuffer;
if (!buffer.isDirty())
list.add(buffer);
}
return list.toArray(new IFileBuffer[list.size()]);
}
private boolean isCommitable(IFileBuffer[] fileBuffers) {
for (int i= 0; i < fileBuffers.length; i++) {
if (!fileBuffers[i].isCommitable())
return false;
}
return true;
}
protected ISchedulingRule computeCommitRule(IFileBuffer[] fileBuffers) {
ArrayList<ISchedulingRule> list= new ArrayList<>();
for (IFileBuffer fileBuffer : fileBuffers) {
ISchedulingRule rule= fileBuffer.computeCommitRule();
if (rule != null)
list.add(rule);
}
ISchedulingRule[] rules= new ISchedulingRule[list.size()];
list.toArray(rules);
return new MultiRule(rules);
}
protected void commit(final IFileBuffer[] fileBuffers, final IProgressMonitor progressMonitor) throws CoreException {
SubMonitor subMonitor= SubMonitor.convert(progressMonitor, 2);
ISchedulingRule rule= computeCommitRule(fileBuffers);
Job.getJobManager().beginRule(rule, subMonitor.split(1));
try {
doCommit(fileBuffers, subMonitor.split(1));
} finally {
Job.getJobManager().endRule(rule);
}
}
protected void doCommit(final IFileBuffer[] fileBuffers, IProgressMonitor progressMonitor) throws CoreException {
SubMonitor subMonitor= SubMonitor.convert(progressMonitor, FileBuffersMessages.FileBufferOperationRunner_task_committing, fileBuffers.length);
for (IFileBuffer fileBuffer : fileBuffers) {
fileBuffer.commit(subMonitor.split(1), true);
}
}
}
|
