From 7425fdddcc1661043040b6042d6a2f392ad47749 Mon Sep 17 00:00:00 2001
From: CyberLeo <cyberleo@cyberleo.net>
Date: Sat, 29 Dec 2012 07:58:31 -0600
Subject: [PATCH] sh/stopwatch: utilize customizable message callback for event
 spam

---
 lib/sh/stopwatch.sh | 68 +++++++++++++++++++++++++++++++++++++++------
 1 file changed, 60 insertions(+), 8 deletions(-)

diff --git a/lib/sh/stopwatch.sh b/lib/sh/stopwatch.sh
index 59e6785..3257d7e 100644
--- a/lib/sh/stopwatch.sh
+++ b/lib/sh/stopwatch.sh
@@ -74,6 +74,21 @@ stopwatch_humany_duration <usec>
   Transform an integer number of microseconds into a human-readable string
   (Ex: 3d14h10m3.223s or 7m10.013s )
 
+stopwatch_set_message_callback <command>
+  Register a callback to format event messages emitted when a stopwatch is
+  commanded. The callback will receive the following parameters:
+    <command> - one of: starting, started, lap, get, stopping, stopped, reset
+    <tag>     - stopwatch name
+    <time>    - the current time on the stopwatch, if any
+  The commands are as follows:
+    starting  - called start while stopped
+    started   - called start while running
+    lap       - called lap while running
+    get       - called lap while stopped
+    stopping  - called stop while running
+    stopped   - called stop while stopped
+    reset     - called reset
+
 EOF
     kill -ABRT $$
   }
@@ -95,6 +110,44 @@ EOF
     ;;
   esac
 
+  # Format stopwatch event messages (Can be overridden; see
+  # 'stopwatch_set_message_callback')
+  _stopwatch_message_callback() {
+    command="${1}"
+    tag="${2}"
+    time="${3:+$(stopwatch_humany_duration ${3})}"
+    printf "Stopwatch: "
+    case "${command}" in
+    starting)  printf "'%s' starts%s.\n" "${tag}" "${time:+ at ${time}}";;
+    started)   printf "'%s' is already running.\n" "${tag}" ;;
+    lap)       printf "'%s' is running: %s\n" "${tag}" "${time}" ;;
+    get)       printf "'%s' is stopped: %s\n" "${tag}" "${time}" ;;
+    stopping)  printf "'%s' stops at %s.\n" "${tag}" "${time}" ;;
+    stopped)   printf "'%s' is stopped%s.\n" "${tag}" "${time:+ at ${time}}" ;;
+    reset)     printf "'%s' is reset to zero.\n" "${tag}" ;;
+    *)         printf "No message for command %s\n" "${command}" ;;
+    esac
+  }
+
+  # Set the message callback
+  stopwatch_set_message_callback() {
+    _stopwatch_registered_message_callback="${1:-_stopwatch_message_callback}"
+    kvs_set stopwatch message_callback "${_stopwatch_registered_message_callback}"
+  }
+
+  # Fetch the message callback; default if unset
+  stopwatch_get_message_callback() {
+    [ "${_stopwatch_registered_message_callback}" ] ||
+      _stopwatch_registered_message_callback="$(kvs_get stopwatch messsage_callback)"
+    if [ "${_stopwatch_registered_message_callback}" ]
+    then
+      echo "${_stopwatch_registered_message_callback}"
+    else
+      _stopwatch_registered_message_callback=_stopwatch_message_callback
+      echo _stopwatch_message_callback
+    fi
+  }
+
   # Try and format a passed integer number of seconds into something more
   # easily parseable by a human (like 6m10s or something)
   stopwatch_humany_duration() {
@@ -130,13 +183,12 @@ EOF
     # Is the stopwatch running?
     if kvs_has_key stopwatch "${name}"
     then
-      printf "Stopwatch: '%s' is already running.\n" "${name}"
+      eval "$(stopwatch_get_message_callback) started ${name}"
     else
       # start the stopwatch
       accum="$(kvs_get stopwatch "${name}_accumulator")"
       kvs_set stopwatch "${name}" "${nao}"
-      [ "${accum}" ] && restart="$(printf " at %s" "$(stopwatch_humany_duration "${accum}")")"
-      printf "Stopwatch: '%s' starts%s.\n" "${name}" "${restart}"
+      eval "$(stopwatch_get_message_callback) starting ${name} ${accum}"
     fi
   }
 
@@ -153,10 +205,10 @@ EOF
       accum="$(kvs_get stopwatch "${name}_accumulator")"
       delta="$(( ${nao} - ${start} ))"
       [ "${accum}" ] && delta="$(( ${delta} + ${accum} ))"
-      printf "Stopwatch: '%s' is running: %s.\n" "${name}" "$(stopwatch_humany_duration "${delta}")"
+      eval "$(stopwatch_get_message_callback) lap ${name} ${delta}"
     else
       accum="$(kvs_get stopwatch "${name}_accumulator")"
-      [ "${accum}" ] && printf "Stopwatch: '%s' is stopped: %s.\n" "${name}" "$(stopwatch_humany_duration "${accum}")"
+      eval "$(stopwatch_get_message_callback) get ${name} ${accum}"
     fi
   }
 
@@ -173,10 +225,10 @@ EOF
       [ "${accum}" ] && delta="$(( ${delta} + ${accum} ))"
       kvs_set stopwatch "${name}_accumulator" "${delta}"
       kvs_unset stopwatch "${name}"
-      printf "Stopwatch: '%s' stops at %s.\n" "${name}" "$(stopwatch_humany_duration "${delta}")"
+      eval "$(stopwatch_get_message_callback) stopping ${name} ${delta}"
     else
       accum="$(kvs_get stopwatch "${name}_accumulator")"
-      [ "${accum}" ] && printf "Stopwatch: '%s' is stopped at %s.\n" "${name}" "$(stopwatch_humany_duration "${accum}")"
+      eval "$(stopwatch_get_message_callback) stopped ${name} ${accum}"
     fi
   }
 
@@ -186,7 +238,7 @@ EOF
     [ "${nao}" ] || nao="$(_stopwatch_usec)"
     kvs_unset stopwatch "${name}"
     kvs_unset stopwatch "${name}_accumulator"
-    printf "Stopwatch: '%s' is reset to 0s.\n" "${name}"
+    eval "$(stopwatch_get_message_callback) reset ${name}"
   }
 
   stopwatch() {
-- 
2.42.0