kakoune/rc/commenting.kak
Frank LENORMAND f7e976676c Introduce the commenting.kak file
Centralize commenting functions into a single file, and declare
variables used by those functions in language support files. The
functions are `comment-selection` and `comment-line`, users should bind
those functions to the keys of their liking for easy access.
2015-10-25 15:54:17 +03:00

78 lines
2.7 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 "//"
def comment-selection -docstring "Comment/uncomment the current selection" %{
%sh{
function escape_regex_chars {
## Escape characters that can be interpreted as modifiers/repetitors by the regex engine
sed -r 's,(\*|\+|\[|\]|\{\}|\||\(|\)|\?),\\\1,g' <<< "$@"
}
readonly opening="${kak_opt_comment_selection_chars%%:*}"
readonly closing="${kak_opt_comment_selection_chars##*:}"
readonly opening_escaped=$(escape_regex_chars "${opening}")
readonly closing_escaped=$(escape_regex_chars "${closing}")
if [ -z "${opening}" -o -z "${closing}" ]; then
echo "The \`comment_selection_chars\` variable is empty, couldn't comment the selection" >&2
exit
fi
echo "try %{
## The selection is empty
exec -draft %{<a-K>\A[\h\v\n]*\z<ret>}
try %{
## The selection has already been commented
exec -draft %{<a-K>\A${opening_escaped}.*${closing_escaped}\z<ret>}
## Comment the selection
exec %{a ${closing}<esc>i${opening} <esc>$((${#opening} + 1))H}
} catch %{
## Uncomment the commented selection
exec -draft %{s(\A${opening_escaped} )|( ${closing_escaped}\z)<ret>d}
}
}"
}
}
def comment-line -docstring "Comment/uncomment the current line" %{
%sh{
function escape_regex_chars {
## Escape characters that can be interpreted as modifiers/repetitors by the regex engine
sed -r 's,(\*|\+|\[|\]|\{\}|\||\(|\)|\?),\\\1,g' <<< "$@"
}
readonly opening="${kak_opt_comment_line_chars}"
readonly opening_escaped=$(escape_regex_chars "${opening}")
if [ -z "${opening}" ]; then
echo "The \`comment_line_chars\` variable is empty, couldn't comment the line" >&2
exit
fi
echo "
## Select the content of the line, without indentation
exec %{I<esc><a-l>}
try %{
## There's no text on the line
exec -draft %{<a-K>\A[\h\v\n]*\z<ret>}
try %{
## The line has already been commented
exec -draft %{<a-K>^${opening_escaped}<ret>}
## Comment the line
exec %{i${opening} <esc>$((${#opening} + 1))H}
} catch %{
## Uncomment the line
exec -draft %{s^${opening_escaped}\h*<ret>d}
}
}"
}
}