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
|
/*******************************************************************************
* Copyright (c) 2016 Red Hat Inc. 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:
* - Mickael Istria (Red Hat Inc.)
*******************************************************************************/
package org.eclipse.ui.internal.genericeditor;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IRegistryChangeEvent;
import org.eclipse.core.runtime.IRegistryChangeListener;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.content.IContentType;
import org.eclipse.core.runtime.content.IContentTypeManager;
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.contentassist.ICompletionProposal;
import org.eclipse.jface.text.contentassist.IContentAssistProcessor;
import org.eclipse.jface.text.contentassist.IContextInformation;
import org.eclipse.jface.text.contentassist.IContextInformationValidator;
import org.eclipse.jface.text.source.ISourceViewer;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.PlatformUI;
/**
* A registry of content assist processors provided by extension <code>org.eclipse.ui.genericeditor.contentAssistProcessors</code>.
* Those extensions are specific to a given {@link IContentType}.
*
* @since 1.0
*/
public class ContentAssistProcessorRegistry {
private static final String EXTENSION_POINT_ID = GenericEditorPlugin.BUNDLE_ID + ".contentAssistProcessors"; //$NON-NLS-1$
/**
* This class wraps and proxies an {@link IContentAssistProcessor} provided through extensions
* and loads it lazily when it can contribute to the editor, then delegates all operations to
* actual processor.
* When the contribution cannot contribute to the editor, this wrapper will return neutral values
* that don't affect editor behavior.
*/
private static class ContentAssistProcessorExtension implements IContentAssistProcessor {
private static final String CONTENT_TYPE_ATTRIBUTE = "contentType"; //$NON-NLS-1$
private static final String CLASS_ATTRIBUTE = "class"; //$NON-NLS-1$
private IConfigurationElement extension;
private IContentType targetContentType;
private IContentAssistProcessor delegate;
private ContentAssistProcessorExtension(IConfigurationElement element) throws Exception {
this.extension = element;
this.targetContentType = Platform.getContentTypeManager().getContentType(element.getAttribute(CONTENT_TYPE_ATTRIBUTE));
}
private IContentAssistProcessor getDelegate() {
if (this.delegate == null) {
try {
this.delegate = (IContentAssistProcessor) extension.createExecutableExtension(CLASS_ATTRIBUTE);
} catch (CoreException e) {
e.printStackTrace();
}
}
return delegate;
}
/**
* @return whether the referenced contribution should contribute to the current editor.
*/
public boolean isActive() {
IEditorInput input = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage().getActiveEditor().getEditorInput();
IContentTypeManager contentTypeManager= Platform.getContentTypeManager();
for (IContentType currentContentType : contentTypeManager.findContentTypesFor(input.getName())) {
if (currentContentType.isKindOf(targetContentType)) {
return true;
}
}
return false;
}
@Override
public ICompletionProposal[] computeCompletionProposals(ITextViewer viewer, int offset) {
if (isActive()) {
return getDelegate().computeCompletionProposals(viewer, offset);
}
return new ICompletionProposal[0];
}
@Override
public IContextInformation[] computeContextInformation(ITextViewer viewer, int offset) {
if (isActive()) {
return getDelegate().computeContextInformation(viewer, offset);
}
return new IContextInformation[0];
}
@Override
public char[] getCompletionProposalAutoActivationCharacters() {
if (isActive()) {
return getDelegate().getCompletionProposalAutoActivationCharacters();
}
return null;
}
@Override
public char[] getContextInformationAutoActivationCharacters() {
if (isActive()) {
return getDelegate().getContextInformationAutoActivationCharacters();
}
return null;
}
@Override
public String getErrorMessage() {
if (isActive()) {
return getDelegate().getErrorMessage();
}
return null;
}
@Override
public IContextInformationValidator getContextInformationValidator() {
if (isActive()) {
return getDelegate().getContextInformationValidator();
}
return null;
}
}
private Map<IConfigurationElement, ContentAssistProcessorExtension> extensions = new HashMap<>();
private boolean outOfSync = true;
/**
* Creates the registry and binds it to the extension point.
*/
public ContentAssistProcessorRegistry() {
Platform.getExtensionRegistry().addRegistryChangeListener(new IRegistryChangeListener() {
@Override
public void registryChanged(IRegistryChangeEvent event) {
outOfSync = true;
}
}, EXTENSION_POINT_ID);
}
/**
* Get the contributed {@link IContentAssistProcessor}s that are relevant to hook on source viewer according
* to document content types.
* @param sourceViewer the source viewer we're hooking completion to.
* @param contentTypes the content types of the document we're editing.
* @return the list of {@link IContentAssistProcessor} contributed for at least one of the content types.
*/
public List<IContentAssistProcessor> getContentAssistProcessors(ISourceViewer sourceViewer, Set<IContentType> contentTypes) {
if (this.outOfSync) {
sync();
}
List<IContentAssistProcessor> res = new ArrayList<>();
for (ContentAssistProcessorExtension ext : this.extensions.values()) {
if (contentTypes.contains(ext.targetContentType)) {
res.add(ext);
}
}
return res;
}
private void sync() {
Set<IConfigurationElement> toRemoveExtensions = new HashSet<>(this.extensions.keySet());
for (IConfigurationElement extension : Platform.getExtensionRegistry().getConfigurationElementsFor(EXTENSION_POINT_ID)) {
toRemoveExtensions.remove(extension);
if (!this.extensions.containsKey(extension)) {
try {
this.extensions.put(extension, new ContentAssistProcessorExtension(extension));
} catch (Exception ex) {
GenericEditorPlugin.getDefault().getLog().log(new Status(IStatus.ERROR, GenericEditorPlugin.BUNDLE_ID, ex.getMessage(), ex));
}
}
}
for (IConfigurationElement toRemove : toRemoveExtensions) {
this.extensions.remove(toRemove);
}
this.outOfSync = false;
}
}
|
