#!/bin/sh

# The MIT License (MIT)
#
# Copyright © 2020-2025 pacman64
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the “Software”), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.


# clean [options...] command [args...]
#
#
# CLEAN the screen, after running the command given. When its standard output
# is piped, no cleaning happens, and this script becomes a passthru.
#
# This tool doesn't clear the screen, but rather uses the alternative screen
# buffer, so the original content of the terminal is restored when done.
#
# The help option is `-h`, `--h`, `-help`, or `--help`.


case "$1" in
    -h|--h|-help|--help)
        awk '/^# +clean /, /^$/ { gsub(/^# ?/, ""); print }' "$0"
        exit 0
    ;;
esac

if [ -p /dev/stdout ]; then
    "$@"
    exit $?
fi

tput smcup
"$@"
res=$?
tput rmcup
exit "${res}"