/
tcomment.vim
2172 lines (2025 loc) · 81.3 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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
" @Author: Tom Link (mailto:micathom AT gmail com?subject=[vim])
" @Website: http://www.vim.org/account/profile.php?user_id=4037
" @License: GPL (see http://www.gnu.org/licenses/gpl.txt)
" @Created: 2007-09-17.
" @Last Change: 2015-08-11.
" @Revision: 1760
" call tlog#Log('Load: '. expand('<sfile>')) " vimtlib-sfile
if !exists("g:tcomment#blank_lines")
" If 1, comment blank lines too.
" If 2, also comment blank lines within indented code blocks
" (requires mixedindent -- see |tcomment#Comment()|).
let g:tcomment#blank_lines = 2 "{{{2
endif
if !exists('g:tcomment#rstrip_on_uncomment')
" If 1, remove right-hand whitespace on uncomment from empty lines.
" If 2, remove right-hand whitespace on uncomment from all lines.
let g:tcomment#rstrip_on_uncomment = 1 "{{{2
endif
if !exists("g:tcommentModeExtra")
" Modifies how commenting works.
" > ... Move the cursor to the end of the comment
" >> ... Like above but move the cursor to the next line
" # ... Move the cursor to the position of the commented text
" (NOTE: this only works when creating empty comments using
" |:TCommentInline| from normal or insert mode and should
" not be set here as a global option.)
let g:tcommentModeExtra = '' "{{{2
endif
if !exists("g:tcommentOpModeExtra")
" Modifies how the operator works.
" See |g:tcommentModeExtra| for a list of possible values.
let g:tcommentOpModeExtra = '' "{{{2
endif
if !exists('g:tcommentOptions')
" Other key-value options used by |tcomment#Comment()|.
"
" Example: If you want to put the opening comment marker always in
" the first column regardless of the block's indentation, put this
" into your |vimrc| file: >
" let g:tcommentOptions = {'col': 1}
let g:tcommentOptions = {} "{{{2
endif
if !exists('g:tcomment#options_comments')
" Additional args for |tcomment#Comment()| when using the 'comments'
" option.
let g:tcomment#options_comments = {'whitespace': get(g:tcommentOptions, 'whitespace', 'both')} "{{{2
endif
if !exists('g:tcomment#options_commentstring')
" Additional args for |tcomment#Comment()| when using the
" 'commentstring' option.
let g:tcomment#options_commentstring = {'whitespace': get(g:tcommentOptions, 'whitespace', 'both')} "{{{2
endif
if !exists('g:tcomment#ignore_char_type')
" |text-objects| for use with |tcomment#Operator| can have different
" types: line, block, char etc. Text objects like aB, it, at etc.
" have type char but this may not work reliably. By default,
" tcomment handles those text objects most often as if they were of
" type line. Set this variable to 0 in order to change this
" behaviour. Be prepared that the result may not always match your
" intentions.
let g:tcomment#ignore_char_type = 1 "{{{2
endif
if !exists("g:tcommentGuessFileType")
" Guess the file type based on syntax names always or for some fileformat only
" If non-zero, try to guess filetypes.
" tcomment also checks g:tcommentGuessFileType_{&filetype} for
" filetype specific values.
"
" Values:
" 0 ... don't guess
" 1 ... guess
" FILETYPE ... assume this filetype
let g:tcommentGuessFileType = 0 "{{{2
endif
if !exists("g:tcommentGuessFileType_dsl")
" For dsl documents, assume filetype = xml.
let g:tcommentGuessFileType_dsl = 'xml' "{{{2
endif
if !exists("g:tcommentGuessFileType_php")
" In php documents, the php part is usually marked as phpRegion. We
" thus assume that the buffers default comment style isn't php but
" html.
let g:tcommentGuessFileType_php = 'html' "{{{2
endif
if !exists("g:tcommentGuessFileType_blade")
" See |g:tcommentGuessFileType_php|.
let g:tcommentGuessFileType_blade = 'html' "{{{2
endif
if !exists("g:tcommentGuessFileType_html")
let g:tcommentGuessFileType_html = 1 "{{{2
endif
if !exists("g:tcommentGuessFileType_tskeleton")
let g:tcommentGuessFileType_tskeleton = 1 "{{{2
endif
if !exists("g:tcommentGuessFileType_vim")
let g:tcommentGuessFileType_vim = 1 "{{{2
endif
if !exists("g:tcommentGuessFileType_django")
let g:tcommentGuessFileType_django = 1 "{{{2
endif
if !exists("g:tcommentGuessFileType_eruby")
let g:tcommentGuessFileType_eruby = 1 "{{{2
endif
if !exists("g:tcommentGuessFileType_jinja")
let g:tcommentGuessFileType_jinja = 'html' "{{{2
endif
if !exists("g:tcommentGuessFileType_smarty")
let g:tcommentGuessFileType_smarty = 1 "{{{2
endif
if !exists("g:tcommentGuessFileType_rnoweb")
let g:tcommentGuessFileType_rnoweb = 'r' "{{{2
endif
if !exists("g:tcommentIgnoreTypes_php")
" In php files, some syntax regions are wrongly highlighted as sql
" markup. We thus ignore sql syntax when guessing the filetype in
" php files.
let g:tcommentIgnoreTypes_php = 'sql' "{{{2
endif
if !exists('g:tcomment#syntax_substitute')
" :read: let g:tcomment#syntax_substitute = {...} "{{{2
" Perform replacements on the syntax name.
let g:tcomment#syntax_substitute = {
\ '\C^javaScript\ze\(\u\|$\)': {'sub': 'javascript'},
\ '\C^js\ze\(\u\|$\)': {'sub': 'javascript'}
\ }
endif
if !exists('g:tcomment#filetype_map')
" Keys must match the full |filetype|. Regexps must be |magic|. No
" regexp modifiers (like |\V|) are allowed.
" let g:tcomment#filetype_map = {...} "{{{2
let g:tcomment#filetype_map = {
\ 'rails-views': 'html',
\ 'mkd': 'html',
\ }
endif
if !exists('g:tcommentSyntaxMap')
" tcomment guesses filetypes based on the name of the current syntax
" region. This works well if the syntax names match
" /filetypeSomeName/. Other syntax names have to be explicitly
" mapped onto the corresponding filetype.
" :read: let g:tcommentSyntaxMap = {...} "{{{2
let g:tcommentSyntaxMap = {
\ 'erubyExpression': 'ruby',
\ 'vimMzSchemeRegion': 'scheme',
\ 'vimPerlRegion': 'perl',
\ 'vimPythonRegion': 'python',
\ 'vimRubyRegion': 'ruby',
\ 'vimTclRegion': 'tcl',
\ 'Delimiter': {
\ 'filetype': {
\ 'php': 'php',
\ },
\ },
\ 'phpRegionDelimiter': {
\ 'prevnonblank': [
\ {'match': '<?php', 'filetype': 'php'},
\ {'match': '?>', 'filetype': 'html'},
\ ],
\ 'nextnonblank': [
\ {'match': '?>', 'filetype': 'php'},
\ {'match': '<?php', 'filetype': 'html'},
\ ],
\ },
\ }
endif
if !exists('g:tcomment#replacements_c')
" Replacements for c filetype.
" :read: let g:tcomment#replacements_c = {...} "{{{2
let g:tcomment#replacements_c = {
\ '/*': '#<{(|',
\ '*/': '|)}>#',
\ }
endif
if !exists("g:tcommentLineC_fmt")
" Generic c-like block comments.
let g:tcommentLineC_fmt = {
\ 'commentstring_rx': '\%%(// %s\|/* %s */\)',
\ 'commentstring': '/* %s */',
\ 'rxbeg': '\*\+',
\ 'rxend': '',
\ 'rxmid': '',
\ 'replacements': g:tcomment#replacements_c
\ }
endif
function! tcomment#GetLineC(...)
let cmt = deepcopy(g:tcommentLineC_fmt)
if a:0 >= 1
let cmt.commentstring = a:1
endif
return cmt
endf
if !exists("g:tcommentInlineC")
" Generic c-like comments.
" :read: let g:tcommentInlineC = {...} "{{{2
let g:tcommentInlineC = tcomment#GetLineC()
endif
if !exists("g:tcommentBlockC")
let g:tcommentBlockC = {
\ 'commentstring': '/*%s */',
\ 'middle': ' * ',
\ 'rxbeg': '\*\+',
\ 'rxend': '',
\ 'rxmid': '',
\ 'replacements': g:tcomment#replacements_c
\ }
endif
if !exists("g:tcommentBlockC2")
" Generic c-like block comments (alternative markup).
" :read: let g:tcommentBlockC2 = {...} "{{{2
let g:tcommentBlockC2 = {
\ 'commentstring': '/**%s */',
\ 'middle': ' * ',
\ 'rxbeg': '\*\+',
\ 'rxend': '\*\+',
\ 'rxmid': '\*\+',
\ 'replacements': g:tcomment#replacements_c
\ }
endif
if !exists('g:tcomment#replacements_xml')
" Replacements for xml filetype.
" :read: let g:tcomment#replacements_xml = {...} "{{{2
let g:tcomment#replacements_xml = {
\ '-': '-',
\ '&': '&',
\ }
endif
if !exists("g:tcommentBlockXML")
" Generic xml-like block comments.
" :read: let g:tcommentBlockXML = {...} "{{{2
let g:tcommentBlockXML = {
\ 'commentstring': "<!--%s-->\n ",
\ 'replacements': g:tcomment#replacements_xml
\ }
endif
if !exists("g:tcommentInlineXML")
" Generic xml-like comments.
" :read: let g:tcommentInlineXML = {...} "{{{2
let g:tcommentInlineXML = {
\ 'commentstring': "<!-- %s -->",
\ 'replacements': g:tcomment#replacements_xml
\ }
endif
if !exists('g:tcomment#ignore_comment_def')
" A list of names or filetypes, which should be ignored by
" |tcomment#DefineType()| -- no custom comment definition will be
" stored for these names.
"
" This variable should be set before loading autoload/tcomment.vim.
let g:tcomment#ignore_comment_def = [] "{{{2
endif
if !exists('g:tcomment#must_escape_expression_backslash')
" Users of vim earlier than 7.3 might have to set this variable to
" true. Set this variable to 0, if you see unexpected "\r" char
" sequences in comments.
"
" The reommended value was `!(v:version > 702 || (v:version == 702 && has('patch407')))`.
" It is now assumed though, that no unpatched versions of vim are in
" use.
"
" References:
" Patch 7.2.407 when using :s with an expression backslashes are dropped
" https://github.com/tomtom/tcomment_vim/issues/102
let g:tcomment#must_escape_expression_backslash = 0 "{{{2
endif
let s:types_dirty = 1
let s:definitions = {}
" If you don't explicitly define a comment style, |:TComment| will use
" 'commentstring' instead. We override the default values here in order
" to have a blank after the comment marker. Block comments work only if
" we explicitly define the markup.
"
" NAME usually is a 'filetype'. You can use special suffixes to define
" special comment types. E.g. the name "FILETYPE_block" is used for
" block comments for 'filetype'. The name "FILETYPE_inline" is used for
" inline comments. If no specialized comment definition exists, the
" normal one with name "FILETYPE" is used.
"
" The comment definition can be either a string or a dictionary.
"
" If it is a string:
" The format for block comments is similar to 'commentstrings' with the
" exception that the format strings for blocks can contain a second line
" that defines how "middle lines" (see :h format-comments) should be
" displayed.
"
" Example: If the string is "--%s--\n-- ", lines will be commented as
" "--%s--" but the middle lines in block comments will be commented as
" "--%s".
"
" If it is a dictionary:
" See the help on the args argument of |tcomment#Comment| (see item 1,
" args is a list of key=value pairs) to find out which fields can be
" used.
" :display: tcomment#DefineType(name, commentdef, ?cdef={}, ?anyway=0)
function! tcomment#DefineType(name, commentdef, ...)
let basename = matchstr(a:name, '^[^_]\+')
let use = a:0 >= 2 ? a:2 : len(filter(copy(g:tcomment#ignore_comment_def), 'v:val == basename')) == 0
" TLogVAR a:name, use
if use
if type(a:commentdef) == 4
let cdef = copy(a:commentdef)
else
let cdef = a:0 >= 1 ? a:1 : {}
let cdef.commentstring = a:commentdef
endif
let s:definitions[a:name] = cdef
endif
let s:types_dirty = 1
endf
" Return the comment definition for NAME.
" *b:tcomment_def_{NAME}*
" Return b:tcomment_def_{NAME} if the variable exists. Otherwise return
" the comment definition as set with |tcomment#DefineType|.
function! tcomment#GetCommentDef(name, ...)
if exists('b:tcomment_def_'. a:name)
return b:tcomment_def_{a:name}
else
return get(s:definitions, a:name, a:0 >= 1 ? a:1 : '')
endif
endf
" :nodoc:
" Return 1 if a comment type is defined.
function! tcomment#TypeExists(name, ...)
let comment_mode = a:0 >= 1 ? a:1 : ''
let name = a:name
if comment_mode =~? 'b'
let name .= '_block'
elseif comment_mode =~? 'i'
let name .= '_inline'
endif
return has_key(s:definitions, name) ? name : ''
endf
call tcomment#DefineType('aap', '# %s' )
call tcomment#DefineType('ada', '-- %s' )
call tcomment#DefineType('autohotkey', '; %s' )
call tcomment#DefineType('apache', '# %s' )
call tcomment#DefineType('applescript', '(* %s *)' )
call tcomment#DefineType('applescript_block',"(*%s*)\n" )
call tcomment#DefineType('applescript_inline','(* %s *)' )
call tcomment#DefineType('asciidoc', '// %s' )
call tcomment#DefineType('asm', '; %s' )
call tcomment#DefineType('asterisk', '; %s' )
call tcomment#DefineType('blade', '{{-- %s --}}' )
call tcomment#DefineType('blade_block', '{{-- %s --}}' )
call tcomment#DefineType('blade_inline', '{{-- %s --}}' )
call tcomment#DefineType('c', tcomment#GetLineC())
call tcomment#DefineType('c_block', g:tcommentBlockC )
call tcomment#DefineType('c_inline', g:tcommentInlineC )
call tcomment#DefineType('catalog', '-- %s --' )
call tcomment#DefineType('catalog_block', "--%s--\n " )
call tcomment#DefineType('cfg', '# %s' )
call tcomment#DefineType('chromemanifest', '# %s' )
call tcomment#DefineType('clojure', {'commentstring': '; %s', 'count': 2})
call tcomment#DefineType('clojure_inline', '; %s' )
call tcomment#DefineType('clojurescript', ';; %s' )
call tcomment#DefineType('clojurescript_inline', '; %s' )
call tcomment#DefineType('cmake', '# %s' )
call tcomment#DefineType('coffee', '# %s' )
call tcomment#DefineType('conf', '# %s' )
call tcomment#DefineType('context', '%% %s' )
call tcomment#DefineType('conkyrc', '# %s' )
call tcomment#DefineType('cpp', tcomment#GetLineC('// %s'))
call tcomment#DefineType('cpp_block', g:tcommentBlockC )
call tcomment#DefineType('cpp_inline', g:tcommentInlineC )
call tcomment#DefineType('cram', {'col': 1, 'commentstring': '# %s' })
call tcomment#DefineType('crontab', '# %s' )
call tcomment#DefineType('cs', '// %s' )
call tcomment#DefineType('cs_block', g:tcommentBlockC )
call tcomment#DefineType('cs_inline', g:tcommentInlineC )
call tcomment#DefineType('css', '/* %s */' )
call tcomment#DefineType('css_block', g:tcommentBlockC )
call tcomment#DefineType('css_inline', g:tcommentInlineC )
call tcomment#DefineType('debcontrol', '# %s' )
call tcomment#DefineType('debsources', '# %s' )
call tcomment#DefineType('desktop', '# %s' )
call tcomment#DefineType('dnsmasq', '# %s' )
call tcomment#DefineType('docbk', g:tcommentInlineXML)
call tcomment#DefineType('docbk_block', g:tcommentBlockXML )
call tcomment#DefineType('docbk_inline', g:tcommentInlineXML)
call tcomment#DefineType('dosbatch', 'rem %s' )
call tcomment#DefineType('dosini', '; %s' )
call tcomment#DefineType('dsl', '; %s' )
call tcomment#DefineType('dustjs', '{! %s !}' )
call tcomment#DefineType('dylan', '// %s' )
call tcomment#DefineType('eiffel', '-- %s' )
call tcomment#DefineType('elixir', '# %s' )
call tcomment#DefineType('erlang', '%%%% %s' )
call tcomment#DefineType('eruby', '<%%# %s' )
call tcomment#DefineType('esmtprc', '# %s' )
call tcomment#DefineType('expect', '# %s' )
call tcomment#DefineType('fish', '# %s' )
call tcomment#DefineType('form', {'commentstring': '* %s', 'col': 1})
call tcomment#DefineType('fstab', '# %s' )
call tcomment#DefineType('gitconfig', '# %s' )
call tcomment#DefineType('gitcommit', '# %s' )
call tcomment#DefineType('gitignore', '# %s' )
call tcomment#DefineType('gnuplot', '# %s' )
call tcomment#DefineType('go', '// %s' )
call tcomment#DefineType('go_block', g:tcommentBlockC )
call tcomment#DefineType('go_inline', g:tcommentInlineC )
call tcomment#DefineType('groovy', tcomment#GetLineC('// %s'))
call tcomment#DefineType('groovy_block', g:tcommentBlockC )
call tcomment#DefineType('groovy_doc_block', g:tcommentBlockC2 )
call tcomment#DefineType('groovy_inline', g:tcommentInlineC )
call tcomment#DefineType('gtkrc', '# %s' )
call tcomment#DefineType('haml', '-# %s' )
call tcomment#DefineType('haskell', '-- %s' )
call tcomment#DefineType('haskell_block', "{-%s-}\n " )
call tcomment#DefineType('haskell_inline', '{- %s -}' )
call tcomment#DefineType('html', g:tcommentInlineXML)
call tcomment#DefineType('html_block', g:tcommentBlockXML )
call tcomment#DefineType('html_inline', g:tcommentInlineXML)
call tcomment#DefineType('htmldjango', '{# %s #}' )
call tcomment#DefineType('htmldjango_block', "{%% comment %%}%s{%% endcomment %%}\n ")
call tcomment#DefineType('htmljinja', '{# %s #}' )
call tcomment#DefineType('htmljinja_block', "{%% comment %%}%s{%% endcomment %%}\n ")
call tcomment#DefineType('hy', '; %s' )
call tcomment#DefineType('ini', '; %s' ) " php ini (/etc/php5/...)
call tcomment#DefineType('io', '// %s' )
call tcomment#DefineType('jade', '// %s' )
call tcomment#DefineType('jasmine', '# %s' )
call tcomment#DefineType('java', tcomment#GetLineC('// %s'))
call tcomment#DefineType('java_block', g:tcommentBlockC )
call tcomment#DefineType('java_doc_block', g:tcommentBlockC2 )
call tcomment#DefineType('java_inline', g:tcommentInlineC )
call tcomment#DefineType('javascript', tcomment#GetLineC('// %s'))
call tcomment#DefineType('javascript_block', g:tcommentBlockC )
call tcomment#DefineType('javascript_inline', g:tcommentInlineC )
call tcomment#DefineType('jinja', '{# %s #}' )
call tcomment#DefineType('jinja_block', "{%% comment %%}%s{%% endcomment %%}\n ")
call tcomment#DefineType('jproperties', '# %s' )
call tcomment#DefineType('lilypond', '%% %s' )
call tcomment#DefineType('lisp', '; %s' )
call tcomment#DefineType('liquid', g:tcommentInlineXML)
call tcomment#DefineType('liquid_block', g:tcommentBlockXML )
call tcomment#DefineType('liquid_inline', g:tcommentInlineXML)
call tcomment#DefineType('lua', '-- %s' )
call tcomment#DefineType('lua_block', "--[[%s--]]\n" )
call tcomment#DefineType('lua_inline', '--[[%s --]]' )
call tcomment#DefineType('lynx', '# %s' )
call tcomment#DefineType('m4', 'dnl %s' )
call tcomment#DefineType('mail', '> %s' )
call tcomment#DefineType('make', '# %s' )
call tcomment#DefineType('matlab', '%% %s' )
call tcomment#DefineType('monkey', ''' %s' )
call tcomment#DefineType('msidl', '// %s' )
call tcomment#DefineType('msidl_block', g:tcommentBlockC )
call tcomment#DefineType('nginx', '# %s' )
call tcomment#DefineType('nroff', '.\\" %s' )
call tcomment#DefineType('noweb', '%% %s' )
call tcomment#DefineType('nsis', '# %s' )
call tcomment#DefineType('objc', '/* %s */' )
call tcomment#DefineType('objc_block', g:tcommentBlockC )
call tcomment#DefineType('objc_inline', g:tcommentInlineC )
call tcomment#DefineType('objcpp', '// %s' )
call tcomment#DefineType('ocaml', '(* %s *)' )
call tcomment#DefineType('ocaml_block', "(*%s*)\n " )
call tcomment#DefineType('ocaml_inline', '(* %s *)' )
call tcomment#DefineType('pac', '// %s' )
call tcomment#DefineType('pascal', '(* %s *)' )
call tcomment#DefineType('pascal_block', "(*%s*)\n " )
call tcomment#DefineType('pascal_inline', '(* %s *)' )
call tcomment#DefineType('perl', '# %s' )
call tcomment#DefineType('perl_block', "=cut%s=cut" )
call tcomment#DefineType('pfmain', '# %s' )
call tcomment#DefineType('php', {'commentstring_rx': '\%%(//\|#\) %s', 'commentstring': '// %s'})
call tcomment#DefineType('php_2_block', g:tcommentBlockC2 )
call tcomment#DefineType('php_block', g:tcommentBlockC )
call tcomment#DefineType('php_inline', g:tcommentInlineC )
call tcomment#DefineType('po', '# %s' )
call tcomment#DefineType('prolog', '%% %s' )
call tcomment#DefineType('puppet', '# %s' )
call tcomment#DefineType('purescript', '-- %s' )
call tcomment#DefineType('purescript_block', "{-%s-}\n " )
call tcomment#DefineType('purescript_inline','{- %s -}' )
call tcomment#DefineType('python', '# %s' )
call tcomment#DefineType('qml', '// %s' )
call tcomment#DefineType('r', '# %s' )
call tcomment#DefineType('racket', '; %s' )
call tcomment#DefineType('racket_block', '#|%s|#' )
call tcomment#DefineType('rc', '// %s' )
call tcomment#DefineType('readline', '# %s' )
call tcomment#DefineType('remind', {'commentstring_rx': '\[;#] %s', 'commentstring': '# %s'})
call tcomment#DefineType('resolv', '# %s' )
call tcomment#DefineType('robot', {'col': 1, 'commentstring': '# %s'})
call tcomment#DefineType('robots', '# %s' )
call tcomment#DefineType('rust', tcomment#GetLineC('// %s'))
call tcomment#DefineType('rust_block', g:tcommentBlockC )
call tcomment#DefineType('ruby', '# %s' )
call tcomment#DefineType('ruby_3', '### %s' )
call tcomment#DefineType('ruby_block', "=begin rdoc%s=end")
call tcomment#DefineType('ruby_nodoc_block', "=begin%s=end" )
call tcomment#DefineType('samba', '# %s' )
call tcomment#DefineType('sbs', "' %s" )
call tcomment#DefineType('scala', '// %s' )
call tcomment#DefineType('scala_block', g:tcommentBlockC )
call tcomment#DefineType('scala_inline', g:tcommentInlineC )
call tcomment#DefineType('scheme', '; %s' )
call tcomment#DefineType('scheme_block', '#|%s|#' )
call tcomment#DefineType('scss', '// %s' )
call tcomment#DefineType('scss_block', g:tcommentBlockC )
call tcomment#DefineType('scss_inline', g:tcommentInlineC )
call tcomment#DefineType('sed', '# %s' )
call tcomment#DefineType('sgml', g:tcommentInlineXML)
call tcomment#DefineType('sgml_block', g:tcommentBlockXML )
call tcomment#DefineType('sgml_inline', g:tcommentInlineXML)
call tcomment#DefineType('sh', '# %s' )
call tcomment#DefineType('slim', '/%s' )
call tcomment#DefineType('sls', '# %s' )
call tcomment#DefineType('smarty', '{* %s *}' )
call tcomment#DefineType('spec', '# %s' )
call tcomment#DefineType('sps', '* %s.' )
call tcomment#DefineType('sps_block', "* %s." )
call tcomment#DefineType('spss', '* %s.' )
call tcomment#DefineType('spss_block', "* %s." )
call tcomment#DefineType('sql', '-- %s' )
call tcomment#DefineType('squid', '# %s' )
call tcomment#DefineType('sshconfig', '# %s' )
call tcomment#DefineType('sshdconfig', '# %s' )
call tcomment#DefineType('st', '" %s "' )
call tcomment#DefineType('tcl', '# %s' )
call tcomment#DefineType('tex', '%% %s' )
call tcomment#DefineType('toml', '# %s' )
call tcomment#DefineType('tpl', '<!-- %s -->' )
call tcomment#DefineType('tup', '# %s' )
call tcomment#DefineType('typoscript', '# %s' )
call tcomment#DefineType('upstart', '# %s' )
call tcomment#DefineType('vader', {'col': 1, 'commentstring': '" %s' })
call tcomment#DefineType('vhdl', '-- %s' )
call tcomment#DefineType('verilog', '// %s' )
call tcomment#DefineType('verilog_inline', g:tcommentInlineC )
call tcomment#DefineType('verilog_block', g:tcommentBlockC )
call tcomment#DefineType('verilog_systemverilog', '// %s' )
call tcomment#DefineType('verilog_systemverilog_block', g:tcommentBlockC)
call tcomment#DefineType('verilog_systemverilog_inline', g:tcommentInlineC)
call tcomment#DefineType('viki', '%% %s' )
call tcomment#DefineType('viki_3', '%%%%%% %s' )
call tcomment#DefineType('viki_inline', '{cmt: %s}' )
call tcomment#DefineType('vim', '" %s' )
call tcomment#DefineType('vim_3', '""" %s' )
call tcomment#DefineType('vimwiki', '%%%% %s' )
call tcomment#DefineType('websec', '# %s' )
call tcomment#DefineType('x86conf', '# %s' )
call tcomment#DefineType('xml', g:tcommentInlineXML)
call tcomment#DefineType('xml_block', g:tcommentBlockXML )
call tcomment#DefineType('xml_inline', g:tcommentInlineXML)
call tcomment#DefineType('xs', g:tcommentInlineC )
call tcomment#DefineType('xs_block', g:tcommentBlockC )
call tcomment#DefineType('xslt', g:tcommentInlineXML)
call tcomment#DefineType('xslt_block', g:tcommentBlockXML )
call tcomment#DefineType('xslt_inline', g:tcommentInlineXML)
call tcomment#DefineType('yaml', '# %s' )
" :doc:
" A dictionary of NAME => COMMENT DEFINITION (see |tcomment#DefineType|)
" that can be set in vimrc to override tcomment's default comment
" styles.
" :read: let g:tcomment_types = {} "{{{2
if exists('g:tcomment_types')
for [s:name, s:def] in items(g:tcomment_types)
call tcomment#DefineType(s:name, s:def)
endfor
unlet! s:name s:def
endif
function! s:DefaultValue(option)
exec 'let '. a:option .' = &'. a:option
exec 'set '. a:option .'&'
exec 'let default = &'. a:option
exec 'let &'. a:option .' = '. a:option
return default
endf
function! s:Count(string, rx)
return len(split(a:string, a:rx, 1)) - 1
endf
function! s:Printf1(fmt, expr)
let n = s:Count(a:fmt, '%\@<!\%(%%\)*%s')
let exprs = repeat([a:expr], n)
" TLogVAR a:fmt, a:expr, exprs
let rv = call(function('printf'), [a:fmt] + exprs)
" TLogVAR rv
return rv
endf
let s:default_comments = s:DefaultValue('comments')
let s:default_comment_string = s:DefaultValue('commentstring')
let s:null_comment_string = '%s'
" tcomment#Comment(line1, line2, ?comment_mode, ?comment_anyway, ?args...)
" args... are either:
" 1. a list of key=value pairs where known keys are (see also
" |g:tcommentOptions|):
" as=STRING ... Use a specific comment definition
" count=N ... Repeat the comment string N times
" col=N ... Start the comment at column N (in block
" mode; must be smaller than |indent()|)
" mode=STRING ... See the notes below on the "comment_mode" argument
" mode_extra=STRING ... Add to comment_mode
" begin=STRING ... Comment prefix
" end=STRING ... Comment postfix
" middle=STRING ... Middle line comments in block mode
" rxbeg=N ... Regexp to find the substring of "begin"
" that should be multiplied by "count"
" rxend=N ... The above for "end"
" rxmid=N ... The above for "middle"
" mixedindent=BOOL ... If true, allow use of mixed
" characters for indentation
" commentstring_rx ... A regexp format string that matches
" commented lines (no new groups may be
" introduced, the |regexp| is |\V|; % have
" to be doubled); "commentstring", "begin"
" and optionally "end" must be defined or
" deducible.
" whitespace ... Define whether commented text is
" surrounded with whitespace; if
" both ... surround with whitespace (default)
" left ... keep whitespace on the left
" right... keep whitespace on the right
" no ... don't use whitespace
" strip_whitespace ... Strip trailing whitespace: if 1
" (default), strip from empty lines only,
" if 2, always strip whitespace; if 0,
" don't strip any whitespace
" 2. 1-2 values for: ?commentPrefix, ?commentPostfix
" 3. a dictionary (internal use only)
"
" comment_mode (see also ¦g:tcommentModeExtra¦):
" G ... guess the value of comment_mode
" B ... block (use extra lines for the comment markers)
" L ... lines
" i ... maybe inline, guess
" I ... inline
" R ... right (comment the line right of the cursor)
" v ... visual
" o ... operator
" C ... force comment
" K ... comment only uncommented lines
" U ... force uncomment (if U and C are present, U wins)
" By default, each line in range will be commented by adding the comment
" prefix and postfix.
function! tcomment#Comment(beg, end, ...)
let comment_mode0 = s:AddModeExtra((a:0 >= 1 ? a:1 : 'G'), g:tcommentModeExtra, a:beg, a:end)
let comment_mode = comment_mode0
let comment_anyway = a:0 >= 2 ? (a:2 == '!') : 0
" TLogVAR a:beg, a:end, comment_mode, comment_anyway, a:000
" save the cursor position
if exists('w:tcomment_pos')
let s:current_pos = copy(w:tcomment_pos)
else
let s:current_pos = getpos('.')
endif
" echom "DBG current_pos=" string(s:current_pos)
let cursor_pos = getpos("'>")
" TLogVAR cursor_pos
let s:cursor_pos = []
if comment_mode =~# 'i'
let blnum = line("'<")
if blnum == line("'>")
if virtcol('.') <= indent(blnum)
let i_mode = 'G'
else
let i_mode = 'I'
endif
else
let i_mode = 'G'
endif
let comment_mode = substitute(comment_mode, '\Ci', i_mode, 'g')
" TLogVAR 1, comment_mode
endif
let [lbeg, cbeg, lend, cend] = s:GetStartEnd(a:beg, a:end, comment_mode)
" TLogVAR lbeg, cbeg, lend, cend, virtcol('$')
if comment_mode ==? 'I' && comment_mode0 =~# 'i' && lbeg == lend && cend >= virtcol('$') - 1
let comment_mode = substitute(comment_mode, '\CI', cbeg <= 1 ? 'G' : 'R', 'g')
" TLogVAR comment_mode
endif
let mode_extra = s:GetTempOption('mode_extra', '')
" TLogVAR mode_extra
if !empty(mode_extra)
let comment_mode = s:AddModeExtra(comment_mode, mode_extra, lbeg, lend)
" TLogVAR "mode_extra", comment_mode
unlet s:temp_options.mode_extra
endif
" get the correct commentstring
let cdef = copy(g:tcommentOptions)
" TLogVAR 1, cdef
if exists('b:tcommentOptions')
let cdef = extend(cdef, copy(b:tcommentOptions))
" TLogVAR 2, cdef
endif
if a:0 >= 3 && type(a:3) == 4
call extend(cdef, a:3)
" TLogVAR 3, cdef
else
let cdef0 = s:GetCommentDefinition(lbeg, lend, comment_mode)
" TLogVAR 4.1, cdef, cdef0
call extend(cdef, cdef0)
" TLogVAR 4.2, cdef
let ax = 3
if a:0 >= 3 && a:3 != '' && stridx(a:3, '=') == -1
let ax = 4
let cdef.begin = a:3
if a:0 >= 4 && a:4 != '' && stridx(a:4, '=') == -1
let ax = 5
let cdef.end = a:4
endif
endif
" TLogVAR ax, a:0, a:000
if a:0 >= ax
" let cdef = extend(cdef, s:ParseArgs(lbeg, lend, comment_mode, a:000[ax - 1 : -1]))
let cdef = s:ExtendCDef(lbeg, lend, comment_mode, cdef, s:ParseArgs(lbeg, lend, comment_mode, a:000[ax - 1 : -1]))
" TLogVAR 5, cdef
endif
if !empty(get(cdef, 'begin', '')) || !empty(get(cdef, 'end', ''))
let cdef.commentstring = s:EncodeCommentPart(get(cdef, 'begin', ''))
\ . '%s'
\ . s:EncodeCommentPart(get(cdef, 'end', ''))
endif
let comment_mode = cdef.mode
" TLogVAR 2, comment_mode
endif
if empty(comment_mode)
echohl WarningMsg
echo "TComment: Comment mode is not supported for the current filetype"
echohl NONE
return
endif
if exists('s:temp_options')
let cdef = s:ExtendCDef(lbeg, lend, comment_mode, cdef, s:temp_options)
" TLogVAR 6, cdef
" echom "DBG s:temp_options" string(s:temp_options)
unlet s:temp_options
endif
" TLogVAR 7, cdef
if has_key(cdef, 'whitespace')
call s:SetWhitespaceMode(cdef)
endif
if !empty(filter(['count', 'cbeg', 'cend', 'cmid'], 'has_key(cdef, v:val)'))
call s:RepeatCommentstring(cdef)
endif
" echom "DBG" string(a:000)
let cms0 = s:BlockGetCommentRx(cdef)
" TLogVAR cms0
"" make whitespace optional; this conflicts with comments that require some
"" whitespace
let cmt_check = substitute(cms0, '\([ ]\)', '\1\\?', 'g')
"" turn commentstring into a search pattern
" TLogVAR cmt_check
let cmt_check = s:Printf1(cmt_check, '\(\_.\{-}\)')
" TLogVAR cdef, cmt_check
let s:cdef = cdef
" set comment_mode
" TLogVAR comment_mode
let [lbeg, lend, uncomment] = s:CommentDef(lbeg, lend, cmt_check, comment_mode, cbeg, cend)
" TLogVAR lbeg, lend, cbeg, cend, uncomment, comment_mode, comment_anyway
if uncomment
if comment_mode =~# 'C' || comment_anyway
let comment_do = 'c'
else
let comment_do = 'u'
endif
else
if comment_mode =~# 'U'
let comment_do = 'u'
elseif comment_mode =~# 'K'
let comment_do = 'k'
else
let comment_do = 'c'
endif
endif
" TLogVAR comment_anyway, comment_mode, mode_extra, comment_do
" " echom "DBG" string(s:cdef)
if comment_do ==# 'c'
let cbeg = get(s:cdef, 'col', cbeg)
endif
" TLogVAR cbeg
" go
" TLogVAR comment_mode
if comment_mode =~# 'B'
" We want a comment block
call s:CommentBlock(lbeg, lend, cbeg, cend, comment_mode, comment_do, cmt_check, s:cdef)
else
" We want commented lines
" final search pattern for uncommenting
let cmt_check = '\V\^\(\s\{-}\)'. cmt_check .'\$'
" let cmt_check = escape(cmt_check, '"/\')
" final pattern for commenting
let cmt_replace = s:GetCommentReplace(s:cdef, cms0)
" TLogVAR cmt_replace
" TLogVAR comment_mode, lbeg, cbeg, lend, cend
let s:processline_lnum = lbeg
let end_rx = s:EndPosRx(comment_mode, lend, cend)
let postfix_rx = end_rx == '\$' ? '' : '\.\*\$'
let prefix_rx = '\^\.\{-}' . s:StartPosRx(comment_mode, lbeg, cbeg)
let comment_rx = '\V'
\ . '\('. prefix_rx . '\)'
\ .'\('
\ .'\(\_.\{-}\)'
\ . end_rx
\ .'\)'
\ .'\(' . postfix_rx . '\)'
" TLogVAR comment_rx, prefix_rx, end_rx, postfix_rx
" let @x = comment_rx " DBG
for lnum in range(lbeg, lend)
let line0 = getline(lnum)
" TLogVAR line0
let lmatch = matchlist(line0, comment_rx)
" TLogVAR lmatch
if empty(lmatch) && g:tcomment#blank_lines >= 2
let lline0 = s:Strdisplaywidth(line0)
" TLogVAR lline0, cbeg
if lline0 < cbeg
let line0 = line0 . repeat(' ', cbeg - lline0)
let lmatch = [line0, line0, '', '', '']
" TLogVAR 'padded', line0, lmatch
endif
endif
if !empty(lmatch)
let [part1, ok] = s:ProcessLine(comment_do, lmatch[2], cmt_check, cmt_replace)
" TLogVAR part1, ok
if ok
let line1 = lmatch[1] . part1 . lmatch[4]
if comment_do ==# 'u' && g:tcomment#rstrip_on_uncomment > 0
if g:tcomment#rstrip_on_uncomment == 2 || line1 !~ '\S'
let line1 = substitute(line1, '\s\+$', '', '')
endif
endif
" TLogVAR line1
call setline(lnum, line1)
endif
endif
endfor
endif
" reposition cursor
" TLogVAR 3, comment_mode
" echom "DBG s:cursor_pos" string(s:cursor_pos)
if !empty(s:cursor_pos)
let cursor_pos = s:cursor_pos
endif
if comment_mode =~ '>'
call setpos('.', cursor_pos)
if comment_mode !~ 'i' && comment_mode =~ '>>'
norm! l^
endif
elseif comment_mode =~ '#'
call setpos('.', cursor_pos)
if exists('w:tcomment_pos')
let w:tcomment_pos = cursor_pos
endif
else
call setpos('.', s:current_pos)
endif
unlet! s:cursor_pos s:current_pos s:cdef
endf
if v:version >= 703
function! s:Strdisplaywidth(...) "{{{3
return call('strdisplaywidth', a:000)
endf
else
function! s:Strdisplaywidth(string, ...) "{{{3
" NOTE: Col argument is ignored
return strlen(substitute(a:string, ".", "x", "g"))
endf
endif
function! tcomment#MaybeReuseOptions(name) "{{{3
if exists('s:options_cache') && get(s:options_cache, 'name', '') == a:name
if exists('s:temp_options')
let s:temp_options = extend(deepcopy(s:options_cache.options), s:temp_options)
let s:options_cache = {'name': a:name, 'options': s:temp_options}
else
let s:temp_options = deepcopy(s:options_cache.options)
endif
elseif exists('s:temp_options')
let s:options_cache = {'name': a:name, 'options': s:temp_options}
endif
endf
function! s:GetTempOption(name, default) "{{{3
if exists('s:temp_options') && has_key(s:temp_options, a:name)
return s:temp_options[a:name]
else
return a:default
endif
endf
function! tcomment#ResetOption() "{{{3
unlet! s:temp_options s:options_cache
endf
function! tcomment#SetOption(name, arg) "{{{3
" TLogVAR a:name, a:arg
if !exists('s:temp_options')
let s:temp_options = {}
endif
" if index(['count', 'as'], a:name) != -1
if empty(a:arg)
if has_key(s:temp_options, a:name)
call remove(s:temp_options, a:name)
endif
else
let s:temp_options[a:name] = a:arg
endif
" endif
endf
function! s:GetStartEnd(beg, end, comment_mode) "{{{3
" TLogVAR a:beg, a:end, a:comment_mode
if type(a:beg) == 3
let [lbeg, cbeg] = a:beg
let [lend, cend] = a:end
else
let lbeg = a:beg
let lend = a:end
let comment_mode = a:comment_mode
" TLogVAR comment_mode
if comment_mode =~# 'R'
let cbeg = virtcol('.')
let cend = virtcol('$')
let comment_mode = substitute(comment_mode, '\CR', 'G', 'g')
" TLogVAR 'R', cbeg, cend, comment_mode
elseif comment_mode =~# 'I'
let cbeg = virtcol("'<")
if cbeg == 0
let cbeg = virtcol('.')
endif
let cend = virtcol("'>")
if cend < virtcol('$') && (comment_mode =~# 'o' || &selection == 'inclusive')
let cend += 1
" TLogVAR cend, virtcol('$')
endif
" TLogVAR 'I', cbeg, cend, comment_mode
else
let cbeg = -1
let cend = 0
for lnum in range(a:beg, a:end)
if getline(lnum) =~ '\S'
let indentwidth = indent(lnum)
" TLogVAR cbeg, lnum, indentwidth, getline(lnum)
if cbeg == -1 || indentwidth < cbeg
let cbeg = indentwidth
endif
endif
endfor
if cbeg == -1
let cbeg = 0
endif
endif
endif
" TLogVAR lbeg, cbeg, lend, cend
if lend < lbeg || (lend == lbeg && cend > 0 && cend < cbeg)
return [lend, cend, lbeg, cbeg]
else
return [lbeg, cbeg, lend, cend]
endif