Quickfix

1. Using QuickFix commands Quickfix E42

vim -q filename

:cexpr system('grep -n xyz *')
:cexpr getline(1, '$')

:g/mypattern/caddexpr expand("%") .. ":" .. line(".") ..  ":" .. getline(".")

function QfMakeConv()
   let qflist = getqflist()
   for i in qflist
      let i.text = iconv(i.text, "cp936", "utf-8")
   endfor
   call setqflist(qflist)
endfunction
au QuickfixCmdPost make call QfMakeConv()

call setqflist([], 'a', {'title' : 'Cmd output'})
echo getqflist({'title' : 1})
call setloclist(3, [], 'a', {'title' : 'Cmd output'})
echo getloclist(3, {'title' : 1})

echo getqflist({'idx' : 0}).idx
echo getqflist({'id' : qfid, 'idx' : 0}).idx
echo getloclist(2, {'idx' : 0}).idx

call setqflist([], 'a', {'idx' : 12})
call setqflist([], 'a', {'id' : qfid, 'idx' : 7})
call setloclist(1, [], 'a', {'idx' : 7})

echo getqflist({'size' : 1})
echo getloclist(5, {'size' : 1})

let somectx = {'name' : 'Vim', 'type' : 'Editor'}
call setqflist([], 'a', {'context' : somectx})
echo getqflist({'context' : 1})
let newctx = ['red', 'green', 'blue']
call setloclist(2, [], 'a', {'id' : qfid, 'context' : newctx})
echo getloclist(2, {'id' : qfid, 'context' : 1})

echo getqflist({'lines' : ["F1:10:Line10", "F2:20:Line20"]})
echo getqflist({'lines' : systemlist('grep -Hn quickfix *')})

echo getqflist({'efm' : '%f#%l#%m', 'lines' : ['F1#10#Line']})

:cfirst
:{cmd}
:cnext
:{cmd}
etc.

:10,$cdo cmd

:cfirst
:{cmd}
:cnfile
:{cmd}
etc.

:lfirst
:{cmd}
:lnext
:{cmd}
etc.

:lfirst
:{cmd}
:lnfile
:{cmd}
etc.

packadd cfilter

:Cfilter[!] /{pat}/
:Lfilter[!] /{pat}/

2. The error window quickfix-window

:botright cwindow

:hi QuickFixLine ctermbg=Yellow guibg=Yellow

au BufReadPost quickfix  setlocal modifiable
        \ | silent exe 'g/^/s//\=line(".") .. " "/'
        \ | setlocal nomodifiable

echo getqflist({'winid' : 1}).winid
echo getloclist(2, {'winid' : 1}).winid

" get the title of the current quickfix list
:echo getqflist({'title' : 0}).title
" get the identifier of the current quickfix list
:let qfid = getqflist({'id' : 0}).id
" get the identifier of the fourth quickfix list in the stack
:let qfid = getqflist({'nr' : 4, 'id' : 0}).id
" check whether a quickfix list with a specific identifier exists
:if getqflist({'id' : qfid}).id == qfid
" get the index of the current quickfix list in the stack
:let qfnum = getqflist({'nr' : 0}).nr
" get the items of a quickfix list specified by an identifier
:echo getqflist({'id' : qfid, 'items' : 0}).items
" get the number of entries in a quickfix list specified by an id
:echo getqflist({'id' : qfid, 'size' : 0}).size
" get the context of the third quickfix list in the stack
:echo getqflist({'nr' : 3, 'context' : 0}).context
" get the number of quickfix lists in the stack
:echo getqflist({'nr' : '$'}).nr
" get the number of times the current quickfix list is changed
:echo getqflist({'changedtick' : 0}).changedtick
" get the current entry in a quickfix list specified by an identifier
:echo getqflist({'id' : qfid, 'idx' : 0}).idx
" get all the quickfix list attributes using an identifier
:echo getqflist({'id' : qfid, 'all' : 0})
" parse text from a List of lines and return a quickfix list
:let myList = ["a.java:10:L10", "b.java:20:L20"]
:echo getqflist({'lines' : myList}).items
" parse text using a custom 'efm' and return a quickfix list
:echo getqflist({'lines' : ['a.c#10#Line 10'], 'efm':'%f#%l#%m'}).items
" get the quickfix list window id
:echo getqflist({'winid' : 0}).winid
" get the quickfix list window buffer number
:echo getqflist({'qfbufnr' : 0}).qfbufnr
" get the context of the current location list
:echo getloclist(0, {'context' : 0}).context
" get the location list window id of the third window
:echo getloclist(3, {'winid' : 0}).winid
" get the location list window buffer number of the third window
:echo getloclist(3, {'qfbufnr' : 0}).qfbufnr
" get the file window id of a location list window (winnr: 4)
:echo getloclist(4, {'filewinid' : 0}).filewinid

" create an empty quickfix list with a title and a context
:let t = 'Search results'
:let c = {'cmd' : 'grep'}
:call setqflist([], ' ', {'title' : t, 'context' : c})
" set the title of the current quickfix list
:call setqflist([], 'a', {'title' : 'Mytitle'})
" change the current entry in the list specified by an identifier
:call setqflist([], 'a', {'id' : qfid, 'idx' : 10})
" set the context of a quickfix list specified by an identifier
:call setqflist([], 'a', {'id' : qfid, 'context' : {'val' : 100}})
" create a new quickfix list from a command output
:call setqflist([], ' ', {'lines' : systemlist('grep -Hn main *.c')})
" parse text using a custom efm and add to a particular quickfix list
:call setqflist([], 'a', {'id' : qfid,
            \ 'lines' : ["a.c#10#L10", "b.c#20#L20"], 'efm':'%f#%l#%m'})
" add items to the quickfix list specified by an identifier
:let newItems = [{'filename' : 'a.txt', 'lnum' : 10, 'text' : "Apple"},
                \ {'filename' : 'b.txt', 'lnum' : 20, 'text' : "Orange"}]
:call setqflist([], 'a', {'id' : qfid, 'items' : newItems})
" empty a quickfix list specified by an identifier
:call setqflist([], 'r', {'id' : qfid, 'items' : []})
" free all the quickfix lists in the stack
:call setqflist([], 'f')
" set the title of the fourth quickfix list
:call setqflist([], 'a', {'nr' : 4, 'title' : 'SomeTitle'})
" create a new quickfix list at the end of the stack
:call setqflist([], ' ', {'nr' : '$',
                    \ 'lines' : systemlist('grep -Hn class *.java')})
" create a new location list from a command output
:call setloclist(0, [], ' ', {'lines' : systemlist('grep -Hn main *.c')})
" replace the location list entries for the third window
:call setloclist(3, [], 'r', {'items' : newItems})

3. Using more than one list of errors quickfix-error-lists

  error list 1 of 3; 43 errors   :make
> error list 2 of 3; 0 errors    :helpgrep tag
  error list 3 of 3; 15 errors   :grep ex_help *.c

" Make the 4th quickfix list current
:4chistory

echo getqflist({'nr' : '$'}).nr
echo getloclist(3, {'nr' : '$'}).nr

echo getqflist({'nr' : 0}).nr

4. Using :make :make_makeprg

:set makeprg=make\ #<.o

:set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}

:let &mp = 'latex \\nonstopmode \\input\{$*}'

:set makeprg=gcc\ -o\ $*\ $*

function QfMakeConv()
   let qflist = getqflist()
   for i in qflist
      let i.text = iconv(i.text, "cp936", "utf-8")
   endfor
   call setqflist(qflist)
endfunction
au QuickfixCmdPost make call QfMakeConv()

5. Using :vimgrep and :grep grep lid

command! -nargs=+ NewGrep execute 'silent grep! <args>' | copen 42

:vimgrep /an error/ *.c
:vimgrep /\<FileName\>/ *.h include/*
:vimgrep /myfunc/ **/*.c

:vimgrep Error *.c

:call setqflist([])
:bufdo grepadd! something %

:silent argdo try
  \ | grepadd! something %
  \ | catch /E480:/
  \ | endtry"

:grep foo *.c

:set grepprg=lid\ -Rgrep\ -s
:set grepformat=%f:%l:%m

:grep (regexp)

:vimgrep /\<read_file\>/ *.c

:vimgrep /\<msg\>/ *.c

:colder

6. Selecting a compiler compiler-select

CPPCHECK quickfix-cppcheck compiler-cppcheck

let &l:path = join(systemlist('git ls-tree -d --name-only -r HEAD'), ',')

DOTNET compiler-dotnet

let dotnet_errors_only = v:true
let dotnet_show_project_file = v:false
compiler dotnet

GCC quickfix-gcc compiler-gcc

JAVAC compiler-javac

let g:javac_makeprg_params = "-Xlint:all -encoding utf-8"

MAVEN compiler-maven

let g:maven_makeprg_params = "-DskipTests -U -X"

SPOTBUGS compiler-spotbugs

let b:spotbugs_makeprg_params = "-longBugCodes -effort:max -low"

let g:spotbugs_properties = {
        \ 'sourceDirPath':        'src/main/java',
        \ 'classDirPath':        'target/classes',
        \ 'testSourceDirPath':        'src/test/java',
        \ 'testClassDirPath':        'target/test-classes',
\ }

let g:spotbugs_properties = {
        \ 'compiler':                'maven',
\ }

let g:spotbugs_properties = {
        \ 'PreCompilerAction':
                \ function('spotbugs#DefaultPreCompilerAction'),
        \ 'PreCompilerTestAction':
                \ function('spotbugs#DefaultPreCompilerTestAction'),
        \ 'PostCompilerAction':
                \ function('spotbugs#DefaultPostCompilerAction'),
        \ 'sourceDirPath':        'src/main/java',
        \ 'classDirPath':        'target/classes',
        \ 'testSourceDirPath':        'src/test/java',
        \ 'testClassDirPath':        'target/test-classes',
\ }

function! MavenPreCompilerAction() abort
        call spotbugs#DeleteClassFiles()
        compiler maven
        make compile
endfunction
function! MavenPreCompilerTestAction() abort
        call spotbugs#DeleteClassFiles()
        compiler maven
        make test-compile
endfunction
let g:spotbugs_properties = {
        \ 'compiler':                'maven',
        \ 'PreCompilerAction':
                \ function('MavenPreCompilerAction'),
        \ 'PreCompilerTestAction':
                \ function('MavenPreCompilerTestAction'),
\ }

GNU MAKE compiler-make

GROFF quickfix-groff compiler-groff

PANDOC quickfix-pandoc compiler-pandoc

PERL quickfix-perl compiler-perl

let g:perl_compiler_force_warnings = 0

MYPY TYPE CHECKER compiler-mypy

let b:mypy_makeprg_params = "--warn-unused-ignores"

RUFF LINTER compiler-ruff

let b:ruff_makeprg_params = "--max-line-length "..&textwidth

PYLINT LINTER compiler-pylint

let b:pylint_makeprg_params = "--max-line-length "..&textwidth

PYUNIT COMPILER compiler-pyunit

PYTEST COMPILER compiler-pytest

let b:pytest_makeprg_params = "--verbose --no-summary --disable-warnings"

TEX COMPILER compiler-tex

:let b:tex_flavor = 'amstex'
:compiler tex

:make mypaper

TYPST COMPILER compiler-typst

let g:typst_cmd = "/path/to/other/command"

7. The error format error-file-format

^

---------^

:set efm=%EError\ %n,%Cline\ %l,%Ccolumn\ %c,%Z%m

:set efm=%C\ %.%#,%A\ \ File\ \"%f\"\\,\ line\ %l%.%#,%Z%[%^\ ]%\\@=%m

:set efm=xxx,%E%>Error in line %l of %f:,%Z%m

setlocal efm=aa,bb,cc,dd,ee

:set efm=%+P[%f],(%l\\,%c)%*[\ ]%t%*[^:]:\ %m,%-Q

{"file1" {"file2" error1} error2 {"file3" error3 {"file4" error4 error5}}}

:set mp=make\ \\\|&\ error_filter

8. The directory stack quickfix-directory-stack

9. Specific error file formats errorformats

:set efm=%A%f:%l:%c:%*\\d:%*\\d:,
      \%C%*\\s%trror:%m,
      \%+C%*[^:]%trror:%m,
      \%C%*\\s%tarning:%m,
      \%C%m

:setl efm=%f:%l:%v:%*\\d:%*\\d:%*\\s%m

:setl efm=%A%f:%l:\ %m,%-Z%p^,%-C%.%#

:setl efm=%A%f:%l:\ %m,%+Z%p^,%+C%.%#,%-G%.%#

:setl errorformat=%Z%f:%l:\ %m,%A%p^,%-G%*[^sl]%.%#
:setl makeprg=javac\ %:S\ 2>&1\ \\\|\ vim-javac-filter

#!/bin/sed -f
/\^$/s/\t/\ /g;/:[0-9]\+:/{h;d};/^[ \t]*\^/G;

:set efm=%A\ %#[javac]\ %f:%l:\ %m,%-Z\ %#[javac]\ %p^,%-C%.%#

<property name = "build.compiler"       value = "jikes"/>
<property name = "build.compiler.emacs" value = "true"/>

:set efm=\ %#[javac]\ %#%f:%l:%c:%*\\d:%*\\d:\ %t%[%^:]%#:%m,
         \%A\ %#[javac]\ %f:%l:\ %m,%-Z\ %#[javac]\ %p^,%-C%.%#

:set efm=jade:%f:%l:%c:%t:%m

:set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}

:set efm=%E!\ LaTeX\ %trror:\ %m,
       \%E!\ %m,

\%Cl.%l\ %m,
\%+C\ \ %m.,
\%+C%.%#-%.%#,
\%+C%.%#[]%.%#,
\%+C[]%.%#,
\%+C%.%#%[{}\\]%.%#,
\%+C<%.%#>%.%#,
\%C\ \ %m,

\%-GSee\ the\ LaTeX%m,
\%-GType\ \ H\ <return>%m,
\%-G\ ...%.%#,
\%-G%.%#\ (C)\ %.%#,
\%-G(see\ the\ transcript%.%#),

\%-G\\s%#,

\%+O(%f)%r,

\%+P(%f%r,
\%+P\ %\\=(%f%r,
\%+P%*[^()](%f%r,
\%+P[%\\d%[^()]%#(%f%r,

\%+Q)%r,
\%+Q%*[^()])%r,
\%+Q[%\\d%*[^()])%r

10. Customizing the quickfix window quickfix-window-function

<filename>|<lnum> col <col>|<text>

" create a quickfix list from v:oldfiles
call setqflist([], ' ', {'lines' : v:oldfiles, 'efm' : '%f',
                                    \ 'quickfixtextfunc' : 'QfOldFiles'})
func QfOldFiles(info)
    " get information about a range of quickfix entries
    let items = getqflist({'id' : a:info.id, 'items' : 1}).items
    let l = []
    for idx in range(a:info.start_idx - 1, a:info.end_idx - 1)
        " use the simplified file name
      call add(l, fnamemodify(bufname(items[idx].bufnr), ':p:.'))
    endfor
    return l
endfunc