Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: e9e6acc233487ce5d3d6874536ebbba25946a787 (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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
/*******************************************************************************
 * Copyright (c) 2009, 2010 Wind River Systems, Inc. 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:
 *     Wind River Systems - initial API and implementation
 *******************************************************************************/

package org.eclipse.cdt.dsf.debug.ui.viewmodel.expression;

import java.util.LinkedList;
import java.util.List;

import org.eclipse.cdt.dsf.concurrent.CountingRequestMonitor;
import org.eclipse.cdt.dsf.concurrent.RequestMonitor;
import org.eclipse.cdt.dsf.datamodel.IDMContext;
import org.eclipse.cdt.dsf.debug.service.IExpressions.IExpressionDMContext;
import org.eclipse.cdt.dsf.ui.concurrent.ViewerDataRequestMonitor;
import org.eclipse.cdt.dsf.ui.viewmodel.AbstractVMContext;
import org.eclipse.cdt.dsf.ui.viewmodel.AbstractVMNode;
import org.eclipse.cdt.dsf.ui.viewmodel.IVMNode;
import org.eclipse.cdt.dsf.ui.viewmodel.VMDelta;
import org.eclipse.cdt.dsf.ui.viewmodel.datamodel.IDMVMContext;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.model.IDebugTarget;
import org.eclipse.debug.core.model.IExpression;
import org.eclipse.debug.core.model.IValue;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IChildrenCountUpdate;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IChildrenUpdate;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IElementLabelProvider;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IHasChildrenUpdate;
import org.eclipse.debug.internal.ui.viewers.model.provisional.ILabelUpdate;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IModelDelta;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IViewerUpdate;
import org.eclipse.jface.viewers.TreePath;

/**
 * A VM node for displaying a single expression in the expression hover.
 * 
 * @since 2.1
 */
public class SingleExpressionVMNode extends AbstractVMNode implements IElementLabelProvider {

	private static class RootDMVMContext extends AbstractVMContext implements IDMVMContext {
		private final IDMContext fDmc;
		public RootDMVMContext(IVMNode node, IDMContext dmc) {
			super(node);
			fDmc = dmc;
		}
	    @Override
		public IDMContext getDMContext() {
			return fDmc;
		}
		@SuppressWarnings("rawtypes")
		@Override
		public Object getAdapter(Class adapter) {
            Object superAdapter = super.getAdapter(adapter);
            if (superAdapter != null) {
                return superAdapter;
            } else {
                // Delegate to the Data Model to find the context.
                if (adapter.isInstance(fDmc)) {
                    return fDmc;
                } else {
                    return fDmc.getAdapter(adapter);
                }
            }
		}

		@Override
		public boolean equals(Object other) {
		    if (this == other) {
		        return true;
		    }
            if (other instanceof RootDMVMContext) {
                RootDMVMContext otherVmc = (RootDMVMContext)other;
                return getVMNode().equals(otherVmc.getVMNode()) && fDmc.equals(otherVmc.fDmc);
            }
            return false;
		}

		@Override
		public int hashCode() {
            return getVMNode().hashCode() + fDmc.hashCode(); 
		}

        @Override
        public String toString() {
            return fDmc.toString();
        }		
	}

	private static class SimpleExpression implements IExpression {
		private String fExpressionText;
		SimpleExpression(String text) {
			fExpressionText = text;
		}
	    @Override
		public void dispose() {
		}
	    @Override
		public IDebugTarget getDebugTarget() {
			return null;
		}
	    @Override
		public String getExpressionText() {
			return fExpressionText;
		}
	    @Override
		public IValue getValue() {
			return null;
		}
	    @Override
		public ILaunch getLaunch() {
			return null;
		}
	    @Override
		public String getModelIdentifier() {
			return null;
		}
		@SuppressWarnings("rawtypes")
	    @Override
		public Object getAdapter(Class adapter) {
			return null;
		}
        @Override
        public boolean equals(Object obj) {
            if (this == obj) {
                return true;
            }
            if (obj instanceof SimpleExpression) {
                return fExpressionText.equals(((SimpleExpression) obj).getExpressionText());
            }
            return false;
        }
        @Override
        public int hashCode() {
            return fExpressionText.hashCode();
        }
	}

    public SingleExpressionVMNode(ExpressionVMProvider provider) {
        super(provider);
    }

	@Override
    public String toString() {
        return "SingleExpressionVMNode";  //$NON-NLS-1$ 
    }
    
    private ExpressionVMProvider getExpressionVMProvider() {
        return (ExpressionVMProvider)getVMProvider();
    }

    private IExpressionDMContext getUpdateExpressionDMC(IViewerUpdate update) {
        if (update.getElement() instanceof IDMVMContext) {
            IDMContext dmc = ((IDMVMContext)update.getElement()).getDMContext();
            if (dmc instanceof IExpressionDMContext) {
                return (IExpressionDMContext)dmc;
            }
        }
        return null;
    }


    @Override
	public void update(IHasChildrenUpdate[] updates) {
        for (int i = 0; i < updates.length; i++) {
            updates[i].setHasChilren(getUpdateExpressionDMC(updates[i]) != null);
            updates[i].done();
        }
    }
    
    @Override
	public void update(IChildrenCountUpdate[] updates) {
        for (IChildrenCountUpdate update : updates) {
            if (!checkUpdate(update)) continue;

            // We assume that the getExpressions() will just read local state data,
            // so we don't bother using a job to perform this operation.
            update.setChildCount(getUpdateExpressionDMC(update) != null ? 1 : 0);
            update.done();
        }
    }
    
    @Override
	public void update(final IChildrenUpdate[] updates) {
        for (IChildrenUpdate update : updates) {
            IExpressionDMContext dmc = getUpdateExpressionDMC(update);
            if (dmc != null) {
                doUpdateChildren(update, new SimpleExpression(dmc.getExpression()));                
            }
            else {
                handleFailedUpdate(update);
            }
        }        
    }
    
    public void doUpdateChildren(final IChildrenUpdate update, final IExpression expression) {
        // getElementForExpression() accepts a IElementsUpdate as an argument.
        // Construct an instance of VMElementsUpdate which will call a 
        // the request monitor when it is finished.  The request monitor
        // will in turn set the element in the update argument in this method. 
        ((ExpressionVMProvider)getVMProvider()).update(
            new VMExpressionUpdate(
                update, expression,
                new ViewerDataRequestMonitor<Object>(getVMProvider().getExecutor(), update) {
                    @Override
                    protected void handleSuccess() {
                        update.setChild(getData(), 0);
                        update.done();
                    } 
                    
                    @Override
                    protected void handleError() {
                        update.setChild(new InvalidExpressionVMContext(SingleExpressionVMNode.this, expression), 0);
                        update.done();
                    }
                })
            );
    }

    @Override
    public void update(ILabelUpdate[] updates) {
        // The label update handler only handles labels for the invalid expression VMCs.
        // The expression layout nodes are responsible for supplying label providers 
        // for their VMCs.
        for (ILabelUpdate update : updates) {
        	update.done();
        }
    }
    
    @Override
    public int getDeltaFlags(Object event) {
        int retVal = 0;

        // Add a flag if the list of expressions in the global expression manager has changed.
        if (event instanceof ExpressionsChangedEvent) {
            retVal |= IModelDelta.ADDED | IModelDelta.REMOVED | IModelDelta.INSERTED | IModelDelta.CONTENT ;
        }

        // The expression in the hover is not known here, so assume that all 
        // expression nodes need to provide delta flags for event.  Iterate 
        // through them here and collect the flags.
        for (IExpressionVMNode node : getExpressionVMProvider().getExpressionNodes()) {
            retVal |= getDeltaFlagsForNode(node, event);
        }
        
        return retVal;
    }

    private int getDeltaFlagsForNode(IVMNode node, Object event) {
        int retVal = node.getDeltaFlags(event);
        for (IVMNode child : getVMProvider().getChildVMNodes(node)) {
            if (!node.equals(child)) {
                retVal |= getDeltaFlagsForNode(child, event);
            }
        }
        return retVal;
    }
    
    @Override
    public void buildDelta(final Object event, final VMDelta parentDelta, final int nodeOffset, final RequestMonitor requestMonitor) {
        if (event instanceof ExpressionsChangedEvent) {
            buildDeltaForExpressionsChangedEvent((ExpressionsChangedEvent)event, parentDelta, nodeOffset, requestMonitor);
        } else {
            Object parent = parentDelta.getElement();
            if (parent instanceof IDMVMContext) {
                IDMContext dmc = ((IDMVMContext)parent).getDMContext();
                if (dmc instanceof IExpressionDMContext) {
                    IExpression expression = new SimpleExpression( ((IExpressionDMContext)dmc).getExpression() );
                    int flags = getExpressionVMProvider().getDeltaFlagsForExpression(expression, event);
                    // If the given expression has no delta flags, skip it.
                    if (flags != IModelDelta.NO_CHANGE) {
                        getExpressionVMProvider().buildDeltaForExpression(
                            expression, nodeOffset, event, parentDelta, getTreePathFromDelta(parentDelta), 
                            requestMonitor);
                        return;
                    }
                }
            }
        }
        requestMonitor.done();
    }
    
    private void buildDeltaForExpressionsChangedEvent(ExpressionsChangedEvent event, VMDelta parentDelta, 
        int nodeOffset, RequestMonitor requestMonitor) 
    {
        CountingRequestMonitor multiRm = new CountingRequestMonitor(getExecutor(), requestMonitor);
        for (int i = 0; i < event.getExpressions().length; i++) {
            int expIndex = event.getIndex() != -1 
                ? nodeOffset + event.getIndex() + i 
                : -1; 
            getExpressionVMProvider().buildDeltaForExpression(
                event.getExpressions()[i], expIndex, event, parentDelta, getTreePathFromDelta(parentDelta), 
                new RequestMonitor(getExecutor(), multiRm));
        }
        multiRm.setDoneCount(event.getExpressions().length);
    }
        
    private TreePath getTreePathFromDelta(IModelDelta delta) {
        List<Object> elementList = new LinkedList<Object>();
        IModelDelta listDelta = delta;
        elementList.add(0, listDelta.getElement());
        while (listDelta.getParentDelta() != null) {
            elementList.add(0, listDelta.getElement());
            listDelta = listDelta.getParentDelta();
        }
        return new TreePath(elementList.toArray());
    }

	public IDMVMContext createVMContext(IDMContext dmc) {
        return new RootDMVMContext(getVMProvider().getRootVMNode(), dmc);
    }

}

Back to the top