Loading indicator is now a context manager

Author: ndahn

hkb_editor/gui/beh_editor.py

@@ -53,6 +53,7 @@
 from .widgets.graph_widget import GraphWidget, HorizontalGraphLayout, Node
 from .widgets.attributes_widget import AttributesWidget
 from .widgets.graphmap import GraphMap  # TODO
+from .widgets import loading_indicator
 from .dialogs import (
     about_dialog,
     open_file_dialog,
@@ -81,7 +82,7 @@
 from .workflows.duplicate_clipcat import duplicate_clipcat_dialog
 from .workflows.fix_common_problems import fix_common_problems_dialog
 from .workflows.verify_behavior import verify_behavior
-from .helpers import make_copy_menu, center_window, common_loading_indicator
+from .helpers import make_copy_menu, center_window
 from . import style
 
 
@@ -104,7 +105,6 @@ def emit(this, record):
         logging.root.addHandler(LogHandler())
 
         self.beh: HavokBehavior = None
-        self._busy = False
         self.alias_manager = AliasManager()
         self.attributes_widget: AttributesWidget = None
         self.pinned_objects_table: str = None
@@ -300,21 +300,12 @@ def file_save_as(self) -> bool:
         return False
 
     def _do_write_to_file(self, file_path):
-        if self._busy:
-            return
-
-        self._busy = True
-        loading = common_loading_indicator("Saving")
-
-        try:
+        with loading_indicator("Saving"):
             if self.config.save_backups:
                 shutil.copy(self.beh.file, self.beh.file + ".backup")
 
             self.beh.save_to_file(file_path)
             self.logger.info(f"Saved to {file_path}")
-        finally:
-            dpg.delete_item(loading)
-            self._busy = False
 
     def _locate_witchy(self) -> str:
         if not self.config.witchy_exe or not os.path.isfile(self.config.witchy_exe):
@@ -343,14 +334,8 @@ def _locate_hklib(self) -> str:
         return self.config.hklib_exe
 
     def _reload_character(self) -> None:
-        if self._busy:
-            return
-
-        self._busy = True
         chr = self.beh.get_character_id()
-        loading = common_loading_indicator(f"Reloading {chr}...")
-
-        try:
+        with loading_indicator(f"Reloading {chr}..."):
             if not self.chr_reloader:
                 if ChrReloader:
                     game_config = detect_game_config()
@@ -359,33 +344,20 @@ def _reload_character(self) -> None:
                     raise RuntimeError("ChrReloader is not available")
 
             self.chr_reloader.reload_character(chr)
-        finally:
-            dpg.delete_item(loading)
-            self._busy = False
 
     def _repack_binder(self) -> None:
-        if self._busy:
-            return
-
-        self._busy = True
-
         # Locate external tools
         self._locate_witchy()
         self._locate_hklib()
 
-        loading = common_loading_indicator("Repacking binder...")
-
-        try:
+        with loading_indicator("Repacking binder..."):
             self.logger.info("Saving XML...")
             self.file_save()
             self.logger.info("Converting XML to HKX...")
             xml_to_hkx(self.beh.file)
             self.logger.info("Repacking Binder...")
             pack_binder(self.beh.file)
             self.logger.info("Done!")
-        finally:
-            dpg.delete_item(loading)
-            self._busy = False
 
     def exit_app(self):
         if not self.beh or self.beh.top_undo_id() == self.last_save_undo_id:
@@ -2217,19 +2189,10 @@ def open_mirror_skeleton_dialog(self):
         skeleton_mirror_dialog(self.loaded_skeleton_path, tag=tag)
 
     def verify_behavior(self):
-        if self._busy:
-            return
-
-        self._busy = True
-        loading = common_loading_indicator("Validating behavior...")
-
-        try:
+        with loading_indicator("Validating behavior...")
             verify_behavior(self.beh)
             # TODO summary dialog?
             logging.info("Validation complete, check log for results!")
-        finally:
-            dpg.delete_item(loading)
-            self._busy = False
 
     def open_apply_template_dialog(self, template_file: str):
         tag = f"{self.tag}_apply_template_dialog"

hkb_editor/gui/widgets/__init__.py

@@ -1,5 +1,6 @@
 from .attributes_widget import AttributesWidget
 from .graph_widget import GraphWidget
+from .loading_indicator import loading_indicator
 from .multilist import add_multilist
 from .rotation_knob import RotationKnob
 from .editable_table import add_widget_table, add_simple_items_table, add_filepaths_table

hkb_editor/gui/widgets/loading_indicator.py

@@ -0,0 +1,36 @@
+from typing import Generator
+from contextlib import contextmanager
+from dearpygui import dearpygui as dpg
+
+from hkb_editor.gui import style
+
+
+@contextmanager
+def loading_indicator(
+    label: str, color: style.RGBA = style.red
+) -> Generator[str, None, None]:
+    try:
+        dpg.split_frame()
+
+        with dpg.window(
+            modal=True,
+            min_size=(50, 20),
+            no_close=True,
+            no_move=True,
+            no_collapse=True,
+            no_title_bar=True,
+            no_resize=True,
+            no_scroll_with_mouse=True,
+            no_scrollbar=True,
+            no_saved_settings=True,
+        ) as dialog:
+            with dpg.group(horizontal=True):
+                dpg.add_loading_indicator(color=color)
+                with dpg.group():
+                    dpg.add_spacer(height=5)
+                    dpg.add_text(label, tag=f"{dialog}_label")
+
+        yield dialog
+    finally:
+        if dpg.does_item_exist(dialog):
+            dpg.delete_item(dialog)

hkb_editor/gui/workflows/clone_hierarchy.py

@@ -1,4 +1,4 @@
-from typing import Any, Callable, Generic, TypeVar
+from typing import Callable, Generic, TypeVar
 import logging
 from dataclasses import dataclass, field
 import re
@@ -12,7 +12,6 @@
 from hkb_editor.hkb.xml import (
     xml_from_str,
     add_type_comments,
-    make_element,
     make_subelement,
 )
 from hkb_editor.hkb.behavior import HavokBehavior, HkbVariable
@@ -25,7 +24,8 @@
 from hkb_editor.hkb import HkbPointer, HkbRecord, HkbArray, XmlValueHandler
 from hkb_editor.hkb.type_registry import TypeMismatch
 from hkb_editor.gui import style
-from hkb_editor.gui.helpers import common_loading_indicator, add_paragraphs
+from hkb_editor.gui.widgets import loading_indicator
+from hkb_editor.gui.helpers import add_paragraphs
 
 
 T = TypeVar("T")
@@ -352,11 +352,8 @@ def paste_hierarchy(
             f"Could not map object type {root_type} ({root_type_name}) to a known type ID"
         )
 
-    loading = common_loading_indicator("Analyzing hierarchy")
-    try:
+    with loading_indicator("Analyzing hierarchy"):
         results = find_conflicts(behavior, xmldoc, target_record)
-    finally:
-        dpg.delete_item(loading)
 
     def add_objects():
         new_root: HkbRecord = results.objects[results.root_id].result
@@ -462,12 +459,9 @@ def add_children():
         raise ValueError("Not a valid behavior hierarchy")
 
     # Search for conflicts
-    loading = common_loading_indicator("Analyzing hierarchy")
-    try:
+    with loading_indicator("Analyzing hierarchy"):
         results = find_conflicts(behavior, xmldoc, target_record)
         results.objects[results.root_id].action = MergeAction.IGNORE
-    finally:
-        dpg.delete_item(loading)
 
     # Let the user decide what to transfer, or just transfer everything
     if interactive:
@@ -1028,15 +1022,11 @@ def update_action(sender: str, action: str, resolution: Resolution):
         resolution.action = MergeAction[action]
 
     def resolve():
-        loading = common_loading_indicator("Merging Hierarchy")
-        try:
+        with loading_indicator("Merging Hierarchy"):
             with behavior.transaction():
                 resolve_conflicts(behavior, target_record, results)
                 results.pin_objects = dpg.get_value(f"{tag}_pin_objects")
                 callback()
-        finally:
-            dpg.delete_item(loading)
-            close()
 
     def close():
         if graph_preview:

hkb_editor/gui/workflows/fix_common_problems.py

@@ -4,10 +4,10 @@
 
 from hkb_editor.hkb import HavokBehavior, HkbArray, HkbPointer
 from hkb_editor.templates.common import Animation
+from hkb_editor.gui.widgets import loading_indicator
 from hkb_editor.gui.helpers import (
     center_window,
     add_paragraphs,
-    common_loading_indicator,
 )
 from hkb_editor.gui import style
 
@@ -116,9 +116,7 @@ def show_message(msg: str = None, color: style.RGBA = style.red) -> None:
 
     def on_okay():
         show_message()
-        loading = common_loading_indicator("Fixing")
-
-        try:
+        with loading_indicator("Fixing"):
             with behavior.transaction():
                 fixes = 0
                 if dpg.get_value(f"{tag}_array_null_pointers"):
@@ -139,11 +137,6 @@ def on_okay():
 
             if callback:
                 callback(tag, fixes, user_data)
-        except Exception:
-            show_message("Error fixing behavior, check terminal!")
-            raise
-        finally:
-            dpg.delete_item(loading)
 
     # Dialog content
     with dpg.window(