* up to date README.md and RELEASENOTES.md

* fixed assertion code in rmdir_safer
* r_absolutepath will now fail if it can't figure out the working directory for a provided relative path (empty path is OK but returns 1)

Author: mulle-nat

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required (VERSION 3.13)
 
-project( mulle-bashfunctions VERSION 6.6.1 LANGUAGES NONE)
+project( mulle-bashfunctions VERSION 6.6.2 LANGUAGES NONE)
 
 
 #

README.md

@@ -20,6 +20,19 @@ tested on **Debian**, **FreeBSD**, **macOS**, **Manjaro**, **MinGW**,
 
 ## Developer Guide
 
+### Use mulle-bashfunctions in an old bash script
+
+Add this near the top of your script. This will load the default set of
+mulle-bashfunctions:
+
+
+``` bash
+eval "`mulle-bashfunctions load --if-missing `"
+[ -z "${MULLE_BASHGLOBAL_SH}" ] && exit 1
+```
+
+### Create a new mulle-bash script
+
 To create a new mulle-bashfunctions script say:
 
 ``` sh
@@ -29,7 +42,7 @@ chmod +x my-script.sh
 
 Use **mulle-bashfunctions** also for discovery and documentation of the
 available functions. Lets say you want to produce identifiers
-for abitrary strings. You can use `apropos` to discover functionality:
+for arbitrary strings. You can use `apropos` to discover functionality:
 
 ``` sh
 mulle-bashfunctions apropos identifier
@@ -99,40 +112,47 @@ Use `include "<name>"` to get access to the functions not included in
 Usage:
    mulle-bashfunctions [command]
 
-   mulle-bashfunctions main purpose is to help load the library functions
-   into an interactive shell. The library functions are almalgamated in a
-   file called "mulle-bashfunctions.sh". There are variants though (none,
-   minimal, all) with different sizes.
-
-   But mulle-bashfunctions can also
+   Use mulle-bashfunctions to
 
+   * load the mulle-bashfunctions into an interactive shell
+   * show documentation for the provided shell functions
    * embed "mulle-bashfunctions.sh" into another shell script
    * show the path to "mulle-bashfunctions.sh"
    * locate the "mulle-bashfunctions.sh" install path for a desired variant
-   * show documentation for any of the defined functions
    * list the available libraries, which you can "include"
    * run an arbitrary mulle-bashfunction with eval and r-eval
+   * get some information about the execution environment
 
-Examples:
-   Load "mulle-bashfunctions-all.sh" into the current interactive shell:
+Example:
+   Load mulle-bashfunctions into the current interactive shell:
 
       eval `mulle-bashfunctions load all`
 
+   Now try out an r_function, a function which returns a value in the global
+   variable RVAL:
+
+      r_escaped_json '{ "url": "https://www.mulle-kybernetik.com" }'
+      echo $RVAL
+
 Commands:
    apropos <f>    : search for a function by keywords
    embed          : embed mulle-bashfunctions into a script
+   common-unames  : list of known values for uname
    env            : print environment needed for "mulle-bashfunctions.sh"
    eval <cmd>     : evaluate cmd inside of mulle-bashfunctions
+   globals [-a]   : list global MULLE_ prefixed variables, -a for all globals
    functions      : list defined functions
    hostname       : show system hostname as used by mulle-bashfunctions
    libraries      : list available libraries
-   load [variant] : use  eval `mulle-bashfunctions load`  to load
+   load [variant] : eval `mulle-bashfunctions load <none|minimal|all>`
    man <function> : show documention for function, if available
    new <name>     : prints a mulle-bash shell script
    path [variant] : path to "mulle-bashfunctions.sh"
    r-eval <cmd>   : evaluate cmd inside of mulle-bashfunctions and print RVAL
+   shell          : path of executing shell
    username       : show username as used by mulle-bashfunctions
    uname          : show system short name as used by mulle-bashfunctions
+   uuid           : generate a UUID
    version        : print currently used version
    versions       : list installed versions
 

RELEASENOTES.md

@@ -1,3 +1,23 @@
+### 6.6.2
+
+* up to date README.md and RELEASENOTES.md
+* fixed assertion code in `rmdir_safer`
+* `r_absolutepath` will now fail if it can't figure out the working directory for a provided relative path (empty path is OK but returns 1)
+
+### 6.6.1
+
+* fixed filepath_contains_filepath for the '.' directory where foo.sh now matches
+
+## 6.6.0
+
+* fix IFS restore in r_reverse_lines
+* add filepath_contains_filepath function to check if a path contains another
+* add r_url_path_encode function that preserves forward slashes
+* improve PATH fallback in mulle-bash
+* add globals command to list MULLE_ variables
+* fix dir_list_files IFS restore
+* fix sed and grep escaping painfully for zsh
+ 
 ### 6.5.1
 
 * updated sed escaping for mulle-template

cola/api.md.bud

@@ -1,5 +1,18 @@
 ## Developer Guide
 
+### Use mulle-bashfunctions in an old bash script
+
+Add this near the top of your script. This will load the default set of
+mulle-bashfunctions:
+
+
+``` bash
+eval "`mulle-bashfunctions load --if-missing `"
+[ -z "${MULLE_BASHGLOBAL_SH}" ] && exit 1
+```
+
+### Create a new mulle-bash script
+
 To create a new mulle-bashfunctions script say:
 
 ``` sh
@@ -9,7 +22,7 @@ chmod +x my-script.sh
 
 Use **mulle-bashfunctions** also for discovery and documentation of the
 available functions. Lets say you want to produce identifiers
-for abitrary strings. You can use `apropos` to discover functionality:
+for arbitrary strings. You can use `apropos` to discover functionality:
 
 ``` sh
 mulle-bashfunctions apropos identifier

mulle-bash

@@ -151,7 +151,7 @@ fi
 # this is "our" version
 # the actual loaded version may differ (and will change this variable)
 #
-MULLE_BASHFUNCTIONS_VERSION="6.6.1"
+MULLE_BASHFUNCTIONS_VERSION="6.6.2"
 MULLE_BASHFUNCTIONS_LIBEXEC_DIRNAME="libexec"
 MULLE_EXECUTABLE="$1"
 

mulle-bashfunctions

@@ -1267,22 +1267,33 @@ MULLE_UNAME=\"${MULLE_UNAME}\""
 
       'load')
          local format
+         local check
 
-         [ $# -ne 0 ] && format="-$1"
+         [ $# -ne 0 -a "$1" = "--if-missing" ] && check='YES' && shift
+         [ $# -ne 0 ] && format="-$1" && shift
+
+         if [ "${check}" = 'YES' ]
+         then
+            echo "if [ -z \"\${MULLE_BASHGLOBAL_SH}\" ]; then"
+         fi
 
          echo "\
-MULLE_BASHFUNCTIONS_LIBEXEC_DIR=\"${MULLE_BASHFUNCTIONS_LIBEXEC_DIR}\" ;
-export MULLE_BASHFUNCTIONS_LIBEXEC_DIR ;
-MULLE_USERNAME=\"${MULLE_USERNAME}\" ;
-export MULLE_USERNAME ;
-MULLE_HOSTNAME=\"${MULLE_HOSTNAME}\" ;
-export MULLE_HOSTNAME ;
-MULLE_UNAME=\"${MULLE_UNAME}\" ;
-export MULLE_UNAME ;
-. \"${MULLE_BASHFUNCTIONS_LIBEXEC_DIR}/mulle-bashfunctions${format}.sh\"
-"
+MULLE_BASHFUNCTIONS_LIBEXEC_DIR=\"${MULLE_BASHFUNCTIONS_LIBEXEC_DIR}\"
+export MULLE_BASHFUNCTIONS_LIBEXEC_DIR
+MULLE_USERNAME=\"${MULLE_USERNAME}\"
+export MULLE_USERNAME
+MULLE_HOSTNAME=\"${MULLE_HOSTNAME}\"
+export MULLE_HOSTNAME
+MULLE_UNAME=\"${MULLE_UNAME}\"
+export MULLE_UNAME
+. \"${MULLE_BASHFUNCTIONS_LIBEXEC_DIR}/mulle-bashfunctions${format}.sh\""
+         if [ "${check}" = 'YES' ]
+         then
+            echo "fi"
+         fi
       ;;
 
+
       'common-unames')
          cat <<EOF
 android

src/mulle-bashfunctions-all-embed.sh

@@ -3258,43 +3258,35 @@ function is_relativepath()
 
 function r_absolutepath()
 {
-  local directory="$1"
-  local working="${2:-${PWD}}"
+   local filepath="$1"
+   local working="$2"
 
-   case "${directory}" in
+   case "${filepath}" in
       "")
         RVAL=''
+        return 1
       ;;
 
       /*|~*)
-        RVAL="${directory}"
-      ;;
-
-      *)
-        RVAL="${working}/${directory}"
+        RVAL="${filepath}"
+        return 0
       ;;
    esac
+   
+   working="${working:-`pwd`}"
+   if ! is_absolutepath "${working}"
+   then
+      fail "working directory \"${working}\" must be an absolute path"
+   fi
+
+   RVAL="${working%%/}/${filepath}"
 }
 
 
 function r_simplified_absolutepath()
 {
-  local directory="$1"
-  local working="${2:-${PWD}}"
-
-   case "${1}" in
-      "")
-        RVAL=''
-      ;;
-
-      /*|~*)
-        r_simplified_path "${directory}"
-      ;;
-
-      *)
-        r_simplified_path "${working}/${directory}"
-      ;;
-   esac
+   r_absolutepath "$@"
+   r_simplified_path "${RVAL}"
 }
 
 function r_symlink_relpath()
@@ -3563,29 +3555,33 @@ function r_mkdir_parent_if_missing()
 
 function dir_is_empty()
 {
-   [ -z "$1" ] && _internal_fail "empty path"
+   local directory="$1"
+
+   [ -z "${directory}" ] && _internal_fail "empty path"
 
-   if [ ! -d "$1" ]
+   if [ ! -d "${directory}" ]
    then
       return 2
    fi
 
    local empty
 
-   empty="`ls -A "$1" 2> /dev/null`"
+   empty="`ls -A "${directory}" 2> /dev/null`"
    [ -z "$empty" ]
 }
 
 
 rmdir_safer()
 {
-   [ -z "$1" ] && _internal_fail "empty path"
+   local directory="$1"
+
+   [ -z "${directory}" ] && _internal_fail "empty path"
 
    [ $"PWD" = "${directory}" ] && fail "Refuse to remove PWD"
 
-   if [ -d "$1" ]
+   if [ -d "${directory}" ]
    then
-      r_assert_sane_path "$1"
+      r_assert_sane_path "${directory}"
 
       case "${MULLE_UNAME}" in
          'android'|'sunos')
@@ -3602,11 +3598,13 @@ rmdir_safer()
 
 rmdir_if_empty()
 {
-   [ -z "$1" ] && _internal_fail "empty path"
+   local directory="$1"
 
-   if dir_is_empty "$1"
+   [ -z "${directory}" ] && _internal_fail "empty path"
+
+   if dir_is_empty "${directory}"
    then
-      exekutor rmdir "$1"  >&2 || fail "failed to remove $1"
+      exekutor rmdir "${directory}"  >&2 || fail "failed to remove $1"
    fi
 }
 
@@ -3626,6 +3624,7 @@ _create_file_if_missing()
 
    r_dirname "${filepath}"
    directory="${RVAL}"
+
    if [ ! -z "${directory}" ]
    then
       mkdir_if_missing "${directory}"