[Feature] Toggle mixed comments

[xeluxee]

Given a similar situation ↓ how to comment uncommented lines and uncomment commented ones?

printf("Line 1\n");
printf("Line 2\n");
// printf("Line 3\n");
// printf("Line 4\n");

Expected result: ↓

// printf("Line 1\n");
// printf("Line 2\n");
printf("Line 3\n");
printf("Line 4\n");

The result I get when I select these 4 lines and press gc: ↓

// printf("Line 1\n");
// printf("Line 2\n");
// // printf("Line 3\n");
// // printf("Line 4\n");

I think gc should toggle comments. To comment everything g> is already available...

[numToStr]

This is expected. gc has to decide whether to comment or not, if it finds any line uncommented then it comments the whole motion/visual region. And to uncomment the whole region every line should be commented. Also, If you can check, this is the same behavior as tcomment, vim-commentary, and even VSCode.
What you are asking seems tempting at first but it is unexpected in practical :)

[IndianBoy42]

btw this functionality can be added for visual mode very easily. using :'<,'>normal gcc<CR> (as a mapping use :normal gcc<CR>). This will run gcc on each line separately, toggling each lines comments. To use it as a operator you will need to do a bit more work dealing with operatorfunc but you can base its functionality on the visual mode mapping

[numToStr]

@IndianBoy42 That's perfect. Just a pointer, I anyone wish to implement custom keybindings I'll recommend using require('Comment').toggle() for this.

[IndianBoy42]

:'<,'>normal works on normal mode commands though, so you would have to do something like this:

  map("x", "gt", ":normal :lua require'Comment'.toggle()<C-v><CR><CR>", nore)

The <C-v><CR> looks a bit jank to me, but its necessary

Or you can use :g like:

  map("x", "gt", ":g/./lua require'Comment'.toggle()<CR><cmd>nohls<CR>", nore)

The g command sets highlights like / and :s so I'd recommend the nohls after othewise the entire file will be highlighted (because the pattern is .)

[numToStr]

@xeluxee This is the best I can do to cover this case.

local A = vim.api
local U = require('Comment.utils')

function _G.__flip_flop_comment(vmode)
    local lcs, rcs = U.unwrap_cstr(vim.bo.commentstring)
    local scol, ecol, lines = U.get_lines(vmode, U.ctype.line)

    local ll, rr = U.escape(lcs), U.escape(rcs)
    local padding = true

    for i, line in ipairs(lines) do
        local is_commented = U.is_commented(line, ll, rr, padding)
        if is_commented then
            lines[i] = U.uncomment_str(line, ll, rr, padding)
        else
            lines[i] = U.comment_str(line, lcs, rcs, padding)
        end
    end

    A.nvim_buf_set_lines(0, scol, ecol, false, lines)
end

A.nvim_set_keymap('x', '<leader>l', '<ESC><CMD>lua __flip_flop_comment(vim.fn.visualmode())<CR>', { noremap = true, silent = true })

Edit: This only works with linewise comment

[xeluxee]

Interesting, thanks
But how to use it in normal mode?
Something like gt3j to toggle comments on the next 3 lines?

[numToStr]

@xeluxee You might wanna use operatorfunc :h operatorfunc.

This might work though I haven't tested

A.nvim_set_keymap('n', 'gt', '<CMD>set operatorfunc=v:lua.__flip_flop_comment<CR>g@', { noremap = true, silent = true })

[VKondakoff]

This is the best I can do to cover this case.

This does not seems to work here...
First I'm receiving a warning Only has 3 variables, but you set 4 values on this line:

local is_commented = U.is_commented(line, ll, rr, padding)

and then there is an error if I'm using <leader>l while there is visual selection: E5108: Error executing lua ...ite/pack/packer/start/Comment.nvim/lua/Comment/utils.lua:259: attempt to concatenate local 'pp' (a boolean value)

[numToStr]

So that now the API is stable. I am considering adding this but I am not sure whether to add a default mapping or just a give a lua api to play with.