updated the code for 0.6.0 version

Author: imdj360

CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All notable changes to the XSLT Debugger extension will be documented in this file.
 
+## [0.6.0] - 2025
+
+### Added
+
+- Paired `template-entry`/`template-exit` instrumentation in both engines so call depth is tracked reliably.
+- Interactive console `StepIntoTest` highlights template markers while stepping through call-template scenarios.
+- Dedicated `StepIntoTests` suite covering step-into, step-over, and step-out flows for compiled and Saxon engines (115 tests total).
+
+### Changed
+
+- Step mode controller records the originating stop location to decide when `Step Over` and `Step Out` should halt.
+- Saxon instrumentation always emits probes for `xsl:call-template`, even when sibling probes exist, ensuring the line after the call is reachable.
+- Documentation references the 0.6.0 VSIX packages and explains the new stepping behaviour.
+
+### Fixed
+
+- `Step Over` no longer runs the Saxon engine to completion after an `xsl:call-template`; execution now pauses on the next statement.
+- `Step Out` consistently returns to the caller template thanks to call-depth unwinding and exit probes.
+
 ## [0.0.3] - 2025
 
 ### Fixed

README.md

@@ -106,10 +106,10 @@ These tradeoffs ensure reliable, cross-platform debugging without slowing down t
 
    ```bash
    # macOS
-   code --install-extension xsltdebugger-darwin-darwin-arm64-0.5.0.vsix
+   code --install-extension xsltdebugger-darwin-darwin-arm64-0.6.0.vsix
 
    # Windows
-   code --install-extension xsltdebugger-windows-win32-x64-0.5.0.vsix
+   code --install-extension xsltdebugger-windows-win32-x64-0.6.0.vsix
    ```
 
 2. **Create a debug configuration** in [.vscode/launch.json](#setting-up-a-debug-configuration)
@@ -138,19 +138,19 @@ These tradeoffs ensure reliable, cross-platform debugging without slowing down t
 
    ```bash
    ./package-all.sh
-   code --install-extension xsltdebugger-darwin-darwin-arm64-0.5.0.vsix
+   code --install-extension xsltdebugger-darwin-darwin-arm64-0.6.0.vsix
    ```
 
    **Platform-specific packaging** (build individually):
 
    ```bash
    # For macOS only
    ./package-darwin.sh
-   code --install-extension xsltdebugger-darwin-darwin-arm64-0.5.0.vsix
+   code --install-extension xsltdebugger-darwin-darwin-arm64-0.6.0.vsix
 
    # For Windows only
    ./package-win.sh
-   code --install-extension xsltdebugger-windows-win32-x64-0.5.0.vsix
+   code --install-extension xsltdebugger-windows-win32-x64-0.6.0.vsix
    ```
 
 ## Usage
@@ -417,47 +417,31 @@ The workflow is split between a lightweight VS Code entry point and a .NET debu
 
 See the [CHANGELOG](CHANGELOG.md) for detailed version history.
 
-### Latest Release: v0.5.0
+### Latest Release: v0.6.0
 
-**Step-Into Debugging Enhancement**
+**Reliable Stepping Across Engines**
 
-- Full support for stepping into named templates with `xsl:call-template`
-- F11 (Step Into) now correctly enters named templates with parameters
-- F10 (Step Over) executes template calls without stepping into them
-- Shift+F11 (Step Out) returns from the current template to the caller
-- Fixed template-entry breakpoint placement to respect XSLT 1.0 param ordering
-- Works with both Compiled engine (XSLT 1.0) and Saxon engine (XSLT 2.0/3.0)
-- Enhanced test coverage with 111 passing tests including step-into scenarios
+- Step Over (F10) now stops on the statement after `xsl:call-template` for both compiled and Saxon engines.
+- Step Out (Shift+F11) returns to the caller template using call-depth tracking and template exit probes.
+- Step Into (F11) continues to enter named templates with parameter handling intact.
+- Template entry/exit markers are emitted consistently so the debugger never “falls through” a nested call.
 
-**Test Infrastructure & Code Quality Improvements**
+**Instrumentation Fixes**
 
-- Centralized test data to `TestData/Integration/` folder at repository root for better organization
-- All test projects now reference common test data location
-- Enhanced test coverage with 111 passing integration and unit tests
-- Improved ConsoleTest project with unified engine support (both Compiled and Saxon)
+- Saxon instrumentation always plants probes for `xsl:call-template`, even when a sibling probe already exists.
+- Named templates receive paired `template-entry`/`template-exit` instrumentation to keep call depth accurate.
+- Guardrails ensure synthetic exit hits do not trigger user breakpoints.
 
-**Variable Debugging Enhancements**
+**Console & Test Coverage**
 
-- Enhanced variable instrumentation for both Compiled and Saxon engines
-- Improved variable capture and display in VS Code Variables panel
-- Better support for XSLT 2.0/3.0 variable debugging with Saxon engine
-- Added `CompiledMessageHandler` for enhanced compiled engine debugging
-- Fixed variable instrumentation to properly handle templates with parameters
+- Interactive console harness (`XsltDebugger.ConsoleTest/StepIntoTest.cs`) highlights template entry/exit markers while you step.
+- Added dedicated `StepIntoTests` verifying step-in/over/out scenarios for both engines.
+- Test suite now covers 115 scenarios (all green with `dotnet test`).
 
-**Engine Improvements**
+**Packaging**
 
-- Unified console testing with `ProgramUsingEngineType.cs` supporting both engines
-- Better breakpoint context information and handling
-- Enhanced xsl:message support for debugging output
-- Improved XSLT 2.0/3.0 features support including accumulators
-- Call depth tracking for proper step mode handling
-
-**Developer Experience**
-
-- Platform-specific packaging with optimized binary sizes
-- Updated build scripts for both macOS (darwin-arm64) and Windows (win32-x64)
-- Comprehensive integration tests for both engines
-- Better documentation and code organization
+- Updated docs/scripts for the 0.6.0 VSIX names on macOS and Windows.
+- `package-darwin.sh`/`package-win.sh` continue to run tests before producing platform-specific bundles.
 
 ## Contributing
 
@@ -523,8 +507,8 @@ Each packaging script:
 ./package-all.sh
 
 # Publish each as a separate extension
-vsce publish -p YOUR_TOKEN --packagePath xsltdebugger-darwin-darwin-arm64-0.5.0.vsix
-vsce publish -p YOUR_TOKEN --packagePath xsltdebugger-windows-win32-x64-0.5.0.vsix
+vsce publish -p YOUR_TOKEN --packagePath xsltdebugger-darwin-darwin-arm64-0.6.0.vsix
+vsce publish -p YOUR_TOKEN --packagePath xsltdebugger-windows-win32-x64-0.6.0.vsix
 ```
 
 **Benefits:**
@@ -550,7 +534,7 @@ XsltDebugger/
 │   ├── CompiledMessageHandler.cs  # Message handling for compiled engine
 │   ├── SaxonDebugExtension.cs     # Debug extension for Saxon
 │   └── XsltEngineManager.cs       # Engine state management
-├── XsltDebugger.Tests/            # C# integration & unit tests (105 tests)
+├── XsltDebugger.Tests/            # C# integration & unit tests (115 tests)
 │   ├── CompiledEngineIntegrationTests.cs
 │   ├── SaxonEngineIntegrationTests.cs
 │   └── [other test files]

XsltDebugger.DebugAdapter/SaxonEngine.cs

@@ -22,6 +22,10 @@ public class SaxonEngine : IXsltEngine
     private StepMode _stepMode = StepMode.Continue;
     private int _callDepth = 0;
     private int _targetDepth = 0;
+    private string _currentStopFile = string.Empty;
+    private int _currentStopLine = -1;
+    private string _stepOriginFile = string.Empty;
+    private int _stepOriginLine = -1;
     private Processor? _processor;
     private XsltTransformer? _transformer;
 
@@ -304,6 +308,8 @@ public Task StepOverAsync()
             _nextStepRequested = true;
             _stepMode = StepMode.Over;
             _targetDepth = _callDepth;
+            _stepOriginFile = _currentStopFile;
+            _stepOriginLine = _currentStopLine;
             _pauseTcs?.TrySetResult(true);
             _pauseTcs = null;
         }
@@ -317,6 +323,8 @@ public Task StepInAsync()
             _nextStepRequested = true;
             _stepMode = StepMode.Into;
             _targetDepth = _callDepth;
+            _stepOriginFile = string.Empty;
+            _stepOriginLine = -1;
             _pauseTcs?.TrySetResult(true);
             _pauseTcs = null;
         }
@@ -330,6 +338,8 @@ public Task StepOutAsync()
             _nextStepRequested = true;
             _stepMode = StepMode.Out;
             _targetDepth = _callDepth - 1; // Stop when we return to parent depth
+            _stepOriginFile = _currentStopFile;
+            _stepOriginLine = _currentStopLine;
             _pauseTcs?.TrySetResult(true);
             _pauseTcs = null;
         }
@@ -380,13 +390,13 @@ internal void RegisterBreakpointHit(string file, int line, XdmNode? contextNode
         }
 
         // Check if we should stop based on step mode
-        if (ShouldStopForStep(isTemplateExit))
+        if (ShouldStopForStep(normalized, line, isTemplateExit))
         {
             PauseForBreakpoint(normalized, line, DebugStopReason.Step, contextNode);
         }
     }
 
-    private bool ShouldStopForStep(bool isTemplateExit)
+    private bool ShouldStopForStep(string file, int line, bool isTemplateExit)
     {
         lock (_sync)
         {
@@ -409,8 +419,9 @@ private bool ShouldStopForStep(bool isTemplateExit)
                     break;
 
                 case StepMode.Over:
-                    // Stop once we return to the original depth (allow template exit to count)
-                    shouldStop = _callDepth <= _targetDepth;
+                    // Stop once we return to the original depth, but skip synthetic template exits
+                    shouldStop = !isTemplateExit && _callDepth <= _targetDepth &&
+                        (!string.Equals(file, _stepOriginFile, StringComparison.OrdinalIgnoreCase) || line != _stepOriginLine);
                     break;
 
                 case StepMode.Out:
@@ -625,6 +636,12 @@ private void PauseForBreakpoint(string file, int line, DebugStopReason reason, X
 
         XsltEngineManager.NotifyStopped(file, line, reason, navigator);
 
+        lock (_sync)
+        {
+            _currentStopFile = file;
+            _currentStopLine = line;
+        }
+
         try
         {
             localTcs?.Task.Wait();
@@ -786,14 +803,6 @@ private void InstrumentStylesheet(XDocument doc)
             }
             else
             {
-                var isCallTemplate = isXsltElement &&
-                    string.Equals(element.Name.LocalName, "call-template", StringComparison.OrdinalIgnoreCase);
-
-                if (!isCallTemplate && HasSiblingProbeBefore(element, debugNamespace))
-                {
-                    continue;
-                }
-
                 var siblingProbes = BuildProbesForElement(element, lineNumber, xsltNamespace, debugNamespace);
                 if (siblingProbes.Count == 0)
                 {

XsltDebugger.DebugAdapter/XsltCompiledEngine.cs

@@ -75,6 +75,10 @@ public class XsltCompiledEngine : IXsltEngine
     private StepMode _stepMode = StepMode.Continue;
     private int _callDepth = 0;
     private int _targetDepth = 0;
+    private string _currentStopFile = string.Empty;
+    private int _currentStopLine = -1;
+    private string _stepOriginFile = string.Empty;
+    private int _stepOriginLine = -1;
 
     public async Task StartAsync(string stylesheet, string xml, bool stopOnEntry)
     {
@@ -255,6 +259,8 @@ public Task StepOverAsync()
             _nextStepRequested = true;
             _stepMode = StepMode.Over;
             _targetDepth = _callDepth;
+            _stepOriginFile = _currentStopFile;
+            _stepOriginLine = _currentStopLine;
             _pauseTcs?.TrySetResult(true);
             _pauseTcs = null;
         }
@@ -268,6 +274,8 @@ public Task StepInAsync()
             _nextStepRequested = true;
             _stepMode = StepMode.Into;
             _targetDepth = _callDepth;
+            _stepOriginFile = string.Empty;
+            _stepOriginLine = -1;
             _pauseTcs?.TrySetResult(true);
             _pauseTcs = null;
         }
@@ -281,6 +289,8 @@ public Task StepOutAsync()
             _nextStepRequested = true;
             _stepMode = StepMode.Out;
             _targetDepth = _callDepth - 1; // Stop when we return to parent depth
+            _stepOriginFile = _currentStopFile;
+            _stepOriginLine = _currentStopLine;
             _pauseTcs?.TrySetResult(true);
             _pauseTcs = null;
         }
@@ -331,13 +341,13 @@ internal void RegisterBreakpointHit(string file, int line, XPathNavigator? conte
         }
 
         // Check if we should stop based on step mode
-        if (ShouldStopForStep(isTemplateExit))
+        if (ShouldStopForStep(normalized, line, isTemplateExit))
         {
             PauseForBreakpoint(normalized, line, DebugStopReason.Step, contextNode);
         }
     }
 
-    private bool ShouldStopForStep(bool isTemplateExit)
+    private bool ShouldStopForStep(string file, int line, bool isTemplateExit)
     {
         lock (_sync)
         {
@@ -360,8 +370,9 @@ private bool ShouldStopForStep(bool isTemplateExit)
                     break;
 
                 case StepMode.Over:
-                    // Stop once we return to the original depth (allow template exit to count)
-                    shouldStop = _callDepth <= _targetDepth;
+                    // Stop once we return to the original depth, but skip synthetic template exits
+                    shouldStop = !isTemplateExit && _callDepth <= _targetDepth &&
+                        (!string.Equals(file, _stepOriginFile, StringComparison.OrdinalIgnoreCase) || line != _stepOriginLine);
                     break;
 
                 case StepMode.Out:
@@ -411,6 +422,12 @@ private void PauseForBreakpoint(string file, int line, DebugStopReason reason, X
 
         XsltEngineManager.NotifyStopped(file, line, reason, context);
 
+        lock (_sync)
+        {
+            _currentStopFile = file;
+            _currentStopLine = line;
+        }
+
         try
         {
             localTcs?.Task.Wait();