File: clean.sh
   1 #!/bin/sh
   2 
   3 # The MIT License (MIT)
   4 #
   5 # Copyright (c) 2026 pacman64
   6 #
   7 # Permission is hereby granted, free of charge, to any person obtaining a copy
   8 # of this software and associated documentation files (the "Software"), to deal
   9 # in the Software without restriction, including without limitation the rights
  10 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11 # copies of the Software, and to permit persons to whom the Software is
  12 # furnished to do so, subject to the following conditions:
  13 #
  14 # The above copyright notice and this permission notice shall be included in
  15 # all copies or substantial portions of the Software.
  16 #
  17 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23 # SOFTWARE.
  24 
  25 
  26 # clean [options...] [command] [args...]
  27 #
  28 #
  29 # CLEAN the screen, after running the command given. When its standard output
  30 # is piped, no cleaning happens, and this script becomes a passthru.
  31 #
  32 # This tool doesn't clear the screen, but rather uses the alternative screen
  33 # buffer, so the original content of the terminal is restored when done.
  34 #
  35 # The help option is `-h`, `--h`, `-help`, or `--help`.
  36 
  37 
  38 case "$1" in
  39     -h|--h|-help|--help)
  40         awk '/^# +clean /, /^$/ { gsub(/^# ?/, ""); print }' "$0"
  41         exit 0
  42     ;;
  43 esac
  44 
  45 [ "$1" = '--' ] && shift
  46 
  47 if [ $# -eq 0 ]; then
  48     awk '/^# +clean /, /^$/ { gsub(/^# ?/, ""); print }' "$0"
  49     exit 0
  50 fi
  51 
  52 if [ -p /dev/stdout ]; then
  53     "$@"
  54     exit $?
  55 fi
  56 
  57 # restore previous screen contents when sent a SIGINT signal, which usually
  58 # happens by pressing Ctrl+C
  59 trap 'tput rmcup 2> /dev/null || printf "\e[?1049l\e[23;0;0t"; exit 130' INT
  60 
  61 tput smcup 2> /dev/null || printf "\e[?1049h\e[22;0;0t"
  62 "$@"
  63 res=$?
  64 tput rmcup 2> /dev/null || printf "\e[?1049l\e[23;0;0t"
  65 
  66 if [ "${res}" -ne 0 ]; then
  67     printf "command \"%s\" failed with error code %d\n" "$*" "${res}" >&2
  68 fi
  69 
  70 exit "${res}"