Move common saturnin routines to a module

This module is intended to be moved around with saturnin, but unlike
main meta-command (bin/saturnin.skel), it should not be necessary to
rename it or edit to adapt to new project.

mkit/config.ini

@@ -55,5 +55,6 @@
     src/libexec/saturnin-www                = saturnin-www
 
 [files:share]
+    src/ffoo/saturnin_common.sh             = ffoo/saturnin_common.sh
     src/ffoo/saturnin_www.sh                = ffoo/saturnin_www.sh
     src/ffoo/saturnin_zleep.sh              = ffoo/saturnin_zleep.sh

src/bin/saturnin.skel

@@ -28,6 +28,8 @@ SATURNIN_VERSION="__VERSION__"
 # =====END BUILT PART=====
 #
 
+ffoo import saturnin_common
+
 export FFOO_INIGREP_PATH FFOO_PATH FFOO_PRETTY_USAGE \
        SATURNIN_VERSION SATURNIN_CACHE_HOME
 
@@ -37,69 +39,11 @@ usage() {
             "--version"
 }
 
-print_help() {
-    echo ""
-    echo "built-in sub-commands:"
-    echo ""
-    echo "    conf"
-    echo "    help"
-    echo ""
-    echo "installed sub-commands:"
-    echo ""
-    ls_subcommands | sed -e 's/^/    /'
-    return "$FFOO_EXIT_OK"
-}
-
-ls_subcommands() {
-    find "$SATURNIN_LIBEXEC" \
-        -mindepth 1 \
-        -maxdepth 1 \
-        -executable \
-      | sed -e 's/.*saturnin-//' \
-      | sort
-}
-
 version_info() {
     echo "$(basename $0) (Smart and ready desktop helper) $SATURNIN_VERSION"
     exit $FFOO_EXIT_OK
 }
 
-run_hook() {
-    #
-    # Run custom hook
-    #
-    local hname="$1"
-    local hook_code
-    test -n "$SATURNIN_SUBCOMMAND" || {
-        warn "unknown subcommand, ignoring hook: $hname"
-        return 0
-    }
-    hook_code="$(inigrep -j -p hook.$SATURNIN_SUBCOMMAND.$hname)"
-    debug -v SATURNIN_SUBCOMMAND hook_code hname
-    bash -n <<<"$hook_code" || {
-        warn "syntax errors, ignoring hook: $hname"
-        return 0
-    }
-    eval "$hook_code"
-}
-
-subcommand() {
-    local sc_es=0   # future exit (return) status
-    local lexpath="$SATURNIN_LIBEXEC/saturnin-$SATURNIN_SUBCOMMAND"
-    debug -v lexpath
-    debug "\$*='$*'"
-    test -x "$lexpath" || {
-        warn "invalid sub-command: $SATURNIN_SUBCOMMAND"
-        print_help
-        return $FFOO_EXIT_USAGE
-    }
-    run_hook pre
-    "$lexpath" "$@" || return $?
-    sc_es=$?
-    run_hook post
-    return $sc_es
-}
-
 while true; do case $1 in
     -d|--debug)     export FFOO_DEBUG=true; shift   ;;
     -v|--verbose)   export FFOO_VERBOSE=true; shift ;;
@@ -120,10 +64,10 @@ shift
 
 case "$SATURNIN_SUBCOMMAND" in
     conf)               inigrep "$@"    ;;
-    help)               print_help      ;;
-    _ls_subcommands)    ls_subcommands ;;
+    help)               saturnin_help ;;
+    _ls_subcommands)    saturnin_lssc ;;
     _lsfun)             ffoom lsfun ;;
     _lsmod)             ffoom lsmod ;;
     _ffrun)             ffrun "$@" ;;
-    *)                  subcommand "$@" ;;
+    *)                  saturnin_runsc "$@" ;;
 esac

src/ffoo/saturnin_common.sh

@@ -0,0 +1,63 @@
+#!/bin/bash
+
+ffoo import exit
+ffoo import inigrep
+ffoo import pretty
+
+saturnin_help() {
+    echo ""
+    echo "built-in sub-commands:"
+    echo ""
+    echo "    conf"
+    echo "    help"
+    echo ""
+    echo "installed sub-commands:"
+    echo ""
+    saturnin_lssc | sed -e 's/^/    /'
+    return "$FFOO_EXIT_OK"
+}
+
+saturnin_lssc() {
+    find "$SATURNIN_LIBEXEC" \
+        -mindepth 1 \
+        -maxdepth 1 \
+        -executable \
+      | sed -e 's/.*saturnin-//' \
+      | sort
+}
+
+saturnin_runhook() {
+    #
+    # Run custom hook
+    #
+    local hname="$1"
+    local hook_code
+    test -n "$SATURNIN_SUBCOMMAND" || {
+        warn "unknown subcommand, ignoring hook: $hname"
+        return 0
+    }
+    hook_code="$(inigrep -j -p hook.$SATURNIN_SUBCOMMAND.$hname)"
+    debug -v SATURNIN_SUBCOMMAND hook_code hname
+    bash -n <<<"$hook_code" || {
+        warn "syntax errors, ignoring hook: $hname"
+        return 0
+    }
+    eval "$hook_code"
+}
+
+saturnin_runsc() {
+    local sc_es=0   # future exit (return) status
+    local lexpath="$SATURNIN_LIBEXEC/saturnin-$SATURNIN_SUBCOMMAND"
+    debug -v lexpath
+    debug "\$*='$*'"
+    test -x "$lexpath" || {
+        warn "invalid sub-command: $SATURNIN_SUBCOMMAND"
+        saturnin_help
+        return $FFOO_EXIT_USAGE
+    }
+    saturnin_runhook pre
+    "$lexpath" "$@" || return $?
+    sc_es=$?
+    saturnin_runhook post
+    return $sc_es
+}