Wikia

Vim Tips Wiki

Changes: User input from a script

Edit

Back to page

m (Overview: text formatting)
(Change <tt> to <code>, perhaps also minor tweak.)
 
Line 3: Line 3:
 
|previous=1615
 
|previous=1615
 
|next=1617
 
|next=1617
|created=February 10, 2009
+
|created=2009
 
|complexity=basic
 
|complexity=basic
 
|author=Slackdna
 
|author=Slackdna
Line 14: Line 14:
   
 
==Overview==
 
==Overview==
Vim provides the function <tt>input()</tt> that can display a prompt for the user, then wait for the user to type some input. To avoid problems with Vim's typeahead mechanism (which includes the processing of mappings), you need to first call <tt>inputsave()</tt>, then call <tt>input()</tt>, then <tt>inputrestore()</tt>.
+
Vim provides the function <code>input()</code> that can display a prompt for the user, then wait for the user to type some input. To avoid problems with Vim's typeahead mechanism (which includes the processing of mappings), you need to first call <code>inputsave()</code>, then call <code>input()</code>, then <code>inputrestore()</code>.
   
 
Often it is better to write a Vim command, so you can simply type the desired command and arguments when wanted (you don't need to be prompted for input). However, it is sometimes useful for a script to prompt the user to enter a required parameter.
 
Often it is better to write a Vim command, so you can simply type the desired command and arguments when wanted (you don't need to be prompted for input). However, it is sometimes useful for a script to prompt the user to enter a required parameter.
Line 23: Line 23:
   
 
==Vim example==
 
==Vim example==
Save the following in a file called, say, <tt>vimdemo.vim</tt>:
+
Save the following in a file called, say, <code>vimdemo.vim</code>:
 
<pre>
 
<pre>
 
function! Demo()
 
function! Demo()
Line 39: Line 39:
 
</pre>
 
</pre>
   
That defines function <tt>Demo()</tt> which you can call with:
+
That defines function <code>Demo()</code> which you can call with:
 
<pre>
 
<pre>
 
:call Demo()
 
:call Demo()
Line 47: Line 47:
   
 
==Python example==
 
==Python example==
Save the following in a file called, say, <tt>pydemo.vim</tt>:
+
Save the following in a file called, say, <code>pydemo.vim</code>:
 
<pre>
 
<pre>
 
function! DefPython()
 
function! DefPython()
Line 72: Line 72:
 
</pre>
 
</pre>
   
That defines a Python function <tt>demo()</tt> which you can call with:
+
That defines a Python function <code>demo()</code> which you can call with:
 
<pre>
 
<pre>
 
:py demo()
 
:py demo()

Latest revision as of 06:39, July 13, 2012

Tip 1616 Printable Monobook Previous Next

created 2009 · complexity basic · author Slackdna · version 7.0


This tip shows how to obtain input from the user from within a script. Examples showing Vim script and Python are given.

OverviewEdit

Vim provides the function input() that can display a prompt for the user, then wait for the user to type some input. To avoid problems with Vim's typeahead mechanism (which includes the processing of mappings), you need to first call inputsave(), then call input(), then inputrestore().

Often it is better to write a Vim command, so you can simply type the desired command and arguments when wanted (you don't need to be prompted for input). However, it is sometimes useful for a script to prompt the user to enter a required parameter.

If your are asking the user to confirm a choice, use instead the command

confirm(text[,choices[,default[,type]]])

(Note: confirm() is only supported when compiled with dialog support). For more details see the help reference.

Vim exampleEdit

Save the following in a file called, say, vimdemo.vim:

function! Demo()
  let curline = getline('.')
  call inputsave()
  let name = input('Enter name: ')
  call inputrestore()
  call setline('.', curline . ' ' . name)
endfunction

Use Vim to edit any file, then enter the following to source (execute) the above script:

:so vimdemo.vim

That defines function Demo() which you can call with:

:call Demo()

The function gets the current line to a variable, prompts the user to enter a name, then appends the entered name to the current line. This is only a simple demonstration, and is not intended to do anything useful.

Python exampleEdit

Save the following in a file called, say, pydemo.vim:

function! DefPython()
python << PYEND
import vim
def python_input(message = 'input'):
  vim.command('call inputsave()')
  vim.command("let user_input = input('" + message + ": ')")
  vim.command('call inputrestore()')
  return vim.eval('user_input')

def demo():
  curline = vim.current.line
  name = python_input('Enter name')
  vim.current.line = curline + ' ' + name
PYEND
endfunction
call DefPython()

Use Vim to edit any file, then enter the following to source the script:

:so pydemo.vim

That defines a Python function demo() which you can call with:

:py demo()

The Python example does the same as the Vim example: it prompts you to enter a name, then appends that name to the current line.

ReferencesEdit

CommentsEdit

Around Wikia's network

Random Wiki