VimL: Make function called through key receive input from Vim command line

Question

So, this may not be a clear question because of the title. But here's the actual explanation:

I have this custom function, I want this function to be able to be called from the command line, this is done (:FunctionName arg), but now I need to make this function react to a certain mapping.

So when the user presses <leader>cs it will prompt the user for the arg part, mapping this is still kind of unclear to me, but also how to achieve this functionality. This is kind of what the Surround script does, where it lets you input the old character and the new character to replace it with.

I need this for my first script that I'm making BTW, which allows you to change the file's syntax in a manner similar to Sublime Text's way.

Thanks for all your help!

Ingo Karkat · Accepted Answer · 2012-11-25 20:09:13Z

3

The simplest way is to remove the concluding <CR> from the mapping, so that it just enters command-line mode and fills the command line with your custom command:

:nnoremap <Leader>cs :FunctionName<Space>

You can then enter the arg and trigger the command with Enter.

Alternatively, you can query for user input via input() (and single characters with getchar(); obvious, isn't it?!), like this:

function! FunctionNameWithQuery()
    let arg = input('arg: ')
    execute 'FunctionName' arg
endfunction
nnoremap <Leader>cs :call FunctionNameWithQuery()<CR>

answered Nov 25, 2012 at 20:09

Ingo Karkat

174k16 gold badges265 silver badges341 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

greduan Over a year ago

Thanks! I'll try this soon enough, and give you feedback. :)

greduan Over a year ago

I just tried it out, and it worked, thanks! BTW, here's my new script, how about giving it a try. :) vim.org/scripts/script.php?script_id=4324

Ingo Karkat Over a year ago

Glad I could help. Some additional hint: If you add -complete=syntax to your plugin's command definition, you can even auto-complete the syntax names with <Tab>.

greduan Over a year ago

I see what you mean. Thanks for the tip, that's the first thing I'll do. :)

Collectives™ on Stack Overflow

VimL: Make function called through key receive input from Vim command line

1 Answer 1

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related