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
|
/*******************************************************************************
* Copyright (c) 2000, 2016 IBM Corporation and others.
* All rights reserved. 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.egit.ui.internal;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import org.eclipse.core.filesystem.EFS;
import org.eclipse.core.filesystem.IFileStore;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IStorage;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.SubMonitor;
import org.eclipse.core.runtime.content.IContentType;
import org.eclipse.egit.core.internal.util.ResourceUtil;
import org.eclipse.egit.ui.Activator;
import org.eclipse.egit.ui.internal.revision.FileRevisionEditorInput;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.util.OpenStrategy;
import org.eclipse.jgit.annotations.Nullable;
import org.eclipse.osgi.util.NLS;
import org.eclipse.team.core.history.IFileRevision;
import org.eclipse.ui.IEditorDescriptor;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IEditorRegistry;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.editors.text.EditorsUI;
import org.eclipse.ui.ide.IDE;
import org.eclipse.ui.part.MultiPageEditorPart;
import org.eclipse.ui.texteditor.ITextEditor;
/**
* Taken from the Team UI plug in Utils class
*/
public class EgitUiEditorUtils {
/**
* @param page
* @param revision
* @param monitor
* @return the part
* @throws CoreException
*/
public static IEditorPart openEditor(IWorkbenchPage page,
IFileRevision revision, IProgressMonitor monitor)
throws CoreException {
SubMonitor progress = SubMonitor.convert(monitor, 2);
IStorage file = revision.getStorage(progress.newChild(1));
if (file instanceof IFile) {
// if this is the current workspace file, open it
return IDE.openEditor(page, (IFile) file, OpenStrategy
.activateOnOpen());
} else {
FileRevisionEditorInput fileRevEditorInput = FileRevisionEditorInput
.createEditorInputFor(revision, progress.newChild(1));
IEditorPart part = openEditor(page, fileRevEditorInput);
return part;
}
}
/**
* Opens a text editor on a revision
*
* @param page
* the page
* @param revision
* the revision
* @param monitor
* a progress monitor, may be null
* @throws CoreException
* upon failure
*/
public static void openTextEditor(IWorkbenchPage page,
IFileRevision revision, IProgressMonitor monitor)
throws CoreException {
SubMonitor progress = SubMonitor.convert(monitor, 1);
FileRevisionEditorInput fileRevEditorInput = FileRevisionEditorInput
.createEditorInputFor(revision, progress.newChild(1));
openEditor(page, fileRevEditorInput, EditorsUI.DEFAULT_TEXT_EDITOR_ID);
}
/**
* @param page
* @param editorInput
* @return the part
* @throws PartInitException
*/
public static IEditorPart openEditor(IWorkbenchPage page,
FileRevisionEditorInput editorInput) throws PartInitException {
String id = getEditorId(editorInput);
return openEditor(page, editorInput, id);
}
/**
* @param page
* @param editorInput
* @param editorId
* @return the part
* @throws PartInitException
*/
private static IEditorPart openEditor(IWorkbenchPage page,
FileRevisionEditorInput editorInput, String editorId)
throws PartInitException {
try {
IEditorPart part = page.openEditor(editorInput, editorId,
OpenStrategy.activateOnOpen());
if (part == null) {
throw new PartInitException(NLS.bind(
UIText.EgitUiUtils_CouldNotOpenEditorMessage, editorId));
}
return part;
} catch (PartInitException e) {
if (editorId.equals(EditorsUI.DEFAULT_TEXT_EDITOR_ID)) {
throw e;
} else {
return page.openEditor(editorInput,
EditorsUI.DEFAULT_TEXT_EDITOR_ID);
}
}
}
/**
* Looks up a resource for the given file and opens an editor on it. A text
* editor is opened if the file is not contained in the workspace.
*
* @param file
* File to open an editor for. {@code file} must exist.
* @param page
* @return the created editor or null in case of an error
*/
@Nullable
public static IEditorPart openEditor(File file, IWorkbenchPage page) {
if (!file.exists()) {
return null;
}
IPath path = new Path(file.getAbsolutePath());
IFile ifile = ResourceUtil.getFileForLocation(path, true);
try {
if (ifile != null) {
return IDE.openEditor(page, ifile,
OpenStrategy.activateOnOpen());
} else {
IFileStore store = EFS.getLocalFileSystem().getStore(path);
return IDE.openEditorOnFileStore(page, store);
}
} catch (PartInitException e) {
Activator.handleError(UIText.EgitUiEditorUtils_openFailed, e, true);
}
return null;
}
private static String getEditorId(FileRevisionEditorInput editorInput) {
String id = getEditorId(editorInput.getFileRevision().getName(),
getContentType(editorInput));
return id;
}
private static String getEditorId(String fileName, IContentType type) {
IEditorRegistry registry = PlatformUI.getWorkbench()
.getEditorRegistry();
IEditorDescriptor descriptor = registry
.getDefaultEditor(fileName, type);
String id;
if (descriptor == null || descriptor.isOpenExternal()) {
id = EditorsUI.DEFAULT_TEXT_EDITOR_ID;
} else {
id = descriptor.getId();
}
return id;
}
private static IContentType getContentType(
FileRevisionEditorInput editorInput) {
IContentType type = null;
try {
InputStream contents = editorInput.getStorage().getContents();
try {
type = getContentType(editorInput.getFileRevision().getName(),
contents);
} finally {
try {
contents.close();
} catch (IOException e) {
// ignore
}
}
} catch (CoreException e) {
Activator.handleError(e.getMessage(), e, false);
}
return type;
}
private static IContentType getContentType(String fileName,
InputStream contents) {
IContentType type = null;
if (contents != null) {
try {
type = Platform.getContentTypeManager().findContentTypeFor(
contents, fileName);
} catch (IOException e) {
Activator.handleError(e.getMessage(), e, false);
}
}
if (type == null) {
type = Platform.getContentTypeManager()
.findContentTypeFor(fileName);
}
return type;
}
/**
* Reveals the given {@code lineNo} if it is greater than zero and the
* editor is an {@link ITextEditor}.
*
* @param editor
* to reveal the line in
* @param lineNo
* to reveal
*/
public static void revealLine(IEditorPart editor, int lineNo) {
if (lineNo < 0) {
return;
}
ITextEditor textEditor = getTextEditor(editor);
if (textEditor == null) {
return;
}
IDocument document = textEditor.getDocumentProvider()
.getDocument(textEditor.getEditorInput());
if (document == null) {
return;
}
try {
textEditor.selectAndReveal(document.getLineOffset(lineNo), 0);
} catch (BadLocationException e) {
// Ignore
}
}
private static ITextEditor getTextEditor(IEditorPart editor) {
if (editor instanceof ITextEditor) {
return (ITextEditor) editor;
} else if (editor instanceof MultiPageEditorPart) {
Object nestedEditor = ((MultiPageEditorPart) editor)
.getSelectedPage();
if (nestedEditor instanceof ITextEditor) {
return (ITextEditor) nestedEditor;
}
}
return null;
}
}
|
