123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792 |
- "============================================================================
- "File: syntastic.vim
- "Description: Vim plugin for on the fly syntax checking.
- "License: This program is free software. It comes without any warranty,
- " to the extent permitted by applicable law. You can redistribute
- " it and/or modify it under the terms of the Do What The Fuck You
- " Want To Public License, Version 2, as published by Sam Hocevar.
- " See http://sam.zoy.org/wtfpl/COPYING for more details.
- "
- "============================================================================
- if exists('g:loaded_syntastic_plugin') || &compatible
- finish
- endif
- let g:loaded_syntastic_plugin = 1
- if has('reltime')
- let g:_SYNTASTIC_START = reltime()
- lockvar! g:_SYNTASTIC_START
- endif
- let g:_SYNTASTIC_VERSION = '3.8.0-9'
- lockvar g:_SYNTASTIC_VERSION
- " Sanity checks {{{1
- if v:version < 700 || (v:version == 700 && !has('patch175'))
- call syntastic#log#error('need Vim version 7.0.175 or later')
- finish
- endif
- for s:feature in [
- \ 'autocmd',
- \ 'eval',
- \ 'file_in_path',
- \ 'modify_fname',
- \ 'quickfix',
- \ 'reltime',
- \ 'user_commands'
- \ ]
- if !has(s:feature)
- call syntastic#log#error('need Vim compiled with feature ' . s:feature)
- finish
- endif
- endfor
- let s:_running_windows = syntastic#util#isRunningWindows()
- lockvar s:_running_windows
- if !exists('g:syntastic_shell')
- let g:syntastic_shell = &shell
- endif
- if s:_running_windows
- let g:_SYNTASTIC_UNAME = 'Windows'
- elseif executable('uname')
- try
- let g:_SYNTASTIC_UNAME = split(syntastic#util#system('uname'), "\n")[0]
- catch /\m^Vim\%((\a\+)\)\=:E484/
- call syntastic#log#error("can't run external programs (misconfigured shell options?)")
- finish
- catch /\m^Vim\%((\a\+)\)\=:E684/
- let g:_SYNTASTIC_UNAME = 'Unknown'
- endtry
- else
- let g:_SYNTASTIC_UNAME = 'Unknown'
- endif
- lockvar g:_SYNTASTIC_UNAME
- " }}}1
- " Defaults {{{1
- let g:_SYNTASTIC_DEFAULTS = {
- \ 'aggregate_errors': 0,
- \ 'always_populate_loc_list': 0,
- \ 'auto_jump': 0,
- \ 'auto_loc_list': 2,
- \ 'check_on_open': 0,
- \ 'check_on_wq': 1,
- \ 'cursor_columns': 1,
- \ 'debug': 0,
- \ 'echo_current_error': 1,
- \ 'enable_balloons': 1,
- \ 'enable_highlighting': 1,
- \ 'enable_signs': 1,
- \ 'error_symbol': '>>',
- \ 'exit_checks': !(s:_running_windows && syntastic#util#var('shell', &shell) =~? '\m\<cmd\.exe$'),
- \ 'filetype_map': {},
- \ 'full_redraws': !(has('gui_running') || has('gui_macvim')),
- \ 'id_checkers': 1,
- \ 'ignore_extensions': '\c\v^([gx]?z|lzma|bz2)$',
- \ 'ignore_files': [],
- \ 'loc_list_height': 10,
- \ 'nested_autocommands': 0,
- \ 'quiet_messages': {},
- \ 'reuse_loc_lists': 1,
- \ 'shell': &shell,
- \ 'sort_aggregated_errors': 1,
- \ 'stl_format': '[Syntax: line:%F (%t)]',
- \ 'style_error_symbol': 'S>',
- \ 'style_warning_symbol': 'S>',
- \ 'warning_symbol': '>>'
- \ }
- lockvar! g:_SYNTASTIC_DEFAULTS
- for s:key in keys(g:_SYNTASTIC_DEFAULTS)
- if !exists('g:syntastic_' . s:key)
- let g:syntastic_{s:key} = copy(g:_SYNTASTIC_DEFAULTS[s:key])
- endif
- endfor
- if exists('g:syntastic_quiet_warnings')
- call syntastic#log#oneTimeWarn("variable g:syntastic_quiet_warnings is deprecated, please use let g:syntastic_quiet_messages = {'level': 'warnings'} instead")
- if g:syntastic_quiet_warnings
- let s:quiet_warnings = get(g:syntastic_quiet_messages, 'type', [])
- if type(s:quiet_warnings) != type([])
- let s:quiet_warnings = [s:quiet_warnings]
- endif
- call add(s:quiet_warnings, 'warnings')
- let g:syntastic_quiet_messages['type'] = s:quiet_warnings
- endif
- endif
- " }}}1
- " Debug {{{1
- let g:_SYNTASTIC_SHELL_OPTIONS = [
- \ 'shell',
- \ 'shellcmdflag',
- \ 'shellpipe',
- \ 'shellquote',
- \ 'shellredir',
- \ 'shelltemp',
- \ 'shellxquote'
- \ ]
- for s:feature in [
- \ 'autochdir',
- \ 'shellslash',
- \ 'shellxescape',
- \ ]
- if exists('+' . s:feature)
- call add(g:_SYNTASTIC_SHELL_OPTIONS, s:feature)
- endif
- endfor
- lockvar! g:_SYNTASTIC_SHELL_OPTIONS
- " debug constants
- let g:_SYNTASTIC_DEBUG_TRACE = 1
- lockvar g:_SYNTASTIC_DEBUG_TRACE
- let g:_SYNTASTIC_DEBUG_LOCLIST = 2
- lockvar g:_SYNTASTIC_DEBUG_LOCLIST
- let g:_SYNTASTIC_DEBUG_NOTIFICATIONS = 4
- lockvar g:_SYNTASTIC_DEBUG_NOTIFICATIONS
- let g:_SYNTASTIC_DEBUG_AUTOCOMMANDS = 8
- lockvar g:_SYNTASTIC_DEBUG_AUTOCOMMANDS
- let g:_SYNTASTIC_DEBUG_VARIABLES = 16
- lockvar g:_SYNTASTIC_DEBUG_VARIABLES
- let g:_SYNTASTIC_DEBUG_CHECKERS = 32
- lockvar g:_SYNTASTIC_DEBUG_CHECKERS
- " }}}1
- runtime! plugin/syntastic/*.vim
- let s:registry = g:SyntasticRegistry.Instance()
- let s:notifiers = g:SyntasticNotifiers.Instance()
- let s:modemap = g:SyntasticModeMap.Instance()
- let s:_check_stack = []
- let s:_quit_pre = []
- " Commands {{{1
- " @vimlint(EVL103, 1, a:cursorPos)
- " @vimlint(EVL103, 1, a:cmdLine)
- " @vimlint(EVL103, 1, a:argLead)
- function! s:CompleteCheckerName(argLead, cmdLine, cursorPos) abort " {{{2
- let names = []
- let sep_idx = stridx(a:argLead, '/')
- if sep_idx >= 1
- let ft = a:argLead[: sep_idx-1]
- call extend(names, map( s:registry.getNamesOfAvailableCheckers(ft), 'ft . "/" . v:val' ))
- else
- for ft in s:registry.resolveFiletypes(&filetype)
- call extend(names, s:registry.getNamesOfAvailableCheckers(ft))
- endfor
- call extend(names, map( copy(s:registry.getKnownFiletypes()), 'v:val . "/"' ))
- endif
- return join(names, "\n")
- endfunction " }}}2
- " @vimlint(EVL103, 0, a:cursorPos)
- " @vimlint(EVL103, 0, a:cmdLine)
- " @vimlint(EVL103, 0, a:argLead)
- " @vimlint(EVL103, 1, a:cursorPos)
- " @vimlint(EVL103, 1, a:cmdLine)
- " @vimlint(EVL103, 1, a:argLead)
- function! s:CompleteFiletypes(argLead, cmdLine, cursorPos) abort " {{{2
- return join(s:registry.getKnownFiletypes(), "\n")
- endfunction " }}}2
- " @vimlint(EVL103, 0, a:cursorPos)
- " @vimlint(EVL103, 0, a:cmdLine)
- " @vimlint(EVL103, 0, a:argLead)
- command! -bar -nargs=* -complete=custom,s:CompleteCheckerName SyntasticCheck call SyntasticCheck(<f-args>)
- command! -bar -nargs=? -complete=custom,s:CompleteFiletypes SyntasticInfo call SyntasticInfo(<f-args>)
- command! -bar Errors call SyntasticErrors()
- command! -bar SyntasticReset call SyntasticReset()
- command! -bar SyntasticToggleMode call SyntasticToggleMode()
- command! -bar SyntasticSetLoclist call SyntasticSetLoclist()
- command! SyntasticJavacEditClasspath runtime! syntax_checkers/java/*.vim | SyntasticJavacEditClasspath
- command! SyntasticJavacEditConfig runtime! syntax_checkers/java/*.vim | SyntasticJavacEditConfig
- " }}}1
- " Public API {{{1
- function! SyntasticCheck(...) abort " {{{2
- call s:UpdateErrors(bufnr(''), 0, a:000)
- call syntastic#util#redraw(g:syntastic_full_redraws)
- endfunction " }}}2
- function! SyntasticInfo(...) abort " {{{2
- call s:modemap.modeInfo(a:000)
- call s:registry.echoInfoFor(a:000)
- call s:_explain_skip(a:000)
- call syntastic#log#debugShowOptions(g:_SYNTASTIC_DEBUG_TRACE, g:_SYNTASTIC_SHELL_OPTIONS)
- call syntastic#log#debugDump(g:_SYNTASTIC_DEBUG_VARIABLES)
- endfunction " }}}2
- function! SyntasticErrors() abort " {{{2
- call g:SyntasticLoclist.current().show()
- endfunction " }}}2
- function! SyntasticReset() abort " {{{2
- call s:ClearCache(bufnr(''))
- call s:notifiers.refresh(g:SyntasticLoclist.New([]))
- endfunction " }}}2
- function! SyntasticToggleMode() abort " {{{2
- call s:modemap.toggleMode()
- call s:ClearCache(bufnr(''))
- call s:notifiers.refresh(g:SyntasticLoclist.New([]))
- call s:modemap.echoMode()
- endfunction " }}}2
- function! SyntasticSetLoclist() abort " {{{2
- call g:SyntasticLoclist.current().setloclist(0)
- endfunction " }}}2
- " }}}1
- " Autocommands {{{1
- augroup syntastic
- autocmd!
- autocmd VimEnter * call s:VimEnterHook()
- autocmd BufEnter * call s:BufEnterHook(expand('<afile>', 1))
- autocmd BufWinEnter * call s:BufWinEnterHook(expand('<afile>', 1))
- augroup END
- if g:syntastic_nested_autocommands
- augroup syntastic
- autocmd BufReadPost * nested call s:BufReadPostHook(expand('<afile>', 1))
- autocmd BufWritePost * nested call s:BufWritePostHook(expand('<afile>', 1))
- augroup END
- else
- augroup syntastic
- autocmd BufReadPost * call s:BufReadPostHook(expand('<afile>', 1))
- autocmd BufWritePost * call s:BufWritePostHook(expand('<afile>', 1))
- augroup END
- endif
- if exists('##QuitPre')
- " QuitPre was added in Vim 7.3.544
- augroup syntastic
- autocmd QuitPre * call s:QuitPreHook(expand('<afile>', 1))
- augroup END
- endif
- function! s:BufReadPostHook(fname) abort " {{{2
- let buf = syntastic#util#fname2buf(a:fname)
- if g:syntastic_check_on_open && buf > 0
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_AUTOCOMMANDS,
- \ 'autocmd: BufReadPost, buffer ' . buf . ' = ' . string(a:fname))
- if index(s:_check_stack, buf) == -1
- call add(s:_check_stack, buf)
- endif
- endif
- endfunction " }}}2
- function! s:BufWritePostHook(fname) abort " {{{2
- let buf = syntastic#util#fname2buf(a:fname)
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_AUTOCOMMANDS,
- \ 'autocmd: BufWritePost, buffer ' . buf . ' = ' . string(a:fname))
- call s:UpdateErrors(buf, 1, [])
- endfunction " }}}2
- function! s:BufEnterHook(fname) abort " {{{2
- let buf = syntastic#util#fname2buf(a:fname)
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_AUTOCOMMANDS,
- \ 'autocmd: BufEnter, buffer ' . buf . ' = ' . string(a:fname) . ', &buftype = ' . string(&buftype))
- if buf > 0 && getbufvar(buf, '&buftype') ==# ''
- let idx = index(reverse(copy(s:_check_stack)), buf)
- if idx >= 0
- if !has('vim_starting')
- call remove(s:_check_stack, -idx - 1)
- call s:UpdateErrors(buf, 1, [])
- endif
- elseif &buftype ==# ''
- call s:notifiers.refresh(g:SyntasticLoclist.current())
- endif
- elseif &buftype ==# 'quickfix'
- " TODO: this is needed because in recent versions of Vim lclose
- " can no longer be called from BufWinLeave
- " TODO: at this point there is no b:syntastic_loclist
- let loclist = filter(copy(getloclist(0)), 'v:val["valid"]')
- let owner = str2nr(getbufvar(buf, 'syntastic_owner_buffer'))
- let buffers = syntastic#util#unique(map(loclist, 'v:val["bufnr"]') + (owner ? [owner] : []))
- if !empty(get(w:, 'syntastic_loclist_set', [])) && !empty(loclist) && empty(filter( buffers, 'syntastic#util#bufIsActive(v:val)' ))
- call SyntasticLoclistHide()
- endif
- endif
- endfunction " }}}2
- function! s:BufWinEnterHook(fname) abort " {{{2
- let buf = syntastic#util#fname2buf(a:fname)
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_AUTOCOMMANDS,
- \ 'autocmd: BufWinEnter, buffer ' . buf . ' = ' . string(a:fname) . ', &buftype = ' . string(&buftype))
- if buf > 0 && getbufvar(buf, '&buftype') ==# ''
- let idx = index(reverse(copy(s:_check_stack)), buf)
- if idx >= 0 && !has('vim_starting')
- call remove(s:_check_stack, -idx - 1)
- call s:UpdateErrors(buf, 1, [])
- endif
- endif
- endfunction " }}}2
- function! s:VimEnterHook() abort " {{{2
- let g:syntastic_version =
- \ g:_SYNTASTIC_VERSION .
- \ ' (Vim ' . v:version . (has('nvim') ? ', Neovim' : '') . ', ' .
- \ g:_SYNTASTIC_UNAME .
- \ (has('gui') ? ', GUI' : '') . ')'
- lockvar g:syntastic_version
- let buf = bufnr('')
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_AUTOCOMMANDS,
- \ 'autocmd: VimEnter, buffer ' . buf . ' = ' . string(bufname(buf)) . ', &buftype = ' . string(&buftype))
- let idx = index(reverse(copy(s:_check_stack)), buf)
- if idx >= 0 && getbufvar(buf, '&buftype') ==# ''
- call remove(s:_check_stack, -idx - 1)
- call s:UpdateErrors(buf, 1, [])
- endif
- endfunction " }}}2
- function! s:QuitPreHook(fname) abort " {{{2
- let buf = syntastic#util#fname2buf(a:fname)
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_AUTOCOMMANDS, 'autocmd: QuitPre, buffer ' . buf . ' = ' . string(a:fname))
- if !syntastic#util#var('check_on_wq')
- call syntastic#util#setWids()
- call add(s:_quit_pre, buf . '_' . getbufvar(buf, 'changetick') . '_' . w:syntastic_wid)
- endif
- if !empty(get(w:, 'syntastic_loclist_set', []))
- call SyntasticLoclistHide()
- endif
- endfunction " }}}2
- " }}}1
- " Main {{{1
- "refresh and redraw all the error info for this buf when saving or reading
- function! s:UpdateErrors(buf, auto_invoked, checker_names) abort " {{{2
- call syntastic#log#debugShowVariables(g:_SYNTASTIC_DEBUG_TRACE, 'version')
- call syntastic#log#debugShowOptions(g:_SYNTASTIC_DEBUG_TRACE, g:_SYNTASTIC_SHELL_OPTIONS)
- call syntastic#log#debugDump(g:_SYNTASTIC_DEBUG_VARIABLES)
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_TRACE, 'UpdateErrors' . (a:auto_invoked ? ' (auto)' : '') .
- \ ': ' . (len(a:checker_names) ? join(a:checker_names) : 'default checkers'))
- call s:modemap.synch()
- if s:_skip_file(a:buf)
- return
- endif
- let run_checks = !a:auto_invoked || s:modemap.doAutoChecking(a:buf)
- if run_checks
- call s:CacheErrors(a:buf, a:checker_names)
- call syntastic#util#setLastTick(a:buf)
- elseif a:auto_invoked
- return
- endif
- let loclist = g:SyntasticLoclist.current(a:buf)
- if exists('*SyntasticCheckHook')
- call SyntasticCheckHook(loclist.getRaw())
- endif
- " populate loclist and jump {{{3
- let do_jump = syntastic#util#var('auto_jump') + 0
- if do_jump == 2
- let do_jump = loclist.getFirstError(1)
- elseif do_jump == 3
- let do_jump = loclist.getFirstError()
- elseif 0 > do_jump || do_jump > 3
- let do_jump = 0
- endif
- if syntastic#util#var('always_populate_loc_list') || do_jump
- call loclist.setloclist(1)
- if run_checks && do_jump && !loclist.isEmpty()
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_NOTIFICATIONS, 'loclist: jump')
- execute 'silent! lrewind ' . do_jump
- " XXX: Vim doesn't call autocmd commands in a predictible
- " order, which can lead to missing filetype when jumping
- " to a new file; the following is a workaround for the
- " resulting brain damage
- if &filetype ==# ''
- silent! filetype detect
- endif
- endif
- endif
- " }}}3
- call s:notifiers.refresh(loclist)
- endfunction " }}}2
- "clear the loc list for the buffer
- function! s:ClearCache(buf) abort " {{{2
- let loclist = g:SyntasticLoclist.current(a:buf)
- call s:notifiers.reset(loclist)
- call loclist.destroy()
- endfunction " }}}2
- "detect and cache all syntax errors in this buffer
- function! s:CacheErrors(buf, checker_names) abort " {{{2
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_TRACE, 'CacheErrors: ' .
- \ (len(a:checker_names) ? join(a:checker_names) : 'default checkers'))
- call s:ClearCache(a:buf)
- let newLoclist = g:SyntasticLoclist.New([])
- call newLoclist.setOwner(a:buf)
- if !s:_skip_file(a:buf)
- " debug logging {{{3
- call syntastic#log#debugShowVariables(g:_SYNTASTIC_DEBUG_TRACE, 'aggregate_errors')
- if syntastic#util#isRunningWindows()
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_CHECKERS, '$TMP = ' . string($TMP) . ', $TEMP = ' . string($TEMP))
- else
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_CHECKERS, '$TERM = ' . string($TERM))
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_CHECKERS, '$TMPDIR = ' . string($TMPDIR))
- endif
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_CHECKERS, '$PATH = ' . string($PATH))
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_TRACE, 'getcwd() = ' . string(getcwd()))
- " }}}3
- let clist = s:registry.getCheckers(getbufvar(a:buf, '&filetype'), a:checker_names)
- let aggregate_errors =
- \ syntastic#util#var('aggregate_errors') || len(syntastic#util#unique(map(copy(clist), 'v:val.getFiletype()'))) > 1
- let decorate_errors = aggregate_errors && syntastic#util#var('id_checkers')
- let sort_aggregated_errors = aggregate_errors && syntastic#util#var('sort_aggregated_errors')
- let names = []
- let unavailable_checkers = 0
- for checker in clist
- let cname = checker.getCName()
- if !checker.isAvailable()
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_TRACE, 'CacheErrors: Checker ' . cname . ' is not available')
- let unavailable_checkers += 1
- continue
- endif
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_TRACE, 'CacheErrors: Invoking checker: ' . cname)
- let loclist = checker.getLocList()
- if !loclist.isEmpty()
- if decorate_errors
- call loclist.decorate(cname)
- endif
- call add(names, cname)
- if checker.wantSort() && !sort_aggregated_errors
- call loclist.sort()
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_LOCLIST, 'sorted:', loclist)
- endif
- call newLoclist.extend(loclist)
- if !aggregate_errors
- break
- endif
- endif
- endfor
- " set names {{{3
- if !empty(names)
- if len(syntastic#util#unique(map( copy(names), 'substitute(v:val, "\\m/.*", "", "")' ))) == 1
- let type = substitute(names[0], '\m/.*', '', '')
- let name = join(map( names, 'substitute(v:val, "\\m.\\{-}/", "", "")' ), ', ')
- call newLoclist.setName( name . ' ('. type . ')' )
- else
- " checkers from mixed types
- call newLoclist.setName(join(names, ', '))
- endif
- endif
- " }}}3
- " issue warning about no active checkers {{{3
- if len(clist) == unavailable_checkers
- if !empty(a:checker_names)
- if len(a:checker_names) == 1
- call syntastic#log#warn('checker ' . a:checker_names[0] . ' is not available')
- else
- call syntastic#log#warn('checkers ' . join(a:checker_names, ', ') . ' are not available')
- endif
- else
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_TRACE, 'CacheErrors: no checkers available for ' . &filetype)
- endif
- endif
- " }}}3
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_LOCLIST, 'aggregated:', newLoclist)
- if sort_aggregated_errors
- call newLoclist.sort()
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_LOCLIST, 'sorted:', newLoclist)
- endif
- endif
- call newLoclist.deploy()
- endfunction " }}}2
- "Emulates the :lmake command. Sets up the make environment according to the
- "options given, runs make, resets the environment, returns the location list
- "
- "a:options can contain the following keys:
- " 'makeprg'
- " 'errorformat'
- "
- "The corresponding options are set for the duration of the function call. They
- "are set with :let, so dont escape spaces.
- "
- "a:options may also contain:
- " 'defaults' - a dict containing default values for the returned errors
- " 'subtype' - all errors will be assigned the given subtype
- " 'preprocess' - a function to be applied to the error file before parsing errors
- " 'postprocess' - a list of functions to be applied to the error list
- " 'cwd' - change directory to the given path before running the checker
- " 'env' - environment variables to set before running the checker
- " 'returns' - a list of valid exit codes for the checker
- " @vimlint(EVL102, 1, l:env_save)
- function! SyntasticMake(options) abort " {{{2
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_TRACE, 'SyntasticMake: called with options:', a:options)
- " save options and locale env variables {{{3
- let old_local_errorformat = &l:errorformat
- let old_errorformat = &errorformat
- let old_cwd = getcwd()
- " }}}3
- if has_key(a:options, 'errorformat')
- let &errorformat = a:options['errorformat']
- set errorformat<
- endif
- if has_key(a:options, 'cwd')
- execute 'lcd ' . fnameescape(a:options['cwd'])
- endif
- " set environment variables {{{3
- let env_save = {}
- if has_key(a:options, 'env') && len(a:options['env'])
- for key in keys(a:options['env'])
- if key =~? '\m^[a-z_][a-z0-9_]*$'
- execute 'let env_save[' . string(key) . '] = $' . key
- execute 'let $' . key . ' = ' . string(a:options['env'][key])
- endif
- endfor
- endif
- " }}}3
- let err_lines = split(syntastic#util#system(a:options['makeprg']), "\n", 1)
- " restore environment variables {{{3
- if len(env_save)
- for key in keys(env_save)
- execute 'let $' . key . ' = ' . string(env_save[key])
- endfor
- endif
- " }}}3
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_LOCLIST, 'checker output:', err_lines)
- " Does it still make sense to go on?
- let bailout =
- \ syntastic#util#var('exit_checks') &&
- \ has_key(a:options, 'returns') &&
- \ index(a:options['returns'], v:shell_error) == -1
- if !bailout
- if has_key(a:options, 'Preprocess')
- let err_lines = call(a:options['Preprocess'], [err_lines])
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_LOCLIST, 'preprocess (external):', err_lines)
- elseif has_key(a:options, 'preprocess')
- let err_lines = call('syntastic#preprocess#' . a:options['preprocess'], [err_lines])
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_LOCLIST, 'preprocess:', err_lines)
- endif
- noautocmd lgetexpr err_lines
- let errors = deepcopy(getloclist(0))
- if has_key(a:options, 'cwd')
- execute 'lcd ' . fnameescape(old_cwd)
- endif
- try
- silent lolder
- catch /\m^Vim\%((\a\+)\)\=:E380/
- " E380: At bottom of quickfix stack
- call setloclist(0, [], 'r')
- try
- " Vim 7.4.2200 or later
- call setloclist(0, [], 'r', { 'title': '' })
- catch /\m^Vim\%((\a\+)\)\=:E\%(118\|731\)/
- " do nothing
- endtry
- catch /\m^Vim\%((\a\+)\)\=:E776/
- " E776: No location list
- " do nothing
- endtry
- else
- let errors = []
- endif
- " restore options {{{3
- let &errorformat = old_errorformat
- let &l:errorformat = old_local_errorformat
- " }}}3
- if !s:_running_windows && (s:_os_name() =~? 'FreeBSD' || s:_os_name() =~? 'OpenBSD')
- call syntastic#util#redraw(g:syntastic_full_redraws)
- endif
- if bailout
- call syntastic#log#ndebug(g:_SYNTASTIC_DEBUG_LOCLIST, 'checker output:', err_lines)
- throw 'Syntastic: checker error'
- endif
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_LOCLIST, 'raw loclist:', errors)
- if has_key(a:options, 'defaults')
- call s:_add_to_errors(errors, a:options['defaults'])
- endif
- " Add subtype info if present.
- if has_key(a:options, 'subtype')
- call s:_add_to_errors(errors, { 'subtype': a:options['subtype'] })
- endif
- if has_key(a:options, 'Postprocess') && !empty(a:options['Postprocess'])
- for rule in a:options['Postprocess']
- let errors = call(rule, [errors])
- endfor
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_LOCLIST, 'postprocess (external):', errors)
- elseif has_key(a:options, 'postprocess') && !empty(a:options['postprocess'])
- for rule in a:options['postprocess']
- let errors = call('syntastic#postprocess#' . rule, [errors])
- endfor
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_LOCLIST, 'postprocess:', errors)
- endif
- return errors
- endfunction " }}}2
- " @vimlint(EVL102, 0, l:env_save)
- "return a string representing the state of buffer according to
- "g:syntastic_stl_format
- "
- "return '' if no errors are cached for the buffer
- function! SyntasticStatuslineFlag() abort " {{{2
- return g:SyntasticLoclist.current().getStatuslineFlag()
- endfunction " }}}2
- " }}}1
- " Utilities {{{1
- function! s:_ignore_file(filename) abort " {{{2
- let fname = fnamemodify(a:filename, ':p')
- for pattern in g:syntastic_ignore_files
- if fname =~# pattern
- return 1
- endif
- endfor
- return 0
- endfunction " }}}2
- function! s:_is_quitting(buf) abort " {{{2
- let quitting = 0
- if exists('w:syntastic_wid')
- let key = a:buf . '_' . getbufvar(a:buf, 'changetick') . '_' . w:syntastic_wid
- let idx = index(s:_quit_pre, key)
- if idx >= 0
- call remove(s:_quit_pre, idx)
- let quitting = 1
- endif
- endif
- return quitting
- endfunction " }}}2
- " Skip running in special buffers
- function! s:_skip_file(buf) abort " {{{2
- let fname = bufname(a:buf)
- let skip = s:_is_quitting(a:buf) || getbufvar(a:buf, 'syntastic_skip_checks') ||
- \ (getbufvar(a:buf, '&buftype') !=# '') || !filereadable(fname) || getwinvar(0, '&diff') ||
- \ getwinvar(0, '&previewwindow') || s:_ignore_file(fname) ||
- \ fnamemodify(fname, ':e') =~? g:syntastic_ignore_extensions
- if skip
- call syntastic#log#debug(g:_SYNTASTIC_DEBUG_TRACE, '_skip_file: skipping checks')
- endif
- return skip
- endfunction " }}}2
- " Explain why checks will be skipped for the current file
- function! s:_explain_skip(filetypes) abort " {{{2
- let buf = bufnr('')
- if empty(a:filetypes) && s:_skip_file(buf)
- let why = []
- let fname = bufname(buf)
- let bt = getbufvar(buf, '&buftype')
- if s:_is_quitting(buf)
- call add(why, 'quitting buffer')
- endif
- if getbufvar(buf, 'syntastic_skip_checks')
- call add(why, 'b:syntastic_skip_checks set')
- endif
- if bt !=# ''
- call add(why, 'buftype = ' . string(&buftype))
- endif
- if !filereadable(fname)
- call add(why, 'file not readable / not local')
- endif
- if getwinvar(0, '&diff')
- call add(why, 'diff mode')
- endif
- if getwinvar(0, '&previewwindow')
- call add(why, 'preview window')
- endif
- if s:_ignore_file(fname)
- call add(why, 'filename matching g:syntastic_ignore_files')
- endif
- if fnamemodify(fname, ':e') =~? g:syntastic_ignore_extensions
- call add(why, 'extension matching g:syntastic_ignore_extensions')
- endif
- echomsg 'The current file will not be checked (' . join(why, ', ') . ')'
- endif
- endfunction " }}}2
- " Take a list of errors and add default values to them from a:options
- function! s:_add_to_errors(errors, options) abort " {{{2
- for err in a:errors
- for key in keys(a:options)
- if !has_key(err, key) || empty(err[key])
- let err[key] = a:options[key]
- endif
- endfor
- endfor
- return a:errors
- endfunction " }}}2
- function! s:_os_name() abort " {{{2
- return g:_SYNTASTIC_UNAME
- endfunction " }}}2
- " }}}1
- " vim: set sw=4 sts=4 et fdm=marker:
|