init commit

Author: noscript

LICENSE.MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2020 Sergey Vlasov <sergey@vlasov.me>
+
+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.

Makefile

@@ -0,0 +1,13 @@
+.PHONY: all test benchmark
+.NOTPARALLEL: all
+
+pscheck: pscheck.c
+	$(CC) $(CFLAGS) -O2 -Wall -Wextra -Werror -Wconversion -pedantic -std=c99 $^ -o $@
+
+benchmark: pscheck
+	./benchmark.sh
+
+test: pscheck
+	./test.sh
+
+all: pscheck test benchmark

README.md

@@ -0,0 +1,90 @@
+# Tmux Mighty Scroll
+
+Ultimate solution to enable seamless mouse scroll in tmux.
+
+When no process running, it will scroll over the pane content. Otherwise,
+depending on process name, if will pass <kbd>↑</kbd> / <kbd>↓</kbd> or
+<kbd>Page Up</kbd> / <kbd>Page Down</kbd> keys.
+
+## Features
+
+* Works in scenarios like `$ git log`, `$ find | less`, etc.
+* Works in other applications like `fzf`, `mc`, `man`, `ranger`, `vim`, etc.
+* Works with nested environments like `chroot`.
+* Starts copy-mode automatically when no process running.
+
+## Limitations
+
+Does not work in panes with open remote connection, since there is no way to
+relay back to tmux which processes are running in remote shell.
+See `@mighty-scroll-fallback-mode`.
+
+## Requirements
+
+* Mouse mode enabled (`set -g mouse on`).
+* Linux (`/proc` file system).
+* C compiler (optional, but highly recommended).
+
+## Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
+
+Add the plugin to the list of TPM plugins in `.tmux.conf`:
+
+```
+set -g @plugin 'noscript/tmux-mighty-scroll'
+```
+
+Hit `prefix + I` to fetch the plugin and source it.
+
+## Manual Installation
+
+Clone the repo:
+
+```
+$ git clone https://github.com/noscript/tmux-mighty-scroll ~/clone/path
+```
+
+Add this line to the bottom of `.tmux.conf`:
+
+```
+run '~/clone/path/mighty-scroll.tmux'
+```
+
+Reload tmux environment:
+
+```
+$ tmux source ~/.tmux.conf
+```
+
+## Configuration
+
+|Option|Default value|Supported values|Description|
+|---|---|---|---|
+|`@mighty-scroll-interval`|`2`|Number|How many lines to scroll in `by-line` and `history` modes.|
+|`@mighty-scroll-select-pane`|`on`|`on`, `off`|If enabled, the pane being scrolled becomes automatically selected.|
+|`@mighty-scroll-by-line`|`'man less pager fzf'`|List|Space separated list of processes that will be scrolled  by line.|
+|`@mighty-scroll-by-page`|`'irssi vim'`|List|Space separated list of processes that will be scrolled by page.|
+|`@mighty-scroll-fallback-mode`|`'history'`|`'history'`, `'by-line'`, `'by-page'`|Scroll mode when in alternate screen but the process didn't match `by-line` and `by-page` lists from above.|
+
+Scrolling modes:
+
+* `history` - enter copy mode and scroll over the pane content by line.
+* `by-line` - scroll by line, the running process will receive <kbd>↑</kbd> / <kbd>↓</kbd> keys.
+* `by-page` - scroll by page, the running process will receive <kbd>Page Up</kbd> / <kbd>Page Down</kbd> keys.
+
+Example configuration:
+
+```
+set -g mouse on
+set -g @mighty-scroll-interval 3
+set -g @mighty-scroll-by-line 'man fzf'
+set -g @mighty-scroll-select-pane off
+```
+
+## Performance caveats
+
+Be sure to have a C compiler (`gcc`, `clang`) available (check with `$ cc -v`),
+otherwise a Shell implementation of the process checker will be used,
+which is about 400% slower!
+
+## License
+[MIT](LICENSE.MIT)

benchmark.sh

@@ -0,0 +1,48 @@
+set -e
+
+cd "$(dirname "$0")"
+
+TARGET_PID=$$ # PID of benchmark.sh
+RUN_NUM=100
+PAGER_CMD="man ascii"
+
+clean() {
+  if [ ! -z $SCREEN_PID ]; then
+    kill $SCREEN_PID
+  fi
+}
+trap clean 0 1 2 3 6 15
+
+run_benchmark() {
+  echo Running: \"$@\"
+  TOTAL=0
+  i=1
+  while [ "$i" -le $RUN_NUM ]; do
+    START=$(date +%s.%N)
+    eval "$@" >/dev/null
+    END=$(date +%s.%N)
+    TOTAL=$(echo "$TOTAL + $END - $START" | bc -l)
+    echo -n "\r$(( $i * 100 / $RUN_NUM ))%"
+    i=$((i + 1))
+  done
+  echo -e "\rAverage per execution (seconds): $(echo "scale=5; $TOTAL / $RUN_NUM" | bc -l | sed 's/^\./0./')"
+  echo
+}
+
+echo Execution count: $RUN_NUM
+
+echo Pager command: \"$PAGER_CMD\"
+screen -Dm $PAGER_CMD &
+SCREEN_PID=$!
+sleep 1 # give processes time to start
+
+echo Process tree:
+pstree -g $TARGET_PID
+echo
+
+run_benchmark "pstree $TARGET_PID | grep 'man\|less\|pager'"
+run_benchmark "./pscheck.sh $TARGET_PID 'man' 'less' 'pager'"
+run_benchmark "./pscheck $TARGET_PID 'man' 'less' 'pager'"
+
+kill $SCREEN_PID
+SCREEN_PID=

mighty-scroll.tmux

@@ -0,0 +1,24 @@
+CURRENT_DIR="$(cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P)"
+
+. "$CURRENT_DIR/scripts/helpers.sh"
+. "$CURRENT_DIR/scripts/variables.sh"
+
+if which cc >/dev/null 2>&1; then
+  make -f "$CURRENT_DIR/Makefile" -C "$CURRENT_DIR" >/dev/null 2>&1
+  set_tmux_environment "PSCHECK" "$CURRENT_DIR/pscheck"
+else
+  set_tmux_environment "PSCHECK" "$CURRENT_DIR/pscheck.sh"
+fi
+
+set_tmux_environment "MIGHTY_SCROLL_INTERVAL" "$(get_tmux_option "$interval_option" "$interval_default")"
+set_tmux_environment "MIGHTY_SCROLL_BY_LINE" "$(get_tmux_option "$by_line_option" "$by_line_default")"
+set_tmux_environment "MIGHTY_SCROLL_BY_PAGE" "$(get_tmux_option "$by_page_option" "$by_page_default")"
+set_tmux_environment "MIGHTY_SCROLL_FALLBACK_MODE" "$(get_tmux_option "$fallback_mode_option" "$fallback_mode_default")"
+
+if [ "$(get_tmux_option "$select_pane_option" "$select_pane_default")" = "on" ]; then
+  set_tmux_environment "MIGHTY_SCROLL_SELECT_PANE" "true"
+else
+  set_tmux_environment "MIGHTY_SCROLL_SELECT_PANE" "false"
+fi
+
+tmux source-file "$CURRENT_DIR/tmux.conf"

pscheck.c

@@ -0,0 +1,66 @@
+// Copyright (C) 2020 Sergey Vlasov <sergey@vlasov.me>
+// MIT License
+
+#define _GNU_SOURCE
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#define BUF_LEN 512
+char path_buf[BUF_LEN];
+
+void read_file(char *path, char *buf)
+{
+    buf[0] = '\0';
+
+    FILE *f = fopen(path, "r");
+    if (!f) { // process no longer exists or something else
+        return;
+    }
+
+    size_t size = fread(buf, sizeof(char), BUF_LEN, f);
+    if (size > 0) {
+        buf[size - 1] = '\0';
+    }
+    fclose(f);
+}
+
+void walk(char *pids, int namesc, char *namesv[])
+{
+    char read_buf[BUF_LEN];
+    char *save_ptr = pids;
+    char *pid = strtok_r(pids, " ", &save_ptr);
+    while (pid) {
+        snprintf(path_buf, BUF_LEN, "/proc/%s/comm", pid);
+        read_file(path_buf, read_buf);
+        if (read_buf[0] != '\0') {
+            for (int i = 0; i < namesc; ++i) {
+                if (!strcmp(read_buf, namesv[i])) { // it's a match
+                    printf("%s\n", namesv[i]);
+                    exit(0);
+                }
+            }
+
+            snprintf(path_buf, BUF_LEN, "/proc/%s/task/%s/children", pid, pid);
+            read_file(path_buf, read_buf);
+            if (read_buf[0] != '\0') {
+                walk(read_buf, namesc, namesv);
+            }
+        }
+
+        pid = strtok_r(NULL, " ", &save_ptr);
+    }
+}
+
+int main(int argc, char *argv[])
+{
+    if (argc < 3) {
+        printf("%s: too few arguments\n", argv[0]);
+        printf("usage: %s PID NAME...\n", argv[0]);
+        return 2;
+    }
+    // command names start from 3rd argument
+    walk(argv[1], argc - 2, argv + 2);
+
+    return 1;
+}

pscheck.sh

@@ -0,0 +1,37 @@
+# Copyright (C) 2020 Sergey Vlasov <sergey@vlasov.me>
+# MIT License
+
+set -e
+
+if [ $# -lt 3 ]; then
+  BASENAME=$(basename $0)
+  echo "$BASENAME: too few arguments"
+  echo "usage: $BASENAME PID NAME..."
+  exit 2
+fi
+
+PID=$1; shift
+NAMES=$@
+
+walk() {
+  for P in $@; do
+    if [ ! -f /proc/$P/comm ]; then # process no longer exists or something else
+      continue
+    fi
+    CMD_NAME=$(cat /proc/$P/comm)
+    for N in $NAMES; do
+      if [ "$N" = "$CMD_NAME" ]; then # it's a match
+        echo "$N"
+        exit 0
+      fi
+    done
+
+    CHILDREN=$(cat /proc/$P/task/$P/children)
+    if [ ! -z "$CHILDREN" ]; then
+      walk $CHILDREN
+    fi
+  done
+}
+
+walk $PID
+exit 1

scripts/helpers.sh

@@ -0,0 +1,16 @@
+get_tmux_option() {
+  local option="$1"
+  local default_value="$2"
+  local option_value="$(tmux show-option -gqv "$option")"
+  if [ -z "$option_value" ]; then
+    echo "$default_value"
+  else
+    echo "$option_value"
+  fi
+}
+
+set_tmux_environment() {
+  local option="$1"
+  local value="$2"
+  tmux set-environment -g "$option" "$value"
+}

scripts/variables.sh

@@ -0,0 +1,14 @@
+interval_option="@mighty-scroll-interval"
+interval_default="2"
+
+select_pane_option="@mighty-scroll-select-pane"
+select_pane_default="on"
+
+by_line_option="@mighty-scroll-by-line"
+by_line_default="man less pager fzf"
+
+by_page_option="@mighty-scroll-by-page"
+by_page_default="irssi vim"
+
+fallback_mode_option="@mighty-scroll-fallback-mode"
+fallback_mode_default="history"

test.sh

@@ -0,0 +1,52 @@
+set -e
+
+cd "$(dirname "$0")"
+
+TARGET_PID=$$ # PID of benchmark.sh
+
+clean() {
+  if [ ! -z $SCREEN_PID ]; then
+    kill $SCREEN_PID
+  fi
+}
+trap clean 0 1 2 3 6 15
+
+run_test() {
+  EXPECTED_EXIT_CODE=$1; shift
+  echo -n Running: \"$@\"
+  (
+    set +e
+    eval "$@" >/dev/null
+    EXIT_CODE=$?
+    if [ "$EXIT_CODE" != "$EXPECTED_EXIT_CODE" ]; then
+      echo " : exit code $EXIT_CODE != $EXPECTED_EXIT_CODE"
+      exit 1
+    fi
+    echo " : passed, exit code $EXIT_CODE"
+  )
+}
+
+run_suit() {
+  EXPECTED_EXIT_CODE=$1; shift
+  echo Pager command: \"$@\"
+  echo Expected exit code: $EXPECTED_EXIT_CODE
+
+  screen -Dm "$@" &
+  SCREEN_PID=$!
+  sleep 1 # give processes time to start
+
+  echo Process tree:
+  pstree -g $TARGET_PID
+  echo
+
+  run_test $EXPECTED_EXIT_CODE "pstree $TARGET_PID | grep 'man\|less\|pager'"
+  run_test $EXPECTED_EXIT_CODE "./pscheck.sh $TARGET_PID 'man' 'less' 'pager'"
+  run_test $EXPECTED_EXIT_CODE "./pscheck $TARGET_PID 'man' 'less' 'pager'"
+
+  kill $SCREEN_PID
+  SCREEN_PID=
+  echo
+}
+
+run_suit 0 man ascii
+run_suit 1 bash