#!/bin/sh

# The MIT License (MIT)
#
# Copyright (c) 2026 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 options are, available both in single and double-dash versions
#
#   -h, -help       show this help message
#   -v, -verbose    show error code if command given fails


verbose=0

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

    -v|--v|-verbose|--verbose)
        verbose=1
        shift
    ;;
esac

[ "$1" = '--' ] && shift

if [ $# -eq 0 ]; then
    awk '/^# +clean /, /^$/ { gsub(/^# ?/, ""); print }' "$0"
    exit 0
fi

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

# restore previous screen contents when sent a SIGINT signal, which usually
# happens by pressing Ctrl+C
trap 'tput rmcup 2> /dev/null || printf "\e[?1049l\e[23;0;0t"; exit 130' INT

tput smcup 2> /dev/null || printf "\e[?1049h\e[22;0;0t"
"$@"
res=$?
tput rmcup 2> /dev/null || printf "\e[?1049l\e[23;0;0t"

if [ "${verbose}" -eq 1 ] && [ "${res}" -ne 0 ]; then
    printf "command \"%s\" failed with error code %d\n" "$*" "${res}" >&2
fi

exit "${res}"