|
1 /* |
|
2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: |
|
15 * |
|
16 * Content provider for tree viewer |
|
17 * |
|
18 */ |
|
19 package com.nokia.tracebuilder.view; |
|
20 |
|
21 import java.util.Iterator; |
|
22 |
|
23 import org.eclipse.jface.viewers.ITreeContentProvider; |
|
24 import org.eclipse.jface.viewers.TreeViewer; |
|
25 import org.eclipse.jface.viewers.Viewer; |
|
26 |
|
27 import com.nokia.tracebuilder.engine.LastKnownLocationList; |
|
28 import com.nokia.tracebuilder.engine.TraceBuilderConfiguration; |
|
29 import com.nokia.tracebuilder.engine.TraceBuilderGlobals; |
|
30 import com.nokia.tracebuilder.engine.TraceLocationList; |
|
31 import com.nokia.tracebuilder.engine.TraceViewExtension; |
|
32 import com.nokia.tracebuilder.model.Trace; |
|
33 import com.nokia.tracebuilder.model.TraceConstantTable; |
|
34 import com.nokia.tracebuilder.model.TraceConstantTableEntry; |
|
35 import com.nokia.tracebuilder.model.TraceGroup; |
|
36 import com.nokia.tracebuilder.model.TraceModel; |
|
37 import com.nokia.tracebuilder.model.TraceModelExtension; |
|
38 import com.nokia.tracebuilder.model.TraceModelExtensionListener; |
|
39 import com.nokia.tracebuilder.model.TraceModelListener; |
|
40 import com.nokia.tracebuilder.model.TraceModelResetListener; |
|
41 import com.nokia.tracebuilder.model.TraceObject; |
|
42 import com.nokia.tracebuilder.model.TraceParameter; |
|
43 import com.nokia.tracebuilder.rules.ArrayParameterRule; |
|
44 import com.nokia.tracebuilder.rules.HiddenTraceObjectRule; |
|
45 |
|
46 /** |
|
47 * Content provider for tree viewer |
|
48 * |
|
49 */ |
|
50 final class TraceContentProvider implements ITreeContentProvider, |
|
51 TraceModelListener, TraceModelResetListener, |
|
52 TraceModelExtensionListener { |
|
53 |
|
54 /** |
|
55 * Root wrapper for trace model |
|
56 */ |
|
57 private TraceModelWrapper modelWrapper; |
|
58 |
|
59 /** |
|
60 * Thread that performs view updates |
|
61 */ |
|
62 private TraceViewUpdater updater; |
|
63 |
|
64 /* |
|
65 * (non-Javadoc) |
|
66 * |
|
67 * @see org.eclipse.jface.viewers.IContentProvider#inputChanged(org.eclipse.jface.viewers.Viewer, |
|
68 * java.lang.Object, java.lang.Object) |
|
69 */ |
|
70 public void inputChanged(Viewer viewer, Object oldInput, Object newInput) { |
|
71 // This is called when user navigates into a sub-tree of the viewer. |
|
72 // However, the updater is created only once. |
|
73 if (updater == null) { |
|
74 TraceModel model = TraceBuilderGlobals.getTraceModel(); |
|
75 updater = new TraceViewUpdater((TreeViewer) viewer); |
|
76 modelWrapper = new TraceModelWrapper(model, null, updater); |
|
77 updater.setRoot(modelWrapper); |
|
78 addListeners(model); |
|
79 } |
|
80 } |
|
81 |
|
82 /* |
|
83 * (non-Javadoc) |
|
84 * |
|
85 * @see org.eclipse.jface.viewers.IContentProvider#dispose() |
|
86 */ |
|
87 public void dispose() { |
|
88 if (updater != null) { |
|
89 updater.stopUpdater(); |
|
90 updater = null; |
|
91 } |
|
92 if (modelWrapper != null) { |
|
93 removeListeners(); |
|
94 modelWrapper.delete(); |
|
95 modelWrapper = null; |
|
96 } |
|
97 } |
|
98 |
|
99 /** |
|
100 * Adds listeners to the model |
|
101 * |
|
102 * @param model |
|
103 * the model |
|
104 */ |
|
105 private void addListeners(TraceModel model) { |
|
106 model.addModelListener(this); |
|
107 model.addExtensionListener(this); |
|
108 model.addResetListener(this); |
|
109 } |
|
110 |
|
111 /** |
|
112 * Removes the model listeners |
|
113 */ |
|
114 private void removeListeners() { |
|
115 TraceModel model = (TraceModel) modelWrapper.getTraceObject(); |
|
116 model.removeModelListener(this); |
|
117 model.removeExtensionListener(this); |
|
118 model.removeResetListener(this); |
|
119 } |
|
120 |
|
121 /* |
|
122 * (non-Javadoc) |
|
123 * |
|
124 * @see org.eclipse.jface.viewers.ITreeContentProvider#getParent(java.lang.Object) |
|
125 */ |
|
126 public Object getParent(Object child) { |
|
127 return ((WrapperBase) child).getParent(); |
|
128 } |
|
129 |
|
130 /* |
|
131 * (non-Javadoc) |
|
132 * |
|
133 * @see org.eclipse.jface.viewers.ITreeContentProvider#hasChildren(java.lang.Object) |
|
134 */ |
|
135 public boolean hasChildren(Object parent) { |
|
136 return ((WrapperBase) parent).hasChildren(); |
|
137 } |
|
138 |
|
139 /* |
|
140 * (non-Javadoc) |
|
141 * |
|
142 * @see org.eclipse.jface.viewers.IStructuredContentProvider#getElements(java.lang.Object) |
|
143 */ |
|
144 public Object[] getElements(Object parent) { |
|
145 Object[] ret; |
|
146 // If the tree is navigated into a sub-element, the parent will be an |
|
147 // instance of WrapperBase |
|
148 if (parent instanceof WrapperBase) { |
|
149 ret = getChildren(parent); |
|
150 } else { |
|
151 ret = modelWrapper.getChildren(); |
|
152 } |
|
153 return ret; |
|
154 } |
|
155 |
|
156 /* |
|
157 * (non-Javadoc) |
|
158 * |
|
159 * @see org.eclipse.jface.viewers.ITreeContentProvider#getChildren(java.lang.Object) |
|
160 */ |
|
161 public Object[] getChildren(Object parent) { |
|
162 return ((WrapperBase) parent).getChildren(); |
|
163 } |
|
164 |
|
165 /* |
|
166 * (non-Javadoc) |
|
167 * |
|
168 * @see com.nokia.tracebuilder.model.TraceModelResetListener#modelResetting() |
|
169 */ |
|
170 public void modelResetting() { |
|
171 } |
|
172 |
|
173 /* |
|
174 * (non-Javadoc) |
|
175 * |
|
176 * @see com.nokia.tracebuilder.model.TraceModelResetListener#modelReset() |
|
177 */ |
|
178 public void modelReset() { |
|
179 modelWrapper.modelReset(); |
|
180 refreshView(modelWrapper); |
|
181 } |
|
182 |
|
183 /* |
|
184 * (non-Javadoc) |
|
185 * |
|
186 * @see com.nokia.tracebuilder.model.TraceModelResetListener#modelValid(boolean) |
|
187 */ |
|
188 public void modelValid(boolean valid) { |
|
189 } |
|
190 |
|
191 /* |
|
192 * (non-Javadoc) |
|
193 * |
|
194 * @see com.nokia.tracebuilder.model.TraceModelListener# |
|
195 * objectAdded(com.nokia.tracebuilder.model.TraceObject, |
|
196 * com.nokia.tracebuilder.model.TraceObject) |
|
197 */ |
|
198 public void objectAdded(TraceObject owner, TraceObject object) { |
|
199 WrapperBase wrapper = null; |
|
200 if (object instanceof TraceGroup) { |
|
201 wrapper = modelWrapper.addGroup((TraceGroup) object); |
|
202 } else if (object instanceof Trace) { |
|
203 TraceGroupWrapper groupWrapper = owner |
|
204 .getExtension(TraceGroupWrapper.class); |
|
205 wrapper = groupWrapper.addTrace((Trace) object); |
|
206 } else if (object instanceof TraceParameter) { |
|
207 TraceWrapper objectWrapper = owner.getExtension(TraceWrapper.class); |
|
208 wrapper = objectWrapper.addParameter((TraceParameter) object); |
|
209 } else if (object instanceof TraceConstantTable) { |
|
210 // Constant tables are added to the model and to the parameters |
|
211 // referencing the tables. The parameter wrapper takes care of the |
|
212 // reference |
|
213 wrapper = modelWrapper |
|
214 .addConstantTable((TraceConstantTable) object); |
|
215 } else if (object instanceof TraceConstantTableEntry) { |
|
216 // Constant tables are referenced from multiple parameters and the |
|
217 // list of constant tables stored into the model wrapper. Thus |
|
218 // getExtensions needs to be used |
|
219 Iterator<ConstantTableWrapper> itr = owner |
|
220 .getExtensions(ConstantTableWrapper.class); |
|
221 while (itr.hasNext()) { |
|
222 refreshView(itr.next().addConstantTableEntry( |
|
223 (TraceConstantTableEntry) object)); |
|
224 } |
|
225 } |
|
226 if (wrapper != null) { |
|
227 refreshView(wrapper); |
|
228 } |
|
229 } |
|
230 |
|
231 /* |
|
232 * (non-Javadoc) |
|
233 * |
|
234 * @see com.nokia.tracebuilder.model.TraceModelListener# |
|
235 * objectRemoved(com.nokia.tracebuilder.model.TraceObject, |
|
236 * com.nokia.tracebuilder.model.TraceObject) |
|
237 */ |
|
238 public void objectRemoved(TraceObject owner, TraceObject object) { |
|
239 WrapperBase wrapper = null; |
|
240 if (object instanceof TraceGroup) { |
|
241 wrapper = modelWrapper.removeGroup((TraceGroup) object); |
|
242 } else if (object instanceof Trace) { |
|
243 TraceGroupWrapper groupWrapper = owner |
|
244 .getExtension(TraceGroupWrapper.class); |
|
245 wrapper = groupWrapper.removeTrace((Trace) object); |
|
246 } else if (object instanceof TraceParameter) { |
|
247 TraceWrapper objectWrapper = owner.getExtension(TraceWrapper.class); |
|
248 wrapper = objectWrapper.removeParameter((TraceParameter) object); |
|
249 } else if (object instanceof TraceConstantTable) { |
|
250 wrapper = modelWrapper |
|
251 .removeConstantTable((TraceConstantTable) object); |
|
252 } else if (object instanceof TraceConstantTableEntry) { |
|
253 // Constant tables are referenced from multiple parameters and the |
|
254 // list of constant tables stored into the model wrapper. Thus |
|
255 // getExtensions needs to be used |
|
256 Iterator<ConstantTableWrapper> itr = owner |
|
257 .getExtensions(ConstantTableWrapper.class); |
|
258 while (itr.hasNext()) { |
|
259 refreshView(itr.next().removeConstantTableEntry( |
|
260 (TraceConstantTableEntry) object)); |
|
261 } |
|
262 } |
|
263 if (wrapper != null) { |
|
264 refreshView(wrapper); |
|
265 } |
|
266 } |
|
267 |
|
268 /* |
|
269 * (non-Javadoc) |
|
270 * |
|
271 * @see com.nokia.tracebuilder.model.TraceModelListener# |
|
272 * objectCreationComplete(com.nokia.tracebuilder.model.TraceObject) |
|
273 */ |
|
274 public void objectCreationComplete(TraceObject object) { |
|
275 // Not interested, since all individual additions and updates are |
|
276 // monitored. TraceViewUpdater takes care of the optimizations if there |
|
277 // are lots of sequential updates |
|
278 } |
|
279 |
|
280 /* |
|
281 * (non-Javadoc) |
|
282 * |
|
283 * @see com.nokia.tracebuilder.model.TraceModelListener# |
|
284 * propertiesUpdated(com.nokia.tracebuilder.model.TraceObject) |
|
285 */ |
|
286 public void propertyUpdated(TraceObject object, int property) { |
|
287 Iterator<TraceObjectWrapper> itr = object |
|
288 .getExtensions(TraceObjectWrapper.class); |
|
289 while (itr.hasNext()) { |
|
290 refreshView(itr.next().refreshProperty(property)); |
|
291 } |
|
292 } |
|
293 |
|
294 /* |
|
295 * (non-Javadoc) |
|
296 * |
|
297 * @see com.nokia.tracebuilder.model.TraceModelExtensionListener# |
|
298 * extensionAdded(com.nokia.tracebuilder.model.TraceObject, |
|
299 * com.nokia.tracebuilder.model.TraceModelExtension) |
|
300 */ |
|
301 public void extensionAdded(TraceObject object, TraceModelExtension extension) { |
|
302 // Location lists and locations have their own listeners, which are |
|
303 // used for update notifications |
|
304 if (extension instanceof TraceLocationList) { |
|
305 if (object instanceof Trace) { |
|
306 TraceWrapper traceWrapper = object |
|
307 .getExtension(TraceWrapper.class); |
|
308 refreshView(traceWrapper |
|
309 .setLocationList((TraceLocationList) extension)); |
|
310 } else if (object instanceof TraceModel) { |
|
311 refreshView(modelWrapper |
|
312 .addLocationList((TraceLocationList) extension)); |
|
313 } |
|
314 } else if (extension instanceof LastKnownLocationList) { |
|
315 TraceWrapper traceWrapper = object.getExtension(TraceWrapper.class); |
|
316 refreshView(traceWrapper |
|
317 .setLastKnownLocationList((LastKnownLocationList) extension)); |
|
318 } else if (extension instanceof TraceViewExtension) { |
|
319 TraceObjectWrapper objectWrapper = object |
|
320 .getExtension(TraceObjectWrapper.class); |
|
321 refreshView(objectWrapper |
|
322 .addExtension((TraceViewExtension) extension)); |
|
323 } else if (extension instanceof HiddenTraceObjectRule) { |
|
324 if (!TraceBuilderConfiguration.SHOW_HIDDEN_PARAMETERS_IN_VIEW) { |
|
325 TraceObjectWrapper objectWrapper = object |
|
326 .getExtension(TraceObjectWrapper.class); |
|
327 refreshView(objectWrapper.hideFromView()); |
|
328 } |
|
329 } else if (extension instanceof ArrayParameterRule) { |
|
330 TraceObjectWrapper objectWrapper = object |
|
331 .getExtension(TraceObjectWrapper.class); |
|
332 if (objectWrapper instanceof TraceParameterWrapper) { |
|
333 refreshView(((TraceParameterWrapper) objectWrapper) |
|
334 .setArrayType(true)); |
|
335 } |
|
336 } |
|
337 } |
|
338 |
|
339 /* |
|
340 * (non-Javadoc) |
|
341 * |
|
342 * @see com.nokia.tracebuilder.model.TraceModelExtensionListener# |
|
343 * extensionRemoved(com.nokia.tracebuilder.model.TraceObject, |
|
344 * com.nokia.tracebuilder.model.TraceModelExtension) |
|
345 */ |
|
346 public void extensionRemoved(TraceObject object, |
|
347 TraceModelExtension extension) { |
|
348 if (extension instanceof TraceLocationList) { |
|
349 if (object instanceof Trace) { |
|
350 TraceWrapper traceWrapper = object |
|
351 .getExtension(TraceWrapper.class); |
|
352 refreshView(traceWrapper.setLocationList(null)); |
|
353 } else if (object instanceof TraceModel) { |
|
354 refreshView(modelWrapper |
|
355 .removeLocationList((TraceLocationList) extension)); |
|
356 } |
|
357 } else if (extension instanceof LastKnownLocationList) { |
|
358 TraceWrapper traceWrapper = object.getExtension(TraceWrapper.class); |
|
359 refreshView(traceWrapper.setLastKnownLocationList(null)); |
|
360 } else if (extension instanceof TraceViewExtension) { |
|
361 TraceObjectWrapper objectWrapper = object |
|
362 .getExtension(TraceObjectWrapper.class); |
|
363 refreshView(objectWrapper |
|
364 .removeExtension((TraceViewExtension) extension)); |
|
365 } else if (extension instanceof ArrayParameterRule) { |
|
366 TraceObjectWrapper objectWrapper = object |
|
367 .getExtension(TraceObjectWrapper.class); |
|
368 if (objectWrapper instanceof TraceParameterWrapper) { |
|
369 refreshView(((TraceParameterWrapper) objectWrapper) |
|
370 .setArrayType(false)); |
|
371 } |
|
372 } |
|
373 } |
|
374 |
|
375 /** |
|
376 * Refreshes the view |
|
377 * |
|
378 * @param wrapper |
|
379 * the wrapper that needs to be updated |
|
380 */ |
|
381 private void refreshView(WrapperBase wrapper) { |
|
382 if (wrapper != null) { |
|
383 updater.queueUpdate(wrapper); |
|
384 } |
|
385 } |
|
386 |
|
387 /** |
|
388 * Dumps the model to System.out |
|
389 * |
|
390 * @param labelProvider |
|
391 * the label provider for objects |
|
392 */ |
|
393 void dumpToSystemOut(TraceLabelProvider labelProvider) { |
|
394 if (TraceBuilderConfiguration.TRACE_VIEW_STATE) { |
|
395 modelWrapper.dumpToSystemOut(0, labelProvider); |
|
396 } |
|
397 } |
|
398 |
|
399 } |