Make comments starting with #mark and #region visible in Script Editor's Minimap

[vaner-org]

Closes #9742.
Allows comments starting with #mark and #region to be visible as text in the Script Editor's Minimap.

Draft progress:

• #mark Description support
• #region Description support
• Increased line height
• Respect indentation
• Accurate visible area rectangle
• Minimap overflow
• Script editor overflow
• Accurate viewport offset
• Accurate hovering and dragging
• Unique syntax highlighting for #mark, managed via Editor setting
• Override color with comment marker colors (Critical, Warning, Notice)

Trying to commit to as few files as possible until I work through this. Any feedback is welcome.

[RedMser]

Thanks for contributing!

Note that you are likely implementing this in the "wrong" place, since TextEdit is not only used for code (as well as the need to support other programming languages).
The hard-coded #mark string will likely cause problems.

To begin, a quick overview of the relevant class hierarchy, as I understand it:

• TextEdit is a class that game projects can also use, which is primarily intended for general-purpose multi-line text editing.
• A sub-class CodeEdit is specialized at editing code of any kind (not just GDScript code). Also exposed for use in game projects.
• Editor-only classes like CodeTextEditor, TextEditor, ScriptTextEditor, or ScriptEditor, are where most script editor features are implemented. I can't really tell you their differences, or which one is best suited for which tasks.

My recommendation on how the implementation should look (not saying it's The Way, but I think it's at least better than how you're doing it):

• Since the minimap is part of TextEdit, there should be a new general-purpose API like TextEdit.set_line_minimap_mark(line: int, mark: String) and a corresponding get function. This allows anyone in any project to insert a readable text in the minimap, without depending on the text content. Might need a clear_minimap_marks() function as well, for when the text editor contents are replaced, to avoid having to loop over all line indices.
• In CodeEdit, you add a new property minimap_mark_strings: Array[String]. If a commented line is found (using is_in_comment maybe?), all of these strings in the array are checked one by one, and if any is matching, then the remaining text of the line is automatically treated as a minimap mark and uses the TextEdit API to register it.
• Godot's Script Editor code (not sure which file is best for this responsibility) would then fill this new property's value, e.g. based on an EditorSetting (defaults to ["mark"]).

I think an approach like this would make it most flexible for end users, while still providing the same functionality as what is proposed.

Of course, you could think to skip the CodeEdit API and directly have the script editor call the new TextEdit APIs.
But it doesn't seem to reduce complexity, while making the feature unavailable to more projects.

[vaner-org]

Thank you, this is exactly the kind of guidance I was hoping for. Currently getting my bearings, once I feel comfortable with the feature set, I will rebuild my commit with all of this in mind.

[enetheru]

I see changes being pushed, you gotta add some setting in there somewhere.
I dont want to have type multiple types of marks to get the headings showing up in different editors, so being able to change settings to allow the pre-existing conventions of MARK: at any indentation, with the remainder of the line being used for the heading would be how I want to set things up.

[vaner-org]

See Calinou's comment in the proposal. I'm in agreement with him, and would prefer to follow convention. In your case, isn't this the responsibility of CodeGlance Pro when they add GDscript support? Same as they do for other languages.