Add a PluginConfig plugin (UI to manage other plugins)

This adds a global plugin called "PluginConfig" which can be used to easily
manage which plugins are enabled/disabled for the Ginga reference viewer.
Additionally, it allows the user to configure how the plugins appear under
the menus.

Documentation has been added to the manual.

doc/WhatsNew.rst

@@ -31,6 +31,8 @@ Ver 5.0.0 (unreleased)
   various MIME types
 - Fixed an issue with the "none-move" event, affected Crosshair plugin
   and "hover" event on canvas items
+- Added PluginConfig plugin; allows configuration of all Ginga plugins
+  graphically; can enable/disable, change menu categories, etc.
 
 Ver 4.1.0 (2022-06-30)
 ======================

doc/dev_manual/modes.rst

@@ -188,5 +188,5 @@ callback.
 
 .. note:: To see what attributes are available in each event, see the
           ``KeyEvent``, ``PointEvent``, ``ScrollEvent``, ``PanEvent``, and
-          ``PinchEvent`` in the :ref:`api` (look under `ginga.Bindings`).
+          ``PinchEvent`` in the :ref:`api` (look under `ginga.events`).
 

doc/manual/plugins.rst

@@ -53,6 +53,7 @@ Global plugins
    plugins_global/saveimage
    plugins_global/downloads
    plugins_global/loaderconfig
+   plugins_global/pluginconfig
 
 
 .. _sec-localplugins:

doc/manual/plugins_global/pluginconfig.rst

@@ -0,0 +1,13 @@
+.. _sec-plugins-PluginConfig:
+
+PluginConfig
+============
+
+.. image:: figures/pluginconfig-plugin.png
+   :align: center
+   :width: 1024px
+   :alt: PluginConfig plugin
+
+.. automodapi:: ginga.rv.plugins.PluginConfig
+   :no-heading:
+   :skip: PluginConfig

doc/ref_api.rst

@@ -27,6 +27,9 @@ Reference/API
 .. automodapi:: ginga.Bindings
    :no-inheritance-diagram:
 
+.. automodapi:: ginga.events
+   :no-inheritance-diagram:
+
 .. automodapi:: ginga.rv.main
    :no-inheritance-diagram:
 

ginga/examples/configs/general.cfg

@@ -143,12 +143,13 @@ channel_prefix = "Image"
 # temp directory (as defined by Python's 'tempfile' module)
 #download_folder = None
 
-# Name of a layout file to configure the GUI
-layout_file = 'layout.json'
-
 # Name of a file to configure the set of available plugins and where they
 # should appear
-plugin_file = 'plugins.json'
+plugin_file = 'plugins.yml'
+
+# Name of a file to configure the set of available loaders and which has
+# priority
+loader_file = 'loaders.yml'
 
 # Confirm program exits with a dialog?
 confirm_shutdown = True

ginga/gw/Desktop.py

@@ -8,6 +8,8 @@
 import math
 import os.path
 
+import yaml
+
 from ginga.misc import Bunch, Callback
 from ginga.gw import Widgets, Viewers
 from ginga.util import json
@@ -696,28 +698,24 @@ def write_layout_conf(self, lo_file, layout=None):
 
         self.record_sizes()
 
-        _n, ext = os.path.splitext(lo_file)
         # write layout
+        _n, ext = os.path.splitext(lo_file)
         with open(lo_file, 'w') as out_f:
-            if ext.lower() == '.json':
-                out_f.write(json.dumps(layout, indent=2))
+            if ext.lower() in ['.yml', '.yaml']:
+                out_f.write(yaml.dump(layout, indent=2))
             else:
-                # older, python format
-                import pprint
-                pprint.pprint(layout, out_f)
+                out_f.write(json.dumps(layout, indent=2))
 
     def read_layout_conf(self, lo_file):
         # read layout
         with open(lo_file, 'r') as in_f:
             buf = in_f.read()
 
         _n, ext = os.path.splitext(lo_file)
-        if ext.lower() == '.json':
-            layout = json.loads(buf)
+        if ext.lower() in ['.yml', '.yaml']:
+            layout = yaml.safe_load(buf)
         else:
-            # older, python format
-            import ast
-            layout = ast.literal_eval(buf)
+            layout = json.loads(buf)
         return layout
 
     def build_desktop(self, layout, lo_file=None, widget_dict=None):

ginga/gw/PluginManager.py

@@ -40,6 +40,8 @@ def __init__(self, logger, gshell, ds, mm):
             self.enable_callback(name)
 
     def load_plugin(self, name, spec, chinfo=None):
+        if not spec.get('enabled', True):
+            return
         try:
             module = self.mm.get_module(spec.module)
             className = spec.get('klass', spec.module)

ginga/rv/Control.py

@@ -328,8 +328,9 @@ def add_local_plugin(self, spec):
 
             pfx = spec.get('pfx', pluginconfpfx)
             path = spec.get('path', None)
-            self.mm.load_module(spec.module, pfx=pfx, path=path)
             self.plugins.append(spec)
+            if spec.get('enabled', True):
+                self.mm.load_module(spec.module, pfx=pfx, path=path)
 
         except Exception as e:
             self.logger.error("Unable to load local plugin '%s': %s" % (
@@ -342,8 +343,9 @@ def add_global_plugin(self, spec):
 
             pfx = spec.get('pfx', pluginconfpfx)
             path = spec.get('path', None)
-            self.mm.load_module(spec.module, pfx=pfx, path=path)
             self.plugins.append(spec)
+            if spec.get('enabled', True):
+                self.mm.load_module(spec.module, pfx=pfx, path=path)
 
             self.gpmon.load_plugin(name, spec)
 
@@ -352,8 +354,6 @@ def add_global_plugin(self, spec):
                 name, str(e)))
 
     def add_plugin(self, spec):
-        if not spec.get('enabled', True):
-            return
         ptype = spec.get('ptype', 'local')
         if ptype == 'global':
             self.add_global_plugin(spec)
@@ -1774,6 +1774,8 @@ def add_plugin_menu(self, name, spec):
         # NOTE: self.w.menu_plug is a ginga.Widgets wrapper
         if 'menu_plug' not in self.w:
             return
+        if not spec.get('enabled', True):
+            return
         category = spec.get('category', None)
         categories = None
         if category is not None: