From 01baadf1a9c61543beac031690153f8a804e9722 Mon Sep 17 00:00:00 2001 From: Omri SirComp Date: Sat, 16 May 2026 19:29:55 +0300 Subject: [PATCH 1/2] Document Data Editor debug launch options --- doc/Wiki.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/doc/Wiki.md b/doc/Wiki.md index 21c3edaae..ad536e0a4 100644 --- a/doc/Wiki.md +++ b/doc/Wiki.md @@ -294,7 +294,15 @@ Once the `launch.json` file has been created it will look something like this "type": "file", "path": "${workspaceFolder}/infoset.xml" }, - "debugServer": 4711 + "debugServer": 4711, + "openDataEditor": false, + "dataEditor": { + "port": 9000, + "logging": { + "file": "", + "level": "info" + } + } } ``` @@ -314,10 +322,20 @@ This default configuration will prompt the user to select the DFDL Schema and da "type": "file", "path": "${workspaceFolder}/infoset.xml" }, - "debugServer": 4711 + "debugServer": 4711, + "openDataEditor": true, + "dataEditor": { + "port": 9000, + "logging": { + "file": "", + "level": "info" + } + } } ``` +Set `openDataEditor` to `true` to open the Data Editor when the debug session starts. The `dataEditor` settings configure the Ωedit server port and Data Editor logging. Leave `logging.file` empty to use the default OS app-data/XDG log location, or set it to a specific log file path. The launch config wizard also exposes these settings as **Open Data Editor**, **omega-edit Port**, **Log File**, and **Log Level**. + ## Dropdown for Log Level A dropdown list has been added in the launch config wizard under Log Level settings. There are four different options to select including DEBUG, INFO, WARNING, ERROR, and CRITICAL. @@ -342,6 +360,8 @@ In the launch.json file, there's a new suggestion mode that gives you suggestion Using the launch profile above a `DFDL parse: My Data` menu item at the top of the `Run and Debug` pane (Command-Shift-D) will display. Then press the `play` button to start the debugging session. +If `openDataEditor` is enabled, the Data Editor opens the configured input data file at the start of the debug session. + In the Terminal, log output from the DFDL debugger backend service will display. If something is not working as expected, check the output in this Terminal window for hints. The DFDL Schema file will also be loaded in VS Code and there should be a visible marking at the beginning where the debugger has paused upon entry to the debugging session. Control the debugger using the available VS Code debugger controls such as `setting breakpoints`, `removing breakpoints`, `continue`, `step over`, `step into`, and `step out`. @@ -372,6 +392,8 @@ From left to right, the icons indicate the following functions: Continue, Step O * The Restart button will stop the current execution and begin again from the beginning. * The Stop button will immediately terminate and abort all processing. +When the Data Editor is open during a debug session, it tracks the parser location in the input data. As the debugger pauses on entry, steps through the schema, or stops at breakpoints, the Data Editor highlights the corresponding byte position so the schema, infoset, and input data can be compared together. +
Debug Control Examples If you were parsing a JPEG file and reached the APP0 Marker, your temporary infoset file would look like this: From 855c2d9afd6d9c88660b29710f8a133c102c9e9e Mon Sep 17 00:00:00 2001 From: Omri SirComp Date: Sun, 17 May 2026 11:38:07 +0300 Subject: [PATCH 2/2] Address Data Editor doc review --- doc/Wiki.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/Wiki.md b/doc/Wiki.md index ad536e0a4..b20826d61 100644 --- a/doc/Wiki.md +++ b/doc/Wiki.md @@ -334,7 +334,7 @@ This default configuration will prompt the user to select the DFDL Schema and da } ``` -Set `openDataEditor` to `true` to open the Data Editor when the debug session starts. The `dataEditor` settings configure the Ωedit server port and Data Editor logging. Leave `logging.file` empty to use the default OS app-data/XDG log location, or set it to a specific log file path. The launch config wizard also exposes these settings as **Open Data Editor**, **omega-edit Port**, **Log File**, and **Log Level**. +Set `openDataEditor` to `true` to open the Data Editor when the debug session starts. The `dataEditor` settings configure the Ωedit server port and Data Editor logging. Leave `logging.file` empty to use the default OS app-data/XDG log location, or set it to a specific log file path. For the Ωedit server, `logging.level` accepts `trace`, `debug`, `info`, `warn`, `warning`, `error`, `fatal`, and `critical`. The launch config wizard also exposes these settings as **Open Data Editor**, **omega-edit Port**, **Log File**, and **Log Level**. ## Dropdown for Log Level A dropdown list has been added in the launch config wizard under Log Level settings. There are four different options to select including DEBUG, INFO, WARNING, ERROR, and CRITICAL. @@ -360,7 +360,7 @@ In the launch.json file, there's a new suggestion mode that gives you suggestion Using the launch profile above a `DFDL parse: My Data` menu item at the top of the `Run and Debug` pane (Command-Shift-D) will display. Then press the `play` button to start the debugging session. -If `openDataEditor` is enabled, the Data Editor opens the configured input data file at the start of the debug session. +If `openDataEditor` is enabled, the Data Editor opens the configured input data file at the start of the debug session. For a DFDL debug session, that file comes from the debug launch target, so the Data Editor does not prompt for a separate file selection. In the Terminal, log output from the DFDL debugger backend service will display. If something is not working as expected, check the output in this Terminal window for hints.