moved status handling (xml) to separate plugin

pycam/Gui/Project.py

@@ -46,7 +46,6 @@ import pycam.Utils
 import pycam.Plugins
 from pycam import VERSION
 import pycam.Physics.ode_physics
-import pycam.Utils.xml_handling
 
 GTKBUILD_FILE = "pycam-project.ui"
 GTKMENU_FILE = "menubar.xml"
@@ -303,29 +302,6 @@ class EventCore(pycam.Gui.Settings.Settings):
         else:
             log.debug("Called an unknown chain: %s" % name)
 
-    def dump_state(self):
-        result = []
-        for plugin in self.get("plugin-manager").get_plugins():
-            if plugin.enabled:
-                plugin.dump_state(result)
-        root = ET.Element("pycam")
-        for match, element in result:
-            chain = match.split("/")
-            if not hasattr(element, "findtext"):
-                # not an instance of ET.Element
-                element = pycam.Utils.xml_handling.get_xml(element, chain[-1])
-            parent = root
-            if match:
-                for component in chain[:-1]:
-                    next_item = parent.find(component)
-                    if not next_item is None:
-                        parent = next_item
-                    else:
-                        item = ET.SubElement(parent, component)
-                        parent = item
-            parent.append(element)
-        return os.linesep.join(pycam.Utils.xml_handling.get_xml_lines(root))
-
     def reset_state(self):
         pass
 
@@ -392,9 +368,6 @@ class ProjectGui(object):
         self.last_model_uri = None
         # define callbacks and accelerator keys for the menu actions
         for objname, callback, data, accel_key in (
-                ("LoadTaskSettings", self.load_task_settings_file, None, "<Control>t"),
-                ("SaveTaskSettings", self.save_task_settings_file, lambda: self.last_task_settings_uri, None),
-                ("SaveAsTaskSettings", self.save_task_settings_file, None, None),
                 ("OpenModel", self.load_model_file, None, "<Control>o"),
                 ("Quit", self.destroy, None, "<Control>q"),
                 ("GeneralSettings", self.toggle_preferences_window, None, "<Control>p"),
@@ -538,37 +511,6 @@ class ProjectGui(object):
                 clear_main_window)
         self.settings.register_ui("main_window", "Tabs", main_tab, -20,
                 args_dict={"expand": True, "fill": True})
-        # autoload task settings file on startup
-        autoload_enable = self.gui.get_object("AutoLoadTaskFile")
-        autoload_box = self.gui.get_object("StartupTaskFileBox")
-        autoload_source = self.gui.get_object("StartupTaskFile")
-        # TODO: fix the extension filter
-        #for one_filter in get_filters_from_list(FILTER_CONFIG):
-        #    autoload_source.add_filter(one_filter)
-        #    autoload_source.set_filter(one_filter)
-        def get_autoload_task_file(autoload_source=autoload_source):
-            if autoload_enable.get_active():
-                return autoload_source.get_filename()
-            else:
-                return ""
-        def set_autoload_task_file(filename):
-            if filename:
-                autoload_enable.set_active(True)
-                autoload_box.show()
-                autoload_source.set_filename(filename)
-            else:
-                autoload_enable.set_active(False)
-                autoload_box.hide()
-                autoload_source.unselect_all()
-        def autoload_enable_switched(widget, box):
-            if not widget.get_active():
-                set_autoload_task_file(None)
-            else:
-                autoload_box.show()
-        autoload_enable.connect("toggled", autoload_enable_switched,
-                autoload_box)
-        self.settings.add_item("default_task_settings_file",
-                get_autoload_task_file, set_autoload_task_file)
         def disable_gui():
             self.menubar.set_sensitive(False)
             main_tab.set_sensitive(False)
@@ -692,9 +634,6 @@ class ProjectGui(object):
         # control would not be updated in time.
         while gtk.events_pending():
             gtk.main_iteration()
-        autoload_task_filename = self.settings.get("default_task_settings_file")
-        if autoload_task_filename:
-            self.open_task_settings_file(autoload_task_filename)
         self.update_all_controls()
         self.no_dialog = no_dialog
         if not self.no_dialog:
@@ -976,27 +915,6 @@ class ProjectGui(object):
         while self._undo_states:
             self._undo_states.pop(0)
 
-    def open_task_settings_file(self, filename):
-        """ This function is used by the commandline handler """
-        self.last_task_settings_uri = pycam.Utils.URIHandler(filename)
-        self.load_task_settings_file(filename=filename)
-
-    @gui_activity_guard
-    def load_task_settings_file(self, widget=None, filename=None):
-        if callable(filename):
-            filename = filename()
-        if not filename:
-            filename = self.settings.get("get_filename_func")("Loading settings ...",
-                    mode_load=True, type_filter=FILTER_CONFIG)
-            # Only update the last_task_settings attribute if the task file was
-            # loaded interactively. E.g. ignore the initial task file loading.
-            if filename:
-                self.last_task_settings_uri = pycam.Utils.URIHandler(filename)
-        if filename:
-            log.info("Loading task settings file: %s" % str(filename))
-            self.load_task_settings(filename)
-            self.add_to_recent_file_list(filename)
-
     def load_model(self, model):
         # load the new model only if the import worked
         if model:
@@ -1007,41 +925,6 @@ class ProjectGui(object):
         else:
             return False
 
-    def load_task_settings(self, filename=None):
-        settings = pycam.Gui.Settings.ProcessSettings()
-        if not filename is None:
-            settings.load_file(filename)
-        # flush all tables (without re-assigning new objects)
-        for one_list_name in ("tools", "processes", "bounds", "tasks"):
-            one_list = self.settings.get(one_list_name)
-            while one_list:
-                one_list.pop()
-        # TODO: load default tools/processes/bounds
-
-    @gui_activity_guard
-    def save_task_settings_file(self, widget=None, filename=None):
-        if callable(filename):
-            filename = filename()
-        if not isinstance(filename, (basestring, pycam.Utils.URIHandler)):
-            # we open a dialog
-            filename = self.settings.get("get_filename_func")("Save settings to ...",
-                    mode_load=False, type_filter=FILTER_CONFIG,
-                    filename_templates=(self.last_task_settings_uri, self.last_model_uri))
-            if filename:
-                self.last_task_settings_uri = pycam.Utils.URIHandler(filename)
-        # no filename given -> exit
-        if not filename:
-            return
-        settings = self.settings.dump_state()
-        try:
-            out_file = open(filename, "w")
-            out_file.write(settings)
-            out_file.close()
-            log.info("Task settings written to %s" % filename)
-            self.add_to_recent_file_list(filename)
-        except IOError:
-            log.error("Failed to save settings file")
-
     def add_to_recent_file_list(self, filename):
         # Add the item to the recent files list - if it already exists.
         # Otherwise it will be added later after writing the file.

pycam/Plugins/StatusManager.py

+# -*- coding: utf-8 -*-
+"""
+$Id$
+
+Copyright 2011 Lars Kruse <devel@sumpfralle.de>
+
+This file is part of PyCAM.
+
+PyCAM is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+PyCAM is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with PyCAM.  If not, see <http://www.gnu.org/licenses/>.
+"""
+
+import xml.etree.ElementTree as ET
+
+import pycam.Utils.log
+import pycam.Plugins
+
+_log = pycam.Utils.log.get_logger()
+
+
+class StatusManager(pycam.Plugins.PluginBase):
+
+    CATEGORIES = ["System"]
+
+    def setup(self):
+        self._types = {}
+        if self.gui:
+            # autoload task settings file on startup
+            autoload_enable = self.gui.get_object("AutoLoadTaskFile")
+            autoload_box = self.gui.get_object("StartupTaskFileBox")
+            autoload_source = self.gui.get_object("StartupTaskFile")
+            # TODO: fix the extension filter
+            #for one_filter in get_filters_from_list(FILTER_CONFIG):
+            #    autoload_source.add_filter(one_filter)
+            #    autoload_source.set_filter(one_filter)
+            def get_autoload_task_file(autoload_source=autoload_source):
+                if autoload_enable.get_active():
+                    return autoload_source.get_filename()
+                else:
+                    return ""
+            def set_autoload_task_file(filename):
+                if filename:
+                    autoload_enable.set_active(True)
+                    autoload_box.show()
+                    autoload_source.set_filename(filename)
+                else:
+                    autoload_enable.set_active(False)
+                    autoload_box.hide()
+                    autoload_source.unselect_all()
+            def autoload_enable_switched(widget, box):
+                if not widget.get_active():
+                    set_autoload_task_file(None)
+                else:
+                    autoload_box.show()
+            autoload_enable.connect("toggled", autoload_enable_switched,
+                    autoload_box)
+            self.settings.add_item("default_task_settings_file",
+                    get_autoload_task_file, set_autoload_task_file)
+            autoload_task_filename = self.settings.get("default_task_settings_file")
+            # TODO: use "startup" hook instead
+            if autoload_task_filename:
+                self.open_task_settings_file(autoload_task_filename)
+                ("LoadTaskSettings", self.load_task_settings_file, None, "<Control>t"),
+                ("SaveTaskSettings", self.save_task_settings_file, lambda: self.last_task_settings_uri, None),
+                ("SaveAsTaskSettings", self.save_task_settings_file, None, None),
+        return True
+
+    def teardown(self):
+        pass
+
+    def register_status_type(self, name, the_type, parse_func, format_func):
+        if name in self._types:
+            _log.info("Trying to register status type twice: %s" % name)
+        self._types[name] = (the_type, parse_func, format_func)
+
+    def unregister_status_type(self, name):
+        if not name in self._types:
+            _log.info("Trying to unregister unknown status type: %s" % name)
+        else:
+            del self._types[name]
+
+    def get_name_of_type(self, the_type):
+        candidates = []
+        for name in self._types:
+            if the_type is self._types[name][0]:
+                return name
+            if isinstance(the_type, self._types[name][0]):
+                candidates.append(name)
+        if candidates:
+            return candidates[0]
+        else:
+            raise KeyError("Status type not registered: %s" % str(the_type))
+
+    def open_task_settings_file(self, filename):
+        """ This function is used by the commandline handler """
+        self.last_task_settings_uri = pycam.Utils.URIHandler(filename)
+        self.load_task_settings_file(filename=filename)
+
+    def load_task_settings_file(self, widget=None, filename=None):
+        if callable(filename):
+            filename = filename()
+        if not filename:
+            filename = self.settings.get("get_filename_func")("Loading settings ...",
+                    mode_load=True, type_filter=FILTER_CONFIG)
+            # Only update the last_task_settings attribute if the task file was
+            # loaded interactively. E.g. ignore the initial task file loading.
+            if filename:
+                self.last_task_settings_uri = pycam.Utils.URIHandler(filename)
+        if filename:
+            log.info("Loading task settings file: %s" % str(filename))
+            self.load_task_settings(filename)
+            self.add_to_recent_file_list(filename)
+
+    def save_task_settings_file(self, widget=None, filename=None):
+        if callable(filename):
+            filename = filename()
+        if not isinstance(filename, (basestring, pycam.Utils.URIHandler)):
+            # we open a dialog
+            filename = self.settings.get("get_filename_func")("Save settings to ...",
+                    mode_load=False, type_filter=FILTER_CONFIG,
+                    filename_templates=(self.last_task_settings_uri, self.last_model_uri))
+            if filename:
+                self.last_task_settings_uri = pycam.Utils.URIHandler(filename)
+        # no filename given -> exit
+        if not filename:
+            return
+        settings = self.settings.dump_state()
+        try:
+            out_file = open(filename, "w")
+            out_file.write(settings)
+            out_file.close()
+            log.info("Task settings written to %s" % filename)
+            self.add_to_recent_file_list(filename)
+        except IOError:
+            log.error("Failed to save settings file")
+
+    def load_task_settings(self, filename=None):
+        settings = pycam.Gui.Settings.ProcessSettings()
+        if not filename is None:
+            settings.load_file(filename)
+        # flush all tables (without re-assigning new objects)
+        for one_list_name in ("tools", "processes", "bounds", "tasks"):
+            one_list = self.settings.get(one_list_name)
+            while one_list:
+                one_list.pop()
+        # TODO: load default tools/processes/bounds
+
+    def dump_state(self):
+        result = []
+        for plugin in self.core.get("plugin-manager").get_plugins():
+            if plugin.enabled:
+                plugin.dump_state(result)
+        root = ET.Element("pycam")
+        for match, element in result:
+            chain = match.split("/")
+            if not hasattr(element, "findtext"):
+                # not an instance of ET.Element
+                element = _get_xml(element, chain[-1])
+            parent = root
+            if match:
+                for component in chain[:-1]:
+                    next_item = parent.find(component)
+                    if not next_item is None:
+                        parent = next_item
+                    else:
+                        item = ET.SubElement(parent, component)
+                        parent = item
+            parent.append(element)
+        return os.linesep.join(_get_xml_lines(root))
+
+
+def _get_xml(item, name=None):
+    if name is None:
+        if hasattr(item, "node_key"):
+            name = item.node_key
+        else:
+            name = "value"
+    if isinstance(item, (list, tuple, set)):
+        leaf = ET.Element(name)
+        leaf.attrib["type"] = str(type(item))
+        for single in item:
+            leaf.append(_get_xml(single))
+        return leaf
+    elif isinstance(item, dict):
+        leaf = ET.Element(name)
+        leaf.attrib["type"] = "dict"
+        for key, value in item.iteritems():
+            leaf.append(_get_xml(value, name=key))
+        return leaf
+    else:
+        leaf = ET.Element(name)
+        leaf.text = str(item)
+        leaf.attrib["type"] = str(type(item))
+        return leaf
+
+
+def _get_xml_lines(item):
+    lines = []
+    content = ET.tostring(item)
+    content = content.replace("><", ">\n<")
+    indent = 0
+    for line in content.split("\n"):
+        indented = False
+        if line.startswith("</"):
+            indent -= 2
+            indented = True
+        lines.append(" " * indent + line)
+        if indented:
+            pass
+        elif line.endswith("/>"):
+            pass
+        elif line.startswith("</"):
+            indent -= 2
+        elif "</" in line:
+            pass
+        else:
+            indent += 2
+    return lines
+

pycam/Plugins/__init__.py

@@ -30,7 +30,6 @@ import gobject
 
 import pycam.Utils.log
 import pycam.Utils.locations
-import pycam.Utils.xml_handling
 
 
 _log = pycam.Utils.log.get_logger()