298 lines
10 KiB
GDScript3
298 lines
10 KiB
GDScript3
|
@tool
|
||
|
|
extends Control
|
||
|
|
|
||
|
|
#signal tree_built # used for debugging
|
||
|
|
enum { CASE_INSENSITIVE, CASE_SENSITIVE }
|
||
|
|
|
||
|
|
const Project := preload("res://addons/Todo_Manager/Project.gd")
|
||
|
|
const Current := preload("res://addons/Todo_Manager/Current.gd")
|
||
|
|
|
||
|
|
const Todo := preload("res://addons/Todo_Manager/todo_class.gd")
|
||
|
|
const TodoItem := preload("res://addons/Todo_Manager/todoItem_class.gd")
|
||
|
|
const ColourPicker := preload("res://addons/Todo_Manager/UI/ColourPicker.tscn")
|
||
|
|
const Pattern := preload("res://addons/Todo_Manager/UI/Pattern.tscn")
|
||
|
|
const DEFAULT_PATTERNS := [["\\bTODO\\b", Color("96f1ad"), CASE_INSENSITIVE], ["\\bHACK\\b", Color("d5bc70"), CASE_INSENSITIVE], ["\\bFIXME\\b", Color("d57070"), CASE_INSENSITIVE]]
|
||
|
|
const DEFAULT_SCRIPT_COLOUR := Color("ccced3")
|
||
|
|
const DEFAULT_SCRIPT_NAME := false
|
||
|
|
const DEFAULT_SORT := true
|
||
|
|
|
||
|
|
var plugin : EditorPlugin
|
||
|
|
|
||
|
|
var todo_items : Array
|
||
|
|
|
||
|
|
var script_colour := Color("ccced3")
|
||
|
|
var ignore_paths : Array[String] = []
|
||
|
|
var full_path := false
|
||
|
|
var auto_refresh := true
|
||
|
|
var builtin_enabled := false
|
||
|
|
var _sort_alphabetical := true
|
||
|
|
|
||
|
|
var patterns := [["\\bTODO\\b", Color("96f1ad"), CASE_INSENSITIVE], ["\\bHACK\\b", Color("d5bc70"), CASE_INSENSITIVE], ["\\bFIXME\\b", Color("d57070"), CASE_INSENSITIVE]]
|
||
|
|
|
||
|
|
|
||
|
|
@onready var tabs := $VBoxContainer/TabContainer as TabContainer
|
||
|
|
@onready var project := $VBoxContainer/TabContainer/Project as Project
|
||
|
|
@onready var current := $VBoxContainer/TabContainer/Current as Current
|
||
|
|
@onready var project_tree := $VBoxContainer/TabContainer/Project/Tree as Tree
|
||
|
|
@onready var current_tree := $VBoxContainer/TabContainer/Current/Tree as Tree
|
||
|
|
@onready var settings_panel := $VBoxContainer/TabContainer/Settings as Panel
|
||
|
|
@onready var colours_container := $VBoxContainer/TabContainer/Settings/ScrollContainer/MarginContainer/VBoxContainer/HBoxContainer3/Colours as VBoxContainer
|
||
|
|
@onready var pattern_container := $VBoxContainer/TabContainer/Settings/ScrollContainer/MarginContainer/VBoxContainer/HBoxContainer4/Patterns as VBoxContainer
|
||
|
|
@onready var ignore_textbox := $VBoxContainer/TabContainer/Settings/ScrollContainer/MarginContainer/VBoxContainer/VBoxContainer/HBoxContainer2/Scripts/IgnorePaths/TextEdit as LineEdit
|
||
|
|
@onready var auto_refresh_button := $VBoxContainer/TabContainer/Settings/ScrollContainer/MarginContainer/VBoxContainer/HBoxContainer5/Patterns/RefreshCheckButton as CheckButton
|
||
|
|
|
||
|
|
func _ready() -> void:
|
||
|
|
load_config()
|
||
|
|
populate_settings()
|
||
|
|
|
||
|
|
|
||
|
|
func build_tree() -> void:
|
||
|
|
if tabs:
|
||
|
|
match tabs.current_tab:
|
||
|
|
0:
|
||
|
|
project.build_tree(todo_items, ignore_paths, patterns, plugin.cased_patterns, _sort_alphabetical, full_path)
|
||
|
|
create_config_file()
|
||
|
|
1:
|
||
|
|
current.build_tree(get_active_script(), patterns, plugin.cased_patterns)
|
||
|
|
create_config_file()
|
||
|
|
2:
|
||
|
|
pass
|
||
|
|
_:
|
||
|
|
pass
|
||
|
|
|
||
|
|
|
||
|
|
func get_active_script() -> TodoItem:
|
||
|
|
var current_script : Script = plugin.get_editor_interface().get_script_editor().get_current_script()
|
||
|
|
if current_script:
|
||
|
|
var script_path = current_script.resource_path
|
||
|
|
for todo_item in todo_items:
|
||
|
|
if todo_item.script_path == script_path:
|
||
|
|
return todo_item
|
||
|
|
|
||
|
|
# nothing found
|
||
|
|
var todo_item := TodoItem.new(script_path, [])
|
||
|
|
return todo_item
|
||
|
|
else:
|
||
|
|
# not a script
|
||
|
|
var todo_item := TodoItem.new("res://Documentation", [])
|
||
|
|
return todo_item
|
||
|
|
|
||
|
|
|
||
|
|
func go_to_script(script_path: String, line_number : int = 0) -> void:
|
||
|
|
if plugin.get_editor_interface().get_editor_settings().get_setting("text_editor/external/use_external_editor"):
|
||
|
|
var exec_path = plugin.get_editor_interface().get_editor_settings().get_setting("text_editor/external/exec_path")
|
||
|
|
var args := get_exec_flags(exec_path, script_path, line_number)
|
||
|
|
OS.execute(exec_path, args)
|
||
|
|
else:
|
||
|
|
var script := load(script_path)
|
||
|
|
plugin.get_editor_interface().edit_resource(script)
|
||
|
|
plugin.get_editor_interface().get_script_editor().goto_line(line_number - 1)
|
||
|
|
|
||
|
|
func get_exec_flags(editor_path : String, script_path : String, line_number : int) -> PackedStringArray:
|
||
|
|
var args : PackedStringArray
|
||
|
|
var script_global_path = ProjectSettings.globalize_path(script_path)
|
||
|
|
|
||
|
|
if editor_path.ends_with("code.cmd") or editor_path.ends_with("code"): ## VS Code
|
||
|
|
args.append(ProjectSettings.globalize_path("res://"))
|
||
|
|
args.append("--goto")
|
||
|
|
args.append(script_global_path + ":" + str(line_number))
|
||
|
|
|
||
|
|
elif editor_path.ends_with("rider64.exe") or editor_path.ends_with("rider"): ## Rider
|
||
|
|
args.append("--line")
|
||
|
|
args.append(str(line_number))
|
||
|
|
args.append(script_global_path)
|
||
|
|
|
||
|
|
else: ## Atom / Sublime
|
||
|
|
args.append(script_global_path + ":" + str(line_number))
|
||
|
|
|
||
|
|
return args
|
||
|
|
|
||
|
|
func sort_alphabetical(a, b) -> bool:
|
||
|
|
if a.script_path > b.script_path:
|
||
|
|
return true
|
||
|
|
else:
|
||
|
|
return false
|
||
|
|
|
||
|
|
func sort_backwards(a, b) -> bool:
|
||
|
|
if a.script_path < b.script_path:
|
||
|
|
return true
|
||
|
|
else:
|
||
|
|
return false
|
||
|
|
|
||
|
|
|
||
|
|
func populate_settings() -> void:
|
||
|
|
for i in patterns.size():
|
||
|
|
## Create Colour Pickers
|
||
|
|
var colour_picker: Variant = ColourPicker.instantiate()
|
||
|
|
colour_picker.colour = patterns[i][1]
|
||
|
|
colour_picker.title = patterns[i][0]
|
||
|
|
colour_picker.index = i
|
||
|
|
colours_container.add_child(colour_picker)
|
||
|
|
colour_picker.colour_picker.color_changed.connect(change_colour.bind(i))
|
||
|
|
|
||
|
|
## Create Patterns
|
||
|
|
var pattern_edit: Variant = Pattern.instantiate()
|
||
|
|
pattern_edit.text = patterns[i][0]
|
||
|
|
pattern_edit.index = i
|
||
|
|
pattern_container.add_child(pattern_edit)
|
||
|
|
pattern_edit.line_edit.text_changed.connect(change_pattern.bind(i,
|
||
|
|
colour_picker))
|
||
|
|
pattern_edit.remove_button.pressed.connect(remove_pattern.bind(i,
|
||
|
|
pattern_edit, colour_picker))
|
||
|
|
pattern_edit.case_checkbox.button_pressed = patterns[i][2]
|
||
|
|
pattern_edit.case_checkbox.toggled.connect(case_sensitive_pattern.bind(i))
|
||
|
|
|
||
|
|
var pattern_button := $VBoxContainer/TabContainer/Settings/ScrollContainer/MarginContainer/VBoxContainer/HBoxContainer4/Patterns/AddPatternButton
|
||
|
|
$VBoxContainer/TabContainer/Settings/ScrollContainer/MarginContainer/VBoxContainer/HBoxContainer4/Patterns.move_child(pattern_button, 0)
|
||
|
|
|
||
|
|
# path filtering
|
||
|
|
var ignore_paths_field := ignore_textbox
|
||
|
|
if not ignore_paths_field.is_connected("text_changed", _on_ignore_paths_changed):
|
||
|
|
ignore_paths_field.connect("text_changed", _on_ignore_paths_changed)
|
||
|
|
var ignore_paths_text := ""
|
||
|
|
for path in ignore_paths:
|
||
|
|
ignore_paths_text += path + ", "
|
||
|
|
ignore_paths_text = ignore_paths_text.trim_suffix(", ")
|
||
|
|
ignore_paths_field.text = ignore_paths_text
|
||
|
|
|
||
|
|
auto_refresh_button.button_pressed = auto_refresh
|
||
|
|
|
||
|
|
|
||
|
|
func rebuild_settings() -> void:
|
||
|
|
for node in colours_container.get_children():
|
||
|
|
node.queue_free()
|
||
|
|
for node in pattern_container.get_children():
|
||
|
|
if node is Button:
|
||
|
|
continue
|
||
|
|
node.queue_free()
|
||
|
|
populate_settings()
|
||
|
|
|
||
|
|
|
||
|
|
#### CONFIG FILE ####
|
||
|
|
func create_config_file() -> void:
|
||
|
|
var config = ConfigFile.new()
|
||
|
|
config.set_value("scripts", "full_path", full_path)
|
||
|
|
config.set_value("scripts", "sort_alphabetical", _sort_alphabetical)
|
||
|
|
config.set_value("scripts", "script_colour", script_colour)
|
||
|
|
config.set_value("scripts", "ignore_paths", ignore_paths)
|
||
|
|
|
||
|
|
config.set_value("patterns", "patterns", patterns)
|
||
|
|
|
||
|
|
config.set_value("config", "auto_refresh", auto_refresh)
|
||
|
|
config.set_value("config", "builtin_enabled", builtin_enabled)
|
||
|
|
|
||
|
|
var err = config.save("res://addons/Todo_Manager/todo.cfg")
|
||
|
|
|
||
|
|
|
||
|
|
func load_config() -> void:
|
||
|
|
var config := ConfigFile.new()
|
||
|
|
if config.load("res://addons/Todo_Manager/todo.cfg") == OK:
|
||
|
|
full_path = config.get_value("scripts", "full_path", DEFAULT_SCRIPT_NAME)
|
||
|
|
_sort_alphabetical = config.get_value("scripts", "sort_alphabetical", DEFAULT_SORT)
|
||
|
|
script_colour = config.get_value("scripts", "script_colour", DEFAULT_SCRIPT_COLOUR)
|
||
|
|
ignore_paths = config.get_value("scripts", "ignore_paths", [] as Array[String])
|
||
|
|
patterns = config.get_value("patterns", "patterns", DEFAULT_PATTERNS)
|
||
|
|
auto_refresh = config.get_value("config", "auto_refresh", true)
|
||
|
|
builtin_enabled = config.get_value("config", "builtin_enabled", false)
|
||
|
|
else:
|
||
|
|
create_config_file()
|
||
|
|
|
||
|
|
|
||
|
|
#### Events ####
|
||
|
|
func _on_SettingsButton_toggled(button_pressed: bool) -> void:
|
||
|
|
settings_panel.visible = button_pressed
|
||
|
|
if button_pressed == false:
|
||
|
|
create_config_file()
|
||
|
|
# plugin.find_tokens_from_path(plugin.script_cache)
|
||
|
|
if auto_refresh:
|
||
|
|
plugin.rescan_files(true)
|
||
|
|
|
||
|
|
func _on_Tree_item_activated() -> void:
|
||
|
|
var item : TreeItem
|
||
|
|
match tabs.current_tab:
|
||
|
|
0:
|
||
|
|
item = project_tree.get_selected()
|
||
|
|
1:
|
||
|
|
item = current_tree.get_selected()
|
||
|
|
if item.get_metadata(0) is Todo:
|
||
|
|
var todo : Todo = item.get_metadata(0)
|
||
|
|
call_deferred("go_to_script", todo.script_path, todo.line_number)
|
||
|
|
else:
|
||
|
|
var todo_item = item.get_metadata(0)
|
||
|
|
call_deferred("go_to_script", todo_item.script_path)
|
||
|
|
|
||
|
|
func _on_FullPathCheckBox_toggled(button_pressed: bool) -> void:
|
||
|
|
full_path = button_pressed
|
||
|
|
|
||
|
|
func _on_ScriptColourPickerButton_color_changed(color: Color) -> void:
|
||
|
|
script_colour = color
|
||
|
|
|
||
|
|
func _on_RescanButton_pressed() -> void:
|
||
|
|
plugin.rescan_files(true)
|
||
|
|
|
||
|
|
func change_colour(colour: Color, index: int) -> void:
|
||
|
|
patterns[index][1] = colour
|
||
|
|
|
||
|
|
func change_pattern(value: String, index: int, this_colour: Node) -> void:
|
||
|
|
patterns[index][0] = value
|
||
|
|
this_colour.title = value
|
||
|
|
plugin.rescan_files(true)
|
||
|
|
|
||
|
|
func remove_pattern(index: int, this: Node, this_colour: Node) -> void:
|
||
|
|
patterns.remove_at(index)
|
||
|
|
this.queue_free()
|
||
|
|
this_colour.queue_free()
|
||
|
|
plugin.rescan_files(true)
|
||
|
|
|
||
|
|
func case_sensitive_pattern(active: bool, index: int) -> void:
|
||
|
|
if active:
|
||
|
|
patterns[index][2] = CASE_SENSITIVE
|
||
|
|
else:
|
||
|
|
patterns[index][2] = CASE_INSENSITIVE
|
||
|
|
plugin.rescan_files(true)
|
||
|
|
|
||
|
|
func _on_DefaultButton_pressed() -> void:
|
||
|
|
patterns = DEFAULT_PATTERNS.duplicate(true)
|
||
|
|
_sort_alphabetical = DEFAULT_SORT
|
||
|
|
script_colour = DEFAULT_SCRIPT_COLOUR
|
||
|
|
full_path = DEFAULT_SCRIPT_NAME
|
||
|
|
rebuild_settings()
|
||
|
|
plugin.rescan_files(true)
|
||
|
|
|
||
|
|
func _on_AlphSortCheckBox_toggled(button_pressed: bool) -> void:
|
||
|
|
_sort_alphabetical = button_pressed
|
||
|
|
plugin.rescan_files(true)
|
||
|
|
|
||
|
|
func _on_AddPatternButton_pressed() -> void:
|
||
|
|
patterns.append(["\\bplaceholder\\b", Color.WHITE, CASE_INSENSITIVE])
|
||
|
|
rebuild_settings()
|
||
|
|
|
||
|
|
func _on_RefreshCheckButton_toggled(button_pressed: bool) -> void:
|
||
|
|
auto_refresh = button_pressed
|
||
|
|
|
||
|
|
func _on_Timer_timeout() -> void:
|
||
|
|
plugin.refresh_lock = false
|
||
|
|
|
||
|
|
func _on_ignore_paths_changed(new_text: String) -> void:
|
||
|
|
var text = ignore_textbox.text
|
||
|
|
var split: Array = text.split(',')
|
||
|
|
ignore_paths.clear()
|
||
|
|
for elem in split:
|
||
|
|
if elem == " " || elem == "":
|
||
|
|
continue
|
||
|
|
ignore_paths.push_front(elem.lstrip(' ').rstrip(' '))
|
||
|
|
# validate so no empty string slips through (all paths ignored)
|
||
|
|
var i := 0
|
||
|
|
for path in ignore_paths:
|
||
|
|
if (path == "" || path == " "):
|
||
|
|
ignore_paths.remove_at(i)
|
||
|
|
i += 1
|
||
|
|
plugin.rescan_files(true)
|
||
|
|
|
||
|
|
func _on_TabContainer_tab_changed(tab: int) -> void:
|
||
|
|
build_tree()
|
||
|
|
|
||
|
|
func _on_BuiltInCheckButton_toggled(button_pressed: bool) -> void:
|
||
|
|
builtin_enabled = button_pressed
|
||
|
|
plugin.rescan_files(true)
|