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
|
/*****************************************************************************
* Copyright (c) 2015 Christian W. Damus 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:
* Christian W. Damus - Initial API and implementation
*
*****************************************************************************/
package org.eclipse.papyrus.uml.tools.profile.index;
import static org.eclipse.papyrus.uml.tools.Activator.TRACE_LANGUAGE_PROVIDERS;
import java.util.Collections;
import java.util.Map;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExecutableExtension;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Status;
import org.eclipse.emf.common.util.URI;
import org.eclipse.papyrus.infra.core.language.ILanguage;
import org.eclipse.papyrus.infra.core.language.ILanguageProvider;
import org.eclipse.papyrus.infra.core.language.ILanguageService;
import org.eclipse.papyrus.infra.core.language.LanguageChangeEvent;
import org.eclipse.papyrus.infra.core.services.BadStateException;
import org.eclipse.papyrus.infra.core.services.ServicesRegistry;
import org.eclipse.papyrus.uml.tools.Activator;
import org.eclipse.papyrus.uml.tools.model.UmlModel;
import org.eclipse.uml2.uml.Profile;
import org.osgi.framework.Bundle;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
/**
* <p>
* A language provider based on UML profiles. It uses the {@link IProfileIndex} to efficiently
* determine the profiles applied to UML resources and return languages based on the applied
* profiles that it finds. It must be configured using the parameterized
* <tt>{@literal <implementation>}</tt> element of the language extension point. Parameters
* are of the form:
* </p>
* <table>
* <tr>
* <th>Name</th>
* <th>Value</th>
* <th>Comments</th>
* </tr>
* <tr valign="top">
* <td><tt>profile.<i>N</i></tt></td>
* <td>URI of a {@link Profile} element in a profile resource</td>
* <td>where <i>N</i> is an unique index 1, 2, etc. distinguishing the profile parameters</td>
* </tr>
* <tr valign="top">
* <td><tt>language.<i>N</i></tt></td>
* <td>name of class implementing the {@link ILanguage} interface on the declaring plug-in's classpath</td>
* <td>where <i>N</i> matches the corresponding profile parameter</td>
* </tr>
* </table>
*/
public class ProfileLanguageProvider implements ILanguageProvider, IExecutableExtension {
private static final Pattern NAME_PATTERN = Pattern.compile("(?:(profile)|language)\\.(\\d+)"); //$NON-NLS-1$
private IConfigurationElement config;
private Map<URI, String> languageClasses;
public ProfileLanguageProvider() {
super();
}
@Override
public void setInitializationData(IConfigurationElement config, String propertyName, Object data) throws CoreException {
this.config = config;
if (!(data instanceof Map<?, ?>)) {
throw new CoreException(new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Initialization parameter 'data' is not a Map in language provider from contributor " + config.getContributor().getName()));
}
// Gather configuration parameters
@SuppressWarnings("unchecked")
Map<String, String> map = (Map<String, String>) data;
Map<String, URI> profileURIs = Maps.newHashMap();
Map<String, String> languages = Maps.newHashMap();
for (Map.Entry<String, String> next : map.entrySet()) {
Matcher m = NAME_PATTERN.matcher(next.getKey());
if (!m.find()) {
Activator.log.warn(String.format("Invalid profile language provider parameter name %s from contributor %s", next.getKey(), config.getContributor().getName())); //$NON-NLS-1$
} else {
if (m.group(1) != null) {
// it's a profile
profileURIs.put(m.group(2), URI.createURI(next.getValue(), true));
} else {
// it's a language
languages.put(m.group(2), next.getValue());
}
}
}
// Assemble the configuration parameters
languageClasses = Maps.newHashMap();
for (Map.Entry<String, URI> next : profileURIs.entrySet()) {
String languageClass = languages.remove(next.getKey());
if (languageClass == null) {
Activator.log.warn(String.format("Missing language class for profile %s from contributor %s", next.getValue(), config.getContributor().getName())); //$NON-NLS-1$
} else {
languageClasses.put(next.getValue(), languageClass);
}
}
// Any left over?
for (String next : languages.values()) {
Activator.log.warn(String.format("Missing profile URI for language class %s from contributor %s", next, config.getContributor().getName())); //$NON-NLS-1$
}
}
@Override
public Iterable<ILanguage> getLanguages(final ILanguageService languageService, final URI modelURI, final boolean uriHasFileExtension) {
Set<ILanguage> result = Collections.emptySet();
final URI uriToQuery = uriHasFileExtension ? modelURI : modelURI.appendFileExtension(UmlModel.UML_FILE_EXTENSION);
try {
IProfileIndex index = null;
ServicesRegistry registry = languageService.getAdapter(ServicesRegistry.class);
if (registry != null) {
try {
index = registry.getService(IProfileIndex.class);
} catch (BadStateException e) {
// The ModelSet is started before the rest of the registry, and it doesn't know about the profile
// index service to start it. So, we must start the profile service explicitly
registry.startServicesByClassKeys(IProfileIndex.class);
index = registry.getService(IProfileIndex.class);
}
}
if (index != null) {
ListenableFuture<Set<URI>> futureProfiles = index.getAppliedProfiles(uriToQuery);
if (futureProfiles.isDone()) {
// Great. We have a result already
result = getLanguages(Futures.getUnchecked(futureProfiles));
if (Activator.log.isTraceEnabled(TRACE_LANGUAGE_PROVIDERS)) {
Activator.log.trace(TRACE_LANGUAGE_PROVIDERS, String.format("Languages already indexed for %s: %s", uriToQuery, result));
}
} else {
final Set<ILanguage> immediateLanguages = getLanguages(index.getIntrinsicAppliedProfiles(uriToQuery));
result = immediateLanguages;
if (!result.isEmpty() && Activator.log.isTraceEnabled(TRACE_LANGUAGE_PROVIDERS)) {
Activator.log.trace(TRACE_LANGUAGE_PROVIDERS, String.format("Partial result already available for %s: %s", uriToQuery, immediateLanguages));
}
// Post an update, later
Futures.addCallback(futureProfiles, new FutureCallback<Set<URI>>() {
@Override
public void onSuccess(Set<URI> result) {
Set<ILanguage> languages = getLanguages(result);
languages.removeAll(immediateLanguages); // Already reported these
if (languages.isEmpty()) {
if (Activator.log.isTraceEnabled(TRACE_LANGUAGE_PROVIDERS)) {
Activator.log.trace(TRACE_LANGUAGE_PROVIDERS, "No further languages available for " + uriToQuery);
}
} else {
if (Activator.log.isTraceEnabled(TRACE_LANGUAGE_PROVIDERS)) {
Activator.log.trace(TRACE_LANGUAGE_PROVIDERS, String.format("Remaining languages now available for %s: %s", uriToQuery, languages));
}
LanguageChangeEvent event = new LanguageChangeEvent(ProfileLanguageProvider.this, LanguageChangeEvent.ADDED, modelURI, uriHasFileExtension, languages);
languageService.languagesChanged(event);
}
}
@Override
public void onFailure(Throwable t) {
// Nothing to post
Activator.log.error(String.format("Failed to access profile index for resource %s", uriToQuery), t); //$NON-NLS-1$
}
});
}
}
} catch (Exception e) {
Activator.log.error(String.format("Failed to access profile index for resource %s", uriToQuery), e); //$NON-NLS-1$
}
return result;
}
private Set<ILanguage> getLanguages(Set<URI> profiles) {
Set<ILanguage> result;
if (profiles.isEmpty()) {
result = Collections.emptySet();
} else {
result = Sets.newHashSet();
for (URI next : profiles) {
ILanguage language = getLanguage(next);
if (language != null) {
result.add(language);
}
}
}
return result;
}
protected synchronized ILanguage getLanguage(URI profileURI) {
ILanguage result = null;
String className = languageClasses.get(profileURI);
if (className != null) {
Bundle bundle = Platform.getBundle(config.getContributor().getName());
if (bundle != null) {
try {
Class<?> class_ = bundle.loadClass(className);
if ((class_ == null) || !ILanguage.class.isAssignableFrom(class_)) {
languageClasses.remove(profileURI); // Don't try this again
Activator.log.error(String.format("Not a language class for profile %s in contributor %s: %s", profileURI, config.getContributor().getName(), className), null); //$NON-NLS-1$
} else {
result = class_.asSubclass(ILanguage.class).newInstance();
}
} catch (Exception e) {
languageClasses.remove(profileURI); // Don't try this again
Activator.log.error(String.format("Failed to instantiate language class %s for profile %s in contributor %s", className, profileURI, config.getContributor().getName()), e); //$NON-NLS-1$
}
}
}
return result;
}
}
|
