[GDScript] Add refactor rename symbol functionality

[adamscott]

Warning

For this moment, this PR is public for testing purposes. Work is still done to it to iron out issues.
Use at your own risk AND always backup before trying out new features.

This PR adds the refactor rename symbol functionality to the GDScript code editor inside the Godot editor.

To use this feature, just click on the desired symbol to rename and press F2 on your keyboard. You can also use the contextual menu (right click) or use the entry in the Edit menu.

Fixes godotengine/godot-proposals#899

[ZanyaNova]

Really hoping this becomes a thing! I'm terrible with naming things correctly on my first pass.

[HolonProduction]

• When using this in an unsaved file the changes get mixed up with the code from disk.
• Doesn't seem to work for constants and signals at all at the moment
• Doesn't pick up usages as type hint:

class Test:
	pass

var with_type: Test

• The following scenario with two scripts:

# a.gd
extends Node
class_name Test1

const SIZE_EXPAND = 1

static var USUAL = 2

# b.gd
extends Node

func ready(delta: float) -> void:
	Test1.SIZE_EXPAND # Renaming SIZE_EXPAND will modify b.gd but not a.gd
	Test1.USUAL # Renaming USUAL will modify a.gd but not b.gd
	pass

Without having looked at the implementation: Collecting all usages and replacing them needs to happen in two passes, or the change might destroy references that can not be found anymore.

• Shadowing:

extends Node

var delta: float # Renaming delta will rename the parameter name as well but not the usages
func test(delta: float): # Renaming delta will change the occurence in print but not the standalone occurence
	print(delta) # Renaming delta will change the parameter name but not the standalone occurence
	delta # Renaming delta will change the parameter name and the occurence in print but not the standalone occurence

[BenjaTK]

Could a 'Match Case' functionality be considered for this? Something like renaming test to test_renamed also changes TEST to TEST_RENAMED, Test to TestRenamed, etc.?

[adamscott]

Could a 'Match Case' functionality be considered for this? Something like renaming test to test_renamed also changes TEST to TEST_RENAMED, Test to TestRenamed, etc.?

I don't understand.

[BenjaTK]

Could a 'Match Case' functionality be considered for this? Something like renaming test to test_renamed also changes TEST to TEST_RENAMED, Test to TestRenamed, etc.?

I don't understand.

See IntelliJ IDEA for example.

If you rename the class MyClass to YourClass:

Before

class_name MyClass

[...]

var my_class = MyClass.new()

After

class_name YourClass

[...]

var your_class = YourClass.new()