Implements "Batch Rename" editor tool.

[bfloch]

Adds a very flexible way to rename multiple nodes at once. I badly needed this in the past. Hope you like it, too.

This is too late for 3.0 so maybe for 3.1? It should be feature complete but please test and read the TODO items at the bottom. I wanted to have this here for discussion before polishing the minimal remaining items.

Long Demo

https://www.dropbox.com/s/wxvhhobk4cc6h9v/batch_rename_overview.mp4?dl=0

(If the mp4 does not work let me know and I try to make a smaller gif)

Features

• Full undo support
• Search / Replace
• Adding of Prefix and Suffix
• Hidden advanced options for simplicity
• Substitution (optional):
  • Node Name
  • Node Parent Name
  • Node Type
  • Scene Name
  • Root Name
  • Counter
    • Per level (each children have their own counter)
    • Start, Step and 0-Padding
• Regular Expressions (optional)
• Post-Processing (optional)
  • CamelCase to under_lined and reveresed
  • to lowercase / UPPERCASE
• Live Preview with RegExp Error display
• Reset options

For discussion / TODO

• Possibly restore selection after rename.
• Missing documentation (if this gets accepted)
• Not using translation strings yet
• Missing Tool tips (especially for the substitutions)
• Fix build (compare comment below)
• Currently lives in editor. Could/Should this be an EditorPlugin? Can I still integrate it with the shortcuts etc? Have not check. Input welcome.
• Just noticed I called it under_lined but godot calls it underscored. Will fix this.
• The dialog could be lazily loaded, however I did not want to make the code more complex
• String offers a CamelCase to underscore (which does not normalize multiple __ btw.). I've implemented the reverese, might be something that can be added to the string itself.
• RegEx behaves strange:
  • Search: .*
  • Replace: Test
  • Result: TestTest
  • Expected: Test
  • It is fixed if ^.* is used instead. This is clearly how RegEx is working. Is there an option I am missing or is this expected?
• Needed to expose EditorSelection::get_selected_nodes as none of the other public methods would keep the order which is necessary for the counter. Hope that's ok.
• Had to expose: LineEdit::seleciton_delete in order to be able to insert text at the cursor (delete selection if something is selected). I think this one is harmless and useful to be public.

In future when I have the time I would like to write a separate tool that sorts nodes based on attributes (E.g. X position, Z order, Name, Type etc.) which would work hand in hand with this tool.

Let me know what you think. Thanks.

[bfloch]

Will get rid of the comment. Sorry.

[bfloch]

Will need to address this:
https://travis-ci.org/godotengine/godot/jobs/331387384#L1618

editor/rename_dialog.cpp:370:44: error: 'Control::FocusMode' is not a class or namespace
  but_insert_count->set_focus_mode(Control::FocusMode::FOCUS_NONE);

[groud]

Hum why not, the tool seems obviously useful but in quite rare and specific cases.
IMHO, I think it would be better to make it a plugin than a part of the editor itself.

[Zephilinox]

Does this also rename node paths in gdscript?

[blurymind]

looks very useful!!

[bfloch]

Thanks for the feedback so far.
@Zephilinox No. But I am using the same renaming function as the regular rename. Meaning if in future someone contributes the work this tool will benefit, too. In my understanding it is not a trivial task to solve. I do believe the current code does take care of references in AnimationPlayer though.

@groud I will look into moving it. I hope that I can still use the shortcut/context menu entry with a PluginEditor.

[groud]

I hope that I can still use the shortcut/context menu entry with a PluginEditor.

If it's a problem later on, we can make this possible :)

[bfloch]

Cleaned up minor issues, added translation strings, tooltips, fixed the build.

I looked into the EditorPlugin. I think this mostly boils down to #6128
Wrapping the dialog into an editor plugin should be the easy part. I just wonder about the benefit until the context menu api exists, since the base-code pollution is pretty minimal as is. Are there other benefits I can not see?

I am not sure about the regex. I'll leave it as expected behaviour.

Not sure if under_score to CamelCase should be moved up to String class. Input welcome.

The only important one I see is restoring the selection (which probably gets lost by the renaming itself).
I hope that it can be fixed by a deferred call to restore the initial selection. Not sure what this implies.
If this does not work than I'll leave it for now. It is a minor defect.

[reduz]

This seems fine to me, if @akien-mga approves, should be able to merge

[bfloch]

Thanks. I just checked it against the latest master. Seems to still work fine.

[akien-mga]

Thanks, looks good! I also think it might be better eventually as an editor plugin, but there might indeed be some features missing from EditorPlugin to do it fully, and since it's a self contained class, it doesn't hurt to add it as is for now.

[bfloch]

Agreed, @akien-mga
I will hook up to the EditorPlugin tickets and will migrate it once its possible.
Thanks for the feedback.