Skip to content

Add simple Zathura viewer alternative #2639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lervag wants to merge 3 commits into from
Closed

Add simple Zathura viewer alternative #2639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
46973c9
chore: make some zathura.vim functions public
lervag Feb 19, 2023
526ac32
feat: add zathura_simple viewer
lervag Feb 19, 2023
51d5bf2
fix: silly mistake
lervag Feb 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 52 additions & 46 deletions autoload/vimtex/view/zathura.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,7 @@ function! vimtex#view#zathura#new() abort " {{{1
endfunction

" }}}1


let s:viewer = vimtex#view#_template#new({
\ 'name': 'Zathura',
\ 'xwin_id': 0,
\ 'has_synctex': 1,
\})

function! s:viewer._check() dict abort " {{{1
function! vimtex#view#zathura#check(viewer) abort " {{{1
" Check if Zathura is executable
if !executable('zathura')
call vimtex#log#error('Zathura is not executable!')
Expand All @@ -30,21 +22,68 @@ function! s:viewer._check() dict abort " {{{1
if v:shell_error == 0
\ && empty(filter(l:shared, 'v:val =~# ''libsynctex'''))
call vimtex#log#warning('Zathura is not linked to libsynctex!')
let s:viewer.has_synctex = 0
if has_key(a:viewer, 'has_synctex')
let a:viewer.has_synctex = 0
endif
endif
endif

return v:true
endfunction

" }}}1
function! vimtex#view#zathura#cmdline(outfile, synctex, start) abort " {{{1
let l:cmd = 'zathura'

if a:start
let l:cmd .= ' ' . g:vimtex_view_zathura_options
if a:synctex
let l:cmd .= printf(
\ ' -x "%s -c \"VimtexInverseSearch %%{line} ''%%{input}''\""',
\ s:inverse_search_cmd)
endif
endif

if a:synctex && (a:start != 1 || g:vimtex_view_forward_search_on_start)
let l:cmd .= printf(
\ ' --synctex-forward %d:%d:%s',
\ line('.'), col('.'),
\ vimtex#util#shellescape(expand('%:p')))
endif

return l:cmd . ' '
\ . vimtex#util#shellescape(vimtex#paths#relative(a:outfile, getcwd()))
\ . '&'
endfunction

let s:inverse_search_cmd = get(g:, 'vimtex_callback_progpath',
\ get(v:, 'progpath', get(v:, 'progname', '')))
\ . (has('nvim')
\ ? ' --headless'
\ : ' -T dumb --not-a-term -n')

" }}}1


let s:viewer = vimtex#view#_template#new({
\ 'name': 'Zathura',
\ 'has_synctex': 1,
\ 'xwin_id': 0,
\})

function! s:viewer._check() dict abort " {{{1
return vimtex#view#zathura#check(self)
endfunction

" }}}1
function! s:viewer._exists() dict abort " {{{1
return self.xdo_exists()
endfunction

" }}}1
function! s:viewer._start(outfile) dict abort " {{{1
let self.cmd_start = s:cmdline(a:outfile, self.has_synctex, 1)
let self.cmd_start
\ = vimtex#view#zathura#cmdline(a:outfile, self.has_synctex, 1)

call vimtex#jobs#run(self.cmd_start)

Expand All @@ -58,7 +97,8 @@ function! s:viewer._forward_search(outfile) dict abort " {{{1
let l:synctex_file = fnamemodify(a:outfile, ':r') . '.synctex.gz'
if !filereadable(l:synctex_file) | return | endif

let self.cmd_forward_search = s:cmdline(a:outfile, self.has_synctex, 0)
let self.cmd_forward_search
\ = vimtex#view#zathura#cmdline(a:outfile, self.has_synctex, 0)

call vimtex#jobs#run(self.cmd_forward_search)
endfunction
Expand All @@ -80,37 +120,3 @@ function! s:viewer.get_pid() dict abort " {{{1
endfunction

" }}}1


function! s:cmdline(outfile, synctex, start) abort " {{{1
let l:cmd = 'zathura'

if a:start
let l:cmd .= ' ' . g:vimtex_view_zathura_options
if a:synctex
let l:cmd .= printf(
\ ' -x "%s -c \"VimtexInverseSearch %%{line} ''%%{input}''\""',
\ s:inverse_search_cmd)
endif
endif

if a:synctex && (!a:start || g:vimtex_view_forward_search_on_start)
let l:cmd .= printf(
\ ' --synctex-forward %d:%d:%s',
\ line('.'), col('.'),
\ vimtex#util#shellescape(expand('%:p')))
endif

return l:cmd . ' '
\ . vimtex#util#shellescape(vimtex#paths#relative(a:outfile, getcwd()))
\ . '&'
endfunction

" }}}1


let s:inverse_search_cmd = get(g:, 'vimtex_callback_progpath',
\ get(v:, 'progpath', get(v:, 'progname', '')))
\ . (has('nvim')
\ ? ' --headless'
\ : ' -T dumb --not-a-term -n')
31 changes: 31 additions & 0 deletions autoload/vimtex/view/zathura_simple.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: karl.yngve@gmail.com
"

function! vimtex#view#zathura_simple#new() abort " {{{1
return s:viewer.init()
endfunction

" }}}1


let s:viewer = vimtex#view#_template#new({
\ 'name': 'Zathura',
\ 'has_synctex': 1,
\})

function! s:viewer._check() dict abort " {{{1
return vimtex#view#zathura#check(self)
endfunction

" }}}1
function! s:viewer._start(outfile) dict abort " {{{1
let self.cmd_start
\ = vimtex#view#zathura#cmdline(a:outfile, self.has_synctex, 2)

call vimtex#jobs#run(self.cmd_start)
endfunction

" }}}1
23 changes: 18 additions & 5 deletions doc/vimtex.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3020,9 +3020,10 @@ OPTIONS *vimtex-options*

Possible values:
* `'general'`
* `'mupdf'` |vimtex-view-mupdf|
* `'skim'` |vimtex-view-skim|
* `'zathura'` |vimtex-view-zathura|
* `'mupdf'` |vimtex-view-mupdf|
* `'skim'` |vimtex-view-skim|
* `'zathura'` |vimtex-view-zathura|
* `'zathura_simple'` |vimtex-view-zathura-simple|

See |vimtex-view-configuration| for more information on various popular
viewers and on how to configure them.
Expand All @@ -3042,8 +3043,10 @@ OPTIONS *vimtex-options*

*g:vimtex_view_mupdf_options*
*g:vimtex_view_zathura_options*
Set options for mupdf (|vimtex-view-mupdf|) and Zathura
(|vimtex-view-zathura|), respectively.
Set options for mupdf and Zathura, respectively. See also:
* |vimtex-view-mupdf|
* |vimtex-view-zathura|
* |vimtex-view-zathura-simple|

Default value: ''

Expand Down Expand Up @@ -5575,6 +5578,16 @@ Note: Viewer handling uses window title matching. If there exists another pdf
might be conflicts. In particular, this might affect forward/inverse
searching for Zathura.

*vimtex-view-zathura-simple*
Zathura (simple) ~
This is a simpler implementation of the Zathura viewer; the user should first
read the docs for |vimtex-view-zathura|.

This variant does not rely on `xdotool`. It leads to a much simpler version
that should work well in most cases. However, `xdotool` is useful in order to
prevent duplicate windows and to detect existing viewer windows when you start
a VimTeX session.

------------------------------------------------------------------------------
SYNCTEX SUPPORT *vimtex-synctex*

Expand Down