Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 9d549066e8c5b73aeb1bbfd30abf741183784589 (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
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
/*******************************************************************************
 * Copyright (c) 2004, 2014 QNX Software Systems 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:
 * QNX Software Systems - Initial API and implementation
 * Freescale Semiconductor - Address watchpoints, https://bugs.eclipse.org/bugs/show_bug.cgi?id=118299
 * QNX Software Systems - catchpoints - bug 226689
 * Ericsson             - tracepoints - bug 284286
 * Marc Khouzam (Ericsson) - Support for dynamic printf (400628)
 *******************************************************************************/
package org.eclipse.cdt.debug.core;

import java.io.IOException;
import java.math.BigInteger;
import java.util.HashMap;
import java.util.Map;

import org.eclipse.cdt.core.CCorePlugin;
import org.eclipse.cdt.core.IAddress;
import org.eclipse.cdt.core.IBinaryParser;
import org.eclipse.cdt.core.IBinaryParser.IBinaryExecutable;
import org.eclipse.cdt.core.IBinaryParser.IBinaryFile;
import org.eclipse.cdt.core.IBinaryParser.IBinaryObject;
import org.eclipse.cdt.core.model.CoreModelUtil;
import org.eclipse.cdt.core.settings.model.ICConfigExtensionReference;
import org.eclipse.cdt.debug.core.cdi.model.ICDITarget;
import org.eclipse.cdt.debug.core.model.ICAddressBreakpoint;
import org.eclipse.cdt.debug.core.model.ICBreakpoint;
import org.eclipse.cdt.debug.core.model.ICBreakpoint2;
import org.eclipse.cdt.debug.core.model.ICBreakpointType;
import org.eclipse.cdt.debug.core.model.ICDynamicPrintf;
import org.eclipse.cdt.debug.core.model.ICEventBreakpoint;
import org.eclipse.cdt.debug.core.model.ICFunctionBreakpoint;
import org.eclipse.cdt.debug.core.model.ICLineBreakpoint;
import org.eclipse.cdt.debug.core.model.ICLineBreakpoint2;
import org.eclipse.cdt.debug.core.model.ICTracepoint;
import org.eclipse.cdt.debug.core.model.ICWatchpoint;
import org.eclipse.cdt.debug.core.model.ICWatchpoint2;
import org.eclipse.cdt.debug.internal.core.breakpoints.CAddressBreakpoint;
import org.eclipse.cdt.debug.internal.core.breakpoints.CAddressDynamicPrintf;
import org.eclipse.cdt.debug.internal.core.breakpoints.CAddressTracepoint;
import org.eclipse.cdt.debug.internal.core.breakpoints.CEventBreakpoint;
import org.eclipse.cdt.debug.internal.core.breakpoints.CFunctionBreakpoint;
import org.eclipse.cdt.debug.internal.core.breakpoints.CFunctionDynamicPrintf;
import org.eclipse.cdt.debug.internal.core.breakpoints.CFunctionTracepoint;
import org.eclipse.cdt.debug.internal.core.breakpoints.CLineBreakpoint;
import org.eclipse.cdt.debug.internal.core.breakpoints.CLineDynamicPrintf;
import org.eclipse.cdt.debug.internal.core.breakpoints.CLineTracepoint;
import org.eclipse.cdt.debug.internal.core.breakpoints.CWatchpoint;
import org.eclipse.cdt.debug.internal.core.model.CDebugTarget;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IWorkspaceRunnable;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Status;
import org.eclipse.debug.core.DebugException;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.debug.core.IBreakpointManager;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.model.IBreakpoint;
import org.eclipse.debug.core.model.IDebugTarget;
import org.eclipse.debug.core.model.ILineBreakpoint;
import org.eclipse.debug.core.model.IProcess;

/**
 * Provides utility methods for creating debug sessions, targets and breakpoints
 * specific to the CDI debug model.
 */
public class CDIDebugModel {

    /**
     * Returns the identifier for the CDI debug model plug-in
     * 
     * @return plugin identifier
     */
    public static String getPluginIdentifier() {
        return CDebugCorePlugin.getUniqueIdentifier();
    }

    /**
     * Creates and returns a debug target for the given CDI target, with the
     * specified name, and associates it with the given process for console I/O.
     * The debug target is added to the given launch.
     * 
     * @param launch
     *            the launch the new debug target will be contained in
     * @param project
     *            the project to use to persist breakpoints.
     * @param cdiTarget
     *            the CDI target to create a debug target for
     * @param name
     *            the name to associate with this target, which will be returned
     *            from <code>IDebugTarget.getName</code>.
     * @param debuggeeProcess
     *            the process to associate with the debug target, which will be
     *            returned from <code>IDebugTarget.getProcess</code>
     * @param file
     *            the executable to debug.
     * @param allowTerminate
     *            allow terminate().
     * @param allowDisconnect
     *            allow disconnect().
     * @param stopSymbol
     *            place temporary breakpoint at <code>stopSymbol</code>, ignore
     *            if <code>null</code> or empty.
     * @param resumeTarget
     *            resume target.
     * @return a debug target
     * @throws DebugException
     * @since 3.1
     */
    public static IDebugTarget newDebugTarget(final ILaunch launch, final IProject project, final ICDITarget cdiTarget,
        final String name, final IProcess debuggeeProcess, final IBinaryObject file, final boolean allowTerminate,
        final boolean allowDisconnect, final String stopSymbol, final boolean resumeTarget) throws DebugException {
        final IDebugTarget[] target = new IDebugTarget[1];
        IWorkspaceRunnable r = new IWorkspaceRunnable() {

            @Override
            public void run(IProgressMonitor m) throws CoreException {
                target[0] = new CDebugTarget(launch, project, cdiTarget, name, debuggeeProcess, file, allowTerminate,
                    allowDisconnect);
                ((CDebugTarget) target[0]).start(stopSymbol, resumeTarget);
            }
        };
        try {
            ResourcesPlugin.getWorkspace().run(r, null);
        } catch (CoreException e) {
            CDebugCorePlugin.log(e);
            throw new DebugException(e.getStatus());
        }
        return target[0];
    }

    /**
     * Creates and returns a debug target for the given CDI target, with the
     * specified name, and associates it with the given process for console I/O.
     * The debug target is added to the given launch.
     * 
     * @param launch
     *            the launch the new debug target will be contained in
     * @param project
     *            the project to use to persist breakpoints.
     * @param cdiTarget
     *            the CDI target to create a debug target for
     * @param name
     *            the name to associate with this target, which will be returned
     *            from <code>IDebugTarget.getName</code>.
     * @param debuggeeProcess
     *            the process to associate with the debug target, which will be
     *            returned from <code>IDebugTarget.getProcess</code>
     * @param file
     *            the executable to debug.
     * @param allowTerminate
     *            allow terminate().
     * @param allowDisconnect
     *            allow disconnect().
     * @param stopInMain
     *            place temporary breakpoint at main()
     * @param resumeTarget
     *            resume target.
     * @return a debug target
     * @throws DebugException
     * @deprecated
     */
    @Deprecated
    public static IDebugTarget newDebugTarget(final ILaunch launch, final IProject project, final ICDITarget cdiTarget,
        final String name, final IProcess debuggeeProcess, final IBinaryObject file, final boolean allowTerminate,
        final boolean allowDisconnect, final boolean stopInMain, final boolean resumeTarget) throws DebugException {
        final IDebugTarget[] target = new IDebugTarget[1];
        IWorkspaceRunnable r = new IWorkspaceRunnable() {

            @Override
            public void run(IProgressMonitor m) throws CoreException {
                String stopSymbol = null;
                if (stopInMain)
                    stopSymbol = launch.getLaunchConfiguration().getAttribute(
                        ICDTLaunchConfigurationConstants.ATTR_DEBUGGER_STOP_AT_MAIN_SYMBOL,
                        ICDTLaunchConfigurationConstants.DEBUGGER_STOP_AT_MAIN_SYMBOL_DEFAULT);
                target[0] = new CDebugTarget(launch, project, cdiTarget, name, debuggeeProcess, file, allowTerminate,
                    allowDisconnect);
                ((CDebugTarget) target[0]).start(stopSymbol, resumeTarget);
            }
        };
        try {
            ResourcesPlugin.getWorkspace().run(r, null);
        } catch (CoreException e) {
            CDebugCorePlugin.log(e);
            throw new DebugException(e.getStatus());
        }
        return target[0];
    }

    /**
     * Creates and returns a debug target for the given CDI target, with the
     * specified name, and associates it with the given process for console I/O.
     * The debug target is added to the given launch.
     * 
     * @param launch
     *            the launch the new debug target will be contained in
     * @param project
     *            the project to use to persist breakpoints.
     * @param cdiTarget
     *            the CDI target to create a debug target for
     * @param name
     *            the name to associate with this target, which will be returned
     *            from <code>IDebugTarget.getName</code>.
     * @param debuggeeProcess
     *            the process to associate with the debug target, which will be
     *            returned from <code>IDebugTarget.getProcess</code>
     * @param file
     *            the executable to debug.
     * @param allowTerminate
     *            allow terminate().
     * @param allowDisconnect
     *            allow disconnect().
     * @param resumeTarget
     *            resume target.
     * @return a debug target
     * @throws DebugException
     */
    public static IDebugTarget newDebugTarget(ILaunch launch, IProject project, ICDITarget cdiTarget,
        final String name, IProcess debuggeeProcess, IBinaryObject file, boolean allowTerminate,
        boolean allowDisconnect, boolean resumeTarget) throws DebugException {
        return newDebugTarget(launch, project, cdiTarget, name, debuggeeProcess, file, allowTerminate, allowDisconnect,
            null, resumeTarget);
    }

    /**
     * Calculates breakpoint marker ID based on the breakpoint object type.
     * 
     * @since 7.2
     */
    public static String calculateMarkerType(IBreakpoint bp) {
        if (bp instanceof ICBreakpoint2) {
            return ((ICBreakpoint2) bp).getMarkerType();
        }
        if (bp instanceof ICDynamicPrintf) {
            if (bp instanceof ICFunctionBreakpoint) {
                return ICDynamicPrintf.C_FUNCTION_DYNAMICPRINTF_MARKER;
            } else if (bp instanceof ICAddressBreakpoint) {
                return ICDynamicPrintf.C_ADDRESS_DYNAMICPRINTF_MARKER;
            } else if (bp instanceof ICLineBreakpoint) {
                return ICDynamicPrintf.C_LINE_DYNAMICPRINTF_MARKER;
            } else {
                return ICDynamicPrintf.C_DYNAMICPRINTF_MARKER;
            }
        } else if (bp instanceof ICTracepoint) {
            if (bp instanceof ICFunctionBreakpoint) {
                return ICTracepoint.C_FUNCTION_TRACEPOINT_MARKER;
            } else if (bp instanceof ICAddressBreakpoint) {
                return ICTracepoint.C_ADDRESS_TRACEPOINT_MARKER;
            } else if (bp instanceof ICLineBreakpoint) {
                return ICTracepoint.C_LINE_TRACEPOINT_MARKER;
            } else {
                return ICTracepoint.C_TRACEPOINT_MARKER;
            }
        } else if (bp instanceof ICFunctionBreakpoint) {
            return ICFunctionBreakpoint.C_FUNCTION_BREAKPOINT_MARKER;
        } else if (bp instanceof ICAddressBreakpoint) {
            return ICAddressBreakpoint.C_ADDRESS_BREAKPOINT_MARKER;
        } else if (bp instanceof ICLineBreakpoint) {
            return ICLineBreakpoint.C_LINE_BREAKPOINT_MARKER;
        } else if (bp instanceof ICEventBreakpoint) {
            return ICEventBreakpoint.C_EVENT_BREAKPOINT_MARKER;
        } else if (bp instanceof ICBreakpoint) {
            return ICBreakpoint.C_BREAKPOINT_MARKER;
        } else if (bp instanceof ILineBreakpoint) {
            return IBreakpoint.LINE_BREAKPOINT_MARKER;
        }
        return IBreakpoint.BREAKPOINT_MARKER;
    }

    /**
     * Creates and returns a line breakpoint for the source defined by the given
     * source handle, at the given line number. The marker associated with the
     * breakpoint will be created on the specified resource.
     * 
     * @param sourceHandle
     *            the handle to the breakpoint source
     * @param resource
     *            the resource on which to create the associated breakpoint
     *            marker
     * @param lineNumber
     *            the line number on which the breakpoint is set - line numbers
     *            are 1 based, associated with the source file in which the
     *            breakpoint is set
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * @return a line breakpoint
     * @throws CoreException
     *             if this method fails. Reasons include:
     *             <ul>
     *             <li>Failure creating underlying marker. The exception's
     *             status contains the underlying exception responsible for the
     *             failure.</li>
     *             </ul>
     * @deprecated as of CDT 5.0 use
     *             {@link #createLineBreakpoint(String, IResource, int, int, boolean, int, String, boolean)}
     */
    @Deprecated
    public static ICLineBreakpoint createLineBreakpoint(String sourceHandle, IResource resource, int lineNumber,
        boolean enabled, int ignoreCount, String condition, boolean register) throws CoreException {
        return createLineBreakpoint(sourceHandle, resource, ICBreakpointType.REGULAR, lineNumber, enabled, ignoreCount,
            condition, register);
    }

    /**
     * Creates and returns a line breakpoint for the source defined by the given
     * source handle, at the given line number. The marker associated with the
     * breakpoint will be created on the specified resource.
     * 
     * @param sourceHandle
     *            the handle to the breakpoint source
     * @param resource
     *            the resource on which to create the associated breakpoint
     *            marker
     * @param type
     *            a type constant from ICBreakpointType
     * @param lineNumber
     *            the line number on which the breakpoint is set - line numbers
     *            are 1 based, associated with the source file in which the
     *            breakpoint is set
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * @return a line breakpoint
     * @throws CoreException
     *             if this method fails. Reasons include:
     *             <ul>
     *             <li>Failure creating underlying marker. The exception's
     *             status contains the underlying exception responsible for the
     *             failure.</li>
     *             </ul>
     */
    public static ICLineBreakpoint createLineBreakpoint(String sourceHandle, IResource resource, int type,
        int lineNumber, boolean enabled, int ignoreCount, String condition, boolean register) throws CoreException {
        HashMap<String, Object> attributes = new HashMap<String, Object>(10);
        setLineBreakpointAttributes(attributes, sourceHandle, type, lineNumber, enabled, ignoreCount, condition);
        return new CLineBreakpoint(resource, attributes, register);
    }

    /**
     * Creates a line breakpoint without associated marker.
     * <p>
     * Note: Before a breakpoint created using this method can be used, the
     * client must first create a marker and register the breakpoint. The former
     * is accomplished using {@link IBreakpoint#setMarker(IMarker)}, the latter
     * using {@link IBreakpointManager#addBreakpoint(IBreakpoint)}.
     * 
     * @since 7.2
     */
    public static ICLineBreakpoint createBlankLineBreakpoint() {
        return new CLineBreakpoint();
    }

    /**
     * @since 7.0
     */
    public static ICLineBreakpoint createLineTracepoint(String sourceHandle, IResource resource, int type,
        int lineNumber, boolean enabled, int ignoreCount, String condition, boolean register) throws CoreException {
        HashMap<String, Object> attributes = new HashMap<String, Object>(10);
        setLineBreakpointAttributes(attributes, sourceHandle, type, lineNumber, enabled, ignoreCount, condition);
        return new CLineTracepoint(resource, attributes, register);
    }

    /**
     * Creates a line tracepoint without associated marker.
     * <p>
     * Note: Before a tracepoint created using this method can be used, the
     * client must first create a marker and register the breakpoint. The former
     * is accomplished using {@link IBreakpoint#setMarker(IMarker)}, the latter
     * using {@link IBreakpointManager#addBreakpoint(IBreakpoint)}.
     * 
     * @since 7.2
     */
    public static ICLineBreakpoint createBlankLineTracepoint() {
        return new CLineTracepoint();
    }

    /**
     * @since 7.5
     */
    public static ICLineBreakpoint createLineDynamicPrintf(String sourceHandle, IResource resource, int type,
        int lineNumber, boolean enabled, int ignoreCount, String condition, String printfStr, boolean register) throws CoreException {
        HashMap<String, Object> attributes = new HashMap<String, Object>(10);
        setLineBreakpointAttributes(attributes, sourceHandle, type, lineNumber, enabled, ignoreCount, condition);
        attributes.put(ICDynamicPrintf.PRINTF_STRING, printfStr);
        return new CLineDynamicPrintf(resource, attributes, register);
    }

    /**
     * Creates a line dynamic printf without associated marker.
     * <p>
     * Note: Before a dynamic printf created using this method can be used, the
     * client must first create a marker and register the breakpoint. The former
     * is accomplished using {@link IBreakpoint#setMarker(IMarker)}, the latter
     * using {@link IBreakpointManager#addBreakpoint(IBreakpoint)}.
     * 
     * @since 7.5
     */
    public static ICLineBreakpoint createBlankLineDynamicPrintf() {
        return new CLineDynamicPrintf();
    }
    
    /**
     * Helper function for setting common line breakpoint attributes.
     * 
     * @param attributes
     *            Map to write the attributes into.
     * @param sourceHandle
     *            The handle to the breakpoint source.
     * @param resource
     *            The resource on which to create the associated breakpoint
     *            marker.
     * @param type
     *            A type constant from ICBreakpointType.
     * @param lineNumber
     *            The line number on which the breakpoint is set - line numbers
     *            are 1 based, associated with the source file in which the
     *            breakpoint is set.
     * @param enabled
     *            Whether to enable or disable this breakpoint.
     * @param ignoreCount
     *            The number of times this breakpoint will be ignored.
     * @param condition
     *            The breakpoint condition.
     * @param register
     *            Whether to add this breakpoint to the breakpoint manager.
     * 
     * @since 7.2
     */
    public static void setLineBreakpointAttributes(Map<String, Object> attributes, String sourceHandle, Integer type,
        int lineNumber, boolean enabled, int ignoreCount, String condition) {
        attributes.put(IBreakpoint.ID, getPluginIdentifier());
        attributes.put(IMarker.LINE_NUMBER, new Integer(lineNumber));
        attributes.put(IBreakpoint.ENABLED, Boolean.valueOf(enabled));
        attributes.put(ICBreakpoint.IGNORE_COUNT, new Integer(ignoreCount));
        attributes.put(ICBreakpoint.CONDITION, condition);
        attributes.put(ICBreakpoint.SOURCE_HANDLE, sourceHandle);
        attributes.put(ICBreakpointType.TYPE, type);

        // Added for source relocated breakpoints.
        if (!attributes.containsKey(ICLineBreakpoint2.REQUESTED_SOURCE_HANDLE)) {
            attributes.put(ICLineBreakpoint2.REQUESTED_SOURCE_HANDLE, sourceHandle);
        }
        if (!attributes.containsKey(ICLineBreakpoint2.REQUESTED_LINE)) {
            attributes.put(ICLineBreakpoint2.REQUESTED_LINE, new Integer(lineNumber));
        }
        if (attributes.containsKey(IMarker.CHAR_START)
            && !attributes.containsKey(ICLineBreakpoint2.REQUESTED_CHAR_START)) {
            attributes.put(ICLineBreakpoint2.REQUESTED_CHAR_START, attributes.get(IMarker.CHAR_START));
        }
        if (attributes.containsKey(IMarker.CHAR_END) && !attributes.containsKey(ICLineBreakpoint2.REQUESTED_CHAR_END)) {
            attributes.put(ICLineBreakpoint2.REQUESTED_CHAR_END, attributes.get(IMarker.CHAR_END));
        }
    }

    /**
     * Creates and returns an address breakpoint for the source defined by the
     * given source handle, at the given address. The marker associated with the
     * breakpoint will be created on the specified resource.
     * 
     * @param module
     *            the module name the breakpoint is set in
     * @param sourceHandle
     *            the handle to the breakpoint source
     * @param resource
     *            the resource on which to create the associated breakpoint
     *            marker
     * @param address
     *            the address on which the breakpoint is set
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * @return an address breakpoint
     * @throws CoreException
     *             if this method fails. Reasons include:
     *             <ul>
     *             <li>Failure creating underlying marker. The exception's
     *             status contains the underlying exception responsible for the
     *             failure.</li>
     *             </ul>
     * @deprecated as of CDT 5.0 use
     *             {@link #createAddressBreakpoint(String, String, IResource, int, int, IAddress, boolean, int, String, boolean)}
     */
    @Deprecated
    public static ICAddressBreakpoint createAddressBreakpoint(String module, String sourceHandle, IResource resource,
        IAddress address, boolean enabled, int ignoreCount, String condition, boolean register) throws CoreException {
        return createAddressBreakpoint(module, sourceHandle, resource, ICBreakpointType.REGULAR, -1, address, enabled,
            ignoreCount, condition, register);
    }

    /**
     * Creates and returns an address breakpoint for the source defined by the
     * given source handle, at the given address. The marker associated with the
     * breakpoint will be created on the specified resource.
     * 
     * @param module
     *            the module name the breakpoint is set in
     * @param sourceHandle
     *            the handle to the breakpoint source
     * @param resource
     *            the resource on which to create the associated breakpoint
     *            marker
     * @param type
     *            a type constant from ICBreakpointType
     * @param address
     *            the address on which the breakpoint is set
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * @return an address breakpoint
     * @throws CoreException
     *             if this method fails. Reasons include:
     *             <ul>
     *             <li>Failure creating underlying marker. The exception's
     *             status contains the underlying exception responsible for the
     *             failure.</li>
     *             </ul>
     */
    public static ICAddressBreakpoint createAddressBreakpoint(String module, String sourceHandle, IResource resource,
        int type, IAddress address, boolean enabled, int ignoreCount, String condition, boolean register)
        throws CoreException {
        return createAddressBreakpoint(module, sourceHandle, resource, type, -1, address, enabled, ignoreCount,
            condition, register);
    }

    /**
     * Creates and returns an address breakpoint for the source defined by the
     * given source handle, at the given address. The marker associated with the
     * breakpoint will be created on the specified resource.
     * 
     * @param module
     *            the module name the breakpoint is set in
     * @param sourceHandle
     *            the handle to the breakpoint source
     * @param resource
     *            the resource on which to create the associated breakpoint
     *            marker
     * @param type
     *            a type constant from ICBreakpointType
     * @param lineNumber
     *            the line number in the source file
     * @param address
     *            the address on which the breakpoint is set
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * @return an address breakpoint
     * @throws CoreException
     *             if this method fails. Reasons include:
     *             <ul>
     *             <li>Failure creating underlying marker. The exception's
     *             status contains the underlying exception responsible for the
     *             failure.</li>
     *             </ul>
     */
    public static ICAddressBreakpoint createAddressBreakpoint(String module, String sourceHandle, IResource resource,
        int type, int lineNumber, IAddress address, boolean enabled, int ignoreCount, String condition, boolean register)
        throws CoreException {
        HashMap<String, Object> attributes = new HashMap<String, Object>(10);
        setAddressBreakpointAttributes(attributes, module, sourceHandle, type, lineNumber, address, enabled,
            ignoreCount, condition);
        return new CAddressBreakpoint(resource, attributes, register);
    }

    /**
     * Creates an address breakpoint without associated marker.
     * <p>
     * Note: Before a breakpoint created using this method can be used, the
     * client must first create a marker and register the breakpoint. The former
     * is accomplished using {@link IBreakpoint#setMarker(IMarker)}, the latter
     * using {@link IBreakpointManager#addBreakpoint(IBreakpoint)}.
     * 
     * @since 7.2
     */
    public static ICAddressBreakpoint createBlankAddressBreakpoint() {
        return new CAddressBreakpoint();
    }

    /**
     * @since 7.0
     */
    public static ICAddressBreakpoint createAddressTracepoint(String module, String sourceHandle, IResource resource,
        int type, int lineNumber, IAddress address, boolean enabled, int ignoreCount, String condition, boolean register)
        throws CoreException {
        HashMap<String, Object> attributes = new HashMap<String, Object>(10);
        setAddressBreakpointAttributes(attributes, module, sourceHandle, type, lineNumber, address, enabled,
            ignoreCount, condition);
        return new CAddressTracepoint(resource, attributes, register);
    }

    /**
     * Creates an address tracepoint without associated marker.
     * <p>
     * Note: Before a tracepoint created using this method can be used, the
     * client must first create a marker and register the breakpoint. The former
     * is accomplished using {@link IBreakpoint#setMarker(IMarker)}, the latter
     * using {@link IBreakpointManager#addBreakpoint(IBreakpoint)}.
     * 
     * @since 7.2
     */
    public static ICAddressBreakpoint createBlankAddressTracepoint() {
        return new CAddressTracepoint();
    }

    /**
     * @since 7.5
     */
    public static ICAddressBreakpoint createAddressDynamicPrintf(String module, String sourceHandle, IResource resource,
        int type, int lineNumber, IAddress address, boolean enabled, int ignoreCount, String condition, String printfStr, boolean register)
        throws CoreException {
        HashMap<String, Object> attributes = new HashMap<String, Object>(10);
        setAddressBreakpointAttributes(attributes, module, sourceHandle, type, lineNumber, address, enabled,
            ignoreCount, condition);
        attributes.put(ICDynamicPrintf.PRINTF_STRING, printfStr);
        return new CAddressDynamicPrintf(resource, attributes, register);
    }

    /**
     * Creates an address dynamic printf without associated marker.
     * <p>
     * Note: Before a dynamic printf created using this method can be used, the
     * client must first create a marker and register the breakpoint. The former
     * is accomplished using {@link IBreakpoint#setMarker(IMarker)}, the latter
     * using {@link IBreakpointManager#addBreakpoint(IBreakpoint)}.
     * 
     * @since 7.5
     */
    public static ICAddressBreakpoint createBlankAddressDynamicPrintf() {
        return new CAddressDynamicPrintf();
    }
    
    /**
     * Helper function for setting common address breakpoint attributes.
     * 
     * @param attributes
     *            Map to write the attributes into.
     * @param module
     *            the module name the breakpoint is set in
     * @param sourceHandle
     *            the handle to the breakpoint source
     * @param resource
     *            the resource on which to create the associated breakpoint
     *            marker
     * @param type
     *            a type constant from ICBreakpointType
     * @param lineNumber
     *            the line number in the source file
     * @param address
     *            the address on which the breakpoint is set
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * 
     * @since 7.2
     */
    public static void setAddressBreakpointAttributes(Map<String, Object> attributes, String module,
        String sourceHandle, int type, int lineNumber, IAddress address, boolean enabled, int ignoreCount,
        String condition) {
        setLineBreakpointAttributes(attributes, sourceHandle, type, lineNumber, enabled, ignoreCount, condition);
        attributes.put(IMarker.CHAR_START, new Integer(-1));
        attributes.put(IMarker.CHAR_END, new Integer(-1));
        attributes.put(ICLineBreakpoint.ADDRESS, address.toHexAddressString());
        attributes.put(ICBreakpoint.MODULE, module);
    }

    /**
     * Creates a watchpoint without associated marker.
     * <p>
     * Note: Before a watchpoint created using this method can be used, the
     * client must first create a marker and register the breakpoint. The former
     * is accomplished using {@link IBreakpoint#setMarker(IMarker)}, the latter
     * using {@link IBreakpointManager#addBreakpoint(IBreakpoint)}.
     * 
     * @since 7.2
     */
    public static ICWatchpoint createBlankWatchpoint() {
        return new CWatchpoint();
    }

    /**
     * Creates and returns a watchpoint for the source defined by the given
     * source handle, at the given expression. The marker associated with the
     * watchpoint will be created on the specified resource.
     * 
     * @param sourceHandle
     *            the handle to the watchpoint source
     * @param resource
     *            the resource on which to create the associated watchpoint
     *            marker
     * @param writeAccess
     *            whether this is write watchpoint
     * @param readAccess
     *            whether this is read watchpoint
     * @param expression
     *            the expression on which the watchpoint is set
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * @return a watchpoint
     * @throws CoreException
     *             if this method fails. Reasons include:
     *             <ul>
     *             <li>Failure creating underlying marker. The exception's
     *             status contains the underlying exception responsible for the
     *             failure.</li>
     *             </ul>
     */
    public static ICWatchpoint createWatchpoint(String sourceHandle, IResource resource, boolean writeAccess,
        boolean readAccess, String expression, boolean enabled, int ignoreCount, String condition, boolean register)
        throws CoreException {
        HashMap<String, Object> attributes = new HashMap<String, Object>(10);
        setWatchPointAttributes(attributes, sourceHandle, resource, writeAccess, readAccess, expression, "", //$NON-NLS-1$ 
            BigInteger.ZERO, enabled, ignoreCount, condition);
        return new CWatchpoint(resource, attributes, register);
    }

    /**
     * Creates and returns a watchpoint for the source defined by the given
     * source handle, at the given expression. The marker associated with the
     * watchpoint will be created on the specified resource.
     * 
     * @param sourceHandle
     *            the handle to the watchpoint source
     * @param resource
     *            the resource on which to create the associated watchpoint
     *            marker
     * @param type
     *            a type constant from ICBreakpointType
     * @param writeAccess
     *            whether this is write watchpoint
     * @param readAccess
     *            whether this is read watchpoint
     * @param expression
     *            the expression on which the watchpoint is set
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * @return a watchpoint
     * @throws CoreException
     *             if this method fails. Reasons include:
     *             <ul>
     *             <li>Failure creating underlying marker. The exception's
     *             status contains the underlying exception responsible for the
     *             failure.</li>
     *             </ul>
     *             
	 * @since 7.3
	 */
    public static ICWatchpoint createWatchpoint(String sourceHandle, IResource resource, int type, boolean writeAccess,
            boolean readAccess, String expression, boolean enabled, int ignoreCount, String condition, boolean register)
            throws CoreException {
            HashMap<String, Object> attributes = new HashMap<String, Object>(10);
            setWatchPointAttributes(attributes, sourceHandle, resource, type, writeAccess, readAccess, expression, "", //$NON-NLS-1$ 
                BigInteger.ZERO, enabled, ignoreCount, condition);
            return new CWatchpoint(resource, attributes, register);
    }

    /**
     * Creates and returns a watchpoint for the source defined by the given
     * source handle, at the given expression. The marker associated with the
     * watchpoint will be created on the specified resource.
     * 
     * @param sourceHandle
     *            the handle to the watchpoint source
     * @param resource
     *            the resource on which to create the associated watchpoint
     *            marker
     * @param charStart
     *            the first character index associated with the watchpoint, or
     *            -1 if unspecified, in the source file in which the watchpoint
     *            is set
     * @param charEnd
     *            the last character index associated with the watchpoint, or -1
     *            if unspecified, in the source file in which the watchpoint is
     *            set
     * @param lineNumber
     *            the lineNumber on which the watchpoint is set, or -1 if
     *            unspecified - line numbers are 1 based, associated with the
     *            source file in which the watchpoint is set
     * @param writeAccess
     *            whether this is write watchpoint
     * @param readAccess
     *            whether this is read watchpoint
     * @param expression
     *            the expression on which the watchpoint is set
     * @param memorySpace
     *            the memory space in which the watchpoint is set
     * @param range
     *            the range of the watchpoint in addressable units
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * @return a watchpoint
     * @throws CoreException
     *             if this method fails. Reasons include:
     *             <ul>
     *             <li>Failure creating underlying marker. The exception's
     *             status contains the underlying exception responsible for the
     *             failure.</li>
     *             </ul>
     */
    public static ICWatchpoint createWatchpoint(String sourceHandle, IResource resource, int charStart, int charEnd,
        int lineNumber, boolean writeAccess, boolean readAccess, String expression, String memorySpace,
        BigInteger range, boolean enabled, int ignoreCount, String condition, boolean register) throws CoreException {
        HashMap<String, Object> attributes = new HashMap<String, Object>(10);
        setWatchPointAttributes(attributes, sourceHandle, resource, writeAccess, readAccess, expression, memorySpace,
            range, enabled, ignoreCount, condition);
        attributes.put(IMarker.CHAR_START, new Integer(charStart));
        attributes.put(IMarker.CHAR_END, new Integer(charEnd));
        attributes.put(IMarker.LINE_NUMBER, new Integer(lineNumber));
        return new CWatchpoint(resource, attributes, register);
    }

    /**
     * Creates and returns a watchpoint for the source defined by the given
     * source handle, at the given expression and over the given range. The
     * marker associated with the watchpoint will be created on the specified
     * resource.
     * 
     * @param sourceHandle
     *            the handle to the watchpoint source
     * @param resource
     *            the resource on which to create the associated watchpoint
     *            marker
     * @param writeAccess
     *            whether this is write watchpoint
     * @param readAccess
     *            whether this is read watchpoint
     * @param expression
     *            the expression on which the watchpoint is set
     * @param memorySpace
     *            the memory space in which the watchpoint is set
     * @param range
     *            the range of the watchpoint in addressable units
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * @return the watchpoint that was created
     * @throws CoreException
     *             if this method fails. Reasons include:
     *             <ul>
     *             <li>Failure creating underlying marker. The exception's
     *             status contains the underlying exception responsible for the
     *             failure.</li>
     *             </ul>
     */
    public static ICWatchpoint createWatchpoint(String sourceHandle, IResource resource, boolean writeAccess,
        boolean readAccess, String expression, String memorySpace, BigInteger range, boolean enabled, int ignoreCount,
        String condition, boolean register) throws CoreException {
        HashMap<String, Object> attributes = new HashMap<String, Object>(10);
        setWatchPointAttributes(attributes, sourceHandle, resource, writeAccess, readAccess, expression, memorySpace,
            range, enabled, ignoreCount, condition);
        return new CWatchpoint(resource, attributes, register);
    }

    /**
     * Helper function for setting common watchpoint attributes.
     * 
     * @param attributes
     *            Map to write the attributes into.
     * @param sourceHandle
     *            the handle to the watchpoint source
     * @param resource
     *            the resource on which to create the associated watchpoint
     *            marker
     * @param writeAccess
     *            whether this is write watchpoint
     * @param readAccess
     *            whether this is read watchpoint
     * @param expression
     *            the expression on which the watchpoint is set
     * @param memorySpace
     *            the memory space in which the watchpoint is set
     * @param range
     *            the range of the watchpoint in addressable units
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * 
     * @since 7.2
     */
    public static void setWatchPointAttributes(Map<String, Object> attributes, String sourceHandle, IResource resource,
        boolean writeAccess, boolean readAccess, String expression, String memorySpace, BigInteger range,
        boolean enabled, int ignoreCount, String condition) {
        attributes.put(IBreakpoint.ID, getPluginIdentifier());
        attributes.put(IBreakpoint.ENABLED, Boolean.valueOf(enabled));
        attributes.put(ICBreakpoint.IGNORE_COUNT, new Integer(ignoreCount));
        attributes.put(ICBreakpoint.CONDITION, condition);
        attributes.put(ICBreakpoint.SOURCE_HANDLE, sourceHandle);
        attributes.put(ICWatchpoint.EXPRESSION, expression);
        attributes.put(ICWatchpoint2.MEMORYSPACE, memorySpace);
        attributes.put(ICWatchpoint2.RANGE, range.toString());
        attributes.put(ICWatchpoint.READ, Boolean.valueOf(readAccess));
        attributes.put(ICWatchpoint.WRITE, Boolean.valueOf(writeAccess));
    }

    /**
     * Helper function for setting common watchpoint attributes.
     * 
     * @param attributes
     *            Map to write the attributes into.
     * @param sourceHandle
     *            the handle to the watchpoint source
     * @param resource
     *            the resource on which to create the associated watchpoint
     *            marker
     * @param type
     *            a type constant from ICBreakpointType
     * @param writeAccess
     *            whether this is write watchpoint
     * @param readAccess
     *            whether this is read watchpoint
     * @param expression
     *            the expression on which the watchpoint is set
     * @param memorySpace
     *            the memory space in which the watchpoint is set
     * @param range
     *            the range of the watchpoint in addressable units
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     *            
	 * @since 7.3
	 */
    public static void setWatchPointAttributes(Map<String, Object> attributes, String sourceHandle, IResource resource,
            int type, boolean writeAccess, boolean readAccess, String expression, String memorySpace, BigInteger range,
            boolean enabled, int ignoreCount, String condition) {
    	setWatchPointAttributes(attributes, sourceHandle, resource, 
    		writeAccess, readAccess, expression, memorySpace, range, enabled, ignoreCount, condition);
        attributes.put(ICBreakpointType.TYPE, type);
    }

    /**
     * Creates and returns a breakpoint for the function defined by the given
     * name. The marker associated with the breakpoint will be created on the
     * specified resource.
     * 
     * @param sourceHandle
     *            the handle to the breakpoint source
     * @param resource
     *            the resource on which to create the associated breakpoint
     *            marker
     * @param function
     *            the name of the function this breakpoint suspends execution in
     * @param charStart
     *            the first character index associated with the breakpoint, or
     *            -1 if unspecified, in the source file in which the breakpoint
     *            is set
     * @param charEnd
     *            the last character index associated with the breakpoint, or -1
     *            if unspecified, in the source file in which the breakpoint is
     *            set
     * @param lineNumber
     *            the lineNumber on which the breakpoint is set, or -1 if
     *            unspecified - line numbers are 1 based, associated with the
     *            source file in which the breakpoint is set
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * @return an address breakpoint
     * @throws CoreException
     *             if this method fails. Reasons include:
     *             <ul>
     *             <li>Failure creating underlying marker. The exception's
     *             status contains the underlying exception responsible for the
     *             failure.</li>
     *             </ul>
     * @deprecated as of CDT 5.0 use
     *             {@link #createFunctionBreakpoint(String, IResource, int, String, int, int, int, boolean, int, String, boolean)}
     */
    @Deprecated
    public static ICFunctionBreakpoint createFunctionBreakpoint(String sourceHandle, IResource resource,
        String function, int charStart, int charEnd, int lineNumber, boolean enabled, int ignoreCount,
        String condition, boolean register) throws CoreException {
        return createFunctionBreakpoint(sourceHandle, resource, ICBreakpointType.REGULAR, function, charStart, charEnd,
            lineNumber, enabled, ignoreCount, condition, register);
    }

    /**
     * Creates and returns a breakpoint for the function defined by the given
     * name. The marker associated with the breakpoint will be created on the
     * specified resource.
     * 
     * @param sourceHandle
     *            the handle to the breakpoint source
     * @param resource
     *            the resource on which to create the associated breakpoint
     *            marker
     * @param type
     *            a type constant from ICBreakpointType
     * @param function
     *            the name of the function this breakpoint suspends execution in
     * @param charStart
     *            the first character index associated with the breakpoint, or
     *            -1 if unspecified, in the source file in which the breakpoint
     *            is set
     * @param charEnd
     *            the last character index associated with the breakpoint, or -1
     *            if unspecified, in the source file in which the breakpoint is
     *            set
     * @param lineNumber
     *            the lineNumber on which the breakpoint is set, or -1 if
     *            unspecified - line numbers are 1 based, associated with the
     *            source file in which the breakpoint is set
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * @return an address breakpoint
     * @throws CoreException
     *             if this method fails. Reasons include:
     *             <ul>
     *             <li>Failure creating underlying marker. The exception's
     *             status contains the underlying exception responsible for the
     *             failure.</li>
     *             </ul>
     */
    public static ICFunctionBreakpoint createFunctionBreakpoint(String sourceHandle, IResource resource, int type,
        String function, int charStart, int charEnd, int lineNumber, boolean enabled, int ignoreCount,
        String condition, boolean register) throws CoreException {
        HashMap<String, Object> attributes = new HashMap<String, Object>(10);
        setFunctionBreakpointAttributes(attributes, sourceHandle, type, function, charStart, charEnd, lineNumber,
            enabled, ignoreCount, condition);
        return new CFunctionBreakpoint(resource, attributes, register);
    }

    /**
     * Creates a function breakpoint without associated marker.
     * <p>
     * Note: Before a breakpoint created using this method can be used, the
     * client must first create a marker and register the breakpoint. The former
     * is accomplished using {@link IBreakpoint#setMarker(IMarker)}, the latter
     * using {@link IBreakpointManager#addBreakpoint(IBreakpoint)}.
     * 
     * @since 7.2
     */
    public static ICFunctionBreakpoint createBlankFunctionBreakpoint() {
        return new CFunctionBreakpoint();
    }

    /**
     * Creates and returns a tracepoint for the function defined by the given
     * name. The marker associated with the breakpoint will be created on the
     * specified resource.
     * 
     * @param sourceHandle
     *            the handle to the breakpoint source
     * @param resource
     *            the resource on which to create the associated breakpoint
     *            marker
     * @param type
     *            a type constant from ICBreakpointType
     * @param function
     *            the name of the function this breakpoint suspends execution in
     * @param charStart
     *            the first character index associated with the breakpoint, or
     *            -1 if unspecified, in the source file in which the breakpoint
     *            is set
     * @param charEnd
     *            the last character index associated with the breakpoint, or -1
     *            if unspecified, in the source file in which the breakpoint is
     *            set
     * @param lineNumber
     *            the lineNumber on which the breakpoint is set, or -1 if
     *            unspecified - line numbers are 1 based, associated with the
     *            source file in which the breakpoint is set
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * @return an address breakpoint
     * @throws CoreException
     *             if this method fails. Reasons include:
     *             <ul>
     *             <li>Failure creating underlying marker. The exception's
     *             status contains the underlying exception responsible for the
     *             failure.</li>
     *             </ul>
     * @since 7.0
     */
    public static ICFunctionBreakpoint createFunctionTracepoint(String sourceHandle, IResource resource, int type,
        String function, int charStart, int charEnd, int lineNumber, boolean enabled, int ignoreCount,
        String condition, boolean register) throws CoreException {
        HashMap<String, Object> attributes = new HashMap<String, Object>(10);
        setFunctionBreakpointAttributes(attributes, sourceHandle, type, function, charStart, charEnd, lineNumber,
            enabled, ignoreCount, condition);
        return new CFunctionTracepoint(resource, attributes, register);
    }

    /**
     * Creates a function tracepoint without associated marker.
     * <p>
     * Note: Before a tracepoint created using this method can be used, the
     * client must first create a marker and register the breakpoint. The former
     * is accomplished using {@link IBreakpoint#setMarker(IMarker)}, the latter
     * using {@link IBreakpointManager#addBreakpoint(IBreakpoint)}.
     * 
     * @since 7.2
     */
    public static ICFunctionBreakpoint createBlankFunctionTracepoint() {
        return new CFunctionTracepoint();
    }

    /**
     * @since 7.5
     */
    public static ICFunctionBreakpoint createFunctionDynamicPrintf(String sourceHandle, IResource resource, int type,
        String function, int charStart, int charEnd, int lineNumber, boolean enabled, int ignoreCount,
        String condition, String printfStr, boolean register) throws CoreException {
        HashMap<String, Object> attributes = new HashMap<String, Object>(10);
        setFunctionBreakpointAttributes(attributes, sourceHandle, type, function, charStart, charEnd, lineNumber,
            enabled, ignoreCount, condition);
        attributes.put(ICDynamicPrintf.PRINTF_STRING, printfStr);
        return new CFunctionDynamicPrintf(resource, attributes, register);
    }

    /**
     * Creates a function dynamic printf without associated marker.
     * <p>
     * Note: Before a dynamic printf created using this method can be used, the
     * client must first create a marker and register the breakpoint. The former
     * is accomplished using {@link IBreakpoint#setMarker(IMarker)}, the latter
     * using {@link IBreakpointManager#addBreakpoint(IBreakpoint)}.
     * 
     * @since 7.5
     */
    public static ICFunctionBreakpoint createBlankFunctionDynamicPrintf() {
        return new CFunctionDynamicPrintf();
    }

    /**
     * Helper function for setting common address breakpoint attributes.
     * 
     * @param attributes
     *            Map to write the attributes into.
     * @param sourceHandle
     *            the handle to the breakpoint source
     * @param resource
     *            the resource on which to create the associated breakpoint
     *            marker
     * @param type
     *            a type constant from ICBreakpointType
     * @param function
     *            the name of the function this breakpoint suspends execution in
     * @param charStart
     *            the first character index associated with the breakpoint, or
     *            -1 if unspecified, in the source file in which the breakpoint
     *            is set
     * @param charEnd
     *            the last character index associated with the breakpoint, or -1
     *            if unspecified, in the source file in which the breakpoint is
     *            set
     * @param lineNumber
     *            the lineNumber on which the breakpoint is set, or -1 if
     *            unspecified - line numbers are 1 based, associated with the
     *            source file in which the breakpoint is set
     * @param enabled
     *            whether to enable or disable this breakpoint
     * @param ignoreCount
     *            the number of times this breakpoint will be ignored
     * @param condition
     *            the breakpoint condition
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * 
     * @since 7.2
     */
    public static void setFunctionBreakpointAttributes(Map<String, Object> attributes, String sourceHandle, int type,
        String function, int charStart, int charEnd, int lineNumber, boolean enabled, int ignoreCount, String condition) {
        setLineBreakpointAttributes(attributes, sourceHandle, type, lineNumber, enabled, ignoreCount, condition);
        attributes.put(IMarker.CHAR_START, new Integer(charStart));
        attributes.put(IMarker.CHAR_END, new Integer(charEnd));
        attributes.put(ICLineBreakpoint.FUNCTION, function);
    }

    /**
     * Returns the line breakpoint that is already registered with the
     * breakpoint manager for a source with the given handle and the given
     * resource at the given line number.
     * 
     * @param sourceHandle
     *            the source handle
     * @param resource
     *            the breakpoint resource
     * @param lineNumber
     *            the line number
     * @return the line breakpoint that is already registered with the
     *         breakpoint manager or <code>null</code> if no such breakpoint is
     *         registered
     * @exception CoreException
     *                if unable to retrieve the associated marker attributes
     *                (line number).
     */
    public static ICLineBreakpoint lineBreakpointExists(String sourceHandle, IResource resource, int lineNumber)
        throws CoreException {
        String modelId = getPluginIdentifier();
        IBreakpointManager manager = DebugPlugin.getDefault().getBreakpointManager();
        IBreakpoint[] breakpoints = manager.getBreakpoints(modelId);
        for (int i = 0; i < breakpoints.length; i++) {
            if (!(breakpoints[i] instanceof ICLineBreakpoint)) {
                continue;
            }
            ICLineBreakpoint breakpoint = (ICLineBreakpoint) breakpoints[i];
            if (sameSourceHandle(sourceHandle, breakpoint.getSourceHandle())) {
                if (breakpoint.getLineNumber() == lineNumber) {
                    return breakpoint;
                }
            }
        }
        return null;
    }

    /**
     * Returns the watchpoint that is already registered with the breakpoint
     * manager for a source with the given handle and the given resource at the
     * given expression.
     * 
     * @param sourceHandle
     *            the source handle
     * @param resource
     *            the breakpoint resource
     * @param expression
     *            the expression
     * @return the watchpoint that is already registered with the breakpoint
     *         manager or <code>null</code> if no such watchpoint is registered
     * @exception CoreException
     *                if unable to retrieve the associated marker attributes
     *                (line number).
     */
    public static ICWatchpoint watchpointExists(String sourceHandle, IResource resource, String expression)
        throws CoreException {
        String modelId = getPluginIdentifier();
        String markerType = ICWatchpoint.C_WATCHPOINT_MARKER;
        IBreakpointManager manager = DebugPlugin.getDefault().getBreakpointManager();
        IBreakpoint[] breakpoints = manager.getBreakpoints(modelId);
        for (int i = 0; i < breakpoints.length; i++) {
            if (!(breakpoints[i] instanceof ICWatchpoint)) {
                continue;
            }
            ICWatchpoint breakpoint = (ICWatchpoint) breakpoints[i];
            if (breakpoint.getMarker().getType().equals(markerType)) {
                if (sameSourceHandle(sourceHandle, breakpoint.getSourceHandle())) {
                    if (breakpoint.getMarker().getResource().equals(resource)) {
                        if (breakpoint.getExpression().equals(expression)) {
                            return breakpoint;
                        }
                    }
                }
            }
        }
        return null;
    }

    /**
     * Returns the function breakpoint that is already registered with the
     * breakpoint manager for a source with the given handle and the given
     * resource with the given function name.
     * 
     * @param sourceHandle
     *            the source handle
     * @param resource
     *            the breakpoint resource
     * @param function
     *            the fully qualified function name
     * @return the breakpoint that is already registered with the breakpoint
     *         manager or <code>null</code> if no such breakpoint is registered
     * @exception CoreException
     *                if unable to retrieve the associated marker attributes
     *                (line number).
     */
    public static ICFunctionBreakpoint functionBreakpointExists(String sourceHandle, IResource resource, String function)
        throws CoreException {
        String modelId = getPluginIdentifier();
        IBreakpointManager manager = DebugPlugin.getDefault().getBreakpointManager();
        IBreakpoint[] breakpoints = manager.getBreakpoints(modelId);
        for (int i = 0; i < breakpoints.length; i++) {
            if (!(breakpoints[i] instanceof ICFunctionBreakpoint)) {
                continue;
            }
            ICFunctionBreakpoint breakpoint = (ICFunctionBreakpoint) breakpoints[i];
            if (sameSourceHandle(sourceHandle, breakpoint.getSourceHandle())) {
                if (breakpoint.getMarker().getResource().equals(resource)) {
                    if (breakpoint.getFunction() != null && breakpoint.getFunction().equals(function)) {
                        return breakpoint;
                    }
                }
            }
        }
        return null;
    }

    /**
     * @deprecated
     */
    @Deprecated
    public static IDebugTarget newDebugTarget(ILaunch launch, ICDITarget target, String name, IProcess iprocess,
        IProcess debuggerProcess, IFile file, boolean allowTerminate, boolean allowDisconnect, boolean stopInMain)
        throws CoreException {
        IBinaryExecutable exeFile = getBinary(file);
        String stopSymbol = null;
        if (stopInMain)
            stopSymbol = launch.getLaunchConfiguration().getAttribute(
                ICDTLaunchConfigurationConstants.ATTR_DEBUGGER_STOP_AT_MAIN_SYMBOL,
                ICDTLaunchConfigurationConstants.DEBUGGER_STOP_AT_MAIN_SYMBOL_DEFAULT);
        return newDebugTarget(launch, file.getProject(), target, name, iprocess, exeFile, allowTerminate,
            allowDisconnect, stopSymbol, true);
    }

    /**
     * @deprecated
     */
    @Deprecated
    public static IDebugTarget newAttachDebugTarget(ILaunch launch, ICDITarget target, String name,
        IProcess debuggerProcess, IFile file) throws CoreException {
        IBinaryExecutable exeFile = getBinary(file);
        return newDebugTarget(launch, file.getProject(), target, name, null, exeFile, true, true, false);
    }

    /**
     * @deprecated
     */
    @Deprecated
    public static IDebugTarget newCoreFileDebugTarget(final ILaunch launch, final ICDITarget target, final String name,
        final IProcess debuggerProcess, final IFile file) throws CoreException {
        IBinaryExecutable exeFile = getBinary(file);
        return newDebugTarget(launch, file.getProject(), target, name, null, exeFile, true, false, false);
    }

    private static IBinaryExecutable getBinary(IFile file) throws CoreException {
        IProject project = file.getProject();
        ICConfigExtensionReference[] binaryParsersExt = CCorePlugin.getDefault().getDefaultBinaryParserExtensions(
            project);
        for (int i = 0; i < binaryParsersExt.length; i++) {
            IBinaryParser parser = CoreModelUtil.getBinaryParser(binaryParsersExt[i]);
            try {
                IBinaryFile exe = parser.getBinary(file.getLocation());
                if (exe instanceof IBinaryExecutable) {
                    return (IBinaryExecutable) exe;
                }
            } catch (IOException e) {
            }
        }
        throw new CoreException(new Status(IStatus.ERROR, CDebugCorePlugin.getUniqueIdentifier(), -1,
            DebugCoreMessages.getString("CDIDebugModel.0"), null)); //$NON-NLS-1$
    }

    private static boolean sameSourceHandle(String handle1, String handle2) {
        if (handle1 == null || handle2 == null)
            return false;
        IPath path1 = new Path(handle1);
        IPath path2 = new Path(handle2);
        if (path1.isValidPath(handle1) && path2.isValidPath(handle2)) {
            return path1.equals(path2);
        }
        // If handles are not file names ????
        return handle1.equals(handle2);
    }

    /**
     * Checks whether an event breakpoint with given type and argument already
     * exists. If multiple event breakpoints exist that match given parameters,
     * only one of them will be returned.
     * 
     * @param type
     *            Event type.
     * @param arg
     *            Event argument.
     * @return Event breakpoint, if found.
     * @throws CoreException
     *             Exception in reading breakpoint properties.
     */
    public static ICEventBreakpoint eventBreakpointExists(String type, String arg) throws CoreException {
        String modelId = getPluginIdentifier();

        IBreakpointManager manager = DebugPlugin.getDefault().getBreakpointManager();
        IBreakpoint[] breakpoints = manager.getBreakpoints(modelId);
        for (int i = 0; i < breakpoints.length; i++) {
            if (!(breakpoints[i] instanceof ICEventBreakpoint)) {
                continue;
            }
            ICEventBreakpoint breakpoint = (ICEventBreakpoint) breakpoints[i];

            if (breakpoint.getEventType().equals(type)) {
                String arg1 = breakpoint.getEventArgument();
                if (arg1 == null)
                    arg1 = ""; //$NON-NLS-1$
                String arg2 = arg == null ? "" : arg; //$NON-NLS-1$
                if (arg1.equals(arg2))
                    return breakpoint;
            }

        }
        return null;
    }

    /**
     * Creates and registers a new event breakpoint.
     * 
     * @param attributes
     *            Map to write the attributes into.
     * @param type
     *            Event breakpoint type.
     * @param arg
     *            Event-specific argument value.
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * @return an event breakpoint
     * 
     * @throws CoreException
     *             if this method fails. Reasons include:
     *             <ul>
     *             <li>Failure creating underlying marker. The exception's
     *             status contains the underlying exception responsible for the
     *             failure.</li>
     *             </ul>
     */
    public static ICEventBreakpoint createEventBreakpoint(String type, String arg, boolean register)
        throws CoreException {
        final IResource resource = ResourcesPlugin.getWorkspace().getRoot();
        final Map<String, Object> attributes = new HashMap<String, Object>();
        setEventBreakpointAttributes(attributes, type, arg);
        return new CEventBreakpoint(resource, attributes, register);

    }

    /**
     * Helper function for setting common event breakpoint attributes.
     * 
     * @param attributes
     *            Map to write the attributes into.
     * @param type
     *            Event breakpoint type.
     * @param arg
     *            Event-specific argument value.
     * @param register
     *            whether to add this breakpoint to the breakpoint manager
     * 
     * @since 7.2
     */
    public static void setEventBreakpointAttributes(Map<String, Object> attributes, String type, String arg) {
        attributes.put(IBreakpoint.ID, CDIDebugModel.getPluginIdentifier());
        attributes.put(IBreakpoint.ENABLED, true);
        attributes.put(ICBreakpoint.IGNORE_COUNT, 0);
        attributes.put(ICBreakpoint.CONDITION, ""); //$NON-NLS-1$
        attributes.put(ICEventBreakpoint.EVENT_TYPE_ID, type);
        attributes.put(ICEventBreakpoint.EVENT_ARG, arg);
    }

    /**
     * Creates an event breakpoint without associated marker.
     * <p>
     * Note: Before an event breakpoint created using this method can be used, the
     * client must first create a marker and register the breakpoint. The former
     * is accomplished using {@link IBreakpoint#setMarker(IMarker)}, the latter
     * using {@link IBreakpointManager#addBreakpoint(IBreakpoint)}.
     * 
     * @since 7.2
     */
    public static ICEventBreakpoint createBlankEventBreakpoint() {
        return new CEventBreakpoint();
    }

    /**
     * Creates a marker for given C breakpoint.
     * 
     * @param breakpoint
     *            Breakpoint to create the marker for.
     * @param resource
     *            Resource to create the marker on.
     * @param attributes
     *            Marker attributes to use.
     * @param add
     *            Whether to register the breakpoint with breakpoint manager.
     * @throws CoreException
     *             Error thrown while creating marker.
     * 
     * @since 7.2
     */
    public static void createBreakpointMarker(final ICBreakpoint breakpoint, final IResource resource,
        final Map<String, Object> attributes, final boolean add) throws CoreException {
        if (breakpoint.getMarker() != null) {
            throw new CoreException(new Status(IStatus.ERROR, CDebugCorePlugin.PLUGIN_ID,
                "Cannot create breakpoint marker breakpoint given breakpoint already has an assotiated maker")); //$NON-NLS-1$
        }

        IWorkspaceRunnable wr = new IWorkspaceRunnable() {
            @Override
            public void run(IProgressMonitor monitor) throws CoreException {
                // create the marker
                IMarker marker = resource.createMarker(calculateMarkerType(breakpoint));
                breakpoint.setMarker(marker);

                // set attributes
                marker.setAttributes(attributes);

                // set the marker message
                if (breakpoint instanceof ICBreakpoint2) {
                    ((ICBreakpoint2) breakpoint).refreshMessage();
                }

                // add to breakpoint manager if requested
                if (add) {
                    DebugPlugin.getDefault().getBreakpointManager().addBreakpoint(breakpoint);
                }
            }
        };
        ResourcesPlugin.getWorkspace().run(wr, null);
    }
}

Back to the top