File: sbs.sh
   1 #!/bin/sh
   2 
   3 # The MIT License (MIT)
   4 #
   5 # Copyright © 2025 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 # sbs [column count...] [filepaths...]
  27 #
  28 # Side-By-Side lays out lines read from all inputs given into several columns,
  29 # separating them with a special symbol. If no named inputs are given, lines
  30 # are read from the standard input, instead of files.
  31 #
  32 # If a column-count isn't given, the script tries to find the most columns
  33 # which can fit a reasonable width-limit; when even a single column can't fit
  34 # that limit, it simply emits all lines, which is the same as using 1 column.
  35 
  36 
  37 case "$1" in
  38     -h|--h|-help|--help)
  39         awk '/^# +sbs /, /^$/ { gsub(/^# ?/, ""); print }' "$0"
  40         exit 0
  41     ;;
  42 esac
  43 
  44 num_columns=0
  45 if [ "$(echo "$1" | grep -E '^[+-]?[0-9]+$' 2> /dev/null)" ]; then
  46     num_columns="$1"
  47     shift
  48 fi
  49 
  50 fancy_sep=1
  51 case "$1" in
  52     -no-sep|--no-sep|-s|--s|-simple|--simple)
  53         fancy_sep=0
  54         shift
  55     ;;
  56 esac
  57 
  58 [ "$1" = "--" ] && shift
  59 
  60 # show all non-existing files given
  61 failed=0
  62 for arg in "$@"; do
  63     if [ "${arg}" = "-" ]; then
  64         continue
  65     fi
  66     if [ ! -e "${arg}" ]; then
  67         printf "\e[38;2;204;0;0mno file named \"%s\"\e[0m\n" "${arg}" >&2
  68         failed=1
  69     fi
  70 done
  71 
  72 # in case of errors, avoid showing an empty screen
  73 if [ "${failed}" -gt 0 ]; then
  74     exit 2
  75 fi
  76 
  77 command='awk'
  78 if [ -e /usr/bin/gawk ]; then
  79     command='gawk'
  80 fi
  81 
  82 # allow loading lines from multiple files, ensuring no lines are accidentally
  83 # joined across inputs
  84 awk 1 "$@" |
  85 
  86 # ignore leading UTF-8 BOMs (byte-order marks) and trailing carriage-returns:
  87 # the latter in particular will ruin side-by-side output; doing it separately
  88 # using `sed` is faster overall for the script
  89 sed 's-^\xef\xbb\xbf--; s-\r$--' |
  90 
  91 # before laying out lines side-by-side, expand all tabs, using 4 as the
  92 # tabstop width
  93 expand -t 4 |
  94 
  95 # lay lines into side-by-side columns
  96 ${command} -v fancy="${fancy_sep}" -v num_columns="${num_columns}" '
  97     BEGIN {
  98         sep = fancy ? " █" : " "
  99         sep_width = width(sep)
 100         total_max_width = 79
 101         max_auto_cols = 26
 102 
 103         # num_columns = 0
 104         # detect a leading number, and use it as the max-number of columns
 105         if (ARGV[1] + 0 != 0) {
 106             num_columns = ARGV[1] + 0
 107             delete ARGV[1]
 108         }
 109     }
 110 
 111     # remember all lines; carriage-returns are already removed
 112     { lines[NR] = $0 }
 113 
 114     # width counts items in the string given, ignoring ANSI-style sequences
 115     function width(s) {
 116         gsub(/\x1b\[[0-9;]*[A-Za-z]/, "", s)
 117         return length(s)
 118     }
 119 
 120     # pick a line using a row-column pair as an index
 121     function pick(lines, height, row, col) {
 122         return lines[(col - 1) * height + row]
 123     }
 124 
 125     # see if a list of lines can fit the number of columns given exactly
 126     function fits(lines, line_count, num_cols, height, max_widths, i, j, w, l) {
 127         height = ceil(line_count / num_cols)
 128 
 129         # prevent too many empty columns
 130         if (height * num_cols - line_count >= height) {
 131             return 0
 132         }
 133 
 134         for (i = 1; i <= height; i++) {
 135             for (j = 1; j <= num_cols; j++) {
 136                 w = width(pick(lines, height, i, j))
 137                 if (w > total_max_width) return 0
 138                 if (max_widths[j] < w) max_widths[j] = w
 139             }
 140         }
 141 
 142         for (i = 1; i <= height; i++) {
 143             w = 0
 144 
 145             for (j = 1; j <= num_cols; j++) {
 146                 if (j > 1) w += sep_width
 147 
 148                 l = pick(lines, height, i, j)
 149                 if (j > 1 && l != "") w++
 150 
 151                 w += width(l)
 152 
 153                 if (j < num_cols) {
 154                     pad = max_widths[j] - width(l)
 155                     if (pad > 0) {
 156                         if (l == "") pad++
 157                         w += pad
 158                     }
 159                 }
 160 
 161                 if (w > total_max_width) return 0
 162             }
 163         }
 164 
 165         return 1
 166     }
 167 
 168     # auto-detect an appropriate column-count for the list of lines given
 169     function find_max_fit(lines, num_columns) {
 170         if (!fits(lines, NR, 1)) {
 171             return 1
 172         }
 173 
 174         for (num_columns = max_auto_cols; num_columns >= 2; num_columns--) {
 175             if (fits(lines, NR, num_columns)) {
 176                 return num_columns
 177             }
 178         }
 179         return 1
 180     }
 181 
 182     # round up non-integers
 183     function ceil(n) {
 184         return (n % 1) ? n - (n % 1) + 1 : n
 185     }
 186 
 187     END {
 188         # prevent errors when input has no lines
 189         if (NR < 1) exit
 190 
 191         # auto-fit when given a non-positive count, or when not given a count
 192         if (num_columns < 1) num_columns = find_max_fit(lines)
 193 
 194         # prevent column-count from exceeding the number of input lines
 195         if (num_columns > NR) num_columns = NR
 196 
 197         # emit a single column as lines, quitting right away
 198         if (num_columns < 2) {
 199             for (i = 1; i <= NR; i++) print lines[i]
 200             exit
 201         }
 202 
 203         # prevent a trailing empty column
 204         num_lines = ceil(NR / num_columns)
 205         if (num_lines * num_columns - NR >= num_lines) {
 206             num_columns--
 207         }
 208 
 209         num_lines = ceil(NR / num_columns)
 210         for (i = 1; i <= num_lines; i++) {
 211             for (j = 1; j <= num_columns; j++) {
 212                 w = width(pick(lines, num_lines, i, j))
 213                 if (max_widths[j] < w) max_widths[j] = w
 214             }
 215         }
 216 
 217         widest = 0
 218         for (i in max_widths) {
 219             if (widest < max_widths[i]) widest = max_widths[i]
 220         }
 221 
 222         # emit lines side by side
 223         for (i = 1; i <= num_lines; i++) {
 224             for (j = 1; j <= num_columns; j++) {
 225                 l = pick(lines, num_lines, i, j)
 226 
 227                 if (j > 1) {
 228                     printf "%s", sep
 229                     if (j != num_columns || l != "") printf " "
 230                 }
 231 
 232                 printf "%s", l
 233 
 234                 if (j < num_columns) {
 235                     pad = max_widths[j] - width(l)
 236                     if (pad > 0) printf "%*s", pad, ""
 237                 }
 238             }
 239 
 240             print ""
 241         }
 242     }
 243 ' |
 244 
 245 # view the result interactively
 246 less -MKiCRS