Rename mkpretty to pretty

Ans its internal sub-modules to _pretty_*

include/_pretty_color.sh

@@ -0,0 +1,59 @@
+#!/bin/bash
+
+ffoo import termcolors
+
+
+FFOO_PRETTY_COLOR_DEBUG=""
+FFOO_PRETTY_COLOR_DIE=""
+FFOO_PRETTY_COLOR_USAGE_IS=""
+FFOO_PRETTY_COLOR_THINK=""
+FFOO_PRETTY_COLOR_WARN=""
+FFOO_PRETTY_COLOR_OFF=""
+
+
+__ffoo__pretty_color__init() {
+    test -t 2 || return 0   # stderr is a pipe/file; refrain from colors
+    FFOO_PRETTY_COLOR_DEBUG="${FFOO_TERMCOLORS_LBLUE}"
+    FFOO_PRETTY_COLOR_DIE="${FFOO_TERMCOLORS_LRED}"
+    FFOO_PRETTY_COLOR_USAGE_IS="${FFOO_TERMCOLORS_YELLOW}"
+    FFOO_PRETTY_COLOR_THINK="${FFOO_TERMCOLORS_NONE}"
+    FFOO_PRETTY_COLOR_WARN="${FFOO_TERMCOLORS_LRED}"
+    FFOO_PRETTY_COLOR_OFF="${FFOO_TERMCOLORS_NONE}"
+}
+
+
+_pretty_debug() {
+    while IFS= read line;
+    do echo -ne "${FFOO_PRETTY_COLOR_DEBUG}debug:$caller:$FFOO_PRETTY_COLOR_OFF"
+       echo "$line"; done
+}
+
+
+_pretty_die() {
+    echo -ne "$FFOO_PRETTY_COLOR_DIE"
+    while IFS= read line;
+    do echo "$line"; done
+    echo -ne "$FFOO_PRETTY_COLOR_OFF"
+}
+
+
+_pretty_usage_is() {
+    echo -ne "$FFOO_PRETTY_COLOR_USAGE_IS"
+    while IFS= read line;
+    do echo -e "$line"; done
+    echo -ne "$FFOO_PRETTY_COLOR_OFF"
+}
+
+
+_pretty_think() {
+    while IFS= read line;
+    do echo "$line"; done
+}
+
+
+_pretty_warn() {
+    echo -ne "$FFOO_PRETTY_COLOR_WARN"
+    while IFS= read line;
+    do echo "$line"; done
+    echo -ne "$FFOO_PRETTY_COLOR_OFF"
+}

include/mkpretty_html.sh → include/_pretty_html.sh

@@ -1,31 +1,31 @@
 #!/bin/bash
 
 
-mkpretty_debug() {
+_pretty_debug() {
     while IFS= read line;
     do echo "<p class='debug'>$caller  $line</p>"; done
 }
 
 
-mkpretty_die() {
+_pretty_die() {
     while IFS= read line;
     do echo "<p class='die'>$line</p>"; done
 }
 
 
-mkpretty_usage_is() {
+_pretty_usage_is() {
     while IFS= read line;
     do echo "<p class='usage'>$line</p>"; done
 }
 
 
-mkpretty_think() {
+_pretty_think() {
     while IFS= read line;
     do echo "<p class='think'>$line</p>"; done
 }
 
 
-mkpretty_warn() {
+_pretty_warn() {
     while IFS= read line;
     do echo "<p class='warn'>$line</p>"; done
 }

include/mkpretty_plain.sh → include/_pretty_plain.sh

@@ -1,27 +1,27 @@
 #!/bin/bash
 
 
-mkpretty_debug() {
+_pretty_debug() {
     while IFS= read line;
     do echo "debug:$caller: $line"; done
 }
 
-mkpretty_die() {
+_pretty_die() {
     while IFS= read line;
     do echo "$line"; done
 }
 
-mkpretty_usage_is() {
+_pretty_usage_is() {
     while IFS= read line;
     do echo "$line"; done
 }
 
-mkpretty_think() {
+_pretty_think() {
     while IFS= read line;
     do echo "$line"; done
 }
 
-mkpretty_warn() {
+_pretty_warn() {
     while IFS= read line;
     do echo "$line"; done
 }

include/core.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 ffoo import exits
-ffoo import mkpretty
+ffoo import pretty
 
 
 ##--------------------##
@@ -173,7 +173,7 @@ __echo() {
         -v|--vars)  src=vars;  shift; break ;;
         *)          src=args;         break ;;
     esac done
-    prettyfn=mkpretty_$frontend
+    prettyfn=_pretty_$frontend
     case $frontend in
         warn|debug|die|usage_is)    __echo_$src "$@" | $prettyfn >&2 ;;
         think)                      __echo_$src "$@" | $prettyfn     ;;

include/mkpretty.sh

@@ -1,27 +0,0 @@
-#!/bin/bash
-
-#
-# Name of prerry-printer module
-#
-# Friendly name of module used for decorating output.  For
-# example, if the value is NAME, a mkpretty_NAME module must
-# exist and be importable.  Otherwise mkpretty will fall back
-# to plain, which is also the default value.
-#
-FFOO_MKPRETTY=${FFOO_MKPRETTY:-plain}
-
-
-__ffoo_mkpretty__init() {
-    #
-    # Import proper submodule
-    #
-    if ffoo try_import mkpretty_${FFOO_MKPRETTY};
-    then
-        ffoo import mkpretty_${FFOO_MKPRETTY}
-        return 0
-    else
-        warn "falling back to mkpretty_plain"
-        FFOO_MKPRETTY=plain
-        ffoo import mkpretty_${FFOO_MKPRETTY}
-    fi
-}

include/mkpretty_color.sh

@@ -1,59 +0,0 @@
-#!/bin/bash
-
-ffoo import termcolors
-
-
-FFOO_MKPRETTY_COLOR_DEBUG=""
-FFOO_MKPRETTY_COLOR_DIE=""
-FFOO_MKPRETTY_COLOR_USAGE_IS=""
-FFOO_MKPRETTY_COLOR_THINK=""
-FFOO_MKPRETTY_COLOR_WARN=""
-FFOO_MKPRETTY_COLOR_OFF=""
-
-
-__ffoo_mkpretty_color__init() {
-    test -t 2 || return 0   # stderr is a pipe/file; refrain from colors
-    FFOO_MKPRETTY_COLOR_DEBUG="${FFOO_TERMCOLORS_LBLUE}"
-    FFOO_MKPRETTY_COLOR_DIE="${FFOO_TERMCOLORS_LRED}"
-    FFOO_MKPRETTY_COLOR_USAGE_IS="${FFOO_TERMCOLORS_YELLOW}"
-    FFOO_MKPRETTY_COLOR_THINK="${FFOO_TERMCOLORS_NONE}"
-    FFOO_MKPRETTY_COLOR_WARN="${FFOO_TERMCOLORS_LRED}"
-    FFOO_MKPRETTY_COLOR_OFF="${FFOO_TERMCOLORS_NONE}"
-}
-
-
-mkpretty_debug() {
-    while IFS= read line;
-    do echo -ne "${FFOO_MKPRETTY_COLOR_DEBUG}debug:$caller:$FFOO_MKPRETTY_COLOR_OFF"
-       echo "$line"; done
-}
-
-
-mkpretty_die() {
-    echo -ne "$FFOO_MKPRETTY_COLOR_DIE"
-    while IFS= read line;
-    do echo "$line"; done
-    echo -ne "$FFOO_MKPRETTY_COLOR_OFF"
-}
-
-
-mkpretty_usage_is() {
-    echo -ne "$FFOO_MKPRETTY_COLOR_USAGE_IS"
-    while IFS= read line;
-    do echo -e "$line"; done
-    echo -ne "$FFOO_MKPRETTY_COLOR_OFF"
-}
-
-
-mkpretty_think() {
-    while IFS= read line;
-    do echo "$line"; done
-}
-
-
-mkpretty_warn() {
-    echo -ne "$FFOO_MKPRETTY_COLOR_WARN"
-    while IFS= read line;
-    do echo "$line"; done
-    echo -ne "$FFOO_MKPRETTY_COLOR_OFF"
-}

include/pretty.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+#
+# Name of prerry-printer module
+#
+# Friendly name of module used for decorating output.  For
+# example, if the value is NAME, a _pretty_NAME module must
+# exist and be importable.  Otherwise pretty will fall back
+# to plain, which is also the default value.
+#
+FFOO_PRETTY=${FFOO_PRETTY:-plain}
+
+
+__ffoo_pretty__init() {
+    #
+    # Import proper submodule
+    #
+    if ffoo try_import _pretty_${FFOO_PRETTY};
+    then
+        ffoo import _pretty_${FFOO_PRETTY}
+        return 0
+    else
+        warn "falling back to _pretty_plain"
+        FFOO_PRETTY=plain
+        ffoo import _pretty_${FFOO_PRETTY}
+    fi
+}

notes/TODO.md

@@ -53,15 +53,13 @@ core.sh
 -------
 
 *   add -name arg to debug, e.g. for pipe/cmd/file and use it in
-    mkpretty
+    pretty
 
-*   set fixed list of valid "leaks" to mkpretty
+*   set fixed list of valid "leaks" to pretty
 
 
-mkpretty_*.sh
--------------
-
-*   change name to pretty
+_pretty_*.sh
+------------
 
 *   implement options (like `ps -o`, et al.)
 

notes/packaging.md

@@ -38,10 +38,10 @@ No modules, just ffoo.sh and supporting binaries.
 
  *  core
  *  error
- *  mkpretty
- *  mkpretty_color
- *  mkpretty_html
- *  mkpretty_plain
+ *  pretty
+ *  _pretty_color
+ *  _pretty_html
+ *  _pretty_plain
  *  types
 
 

test/data/ffoo_api/functions.oracle.stdout

@@ -1,3 +1,19 @@
+_pretty_color.__ffoo__pretty_color__init
+_pretty_color._pretty_debug
+_pretty_color._pretty_die
+_pretty_color._pretty_think
+_pretty_color._pretty_usage_is
+_pretty_color._pretty_warn
+_pretty_html._pretty_debug
+_pretty_html._pretty_die
+_pretty_html._pretty_think
+_pretty_html._pretty_usage_is
+_pretty_html._pretty_warn
+_pretty_plain._pretty_debug
+_pretty_plain._pretty_die
+_pretty_plain._pretty_think
+_pretty_plain._pretty_usage_is
+_pretty_plain._pretty_warn
 charmenu.charmenu
 config.__cfgrep__cat
 config.__cfgrep__fltcmt
@@ -42,23 +58,7 @@ misc.expand_tilde
 misc.filter
 misc.mute_known
 misc.select_args
-mkpretty.__ffoo_mkpretty__init
-mkpretty_color.__ffoo_mkpretty_color__init
-mkpretty_color.mkpretty_debug
-mkpretty_color.mkpretty_die
-mkpretty_color.mkpretty_think
-mkpretty_color.mkpretty_usage_is
-mkpretty_color.mkpretty_warn
-mkpretty_html.mkpretty_debug
-mkpretty_html.mkpretty_die
-mkpretty_html.mkpretty_think
-mkpretty_html.mkpretty_usage_is
-mkpretty_html.mkpretty_warn
-mkpretty_plain.mkpretty_debug
-mkpretty_plain.mkpretty_die
-mkpretty_plain.mkpretty_think
-mkpretty_plain.mkpretty_usage_is
-mkpretty_plain.mkpretty_warn
+pretty.__ffoo_pretty__init
 recon.age_of_leaf
 recon.age_of_tree
 recon.cat_uri

test/data/ffoo_api/modules.oracle.stdout

@@ -1,12 +1,12 @@
+_pretty_color
+_pretty_html
+_pretty_plain
 charmenu
 config
 core
 exits
 misc
-mkpretty
-mkpretty_color
-mkpretty_html
-mkpretty_plain
+pretty
 recon
 stats
 termcolors