adam/vim
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

patch 9.1.1229: the comment plugin can be improved

Browse Source 
Problem:  the comment plugin can be improved
Solution: add comment text objects "ic" and "ac"
          (Maxim Kim)

closes: #16938

Signed-off-by: Maxim Kim <habamax@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Maxim Kim
2025-03-21 18:02:56 +01:00
committed by Christian Brabandt
parent 51a06ecee0
commit 9712a2534f
6 changed files with 451 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
runtime/pack/dist/opt/comment/autoload/comment.vim vendored
View File

@ -1,7 +1,7 @@
vim9script
# Maintainer: Maxim Kim <habamax@gmail.com>
# Last Update: 2024 Oct 05
# Last Update: 2025 Mar 21
#
# Toggle comments
# Usage:
@ -76,3 +76,88 @@ export def Toggle(...args: list<string>): string
noautocmd keepjumps setline(lnum1, lines)
return ''
enddef
# Comment text object
# Usage:
# import autoload 'dist/comment.vim'
# onoremap <silent>ic <scriptcmd>comment.ObjComment(v:true)<CR>
# onoremap <silent>ac <scriptcmd>comment.ObjComment(v:false)<CR>
# xnoremap <silent>ic <esc><scriptcmd>comment.ObjComment(v:true)<CR>
# xnoremap <silent>ac <esc><scriptcmd>comment.ObjComment(v:false)<CR>
export def ObjComment(inner: bool)
def IsComment(): bool
var stx = map(synstack(line('.'), col('.')), 'synIDattr(v:val, "name")')->join()
return stx =~? 'Comment'
enddef
# requires syntax support
if !exists("g:syntax_on")
return
endif
var pos_init = getcurpos()
# If not in comment, search next one,
if !IsComment()
if search('\v\k+', 'W', line(".") + 100, 100, () => !IsComment()) <= 0
return
endif
endif
# Search for the beginning of the comment block
if IsComment()
if search('\v%(\S+)|$', 'bW', 0, 200, IsComment) > 0
search('\v%(\S)|$', 'W', 0, 200, () => !IsComment())
else
cursor(1, 1)
search('\v\S+', 'cW', 0, 200)
endif
endif
var pos_start = getcurpos()
if !inner
var col = pos_start[2]
var prefix = getline(pos_start[1])[ : col - 2]
while col > 0 && prefix[col - 2] =~ '\s'
col -= 1
endwhile
pos_start[2] = col
endif
# Search for the comment end.
if pos_init[1] > pos_start[1]
cursor(pos_init[1], pos_init[2])
endif
if search('\v%(\S+)|$', 'W', 0, 200, IsComment) > 0
search('\S', 'beW', 0, 200, () => !IsComment())
else
if search('\%$', 'W', 0, 200) > 0
search('\ze\S', 'beW', 0, 200, () => !IsComment())
endif
endif
var pos_end = getcurpos()
if !inner
var spaces = matchstr(getline(pos_end[1]), '\%>.c\s*')
pos_end[2] += spaces->len()
if getline(pos_end[1])[pos_end[2] : ] =~ '^\s*$'
&& (pos_start[2] == 1 || getline(pos_start[1])[ : pos_start[2]] =~ '^\s*$')
if search('\v\s*\_$(\s*\n)+', 'eW', 0, 200) > 0
pos_end = getcurpos()
endif
endif
endif
if (pos_end[2] == (getline(pos_end[1])->len() ?? 1)) && pos_start[2] == 1
cursor(pos_end[1], 1)
normal! V
cursor(pos_start[1], 1)
else
cursor(pos_end[1], pos_end[2])
normal! v
cursor(pos_start[1], pos_start[2])
endif
enddef