Improve sorting of Code Completion options.

[EricEzaM]

Continuation of #58931.

Updated after rebasing on top of #59553 as the two had some compatibility issues (and that PR took precedence). Has now been updated to be compatible, and also incorporated the comments @reduz left on #58931. Most notably, the sorting logic is now in the editor code where it belongs.

Closes godotengine/godot-proposals#4189
Closes godotengine/godot-proposals#99

Please read above proposal for more info and some example of what code completion currently looks like.
After changes in this PR:

Code Overview:

• Add location property to ScriptCodeCompletionOption. It is an int, but has a corresponding enum, and more importantly one of the enum values is a mask, LOCATION_PARENT_MASK = (1 << 8),. This allows you, for example, to sort closer ancestors differently from more distant ancestors. The class itself will be value 256, while the class it inherits will have its location at 257, and then its parent at 258, etc.
• When creating options, pass a location. This can be easily calculated if the options are created in a loop, where the loop is looping over parent classes and getting the class info for them. const int location = classes_processed | ScriptCodeCompletionOption::LOCATION_PARENT_MASK;
• When you have all the options, simply sort on location. The lowest values will be highest priority. If two locations are the same, sort alphanumerically. The order in which different ScriptCodeCompletionOption::Kind's are sorted has been added too.

[EricEzaM]

I was not sure if here you would prefer location to be optional:

if (op.has("location)){
    option.location = op["location'];
}

So I just followed what was already there. Using ERR_CONTINUE makes it mandatory to provide.

[reduz]

I think its ok to enforce it

[novaplusplus]

I'm assuming/praying that this PR will fix things like this...?

Drives me crazy 😵‍💫

[EricEzaM]

Yes, it should. That item will still be suggested but it will be much further down the list.

[EricEzaM]

@novaplusplus Actually I just tested, doesnt look like it will help with that specific scenario (assigning a built-in type to a variable). Interestingly "float" does not come up as an option at all. That appears to be an issue which is outside of the scope of this PR though.

[reduz]

I think its ok to enforce it

[reduz]

I would probably be put as an enum of ScriptLanguage and bind it in ScriptLanguageExtension like the other enums, so the extensions can have access to it. Otherwise you dont know what they are from it.

[novaplusplus]

@novaplusplus Actually I just tested, doesnt look like it will help with that specific scenario (assigning a built-in type to a variable). Interestingly "float" does not come up as an option at all. That appears to be an issue which is outside of the scope of this PR though.

That's a shame... maybe there's another issue or PR already made about this. It's quite frustrating - if I were to hit "enter" at the time of that screenshot, it would have automatically replaced "float" with "AudioEffectLowPassFilter", which is just beyond absurd...

[Calinou]

That's a shame... maybe there's another issue or PR already made about this. It's quite frustrating - if I were to hit "enter" at the time of that screenshot, it would have automatically replaced "float" with "AudioEffectLowPassFilter", which is just beyond absurd...

Remember that you can change the completion accept shortcuts in master to only complete suggestions when pressing Tab, not Enter. This makes autocompletion significantly less intrusive in my experience. I'd like to make this the default in 4.0, but a lot of people are used to only using Enter for autocompletion nowadays (since this is the default in VS Code and other IDEs).

[akien-mga]

Thanks!

[dmaz]

there is a pr for the built-in types... was out of sync and should now be ready
#59594