Changes to SyncTeX backward search #2135
Conversation
In the latexmk command line, make sure that --remote-expr is used instead of --remote for SyncTeX backwards search when opening Zathura. This ensures consistency between starting compilation via <LocalLeader>ll and opening the viewer separately via <LocalLeader>lv. Refer lervag#2127 (comment)
When a file is open in a different tab page, make sure to switch to that tab page when SyncTeX backward search requests that file. The previous behavior was to use bufwinnr, which does not look at windows in other tab pages and therefore acts as if the buffer is not open anywhere. Refer https://stackoverflow.com/a/42628934
This option controls the command that is used to open new files from SyncTeX backward search in multi-file projects. Refer lervag#2127
Thanks!
Wow, impressive level of shell escape magic!
Great, thanks!
Sounds good! |
| execute l:tabnr . 'tabnext' | ||
| execute l:winnr . 'wincmd w' | ||
| catch | ||
| execute g:vimtex_view_reverse_search_edit_cmd l:file |
There was a problem hiding this comment.
I don't get why we need the second execute ... (which is the same as line 78)? Is it because of the if !bufloaded?
There was a problem hiding this comment.
Yes, I think so. I included this to replicate the behavior of the old line 94, which used buffer to load the buffer if it exists but is not loaded. With the change from bufexists to bufloaded, this would load the buffer if it is loaded but for whatever reason win_findbuf does not find it. From my limited knowledge, it seems that this should not happen, but I think I found a counterexample in my testing (though I don't remember what the situation was).
I changed buffer to the value of g:vimtex_view_reverse_search_edit_cmd to avoid usurping the current buffer in this case (if that is the user's preference). With default settings, edit is used instead of buffer and (as far as I know) the user experience is largely unchanged.
| \ ? l:winnr . 'wincmd w' | ||
| \ : 'buffer ' . l:bufnr | ||
| " Get window and tab numbers | ||
| try |
There was a problem hiding this comment.
When would the following code fail? During tabnext? Or wincmd?
There was a problem hiding this comment.
This would actually fail in line 95; if the buffer does not exist, then win_findbuf returns an empty list and the unpacking fails.
| @@ -80,7 +80,7 @@ function! s:zathura.latexmk_append_argument() dict abort " {{{1 | |||
| if self.has_synctex | |||
| let zathura .= ' -x \"' . g:vimtex_compiler_progname | |||
| \ . ' --servername ' . v:servername | |||
| \ . ' --remote +\%{line} \%{input}\" \%S' | |||
| \ . ' --remote-expr \"\\\"\"vimtex#view#reverse_goto(\%{line}, ''"''"''\%{input}''"''"'')\"\\\"\"\" \%S' | |||
There was a problem hiding this comment.
And the worst part of this is that it works! Great work!
There was a problem hiding this comment.
Thank you! I had to do quite a bit of testing with latexmk on the command line. For the record, this is what I used:
latexmk -pvc -new-viewer -pdf lectures.tex -e '$pdf_previewer = "zathura -x \"/usr/bin/vim.gtk3 --servername VIM --remote-expr \"\\\"\"vimtex#view#reverse_goto(\%{line}, '"'"'\%{input}'"'"')\"\\\"\"\" lectures.pdf"'The output contained the command line used by latexmk to start Zathura, which I could cross-check against the use of --remote-expr already in zathura.vim:
Running 'start zathura -x "/usr/bin/vim.gtk3 --servername VIM --remote-expr "\""vimtex#view#reverse_goto(%{line}, '%{input}')"\""" lectures.pdf'
|
I'll merge after feedback on my questions. |
|
Thanks for the good work! I made some minor adjustments and merged this just now. |
Fixes #2127. This pull requests addresses three closely related issues related to SyncTeX backward search in multi-file projects, the last of which is the one originally brought up in #2127:
latexmkcommand line, invoked upon<LocalLeader>ll, opens Zathura with--remotefor backward search, while running<LocalLeader>lvopens Zathura with--remote-exprfor backward search. This can lead to inconsistent behavior; 2139057 fixes this by properly escaping all arguments in thelatexmkcommand line in order to use--remote-expr.vimtex#view#reverse_goto, which is called upon backward search, is hard-coded to useeditto open a new file, usurping the current window; b003fee makes this configurable and usesbufloadedinstead ofbufexiststo avoid falling back to usurpation when a buffer exists but is not visible (e.g., if it were opened in another tab page and then closed, we want to reopen it in a tab page — if this is the user's preference — and not always try to usurp the current window to load that buffer).