Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add /waitfordebugger argument to MGCB. #8227

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from

Conversation

dellis1972
Copy link
Contributor

The call to System.Diagnostics.Debugger.Launch is not supported on Unix based platforms. This makes
debugging MGCB.exe and Content Pipeline extensions difficult.

So lets add a new argument which will make MGCB.exe wait for a debugger to attach. Also add a extra
update to the launch.json to demonstrate how to
attach the dotnet debugger to an existing process.

This new system will also work on Windows.

To use this in VSCode you can add the following to the launch.json

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Attach to Process",
            "type": "coreclr",
            "request": "attach",
            "processId": "${input.processid}",
        }
    ],
    "inputs": [
        {
            "id": "processid",
            "type": "promptString",
            "default": "0",
            "description": "Enter Process Id of process to attach to."
        }
    ]
}

you can then add the following to your csproj.

<MonoGameMGCBAdditionalArguments>/waitfordebugger</MonoGameMGCBAdditionalArguments>

This will cause the MGCB.exe to print the ProcessId to the console during the build and wait for the debugger to attach. Once you have the ProcessId you can run the VSCode Attach to Process and enter the ProcessId when prompted. The debugger should then attach.

If you want to prcess without attaching the debugger just hit any key in the console or terminal windows where MGCB.exe is running.

The call to `System.Diagnostics.Debugger.Launch` is
not supported on Unix based platforms. This makes
debugging `MGCB.exe` and Content Pipeline extensions
difficult.

So lets add a new argument which will make `MGCB.exe`
wait for a debugger to attach. Also add a extra
update to the `launch.json` to demonstrate how to
attach the `dotnet` debugger to an existing process.

This new system will also work on Windows.

To use this in VSCode you can add the following to the
`launch.json`

```json
{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Attach to Process",
            "type": "coreclr",
            "request": "attach",
            "processId": "${input.processid}",
        }
    ],
    "inputs": [
        {
            "id": "processid",
            "type": "promptString",
            "default": "0",
            "description": "Enter Process Id of process to attach to."
        }
    ]
}
```

you can then add the following to your `csproj`.

```
<MonoGameMGCBAdditionalArguments>/waitfordebugger</MonoGameMGCBAdditionalArguments>
```

This will cause the `MGCB.exe` to print the ProcessId
to the console during the build and wait for the debugger
to attach. Once you have the ProcessId you can run the
VSCode `Attach to Process` and enter the ProcessId when prompted.
The debugger should then attach.

If you want to prcess without attaching the debugger just hit any
key in the console or terminal windows where `MGCB.exe` is running.
@dellis1972 dellis1972 marked this pull request as ready for review April 7, 2024 18:04
{
var currentProcess = Process.GetCurrentProcess();
Console.WriteLine($"Waiting for debugger to attach ({currentProcess.MainModule.FileName} PID {currentProcess.Id}). Press any key to continue without debugger.");
while (!Debugger.IsAttached) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Braces should be be in new lines.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants