blob: 4d00e6c45286168c69f2b102276a45636c2d7b4a (
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
|
/*******************************************************************************
* Copyright (c) 2004, 2010 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
*******************************************************************************/
package org.eclipse.cdt.debug.core.model;
import org.eclipse.cdt.debug.core.CDIDebugModel;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.model.IBreakpoint;
/**
* A breakpoint specific to the C/C++ debug model. A C/C++ breakpoint supports:
* <ul>
* <li>a condition</li>
* <li>an ignore count</li>
* <li>a thread filter to restrict the breakpoint to a specific thread</li>
* <li>an installed property that indicates a breakpoint was successfully
* installed in debug target</li>
* </ul>
*/
public interface ICBreakpoint extends IBreakpoint {
/**
* This debug model identifier can be returned by a debug implementation
* to indicate that a given debugger integration is using C Breakpoints.
* This model ID will allow breakpoint actions to configure their default
* selection.
*
* @since 7.0
*/
public static final String C_BREAKPOINTS_DEBUG_MODEL_ID = CDIDebugModel.getPluginIdentifier() + ".cbreakpoints"; //$NON-NLS-1$
/**
* Breakpoint attribute storing the number of debug targets a breakpoint is
* installed in (value
* <code>"org.eclipse.cdt.debug.core.installCount"</code>). This
* attribute is an <code>int</code>.
*
* Note: this attribute is used only for notifying listeners
* (IBreakpointListener) of a change in the install count. The attribute is
* not used by the CDT breakpoint object to manage the install count, since
* it is a transient property of a breakpoint, and marker attributes are
* persisted. In other words, it's conceivable that upon breakpoint manager
* initialization, a breakpoint is reconstructed with this attribute being
* >0. That doesn't mean the breakpoint is installed (at workbench launch
* time, there are no installed breakpoints). At that time, the attribute
* means absolutely nothing.
*/
public static final String INSTALL_COUNT = "org.eclipse.cdt.debug.core.installCount"; //$NON-NLS-1$
/**
* Breakpoint attribute storing the conditional expression associated with
* this breakpoint (value <code>"org.eclipse.cdt.debug.core.condition"</code>).
* This attribute is a <code>String</code>.
*/
public static final String CONDITION = "org.eclipse.cdt.debug.core.condition"; //$NON-NLS-1$
/**
* Breakpoint attribute storing a breakpoint's ignore count value (value
* <code>"org.eclipse.cdt.debug.core.ignoreCount"</code>). This attribute
* is an <code>int</code>.
*/
public static final String IGNORE_COUNT = "org.eclipse.cdt.debug.core.ignoreCount"; //$NON-NLS-1$
/**
* Breakpoint attribute storing an identifier of the thread this breakpoint
* is restricted in (value <code>"org.eclipse.cdt.debug.core.threadId"</code>).
* This attribute is a <code>String</code>.
*/
public static final String THREAD_ID = "org.eclipse.cdt.debug.core.threadId"; //$NON-NLS-1$
/**
* Breakpoint attribute storing the source handle of the file this breakpoint
* is set in (value <code>"org.eclipse.cdt.debug.core.sourceHandle"</code>).
* This attribute is a <code>String</code>.
*/
public static final String SOURCE_HANDLE = "org.eclipse.cdt.debug.core.sourceHandle"; //$NON-NLS-1$
/**
* Breakpoint attribute storing the module name this breakpoint
* is set in (value <code>"org.eclipse.cdt.debug.core.module"</code>).
* This attribute is a <code>String</code>.
*
* @since 3.0
*/
public static final String MODULE = "org.eclipse.cdt.debug.core.module"; //$NON-NLS-1$
/**
* Returns whether this breakpoint is installed in at least one debug
* target.
*
* @return whether this breakpoint is installed
* @exception CoreException if unable to access the property on this breakpoint's
* underlying marker
*/
public boolean isInstalled() throws CoreException;
/**
* Returns whether this breakpoint is conditional.
*
* @return whether this breakpoint is conditional
* @exception CoreException if unable to access the property on this breakpoint's
* underlying marker
*/
public boolean isConditional() throws CoreException;
/**
* Returns the conditional expression associated with this breakpoint.
*
* @return this breakpoint's conditional expression
* @exception CoreException if unable to access the property on this breakpoint's
* underlying marker
*/
public String getCondition() throws CoreException;
/**
* Sets the condition associated with this breakpoint.
*
* @param condition the conditional expression
* @exception CoreException if unable to access the property on this breakpoint's
* underlying marker
*/
public void setCondition( String condition ) throws CoreException;
/**
* Returns the ignore count used by this breakpoint.
*
* @return the ignore count used by this breakpoint
* @exception CoreException if unable to access the property on this breakpoint's
* underlying marker
*/
public int getIgnoreCount() throws CoreException;
/**
* Sets the ignore count attribute for this breakpoint.
*
* @param ignoreCount the new ignore count
* @exception CoreException if unable to access the property on this breakpoint's
* underlying marker
*/
public void setIgnoreCount( int ignoreCount ) throws CoreException;
/**
* Returns the identifier of the thread this breakpoint is restricted in.
*
* @return the thread identifier
* @exception CoreException if unable to access the property on this breakpoint's
* underlying marker
*/
public String getThreadId() throws CoreException;
/**
* Restricts this breakpoint to suspend only in the given thread when
* encounterd in the given thread's target.
*
* @param threadId the thread identifier
* @exception CoreException if unable to access the property on this breakpoint's
* underlying marker
*/
public void setThreadId( String threadId ) throws CoreException;
/**
* Returns the module name this breakpoint is set in.
*
* @return the module name
* @exception CoreException if unable to access the property on this breakpoint's
* underlying marker
*/
public String getModule() throws CoreException;
/**
* Sets the module name of this breakpoint.
*
* @param module the module name
* @exception CoreException if unable to access the property on this breakpoint's
* underlying marker
*/
public void setModule( String module ) throws CoreException;
/**
* Returns the source handle this breakpoint is set in.
*
* @return the source handle
* @exception CoreException if unable to access the property on this breakpoint's
* underlying marker
*/
public String getSourceHandle() throws CoreException;
/**
* Sets the source handle of this breakpoint.
*
* @param sourceHandle the source handle
* @exception CoreException if unable to access the property on this breakpoint's
* underlying marker
*/
public void setSourceHandle( String sourceHandle ) throws CoreException;
/**
* Increments the install count of this breakpoint
*
* @return the new install count value
* @throws CoreException if unable to access the property
* on this breakpoint's underlying marker
*/
public int incrementInstallCount() throws CoreException;
/**
* Decrements the install count of this breakpoint.
*
* @return the new install caount value
* @throws CoreException if unable to access the property
* on this breakpoint's underlying marker
*/
public int decrementInstallCount() throws CoreException;
/**
* Resets the install count of this breakpoint
*
* @throws CoreException if unable to access the property
* on this breakpoint's underlying marker
*/
public void resetInstallCount() throws CoreException;
/**
* Returns a breakpoint extension registered for the given debug model
* and of the given type.
*
* @param debugModelId Debug model ID of the extension.
* @param extensionType Type of the extension.
* @return Extension instance.
* @throws CoreException Throws exception in case the extension doesn't exist or cannot be initialized.
*/
public <V extends ICBreakpointExtension> V getExtension(String debugModelId, Class<V> extensionType) throws CoreException;
}
|
