tool extends EditorPlugin const DockScene := preload("res://addons/Todo_Manager/UI/Dock.tscn") const Dock := preload("res://addons/Todo_Manager/Dock.gd") const Todo := preload("res://addons/Todo_Manager/todo_class.gd") const TodoItem := preload("res://addons/Todo_Manager/todoItem_class.gd") var _dockUI : Dock #var update_thread : Thread = Thread.new() var script_cache : Array var remove_queue : Array var combined_pattern : String var refresh_lock := false # makes sure _on_filesystem_changed only triggers once func _enter_tree() -> void: _dockUI = DockScene.instance() as Control add_control_to_bottom_panel(_dockUI, "TODO") connect("resource_saved", self, "check_saved_file") get_editor_interface().get_resource_filesystem().connect("filesystem_changed", self, "_on_filesystem_changed") get_editor_interface().get_file_system_dock().connect("file_removed", self, "queue_remove") get_editor_interface().get_script_editor().connect("editor_script_changed", self, "_on_active_script_changed") _dockUI.plugin = self combined_pattern = combine_patterns(_dockUI.patterns) find_tokens_from_path(find_scripts()) _dockUI.build_tree() func _exit_tree() -> void: _dockUI.create_config_file() remove_control_from_bottom_panel(_dockUI) _dockUI.queue_free() func queue_remove(file: String): for i in _dockUI.todo_items.size() - 1: if _dockUI.todo_items[i].script_path == file: _dockUI.todo_items.remove(i) func find_tokens_from_path(scripts: Array) -> void: for script_path in scripts: var file := File.new() file.open(script_path, File.READ) var contents := file.get_as_text() file.close() find_tokens(contents, script_path) func find_tokens_from_script(script: Resource) -> void: find_tokens(script.source_code, script.resource_path) func find_tokens(text: String, script_path: String) -> void: var regex = RegEx.new() # if regex.compile("#\\s*\\bTODO\\b.*|#\\s*\\bHACK\\b.*") == OK: if regex.compile(combined_pattern) == OK: var result : Array = regex.search_all(text) if result.empty(): for i in _dockUI.todo_items.size(): if _dockUI.todo_items[i].script_path == script_path: _dockUI.todo_items.remove(i) return # No tokens found var match_found : bool var i := 0 for todo_item in _dockUI.todo_items: if todo_item.script_path == script_path: match_found = true var updated_todo_item := update_todo_item(todo_item, result, text, script_path) _dockUI.todo_items.remove(i) _dockUI.todo_items.insert(i, updated_todo_item) break i += 1 if !match_found: _dockUI.todo_items.append(create_todo_item(result, text, script_path)) func create_todo_item(regex_results: Array, text: String, script_path: String) -> TodoItem: var todo_item = TodoItem.new() todo_item.script_path = script_path var last_line_number := 0 var lines := text.split("\n") for r in regex_results: var new_todo : Todo = create_todo(r.get_string(), script_path) new_todo.line_number = get_line_number(r.get_string(), text, last_line_number) # GD Multiline comment var trailing_line := new_todo.line_number var should_break = false while trailing_line < lines.size() and lines[trailing_line].dedent().begins_with("#"): for other_r in regex_results: if lines[trailing_line] in other_r.get_string(): should_break = true break if should_break: break new_todo.content += "\n" + lines[trailing_line] trailing_line += 1 last_line_number = new_todo.line_number todo_item.todos.append(new_todo) return todo_item func update_todo_item(todo_item: TodoItem, regex_results: Array, text: String, script_path: String) -> TodoItem: todo_item.todos.clear() var lines := text.split("\n") for r in regex_results: var new_todo : Todo = create_todo(r.get_string(), script_path) new_todo.line_number = get_line_number(r.get_string(), text) # GD Multiline comment var trailing_line := new_todo.line_number var should_break = false while trailing_line < lines.size() and lines[trailing_line].dedent().begins_with("#"): for other_r in regex_results: if lines[trailing_line] in other_r.get_string(): should_break = true break if should_break: break new_todo.content += "\n" + lines[trailing_line] trailing_line += 1 todo_item.todos.append(new_todo) return todo_item func get_line_number(what: String, from: String, start := 0) -> int: what = what.split('\n')[0] # Match first line of multiline C# comments var temp_array := from.split('\n') var lines := Array(temp_array) var line_number# = lines.find(what) + 1 for i in range(start, lines.size()): if what in lines[i]: line_number = i + 1 # +1 to account of 0-based array vs 1-based line numbers break else: line_number = 0 # This is an error return line_number func check_saved_file(script: Resource) -> void: # print(script) pass # if _dockUI.auto_refresh: # if script is Script: # find_tokens_from_script(script) # _dockUI.build_tree() func _on_filesystem_changed() -> void: if !refresh_lock: if _dockUI.auto_refresh: refresh_lock = true _dockUI.get_node("Timer").start() rescan_files() func find_scripts() -> Array: var scripts : Array var directory_queue : Array var dir : Directory = Directory.new() ### FIRST PHASE ### if dir.open("res://") == OK: get_dir_contents(dir, scripts, directory_queue) else: printerr("TODO_Manager: There was an error during find_scripts() ### First Phase ###") ### SECOND PHASE ### while not directory_queue.empty(): if dir.change_dir(directory_queue[0]) == OK: get_dir_contents(dir, scripts, directory_queue) else: printerr("TODO_Manager: There was an error at: " + directory_queue[0]) directory_queue.pop_front() cache_scripts(scripts) return scripts func cache_scripts(scripts: Array) -> void: for script in scripts: if not script_cache.has(script): script_cache.append(script) func get_dir_contents(dir: Directory, scripts: Array, directory_queue: Array) -> void: dir.list_dir_begin(true, true) var file_name : String = dir.get_next() while file_name != "": if dir.current_is_dir(): if file_name == ".import" or filename == ".mono": # Skip .import folder which should never have scripts pass else: directory_queue.append(dir.get_current_dir() + "/" + file_name) else: if file_name.ends_with(".gd") or file_name.ends_with(".cs"): if dir.get_current_dir() == "res://": scripts.append(dir.get_current_dir() + file_name) else: scripts.append(dir.get_current_dir() + "/" + file_name) file_name = dir.get_next() func rescan_files() -> void: _dockUI.todo_items.clear() script_cache.clear() combined_pattern = combine_patterns(_dockUI.patterns) find_tokens_from_path(find_scripts()) _dockUI.build_tree() func combine_patterns(patterns: Array) -> String: if patterns.size() == 1: return patterns[0][0] else: # var pattern_string : String var pattern_string := "((\\/\\*)|(#|\\/\\/))\\s*(" for i in range(patterns.size()): if i == 0: pattern_string += patterns[i][0] else: pattern_string += "|" + patterns[i][0] pattern_string += ")(?(2)[\\s\\S]*?\\*\\/|.*)" # if i == 0: ## pattern_string = "#\\s*" + patterns[i][0] + ".*" # pattern_string = "((\\/\\*)|(#|\\/\\/))\\s*" + patterns[i][0] + ".*" # (?(2)[\\s\\S]*?\\*\\/|.*) # else: ## pattern_string += "|" + "#\\s*" + patterns[i][0] + ".*" # pattern_string += "|" + "((\\/\\*)|(#|\\/\\/))\\s*" + patterns[i][0] + ".*" return pattern_string func create_todo(todo_string: String, script_path: String) -> Todo: var todo := Todo.new() var regex = RegEx.new() for pattern in _dockUI.patterns: if regex.compile(pattern[0]) == OK: var result : RegExMatch = regex.search(todo_string) if result: todo.pattern = pattern[0] todo.title = result.strings[0] else: continue else: printerr("Error compiling " + pattern[0]) todo.content = todo_string todo.script_path = script_path return todo func _on_active_script_changed(script) -> void: if _dockUI: if _dockUI.tabs.current_tab == 1: _dockUI.build_tree()