dynamically indent comments in decompiler view

[williballenthin]

Is your feature request related to a problem? Please describe. The decompiler view emits comments at a static indent level. When code is nested at various levels, such as with if or while blocks, then indentation changes, and comments don't line up with other source code.

Describe the solution you'd like For the indentation of comments to match that of the surrounding source code.

Additional context

static comment indentation configuration:

example showing comments not lining up with surrounding source code:

[alexander-pick]

This is a very good request, I second that. If you have spaghetti functions with lot of indentation to analyze the comments sometimes make the code even less readable if they stay at the fixed indention level. A dynamic placement would greatly improve the readability.

[goatshriek]

I've created #3472 to implement this. The screenshot below shows how it appears in the decompiler view and tool options:

It's set to a default of 'off' in order to match current functionality, though personally I think it makes more sense to start with it on by default. I'm happy to switch it to be on by default.

Of course I can make whatever other updates are needed, but want to get feedback before I go too far down into something. I've also included tests for existing functionality as well as the new feature's functionality.

[voltangle]

Any updates on this? I would love to see this feature in Ghidra :)

[goatshriek]

I haven't tested my changes in quite a while, and it looks like there are now conflicts that need to be resolved. I'm hesitant to put any more time into this though, particularly since this isn't my only PR to this repo that is stuck in purgatory.