-
Notifications
You must be signed in to change notification settings - Fork 102
/
tcomment.vim
295 lines (257 loc) · 14.7 KB
/
tcomment.vim
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
" tComment.vim -- An easily extensible & universal comment plugin
" @Author: Tom Link (micathom AT gmail com)
" @License: GPL (see http://www.gnu.org/licenses/gpl.txt)
" @Created: 27-Dez-2004.
" @Last Change: 2022-11-05.
" @Revision: 1001
" GetLatestVimScripts: 1173 1 tcomment.vim
if &cp || exists('loaded_tcomment')
finish
endif
let loaded_tcomment = 400
let s:save_cpo = &cpo
set cpo&vim
call tcomment#deprecated#Check()
if !exists('g:tcomment_maps')
" If true, set maps.
let g:tcomment_maps = 1 "{{{2
endif
if !exists("g:tcomment_mapleader1")
" g:tcomment_mapleader1 should be a shortcut that can be used with
" map, imap, vmap.
let g:tcomment_mapleader1 = '<c-_>' "{{{2
endif
if !exists("g:tcomment_mapleader2")
" g:tcomment_mapleader2 should be a shortcut that can be used with
" map, xmap.
let g:tcomment_mapleader2 = '<Leader>_' "{{{2
endif
if !exists("g:tcomment_opleader1")
" See |tcomment-operator|.
let g:tcomment_opleader1 = 'gc' "{{{2
endif
if !exists("g:tcomment_mapleader_uncomment_anyway")
" See |tcomment-operator|.
let g:tcomment_mapleader_uncomment_anyway = 'g<' "{{{2
endif
if !exists("g:tcomment_mapleader_comment_anyway")
" See |tcomment-operator|.
let g:tcomment_mapleader_comment_anyway = 'g>' "{{{2
endif
if !exists('g:tcomment_map_modifier')
" Use map modifiers like |:map-<silent>|.
let g:tcomment_map_modifier = '<silent>' "{{{2
endif
if !exists('g:tcomment_opmap_modifier')
" Use map modifiers like |:map-<silent>| for operators.
let g:tcomment_opmap_modifier = '<silent>' "{{{2
endif
if !exists('g:tcomment_textobject_inlinecomment')
let g:tcomment_textobject_inlinecomment = 'ic' "{{{2
endif
" :display: :[range]TComment[!] ?ARGS...
" If there is a visual selection that begins and ends in the same line,
" then |:TCommentInline| is used instead.
" The optional range defaults to the current line. With a bang '!',
" always comment the line.
"
" ARGS... are either (see also |tcomment#Comment()|):
" 1. a list of key=value pairs
" 2. 1-2 values for: ?commentBegin, ?commentEnd
command! -bar -bang -range -nargs=* -complete=customlist,tcomment#complete#Args TComment
\ keepjumps call tcomment#Comment(<line1>, <line2>, 'G', "<bang>", <f-args>)
" :display: :[range]TCommentAs[!] commenttype ?ARGS...
" TCommentAs requires g:tcomment_{filetype} to be defined.
" With a bang '!', always comment the line.
"
" ARGS... are either (see also |tcomment#Comment()|):
" 1. a list of key=value pairs
" 2. 1-2 values for: ?commentBegin, ?commentEnd
command! -bar -bang -complete=customlist,tcomment#complete#Complete -range -nargs=+ TCommentAs
\ call tcomment#CommentAs(<line1>, <line2>, "<bang>", <f-args>)
" :display: :[range]TCommentRight[!] ?ARGS...
" Comment the text to the right of the cursor. If a visual selection was
" made (be it block-wise or not), all lines are commented out at from
" the current cursor position downwards.
" With a bang '!', always comment the line.
"
" ARGS... are either (see also |tcomment#Comment()|):
" 1. a list of key=value pairs
" 2. 1-2 values for: ?commentBegin, ?commentEnd
command! -bar -bang -range -nargs=* -complete=customlist,tcomment#complete#Args TCommentRight
\ keepjumps call tcomment#Comment(<line1>, <line2>, 'R', "<bang>", <f-args>)
" :display: :[range]TCommentBlock[!] ?ARGS...
" Comment as "block", e.g. use the {&ft}_block comment style. The
" commented text isn't indented or reformated.
" With a bang '!', always comment the line.
"
" ARGS... are either (see also |tcomment#Comment()|):
" 1. a list of key=value pairs
" 2. 1-2 values for: ?commentBegin, ?commentEnd
command! -bar -bang -range -nargs=* -complete=customlist,tcomment#complete#Args TCommentBlock
\ keepjumps call tcomment#Comment(<line1>, <line2>, 'B', "<bang>", <f-args>)
" :display: :[range]TCommentInline[!] ?ARGS...
" Use the {&ft}_inline comment style.
" With a bang '!', always comment the line.
"
" ARGS... are either (see also |tcomment#Comment()|):
" 1. a list of key=value pairs
" 2. 1-2 values for: ?commentBegin, ?commentEnd
command! -bar -bang -range -nargs=* -complete=customlist,tcomment#complete#Args TCommentInline
\ keepjumps call tcomment#Comment(<line1>, <line2>, 'I', "<bang>", <f-args>)
" :display: :[range]TCommentMaybeInline[!] ?ARGS...
" With a bang '!', always comment the line.
"
" ARGS... are either (see also |tcomment#Comment()|):
" 1. a list of key=value pairs
" 2. 1-2 values for: ?commentBegin, ?commentEnd
command! -bar -bang -range -nargs=* -complete=customlist,tcomment#complete#Args TCommentMaybeInline
\ keepjumps call tcomment#Comment(<line1>, <line2>, 'i', "<bang>", <f-args>)
" command! -range TCommentMap call tcomment#ResetOption() | <args>
noremap <Plug>TComment_<c-_><c-_> :TComment<cr>
vnoremap <Plug>TComment_<c-_><c-_> :TCommentMaybeInline<cr>
inoremap <Plug>TComment_<c-_><c-_> <c-o>:TComment<cr>
noremap <Plug>TComment_<c-_>p m`vip:TComment<cr>``
inoremap <Plug>TComment_<c-_>p <c-o>:norm! m`vip<cr>:TComment<cr><c-o>``
noremap <Plug>TComment_<c-_><space> :TComment
inoremap <Plug>TComment_<c-_><space> <c-o>:TComment
inoremap <Plug>TComment_<c-_>r <c-o>:TCommentRight<cr>
noremap <Plug>TComment_<c-_>r :TCommentRight<cr>
vnoremap <Plug>TComment_<c-_>i :TCommentInline<cr>
noremap <Plug>TComment_<c-_>i v:TCommentInline mode=I#<cr>
inoremap <Plug>TComment_<c-_>i <c-\><c-o>v:TCommentInline mode=#<cr>
noremap <Plug>TComment_<c-_>b :TCommentBlock<cr>
inoremap <Plug>TComment_<c-_>b <c-\><c-o>:TCommentBlock mode=#<cr>
noremap <Plug>TComment_<c-_>a :TCommentAs
inoremap <Plug>TComment_<c-_>a <c-o>:TCommentAs
noremap <Plug>TComment_<c-_>n :TCommentAs <c-r>=&ft<cr>
inoremap <Plug>TComment_<c-_>n <c-o>:TCommentAs <c-r>=&ft<cr>
noremap <Plug>TComment_<c-_>s :TCommentAs <c-r>=&ft<cr>_
inoremap <Plug>TComment_<c-_>s <c-o>:TCommentAs <c-r>=&ft<cr>_
noremap <Plug>TComment_<c-_>cc :<c-u>call tcomment#SetOption("count", v:count1)<cr>
noremap <Plug>TComment_<c-_>ca :<c-u>call tcomment#SetOption("as", input("Comment as: ", &filetype, "customlist,tcomment#complete#Complete"))<cr>
noremap <Plug>TComment_<Leader>__ :TComment<cr>
xnoremap <Plug>TComment_<Leader>__ :TCommentMaybeInline<cr>
noremap <Plug>TComment_<Leader>_p vip:TComment<cr>
noremap <Plug>TComment_<Leader>_<space> :TComment
xnoremap <Plug>TComment_<Leader>_i :TCommentInline<cr>
noremap <Plug>TComment_<Leader>_r :TCommentRight<cr>
noremap <Plug>TComment_<Leader>_b :TCommentBlock<cr>
noremap <Plug>TComment_<Leader>_a :TCommentAs
noremap <Plug>TComment_<Leader>_n :TCommentAs <c-r>=&ft<cr>
noremap <Plug>TComment_<Leader>_s :TCommentAs <c-r>=&ft<cr>_
function! s:MapOpPlug(name, extra, op, invoke) "{{{3
let opfunc = 'TCommentOpFunc_'. substitute(a:name, '[^a-zA-Z0-9_]', '_', 'G')
let fn = [
\ 'function! '. opfunc .'(...)',
\ 'call tcomment#MaybeReuseOptions('. string(opfunc) .')',
\ a:extra,
\ 'return call('. string(a:op) .', a:000)',
\ 'endf'
\ ]
exec join(fn, "\n")
exec printf('nnoremap <Plug>TComment_%s '.
\ ':<c-u>call tcomment#ResetOption() \| if v:count > 0 \| call tcomment#SetOption("count", v:count) \| endif \| let w:tcommentPos = getpos(".") \|'.
\ 'set opfunc=%s<cr>%s',
\ a:name, opfunc, a:invoke)
endf
call s:MapOpPlug('Uncomment', 'call tcomment#SetOption("mode_extra", "U")', 'tcomment#operator#Op', 'g@')
call s:MapOpPlug('Uncommentc', 'call tcomment#SetOption("mode_extra", "U")', 'tcomment#operator#Line', 'g@$')
call s:MapOpPlug('Uncommentb', 'call tcomment#SetOption("mode_extra", "UB")', 'tcomment#operator#Line', 'g@')
xnoremap <Plug>TComment_Uncomment :<c-u>if v:count > 0 \| call tcomment#SetOption("count", v:count) \| endif \| call tcomment#SetOption("mode_extra", "U") \| '<,'>TCommentMaybeInline<cr>
call s:MapOpPlug('Comment', '', 'tcomment#operator#Anyway', 'g@')
call s:MapOpPlug('Commentl', '', 'tcomment#operator#Line', 'g@$')
call s:MapOpPlug('Commentc', '', 'tcomment#operator#LineAnyway', 'g@$')
call s:MapOpPlug('Commentb', 'call tcomment#SetOption("mode_extra", "B")', 'tcomment#operator#Line', 'g@')
xnoremap <Plug>TComment_Comment :<c-u>if v:count > 0 \| call tcomment#SetOption("count", v:count) \| endif \| '<,'>TCommentMaybeInline!<cr>
vnoremap <Plug>TComment_ic :<c-U>call tcomment#textobject#InlineComment()<cr>
noremap <Plug>TComment_ic :<c-U>call tcomment#textobject#InlineComment()<cr>
call s:MapOpPlug('gcc', '', 'tcomment#operator#Line', 'g@$')
call s:MapOpPlug('gcb', 'call tcomment#SetOption("mode_extra", "B")', 'tcomment#operator#Line', 'g@')
xnoremap <Plug>TComment_gc :TCommentMaybeInline<cr>
call s:MapOpPlug('gc', '', 'tcomment#operator#Op', 'g@')
call s:MapOpPlug('gC', '', 'tcomment#operator#Line', 'g@')
for s:i in range(1, 9)
exec 'noremap <Plug>TComment_<c-_>' . s:i . ' :call tcomment#SetOption("count", '. s:i .')<cr>'
exec 'inoremap <Plug>TComment_<c-_>' . s:i . ' <c-\><c-o>:call tcomment#SetOption("count", '. s:i .')<cr>'
exec 'vnoremap <Plug>TComment_<c-_>' . s:i . ' :call tcomment#SetOption("count", '. s:i .')<cr>'
endfor
for s:i in range(1, 9)
call s:MapOpPlug('gc' . s:i .'c', 'call tcomment#SetOption("count", '. s:i .')', 'tcomment#operator#Op', 'g@')
endfor
unlet s:i
delfun s:MapOpPlug
if g:tcomment_maps
if g:tcomment_mapleader1 != ''
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader1 . g:tcomment_mapleader1 .' <Plug>TComment_<c-_><c-_>'
exec 'vmap' g:tcomment_map_modifier g:tcomment_mapleader1 . g:tcomment_mapleader1 .' <Plug>TComment_<c-_><c-_>'
exec 'imap' g:tcomment_map_modifier g:tcomment_mapleader1 . g:tcomment_mapleader1 .' <Plug>TComment_<c-_><c-_>'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader1 .'p <Plug>TComment_<c-_>p'
exec 'imap' g:tcomment_map_modifier g:tcomment_mapleader1 .'p <Plug>TComment_<c-_>p'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader1 .'<space> <Plug>TComment_<c-_><space>'
exec 'imap' g:tcomment_map_modifier g:tcomment_mapleader1 .'<space> <Plug>TComment_<c-_><space>'
exec 'imap' g:tcomment_map_modifier g:tcomment_mapleader1 .'r <Plug>TComment_<c-_>r'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader1 .'r <Plug>TComment_<c-_>r'
exec 'vmap' g:tcomment_map_modifier g:tcomment_mapleader1 .'i <Plug>TComment_<c-_>i'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader1 .'i <Plug>TComment_<c-_>i'
exec 'imap' g:tcomment_map_modifier g:tcomment_mapleader1 .'i <Plug>TComment_<c-_>i'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader1 .'b <Plug>TComment_<c-_>b'
exec 'imap' g:tcomment_map_modifier g:tcomment_mapleader1 .'b <Plug>TComment_<c-_>b'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader1 .'a <Plug>TComment_<c-_>a'
exec 'imap' g:tcomment_map_modifier g:tcomment_mapleader1 .'a <Plug>TComment_<c-_>a'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader1 .'n <Plug>TComment_<c-_>n'
exec 'imap' g:tcomment_map_modifier g:tcomment_mapleader1 .'n <Plug>TComment_<c-_>n'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader1 .'s <Plug>TComment_<c-_>s'
exec 'imap' g:tcomment_map_modifier g:tcomment_mapleader1 .'s <Plug>TComment_<c-_>s'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader1 .'cc <Plug>TComment_<c-_>cc'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader1 .'ca <Plug>TComment_<c-_>ca'
for s:i in range(1, 9)
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader1 . s:i .' <Plug>TComment_<c-_>'.s:i
exec 'imap' g:tcomment_map_modifier g:tcomment_mapleader1 . s:i .' <Plug>TComment_<c-_>'.s:i
exec 'vmap' g:tcomment_map_modifier g:tcomment_mapleader1 . s:i .' <Plug>TComment_<c-_>'.s:i
endfor
unlet s:i
endif
if g:tcomment_mapleader2 != ''
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader2 .'_ <Plug>TComment_<Leader>__'
exec 'xmap' g:tcomment_map_modifier g:tcomment_mapleader2 .'_ <Plug>TComment_<Leader>__'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader2 .'p <Plug>TComment_<Leader>_p'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader2 .'<space> <Plug>TComment_<Leader>_<space>'
exec 'xmap' g:tcomment_map_modifier g:tcomment_mapleader2 .'i <Plug>TComment_<Leader>_i'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader2 .'r <Plug>TComment_<Leader>_r'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader2 .'b <Plug>TComment_<Leader>_b'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader2 .'a <Plug>TComment_<Leader>_a'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader2 .'n <Plug>TComment_<Leader>_n'
exec 'map' g:tcomment_map_modifier g:tcomment_mapleader2 .'s <Plug>TComment_<Leader>_s'
endif
if g:tcomment_opleader1 != ''
exec 'nmap' g:tcomment_opmap_modifier g:tcomment_opleader1 .' <Plug>TComment_gc'
for s:i in range(1, 9)
exec 'nmap' g:tcomment_opmap_modifier g:tcomment_opleader1 . s:i .' <Plug>TComment_gc'.s:i
exec 'nmap' g:tcomment_opmap_modifier g:tcomment_opleader1 . s:i .'c <Plug>TComment_gc'.s:i.'c'
endfor
unlet s:i
exec 'nmap' g:tcomment_opmap_modifier g:tcomment_opleader1 .'c <Plug>TComment_gcc'
exec 'nmap' g:tcomment_opmap_modifier g:tcomment_opleader1 .'b <Plug>TComment_gcb'
exec 'xmap' g:tcomment_opmap_modifier g:tcomment_opleader1 .' <Plug>TComment_gc'
endif
if g:tcomment_mapleader_uncomment_anyway != ''
exec 'nmap' g:tcomment_map_modifier g:tcomment_mapleader_uncomment_anyway .' <Plug>TComment_Uncomment'
exec 'nmap' g:tcomment_map_modifier g:tcomment_mapleader_uncomment_anyway .'c <Plug>TComment_Uncommentc'
exec 'nmap' g:tcomment_map_modifier g:tcomment_mapleader_uncomment_anyway .'b <Plug>TComment_Uncommentb'
exec 'xmap' g:tcomment_map_modifier g:tcomment_mapleader_uncomment_anyway .' <Plug>TComment_Uncomment'
endif
if g:tcomment_mapleader_comment_anyway != ''
exec 'nmap' g:tcomment_map_modifier g:tcomment_mapleader_comment_anyway .' <Plug>TComment_Comment'
exec 'nmap' g:tcomment_map_modifier g:tcomment_mapleader_comment_anyway .'c <Plug>TComment_Commentc'
exec 'nmap' g:tcomment_map_modifier g:tcomment_mapleader_comment_anyway .'b <Plug>TComment_Commentb'
exec 'xmap' g:tcomment_map_modifier g:tcomment_mapleader_comment_anyway .' <Plug>TComment_Comment'
endif
if g:tcomment_textobject_inlinecomment != ''
exec 'vmap' g:tcomment_map_modifier g:tcomment_textobject_inlinecomment ' <Plug>TComment_ic'
exec 'omap' g:tcomment_map_modifier g:tcomment_textobject_inlinecomment ' <Plug>TComment_ic'
endif
endif
let &cpo = s:save_cpo
unlet s:save_cpo
" vi: ft=vim:tw=72:ts=4:fo=w2croql