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.

Sign up for GitHub

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

Jump to bottom

Impossible to use symbols as a comment marker #96472

Open
SorielXD opened this issue Sep 2, 2024 · 3 comments · May be fixed by #96566
Open

Impossible to use symbols as a comment marker #96472

SorielXD opened this issue Sep 2, 2024 · 3 comments · May be fixed by #96566
Labels
discussion documentation topic:editor topic:gdscript

Comments

@SorielXD
Copy link

SorielXD commented Sep 2, 2024

Tested versions

  • 4.3.stable

System information

Godot v4.3.stable - Windows 10.0.22631 - GLES3 (Compatibility) - Intel(R) Iris(R) Xe Graphics (Intel Corporation; 31.0.101.5186) - 12th Gen Intel(R) Core(TM) i7-1255U (12 Threads)

Issue description

It seems the text editor does not support, symbols (such as : §, ?, !, !!) as comment marker
image

The comment doesn't use the corresponding color and keep the normal comment color compared to a comment marker with letters and numbers
image

Steps to reproduce

  1. Open the customisation parameters of the text editor (Editor Settings -> Text Editor -> Theme)
  2. Set the theme to Custom
  3. Add symbols to the list (there are at the end)
  4. Comment with these symbols

Minimal reproduction project (MRP)

N/A
@bruvzg
Copy link
Member

bruvzg commented Sep 2, 2024

Currently, markers names follow the same rules as GDScript identifiers: should starts with XID_Start class character or "_", and may contain only XID_Continue class characters.

@SorielXD
Copy link
Author

SorielXD commented Sep 2, 2024

@bruvzg I see, but then i think it should be mention in the description (the actual description is blank) or have some kind of warning because it feel just weird like this.

@dalexeev
Copy link
Member

dalexeev commented Sep 3, 2024 •
edited
Loading

I can confirm that during the work on #79761 this limitation was intended. It is done to speed up comment marker searches using a hashmap. Yes, the limitation should be documented, we just need to move EDITOR_DEFs so the DocTools system can detect the setting.

should starts with XID_Start class character or "_", and may contain only XID_Continue class characters.

No, it only uses is_unicode_identifier_continue(). I'm not sure how important this is from a Unicode standards perspective.

godot/modules/gdscript/editor/gdscript_highlighter.cpp

Lines 205 to 231 in 8120e03

if (color_regions[in_region].is_comment) {
int marker_start_pos = from;
int marker_len = 0;
while (from <= line_length) {
if (from < line_length && is_unicode_identifier_continue(str[from])) {
marker_len++;
} else {
if (marker_len > 0) {
HashMap<String, CommentMarkerLevel>::ConstIterator E = comment_markers.find(str.substr(marker_start_pos, marker_len));
if (E) {
Dictionary marker_highlighter_info;
marker_highlighter_info["color"] = comment_marker_colors[E->value];
color_map[marker_start_pos] = marker_highlighter_info;
Dictionary marker_continue_highlighter_info;
marker_continue_highlighter_info["color"] = region_color;
color_map[from] = marker_continue_highlighter_info;
}
}
marker_start_pos = from + 1;
marker_len = 0;
}
from++;
}
from = line_length - 1;
j = from;
} else {

@dalexeev dalexeev linked a pull request Sep 4, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
discussion documentation topic:editor topic:gdscript
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Editor: Document comment marker editor settings dalexeev/godot
4 participants
@bruvzg @dalexeev @AThousandShips @SorielXD