Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 31ecabfa3aaff13e531345c5a9b003499fcda9cd (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
/*******************************************************************************
 * Copyright (c) 2007, 2014 Wind River Systems and others.
 *
 * 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:
 *     Wind River Systems - initial API and implementation
 *******************************************************************************/
package org.eclipse.cdt.dsf.debug.ui.viewmodel.variable;

import java.util.concurrent.RejectedExecutionException;

import org.eclipse.cdt.dsf.concurrent.DsfRunnable;
import org.eclipse.cdt.dsf.debug.internal.ui.viewmodel.DsfCastToTypeSupport;
import org.eclipse.cdt.dsf.debug.service.ICachingService;
import org.eclipse.cdt.dsf.debug.service.IExpressions;
import org.eclipse.cdt.dsf.debug.service.IExpressions2;
import org.eclipse.cdt.dsf.debug.service.IRunControl.ISuspendedDMEvent;
import org.eclipse.cdt.dsf.debug.ui.DsfDebugUITools;
import org.eclipse.cdt.dsf.debug.ui.IDsfDebugUIConstants;
import org.eclipse.cdt.dsf.debug.ui.viewmodel.numberformat.AbstractElementVMProvider;
import org.eclipse.cdt.dsf.debug.ui.viewmodel.update.BreakpointHitUpdatePolicy;
import org.eclipse.cdt.dsf.debug.ui.viewmodel.update.DebugManualUpdatePolicy;
import org.eclipse.cdt.dsf.internal.ui.DsfUIPlugin;
import org.eclipse.cdt.dsf.service.DsfServicesTracker;
import org.eclipse.cdt.dsf.service.DsfSession;
import org.eclipse.cdt.dsf.ui.viewmodel.AbstractVMAdapter;
import org.eclipse.cdt.dsf.ui.viewmodel.IRootVMNode;
import org.eclipse.cdt.dsf.ui.viewmodel.IVMNode;
import org.eclipse.cdt.dsf.ui.viewmodel.datamodel.RootDMVMNode;
import org.eclipse.cdt.dsf.ui.viewmodel.update.AutomaticUpdatePolicy;
import org.eclipse.cdt.dsf.ui.viewmodel.update.IVMUpdatePolicy;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IColumnPresentation;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IPresentationContext;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.util.IPropertyChangeListener;
import org.eclipse.jface.util.PropertyChangeEvent;

public class VariableVMProvider extends AbstractElementVMProvider {
	private IPropertyChangeListener fPreferencesListener = new IPropertyChangeListener() {
		@Override
		public void propertyChange(PropertyChangeEvent event) {
			String property = event.getProperty();
			if (property.equals(IDsfDebugUIConstants.PREF_WAIT_FOR_VIEW_UPDATE_AFTER_STEP_ENABLE)) {
				IPreferenceStore store = DsfDebugUITools.getPreferenceStore();
				setDelayEventHandleForViewUpdate(store.getBoolean(property));
			}
		}
	};

	private IPropertyChangeListener fPresentationContextListener = new IPropertyChangeListener() {
		@Override
		public void propertyChange(final PropertyChangeEvent event) {
			getExecutor().execute(new DsfRunnable() {
				@Override
				public void run() {
					handleEvent(event);
				}
			});
		}
	};

	public VariableVMProvider(AbstractVMAdapter adapter, IPresentationContext context, DsfSession session) {
		super(adapter, context, session);

		context.addPropertyChangeListener(fPresentationContextListener);

		IPreferenceStore store = DsfDebugUITools.getPreferenceStore();
		store.addPropertyChangeListener(fPreferencesListener);
		setDelayEventHandleForViewUpdate(
				store.getBoolean(IDsfDebugUIConstants.PREF_WAIT_FOR_VIEW_UPDATE_AFTER_STEP_ENABLE));

		configureLayout();
	}

	@Override
	public void dispose() {
		DsfDebugUITools.getPreferenceStore().removePropertyChangeListener(fPreferencesListener);
		getPresentationContext().removePropertyChangeListener(fPresentationContextListener);
		super.dispose();
	}

	/**
	 * Configures the nodes of this provider.  This method may be over-ridden by
	 * sub classes to create an alternate configuration in this provider.
	 *
	 * @since 2.1
	 */
	protected void configureLayout() {

		// Create the variable data access routines.
		SyncVariableDataAccess varAccess = new SyncVariableDataAccess(getSession());

		// Create the top level node to deal with the root selection.
		IRootVMNode rootNode = new RootDMVMNode(this);
		setRootNode(rootNode);

		// Create the next level which represents members of structs/unions/enums and elements of arrays.
		VariableVMNode subExpressioNode = new VariableVMNode(this, getSession(), varAccess);
		addChildNodes(rootNode, new IVMNode[] { subExpressioNode });

		// Wire up the casting support if the IExpressions2 service is available.
		hookUpCastingSupport(varAccess, subExpressioNode);

		// Configure the sub-expression node to be a child of itself.  This way the content
		// provider will recursively drill-down the variable hierarchy.
		addChildNodes(subExpressioNode, new IVMNode[] { subExpressioNode });
	}

	private void hookUpCastingSupport(final SyncVariableDataAccess syncvarDataAccess,
			final VariableVMNode variableNode) {
		try {
			getSession().getExecutor().execute(new DsfRunnable() {
				@Override
				public void run() {
					DsfServicesTracker tracker = new DsfServicesTracker(DsfUIPlugin.getBundleContext(),
							getSession().getId());
					IExpressions2 expressions2 = tracker.getService(IExpressions2.class);
					if (expressions2 != null) {
						variableNode.setCastToTypeSupport(
								new DsfCastToTypeSupport(getSession(), VariableVMProvider.this, syncvarDataAccess));
					}
					tracker.dispose();
				}
			});
		} catch (RejectedExecutionException e) {
			// Session disposed, ignore.
		}
	}

	@Override
	public IColumnPresentation createColumnPresentation(IPresentationContext context, Object element) {
		return new VariableColumnPresentation();
	}

	@Override
	public String getColumnPresentationId(IPresentationContext context, Object element) {
		return VariableColumnPresentation.ID;
	}

	@Override
	protected IVMUpdatePolicy[] createUpdateModes() {
		return new IVMUpdatePolicy[] { new AutomaticUpdatePolicy(), new DebugManualUpdatePolicy(),
				new BreakpointHitUpdatePolicy() };
	}

	@Override
	protected boolean canSkipHandlingEvent(Object newEvent, Object eventToSkip) {
		// To optimize the performance of the view when stepping rapidly, skip all
		// other events when a suspended event is received, including older suspended
		// events.
		return newEvent instanceof ISuspendedDMEvent;
	}

	@Override
	public void refresh() {
		super.refresh();
		try {
			getSession().getExecutor().execute(new DsfRunnable() {
				@Override
				public void run() {
					DsfServicesTracker tracker = new DsfServicesTracker(DsfUIPlugin.getBundleContext(),
							getSession().getId());
					IExpressions expressionsService = tracker.getService(IExpressions.class);
					if (expressionsService instanceof ICachingService) {
						((ICachingService) expressionsService).flushCache(null);
					}
					tracker.dispose();
				}
			});
		} catch (RejectedExecutionException e) {
			// Session disposed, ignore.
		}
	}
}

Back to the top