[WIP] Adds error message feature

[etc/vim.git] / autoload / flake8.vim

diff --git a/autoload/flake8.vim b/autoload/flake8.vim
index a958ec5d73acf9fd7c4a3d324898a0ad81e432e3..157a717c8c2ef3b4f8f3c0ff83f1c0c7d8bda9d1 100644 (file)
--- a/autoload/flake8.vim
+++ b/autoload/flake8.vim
@@ -20,6 +20,10 @@ function! flake8#Flake8UnplaceMarkers()
     call s:Warnings()
 endfunction
 
+function! flake8#ShowErrorMessage()
+    call s:ShowErrorMessage()
+endfunction
+
 "" }}}
 
 "" ** internal ** {{{
@@ -27,11 +31,11 @@ endfunction
 "" warnings 
 
 let s:displayed_warnings = 0
-function s:Warnings()
+function! s:Warnings()
   if !s:displayed_warnings
     let l:show_website_url = 0
 
-    let l:msg = "has been depreciated in favour of flake8 config files"
+    let l:msg = "has been deprecated in favour of flake8 config files"
     for setting_name in ['g:flake8_ignore', 'g:flake8_builtins', 'g:flake8_max_line_length', 'g:flake8_max_complexity']
       if exists(setting_name)
         echohl WarningMsg | echom setting_name l:msg | echohl None
@@ -73,33 +77,37 @@ function! s:Setup()  " {{{
     call s:DeclareOption('flake8_cmd', '', '"flake8"')
     " quickfix
     call s:DeclareOption('flake8_quickfix_location', '', '"belowright"')
-    call s:DeclareOption('flake8_show_quickfix',     '', 1)
+    call s:DeclareOption('flake8_quickfix_height', '', 5)
+    call s:DeclareOption('flake8_show_quickfix', '', 1)
     " markers to show
     call s:DeclareOption('flake8_show_in_gutter', '',   0)
-    call s:DeclareOption('flake8_show_in_file',   '',   0)
-    call s:DeclareOption('flake8_max_markers',    '', 500)
+    call s:DeclareOption('flake8_show_in_file', '',   0)
+    call s:DeclareOption('flake8_max_markers', '', 500)
     " marker signs
-    call s:DeclareOption('flake8_error_marker',      '', '"E>"')
-    call s:DeclareOption('flake8_warning_marker',    '', '"W>"')
-    call s:DeclareOption('flake8_pyflake_marker',    '', '"F>"')
+    call s:DeclareOption('flake8_error_marker', '', '"E>"')
+    call s:DeclareOption('flake8_warning_marker', '', '"W>"')
+    call s:DeclareOption('flake8_pyflake_marker', '', '"F>"')
     call s:DeclareOption('flake8_complexity_marker', '', '"C>"')
-    call s:DeclareOption('flake8_naming_marker',     '', '"N>"')
+    call s:DeclareOption('flake8_naming_marker', '', '"N>"')
 
     "" setup markerdata
 
     if !exists('s:markerdata')
         let s:markerdata = {}
-        let s:markerdata['E'] = { 'name': 'Flake8_Error'      }
-        let s:markerdata['W'] = { 'name': 'Flake8_Warning'    }
-        let s:markerdata['F'] = { 'name': 'Flake8_PyFlake'    }
-        let s:markerdata['C'] = { 'name': 'Flake8_Complexity' }
-        let s:markerdata['N'] = { 'name': 'Flake8_Nameing'    }
+        let s:markerdata['E'] = {'name': 'Flake8_Error'}
+        let s:markerdata['W'] = {'name': 'Flake8_Warning'}
+        let s:markerdata['F'] = {'name': 'Flake8_PyFlake'}
+        let s:markerdata['C'] = {'name': 'Flake8_Complexity'}
+        let s:markerdata['N'] = {'name': 'Flake8_Nameing'}
     endif
     let s:markerdata['E'].marker = s:flake8_error_marker
     let s:markerdata['W'].marker = s:flake8_warning_marker
     let s:markerdata['F'].marker = s:flake8_pyflake_marker
     let s:markerdata['C'].marker = s:flake8_complexity_marker
     let s:markerdata['N'].marker = s:flake8_naming_marker
+
+
+
 endfunction  " }}}
 
 "" do flake8
@@ -108,8 +116,10 @@ function! s:Flake8()  " {{{
     " read config
     call s:Setup()
 
-    if !executable(s:flake8_cmd)
-        echoerr "File " . s:flake8_cmd . " not found. Please install it first."
+    let l:executable = split(s:flake8_cmd)[0]
+
+    if !executable(l:executable)
+        echoerr "File " . l:executable . " not found. Please install it first."
         return
     endif
 
@@ -122,6 +132,8 @@ function! s:Flake8()  " {{{
     let l:old_gfm=&grepformat
     let l:old_gp=&grepprg
     let l:old_shellpipe=&shellpipe
+    let l:old_t_ti=&t_ti
+    let l:old_t_te=&t_te
 
     " write any changes before continuing
     if &readonly == 0
@@ -129,25 +141,38 @@ function! s:Flake8()  " {{{
     endif
 
     set lazyredraw   " delay redrawing
-    cclose           " close any existing cwindows
 
-    " set shellpipe to > instead of tee (suppressing output)
+    " prevent terminal from blinking
     set shellpipe=>
+    set t_ti=
+    set t_te=
 
     " perform the grep itself
     let &grepformat="%f:%l:%c: %m\,%f:%l: %m"
     let &grepprg=s:flake8_cmd
     silent! grep! "%"
+    " close any existing cwindows,
+    " placed after 'grep' in case quickfix is open on autocmd QuickFixCmdPost
+    cclose
 
     " restore grep settings
     let &grepformat=l:old_gfm
     let &grepprg=l:old_gp
     let &shellpipe=l:old_shellpipe
+    let &t_ti=l:old_t_ti
+    let &t_te=l:old_t_te
+    " store mapping of line number to error string
 
     " process results
+    let s:resultDict = {} 
+
     let l:results=getqflist()
     let l:has_results=results != []
     if l:has_results
+       " save line number of each error message        
+        for result in a:results:
+            s:resultDict[result.lnum] = result.text
+
         " markers
         if !s:flake8_show_in_gutter == 0 || !s:flake8_show_in_file == 0
             call s:PlaceMarkers(l:results)
@@ -155,7 +180,7 @@ function! s:Flake8()  " {{{
         " quickfix
         if !s:flake8_show_quickfix == 0
             " open cwindow
-            execute s:flake8_quickfix_location." copen"
+            execute s:flake8_quickfix_location." copen".s:flake8_quickfix_height
             setlocal wrap
             nnoremap <buffer> <silent> c :cclose<CR>
             nnoremap <buffer> <silent> q :cclose<CR>
@@ -174,7 +199,6 @@ function! s:Flake8()  " {{{
 endfunction  " }}}
 
 "" markers
-
 function! s:PlaceMarkers(results)  " {{{
     " in gutter?
     if !s:flake8_show_in_gutter == 0
@@ -242,6 +266,29 @@ function! s:UnplaceMarkers()  " {{{
     endfor
 endfunction  " }}}
 
+function! s:ShowErrorMessage()  " {{{
+    let l:cursorPos = getpos(".")
+    if !exists('s:resultDict')
+       return
+    endif
+
+    " if there is a message on the current line,
+    " then echo it 
+    if has_key(s:matchDict, s:cursorPos[1])
+       let l:errorText = get(s:matchDict, l:cursorPos[1]) 
+       echo strpart(l:errorText, 0, &columns-1)
+       let b:showing_message = 1
+    endif
+
+    " if a message is already being shown,
+    " then clear it
+    if !b:showing_message == 0
+       echo
+       let b:showing_message = 0
+    endif
+
+endfunction  " }}}
+
 "" }}}
 
 let &cpo = s:save_cpo