Support removing on-exit calls

Author: CodingMarkus

lib/psst/basic/onexit.inc.sh

@@ -2,7 +2,7 @@
 
 # Double include protection
 case "${INCLUDE_SEEN_PSST-}" in
-    *_onexit_*) return
+    *:onexit:*) return
 esac
 INCLUDE_SEEN_PSST="${INCLUDE_SEEN_PSST-}:onexit:"
 
@@ -16,8 +16,31 @@ INCLUDE_SEEN_PSST="${INCLUDE_SEEN_PSST-}:onexit:"
 # shellcheck source=esc.inc.sh
 . "$INCLUDE_PSST/basic/esc.inc.sh"
 
-# shellcheck source=stack.inc.sh
-. "$INCLUDE_PSST/basic/stack.inc.sh"
+# shellcheck source=ifs.inc.sh
+. "$INCLUDE_PSST/basic/ifs.inc.sh"
+
+# shellcheck source=list.inc.sh
+. "$INCLUDE_PSST/basic/list.inc.sh"
+
+
+##
+# VARIABLE
+#	__OnExit_PSST
+#
+# SUMMARY
+#	List storing commands to be excuted on exit.
+#
+__OnExit_PSST=''
+
+
+##
+# VARIABLE
+#	__OnExitSet_PSST
+#
+# SUMMARY
+#	Whether on exit trap has been set already
+#
+__OnExitSet_PSST=0
 
 
 ##
@@ -31,8 +54,10 @@ INCLUDE_SEEN_PSST="${INCLUDE_SEEN_PSST-}:onexit:"
 #	codeToEval: String to be passed to `eval`.
 #
 # SAMPLE
-#	on_exit_psst "rm -rf /tmp/someTempFile.tmp"
+#	onexit_psst "rm -rf /tmp/someTempFile.tmp"
 #
+# NOTE
+#	`codeToEval` must not contain the character `$RS_CHAR_PSST`.
 onexit_psst()
 {
     # We cannot use a subshell for this function as we need to register the
@@ -42,9 +67,15 @@ onexit_psst()
 	assert_argc_psst 'onexit_psst' 1 $#
 	assert_hasarg_psst 'onexit_psst' 'codeToEval' "$1"
 
+	# shellcheck disable=SC2016
+	case $1 in
+		*$RS_CHAR_PSST*) assert_func_fail_psst "onexit_psst" \
+			'Argument "codeToEval" must not contain $RS_CHAR_PSST'
+	esac
+
     #codeToEval=$1
 
-    if ! stack_exists_psst 'onExitStack_psst'
+    if [ $__OnExitSet_PSST -eq 0 ]
     then
     	_oldtraps_onexit_psst=$( trap )
         _oldexit_onexit_psst=$(
@@ -54,23 +85,55 @@ onexit_psst()
         )
 
         if [ -n "$_oldexit_onexit_psst" ]
-            then
-           _oldexit_onexit_psst=$( esc_for_sq_psst "$_oldexit_onexit_psst" )
+        then
+           _oldexit_onexit_psst=$( esc_squotes_psst "$_oldexit_onexit_psst" )
             # shellcheck disable=SC2064
             trap "eval '$_oldexit_onexit_psst' ; __onexit_run_psst" EXIT
         else
             # shellcheck disable=SC2064
             trap '__onexit_run_psst' EXIT
         fi
 
+        __OnExitSet_PSST=1
+
         unset _oldtraps_onexit_psst
         unset _oldexit_onexit_psst
     fi
 
-    stack_push_psst 'onExitStack_psst' "$1"
+    __OnExit_PSST="$1$RS_CHAR_PSST$__OnExit_PSST"
 }
 
 
+
+##
+# FUNCTION
+#	onexit_remove_psst <codeNotToEval>
+#
+# SUMMARY
+#	Remove code to be executed when process or subprocess exists.
+#
+# PARAMETERS
+#	codeNotToEval: Code to be removed from the onexit list.
+#
+# SAMPLE
+#   # Temp file has already been deleted
+#	onexit_remove_psst "rm -rf /tmp/someTempFile.tmp"
+#
+onexit_remove_psst()
+{
+    # We cannot use a subshell for this function as we need to register the
+	# variables in the main shell. Thus we need to be careful to not conflict
+	# when defining local variables.
+
+	assert_argc_psst 'onexit_remove_psst' 1 $#
+	assert_hasarg_psst 'onexit_remove_psst' 'codeNotToEval' "$1"
+
+    #codeNotToEval=$1
+    __OnExit_PSST=$( list_remove_value_psst "$__OnExit_PSST" "$1" )
+}
+
+
+
 ##
 # FUNCTION
 #	__onexit_run_psst
@@ -87,9 +150,15 @@ __onexit_run_psst()
 	# variables in the main shell. Thus we need to be careful to not conflict
 	# when defining local variables.
 
-    _evalMe_psst=
-    while stack_pop_psst 'onExitStack_psst' _evalMe_psst
-    do
-        eval "$_evalMe_psst"
-    done
+	ifs_set_psst "$RS_CHAR_PSST"
+	for _eval_onexit_psst in $__OnExit_PSST
+	do
+		eval "$_eval_onexit_psst"
+	done
+
+	__OnExit_PSST=''
+	__OnExitSet_PSST=0
+	unset _eval_onexit_psst
+
+	set -e
 }

test/basic/bin/test_onexit.sh

@@ -14,7 +14,9 @@ fi
 # shellcheck source=../../../lib/psst/basic.inc.sh
 . "$INCLUDE_PSST/basic.inc.sh"
 
+
 # =============================================================================
+# On Exit
 
 # Must accept exactly one argument
 set +e
@@ -31,15 +33,57 @@ set +e
 [ $? = 127 ] || test_fail_psst $LINENO
 set -e
 
+# Argument must not contain  $RS_CHAR_PSST
+set +e
+( onexit_psst "$ $RS_CHAR_PSST" 2>/dev/null )
+[ $? = 127 ] || test_fail_psst $LINENO
+set -e
+
+
 # Code gets execute on exit
-[ "$( onexit_psst "echo test_success" )" = "test_success" ] \
+[ "$( onexit_psst 'printf "test_success"' )" = "test_success" ] \
 	|| test_fail_psst $LINENO
 
 
 # Multiple evaluations are possible
 multi=$(
-	onexit_psst "printf \"test1\""
-	onexit_psst "printf \"test2\""
+	onexit_psst 'printf "test1"'
+	onexit_psst 'printf "test2"'
 )
-{ [ "$multi" = "test1test2" ] || [ "$multi" = "test2test1" ]; } \
-	|| test_fail_psst $LINENO
+[ "$multi" = "test2test1" ] || test_fail_psst $LINENO
+
+
+
+# =============================================================================
+# On Exit Remvoe
+
+# Must accept exactly one argument
+set +e
+( onexit_remove_psst 2>/dev/null )
+[ $? = 127 ] || test_fail_psst $LINENO
+
+( onexit_remove_psst 1 2  2>/dev/null )
+[ $? = 127 ] || test_fail_psst $LINENO
+set -e
+
+# Argument must not be empty
+set +e
+( onexit_remove_psst '' 2>/dev/null )
+[ $? = 127 ] || test_fail_psst $LINENO
+set -e
+
+
+# Removed code is not executed
+multi=$(
+	onexit_psst 'printf "test1"'
+	onexit_psst 'printf "test2"'
+	onexit_remove_psst 'printf "test2"'
+)
+[ "$multi" = "test1" ] || test_fail_psst $LINENO
+
+multi=$(
+	onexit_psst 'printf "test1"'
+	onexit_psst 'printf "test2"'
+	onexit_remove_psst 'printf "test1"'
+)
+[ "$multi" = "test2" ] || test_fail_psst $LINENO