vim-compil-hints


Ⅰ. 插件描述

Hints about compilation errors for Vim

Ⅱ. 基本信息

创建日期:  2012-04-10
使用用户:  0
Github星:  2
插件作者:  Luc Hermitte

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:
Plugin 'luchermitte/vim-compil-hints'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall

对于Vundle版本 < 0.10.2,请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:
NeoBundle 'luchermitte/vim-compil-hints'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:
Plug 'luchermitte/vim-compil-hints'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:
cd ~/.vim/bundle
git clone https://github.com/luchermitte/vim-compil-hints

Ⅳ. 文档说明

compil-hints

Add ballons and signs to show where compilation errors have occurred.
The information is extracted from the quickfix list.

Last release Project Stats

Features

  • Parses the quickfix list and presents its entries as
    signs and/or

balloons --
when supported by Vim.

  • Works out of the box in synchronous and asynchronous compilation and

    1. IOW, asynchronous compilation plugins don't require to do anything
    2. update the signs placed by compil-hints.
  • Multiple issues happening on a same line are merged together, the highest
    error level is kept (_error_ > warning > note > _context_), even when

compilation/grep is asynchronous.

  • Balloons are automatically updated.
  • Signs are automatically updated at the end of a compilation, a (vim)grep...
    They are also automatically (and incrementally!) updated on asynchronous

compilation/grepping -- that use
:caddexpr,
:grepadd...

  • Closing and opening the qf-window will activate and deactivate signs and

    1. IOW, when enabled, signs and balloons will be displayed only when
    2. quickfix window is opened.
  • End-user can decide to globally use or disable the plugin, through the menu
    or the auto_start option.
  • Signs and balloons are updated on
    :cnewer & al.

Commands

Provides:

  • :CompilHintsToggle -- to start/stop using the plugin
  • :CompilHintsUpdate -- to update the signs to display; should not be
    required anymore

Listens/reacts on:

  • :make, :grep, :vimgrep, :cscope, :cfile, :cgetfile, :helpgrep, :cexpr, :cgetexpr, :cbuffer, :cgetbuffer
  • :grepadd, :vimgreadd, :caddfile, :caddexpr, :caddbuffer
  • :copen, :cclose, :quit, and anything that makes a qf window appears
  • :cnewer, :colder
  • :call setqflist()

IOW, plugins that update the quickfix list don't need to explicitly refresh
the signs by calling lh#compil_hints#update() anymore since version 1.1.0.

Demo

Here is a little screencast to see how things are displayed with vim-compil-hints.

vim-compil-hints demo

Note: You should observe that :colder suffers an important slow down in the
screencast (made on a slow VM). Since that screencast, I've improved the signs
unplacing execution by a 1200 times factor. It's likelly to still be slow when
all the buffers containining thousands of signs are loaded. With
lh-compil-hints 2.2 and Vim 8.1.0614+, unplacing performances have improved,
but I haven't measured the speed-up yet.

In order to workaround it, I could have set
g:compil_hints.harsh_signs_removal_enabled
to 1. Alas, it will remove signs placed by other plugins as well. Starting from
Vim 8.1.0614+, this option is ignored.

Options

The
options are:

g:compil_hints.use_balloons

Activates the display of balloons -- boolean: [1]/0

Requires Vim to be compiled with
+balloon_eval
support.

g:compil_hints.use_signs

Activates the display of signs -- boolean: [1]/0

Requires Vim to be compiled with
+signs support.

g:compil_hints.autostart

When sets, the plugin is automatically started -- boolean: [1]/0

Needs to be set in the .vimrc.

(bpg):compil_hints.context_re

Regular expression used to recognize and display differently messages like:

instantiated from
within this context
required from here

(bpg):compil_hints.harsh_signs_removal_enabled

Up to Vim 8.1.0613. This options becomes useless and is ignored afterward.

Improves greatly the time required to remove signs. However, this option does
remove all signs in a buffer, even the ones not placed by compil-hints.

boolean: 1/0; default: ! exists('*execute') => false with recent versions of
Vim

g:compil_hints.signs

Permits to specify which codepoints to use as sign characters depending on the
level:

  • error , defaults to ["\u274c", 'XX'] -- '❌', 'XX'
  • warning', defaults to ["\u26a0", "\u26DB", '!!'] -- '⚠', '⛛', '!!'
  • note' , defaults to ["\u2139", "\U1F6C8", 'ii'] -- 'ℹ', '🛈', 'ii'
  • context', defaults to ['>>']
  • info' , defaults to ["\u27a9", '->'] -- '➩', '->'

This feature is used only when:

  • 'guifont' is
    available (i.e. in graphical sessions),
  • and when gvim doesn't support
    +xpm -- Pixmap

support has the precedence.

  • and when the Python module python-config can be used.

Otherwise, the last value in each list will be used. IOW, if you know that the
font you use in your terminal always support \u274c, you can simply define in
your .vimrc (only!).

" Manually
:let g:compil_hints             = get(g:, 'compil_hints', {'signs': {}})
:let g:compil_hints.signs       = get(g:compil_hints, 'signs', {})
:let g:compil_hints.signs.error = ["\u274c"] " ❌


" Or, thanks to lh-vim-lib
call lh#dict#let(g:, 'compil_hints.signs.error', ["\u274c"]) " ❌

" Or, still thanks to lh-vim-lib
runtime plugin/let.vim
:LetTo g:compil_hints.signs.error = ["\u274c"] " ❌

Needs to be set in the .vimrc.

g:compil_hints.hl

Permits to specify which
highlight group to
use depending on the level:

  • error , defaults to "error"
  • warning', defaults to "todo"
  • note' , defaults to "comment"
  • context', defaults to "constant"
  • info' , defaults to "todo"

Needs to be set in the .vimrc.

baloon format - v1.3.0

We can have a fine control on the actual balloon expression for each quick-fix
entry.

This is done by injecting a lambda (or more precisally an expression passed
as the second parameter to
map()). The lambda is
applied to the items returned by
getqflist().

Note: Unlike other times, the key variable
(v:key) cannot be used

  1. Instead, its value can be checked in v:val.key.

Example: In lh-cpp implementation of :Ancestors command I do the

  1. Given l:balloons that contains the list of the exact text to
  2. for each quickfix item, I execute:
if lh#has#properties_in_qf()
call setqflist([], 'a', {'title': current.name . ' base classes'})
    if lh#has#plugin('autoload/lh/compil_hints.vim')
      call lh#compil_hints#set_balloon_format({k, v -> l:current.name . l:balloons[v.key]})
    endif
endif

Requirements / Installation

  • Requirements: Vim 7.2.295+,
    +balloon_eval,
    +signs,
    lh-vim-lib 4.5.1.
    Starting with Vim 8.1.0614+ plugin performances should greatly improve.
  • With vim-addon-manager, install vim-compil-hints.

    ActivateAddons vim-compil-hints
  • or with vim-flavor which also supports
    dependencies:

    flavor 'LucHermitte/vim-compil-hints'
  • or with Vundle/NeoBundle (expecting I haven't forgotten anything):

    Bundle 'LucHermitte/lh-vim-lib'
    Bundle 'LucHermitte/vim-compil-hints'

TO DO

  • Handle local options for balloon use: use/restore b:bexpr
  • Ask fontconfig fc-list, when recent enough, which UTF-8 codepoints could be used -> lh-vim-lib
  • Check the behaviour with encodings other than UTF-8.
  • WIP: Permit to inject a different text to display in balloons (in grepping cases)
  • Add a real option to inject linehl to signs
  • Clean cached contexts from qf list no longer available with c:older
  • When the qf-list isn't opened automatically at the end of the compilation,
    it's more tricky to remove the signs as :cclose doesn't do anything.
  • Continue to improve the speed of s:ReduceQFList -- which is the slowest
    function of the plugin along with s:WorksType

Notes and other implementation details

  • It doesn't copy getqflist() for balloon, but always fetch the last version
    in order to automagically rely on vim to update the line numbers.

History

  • V 1.3.0

    • Add control over balloon format
  • V 1.1.1

    • Improve sign placing and unplacing speed
  • V 1.1.0.

    • Automatically activate the signs and balloons on quickfix related
      commands, whether the compilation is synchronous or asynchronous.
    • Improve style options
    • Distinguish enabled and activated states
    • Improve performances depending on whether the qf list is filled
      asynchronously or not
    • Balloons are filled differently quickfix list contain grep result
    • Keep track of context when navigating through qf history with :cnewer &
      all, with versions of vim recent enough (> v 7.4-2200)
  • V 1.0.1.

    • Detect when XPM icons cannot be used.
    • Use the first UTF-8 glyphs
  • V 1.0.0.

    • The XPM icons used come from Vim source code, they're under
      Vim License.
    • Options have been renamed from compil_hint_xxx to compil_hints.xxx
  • V 0.2.x.

    • This plugin is strongly inspired by syntastic, but it restricts its work to
    1. result of the compilation.

添加新评论