Code Editor 2: "Auto-indent clipboard content" inserts tabs where they don't belong

[DragoniteSpam]

Description

I'm not sure if this is the same bug as #5356 or not, which looks like it has to do with curly brace behavior

When you paste code into an area with the same indentation level as the place where it came from, extra tabs get added

This doesn't happen if the Auto Indent setting is turned off

Expected Change

No response

Steps To Reproduce

1. Start GameMaker
4. See the issue

How reliably can you recreate this issue using your steps above?

Always

Which version of GameMaker are you reporting this issue for?

2024.600 (Betas)

Which operating system(s) are you seeing the problem on?

Windows 10

Are you running GameMaker from inside your Steam library?

No

Contact Us Package Attached?

• I have attached my Contact Us Package

Sample Project Added?

• I have included a small sample project

[DragoniteSpam]

Tabs also behave badly if you paste single strings mid-line. This is probably the same bug but it might not be.

Once again, it doesn't do this if the Auto Indent setting is turned off.

edit: I misspelled "snowman" didn't I

[zreedy]

Fixed. See #6243 for details

[caitlinrmcintyre]

Reopening as I'm still seeing a similar issue in IDE v2024.1100.0.624 Runtime v2024.1100.0.650, thanks.

[caitlinrmcintyre]

Following the same steps as reported, this was the result I got.

Here's the code to repro:

static GetRelevantSprite = function(direction) {
    // prioritize the up/down directions
    if (direction < 45 || direction > 315) return self.sprite_right; 
    if (direction <= 135) return self.sprite_up;
    if (direction < 225) return self.sprite_up;
    return self.sprite_down;
};

[zreedy]

I'm not sure this issue is fully resolvable without a full fat pretty printer. The current heuristic is that the clipboard contents are reformatted to the local indentation level by calculating the indent delta from the first line of the clipboard contents and the insertion line. This works well if the clipboard contents are fully qualified (i.e. the leading whitespace is preserved on all lines). However, if the first line's whitespace is missing and subsequent lines preserve their indentation there is no way to recover the missing indentation for the delta calculation. Any assumption you make will inevitably be wrong in some context.

The only solution is to completely dismiss any indentation in the clipboard contents and run them through a pretty printer in context of the insertion line. This is what the old implementation did, however the old implementation relied on our single-line indentation pretty printer which is not a full fat pretty printer and is incapable of calculating indentation appropriately for all styles that users might want (or even correct indentation for BSD-style in some cases).

The only solution I can see for now is to simply disable this feature until a full fat pretty printer is developed.

For documentation purposes I have attempted the following alternative heuristics to no success in all contexts.
Contexts (based on the above code, starting from just that code):

1. Insert new line on line 1 + Paste lines [2, 5] on line 1
2. Insert new line on line 7 + Paste lines [1, 7] on line 8
3. Insert new line on line 6 + Insert 1 tab on line 7 + Paste lines [2, 5] on line 7

Heuristics (IL is Resolve Indentation Level for string, TS is Resolve Terminal Tab Stop via in-context single-line pretty printer):

• newTabStop = IL(docLines[insertLine]), oldTabStop = IL(clipboardLines[0])
  • oldTabStop = IL(clipboardLines[0]) or if 0 then max(0, TS(docLines[insertLine]))
  • oldTabStop = IL(clipboardLines[0]) or if 0 then max(0, TS(docLines[insertLine + 1]))
  • oldTabStop = IL(clipboardLines[0]) or if 0 then max(0, TS(docLines[insertLine + 1]) - TS(docLines[insertLine]))
• tabDeltaExt calculated per line > 0 given TS(docLines[insertLine + i]) after insertion in context -> tabDelta - tabDeltaExt
• indent = GEN(IL(docLines[i]) + TS(clipboardLines[i]) + tabDelta)
• indent = GEN(IL(docLines[i]) + TS(clipboardLines[i]) + tabDelta - tabDeltaExt)
• All heuristics from group 1 with greedy preservation of existing indentation (best case coverage)

None of these have successfully handled all 3 contexts.

[gnysek]

Until there's no pretty printer, same results as CE1 (if it's possible) would be enough. We're used for years to how it works, so would be good if there's no change here.

[zreedy]

This feature has temporarily been removed due to the above stated reasons.

[alicemoretti]

Verified on IDE v9.9.1.900 Runtime v9.9.1.1044.
The option to "Auto indent clipboard content" has been removed.
Thank you.