Скрипт Vim для компиляции исходного кода TeX и запуска PDF только при отсутствии ошибок - PullRequest
6 голосов
/ 21 апреля 2010

Я переключаюсь на использование Vim для моей среды редактирования LaTeX. Я хотел бы иметь возможность отправлять исходные текстовые файлы из Vim и запускать внешний просмотр, если компиляция прошла успешно.

Я знаю о наборе Vim-Latex, но, если возможно, предпочел бы не использовать его: он довольно тяжелый, захватывает много моих ключей и загромождает мой vimruntime с помощью много файлов.

Вот что у меня сейчас:

if exists('b:tex_build_mapped')
    finish
endif
" use maparg or mapcheck to see if key is free
command! -buffer -nargs=* BuildTex call BuildTex(0, <f-args>)
command! -buffer -nargs=* BuildAndViewTex call BuildTex(1, <f-args>)
noremap <buffer> <silent> <F9> <Esc>:call BuildTex(0)<CR>
noremap <buffer> <silent> <S-F9> <Esc>:call BuildTex(1)<CR>
let b:tex_build_mapped = 1

if exists('g:tex_build_loaded')
    finish
endif
let g:tex_build_loaded = 1

function! BuildTex(view_results, ...)
    write
    if filereadable("Makefile")
        " If Makefile is available in current working directory, run 'make' with arguments
        echo "(using Makefile)"
        let l:cmd = "!make ".join(a:000, ' ')
        echo l:cmd
        execute l:cmd
        if a:view_results && v:shell_error == 0
            call ViewTexResults()
        endif
    else
        let b:tex_flavor = 'pdflatex'
        compiler tex
        make %
        if a:view_results && v:shell_error == 0
            call ViewTexResults()
        endif
    endif
endfunction

function! ViewTexResults(...)
    if a:0 == 0
        let l:target = expand("%:p:r") . ".pdf"
    else
        let l:target = a:1
    endif
    if has('mac')
        execute "! open -a Preview ".l:target
    endif
endfunction

Проблема в том, что v:shell_error не установлен, даже если есть ошибки компиляции. Будем весьма благодарны за любые предложения или идеи о том, как определить, была ли успешной компиляция! Спасибо!


Между ответами, данными здесь, плюс некоторым изучением других подходов, я думаю, что это было удовлетворительно решено. Я публикую решение здесь на тот случай, если кому-то еще будет интересно.

По сути, наилучшим решением, по-видимому, является использование Rubber , оболочки вокруг LaTeX, которая, как правило, "просто работает" и обеспечивает очень чистый вывод / ошибки. Решение, которое я представляю ниже, преимущественно использует Rubber, если оно найдено в системе, а Makefile не найден в текущем каталоге. Если Makefile найден, он использует его. Если Makefile отсутствует, а Rubber не установлен, он использует pdflatex. Во всех случаях, если исходный код не удается скомпилировать, ошибки (отфильтрованные и проанализированные) отправляются в буфер QuickFix, и окно QuickFix открывается автоматически. Если он успешно компилируется, пишется короткое сообщение, и если пользователь запросил его, PDF-файл будет открыт для просмотра.

В моей собственной установке я поднял ( превосходный ) функцию SetLatexEfm () с Vim-Latex для анализа и фильтрации вывода сборки tex. Однако, если эта функция не найдена, нижеприведенная функция по умолчанию устанавливает формат сообщения об ошибке, который работает достаточно хорошо для выявления и выделения ошибок в окне QuickFix, хотя и с большим количеством ошибок.

    function! BuildTex(view_results, ...)

        " record position
        let save_cursor = getpos(".")

        " save work
        silent write

        " From: http://stackoverflow.com/questions/2679475/vim-script-to-compile-tex-source-and-launch-pdf-only-if-no-errors
        " If your shell is bash, you can use the ${PIPESTATUS} array variable to get
        " the correct exit code (borrowed from this answer to another question).
        silent setlocal shell=bash
        silent setlocal shellpipe=2>&1\ \|\ tee\ %s;exit\ \${PIPESTATUS[0]}

        let success = 1
        if filereadable("Makefile")
            " If Makefile is available in current working directory, run 'make' with arguments
            echon "compiling using Makefile ..."
            let l:makecmd = "make\\ ".join(a:000, '\\ ')
            silent execute "setlocal makeprg=" . l:makecmd
            try
                " This function is defined in the Vim-Latex package, 
                " and provides excellent parsing and filtering of the error messages
                " when running latex outside of the Rubber wrapper.
                call s:SetLatexEfm()
            catch /E117/
                set errorformat=%E!\ LaTeX\ %trror:\ %m,
                    \%E!\ %m,
                    \%+WLaTeX\ %.%#Warning:\ %.%#line\ %l%.%#,
                    \%+W%.%#\ at\ lines\ %l--%*\\d,
                    \%WLaTeX\ %.%#Warning:\ %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
            endtry
            silent make
        else
            let l:special_tex_compiler = "rubber"
            if executable(l:special_tex_compiler)
                echon "compiling with Rubber ..."
                silent execute "setlocal makeprg=" . l:special_tex_compiler . "\\ -dfs\\ %"
                setlocal errorformat=%f:%l:\ %m
                silent make %
            else
                echon "compiling ..."
                let b:tex_flavor = 'pdflatex'
                compiler tex
                silent make %
            endif
        endif

        " set/report compile status
        if v:shell_error
            let l:success = 0
            " let l:wheight = winheight(bufnr("%")) / 2
            " execute "copen ".l:wheight
            copen
        else
            let l:success = 1
            cclose
            redraw
            echon "successfully compiled"
        endif

        " view results if successful compile
        if l:success && a:view_results
            call ViewTexResults()
        endif

        " restore position
        call setpos('.', save_cursor)

    endfunction

    function! ViewTexResults(...)
        if a:0 == 0
            let l:target = expand("%:p:r") . ".pdf"
        else
            let l:target = a:1
        endif
        if has('mac')
            silent execute "! open -a Preview ".l:target
            " obviously, you will need to write specific commands for other systems
            " left as an exercise for the reader ...
        endif
    endfunction

    command! -buffer -nargs=* BuildTex call BuildTex(0, <f-args>)
    command! -buffer -nargs=* BuildAndViewTex call BuildTex(1, <f-args>)
    noremap <buffer> <silent> <F9> <Esc>:call BuildTex(0)<CR>
    noremap <buffer> <silent> <S-F9> <Esc>:call BuildTex(1)<CR>

Обновление: я упаковал и опубликовал это как скрипт-плагин типа файла Vim, доступный по адресу: http://www.vim.org/scripts/script.php?script_id=3230.

Ответы [ 3 ]

3 голосов
/ 21 апреля 2010

Если вы попадаете в раздел else-theres-no-makefile, проблема может заключаться в переменной shellpipe.

В моей системе (Ubuntu), shellpipe=2>&1| tee и встроенномв make вызов не устанавливается v:shell_error в случае сбоя.

Состояние возврата | tee может быть таким, как v:shell_error устанавливается.

Если ваша оболочка bash, вы можете использовать переменную массива ${PIPESTATUS}, чтобы получить правильный выходкод (заимствован из этого ответа к другому вопросу).

:set shellpipe=2>&1\ \|\ tee\ %s;exit\ \${PIPESTATUS[0]}

В противном случае вы можете попробовать:

:set shellpipe=\>
:make %

Устанавливает v:shell_error, если не удается, ноЯ не уверен, будет ли это портить функциональность перехода к номеру строки ошибки, если таковая имеется.

Чтобы узнать, для какой переменной установлена:

:set shellpipe?
1 голос
/ 24 апреля 2010

Я знаю, что это не связано с vim, но я думаю, что latexmk делает свою работу.

Это скрипт (написанный на perl), который компилирует латексный файл и обновляет pdf. Самое полезное будущее - автообновление. Как только вы сохраните свой файл, 'latexmk' скомпилирует его, и если ваш просмотрщик PDF его поддержит, представление обновится.

latexmk -pdf -pvc

0 голосов
/ 11 мая 2010

Если latexmk запускает латекс с параметром -halt-on-error (или в режиме нон-стоп), компиляция прекратится без остановки ввода.

...