Merge core.sh into pretty.sh

bin/ffdoc

@@ -2,7 +2,7 @@
 
 . <(ffoom init)
 
-ffoo import core
+ffoo import pretty
 
 
 usage() {

bin/fff

@@ -2,7 +2,7 @@
 
 . <(ffoom init)
 
-ffoo import core
+ffoo import pretty
 
 
 usage() {

bin/ffoom.skel

@@ -2,7 +2,7 @@
 
 . __FFOO_DIR__/ffoo.sh
 
-ffoo import core
+ffoo import pretty
 
 
 usage() {

doc/examples/template.sh

@@ -2,7 +2,7 @@
 
 . <(ffoom init)
 
-ffoo import core
+ffoo import pretty
 
 FFOO_VERBOSE=true
 FFOO_DEBUG=true

doc/examples/test_something.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 . <(ffoom init)
 
-ffoo import core
+ffoo import pretty
 ffoo import testing
 FFOO_VERBOSE=true           ## to think loud
 FFOO_DEBUG=true             ## to stay on the safe side

doc/ffoo.3.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 # ~/bin/example
 . <(ffoom init)
-ffoo import core
+ffoo import pretty
 
 #
 # basic echo helpers

include/charmenu.sh

@@ -1,4 +1,4 @@
-ffoo import core
+ffoo import pretty
 
 
 FFOO_CHARMENU_FILE="${FFOO_CHARMENU_FILE:-}"

include/config.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-ffoo import core
+ffoo import pretty
 
 
 #

include/core.sh

@@ -1,250 +0,0 @@
-#!/bin/bash
-
-ffoo import exits
-ffoo import pretty
-
-
-##--------------------##
-## PRINTING FRONT-END ##
-##--------------------##
-
-debug() {
-    #
-    # You already know what it does
-    #
-    # BTW, following are equivalent:
-    #
-    #     debug "var1=$var1" "var2=$var2" "result=$result"
-    #     debug -v var1 var2 result
-    #     debug -v "var@ result"
-    #
-    $FFOO_DEBUG || return 0
-    __echo "$@"
-}
-
-
-debug_pipe() {
-    #
-    # Debug the whole pipe.
-    #
-    grep . \
-        | while IFS= read line;
-          do
-              debug "|$1: '$line'"
-              echos "$line"
-          done
-}
-
-
-die() {
-    #
-    # A fatal error
-    #
-    __echo -t
-    __echo "$@"
-    exits_error
-}
-
-
-echos() {
-    #
-    # Safer version of echo able to echo "-n"
-    #
-    # Traditional echo is broken in that it does not
-    # distinguish between string to print and its own switches
-    # (-e, -E or -n), leading to unexpected behavior.
-    #
-    # This echo version circumvents this by using printf.
-    #
-    printf -- '%s\n' "$@"
-}
-
-
-usage_is() {
-    #
-    # Echo out usage patterns and (by default) exit 2
-    #
-    # Specify -e STATUS for exit status, or "-E" to prevent
-    # exiting.  Use "--" to delimit end of arguments processed
-    # by usage_is.
-    #
-    # Recommended usage is to define usage() in your script and
-    # use this in body.
-    #
-    local es=$FFOO_EXITS_OK
-    while true; do case "$1" in
-        -e) es="$2"; shift 2 ;;
-        -E) es="";   shift   ;;
-        *)           break ;;
-    esac done
-    __echo -u "$@";
-    test -n "$es" && exits "$es"
-}
-
-
-think() {
-    #
-    # If verose is on, think loud
-    #
-    # Use "-l" to split every parameter to separate line, (useful
-    # or longer warnings)
-    #
-    $FFOO_VERBOSE || return 0
-    __echo "$@"
-}
-
-
-warn() {
-    #
-    # Warn them
-    #
-    # Use "-l" to split every parameter to separate line, (useful
-    # or longer warnings)
-    #
-    # Resist  temptation to prefix "warning" or similar BS here.
-    # STDERR is *made* for warnings.
-    #
-    __echo "$@"
-}
-
-
-##----------##
-## BACK-END ##
-##----------##
-
-
-__cat() {
-    # cat without starting a process
-    while IFS= read line;
-    do echos "$line"; done
-}
-
-
-__cut_stack() {
-    #
-    # call stack except the head that fits pattern $1
-    #
-    local patt=${1:-"^__"}
-    echos "${FUNCNAME[@]}" \
-      | perl -ne "
-            my \$checking = 1;
-            while (<>) {
-                next if (\$checking and m/$patt/);
-                \$checking = 0;
-                print qq/\$_\\n/;
-            }
-        "
-}
-
-
-__echo() {
-    #
-    # A smarter echo backend
-    #
-    # A smarter backend for debug, warn, think, die and
-    # usage_is.
-    #
-    #   -c cmd      echo output of a command
-    #   -f file     echo output of a file (- for stdin)
-    #   -l line [line...] echo each line separately
-    #   -t          add stack trace to output
-    #   -u patt [patt...] convert each patt to usage pattern
-    #   -v var [var...] show contents of each var
-    #
-    local frontend  # who (of core.sh) was called (=> prettyprinter choice)
-    local caller    # which user's function (or script) called it
-    frontend="$(__cut_stack '^__echo' | head -1 )"
-    caller="$(
-        __cut_stack \
-            '^__echo|^warn$|^debug$|^die$|^usage$|^usage_is$|^think$' \
-            | head -1
-    )"
-    test "$frontend" == "main" && frontend=$(basename $0)
-    test "$caller" == "main" && caller=$(basename $0)
-    test "$frontend" == "usage" && frontend=usage_is
-    local prettyfn=__cat
-    local src       # which source, or "producer" (__echo_*()) to use
-    while true; do case $1 in
-        -c|--cmd)   src=cmd;   shift; break ;;
-        -f|--files) src=files; shift; break ;;
-        -l|--lines) src=lines; shift; break ;;
-        -t|--trace) src=trace; shift; break ;;
-        -u|--usage) src=usage; shift; break ;;
-        -v|--vars)  src=vars;  shift; break ;;
-        *)          src=args;         break ;;
-    esac done
-    prettyfn=_pretty_$frontend
-    case $frontend in
-        warn|debug|die|usage_is)    __echo_$src "$@" | $prettyfn >&2 ;;
-        think)                      __echo_$src "$@" | $prettyfn     ;;
-        *)      echo "do not call __echo* directly: $frontend" >&2;
-                exits_usage                                          ;;
-    esac
-}
-
-
-__echo_args() {
-    echos "$@"
-}
-
-
-__echo_cmd() {
-    local c=\$
-    test $(id -u) -eq 0 && c=\#
-    echo "$c $*"
-    $@
-    echo "^ exit status: $?"
-}
-
-
-__echo_files() {
-    local fp
-    for fp in "$@";
-    do
-        test -s "$fp" || continue
-        echo "-- $fp --"
-        cat $fp
-    done
-}
-
-
-__echo_lines() {
-    local l;
-    for l in "$@"; do __echo "$l"; done
-}
-
-
-__echo_trace() {
-    $FFOO_DEBUG || return 0
-    echo "== trace =="
-    caller | sed -e 's/^/-> /g'
-}
-
-
-__echo_usage() {
-    local u
-    for u in "$@";
-    do echo "usage: $caller $u"
-    done
-}
-
-
-__echo_vars() {
-    local vn
-    for vn in "$@";
-    do
-        local heel="${vn:0-1}"          # last char
-        local toes="${vn%%$heel}"       # all but last char
-        case "$heel" in
-            @)
-                # FIXME: review+fix the eval (even at cost of
-                #        dropping the feature)
-                local vars="$(eval "echos \"\${!$toes$heel}\"")"
-                __echo_vars "$vars"
-                ;;
-            *)
-                __echo "$vn='$(echos "${!vn}")'"
-                ;;
-        esac
-    done
-}

include/misc.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
-ffoo import core
 ffoo import config
+ffoo import pretty
 
 
 append_if_missing() {

include/pretty.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+ffoo import exits
+
 #
 # Name of prerry-printer module
 #
@@ -25,3 +27,249 @@ __ffoo_pretty__init() {
         ffoo import _pretty_${FFOO_PRETTY}
     fi
 }
+
+
+##--------------------##
+## PRINTING FRONT-END ##
+##--------------------##
+
+debug() {
+    #
+    # You already know what it does
+    #
+    # BTW, following are equivalent:
+    #
+    #     debug "var1=$var1" "var2=$var2" "result=$result"
+    #     debug -v var1 var2 result
+    #     debug -v "var@ result"
+    #
+    $FFOO_DEBUG || return 0
+    __echo "$@"
+}
+
+
+debug_pipe() {
+    #
+    # Debug the whole pipe.
+    #
+    grep . \
+        | while IFS= read line;
+          do
+              debug "|$1: '$line'"
+              echos "$line"
+          done
+}
+
+
+die() {
+    #
+    # A fatal error
+    #
+    __echo -t
+    __echo "$@"
+    exits_error
+}
+
+
+echos() {
+    #
+    # Safer version of echo able to echo "-n"
+    #
+    # Traditional echo is broken in that it does not
+    # distinguish between string to print and its own switches
+    # (-e, -E or -n), leading to unexpected behavior.
+    #
+    # This echo version circumvents this by using printf.
+    #
+    printf -- '%s\n' "$@"
+}
+
+
+usage_is() {
+    #
+    # Echo out usage patterns and (by default) exit 2
+    #
+    # Specify -e STATUS for exit status, or "-E" to prevent
+    # exiting.  Use "--" to delimit end of arguments processed
+    # by usage_is.
+    #
+    # Recommended usage is to define usage() in your script and
+    # use this in body.
+    #
+    local es=$FFOO_EXITS_OK
+    while true; do case "$1" in
+        -e) es="$2"; shift 2 ;;
+        -E) es="";   shift   ;;
+        *)           break ;;
+    esac done
+    __echo -u "$@";
+    test -n "$es" && exits "$es"
+}
+
+
+think() {
+    #
+    # If verose is on, think loud
+    #
+    # Use "-l" to split every parameter to separate line, (useful
+    # or longer warnings)
+    #
+    $FFOO_VERBOSE || return 0
+    __echo "$@"
+}
+
+
+warn() {
+    #
+    # Warn them
+    #
+    # Use "-l" to split every parameter to separate line, (useful
+    # or longer warnings)
+    #
+    # Resist  temptation to prefix "warning" or similar BS here.
+    # STDERR is *made* for warnings.
+    #
+    __echo "$@"
+}
+
+
+##----------##
+## BACK-END ##
+##----------##
+
+
+__cat() {
+    # cat without starting a process
+    while IFS= read line;
+    do echos "$line"; done
+}
+
+
+__cut_stack() {
+    #
+    # call stack except the head that fits pattern $1
+    #
+    local patt=${1:-"^__"}
+    echos "${FUNCNAME[@]}" \
+      | perl -ne "
+            my \$checking = 1;
+            while (<>) {
+                next if (\$checking and m/$patt/);
+                \$checking = 0;
+                print qq/\$_\\n/;
+            }
+        "
+}
+
+
+__echo() {
+    #
+    # A smarter echo backend
+    #
+    # A smarter backend for debug, warn, think, die and
+    # usage_is.
+    #
+    #   -c cmd      echo output of a command
+    #   -f file     echo output of a file (- for stdin)
+    #   -l line [line...] echo each line separately
+    #   -t          add stack trace to output
+    #   -u patt [patt...] convert each patt to usage pattern
+    #   -v var [var...] show contents of each var
+    #
+    local frontend  # who (of pretty.sh) was called (=> prettyprinter choice)
+    local caller    # which user's function (or script) called it
+    frontend="$(__cut_stack '^__echo' | head -1 )"
+    caller="$(
+        __cut_stack \
+            '^__echo|^warn$|^debug$|^die$|^usage$|^usage_is$|^think$' \
+            | head -1
+    )"
+    test "$frontend" == "main" && frontend=$(basename $0)
+    test "$caller" == "main" && caller=$(basename $0)
+    test "$frontend" == "usage" && frontend=usage_is
+    local prettyfn=__cat
+    local src       # which source, or "producer" (__echo_*()) to use
+    while true; do case $1 in
+        -c|--cmd)   src=cmd;   shift; break ;;
+        -f|--files) src=files; shift; break ;;
+        -l|--lines) src=lines; shift; break ;;
+        -t|--trace) src=trace; shift; break ;;
+        -u|--usage) src=usage; shift; break ;;
+        -v|--vars)  src=vars;  shift; break ;;
+        *)          src=args;         break ;;
+    esac done
+    prettyfn=_pretty_$frontend
+    case $frontend in
+        warn|debug|die|usage_is)    __echo_$src "$@" | $prettyfn >&2 ;;
+        think)                      __echo_$src "$@" | $prettyfn     ;;
+        *)      echo "do not call __echo* directly: $frontend" >&2;
+                exits_usage                                          ;;
+    esac
+}
+
+
+__echo_args() {
+    echos "$@"
+}
+
+
+__echo_cmd() {
+    local c=\$
+    test $(id -u) -eq 0 && c=\#
+    echo "$c $*"
+    $@
+    echo "^ exit status: $?"
+}
+
+
+__echo_files() {
+    local fp
+    for fp in "$@";
+    do
+        test -s "$fp" || continue
+        echo "-- $fp --"
+        cat $fp
+    done
+}
+
+
+__echo_lines() {
+    local l;
+    for l in "$@"; do __echo "$l"; done
+}
+
+
+__echo_trace() {
+    $FFOO_DEBUG || return 0
+    echo "== trace =="
+    caller | sed -e 's/^/-> /g'
+}
+
+
+__echo_usage() {
+    local u
+    for u in "$@";
+    do echo "usage: $caller $u"
+    done
+}
+
+
+__echo_vars() {
+    local vn
+    for vn in "$@";
+    do
+        local heel="${vn:0-1}"          # last char
+        local toes="${vn%%$heel}"       # all but last char
+        case "$heel" in
+            @)
+                # FIXME: review+fix the eval (even at cost of
+                #        dropping the feature)
+                local vars="$(eval "echos \"\${!$toes$heel}\"")"
+                __echo_vars "$vars"
+                ;;
+            *)
+                __echo "$vn='$(echos "${!vn}")'"
+                ;;
+        esac
+    done
+}

include/recon.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
-ffoo import core
 ffoo import misc
+ffoo import pretty
 
 
 age_of_leaf() {

include/testing.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-ffoo import core
+ffoo import pretty
 ffoo import tmp
 
 

include/types.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-ffoo import core
+ffoo import pretty
 
 
 is_integer() {

notes/TODO.md

@@ -49,8 +49,8 @@ test
 *   write some tests!
 
 
-core.sh
--------
+pretty.sh
+---------
 
 *   add -name arg to debug, e.g. for pipe/cmd/file and use it in
     pretty

notes/guidelines.md

@@ -50,7 +50,7 @@ API
     success or error type
 
 *   use 1 for "no", 2 for syntax error (if applicable), more
-    otherwise;  note that ffoo core.die uses 9 as a generic
+    otherwise;  note that ffoo pretty.die uses 9 as a generic
     status
 
 

notes/packaging.md

@@ -36,7 +36,6 @@ No modules, just ffoo.sh and supporting binaries.
 
 ### ffoo-core ###
 
- *  core
  *  error
  *  pretty
  *  _pretty_color

test/data/ffoo_api/functions.oracle.stdout

@@ -23,23 +23,6 @@ config.__cfgrep__fltsct
 config.__cfgrep__load
 config.__cfgrep__merge
 config.cfgrep
-core.__cat
-core.__cut_stack
-core.__echo
-core.__echo_args
-core.__echo_cmd
-core.__echo_files
-core.__echo_lines
-core.__echo_trace
-core.__echo_usage
-core.__echo_vars
-core.debug
-core.debug_pipe
-core.die
-core.echos
-core.think
-core.usage_is
-core.warn
 exits.exit_error
 exits.exit_no
 exits.exit_ok
@@ -58,7 +41,24 @@ misc.expand_tilde
 misc.filter
 misc.mute_known
 misc.select_args
+pretty.__cat
+pretty.__cut_stack
+pretty.__echo
+pretty.__echo_args
+pretty.__echo_cmd
+pretty.__echo_files
+pretty.__echo_lines
+pretty.__echo_trace
+pretty.__echo_usage
+pretty.__echo_vars
 pretty.__ffoo_pretty__init
+pretty.debug
+pretty.debug_pipe
+pretty.die
+pretty.echos
+pretty.think
+pretty.usage_is
+pretty.warn
 recon.age_of_leaf
 recon.age_of_tree
 recon.cat_uri

test/data/ffoo_api/modules.oracle.stdout

@@ -3,7 +3,6 @@ _pretty_html
 _pretty_plain
 charmenu
 config
-core
 exits
 misc
 pretty