Add mkhelp for --help printing

src/include/_pretty_color.sh

@@ -37,6 +37,14 @@ _pretty__die() {
 }
 
 
+_pretty__mkhelp() {
+    echo -ne "$FFOO_PRETTY_COLOR_USAGE_IS"
+    while IFS= read line;
+    do echo -e "$line"; done
+    echo -ne "$FFOO_PRETTY_COLOR_OFF"
+}
+
+
 _pretty__usage_is() {
     echo -ne "$FFOO_PRETTY_COLOR_USAGE_IS"
     while IFS= read line;

src/include/_pretty_html.sh

@@ -13,6 +13,12 @@ _pretty__die() {
 }
 
 
+_pretty__mkhelp() {
+    while IFS= read line;
+    do echo "<p class='usage'>$line</p>"; done
+}
+
+
 _pretty__usage_is() {
     while IFS= read line;
     do echo "<p class='usage'>$line</p>"; done

src/include/_pretty_plain.sh

@@ -11,6 +11,11 @@ _pretty__die() {
     do echo "$line"; done
 }
 
+_pretty__mkhelp() {
+    while IFS= read line;
+    do echo "$line"; done
+}
+
 _pretty__usage_is() {
     while IFS= read line;
     do echo "$line"; done

src/include/pretty.sh

@@ -135,6 +135,44 @@ usage_is() {
 }
 
 
+mkhelp() {
+    #
+    # Echo out help text
+    #
+    #     mkhelp line...
+    #
+    # Each argument as a separate line.  This makes it easy to
+    # print out bigger amount of text and still keep your script
+    # relatively clean:
+    #
+    #     mkhelp  "line1" \
+    #             "line2" \
+    #             "line3" \
+    #             "line4"
+    #
+    # By default, will exit with status *FFOO_EXIT_OK*, you
+    # can use `-e STATUS` to specify other number.
+    #
+    # Use `-E` to prevent exiting; in that case, the status
+    # that would be fed to `exit` will be used as exit status
+    # of this function.
+    #
+    # Use "--" to delimit end of arguments processed by mkhelp
+    #
+    local es=$FFOO_EXIT_OK
+    local doexit=true
+    while true; do case "$1" in
+        -e) es="$2";            shift 2      ;;
+        -E) doexit=false;       shift        ;;
+        --)                     shift; break ;;
+        *)                      break        ;;
+    esac done
+    _pretty__echo -l "$@"
+    $doexit && exit "$es"
+    return "$es"
+}
+
+
 think() {
     #
     # If verbose is on, think loud
@@ -235,7 +273,7 @@ _pretty__echo() {
     frontend="$(_pretty__cut_stack '^_pretty__echo' | head -1 )"
     caller="$(
         _pretty__cut_stack \
-            '^_pretty_|^warn$|^debug_pipe$|^debug$|^die$|^usage$|^usage_is$|^think$' \
+            '^_pretty_|^warn$|^debug_pipe$|^debug$|^die$|^mkhelp$|^usage$|^usage_is$|^think$' \
             | head -1
     )"
     test "$frontend" == "main" && frontend=$(basename $0)
@@ -254,6 +292,7 @@ _pretty__echo() {
     case $frontend in
         debug)    ;&
         die)      ;&
+        mkhelp)   ;&
         think)    ;&
         usage_is) ;&
         warn)
@@ -320,6 +359,12 @@ _pretty__echo_trace() {
 }
 
 
+_pretty__echo_help() {
+    local oldverbose="$FFOO_VERBOSE"
+    think -l "$@"
+    FFOO_VERBOSE=$oldverbose
+}
+
 _pretty__echo_usage() {
     #
     # Print each argument as usage pattern

tests/ffoo_api/oracle/functions.stdout

@@ -1,16 +1,19 @@
 _pretty_color.__ffoo__pretty_color__init
 _pretty_color._pretty__debug
 _pretty_color._pretty__die
+_pretty_color._pretty__mkhelp
 _pretty_color._pretty__think
 _pretty_color._pretty__usage_is
 _pretty_color._pretty__warn
 _pretty_html._pretty__debug
 _pretty_html._pretty__die
+_pretty_html._pretty__mkhelp
 _pretty_html._pretty__think
 _pretty_html._pretty__usage_is
 _pretty_html._pretty__warn
 _pretty_plain._pretty__debug
 _pretty_plain._pretty__die
+_pretty_plain._pretty__mkhelp
 _pretty_plain._pretty__think
 _pretty_plain._pretty__usage_is
 _pretty_plain._pretty__warn
@@ -34,6 +37,7 @@ pretty._pretty__cut_stack
 pretty._pretty__echo
 pretty._pretty__echo_args
 pretty._pretty__echo_cmd
+pretty._pretty__echo_help
 pretty._pretty__echo_files
 pretty._pretty__echo_lines
 pretty._pretty__echo_trace
@@ -44,6 +48,7 @@ pretty.debug
 pretty.debug_pipe
 pretty.die
 pretty.echos
+pretty.mkhelp
 pretty.think
 pretty.usage_is
 pretty.warn