Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: c5028bb0e225cf52335cb96059879217acb6c830 (plain) (blame)
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
/*****************************************************************************
 * Copyright (c) 2011 CEA LIST.
 *
 *
 * 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:
 *  Vincent Lorenzo (CEA LIST) Vincent.Lorenzo@cea.fr - Initial API and implementation
 *
 *****************************************************************************/
package org.eclipse.papyrus.infra.emf.commandstack.view;

import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;

import org.eclipse.core.commands.operations.IOperationHistory;
import org.eclipse.core.commands.operations.IOperationHistoryListener;
import org.eclipse.core.commands.operations.IUndoContext;
import org.eclipse.core.commands.operations.IUndoableOperation;
import org.eclipse.core.commands.operations.OperationHistoryEvent;
import org.eclipse.core.commands.operations.OperationHistoryFactory;
import org.eclipse.emf.common.command.AbstractCommand;
import org.eclipse.emf.common.command.Command;
import org.eclipse.emf.common.command.CompoundCommand;
import org.eclipse.emf.workspace.EMFCommandOperation;
import org.eclipse.gmf.runtime.common.core.command.CompositeCommand;
import org.eclipse.gmf.runtime.emf.commands.core.command.EditingDomainUndoContext;
import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.jface.viewers.ColumnLabelProvider;
import org.eclipse.jface.viewers.IContentProvider;
import org.eclipse.jface.viewers.ITreeContentProvider;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.papyrus.emf.facet.common.ui.internal.views.AbstractTreeView;
import org.eclipse.papyrus.infra.emf.gmf.command.ICommandWrapper;
import org.eclipse.papyrus.infra.emf.gmf.util.CommandUtils;

public class CommandStackView extends AbstractTreeView {

	private final int maxSize = 25;

	private final IOperationHistory history;

	private final List<IUndoableOperation> commandList = new ArrayList<>();

	private final Map<IUndoableOperation, String> dates = new HashMap<>();

	private final IOperationHistoryListener historyListener;

	public CommandStackView() {
		this.history = OperationHistoryFactory.getOperationHistory();
		this.history.addOperationHistoryListener(historyListener = new IOperationHistoryListener() {

			@Override
			public void historyNotification(final OperationHistoryEvent event) {
				if (!CommandStackView.this.commandList.contains(event.getOperation())) {
					if (CommandStackView.this.commandList.size() == CommandStackView.this.maxSize) {
						IUndoableOperation removedOperation = CommandStackView.this.commandList.remove(CommandStackView.this.maxSize - 1);
						dates.remove(removedOperation);
					}
					CommandStackView.this.commandList.add(0, event.getOperation());
					final DateFormat dateFormat = new SimpleDateFormat("HH:mm:ss"); //$NON-NLS-1$
					final Calendar cal = Calendar.getInstance();
					CommandStackView.this.dates.put(event.getOperation(), dateFormat.format(cal.getTime()));
					refresh(true);
				}
			}
		});
	}

	private boolean isValidUndoContext(IUndoableOperation operation) {
		for (IUndoContext undoContext : operation.getContexts()) {
			if (undoContext instanceof EditingDomainUndoContext) {
				return true;
			}
		}
		return false;
	}

	@Override
	protected void createColumns() {
		createNameColumn();
		createDescriptionColumn();
		createCommandTypeColumn();
		createTimeColumn();
		createUndoContextColumn();
	}

	@Override
	public void createPartControl(final org.eclipse.swt.widgets.Composite parent) {
		super.createPartControl(parent);
		final IToolBarManager tbm = getViewSite().getActionBars().getToolBarManager();
		tbm.add(new Action() {

			@Override
			public void run() {
				clear();
				refresh(true);
			}

			@Override
			public boolean isEnabled() {
				return true;
			}

			@Override
			public String getToolTipText() {
				return getText();
			}

			@Override
			public String getText() {
				return "Clear the view"; //$NON-NLS-1$
			}
		});
	}

	private void createCommandTypeColumn() {
		final ColumnLabelProvider columnLabelProvider = new ColumnLabelProvider() {

			@Override
			public String getText(final Object element) {
				return element.getClass().getName();
			}
		};
		createColumn("Type", "TYPE_COLUMN_ID", 200, columnLabelProvider); //$NON-NLS-1$ //$NON-NLS-2$
	}

	protected void createNameColumn() {
		final ColumnLabelProvider columnLabelProvider = new ColumnLabelProvider() {

			@Override
			public String getText(final Object element) {
				return CommandUtils.getLabel(element);
			}
		};
		createColumn("Name", "NAME_COLUMN_ID", 200, columnLabelProvider); //$NON-NLS-1$ //$NON-NLS-2$
	}

	protected void createUndoContextColumn() {
		final ColumnLabelProvider columnLabelProvider = new ColumnLabelProvider() {

			@Override
			public String getText(final Object element) {
				if (element instanceof IUndoableOperation) {
					return Boolean.toString(isValidUndoContext((IUndoableOperation) element));
				}
				return "?"; //$NON-NLS-1$
			}
		};
		createColumn("EMF Command Stack", "UNDO_CONTEXT_COLUMN_ID", 100, columnLabelProvider); //$NON-NLS-1$ //$NON-NLS-2$
	}

	protected void createDescriptionColumn() {
		final ColumnLabelProvider columnLabelProvider = new ColumnLabelProvider() {

			@Override
			public String getText(final Object element) {
				if (element instanceof AbstractCommand) {
					return ((AbstractCommand) element).getDescription();
				}
				return "no description"; //$NON-NLS-1$
			}
		};
		createColumn("Description", "DESCRIPTION_COLUMN_ID", 150, columnLabelProvider); //$NON-NLS-1$ //$NON-NLS-2$
	}

	protected void createTimeColumn() {
		final ColumnLabelProvider columnLabelProvider = new ColumnLabelProvider() {

			@Override
			public String getText(final Object element) {
				if (CommandStackView.this.dates.containsKey(element)) {
					return CommandStackView.this.dates.get(element);
				}
				return ""; //$NON-NLS-1$
			}
		};
		createColumn("Time", "TIME_COLUMN_ID", 100, columnLabelProvider); //$NON-NLS-1$ //$NON-NLS-2$
	}

	@Override
	protected IContentProvider getContentProvider() {
		return new ITreeContentProvider() {

			@Override
			public Object[] getElements(final Object inputElement) {
				if (inputElement instanceof Command) {
					return new Object[] { inputElement };
				} else if (inputElement instanceof Collection<?>) {
					return ((Collection<?>) inputElement).toArray();
				}
				return new Object[0];
			}

			@Override
			public void inputChanged(final Viewer viewer, final Object oldInput, final Object newInput) {
				// nothing
			}

			@Override
			public void dispose() {
				// nothing
			}

			@Override
			public boolean hasChildren(final Object element) {
				return getChildren(element).length != 0;
			}

			@Override
			public Object getParent(final Object element) {
				return null;
			}

			@Override
			public Object[] getChildren(final Object parentElement) {
				if (parentElement instanceof CompoundCommand) {
					return ((CompoundCommand) parentElement).getCommandList().toArray();
				} else if (parentElement instanceof CompositeCommand) {
					final List<Object> children = new ArrayList<>();
					final ListIterator<Object> iter = ((CompositeCommand) parentElement).listIterator();
					while (iter.hasNext()) {
						children.add(iter.next());
					}
					return children.toArray();
				} else if (parentElement instanceof EMFCommandOperation) {
					final List<Object> children = new ArrayList<>();
					children.add(((EMFCommandOperation) parentElement).getCommand());
					return children.toArray();
				} else if (parentElement instanceof ICommandWrapper<?>) {
					return new Object[] { ((ICommandWrapper<?>) parentElement).getWrappedCommand() };
				} else if (CommandUtils.isCompound(parentElement)) {
					final List<Object> children = new ArrayList<>();
					for (Object next : CommandUtils.getChildren(parentElement)) {
						children.add(next);
					}
					return children.toArray();
				} else if (ICommandWrapper.isWrapper(parentElement, Object.class)) {
					return new Object[] { ICommandWrapper.unwrap(parentElement, Object.class) };
				}
				return new Object[0];
			}
		};
	}

	@Override
	protected void openElement(final Object element) {

	}

	@Override
	protected String getRefreshMessage() {
		return "Refresh CommandStack View"; //$NON-NLS-1$
	}

	private Object result[];// = new Object[1];

	@Override
	protected Object getInput() {
		return this.commandList;
	}

	@Override
	public void dispose() {
		super.dispose();
		history.removeOperationHistoryListener(historyListener);
		clear();
	}

	private void clear() {
		this.commandList.clear();
		this.dates.clear();
	}
}

Back to the top