Skip to content
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

Global variables override by buffer variables (#80) #137

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Global variables override by buffer variables (#80) #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8bfe2ad
Global variables override by buffer variables
rockandska Dec 19, 2018
56063b1
Fix override on vim startup
rockandska Dec 20, 2018
6cffc17
fix(getvar): index_guides_ add to var in lookup
rockandska Feb 24, 2023
30ce443
fix: lint
rockandska Feb 24, 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
53 changes: 30 additions & 23 deletions autoload/indent_guides.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,18 @@ endfunction
" other buffers and windows.
"
function! indent_guides#process_autocmds() abort
if g:indent_guides_autocmds_enabled
if indent_guides#getvar('enable_on_vim_startup')
call indent_guides#enable()
else
call indent_guides#disable()
end
endfunction

"
" Enables the indent guides for the current buffer and any other buffer upon
" entering it.
" Enables the indent guides for the current buffer
"
function! indent_guides#enable() abort
let g:indent_guides_autocmds_enabled = 1
let b:indent_guides_enable_on_vim_startup = 1

if &diff || indent_guides#exclude_filetype()
call indent_guides#clear_matches()
Expand All @@ -49,11 +48,11 @@ function! indent_guides#enable() abort
let l:column_start = (l:level - 1) * s:indent_size + 1

" define the higlight patterns and add to matches list
if g:indent_guides_space_guides
let l:soft_pattern = indent_guides#indent_highlight_pattern(g:indent_guides_soft_pattern, l:column_start, s:guide_size)
if indent_guides#getvar('space_guides')
let l:soft_pattern = indent_guides#indent_highlight_pattern(indent_guides#getvar('soft_pattern'), l:column_start, s:guide_size)
call add(w:indent_guides_matches, matchadd(l:group, l:soft_pattern))
end
if g:indent_guides_tab_guides
if indent_guides#getvar('tab_guides')
let l:hard_pattern = indent_guides#indent_highlight_pattern('\t', l:column_start, s:indent_size)
call add(w:indent_guides_matches, matchadd(l:group, l:hard_pattern))
end
Expand All @@ -65,7 +64,7 @@ endfunction
" entering it.
"
function! indent_guides#disable() abort
let g:indent_guides_autocmds_enabled = 0
let b:indent_guides_enable_on_vim_startup = 0
call indent_guides#clear_matches()
endfunction

Expand Down Expand Up @@ -201,19 +200,19 @@ function! indent_guides#init_script_vars() abort
let s:hi_normal = substitute(s:hi_normal, ' font=[A-Za-z0-9:]\+', '', '')

" shortcuts to the global variables - this makes the code easier to read
let s:debug = g:indent_guides_debug
let s:indent_levels = g:indent_guides_indent_levels
let s:auto_colors = g:indent_guides_auto_colors
let s:color_hex_pat = g:indent_guides_color_hex_pattern
let s:color_hex_bg_pat = g:indent_guides_color_hex_guibg_pattern
let s:color_name_bg_pat = g:indent_guides_color_name_guibg_pattern
let s:start_level = g:indent_guides_start_level
let s:debug = indent_guides#getvar('debug')
let s:indent_levels = indent_guides#getvar('indent_levels')
let s:auto_colors = indent_guides#getvar('auto_colors')
let s:color_hex_pat = indent_guides#getvar('color_hex_pattern')
let s:color_hex_bg_pat = indent_guides#getvar('color_hex_guibg_pattern')
let s:color_name_bg_pat = indent_guides#getvar('color_name_guibg_pattern')
let s:start_level = indent_guides#getvar('start_level')

" str2float not available in vim versions <= 7.1
if has('float')
let s:change_percent = g:indent_guides_color_change_percent / str2float('100.0')
let s:change_percent = indent_guides#getvar('color_change_percent') / str2float('100.0')
else
let s:change_percent = g:indent_guides_color_change_percent / 100.0
let s:change_percent = indent_guides#getvar('color_change_percent') / 100.0
endif

if s:debug
Expand All @@ -237,7 +236,7 @@ endfunction
" NOTE: Currently, this only works when soft-tabs are being used.
"
function! indent_guides#calculate_guide_size() abort
let l:guide_size = g:indent_guides_guide_size
let l:guide_size = indent_guides#getvar('guide_size')

if l:guide_size == 0 || l:guide_size > s:indent_size
let l:guide_size = s:indent_size
Expand Down Expand Up @@ -281,15 +280,23 @@ endfunction
" Detect if any of the buffer filetypes should be excluded.
"
function! indent_guides#exclude_filetype() abort
if exists('g:indent_guides_exclude_buftype')
if g:indent_guides_exclude_buftype && &buftype !=# ''
return 1
endif
if indent_guides#getvar('exclude_buftype') && &buftype !=# ''
return 1
endif
for ft in split(&ft, '\.', 1)
if index(g:indent_guides_exclude_filetypes, ft) > -1
if index(indent_guides#getvar('exclude_filetypes'), ft) > -1
return 1
end
endfor
return 0
endfunction

"
" Return variables value
" Choose local buffer variable first if exist or global variable if not
" return -1 if none of local buffer / global variable exists
"
function! indent_guides#getvar(var) abort
let l:varName = 'indent_guides_' . a:var
return get(b:, l:varName, get(g:, l:varName, -1))
endfunction
11 changes: 10 additions & 1 deletion doc/indent_guides.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,14 @@ Features:~
==============================================================================
3. OPTIONS *indent-guides-options*

All options described bellow could be used at buffer level if needed without
cluttering the other windows / buffers. The buffer variables could be used for
example to change only settings for particular filetype with ftplugin files.

Example (in ~/vim/ftplugin/sh.vim):
>
let b:indent_guides_indent_levels = 50
<
------------------------------------------------------------------------------
*'indent_guides_indent_levels'*
Use this option to control how many indent levels to display guides for.
Expand Down Expand Up @@ -163,7 +171,8 @@ Default: '\s'. Values: Vim regexp.

------------------------------------------------------------------------------
*'indent_guides_enable_on_vim_startup'*
Use this option to control whether the plugin is enabled on Vim startup.
Use this option to control whether the plugin is enabled on Vim startup and
future buffers.

Default: 0. Values: 0 or 1.
>
Expand Down
5 changes: 0 additions & 5 deletions plugin/indent_guides.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ function s:InitVariable(var, value)
endfunction

" Fixed global variables
let g:indent_guides_autocmds_enabled = 0
let g:indent_guides_color_hex_pattern = '#[0-9A-Fa-f]\{6\}'
let g:indent_guides_color_hex_guibg_pattern = 'guibg=\zs' . g:indent_guides_color_hex_pattern . '\ze'
let g:indent_guides_color_name_guibg_pattern = "guibg='\\?\\zs[0-9A-Za-z ]\\+\\ze'\\?"
Expand Down Expand Up @@ -81,10 +80,6 @@ nnoremap <unique><script> <Plug>IndentGuidesDisable :IndentGuidesDisable<CR>
augroup indent_guides
autocmd!

if g:indent_guides_enable_on_vim_startup
autocmd VimEnter * :IndentGuidesEnable
endif

autocmd BufEnter,WinEnter,FileType * call indent_guides#process_autocmds()
if (v:version == 704 && has('patch786')) || (v:version > 704)
autocmd OptionSet tabstop,shiftwidth,expandtab call indent_guides#process_autocmds()
Expand Down