PHP: Added support for exception breakpoints.

[troizet]

What has been done in this PR:
1) Added support for exception breakpoints. (Closes #5434)

Debugging examples:

• without using exception breakpoint

simplescreenrecorder-2023-08-21_21.26.24.mp4

• breakpoint on warning

simplescreenrecorder-2023-08-21_21.27.00.mp4

• breakpoint on MyException class

simplescreenrecorder-2023-08-21_21.28.44.mp4

The code used in the example:

<?php

class MyException extends Exception
{}

function throwException()
{
    throw new MyException();
}

echo "Test exception breakpoint";


echo "Line breakpoint";

$foo = $bar['nope'];

try {
    throwException();
} catch (Exception $e) {}

echo "End test exception breakpoint";

2) Breakpoint_set and breakpoint_remove commands are used instead of breakpoint_update to change breakpoint state during debugging.

In the current implementation, enabling/disabling a breakpoint during debugging is done by setting the state attribute with the breakpoint_update command.
But for exception breakpoint the state attribute has no effect. I checked on versions of xdebug: v3.1.6, v3.2.0, v3.2.1.
I looked at how this functionality is implemented in PhpStorm and VSCode using the xdebug log file.
There breakpoint enable/disable is implemented via breakpoint_set/breakpoint_remove commands.

--- a/php/php.dbgp/src/org/netbeans/modules/php/dbgp/breakpoints/BreakpointRuntimeSetter.java
+++ b/php/php.dbgp/src/org/netbeans/modules/php/dbgp/breakpoints/BreakpointRuntimeSetter.java
@@ -66,7 +66,12 @@ public void propertyChange(PropertyChangeEvent event) {
             return;
         }
         Object source = event.getSource();
-        performCommand((Breakpoint) source, Lazy.UPDATE_COMMAND);
+
+        if (((Breakpoint)source).isEnabled()) {
+            performCommand((Breakpoint) source, Lazy.SET_COMMAND);
+        } else {
+            performCommand((Breakpoint) source, Lazy.REMOVE_COMMAND);
+        }
     }

For the same reason, I removed the breakpoint_set command for a disabled breakpoint when debugging starts.

--- a/php/php.dbgp/src/org/netbeans/modules/php/dbgp/packets/InitMessage.java
+++ b/php/php.dbgp/src/org/netbeans/modules/php/dbgp/packets/InitMessage.java
@@ -122,7 +122,11 @@ private void setBreakpoints(DebugSession session) {
         SessionId id = session.getSessionId();
         Breakpoint[] breakpoints = DebuggerManager.getDebuggerManager().getBreakpoints();
         for (Breakpoint breakpoint : breakpoints) {
-            if (!(breakpoint instanceof AbstractBreakpoint)) {
+            if (!(breakpoint instanceof AbstractBreakpoint) ) {
+                continue;
+            }
+            //do not set a breakpoint at debug start if it is not enabled
+            if (!breakpoint.isEnabled()) {
                 continue;
             }
             AbstractBreakpoint brkpnt = (AbstractBreakpoint) breakpoint;

3) Fixed a bug where the previous breakpoint was displayed as the current breakpoint in the breakpoint list if the current breakpoint was not found.

--- a/php/php.dbgp/src/org/netbeans/modules/php/dbgp/breakpoints/BreakpointModel.java
+++ b/php/php.dbgp/src/org/netbeans/modules/php/dbgp/breakpoints/BreakpointModel.java

@@ -119,15 +126,25 @@ public String getShortDescription(Object node) throws UnknownTypeException {
 
     public void setCurrentStack(Stack stack, DebugSession session) {
         if (stack == null) {
-            synchronized (myCurrentBreakpoints) {
-                AbstractBreakpoint breakpoint = myCurrentBreakpoints.remove(session);
-                fireChangeEvent(new ModelEvent.NodeChanged(this, breakpoint));
-            }
+            removeCurrentBreakpoint(session);
             return;
         }
         String currentCommand = stack.getCurrentCommandName();
         if (!foundLineBreakpoint(stack.getFileName().replace("file:///", "file:/"), stack.getLine() - 1, session)) { //NOI18N
-            foundFunctionBreakpoint(currentCommand, session);
+            if (!foundFunctionBreakpoint(currentCommand, session)) {
+                /**
+                 * Clear myCurrentBreakpoints because if the current breakpoints is not found,
+                 * the previous breakpoint will still be shown as current
+                 */
+                removeCurrentBreakpoint(session);
+            }
+        }
+    }
+
+    private void removeCurrentBreakpoint(DebugSession session) {
+        synchronized (myCurrentBreakpoints) {
+            AbstractBreakpoint breakpoint = myCurrentBreakpoints.remove(session);
+            fireChangeEvent(new ModelEvent.NodeChanged(this, breakpoint));
         }
     }

[junichi11]

// NOI18N

[tmysik]

Well, these are not friendly accessible descriptions, right...?

[tmysik]

Please, improve A11Y description of these elements (imagine, that you cannot see them - how would you describe them?), thanks.

[junichi11]

@troizet Thank you for your work!
Please add the issue number to the commit message.
Please write an example code.

[tmysik]

@troizet

Wow, very nice PR, thanks a lot for it! 👍

[troizet]

@junichi11, @tmysik. Has corrected the shortcomings you pointed out. Thank you very much for the review!

[junichi11]

Please add image files to the licenseinfo.xml. Thanks!

[tmysik]

@troizet Please, resolve the remaining comments so we can merge this PR 👍 Thanks a lot for your work!

[junichi11]

Thank you for your work!

[tmysik]

Thanks! 👍

[junichi11]

Merging.

[ErikKrause]

Many thanks for this useful addition! However, how would I see the cause of (f.e) a warning, once the breakpoint is hit?

[troizet]

how would I see the cause of (f.e) a warning, once the breakpoint is hit?

Unfortunately, there is no such opportunity at the moment.

[ErikKrause]

That's a pity. Is this planned?

[troizet]

Is this planned?

Yes, that's in the plans.