display search results statistics in the command line

Author: gabesoft

autoload/ags.vim

@@ -72,6 +72,7 @@ function! s:show(lines, ...)
 
     call ags#buf#openViewResultsBuffer()
     call s:execw(obj)
+    call s:printStats(0, 0, 1)
 endfunction
 
 " Prepares the search {data} for display
@@ -101,6 +102,35 @@ function! s:processSearchData(data)
     return results
 endfunction
 
+" Gathers statistics about the search results from {lines}
+"
+function! s:gatherStatistics(lines)
+    if len(a:lines) > g:ags_stats_max_ln | return {} | endif
+
+    let stats       = {}
+    let resultPat   = s:pat('^:lineStart:\s\{}\d\{1,}\s\{}:lineColEnd:')
+    let filePat     = s:pat('^:file:$')
+    let resultCount = 0
+    let fileCount   = 0
+    let index       = 0
+    let llines      = len(a:lines)
+
+    while index < llines
+        let line = a:lines[index]
+
+        if line =~ filePat
+            let fileCount = fileCount + 1
+        elseif line =~ resultPat
+            let resultCount = resultCount + 1
+        endif
+
+        let index = index + 1
+        let stats[index] = { 'file': fileCount, 'result': resultCount }
+    endw
+
+    return { 'data': stats, 'files': fileCount, 'results': resultCount }
+endfunction
+
 " Returns the cursor position when opening a file
 " from the {lineNo} in the search results window
 "
@@ -125,6 +155,41 @@ function! s:resultPosition(lineNo)
     return [0, row, col, 0]
 endfunction
 
+" Prints search results statistics
+"
+" {r} - print result info
+" {f} - print file info
+" {t} - print totals info
+function! s:printStats(r, f, t)
+    if empty(s:stats) | return | endif
+
+    let result = s:stats.data[line('.')].result
+    let file = s:stats.data[line('.')].file
+    let resultMsg = 'Result ' . result . '/' . s:stats.results . ' '
+    let fileMsg = 'File ' . file . '/' . s:stats.files
+
+    if a:r
+        echohl None
+        redraw | echon resultMsg
+    endif
+
+    if !a:r
+        redraw
+    endif
+
+    if a:f
+        echohl MoreMsg
+        echon fileMsg
+    endif
+
+    if a:t
+        echohl Underlined
+        redraw | echom s:stats.results . ' results found in ' . s:stats.files . ' files'
+    endif
+
+    echohl None
+endfunction
+
 " Performs a search with the specified {args} and according to {cmd}.
 "
 " {cmd|add}  the new results will be added to previous results in the search window
@@ -144,7 +209,8 @@ function! ags#search(args, cmd)
         let data  = ags#run#ag(args)
     endif
 
-    let lines = s:processSearchData(data)
+    let lines   = s:processSearchData(data)
+    let s:stats = s:gatherStatistics(lines)
     if empty(lines)
         call ags#log#warn("No matches for " . string(a:args))
     elseif len(lines) == 1
@@ -291,6 +357,7 @@ function! ags#navigateResults(...)
     call setpos('.', pos)
 
     let s:hlpos = pos
+    call s:printStats(1, 1, 0)
 endfunction
 
 " Navigates the search results file paths
@@ -302,6 +369,7 @@ function! ags#navigateResultsFiles(...)
     let file = s:pat(':file:')
     call search(file, flags)
     exec 'normal zt'
+    call s:printStats(0, 1, 0)
 endfunction
 
 function! ags#quit()

autoload/ags/log.vim

@@ -6,19 +6,58 @@ function! s:log(message, hl)
     echohl None
 endfunction
 
+" Writes a {message} highlighted with {hl}
+"
+function! s:write(message, hl)
+    exec 'echohl ' . a:hl
+    redraw | echo a:message
+    echohl None
+endfunction
+
 " Logs an error with {message}
 "
 function! ags#log#error(message)
     call s:log(a:message, 'Error')
 endfunction
 
-" Log an info {message}
+" Logs an info {message}
 "
 function! ags#log#info(message)
     call s:log(a:message, 'MoreMsg')
 endfunction
 
-" Log a warning {message}
+" Logs a warning {message}
+"
 function! ags#log#warn(message)
     call s:log(a:message, 'WarningMsg')
 endfunction
+
+" Logs a plain {message}
+"
+function! ags#log#plain(message)
+    call s:log(a:message, 'None')
+endfunction
+
+" Writes an error with {message}
+"
+function! ags#log#errorw(message)
+    call s:write(a:message, 'Error')
+endfunction
+
+" Writes an info {message}
+"
+function! ags#log#infow(message)
+    call s:write(a:message, 'MoreMsg')
+endfunction
+
+" Writes a warning {message}
+"
+function! ags#log#warnw(message)
+    call s:write(a:message, 'WarningMsg')
+endfunction
+
+" Writes a plain {message}
+"
+function! ags#log#plainw(message)
+    call s:write(a:message, 'None')
+endfunction

autoload/ags/run.vim

@@ -30,7 +30,7 @@ function! s:cmd(args)
 
         if value =~ '^g:'
             let value = substitute(value, '^g:', '', '')
-            let value = has_key(g:, value) ? g:[value] : arg[2]
+            let value = get(g:, value, 0)
         endif
 
         let op   = strlen(value) == 0 ? '' : '='

doc/ags.txt

@@ -50,6 +50,8 @@ OPTIONS                                         *ags-options*
 |ags_agexe|......................The ag executable path
 |ags_agmaxcount|.................The --max-count ag param
 |ags_agcontext|..................The --context ag param
+|ags_stats_max_ln|...............The maximum number of lines
+                               before disabling statistics
 |ags_agargs|.....................The predefined ag args
 |ags_edit_show_line_numbers|.....Show line numbers in edit mode
 |ags_edit_skip_if_file_changed|..In edit mode skip write of any
@@ -58,30 +60,39 @@ OPTIONS                                         *ags-options*
 -------------------------------------------------------------
 Detailed options:~
 
-                                                  *ags_agexe*
+                                                    *ags_agexe*
 This is the ag executable path >
     let g:ags_agexe = 'ag'
 <
 
-                                             *ags_agmaxcount*
+                                               *ags_agmaxcount*
 This is the max-count parameter to be passed to ag >
     let g:ags_agmaxcount = 2000
 <
 
-                                              *ags_agcontext*
+                                                *ags_agcontext*
 This is the context parameter to be passed to ag >
     let g:ags_agcontext = 3
 <
 
-                                 *ags_edit_show_line_numbers*
+                                             *ags_stats_max_ln*
+This is the maximum number of lines before disabling the
+statistics info that shows when navigating results in the
+search results window. When the number of lines returned by
+ag is larger than the value of this variable the statistics
+are disabled to improve performance.
+    let g:ags_stats_max_ln = 5000
+<
+
+                                   *ags_edit_show_line_numbers*
 This enables showing file line numbers in edit mode as visual
 cues. The file numbers as well as file paths in edit mode are
 not meant to be edited and could result in unwanted changes if
-removed
+removed.
     let g:ags_edit_show_line_numbers = 0
 <
 
-                              *ags_edit_skip_if_file_changed*
+                                *ags_edit_skip_if_file_changed*
 When writing files from edit mode this allows to skip writing
 lines that have changed from outside vim. This could have
 mixed results as some lines will be changed and others not.
@@ -90,7 +101,7 @@ file lines exactly as they appear in the file.
     let g:ags_edit_skip_if_file_changed = 0
 <
 
-                                           *ags_agargs*
+                                                   *ags_agargs*
 This variable contains the predefined search arguments
 used to ensure that the search results are highlighted
 properly in Vim. Any of these arguments can be overwritten

plugin/ags.vim

@@ -2,33 +2,28 @@ if exists('g:ags_loaded') || &cp || v:version < 700 | finish | endif
 
 let g:ags_loaded = 1
 
-if !exists('g:ags_agexe')      | let g:ags_agexe = 'ag'      | endif
-if !exists('g:ags_agmaxcount') | let g:ags_agmaxcount = 2000 | endif
-if !exists('g:ags_agcontext')  | let g:ags_agcontext = 3     | endif
-
-if !exists('g:ags_edit_skip_if_file_changed')
-    let g:ags_edit_skip_if_file_changed = 0
-endif
-
-if !exists('g:ags_edit_show_line_numbers')
-    let g:ags_edit_show_line_numbers = 0
-endif
+let g:ags_agexe                     = get(g:, 'ags_agexe', 'ag')
+let g:ags_agmaxcount                = get(g:, 'ags_agmaxcount', 2000)
+let g:ags_agcontext                 = get(g:, 'ags_agcontext', 3)
+let g:ags_stats_max_ln              = get(g:, 'ags_stats_max_ln', 5000)
+let g:ags_edit_skip_if_file_changed = get(g:, 'ags_edit_skip_if_file_changed', 0)
+let g:ags_edit_show_line_numbers    = get(g:, 'ags_edit_show_line_numbers', 0)
 
 if !exists('g:ags_agargs')
     " Predefined search arguments
-    " arg : [ value, short-name, default ]
+    " arg : [ value, short-name ]
     let g:ags_agargs = {
                 \ '--break'             : [ '', '' ],
                 \ '--color'             : [ '', '' ],
                 \ '--color-line-number' : [ '"1;30"', '' ],
                 \ '--color-match'       : [ '"32;40"', '' ],
                 \ '--color-path'        : [ '"1;31"', '' ],
                 \ '--column'            : [ '', '' ],
-                \ '--context'           : [ 'g:ags_agcontext', '-C', '3' ],
+                \ '--context'           : [ 'g:ags_agcontext', '-C' ],
                 \ '--filename'          : [ '', '' ],
                 \ '--group'             : [ '', '' ],
                 \ '--heading'           : [ '', '-H' ],
-                \ '--max-count'         : [ 'g:ags_agmaxcount', '-m', '2000' ],
+                \ '--max-count'         : [ 'g:ags_agmaxcount', '-m' ],
                 \ '--numbers'           : [ '', '' ]
                 \ }
 endif