From bb9c87383f8a3c6e4a49f9161df4ada14b2aec56 Mon Sep 17 00:00:00 2001
From: Martin Grenfell <martin.grenfell@gmail.com>
Date: Thu, 8 Dec 2011 20:34:11 +0000
Subject: [PATCH] rearrange and comment some functions

Move 2 functions further up syntastic.vim so that all public functions
are at the bottom - purely to be tidy.

Stick some comments on functions - most functions now have at least a
one liner explaining them.

Also, rename a variable in SyntasticHighlightErrors (since I had to look
at the log to figure out what it was).
---
 plugin/syntastic.vim | 59 ++++++++++++++++++++++++++++----------------
 1 file changed, 38 insertions(+), 21 deletions(-)

diff --git a/plugin/syntastic.vim b/plugin/syntastic.vim
index 9c43e87a..917a7ef6 100644
--- a/plugin/syntastic.vim
+++ b/plugin/syntastic.vim
@@ -253,6 +253,7 @@ function! s:ShowLocList()
     endif
 endfunction
 
+"remove all error highlights from the window
 function! s:ClearErrorHighlights()
     for i in s:ErrorHighlightIds()
         call matchdelete(i)
@@ -260,10 +261,12 @@ function! s:ClearErrorHighlights()
     let w:syntastic_error_highlight_ids = []
 endfunction
 
+"add an error highlight to the window
 function! s:HighlightError(group, pattern)
     call add(s:ErrorHighlightIds(), matchadd(a:group, a:pattern))
 endfunction
 
+"get (and/or init) the array of error highlights for the current window
 function! s:ErrorHighlightIds()
     if !exists("w:syntastic_error_highlight_ids")
         let w:syntastic_error_highlight_ids = []
@@ -271,6 +274,27 @@ function! s:ErrorHighlightIds()
     return w:syntastic_error_highlight_ids
 endfunction
 
+"check if a syntax checker exists for the given filetype - and attempt to
+"load one
+function! s:Checkable(ft)
+    if !exists("g:loaded_" . a:ft . "_syntax_checker")
+        exec "runtime syntax_checkers/" . a:ft . ".vim"
+    endif
+
+    return exists("*SyntaxCheckers_". a:ft ."_GetLocList")
+endfunction
+
+"set up error ballons for the current set of errors
+function! s:RefreshBalloons()
+    let b:syntastic_balloons = {}
+    if s:BufHasErrorsOrWarningsToDisplay() && has('balloon_eval')
+        for i in b:syntastic_loclist
+            let b:syntastic_balloons[i['lnum']] = i['text']
+        endfor
+        set beval bexpr=SyntasticErrorBalloonExpr()
+    endif
+endfunction
+
 "return a string representing the state of buffer according to
 "g:syntastic_stl_format
 "
@@ -359,28 +383,29 @@ function! SyntasticMake(options)
     return errors
 endfunction
 
-function! s:RefreshBalloons()
-    let b:syntastic_balloons = {}
-    if s:BufHasErrorsOrWarningsToDisplay() && has('balloon_eval')
-        for i in b:syntastic_loclist
-            let b:syntastic_balloons[i['lnum']] = i['text']
-        endfor
-        set beval bexpr=SyntasticErrorBalloonExpr()
-    endif
-endfunction
-
+"get the error balloon for the current mouse position
 function! SyntasticErrorBalloonExpr()
-    if !exists('b:syntastic_balloons') | return '' | endif
+    if !exists('b:syntastic_balloons')
+        return ''
+    endif
     return get(b:syntastic_balloons, v:beval_lnum, '')
 endfunction
 
+"highlight the list of errors (a:errors) using matchadd()
+"
+"a:termfunc is provided to highlight errors that do not have a 'col' key (and
+"hence cant be done automatically). This function must take one arg (an error
+"item) and return a regex to match that item in the buffer.
+"
+"an optional boolean third argument can be provided to force a:termfunc to be
+"used regardless of whether a 'col' key is present for the error
 function! SyntasticHighlightErrors(errors, termfunc, ...)
     call s:ClearErrorHighlights()
 
-    let forcecb = a:0 && a:1
+    let force_callback = a:0 && a:1
     for item in a:errors
         let group = item['type'] == 'E' ? 'SpellBad' : 'SpellCap'
-        if item['col'] && !forcecb
+        if item['col'] && !force_callback
             let lastcol = col([item['lnum'], '$'])
             let lcol = min([lastcol, item['col']])
             call s:HighlightError(group, '\%'.item['lnum'].'l\%'.lcol.'c')
@@ -393,12 +418,4 @@ function! SyntasticHighlightErrors(errors, termfunc, ...)
     endfor
 endfunction
 
-function! s:Checkable(ft)
-    if !exists("g:loaded_" . a:ft . "_syntax_checker")
-        exec "runtime syntax_checkers/" . a:ft . ".vim"
-    endif
-
-    return exists("*SyntaxCheckers_". a:ft ."_GetLocList")
-endfunction
-
 " vim: set et sts=4 sw=4: