extern/atuin
1
0
Fork 0
mirror of https://github.com/atuinsh/atuin.git synced 2025-06-20 09:58:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

refactor(bash): refactor and optimize __atuin_accept_line (#1482)

Browse Source 
* fix(bash): prefix "__atuin_" to avoid variable conflicts

Because the function "__atuin_history" executes an arbitary user
command for "enter_accept", the local variable names should be
carefully chosen.  A local variable can shadow a global variable that
the user wants to use when there is a name conflict.  To avoid such a
situation we try to namespace the variables used by atuin by prefixing
"__atuin_".

* fix(bash): work around "shopt -s xpg_echo"

* refactor(bash): simplify the rendering of the prompt

* perf(bash): avoid extra evaluation of PS1

* refactor(bash): count \n by wc

We can simply use "wc -l" to count the number of newline characters.
In the POSIX standard, a line in a text stream is defined as
characters terminated by a newline character, so the unterminated line
is not counted by "wc -l".  As a result, "wc -l" actually counts the
number of newline characters.

* refactor(bash): rename localvar `HISTORY => __atuin_command`

This patch renames the local variable `HISTORY` in __atuin_accept_line
to `__atuin_command`.  The name of the global variable `HISTORY` set
by `__atuin_history` is kept.
This commit is contained in:
Koichi Murase 2024-01-02 17:29:16 +09:00 committed by GitHub
parent 5bef19ba4c
commit d9dab6c92d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
atuin/src/shell/atuin.bash
View File

@ -22,50 +22,51 @@ __atuin_set_ret_value() {
} }
__atuin_accept_line() { __atuin_accept_line() {
local HISTORY=$1 local __atuin_command=$1
# Reprint the prompt, accounting for multiple lines # Reprint the prompt, accounting for multiple lines
local __atuin_prompt=${PS1@P}
local __atuin_prompt_offset local __atuin_prompt_offset
__atuin_prompt_offset=$(echo -n "${PS1@P}" | tr -cd '\n' | wc -c) __atuin_prompt_offset=$(printf '%s' "$__atuin_prompt" | wc -l)
if ((__atuin_prompt_offset > 0)); then if ((__atuin_prompt_offset > 0)); then
tput cuu "$__atuin_prompt_offset" tput cuu "$__atuin_prompt_offset"
fi fi
echo "${PS1@P}$HISTORY" printf '%s\n' "$__atuin_prompt$__atuin_command"
# Add it to the bash history # Add it to the bash history
history -s "$HISTORY" history -s "$__atuin_command"
# Assuming bash-preexec # Assuming bash-preexec
# Invoke every function in the preexec array # Invoke every function in the preexec array
local preexec_function local __atuin_preexec_function
local preexec_function_ret_value local __atuin_preexec_function_ret_value
local preexec_ret_value=0 local __atuin_preexec_ret_value=0
for preexec_function in "${preexec_functions[@]:-}"; do for __atuin_preexec_function in "${preexec_functions[@]:-}"; do
if type -t "$preexec_function" 1>/dev/null; then if type -t "$__atuin_preexec_function" 1>/dev/null; then
__atuin_set_ret_value "${__bp_last_ret_value:-}" __atuin_set_ret_value "${__bp_last_ret_value:-}"
"$preexec_function" "$HISTORY" "$__atuin_preexec_function" "$__atuin_command"
preexec_function_ret_value="$?" __atuin_preexec_function_ret_value="$?"
if [[ "$preexec_function_ret_value" != 0 ]]; then if [[ "$__atuin_preexec_function_ret_value" != 0 ]]; then
preexec_ret_value="$preexec_function_ret_value" __atuin_preexec_ret_value="$__atuin_preexec_function_ret_value"
fi fi
fi fi
done done
# If extdebug is turned on and any preexec function returns non-zero # If extdebug is turned on and any preexec function returns non-zero
# exit status, we do not run the user command. # exit status, we do not run the user command.
if ! { shopt -q extdebug && ((preexec_ret_value)); }; then if ! { shopt -q extdebug && ((__atuin_preexec_ret_value)); }; then
# Juggle the terminal settings so that the command can be interacted with # Juggle the terminal settings so that the command can be interacted with
local stty_backup local __atuin_stty_backup
stty_backup=$(stty -g) __atuin_stty_backup=$(stty -g)
stty "$ATUIN_STTY" stty "$ATUIN_STTY"
# Execute the command. Note: We need to record $? and $_ after the # Execute the command. Note: We need to record $? and $_ after the
# user command within the same call of "eval" because $_ is otherwise # user command within the same call of "eval" because $_ is otherwise
# overwritten by the last argument of "eval". # overwritten by the last argument of "eval".
__atuin_set_ret_value "${__bp_last_ret_value-}" "${__bp_last_argument_prev_command-}" __atuin_set_ret_value "${__bp_last_ret_value-}" "${__bp_last_argument_prev_command-}"
eval -- "$HISTORY"$'\n__bp_last_ret_value=$? __bp_last_argument_prev_command=$_' eval -- "$__atuin_command"$'\n__bp_last_ret_value=$? __bp_last_argument_prev_command=$_'
stty "$stty_backup" stty "$__atuin_stty_backup"
fi fi
# Execute preprompt commands # Execute preprompt commands
@ -76,10 +77,9 @@ __atuin_accept_line() {
done done
# Bash will redraw only the line with the prompt after we finish, # Bash will redraw only the line with the prompt after we finish,
# so to work for a multiline prompt we need to print it ourselves, # so to work for a multiline prompt we need to print it ourselves,
# then move up a line # then go to the beginning of the last line.
__atuin_set_ret_value "${__bp_last_ret_value-}" "${__bp_last_argument_prev_command-}" __atuin_set_ret_value "${__bp_last_ret_value-}" "${__bp_last_argument_prev_command-}"
echo "${PS1@P}" printf '%s\r' "${PS1@P}"
tput cuu 1
} }
__atuin_history() { __atuin_history() {