Confirm with user when formatting in a debug session

Formatting a file while debugging causes the highlighting of the source
code from the debugger to disappear and there's no way (that I've found)
to get it back.

With this change, we confirm with the user via a dialog whether they
really want to format while debugging.

Author: zaneduffield

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 * Support for updating breakpoints and bookmarks after the buffer rewrite.
+* Confirmation prompt for formatting while debugging.
 
 ## [0.1.0] - 2025-02-20
 

Pasfmt.FormatEditor.pas

@@ -25,7 +25,9 @@ implementation
   Winapi.ActiveX,
   Vcl.AxCtrls,
   Pasfmt.Log,
-  System.StrUtils;
+  System.StrUtils,
+  Vcl.Dialogs,
+  System.UITypes;
 
 //______________________________________________________________________________________________________________________
 
@@ -73,9 +75,19 @@ procedure SetBufferViewMessages(Buffer: IOTAEditBuffer; Msg: string);
 
 //______________________________________________________________________________________________________________________
 
+function ConfirmFormatWhileDebugging: Boolean;
+begin
+  Result :=
+      MessageDlg('Formatting will disrupt debugging in this file. Continue?', mtWarning, [mbOK, mbCancel], 0, mbCancel)
+          = mrOK;
+end;
+
+//______________________________________________________________________________________________________________________
+
 procedure TEditBufferFormatter.Format(Buffer: IOTAEditBuffer);
 var
   SourceEditor: IOTAEditorContent;
+  DebuggerServices: IOTADebuggerServices;
   Cursors: TCursors;
 begin
   if not Supports(Buffer, IOTAEditorContent, SourceEditor) then begin
@@ -85,6 +97,13 @@ procedure TEditBufferFormatter.Format(Buffer: IOTAEditBuffer);
   else if Buffer.IsReadOnly then begin
     Log.Debug('Format request ignored: "%s" is read-only', [Buffer.FileName]);
     Exit;
+  end
+  else if Supports(BorlandIDEServices, IOTADebuggerServices, DebuggerServices)
+      and Assigned(DebuggerServices.CurrentProcess)
+      and not ConfirmFormatWhileDebugging then
+  begin
+    Log.Debug('Format request ignored: debugger is running and user has cancelled');
+    Exit;
   end;
 
   SetBufferViewMessages(Buffer, 'Formatting...');

Pasfmt.Main.pas

@@ -207,6 +207,7 @@ procedure TPlugin.OnFormatKeyPress(
     var BindingResult: TKeyBindingResult
 );
 begin
+  BindingResult := krHandled;
   Format;
 end;