2017-10-16 17:07:52 +03:00
|
|
|
# Line comments
|
2017-11-03 10:34:41 +03:00
|
|
|
declare-option -docstring "characters inserted at the beginning of a commented line" \
|
2017-05-16 14:35:43 +03:00
|
|
|
str comment_line '#'
|
2016-10-15 11:04:43 +03:00
|
|
|
|
2017-10-16 17:07:52 +03:00
|
|
|
# Block comments
|
|
|
|
declare-option -docstring "characters inserted before a commented block" \
|
|
|
|
str comment_block_begin
|
|
|
|
declare-option -docstring "characters inserted after a commented block" \
|
|
|
|
str comment_block_end
|
2015-10-25 15:17:36 +03:00
|
|
|
|
2017-10-16 17:07:52 +03:00
|
|
|
# Default comments for all languages
|
2016-10-15 11:04:43 +03:00
|
|
|
hook global BufSetOption filetype=asciidoc %{
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_block_begin '///'
|
|
|
|
set-option buffer comment_block_end '///'
|
2016-10-15 11:04:43 +03:00
|
|
|
}
|
|
|
|
|
2017-12-06 22:49:08 +03:00
|
|
|
hook global BufSetOption filetype=(c|cpp|go|java|javascript|objc|php|rust|sass|scala|scss|swift|typescript) %{
|
2017-11-03 10:34:41 +03:00
|
|
|
set-option buffer comment_line '//'
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_block_begin '/*'
|
|
|
|
set-option buffer comment_block_end '*/'
|
2016-10-15 11:04:43 +03:00
|
|
|
}
|
|
|
|
|
2018-05-04 10:22:17 +03:00
|
|
|
hook global BufSetOption filetype=(cabal|haskell|moon|idris) %{
|
2018-03-22 14:56:07 +03:00
|
|
|
set-option buffer comment_line '-- '
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_block_begin '{-'
|
|
|
|
set-option buffer comment_block_end '-}'
|
2016-10-15 11:04:43 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
hook global BufSetOption filetype=clojure %{
|
2017-11-03 10:34:41 +03:00
|
|
|
set-option buffer comment_line '#_ '
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_block_begin '(comment '
|
|
|
|
set-option buffer comment_block_end ')'
|
2016-10-15 11:04:43 +03:00
|
|
|
}
|
|
|
|
|
2016-10-14 22:12:01 +03:00
|
|
|
hook global BufSetOption filetype=coffee %{
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_block_begin '###'
|
|
|
|
set-option buffer comment_block_end '###'
|
2016-10-14 22:12:01 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
hook global BufSetOption filetype=css %{
|
2017-11-03 10:34:41 +03:00
|
|
|
set-option buffer comment_line ''
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_block_begin '/*'
|
|
|
|
set-option buffer comment_block_end '*/'
|
2016-10-14 22:12:01 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
hook global BufSetOption filetype=d %{
|
2017-11-03 10:34:41 +03:00
|
|
|
set-option buffer comment_line '//'
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_block_begin '/+'
|
|
|
|
set-option buffer comment_block_end '+/'
|
2016-10-14 22:12:01 +03:00
|
|
|
}
|
|
|
|
|
2016-10-15 11:04:43 +03:00
|
|
|
hook global BufSetOption filetype=(gas|ini) %{
|
2017-11-03 10:34:41 +03:00
|
|
|
set-option buffer comment_line ';'
|
2016-10-15 11:04:43 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
hook global BufSetOption filetype=haml %{
|
2017-11-03 10:34:41 +03:00
|
|
|
set-option buffer comment_line '-#'
|
2016-10-15 11:04:43 +03:00
|
|
|
}
|
|
|
|
|
2018-02-28 07:07:25 +03:00
|
|
|
hook global BufSetOption filetype=(html|xml) %{
|
2017-11-03 10:34:41 +03:00
|
|
|
set-option buffer comment_line ''
|
2017-11-23 12:30:10 +03:00
|
|
|
set-option buffer comment_block_begin '<!--'
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_block_end '-->'
|
2016-10-14 22:12:01 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
hook global BufSetOption filetype=latex %{
|
2017-11-03 10:34:41 +03:00
|
|
|
set-option buffer comment_line '%'
|
2016-10-15 11:04:43 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
hook global BufSetOption filetype=lisp %{
|
2017-11-03 10:34:41 +03:00
|
|
|
set-option buffer comment_line ';'
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_block_begin '#|'
|
|
|
|
set-option buffer comment_block_end '|#'
|
2016-10-14 22:12:01 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
hook global BufSetOption filetype=lua %{
|
2017-11-03 10:34:41 +03:00
|
|
|
set-option buffer comment_line '--'
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_block_begin '--[['
|
|
|
|
set-option buffer comment_block_end ']]'
|
2016-10-14 22:12:01 +03:00
|
|
|
}
|
|
|
|
|
2016-10-15 11:04:43 +03:00
|
|
|
hook global BufSetOption filetype=markdown %{
|
2017-11-03 10:34:41 +03:00
|
|
|
set-option buffer comment_line ''
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_block_begin '[//]'
|
|
|
|
set-option buffer comment_block_end '# (:)'
|
2016-10-15 11:04:43 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
hook global BufSetOption filetype=perl %{
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_block_begin '#['
|
|
|
|
set-option buffer comment_block_end ']'
|
2016-10-15 11:04:43 +03:00
|
|
|
}
|
|
|
|
|
2017-10-16 17:07:43 +03:00
|
|
|
hook global BufSetOption filetype=pug %{
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_line '//'
|
2016-10-15 11:04:43 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
hook global BufSetOption filetype=python %{
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_block_begin "'''"
|
|
|
|
set-option buffer comment_block_end "'''"
|
2016-10-14 22:12:01 +03:00
|
|
|
}
|
|
|
|
|
2016-10-15 11:04:43 +03:00
|
|
|
hook global BufSetOption filetype=ragel %{
|
2017-11-03 10:34:41 +03:00
|
|
|
set-option buffer comment_line '%%'
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_block_begin '%%{'
|
|
|
|
set-option buffer comment_block_end '}%%'
|
2016-10-14 22:12:01 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
hook global BufSetOption filetype=ruby %{
|
2017-10-16 17:07:52 +03:00
|
|
|
set-option buffer comment_block_begin '^begin='
|
|
|
|
set-option buffer comment_block_end '^=end'
|
2016-10-14 22:12:01 +03:00
|
|
|
}
|
|
|
|
|
2017-10-16 17:07:52 +03:00
|
|
|
define-command comment-block -docstring '(un)comment selections using block comments' %{
|
2015-10-25 15:17:36 +03:00
|
|
|
%sh{
|
2017-10-16 17:07:52 +03:00
|
|
|
if [ -z "${kak_opt_comment_block_begin}" ] || [ -z "${kak_opt_comment_block_end}" ]; then
|
|
|
|
echo "fail \"The 'comment_block' options are empty, could not comment the selection\""
|
2015-10-25 15:17:36 +03:00
|
|
|
fi
|
2017-10-16 17:07:52 +03:00
|
|
|
}
|
|
|
|
evaluate-commands -draft %{
|
|
|
|
# Keep non-empty selections
|
|
|
|
execute-keys <a-K>\A\s*\z<ret>
|
|
|
|
|
|
|
|
try %{
|
2017-11-23 12:30:10 +03:00
|
|
|
# Assert that the selection has been commented
|
|
|
|
set-register / "\A\Q%opt{comment_block_begin}\E.*\Q%opt{comment_block_end}\E\n*\z"
|
|
|
|
execute-keys "s<ret>"
|
|
|
|
# Uncomment it
|
|
|
|
set-register / "\A\Q%opt{comment_block_begin}\E|\Q%opt{comment_block_end}\E\n*\z"
|
|
|
|
execute-keys s<ret>d
|
2017-10-16 17:07:52 +03:00
|
|
|
} catch %{
|
2017-11-23 12:30:10 +03:00
|
|
|
# Comment the selection
|
|
|
|
set-register '"' "%opt{comment_block_begin}"
|
|
|
|
execute-keys P
|
|
|
|
set-register '"' "%opt{comment_block_end}"
|
|
|
|
execute-keys p
|
2017-10-16 17:07:52 +03:00
|
|
|
}
|
2015-10-25 15:17:36 +03:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-11-03 10:34:41 +03:00
|
|
|
define-command comment-line -docstring '(un)comment selected lines using line comments' %{
|
2015-10-25 15:17:36 +03:00
|
|
|
%sh{
|
2017-10-16 17:07:52 +03:00
|
|
|
if [ -z "${kak_opt_comment_line}" ]; then
|
|
|
|
echo "fail \"The 'comment_line' option is empty, could not comment the line\""
|
2015-10-25 15:17:36 +03:00
|
|
|
fi
|
2017-10-16 17:07:52 +03:00
|
|
|
}
|
|
|
|
evaluate-commands -draft %{
|
|
|
|
# Select the content of the lines, without indentation
|
2018-03-30 01:29:05 +03:00
|
|
|
execute-keys <a-s>gi<a-l>
|
2015-10-25 15:17:36 +03:00
|
|
|
|
2017-10-16 17:07:52 +03:00
|
|
|
try %{
|
|
|
|
# Keep non-empty lines
|
|
|
|
execute-keys <a-K>\A\s*\z<ret>
|
2015-10-25 15:17:36 +03:00
|
|
|
|
|
|
|
try %{
|
2017-11-23 12:30:10 +03:00
|
|
|
# Select the comment characters and remove them
|
|
|
|
set-register / "\A\Q%opt{comment_line}\E\h*"
|
|
|
|
execute-keys s<ret>d
|
2017-10-16 17:07:52 +03:00
|
|
|
} catch %{
|
2017-11-23 12:30:10 +03:00
|
|
|
# Comment the line
|
|
|
|
set-register '"' "%opt{comment_line}"
|
|
|
|
execute-keys P
|
2015-10-25 15:17:36 +03:00
|
|
|
}
|
2017-10-16 17:07:52 +03:00
|
|
|
}
|
2015-10-25 15:17:36 +03:00
|
|
|
}
|
|
|
|
}
|