aboutsummaryrefslogtreecommitdiff
path: root/vim/plugin/big_file_options.vim
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2017-11-04 22:41:15 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-11-04 22:41:15 +1300
commit1175a6d4338b43b8521617606f44a3c29a2ec0ff (patch)
tree2c15a1f3416f4c547fd1834e2991eb60c4cf18c9 /vim/plugin/big_file_options.vim
parent09f8635dcd7d5a459b7d4b38482b2e1fece607b0 (diff)
downloaddotfiles-1175a6d4338b43b8521617606f44a3c29a2ec0ff.tar.gz
dotfiles-1175a6d4338b43b8521617606f44a3c29a2ec0ff.zip
Add short-circuit boilerplate to plugins
Set a g:loaded_* flag to prevent repeated reloads, and refuse to load at all if &compatible is set or if required features are missing. Some more accommodating plugins avoid the problems 'compatible' causes by saving its value at startup into a script variable, setting the option to the Vim default, and then restoring it when the plugin is done, to prevent any of its flags from interfering in the plugin code: let s:save_cpo = &cpo set cpo&vim ... let &cpo = s:save_cpo unlet s:save_cpo I don't want this boilerplate, so I'm going to do what Tim Pope's modules seem to, and just have the plugin refuse to do a single thing if 'compatible' is set.
Diffstat (limited to 'vim/plugin/big_file_options.vim')
-rw-r--r--vim/plugin/big_file_options.vim97
1 files changed, 50 insertions, 47 deletions
diff --git a/vim/plugin/big_file_options.vim b/vim/plugin/big_file_options.vim
index fd686fd8..3d239048 100644
--- a/vim/plugin/big_file_options.vim
+++ b/vim/plugin/big_file_options.vim
@@ -5,58 +5,61 @@
" Author: Tom Ryder <tom@sanctum.geek.nz>
" License: Same as Vim itself
"
-if has('eval') && has('autocmd')
+if exists('g:loaded_big_file_options')
+ \ || !has('autocmd')
+ \ || &compatible
+ finish
+endif
+let g:loaded_big_file_options = 1
+
+" Default threshold is 10 MiB
+if !exists('g:big_file_size')
+ let g:big_file_size = 10 * 1024 * 1024
+endif
- " Default threshold is 10 MiB
- if !exists('g:big_file_size')
- let g:big_file_size = 10 * 1024 * 1024
+" Default to leaving syntax highlighting off
+if !exists('g:big_file_syntax')
+ let g:big_file_syntax = 0
+endif
+
+" Cut 'synmaxcol' down to this or smaller for big files
+if !exists('g:big_file_synmaxcol')
+ let g:big_file_synmaxcol = 256
+endif
+
+" Declare function for turning off slow options
+function! s:BigFileOptions()
+
+ " Don't do anything if the file is under the threshold
+ if getfsize(expand('<afile>')) <= g:big_file_size
+ return
endif
- " Default to leaving syntax highlighting off
- if !exists('g:big_file_syntax')
- let g:big_file_syntax = 0
+ " Turn off backups, swap files, and undo files
+ setlocal nobackup
+ setlocal nowritebackup
+ setlocal noswapfile
+ if has('persistent_undo')
+ setlocal noundofile
endif
- " Cut 'synmaxcol' down to this or smaller for big files
- if !exists('g:big_file_synmaxcol')
- let g:big_file_synmaxcol = 256
+ " Limit the number of columns of syntax highlighting
+ if exists('&synmaxcol')
+ \ && &synmaxcol > g:big_file_synmaxcol
+ execute 'setlocal synmaxcol=' . g:big_file_synmaxcol
endif
- " Declare function for turning off slow options
- function! s:BigFileOptions()
-
- " Don't do anything if the file is under the threshold
- if getfsize(expand('<afile>')) <= g:big_file_size
- return
- endif
-
- " Turn off backups, swap files, and undo files
- setlocal nobackup
- setlocal nowritebackup
- setlocal noswapfile
- if has('persistent_undo')
- setlocal noundofile
- endif
-
- " Limit the number of columns of syntax highlighting
- if exists('&synmaxcol')
- \ && &synmaxcol > g:big_file_synmaxcol
- execute 'setlocal synmaxcol=' . g:big_file_synmaxcol
- endif
-
- " Disable syntax highlighting if configured to do so
- if !g:big_file_syntax
- setlocal syntax=OFF
- endif
-
- endfunction
-
- " Define autocmd for calling to check filesize
- augroup big_file_options_bufreadpre
- autocmd!
- autocmd BufReadPre
- \ *
- \ call s:BigFileOptions()
- augroup end
+ " Disable syntax highlighting if configured to do so
+ if !g:big_file_syntax
+ setlocal syntax=OFF
+ endif
-endif
+endfunction
+
+" Define autocmd for calling to check filesize
+augroup big_file_options_bufreadpre
+ autocmd!
+ autocmd BufReadPre
+ \ *
+ \ call s:BigFileOptions()
+augroup end