per-directory-history.zsh 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  1. #!/usr/bin/env zsh
  2. #
  3. # This is a implementation of per directory history for zsh, some
  4. # implementations of which exist in bash[1,2]. It also implements
  5. # a per-directory-history-toggle-history function to change from using the
  6. # directory history to using the global history. In both cases the history is
  7. # always saved to both the global history and the directory history, so the
  8. # toggle state will not effect the saved histories. Being able to switch
  9. # between global and directory histories on the fly is a novel feature as far
  10. # as I am aware.
  11. #
  12. #-------------------------------------------------------------------------------
  13. # Configuration
  14. #-------------------------------------------------------------------------------
  15. #
  16. # HISTORY_BASE a global variable that defines the base directory in which the
  17. # directory histories are stored
  18. #
  19. #-------------------------------------------------------------------------------
  20. # History
  21. #-------------------------------------------------------------------------------
  22. #
  23. # The idea/inspiration for a per directory history is from Stewart MacArthur[1]
  24. # and Dieter[2], the implementation idea is from Bart Schaefer on the the zsh
  25. # mailing list[3]. The implementation is by Jim Hester in September 2012.
  26. #
  27. # [1]: http://www.compbiome.com/2010/07/bash-per-directory-bash-history.html
  28. # [2]: http://dieter.plaetinck.be/per_directory_bash
  29. # [3]: http://www.zsh.org/mla/users/1997/msg00226.html
  30. #
  31. ################################################################################
  32. #
  33. # Copyright (c) 2014 Jim Hester
  34. #
  35. # This software is provided 'as-is', without any express or implied warranty.
  36. # In no event will the authors be held liable for any damages arising from the
  37. # use of this software.
  38. #
  39. # Permission is granted to anyone to use this software for any purpose,
  40. # including commercial applications, and to alter it and redistribute it
  41. # freely, subject to the following restrictions:
  42. #
  43. # 1. The origin of this software must not be misrepresented; you must not claim
  44. # that you wrote the original software. If you use this software in a product,
  45. # an acknowledgment in the product documentation would be appreciated but is
  46. # not required.
  47. #
  48. # 2. Altered source versions must be plainly marked as such, and must not be
  49. # misrepresented as being the original software.
  50. #
  51. # 3. This notice may not be removed or altered from any source distribution..
  52. #
  53. ################################################################################
  54. #-------------------------------------------------------------------------------
  55. # configuration, the base under which the directory histories are stored
  56. #-------------------------------------------------------------------------------
  57. [[ -z $HISTORY_BASE ]] && HISTORY_BASE="$HOME/.directory_history"
  58. [[ -z $PER_DIRECTORY_HISTORY_TOGGLE ]] && PER_DIRECTORY_HISTORY_TOGGLE='^G'
  59. #-------------------------------------------------------------------------------
  60. # toggle global/directory history used for searching - ctrl-G by default
  61. #-------------------------------------------------------------------------------
  62. function per-directory-history-toggle-history() {
  63. if [[ $_per_directory_history_is_global == true ]]; then
  64. _per-directory-history-set-directory-history
  65. print -n "\nusing local history"
  66. else
  67. _per-directory-history-set-global-history
  68. print -n "\nusing global history"
  69. fi
  70. zle .push-line
  71. zle .accept-line
  72. }
  73. autoload per-directory-history-toggle-history
  74. zle -N per-directory-history-toggle-history
  75. bindkey $PER_DIRECTORY_HISTORY_TOGGLE per-directory-history-toggle-history
  76. #-------------------------------------------------------------------------------
  77. # implementation details
  78. #-------------------------------------------------------------------------------
  79. _per_directory_history_directory="$HISTORY_BASE${PWD:A}/history"
  80. function _per-directory-history-change-directory() {
  81. _per_directory_history_directory="$HISTORY_BASE${PWD:A}/history"
  82. mkdir -p ${_per_directory_history_directory:h}
  83. if [[ $_per_directory_history_is_global == false ]]; then
  84. #save to the global history
  85. fc -AI $HISTFILE
  86. #save history to previous file
  87. local prev="$HISTORY_BASE${OLDPWD:A}/history"
  88. mkdir -p ${prev:h}
  89. fc -AI $prev
  90. #discard previous directory's history
  91. local original_histsize=$HISTSIZE
  92. HISTSIZE=0
  93. HISTSIZE=$original_histsize
  94. #read history in new file
  95. if [[ -e $_per_directory_history_directory ]]; then
  96. fc -R $_per_directory_history_directory
  97. fi
  98. fi
  99. }
  100. function _per-directory-history-addhistory() {
  101. # respect hist_ignore_space
  102. if [[ -o hist_ignore_space ]] && [[ "$1" == \ * ]]; then
  103. true
  104. else
  105. print -Sr -- "${1%%$'\n'}"
  106. fc -p $_per_directory_history_directory
  107. fi
  108. }
  109. function _per-directory-history-set-directory-history() {
  110. if [[ $_per_directory_history_is_global == true ]]; then
  111. fc -AI $HISTFILE
  112. local original_histsize=$HISTSIZE
  113. HISTSIZE=0
  114. HISTSIZE=$original_histsize
  115. if [[ -e "$_per_directory_history_directory" ]]; then
  116. fc -R "$_per_directory_history_directory"
  117. fi
  118. fi
  119. _per_directory_history_is_global=false
  120. }
  121. function _per-directory-history-set-global-history() {
  122. if [[ $_per_directory_history_is_global == false ]]; then
  123. fc -AI $_per_directory_history_directory
  124. local original_histsize=$HISTSIZE
  125. HISTSIZE=0
  126. HISTSIZE=$original_histsize
  127. if [[ -e "$HISTFILE" ]]; then
  128. fc -R "$HISTFILE"
  129. fi
  130. fi
  131. _per_directory_history_is_global=true
  132. }
  133. #add functions to the exec list for chpwd and zshaddhistory
  134. autoload -U add-zsh-hook
  135. add-zsh-hook chpwd _per-directory-history-change-directory
  136. add-zsh-hook zshaddhistory _per-directory-history-addhistory
  137. #start in directory mode
  138. mkdir -p ${_per_directory_history_directory:h}
  139. _per_directory_history_is_global=true
  140. _per-directory-history-set-directory-history