1
1
mirror of https://github.com/mawww/kakoune.git synced 2024-12-18 08:51:46 +03:00
kakoune/rc/core/commenting.kak
Frank LENORMAND 68d3eda270 Miscellaneous fixes to the commenting.kak script
This commit properly produces backslash characters within double quote
strings instead of hoping the shell will not recognize the escape
sequence that they form with the following character. Use the proper
POSIX function declaration form.

The uncommenting logic now also ignores trailing newline characters,
which shortens the amount of operations needed to uncomment a selection.
2016-10-14 22:15:35 +03:00

116 lines
3.5 KiB
Plaintext

## Characters that will be used to surround a selection with
decl str-list comment_selection_chars "/*:*/"
## Characters that will be inserted at the beginning of a line to comment
decl str comment_line_chars "//"
## Default characters for all languages
hook global BufSetOption filetype=coffee %{
set buffer comment_line_chars '#'
set buffer comment_selection_chars '###:###'
}
hook global BufSetOption filetype=css %{
set buffer comment_line_chars ''
}
hook global BufSetOption filetype=d %{
set buffer comment_selection_chars '/+:+/'
}
hook global BufSetOption filetype=html %{
set buffer comment_line_chars ''
set buffer comment_selection_chars '<!--:-->'
}
hook global BufSetOption filetype=latex %{
set buffer comment_line_chars '%'
set buffer comment_selection_chars ''
}
hook global BufSetOption filetype=lua %{
set buffer comment_line_chars '--'
set buffer comment_selection_chars '--[[:]]'
}
hook global BufSetOption filetype=moon %{
set buffer comment_line_chars '--'
set buffer comment_selection_chars ''
}
hook global BufSetOption filetype=(perl|makefile) %{
set buffer comment_line_chars '#'
set buffer comment_selection_chars ''
}
hook global BufSetOption filetype=ruby %{
set buffer comment_line_chars '#'
set buffer comment_selection_chars '^begin=:^=end'
}
def comment-selection -docstring "Comment/uncomment the current selection" %{
%sh{
exec_proof() {
## Replace the '<' sign that is interpreted differently in `exec`
printf %s\\n "$@" | sed 's,<,<lt>,g'
}
readonly opening=$(exec_proof "${kak_opt_comment_selection_chars%%:*}")
readonly closing=$(exec_proof "${kak_opt_comment_selection_chars##*:}")
if [ -z "${opening}" ] || [ -z "${closing}" ]; then
echo "echo -debug 'The \`comment_selection_chars\` variable is empty, could not comment the selection'"
exit
fi
printf %s\\n "eval -draft %{ try %{
## The selection is empty
exec <a-K>\\A[\\h\\v\\n]*\\z<ret>
try %{
## The selection has already been commented
exec %{<a-K>\\A\\Q${opening}\\E.*\\Q${closing}\\E\\n*\\z<ret>}
## Comment the selection
exec -draft %{a${closing}<esc>i${opening}}
} catch %{
## Uncomment the commented selection
exec -draft %{s(\\A\\Q${opening}\\E)|(\\Q${closing}\\E\\n*\\z)<ret>d}
}
} }"
}
}
def comment-line -docstring "Comment/uncomment the current line" %{
%sh{
readonly opening="${kak_opt_comment_line_chars}"
readonly opening_escaped="\\Q${opening}\\E"
if [ -z "${opening}" ]; then
echo "echo -debug 'The \`comment_line_chars\` variable is empty, could not comment the line'"
exit
fi
printf %s\\n "eval -draft %{
## Select the content of the line, without indentation
exec I<esc><a-l>
try %{
## There's no text on the line
exec <a-K>\\A[\\h\\v\\n]*\\z<ret>
try %{
## The line has already been commented
exec %{<a-K>\\A${opening_escaped}<ret>}
## Comment the line
exec -draft %{i${opening}}
} catch %{
## Uncomment the line
exec -draft %{s\\A${opening_escaped}\\h*<ret>d}
}
}
}"
}
}