From: Marlon Richert <marlon.richert@gmail.com>
To: Daniel Shahaf <d.s@daniel.shahaf.name>
Cc: Zsh hackers list <zsh-workers@zsh.org>
Subject: Re: [RFC][PATCH] Reset ZLE hooks when changing prompt themes (was Re: [RFC][PATCH] `newuser` prompt theme)
Date: Sat, 17 Apr 2021 01:34:57 +0300 [thread overview]
Message-ID: <E5F5E0AF-0A2B-451C-8981-1341D1DB541E@gmail.com> (raw)
In-Reply-To: <20210415213456.GE6669@tarpaulin.shahaf.local2>
[-- Attachment #1: Type: text/plain, Size: 1522 bytes --]
On 16 Apr 2021, at 00:34, Daniel Shahaf <d.s@daniel.shahaf.name> wrote:
> Marlon wrote on Thu, Apr 15, 2021 at 21:54:48 +0300:
>> +that follow the naming pattern tt(prompt_<theme>_<hook>) are automatically
>
> This should be tt(prompt_)var(theme)tt(_)var(hook).
>
>> +removed when the prompt theme changes or is disabled.
>
> Add a pointer to the relevant section? Something like
> .
> ifzman(… Manipulating Hook Functions … above)ifnzman(noderef(Manipulating Hook Functions))
> .
> plus appropriate markup in the first branch.
Done and done.
>> - for hook in chpwd precmd preexec periodic zshaddhistory zshexit; do
>> - add-zsh-hook -D "${hook}" "prompt_*_${hook}"
>> + for hook in chpwd precmd preexec periodic zshaddhistory zshexit \
>> + zsh_directory_name; do
>> + add-zsh-hook -D "$hook" "prompt_*_$hook"
>> + done
>> + for hook in isearch-exit isearch-update line-pre-redraw line-init \
>> + line-finish history-line-set keymap-select; do
>> + add-zle-hook-widget -D "$hook" "prompt_*_$hook"
> Hmm. I'm not at all sure that this is sufficient. There's a bunch of
> reference to precmd and preexec in promptinit; it's possible that some
> of these should also handle chpwd,periodic,zshaddhistory,zshexit
> (a preëxisting issue) and the add-zle-hook-widget hook classes (an issue
> this patch might be introducing).
Attached is a new version of the patch that handles _all the things._ \o/
[-- Attachment #2.1: Type: text/html, Size: 13492 bytes --]
[-- Attachment #2.2: 0001-Reset-ZLE-hooks-when-changing-prompt-themes.txt --]
[-- Type: text/plain, Size: 10459 bytes --]
From ae73759d82da603e6e88e1a95d91274451defc91 Mon Sep 17 00:00:00 2001
From: Marlon Richert <marlon.richert@gmail.com>
Date: Fri, 16 Apr 2021 23:00:44 +0300
Subject: [PATCH] Reset ZLE hooks when changing prompt themes
---
Doc/Zsh/contrib.yo | 10 ++-
Functions/Prompts/promptinit | 167 +++++++++++++++--------------------
2 files changed, 79 insertions(+), 98 deletions(-)
diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo
index 3c4fdded0..6e33cd6f9 100644
--- a/Doc/Zsh/contrib.yo
+++ b/Doc/Zsh/contrib.yo
@@ -2032,10 +2032,12 @@ setopts (tt(promptbang), etc.) are turned on, all other prompt-related
options are turned off. The tt(prompt_opts) array preserves setopts even
beyond the scope of tt(localoptions), should your function need that.
)
-item(Modify precmd and preexec)(
-Use of tt(add-zsh-hook) is recommended. The tt(precmd) and tt(preexec)
-hooks are automatically adjusted if the prompt theme changes or is
-disabled.
+item(Modify hooks)(
+Use of tt(add-zsh-hook) and tt(add-zle-hook-widget) is recommended (see
+ifzman(the bf(Manipulating Hook Functions) section above)\
+ifnzman(noderef(Manipulating Hook Functions))\
+). All hooks that follow the naming pattern tt(prompt_)var(theme)tt(_)var(hook)
+are automatically removed when the prompt theme changes or is disabled.
)
item(Declare cleanup)(
If your function makes any other changes that should be undone when the
diff --git a/Functions/Prompts/promptinit b/Functions/Prompts/promptinit
index 37d69f100..a6c9e31dd 100644
--- a/Functions/Prompts/promptinit
+++ b/Functions/Prompts/promptinit
@@ -14,6 +14,8 @@ prompt_themes=()
promptinit () {
emulate -L zsh
setopt extendedglob
+ autoload -Uz add-zsh-hook add-zle-hook-widget
+
local ppath='' name theme
local -a match mbegin mend
@@ -32,9 +34,6 @@ promptinit () {
fi
done
- # To manipulate precmd and preexec hooks...
- autoload -Uz add-zsh-hook
-
# Variables common to all prompt styles
prompt_newline=$'\n%{\r%}'
}
@@ -47,38 +46,23 @@ prompt_preview_safely() {
return
fi
- # This handles all the stuff from the default :prompt-theme restore
- local +h PS1=$PS1 PS2=$PS2 PS3=$PS3 PS4=$PS4 RPS1=$RPS1 RPS2=$RPS2
- local +h PROMPT=$PROMPT RPROMPT=$RPROMPT RPROMPT2=$RPROMPT2 PSVAR=$PSVAR
- local -a precmd_functions preexec_functions prompt_preview_restore
- local -aLl +h zle_highlight
+ # Run this in a subshell, so we don't need to clean up afterwards.
+ (
+ # Execute current theme's cleanup sequence, if any.
+ zstyle -t :prompt-theme cleanup
- {
- # Save and clear current restore-point if any
- zstyle -g prompt_preview_restore :prompt-theme restore
- {
- zstyle -d :prompt-theme restore
- # Execute current cleanup sequence, if any.
- zstyle -t :prompt-theme cleanup
-
- # The next line is a bit ugly. It (perhaps unnecessarily)
- # runs the prompt theme setup function to ensure that if
- # the theme has a _preview function that it's been autoloaded.
+ # If we can't find a _preview function, run the _setup function to see if
+ # it will create one.
+ typeset +f prompt_${1}_preview >&/dev/null ||
prompt_${1}_setup
- if typeset +f prompt_${1}_preview >&/dev/null; then
- prompt_${1}_preview "$@[2,-1]"
- else
- prompt_preview_theme "$@"
- fi
- } always {
- # Run any theme-specific cleanup, then reset restore point
- zstyle -t :prompt-theme cleanup
- }
- } always {
- (( $#prompt_preview_restore )) &&
- zstyle -e :prompt-theme restore "${prompt_preview_restore[@]}"
- }
+ # ...then try again.
+ if typeset +f prompt_${1}_preview >&/dev/null; then
+ prompt_${1}_preview "$@[2,-1]"
+ else
+ prompt_preview_theme "$@"
+ fi
+ )
}
set_prompt() {
@@ -97,21 +81,6 @@ Options:
Use prompt -h <theme> for help on specific themes.'
getopts "chlps:" opt
- case "$opt" in
- (h|p)
- setopt localtraps
- if [[ -z "$prompt_theme[1]" ]]; then
- # Not using a prompt theme; save settings
- local +h PS1=$PS1 PS2=$PS2 PS3=$PS3 PS4=$PS4 RPS1=$RPS1 RPS2=$RPS2
- local +h PROMPT=$PROMPT RPROMPT=$RPROMPT RPROMPT2=$RPROMPT2 PSVAR=$PSVAR
- local -a precmd_functions preexec_functions
- local theme_reset=''
- else
- local theme_reset='prompt_${prompt_theme[1]}_setup "${(@)prompt_theme[2,-1]}"'
- fi
- trap 'zstyle -t :prompt-theme cleanup;'"${theme_reset:+ $theme_reset}" 0
- ;;
- esac
case "$opt" in
c) if [[ -n $prompt_theme ]]; then
print -n "Current prompt theme"
@@ -123,21 +92,26 @@ Use prompt -h <theme> for help on specific themes.'
return
;;
h) if [[ -n "$2" && -n $prompt_themes[(r)$2] ]]; then
- if functions prompt_$2_setup >/dev/null; then
+ # Run this in a subshell, so we don't need to clean up afterwards.
+ (
+ # Execute current theme's cleanup sequence, if any.
zstyle -t :prompt-theme cleanup
- # The next line is a bit ugly. It (perhaps unnecessarily)
- # runs the prompt theme setup function to ensure that if
- # the theme has a _help function that it's been autoloaded.
- prompt_$2_setup
- fi
- if functions prompt_$2_help >/dev/null; then
- print "Help for $2 theme:\n"
- prompt_$2_help
- else
- print "No help available for $2 theme."
- fi
- print "\nType \`prompt -p $2' to preview the theme, \`prompt $2'"
- print "to try it out, and \`prompt -s $2' to use it in future sessions."
+
+ # If we can't find a _help function, run the _setup function to see
+ # if it will create one.
+ typeset +f prompt_$2_help >/dev/null ||
+ prompt_$2_setup
+
+ # ...then try again.
+ if typeset +f prompt_$2_help >/dev/null; then
+ print "Help for $2 theme:\n"
+ prompt_$2_help
+ else
+ print "No help available for $2 theme."
+ fi
+ print "\nType \`prompt -p $2' to preview the theme, \`prompt $2'"
+ print "to try it out, and \`prompt -s $2' to use it in future sessions."
+ )
else
print "$usage"
fi
@@ -178,8 +152,13 @@ Use prompt -h <theme> for help on specific themes.'
# Reset some commonly altered bits to the default
local hook
- for hook in chpwd precmd preexec periodic zshaddhistory zshexit; do
- add-zsh-hook -D "${hook}" "prompt_*_${hook}"
+ for hook in chpwd precmd preexec periodic zshaddhistory zshexit \
+ zsh_directory_name; do
+ add-zsh-hook -D "$hook" "prompt_*_$hook"
+ done
+ for hook in isearch-exit isearch-update line-pre-redraw line-init \
+ line-finish history-line-set keymap-select; do
+ add-zle-hook-widget -D "$hook" "prompt_*_$hook"
done
typeset -ga zle_highlight=( ${zle_highlight:#default:*} )
(( ${#zle_highlight} )) || unset zle_highlight
@@ -192,11 +171,8 @@ Use prompt -h <theme> for help on specific themes.'
prompt_cleanup () {
local -a cleanup_hooks theme_active
- if ! zstyle -g cleanup_hooks :prompt-theme cleanup
- then
- (( $+prompt_preview_restore == 0 )) &&
- if ! zstyle -g theme_active :prompt-theme restore
- then
+ if ! zstyle -g cleanup_hooks :prompt-theme cleanup; then
+ if ! zstyle -g theme_active :prompt-theme restore; then
print -u2 "prompt_cleanup: no prompt theme active"
return 1
fi
@@ -225,22 +201,23 @@ prompt () {
[[ -o promptpercent ]] && prompt_opts+=(percent)
[[ -o promptsp ]] && prompt_opts+=(sp)
[[ -o promptsubst ]] && prompt_opts+=(subst)
- zstyle -e :prompt-theme restore \
- 'zstyle -d :prompt-theme restore;' \
- 'prompt_default_setup;' \
- ${PS1+PS1="${(q)PS1}"} \
- ${PS2+PS2="${(q)PS2}"} \
- ${PS3+PS3="${(q)PS3}"} \
- ${PS4+PS4="${(q)PS4}"} \
- ${RPS1+RPS1="${(q)RPS1}"} \
- ${RPS2+RPS2="${(q)RPS2}"} \
- ${RPROMPT+RPROMPT="${(q)RPROMPT}"} \
- ${RPROMPT2+RPROMPT2="${(q)RPROMPT2}"} \
- ${PSVAR+PSVAR="${(q)PSVAR}"} \
- "precmd_functions=(${(q)precmd_functions[@]})" \
- "preexec_functions=(${(q)preexec_functions[@]})" \
- "prompt_opts=( ${prompt_opts[*]} )" \
- 'reply=(yes)'
+ zstyle -e :prompt-theme restore "
+ zstyle -d :prompt-theme restore
+ prompt_default_setup
+ ${PS1+PS1=${(q+)PS1}}
+ ${PS2+PS2=${(q+)PS2}}
+ ${PS3+PS3=${(q+)PS3}}
+ ${PS4+PS4=${(q+)PS4}}
+ ${RPS1+RPS1=${(q+)RPS1}}
+ ${RPS2+RPS2=${(q+)RPS2}}
+ ${RPROMPT+RPROMPT=${(q+)RPROMPT}}
+ ${RPROMPT2+RPROMPT2=${(q+)RPROMPT2}}
+ ${PSVAR+PSVAR=${(q+)PSVAR}}
+ $( add-zsh-hook -L )
+ $( add-zle-hook-widget -L )
+ prompt_opts=( $prompt_opts[*] )
+ reply=( yes )
+ "
}
set_prompt "$@"
@@ -253,12 +230,6 @@ prompt () {
prompt_preview_theme () {
emulate -L zsh
- # Check for proper state handling
- (( $+prompt_preview_restore )) || {
- prompt_preview_safely "$@"
- return
- }
-
# Minimal preview for prompts that don't supply one
local -a prompt_opts
print -n "$1 theme"
@@ -268,12 +239,20 @@ prompt_preview_theme () {
prompt_${1}_setup "$@[2,-1]"
(( ${#prompt_opts} )) &&
setopt noprompt{bang,cr,percent,sp,subst} "prompt${^prompt_opts[@]}"
+
+ [[ -n ${chpwd_functions[(r)prompt_${1}_chpwd]} ]] &&
+ prompt_${1}_chpwd
[[ -n ${precmd_functions[(r)prompt_${1}_precmd]} ]] &&
- prompt_${1}_precmd
- [[ -o promptcr ]] && print -n $'\r'; :
- print -P "${PS1}command arg1 arg2 ... argn"
+ prompt_${1}_precmd
+
+ # We'd like to call zle-line-init/finish hooks, too, but that's not possible
+ # while the ZLE is not active.
+
+ [[ -o promptcr ]] && print -n $'\r'
+ :; print -P -- "${PS1}command arg1 arg2 ... argn"
+
[[ -n ${preexec_functions[(r)prompt_${1}_preexec]} ]] &&
- prompt_${1}_preexec
+ prompt_${1}_preexec
}
[[ -o kshautoload ]] || promptinit "$@"
--
2.31.1
[-- Attachment #2.3: Type: text/html, Size: 272 bytes --]
next prev parent reply other threads:[~2021-04-16 22:35 UTC|newest]
Thread overview: 65+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-13 19:41 [RFC][PATCH] `newuser` prompt theme Marlon
2021-04-13 20:31 ` Roman Perepelitsa
2021-04-13 20:44 ` Bart Schaefer
2021-04-14 5:09 ` Marlon Richert
2021-04-14 5:17 ` Bart Schaefer
2021-04-14 5:45 ` Marlon
2021-04-14 12:05 ` Daniel Shahaf
2021-04-14 13:17 ` Marlon
2021-04-14 14:09 ` Daniel Shahaf
2021-04-15 1:07 ` Bart Schaefer
2021-04-15 3:50 ` Marlon Richert
2021-04-15 20:27 ` Daniel Shahaf
2021-04-15 23:42 ` Daniel Shahaf
2021-04-15 11:11 ` Mikael Magnusson
2021-04-15 16:44 ` vcs_info's global variables (was: Re: [RFC][PATCH] `newuser` prompt theme) Daniel Shahaf
2021-04-16 16:04 ` [RFC][PATCH] `newuser` prompt theme Marlon
2021-04-16 17:13 ` Daniel Shahaf
2021-04-16 19:19 ` Marlon Richert
2021-04-16 19:30 ` Daniel Shahaf
2021-04-19 16:46 ` Marlon Richert
2021-05-02 17:18 ` Lawrence Velázquez
2021-05-03 2:38 ` Bart Schaefer
2021-05-03 4:11 ` Lawrence Velázquez
2021-05-03 11:38 ` [PATCH] Add customizable `vcs` prompt theme (was Re: [RFC][PATCH] `newuser` prompt theme) Marlon Richert
2021-05-09 18:04 ` Lawrence Velázquez
2021-05-31 1:01 ` Lawrence Velázquez
2021-06-09 12:58 ` Marlon Richert
2021-06-09 13:22 ` Roman Perepelitsa
2021-06-09 18:06 ` Marlon Richert
2021-06-10 9:30 ` Roman Perepelitsa
2021-06-10 13:47 ` Marlon Richert
2021-06-10 14:01 ` Marlon Richert
2021-06-10 17:45 ` Roman Perepelitsa
2021-06-20 22:13 ` Marlon Richert
2021-06-23 17:26 ` Roman Perepelitsa
2022-08-08 10:12 ` Marlon Richert
2022-08-08 10:17 ` Roman Perepelitsa
2021-04-14 14:09 ` sysexits.h codes? (was: " Daniel Shahaf
2021-04-30 19:40 ` Marlon Richert
2021-04-30 21:16 ` Daniel Shahaf
2021-04-30 21:34 ` Bart Schaefer
2021-05-01 15:09 ` Daniel Shahaf
2021-04-30 21:40 ` Bart Schaefer
2021-05-01 13:39 ` Marlon Richert
2021-05-01 14:43 ` Daniel Shahaf
2021-05-03 11:36 ` Marlon Richert
2021-05-03 16:04 ` Daniel Shahaf
2021-05-04 11:13 ` Marlon Richert
2021-05-21 11:38 ` Marlon Richert
2021-04-14 15:30 ` [RFC][PATCH] `newuser` prompt theme Arseny Maslennikov
2021-04-14 18:52 ` Daniel Shahaf
2021-04-14 14:00 ` precmd hooks and $? Bart Schaefer
2021-04-14 15:18 ` docs patches for precmd hooks and $?, and vcs_info Daniel Shahaf
2021-04-15 2:35 ` Bart Schaefer
2021-04-15 16:17 ` Archives render attachments as first-class messages (was: docs patches for precmd hooks and $?, and vcs_info) Daniel Shahaf
2021-04-15 18:54 ` [RFC][PATCH] Reset ZLE hooks when changing prompt themes (was Re: [RFC][PATCH] `newuser` prompt theme) Marlon
2021-04-15 21:34 ` Daniel Shahaf
2021-04-16 22:34 ` Marlon Richert [this message]
2021-04-25 16:08 ` Lawrence Velázquez
2021-05-02 17:03 ` Lawrence Velázquez
2021-05-02 17:59 ` Bart Schaefer
2021-05-05 6:10 ` Marlon Richert
2021-05-16 15:27 ` Lawrence Velázquez
2021-05-16 19:31 ` Marlon Richert
2021-05-17 4:19 ` Bart Schaefer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=E5F5E0AF-0A2B-451C-8981-1341D1DB541E@gmail.com \
--to=marlon.richert@gmail.com \
--cc=d.s@daniel.shahaf.name \
--cc=zsh-workers@zsh.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.vuxu.org/mirror/zsh/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).