From 38376d5293f3431d9b2b77e7cb7d38679c37e971 Mon Sep 17 00:00:00 2001
From: Joe MacDonald <joe@deserted.net>
Date: Mon, 5 Dec 2022 13:34:40 -0500
Subject: [PATCH] lib: provide a prompt function for the dirstack

Providing this additional function for prompts allows anyone using
pushd/popd/dirs to navigate directory trees to quickly view their
stack and find which entry they want to switch to.

This degrades gracefully for anyone not using the directory stack since
dirs will always display the same as \w when the stack is only one entry
deep.

Setting DIRSTACK_EXPAND_TILDE to true in the environment will display
the directory stack with ~ expanded to the full path of the user's home
directory.

Setting DIRSTACK_LIMIT to any value greater than 0 will limit the
display to that number of entries, though the directory stack will still
contain all entries in it.

The bakke theme has been tweaked to use the new function as an example.

Signed-off-by: Joe MacDonald <joe@deserted.net>
---
 lib/omb-prompt-base.sh      | 26 ++++++++++++++++++++++++++
 themes/bakke/bakke.theme.sh |  2 +-
 2 files changed, 27 insertions(+), 1 deletion(-)

diff --git a/lib/omb-prompt-base.sh b/lib/omb-prompt-base.sh
index 8f92e41cf..f3984f23a 100644
--- a/lib/omb-prompt-base.sh
+++ b/lib/omb-prompt-base.sh
@@ -52,6 +52,9 @@ SCM_SVN_CHAR='⑆'
 SCM_NONE='NONE'
 SCM_NONE_CHAR='○'
 
+DIRSTACK_EXPAND_TILDE=${DIRSTACK_EXPAND_TILDE:=false}
+DIRSTACK_LIMIT=${DIRSTACK_LIMIT:=0}
+
 THEME_SHOW_USER_HOST=${THEME_SHOW_USER_HOST:=false}
 USER_HOST_THEME_PROMPT_PREFIX=''
 USER_HOST_THEME_PROMPT_SUFFIX=''
@@ -585,6 +588,29 @@ function aws_profile {
   fi
 }
 
+function _omb_dirstack_limit {
+    if [[ "${DIRSTACK_EXPAND_TILDE}" = true ]]; then
+      dirargs="-l"
+    fi
+    if [[ "${BASH_VERSINFO[0]}" -lt 4 ]]; then
+      IFS=$'\n' read -r -d '' -a DIRS < <( dirs -p ${dirargs} && printf '\0' )
+    else
+      readarray -t DIRS < <(dirs -p ${dirargs})
+    fi
+    echo "${DIRS[@]:0:${DIRSTACK_LIMIT}}"
+}
+
+function dirs_prompt {
+  if [[ "${DIRSTACK_LIMIT}" -gt 0 ]]; then
+    _omb_dirstack_limit
+  else
+    if [[ "${DIRSTACK_EXPAND_TILDE}" = true ]]; then
+      dirs -l
+    else
+      dirs
+    fi
+  fi
+}
 
 # Returns true if $1 is a shell function.
 _omb_deprecate_function 20000 fn_exists _omb_util_function_exists
diff --git a/themes/bakke/bakke.theme.sh b/themes/bakke/bakke.theme.sh
index a388b24a5..cc1bb21f5 100644
--- a/themes/bakke/bakke.theme.sh
+++ b/themes/bakke/bakke.theme.sh
@@ -16,7 +16,7 @@ function _omb_theme_PROMPT_COMMAND() {
     #PS1="${_omb_prompt_bold_teal}$(scm_char)${_omb_prompt_green}$(scm_prompt_info)${_omb_prompt_purple}$(_omb_prompt_print_ruby_env) ${_omb_prompt_olive}\h ${_omb_prompt_reset_color}in ${_omb_prompt_green}\w ${_omb_prompt_reset_color}\n${_omb_prompt_green}→${_omb_prompt_reset_color} "
     #PS1="\n${_omb_prompt_purple}\h: ${_omb_prompt_reset_color} ${_omb_prompt_green}\w\n${_omb_prompt_bold_teal}$(scm_char)${_omb_prompt_green}$(scm_prompt_info) ${_omb_prompt_green}→${_omb_prompt_reset_color} "
     #PS1="\n${_omb_prompt_teal}\h: ${_omb_prompt_reset_color} ${_omb_prompt_olive}\w\n${_omb_prompt_brown}$(scm_char)${_omb_prompt_brown}$(scm_prompt_info) ${_omb_prompt_green}→${_omb_prompt_reset_color} "
-    PS1="\n${_omb_prompt_teal}\h: ${_omb_prompt_reset_color} ${_omb_prompt_olive}\w ${_omb_prompt_green}$(scm_prompt_info)\n${_omb_prompt_reset_color}→ "
+    PS1="\n${_omb_prompt_teal}\h: ${_omb_prompt_reset_color} ${_omb_prompt_olive}$(dirs_prompt) ${_omb_prompt_green}$(scm_prompt_info)\n${_omb_prompt_reset_color}→ "
 }
 
 _omb_util_add_prompt_command _omb_theme_PROMPT_COMMAND