├── .gitignore ├── TODO.md ├── README.md ├── plugin └── searchhi.vim ├── autoload └── searchhi.vim ├── doc └── searchhi.txt └── LICENSE.txt /.gitignore: -------------------------------------------------------------------------------- 1 | # Vim help tags file (generated by `:helptags`) 2 | /doc/tags 3 | -------------------------------------------------------------------------------- /TODO.md: -------------------------------------------------------------------------------- 1 | # TODO 2 | 3 | - [x] `No matching autocommands` 4 | - Search with `/` returns prints that message 5 | - Fixed by upgrading to Neovim 0.4.4 6 | - [x] Star doesn't search word under cursor 7 | - Can't reproduce 8 | - [x] Searching with `/` with `clear_all_asap` doesn't work sometimes 9 | - CTRL-L doesn't work `clear_all_asap` 10 | - **Solution**: Delay after leaving command line 11 | - [x] `incsearch` setting not working with `clear_all_asap` sometimes 12 | - Search for a string using `/` 13 | - Hit `l` to clear it 14 | - Search for another string using `/` 15 | - Notice that search results are not highlighted as you type, as would 16 | be expected of `incsearch` 17 | - Press `` 18 | - Search for a string using `/` 19 | - Notice that `incsearch` seems to be working again 20 | - **Solution**: Not sure what fixed this, but I can't reproduce anymore 21 | - [ ] Autocommands aren't execute properly with `/` 22 | - Search for a string using `/` 23 | - You should see the autocommands execute 24 | - Search for another string using '/' 25 | - You won't see the autocommands execute 26 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # vim-searchhi 2 | 3 | Highlight the current search result in a different style than the other search 4 | results. 5 | 6 | ![Demo gif](https://raw.githubusercontent.com/qxxxb/vim-searchhi/assets/demo.gif) 7 | 8 | ## Credits 9 | 10 | This plugin would not have existed without [vim-searchant]. It uses the same 11 | basic implementation for highlighting the current search result. 12 | 13 | ## Features 14 | 15 | - Smooth integration with standard search as well as other search-enhancing 16 | plugins (e.g. [vim-anzu], [vim-asterisk]). 17 | 18 | - Uses a custom highlight group for the cursor when it's inside a search result. 19 | 20 | - Behaves appropriately in Visual mode. 21 | 22 | - Highlighting is updated predictably when the cursor is moved, as well as 23 | when switching buffers and windows. It can also be toggled with custom 24 | autocommands. 25 | 26 | - User autocommands are provided and executed when highlighting is turned on 27 | and off. 28 | 29 | **Note**: This plugin uses a lot of `` mappings. An alternative plugin is 30 | [vim-searchlight], which has the same basic functionality but doesn't require 31 | any mappings. 32 | 33 | ## Quick start 34 | ```vim 35 | nmap n (searchhi-n) 36 | nmap N (searchhi-N) 37 | nmap * (searchhi-*) 38 | nmap g* (searchhi-g*) 39 | nmap # (searchhi-#) 40 | nmap g# (searchhi-g#) 41 | nmap gd (searchhi-gd) 42 | nmap gD (searchhi-gD) 43 | 44 | vmap n (searchhi-v-n) 45 | vmap N (searchhi-v-N) 46 | vmap * (searchhi-v-*) 47 | vmap g* (searchhi-v-g*) 48 | vmap # (searchhi-v-#) 49 | vmap g# (searchhi-v-g#) 50 | vmap gd (searchhi-v-gd) 51 | vmap gD (searchhi-v-gD) 52 | 53 | nmap (searchhi-clear-all) 54 | vmap (searchhi-v-clear-all) 55 | ``` 56 | 57 | Integration with [vim-anzu]: 58 | ```vim 59 | let g:searchhi_user_autocmds_enabled = 1 60 | let g:searchhi_redraw_before_on = 1 61 | 62 | augroup searchhi 63 | autocmd! 64 | autocmd User SearchHiOn AnzuUpdateSearchStatusOutput 65 | autocmd User SearchHiOff echo g:anzu_no_match_word 66 | augroup END 67 | ``` 68 | 69 | Example with [vim-asterisk]: 70 | ```vim 71 | map * (asterisk-*)(searchhi-update) 72 | map # (asterisk-#)(searchhi-update) 73 | map g* (asterisk-g*)(searchhi-update) 74 | map g# (asterisk-g#)(searchhi-update) 75 | 76 | map z* (asterisk-z*)(searchhi-update) 77 | map z# (asterisk-z#)(searchhi-update) 78 | map gz* (asterisk-gz*)(searchhi-update) 79 | map gz# (asterisk-gz#)(searchhi-update) 80 | ``` 81 | 82 | ## Customization 83 | 84 | ### Highlight style 85 | 86 | The current search result is highlighted with `CurrentSearch`, and the cursor 87 | when it's inside a search result is highlighted with `SearchCursor`. Example: 88 | ```vim 89 | highlight CurrentSearch 90 | \ cterm=reverse,bold ctermfg=108 ctermbg=235 91 | \ gui=reverse,bold guifg=#8ec07c guibg=#282828 92 | 93 | highlight link SearchCursor WarningMsg 94 | ``` 95 | 96 | By default, `CurrentSearch` is linked to `Incsearch`, which works nicely if your 97 | `Incsearch` and `Search` highlight groups are visually distinguishable. 98 | `SearchCursor` is linked to `Normal` by default. 99 | 100 | ### Autocommands 101 | 102 | The autocommands `SearchHiOn` and `SearchHiOff` are executed when highlighting 103 | is turned on or off. Below is an example that blinks the cursor when search 104 | highlighting is turned on, making the cursor easier to find. [vim-anzu] is also 105 | used to echo the search count. 106 | ```vim 107 | let g:searchhi_user_autocmds_enabled = 1 108 | let g:searchhi_redraw_before_on = 1 109 | 110 | augroup searchhi 111 | autocmd! 112 | 113 | autocmd User SearchHiOn 114 | \ set guicursor= 115 | \c-sm:block,i-ci-ve:ver25,r-cr-o:hor20, 116 | \n-v:block-blinkwait20-blinkon20-blinkoff20 | 117 | \ AnzuUpdateSearchStatusOutput 118 | 119 | autocmd User SearchHiOff set guicursor& | echo g:anzu_no_match_word 120 | augroup END 121 | ``` 122 | 123 | ### Autocommands for toggling search highlighting 124 | 125 | Highlighting for all search results can be toggled with custom autocommands. 126 | Example: 127 | ```vim 128 | let g:searchhi_clear_all_autocmds = 'InsertEnter' 129 | let g:searchhi_update_all_autocmds = 'InsertLeave' 130 | ``` 131 | 132 | **Note**: Using `CursorMoved` for these will cause issues. If you want search 133 | highlighting to be cleared as soon as the cursor moves, use this: 134 | 135 | ```vim 136 | let g:searchhi_clear_all_asap = 1 137 | ``` 138 | 139 | Because `g:searchhi_clear_all_asap` and `g:searchhi_clear_all_autocmds` both 140 | use a hack that directly sets `nohlsearch`, you may also need to use the 141 | following maps to make sure that `incsearch` works properly when searching: 142 | 143 | ```vim 144 | nmap / (searchhi-/) 145 | nmap ? (searchhi-?) 146 | 147 | vmap / (searchhi-v-/) 148 | vmap ? (searchhi-v-?) 149 | ``` 150 | 151 | [vim-searchant]: https://github.com/timakro/vim-searchant 152 | [vim-anzu]: https://github.com/osyo-manga/vim-anzu 153 | [vim-asterisk]: https://github.com/haya14busa/vim-asterisk 154 | [vim-searchlight]: https://github.com/PeterRincker/vim-searchlight 155 | -------------------------------------------------------------------------------- /plugin/searchhi.vim: -------------------------------------------------------------------------------- 1 | if exists('g:loaded_searchhi') || &cp 2 | finish 3 | endif 4 | let g:loaded_searchhi = 1 5 | 6 | if !exists('g:searchhi_user_autocmds_enabled') 7 | let g:searchhi_user_autocmds_enabled = 0 8 | endif 9 | 10 | if !exists('g:searchhi_clear_all_autocmds') 11 | let g:searchhi_clear_all_autocmds = '' 12 | endif 13 | 14 | if !exists('g:searchhi_update_all_autocmds') 15 | let g:searchhi_update_all_autocmds = '' 16 | endif 17 | 18 | if !exists('g:searchhi_clear_all_asap') 19 | let g:searchhi_clear_all_asap = 0 20 | endif 21 | 22 | if !exists('g:searchhi_open_folds') 23 | let g:searchhi_open_folds = 1 24 | endif 25 | 26 | if !exists('g:searchhi_visual_maps_enabled') 27 | let g:searchhi_visual_maps_enabled = 1 28 | endif 29 | 30 | if !exists('g:searchhi_cmdline_leave_time') 31 | let g:searchhi_cmdline_leave_time = 25 32 | endif 33 | 34 | if !exists('g:searchhi_redraw_before_on') 35 | let g:searchhi_redraw_before_on = 0 36 | endif 37 | 38 | if !exists('g:searchhi_cursor') 39 | let g:searchhi_cursor = 1 40 | end 41 | 42 | " Setting it to `Incsearch` works out surprisingly nicely 43 | highlight default link CurrentSearch Incsearch 44 | 45 | highlight default link SearchCursor Normal 46 | 47 | let g:searchhi_status = '' 48 | call searchhi#await() 49 | 50 | noremap (searchhi-listen) 51 | \ :call searchhi#listen(0, 0) 52 | 53 | noremap (searchhi-await) 54 | \ :call searchhi#await(0, 0) 55 | 56 | noremap (searchhi-update) 57 | \ :call searchhi#update(0, 0) 58 | 59 | noremap (searchhi-clear) 60 | \ :call searchhi#clear(0, 0) 61 | 62 | " Convenience mappings 63 | 64 | " These don't need to be used unless `g:searchhi_clear_all_asap` or 65 | " `g:searchhi_clear_all_autocmds` are used in a such a way that hlsearch is 66 | " still turned off when the next search is started {{{ 67 | 68 | noremap (searchhi-pre-search) 69 | \ :nohlsearch:call searchhi#hlsearch(0, 0) 70 | 71 | noremap (searchhi-/) 72 | \ :nohlsearch:call searchhi#hlsearch(0, 0)/ 73 | 74 | noremap (searchhi-?) 75 | \ :nohlsearch:call searchhi#hlsearch(0, 0)? 76 | 77 | " }}} 78 | 79 | map (searchhi-clear-all) 80 | \ :nohlsearch(searchhi-clear)(searchhi-await) 81 | 82 | noremap (searchhi-n) 83 | \ n:call searchhi#update(0, 0) 84 | 85 | noremap (searchhi-N) 86 | \ N:call searchhi#update(0, 0) 87 | 88 | if g:searchhi_clear_all_asap 89 | noremap (searchhi-*) 90 | \ :call searchhi#update(0, 0) 91 | \:call searchhi#force_ignorecase(0, 0)* 92 | \:call searchhi#update(0, 0) 93 | 94 | noremap (searchhi-g*) 95 | \ :call searchhi#update(0, 0) 96 | \:call searchhi#force_ignorecase(0, 0)g* 97 | \:call searchhi#update(0, 0) 98 | 99 | noremap (searchhi-#) 100 | \ :call searchhi#update(0, 0) 101 | \:call searchhi#force_ignorecase(0, 0)# 102 | \:call searchhi#update(0, 0) 103 | 104 | noremap (searchhi-g#) 105 | \ :call searchhi#update(0, 0) 106 | \:call searchhi#force_ignorecase(0, 0)g# 107 | \:call searchhi#update(0, 0) 108 | 109 | noremap (searchhi-gd) 110 | \ :call searchhi#update(0, 0) 111 | \:call searchhi#force_ignorecase(0, 0)gd 112 | \:call searchhi#update(0, 0) 113 | 114 | noremap (searchhi-gD) 115 | \ :call searchhi#update(0, 0) 116 | \:call searchhi#force_ignorecase(0, 0)gD 117 | \:call searchhi#update(0, 0) 118 | else 119 | noremap (searchhi-*) 120 | \ :call searchhi#update(0, 0) 121 | \:call searchhi#force_ignorecase(0, 0)* 122 | 123 | noremap (searchhi-g*) 124 | \ :call searchhi#update(0, 0) 125 | \:call searchhi#force_ignorecase(0, 0)g* 126 | 127 | noremap (searchhi-#) 128 | \ :call searchhi#update(0, 0) 129 | \:call searchhi#force_ignorecase(0, 0)# 130 | 131 | noremap (searchhi-g#) 132 | \ :call searchhi#update(0, 0) 133 | \:call searchhi#force_ignorecase(0, 0)g# 134 | 135 | noremap (searchhi-gd) 136 | \ :call searchhi#update(0, 0) 137 | \:call searchhi#force_ignorecase(0, 0)gd 138 | 139 | noremap (searchhi-gD) 140 | \ :call searchhi#update(0, 0) 141 | \:call searchhi#force_ignorecase(0, 0)gD 142 | endif 143 | 144 | if g:searchhi_visual_maps_enabled 145 | noremap (searchhi-v-listen) 146 | \ :call searchhi#listen(1, 0) 147 | 148 | noremap (searchhi-v-await) 149 | \ :call searchhi#await(1, 0) 150 | 151 | noremap (searchhi-v-clear) 152 | \ :call searchhi#clear(1, 0) 153 | 154 | noremap (searchhi-v-update) 155 | \ :call searchhi#update(1, 0) 156 | 157 | noremap (searchhi-v-pre-search) 158 | \ :nohlsearch:call searchhi#hlsearch(1, 0) 159 | 160 | noremap (searchhi-v-/) 161 | \ :nohlsearch:call searchhi#hlsearch(1, 0)/ 162 | 163 | noremap (searchhi-v-?) 164 | \ :nohlsearch:call searchhi#hlsearch(1, 0)? 165 | 166 | map (searchhi-v-clear-all) 167 | \ :nohlsearch(searchhi-clear)(searchhi-v-await) 168 | 169 | noremap (searchhi-v-n) 170 | \ n:call searchhi#update(1, 0) 171 | 172 | noremap (searchhi-v-N) 173 | \ N:call searchhi#update(1, 0) 174 | 175 | noremap (searchhi-v-*) 176 | \ :call searchhi#update(0, 0) 177 | \:call searchhi#force_ignorecase(1, 0)* 178 | 179 | noremap (searchhi-v-g*) 180 | \ :call searchhi#update(0, 0) 181 | \:call searchhi#force_ignorecase(1, 0)g* 182 | 183 | noremap (searchhi-v-#) 184 | \ :call searchhi#update(0, 0) 185 | \:call searchhi#force_ignorecase(1, 0)# 186 | 187 | noremap (searchhi-v-g#) 188 | \ :call searchhi#update(0, 0) 189 | \:call searchhi#force_ignorecase(1, 0)g# 190 | 191 | noremap (searchhi-v-gd) 192 | \ :call searchhi#update(0, 0) 193 | \:call searchhi#force_ignorecase(1, 0)gd 194 | 195 | noremap (searchhi-v-gD) 196 | \ :call searchhi#update(0, 0) 197 | \:call searchhi#force_ignorecase(1, 0)gD 198 | endif 199 | -------------------------------------------------------------------------------- /autoload/searchhi.vim: -------------------------------------------------------------------------------- 1 | let s:save_cpo = &cpo 2 | set cpo&vim 3 | 4 | " Await mode should be used when search highlighting is off 5 | function! searchhi#await(...) range 6 | let expect_visual = get(a:, 1, s:is_visual()) 7 | let is_visual = get(a:, 2, s:is_visual()) 8 | 9 | if g:searchhi_status != 'await' 10 | let g:searchhi_status = 'await' 11 | 12 | augroup searchhi_internal 13 | autocmd! 14 | autocmd CmdLineLeave * silent call searchhi#await_cmdline_leave() 15 | augroup END 16 | endif 17 | 18 | call s:restore_visual(expect_visual, is_visual) 19 | endfunction 20 | 21 | " Listen mode should be used when search highlighting is on. The plugin 22 | " 'listens' for any events (e.g. `CursorMoved`) that might update the current 23 | " search result 24 | function! searchhi#listen(...) range 25 | let expect_visual = get(a:, 1, s:is_visual()) 26 | let is_visual = get(a:, 2, s:is_visual()) 27 | 28 | if g:searchhi_status != 'listen' 29 | let g:searchhi_status = 'listen' 30 | 31 | augroup searchhi_internal 32 | autocmd! 33 | 34 | autocmd CursorMoved,WinEnter,BufEnter * 35 | \ silent call searchhi#update() 36 | 37 | autocmd WinLeave,BufLeave * silent call searchhi#listen_leave() 38 | 39 | autocmd CmdlineLeave * silent call searchhi#listen_cmdline_leave() 40 | autocmd CmdlineEnter * silent call searchhi#listen_cmdline_enter() 41 | 42 | if len(g:searchhi_clear_all_autocmds) > 0 43 | execute 'autocmd! ' . g:searchhi_clear_all_autocmds . 44 | \ ' * silent call searchhi#clear_all()' 45 | endif 46 | 47 | if len(g:searchhi_update_all_autocmds) > 0 48 | execute 'autocmd! ' . g:searchhi_update_all_autocmds . 49 | \ ' * silent call searchhi#update_all()' 50 | endif 51 | augroup END 52 | endif 53 | 54 | call s:restore_visual(expect_visual, is_visual) 55 | endfunction 56 | 57 | function! searchhi#update(...) range 58 | let expect_visual = get(a:, 1, s:is_visual()) 59 | let is_visual = get(a:, 2, s:is_visual()) 60 | 61 | if g:searchhi_status != 'listen' 62 | call searchhi#listen(0, 0) 63 | endif 64 | 65 | if expect_visual 66 | " We need to do this so the cursor is at the end position of the 67 | " visual selection 68 | call s:restore_visual(expect_visual, is_visual) 69 | let is_visual = expect_visual 70 | endif 71 | 72 | let query = @/ 73 | 74 | if exists('g:searchhi_force_ignorecase') 75 | let search_query = query . '\c' 76 | else 77 | let search_query = query 78 | endif 79 | 80 | silent! let [end_line, end_column] = searchpos(search_query, 'bneW') 81 | silent! let [start_line, start_column] = searchpos(search_query, 'bcnW') 82 | 83 | if start_line > end_line || start_column > end_column 84 | if !exists('g:searchhi_match') || 85 | \ !exists('g:searchhi_match_column') || 86 | \ g:searchhi_match_column != start_column || 87 | \ g:searchhi_match_line != start_line || 88 | \ g:searchhi_match_query != query 89 | " Off -> On || On -> On (different) 90 | 91 | if exists('g:searchhi_match') 92 | " On -> On (different) 93 | call searchhi#clear(0, 0) 94 | 95 | if g:searchhi_clear_all_asap 96 | set nohlsearch 97 | call searchhi#await(0, 0) 98 | call s:restore_visual(expect_visual, is_visual) 99 | return 100 | endif 101 | else 102 | " Off -> On 103 | if !&hlsearch 104 | set hlsearch 105 | endif 106 | endif 107 | 108 | " The pattern is restricted to the line and column where the 109 | " current search result begins, using (`/\%l`) and (`/\%c`) 110 | " respectively. The previous search query is then used to finish 111 | " the pattern 112 | let pattern = 113 | \ '\%' . start_line . 'l' . 114 | \ '\%' . start_column . 'c' . 115 | \ query 116 | 117 | " I think this already handles `smartcase` properly 118 | if &ignorecase 119 | let pattern .= '\c' 120 | endif 121 | 122 | let g:searchhi_match = matchadd('CurrentSearch', pattern) 123 | 124 | let g:searchhi_match_query = query 125 | let g:searchhi_match_line = start_line 126 | let g:searchhi_match_column = start_column 127 | let g:searchhi_match_cursor_line = line('.') 128 | let g:searchhi_match_cursor_column = col('.') 129 | let g:searchhi_match_window = win_getid() 130 | 131 | if g:searchhi_cursor && bufname('%') != '[Command Line]' 132 | let g:searchhi_cursor_match = matchadd('SearchCursor', '\%#') 133 | endif 134 | 135 | if g:searchhi_user_autocmds_enabled 136 | if g:searchhi_redraw_before_on 137 | redraw 138 | endif 139 | 140 | unsilent doautocmd User SearchHiOn 141 | endif 142 | 143 | if g:searchhi_open_folds 144 | try 145 | " Try to open a fold (this will exit visual mode and go to 146 | " normal mode) 147 | normal! zO 148 | catch /^Vim\%((\a\+)\)\=:E490/ 149 | endtry 150 | 151 | let is_visual = 0 152 | endif 153 | elseif g:searchhi_clear_all_asap && 154 | \ exists('g:searchhi_match') && 155 | \ exists('g:searchhi_match_cursor_column') && 156 | \ ( 157 | \ g:searchhi_match_cursor_column != col('.') || 158 | \ g:searchhi_match_cursor_line != line('.') 159 | \ ) 160 | " Specific case of On -> On (same) 161 | 162 | call searchhi#clear(0, 0) 163 | set nohlsearch 164 | call searchhi#await(0, 0) 165 | endif 166 | else 167 | " Make Off -> Off as optimized as possible 168 | if exists('g:searchhi_match') 169 | " On -> Off 170 | call searchhi#clear(0, 0) 171 | 172 | if g:searchhi_clear_all_asap 173 | set nohlsearch 174 | call searchhi#await(0, 0) 175 | endif 176 | endif 177 | endif 178 | 179 | call s:restore_visual(expect_visual, is_visual) 180 | endfunction 181 | 182 | function! searchhi#clear(...) range 183 | let expect_visual = get(a:, 1, s:is_visual()) 184 | let is_visual = get(a:, 2, s:is_visual()) 185 | 186 | if exists('g:searchhi_match') 187 | " On -> Off 188 | 189 | " All this logic for switching windows is only required when the 190 | " command-window is used, because that doesn't trigger `WinLeave` or 191 | " `BufLeave` 192 | 193 | let orig_window = win_getid() 194 | 195 | let same_window = 0 196 | if orig_window == g:searchhi_match_window 197 | let same_window = 1 198 | endif 199 | 200 | if !same_window 201 | " Move to the tab and window where the highlight is 202 | " 203 | " This can be false if the other window was closed. If this true, 204 | " then it means that it exists and we have moved to it. 205 | noautocmd let match_window_exists = 206 | \ win_gotoid(g:searchhi_match_window) 207 | endif 208 | 209 | if same_window || match_window_exists 210 | " Remove the highlight 211 | call matchdelete(g:searchhi_match) 212 | 213 | if g:searchhi_cursor && exists('g:searchhi_cursor_match') 214 | call matchdelete(g:searchhi_cursor_match) 215 | silent! unlet g:searchhi_cursor_match 216 | endif 217 | endif 218 | 219 | if !same_window && match_window_exists 220 | " Move back to the original window 221 | noautocmd call win_gotoid(orig_window) 222 | 223 | " If there was a visual selection before we moved to another 224 | " window, it got clobbered 225 | let is_visual = 0 226 | endif 227 | 228 | if g:searchhi_user_autocmds_enabled 229 | unsilent doautocmd User SearchHiOff 230 | endif 231 | 232 | unlet g:searchhi_match 233 | silent! unlet g:searchhi_match_query 234 | silent! unlet g:searchhi_match_line 235 | silent! unlet g:searchhi_match_column 236 | silent! unlet g:searchhi_match_cursor_line 237 | silent! unlet g:searchhi_match_cursor_column 238 | silent! unlet g:searchhi_match_window 239 | endif 240 | 241 | call s:restore_visual(expect_visual, is_visual) 242 | endfunction 243 | 244 | function! searchhi#clear_all(...) range 245 | let expect_visual = get(a:, 1, s:is_visual()) 246 | let is_visual = get(a:, 2, s:is_visual()) 247 | 248 | " Hack: Set the option directly 249 | set nohlsearch 250 | call searchhi#clear(expect_visual, is_visual) 251 | call searchhi#await(0, 0) 252 | endfunction 253 | 254 | " Autocmd functions {{{ 255 | 256 | " Hack: if the search was aborted, wait a little bit before updating the 257 | " search highlight. It's done this way because `CmdlineEnter` does not give 258 | " the right cursor position, so we wait for it to get restored before updating 259 | " the search highlight. 260 | 261 | function! searchhi#cmdline_leave_handler(timer) 262 | call searchhi#update() 263 | 264 | if exists('g:searchhi_force_ignorecase') 265 | unlet g:searchhi_force_ignorecase 266 | endif 267 | 268 | if exists('g:searchhi_cmdline_leave_timer') 269 | unlet g:searchhi_cmdline_leave_timer 270 | endif 271 | endfunction 272 | 273 | function! searchhi#listen_cmdline_leave() 274 | if getcmdtype() == '/' || getcmdtype() == '?' 275 | let g:searchhi_cmdline_leave_timer = 276 | \ timer_start( 277 | \ g:searchhi_cmdline_leave_time, 278 | \ 'searchhi#cmdline_leave_handler' 279 | \ ) 280 | endif 281 | endfunction 282 | 283 | function! searchhi#listen_cmdline_enter() 284 | if getcmdtype() == '/' || getcmdtype() == '?' 285 | call searchhi#clear() 286 | 287 | if exists('g:searchhi_force_ignorecase') 288 | unlet g:searchhi_force_ignorecase 289 | endif 290 | endif 291 | endfunction 292 | 293 | function! searchhi#listen_leave() 294 | " This is to prevent prompts from appearing if the users' autocmds use an 295 | " echo. An example is using anzu and calling FZF while highlighting is on 296 | let orig = g:searchhi_user_autocmds_enabled 297 | let g:searchhi_user_autocmds_enabled = 0 298 | 299 | call searchhi#clear() 300 | 301 | let g:searchhi_user_autocmds_enabled = orig 302 | endfunction 303 | 304 | function! searchhi#await_cmdline_leave() 305 | if (getcmdtype() == '/' || getcmdtype() == '?') && 306 | \ has_key(v:event, 'abort') && v:event.abort 307 | call searchhi#clear_all() 308 | else 309 | call searchhi#listen_cmdline_leave() 310 | endif 311 | endfunction 312 | 313 | function! searchhi#update_all() 314 | if !&hlsearch 315 | set hlsearch 316 | endif 317 | 318 | call searchhi#update() 319 | endfunction 320 | 321 | function! searchhi#hlsearch(...) 322 | let expect_visual = get(a:, 1, s:is_visual()) 323 | let is_visual = get(a:, 2, s:is_visual()) 324 | 325 | if !&hlsearch 326 | set hlsearch 327 | endif 328 | 329 | call s:restore_visual(expect_visual, is_visual) 330 | endfunction 331 | 332 | " }}} 333 | 334 | " Helpers {{{ 335 | 336 | " A more accurate name would be `restore_visual_if_necessary` but that's too 337 | " long 338 | function! s:restore_visual(expect_visual, is_visual) 339 | if a:is_visual == a:expect_visual 340 | return 341 | elseif a:expect_visual && !a:is_visual 342 | " Reselect previous visual selection 343 | normal! gv 344 | elseif !a:expect_visual && a:is_visual 345 | " This will probably never get called in this script, but for 346 | " completeness here it is. This just returns to normal mode 347 | normal '' 348 | endif 349 | endfunction 350 | 351 | function! searchhi#force_ignorecase(...) range 352 | let expect_visual = get(a:, 1, s:is_visual()) 353 | let is_visual = get(a:, 2, s:is_visual()) 354 | 355 | let g:searchhi_force_ignorecase = 1 356 | 357 | call s:restore_visual(expect_visual, is_visual) 358 | endfunction 359 | 360 | function! s:is_visual() 361 | " `=~#` is if regexp matches (case sensitive) 362 | " `mode(1)` returns the full name of the mode 363 | return mode(1) =~# "[vV\]" 364 | endfunction 365 | 366 | " }}} 367 | 368 | let &cpo = s:save_cpo 369 | -------------------------------------------------------------------------------- /doc/searchhi.txt: -------------------------------------------------------------------------------- 1 | *searchhi.txt* Plugin for highlighting the current search result 2 | *searchhi* 3 | 4 | ============================================================================== 5 | CONTENTS *searchhi-contents* 6 | 7 | 1. Intro .......................................... |searchhi-intro| 8 | 1.1. Credits .................................. |searchhi-credits| 9 | 2. Features ....................................... |searchhi-features| 10 | 3. Quick start .................................... |searchhi-quick-start| 11 | 4. Config ......................................... |searchhi-config| 12 | 4.1. Highlight ................................ |searchhi-highlight| 13 | 4.2. Autocommands ............................. |searchhi-autocmds| 14 | 4.3. Options .................................. |searchhi-options| 15 | 5. Mappings ....................................... |searchhi-mappings| 16 | 5.1. Normal mode .............................. |searchhi-n-mappings| 17 | 5.2. Visual mode .............................. |searchhi-v-mappings| 18 | 19 | ============================================================================== 20 | 1. Intro *searchhi-intro* 21 | 22 | This plugin does primarily one thing: highlight the current search result (the 23 | one under the cursor) in a different style than the others. 24 | 25 | ------------------------------------------------------------------------------ 26 | 1.1. Credits *searchhi-credits* 27 | 28 | This plugin uses code from the following sources: 29 | 30 | Plugin: {vim-searchant}{1} 31 | Author: Tim Schumacher 32 | 33 | - |searchhi| would not have existed without {vim-searchant}{1}. It uses 34 | the same basic implementation for highlighting the current search 35 | result. 36 | 37 | {1} https://github.com/timakro/vim-searchant 38 | 39 | ============================================================================== 40 | 2. Features *searchhi-features* 41 | 42 | - Smooth integration with standard search as well as other 43 | search-enhancing plugins (e.g. {vim-anzu}{2}, {vim-asterisk}{3}). 44 | 45 | - Uses a custom highlight group for the cursor when it's inside a search 46 | result. 47 | 48 | - Behaves appropriately in Visual mode. 49 | 50 | - Highlighting is updated predictably when the cursor is moved, as well as 51 | when switching buffers and windows. It can also be toggled with custom 52 | autocommands. 53 | 54 | - User autocommands are provided and executed when highlighting is turned 55 | on and off. 56 | 57 | {2} https://github.com/osyo-manga/vim-anzu 58 | {3} https://github.com/haya14busa/vim-asterisk 59 | 60 | 61 | ============================================================================== 62 | 3. Quick start *searchhi-quick-start* 63 | 64 | > 65 | nmap n (searchhi-n) 66 | nmap N (searchhi-N) 67 | nmap * (searchhi-*) 68 | nmap g* (searchhi-g*) 69 | nmap # (searchhi-#) 70 | nmap g# (searchhi-g#) 71 | nmap gd (searchhi-gd) 72 | nmap gD (searchhi-gD) 73 | 74 | vmap n (searchhi-v-n) 75 | vmap N (searchhi-v-N) 76 | vmap * (searchhi-v-*) 77 | vmap g* (searchhi-v-g*) 78 | vmap # (searchhi-v-#) 79 | vmap g# (searchhi-v-g#) 80 | vmap gd (searchhi-v-gd) 81 | vmap gD (searchhi-v-gD) 82 | 83 | nmap (searchhi-clear-all) 84 | vmap (searchhi-v-clear-all) 85 | < 86 | 87 | Integration with {vim-anzu}{2}: 88 | > 89 | let g:searchhi_user_autocmds_enabled = 1 90 | let g:searchhi_redraw_before_on = 1 91 | 92 | augroup searchhi 93 | autocmd! 94 | autocmd User SearchHiOn AnzuUpdateSearchStatusOutput 95 | autocmd User SearchHiOff echo g:anzu_no_match_word 96 | augroup END 97 | < 98 | 99 | Integration with {vim-asterisk}{3}: 100 | > 101 | map * (asterisk-*)(searchhi-update)(searchhi-listen) 102 | map # (asterisk-#)(searchhi-update)(searchhi-listen) 103 | map g* (asterisk-g*)(searchhi-update)(searchhi-listen) 104 | map g# (asterisk-g#)(searchhi-update)(searchhi-listen) 105 | 106 | map z* (asterisk-z*)(searchhi-update)(searchhi-listen) 107 | map z# (asterisk-z#)(searchhi-update)(searchhi-listen) 108 | map gz* (asterisk-gz*)(searchhi-update)(searchhi-listen) 109 | map gz# (asterisk-gz#)(searchhi-update)(searchhi-listen) 110 | < 111 | 112 | ============================================================================== 113 | 4. Config *searchhi-config* 114 | 115 | ------------------------------------------------------------------------------ 116 | 4.1. Highlight *searchhi-highlight* 117 | 118 | *hl-CurrentSearch* 119 | Current search result. The default value works nicely if |hl-Incsearch| 120 | and |hl-Search| are visually distinguishable. 121 | `---` 122 | Default: `Incsearch` 123 | 124 | *hl-SearchCursor* 125 | Cursor when it's inside a search result. This isn't used in the command 126 | window, because the search pattern isn't updated there for some reason. 127 | `---` 128 | Default: `Normal` 129 | 130 | Example: 131 | > 132 | highlight CurrentSearch 133 | \ cterm=reverse,bold ctermfg=108 ctermbg=235 134 | \ gui=reverse,bold guifg=#8ec07c guibg=#282828 135 | 136 | highlight link SearchCursor WarningMsg 137 | < 138 | 139 | ------------------------------------------------------------------------------ 140 | 4.2. Autocommands *searchhi-autocmds* 141 | 142 | Name Trigger ~ 143 | *SearchHiOn* When highlighting is turned on 144 | *SearchHiOff* When highlighting is turned off 145 | 146 | Below is an example that blinks the cursor when search highlighting is turned 147 | on, making the cursor easier to find. {vim-anzu}{2} is also used to echo the 148 | search count. 149 | > 150 | let g:searchhi_user_autocmds_enabled = 1 151 | let g:searchhi_redraw_before_on = 1 152 | 153 | augroup searchhi 154 | autocmd! 155 | 156 | autocmd User SearchHiOn 157 | \ set guicursor= 158 | \c-sm:block,i-ci-ve:ver25,r-cr-o:hor20, 159 | \n-v:block-blinkwait20-blinkon20-blinkoff20 | 160 | \ AnzuUpdateSearchStatusOutput 161 | 162 | autocmd User SearchHiOff set guicursor& | echo g:anzu_no_match_word 163 | augroup END 164 | < 165 | 166 | ------------------------------------------------------------------------------ 167 | 4.3. Misc *searchhi-config-misc* 168 | 169 | *g:searchhi_user_autocmds_enabled* 170 | Whether |SearchHiOn| and |SearchHiOff| are executed. 171 | `---` 172 | Type: |Number| 173 | Default: `0` 174 | 175 | *g:searchhi_clear_all_autocmds* 176 | |autocmd-events| separated by commas (no spaces) that will clear all 177 | search highlighting. 178 | 179 | Note: Do not use `CursorMoved` for this. This causes issues because 180 | this plugin internally relies on `CursorMoved`. Instead, use 181 | |g:searchhi_clear_all_asap|. 182 | 183 | Note: This uses a hack that runs `set nohlsearch`, because using the 184 | command |nohlsearch| does not work in scripts. See |(searchhi-/)| to 185 | avoid side-effects. 186 | 187 | `---` 188 | Type: |String| 189 | Default: `''` 190 | Example: 191 | > 192 | let g:searchhi_clear_all_autocmds = 'InsertEnter' 193 | < 194 | 195 | *g:searchhi_update_all_autocmds* 196 | |autocmd-events| separated by commas (no spaces) that update highlighting 197 | for all search results. 198 | 199 | Note: Do not use `CursorMoved` for this. This causes issues because this 200 | plugin internally relies on `CursorMoved`. 201 | 202 | `---` 203 | Type: |String| 204 | Default: `''` 205 | Example: 206 | > 207 | let g:searchhi_update_all_autocmds = 'InsertLeave' 208 | < 209 | 210 | *g:searchhi_clear_all_asap* 211 | Whether all search highlighting should be turned off as soon as the cursor 212 | moves. 213 | 214 | Note: This uses a hack that runs `set nohlsearch`, because using the 215 | command |nohlsearch| does not work in scripts. See |(searchhi-/)| to 216 | avoid side-effects. 217 | 218 | `---` 219 | Type: |Number| 220 | Default: `0` 221 | 222 | *g:searchhi_cursor* 223 | Whether the cursor should be highlighted with |hl-SearchCursor| when it's 224 | inside a search result. 225 | `---` 226 | Type: |Number| 227 | Default: `1` 228 | 229 | *g:searchhi_open_folds* 230 | Whether folds should be automatically opened if they contain the current 231 | search result. 232 | `---` 233 | Type: |Number| 234 | Default: `1` 235 | 236 | *g:searchhi_visual_maps_enabled* 237 | Whether mappings should be created for Visual mode functions. 238 | `---` 239 | Type: |Number| 240 | Default: `1` 241 | 242 | *g:searchhi_cmdline_leave_time* 243 | Time in milliseconds before updating the search highlight after leaving 244 | the command line. This exists so that the cursor position can be restored 245 | and dealt with properly after leaving the command line. 246 | `---` 247 | Type: |Number| 248 | Default: `25` 249 | 250 | *g:searchhi_redraw_before_on* 251 | Whether the screen should be redrawn before |SearchHiOn| is executed. This 252 | fixes several specific cases when |echo| messages from |searchhi-autocmds| 253 | are immediately overwritten, such as when the viewport scrolls when 254 | jumping to the next match. 255 | `---` 256 | Type: |Number| 257 | Default: `1` 258 | 259 | ============================================================================== 260 | 5. Mappings *searchhi-mappings* 261 | 262 | ------------------------------------------------------------------------------ 263 | 5.1. Normal mode *searchhi-n-mappings* 264 | 265 | Standard mappings that can replace their respective normal mode 266 | commands: 267 | 268 | *(searchhi-n)* 269 | *(searchhi-N)* 270 | *(searchhi-star)* -> (searchhi-*) 271 | *(searchhi-#)* 272 | *(searchhi-gstar)* -> (searchhi-g*) 273 | *(searchhi-g#)* 274 | *(searchhi-gd)* 275 | *(searchhi-gD)* 276 | 277 | General use mappings: 278 | 279 | *(searchhi-clear-all)* 280 | Clear all search highlighting. 281 | 282 | Other mappings that can replace their respective normal mode commands: 283 | 284 | *(searchhi-/)* 285 | *(searchhi-?)* 286 | These execute |(searchhi-pre-search)| before searching. They 287 | only need to be used for specific cases which involve the hack that 288 | uses `set nohlsearch` to clear search highlighting. Here are two 289 | example cases: 290 | 291 | 1. |g:searchhi_clear_all_asap| is `1` 292 | 293 | 2. |g:searchhi_clear_all_autocmds| is `InsertEnter` and 294 | |g:searchhi_update_all_autocmds| does not contain `InsertLeave` 295 | 296 | Low-level mappings (can be used to integrate with other plugins): 297 | 298 | *(searchhi-listen)* 299 | Start listening for any events (e.g. `CursorMoved`, `WinLeave`) that 300 | might update the current search result. 301 | 302 | *(searchhi-await)* 303 | Waits for events that will start search highlighting. This essentially 304 | turns off |(searchhi-listen)|, and should be called when search 305 | highlighting is turned off. 306 | 307 | *(searchhi-update)* 308 | If the cursor is over a search result, highlight it and call the 309 | appropriate |searchhi-autocmds|. This turns on 310 | |(searchhi-listen)| if it's not already on. 311 | 312 | *(searchhi-clear)* 313 | Clears the highlight on the current search result, but not the 314 | highlights on the rest of them. 315 | 316 | Note: this doesn't mean that the current search result will not be 317 | highlighted at all. Instead, it will be highlighted with the same 318 | highlight group as the other search results (i.e. |hl-Search|). 319 | 320 | *(searchhi-pre-search)* 321 | Executes |:nohlsearch| and sets |hlsearch|. This ensures that 322 | |incsearch| works properly. 323 | 324 | ------------------------------------------------------------------------------ 325 | 5.2. Visual mode *searchhi-v-mappings* 326 | 327 | These are the same as the normal mode mappings, but they preserve the visual 328 | selection: 329 | 330 | *(searchhi-v-n)* 331 | *(searchhi-v-N)* 332 | *(searchhi-v-star)* -> (searchhi-v-*) 333 | *(searchhi-v-#)* 334 | *(searchhi-v-gstar)* -> (searchhi-v-g*) 335 | *(searchhi-v-g#)* 336 | *(searchhi-v-gd)* 337 | *(searchhi-v-gD)* 338 | 339 | *(searchhi-v-clear-all)* 340 | 341 | *(searchhi-v-listen)* 342 | *(searchhi-v-await)* 343 | *(searchhi-v-update)* 344 | *(searchhi-v-clear)* 345 | 346 | vim:tw=78:sw=4:ft=help:norl: 347 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------