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
|
/*******************************************************************************
* Copyright (c) 2008, 2014 BestSolution.at 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:
* Tom Schindl <tom.schindl@bestsolution.at> - initial API and implementation
* IBM Corporation - initial API and implementation
* Christian Georgi (SAP) - Bug 432480
******************************************************************************/
package org.eclipse.e4.ui.internal.workbench;
import java.net.URI;
import java.util.Hashtable;
import java.util.List;
import java.util.UUID;
import org.eclipse.e4.core.commands.ExpressionContext;
import org.eclipse.e4.core.contexts.IEclipseContext;
import org.eclipse.e4.core.services.contributions.IContributionFactory;
import org.eclipse.e4.core.services.log.Logger;
import org.eclipse.e4.ui.model.application.MApplication;
import org.eclipse.e4.ui.model.application.MApplicationElement;
import org.eclipse.e4.ui.model.application.ui.MContext;
import org.eclipse.e4.ui.workbench.IPresentationEngine;
import org.eclipse.e4.ui.workbench.IWorkbench;
import org.eclipse.emf.common.notify.Notifier;
import org.eclipse.osgi.service.datalocation.Location;
import org.osgi.framework.ServiceRegistration;
/**
* Default implementation of {@link IWorkbench}
*/
public class E4Workbench implements IWorkbench {
/**
* The argument for the locale active shell <br>
* <br>
* Value is: <code>localActiveShell</code>
*/
public static final String LOCAL_ACTIVE_SHELL = "localActiveShell"; //$NON-NLS-1$
/**
* The argument for the {@link URI} of the initial workbench model <br>
* <br>
* Value is: <code>initialWorkbenchModelURI</code>
*/
public static final String INITIAL_WORKBENCH_MODEL_URI = "initialWorkbenchModelURI"; //$NON-NLS-1$
/**
* The argument for the {@link Location} of the running instance <br>
* <br>
* Value is: <code>instanceLocation</code>
*/
public static final String INSTANCE_LOCATION = "instanceLocation"; //$NON-NLS-1$
/**
* The argument for the renderer factory to use <br>
* <br>
* Value is: <code>rendererFactoryUri</code>
*/
public static final String RENDERER_FACTORY_URI = "rendererFactoryUri"; //$NON-NLS-1$
/**
* The argument for setting the delta store location <br>
* <br>
* Value is: <code>deltaRestore</code>
*
* @deprecated
*/
@Deprecated
public static final String DELTA_RESTORE = "deltaRestore"; //$NON-NLS-1$
/**
* The argument for setting RTL mode <br>
* <br>
* Value is: <code>dir</code>
*/
public static final String RTL_MODE = "dir"; //$NON-NLS-1$
/**
* The argument for the perspective to activate <br>
* <br>
* Value is: <code>perspectiveId</code>
*/
public static final String FORCED_PERSPECTIVE_ID = "forcedPerspetiveId"; //$NON-NLS-1$
public static final String NO_SAVED_MODEL_FOUND = "NO_SAVED_MODEL_FOUND"; //$NON-NLS-1$
/**
* The argument for the whether to forcefully show the location in the window title (set on the
* command line)<br>
* <br>
* Value is: <code>forcedShowLocation</code>
*/
public static final String FORCED_SHOW_LOCATION = "forcedShowLocation"; //$NON-NLS-1$
private final String id;
private ServiceRegistration<?> osgiRegistration;
IEclipseContext appContext;
IPresentationEngine renderer;
MApplication appModel = null;
private UIEventPublisher uiEventPublisher;
private boolean restart;
/**
* @return the {@link IEclipseContext} for the main application
*/
public IEclipseContext getContext() {
return appContext;
}
/**
* Constructor
*
* @param uiRoot
* the root UI element
* @param applicationContext
* the root context
*/
public E4Workbench(MApplicationElement uiRoot, IEclipseContext applicationContext) {
id = createId();
appContext = applicationContext;
appContext.set(IWorkbench.class.getName(), this);
if (uiRoot instanceof MApplication) {
appModel = (MApplication) uiRoot;
}
if (uiRoot instanceof MApplication) {
init((MApplication) uiRoot);
}
uiEventPublisher = new UIEventPublisher(appContext);
appContext.set(UIEventPublisher.class, uiEventPublisher);
((Notifier) uiRoot).eAdapters().add(uiEventPublisher);
Hashtable<String, Object> properties = new Hashtable<String, Object>();
properties.put("id", getId()); //$NON-NLS-1$
osgiRegistration = Activator.getDefault().getContext()
.registerService(IWorkbench.class.getName(), this, properties);
}
@Override
public final String getId() {
return id;
}
protected String createId() {
return UUID.randomUUID().toString();
}
/**
* @param uiRoot
*/
public void createAndRunUI(MApplicationElement uiRoot) {
// Has someone already created one ?
instantiateRenderer();
if (renderer != null) {
renderer.run(uiRoot, appContext);
}
}
/**
*
*/
public void instantiateRenderer() {
renderer = (IPresentationEngine) appContext.get(IPresentationEngine.class.getName());
if (renderer == null) {
String presentationURI = (String) appContext.get(IWorkbench.PRESENTATION_URI_ARG);
if (presentationURI != null) {
IContributionFactory factory = (IContributionFactory) appContext
.get(IContributionFactory.class.getName());
renderer = (IPresentationEngine) factory.create(presentationURI, appContext);
appContext.set(IPresentationEngine.class.getName(), renderer);
}
if (renderer == null) {
Logger logger = (Logger) appContext.get(Logger.class.getName());
logger.error("Failed to create the presentation engine for URI: " + presentationURI); //$NON-NLS-1$
}
}
}
private void init(MApplication appElement) {
Activator.trace(Policy.DEBUG_WORKBENCH, "init() workbench", null); //$NON-NLS-1$
IEclipseContext context = appElement.getContext();
if (context != null) {
context.set(ExpressionContext.ALLOW_ACTIVATION, Boolean.TRUE);
}
}
@Override
public boolean close() {
if (renderer != null) {
renderer.stop();
}
if (uiEventPublisher != null && appModel != null) {
((Notifier) appModel).eAdapters().remove(uiEventPublisher);
uiEventPublisher = null;
}
if (osgiRegistration != null) {
osgiRegistration.unregister();
osgiRegistration = null;
}
return true;
}
@Override
public boolean restart() {
this.restart = true;
return close();
}
/**
* @return <code>true</code> when the workbench should be restarted
*/
public boolean isRestart() {
return restart;
}
// TODO: Remove in RAP
// /**
// * @return a context that can be used to lookup OSGi services
// */
// public static IEclipseContext getServiceContext() {
// return
// EclipseContextFactory.getServiceContext(Activator.getDefault().getContext());
// }
@Override
public MApplication getApplication() {
return appModel;
}
/**
* Create the context chain. It both creates the chain for the current model, and adds eAdapters
* so it can add new contexts when new model items are added.
*
* @param parentContext
* The parent context
* @param contextModel
* needs a context created
* @return a chained {@link IEclipseContext}
*/
public static IEclipseContext initializeContext(IEclipseContext parentContext,
MContext contextModel) {
final IEclipseContext context;
if (contextModel.getContext() != null) {
context = contextModel.getContext();
} else {
context = parentContext.createChild("PartContext(" + contextModel + ')'); //$NON-NLS-1$
}
Activator.trace(Policy.DEBUG_CONTEXTS, "initializeContext(" //$NON-NLS-1$
+ parentContext.toString() + ", " + contextModel + ")", null); //$NON-NLS-1$ //$NON-NLS-2$
// fill in the interfaces, so MContributedPart.class.getName() will
// return the model element, for example.
ContributionsAnalyzer.populateModelInterfaces(contextModel, context, contextModel
.getClass().getInterfaces());
// declares modifiable variables from the model
List<String> containedProperties = contextModel.getVariables();
for (String name : containedProperties) {
context.declareModifiable(name);
}
contextModel.setContext(context);
return context;
}
}
|
