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) 2010, 2021 CEA LIST, 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:
* Vincent Lorenzo (CEA LIST) vincent.lorenzo@cea.fr - Initial API and implementation
* Christian W. Damus - bug 574592
*
*****************************************************************************/
package org.eclipse.papyrus.uml.diagram.profile.service;
import java.util.Map;
import org.eclipse.core.commands.ExecutionException;
import org.eclipse.core.commands.operations.IOperationHistory;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.emf.common.notify.AdapterFactory;
import org.eclipse.emf.common.ui.dialogs.DiagnosticDialog;
import org.eclipse.emf.common.util.BasicDiagnostic;
import org.eclipse.emf.common.util.Diagnostic;
import org.eclipse.emf.common.util.DiagnosticChain;
import org.eclipse.emf.ecore.EClass;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.emf.ecore.util.Diagnostician;
import org.eclipse.emf.edit.domain.AdapterFactoryEditingDomain;
import org.eclipse.emf.edit.provider.IItemLabelProvider;
import org.eclipse.emf.edit.ui.action.ValidateAction.EclipseResourcesUtil;
import org.eclipse.emf.transaction.TransactionalEditingDomain;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.window.Window;
import org.eclipse.osgi.util.NLS;
import org.eclipse.papyrus.infra.core.resource.IModel;
import org.eclipse.papyrus.infra.core.resource.ModelSet;
import org.eclipse.papyrus.infra.core.services.ServicesRegistry;
import org.eclipse.papyrus.infra.core.utils.ServiceUtils;
import org.eclipse.papyrus.infra.services.validation.ValidationTool;
import org.eclipse.papyrus.infra.ui.lifecycleevents.DoSaveEvent;
import org.eclipse.papyrus.infra.ui.lifecycleevents.ISaveEventListener;
import org.eclipse.papyrus.uml.diagram.profile.custom.commands.DefineProfileCommand;
import org.eclipse.papyrus.uml.diagram.profile.custom.messages.Messages;
import org.eclipse.papyrus.uml.profile.Activator;
import org.eclipse.papyrus.uml.profile.ui.dialogs.ProfileDefinitionDialog;
import org.eclipse.papyrus.uml.tools.model.UmlModel;
import org.eclipse.papyrus.uml.tools.profile.definition.PapyrusDefinitionAnnotation;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.operations.IWorkbenchOperationSupport;
import org.eclipse.uml2.uml.Element;
import org.eclipse.uml2.uml.Profile;
/**
* Handler of the pre-save event for <em>UML Profiles</em> that, if appropriate,
* prompts the user to create a new dynamic definition before saving.
*/
public class PreSaveProfileListener implements ISaveEventListener {
/**
* If an error comes here, the save action can't be make entirely -> use try-catch!
*
* This function is called before the user make a "save" action
*/
@Override
public void doSave(DoSaveEvent event) {
if (event.isAutoSave()) {
return;
}
try {
// System.out.println("preSave Event received"); //$NON-NLS-1$
/**
* if the root is a profile, we must define it. If it's another thing, we
* do nothing
*/
Profile rootProfile = null;
/**
* Obtain the root profile
*/
ServicesRegistry registry = event.getServiceRegistry();
ModelSet modelSet = ServiceUtils.getInstance().getModelSet(registry);
IModel umlModel = modelSet.getModel(UmlModel.MODEL_ID);
EObject profileEObject = null;
if (umlModel != null) {
profileEObject = ((UmlModel) umlModel).lookupRoot();
}
if (profileEObject instanceof Profile) {
rootProfile = (Profile) profileEObject;
}
if (rootProfile == null || isStaticallyGenerated(rootProfile, modelSet)) {
// We're not saving a profile model or it is statically generated and should not
// have dynamic definitions (bug 574592)
return;
}
/**
* Does the user want define the profile?
*/
String defineMsg = Messages.PreSaveProfileListener_0;
String defineTitle = Messages.PreSaveProfileListener_8;
Shell activeShell = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell();
boolean result = MessageDialog.openQuestion(activeShell, defineTitle, defineMsg);
if (!result) {
return;
}
ProfileDefinitionDialog dialog = new ProfileDefinitionDialog(activeShell, rootProfile);
dialog.open();
if (dialog.getReturnCode() == Window.OK) {
PapyrusDefinitionAnnotation papyrusAnnotation = dialog.getPapyrusDefinitionAnnotation();
TransactionalEditingDomain domain = ServiceUtils.getInstance().getTransactionalEditingDomain(registry);
// evaluate contraint of profiles
AdapterFactory adapterFactory = domain instanceof AdapterFactoryEditingDomain ? ((AdapterFactoryEditingDomain) domain).getAdapterFactory() : null;
Diagnostician diagnostician = createDiagnostician(adapterFactory, new NullProgressMonitor());
BasicDiagnostic diagnostic = diagnostician.createDefaultDiagnostic(rootProfile);
diagnostic.getSeverity();
Map<Object, Object> context = diagnostician.createDefaultContext();
diagnostician.validate(rootProfile, diagnostic, context);
if (canDefine(diagnostic)) {
DefineProfileCommand cmd = new DefineProfileCommand(domain, papyrusAnnotation, rootProfile, dialog.saveConstraintInDefinition());
try {
IOperationHistory history = event.getMultiDiagramEditor().getSite().getService(IWorkbenchOperationSupport.class).getOperationHistory();
IStatus status = history.execute(cmd, new NullProgressMonitor(), null);
switch (status.getSeverity()) {
case IStatus.OK:
MessageDialog.openInformation(activeShell, defineTitle, Messages.PreSaveProfileListener_1);
break;
case IStatus.WARNING:
Activator.log.warn(status.getMessage());
MessageDialog.openWarning(activeShell, defineTitle, status.getMessage());
break;
case IStatus.ERROR:
notifyErrors(activeShell, cmd.getDiagnostic());
break;
}
} catch (ExecutionException e) {
Activator.log.error(e);
MessageDialog.openError(activeShell, Messages.PreSaveProfileListener_2, NLS.bind(Messages.PreSaveProfileListener_3, e.getMessage()));
}
} else {
handleDiagnostic(diagnostic, rootProfile);
MessageDialog.openError(activeShell, Messages.PreSaveProfileListener_4, Messages.PreSaveProfileListener_5);
}
}
} catch (Exception e) {
Activator.log.error("Uncaught exception in profile definition.", e); //$NON-NLS-1$
}
}
protected void notifyErrors(Shell activeShell, Diagnostic diagnostic) {
Activator.log.error(diagnostic.getMessage(), diagnostic.getException());
DiagnosticDialog.openProblem(activeShell, Messages.PreSaveProfileListener_6, Messages.PreSaveProfileListener_7, diagnostic);
}
protected boolean canDefine(Diagnostic diagnostic) {
int severity = diagnostic.getSeverity();
if (severity == Diagnostic.CANCEL) {
return false;
}
if (severity == Diagnostic.ERROR) {
//
for (Diagnostic childDiagnostic : diagnostic.getChildren()) {
if (childDiagnostic.getSeverity() != Diagnostic.ERROR) {
continue;
}
if (childDiagnostic.getData().isEmpty()) {
continue;
}
// Only fail on validation errors occuring on the UML Profile itself; do not fail on its Ecore definitions
if (childDiagnostic.getData().get(0) instanceof Element) {
return false;
}
}
}
// Ok, Warning, Info
return true;
}
protected Diagnostician createDiagnostician(final AdapterFactory adapterFactory, final IProgressMonitor progressMonitor) {
return new Diagnostician() {
@Override
public String getObjectLabel(EObject eObject) {
if (adapterFactory != null && !eObject.eIsProxy()) {
IItemLabelProvider itemLabelProvider = (IItemLabelProvider) adapterFactory.adapt(eObject, IItemLabelProvider.class);
if (itemLabelProvider != null) {
return itemLabelProvider.getText(eObject);
}
}
return super.getObjectLabel(eObject);
}
@Override
public boolean validate(EClass eClass, EObject eObject, DiagnosticChain diagnostics, Map<Object, Object> context) {
progressMonitor.worked(1);
return super.validate(eClass, eObject, diagnostics, context);
}
};
}
protected void handleDiagnostic(Diagnostic diagnostic, Profile profil) {
// Do not show a dialog, as in the original version since the user sees the result directly
// in the model explorer
Resource resource = profil.eResource();
if (resource != null) {
if (profil != null) {
ValidationTool vt = new ValidationTool(profil);
vt.deleteSubMarkers();
}
// IPath path = new Path(resource.getURI().toPlatformString (false));
// IWorkspaceRoot wsRoot = ResourcesPlugin.getWorkspace().getRoot();
// IFile file = wsRoot.getFile(path);
// eclipseResourcesUtil.deleteMarkers (file);
EclipseResourcesUtil eclipseResourcesUtil = new EclipseResourcesUtil();
for (Diagnostic childDiagnostic : diagnostic.getChildren()) {
eclipseResourcesUtil.createMarkers(resource, childDiagnostic);
// createMarkersOnDi (file, childDiagnostic);
}
}
}
/**
* If an error comes here, the save action can't be make entirely -> use try-catch!
*
* This function is called before the user make a "save as" action
*/
@Override
public void doSaveAs(DoSaveEvent event) {
try {
// System.out.println("preSaveAS Event received"); //$NON-NLS-1$
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* Query whether an UML {@code profile} is statically generated (imported into an EMF Generator Model).
*
* @param profile
* an UML profile
* @param resourceSet
* the resource set context in which it is loaded
*
* @return whether the {@code profile} appears to be statically generated
*/
boolean isStaticallyGenerated(Profile profile, ResourceSet resourceSet) {
return GenModelHelper.getInstance().hasGeneratorModel(profile, resourceSet);
}
}
|
