Better exit code handling for components, and some documentation

Author: Egil

README.md

@@ -41,6 +41,7 @@ Features:
 * Configuration
   * [Key bindings](docs/KEYMAP.md)
   * [Sessions](docs/SESSION.md)
+  * [Components](docs/COMPONENTS.md)
   * [Command line](docs/COMMANDLINE.md)
   * [Integrations](docs/INTEGRATIONS.md)
   * [Themes](docs/THEMES.md)

docs/COMPONENTS.md

@@ -0,0 +1,17 @@
+Implemented by: [`glass-components`](../glass-components)
+
+The components configuration is done in
+[~/.config/glass/components.yml](../glass-config-init/glass_config_init/components.yml).
+
+# Components
+
+Components are applications to run during your session or at startup
+that provide some part of the desktop environment. As opposed to
+normal applications used by the user, they are not normally started
+and stopped by the user and do not provide windows managed by the
+user. In particular, they are not SMlib clients and do not store a
+RestartCommand with `glass-ghosts`.
+
+However, each component is given a name, and can be restarted or
+replaced using the `glass-action component` subcommands with that
+name.

docs/SESSION.md

@@ -39,16 +39,3 @@ pre-define some ghosts in the configuration file. This is
 particularly useful for windows of components (see above). To generate the correct json for such a ghost, the following command can be used
 
     glass-action ghost export
-
-# Components
-
-Components are applications to run during your session or at startup
-that provide some part of the desktop environment. As opposed to
-normal applications used by the user, they are not normally started
-and stopped by the user and do not provide windows managed by the
-user. In particular, they are not SMlib clients and do not store a
-RestartCommand with glass-ghosts.
-
-However, each component is given a name, and can be restarted or
-replaced using the 'glass-action component' subcommands with that
-name.

glass-components/glass_components/components.py

@@ -64,13 +64,30 @@ def sigchild(self, signum, frame):
                     if pid in self.components_by_pid:
                         name = self.components_by_pid.pop(pid)
                         del self.display.root["IG_COMPONENTPID_" + name]
-                        if (    not exitcode == 0
-                            and (   not os.WIFSIGNALED(exitcode)
-                                 or os.WTERMSIG(exitcode) not in (signal.SIGHUP, signal.SIGINT, signal.SIGQUIT, signal.SIGKILL))):
-                            # This is a component, and it wasn't killed intentionally... restart it
-                            if name in self.components and self.restart_components:
-                                spec = self.components[name]["component"]
+                        
+                        if name in self.components:
+                            spec = self.components[name]["component"]
+                            spec_actions = spec.get("exit_actions", {})
+                            default_actions = self.config.get("defaults", {}).get("exit_actions", {})
+
+                            exit_action = spec_actions.get("exited", default_actions.get("exited", "nothing"))
+                            killed_action = spec_actions.get("killed", default_actions.get("killed", "nothing"))
+                            fail_action = spec_actions.get("failed", default_actions.get("failed", "restart"))
+
+                            if exitcode == 0:
+                                action = exit_action
+                            elif (os.WIFSIGNALED(exitcode)
+                                  and os.WTERMSIG(exitcode) in (signal.SIGHUP, signal.SIGINT, signal.SIGQUIT, signal.SIGKILL)):
+                                action = killed_action
+                            else:
+                                action = fail_action
+                            
+                            if action == "restart":
                                 self.start_component(spec)
+                            elif action == "exit":
+                                self.display.exit()
+                                return
+
                     InfiniteGlass.debug.DEBUG("SIGCHLD", "Checking for more children in the same batch...\n")
                     try:
                         pid, exitcode, ru_child = os.wait4(-1, os.WNOHANG)

glass-components/glass_components/main.py

@@ -31,7 +31,7 @@ def setup_annotator():
 @InfiniteGlass.profilable
 def main(**kw):
     setup_annotator()
-    manager = None
+    components = None
     try:
         with InfiniteGlass.Display() as display:
             overlay = display.root.composite_get_overlay_window().overlay_window
@@ -44,13 +44,13 @@ def main(**kw):
 
             components = glass_components.components.Components(display, **kw)
 
-        manager.components.shutdown()
+        components.shutdown()
     except Exception as e:
         print("Components manager systemic failure, restarting: %s" % (e,))
         traceback.print_exc()
         try:
-            if manager is not None and hasattr(manager, "components") and hasattr(manager.components, "components_by_pid"):
-                for pid in manager.components.components_by_pid.keys():
+            if components is not None and hasattr(components, "components_by_pid"):
+                for pid in components.components_by_pid.keys():
                     os.kill(pid, signal.SIGINT)
         except Exception as e:
             print(e)

glass-config-init/glass_config_init/components.yml

@@ -1,14 +1,23 @@
-restart_components: true
+defaults:
+  exit_actions:
+    exited: nothing
+    failed: restart
+    killed: nothing
 
 components:
-  glass-input: {"command": ["glass-input"]}
-  glass-theme: {"command": ["glass-theme"]}
-  glass-widgets: {"command": ["glass-widgets"]}
+  glass-ghosts:
+    command: ["glass-ghosts"]
+    exit_actions:
+      exited: exit
+      failed: exit
+  glass-input:    {"command": ["glass-input"]}
+  glass-theme:    {"command": ["glass-theme"]}
+  glass-widgets:  {"command": ["glass-widgets"]}
   glass-animator: {"command": ["glass-animator"]}
   glass-renderer: {"command": ["glass-renderer-wrapper.sh"]}
-  glass-islands: {"command": ["glass-islands"]}
-  xkb: {"command": ["setxkbmap", "-model", "pc101", "-layout", "us"]}
-  root-cursor: {"command": ["xsetroot", "-cursor_name", "arrow"]}
+  glass-islands:  {"command": ["glass-islands"]}
+  xkb:            {"command": ["setxkbmap", "-model", "pc101", "-layout", "us"]}
+  root-cursor:    {"command": ["xsetroot", "-cursor_name", "arrow"]}
   panelterm:
     command: ["xterm", "-title", "panelterm", "-xrm", "XTerm.vt100.allowTitleOps: false"]
     environment: { "IG_APP_ID": "panelterm" }