xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'occivink/comment'

Browse Source
This commit is contained in:
Maxime Coste 2017-11-24 16:29:30 +08:00
commit 74b0c98769
1 changed files with 77 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

149
rc/core/comment.kak
View File

@ -1,43 +1,52 @@
## Line comments # Line comments
declare-option -docstring "characters inserted at the beginning of a commented line" \ declare-option -docstring "characters inserted at the beginning of a commented line" \
str comment_line '#' str comment_line '#'
## Block comments # Block comments
declare-option -docstring "colon separated tuple containing the characters inserted before/after a commented line" \ declare-option -docstring "characters inserted before a commented block" \
str-list comment_block str comment_block_begin
declare-option -docstring "characters inserted after a commented block" \
str comment_block_end
## Default comments for all languages # Default comments for all languages
hook global BufSetOption filetype=asciidoc %{ hook global BufSetOption filetype=asciidoc %{
set-option buffer comment_block '///:///' set-option buffer comment_block_begin '///'
set-option buffer comment_block_end '///'
} }
hook global BufSetOption filetype=(c|cpp|go|java|javascript|objc|php|sass|scala|scss|swift) %{ hook global BufSetOption filetype=(c|cpp|go|java|javascript|objc|php|rust|sass|scala|scss|swift) %{
set-option buffer comment_line '//' set-option buffer comment_line '//'
set-option buffer comment_block '/*:*/' set-option buffer comment_block_begin '/*'
set-option buffer comment_block_end '*/'
} }
hook global BufSetOption filetype=(cabal|haskell|moon) %{ hook global BufSetOption filetype=(cabal|haskell|moon) %{
set-option buffer comment_line '--' set-option buffer comment_line '--'
set-option buffer comment_block '{-:-}' set-option buffer comment_block_begin '{-'
set-option buffer comment_block_end '-}'
} }
hook global BufSetOption filetype=clojure %{ hook global BufSetOption filetype=clojure %{
set-option buffer comment_line '#_ ' set-option buffer comment_line '#_ '
set-option buffer comment_block '(comment :)' set-option buffer comment_block_begin '(comment '
set-option buffer comment_block_end ')'
} }
hook global BufSetOption filetype=coffee %{ hook global BufSetOption filetype=coffee %{
set-option buffer comment_block '###:###' set-option buffer comment_block_begin '###'
set-option buffer comment_block_end '###'
} }
hook global BufSetOption filetype=css %{ hook global BufSetOption filetype=css %{
set-option buffer comment_line '' set-option buffer comment_line ''
set-option buffer comment_block '/*:*/' set-option buffer comment_block_begin '/*'
set-option buffer comment_block_end '*/'
} }
hook global BufSetOption filetype=d %{ hook global BufSetOption filetype=d %{
set-option buffer comment_line '//' set-option buffer comment_line '//'
set-option buffer comment_block '/+:+/' set-option buffer comment_block_begin '/+'
set-option buffer comment_block_end '+/'
} }
hook global BufSetOption filetype=(gas|ini) %{ hook global BufSetOption filetype=(gas|ini) %{
@ -50,7 +59,8 @@ hook global BufSetOption filetype=haml %{
hook global BufSetOption filetype=html %{ hook global BufSetOption filetype=html %{
set-option buffer comment_line '' set-option buffer comment_line ''
set-option buffer comment_block '<!--:-->' set-option buffer comment_block_begin '<!--'
set-option buffer comment_block_end '-->'
} }
hook global BufSetOption filetype=latex %{ hook global BufSetOption filetype=latex %{
@ -59,102 +69,97 @@ hook global BufSetOption filetype=latex %{
hook global BufSetOption filetype=lisp %{ hook global BufSetOption filetype=lisp %{
set-option buffer comment_line ';' set-option buffer comment_line ';'
set-option buffer comment_block '#|:|#' set-option buffer comment_block_begin '#|'
set-option buffer comment_block_end '|#'
} }
hook global BufSetOption filetype=lua %{ hook global BufSetOption filetype=lua %{
set-option buffer comment_line '--' set-option buffer comment_line '--'
set-option buffer comment_block '--[[:]]' set-option buffer comment_block_begin '--[['
set-option buffer comment_block_end ']]'
} }
hook global BufSetOption filetype=markdown %{ hook global BufSetOption filetype=markdown %{
set-option buffer comment_line '' set-option buffer comment_line ''
set-option buffer comment_block '[//]: # (:)' set-option buffer comment_block_begin '[//]'
set-option buffer comment_block_end '# (:)'
} }
hook global BufSetOption filetype=perl %{ hook global BufSetOption filetype=perl %{
set-option buffer comment_block '#[:]' set-option buffer comment_block_begin '#['
set-option buffer comment_block_end ']'
} }
hook global BufSetOption filetype=(pug|rust) %{ hook global BufSetOption filetype=pug %{
set-option buffer comment_line '//' set-option buffer comment_line '//'
} }
hook global BufSetOption filetype=python %{ hook global BufSetOption filetype=python %{
set-option buffer comment_block "''':'''" set-option buffer comment_block_begin "'''"
set-option buffer comment_block_end "'''"
} }
hook global BufSetOption filetype=ragel %{ hook global BufSetOption filetype=ragel %{
set-option buffer comment_line '%%' set-option buffer comment_line '%%'
set-option buffer comment_block '%%{:}%%' set-option buffer comment_block_begin '%%{'
set-option buffer comment_block_end '}%%'
} }
hook global BufSetOption filetype=ruby %{ hook global BufSetOption filetype=ruby %{
set-option buffer comment_block '^begin=:^=end' set-option buffer comment_block_begin '^begin='
set-option buffer comment_block_end '^=end'
} }
define-command comment-block -docstring '(un)comment selected lines using block comments' %{ define-command comment-block -docstring '(un)comment selections using block comments' %{
%sh{ %sh{
exec_proof() { if [ -z "${kak_opt_comment_block_begin}" ] || [ -z "${kak_opt_comment_block_end}" ]; then
## Replace the '<' sign that is interpreted differently in `execute-keys` echo "fail \"The 'comment_block' options are empty, could not comment the selection\""
printf %s\\n "$@" | sed 's,<,<lt>,g'
}
readonly opening=$(exec_proof "${kak_opt_comment_block%:*}")
readonly closing=$(exec_proof "${kak_opt_comment_block##*:}")
if [ -z "${opening}" ] || [ -z "${closing}" ]; then
echo "echo -debug 'The \`comment_block\` variable is empty, could not comment the selection'"
exit
fi fi
}
evaluate-commands -draft %{
# Keep non-empty selections
execute-keys <a-K>\A\s*\z<ret>
printf %s\\n "evaluate-commands -draft %{ try %{ try %{
## The selection is empty # Assert that the selection has been commented
execute-keys <a-K>\\A[\\h\\v\\n]*\\z<ret> set-register / "\A\Q%opt{comment_block_begin}\E.*\Q%opt{comment_block_end}\E\n*\z"
execute-keys "s<ret>"
try %{ # Uncomment it
## The selection has already been commented set-register / "\A\Q%opt{comment_block_begin}\E|\Q%opt{comment_block_end}\E\n*\z"
execute-keys %{<a-K>\\A\\Q${opening}\\E.*\\Q${closing}\\E\\n*\\z<ret>} execute-keys s<ret>d
} catch %{
## Comment the selection # Comment the selection
execute-keys -draft %{a${closing}<esc>i${opening}} set-register '"' "%opt{comment_block_begin}"
} catch %{ execute-keys P
## Uncomment the commented selection set-register '"' "%opt{comment_block_end}"
execute-keys -draft %{s(\\A\\Q${opening}\\E)|(\\Q${closing}\\E\\n*\\z)<ret>d} execute-keys p
} }
} }"
} }
} }
define-command comment-line -docstring '(un)comment selected lines using line comments' %{ define-command comment-line -docstring '(un)comment selected lines using line comments' %{
%sh{ %sh{
readonly opening="${kak_opt_comment_line}" if [ -z "${kak_opt_comment_line}" ]; then
readonly opening_escaped="\\Q${opening}\\E" echo "fail \"The 'comment_line' option is empty, could not comment the line\""
if [ -z "${opening}" ]; then
echo "echo -debug 'The \`comment_line\` variable is empty, could not comment the line'"
exit
fi fi
}
evaluate-commands -draft %{
# Select the content of the lines, without indentation
execute-keys <a-s>gi<a-l>
printf %s\\n "evaluate-commands -draft %{ try %{
## Select the content of the lines, without indentation # Keep non-empty lines
execute-keys <a-s>I<esc><a-l> execute-keys <a-K>\A\s*\z<ret>
try %{ try %{
## There’s no text on the line # Select the comment characters and remove them
execute-keys <a-K>\\A[\\h\\v\\n]*\\z<ret> set-register / "\A\Q%opt{comment_line}\E\h*"
execute-keys s<ret>d
try %{ } catch %{
## The line has already been commented # Comment the line
execute-keys %{<a-K>\\A${opening_escaped}<ret>} set-register '"' "%opt{comment_line}"
execute-keys P
## Comment the line
execute-keys -draft %{i${opening}}
} catch %{
## Uncomment the line
execute-keys -draft %{s\\A${opening_escaped}\\h*<ret>d}
}
} }
}" }
} }
} }