Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: d37921c0703c7279cb3c7bfa614e96851e19f602 (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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
/*******************************************************************************
 * Copyright (c) 2006, 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
 *     Marc Khouzam (Ericsson) - Add support disable "View Memory" action (bug 418710)
 *******************************************************************************/

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

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.RejectedExecutionException;

import org.eclipse.cdt.debug.core.model.ICastToArray;
import org.eclipse.cdt.debug.core.model.ICastToType;
import org.eclipse.cdt.debug.core.model.IViewInMemory;
import org.eclipse.cdt.debug.internal.ui.CDebugImages;
import org.eclipse.cdt.dsf.concurrent.ConfinedToDsfExecutor;
import org.eclipse.cdt.dsf.concurrent.CountingRequestMonitor;
import org.eclipse.cdt.dsf.concurrent.DataRequestMonitor;
import org.eclipse.cdt.dsf.concurrent.DsfExecutor;
import org.eclipse.cdt.dsf.concurrent.DsfRunnable;
import org.eclipse.cdt.dsf.concurrent.IDsfStatusConstants;
import org.eclipse.cdt.dsf.concurrent.ImmediateExecutor;
import org.eclipse.cdt.dsf.concurrent.RequestMonitor;
import org.eclipse.cdt.dsf.datamodel.DMContexts;
import org.eclipse.cdt.dsf.datamodel.IDMContext;
import org.eclipse.cdt.dsf.debug.internal.ui.viewmodel.DsfCastToTypeSupport;
import org.eclipse.cdt.dsf.debug.service.IExpressions;
import org.eclipse.cdt.dsf.debug.service.IExpressions.IExpressionChangedDMEvent;
import org.eclipse.cdt.dsf.debug.service.IExpressions.IExpressionDMAddress;
import org.eclipse.cdt.dsf.debug.service.IExpressions.IExpressionDMContext;
import org.eclipse.cdt.dsf.debug.service.IExpressions.IExpressionDMData;
import org.eclipse.cdt.dsf.debug.service.IExpressions.IExpressionDMLocation;
import org.eclipse.cdt.dsf.debug.service.IExpressions.IIndexedPartitionDMContext;
import org.eclipse.cdt.dsf.debug.service.IExpressions2;
import org.eclipse.cdt.dsf.debug.service.IExpressions3;
import org.eclipse.cdt.dsf.debug.service.IExpressions3.IExpressionDMDataExtension;
import org.eclipse.cdt.dsf.debug.service.IFormattedValues;
import org.eclipse.cdt.dsf.debug.service.IMemory.IMemoryChangedEvent;
import org.eclipse.cdt.dsf.debug.service.IRunControl.ISuspendedDMEvent;
import org.eclipse.cdt.dsf.debug.service.IStack;
import org.eclipse.cdt.dsf.debug.service.IStack.IFrameDMContext;
import org.eclipse.cdt.dsf.debug.service.IStack.IVariableDMContext;
import org.eclipse.cdt.dsf.debug.service.IStack.IVariableDMData;
import org.eclipse.cdt.dsf.debug.ui.viewmodel.ErrorLabelForeground;
import org.eclipse.cdt.dsf.debug.ui.viewmodel.ErrorLabelText;
import org.eclipse.cdt.dsf.debug.ui.viewmodel.IDebugVMConstants;
import org.eclipse.cdt.dsf.debug.ui.viewmodel.expression.AbstractExpressionVMNode;
import org.eclipse.cdt.dsf.debug.ui.viewmodel.expression.IExpressionUpdate;
import org.eclipse.cdt.dsf.debug.ui.viewmodel.numberformat.FormattedValueLabelText;
import org.eclipse.cdt.dsf.debug.ui.viewmodel.numberformat.FormattedValueRetriever;
import org.eclipse.cdt.dsf.debug.ui.viewmodel.numberformat.FormattedValueVMUtil;
import org.eclipse.cdt.dsf.debug.ui.viewmodel.numberformat.IFormattedValueVMContext;
import org.eclipse.cdt.dsf.debug.ui.viewmodel.update.ElementFormatEvent;
import org.eclipse.cdt.dsf.internal.ui.DsfUIPlugin;
import org.eclipse.cdt.dsf.service.DsfSession;
import org.eclipse.cdt.dsf.ui.concurrent.ViewerCountingRequestMonitor;
import org.eclipse.cdt.dsf.ui.concurrent.ViewerDataRequestMonitor;
import org.eclipse.cdt.dsf.ui.viewmodel.VMDelta;
import org.eclipse.cdt.dsf.ui.viewmodel.datamodel.AbstractDMVMProvider;
import org.eclipse.cdt.dsf.ui.viewmodel.datamodel.IDMVMContext;
import org.eclipse.cdt.dsf.ui.viewmodel.properties.IElementPropertiesProvider;
import org.eclipse.cdt.dsf.ui.viewmodel.properties.IPropertiesUpdate;
import org.eclipse.cdt.dsf.ui.viewmodel.properties.LabelAttribute;
import org.eclipse.cdt.dsf.ui.viewmodel.properties.LabelBackground;
import org.eclipse.cdt.dsf.ui.viewmodel.properties.LabelColumnInfo;
import org.eclipse.cdt.dsf.ui.viewmodel.properties.LabelForeground;
import org.eclipse.cdt.dsf.ui.viewmodel.properties.LabelImage;
import org.eclipse.cdt.dsf.ui.viewmodel.properties.LabelText;
import org.eclipse.cdt.dsf.ui.viewmodel.properties.PropertiesBasedLabelProvider;
import org.eclipse.cdt.dsf.ui.viewmodel.properties.VMDelegatingPropertiesUpdate;
import org.eclipse.cdt.dsf.ui.viewmodel.update.ICachingVMProvider;
import org.eclipse.cdt.dsf.ui.viewmodel.update.StaleDataLabelBackground;
import org.eclipse.cdt.dsf.ui.viewmodel.update.StaleDataLabelForeground;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.debug.core.model.IExpression;
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.IElementCompareRequest;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IElementEditor;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IElementLabelProvider;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IElementMementoProvider;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IElementMementoRequest;
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.IPresentationContext;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IViewerUpdate;
import org.eclipse.debug.ui.DebugUITools;
import org.eclipse.debug.ui.IDebugModelPresentation;
import org.eclipse.debug.ui.IDebugUIConstants;
import org.eclipse.debug.ui.actions.IWatchExpressionFactoryAdapter2;
import org.eclipse.jface.util.IPropertyChangeListener;
import org.eclipse.jface.util.PropertyChangeEvent;
import org.eclipse.jface.viewers.CellEditor;
import org.eclipse.jface.viewers.ICellModifier;
import org.eclipse.jface.viewers.TextCellEditor;
import org.eclipse.jface.viewers.TreePath;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.IMemento;

public class VariableVMNode extends AbstractExpressionVMNode
		implements IElementEditor, IElementLabelProvider, IElementPropertiesProvider, IElementMementoProvider {
	/**
	 * @since 2.1
	 */
	public static final String PROP_VARIABLE_TYPE_NAME = "variable_type_name"; //$NON-NLS-1$

	/**
	 * @since 2.1
	 */
	public static final String PROP_VARIABLE_BASIC_TYPE = "variable_basic_type"; //$NON-NLS-1$

	/**
	 * @since 2.1
	 */
	public static final String PROP_VARIABLE_ADDRESS = "variable_address"; //$NON-NLS-1$

	/**
	 * @since 2.1
	 */
	public static final String PROP_VARIABLE_SHOW_TYPE_NAMES = "variable_show_type_names"; //$NON-NLS-1$

	/**
	 * @since 2.1
	 */
	public static final String PROP_VARIABLE_ADDRESS_CHANGED = ICachingVMProvider.PROP_IS_CHANGED_PREFIX
			+ PROP_VARIABLE_ADDRESS;

	/**
	 * 'PROP_VARIABLE_BASIC_TYPE' property value for indexed partitions
	 */
	private static final String INDEXED_PARTITION_TYPE = "indexed_partition_type"; //$NON-NLS-1$

	private final SyncVariableDataAccess fSyncVariableDataAccess;

	/**
	 * The label provider delegate.  This VM node will delegate label updates to this provider
	 * which can be created by sub-classes.
	 *
	 * @since 2.0
	 */
	private final IElementLabelProvider fLabelProvider;

	/**
	 * Retriever for formatted values configured for this VM node.
	 * @since 2.2
	 */
	private final FormattedValueRetriever fFormattedValueRetriever;

	public class VariableExpressionVMC extends DMVMContext implements IFormattedValueVMContext, IViewInMemory {

		private IExpression fExpression;

		public VariableExpressionVMC(IDMContext dmc) {
			super(dmc);
		}

		/* (non-Javadoc)
		 * @see org.eclipse.cdt.debug.internal.core.IWatchpointTarget#getExpression()
		 */
		public String getExpression() {
			final IExpressionDMContext exprDmc = DMContexts.getAncestorOfType(getDMContext(),
					IExpressionDMContext.class);
			if (exprDmc != null) {
				return exprDmc.getExpression();
			}
			return ""; //$NON-NLS-1$
		}

		public void setExpression(IExpression expression) {
			fExpression = expression;
		}

		@SuppressWarnings({ "unchecked", "rawtypes" })
		@Override
		public Object getAdapter(Class adapter) {
			if (fExpression != null && adapter.isAssignableFrom(fExpression.getClass())) {
				return fExpression;
			} else if (adapter.isAssignableFrom(IWatchExpressionFactoryAdapter2.class)) {
				return fVariableExpressionFactory;
			} else if (fCastToTypeSupport != null && getDMContext() instanceof IExpressionDMContext
					&& (adapter.isAssignableFrom(ICastToType.class) || adapter.isAssignableFrom(ICastToArray.class))) {
				return fCastToTypeSupport.getCastImpl((IExpressionDMContext) getDMContext());
			} else {
				return super.getAdapter(adapter);
			}
		}

		@Override
		public boolean equals(Object other) {
			if (other instanceof VariableExpressionVMC && super.equals(other)) {
				VariableExpressionVMC otherGroup = (VariableExpressionVMC) other;
				return (otherGroup.fExpression == null && fExpression == null)
						|| (otherGroup.fExpression != null && otherGroup.fExpression.equals(fExpression));
			}
			return false;
		}

		@Override
		public int hashCode() {
			return super.hashCode() + (fExpression != null ? fExpression.hashCode() : 0);
		}

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

		@Override
		public void viewInMemory() {
			assert false : "VariableExpressionVMC.viewInMemory() not implemented"; //$NON-NLS-1$
		}
	}

	protected class VariableExpressionFactory implements IWatchExpressionFactoryAdapter2 {

		@Override
		public boolean canCreateWatchExpression(Object element) {
			return element instanceof VariableExpressionVMC;
		}

		@Override
		public String createWatchExpression(Object element) throws CoreException {

			VariableExpressionVMC exprVmc = (VariableExpressionVMC) element;

			IExpressionDMContext exprDmc = DMContexts.getAncestorOfType(exprVmc.getDMContext(),
					IExpressionDMContext.class);
			if (exprDmc != null) {
				return exprDmc.getExpression();
			}

			return null;
		}
	}

	final protected VariableExpressionFactory fVariableExpressionFactory = new VariableExpressionFactory();

	protected DsfCastToTypeSupport fCastToTypeSupport;

	public VariableVMNode(AbstractDMVMProvider provider, DsfSession session,
			SyncVariableDataAccess syncVariableDataAccess) {
		super(provider, session, IExpressions.IExpressionDMContext.class);
		fSyncVariableDataAccess = syncVariableDataAccess;
		fLabelProvider = createLabelProvider();
		fFormattedValueRetriever = new FormattedValueRetriever(this, session, IExpressions.class,
				IExpressionDMContext.class);
	}

	/**
	 * Set the cast support target.  This is only meaningful if the {@link IExpressions2}
	 * service is available.
	 * @param castToTypeSupport
	 */
	public void setCastToTypeSupport(DsfCastToTypeSupport castToTypeSupport) {
		this.fCastToTypeSupport = castToTypeSupport;
	}

	/**
	 * Creates the label provider delegate.  This VM node will delegate label
	 * updates to this provider which can be created by sub-classes.
	 *
	 * @return Returns the label provider for this node.
	 *
	 * @since 2.0
	 */
	private LabelBackground columnIdValueBackground;
	private LabelBackground columnNoColumnsBackground;
	private IPropertyChangeListener fPreferenceChangeListener;

	@Override
	public void dispose() {

		if (fPreferenceChangeListener != null) {
			DebugUITools.getPreferenceStore().removePropertyChangeListener(fPreferenceChangeListener);
		}

		super.dispose();

		fFormattedValueRetriever.dispose();
	}

	/**
	 * Create label image objects which are used in more than one column.
	 *
	 * @since 2.1
	 *
	 * Pointer image is used for variable and function pointers.
	 */
	public final static LabelImage POINTER_LABEL_IMAGE = new LabelImage(CDebugImages.DESC_OBJS_VARIABLE_POINTER) {
		{
			setPropertyNames(new String[] { PROP_VARIABLE_BASIC_TYPE });
		}

		@Override
		public boolean isEnabled(IStatus status, java.util.Map<String, Object> properties) {
			String type = (String) properties.get(PROP_VARIABLE_BASIC_TYPE);
			return IExpressionDMData.BasicType.pointer.name().equals(type)
					|| IExpressionDMData.BasicType.function.name().equals(type);
		};
	};

	/**
	 * @since 2.1
	 *
	 * Aggregate image is used for array, struct, etc.
	 */
	public final static LabelImage AGGREGATE_LABEL_IMAGE = new LabelImage(CDebugImages.DESC_OBJS_VARIABLE_AGGREGATE) {
		{
			setPropertyNames(new String[] { PROP_VARIABLE_BASIC_TYPE });
		}

		@Override
		public boolean isEnabled(IStatus status, java.util.Map<String, Object> properties) {
			String type = (String) properties.get(PROP_VARIABLE_BASIC_TYPE);
			return IExpressionDMData.BasicType.array.name().equals(type)
					|| IExpressionDMData.BasicType.composite.name().equals(type);
		};
	};

	/**
	 * @since 2.1
	 *
	 * Simple variable image is used for all other types, except when there is no type specified.
	 */
	public final static LabelImage SIMPLE_LABEL_IMAGE = new LabelImage(CDebugImages.DESC_OBJS_VARIABLE_SIMPLE) {
		{
			setPropertyNames(new String[] { PROP_VARIABLE_BASIC_TYPE });
		}

		@Override
		public boolean isEnabled(IStatus status, java.util.Map<String, Object> properties) {
			String type = (String) properties.get(PROP_VARIABLE_BASIC_TYPE);
			return type != null;
		};
	};

	public final static LabelImage PARTITION_LABEL_IMAGE = new LabelImage(CDebugImages.DESC_OBJS_ARRAY_PARTITION) {
		{
			setPropertyNames(new String[] { PROP_VARIABLE_BASIC_TYPE });
		}

		@Override
		public boolean isEnabled(IStatus status, java.util.Map<String, Object> properties) {
			String type = (String) properties.get(PROP_VARIABLE_BASIC_TYPE);
			return INDEXED_PARTITION_TYPE.equals(type);
		};
	};

	protected IElementLabelProvider createLabelProvider() {

		//
		// Create the foreground/background colors which can be dynamically modified.
		//
		columnIdValueBackground = new LabelBackground(
				DebugUITools.getPreferenceColor(IDebugUIConstants.PREF_CHANGED_VALUE_BACKGROUND).getRGB()) {
			{
				setPropertyNames(new String[] {
						FormattedValueVMUtil.getPropertyForFormatId(IFormattedValues.STRING_FORMAT),
						ICachingVMProvider.PROP_IS_CHANGED_PREFIX
								+ FormattedValueVMUtil.getPropertyForFormatId(IFormattedValues.STRING_FORMAT),
						IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT_VALUE,
						ICachingVMProvider.PROP_IS_CHANGED_PREFIX
								+ IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT_VALUE,
						IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT, ICachingVMProvider.PROP_IS_CHANGED_PREFIX
								+ IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT });
			}

			@Override
			public boolean isEnabled(IStatus status, java.util.Map<String, Object> properties) {
				Boolean activeFormatChanged = (Boolean) properties.get(ICachingVMProvider.PROP_IS_CHANGED_PREFIX
						+ IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT);
				Boolean activeChanged = (Boolean) properties.get(ICachingVMProvider.PROP_IS_CHANGED_PREFIX
						+ IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT_VALUE);
				Boolean stringChanged = (Boolean) properties.get(ICachingVMProvider.PROP_IS_CHANGED_PREFIX
						+ FormattedValueVMUtil.getPropertyForFormatId(IFormattedValues.STRING_FORMAT));
				return Boolean.TRUE.equals(stringChanged)
						|| (Boolean.TRUE.equals(activeChanged) && !Boolean.TRUE.equals(activeFormatChanged));
			}
		};

		columnNoColumnsBackground = new LabelBackground(
				DebugUITools.getPreferenceColor(IDebugUIConstants.PREF_CHANGED_VALUE_BACKGROUND).getRGB()) {
			{
				setPropertyNames(
						new String[] { FormattedValueVMUtil.getPropertyForFormatId(IFormattedValues.STRING_FORMAT),
								IDebugVMConstants.PROP_IS_STRING_FORMAT_VALUE_CHANGED,
								IDebugVMConstants.PROP_IS_ACTIVE_FORMATTED_VALUE_CHANGED });
			}

			@Override
			public boolean isEnabled(IStatus status, java.util.Map<String, Object> properties) {
				Boolean stringChanged = (Boolean) properties.get(IDebugVMConstants.PROP_IS_STRING_FORMAT_VALUE_CHANGED);
				Boolean activeChanged = (Boolean) properties
						.get(IDebugVMConstants.PROP_IS_ACTIVE_FORMATTED_VALUE_CHANGED);
				return Boolean.TRUE.equals(stringChanged) || Boolean.TRUE.equals(activeChanged);
			}
		};

		// Get rid of the previous listener if it exists and then create a new one and sign it up.
		if (fPreferenceChangeListener != null) {
			DebugUITools.getPreferenceStore().removePropertyChangeListener(fPreferenceChangeListener);
		}

		fPreferenceChangeListener = event -> {
			if (event.getProperty().equals(IDebugUIConstants.PREF_CHANGED_VALUE_BACKGROUND)) {
				columnIdValueBackground.setBackground(
						DebugUITools.getPreferenceColor(IDebugUIConstants.PREF_CHANGED_VALUE_BACKGROUND).getRGB());
				columnNoColumnsBackground.setBackground(
						DebugUITools.getPreferenceColor(IDebugUIConstants.PREF_CHANGED_VALUE_BACKGROUND).getRGB());
			}
		};

		DebugUITools.getPreferenceStore().addPropertyChangeListener(fPreferenceChangeListener);

		// Create the initial properties provider which can be built on.
		PropertiesBasedLabelProvider provider = new PropertiesBasedLabelProvider();

		// The name column consists of the expression name.  The name column image depends on the variable type.
		provider.setColumnInfo(IDebugVMConstants.COLUMN_ID__NAME, new LabelColumnInfo(new LabelAttribute[] {
				new LabelText(MessagesForVariablesVM.VariableVMNode_Name_column__text_format,
						new String[] { PROP_NAME }),
				POINTER_LABEL_IMAGE, AGGREGATE_LABEL_IMAGE, PARTITION_LABEL_IMAGE, SIMPLE_LABEL_IMAGE,
				new StaleDataLabelForeground(), new VariableLabelFont(), }));

		// Expression column is visible only in the expressions view.  It shows the expression string that the user
		// entered.  Expression column images are the same as for the name column.
		provider.setColumnInfo(IDebugVMConstants.COLUMN_ID__EXPRESSION, new LabelColumnInfo(new LabelAttribute[] {
				new LabelText(MessagesForVariablesVM.VariableVMNode_Expression_column__text_format,
						new String[] { PROP_ELEMENT_EXPRESSION }),
				POINTER_LABEL_IMAGE, AGGREGATE_LABEL_IMAGE, PARTITION_LABEL_IMAGE, SIMPLE_LABEL_IMAGE,
				new StaleDataLabelForeground(), new VariableLabelFont(), }));

		// Type column only contains the type name.
		provider.setColumnInfo(IDebugVMConstants.COLUMN_ID__TYPE, new LabelColumnInfo(new LabelAttribute[] {
				new LabelText(MessagesForVariablesVM.VariableVMNode_Type_column__text_format,
						new String[] { PROP_VARIABLE_TYPE_NAME }),
				new LabelText(MessagesForVariablesVM.VariableVMNode_Type_column__Error__text_format, new String[] {}),
				new StaleDataLabelForeground(), new VariableLabelFont(), }));

		// Value column is more complicated:
		// - If a STRING value format is supported.  Then the value label consists of the active format label followed
		//   by the string format.
		// - If the STRIGN value format is not supported.  Then only show the active value format.  The GDB reference
		//   implementation currently does not support the string format, but by default it does append extra
		//   information to the value label itself.
		//
		// In case of error, show the error message in the value column (instead of the usual "...".  This is needed
		// for the expressions view, where an invalid expression entered by the user is a normal use case.
		//
		// For changed value high-lighting check both the string value and the value in the active format.  But,
		// ignore the active format value change if the format itself has changed.
		provider.setColumnInfo(IDebugVMConstants.COLUMN_ID__VALUE,
				new LabelColumnInfo(new LabelAttribute[] {
						new FormattedValueLabelText(MessagesForVariablesVM.VariableVMNode_Value_column__text_format,
								new String[] { IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT_VALUE,
										FormattedValueVMUtil.getPropertyForFormatId(IFormattedValues.STRING_FORMAT),
										IDebugVMConstants.PROP_FORMATTED_VALUE_AVAILABLE_FORMATS }) {
							@Override
							public boolean isEnabled(IStatus status, Map<String, Object> properties) {
								String[] formatIds = (String[]) properties
										.get(IDebugVMConstants.PROP_FORMATTED_VALUE_AVAILABLE_FORMATS);
								String activeFormat = (String) properties
										.get(IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT);
								return !IFormattedValues.STRING_FORMAT.equals(activeFormat) && formatIds != null
										&& Arrays.asList(formatIds).contains(IFormattedValues.STRING_FORMAT)
										&& super.isEnabled(status, properties);
							}
						}, new FormattedValueLabelText(), new ErrorLabelText(), new ErrorLabelForeground(),
						columnIdValueBackground, new StaleDataLabelForeground(), new VariableLabelFont(), }));

		// Address column shows the variable's address.  It is highlighted with the change background color when the
		// address value changes.
		provider.setColumnInfo(IDebugVMConstants.COLUMN_ID__ADDRESS, new LabelColumnInfo(new LabelAttribute[] {
				new LabelText(MessagesForVariablesVM.VariableVMNode_Location_column__text_format,
						new String[] { PROP_VARIABLE_ADDRESS }),
				new LabelText(MessagesForVariablesVM.VariableVMNode_Location_column__Error__text_format,
						new String[] {}),
				new LabelBackground(
						DebugUITools.getPreferenceColor(IDebugUIConstants.PREF_CHANGED_VALUE_BACKGROUND).getRGB()) {
					{
						setPropertyNames(new String[] { PROP_VARIABLE_ADDRESS, PROP_VARIABLE_ADDRESS_CHANGED });
					}

					@Override
					public boolean isEnabled(IStatus status, java.util.Map<String, Object> properties) {
						Boolean changed = (Boolean) properties.get(PROP_VARIABLE_ADDRESS_CHANGED);
						return Boolean.TRUE.equals(changed);
					}
				}, new StaleDataLabelForeground(), new VariableLabelFont(), }));

		// Description column is shown in the expression view, but is not supported for variables.
		provider.setColumnInfo(IDebugVMConstants.COLUMN_ID__DESCRIPTION,

				new LabelColumnInfo(new LabelAttribute[] {
						new LabelText(MessagesForVariablesVM.VariableVMNode_Description_column__text_format,
								new String[] {}),
						new VariableLabelFont(), }));

		// Configure the case where there are no columns visible.  It basically combines the name and the value columns only.
		provider.setColumnInfo(PropertiesBasedLabelProvider.ID_COLUMN_NO_COLUMNS,
				new LabelColumnInfo(new LabelAttribute[] {
						new FormattedValueLabelText(MessagesForVariablesVM.VariableVMNode_NoColumns_column__text_format,
								new String[] { PROP_NAME, IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT_VALUE,
										FormattedValueVMUtil.getPropertyForFormatId(IFormattedValues.STRING_FORMAT),
										IDebugVMConstants.PROP_FORMATTED_VALUE_AVAILABLE_FORMATS,
										IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT,
										IDebugVMConstants.PROP_FORMATTED_VALUE_FORMAT_PREFERENCE,
										PROP_VARIABLE_SHOW_TYPE_NAMES }) {
							@Override
							public boolean isEnabled(IStatus status, Map<String, Object> properties) {
								Boolean showTypeNames = (Boolean) properties.get(PROP_VARIABLE_SHOW_TYPE_NAMES);
								String[] formatIds = (String[]) properties
										.get(IDebugVMConstants.PROP_FORMATTED_VALUE_AVAILABLE_FORMATS);
								String activeFormat = (String) properties
										.get(IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT);
								return showTypeNames != null && !showTypeNames.booleanValue()
										&& !IFormattedValues.STRING_FORMAT.equals(activeFormat) && formatIds != null
										&& Arrays.asList(formatIds).contains(IFormattedValues.STRING_FORMAT)
										&& super.isEnabled(status, properties);
							}
						},
						new FormattedValueLabelText(
								MessagesForVariablesVM.VariableVMNode_NoColumns_column__No_string__text_format,
								new String[] { PROP_NAME, IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT_VALUE,
										IDebugVMConstants.PROP_FORMATTED_VALUE_AVAILABLE_FORMATS,
										IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT,
										IDebugVMConstants.PROP_FORMATTED_VALUE_FORMAT_PREFERENCE,
										PROP_VARIABLE_SHOW_TYPE_NAMES }) {
							@Override
							public boolean isEnabled(IStatus status, Map<String, Object> properties) {
								Boolean showTypeNames = (Boolean) properties.get(PROP_VARIABLE_SHOW_TYPE_NAMES);
								return showTypeNames != null && !showTypeNames.booleanValue()
										&& super.isEnabled(status, properties);
							}
						},
						new FormattedValueLabelText(
								MessagesForVariablesVM.VariableVMNode_NoColumns_column__text_format_with_type,
								new String[] { PROP_NAME, IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT_VALUE,
										FormattedValueVMUtil.getPropertyForFormatId(IFormattedValues.STRING_FORMAT),
										PROP_VARIABLE_TYPE_NAME,
										IDebugVMConstants.PROP_FORMATTED_VALUE_AVAILABLE_FORMATS,
										IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT,
										IDebugVMConstants.PROP_FORMATTED_VALUE_FORMAT_PREFERENCE,
										PROP_VARIABLE_SHOW_TYPE_NAMES }) {
							@Override
							public boolean isEnabled(IStatus status, Map<String, Object> properties) {
								Boolean showTypeNames = (Boolean) properties.get(PROP_VARIABLE_SHOW_TYPE_NAMES);
								String[] formatIds = (String[]) properties
										.get(IDebugVMConstants.PROP_FORMATTED_VALUE_AVAILABLE_FORMATS);
								String activeFormat = (String) properties
										.get(IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT);
								return showTypeNames != null && showTypeNames.booleanValue()
										&& !IFormattedValues.STRING_FORMAT.equals(activeFormat) && formatIds != null
										&& Arrays.asList(formatIds).contains(IFormattedValues.STRING_FORMAT)
										&& super.isEnabled(status, properties);
							}
						},
						new FormattedValueLabelText(
								MessagesForVariablesVM.VariableVMNode_NoColumns_column__No_string__text_format_with_type,
								new String[] { PROP_NAME, IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT_VALUE,
										PROP_VARIABLE_TYPE_NAME,
										IDebugVMConstants.PROP_FORMATTED_VALUE_AVAILABLE_FORMATS,
										IDebugVMConstants.PROP_FORMATTED_VALUE_ACTIVE_FORMAT,
										IDebugVMConstants.PROP_FORMATTED_VALUE_FORMAT_PREFERENCE,
										PROP_VARIABLE_SHOW_TYPE_NAMES }) {
							@Override
							public boolean isEnabled(IStatus status, Map<String, Object> properties) {
								Boolean showTypeNames = (Boolean) properties.get(PROP_VARIABLE_SHOW_TYPE_NAMES);
								return showTypeNames != null && showTypeNames.booleanValue()
										&& super.isEnabled(status, properties);
							}
						},
						new ErrorLabelText(MessagesForVariablesVM.VariableVMNode_NoColumns_column__Error__text_format,
								new String[] { PROP_NAME }),
						POINTER_LABEL_IMAGE, AGGREGATE_LABEL_IMAGE, SIMPLE_LABEL_IMAGE, new ErrorLabelForeground(),
						new LabelForeground(DebugUITools
								.getPreferenceColor(IDebugUIConstants.PREF_CHANGED_DEBUG_ELEMENT_COLOR).getRGB()) {
							{
								setPropertyNames(new String[] {
										FormattedValueVMUtil.getPropertyForFormatId(IFormattedValues.STRING_FORMAT),
										IDebugVMConstants.PROP_IS_STRING_FORMAT_VALUE_CHANGED,
										IDebugVMConstants.PROP_IS_ACTIVE_FORMATTED_VALUE_CHANGED });
							}

							@Override
							public boolean isEnabled(IStatus status, java.util.Map<String, Object> properties) {
								Boolean stringChanged = (Boolean) properties
										.get(IDebugVMConstants.PROP_IS_STRING_FORMAT_VALUE_CHANGED);
								Boolean activeChanged = (Boolean) properties
										.get(IDebugVMConstants.PROP_IS_ACTIVE_FORMATTED_VALUE_CHANGED);
								return Boolean.TRUE.equals(stringChanged) || Boolean.TRUE.equals(activeChanged);
							}
						}, columnNoColumnsBackground, new StaleDataLabelBackground(), new VariableLabelFont(), }));

		return provider;
	}

	@Override
	public String toString() {
		return "VariableVMNode(" + getSession().getId() + ")"; //$NON-NLS-1$ //$NON-NLS-2$
	}

	@Override
	protected IDMVMContext createVMContext(IDMContext dmc) {
		return new VariableExpressionVMC(dmc);
	}

	@Override
	public void update(final ILabelUpdate[] updates) {
		fLabelProvider.update(updates);
	}

	/**
	 * Update the variable view properties.  The formatted values need to be
	 * updated in the VM executor thread while the rest of the properties is
	 * updated in the service session's executor thread.  The implementation
	 * splits the handling of the updates to accomplish that.
	 *
	 * @see IElementPropertiesProvider#update(IPropertiesUpdate[])
	 *
	 * @since 2.0
	 */
	@Override
	public void update(final IPropertiesUpdate[] updates) {
		final CountingRequestMonitor countingRm = new CountingRequestMonitor(ImmediateExecutor.getInstance(), null) {
			@Override
			protected void handleCompleted() {
				for (int i = 0; i < updates.length; i++) {
					updates[i].done();
				}
			}
		};
		int count = 0;

		fFormattedValueRetriever.update(updates, countingRm);
		count++;

		final IPropertiesUpdate[] subUpdates = new IPropertiesUpdate[updates.length];
		for (int i = 0; i < updates.length; i++) {
			final IPropertiesUpdate update = updates[i];
			subUpdates[i] = new VMDelegatingPropertiesUpdate(update, countingRm);
			count++;
		}
		countingRm.setDoneCount(count);

		try {
			getSession().getExecutor().execute(new DsfRunnable() {
				@Override
				public void run() {
					updatePropertiesInSessionThread(subUpdates);
				}
			});
		} catch (RejectedExecutionException e) {
			for (IPropertiesUpdate subUpdate : subUpdates) {
				subUpdate.setStatus(new Status(IStatus.ERROR, DsfUIPlugin.PLUGIN_ID, IDsfStatusConstants.REQUEST_FAILED,
						"Session executor shut down " + getSession().getExecutor(), e)); //$NON-NLS-1$
				subUpdate.done();
			}
		}
	}

	//
	//  @param return-value Boolean.TRUE  --> Show Types ICON is     selected/depressed
	//  @param return-value Boolean.FALSE --> Show Types ICON is not selected/depressed
	//
	private Boolean getShowTypeNamesState(IPresentationContext context) {
		Boolean attribute = (Boolean) context.getProperty(IDebugModelPresentation.DISPLAY_VARIABLE_TYPE_NAMES);

		if (attribute != null) {
			return attribute;
		}

		return Boolean.FALSE;
	}

	/**
	 * @since 2.0
	 */
	@ConfinedToDsfExecutor("getSession().getExecutor()")
	protected void updatePropertiesInSessionThread(final IPropertiesUpdate[] updates) {
		IExpressions service = getServicesTracker().getService(IExpressions.class, null);

		final CountingRequestMonitor countingRm = new CountingRequestMonitor(ImmediateExecutor.getInstance(), null) {
			@Override
			protected void handleCompleted() {
				for (final IPropertiesUpdate update : updates) {
					update.done();
				}
			}
		};
		int count = 0;

		for (final IPropertiesUpdate update : updates) {
			final IExpression expression = (IExpression) DebugPlugin.getAdapter(update.getElement(), IExpression.class);
			if (expression != null) {
				update.setProperty(AbstractExpressionVMNode.PROP_ELEMENT_EXPRESSION, expression.getExpressionText());
			}

			// Capture the current "Show Type Names" ICON state in case there are no columns.
			if (update.getProperties().contains(PROP_VARIABLE_SHOW_TYPE_NAMES)) {
				update.setProperty(PROP_VARIABLE_SHOW_TYPE_NAMES,
						getShowTypeNamesState(update.getPresentationContext()));
			}

			IExpressionDMContext dmc = findDmcInPath(update.getViewerInput(), update.getElementPath(),
					IExpressions.IExpressionDMContext.class);
			if (dmc == null || service == null) {
				update.setStatus(DsfUIPlugin.newErrorStatus(IDsfStatusConstants.INVALID_STATE,
						"Invalid context or service not available.", null)); //$NON-NLS-1$
				continue;
			}

			if (update.getProperties().contains(PROP_NAME) || update.getProperties().contains(PROP_VARIABLE_TYPE_NAME)
					|| update.getProperties().contains(PROP_VARIABLE_BASIC_TYPE)) {
				service.getExpressionData(dmc,
						// Use the ViewerDataRequestMonitor in order to propagate the update's cancel request. Use an immediate
						// executor to avoid the possibility of a rejected execution exception.
						new ViewerDataRequestMonitor<IExpressionDMData>(ImmediateExecutor.getInstance(), update) {
							@Override
							protected void handleCompleted() {
								if (isSuccess()) {
									fillExpressionDataProperties(update, getData());
								} else {
									// In case of an error fill in the expression text in the name column and expressions columns.
									IExpressionDMContext dmc = findDmcInPath(update.getViewerInput(),
											update.getElementPath(), IExpressions.IExpressionDMContext.class);
									if (dmc != null && dmc.getExpression() != null) {
										String displayName = getExpressionDisplayName(dmc, dmc.getExpression());
										update.setProperty(PROP_NAME, displayName);
										if (expression == null) {
											update.setProperty(PROP_ELEMENT_EXPRESSION, displayName);
										}
										if (dmc instanceof IIndexedPartitionDMContext)
											update.setProperty(PROP_VARIABLE_BASIC_TYPE, INDEXED_PARTITION_TYPE);
									}
									update.setStatus(getStatus());
								}
								countingRm.done();
							}
						});

				count++;
			}

			if (update.getProperties().contains(PROP_VARIABLE_ADDRESS)) {
				service.getExpressionAddressData(dmc,
						// Use the ViewerDataRequestMonitor in order to propagate the update's cancel request. Use an immediate
						// executor to avoid the possibility of a rejected execution exception.
						new ViewerDataRequestMonitor<IExpressionDMAddress>(ImmediateExecutor.getInstance(), update) {
							@Override
							protected void handleCompleted() {
								if (isSuccess()) {
									fillAddressDataProperties(update, getData());
								} else if (getStatus().getCode() != IDsfStatusConstants.NOT_SUPPORTED
										&& getStatus().getCode() != IDsfStatusConstants.INVALID_STATE) {
									update.setStatus(getStatus());
								}
								countingRm.done();
							}
						});
				count++;
			}
		}
		countingRm.setDoneCount(count);
	}

	/**
	 * @since 2.0
	 */
	@ConfinedToDsfExecutor("getSession().getExecutor()")
	protected void fillExpressionDataProperties(IPropertiesUpdate update, IExpressionDMData data) {
		IExpressionDMContext dmc = findDmcInPath(update.getViewerInput(), update.getElementPath(),
				IExpressions.IExpressionDMContext.class);
		String displayName = data.getName();
		if (dmc != null) {
			displayName = getExpressionDisplayName(dmc, displayName);
		}
		update.setProperty(PROP_NAME, displayName);
		update.setProperty(PROP_VARIABLE_TYPE_NAME, data.getTypeName());
		String typeValue = null;
		if (dmc instanceof IIndexedPartitionDMContext)
			typeValue = INDEXED_PARTITION_TYPE;
		else {
			IExpressionDMData.BasicType type = data.getBasicType();
			if (type != null)
				typeValue = type.name();
		}
		if (typeValue != null) {
			update.setProperty(PROP_VARIABLE_BASIC_TYPE, typeValue);
		}

		//
		// If this node has an expression then it has already been filled in by the higher
		// level logic. If not then we need to supply something.  In the  previous version
		// ( pre-property based ) we supplied the name. So we will do that here also.
		//
		IExpression expression = (IExpression) DebugPlugin.getAdapter(update.getElement(), IExpression.class);
		if (expression == null) {
			update.setProperty(AbstractExpressionVMNode.PROP_ELEMENT_EXPRESSION, displayName);
		}
	}

	/**
	 *  Private data access routine which performs the extra level of data access needed to
	 *  get the formatted data value for a specific register.
	 */
	@ConfinedToDsfExecutor("getSession().getExecutor()")
	protected void fillAddressDataProperties(IPropertiesUpdate update, IExpressionDMAddress address) {
		if (address instanceof IExpressionDMLocation)
			update.setProperty(PROP_VARIABLE_ADDRESS, ((IExpressionDMLocation) address).getLocation());
		else
			update.setProperty(PROP_VARIABLE_ADDRESS, "0x" + address.getAddress().toString(16)); //$NON-NLS-1$
	}

	@Override
	public CellEditor getCellEditor(IPresentationContext context, String columnId, Object element, Composite parent) {
		if (IDebugVMConstants.COLUMN_ID__VALUE.equals(columnId)) {
			return new TextCellEditor(parent);
		} else if (IDebugVMConstants.COLUMN_ID__EXPRESSION.equals(columnId)) {
			return new TextCellEditor(parent);
		}

		return null;
	}

	@Override
	public ICellModifier getCellModifier(IPresentationContext context, Object element) {
		return new VariableCellModifier(getDMVMProvider(), fSyncVariableDataAccess);
	}

	@Override
	public boolean canParseExpression(IExpression expression) {
		// At this point we are going to say we will allow anything as an expression.
		// Since the evaluation  of VM Node implementations searches  in the order of
		// registration  and we always make sure we register the VariableVMNode last,
		// we know that the other possible handlers have passed the expression by. So
		// we are going to say OK and let the expression evaluation of whatever debug
		// backend is connected to decide. This does not allow us to put up any  good
		// diagnostic error message ( instead the error will come from the backend ).
		// But it does allow for the most flexibility

		return true;
	}

	@Override
	public void update(final IExpressionUpdate update) {
		try {
			getSession().getExecutor().execute(() -> {
				final IExpressions expressionService = getServicesTracker().getService(IExpressions.class);
				if (expressionService != null) {
					IExpressionDMContext expressionDMC = createExpression(expressionService,
							createCompositeDMVMContext(update), update.getExpression().getExpressionText());

					VariableExpressionVMC variableVmc = (VariableExpressionVMC) createVMContext(expressionDMC);
					variableVmc.setExpression(update.getExpression());

					update.setExpressionElement(variableVmc);
					update.done();
				} else {
					handleFailedUpdate(update);
				}
			});
		} catch (RejectedExecutionException e) {
			handleFailedUpdate(update);
		}
	}

	@Override
	protected void handleFailedUpdate(IViewerUpdate update) {
		if (update instanceof IExpressionUpdate) {
			update.setStatus(new Status(IStatus.ERROR, DsfUIPlugin.PLUGIN_ID, IDsfStatusConstants.INVALID_STATE,
					"Update failed", null)); //$NON-NLS-1$
			update.done();
		} else {
			super.handleFailedUpdate(update);
		}
	}

	@Override
	protected void associateExpression(Object element, IExpression expression) {
		if (element instanceof VariableExpressionVMC) {
			((VariableExpressionVMC) element).setExpression(expression);
		}
	}

	@Override
	protected void updateHasElementsInSessionThread(final IHasChildrenUpdate update) {
		// Get the data model context object for the current node in the hierarchy.

		final IExpressionDMContext expressionDMC = findDmcInPath(update.getViewerInput(), update.getElementPath(),
				IExpressionDMContext.class);

		if (expressionDMC != null) {
			final IExpressions expressionService = getServicesTracker().getService(IExpressions.class);

			if (expressionService == null) {
				handleFailedUpdate(update);
				return;
			}

			if (expressionService instanceof IExpressions3) {
				((IExpressions3) expressionService).getExpressionDataExtension(expressionDMC,
						new ViewerDataRequestMonitor<IExpressionDMDataExtension>(getExecutor(), update) {
							@Override
							protected void handleCompleted() {
								if (!isSuccess()) {
									handleFailedUpdate(update);
									return;
								}
								IExpressionDMDataExtension data = getData();
								update.setHasChilren(data.hasChildren());
								update.done();
							}
						});
			} else {
				expressionService.getSubExpressionCount(expressionDMC,
						new ViewerDataRequestMonitor<Integer>(getExecutor(), update) {
							@Override
							public void handleCompleted() {
								if (!isSuccess()) {
									handleFailedUpdate(update);
									return;
								}
								update.setHasChilren(getData() > 0);
								update.done();
							}
						});
			}
		} else {
			super.updateHasElementsInSessionThread(update);
		}
	}

	@Override
	@ConfinedToDsfExecutor("getSession().getExecutor()")
	protected void updateElementCountInSessionThread(final IChildrenCountUpdate update) {
		// Get the data model context object for the current node in the hierarchy.

		final IExpressionDMContext expressionDMC = findDmcInPath(update.getViewerInput(), update.getElementPath(),
				IExpressionDMContext.class);

		if (expressionDMC != null) {
			final IExpressions expressionService = getServicesTracker().getService(IExpressions.class);

			if (expressionService == null) {
				handleFailedUpdate(update);
				return;
			}

			expressionService.getSubExpressionCount(expressionDMC,
					new ViewerDataRequestMonitor<Integer>(getExecutor(), update) {
						@Override
						public void handleCompleted() {
							if (!isSuccess()) {
								handleFailedUpdate(update);
								return;
							}
							update.setChildCount(getData());
							update.done();
						}
					});
		} else {
			super.updateElementCountInSessionThread(update);
		}
	}

	@Override
	protected void updateElementsInSessionThread(final IChildrenUpdate update) {
		// Get the data model context object for the current node in the hierarchy.

		final IExpressionDMContext expressionDMC = findDmcInPath(update.getViewerInput(), update.getElementPath(),
				IExpressionDMContext.class);

		if (expressionDMC != null) {
			getSubexpressionsUpdateElementsInSessionThread(update);
		} else {
			getLocalsUpdateElementsInSessionThread(update);
		}
	}

	private void getSubexpressionsUpdateElementsInSessionThread(final IChildrenUpdate update) {

		final IExpressionDMContext expressionDMC = findDmcInPath(update.getViewerInput(), update.getElementPath(),
				IExpressionDMContext.class);

		if (expressionDMC != null) {

			// Get the services we need to use.

			final IExpressions expressionService = getServicesTracker().getService(IExpressions.class);

			if (expressionService == null) {
				handleFailedUpdate(update);
				return;
			}

			final DsfExecutor dsfExecutor = getSession().getExecutor();

			// Call IExpressions.getSubExpressions() to get an Iterable of IExpressionDMContext objects representing
			// the sub-expressions of the expression represented by the current expression node.

			final DataRequestMonitor<IExpressionDMContext[]> rm = new ViewerDataRequestMonitor<IExpressionDMContext[]>(
					dsfExecutor, update) {
				@Override
				public void handleCompleted() {
					if (!isSuccess()) {
						handleFailedUpdate(update);
						return;
					}

					IExpressionDMContext[] data = getData();

					// If any of these expressions use casts, replace them.
					if (fCastToTypeSupport != null) {
						for (int i = 0; i < data.length; i++) {
							data[i] = fCastToTypeSupport.replaceWithCastedExpression(data[i]);
						}
					}

					if (update.getOffset() < 0) {
						fillUpdateWithVMCs(update, data);
					} else {
						fillUpdateWithVMCs(update, data, update.getOffset());
					}
					update.done();
				}
			};

			// Make the asynchronous call to IExpressions.getSubExpressions().  The results are processed in the
			// DataRequestMonitor.handleCompleted() above.

			if (update.getOffset() < 0 || update.getLength() < 0) {
				// If the range is not specified, get all expressions.
				expressionService.getSubExpressions(expressionDMC, rm);
			} else {
				expressionService.getSubExpressions(expressionDMC, update.getOffset(), update.getLength(), rm);
			}
		} else {
			handleFailedUpdate(update);
		}
	}

	private void getLocalsUpdateElementsInSessionThread(final IChildrenUpdate update) {

		final IFrameDMContext frameDmc = findDmcInPath(update.getViewerInput(), update.getElementPath(),
				IFrameDMContext.class);

		// Get the services we need to use.

		final IExpressions expressionService = getServicesTracker().getService(IExpressions.class);
		final IStack stackFrameService = getServicesTracker().getService(IStack.class);

		if (frameDmc == null || expressionService == null || stackFrameService == null) {
			handleFailedUpdate(update);
			return;
		}

		final DsfExecutor dsfExecutor = getSession().getExecutor();

		// Call IStack.getLocals() to get an array of IVariableDMContext objects representing the local
		// variables in the stack frame represented by frameDmc.

		final DataRequestMonitor<IVariableDMContext[]> rm = new ViewerDataRequestMonitor<IVariableDMContext[]>(
				dsfExecutor, update) {
			@Override
			public void handleCompleted() {
				if (!isSuccess()) {
					handleFailedUpdate(update);
					return;
				}

				// For each IVariableDMContext object returned by IStack.getLocals(), call
				// MIStackFrameService.getModelData() to get the IVariableDMData object.  This requires
				// a MultiRequestMonitor object.

				// First, get the data model context objects for the local variables.

				IVariableDMContext[] localsDMCs = getData();

				if (localsDMCs == null) {
					handleFailedUpdate(update);
					return;
				}

				if (localsDMCs.length == 0) {
					// There are no locals so just complete the request
					update.done();
					return;
				}

				// Create a List in which we store the DM data objects for the local variables.  This is
				// necessary because there is no MultiDataRequestMonitor. :)

				final List<IVariableDMData> localsDMData = new ArrayList<>();

				// Create the MultiRequestMonitor to handle completion of the set of getModelData() calls.

				final CountingRequestMonitor crm = new ViewerCountingRequestMonitor(dsfExecutor, update) {
					@Override
					public void handleCompleted() {
						// Now that all the calls to getModelData() are complete, we create an
						// IExpressionDMContext object for each local variable name, saving them all
						// in an array.

						if (!isSuccess()) {
							handleFailedUpdate(update);
							return;
						}

						IExpressionDMContext[] expressionDMCs = new IExpressionDMContext[localsDMData.size()];

						int i = 0;
						for (IVariableDMData localDMData : localsDMData) {
							expressionDMCs[i++] = createExpression(expressionService, frameDmc, localDMData.getName());
						}

						// Lastly, we fill the update from the array of view model context objects
						// that reference the ExpressionDMC objects for the local variables.  This is
						// the last code to run for a given call to updateElementsInSessionThread().
						// We can now leave anonymous-inner-class hell.

						fillUpdateWithVMCs(update, expressionDMCs);
						update.done();
					}
				};
				int countRM = 0;

				// Perform a set of getModelData() calls, one for each local variable's data model
				// context object.  In the handleCompleted() method of the DataRequestMonitor, add the
				// IVariableDMData object to the localsDMData List for later processing (see above).

				for (IVariableDMContext localDMC : localsDMCs) {
					DataRequestMonitor<IVariableDMData> rm = new DataRequestMonitor<IVariableDMData>(dsfExecutor, crm) {
						@Override
						public void handleSuccess() {
							localsDMData.add(getData());
							crm.done();
						}
					};

					stackFrameService.getVariableData(localDMC, rm);
					countRM++;
				}
				crm.setDoneCount(countRM);
			}
		};

		// Make the asynchronous call to IStack.getLocals().  The results are processed in the
		// DataRequestMonitor.handleCompleted() above.

		stackFrameService.getLocals(frameDmc, rm);
	}

	private IExpressionDMContext createExpression(IExpressions expressionService, final IDMContext dmc,
			final String expression) {
		IExpressionDMContext exprDMC = expressionService.createExpression(dmc, expression);

		if (fCastToTypeSupport != null) {
			exprDMC = fCastToTypeSupport.replaceWithCastedExpression(exprDMC);
		}
		return exprDMC;
	}

	@Override
	public int getDeltaFlags(Object e) {
		if (e instanceof ISuspendedDMEvent || e instanceof IMemoryChangedEvent || e instanceof IExpressionChangedDMEvent
				|| (e instanceof PropertyChangeEvent && (((PropertyChangeEvent) e)
						.getProperty() == IDebugVMConstants.PROP_FORMATTED_VALUE_FORMAT_PREFERENCE
						|| ((PropertyChangeEvent) e)
								.getProperty() == IDebugModelPresentation.DISPLAY_VARIABLE_TYPE_NAMES))) {
			return IModelDelta.CONTENT;
		}

		if (e instanceof ElementFormatEvent) {
			int depth = ((ElementFormatEvent) e).getApplyDepth();
			if (depth == 0)
				return IModelDelta.NO_CHANGE;
			if (depth == 1)
				return IModelDelta.STATE;
			return IModelDelta.CONTENT;
		}

		return IModelDelta.NO_CHANGE;
	}

	@Override
	public void buildDelta(final Object e, final VMDelta parentDelta, final int nodeOffset,
			final RequestMonitor requestMonitor) {

		// The following events can affect any expression's values,
		// refresh the contents of the parent element (i.e. all the expressions).
		if (e instanceof ISuspendedDMEvent || e instanceof IMemoryChangedEvent || e instanceof IExpressionChangedDMEvent
				|| (e instanceof PropertyChangeEvent && (((PropertyChangeEvent) e)
						.getProperty() == IDebugVMConstants.PROP_FORMATTED_VALUE_FORMAT_PREFERENCE
						|| ((PropertyChangeEvent) e)
								.getProperty() == IDebugModelPresentation.DISPLAY_VARIABLE_TYPE_NAMES))) {
			parentDelta.setFlags(parentDelta.getFlags() | IModelDelta.CONTENT);
		} else if (e instanceof ElementFormatEvent) {
			int depth = ((ElementFormatEvent) e).getApplyDepth();
			if (depth != 0) {
				int deltaType = IModelDelta.CONTENT;
				if (depth == 1)
					deltaType = IModelDelta.STATE;

				Set<Object> elements = ((ElementFormatEvent) e).getElements();
				for (Object elem : elements) {
					parentDelta.addNode(elem, deltaType);
				}
			}
		}

		requestMonitor.done();
	}

	@Override
	public int getDeltaFlagsForExpression(IExpression expression, Object event) {
		if (event instanceof IExpressionChangedDMEvent || event instanceof IMemoryChangedEvent
				|| (event instanceof PropertyChangeEvent && (((PropertyChangeEvent) event)
						.getProperty() == IDebugVMConstants.PROP_FORMATTED_VALUE_FORMAT_PREFERENCE
						|| ((PropertyChangeEvent) event)
								.getProperty() == IDebugModelPresentation.DISPLAY_VARIABLE_TYPE_NAMES))) {
			return IModelDelta.CONTENT;
		}

		if (event instanceof ISuspendedDMEvent) {
			return IModelDelta.CONTENT;
		}

		if (event instanceof ElementFormatEvent) {
			int depth = ((ElementFormatEvent) event).getApplyDepth();
			if (depth == 0)
				return IModelDelta.NO_CHANGE;
			if (depth == 1)
				return IModelDelta.STATE;
			return IModelDelta.CONTENT;
		}

		return IModelDelta.NO_CHANGE;
	}

	@Override
	public void buildDeltaForExpression(IExpression expression, int elementIdx, Object event, VMDelta parentDelta,
			TreePath path, RequestMonitor rm) {
		// The following events can affect any expression's values,
		// refresh the contents of the parent element (i.e. all the expressions).
		if (event instanceof ISuspendedDMEvent || event instanceof IMemoryChangedEvent
				|| event instanceof IExpressionChangedDMEvent
				|| (event instanceof PropertyChangeEvent && ((PropertyChangeEvent) event)
						.getProperty() == IDebugVMConstants.PROP_FORMATTED_VALUE_FORMAT_PREFERENCE)) {
			parentDelta.setFlags(parentDelta.getFlags() | IModelDelta.CONTENT);
		} else if (event instanceof ElementFormatEvent) {
			int depth = ((ElementFormatEvent) event).getApplyDepth();
			if (depth != 0) {
				int deltaType = IModelDelta.CONTENT;
				if (depth == 1)
					deltaType = IModelDelta.STATE;

				Set<Object> elements = ((ElementFormatEvent) event).getElements();
				for (Object elem : elements) {
					parentDelta.addNode(elem, deltaType);
				}
			}
		}

		rm.done();
	}

	@Override
	public void buildDeltaForExpressionElement(Object element, int elementIdx, Object event, VMDelta parentDelta,
			RequestMonitor rm) {
		// The following events can affect expression values, refresh the state
		// of the expression.
		if (event instanceof IExpressionChangedDMEvent || event instanceof IMemoryChangedEvent
				|| (event instanceof PropertyChangeEvent && ((PropertyChangeEvent) event)
						.getProperty() == IDebugVMConstants.PROP_FORMATTED_VALUE_FORMAT_PREFERENCE)) {
			parentDelta.addNode(element, IModelDelta.CONTENT);
		}

		rm.done();
	}

	private String produceExpressionElementName(String viewName, IExpressionDMContext expression) {

		return "Variable." + expression.getExpression(); //$NON-NLS-1$
	}

	private final String MEMENTO_NAME = "VARIABLE_MEMENTO_NAME"; //$NON-NLS-1$

	@Override
	public void compareElements(IElementCompareRequest[] requests) {

		for (IElementCompareRequest request : requests) {

			Object element = request.getElement();
			IMemento memento = request.getMemento();
			String mementoName = memento.getString(MEMENTO_NAME);

			if (mementoName != null) {
				if (element instanceof IDMVMContext) {

					IDMContext dmc = ((IDMVMContext) element).getDMContext();

					if (dmc instanceof IExpressionDMContext) {

						String elementName = produceExpressionElementName(request.getPresentationContext().getId(),
								(IExpressionDMContext) dmc);
						request.setEqual(elementName.equals(mementoName));
					}
				}
			}
			request.done();
		}
	}

	@Override
	public void encodeElements(IElementMementoRequest[] requests) {

		for (IElementMementoRequest request : requests) {

			Object element = request.getElement();
			IMemento memento = request.getMemento();

			if (element instanceof IDMVMContext) {

				IDMContext dmc = ((IDMVMContext) element).getDMContext();

				if (dmc instanceof IExpressionDMContext) {

					String elementName = produceExpressionElementName(request.getPresentationContext().getId(),
							(IExpressionDMContext) dmc);
					memento.putString(MEMENTO_NAME, elementName);
				}
			}
			request.done();
		}
	}

	/**
	 * Returns the label for the element with the given context.
	 */
	protected String getExpressionDisplayName(IExpressionDMContext dmc, String name) {
		if (dmc instanceof IIndexedPartitionDMContext) {
			IIndexedPartitionDMContext ipDmc = (IIndexedPartitionDMContext) dmc;
			name = String.format("[%d...%d]", //$NON-NLS-1$
					ipDmc.getIndex(), ipDmc.getIndex() + ipDmc.getLength() - 1);
		}
		return name;
	}
}

Back to the top