Skip to content

Commit 4002a0b

Browse files
SougandhSSougandhS
committed
Add support for custom labels on breakpoints
This commit introduces the ability for users to set custom labels on breakpoints, making it easier to identify and differentiate them. Additionally, breakpoints with custom labels are visually highlighted, improving workflow and debugging efficiency.
1 parent 9e339b2 commit 4002a0b

File tree

11 files changed

+179
-7
lines changed

11 files changed

+179
-7
lines changed

‎debug/org.eclipse.debug.core/META-INF/MANIFEST.MF‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Manifest-Version: 1.0
22
Bundle-ManifestVersion: 2
33
Bundle-Name: %pluginName
44
Bundle-SymbolicName: org.eclipse.debug.core; singleton:=true
5-
Bundle-Version: 3.23.0.qualifier
5+
Bundle-Version: 3.24.0.qualifier
66
Bundle-Activator: org.eclipse.debug.core.DebugPlugin
77
Bundle-Vendor: %providerName
88
Bundle-Localization: plugin

‎debug/org.eclipse.debug.core/core/org/eclipse/debug/core/model/Breakpoint.java‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*******************************************************************************
2-
* Copyright (c) 2000, 2016 IBM Corporation and others.
2+
* Copyright (c) 2000, 2025 IBM Corporation and others.
33
*
44
* This program and the accompanying materials
55
* are made available under the terms of the Eclipse Public License 2.0
@@ -45,7 +45,6 @@
4545

4646
public abstract class Breakpoint extends PlatformObject implements IBreakpoint, ITriggerPoint {
4747

48-
4948
/**
5049
* Creates a breakpoint.
5150
*
@@ -384,4 +383,22 @@ public String toString() {
384383
return builder.toString();
385384
}
386385

386+
/**
387+
* Returns associated label associated with the breakpoint.
388+
* @since 3.23
389+
*/
390+
public String getBreakpointLabel() {
391+
return getMarker().getAttribute(LABEL, ""); //$NON-NLS-1$
392+
}
393+
394+
/**
395+
* Sets a new label for the breakpoint.
396+
*
397+
* @param label provide by the user
398+
* @since 3.23
399+
*/
400+
public void setBreakpointLabel(String label) throws CoreException {
401+
setAttribute(LABEL, label);
402+
}
403+
387404
}

‎debug/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IBreakpoint.java‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,16 @@ public interface IBreakpoint extends IAdaptable {
119119
*/
120120
String PERSISTED= "org.eclipse.debug.core.persisted"; //$NON-NLS-1$
121121

122+
/**
123+
* Persisted breakpoint marker attribute (value
124+
* <code>"org.eclipse.debug.core.label"</code>). The attribute is a
125+
* <code>String</code> corresponding to whether a breakpoint's custom label
126+
* for easier identification
127+
* @since 3.23
128+
* @see org.eclipse.core.resources.IMarker#getAttribute(String, String)
129+
*/
130+
String LABEL = "org.eclipse.debug.core.label"; //$NON-NLS-1$
131+
122132
/**
123133
* Deletes this breakpoint's underlying marker, and removes
124134
* this breakpoint from the breakpoint manager.

‎debug/org.eclipse.debug.ui/icons/full/elcl16/bp_label.png‎

402 Bytes
Loading

‎debug/org.eclipse.debug.ui/plugin.properties‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -418,3 +418,4 @@ debug.core.component.label = Platform Debug Core
418418
GroupLaunch.description=Launch several other configurations sequentially
419419

420420
prototype.decorator.label = Prototype Decorator
421+
breakpointLabel.label=Label

‎debug/org.eclipse.debug.ui/plugin.xml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1540,6 +1540,15 @@
15401540
enablesFor="+"
15411541
id="org.eclipse.debug.ui.breakpointsView.toolbar.remove">
15421542
</action>
1543+
<action
1544+
label="%breakpointLabel.label"
1545+
icon="$nl$/icons/full/elcl16/bp_label.png"
1546+
helpContextId="remove_breakpoint_action_context"
1547+
class="org.eclipse.debug.internal.ui.actions.breakpoints.BreakpointLabelAction"
1548+
menubarPath="breakpointGroup"
1549+
enablesFor="1"
1550+
id="org.eclipse.debug.ui.breakpointsView.breakpointLabel">
1551+
</action>
15431552
<action
15441553
label="%DisableAllBreakpointsAction.label"
15451554
icon="$nl$/icons/full/elcl16/disabled_co.png"

‎debug/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/ActionMessages.java‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*******************************************************************************
2-
* Copyright (c) 2000, 2020 IBM Corporation and others.
2+
* Copyright (c) 2000, 2025 IBM Corporation and others.
33
*
44
* This program and the accompanying materials
55
* are made available under the terms of the Eclipse Public License 2.0
@@ -252,4 +252,9 @@ public class ActionMessages extends NLS {
252252
public static String EnableAllBreakpointsAction_0;
253253
public static String EnableAllBreakpointsAction_1;
254254
public static String EnableAllBreakpointsAction_3;
255+
public static String BreakpointLabelTitle;
256+
public static String BreakpointLabelDialog;
257+
public static String BreakpointLabelRemove;
258+
public static String BreakpointLabelValid;
259+
255260
}

‎debug/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/ActionMessages.properties‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
###############################################################################
2-
# Copyright (c) 2000, 2020 IBM Corporation and others.
2+
# Copyright (c) 2000, 2025 IBM Corporation and others.
33
#
44
# This program and the accompanying materials
55
# are made available under the terms of the Eclipse Public License 2.0
@@ -235,4 +235,8 @@ VirtualFindAction_0=Error
235235
VirtualFindAction_1=Unable to locate {0} in viewer
236236

237237
ToggleBreakpointsTargetManager_defaultToggleTarget_name = Default
238-
ToggleBreakpointsTargetManager_defaultToggleTarget_description = Default
238+
ToggleBreakpointsTargetManager_defaultToggleTarget_description = Default
239+
BreakpointLabelTitle=Set Breakpoint Label
240+
BreakpointLabelDialog=Provide a new label, Leave blank to stick to default
241+
BreakpointLabelRemove=Remove
242+
BreakpointLabelValid=Label should contain valid characters

‎debug/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/breakpoints/BreakpointLabelAction.java‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
/*******************************************************************************
2+
* Copyright (c) 2025 IBM Corporation
3+
*
4+
* This program and the accompanying materials
5+
* are made available under the terms of the Eclipse Public License 2.0
6+
* which accompanies this distribution, and is available at
7+
* https://www.eclipse.org/legal/epl-2.0/
8+
*
9+
* SPDX-License-Identifier: EPL-2.0
10+
*
11+
* Contributors:
12+
* IBM Corporation - initial API and implementation
13+
*******************************************************************************/
14+
package org.eclipse.debug.internal.ui.actions.breakpoints;
15+
16+
import org.eclipse.core.runtime.CoreException;
17+
import org.eclipse.debug.core.model.Breakpoint;
18+
import org.eclipse.debug.internal.ui.DebugUIPlugin;
19+
import org.eclipse.debug.internal.ui.actions.ActionMessages;
20+
import org.eclipse.jface.action.IAction;
21+
import org.eclipse.jface.dialogs.InputDialog;
22+
import org.eclipse.jface.viewers.ISelection;
23+
import org.eclipse.jface.viewers.IStructuredSelection;
24+
import org.eclipse.jface.window.Window;
25+
import org.eclipse.ui.IViewActionDelegate;
26+
import org.eclipse.ui.IViewPart;
27+
28+
public class BreakpointLabelAction implements IViewActionDelegate {
29+
30+
private IViewPart fView;
31+
32+
protected IViewPart getView() {
33+
return fView;
34+
}
35+
36+
protected void setView(IViewPart view) {
37+
fView = view;
38+
}
39+
40+
@Override
41+
public void run(IAction action) {
42+
IStructuredSelection selection = getSelection();
43+
if (selection.getFirstElement() instanceof Breakpoint bp) {
44+
String label = askForLabel(bp);
45+
if (label == null) {
46+
return;
47+
}
48+
if (!label.isEmpty()) {
49+
try {
50+
bp.setBreakpointLabel(label);
51+
} catch (CoreException e) {
52+
DebugUIPlugin.log(e);
53+
}
54+
} else {
55+
try {
56+
bp.setBreakpointLabel(""); //$NON-NLS-1$
57+
} catch (CoreException e) {
58+
DebugUIPlugin.log(e);
59+
}
60+
}
61+
}
62+
}
63+
64+
protected IStructuredSelection getSelection() {
65+
return (IStructuredSelection) getView().getViewSite().getSelectionProvider().getSelection();
66+
}
67+
68+
@Override
69+
public void selectionChanged(IAction action, ISelection selection) {
70+
}
71+
72+
@Override
73+
public void init(IViewPart view) {
74+
setView(view);
75+
}
76+
77+
private String askForLabel(Breakpoint breakpoint) {
78+
String current = breakpoint.getBreakpointLabel();
79+
InputDialog dialog = new InputDialog(fView.getSite().getShell(),
80+
ActionMessages.BreakpointLabelTitle, ActionMessages.BreakpointLabelDialog,
81+
current, null);
82+
83+
if (dialog.open() != Window.OK) {
84+
return null;
85+
}
86+
String data = dialog.getValue();
87+
return data.trim();
88+
}
89+
90+
}

‎debug/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/model/elements/BreakpointLabelProvider.java‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*****************************************************************
2-
* Copyright (c) 2009, 2010 Texas Instruments and others
2+
* Copyright (c) 2009, 2025 Texas Instruments and others
33
*
44
* This program and the accompanying materials
55
* are made available under the terms of the Eclipse Public License 2.0
@@ -15,6 +15,7 @@
1515
package org.eclipse.debug.internal.ui.model.elements;
1616

1717
import org.eclipse.core.runtime.CoreException;
18+
import org.eclipse.debug.core.model.Breakpoint;
1819
import org.eclipse.debug.core.model.IBreakpoint;
1920
import org.eclipse.debug.internal.core.IInternalDebugCoreConstants;
2021
import org.eclipse.debug.internal.ui.viewers.model.provisional.IPresentationContext;
@@ -31,6 +32,20 @@ public class BreakpointLabelProvider extends DebugElementLabelProvider {
3132
@Override
3233
protected String getLabel(TreePath elementPath, IPresentationContext presentationContext, String columnId, int columnIndex) throws CoreException {
3334
if (columnIndex == 0) {
35+
if (elementPath.getFirstSegment() instanceof Breakpoint breakpoint) {
36+
String current = super.getLabel(elementPath, presentationContext, columnId, columnIndex);
37+
if (!breakpoint.getBreakpointLabel().isEmpty()) {
38+
String[] currentElements = current.split(" "); //$NON-NLS-1$
39+
if (current.contains("line")) { //$NON-NLS-1$
40+
41+
return currentElements[0] + currentElements[1] + currentElements[2] + " " //$NON-NLS-1$
42+
+ breakpoint.getBreakpointLabel();
43+
}
44+
return currentElements[0] + " " //$NON-NLS-1$
45+
+ breakpoint.getBreakpointLabel();
46+
}
47+
48+
}
3449
return super.getLabel(elementPath, presentationContext, columnId, columnIndex);
3550
} else {
3651
return IInternalDebugCoreConstants.EMPTY_STRING;

0 commit comments

Comments
 (0)