xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
6990270005
kakoune/rc/windowing/screen.kak

77 lines
2.5 KiB
Plaintext
Raw Normal View History

Integration with GNU screen; based on tmux.kak - Hack: kak sets `/proc/self/fd/0 -> /dev/null`. Get the client process tty because Screen needs to know the controlling terminal. Else Screen will use the last known tty and will open new windows on a different terminal if one is connected.
2017-09-23 16:26:57 +02:00
# http://gnu.org/software/screen/
# ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
Change cleanup of base/ languages to use a simpler hook -once
2018-11-28 10:39:15 +01:00
Integration with GNU screen; based on tmux.kak - Hack: kak sets `/proc/self/fd/0 -> /dev/null`. Get the client process tty because Screen needs to know the controlling terminal. Else Screen will use the last known tty and will open new windows on a different terminal if one is connected.
2017-09-23 16:26:57 +02:00
Modified base files to use modules
2019-03-13 19:15:59 +01:00
provide-module screen %{
Implement smarter detection of windowing environments. This patch centralises the loading of windowing environments, in order to ensure that by default only a single module is loaded, rather than the current code which can load multiple potentially incompatible modules; and in order to provide the user with more control over the loading of windowing modules. The patch introduces a new str-list option `windowing_modules` which defines an ordered list of windowing modules to attempt to load. Modules are loaded in the order specified in the list until a module loads without error, at which point the process finishes. When loaded each windowing module tests the environment to determine whether it should load (e.g. the tmux module tests to see if it's being run within a tmux session), and if it determines that it should then it completes its loading without error. If it doesn't detect an appropriate environment then it returns an error, and the module loading logic tries the next module. The user can override the default `windowing_modules` list to specify their preferred modules (i.e. they can put kitty ahead of tmux if that's their preference, or they can leave out the x11 modules alltogether). In addition, if the `windowing_modules` option is an empty list this bypasses the environment detection logic completely, and allows the modules to be loaded manually - this allows a user to replace the windowing module loading logic with their own manual set up.
2020-07-05 04:02:59 +02:00
# ensure that we're running under screen
evaluate-commands %sh{
Fix syntax errors.
2020-07-06 13:55:54 +02:00
[ -z "${kak_opt_windowing_modules}" ] || [ -n "$STY" ] || echo 'fail screen not detected'
Implement smarter detection of windowing environments. This patch centralises the loading of windowing environments, in order to ensure that by default only a single module is loaded, rather than the current code which can load multiple potentially incompatible modules; and in order to provide the user with more control over the loading of windowing modules. The patch introduces a new str-list option `windowing_modules` which defines an ordered list of windowing modules to attempt to load. Modules are loaded in the order specified in the list until a module loads without error, at which point the process finishes. When loaded each windowing module tests the environment to determine whether it should load (e.g. the tmux module tests to see if it's being run within a tmux session), and if it determines that it should then it completes its loading without error. If it doesn't detect an appropriate environment then it returns an error, and the module loading logic tries the next module. The user can override the default `windowing_modules` list to specify their preferred modules (i.e. they can put kitty ahead of tmux if that's their preference, or they can leave out the x11 modules alltogether). In addition, if the `windowing_modules` option is an empty list this bypasses the environment detection logic completely, and allows the modules to be loaded manually - this allows a user to replace the windowing module loading logic with their own manual set up.
2020-07-05 04:02:59 +02:00
}
Rework 'terminal' commands * Arguments of the kakoune command are now preserved in the shell call * Escaping logic is moved from 'new' to 'terminal'
2018-12-21 18:14:28 +01:00
define-command screen-terminal-impl -hidden -params 3.. %{
Expose a 'terminal' command for the various windowing systems It allows plugins to create generic terminal using the user's preferred windowing system For example, it can be used to run fzf, gdb or simply a shell. * 'new' commands are refactored to simply use the 'terminal' one * style and docstrings has been unified * all windowing systems go through "sh -c" for consistency purposes, even if unnecessary
2018-12-02 13:59:45 +01:00
nop %sh{
Integration with GNU screen; based on tmux.kak - Hack: kak sets `/proc/self/fd/0 -> /dev/null`. Get the client process tty because Screen needs to know the controlling terminal. Else Screen will use the last known tty and will open new windows on a different terminal if one is connected.
2017-09-23 16:26:57 +02:00
tty="$(ps -o tty ${kak_client_pid} | tail -n 1)"
Expose a 'terminal' command for the various windowing systems It allows plugins to create generic terminal using the user's preferred windowing system For example, it can be used to run fzf, gdb or simply a shell. * 'new' commands are refactored to simply use the 'terminal' one * style and docstrings has been unified * all windowing systems go through "sh -c" for consistency purposes, even if unnecessary
2018-12-02 13:59:45 +01:00
screen -X eval "$1" "$2"
Rework 'terminal' commands * Arguments of the kakoune command are now preserved in the shell call * Escaping logic is moved from 'new' to 'terminal'
2018-12-21 18:14:28 +01:00
shift 2
# see x11.kak for what this achieves
args=$(
for i in "$@"; do
Handle spawning iTerm and screen commands with arguments containing newlines Before, sed would add quotes to every line of the single multiline argument, causing the final quoted argument to "split ... command" or screen to contain unquoted newlines such as this (from kakoune-cr): tell application "iTerm" tell current session of current window tell (split vertically with same profile command "env PATH='...' 'sh' '-c' '' ' export KAKOUNE_SESSION=$1' ' export KAKOUNE_CLIENT=$2' ' shift 3' '' ' [ $# = 0 ] && set \"$SHELL\"' '' ' \"sh\"' ' ' '--' '51909' 'client0' 'terminal' ") to select end tell end tell Instead of using sed to do this which operates on single lines at a time, simply use printf to insert ' quotes before and after the entire argument.
2022-11-20 02:13:34 +01:00
printf "'%s' " "$(printf %s "$i" | sed "s|'|'\\\\''|g")"
Rework 'terminal' commands * Arguments of the kakoune command are now preserved in the shell call * Escaping logic is moved from 'new' to 'terminal'
2018-12-21 18:14:28 +01:00
done
)
screen -X screen sh -c "${args} ; screen -X remove" < "/dev/$tty"
Integration with GNU screen; based on tmux.kak - Hack: kak sets `/proc/self/fd/0 -> /dev/null`. Get the client process tty because Screen needs to know the controlling terminal. Else Screen will use the last known tty and will open new windows on a different terminal if one is connected.
2017-09-23 16:26:57 +02:00
}
}
Add a complete-command command to configure command completion This makes it possible to change command completion in hooks and paves the way to more flexibility in how custom commands can be completed
2022-02-22 10:14:47 +01:00
define-command screen-terminal-vertical -params 1.. -docstring '
Rework 'terminal' commands * Arguments of the kakoune command are now preserved in the shell call * Escaping logic is moved from 'new' to 'terminal'
2018-12-21 18:14:28 +01:00
screen-terminal-vertical <program> [<arguments>] [<arguments>]: create a new terminal as a screen pane
Expose a 'terminal' command for the various windowing systems It allows plugins to create generic terminal using the user's preferred windowing system For example, it can be used to run fzf, gdb or simply a shell. * 'new' commands are refactored to simply use the 'terminal' one * style and docstrings has been unified * all windowing systems go through "sh -c" for consistency purposes, even if unnecessary
2018-12-02 13:59:45 +01:00
The current pane is split into two, left and right
Rework 'terminal' commands * Arguments of the kakoune command are now preserved in the shell call * Escaping logic is moved from 'new' to 'terminal'
2018-12-21 18:14:28 +01:00
The program passed as argument will be executed in the new terminal' \
Expose a 'terminal' command for the various windowing systems It allows plugins to create generic terminal using the user's preferred windowing system For example, it can be used to run fzf, gdb or simply a shell. * 'new' commands are refactored to simply use the 'terminal' one * style and docstrings has been unified * all windowing systems go through "sh -c" for consistency purposes, even if unnecessary
2018-12-02 13:59:45 +01:00
%{
screen-terminal-impl 'split -v' 'focus right' %arg{@}
Integration with GNU screen; based on tmux.kak - Hack: kak sets `/proc/self/fd/0 -> /dev/null`. Get the client process tty because Screen needs to know the controlling terminal. Else Screen will use the last known tty and will open new windows on a different terminal if one is connected.
2017-09-23 16:26:57 +02:00
}
Add a complete-command command to configure command completion This makes it possible to change command completion in hooks and paves the way to more flexibility in how custom commands can be completed
2022-02-22 10:14:47 +01:00
complete-command screen-terminal-vertical shell
define-command screen-terminal-horizontal -params 1.. -docstring '
Rework 'terminal' commands * Arguments of the kakoune command are now preserved in the shell call * Escaping logic is moved from 'new' to 'terminal'
2018-12-21 18:14:28 +01:00
screen-terminal-horizontal <program> [<arguments>]: create a new terminal as a screen pane
Expose a 'terminal' command for the various windowing systems It allows plugins to create generic terminal using the user's preferred windowing system For example, it can be used to run fzf, gdb or simply a shell. * 'new' commands are refactored to simply use the 'terminal' one * style and docstrings has been unified * all windowing systems go through "sh -c" for consistency purposes, even if unnecessary
2018-12-02 13:59:45 +01:00
The current pane is split into two, top and bottom
Rework 'terminal' commands * Arguments of the kakoune command are now preserved in the shell call * Escaping logic is moved from 'new' to 'terminal'
2018-12-21 18:14:28 +01:00
The program passed as argument will be executed in the new terminal' \
Expose a 'terminal' command for the various windowing systems It allows plugins to create generic terminal using the user's preferred windowing system For example, it can be used to run fzf, gdb or simply a shell. * 'new' commands are refactored to simply use the 'terminal' one * style and docstrings has been unified * all windowing systems go through "sh -c" for consistency purposes, even if unnecessary
2018-12-02 13:59:45 +01:00
%{
screen-terminal-impl 'split -h' 'focus down' %arg{@}
}
Add a complete-command command to configure command completion This makes it possible to change command completion in hooks and paves the way to more flexibility in how custom commands can be completed
2022-02-22 10:14:47 +01:00
complete-command screen-terminal-horizontal shell
define-command screen-terminal-window -params 1.. -docstring '
Rework 'terminal' commands * Arguments of the kakoune command are now preserved in the shell call * Escaping logic is moved from 'new' to 'terminal'
2018-12-21 18:14:28 +01:00
screen-terminal-window <program> [<arguments>]: create a new terminal as a screen window
The program passed as argument will be executed in the new terminal' \
Expose a 'terminal' command for the various windowing systems It allows plugins to create generic terminal using the user's preferred windowing system For example, it can be used to run fzf, gdb or simply a shell. * 'new' commands are refactored to simply use the 'terminal' one * style and docstrings has been unified * all windowing systems go through "sh -c" for consistency purposes, even if unnecessary
2018-12-02 13:59:45 +01:00
%{
Do not reparse %sh{...} strings Automatic reparsing of %sh{...}, while convenient in many cases, can be surprising as well, and can lead to security problems: 'echo %sh{ printf "foo\necho bar" }' runs 'echo foo', then 'echo bar'. we make this danger explicit, and we fix the 'nop %sh{...}' pattern. To reparse %sh{...} strings, they can be passed to evaluate-commands, which has been fixed to work in every cases where %sh{...} reparsing was used..
2018-05-06 23:29:52 +02:00
nop %sh{
Integration with GNU screen; based on tmux.kak - Hack: kak sets `/proc/self/fd/0 -> /dev/null`. Get the client process tty because Screen needs to know the controlling terminal. Else Screen will use the last known tty and will open new windows on a different terminal if one is connected.
2017-09-23 16:26:57 +02:00
tty="$(ps -o tty ${kak_client_pid} | tail -n 1)"
Rework 'terminal' commands * Arguments of the kakoune command are now preserved in the shell call * Escaping logic is moved from 'new' to 'terminal'
2018-12-21 18:14:28 +01:00
screen -X screen "$@" < "/dev/$tty"
Integration with GNU screen; based on tmux.kak - Hack: kak sets `/proc/self/fd/0 -> /dev/null`. Get the client process tty because Screen needs to know the controlling terminal. Else Screen will use the last known tty and will open new windows on a different terminal if one is connected.
2017-09-23 16:26:57 +02:00
}
}
Add a complete-command command to configure command completion This makes it possible to change command completion in hooks and paves the way to more flexibility in how custom commands can be completed
2022-02-22 10:14:47 +01:00
complete-command screen-terminal-window shell
Integration with GNU screen; based on tmux.kak - Hack: kak sets `/proc/self/fd/0 -> /dev/null`. Get the client process tty because Screen needs to know the controlling terminal. Else Screen will use the last known tty and will open new windows on a different terminal if one is connected.
2017-09-23 16:26:57 +02:00
Add a complete-command command to configure command completion This makes it possible to change command completion in hooks and paves the way to more flexibility in how custom commands can be completed
2022-02-22 10:14:47 +01:00
define-command screen-focus -params ..1 -docstring '
Expose a 'terminal' command for the various windowing systems It allows plugins to create generic terminal using the user's preferred windowing system For example, it can be used to run fzf, gdb or simply a shell. * 'new' commands are refactored to simply use the 'terminal' one * style and docstrings has been unified * all windowing systems go through "sh -c" for consistency purposes, even if unnecessary
2018-12-02 13:59:45 +01:00
screen-focus [<client>]: focus the given client
If no client is passed then the current one is used' \
%{
evaluate-commands %sh{
Integration with GNU screen; based on tmux.kak - Hack: kak sets `/proc/self/fd/0 -> /dev/null`. Get the client process tty because Screen needs to know the controlling terminal. Else Screen will use the last known tty and will open new windows on a different terminal if one is connected.
2017-09-23 16:26:57 +02:00
if [ $# -eq 1 ]; then
printf %s\\n "
* Crude implementation of focus: use the current region to switch to the desired window. - The proper way to do this would be to switch focus to the target client's region but GNU Screen offers no obvious way to do that. - Remove screen region after client is closed. - Assumed: Kak server runs in screen.
2017-11-17 20:40:42 +01:00
evaluate-commands -client '$1' focus
"
code review: typos.
2017-11-15 15:42:37 +01:00
elif [ -n "${kak_client_env_STY}" ]; then
Integration with GNU screen; based on tmux.kak - Hack: kak sets `/proc/self/fd/0 -> /dev/null`. Get the client process tty because Screen needs to know the controlling terminal. Else Screen will use the last known tty and will open new windows on a different terminal if one is connected.
2017-09-23 16:26:57 +02:00
tty="$(ps -o tty ${kak_client_pid} | tail -n 1)"
* Crude implementation of focus: use the current region to switch to the desired window. - The proper way to do this would be to switch focus to the target client's region but GNU Screen offers no obvious way to do that. - Remove screen region after client is closed. - Assumed: Kak server runs in screen.
2017-11-17 20:40:42 +01:00
screen -X select "${kak_client_env_WINDOW}" < "/dev/$tty"
Integration with GNU screen; based on tmux.kak - Hack: kak sets `/proc/self/fd/0 -> /dev/null`. Get the client process tty because Screen needs to know the controlling terminal. Else Screen will use the last known tty and will open new windows on a different terminal if one is connected.
2017-09-23 16:26:57 +02:00
fi
Expose a 'terminal' command for the various windowing systems It allows plugins to create generic terminal using the user's preferred windowing system For example, it can be used to run fzf, gdb or simply a shell. * 'new' commands are refactored to simply use the 'terminal' one * style and docstrings has been unified * all windowing systems go through "sh -c" for consistency purposes, even if unnecessary
2018-12-02 13:59:45 +01:00
}
}
rc windowing: use menu behavior for focus We can complete every possible client argument.
2022-07-19 15:56:05 +02:00
complete-command -menu screen-focus client
Modified base files to use modules
2019-03-13 19:15:59 +01:00
alias global focus screen-focus
alias global terminal screen-terminal-vertical
}
Reference in New Issue Copy Permalink