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
|
/*
* Copyright (c) 2002 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM - Initial API and implementation
* Jens Lukowski/Innoopract - initial renaming/restructuring
*
*/
package org.eclipse.wst.sse.ui.extension;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IPluginDescriptor;
import org.eclipse.core.runtime.IPluginRegistry;
import org.eclipse.core.runtime.Platform;
import org.eclipse.swt.custom.BusyIndicator;
import org.eclipse.wst.sse.ui.Logger;
import org.eclipse.wst.sse.ui.extensions.spellcheck.SpellCheckProvider;
import org.eclipse.wst.sse.ui.internal.extension.RegistryReader;
/**
* Reads breakpoint extension registory and returns breakpoint provider
* instances
*/
public class SpellCheckProviderBuilder extends RegistryReader {
private static SpellCheckProviderBuilder instance;
protected String targetContributionTag;
protected List cache;
protected SpellCheckProvider[] providers = null;
private static final String PLUGIN_ID = "org.eclipse.wst.sse.ui.extensions"; //$NON-NLS-1$
private static final String PL_SPELLCHECK = "spellcheck"; //$NON-NLS-1$
private static final String TAG_SPELLCHECK_CONTRIBUTION = "spellcheckContribution"; //$NON-NLS-1$
private static final String TAG_PROVIDER = "provider"; //$NON-NLS-1$
private static final String ATT_CLASS = "class"; //$NON-NLS-1$
//private static final String ATT_ID = "id"; //$NON-NLS-1$
/*
* Constructor
*/
private SpellCheckProviderBuilder() {
}
/**
* returns singleton instance of SpellCheckProviderBuilder
* @return SpellCheckProviderBuilder
*/
public synchronized static SpellCheckProviderBuilder getInstance() {
if (instance == null) {
instance = new SpellCheckProviderBuilder();
}
return instance;
}
/*
* Creates an array of breakpoint providers
* @return SpellCheckProvider[]
*/
protected SpellCheckProvider[] createSpellCheckProviders() {
if (cache == null)
return new SpellCheckProvider[0];
final int num = cache.size();
if (num == 0)
return new SpellCheckProvider[0];
SpellCheckProvider[] bp = new SpellCheckProvider[num];
int j = 0;
for (int i = 0; i < num; i++) {
Object obj = cache.get(i);
if (!(obj instanceof IConfigurationElement))
continue;
IConfigurationElement element = (IConfigurationElement) obj;
if (!TAG_PROVIDER.equals(element.getName())) {
continue;
}
SpellCheckProvider b = createSpellCheckProvider(element);
if (b != null) {
// b.setSourceEditingTextTools(new SourceEditingTextToolsImpl());
bp[j] = b;
j++;
}
}
SpellCheckProvider[] bp2 = new SpellCheckProvider[j];
for (int i = 0; i < j; i++) {
bp2[i] = bp[i];
}
return bp2;
}
/*
* Creates a breakpoint provider object to given element
* @param element configuration element object
* @return SpellCheckProvider
*/
protected SpellCheckProvider createSpellCheckProvider(IConfigurationElement element) {
Object obj = null;
obj = createExtension(element, ATT_CLASS);
if (obj == null)
return null;
return (obj instanceof SpellCheckProvider) ? (SpellCheckProvider) obj : null;
}
/**
* Creates an extension. If the extension plugin has not
* been loaded a busy cursor will be activated during the duration of
* the load.
*
* @param element the config element defining the extension
* @param classAttribute the name of the attribute carrying the class
* @return the extension object
* @throws CoreException
*/
public static Object createExtension(final IConfigurationElement element, final String classAttribute) {
// If plugin has been loaded create extension.
// Otherwise, show busy cursor then create extension.
IPluginDescriptor plugin = element.getDeclaringExtension().getDeclaringPluginDescriptor();
final Object[] result = new Object[1];
if (plugin.isPluginActivated()) {
try {
return createExecutableExtension(element, classAttribute);
}
catch (Throwable e) {
handleCreateExecutableException(result, e);
}
}
else {
BusyIndicator.showWhile(null, new Runnable() {
public void run() {
try {
result[0] = createExecutableExtension(element, classAttribute);
}
catch (Throwable e) {
handleCreateExecutableException(result, e);
}
}
});
}
return result[0];
}
/**
* @param result
* @param e
*/
private static void handleCreateExecutableException(Object[] result, Throwable e) {
Logger.logException(e);
result[0] = null;
}
/*
* Creates an executable extension.
* @param element the config element defining the extension
* @param classAttribute the name of the attribute carrying the class
* @return the extension object
* @throws CoreException
*/
static Object createExecutableExtension(final IConfigurationElement element, final String classAttribute) throws CoreException {
return element.createExecutableExtension(classAttribute);
}
/**
* Returns an array of spellcheck providers for a specified content type
* handler
* @param handler a content type handler
* @param ext file extension
* @return SpellCheckProvider[]
*/
public SpellCheckProvider[] getSpellCheckProviders() {
if (cache == null) {
readContributions(TAG_SPELLCHECK_CONTRIBUTION, PL_SPELLCHECK);
}
if (providers == null) {
providers = createSpellCheckProviders();
}
return providers;
}
/**
* Returns an array of breakpoint providers
* @return boolean
*/
public boolean isAvailable() {
return getSpellCheckProviders().length != 0 ? true : false;
}
/**
* Reads the contributions from the registry for the provided workbench
* part and the provided extension point ID.
* @param tag
* @param extensionPoint
*/
protected void readContributions(String tag, String extensionPoint) {
cache = null;
targetContributionTag = tag;
IPluginRegistry registry = Platform.getPluginRegistry();
readRegistry(registry, PLUGIN_ID, extensionPoint);
}
/*
*/
protected boolean readElement(IConfigurationElement element) {
String tag = element.getName();
if (tag.equals(targetContributionTag)) {
readElementChildren(element);
return true;
}
else if (tag.equals(TAG_PROVIDER)) {
if (cache == null)
cache = new ArrayList();
cache.add(element);
return true; // just cache the element - don't go into it
}
return false;
}
}
|
